You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[Installing v4 (Both Generated and Manual SDK)](#installing-v4-both-generated-and-manual-sdk)
24
25
-[Getting Started](#getting-started)
25
26
-[With generated SDK](#with-generated-sdk)
26
27
-[With manually written SDK](#with-manually-written-sdk)
@@ -54,7 +55,7 @@ A Node.js interface to the [Box Content API](https://developer.box.com/reference
54
55
55
56
In v4 of the Box Node SDK, we are introducing a version that consolidates both the manually written SDK (formerly known as v3) and the generated SDK (currently in v10, formerly known as [box-typescript-sdk-gen](https://github.com/box/box-typescript-sdk-gen)) into a single SDK package for improved usability and maintenance. This allows developers to use both the manually written SDK and the generated SDK in the same project.
56
57
57
-
Version v4 of the Box Node SDK will be supporte until 2027. During this period, the manually written SDK will be marked as deprecated and will receive only bug fixes and security updates.
58
+
Version v4 of the Box Node SDK will be supported until 2027. During this period, the manually written SDK will be marked as deprecated and will receive only bug fixes and security updates.
58
59
All new features and functionality will be provided exclusively in the `sdk-gen` namespace.
59
60
60
61
The codebase for v4 of the Box Node SDK is currently available in the [combined-sdk](https://github.com/box/box-node-sdk/tree/combined-sdk) branch.
@@ -79,17 +80,26 @@ You can find the migration guide [here](https://github.com/box/box-node-sdk/blob
For general Node SDK installation details, see the [Box Developer documentation](https://developer.box.com/guides/tooling/sdks/node/).
83
84
84
-
The installation process for v4 of the Box Node SDK is similar, but there are some differences in the version number you need to use.
85
+
## Installing v10 (Generated SDK only)
85
86
86
-
In version v4, all classes and methods of manually written SDK are available in the `box-node-sdk` package, and the generated SDK is available in the `box-node-sdk/sdk-gen` namespace.
87
+
If you want to use only the generated SDK with the latest features:
87
88
88
-
To install v4 of the Box Node SDK, you can use the following command:
89
+
```bash
90
+
npm install --save box-node-sdk@^10
89
91
```
92
+
93
+
## Installing v4 (Both Generated and Manual SDK)
94
+
95
+
If you need to use both the generated SDK and the manually written SDK (for migration purposes):
96
+
97
+
```bash
90
98
npm install --save box-node-sdk@^4
91
99
```
92
100
101
+
In version v4, the manually written SDK is available in the `box-node-sdk` package, and the generated SDK is available in the `box-node-sdk/sdk-gen` namespace.
102
+
93
103
# Getting Started
94
104
95
105
To get started with the SDK, get a Developer Token from the Configuration page
@@ -100,7 +110,7 @@ You can use this token to make test calls for your own Box account.
100
110
101
111
## With generated SDK
102
112
103
-
The SDK provides a `DeveloperTokenAuth` class, which allows you to authenticate using your Developer Token. Use instance of `DeveloperTokenAuth` to initialize `Client` object. Using `Client` object you can access managers, which allow you to perform some operations on your Box account.
113
+
The SDK provides a `BoxDeveloperTokenAuth` class, which allows you to authenticate using your Developer Token. Use an instance of `BoxDeveloperTokenAuth` to initialize a `BoxClient` object. Using the `BoxClient` object you can access managers, which allow you to perform operations on your Box account.
104
114
105
115
The example below demonstrates how to authenticate with Developer Token and print names of all items inside a root folder.
106
116
@@ -367,7 +377,7 @@ We use a modified version of [Semantic Versioning](https://semver.org/) for all
367
377
368
378
## Supported Version
369
379
370
-
Currently, we support the v10 version and v3 version of the SDK. New features, functionality, bug fixes, and security updates will only be added to these versions.
380
+
Currently, we support versions v10, v4 of the SDK. New features and functionality are added to v10, while the manually written portion of v4 receive bug fixes and security updates only.
371
381
372
382
A current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features.
373
383
Instead of stating a release date for a new feature, we set a fixed minor or patch release cadence of maximum 2-3 months (while we may release more often).
0 commit comments