box-node-sdk 3.8.0 → 3.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (449) hide show
  1. package/README.md +89 -69
  2. package/config/package.schema.json +42 -42
  3. package/lib/api-request-manager.d.ts +0 -2
  4. package/lib/api-request-manager.js.map +1 -1
  5. package/lib/api-request.d.ts +0 -3
  6. package/lib/api-request.js.map +1 -1
  7. package/lib/box-client.d.ts +7 -7
  8. package/lib/box-client.js +6 -3
  9. package/lib/box-client.js.map +1 -1
  10. package/lib/box-node-sdk.d.ts +1 -3
  11. package/lib/box-node-sdk.js +26 -10
  12. package/lib/box-node-sdk.js.map +1 -1
  13. package/lib/chunked-uploader.d.ts +0 -5
  14. package/lib/chunked-uploader.js.map +1 -1
  15. package/lib/enterprise-event-stream.d.ts +0 -1
  16. package/lib/enterprise-event-stream.js +3 -3
  17. package/lib/enterprise-event-stream.js.map +1 -1
  18. package/lib/event-stream.d.ts +0 -2
  19. package/lib/event-stream.js.map +1 -1
  20. package/lib/managers/ai.generated.js.map +1 -1
  21. package/lib/managers/collaboration-allowlist.js.map +1 -1
  22. package/lib/managers/collaborations.d.ts +3 -3
  23. package/lib/managers/collaborations.js +23 -23
  24. package/lib/managers/collaborations.js.map +1 -1
  25. package/lib/managers/collections.js.map +1 -1
  26. package/lib/managers/comments.js.map +1 -1
  27. package/lib/managers/device-pins.js.map +1 -1
  28. package/lib/managers/enterprise.js.map +1 -1
  29. package/lib/managers/events.d.ts +0 -1
  30. package/lib/managers/events.js +3 -1
  31. package/lib/managers/events.js.map +1 -1
  32. package/lib/managers/file-requests-manager.d.ts +2 -2
  33. package/lib/managers/file-requests-manager.js +1 -1
  34. package/lib/managers/file-requests-manager.js.map +1 -1
  35. package/lib/managers/files.d.ts +1 -4
  36. package/lib/managers/files.js +6 -2
  37. package/lib/managers/files.js.map +1 -1
  38. package/lib/managers/folders.d.ts +1 -1
  39. package/lib/managers/folders.js +3 -1
  40. package/lib/managers/folders.js.map +1 -1
  41. package/lib/managers/groups.js +2 -2
  42. package/lib/managers/groups.js.map +1 -1
  43. package/lib/managers/integration-mappings.js.map +1 -1
  44. package/lib/managers/legal-hold-policies.js.map +1 -1
  45. package/lib/managers/metadata.js.map +1 -1
  46. package/lib/managers/recent-items.js.map +1 -1
  47. package/lib/managers/retention-policies.d.ts +1 -1
  48. package/lib/managers/retention-policies.js.map +1 -1
  49. package/lib/managers/search.d.ts +1 -1
  50. package/lib/managers/search.js.map +1 -1
  51. package/lib/managers/shared-items.js.map +1 -1
  52. package/lib/managers/shield-information-barrier-reports.generated.js.map +1 -1
  53. package/lib/managers/shield-information-barrier-segment-members.generated.js.map +1 -1
  54. package/lib/managers/shield-information-barrier-segment-restrictions.generated.js.map +1 -1
  55. package/lib/managers/shield-information-barrier-segments.generated.js.map +1 -1
  56. package/lib/managers/shield-information-barriers.generated.js.map +1 -1
  57. package/lib/managers/sign-requests.generated.js.map +1 -1
  58. package/lib/managers/sign-templates.generated.js.map +1 -1
  59. package/lib/managers/storage-policies.js.map +1 -1
  60. package/lib/managers/tasks.js.map +1 -1
  61. package/lib/managers/terms-of-service.js.map +1 -1
  62. package/lib/managers/trash.js.map +1 -1
  63. package/lib/managers/users.d.ts +0 -3
  64. package/lib/managers/users.js +1 -1
  65. package/lib/managers/users.js.map +1 -1
  66. package/lib/managers/web-links.js +3 -1
  67. package/lib/managers/web-links.js.map +1 -1
  68. package/lib/managers/webhooks.d.ts +11 -11
  69. package/lib/managers/webhooks.js +24 -14
  70. package/lib/managers/webhooks.js.map +1 -1
  71. package/lib/schemas/collaboration-update.d.ts +1 -1
  72. package/lib/schemas/collaboration.d.ts +3 -3
  73. package/lib/schemas/collaborations.d.ts +1 -1
  74. package/lib/schemas/file-request.d.ts +2 -2
  75. package/lib/sessions/app-auth-session.js.map +1 -1
  76. package/lib/sessions/basic-session.d.ts +0 -1
  77. package/lib/sessions/basic-session.js.map +1 -1
  78. package/lib/sessions/ccg-session.js.map +1 -1
  79. package/lib/sessions/persistent-session.js.map +1 -1
  80. package/lib/token-manager.js +4 -2
  81. package/lib/token-manager.js.map +1 -1
  82. package/lib/util/config.d.ts +0 -2
  83. package/lib/util/config.js +18 -8
  84. package/lib/util/config.js.map +1 -1
  85. package/lib/util/errors.js +17 -7
  86. package/lib/util/errors.js.map +1 -1
  87. package/lib/util/exponential-backoff.js.map +1 -1
  88. package/lib/util/paging-iterator.js +17 -7
  89. package/lib/util/paging-iterator.js.map +1 -1
  90. package/lib/util/serializable.js.map +1 -1
  91. package/lib/util/url-path.js.map +1 -1
  92. package/lib-esm/api-request-manager.d.ts +36 -0
  93. package/lib-esm/api-request-manager.js +78 -0
  94. package/lib-esm/api-request-manager.js.map +1 -0
  95. package/lib-esm/api-request.d.ts +135 -0
  96. package/lib-esm/api-request.js +282 -0
  97. package/lib-esm/api-request.js.map +1 -0
  98. package/lib-esm/box-client.d.ts +274 -0
  99. package/lib-esm/box-client.js +594 -0
  100. package/lib-esm/box-client.js.map +1 -0
  101. package/lib-esm/box-node-sdk.d.ts +227 -0
  102. package/lib-esm/box-node-sdk.js +373 -0
  103. package/lib-esm/box-node-sdk.js.map +1 -0
  104. package/lib-esm/chunked-uploader.d.ts +128 -0
  105. package/lib-esm/chunked-uploader.js +276 -0
  106. package/lib-esm/chunked-uploader.js.map +1 -0
  107. package/lib-esm/enterprise-event-stream.d.ts +82 -0
  108. package/lib-esm/enterprise-event-stream.js +205 -0
  109. package/lib-esm/enterprise-event-stream.js.map +1 -0
  110. package/lib-esm/event-stream.d.ts +91 -0
  111. package/lib-esm/event-stream.js +277 -0
  112. package/lib-esm/event-stream.js.map +1 -0
  113. package/lib-esm/managers/ai.generated.d.ts +58 -0
  114. package/lib-esm/managers/ai.generated.js +66 -0
  115. package/lib-esm/managers/ai.generated.js.map +1 -0
  116. package/lib-esm/managers/collaboration-allowlist.d.ts +133 -0
  117. package/lib-esm/managers/collaboration-allowlist.js +194 -0
  118. package/lib-esm/managers/collaboration-allowlist.js.map +1 -0
  119. package/lib-esm/managers/collaborations.d.ts +173 -0
  120. package/lib-esm/managers/collaborations.js +252 -0
  121. package/lib-esm/managers/collaborations.js.map +1 -0
  122. package/lib-esm/managers/collections.d.ts +42 -0
  123. package/lib-esm/managers/collections.js +62 -0
  124. package/lib-esm/managers/collections.js.map +1 -0
  125. package/lib-esm/managers/comments.d.ts +103 -0
  126. package/lib-esm/managers/comments.js +175 -0
  127. package/lib-esm/managers/comments.js.map +1 -0
  128. package/lib-esm/managers/device-pins.d.ts +52 -0
  129. package/lib-esm/managers/device-pins.js +91 -0
  130. package/lib-esm/managers/device-pins.js.map +1 -0
  131. package/lib-esm/managers/enterprise.d.ts +164 -0
  132. package/lib-esm/managers/enterprise.js +193 -0
  133. package/lib-esm/managers/enterprise.js.map +1 -0
  134. package/lib-esm/managers/events.d.ts +222 -0
  135. package/lib-esm/managers/events.js +295 -0
  136. package/lib-esm/managers/events.js.map +1 -0
  137. package/lib-esm/managers/file-requests-manager.d.ts +56 -0
  138. package/lib-esm/managers/file-requests-manager.js +81 -0
  139. package/lib-esm/managers/file-requests-manager.js.map +1 -0
  140. package/lib-esm/managers/files.d.ts +817 -0
  141. package/lib-esm/managers/files.js +1408 -0
  142. package/lib-esm/managers/files.js.map +1 -0
  143. package/lib-esm/managers/folders.d.ts +396 -0
  144. package/lib-esm/managers/folders.js +570 -0
  145. package/lib-esm/managers/folders.js.map +1 -0
  146. package/lib-esm/managers/groups.d.ts +213 -0
  147. package/lib-esm/managers/groups.js +289 -0
  148. package/lib-esm/managers/groups.js.map +1 -0
  149. package/lib-esm/managers/integration-mappings.d.ts +116 -0
  150. package/lib-esm/managers/integration-mappings.js +101 -0
  151. package/lib-esm/managers/integration-mappings.js.map +1 -0
  152. package/lib-esm/managers/legal-hold-policies.d.ts +190 -0
  153. package/lib-esm/managers/legal-hold-policies.js +254 -0
  154. package/lib-esm/managers/legal-hold-policies.js.map +1 -0
  155. package/lib-esm/managers/metadata.d.ts +232 -0
  156. package/lib-esm/managers/metadata.js +288 -0
  157. package/lib-esm/managers/metadata.js.map +1 -0
  158. package/lib-esm/managers/recent-items.d.ts +38 -0
  159. package/lib-esm/managers/recent-items.js +49 -0
  160. package/lib-esm/managers/recent-items.js.map +1 -0
  161. package/lib-esm/managers/retention-policies.d.ts +308 -0
  162. package/lib-esm/managers/retention-policies.js +374 -0
  163. package/lib-esm/managers/retention-policies.js.map +1 -0
  164. package/lib-esm/managers/search.d.ts +82 -0
  165. package/lib-esm/managers/search.js +90 -0
  166. package/lib-esm/managers/search.js.map +1 -0
  167. package/lib-esm/managers/shared-items.d.ts +33 -0
  168. package/lib-esm/managers/shared-items.js +74 -0
  169. package/lib-esm/managers/shared-items.js.map +1 -0
  170. package/lib-esm/managers/shield-information-barrier-reports.generated.d.ts +65 -0
  171. package/lib-esm/managers/shield-information-barrier-reports.generated.js +65 -0
  172. package/lib-esm/managers/shield-information-barrier-reports.generated.js.map +1 -0
  173. package/lib-esm/managers/shield-information-barrier-segment-members.generated.d.ts +83 -0
  174. package/lib-esm/managers/shield-information-barrier-segment-members.generated.js +83 -0
  175. package/lib-esm/managers/shield-information-barrier-segment-members.generated.js.map +1 -0
  176. package/lib-esm/managers/shield-information-barrier-segment-restrictions.generated.d.ts +84 -0
  177. package/lib-esm/managers/shield-information-barrier-segment-restrictions.generated.js +84 -0
  178. package/lib-esm/managers/shield-information-barrier-segment-restrictions.generated.js.map +1 -0
  179. package/lib-esm/managers/shield-information-barrier-segments.generated.d.ts +98 -0
  180. package/lib-esm/managers/shield-information-barrier-segments.generated.js +99 -0
  181. package/lib-esm/managers/shield-information-barrier-segments.generated.js.map +1 -0
  182. package/lib-esm/managers/shield-information-barriers.generated.d.ts +79 -0
  183. package/lib-esm/managers/shield-information-barriers.generated.js +83 -0
  184. package/lib-esm/managers/shield-information-barriers.generated.js.map +1 -0
  185. package/lib-esm/managers/sign-requests.generated.d.ts +93 -0
  186. package/lib-esm/managers/sign-requests.generated.js +97 -0
  187. package/lib-esm/managers/sign-requests.generated.js.map +1 -0
  188. package/lib-esm/managers/sign-templates.generated.d.ts +51 -0
  189. package/lib-esm/managers/sign-templates.generated.js +49 -0
  190. package/lib-esm/managers/sign-templates.generated.js.map +1 -0
  191. package/lib-esm/managers/storage-policies.d.ts +86 -0
  192. package/lib-esm/managers/storage-policies.js +174 -0
  193. package/lib-esm/managers/storage-policies.js.map +1 -0
  194. package/lib-esm/managers/tasks.d.ts +161 -0
  195. package/lib-esm/managers/tasks.js +243 -0
  196. package/lib-esm/managers/tasks.js.map +1 -0
  197. package/lib-esm/managers/terms-of-service.d.ts +161 -0
  198. package/lib-esm/managers/terms-of-service.js +283 -0
  199. package/lib-esm/managers/terms-of-service.js.map +1 -0
  200. package/lib-esm/managers/trash.d.ts +30 -0
  201. package/lib-esm/managers/trash.js +47 -0
  202. package/lib-esm/managers/trash.js.map +1 -0
  203. package/lib-esm/managers/users.d.ts +171 -0
  204. package/lib-esm/managers/users.js +230 -0
  205. package/lib-esm/managers/users.js.map +1 -0
  206. package/lib-esm/managers/web-links.d.ts +127 -0
  207. package/lib-esm/managers/web-links.js +200 -0
  208. package/lib-esm/managers/web-links.js.map +1 -0
  209. package/lib-esm/managers/webhooks.d.ts +169 -0
  210. package/lib-esm/managers/webhooks.js +398 -0
  211. package/lib-esm/managers/webhooks.js.map +1 -0
  212. package/lib-esm/schemas/ai-agent-ask.generated.d.ts +17 -0
  213. package/lib-esm/schemas/ai-agent-ask.generated.js +3 -0
  214. package/lib-esm/schemas/ai-agent-ask.generated.js.map +1 -0
  215. package/lib-esm/schemas/ai-agent-basic-gen-tool.generated.d.ts +14 -0
  216. package/lib-esm/schemas/ai-agent-basic-gen-tool.generated.js +3 -0
  217. package/lib-esm/schemas/ai-agent-basic-gen-tool.generated.js.map +1 -0
  218. package/lib-esm/schemas/ai-agent-basic-text-tool-ask.generated.d.ts +34 -0
  219. package/lib-esm/schemas/ai-agent-basic-text-tool-ask.generated.js +3 -0
  220. package/lib-esm/schemas/ai-agent-basic-text-tool-ask.generated.js.map +1 -0
  221. package/lib-esm/schemas/ai-agent-basic-text-tool-text-gen.generated.d.ts +36 -0
  222. package/lib-esm/schemas/ai-agent-basic-text-tool-text-gen.generated.js +3 -0
  223. package/lib-esm/schemas/ai-agent-basic-text-tool-text-gen.generated.js.map +1 -0
  224. package/lib-esm/schemas/ai-agent-long-text-tool.generated.d.ts +9 -0
  225. package/lib-esm/schemas/ai-agent-long-text-tool.generated.js +3 -0
  226. package/lib-esm/schemas/ai-agent-long-text-tool.generated.js.map +1 -0
  227. package/lib-esm/schemas/ai-agent-text-gen.generated.d.ts +14 -0
  228. package/lib-esm/schemas/ai-agent-text-gen.generated.js +3 -0
  229. package/lib-esm/schemas/ai-agent-text-gen.generated.js.map +1 -0
  230. package/lib-esm/schemas/ai-ask.generated.d.ts +40 -0
  231. package/lib-esm/schemas/ai-ask.generated.js +3 -0
  232. package/lib-esm/schemas/ai-ask.generated.js.map +1 -0
  233. package/lib-esm/schemas/ai-citation.generated.d.ts +27 -0
  234. package/lib-esm/schemas/ai-citation.generated.js +3 -0
  235. package/lib-esm/schemas/ai-citation.generated.js.map +1 -0
  236. package/lib-esm/schemas/ai-dialogue-history.generated.d.ts +22 -0
  237. package/lib-esm/schemas/ai-dialogue-history.generated.js +3 -0
  238. package/lib-esm/schemas/ai-dialogue-history.generated.js.map +1 -0
  239. package/lib-esm/schemas/ai-llm-endpoint-params-google.generated.d.ts +31 -0
  240. package/lib-esm/schemas/ai-llm-endpoint-params-google.generated.js +3 -0
  241. package/lib-esm/schemas/ai-llm-endpoint-params-google.generated.js.map +1 -0
  242. package/lib-esm/schemas/ai-llm-endpoint-params-open-ai.generated.d.ts +43 -0
  243. package/lib-esm/schemas/ai-llm-endpoint-params-open-ai.generated.js +3 -0
  244. package/lib-esm/schemas/ai-llm-endpoint-params-open-ai.generated.js.map +1 -0
  245. package/lib-esm/schemas/ai-response-full.generated.d.ts +12 -0
  246. package/lib-esm/schemas/ai-response-full.generated.js +3 -0
  247. package/lib-esm/schemas/ai-response-full.generated.js.map +1 -0
  248. package/lib-esm/schemas/ai-response.generated.d.ts +22 -0
  249. package/lib-esm/schemas/ai-response.generated.js +3 -0
  250. package/lib-esm/schemas/ai-response.generated.js.map +1 -0
  251. package/lib-esm/schemas/ai-text-gen.generated.d.ts +30 -0
  252. package/lib-esm/schemas/ai-text-gen.generated.js +3 -0
  253. package/lib-esm/schemas/ai-text-gen.generated.js.map +1 -0
  254. package/lib-esm/schemas/collaboration-create.d.ts +5 -0
  255. package/lib-esm/schemas/collaboration-create.js +3 -0
  256. package/lib-esm/schemas/collaboration-create.js.map +1 -0
  257. package/lib-esm/schemas/collaboration-update.d.ts +7 -0
  258. package/lib-esm/schemas/collaboration-update.js +3 -0
  259. package/lib-esm/schemas/collaboration-update.js.map +1 -0
  260. package/lib-esm/schemas/collaboration.d.ts +108 -0
  261. package/lib-esm/schemas/collaboration.js +3 -0
  262. package/lib-esm/schemas/collaboration.js.map +1 -0
  263. package/lib-esm/schemas/collaborations.d.ts +13 -0
  264. package/lib-esm/schemas/collaborations.js +3 -0
  265. package/lib-esm/schemas/collaborations.js.map +1 -0
  266. package/lib-esm/schemas/enterprise-base.generated.d.ts +18 -0
  267. package/lib-esm/schemas/enterprise-base.generated.js +3 -0
  268. package/lib-esm/schemas/enterprise-base.generated.js.map +1 -0
  269. package/lib-esm/schemas/file-base.generated.d.ts +32 -0
  270. package/lib-esm/schemas/file-base.generated.js +3 -0
  271. package/lib-esm/schemas/file-base.generated.js.map +1 -0
  272. package/lib-esm/schemas/file-mini.generated.d.ts +41 -0
  273. package/lib-esm/schemas/file-mini.generated.js +3 -0
  274. package/lib-esm/schemas/file-mini.generated.js.map +1 -0
  275. package/lib-esm/schemas/file-request.d.ts +41 -0
  276. package/lib-esm/schemas/file-request.js +3 -0
  277. package/lib-esm/schemas/file-request.js.map +1 -0
  278. package/lib-esm/schemas/file-version-base.generated.d.ts +19 -0
  279. package/lib-esm/schemas/file-version-base.generated.js +3 -0
  280. package/lib-esm/schemas/file-version-base.generated.js.map +1 -0
  281. package/lib-esm/schemas/file-version-mini.generated.d.ts +14 -0
  282. package/lib-esm/schemas/file-version-mini.generated.js +3 -0
  283. package/lib-esm/schemas/file-version-mini.generated.js.map +1 -0
  284. package/lib-esm/schemas/folder-base.generated.d.ts +32 -0
  285. package/lib-esm/schemas/folder-base.generated.js +3 -0
  286. package/lib-esm/schemas/folder-base.generated.js.map +1 -0
  287. package/lib-esm/schemas/folder-mini.generated.d.ts +31 -0
  288. package/lib-esm/schemas/folder-mini.generated.js +3 -0
  289. package/lib-esm/schemas/folder-mini.generated.js.map +1 -0
  290. package/lib-esm/schemas/index.d.ts +15 -0
  291. package/lib-esm/schemas/index.generated.d.ts +52 -0
  292. package/lib-esm/schemas/index.generated.js +69 -0
  293. package/lib-esm/schemas/index.generated.js.map +1 -0
  294. package/lib-esm/schemas/index.js +32 -0
  295. package/lib-esm/schemas/index.js.map +1 -0
  296. package/lib-esm/schemas/integration-mapping-base.d.ts +23 -0
  297. package/lib-esm/schemas/integration-mapping-base.js +3 -0
  298. package/lib-esm/schemas/integration-mapping-base.js.map +1 -0
  299. package/lib-esm/schemas/integration-mapping-box-item-slack.d.ts +17 -0
  300. package/lib-esm/schemas/integration-mapping-box-item-slack.js +3 -0
  301. package/lib-esm/schemas/integration-mapping-box-item-slack.js.map +1 -0
  302. package/lib-esm/schemas/integration-mapping-partner-item-slack.d.ts +27 -0
  303. package/lib-esm/schemas/integration-mapping-partner-item-slack.js +3 -0
  304. package/lib-esm/schemas/integration-mapping-partner-item-slack.js.map +1 -0
  305. package/lib-esm/schemas/integration-mapping-slack-create-request.d.ts +12 -0
  306. package/lib-esm/schemas/integration-mapping-slack-create-request.js +3 -0
  307. package/lib-esm/schemas/integration-mapping-slack-create-request.js.map +1 -0
  308. package/lib-esm/schemas/integration-mapping-slack-options.d.ts +16 -0
  309. package/lib-esm/schemas/integration-mapping-slack-options.js +3 -0
  310. package/lib-esm/schemas/integration-mapping-slack-options.js.map +1 -0
  311. package/lib-esm/schemas/integration-mapping.d.ts +55 -0
  312. package/lib-esm/schemas/integration-mapping.js +3 -0
  313. package/lib-esm/schemas/integration-mapping.js.map +1 -0
  314. package/lib-esm/schemas/integration-mappings.d.ts +27 -0
  315. package/lib-esm/schemas/integration-mappings.js +3 -0
  316. package/lib-esm/schemas/integration-mappings.js.map +1 -0
  317. package/lib-esm/schemas/shield-information-barrier-base.generated.d.ts +18 -0
  318. package/lib-esm/schemas/shield-information-barrier-base.generated.js +3 -0
  319. package/lib-esm/schemas/shield-information-barrier-base.generated.js.map +1 -0
  320. package/lib-esm/schemas/shield-information-barrier-reference.generated.d.ts +9 -0
  321. package/lib-esm/schemas/shield-information-barrier-reference.generated.js +3 -0
  322. package/lib-esm/schemas/shield-information-barrier-reference.generated.js.map +1 -0
  323. package/lib-esm/schemas/shield-information-barrier-report-base.generated.d.ts +18 -0
  324. package/lib-esm/schemas/shield-information-barrier-report-base.generated.js +3 -0
  325. package/lib-esm/schemas/shield-information-barrier-report-base.generated.js.map +1 -0
  326. package/lib-esm/schemas/shield-information-barrier-report-details.generated.d.ts +9 -0
  327. package/lib-esm/schemas/shield-information-barrier-report-details.generated.js +3 -0
  328. package/lib-esm/schemas/shield-information-barrier-report-details.generated.js.map +1 -0
  329. package/lib-esm/schemas/shield-information-barrier-report.generated.d.ts +32 -0
  330. package/lib-esm/schemas/shield-information-barrier-report.generated.js +3 -0
  331. package/lib-esm/schemas/shield-information-barrier-report.generated.js.map +1 -0
  332. package/lib-esm/schemas/shield-information-barrier-reports.generated.d.ts +26 -0
  333. package/lib-esm/schemas/shield-information-barrier-reports.generated.js +3 -0
  334. package/lib-esm/schemas/shield-information-barrier-reports.generated.js.map +1 -0
  335. package/lib-esm/schemas/shield-information-barrier-segment-member-base.generated.d.ts +19 -0
  336. package/lib-esm/schemas/shield-information-barrier-segment-member-base.generated.js +3 -0
  337. package/lib-esm/schemas/shield-information-barrier-segment-member-base.generated.js.map +1 -0
  338. package/lib-esm/schemas/shield-information-barrier-segment-member-mini.generated.d.ts +13 -0
  339. package/lib-esm/schemas/shield-information-barrier-segment-member-mini.generated.js +3 -0
  340. package/lib-esm/schemas/shield-information-barrier-segment-member-mini.generated.js.map +1 -0
  341. package/lib-esm/schemas/shield-information-barrier-segment-member.generated.d.ts +39 -0
  342. package/lib-esm/schemas/shield-information-barrier-segment-member.generated.js +3 -0
  343. package/lib-esm/schemas/shield-information-barrier-segment-member.generated.js.map +1 -0
  344. package/lib-esm/schemas/shield-information-barrier-segment-members.generated.d.ts +26 -0
  345. package/lib-esm/schemas/shield-information-barrier-segment-members.generated.js +3 -0
  346. package/lib-esm/schemas/shield-information-barrier-segment-members.generated.js.map +1 -0
  347. package/lib-esm/schemas/shield-information-barrier-segment-restriction-base.generated.d.ts +20 -0
  348. package/lib-esm/schemas/shield-information-barrier-segment-restriction-base.generated.js +3 -0
  349. package/lib-esm/schemas/shield-information-barrier-segment-restriction-base.generated.js.map +1 -0
  350. package/lib-esm/schemas/shield-information-barrier-segment-restriction-mini.generated.d.ts +20 -0
  351. package/lib-esm/schemas/shield-information-barrier-segment-restriction-mini.generated.js +3 -0
  352. package/lib-esm/schemas/shield-information-barrier-segment-restriction-mini.generated.js.map +1 -0
  353. package/lib-esm/schemas/shield-information-barrier-segment-restriction.generated.d.ts +33 -0
  354. package/lib-esm/schemas/shield-information-barrier-segment-restriction.generated.js +3 -0
  355. package/lib-esm/schemas/shield-information-barrier-segment-restriction.generated.js.map +1 -0
  356. package/lib-esm/schemas/shield-information-barrier-segment-restrictions.generated.d.ts +26 -0
  357. package/lib-esm/schemas/shield-information-barrier-segment-restrictions.generated.js +3 -0
  358. package/lib-esm/schemas/shield-information-barrier-segment-restrictions.generated.js.map +1 -0
  359. package/lib-esm/schemas/shield-information-barrier-segment.generated.d.ts +50 -0
  360. package/lib-esm/schemas/shield-information-barrier-segment.generated.js +3 -0
  361. package/lib-esm/schemas/shield-information-barrier-segment.generated.js.map +1 -0
  362. package/lib-esm/schemas/shield-information-barrier-segments.generated.d.ts +26 -0
  363. package/lib-esm/schemas/shield-information-barrier-segments.generated.js +3 -0
  364. package/lib-esm/schemas/shield-information-barrier-segments.generated.js.map +1 -0
  365. package/lib-esm/schemas/shield-information-barrier.generated.d.ts +56 -0
  366. package/lib-esm/schemas/shield-information-barrier.generated.js +3 -0
  367. package/lib-esm/schemas/shield-information-barrier.generated.js.map +1 -0
  368. package/lib-esm/schemas/shield-information-barriers.generated.d.ts +25 -0
  369. package/lib-esm/schemas/shield-information-barriers.generated.js +3 -0
  370. package/lib-esm/schemas/shield-information-barriers.generated.js.map +1 -0
  371. package/lib-esm/schemas/sign-request-base.generated.d.ts +78 -0
  372. package/lib-esm/schemas/sign-request-base.generated.js +3 -0
  373. package/lib-esm/schemas/sign-request-base.generated.js.map +1 -0
  374. package/lib-esm/schemas/sign-request-create-request.generated.d.ts +39 -0
  375. package/lib-esm/schemas/sign-request-create-request.generated.js +3 -0
  376. package/lib-esm/schemas/sign-request-create-request.generated.js.map +1 -0
  377. package/lib-esm/schemas/sign-request-create-signer.generated.d.ts +95 -0
  378. package/lib-esm/schemas/sign-request-create-signer.generated.js +3 -0
  379. package/lib-esm/schemas/sign-request-create-signer.generated.js.map +1 -0
  380. package/lib-esm/schemas/sign-request-prefill-tag.generated.d.ts +28 -0
  381. package/lib-esm/schemas/sign-request-prefill-tag.generated.js +3 -0
  382. package/lib-esm/schemas/sign-request-prefill-tag.generated.js.map +1 -0
  383. package/lib-esm/schemas/sign-request-signer-input.generated.d.ts +28 -0
  384. package/lib-esm/schemas/sign-request-signer-input.generated.js +3 -0
  385. package/lib-esm/schemas/sign-request-signer-input.generated.js.map +1 -0
  386. package/lib-esm/schemas/sign-request-signer.generated.d.ts +34 -0
  387. package/lib-esm/schemas/sign-request-signer.generated.js +3 -0
  388. package/lib-esm/schemas/sign-request-signer.generated.js.map +1 -0
  389. package/lib-esm/schemas/sign-request.generated.d.ts +72 -0
  390. package/lib-esm/schemas/sign-request.generated.js +3 -0
  391. package/lib-esm/schemas/sign-request.generated.js.map +1 -0
  392. package/lib-esm/schemas/sign-requests.generated.d.ts +25 -0
  393. package/lib-esm/schemas/sign-requests.generated.js +3 -0
  394. package/lib-esm/schemas/sign-requests.generated.js.map +1 -0
  395. package/lib-esm/schemas/sign-template.generated.d.ts +94 -0
  396. package/lib-esm/schemas/sign-template.generated.js +3 -0
  397. package/lib-esm/schemas/sign-template.generated.js.map +1 -0
  398. package/lib-esm/schemas/sign-templates.generated.d.ts +30 -0
  399. package/lib-esm/schemas/sign-templates.generated.js +3 -0
  400. package/lib-esm/schemas/sign-templates.generated.js.map +1 -0
  401. package/lib-esm/schemas/template-signer-input.generated.d.ts +61 -0
  402. package/lib-esm/schemas/template-signer-input.generated.js +3 -0
  403. package/lib-esm/schemas/template-signer-input.generated.js.map +1 -0
  404. package/lib-esm/schemas/template-signer.generated.d.ts +43 -0
  405. package/lib-esm/schemas/template-signer.generated.js +3 -0
  406. package/lib-esm/schemas/template-signer.generated.js.map +1 -0
  407. package/lib-esm/schemas/user-base.generated.d.ts +18 -0
  408. package/lib-esm/schemas/user-base.generated.js +3 -0
  409. package/lib-esm/schemas/user-base.generated.js.map +1 -0
  410. package/lib-esm/schemas/user-integration-mappings.d.ts +19 -0
  411. package/lib-esm/schemas/user-integration-mappings.js +3 -0
  412. package/lib-esm/schemas/user-integration-mappings.js.map +1 -0
  413. package/lib-esm/schemas/user-mini.d.ts +6 -0
  414. package/lib-esm/schemas/user-mini.js +3 -0
  415. package/lib-esm/schemas/user-mini.js.map +1 -0
  416. package/lib-esm/sessions/app-auth-session.d.ts +92 -0
  417. package/lib-esm/sessions/app-auth-session.js +176 -0
  418. package/lib-esm/sessions/app-auth-session.js.map +1 -0
  419. package/lib-esm/sessions/basic-session.d.ts +55 -0
  420. package/lib-esm/sessions/basic-session.js +62 -0
  421. package/lib-esm/sessions/basic-session.js.map +1 -0
  422. package/lib-esm/sessions/ccg-session.d.ts +72 -0
  423. package/lib-esm/sessions/ccg-session.js +111 -0
  424. package/lib-esm/sessions/ccg-session.js.map +1 -0
  425. package/lib-esm/sessions/persistent-session.d.ts +96 -0
  426. package/lib-esm/sessions/persistent-session.js +234 -0
  427. package/lib-esm/sessions/persistent-session.js.map +1 -0
  428. package/lib-esm/token-manager.d.ts +191 -0
  429. package/lib-esm/token-manager.js +453 -0
  430. package/lib-esm/token-manager.js.map +1 -0
  431. package/lib-esm/util/config.d.ts +85 -0
  432. package/lib-esm/util/config.js +212 -0
  433. package/lib-esm/util/config.js.map +1 -0
  434. package/lib-esm/util/errors.d.ts +50 -0
  435. package/lib-esm/util/errors.js +176 -0
  436. package/lib-esm/util/errors.js.map +1 -0
  437. package/lib-esm/util/exponential-backoff.d.ts +11 -0
  438. package/lib-esm/util/exponential-backoff.js +17 -0
  439. package/lib-esm/util/exponential-backoff.js.map +1 -0
  440. package/lib-esm/util/paging-iterator.d.ts +53 -0
  441. package/lib-esm/util/paging-iterator.js +247 -0
  442. package/lib-esm/util/paging-iterator.js.map +1 -0
  443. package/lib-esm/util/serializable.d.ts +10 -0
  444. package/lib-esm/util/serializable.js +17 -0
  445. package/lib-esm/util/serializable.js.map +1 -0
  446. package/lib-esm/util/url-path.d.ts +16 -0
  447. package/lib-esm/util/url-path.js +36 -0
  448. package/lib-esm/util/url-path.js.map +1 -0
  449. package/package.json +33 -28
