box-node-sdk 1.35.0 → 1.37.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 (126) hide show
  1. package/CHANGELOG.md +37 -2
  2. package/README.md +1 -1
  3. package/lib/api-request-manager.d.ts +38 -0
  4. package/lib/api-request-manager.js +48 -55
  5. package/lib/api-request-manager.js.map +1 -0
  6. package/lib/api-request.d.ts +141 -0
  7. package/lib/api-request.js +202 -281
  8. package/lib/api-request.js.map +1 -0
  9. package/lib/box-client.d.ts +269 -0
  10. package/lib/box-client.js +551 -713
  11. package/lib/box-client.js.map +1 -0
  12. package/lib/box-node-sdk.d.ts +216 -0
  13. package/lib/box-node-sdk.js +317 -352
  14. package/lib/box-node-sdk.js.map +1 -0
  15. package/lib/chunked-uploader.d.ts +129 -0
  16. package/lib/chunked-uploader.js +287 -358
  17. package/lib/chunked-uploader.js.map +1 -0
  18. package/lib/enterprise-event-stream.d.ts +82 -0
  19. package/lib/enterprise-event-stream.js +189 -203
  20. package/lib/enterprise-event-stream.js.map +1 -0
  21. package/lib/event-stream.d.ts +92 -0
  22. package/lib/event-stream.js +274 -302
  23. package/lib/event-stream.js.map +1 -0
  24. package/lib/managers/collaboration-allowlist.d.ts +137 -0
  25. package/lib/managers/collaboration-allowlist.js +200 -0
  26. package/lib/managers/collaboration-allowlist.js.map +1 -0
  27. package/lib/managers/collaboration-whitelist.d.ts +3 -0
  28. package/lib/managers/collaboration-whitelist.js +8 -222
  29. package/lib/managers/collaboration-whitelist.js.map +1 -0
  30. package/lib/managers/collaborations.d.ts +166 -0
  31. package/lib/managers/collaborations.js +225 -258
  32. package/lib/managers/collaborations.js.map +1 -0
  33. package/lib/managers/collections.d.ts +42 -0
  34. package/lib/managers/collections.js +45 -50
  35. package/lib/managers/collections.js.map +1 -0
  36. package/lib/managers/comments.d.ts +103 -0
  37. package/lib/managers/comments.js +158 -173
  38. package/lib/managers/comments.js.map +1 -0
  39. package/lib/managers/device-pins.d.ts +52 -0
  40. package/lib/managers/device-pins.js +75 -88
  41. package/lib/managers/device-pins.js.map +1 -0
  42. package/lib/managers/enterprise.d.ts +162 -0
  43. package/lib/managers/enterprise.js +168 -199
  44. package/lib/managers/enterprise.js.map +1 -0
  45. package/lib/managers/events.d.ts +177 -0
  46. package/lib/managers/events.js +230 -254
  47. package/lib/managers/events.js.map +1 -0
  48. package/lib/managers/files.d.ts +772 -0
  49. package/lib/managers/files.js +1400 -1602
  50. package/lib/managers/files.js.map +1 -0
  51. package/lib/managers/folders.d.ts +347 -0
  52. package/lib/managers/folders.js +551 -567
  53. package/lib/managers/folders.js.map +1 -0
  54. package/lib/managers/groups.d.ts +202 -0
  55. package/lib/managers/groups.js +238 -287
  56. package/lib/managers/groups.js.map +1 -0
  57. package/lib/managers/legal-hold-policies.d.ts +190 -0
  58. package/lib/managers/legal-hold-policies.js +228 -272
  59. package/lib/managers/legal-hold-policies.js.map +1 -0
  60. package/lib/managers/metadata.d.ts +228 -0
  61. package/lib/managers/metadata.js +265 -328
  62. package/lib/managers/metadata.js.map +1 -0
  63. package/lib/managers/recent-items.d.ts +38 -0
  64. package/lib/managers/recent-items.js +32 -39
  65. package/lib/managers/recent-items.js.map +1 -0
  66. package/lib/managers/retention-policies.d.ts +213 -0
  67. package/lib/managers/retention-policies.js +235 -281
  68. package/lib/managers/retention-policies.js.map +1 -0
  69. package/lib/managers/search.d.ts +82 -0
  70. package/lib/managers/search.js +68 -88
  71. package/lib/managers/search.js.map +1 -0
  72. package/lib/managers/shared-items.d.ts +33 -0
  73. package/lib/managers/shared-items.js +54 -62
  74. package/lib/managers/shared-items.js.map +1 -0
  75. package/lib/managers/storage-policies.d.ts +86 -0
  76. package/lib/managers/storage-policies.js +108 -142
  77. package/lib/managers/storage-policies.js.map +1 -0
  78. package/lib/managers/tasks.d.ts +161 -0
  79. package/lib/managers/tasks.js +219 -260
  80. package/lib/managers/tasks.js.map +1 -0
  81. package/lib/managers/terms-of-service.d.ts +161 -0
  82. package/lib/managers/terms-of-service.js +250 -273
  83. package/lib/managers/terms-of-service.js.map +1 -0
  84. package/lib/managers/trash.d.ts +30 -0
  85. package/lib/managers/trash.js +30 -41
  86. package/lib/managers/trash.js.map +1 -0
  87. package/lib/managers/users.d.ts +131 -0
  88. package/lib/managers/users.js +160 -203
  89. package/lib/managers/users.js.map +1 -0
  90. package/lib/managers/web-links.d.ts +127 -0
  91. package/lib/managers/web-links.js +183 -209
  92. package/lib/managers/web-links.js.map +1 -0
  93. package/lib/managers/webhooks.d.ts +166 -0
  94. package/lib/managers/webhooks.js +312 -305
  95. package/lib/managers/webhooks.js.map +1 -0
  96. package/lib/sessions/anonymous-session.d.ts +69 -0
  97. package/lib/sessions/anonymous-session.js +88 -102
  98. package/lib/sessions/anonymous-session.js.map +1 -0
  99. package/lib/sessions/app-auth-session.d.ts +92 -0
  100. package/lib/sessions/app-auth-session.js +140 -160
  101. package/lib/sessions/app-auth-session.js.map +1 -0
  102. package/lib/sessions/basic-session.d.ts +56 -0
  103. package/lib/sessions/basic-session.js +40 -50
  104. package/lib/sessions/basic-session.js.map +1 -0
  105. package/lib/sessions/persistent-session.d.ts +96 -0
  106. package/lib/sessions/persistent-session.js +191 -211
  107. package/lib/sessions/persistent-session.js.map +1 -0
  108. package/lib/token-manager.d.ts +191 -0
  109. package/lib/token-manager.js +390 -465
  110. package/lib/token-manager.js.map +1 -0
  111. package/lib/util/config.d.ts +86 -0
  112. package/lib/util/config.js +124 -152
  113. package/lib/util/config.js.map +1 -0
  114. package/lib/util/errors.d.ts +50 -0
  115. package/lib/util/errors.js +134 -145
  116. package/lib/util/errors.js.map +1 -0
  117. package/lib/util/exponential-backoff.d.ts +11 -0
  118. package/lib/util/exponential-backoff.js +10 -22
  119. package/lib/util/exponential-backoff.js.map +1 -0
  120. package/lib/util/paging-iterator.d.ts +53 -0
  121. package/lib/util/paging-iterator.js +202 -218
  122. package/lib/util/paging-iterator.js.map +1 -0
  123. package/lib/util/url-path.d.ts +16 -0
  124. package/lib/util/url-path.js +20 -35
  125. package/lib/util/url-path.js.map +1 -0
  126. package/package.json +24 -9
