@unofficialbox/box-open-sdk 0.7.1 → 0.9.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 (188) hide show
  1. package/dist/cjs/buildinfo.js +2 -2
  2. package/dist/cjs/client.js +11 -2
  3. package/dist/cjs/errors.js +3 -2
  4. package/dist/cjs/managers/authorization.js +15 -0
  5. package/dist/cjs/managers/events.js +27 -1
  6. package/dist/cjs/managers/web_links.js +26 -2
  7. package/dist/cjs/models/schemas/ai.js +1 -1
  8. package/dist/cjs/models/schemas/ai_studio.js +1 -1
  9. package/dist/cjs/models/schemas/app_item_associations.js +1 -1
  10. package/dist/cjs/models/schemas/archives.js +1 -1
  11. package/dist/cjs/models/schemas/authorization.js +1 -1
  12. package/dist/cjs/models/schemas/automate_workflows.js +1 -1
  13. package/dist/cjs/models/schemas/avatars.js +1 -1
  14. package/dist/cjs/models/schemas/chunked_uploads.js +1 -1
  15. package/dist/cjs/models/schemas/classifications.js +1 -1
  16. package/dist/cjs/models/schemas/collaboration_allowlist_entries.js +1 -1
  17. package/dist/cjs/models/schemas/collaboration_allowlist_exempt_targets.js +1 -1
  18. package/dist/cjs/models/schemas/collections.js +1 -1
  19. package/dist/cjs/models/schemas/comments.js +1 -1
  20. package/dist/cjs/models/schemas/device_pinners.js +1 -1
  21. package/dist/cjs/models/schemas/docgen.js +1 -1
  22. package/dist/cjs/models/schemas/docgen_template.js +1 -1
  23. package/dist/cjs/models/schemas/document_split.js +1 -1
  24. package/dist/cjs/models/schemas/email_aliases.js +1 -1
  25. package/dist/cjs/models/schemas/enterprise_configurations.js +1 -1
  26. package/dist/cjs/models/schemas/events.js +1 -1
  27. package/dist/cjs/models/schemas/external_users.js +1 -1
  28. package/dist/cjs/models/schemas/file_requests.js +1 -1
  29. package/dist/cjs/models/schemas/file_version_legal_holds.js +1 -1
  30. package/dist/cjs/models/schemas/file_version_retentions.js +1 -1
  31. package/dist/cjs/models/schemas/file_versions.js +1 -1
  32. package/dist/cjs/models/schemas/files.js +1 -1
  33. package/dist/cjs/models/schemas/folder_locks.js +1 -1
  34. package/dist/cjs/models/schemas/folders.js +1 -1
  35. package/dist/cjs/models/schemas/groups.js +1 -1
  36. package/dist/cjs/models/schemas/hub_collaborations.js +1 -1
  37. package/dist/cjs/models/schemas/hub_document.js +1 -1
  38. package/dist/cjs/models/schemas/hub_items.js +1 -1
  39. package/dist/cjs/models/schemas/hubs.js +1 -1
  40. package/dist/cjs/models/schemas/integration_mappings.js +1 -1
  41. package/dist/cjs/models/schemas/invites.js +1 -1
  42. package/dist/cjs/models/schemas/legal_hold_policies.js +1 -1
  43. package/dist/cjs/models/schemas/legal_hold_policy_assignments.js +1 -1
  44. package/dist/cjs/models/schemas/list_collaborations.js +1 -1
  45. package/dist/cjs/models/schemas/memberships.js +1 -1
  46. package/dist/cjs/models/schemas/metadata_cascade_policies.js +1 -1
  47. package/dist/cjs/models/schemas/metadata_taxonomies.js +1 -1
  48. package/dist/cjs/models/schemas/metadata_templates.js +1 -1
  49. package/dist/cjs/models/schemas/notes.js +1 -1
  50. package/dist/cjs/models/schemas/query.js +1 -1
  51. package/dist/cjs/models/schemas/recent_items.js +1 -1
  52. package/dist/cjs/models/schemas/retention_policies.js +1 -1
  53. package/dist/cjs/models/schemas/retention_policy_assignments.js +1 -1
  54. package/dist/cjs/models/schemas/search.js +1 -1
  55. package/dist/cjs/models/schemas/session_termination.js +1 -1
  56. package/dist/cjs/models/schemas/shared_links_folders.js +1 -1
  57. package/dist/cjs/models/schemas/shield_information_barrier_reports.js +1 -1
  58. package/dist/cjs/models/schemas/shield_information_barrier_segment_members.js +1 -1
  59. package/dist/cjs/models/schemas/shield_information_barrier_segment_restrictions.js +1 -1
  60. package/dist/cjs/models/schemas/shield_information_barrier_segments.js +1 -1
  61. package/dist/cjs/models/schemas/shield_information_barriers.js +1 -1
  62. package/dist/cjs/models/schemas/shield_lists.js +1 -1
  63. package/dist/cjs/models/schemas/shuttle.js +1 -1
  64. package/dist/cjs/models/schemas/sign_requests.js +1 -1
  65. package/dist/cjs/models/schemas/sign_templates.js +1 -1
  66. package/dist/cjs/models/schemas/skills.js +1 -1
  67. package/dist/cjs/models/schemas/storage_policies.js +1 -1
  68. package/dist/cjs/models/schemas/storage_policy_assignments.js +1 -1
  69. package/dist/cjs/models/schemas/task_assignments.js +1 -1
  70. package/dist/cjs/models/schemas/tasks.js +1 -1
  71. package/dist/cjs/models/schemas/terms_of_service_user_statuses.js +1 -1
  72. package/dist/cjs/models/schemas/terms_of_services.js +1 -1
  73. package/dist/cjs/models/schemas/transfer.js +1 -1
  74. package/dist/cjs/models/schemas/trashed_files.js +1 -1
  75. package/dist/cjs/models/schemas/trashed_folders.js +1 -1
  76. package/dist/cjs/models/schemas/trashed_items.js +1 -1
  77. package/dist/cjs/models/schemas/trashed_web_links.js +1 -1
  78. package/dist/cjs/models/schemas/uploads.js +1 -1
  79. package/dist/cjs/models/schemas/user_collaborations.js +1 -1
  80. package/dist/cjs/models/schemas/users.js +1 -1
  81. package/dist/cjs/models/schemas/web_links.js +1 -1
  82. package/dist/cjs/models/schemas/webhooks.js +1 -1
  83. package/dist/cjs/models/schemas/workflows.js +1 -1
  84. package/dist/cjs/models/schemas/zip_downloads.js +1 -1
  85. package/dist/cjs/models/schemas.js +1 -1
  86. package/dist/cjs/runtime.js +127 -0
  87. package/dist/cjs/webhooks.js +113 -0
  88. package/dist/esm/buildinfo.js +2 -2
  89. package/dist/esm/client.js +11 -2
  90. package/dist/esm/errors.js +3 -2
  91. package/dist/esm/managers/authorization.js +15 -0
  92. package/dist/esm/managers/events.js +27 -1
  93. package/dist/esm/managers/web_links.js +26 -2
  94. package/dist/esm/models/schemas/ai.js +1 -1
  95. package/dist/esm/models/schemas/ai_studio.js +1 -1
  96. package/dist/esm/models/schemas/app_item_associations.js +1 -1
  97. package/dist/esm/models/schemas/archives.js +1 -1
  98. package/dist/esm/models/schemas/authorization.js +1 -1
  99. package/dist/esm/models/schemas/automate_workflows.js +1 -1
  100. package/dist/esm/models/schemas/avatars.js +1 -1
  101. package/dist/esm/models/schemas/chunked_uploads.js +1 -1
  102. package/dist/esm/models/schemas/classifications.js +1 -1
  103. package/dist/esm/models/schemas/collaboration_allowlist_entries.js +1 -1
  104. package/dist/esm/models/schemas/collaboration_allowlist_exempt_targets.js +1 -1
  105. package/dist/esm/models/schemas/collections.js +1 -1
  106. package/dist/esm/models/schemas/comments.js +1 -1
  107. package/dist/esm/models/schemas/device_pinners.js +1 -1
  108. package/dist/esm/models/schemas/docgen.js +1 -1
  109. package/dist/esm/models/schemas/docgen_template.js +1 -1
  110. package/dist/esm/models/schemas/document_split.js +1 -1
  111. package/dist/esm/models/schemas/email_aliases.js +1 -1
  112. package/dist/esm/models/schemas/enterprise_configurations.js +1 -1
  113. package/dist/esm/models/schemas/events.js +1 -1
  114. package/dist/esm/models/schemas/external_users.js +1 -1
  115. package/dist/esm/models/schemas/file_requests.js +1 -1
  116. package/dist/esm/models/schemas/file_version_legal_holds.js +1 -1
  117. package/dist/esm/models/schemas/file_version_retentions.js +1 -1
  118. package/dist/esm/models/schemas/file_versions.js +1 -1
  119. package/dist/esm/models/schemas/files.js +1 -1
  120. package/dist/esm/models/schemas/folder_locks.js +1 -1
  121. package/dist/esm/models/schemas/folders.js +1 -1
  122. package/dist/esm/models/schemas/groups.js +1 -1
  123. package/dist/esm/models/schemas/hub_collaborations.js +1 -1
  124. package/dist/esm/models/schemas/hub_document.js +1 -1
  125. package/dist/esm/models/schemas/hub_items.js +1 -1
  126. package/dist/esm/models/schemas/hubs.js +1 -1
  127. package/dist/esm/models/schemas/integration_mappings.js +1 -1
  128. package/dist/esm/models/schemas/invites.js +1 -1
  129. package/dist/esm/models/schemas/legal_hold_policies.js +1 -1
  130. package/dist/esm/models/schemas/legal_hold_policy_assignments.js +1 -1
  131. package/dist/esm/models/schemas/list_collaborations.js +1 -1
  132. package/dist/esm/models/schemas/memberships.js +1 -1
  133. package/dist/esm/models/schemas/metadata_cascade_policies.js +1 -1
  134. package/dist/esm/models/schemas/metadata_taxonomies.js +1 -1
  135. package/dist/esm/models/schemas/metadata_templates.js +1 -1
  136. package/dist/esm/models/schemas/notes.js +1 -1
  137. package/dist/esm/models/schemas/query.js +1 -1
  138. package/dist/esm/models/schemas/recent_items.js +1 -1
  139. package/dist/esm/models/schemas/retention_policies.js +1 -1
  140. package/dist/esm/models/schemas/retention_policy_assignments.js +1 -1
  141. package/dist/esm/models/schemas/search.js +1 -1
  142. package/dist/esm/models/schemas/session_termination.js +1 -1
  143. package/dist/esm/models/schemas/shared_links_folders.js +1 -1
  144. package/dist/esm/models/schemas/shield_information_barrier_reports.js +1 -1
  145. package/dist/esm/models/schemas/shield_information_barrier_segment_members.js +1 -1
  146. package/dist/esm/models/schemas/shield_information_barrier_segment_restrictions.js +1 -1
  147. package/dist/esm/models/schemas/shield_information_barrier_segments.js +1 -1
  148. package/dist/esm/models/schemas/shield_information_barriers.js +1 -1
  149. package/dist/esm/models/schemas/shield_lists.js +1 -1
  150. package/dist/esm/models/schemas/shuttle.js +1 -1
  151. package/dist/esm/models/schemas/sign_requests.js +1 -1
  152. package/dist/esm/models/schemas/sign_templates.js +1 -1
  153. package/dist/esm/models/schemas/skills.js +1 -1
  154. package/dist/esm/models/schemas/storage_policies.js +1 -1
  155. package/dist/esm/models/schemas/storage_policy_assignments.js +1 -1
  156. package/dist/esm/models/schemas/task_assignments.js +1 -1
  157. package/dist/esm/models/schemas/tasks.js +1 -1
  158. package/dist/esm/models/schemas/terms_of_service_user_statuses.js +1 -1
  159. package/dist/esm/models/schemas/terms_of_services.js +1 -1
  160. package/dist/esm/models/schemas/transfer.js +1 -1
  161. package/dist/esm/models/schemas/trashed_files.js +1 -1
  162. package/dist/esm/models/schemas/trashed_folders.js +1 -1
  163. package/dist/esm/models/schemas/trashed_items.js +1 -1
  164. package/dist/esm/models/schemas/trashed_web_links.js +1 -1
  165. package/dist/esm/models/schemas/uploads.js +1 -1
  166. package/dist/esm/models/schemas/user_collaborations.js +1 -1
  167. package/dist/esm/models/schemas/users.js +1 -1
  168. package/dist/esm/models/schemas/web_links.js +1 -1
  169. package/dist/esm/models/schemas/webhooks.js +1 -1
  170. package/dist/esm/models/schemas/workflows.js +1 -1
  171. package/dist/esm/models/schemas/zip_downloads.js +1 -1
  172. package/dist/esm/models/schemas.js +1 -1
  173. package/dist/esm/runtime.js +124 -0
  174. package/dist/esm/webhooks.js +109 -0
  175. package/dist/types/buildinfo.d.ts +1 -1
  176. package/dist/types/client.d.ts +9 -3
  177. package/dist/types/managers/authorization.d.ts +6 -0
  178. package/dist/types/managers/events.d.ts +4 -0
  179. package/dist/types/managers/web_links.d.ts +14 -2
  180. package/dist/types/runtime.d.ts +41 -0
  181. package/dist/types/webhooks.d.ts +24 -0
  182. package/docs/README.md +1 -0
  183. package/docs/auth.md +35 -8
  184. package/docs/errors.md +2 -2
  185. package/docs/managers/web_links.md +3 -0
  186. package/docs/pagination.md +17 -1
  187. package/docs/webhooks.md +34 -0
  188. package/package.json +1 -1
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,4 +1,4 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 21e020ceb5dcf964) for Box API 2024.0. DO NOT EDIT.
2
2
  export * from './schemas/ai.js';