@@ -0,0 +1,243 @@
1
+ "use strict";
2
+ /**
3
+ * @fileoverview Manager for the Tasks Resource
4
+ */
5
+ var __importDefault = (this && this.__importDefault) || function (mod) {
6
+ return (mod && mod.__esModule) ? mod : { "default": mod };
7
+ };
8
+ const url_path_1 = __importDefault(require("../util/url-path"));
9
+ // -----------------------------------------------------------------------------
10
+ // Typedefs
11
+ // -----------------------------------------------------------------------------
12
+ /**
13
+ * Enum of valid task resolution states
14
+ * @readonly
15
+ * @enum {TaskResolutionState}
16
+ */
17
+ var TaskResolutionState;
18
+ (function (TaskResolutionState) {
19
+ TaskResolutionState["COMPLETE"] = "completed";
20
+ TaskResolutionState["INCOMPLETE"] = "incomplete";
21
+ TaskResolutionState["APPROVED"] = "approved";
22
+ TaskResolutionState["REJECTED"] = "rejected";
23
+ })(TaskResolutionState || (TaskResolutionState = {}));
24
+ // -----------------------------------------------------------------------------
25
+ // Private
26
+ // -----------------------------------------------------------------------------
27
+ const BASE_PATH = '/tasks', ASSIGNMENTS_SUBRESOURCE = 'assignments', ASSIGNMENTS_PATH = '/task_assignments', REVIEW_ACTION = 'review';
28
+ // -----------------------------------------------------------------------------
29
+ // Public
30
+ // -----------------------------------------------------------------------------
31
+ /**
32
+ * Simple manager for interacting with all 'Tasks' endpoints and actions.
33
+ *
34
+ * @constructor
35
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
36
+ * @returns {void}
37
+ */
38
+ class Tasks {
39
+ constructor(client) {
40
+ this.client = client;
41
+ }
42
+ /**
43
+ * Used to create a single task for single user on a single file.
44
+ *
45
+ * API Endpoint: '/tasks'
46
+ * Method: POST
47
+ *
48
+ * @param {string} fileID - The ID of the item this task is for
49
+ * @param {Object} [options] - Additional parameters
50
+ * @param {string} [options.message] - An optional message to include with the task
51
+ * @param {string} [options.due_at] - The day at which this task is due
52
+ * @param {Function} [callback] - Passed the new task information if it was acquired successfully, error otherwise
53
+ * @returns {Promise<Object>} A promise resolving to the created task object
54
+ */
55
+ create(fileID, options, callback) {
56
+ var apiPath = (0, url_path_1.default)(BASE_PATH), params = {
57
+ body: {
58
+ item: {
59
+ type: 'file',
60
+ id: fileID,
61
+ },
62
+ action: REVIEW_ACTION,
63
+ },
64
+ };
65
+ Object.assign(params.body, options);
66
+ return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
67
+ }
68
+ /**
69
+ * Fetches a specific task.
70
+ *
71
+ * API Endpoint: '/tasks/:taskID'
72
+ * Method: GET
73
+ *
74
+ * @param {string} taskID - The Box ID of the task being requested
75
+ * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
76
+ * @param {Function} [callback] - Passed the task information if it was acquired successfully, error otherwise
77
+ * @returns {Promise<Object>} A promise resolving to the task object
78
+ */
79
+ get(taskID, options, callback) {
80
+ var apiPath = (0, url_path_1.default)(BASE_PATH, taskID), params = {
81
+ qs: options,
82
+ };
83
+ return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
84
+ }
85
+ /**
86
+ * Updates a specific task.
87
+ *
88
+ * API Endpoint: '/tasks/:taskID'
89
+ * Method: PUT
90
+ *
91
+ * @param {string} taskID - The Box ID of the task being updated
92
+ * @param {Object} updates - Fields of the task object to update
93
+ * @param {string} [updates.message] - An optional message to include with the task
94
+ * @param {string} [updates.due_at] - The day at which this task is due
95
+ * @param {Function} [callback] - Passed the updated task information if it was acquired successfully, error otherwise
96
+ * @returns {Promise<Object>} A promise resolving to the updated task object
97
+ */
98
+ update(taskID, updates, callback) {
99
+ var apiPath = (0, url_path_1.default)(BASE_PATH, taskID), params = {
100
+ body: updates,
101
+ };
102
+ return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
103
+ }
104
+ /**
105
+ * Permanently deletes a specific task.
106
+ *
107
+ * API Endpoint: '/tasks/:taskID'
108
+ * Method: DELETE
109
+ *
110
+ * @param {string} taskID - The Box ID of the task being deleted
111
+ * @param {Function} [callback] - Empty body passed if successful, error otherwise
112
+ * @returns {Promise<void>} A promise resolving to nothing
113
+ */
114
+ delete(taskID, callback) {
115
+ var apiPath = (0, url_path_1.default)(BASE_PATH, taskID);
116
+ return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
117
+ }
118
+ /**
119
+ * Get a list of assignments for a given task
120
+ *
121
+ * API Endpoint: '/tasks/:taskID/assignments'
122
+ * Method: GET
123
+ *
124
+ * @param {string} taskID - The Box ID of the task to get assignments for
125
+ * @param {Object} [options] - Additional parameters, can be left null in most cases
126
+ * @param {Function} [callback] - Passed the list of assignments if successful, error otherwise
127
+ * @returns {Promise<Object>} A promise resolving to the collection of assignment objects
128
+ */
129
+ getAssignments(taskID, options, callback) {
130
+ var apiPath = (0, url_path_1.default)(BASE_PATH, taskID, ASSIGNMENTS_SUBRESOURCE), params = {
131
+ qs: options,
132
+ };
133
+ return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
134
+ }
135
+ /**
136
+ * Get a specific task assignment
137
+ *
138
+ * API Endpoint: '/task_assignments/:assignmentID'
139
+ * Method: GET
140
+ *
141
+ * @param {string} assignmentID - The Box ID of the task assignment to retrieve
142
+ * @param {Object} [options] - Additional parameters, can be left null in most cases
143
+ * @param {Function} [callback] - Passed the task assignment if successful, error otherwise
144
+ * @returns {Promise<Object>} A promise resolving to the assignment object
145
+ */
146
+ getAssignment(assignmentID, options, callback) {
147
+ var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID), params = {
148
+ qs: options,
149
+ };
150
+ return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
151
+ }
152
+ /**
153
+ * Assign a task to a specific user by ID
154
+ *
155
+ * API Endpoint: '/task_assignments'
156
+ * Method: POST
157
+ *
158
+ * @param {string} taskID - The Box ID of the task to assign
159
+ * @param {string} userID - The ID of the user to assign the task to
160
+ * @param {Function} [callback] - Passed the task assignment if successful, error otherwise
161
+ * @returns {Promise<Object>} A promise resolving to the new assignment object
162
+ */
163
+ assignByUserID(taskID, userID, callback) {
164
+ var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH), params = {
165
+ body: {
166
+ task: {
167
+ type: 'task',
168
+ id: taskID,
169
+ },
170
+ assign_to: {
171
+ id: userID,
172
+ },
173
+ },
174
+ };
175
+ return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
176
+ }
177
+ /**
178
+ * Assign a task to a specific user by email address
179
+ *
180
+ * API Endpoint: '/task_assignments'
181
+ * Method: POST
182
+ *
183
+ * @param {string} taskID - The Box ID of the task to assign
184
+ * @param {string} email - The email address of the user to assign the task to
185
+ * @param {Function} [callback] - Passed the task assignment if successful, error otherwise
186
+ * @returns {Promise<Object>} A promise resolving to the new assignment object
187
+ */
188
+ assignByEmail(taskID, email, callback) {
189
+ var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH), params = {
190
+ body: {
191
+ task: {
192
+ type: 'task',
193
+ id: taskID,
194
+ },
195
+ assign_to: {
196
+ login: email,
197
+ },
198
+ },
199
+ };
200
+ return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
201
+ }
202
+ /**
203
+ * Update a task assignment. This is used to resolve or complete a task.
204
+ *
205
+ * API Endpoint: '/task_assignments/:assignmentID'
206
+ * Method: PUT
207
+ *
208
+ * @param {string} assignmentID - The Box ID of the task assignment to update
209
+ * @param {Object} options - The fields of the assignment to update
210
+ * @param {string} [options.message] - A message from the assignee about this task
211
+ * @param {TaskResolutionState} [options.resolution_state] - Resolution of the task
212
+ * @param {Function} [callback] - Passed the updated task assignment if successful, error otherwise
213
+ * @returns {Promise<Object>} A promise resolving to the updated assignment object
214
+ */
215
+ updateAssignment(assignmentID, options, callback) {
216
+ var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID), params = {
217
+ body: options,
218
+ };
219
+ return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
220
+ }
221
+ /**
222
+ * Delete a task assignment. This unassigns a user from the related task.
223
+ *
224
+ * API Endpoint: '/task_assignments/:assignmentID'
225
+ * Method: DELETE
226
+ *
227
+ * @param {string} assignmentID - The Box ID of the task assignment to delete
228
+ * @param {Function} [callback] - Passed nothing if successful, error otherwise
229
+ * @returns {Promise<void>} A promise resolving to nothing
230
+ */
231
+ deleteAssignment(assignmentID, callback) {
232
+ var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID);
233
+ return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
234
+ }
235
+ }
236
+ /**
237
+ * Enum of valid task resolution states
238
+ * @readonly
239
+ * @enum {TaskResolutionState}
240
+ */
241
+ Tasks.prototype.resolutionStates = TaskResolutionState;
242
+ module.exports = Tasks;
243
+ //# sourceMappingURL=tasks.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tasks.js","sourceRoot":"","sources":["../../src/managers/tasks.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,gEAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;GAIG;AACH,IAAK,mBAKJ;AALD,WAAK,mBAAmB;IACtB,6CAAsB,CAAA;IACtB,gDAAyB,CAAA;IACzB,4CAAqB,CAAA;IACrB,4CAAqB,CAAA;AACvB,CAAC,EALI,mBAAmB,KAAnB,mBAAmB,QAKvB;AAED,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,MAAM,SAAS,GAAG,QAAQ,EACxB,uBAAuB,GAAG,aAAa,EACvC,gBAAgB,GAAG,mBAAmB,EACtC,aAAa,GAAG,QAAQ,CAAC;AAE3B,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,KAAK;IAKT,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,MAAc,EACd,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,EAC9B,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,MAAM;iBACX;gBACD,MAAM,EAAE,aAAa;aACtB;SACF,CAAC;QAEJ,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,MAAc,EAAE,OAA6B,EAAE,QAAmB;QACpE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,CAAC,EACtC,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,MAAc,EACd,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,CAAC,EACtC,MAAM,GAAG;YACP,IAAI,EAAE,OAAO;SACd,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAc,EAAE,QAAmB;QACxC,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CACZ,MAAc,EACd,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,EAAE,uBAAuB,CAAC,EAC/D,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CACX,YAAoB,EACpB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,EACnD,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,QAAmB;QAChE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,CAAC,EACrC,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,MAAM;iBACX;gBACD,SAAS,EAAE;oBACT,EAAE,EAAE,MAAM;iBACX;aACF;SACF,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CAAC,MAAc,EAAE,KAAa,EAAE,QAAmB;QAC9D,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,CAAC,EACrC,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,MAAM;iBACX;gBACD,SAAS,EAAE;oBACT,KAAK,EAAE,KAAK;iBACb;aACF;SACF,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,YAAoB,EACpB,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,EACnD,MAAM,GAAG;YACP,IAAI,EAAE,OAAO;SACd,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAC,YAAoB,EAAE,QAAmB;QACxD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,KAAK,CAAC,SAAS,CAAC,gBAAgB,GAAG,mBAAmB,CAAC;AAEvD,iBAAS,KAAK,CAAC"}
@@ -0,0 +1,161 @@
1
+ /**
2
+ * @fileoverview Manager for the Box Terms of Service Resource
3
+ */
4
+ import BoxClient from '../box-client';
5
+ /**
6
+ * Enum value of scope of the custom terms of services set to either managed by an enterprise or enternal to an enterprise
7
+ *
8
+ * @readonly
9
+ * @enum {TermsOfServicesType}
10
+ */
11
+ declare enum TermsOfServicesType {
12
+ MANAGED = "managed",
13
+ EXTERNAL = "external"
14
+ }
15
+ /**
16
+ * Enum value of status of the custom terms of services, either currently enabled or currently disabled
17
+ *
18
+ * @readonly
19
+ * @enum {TermsOfServicesStatus}
20
+ */
21
+ declare enum TermsOfServicesStatus {
22
+ ENABLED = "enabled",
23
+ DISABLED = "disabled"
24
+ }
25
+ /**
26
+ * Simple manager for interacting with all 'Terms of Services' and 'Terms of Service User Statuses' endpoints and actions.
27
+ *
28
+ * @param {BoxClient} client The Box API Client that is responsible for making calls to the API
29
+ * @constructor
30
+ */
31
+ declare class TermsOfService {
32
+ client: BoxClient;
33
+ type: typeof TermsOfServicesType;
34
+ status: typeof TermsOfServicesStatus;
35
+ constructor(client: BoxClient);
36
+ /**
37
+ * Creates a custom terms of services with user specified values
38
+ *
39
+ * API Endpoint: '/terms_of_services'
40
+ * Method: POST
41
+ *
42
+ * @param {TermsOfServicesType} termsOfServicesType - Determine if the custom terms of service is scoped internall or externally to an enterprise
43
+ * @param {TermsOfServicesStatus} termsOfServicesStatus - Determine if the custom terms of service is enabled or disabled
44
+ * @param {string} termsOfServicesText - Text field for message associated with custom terms of services
45
+ * @param {Function} [callback] - Passed the terms of services information if successful, error otherwise
46
+ * @returns {Promise<Object>} A promise resolving to the terms of services object
47
+ */
48
+ create(termsOfServicesType: TermsOfServicesType, termsOfServicesStatus: TermsOfServicesStatus, termsOfServicesText: string, callback?: Function): any;
49
+ /**
50
+ * Updates a custom terms of services with new specified values
51
+ *
52
+ * API Endpoint: '/terms_of_services/:termsOfServicesID'
53
+ * Method: PUT
54
+ *
55
+ * @param {string} termsOfServicesID - The id of the custom terms of services to update
56
+ * @param {Object} updates - Fields ot the Terms of Service to update
57
+ * @param {TermsOfServicesStatus} [updates.status] - Determine if the custom terms of service is scoped internall or externally to an enterprise
58
+ * @param {string} [updates.text] - Text field for message associated with custom terms of services
59
+ * @param {Function} [callback] - Passed the terms of services updated information if successful, error otherwise
60
+ * @returns {Promise<Object>} A promise resolving to the terms of services object
61
+ */
62
+ update(termsOfServicesID: string, updates: {
63
+ status?: TermsOfServicesStatus;
64
+ text?: string;
65
+ }, callback?: Function): any;
66
+ /**
67
+ * Gets a specific custom terms of services with specified ID
68
+ *
69
+ * API Endpoint: '/terms_of_services/:termsOfServicesID'
70
+ * Method: GET
71
+ *
72
+ * @param {string} termsOfServicesID - The id of the custom terms of services to retrieve
73
+ * @param {Object} [options] - Additional options. Can be left null in most cases.
74
+ * @param {string} [options.fields] - Comma-separated list of fields to return on the collaboration objects
75
+ * @param {Function} [callback] - Passed the terms of services information with specified ID if successful, error otherwise
76
+ * @returns {Promise<Object>} A promise resolving to the terms of services object
77
+ */
78
+ get(termsOfServicesID: string, options?: {
79
+ fields?: string;
80
+ }, callback?: Function): any;
81
+ /**
82
+ * Gets custom terms of services for the user's enterprise
83
+ *
84
+ * API Endpoint: '/terms_of_services'
85
+ * Method: GET
86
+ *
87
+ * @param {Object} [options] - Additional options. Can be left null in most cases.
88
+ * @param {TermsOfServiceType} [options.tos_type] - Optional, indicates whether the terms of service is set for external or managed under enterprise
89
+ * @param {string} [options.fields] - Comma-separated list of fields to return on the collaboration objects
90
+ * @param {Function} [callback] - Passed the terms of services information if successful, error otherwise
91
+ * @returns {Promise<Object>} A promise resolving to the terms of services object
92
+ */
93
+ getAll(options?: {
94
+ tos_type?: TermsOfServicesType;
95
+ fields?: string;
96
+ }, callback?: Function): any;
97
+ /**
98
+ * Accepts/rejects custom terms of services for the user
99
+ *
100
+ * API Endpoint: '/terms_of_service_user_statuses'
101
+ * Method: POST
102
+ *
103
+ * @param {string} termsOfServicesID - Terms of services ID to retrieve user statuses on
104
+ * @param {boolean} isAccepted - Determines wehether the terms of services has been accepted or rejected
105
+ * @param {Object} [options] - Additional options. Can be left null in most cases.
106
+ * @param {string} [options.user_id] - Optional, user id to retrieve terms of service status on, default is current user
107
+ * @param {Function} [callback] - Passed the terms of service user status information if successful, error otherwise
108
+ * @returns {Promise<Object>} A promise resolving to the terms of service user status
109
+ */
110
+ createUserStatus(termsOfServicesID: string, isAccepted: boolean, options?: {
111
+ user_id?: string;
112
+ }, callback?: Function): any;
113
+ /**
114
+ * Gets a terms os service status given the terms of services id
115
+ *
116
+ * API Endpoint: '/terms_of_service_user_statuses'
117
+ * Method: GET
118
+ *
119
+ * @param {string} termsOfServicesID - The ID of the terms of services to retrieve status on
120
+ * @param {Object} [options] - Additional options. Can be left null in most cases
121
+ * @param {string} [options.user_id] - Optional, the id of the user to retrieve status of custom terms and service on
122
+ * @param {Function} [callback] - Passed the terms of service user status information if successful, error otherwise
123
+ * @returns {Promise<Object>} A promise resolving to the terms of service user status
124
+ */
125
+ getUserStatus(termsOfServicesID: string, options?: {
126
+ user_id?: string;
127
+ }, callback?: Function): any;
128
+ /**
129
+ * Accepts/rejects custom terms of services for the user
130
+ *
131
+ * API Endpoint: '/terms_of_service_user_statuses'
132
+ * Method: PUT
133
+ *
134
+ * @param {string} termsOfServiceUserStatusID - Terms of service user status object ID
135
+ * @param {boolean} isAccepted - Determines wehether the terms of services has been accepted or rejected
136
+ * @param {Function} [callback] - Passed the terms of service user status updated information if successful, error otherwise
137
+ * @returns {Promise<Object>} A promise resolving to the updated terms of service user status
138
+ */
139
+ updateUserStatus(termsOfServiceUserStatusID: string, isAccepted: boolean, callback?: Function): any;
140
+ /**
141
+ * Creates a user status for terms of service, if already exists then update existing user status for terms of service
142
+ *
143
+ * API Endpoint: '/terms_of_service_user_statuses'
144
+ * Method: POST/PUT
145
+ *
146
+ * @param {string} termsOfServicesID - Terms of services ID to retrieve user statuses on
147
+ * @param {boolean} isAccepted - Determines wehether the terms of services has been accepted or rejected
148
+ * @param {Object} [options] - Additional options. Can be left null in most cases.
149
+ * @param {string} [options.user_id] - Optional, user id to retrieve terms of service status on, default is current user
150
+ * @param {Function} [callback] - Passed the terms of service user status information if successful, error otherwise
151
+ * @returns {Promise<Object>} A promise resolving to the terms of service user status
152
+ */
153
+ setUserStatus(termsOfServicesID: string, isAccepted: boolean, options?: {
154
+ user_id?: string;
155
+ }, callback?: Function): any;
156
+ }
157
+ /**
158
+ * @module box-node-sdk/lib/managers/terms-of-service
159
+ * @see {@Link TermsOfService}
160
+ */
161
+ export = TermsOfService;