box-node-sdk 1.36.0 → 1.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +45 -3
- package/README.md +3 -1
- package/lib/api-request-manager.d.ts +38 -0
- package/lib/api-request-manager.js +48 -55
- package/lib/api-request-manager.js.map +1 -0
- package/lib/api-request.d.ts +137 -0
- package/lib/api-request.js +202 -281
- package/lib/api-request.js.map +1 -0
- package/lib/box-client.d.ts +269 -0
- package/lib/box-client.js +551 -713
- package/lib/box-client.js.map +1 -0
- package/lib/box-node-sdk.d.ts +216 -0
- package/lib/box-node-sdk.js +317 -352
- package/lib/box-node-sdk.js.map +1 -0
- package/lib/chunked-uploader.d.ts +129 -0
- package/lib/chunked-uploader.js +287 -358
- package/lib/chunked-uploader.js.map +1 -0
- package/lib/enterprise-event-stream.d.ts +82 -0
- package/lib/enterprise-event-stream.js +189 -203
- package/lib/enterprise-event-stream.js.map +1 -0
- package/lib/event-stream.d.ts +92 -0
- package/lib/event-stream.js +274 -302
- package/lib/event-stream.js.map +1 -0
- package/lib/managers/collaboration-allowlist.d.ts +137 -0
- package/lib/managers/collaboration-allowlist.js +200 -0
- package/lib/managers/collaboration-allowlist.js.map +1 -0
- package/lib/managers/collaboration-whitelist.d.ts +3 -0
- package/lib/managers/collaboration-whitelist.js +8 -222
- package/lib/managers/collaboration-whitelist.js.map +1 -0
- package/lib/managers/collaborations.d.ts +166 -0
- package/lib/managers/collaborations.js +225 -258
- package/lib/managers/collaborations.js.map +1 -0
- package/lib/managers/collections.d.ts +42 -0
- package/lib/managers/collections.js +45 -50
- package/lib/managers/collections.js.map +1 -0
- package/lib/managers/comments.d.ts +103 -0
- package/lib/managers/comments.js +158 -173
- package/lib/managers/comments.js.map +1 -0
- package/lib/managers/device-pins.d.ts +52 -0
- package/lib/managers/device-pins.js +75 -88
- package/lib/managers/device-pins.js.map +1 -0
- package/lib/managers/enterprise.d.ts +162 -0
- package/lib/managers/enterprise.js +168 -199
- package/lib/managers/enterprise.js.map +1 -0
- package/lib/managers/events.d.ts +179 -0
- package/lib/managers/events.js +232 -254
- package/lib/managers/events.js.map +1 -0
- package/lib/managers/files.d.ts +773 -0
- package/lib/managers/files.js +1401 -1602
- package/lib/managers/files.js.map +1 -0
- package/lib/managers/folders.d.ts +347 -0
- package/lib/managers/folders.js +551 -630
- package/lib/managers/folders.js.map +1 -0
- package/lib/managers/groups.d.ts +202 -0
- package/lib/managers/groups.js +238 -288
- package/lib/managers/groups.js.map +1 -0
- package/lib/managers/legal-hold-policies.d.ts +190 -0
- package/lib/managers/legal-hold-policies.js +228 -272
- package/lib/managers/legal-hold-policies.js.map +1 -0
- package/lib/managers/metadata.d.ts +228 -0
- package/lib/managers/metadata.js +265 -328
- package/lib/managers/metadata.js.map +1 -0
- package/lib/managers/recent-items.d.ts +38 -0
- package/lib/managers/recent-items.js +32 -39
- package/lib/managers/recent-items.js.map +1 -0
- package/lib/managers/retention-policies.d.ts +251 -0
- package/lib/managers/retention-policies.js +278 -281
- package/lib/managers/retention-policies.js.map +1 -0
- package/lib/managers/search.d.ts +82 -0
- package/lib/managers/search.js +68 -88
- package/lib/managers/search.js.map +1 -0
- package/lib/managers/shared-items.d.ts +33 -0
- package/lib/managers/shared-items.js +54 -62
- package/lib/managers/shared-items.js.map +1 -0
- package/lib/managers/storage-policies.d.ts +86 -0
- package/lib/managers/storage-policies.js +108 -142
- package/lib/managers/storage-policies.js.map +1 -0
- package/lib/managers/tasks.d.ts +161 -0
- package/lib/managers/tasks.js +219 -260
- package/lib/managers/tasks.js.map +1 -0
- package/lib/managers/terms-of-service.d.ts +161 -0
- package/lib/managers/terms-of-service.js +250 -273
- package/lib/managers/terms-of-service.js.map +1 -0
- package/lib/managers/trash.d.ts +30 -0
- package/lib/managers/trash.js +30 -41
- package/lib/managers/trash.js.map +1 -0
- package/lib/managers/users.d.ts +130 -0
- package/lib/managers/users.js +160 -203
- package/lib/managers/users.js.map +1 -0
- package/lib/managers/web-links.d.ts +127 -0
- package/lib/managers/web-links.js +183 -209
- package/lib/managers/web-links.js.map +1 -0
- package/lib/managers/webhooks.d.ts +166 -0
- package/lib/managers/webhooks.js +312 -305
- package/lib/managers/webhooks.js.map +1 -0
- package/lib/sessions/anonymous-session.d.ts +69 -0
- package/lib/sessions/anonymous-session.js +88 -102
- package/lib/sessions/anonymous-session.js.map +1 -0
- package/lib/sessions/app-auth-session.d.ts +92 -0
- package/lib/sessions/app-auth-session.js +140 -160
- package/lib/sessions/app-auth-session.js.map +1 -0
- package/lib/sessions/basic-session.d.ts +56 -0
- package/lib/sessions/basic-session.js +40 -50
- package/lib/sessions/basic-session.js.map +1 -0
- package/lib/sessions/persistent-session.d.ts +96 -0
- package/lib/sessions/persistent-session.js +191 -211
- package/lib/sessions/persistent-session.js.map +1 -0
- package/lib/token-manager.d.ts +191 -0
- package/lib/token-manager.js +390 -465
- package/lib/token-manager.js.map +1 -0
- package/lib/util/config.d.ts +86 -0
- package/lib/util/config.js +146 -152
- package/lib/util/config.js.map +1 -0
- package/lib/util/errors.d.ts +50 -0
- package/lib/util/errors.js +134 -145
- package/lib/util/errors.js.map +1 -0
- package/lib/util/exponential-backoff.d.ts +11 -0
- package/lib/util/exponential-backoff.js +10 -22
- package/lib/util/exponential-backoff.js.map +1 -0
- package/lib/util/paging-iterator.d.ts +53 -0
- package/lib/util/paging-iterator.js +202 -218
- package/lib/util/paging-iterator.js.map +1 -0
- package/lib/util/url-path.d.ts +16 -0
- package/lib/util/url-path.js +20 -35
- package/lib/util/url-path.js.map +1 -0
- package/package.json +14 -3
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"box-client.js","sourceRoot":"","sources":["../src/box-client.ts"],"names":[],"mappings":";AAAA;;GAEG;AAEH,qCAAmC;AA2BnC,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AACjF,IAAI,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,EACzB,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,EAC3B,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,EACjC,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,EACxC,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,EAC1B,KAAK,GAAG,OAAO,CAAC,eAAe,CAAC,EAChC,cAAc,GAAG,OAAO,CAAC,wBAAwB,CAAC,EAClD,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAElC,wBAAwB;AACxB,IAAI,KAAK,GAAG,OAAO,CAAC,kBAAkB,CAAC,EACtC,KAAK,GAAG,OAAO,CAAC,kBAAkB,CAAC,EACnC,OAAO,GAAG,OAAO,CAAC,oBAAoB,CAAC,EACvC,cAAc,GAAG,OAAO,CAAC,2BAA2B,CAAC,EACrD,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,EACrC,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,EACzC,WAAW,GAAG,OAAO,CAAC,yBAAyB,CAAC,EAChD,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,EACzC,WAAW,GAAG,OAAO,CAAC,wBAAwB,CAAC,EAC/C,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,EACrC,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,EACrC,KAAK,GAAG,OAAO,CAAC,kBAAkB,CAAC,EACnC,KAAK,GAAG,OAAO,CAAC,kBAAkB,CAAC,EACnC,UAAU,GAAG,OAAO,CAAC,uBAAuB,CAAC,EAC7C,iBAAiB,GAAG,OAAO,CAAC,gCAAgC,CAAC,EAC7D,QAAQ,GAAG,OAAO,CAAC,sBAAsB,CAAC,EAC1C,iBAAiB,GAAG,OAAO,CAAC,+BAA+B,CAAC,EAC5D,UAAU,GAAG,OAAO,CAAC,wBAAwB,CAAC,EAC9C,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,EACzC,WAAW,GAAG,OAAO,CAAC,yBAAyB,CAAC,EAChD,sBAAsB,GAAG,OAAO,CAAC,oCAAoC,CAAC,EACtE,cAAc,GAAG,OAAO,CAAC,6BAA6B,CAAC,EACvD,eAAe,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;AAE1D,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,iCAAiC;AACjC,IAAI,oBAAoB,GAAG,eAAe;AACzC,gEAAgE;AAChE,2BAA2B,GAAG,SAAS;AACvC,4BAA4B;AAC5B,aAAa,GAAG,QAAQ;AACxB,kGAAkG;AAClG,UAAU,GAAG,iBAAiB;AAC9B,iBAAiB;AACjB,cAAc,GAAG,SAAS;AAC1B,qCAAqC;AACrC,oCAAoC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAEnD;;;;;;GAMG;AACH,SAAS,wBAAwB,CAAC,WAAmB;IACpD,OAAO,2BAA2B,GAAG,WAAW,CAAC;AAClD,CAAC;AAED;;;;;GAKG;AACH,SAAS,qCAAqC,CAAC,QAAa,CAAC,WAAW;IACvE,qCAAqC;IACrC,wHAAwH;IACxH,0JAA0J;IAC1J,iJAAiJ;IACjJ,2CAA2C;IAE3C,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QACnC,OAAO,KAAK,CAAC;KACb;IAED,IAAI,gCAAgC,GAClC,QAAQ,CAAC,UAAU,KAAK,eAAe,CAAC,YAAY,EACrD,mBAAmB,GAClB,CAAC,QAAQ,CAAC,IAAI,IAAI,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;IAC3E,OAAO,gCAAgC,IAAI,mBAAmB,CAAC;AAChE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,UAAU,CAAC,eAAuB,EAAE,GAAW;IACvD,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAC7B,OAAO,GAAG,CAAC;KACX;IACD,OAAO,eAAe,GAAG,GAAG,CAAC;AAC9B,CAAC;AAED;;;;;;GAMG;AACH,SAAS,qBAAqB,CAAC,MAAuC;IACrE,IAAI,YAAY,GAAI,MAAM,CAAC,GAAc,CAAC,OAAO,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC;IAE7E,OAAO;QACN,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,YAAY,EACX,YAAY,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,MAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;KACvB,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,sBAAsB,CAAC,QAAa,CAAC,WAAW;IACxD,OAAO;QACN,UAAU,EAAE,QAAQ,CAAC,MAAM;QAC3B,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,IAAI,EAAE,QAAQ,CAAC,QAAQ;KACvB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,oBAAoB,CAAC,MAAW,CAAC,WAAW;IACpD,IAAI,oBAAoB,GAAG;QAC1B,KAAK,EAAE,kBAAgB,GAAG,CAAC,OAAS;QACpC,GAAG,EAAE,UAAQ,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAG;KACrB,CAAC;IAE5B,IAAI,MAAM,EAAE;QACX,oBAAoB,CAAC,MAAM,GAAM,MAAM,CAAC,IAAI,SAAI,MAAM,CAAC,OAAS,CAAC;KACjE;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC;SACtC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAG,CAAC,SAAI,oBAAoB,CAAC,CAAC,CAAG,EAAjC,CAAiC,CAAC;SAC7C,IAAI,CAAC,IAAI,CAAC,CAAC;AACd,CAAC;AAED;IA+CC;;;;;;;;;;OAUG;IACH,mBACC,UAAsB,EACtB,MAAW,CAAC,WAAW,EACvB,cAAiC;QA0XlC;;;;;;;WAOG;QACH,UAAK,GAAG,IAAI,CAAC,SAAS,CAAC;YACtB,oCAAoC;YACpC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;YACZ,mCAAmC;QACpC,CAAC,EAAE,oFAAoF,CAAC,CAAC;QAEzF;;;;;;WAMG;QACH,cAAS,GAAG,IAAI,CAAC,SAAS,CAAC,UAA2B,QAAkB;YACvE,oCAAoC;YACpC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACjB,OAAO,kBAAO,CAAC,MAAM,CACpB,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAChD,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;aACvB;YAED,IAAI,MAAM,GAAG;gBACZ,IAAI,EAAE;oBACL,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAC,QAAa,CAAC,WAAW;wBACnD,OAAA,qBAAqB,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAAtC,CAAsC,CACtC;iBACD;aACD,CAAC;YAEF,IAAI,KAAK,GAAU,IAAI,CAAC,MAAM,CAAC;YAC/B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YACnB,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;iBAChC,IAAI,CAAC,UAAC,GAAQ,CAAC,WAAW;gBAC1B,IAAI,SAAS,GAAU,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC;gBAE1C,SAAS;qBACP,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,sBAAsB,CAAC,CAAC,CAAC,EAAzB,CAAyB,CAAC;qBACrC,OAAO,CAAC,UAAC,QAAQ,EAAE,KAAK;oBACxB,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChC,CAAC,CAAC,CAAC;gBAEJ,OAAO,GAAG,CAAC,IAAI,CAAC;YACjB,CAAC,CAAC;iBACD,KAAK,CAAC,UAAC,GAAQ;gBACf,KAAK,CAAC,OAAO,CAAC,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAf,CAAe,CAAC,CAAC;gBAExC,MAAM,GAAG,CAAC;YACX,CAAC,CAAC;iBACD,UAAU,CAAC,QAAQ,CAAC,CAAC;YACvB,mCAAmC;QACpC,CAAC,EAAE,oFAAoF,CAAC,CAAC;QAnbxF,wDAAwD;QACxD,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC;QAE3B,wDAAwD;QACxD,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QAEtC,mGAAmG;QACnG,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,mCAAmC;QACnC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QAC3E,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAChC,OAAO,EACP,MAAM,CAAC,gBAAgB,EACvB,MAAM,CAAC,UAAU,CACjB,CAAC;QACF,IAAI,CAAC,uBAAuB,GAAG,MAAM,CAAC,sBAAsB,CAAC;QAC7D,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,eAAe,CAAC;QAE/C,+BAA+B;QAC/B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,sBAAsB,GAAG,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC/D,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;QAEjD,8BAA8B;QAC9B,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,CAAC;QAE1D,uDAAuD;QACvD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;;;;OASG;IACH,4CAAwB,GAAxB,UAAyB,aAA4B,EAAE,WAAmB;QACzE,IAAI,OAAO,GAA2B,EAAE,CAAC;QAEzC,uEAAuE;QACvE,OAAO,CAAC,oBAAoB,CAAC,GAAG,wBAAwB,CAAC,WAAW,CAAC,CAAC;QAEtE,8GAA8G;QAC9G,qDAAqD;QACrD,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAE3D,2DAA2D;QAC3D,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YACtB,UAAU,EAAE,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,CAAC;SACvD,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IAChB,CAAC;IAED;;;;;;;;;;OAUG;IACH,gCAAY,GAAZ,UAAa,MAAW,CAAC,WAAW,EAAE,QAAmB;QAAzD,iBAkEC;QAjEA,IAAI,OAAO,CAAC;QAEZ,IAAI,IAAI,CAAC,MAAM,EAAE;YAChB,6CAA6C;YAC7C,OAAO,GAAG,IAAI,kBAAO,CAAC,UAAC,OAAO,EAAE,MAAM;gBACrC,KAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,QAAA,EAAE,OAAO,SAAA,EAAE,MAAM,QAAA,EAAE,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;SACH;aAAM;YACN,kFAAkF;YAClF,OAAO,GAAG,IAAI,CAAC,QAAQ;iBACrB,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC;iBAClC,IAAI,CAAC,UAAC,WAAmB;gBACzB,MAAM,CAAC,OAAO,GAAG,KAAI,CAAC,wBAAwB,CAC7C,MAAM,CAAC,OAAO,EACd,WAAW,CACX,CAAC;gBAEF,IAAI,MAAM,CAAC,SAAS,EAAE;oBACrB,+EAA+E;oBAC/E,OAAO,MAAM,CAAC,SAAS,CAAC;oBACxB,IAAI,cAAc,GACjB,KAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;oBACnD,yGAAyG;oBACzG,8BAA8B;oBAC9B,cAAc,CAAC,EAAE,CAAC,UAAU,EAAE,UAAC,QAAa,CAAC,WAAW;wBACvD,IAAI,qCAAqC,CAAC,QAAQ,CAAC,EAAE;4BACpD,IAAI,kBAAkB,GAAG,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;4BAEzD,sGAAsG;4BACtG,IAAI,KAAI,CAAC,QAAQ,CAAC,wBAAwB,EAAE;gCAC3C,KAAI,CAAC,QAAQ,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC;6BAC3D;yBACD;oBACF,CAAC,CAAC,CAAC;oBAEH,OAAO,cAAc,CAAC;iBACtB;gBAED,kEAAkE;gBAClE,OAAO,KAAI,CAAC,eAAe,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,OAAO;aACZ,IAAI,CAAC,UAAC,QAAa,CAAC,WAAW;YAC/B,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE;gBACzB,yFAAyF;gBACzF,0EAA0E;gBAC1E,OAAO,QAAQ,CAAC;aAChB;YAED,IAAI,qCAAqC,CAAC,QAAQ,CAAC,EAAE;gBACpD,IAAI,kBAAkB,GAAG,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;gBAEzD,sGAAsG;gBACtG,IAAI,KAAI,CAAC,QAAQ,CAAC,wBAAwB,EAAE;oBAC3C,OAAO,KAAI,CAAC,QAAQ,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC;iBAClE;gBAED,MAAM,kBAAkB,CAAC;aACzB;YAED,OAAO,QAAQ,CAAC;QACjB,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,mCAAe,GAAf,UAAgB,MAAc,EAAE,KAAU;QACzC,IAAI,KAAK,EAAE;YACV,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;SACpC;aAAM;YACN,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;SACnC;IACF,CAAC;IAED;;;;;;OAMG;IACH,0BAAM,GAAN,UAAO,GAAa;QACnB,IAAI,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,UAAC,QAAgB,IAAK,OAAA,IAAI,CAAC,QAAQ,CAAC,EAAd,CAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE3E,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAE3C,IAAI,CAAC,aAAa,GAAG,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACH,oCAAgB,GAAhB,UAAiB,GAAW,EAAE,QAAuB;QACpD,IAAI,uBAAuB,GAAG,IAAI,CAAC,yBAAyB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC5E,IAAI,CAAC,eAAe,CAAC,aAAa,EAAE,uBAAuB,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,uCAAmB,GAAnB;QACC,IAAI,CAAC,eAAe,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACH,0BAAM,GAAN,UAAO,MAAc;QACpB,IAAI,CAAC,eAAe,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACH,0BAAM,GAAN;QACC,IAAI,CAAC,eAAe,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACH,gCAAY,GAAZ,UAAa,QAAkB;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;OASG;IACH,iCAAa,GAAb,UACC,MAAyB,EACzB,QAAiB,EACjB,OAA2B,EAC3B,QAAmB;QAEnB,8BAA8B;QAC9B,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,EAAE,CAAC;SACb;QAED,IAAI,IAAI,GAAG,MAAM,CAAC,MAAM,CACvB,EAAE,mBAAmB,EAAE,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE,EACnD,OAAO,CACP,CAAC;QAEF,OAAO,IAAI,CAAC,QAAQ;aAClB,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC;aACrC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,uBAAG,GAAH,UAAI,IAAY,EAAE,MAAsB,EAAE,QAAmB;QAC5D,IAAI,SAAS,GAAG,KAAK,CAAC,EAAE,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;QACxC,SAAS,CAAC,MAAM,GAAG,KAAK,CAAC;QACzB,SAAS,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAEhD,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,wBAAI,GAAJ,UAAK,IAAY,EAAE,MAAqB,EAAE,QAAmB;QAC5D,IAAI,SAAS,GAAG,KAAK,CAAC,EAAE,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;QACxC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC;QAC1B,SAAS,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,uBAAG,GAAH,UAAI,IAAY,EAAE,MAAsB,EAAE,QAAmB;QAC5D,IAAI,SAAS,GAAG,KAAK,CAAC,EAAE,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;QACxC,SAAS,CAAC,MAAM,GAAG,KAAK,CAAC;QACzB,SAAS,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,uBAAG,GAAH,UAAI,IAAY,EAAE,MAAqB,EAAE,QAAkB;QAC1D,IAAI,SAAS,GAAG,KAAK,CAAC,EAAE,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;QACxC,SAAS,CAAC,MAAM,GAAG,QAAQ,CAAC;QAC5B,SAAS,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,2BAAO,GAAP,UAAQ,IAAY,EAAE,MAAqB,EAAE,QAAmB;QAC/D,IAAI,SAAS,GAAG,KAAK,CAAC,EAAE,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;QACxC,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC;QAC7B,SAAS,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAEhD,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,0BAAM,GAAN,UACC,IAAY,EACZ,MAAqB,EACrB,QAAuB,EACvB,QAAkB;QAElB,IAAI,QAAQ,GAAG;YACd,MAAM,EAAE,MAAM;SACd,CAAC;QACF,IAAI,SAAS,GAAG,KAAK,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;QAC9C,SAAS,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACtD,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC9B,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC,uBAAuB,CAAC;QAEjD,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IA+DD;;;;;;OAMG;IACH,6CAAyB,GAAzB,UAA0B,GAAW,EAAE,QAAuB;QAC7D,IAAI,UAAU,GAAG,kBAAkB,CAAC,GAAG,CAAC,EACvC,eAAe,GAAG,kBAAkB,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CAAC;QAEtD,IAAI,QAAQ,EAAE;YACb,OAAO,IAAI,CAAC,MAAM,CACjB,wCAAwC,EACxC,UAAU,EACV,eAAe,CACf,CAAC;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;OAOG;IACH,0CAAsB,GAAtB,UAAuB,QAAkB;QACxC,IAAI,IAAI,GAAG,IAAI,CAAC;QAEhB,IAAI,CAAC,QAAQ,EAAE;YACd,OAAO,IAAI,CAAC;SACZ;QAED,OAAO,UAAU,GAAQ,EAAE,QAAa,CAAC,WAAW;YACnD,qBAAqB;YACrB,IAAI,GAAG,EAAE;gBACR,QAAQ,CAAC,GAAG,CAAC,CAAC;gBACd,OAAO;aACP;YAED,sBAAsB;YACtB,IACC,QAAQ,CAAC,UAAU,IAAI,oCAAoC,CAAC,CAAC,CAAC;gBAC9D,QAAQ,CAAC,UAAU,IAAI,oCAAoC,CAAC,CAAC,CAAC,EAC7D;gBACD,IAAI,IAAI,CAAC,aAAa,IAAI,cAAc,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;oBAC9D,QAAQ,CAAC,IAAI,EAAE,IAAI,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;oBACnD,OAAO;iBACP;gBAED,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC9B,OAAO;aACP;YACD,sBAAsB;YACtB,QAAQ,CAAC,MAAM,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzD,CAAC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,0CAAsB,GAAtB,UAAuB,MAAgB;QACtC,IAAI,IAAI,GAAG,IAAI,CAAC;QAChB,OAAO,SAAS,mBAAmB,EAAC,eAAe;YAClD,2CAA2C;YAC3C,IAAI,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,EAC5C,QAAQ,CAAC;YACV,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;gBAClC,QAAQ,GAAG,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;gBAChD,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC;aAC3C;YAED,IAAI,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAExC,IAAI,GAAG,YAAY,kBAAO,EAAE;gBAC3B,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,UAAC,QAAQ;oBACvB,IACC,QAAQ,CAAC,UAAU,IAAI,oCAAoC,CAAC,CAAC,CAAC;wBAC9D,QAAQ,CAAC,UAAU,IAAI,oCAAoC,CAAC,CAAC,CAAC,EAC7D;wBACD,IAAI,IAAI,CAAC,aAAa,IAAI,cAAc,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;4BAC9D,OAAO,IAAI,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;yBAC1C;wBAED,OAAO,QAAQ,CAAC,IAAI,CAAC;qBACrB;oBAED,MAAM,MAAM,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC;gBACrD,CAAC,CAAC,CAAC;aACH;YAED,IAAI,QAAQ,EAAE;gBACb,wEAAwE;gBACxE,GAAG,CAAC,2BAA2B,EAAE,CAAC;aAClC;YAED,OAAO,GAAG,CAAC;QACZ,CAAC,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,wBAAI,GAAJ,UAAK,IAAY,EAAE,MAAgB,EAAE,OAAe;QACnD,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QAExB,IAAI,IAAI,IAAI,IAAI,IAAI,OAAQ,IAAY,CAAC,IAAI,CAAC,KAAK,UAAU,EAAE;YAC9D,MAAM,IAAI,KAAK,CACd,4EAA4E,CAC5E,CAAC;SACF;QAED,+CAA+C;QAC9C,IAAY,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IACF,gBAAC;AAAD,CAAC,AAlnBD,IAknBC;AAED,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;GAKG;AACH,SAAS,CAAC,SAAS,CAAC,kBAAkB,GAAG;IACxC,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,kBAAkB,EAAE,oBAAoB;IACxC,eAAe,EAAE,iBAAiB;IAClC,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;CACd,CAAC;AAEF;;;;;GAKG;AACH,SAAS,CAAC,SAAS,CAAC,SAAS,GAAG;IAC/B,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;CAChB,CAAC;AAEF;;;;;;GAMG;AACH,SAAS,CAAC,SAAS,CAAC,YAAY,GAAG;IAClC,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;IACxB,aAAa,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE;IAC1C,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE;IAC9B,OAAO,EAAE,EAAE;IACX,QAAQ,EAAE,IAAI;CACd,CAAC;AAEF,sBAAsB;AACtB,SAAS,CAAC,SAAS,CAAC,eAAe,GAAG,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC;AAUtE,iBAAS,SAAS,CAAC"}
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Box SDK for Node.js
|
|
3
|
+
*/
|
|
4
|
+
/// <reference types="node" />
|
|
5
|
+
/// <reference types="bluebird" />
|
|
6
|
+
import { EventEmitter } from 'events';
|
|
7
|
+
import AnonymousAPISession = require('./sessions/anonymous-session');
|
|
8
|
+
import APIRequestManager = require('./api-request-manager');
|
|
9
|
+
import BoxClient = require('./box-client');
|
|
10
|
+
import TokenManager = require('./token-manager');
|
|
11
|
+
/**
|
|
12
|
+
* Object representing interface functions for PersistentClient to interact with the consumer app's central storage layer.
|
|
13
|
+
* @typedef {Object} TokenStore
|
|
14
|
+
* @property {ReadTokenInfoFromStore} read - read TokenInfo from app central store.
|
|
15
|
+
* @property {WriteTokenInfoToStore} write - write TokenInfo to the app's central store.
|
|
16
|
+
* @property {ClearTokenInfoFromStore} clear - delete TokenInfo from the app's central store.
|
|
17
|
+
*/
|
|
18
|
+
/**
|
|
19
|
+
* Acquires TokenInfo from the consumer app's central store.
|
|
20
|
+
* @typedef {Function} ReadTokenInfoFromStore
|
|
21
|
+
* @param {Function} callback - err if store read issue occurred, otherwise propagates a TokenInfo object
|
|
22
|
+
*/
|
|
23
|
+
/**
|
|
24
|
+
* Writes TokenInfo to the consumer app's central store
|
|
25
|
+
* @typedef {Function} WriteTokenInfoToStore
|
|
26
|
+
* @param {TokenInfo} tokenInfo - the token info to be written
|
|
27
|
+
* @param {Function} callback - err if store write issue occurred, otherwise propagates null err
|
|
28
|
+
* and null result to indicate success
|
|
29
|
+
*/
|
|
30
|
+
/**
|
|
31
|
+
* Clears TokenInfo from the consumer app's central store
|
|
32
|
+
* @typedef {Function} ClearTokenInfoFromStore
|
|
33
|
+
* @param {Function} callback - err if store delete issue occurred, otherwise propagates null err
|
|
34
|
+
* and null result to indicate success
|
|
35
|
+
*/
|
|
36
|
+
declare type TokenStore = object;
|
|
37
|
+
declare type UserConfigurationOptions = object;
|
|
38
|
+
declare type TokenRequestOptions = object;
|
|
39
|
+
/**
|
|
40
|
+
* A backend NodeJS SDK to interact with the Box V2 API.
|
|
41
|
+
* This is the single entry point for all SDK consumer interactions. This is the only file that a 3rd party app
|
|
42
|
+
* should require. All other components are private and reached out to via this component.
|
|
43
|
+
* 1. Provides getters to spawn client instances for users to interact with the Box API.
|
|
44
|
+
* 2. Provides manual capability to acquire tokens via token grant endpoints.
|
|
45
|
+
* However, it is recommended to use clients to do this for you.
|
|
46
|
+
* 3. Emits notification events about relevant request/response events. Useful for logging Box API interactions.
|
|
47
|
+
* Notification events: request retries, exceeding max retries, permanent failures.
|
|
48
|
+
*
|
|
49
|
+
* @param {UserConfigurationOptions} params User settings used to initialize and customize the SDK
|
|
50
|
+
* @constructor
|
|
51
|
+
*/
|
|
52
|
+
declare class BoxSDKNode extends EventEmitter {
|
|
53
|
+
accessLevels: any;
|
|
54
|
+
collaborationRoles: any;
|
|
55
|
+
CURRENT_USER_ID: any;
|
|
56
|
+
config: any;
|
|
57
|
+
_eventBus: EventEmitter;
|
|
58
|
+
requestManager: APIRequestManager;
|
|
59
|
+
tokenManager: TokenManager;
|
|
60
|
+
anonymousSession: AnonymousAPISession;
|
|
61
|
+
/**
|
|
62
|
+
* Expose the BoxClient property enumerations to the SDK as a whole. This allows
|
|
63
|
+
* the consumer to access and use these values from anywhere in their application
|
|
64
|
+
* (like a helper) by requiring the SDK, instead of needing to pass the client.
|
|
65
|
+
*/
|
|
66
|
+
static accessLevels: any;
|
|
67
|
+
static collaborationRoles: any;
|
|
68
|
+
static CURRENT_USER_ID: any;
|
|
69
|
+
/**
|
|
70
|
+
* Expose Webhooks.validateMessage() to the SDK as a whole. This allows
|
|
71
|
+
* the consumer to call BoxSDK.validateWebhookMessage() by just requiring the SDK,
|
|
72
|
+
* instead of needing to create a client (which is not needed to validate messages).
|
|
73
|
+
*/
|
|
74
|
+
static validateWebhookMessage: any;
|
|
75
|
+
constructor(params: UserConfigurationOptions);
|
|
76
|
+
/**
|
|
77
|
+
* Setup the SDK instance by instantiating necessary objects with current
|
|
78
|
+
* configuration values.
|
|
79
|
+
*
|
|
80
|
+
* @returns {void}
|
|
81
|
+
* @private
|
|
82
|
+
*/
|
|
83
|
+
_setup(): void;
|
|
84
|
+
/**
|
|
85
|
+
* Gets the BoxSDKNode instance by passing boxAppSettings json downloaded from the developer console.
|
|
86
|
+
*
|
|
87
|
+
* @param {Object} appConfig boxAppSettings object retrieved from Dev Console.
|
|
88
|
+
* @returns {BoxSDKNode} an instance that has been preconfigured with the values from the Dev Console
|
|
89
|
+
*/
|
|
90
|
+
static getPreconfiguredInstance(appConfig: any): BoxSDKNode;
|
|
91
|
+
/**
|
|
92
|
+
* Updates the SDK configuration with new parameters.
|
|
93
|
+
*
|
|
94
|
+
* @param {UserConfigurationOptions} params User settings
|
|
95
|
+
* @returns {void}
|
|
96
|
+
*/
|
|
97
|
+
configure(params: UserConfigurationOptions): void;
|
|
98
|
+
/**
|
|
99
|
+
* Returns a Box Client with a Basic API Session. The client is able to make requests on behalf of a user.
|
|
100
|
+
* A basic session has no access to a user's refresh token. Because of this, once the session's tokens
|
|
101
|
+
* expire the client cannot recover and a new session will need to be generated.
|
|
102
|
+
*
|
|
103
|
+
* @param {string} accessToken A user's Box API access token
|
|
104
|
+
* @returns {BoxClient} Returns a new Box Client paired to a new BasicAPISession
|
|
105
|
+
*/
|
|
106
|
+
getBasicClient(accessToken: string): BoxClient;
|
|
107
|
+
/**
|
|
108
|
+
* Returns a Box Client with a Basic API Session. The client is able to make requests on behalf of a user.
|
|
109
|
+
* A basic session has no access to a user's refresh token. Because of this, once the session's tokens
|
|
110
|
+
* expire the client cannot recover and a new session will need to be generated.
|
|
111
|
+
*
|
|
112
|
+
* @param {string} accessToken A user's Box API access token
|
|
113
|
+
* @returns {BoxClient} Returns a new Box Client paired to a new BasicAPISession
|
|
114
|
+
*/
|
|
115
|
+
static getBasicClient(accessToken: string): BoxClient;
|
|
116
|
+
/**
|
|
117
|
+
* Returns a Box Client with a persistent API session. A persistent API session helps manage the user's tokens,
|
|
118
|
+
* and can refresh them automatically if the access token expires. If a central data-store is given, the session
|
|
119
|
+
* can read & write tokens to it.
|
|
120
|
+
*
|
|
121
|
+
* NOTE: If tokenInfo or tokenStore are formatted incorrectly, this method will throw an error. If you
|
|
122
|
+
* haven't explicitly created either of these objects or are otherwise not completly confident in their validity,
|
|
123
|
+
* you should wrap your call to getPersistentClient in a try-catch to handle any potential errors.
|
|
124
|
+
*
|
|
125
|
+
* @param {TokenInfo} tokenInfo A tokenInfo object to use for authentication
|
|
126
|
+
* @param {TokenStore} [tokenStore] An optional token store for reading/writing tokens to session
|
|
127
|
+
* @returns {BoxClient} Returns a new Box Client paired to a new PersistentAPISession
|
|
128
|
+
*/
|
|
129
|
+
getPersistentClient(tokenInfo: any, tokenStore?: TokenStore): BoxClient;
|
|
130
|
+
/**
|
|
131
|
+
* Returns A Box Client with an Anonymous API Session. An Anonymous API Session has access to an anonymous
|
|
132
|
+
* client-credentials token, which isn't tied to any specific user. Because of this, the client will only
|
|
133
|
+
* have access to endpoints that allow client-credential tokens. All Anonymous API Sessions share the
|
|
134
|
+
* same tokens, which allows them to refresh them efficiently and reduce load on both the application and
|
|
135
|
+
* the API.
|
|
136
|
+
*
|
|
137
|
+
* @returns {BoxClient} Returns a new Box Client paired to a AnonymousAPISession
|
|
138
|
+
*/
|
|
139
|
+
getAnonymousClient(): BoxClient;
|
|
140
|
+
/**
|
|
141
|
+
* Create a new client using App Auth for the given entity. This allows either
|
|
142
|
+
* managing App Users (as the enterprise) or performing operations as the App
|
|
143
|
+
* Users themselves (as a user).
|
|
144
|
+
*
|
|
145
|
+
* @param {string} type The type of entity to operate as, "enterprise" or "user"
|
|
146
|
+
* @param {string} [id] (Optional) The Box ID of the entity to operate as
|
|
147
|
+
* @param {TokenStore} [tokenStore] (Optional) the token store to use for caching tokens
|
|
148
|
+
* @returns {BoxClient} A new client authorized as the app user or enterprise
|
|
149
|
+
*/
|
|
150
|
+
getAppAuthClient(type: string, id?: string, tokenStore?: TokenStore): BoxClient;
|
|
151
|
+
/**
|
|
152
|
+
* Generate the URL for the authorize page to send users to for the first leg of
|
|
153
|
+
* the OAuth2 flow.
|
|
154
|
+
*
|
|
155
|
+
* @param {Object} params The OAuth2 parameters
|
|
156
|
+
* @returns {string} The authorize page URL
|
|
157
|
+
*/
|
|
158
|
+
getAuthorizeURL(params: {
|
|
159
|
+
client_id?: string;
|
|
160
|
+
}): string;
|
|
161
|
+
/**
|
|
162
|
+
* Acquires token info using an authorization code
|
|
163
|
+
*
|
|
164
|
+
* @param {string} authorizationCode - authorization code issued by Box
|
|
165
|
+
* @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
|
|
166
|
+
* @param {Function} [callback] - passed a TokenInfo object if tokens were granted successfully
|
|
167
|
+
* @returns {Promise<TokenInfo>} Promise resolving to the token info
|
|
168
|
+
*/
|
|
169
|
+
getTokensAuthorizationCodeGrant(authorizationCode: string, options: TokenRequestOptions | null, callback: Function): import("bluebird")<{
|
|
170
|
+
accessToken: any;
|
|
171
|
+
refreshToken: any;
|
|
172
|
+
accessTokenTTLMS: number;
|
|
173
|
+
acquiredAtMS: number;
|
|
174
|
+
}>;
|
|
175
|
+
/**
|
|
176
|
+
* Refreshes the access and refresh tokens for a given refresh token.
|
|
177
|
+
*
|
|
178
|
+
* @param {string} refreshToken - A valid OAuth refresh token
|
|
179
|
+
* @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
|
|
180
|
+
* @param {Function} [callback] - passed a TokenInfo object if tokens were granted successfully
|
|
181
|
+
* @returns {Promise<TokenInfo>} Promise resolving to the token info
|
|
182
|
+
*/
|
|
183
|
+
getTokensRefreshGrant(refreshToken: string, options: TokenRequestOptions | Function | null, callback: Function): import("bluebird")<{
|
|
184
|
+
accessToken: any;
|
|
185
|
+
refreshToken: any;
|
|
186
|
+
accessTokenTTLMS: number;
|
|
187
|
+
acquiredAtMS: number;
|
|
188
|
+
}>;
|
|
189
|
+
/**
|
|
190
|
+
* Gets tokens for enterprise administration of app users
|
|
191
|
+
* @param {string} enterpriseID The ID of the enterprise to generate a token for
|
|
192
|
+
* @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
|
|
193
|
+
* @param {Function} [callback] Passed the tokens if successful
|
|
194
|
+
* @returns {Promise<TokenInfo>} Promise resolving to the token info
|
|
195
|
+
*/
|
|
196
|
+
getEnterpriseAppAuthTokens(enterpriseID: string, options: TokenRequestOptions | Function | null, callback: Function): import("bluebird")<any>;
|
|
197
|
+
/**
|
|
198
|
+
* Gets tokens for App Users via a JWT grant
|
|
199
|
+
* @param {string} userID The ID of the App User to generate a token for
|
|
200
|
+
* @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
|
|
201
|
+
* @param {Function} [callback] Passed the tokens if successful
|
|
202
|
+
* @returns {Promise<TokentInfo>} Promise reolving to the token infp
|
|
203
|
+
*/
|
|
204
|
+
getAppUserTokens(userID: string, options: TokenRequestOptions | Function | null, callback: Function): import("bluebird")<any>;
|
|
205
|
+
/**
|
|
206
|
+
* Revokes a token pair associated with a given access or refresh token.
|
|
207
|
+
*
|
|
208
|
+
* @param {string} token - A valid access or refresh token to revoke
|
|
209
|
+
* @param {TokenRequestOptions} [options] - Sets optional behavior for the token grant, null for default behavior
|
|
210
|
+
* @param {Function} [callback] - If err, revoke failed. Otherwise, revoke succeeded.
|
|
211
|
+
* @returns {Promise<TokenInfo>} Promise resolving to the token info
|
|
212
|
+
*/
|
|
213
|
+
revokeTokens(token: string, options: TokenRequestOptions | Function | null, callback: Function): import("bluebird")<unknown>;
|
|
214
|
+
}
|
|
215
|
+
/** @module box-node-sdk/lib/box-node-sdk */
|
|
216
|
+
export = BoxSDKNode;
|