Releases: box/box-node-sdk
Release list
v10.1.0
Bug Fixes
- Fix error handling in TS (box/box-codegen#882) (#1180) (2b68145)
- Fix error propagation and empty fetch response handling in node SDK (box/box-codegen#883) (#1192) (5664231)
- Remove enum types from GET enterprise configurations endpoint (box/box-openapi#560) (#1155) (3ba01aa), closes box/box-openapi#558 box/box-openapi#558 box/box-openapi#559 box/box-codegen#869 box/box-codegen#871 box/box-codegen#872
New Features and Enhancements
v4.1.0
Bug Fixes
- boxsdkgen: Fix error handling in TS (box/box-codegen#882) (#1182) (c6c0f50)
- boxsdkgen: Remove enum types from GET enterprise configurations endpoint (box/box-openapi#560) (#1154) (5fd824b), closes box/box-codegen#869 box/box-openapi#559 box/box-codegen#872
New Features and Enhancements
v4.0.0
Introducing a new major version of Box Node SDK v4 that includes two modules — the manually maintained module and the generated module. The coexisting modules provide easier access to the latest Box API features and support gradual migration to the standalone generated module.
Breaking Changes
-
With
v4of Box Node SDK, support for Node version below 18 has been dropped. While it may still be possible to download and use this SDK under Node below 18, we do not provide support for issues encountered on that version. -
We have updated the module export style in the manually maintained
box-node-sdkmodule to support the ES module and be more consistent with the generatedsdk-genmodule. Classes in the manual SDK are now exported as default exports from their respective files. When importing via CommonJS (require), use.defaultto access the class (e.g.,const BoxSDK = require('box-node-sdk').default;).
For more information about migrating to v4 visit v3 to v4 migration guide
What's New in v4
With this SDK version, alongside the existing manually maintained module, we’re introducing a new generated sdk-gen module under box-node-sdk/sdk-gen import path, which gives you access to:
-
Full API Support — Complete coverage of the Box API ecosystem, giving you access to all the latest features and functionalities to build feature-rich applications.
-
Rapid API Updates — Our new auto-generation approach enables Box API additions within days, ensuring you can leverage the most up-to-date features without delay.
-
Embedded Documentation — All objects and parameters are documented directly in the SDK source code, keeping essential information in one place.
-
Enhanced Convenience Methods — New methods for authentication, chunk uploads, automatic retries, retry strategy, and more.
Important Notes
This version allows you to gradually migrate your codebase to the sdk-gen module. The key differences between the modules are documented in the module migration guide.
Ultimately, we recommend to migrate to v10 which includes only the generated sdk-gen module. To migrate from v4 to v10 follow this migration guide.
For more information, see the SDK versioning strategy document. Follow developer changelog for future updates.
v10.0.1
Bug Fixes
- Allow flexible key-value data in
AiExtractStructuredResponse.answerandEvent.additionalDetails(box/box-openapi#556) (#1051) (70a2275) - Make
roleparameter of update collaboration optional (box/box-openapi#557) (#1068) (3992171) - Relax JSON deserialization guard by removing strict
content-typecheck (box/box-codegen#844) (#1033) (1eb2c32)
v10.0.0
Introducing Box Node SDK v10, a major release designed to elevate your developer experience and streamline integration with Box Content Cloud. Currently available as a separate sdk-gen branch, v10 will ultimately become the main branch.
Breaking Changes
- This SDK version is auto-generated and introduces a new interface for all methods. Extensive documentation is available here.
What's New in v10
-
Full API Support — Complete coverage of the Box API ecosystem, giving you access to all the latest features and functionalities to build feature-rich applications.
-
Rapid API Updates — Our new auto-generation approach enables Box API additions within days, ensuring you can leverage the most up-to-date features without delay.
-
Embedded Documentation — All objects and parameters are documented directly in the SDK source code, keeping essential information in one place.
-
Enhanced Convenience Methods — New methods for authentication, chunk uploads, automatic retries, retry strategy, and more.
Important Notes
This version includes the Box Next Generation SDK artifact, previously developed in parallel to core Box SDKs. To facilitate migration and provide access to the newest features, we'll soon release an additional major version combining both artifacts. Migration to v10 includes breaking changes, please review the migration guide for details. For more information, see the SDK versioning strategy document. Follow developer changelog for future updates.
What’s New Compared to Typescript SDK Gen v1.19.1
⚠ BREAKING CHANGES
- Change names of unions (box/box-codegen#787) (#938) (06a8e9b)
- Remove unused models from schemas (box/box-openapi#547) (#933) (35690f4), closes box/box-codegen#773 box/box-openapi#542 box/box-openapi#544 box/box-codegen#781 box/box-openapi#545
- Remove generated suffix from files (box/box-codegen#779) (#948) (4bfb073)
- Adjust imports and exports (box/box-codegen#801) (#965) (d8e6a0a)
Bug Fixes
New Features and Enhancements
- Add missing webhook events (box/box-openapi#554) (#982) (2f5e245)
- Support external user deletion API (box/box-codegen#796) (#946) (44b37a4)
For more details check migration guide from box-typescript-sdk-gen v1 to box-node-sdk v10.