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,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=shield-information-barrier.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"shield-information-barrier.generated.js","sourceRoot":"","sources":["../../src/schemas/shield-information-barrier.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,25 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * List of Shield Information Barriers
4
+ *
5
+ * The part of an API response that describes marker
6
+ * based pagination
7
+ */
8
+ export interface ShieldInformationBarriers {
9
+ /**
10
+ * The limit that was used for these entries. This will be the same as the
11
+ * `limit` query parameter unless that value exceeded the maximum value
12
+ * allowed. The maximum value varies by API.
13
+ * Example: 1000
14
+ */
15
+ limit?: number;
16
+ /**
17
+ * The marker for the start of the next page of results.
18
+ * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
19
+ */
20
+ next_marker?: string;
21
+ /**
22
+ * A list of shield information barrier objects
23
+ */
24
+ entries?: schemas.ShieldInformationBarrier[];
25
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=shield-information-barriers.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"shield-information-barriers.generated.js","sourceRoot":"","sources":["../../src/schemas/shield-information-barriers.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,78 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * Box Sign request (Base)
4
+ *
5
+ * A standard representation of a signature request object.
6
+ */
7
+ export interface SignRequestBase {
8
+ /**
9
+ * Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI.
10
+ * Example: true
11
+ */
12
+ is_document_preparation_needed?: boolean;
13
+ /**
14
+ * When specified, the signature request will be redirected to this url when a document is signed.
15
+ * Example: https://www.example.com
16
+ */
17
+ redirect_url?: string;
18
+ /**
19
+ * The uri that a signer will be redirected to after declining to sign a document.
20
+ * Example: https://declined-redirect.com
21
+ */
22
+ declined_redirect_url?: string;
23
+ /**
24
+ * Disables the usage of signatures generated by typing (text).
25
+ * Example: true
26
+ * @default true
27
+ */
28
+ are_text_signatures_enabled?: boolean;
29
+ /**
30
+ * Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.
31
+ * Example: Sign Request from Acme
32
+ */
33
+ email_subject?: string;
34
+ /**
35
+ * Message to include in sign request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.
36
+ * Example: Hello! Please sign the document below
37
+ */
38
+ email_message?: string;
39
+ /**
40
+ * Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.
41
+ * Example: true
42
+ */
43
+ are_reminders_enabled?: boolean;
44
+ /**
45
+ * Name of the signature request.
46
+ * Example: name
47
+ */
48
+ name?: string;
49
+ /**
50
+ * When a document contains sign-related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag.
51
+ */
52
+ prefill_tags?: schemas.SignRequestPrefillTag[];
53
+ /**
54
+ * Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire.
55
+ * Example: 2
56
+ */
57
+ days_valid?: number;
58
+ /**
59
+ * This can be used to reference an ID in an external system that the sign request is related to.
60
+ * Example: 123
61
+ */
62
+ external_id?: string;
63
+ /**
64
+ * Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them.
65
+ * Example: true
66
+ */
67
+ is_phone_verification_required_to_view?: boolean;
68
+ /**
69
+ * When a signature request is created from a template this field will indicate the id of that template.
70
+ * Example: 123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb
71
+ */
72
+ template_id?: string;
73
+ /**
74
+ * Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`.
75
+ * Example: Box
76
+ */
77
+ external_system_name?: string;
78
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=sign-request-base.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign-request-base.generated.js","sourceRoot":"","sources":["../../src/schemas/sign-request-base.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,39 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * Create a Box Sign request
4
+ *
5
+ * Creates a Box Sign request object.
6
+ */
7
+ export interface SignRequestCreateRequest extends schemas.SignRequestBase {
8
+ /**
9
+ * List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file.
10
+ */
11
+ source_files?: schemas.FileBase[];
12
+ /**
13
+ * Force a specific color for the signature (blue, black, or red)
14
+ * Example: blue
15
+ */
16
+ signature_color?: 'blue' | 'black' | 'red';
17
+ /**
18
+ * Array of signers for the signature request. 35 is the
19
+ * max number of signers permitted.
20
+ *
21
+ * **Note**: It may happen that some signers belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups).
22
+ * This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts.
23
+ * In such a case, an attempt to send the sign request will result in an error.
24
+ *
25
+ * Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
26
+ */
27
+ signers: schemas.SignRequestCreateSigner[];
28
+ /**
29
+ * The destination folder to place final, signed document and signing
30
+ * log. Only `ID` and `type` fields are required. The root folder,
31
+ * folder ID `0`, cannot be used and can also not be null.
32
+ *
33
+ * When this value is not passed in when the signature request, then
34
+ * we will use a default folder which is either the parent folder of
35
+ * the first source file in the payload if we have the permission to
36
+ * upload to that folder or a folder called "My Sign Requests".
37
+ */
38
+ parent_folder?: schemas.FolderMini;
39
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=sign-request-create-request.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign-request-create-request.generated.js","sourceRoot":"","sources":["../../src/schemas/sign-request-create-request.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,95 @@
1
+ /**
2
+ * Signer fields used to create a Box Sign request object.
3
+ *
4
+ * The schema for a Signer object used in
5
+ * for creating a Box Sign request object.
6
+ */
7
+ export interface SignRequestCreateSigner {
8
+ /**
9
+ * Email address of the signer.
10
+ * The email address of the signer is required when making signature requests, except when using templates that are configured to include emails.
11
+ * Example: example@gmail.com
12
+ */
13
+ email?: string;
14
+ /**
15
+ * Defines the role of the signer in the signature request. A `signer`
16
+ * must sign the document and an `approver` must approve the document. A
17
+ * `final_copy_reader` only receives the final signed document and signing
18
+ * log.
19
+ * Example: signer
20
+ * @default signer
21
+ */
22
+ role?: 'signer' | 'approver' | 'final_copy_reader';
23
+ /**
24
+ * Used in combination with an embed URL for a sender. After the
25
+ * sender signs, they are redirected to the next `in_person` signer.
26
+ * Example: true
27
+ */
28
+ is_in_person?: boolean;
29
+ /**
30
+ * Order of the signer
31
+ * Example: 2
32
+ */
33
+ order?: number;
34
+ /**
35
+ * User ID for the signer in an external application responsible
36
+ * for authentication when accessing the embed URL.
37
+ * Example: 1234
38
+ */
39
+ embed_url_external_user_id?: string;
40
+ /**
41
+ * The URL that a signer will be redirected
42
+ * to after signing a document. Defining this URL
43
+ * overrides default or global redirect URL
44
+ * settings for a specific signer.
45
+ * If no declined redirect URL is specified,
46
+ * this URL will be used for decline actions as well.
47
+ * Example: https://example.com
48
+ */
49
+ redirect_url?: string;
50
+ /**
51
+ * The URL that a signer will be redirect
52
+ * to after declining to sign a document.
53
+ * Defining this URL overrides default or global
54
+ * declined redirect URL settings for a specific signer.
55
+ * Example: https://declined-example.com
56
+ */
57
+ declined_redirect_url?: string;
58
+ /**
59
+ * If set to true, the signer will need to log in to a Box account
60
+ * before signing the request. If the signer does not have
61
+ * an existing account, they will have the option to create
62
+ * a free Box account. Cannot be selected in combination with
63
+ * `verification_phone_number`.
64
+ * Example: true
65
+ */
66
+ login_required?: boolean;
67
+ /**
68
+ * If set, this phone number will be used to verify the signer
69
+ * via two-factor authentication before they are able to sign the document.
70
+ * Cannot be selected in combination with `login_required`.
71
+ * Example: 6314578901
72
+ */
73
+ verification_phone_number?: string;
74
+ /**
75
+ * If set, the signer is required to enter the password before they are able
76
+ * to sign a document. This field is write only.
77
+ * Example: SecretPassword123
78
+ */
79
+ password?: string;
80
+ /**
81
+ * If set, signers who have the same value will be assigned to the same input and to the same signer group.
82
+ * A signer group is not a Box Group. It is an entity that belongs to a Sign Request and can only be
83
+ * used/accessed within this Sign Request. A signer group is expected to have more than one signer.
84
+ * If the provided value is only used for one signer, this value will be ignored and request will be handled
85
+ * as it was intended for an individual signer. The value provided can be any string and only used to
86
+ * determine which signers belongs to same group. A successful response will provide a generated UUID value
87
+ * instead for signers in the same signer group.
88
+ * Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
89
+ */
90
+ signer_group_id?: string;
91
+ /**
92
+ * If true, no emails about the sign request will be sent
93
+ */
94
+ suppress_notifications?: boolean;
95
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=sign-request-create-signer.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign-request-create-signer.generated.js","sourceRoot":"","sources":["../../src/schemas/sign-request-create-signer.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,28 @@
1
+ /**
2
+ * Sign request prefill tag
3
+ *
4
+ * Prefill tags are used to prefill placeholders with signer input data. Only
5
+ * one value field can be included.
6
+ */
7
+ export interface SignRequestPrefillTag {
8
+ /**
9
+ * This references the ID of a specific tag contained in a file of the signature request.
10
+ * Example: 1234
11
+ */
12
+ document_tag_id?: string;
13
+ /**
14
+ * Text prefill value
15
+ * Example: text
16
+ */
17
+ text_value?: string;
18
+ /**
19
+ * Checkbox prefill value
20
+ * Example: true
21
+ */
22
+ checkbox_value?: boolean;
23
+ /**
24
+ * Date prefill value
25
+ * Example: 2021-04-26
26
+ */
27
+ date_value?: string;
28
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=sign-request-prefill-tag.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign-request-prefill-tag.generated.js","sourceRoot":"","sources":["../../src/schemas/sign-request-prefill-tag.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,28 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * Sign Request Signer Input
4
+ *
5
+ * Input created by a Signer on a Sign Request
6
+ */
7
+ export interface SignRequestSignerInput extends schemas.SignRequestPrefillTag {
8
+ /**
9
+ * Type of input
10
+ * Example: text
11
+ */
12
+ type?: 'signature' | 'date' | 'text' | 'checkbox' | 'radio' | 'dropdown';
13
+ /**
14
+ * Content type of input
15
+ * Example: signature
16
+ */
17
+ content_type?: 'signature' | 'initial' | 'stamp' | 'date' | 'checkbox' | 'text' | 'full_name' | 'first_name' | 'last_name' | 'company' | 'title' | 'email' | 'attachment' | 'radio' | 'dropdown';
18
+ /**
19
+ * Index of page that the input is on
20
+ * Example: 4
21
+ */
22
+ page_index: number;
23
+ /**
24
+ * Whether this input was defined as read-only(immutable by signers) or not
25
+ * Example: true
26
+ */
27
+ read_only?: boolean;
28
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=sign-request-signer-input.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign-request-signer-input.generated.js","sourceRoot":"","sources":["../../src/schemas/sign-request-signer-input.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,34 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * Signer fields for Box Sign request response
4
+ *
5
+ * The schema for a Signer object used
6
+ * on the body of a Box Sign request object.
7
+ */
8
+ export interface SignRequestSigner extends schemas.SignRequestCreateSigner {
9
+ /**
10
+ * Set to `true` if the signer views the document
11
+ * Example: true
12
+ */
13
+ has_viewed_document?: boolean;
14
+ /**
15
+ * Final decision made by the signer.
16
+ */
17
+ signer_decision?: object;
18
+ inputs?: schemas.SignRequestSignerInput[];
19
+ /**
20
+ * URL to direct a signer to for signing
21
+ * Example: https://example.com
22
+ */
23
+ embed_url?: string;
24
+ /**
25
+ * This URL is specifically designed for
26
+ * signing documents within an HTML `iframe` tag.
27
+ * It will be returned in the response
28
+ * only if the `embed_url_external_user_id`
29
+ * parameter was passed in the
30
+ * `create Box Sign request` call.
31
+ * Example: https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4
32
+ */
33
+ iframeable_embed_url?: string;
34
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=sign-request-signer.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign-request-signer.generated.js","sourceRoot":"","sources":["../../src/schemas/sign-request-signer.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,72 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * Box Sign request
4
+ *
5
+ * A Box Sign request object.
6
+ */
7
+ export interface SignRequest extends schemas.SignRequestBase {
8
+ /**
9
+ * object type
10
+ * Example: sign-request
11
+ */
12
+ type?: 'sign-request';
13
+ /**
14
+ * List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file.
15
+ */
16
+ source_files?: schemas.FileBase[];
17
+ /**
18
+ * Array of signers for the signature request.
19
+ */
20
+ signers?: schemas.SignRequestSigner[];
21
+ /**
22
+ * Force a specific color for the signature (blue, black, or red).
23
+ * Example: blue
24
+ */
25
+ signature_color?: string;
26
+ /**
27
+ * Box Sign request ID.
28
+ * Example: 12345
29
+ */
30
+ id?: string;
31
+ /**
32
+ * This URL is returned if `is_document_preparation_needed` is
33
+ * set to `true` in the request. The parameter is used to prepare
34
+ * the signature request
35
+ * using the UI. The signature request is not
36
+ * sent until the preparation
37
+ * phase is complete.
38
+ * Example: https://prepareurl.com
39
+ */
40
+ prepare_url?: string;
41
+ /**
42
+ * Reference to a file that holds a log of all signer activity for
43
+ * the request.
44
+ */
45
+ signing_log?: schemas.FileMini;
46
+ /**
47
+ * Describes the status of the signature request.
48
+ * Example: converting
49
+ */
50
+ status?: 'converting' | 'created' | 'sent' | 'viewed' | 'signed' | 'cancelled' | 'declined' | 'error_converting' | 'error_sending' | 'expired' | 'finalizing' | 'error_finalizing';
51
+ /**
52
+ * List of files that will be signed, which are copies of the original
53
+ * source files. A new version of these files are created as signers sign
54
+ * and can be downloaded at any point in the signing process.
55
+ */
56
+ sign_files?: object;
57
+ /**
58
+ * Uses `days_valid` to calculate the date and time, in GMT, the sign request will expire if unsigned.
59
+ * Example: 2021-04-26T08:12:13.982Z
60
+ */
61
+ auto_expire_at?: string;
62
+ /**
63
+ * The destination folder to place final, signed document and signing
64
+ * log.
65
+ *
66
+ * When this value was not passed in when the signature request was
67
+ * created, then we will use a default folder which is either the parent
68
+ * folder of the first source file in the payload if we have the permission
69
+ * to upload to that folder or a folder called "My Sign Requests".
70
+ */
71
+ parent_folder?: schemas.FolderMini;
72
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=sign-request.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign-request.generated.js","sourceRoot":"","sources":["../../src/schemas/sign-request.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,25 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * Box Sign requests
4
+ *
5
+ * The part of an API response that describes marker
6
+ * based pagination
7
+ */
8
+ export interface SignRequests {
9
+ /**
10
+ * The limit that was used for these entries. This will be the same as the
11
+ * `limit` query parameter unless that value exceeded the maximum value
12
+ * allowed. The maximum value varies by API.
13
+ * Example: 1000
14
+ */
15
+ limit?: number;
16
+ /**
17
+ * The marker for the start of the next page of results.
18
+ * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
19
+ */
20
+ next_marker?: string;
21
+ /**
22
+ * A list of Box Sign requests.
23
+ */
24
+ entries?: schemas.SignRequest[];
25
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=sign-requests.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign-requests.generated.js","sourceRoot":"","sources":["../../src/schemas/sign-requests.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,94 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * Box Sign template
4
+ *
5
+ * A Box Sign template object
6
+ */
7
+ export interface SignTemplate {
8
+ /**
9
+ * object type
10
+ * Example: sign-template
11
+ */
12
+ type?: 'sign-template';
13
+ /**
14
+ * Template identifier.
15
+ * Example: 4206996024-14944f75-c34b-478a-95a1-264b1ff80d35
16
+ */
17
+ id?: string;
18
+ /**
19
+ * The name of the template.
20
+ * Example: Official contract
21
+ */
22
+ name?: string;
23
+ /**
24
+ * Subject of signature request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.
25
+ * Example: Sign Request from Acme
26
+ */
27
+ email_subject?: string;
28
+ /**
29
+ * Message to include in signature request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.
30
+ * Example: Hello! Please sign the document below
31
+ */
32
+ email_message?: string;
33
+ /**
34
+ * Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire.
35
+ * Example: 2
36
+ */
37
+ days_valid?: number;
38
+ /**
39
+ * The destination folder to place final, signed document and signing
40
+ * log. Only `ID` and `type` fields are required. The root folder,
41
+ * folder ID `0`, cannot be used.
42
+ */
43
+ parent_folder?: schemas.FolderMini;
44
+ /**
45
+ * List of files to create a signing document from. Only the ID and type fields are required for each file.
46
+ */
47
+ source_files?: schemas.FileMini[];
48
+ /**
49
+ * Indicates if the template input fields are editable or not.
50
+ */
51
+ are_fields_locked?: boolean;
52
+ /**
53
+ * Indicates if the template document options are editable or not, for example renaming the document.
54
+ * Example: true
55
+ */
56
+ are_options_locked?: boolean;
57
+ /**
58
+ * Indicates if the template signers are editable or not.
59
+ */
60
+ are_recipients_locked?: boolean;
61
+ /**
62
+ * Indicates if the template email settings are editable or not.
63
+ * Example: true
64
+ */
65
+ are_email_settings_locked?: boolean;
66
+ /**
67
+ * Indicates if the template files are editable or not. This includes deleting or renaming template files.
68
+ * Example: true
69
+ */
70
+ are_files_locked?: boolean;
71
+ /**
72
+ * Array of signers for the template.
73
+ *
74
+ * **Note**: It may happen that some signers specified in the template belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups).
75
+ * This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts.
76
+ * In such a case, an attempt to send a sign request based on a template that lists signers in conflicting segments will result in an error.
77
+ *
78
+ * Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
79
+ */
80
+ signers?: schemas.TemplateSigner[];
81
+ /**
82
+ * Additional information on which fields are required and which fields are not editable.
83
+ */
84
+ additional_info?: object;
85
+ /**
86
+ * Box's ready-sign link feature enables you to create a link to a signature request that you've created from a template. Use this link when you want to post a signature request on a public form — such as an email, social media post, or web page — without knowing who the signers will be. Note: The ready-sign link feature is limited to Enterprise Plus customers and not available to Box Verified Enterprises.
87
+ */
88
+ ready_sign_link?: object;
89
+ /**
90
+ * Custom branding applied to notifications
91
+ * and signature requests.
92
+ */
93
+ custom_branding?: object;
94
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=sign-template.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign-template.generated.js","sourceRoot":"","sources":["../../src/schemas/sign-template.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,30 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * Box Sign templates
4
+ *
5
+ * The part of an API response that describes marker
6
+ * based pagination
7
+ */
8
+ export interface SignTemplates {
9
+ /**
10
+ * The limit that was used for these entries. This will be the same as the
11
+ * `limit` query parameter unless that value exceeded the maximum value
12
+ * allowed. The maximum value varies by API.
13
+ * Example: 1000
14
+ */
15
+ limit?: number;
16
+ /**
17
+ * The marker for the start of the next page of results.
18
+ * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
19
+ */
20
+ next_marker?: string;
21
+ /**
22
+ * The marker for the start of the previous page of results.
23
+ * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih
24
+ */
25
+ prev_marker?: string;
26
+ /**
27
+ * A list of templates.
28
+ */
29
+ entries?: schemas.SignTemplate[];
30
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=sign-templates.generated.js.map