@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,124 @@
1
+ "use strict";
2
+ // Code generated by box-gantry. DO NOT EDIT.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.CollectionsManager = void 0;
38
+ const runtime = __importStar(require("../runtime.js"));
39
+ const internal_js_1 = require("../internal.js");
40
+ /** Operations for the "collections" API area. */
41
+ class CollectionsManager {
42
+ session;
43
+ constructor(session) {
44
+ this.session = session;
45
+ }
46
+ /** Iterate every `models.schemas.Collection` across pages, threading the offset cursor. */
47
+ async *list(opts) {
48
+ const options = { ...opts };
49
+ for (;;) {
50
+ const page = await this.listPage(options);
51
+ const items = page.entries ?? [];
52
+ for (const item of items) {
53
+ yield item;
54
+ }
55
+ if (items.length === 0) {
56
+ return;
57
+ }
58
+ options.offset = (options.offset ?? 0) + items.length;
59
+ }
60
+ }
61
+ async listPage(opts) {
62
+ let url = this.session.baseUrl("api");
63
+ url += "/collections";
64
+ let req = this.session.newRequest("GET", url);
65
+ const options = opts ?? {};
66
+ if (options.fields !== undefined) {
67
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
68
+ }
69
+ if (options.offset !== undefined) {
70
+ req = runtime.withQuery(req, "offset", String(options.offset));
71
+ }
72
+ if (options.limit !== undefined) {
73
+ req = runtime.withQuery(req, "limit", String(options.limit));
74
+ }
75
+ const resp = await this.session.fetch(req);
76
+ const data = runtime.responseBytes(resp);
77
+ return JSON.parse(new TextDecoder().decode(data));
78
+ }
79
+ /** Iterate every `models.schemas.Item` across pages, threading the offset cursor. */
80
+ async *listItems(collectionId, opts) {
81
+ const options = { ...opts };
82
+ for (;;) {
83
+ const page = await this.listItemsPage(collectionId, options);
84
+ const items = page.entries ?? [];
85
+ for (const item of items) {
86
+ yield item;
87
+ }
88
+ if (items.length === 0) {
89
+ return;
90
+ }
91
+ options.offset = (options.offset ?? 0) + items.length;
92
+ }
93
+ }
94
+ async listItemsPage(collectionId, opts) {
95
+ let url = this.session.baseUrl("api");
96
+ url += "/collections";
97
+ url += '/' + (0, internal_js_1.pathEscape)(collectionId);
98
+ url += "/items";
99
+ let req = this.session.newRequest("GET", url);
100
+ const options = opts ?? {};
101
+ if (options.fields !== undefined) {
102
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
103
+ }
104
+ if (options.offset !== undefined) {
105
+ req = runtime.withQuery(req, "offset", String(options.offset));
106
+ }
107
+ if (options.limit !== undefined) {
108
+ req = runtime.withQuery(req, "limit", String(options.limit));
109
+ }
110
+ const resp = await this.session.fetch(req);
111
+ const data = runtime.responseBytes(resp);
112
+ return JSON.parse(new TextDecoder().decode(data));
113
+ }
114
+ async get(collectionId) {
115
+ let url = this.session.baseUrl("api");
116
+ url += "/collections";
117
+ url += '/' + (0, internal_js_1.pathEscape)(collectionId);
118
+ let req = this.session.newRequest("GET", url);
119
+ const resp = await this.session.fetch(req);
120
+ const data = runtime.responseBytes(resp);
121
+ return JSON.parse(new TextDecoder().decode(data));
122
+ }
123
+ }
124
+ exports.CollectionsManager = CollectionsManager;
@@ -0,0 +1,131 @@
1
+ "use strict";
2
+ // Code generated by box-gantry. DO NOT EDIT.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.CommentsManager = void 0;
38
+ const runtime = __importStar(require("../runtime.js"));
39
+ const internal_js_1 = require("../internal.js");
40
+ /** Operations for the "comments" API area. */
41
+ class CommentsManager {
42
+ session;
43
+ constructor(session) {
44
+ this.session = session;
45
+ }
46
+ /** Iterate every `models.schemas.CommentFull` across pages, threading the offset cursor. */
47
+ async *listFile(fileId, opts) {
48
+ const options = { ...opts };
49
+ for (;;) {
50
+ const page = await this.listFilePage(fileId, options);
51
+ const items = page.entries ?? [];
52
+ for (const item of items) {
53
+ yield item;
54
+ }
55
+ if (items.length === 0) {
56
+ return;
57
+ }
58
+ options.offset = (options.offset ?? 0) + items.length;
59
+ }
60
+ }
61
+ async listFilePage(fileId, opts) {
62
+ let url = this.session.baseUrl("api");
63
+ url += "/files";
64
+ url += '/' + (0, internal_js_1.pathEscape)(fileId);
65
+ url += "/comments";
66
+ let req = this.session.newRequest("GET", url);
67
+ const options = opts ?? {};
68
+ if (options.fields !== undefined) {
69
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
70
+ }
71
+ if (options.limit !== undefined) {
72
+ req = runtime.withQuery(req, "limit", String(options.limit));
73
+ }
74
+ if (options.offset !== undefined) {
75
+ req = runtime.withQuery(req, "offset", String(options.offset));
76
+ }
77
+ const resp = await this.session.fetch(req);
78
+ const data = runtime.responseBytes(resp);
79
+ return JSON.parse(new TextDecoder().decode(data));
80
+ }
81
+ async get(commentId, opts) {
82
+ let url = this.session.baseUrl("api");
83
+ url += "/comments";
84
+ url += '/' + (0, internal_js_1.pathEscape)(commentId);
85
+ let req = this.session.newRequest("GET", url);
86
+ const options = opts ?? {};
87
+ if (options.fields !== undefined) {
88
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
89
+ }
90
+ const resp = await this.session.fetch(req);
91
+ const data = runtime.responseBytes(resp);
92
+ return JSON.parse(new TextDecoder().decode(data));
93
+ }
94
+ async update(commentId, body, opts) {
95
+ let url = this.session.baseUrl("api");
96
+ url += "/comments";
97
+ url += '/' + (0, internal_js_1.pathEscape)(commentId);
98
+ let req = this.session.newRequest("PUT", url);
99
+ const options = opts ?? {};
100
+ if (options.fields !== undefined) {
101
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
102
+ }
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 delete_(commentId) {
110
+ let url = this.session.baseUrl("api");
111
+ url += "/comments";
112
+ url += '/' + (0, internal_js_1.pathEscape)(commentId);
113
+ let req = this.session.newRequest("DELETE", url);
114
+ await this.session.fetch(req);
115
+ }
116
+ async create(body, opts) {
117
+ let url = this.session.baseUrl("api");
118
+ url += "/comments";
119
+ let req = this.session.newRequest("POST", url);
120
+ const options = opts ?? {};
121
+ if (options.fields !== undefined) {
122
+ req = runtime.withQuery(req, "fields", options.fields.join(','));
123
+ }
124
+ const payload = new TextEncoder().encode(JSON.stringify(body));
125
+ req = runtime.withJsonBody(req, payload);
126
+ const resp = await this.session.fetch(req);
127
+ const data = runtime.responseBytes(resp);
128
+ return JSON.parse(new TextDecoder().decode(data));
129
+ }
130
+ }
131
+ exports.CommentsManager = CommentsManager;
@@ -0,0 +1,99 @@
1
+ "use strict";
2
+ // Code generated by box-gantry. DO NOT EDIT.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.DevicePinnersManager = void 0;
38
+ const runtime = __importStar(require("../runtime.js"));
39
+ const internal_js_1 = require("../internal.js");
40
+ /** Operations for the "device_pinners" API area. */
41
+ class DevicePinnersManager {
42
+ session;
43
+ constructor(session) {
44
+ this.session = session;
45
+ }
46
+ async get(devicePinnerId) {
47
+ let url = this.session.baseUrl("api");
48
+ url += "/device_pinners";
49
+ url += '/' + (0, internal_js_1.pathEscape)(devicePinnerId);
50
+ let req = this.session.newRequest("GET", url);
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 delete_(devicePinnerId) {
56
+ let url = this.session.baseUrl("api");
57
+ url += "/device_pinners";
58
+ url += '/' + (0, internal_js_1.pathEscape)(devicePinnerId);
59
+ let req = this.session.newRequest("DELETE", url);
60
+ await this.session.fetch(req);
61
+ }
62
+ /** Iterate every `models.schemas.DevicePinner` across pages, threading the marker cursor. */
63
+ async *listEnterprise(enterpriseId, opts) {
64
+ const options = { ...opts };
65
+ for (;;) {
66
+ const page = await this.listEnterprisePage(enterpriseId, options);
67
+ const items = page.entries ?? [];
68
+ for (const item of items) {
69
+ yield item;
70
+ }
71
+ const cursor = page.next_marker;
72
+ if (cursor === undefined || cursor === null) {
73
+ return;
74
+ }
75
+ options.marker = String(cursor);
76
+ }
77
+ }
78
+ async listEnterprisePage(enterpriseId, opts) {
79
+ let url = this.session.baseUrl("api");
80
+ url += "/enterprises";
81
+ url += '/' + (0, internal_js_1.pathEscape)(enterpriseId);
82
+ url += "/device_pinners";
83
+ let req = this.session.newRequest("GET", url);
84
+ const options = opts ?? {};
85
+ if (options.marker !== undefined) {
86
+ req = runtime.withQuery(req, "marker", options.marker);
87
+ }
88
+ if (options.limit !== undefined) {
89
+ req = runtime.withQuery(req, "limit", String(options.limit));
90
+ }
91
+ if (options.direction !== undefined) {
92
+ req = runtime.withQuery(req, "direction", options.direction);
93
+ }
94
+ const resp = await this.session.fetch(req);
95
+ const data = runtime.responseBytes(resp);
96
+ return JSON.parse(new TextDecoder().decode(data));
97
+ }
98
+ }
99
+ exports.DevicePinnersManager = DevicePinnersManager;
@@ -0,0 +1,133 @@
1
+ "use strict";
2
+ // Code generated by box-gantry. DO NOT EDIT.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.DocgenManager = void 0;
38
+ const runtime = __importStar(require("../runtime.js"));
39
+ const internal_js_1 = require("../internal.js");
40
+ /** Operations for the "docgen" API area. */
41
+ class DocgenManager {
42
+ session;
43
+ constructor(session) {
44
+ this.session = session;
45
+ }
46
+ async getJob(jobId) {
47
+ let url = this.session.baseUrl("api");
48
+ url += "/docgen_jobs";
49
+ url += '/' + (0, internal_js_1.pathEscape)(jobId);
50
+ let req = this.session.newRequest("GET", url);
51
+ req = runtime.withHeader(req, "box-version", "2025.0");
52
+ const resp = await this.session.fetch(req);
53
+ const data = runtime.responseBytes(resp);
54
+ return JSON.parse(new TextDecoder().decode(data));
55
+ }
56
+ /** Iterate every `models.schemas.DocGenJobFull` across pages, threading the marker cursor. */
57
+ async *listJobs(opts) {
58
+ const options = { ...opts };
59
+ for (;;) {
60
+ const page = await this.listJobsPage(options);
61
+ const items = page.entries ?? [];
62
+ for (const item of items) {
63
+ yield item;
64
+ }
65
+ const cursor = page.next_marker;
66
+ if (cursor === undefined || cursor === null || cursor === '') {
67
+ return;
68
+ }
69
+ options.marker = cursor;
70
+ }
71
+ }
72
+ async listJobsPage(opts) {
73
+ let url = this.session.baseUrl("api");
74
+ url += "/docgen_jobs";
75
+ let req = this.session.newRequest("GET", url);
76
+ const options = opts ?? {};
77
+ if (options.marker !== undefined) {
78
+ req = runtime.withQuery(req, "marker", options.marker);
79
+ }
80
+ if (options.limit !== undefined) {
81
+ req = runtime.withQuery(req, "limit", String(options.limit));
82
+ }
83
+ req = runtime.withHeader(req, "box-version", "2025.0");
84
+ const resp = await this.session.fetch(req);
85
+ const data = runtime.responseBytes(resp);
86
+ return JSON.parse(new TextDecoder().decode(data));
87
+ }
88
+ /** Iterate every `models.schemas.DocGenJob` across pages, threading the marker cursor. */
89
+ async *listBatchJob(batchId, opts) {
90
+ const options = { ...opts };
91
+ for (;;) {
92
+ const page = await this.listBatchJobPage(batchId, options);
93
+ const items = page.entries ?? [];
94
+ for (const item of items) {
95
+ yield item;
96
+ }
97
+ const cursor = page.next_marker;
98
+ if (cursor === undefined || cursor === null || cursor === '') {
99
+ return;
100
+ }
101
+ options.marker = cursor;
102
+ }
103
+ }
104
+ async listBatchJobPage(batchId, opts) {
105
+ let url = this.session.baseUrl("api");
106
+ url += "/docgen_batch_jobs";
107
+ url += '/' + (0, internal_js_1.pathEscape)(batchId);
108
+ let req = this.session.newRequest("GET", url);
109
+ const options = opts ?? {};
110
+ if (options.marker !== undefined) {
111
+ req = runtime.withQuery(req, "marker", options.marker);
112
+ }
113
+ if (options.limit !== undefined) {
114
+ req = runtime.withQuery(req, "limit", String(options.limit));
115
+ }
116
+ req = runtime.withHeader(req, "box-version", "2025.0");
117
+ const resp = await this.session.fetch(req);
118
+ const data = runtime.responseBytes(resp);
119
+ return JSON.parse(new TextDecoder().decode(data));
120
+ }
121
+ async createBatches(body) {
122
+ let url = this.session.baseUrl("api");
123
+ url += "/docgen_batches";
124
+ let req = this.session.newRequest("POST", url);
125
+ req = runtime.withHeader(req, "box-version", "2025.0");
126
+ const payload = new TextEncoder().encode(JSON.stringify(body));
127
+ req = runtime.withJsonBody(req, payload);
128
+ const resp = await this.session.fetch(req);
129
+ const data = runtime.responseBytes(resp);
130
+ return JSON.parse(new TextDecoder().decode(data));
131
+ }
132
+ }
133
+ exports.DocgenManager = DocgenManager;
@@ -0,0 +1,178 @@
1
+ "use strict";
2
+ // Code generated by box-gantry. DO NOT EDIT.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.DocgenTemplateManager = void 0;
38
+ const runtime = __importStar(require("../runtime.js"));
39
+ const internal_js_1 = require("../internal.js");
40
+ /** Operations for the "docgen_template" API area. */
41
+ class DocgenTemplateManager {
42
+ session;
43
+ constructor(session) {
44
+ this.session = session;
45
+ }
46
+ /** Iterate every `models.schemas.DocGenTemplate` across pages, threading the marker cursor. */
47
+ async *listDocgenTemplates(opts) {
48
+ const options = { ...opts };
49
+ for (;;) {
50
+ const page = await this.listDocgenTemplatesPage(options);
51
+ const items = page.entries ?? [];
52
+ for (const item of items) {
53
+ yield item;
54
+ }
55
+ const cursor = page.next_marker;
56
+ if (cursor === undefined || cursor === null || cursor === '') {
57
+ return;
58
+ }
59
+ options.marker = cursor;
60
+ }
61
+ }
62
+ async listDocgenTemplatesPage(opts) {
63
+ let url = this.session.baseUrl("api");
64
+ url += "/docgen_templates";
65
+ let req = this.session.newRequest("GET", url);
66
+ const options = opts ?? {};
67
+ if (options.marker !== undefined) {
68
+ req = runtime.withQuery(req, "marker", options.marker);
69
+ }
70
+ if (options.limit !== undefined) {
71
+ req = runtime.withQuery(req, "limit", String(options.limit));
72
+ }
73
+ req = runtime.withHeader(req, "box-version", "2025.0");
74
+ const resp = await this.session.fetch(req);
75
+ const data = runtime.responseBytes(resp);
76
+ return JSON.parse(new TextDecoder().decode(data));
77
+ }
78
+ async createDocgenTemplates(body) {
79
+ let url = this.session.baseUrl("api");
80
+ url += "/docgen_templates";
81
+ let req = this.session.newRequest("POST", url);
82
+ req = runtime.withHeader(req, "box-version", "2025.0");
83
+ const payload = new TextEncoder().encode(JSON.stringify(body));
84
+ req = runtime.withJsonBody(req, payload);
85
+ const resp = await this.session.fetch(req);
86
+ const data = runtime.responseBytes(resp);
87
+ return JSON.parse(new TextDecoder().decode(data));
88
+ }
89
+ async getDocgenTemplate(templateId) {
90
+ let url = this.session.baseUrl("api");
91
+ url += "/docgen_templates";
92
+ url += '/' + (0, internal_js_1.pathEscape)(templateId);
93
+ let req = this.session.newRequest("GET", url);
94
+ req = runtime.withHeader(req, "box-version", "2025.0");
95
+ const resp = await this.session.fetch(req);
96
+ const data = runtime.responseBytes(resp);
97
+ return JSON.parse(new TextDecoder().decode(data));
98
+ }
99
+ async deleteDocgenTemplate(templateId) {
100
+ let url = this.session.baseUrl("api");
101
+ url += "/docgen_templates";
102
+ url += '/' + (0, internal_js_1.pathEscape)(templateId);
103
+ let req = this.session.newRequest("DELETE", url);
104
+ req = runtime.withHeader(req, "box-version", "2025.0");
105
+ await this.session.fetch(req);
106
+ }
107
+ /** Iterate every `models.schemas.DocGenTag` across pages, threading the marker cursor. */
108
+ async *listDocgenTemplateTags(templateId, opts) {
109
+ const options = { ...opts };
110
+ for (;;) {
111
+ const page = await this.listDocgenTemplateTagsPage(templateId, options);
112
+ const items = page.entries ?? [];
113
+ for (const item of items) {
114
+ yield item;
115
+ }
116
+ const cursor = page.next_marker;
117
+ if (cursor === undefined || cursor === null || cursor === '') {
118
+ return;
119
+ }
120
+ options.marker = cursor;
121
+ }
122
+ }
123
+ async listDocgenTemplateTagsPage(templateId, opts) {
124
+ let url = this.session.baseUrl("api");
125
+ url += "/docgen_templates";
126
+ url += '/' + (0, internal_js_1.pathEscape)(templateId);
127
+ url += "/tags";
128
+ let req = this.session.newRequest("GET", url);
129
+ const options = opts ?? {};
130
+ if (options.template_version_id !== undefined) {
131
+ req = runtime.withQuery(req, "template_version_id", options.template_version_id);
132
+ }
133
+ if (options.marker !== undefined) {
134
+ req = runtime.withQuery(req, "marker", options.marker);
135
+ }
136
+ if (options.limit !== undefined) {
137
+ req = runtime.withQuery(req, "limit", String(options.limit));
138
+ }
139
+ req = runtime.withHeader(req, "box-version", "2025.0");
140
+ const resp = await this.session.fetch(req);
141
+ const data = runtime.responseBytes(resp);
142
+ return JSON.parse(new TextDecoder().decode(data));
143
+ }
144
+ /** Iterate every `models.schemas.DocGenJob` across pages, threading the marker cursor. */
145
+ async *listJob(templateId, opts) {
146
+ const options = { ...opts };
147
+ for (;;) {
148
+ const page = await this.listJobPage(templateId, options);
149
+ const items = page.entries ?? [];
150
+ for (const item of items) {
151
+ yield item;
152
+ }
153
+ const cursor = page.next_marker;
154
+ if (cursor === undefined || cursor === null || cursor === '') {
155
+ return;
156
+ }
157
+ options.marker = cursor;
158
+ }
159
+ }
160
+ async listJobPage(templateId, opts) {
161
+ let url = this.session.baseUrl("api");
162
+ url += "/docgen_template_jobs";
163
+ url += '/' + (0, internal_js_1.pathEscape)(templateId);
164
+ let req = this.session.newRequest("GET", url);
165
+ const options = opts ?? {};
166
+ if (options.marker !== undefined) {
167
+ req = runtime.withQuery(req, "marker", options.marker);
168
+ }
169
+ if (options.limit !== undefined) {
170
+ req = runtime.withQuery(req, "limit", String(options.limit));
171
+ }
172
+ req = runtime.withHeader(req, "box-version", "2025.0");
173
+ const resp = await this.session.fetch(req);
174
+ const data = runtime.responseBytes(resp);
175
+ return JSON.parse(new TextDecoder().decode(data));
176
+ }
177
+ }
178
+ exports.DocgenTemplateManager = DocgenTemplateManager;