@@ -0,0 +1 @@
1
+ {"version":3,"file":"folders.js","sourceRoot":"","sources":["../../src/managers/folders.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,8DAAuC;AACvC,0DAAoC;AAEpC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,IAAM,SAAS,GAAG,UAAU,EAC3B,WAAW,GAAG,eAAe,EAC7B,qBAAqB,GAAG,YAAY,CAAC;AAEtC,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH;IAGC,iBAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAG,GAAH,UAAI,QAAgB,EAAE,OAA6B,EAAE,QAAmB;QACvE,IAAI,MAAM,GAAG;YACZ,EAAE,EAAE,OAAO;SACX,CAAC;QACF,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,0BAAQ,GAAR,UACC,QAAgB,EAChB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACZ,EAAE,EAAE,OAAO;SACX,CAAC;QACF,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,mCAAiB,GAAjB,UACC,QAAgB,EAChB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACZ,EAAE,EAAE,OAAO;SACX,CAAC;QACF,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,wBAAM,GAAN,UAAO,cAAsB,EAAE,IAAY,EAAE,QAAmB;QAC/D,IAAI,MAAM,GAAG;YACZ,IAAI,EAAE;gBACL,IAAI,MAAA;gBACJ,MAAM,EAAE;oBACP,EAAE,EAAE,cAAc;iBAClB;aACD;SACD,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,SAAS,EACT,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,sBAAI,GAAJ,UACC,QAAgB,EAChB,WAAmB,EACnB,OAKW,EACX,QAAmB;QAEnB,kFAAkF;QAClF,0CAA0C;QAC1C,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,EAAE,CAAC;SACb;QAED,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QAExB,OAAO,CAAC,MAAM,GAAG;YAChB,EAAE,EAAE,WAAW;SACf,CAAC;QAEF,IAAI,MAAM,GAAG;YACZ,IAAI,EAAE,OAAO;SACb,CAAC;QACF,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,wBAAM,GAAN,UACC,QAAgB,EAChB,OAGC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAwB;YACjC,IAAI,EAAE,OAAO;SACb,CAAC;QAEF,IAAI,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE;YAC5B,MAAM,CAAC,OAAO,GAAG;gBAChB,UAAU,EAAE,OAAO,CAAC,IAAI;aACxB,CAAC;YACF,OAAO,OAAO,CAAC,IAAI,CAAC;SACpB;QAED,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,iCAAe,GAAf,UAAgB,QAAgB,EAAE,YAAoB,EAAE,QAAmB;QAA3E,iBAeC;QAdA,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;aAClD,IAAI,CAAC,UAAC,IAAS,CAAC,WAAW;YAC3B,IAAI,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;YAEzC,4BAA4B;YAC5B,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC,UAAC,CAAM,CAAC,WAAW,IAAK,OAAA,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,EAAd,CAAc,CAAC,CAAC;YAEtE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAC,CAAM,CAAC,WAAW,IAAK,OAAA,CAAC,CAAC,EAAE,KAAK,YAAY,EAArB,CAAqB,CAAC,EAAE;gBACrE,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;aACvC;YAED,OAAO,KAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,WAAW,aAAA,EAAE,CAAC,CAAC;QAC/C,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;;;;OAUG;IACH,sCAAoB,GAApB,UACC,QAAgB,EAChB,YAAoB,EACpB,QAAmB;QAHpB,iBAgBC;QAXA,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;aAClD,IAAI,CAAC,UAAC,IAAS,CAAC,WAAW;YAC3B,IAAI,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;YACzC,uEAAuE;YACvE,WAAW,GAAG,WAAW;iBACvB,GAAG,CAAC,UAAC,CAAM,CAAC,WAAW,IAAK,OAAA,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,EAAd,CAAc,CAAC;iBAC3C,MAAM,CAAC,UAAC,CAAM,CAAC,WAAW,IAAK,OAAA,CAAC,CAAC,EAAE,KAAK,YAAY,EAArB,CAAqB,CAAC,CAAC;YAExD,OAAO,KAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,WAAW,aAAA,EAAE,CAAC,CAAC;QAC/C,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;;;;OAUG;IACH,sBAAI,GAAJ,UAAK,QAAgB,EAAE,WAAmB,EAAE,QAAmB;QAC9D,IAAI,MAAM,GAAG;YACZ,IAAI,EAAE;gBACL,MAAM,EAAE;oBACP,EAAE,EAAE,WAAW;iBACf;aACD;SACD,CAAC;QACF,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,wBAAM,GAAN,UACC,QAAgB,EAChB,OAGC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAwB;YACjC,EAAE,EAAE,OAAO;SACX,CAAC;QAEF,IAAI,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE;YAC5B,MAAM,CAAC,OAAO,GAAG;gBAChB,UAAU,EAAE,OAAO,CAAC,IAAI;aACxB,CAAC;YACF,OAAO,OAAO,CAAC,IAAI,CAAC;SACpB;QAED,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,gCAAc,GAAd,UAAe,QAAgB,EAAE,QAAmB;QACnD,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,6BAAW,GAAX,UACC,QAAgB,EAChB,KAAa,EACb,QAAgB,EAChB,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,6BAAW,GAAX,UACC,QAAgB,EAChB,KAAa,EACb,QAAgB,EAChB,IAAyB,EACzB,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,CAAC,EACtE,MAAM,GAAG;YACR,IAAI,EAAE,IAAI;SACV,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gCAAc,GAAd,UACC,QAAgB,EAChB,KAAa,EACb,QAAgB,EAChB,KAA0B,EAC1B,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,CAAC,EACtE,MAAM,GAAG;YACR,IAAI,EAAE,KAAK;YACX,OAAO,EAAE;gBACR,cAAc,EAAE,6BAA6B;aAC7C;SACD,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,6BAAW,GAAX,UACC,QAAgB,EAChB,KAAa,EACb,QAAgB,EAChB,QAA6B,EAC7B,QAAmB;QALpB,iBAuBC;QAhBA,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC;aAC1D,KAAK,CAAC,UAAC,GAAQ,CAAC,WAAW;YAC3B,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE;gBAC3B,MAAM,GAAG,CAAC;aACV;YAED,sDAAsD;YACtD,IAAI,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,CAAC;gBACjD,EAAE,EAAE,KAAK;gBACT,IAAI,EAAE,MAAI,GAAK;gBACf,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC;aACpB,CAAC,EAJ+C,CAI/C,CAAC,CAAC;YAEJ,OAAO,KAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAChE,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,gCAAc,GAAd,UACC,QAAgB,EAChB,KAAa,EACb,QAAgB,EAChB,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,kCAAgB,GAAhB,UACC,QAAgB,EAChB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACZ,EAAE,EAAE,OAAO;SACX,CAAC;QAEF,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,kCAAgB,GAAhB,UACC,QAAgB,EAChB,OAIC,EACD,QAAmB;QAEnB,iCAAiC;QACjC,IAAI,OAAO,IAAI,OAAO,CAAC,SAAS,EAAE;YACjC,OAAO,CAAC,MAAM,GAAG;gBAChB,EAAE,EAAE,OAAO,CAAC,SAAS;aACrB,CAAC;YAEF,OAAO,OAAO,CAAC,SAAS,CAAC;SACzB;QAED,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,EACzC,MAAM,GAAG;YACR,IAAI,EAAE,OAAO,IAAI,EAAE;SACnB,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,mCAAiB,GAAjB,UACC,QAAgB,EAChB,OAGC,EACD,QAAmB;QAEnB,mEAAmE;QACnE,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,EAAE,CAAC;SACb;QAED,IAAI,MAAM,GAAwB,EAAE,CAAC;QAErC,IAAI,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE;YAC5B,MAAM,CAAC,OAAO,GAAG;gBAChB,UAAU,EAAE,OAAO,CAAC,IAAI;aACxB,CAAC;SACF;QAED,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,8BAAY,GAAZ,UACC,QAAgB,EAChB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,qBAAqB,CAAC,EAChE,MAAM,GAAG;YACR,EAAE,EAAE,OAAO;SACX,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM;aAChB,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC;aACpB,IAAI,CAAC,UAAC,QAAa,CAAC,WAAW;YAC/B,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG,EAAE;gBAChC,MAAM,gBAAM,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC;aACpD;YAED,OAAO,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;QAChC,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;;;;OAUG;IACH,gCAAc,GAAd,UACC,QAAgB,EAChB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,qBAAqB,CAAC,EAChE,MAAM,GAAG;YACR,IAAI,EAAE;gBACL,SAAS,EAAE;oBACV,OAAO,EAAE,SAAS,EAAE,kDAAkD;iBACtE;aACD;SACD,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAE9C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,iCAAe,GAAf,UAAgB,QAAgB,EAAE,QAAmB;QACpD,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,qBAAqB,CAAC,CAAC;QAElE,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,sBAAI,GAAJ,UAAK,QAAgB,EAAE,QAAmB;QACzC,IAAI,MAAM,GAAG;YACZ,IAAI,EAAE;gBACL,MAAM,EAAE;oBACP,IAAI,EAAE,QAAQ;oBACd,EAAE,EAAE,QAAQ;iBACZ;gBACD,iBAAiB,EAAE;oBAClB,IAAI,EAAE,IAAI;oBACV,MAAM,EAAE,IAAI;iBACZ;aACD;SACD,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,WAAW,EACX,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,0BAAQ,GAAR,UAAS,QAAgB,EAAE,QAAmB;QAC7C,IAAI,MAAM,GAAG;YACZ,EAAE,EAAE;gBACH,SAAS,EAAE,QAAQ;aACnB;SACD,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,WAAW,EACX,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,4BAAU,GAAV,UAAW,YAAoB,EAAE,QAAmB;QACnD,IAAI,OAAO,GAAG,kBAAO,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAEjD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IACF,cAAC;AAAD,CAAC,AAlwBD,IAkwBC;AAMD,iBAAS,OAAO,CAAC"}
@@ -0,0 +1,202 @@
1
+ /**
2
+ * @fileoverview Manager for the Groups resource
3
+ * @author mwiller
4
+ */
5
+ import BoxClient from '../box-client';
6
+ /**
7
+ * Enum of valid access levels for groups, which are used to specify who can
8
+ * perform certain actions on the group.
9
+ * @enum {GroupAccessLevel}
10
+ */
11
+ declare enum GroupAccessLevel {
12
+ ADMINS = "admins_only",
13
+ MEMBERS = "admins_and_members",
14
+ ALL_USERS = "all_managed_users"
15
+ }
16
+ /**
17
+ * Enum of valid user roles within a group
18
+ * @enum {GroupUserRole}
19
+ */
20
+ declare enum GroupUserRole {
21
+ MEMBER = "member",
22
+ ADMIN = "admin"
23
+ }
24
+ /**
25
+ * Simple manager for interacting with all 'Groups' endpoints and actions.
26
+ *
27
+ * @constructor
28
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
29
+ * @returns {void}
30
+ */
31
+ declare class Groups {
32
+ client: BoxClient;
33
+ accessLevels: typeof GroupAccessLevel;
34
+ userRoles: typeof GroupUserRole;
35
+ constructor(client: BoxClient);
36
+ /**
37
+ * Used to create a new group
38
+ *
39
+ * API Endpoint: '/groups'
40
+ * Method: POST
41
+ *
42
+ * @param {string} name - The name for the new group
43
+ * @param {Object} [options] - Additional parameters
44
+ * @param {string} [options.provenance] - Used to track the external source where the group is coming from
45
+ * @param {string} [options.external_sync_identifier] - Used as a group identifier for groups coming from an external source
46
+ * @param {string} [options.description] - Description of the group
47
+ * @param {GroupAccessLevel} [options.invitability_level] - Specifies who can invite this group to collaborate on folders
48
+ * @param {GroupAccessLevel} [options.member_viewability_level] - Specifies who can view the members of this group
49
+ * @param {Function} [callback] - Passed the new group object if it was created successfully, error otherwise
50
+ * @returns {Promise<Object>} A promise resolving to the new group object
51
+ */
52
+ create(name: string, options?: {
53
+ provenance?: string;
54
+ external_sync_identifier?: string;
55
+ description?: string;
56
+ invitability_level?: GroupAccessLevel;
57
+ member_viewability_level?: GroupAccessLevel;
58
+ }, callback?: Function): any;
59
+ /**
60
+ * Used to fetch information about a group
61
+ *
62
+ * API Endpoint: '/groups/:groupID'
63
+ * Method: GET
64
+ *
65
+ * @param {string} groupID - The ID of the group to retrieve
66
+ * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
67
+ * @param {Function} [callback] - Passed the group object if successful, error otherwise
68
+ * @returns {Promise<Object>} A promise resolving to the group object
69
+ */
70
+ get(groupID: string, options?: Record<string, any>, callback?: Function): any;
71
+ /**
72
+ * Used to update or modify a group object
73
+ *
74
+ * API Endpoint: '/groups/:groupID'
75
+ * Method: PUT
76
+ *
77
+ * @param {string} groupID - The ID of the group to update
78
+ * @param {Object} updates - Group fields to update
79
+ * @param {Function} [callback] - Passed the updated group object if successful, error otherwise
80
+ * @returns {Promise<Object>} A promise resolving to the updated group object
81
+ */
82
+ update(groupID: string, updates?: Record<string, any>, callback?: Function): any;
83
+ /**
84
+ * Delete a group
85
+ *
86
+ * API Endpoint: '/groups/:groupID'
87
+ * Method: DELETE
88
+ *
89
+ * @param {string} groupID - The ID of the group to delete
90
+ * @param {Function} [callback] - Passed nothing if successful, error otherwise
91
+ * @returns {Promise<void>} A promise resolving to nothing
92
+ */
93
+ delete(groupID: string, callback?: Function): any;
94
+ /**
95
+ * Add a user to a group, which creates a membership record for the user
96
+ *
97
+ * API Endpoint: '/group_memberships'
98
+ * Method: POST
99
+ *
100
+ * @param {string} groupID - The ID of the group to add the user to
101
+ * @param {string} userID - The ID of the user to add the the group
102
+ * @param {Object} [options] - Optional parameters for adding the user, can be left null in most cases
103
+ * @param {GroupUserRole} [options.role] - The role of the user in the group
104
+ * @param {Function} [callback] - Passed the membership record if successful, error otherwise
105
+ * @returns {Promise<Object>} A promise resolving to the new membership object
106
+ */
107
+ addUser(groupID: string, userID: string, options?: {
108
+ role?: GroupUserRole;
109
+ }, callback?: Function): any;
110
+ /**
111
+ * Fetch a specific membership record, which shows that a given user is a member
112
+ * of some group.
113
+ *
114
+ * API Endpoint: '/group_memberships/:membershipID'
115
+ * Method: GET
116
+ *
117
+ * @param {string} membershipID - The ID of the membership to fetch
118
+ * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
119
+ * @param {Function} [callback] - Passed the membership record if successful, error otherwise
120
+ * @returns {Promise<Object>} A promise resolving to the membership object
121
+ */
122
+ getMembership(membershipID: string, options?: Record<string, any>, callback?: Function): any;
123
+ /**
124
+ * Used to update or modify a group object
125
+ *
126
+ * API Endpoint: '/group_memberships/:membershipID'
127
+ * Method: PUT
128
+ *
129
+ * @param {string} membershipID - The ID of the membership to update
130
+ * @param {Object} options - Membership record fields to update
131
+ * @param {Function} [callback] - Passed the updated membership object if successful, error otherwise
132
+ * @returns {Promise<Object>} A promise resolving to the updated membership object
133
+ */
134
+ updateMembership(membershipID: string, options: Record<string, any>, callback?: Function): any;
135
+ /**
136
+ * Used to remove a group membership
137
+ *
138
+ * API Endpoint: '/group_memberships/:membershipID'
139
+ * Method: DELETE
140
+ *
141
+ * @param {string} membershipID - The ID of the membership to be removed
142
+ * @param {Function} [callback] - Passed nothing if successful, error otherwise
143
+ * @returns {Promise<void>} A promise resolving to nothing
144
+ */
145
+ removeMembership(membershipID: string, callback?: Function): any;
146
+ /**
147
+ * Retreieve a list of memberships for the group, which show which users
148
+ * belong to the group
149
+ *
150
+ * API Endpoint: '/groups/:groupID/memberships'
151
+ * Method: GET
152
+ *
153
+ * @param {string} groupID - The ID of the group to get memberships for
154
+ * @param {Object} [options] - Optional parameters, can be left null in most cases
155
+ * @param {int} [options.limit] - The number of memberships to retrieve
156
+ * @param {int} [options.offset] - Paging marker, retrieve records starting at this position in the list
157
+ * @param {Function} [callback] - Passed a list of memberships if successful, error otherwise
158
+ * @returns {Promise<Object>} A promise resolving to the collection of memberships
159
+ */
160
+ getMemberships(groupID: string, options?: {
161
+ limit?: number;
162
+ offset?: number;
163
+ }, callback?: Function): any;
164
+ /**
165
+ * Retreieve a list of groups in the caller's enterprise. This ability is
166
+ * restricted to certain users with permission to view groups.
167
+ *
168
+ * API Endpoint: '/groups'
169
+ * Method: GET
170
+ *
171
+ * @param {Object} [options] - Optional parameters, can be left null in most cases
172
+ * @param {string} [options.filter_term] - Limits the results to only groups whose name starts with the search term
173
+ * @param {int} [options.limit] - The number of memberships to retrieve
174
+ * @param {int} [options.offset] - Paging marker, retrieve records starting at this position in the list
175
+ * @param {Function} [callback] - Passed a list of groups if successful, error otherwise
176
+ * @returns {Promise<Object>} A promise resolving to the collection of groups
177
+ */
178
+ getAll(options?: {
179
+ filter_term?: string;
180
+ limit?: number;
181
+ offset?: number;
182
+ }, callback?: Function): any;
183
+ /**
184
+ * Retreieve a list of collaborations for the group, which show which items the
185
+ * group has access to.
186
+ *
187
+ * API Endpoint: '/groups/:groupID/collaborations'
188
+ * Method: GET
189
+ *
190
+ * @param {string} groupID - The ID of the group to get collaborations for
191
+ * @param {Object} [options] - Optional parameters, can be left null in most cases
192
+ * @param {int} [options.limit] - The number of memberships to retrieve
193
+ * @param {int} [options.offset] - Paging marker, retrieve records starting at this position in the list
194
+ * @param {Function} [callback] - Passed a list of collaborations if successful, error otherwise
195
+ * @returns {Promise<Object>} A promise resolving to the collection of collaborations for the group
196
+ */
197
+ getCollaborations(groupID: string, options?: {
198
+ limit?: number;
199
+ offset?: number;
200
+ }, callback?: Function): any;
201
+ }
202
+ export = Groups;