3
3
  export * from './schemas/ai_studio.js';
4
4
  export * from './schemas/app_item_associations.js';
@@ -2,6 +2,7 @@
2
2
  import { BoxApiError, apiErrorFromResponse } from './errors.js';
3
3
  export { BoxApiError, isPreconditionFailed } from './errors.js';
4
4
  export * from './auth.js';
5
+ export * from './webhooks.js';
5
6
  /** The default base URLs for the D-106 URL classes. */
6
7
  const DEFAULT_BASE_URLS = {
7
8
  api: 'https://api.box.com/2.0',
@@ -68,6 +69,20 @@ export class Client {
68
69
  this.fetchImpl = options.fetch ?? fetch;
69
70
  this.defaultHeaders = { ...(options.headers ?? {}) };
70
71
  }
72
+ /** A new client that sends `As-User: userId` with every API request, so Box
73
+ * acts as that user (an admin, or a service account whose app may "make API
74
+ * calls using the as-user header"). It shares this client's auth flow and
75
+ * token cache, `fetch`, base URLs, and retry policy; this client is
76
+ * unchanged. Token requests never carry the header. */
77
+ withAsUserHeader(userId) {
78
+ const headers = Object.fromEntries(Object.entries(this.defaultHeaders).filter(([name]) => name.toLowerCase() !== 'as-user'));
79
+ return new Client(this.auth, {
80
+ maxRetries: this.maxRetries,
81
+ baseUrls: this.baseUrls,
82
+ fetch: this.fetchImpl,
83
+ headers: { ...headers, 'As-User': userId },
84
+ });
85
+ }
71
86
  /** The configured base URL for a D-106 class, without a trailing slash. */
72
87
  baseUrl(name) {
73
88
  return this.baseUrls[name] ?? '';
@@ -284,3 +299,112 @@ export function responseHeader(response, name) {
284
299
  export function statusCode(response) {
285
300
  return response.status;
286
301
  }
302
+ const DEFAULT_LONG_POLL_RETRIES = 10;
303
+ const DEFAULT_LONG_POLL_TIMEOUT_SECONDS = 610;
304
+ /** Box may deliver an event twice; this many recent event ids are kept to drop
305
+ * the repeats (the bound Box's own SDKs use). */
306
+ const MAX_SEEN_EVENTS = 1000;
307
+ /**
308
+ * Follow Box's long-poll protocol from `position` (`'now'` for events from
309
+ * here on): yield the events after it, each once, then wait on a real-time
310
+ * server until Box reports a change and yield those. A `reconnect` answer, or
311
+ * exhausting the server's retries, lists a fresh server. A long poll that times
312
+ * out or fails in transit is retried; an error response from Box ends the
313
+ * stream by throwing it, and aborting `signal` throws the abort.
314
+ */
315
+ export async function* eventStream(client, position, source, signal) {
316
+ let seen = new Set();
317
+ let server;
318
+ let retries = 0;
319
+ for (;;) {
320
+ const { events, next } = await source.page(position);
321
+ for (const event of events) {
322
+ const id = source.id(event);
323
+ if (id !== undefined) {
324
+ if (seen.has(id)) {
325
+ continue;
326
+ }
327
+ seen.add(id);
328
+ }
329
+ yield event;
330
+ }
331
+ if (seen.size >= MAX_SEEN_EVENTS) {
332
+ // Repeats arrive close together: keep only this page's ids.
333
+ seen = new Set();
334
+ for (const event of events) {
335
+ const id = source.id(event);
336
+ if (id !== undefined) {
337
+ seen.add(id);
338
+ }
339
+ }
340
+ }
341
+ if (next !== undefined && next !== '') {
342
+ position = next;
343
+ }
344
+ // Wait for Box to report a change after `position`.
345
+ for (let changed = false; !changed;) {
346
+ if (server === undefined || retries >= server.maxRetries) {
347
+ const listed = await source.server();
348
+ server = {
349
+ url: listed.url,
350
+ maxRetries: positiveOr(listed.maxRetries, DEFAULT_LONG_POLL_RETRIES),
351
+ retryTimeoutSeconds: positiveOr(listed.retryTimeoutSeconds, DEFAULT_LONG_POLL_TIMEOUT_SECONDS),
352
+ };
353
+ retries = 0;
354
+ }
355
+ retries++;
356
+ let message;
357
+ try {
358
+ message = await longPoll(client, server, position, signal);
359
+ }
360
+ catch (err) {
361
+ if (signal?.aborted || (err instanceof BoxApiError && err.status !== undefined)) {
362
+ throw err;
363
+ }
364
+ // Timed out or failed in transit: poll again.
365
+ continue;
366
+ }
367
+ if (message === 'new_change') {
368
+ changed = true;
369
+ }
370
+ else if (message === 'reconnect' || message === 'max_retries') {
371
+ server = undefined;
372
+ }
373
+ }
374
+ }
375
+ }
376
+ function positiveOr(value, fallback) {
377
+ return value !== undefined && value > 0 ? value : fallback;
378
+ }
379
+ /** Wait on a real-time server for Box's next message about the stream after
380
+ * `position`: `new_change`, `reconnect`, or `max_retries`. */
381
+ async function longPoll(client, server, position, signal) {
382
+ const separator = server.url.includes('?') ? '&' : '?';
383
+ const url = `${server.url}${separator}stream_position=${encodeURIComponent(position)}`;
384
+ const timeout = AbortSignal.timeout(server.retryTimeoutSeconds * 1000);
385
+ const response = await client.fetch(client.newRequest('GET', url), signal === undefined ? timeout : AbortSignal.any([signal, timeout]));
386
+ const answer = JSON.parse(new TextDecoder().decode(response.bodyBytes));
387
+ if (typeof answer === 'object' && answer !== null && 'message' in answer) {
388
+ return typeof answer.message === 'string' ? answer.message : undefined;
389
+ }
390
+ return undefined;
391
+ }
392
+ /** A stream position Box sent as a JSON string or number, as the string to
393
+ * send back. */
394
+ export function streamPosition(value) {
395
+ if (typeof value === 'string') {
396
+ return value;
397
+ }
398
+ return typeof value === 'number' || typeof value === 'bigint' ? String(value) : undefined;
399
+ }
400
+ /** `JSON.parse`, except an integer too large for a `number` keeps its exact
401
+ * digits as a string — a stream position must round-trip unchanged. */
402
+ export function parseJsonExact(text) {
403
+ const reviver = (_key, value, context) => typeof value === 'number' &&
404
+ !Number.isSafeInteger(value) &&
405
+ context?.source !== undefined &&
406
+ /^-?\d+$/.test(context.source)
407
+ ? context.source
408
+ : value;
409
+ return JSON.parse(text, reviver);
410
+ }
@@ -0,0 +1,109 @@
1
+ // Code generated by box-gantry (vendored from runtimes/typescript/gantryruntime/src/webhooks.ts). DO NOT EDIT.
2
+ // Box webhook signature verification (Box's v2 scheme). Each
3
+ // `BOX-SIGNATURE-*` header of a delivery is the base64 HMAC-SHA256, under that
4
+ // signature key, of the body followed by the `BOX-DELIVERY-TIMESTAMP` header.
5
+ // Built on WebCrypto (`crypto.subtle`), so it runs in Node and browsers alike
6
+ // and needs no `node:crypto`; `subtle.verify` compares in constant time.
7
+ /** How old a delivery may be, in seconds, before it's rejected as a possible
8
+ * replay: Box's ten minutes. */
9
+ export const DEFAULT_WEBHOOK_MAX_AGE_SECONDS = 600;
10
+ /**
11
+ * Whether `body` and `headers` are a genuine, recent delivery from Box. Pass
12
+ * the body exactly as received; header names match in any case. Resolves
13
+ * `false` for an unknown signature version or algorithm, a delivery older than
14
+ * the maximum age or timestamped in the future, and a signature no configured
15
+ * key produces.
16
+ */
17
+ export async function verifyWebhook(body, headers, keys) {
18
+ const header = (name) => {
19
+ if (headers instanceof Headers) {
20
+ return headers.get(name) ?? undefined;
21
+ }
22
+ for (const [key, value] of Object.entries(headers)) {
23
+ if (key.toLowerCase() === name) {
24
+ return value;
25
+ }
26
+ }
27
+ return undefined;
28
+ };
29
+ if (header('box-signature-version') !== '1' || header('box-signature-algorithm') !== 'HmacSHA256') {
30
+ return false;
31
+ }
32
+ const timestamp = header('box-delivery-timestamp');
33
+ const sentMs = timestamp === undefined ? NaN : Date.parse(timestamp);
34
+ if (Number.isNaN(sentMs)) {
35
+ return false;
36
+ }
37
+ // Whole seconds, as Box's own SDKs compare them.
38
+ const sent = Math.floor(sentMs / 1000);
39
+ const at = Math.floor((keys.now ?? new Date()).getTime() / 1000);
40
+ if (sent > at || at - sent > (keys.maxAgeSeconds ?? DEFAULT_WEBHOOK_MAX_AGE_SECONDS)) {
41
+ return false;
42
+ }
43
+ const encoder = new TextEncoder();
44
+ const raw = typeof body === 'string' ? encoder.encode(body) : Uint8Array.from(body);
45
+ const bodies = [raw];
46
+ const escaped = escapeNonAscii(raw);
47
+ if (escaped !== undefined) {
48
+ bodies.push(encoder.encode(escaped));
49
+ }
50
+ const stamp = encoder.encode(timestamp);
51
+ const signed = [
52
+ [keys.primaryKey, 'box-signature-primary'],
53
+ [keys.secondaryKey, 'box-signature-secondary'],
54
+ ];
55
+ for (const [key, name] of signed) {
56
+ const received = decodeBase64(header(name));
57
+ if (key === undefined || key === '' || received === undefined) {
58
+ continue;
59
+ }
60
+ const hmac = await crypto.subtle.importKey('raw', encoder.encode(key), { name: 'HMAC', hash: 'SHA-256' }, false, ['verify']);
61
+ for (const candidate of bodies) {
62
+ const message = new Uint8Array(candidate.length + stamp.length);
63
+ message.set(candidate);
64
+ message.set(stamp, candidate.length);
65
+ if (await crypto.subtle.verify('HMAC', hmac, received, message)) {
66
+ return true;
67
+ }
68
+ }
69
+ }
70
+ return false;
71
+ }
72
+ /** Standard base64 to bytes; `undefined` when absent, empty, or malformed. */
73
+ function decodeBase64(value) {
74
+ if (value === undefined || value === '') {
75
+ return undefined;
76
+ }
77
+ try {
78
+ return Uint8Array.from(atob(value), (c) => c.charCodeAt(0));
79
+ }
80
+ catch {
81
+ return undefined;
82
+ }
83
+ }
84
+ /** `body` with every character from U+007F up written as a JSON `\uXXXX`
85
+ * escape (UTF-16, lowercase hex) — the form Box signs. A body re-encoded as
86
+ * raw UTF-8 on its way to the caller verifies through it. `undefined` when
87
+ * `body` is already all ASCII, or is not UTF-8. */
88
+ function escapeNonAscii(body) {
89
+ let text;
90
+ try {
91
+ text = new TextDecoder('utf-8', { fatal: true }).decode(body);
92
+ }
93
+ catch {
94
+ return undefined;
95
+ }
96
+ let out = '';
97
+ let escaped = false;
98
+ for (let i = 0; i < text.length; i++) {
99
+ const unit = text.charCodeAt(i);
100
+ if (unit < 0x7f) {
101
+ out += text[i];
102
+ }
103
+ else {
104
+ escaped = true;
105
+ out += `\\u${unit.toString(16).padStart(4, '0')}`;
106
+ }
107
+ }
108
+ return escaped ? out : undefined;
109
+ }
@@ -1,6 +1,6 @@
1
1
  /** The box-gantry engine version that generated this SDK. */
2
2
  export declare const ENGINE = "0.1.0";
3
3
  /** Fingerprint of the input spec set. */
4
- export declare const SPEC_FINGERPRINT = "3283827dcf199770";
4
+ export declare const SPEC_FINGERPRINT = "21e020ceb5dcf964";
5
5
  /** The target language key (FR-4). */
6
6
  export declare const TARGET = "typescript";
@@ -1,4 +1,4 @@
1
- import { Auth, ClientOptions } from './runtime.js';
1
+ import { Auth, Client as Session, ClientOptions } from './runtime.js';
2
2
  import { AiManager } from './managers/ai.js';
3
3
  import { AiStudioManager } from './managers/ai_studio.js';
4
4
  import { AppItemAssociationsManager } from './managers/app_item_associations.js';
@@ -89,6 +89,7 @@ import { WorkflowsManager } from './managers/workflows.js';
89
89
  import { ZipDownloadsManager } from './managers/zip_downloads.js';
90
90
  /** The Box SDK client: one manager per API area over a shared session. */
91
91
  export declare class Client {
92
+ #private;
92
93
  readonly ai: AiManager;
93
94
  readonly aiStudio: AiStudioManager;
94
95
  readonly appItemAssociations: AppItemAssociationsManager;
@@ -178,6 +179,11 @@ export declare class Client {
178
179
  readonly workflows: WorkflowsManager;
179
180
  readonly zipDownloads: ZipDownloadsManager;
180
181
  /** Build a client for an authentication flow; `options` configures the
181
- * runtime session (retries, `fetch`, default headers, base URLs). */
182
- constructor(auth: Auth, options?: ClientOptions);
182
+ * runtime session (retries, `fetch`, default headers, base URLs). An
183
+ * already configured runtime session is used as is. */
184
+ constructor(auth: Auth | Session, options?: ClientOptions);
185
+ /** A new client whose every API call acts as the user `userId` (Box's
186
+ * `As-User` header). It shares this client's auth and configuration;
187
+ * this client is unchanged. */
188
+ withAsUserHeader(userId: string): Client;
183
189
  }
@@ -14,4 +14,10 @@ export declare class AuthorizationManager {
14
14
  createOauth2Token(body: models.schemas.PostOAuth2Token): Promise<models.schemas.AccessToken>;
15
15
  createOauth2TokenRefresh(body: models.schemas.PostOAuth2TokenRefreshAccessToken): Promise<models.schemas.AccessToken>;
16
16
  revokeOauth2(body: models.schemas.PostOAuth2Revoke): Promise<void>;
17
+ /** Exchange the session's current access token for one limited to `scopes`
18
+ * and, when given, to one item (`resource`: its API URL, e.g.
19
+ * `https://api.box.com/2.0/files/123`) or a shared link. The result is a plain
20
+ * access token with no refresh token: build a client from it with
21
+ * `auth.developerToken`. */
22
+ downscopeToken(scopes: readonly string[], resource?: string, sharedLink?: string): Promise<models.schemas.AccessToken>;
17
23
  }
@@ -15,4 +15,8 @@ export declare class EventsManager {
15
15
  constructor(session: runtime.Client);
16
16
  list(opts?: EventsManagerListOptions): Promise<models.schemas.Events>;
17
17
  options(): Promise<models.schemas.RealtimeServers>;
18
+ /** Box's long-poll event stream from `opts.stream_position` (`'now'` when
19
+ * unset): yields each event once, then waits on a real-time server for the
20
+ * next change. It rejects when a call fails; aborting `signal` stops it. */
21
+ stream(opts?: EventsManagerListOptions, signal?: AbortSignal): AsyncGenerator<models.schemas.Event, void, undefined>;
18
22
  }