diff --git a/content/guides/representations/supported-file-types.md b/content/guides/representations/supported-file-types.md index 58dab3dc8..37fe9c46d 100644 --- a/content/guides/representations/supported-file-types.md +++ b/content/guides/representations/supported-file-types.md @@ -76,7 +76,7 @@ The following file types are supported by the representation API. ## Drawing | File Type | PDF Support? | Thumbnails? | Text? | -| --- | --- | ---| --- | +| --------- | ------------ | ----------- | ----- | | `.ai` | No | Yes | No | | `.boxcanvas` | No | No | Yes | | `.indd` | Yes | Yes | No | diff --git a/content/guides/tooling/sdks/dotnet-gen.md b/content/guides/tooling/sdks/dotnet-gen.md index e4a23a3aa..4bc2f906b 100644 --- a/content/guides/tooling/sdks/dotnet-gen.md +++ b/content/guides/tooling/sdks/dotnet-gen.md @@ -1,5 +1,5 @@ --- -rank: 1 +rank: 9 related_endpoints: [] related_guides: - authentication/jwt @@ -11,7 +11,13 @@ related_resources: [] alias_paths: [] --- -# Install .NET SDK (Generated) +# Deprecated .NET SDK + + + In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. **Don’t worry, your existing code will continue to work without changes**. + + To learn more visit our SDK [versioning strategy document][versioning] + You can use Box .NET SDK to call Box APIs in a .NET project. @@ -31,3 +37,4 @@ PM> Install-Package Box.Sdk.Gen ``` [nuget]: https://www.nuget.org/ +[versioning]: g://tooling/sdks/sdk-versioning diff --git a/content/guides/tooling/sdks/dotnet.md b/content/guides/tooling/sdks/dotnet.md index d5931b070..985a9c281 100644 --- a/content/guides/tooling/sdks/dotnet.md +++ b/content/guides/tooling/sdks/dotnet.md @@ -1,5 +1,5 @@ --- -rank: 1 +rank: 2 related_endpoints: [] related_guides: - authentication/jwt @@ -11,19 +11,11 @@ related_resources: [] alias_paths: [] --- -# Install .NET SDK (Deprecated) +# Install .NET SDK You can use Box .NET SDK to call Box APIs in a .NET project. - - [.NET SDK](https://github.com/box/box-windows-sdk-v2) - is currently in maintenance mode and will be deprecated soon. - This means only critical security updates and bug fixes will be - implemented. - It is recommended to use the [auto-generated .NET SDK][dotnetgensdk]. - - The SDK is available for both .NET Framework 4.5 and .NET Core 1.0 or above. The installation of the SDK depends on the framework used. @@ -50,4 +42,3 @@ PM> Install-Package Box.V2.Core ``` [nuget]: https://www.nuget.org/ -[dotnetgensdk]: https://github.com/box/box-dotnet-sdk-gen diff --git a/content/guides/tooling/sdks/index.md b/content/guides/tooling/sdks/index.md index b66a6bc99..ebd4fc818 100644 --- a/content/guides/tooling/sdks/index.md +++ b/content/guides/tooling/sdks/index.md @@ -14,11 +14,6 @@ alias_paths: Box offers a set of SDKs you can use to build your application. -The next generation .NET SDK is the -newest addition to the set. -It is still a beta feature, but you can -give them a try to explore all the -features they bring along. The tables below list SDKs along with additional information @@ -35,48 +30,18 @@ with partial API parity lack some functionality while we work on bringing these projects to full parity. -## Next generation SDKs - -The latest generation Box Python SDK, Box TypeScript -SDK, .NET SDK, and Swift SDK are designed to elevate the developer -experience and streamline your integration -with the Box Content Cloud. - - -Swift SDK is in a Public Beta phase. - - -Here's what you can expect from the new SDKs: - -- **Full API Support**: New Box SDKs empower developers with complete coverage of the Box API ecosystem. You can access all the latest features and functionalities offered by Box and build feature-rich applications. -- **Rapid API Updates**: The new auto-generation development approach allows for adding Box APIs to SDKs at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay. -- **Embedded Documentation**: All objects and parameters are documented directly in the source code of the SDK so all the necessary information is stored in one place. -- **Enhanced Convenience Methods**: The newly introduced convenience methods cover various aspects such as authentication, chunk uploads, exponential back-offs, automatic retries, type checkers which help to ensure that you’re using variables correctly, and much more. - -Download the **Box Platform** SDK in a programming language of your choice and get started: - -| Platform | Maintained? | API Parity | -| ----------------------------------- | ----------- | ---------- | -| [Python Gen SDK][pythongensdk] | Yes | Full | -| [TypeScript Gen SDK][tsgensdk] | Yes | Full | -| [.NET Gen SDK][dotnetgensdk] | Yes | Full | -| [Swift Gen SDK][swiftgensdk] (Beta) | Yes | Full | -| [Java Gen SDK][javagensdk] (Beta) | Yes | Full | - -## Legacy SDKs - The table lists legacy Box SDKs that you can use when building your applications. For latest API support and features, use the next generation SDKs. | Platform | Maintained? | API Parity | | --- | ------- |-------- | -| [Java SDK][javasdk] | Yes | Full | -| [iOS Content SDK][iossdk] | Yes | Full | +| [Java SDK][javasdk] | Yes | Partial | +| [iOS Content SDK][iossdk] | Yes | Partial | | [Android Content SDK][androidsdk] | No | Partial | -| [.NET SDK][dotnetsdk] | Deprecated. Only critical security updates and bug fixes are implemented. | Full | -| [Python SDK][pythonsdk] | Deprecated. Only critical security updates and bug fixes are implemented. | Full | -| [Node SDK][nodesdk] | Deprecated. Only critical security updates and bug fixes are implemented. | Full | +| [.NET SDK][dotnetsdk] | Yes | Partial | +| [Python SDK][pythonsdk] | Yes | Partial | +| [Node SDK][nodesdk] | Yes | Partial | As of May 31, 2023 Android SDK is no @@ -91,6 +56,32 @@ build apps on Android. Refer to [this][android-docs] documentation for more details. +## Next generation SDKs + + + In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. **Don’t worry, your existing code will continue to work without changes**. + + ## Why we are making this change + + In keeping with industry best practices, we are consolidating the Next Gen and legacy SDKs into a single package. This makes migration efforts much easier and allows you to seamlessly add new capabilities to existing applications still powered by the legacy SDKs. + + Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. Read more to learn the details. + + To learn more visit our SDK [versioning strategy document][versioning] + + +The latest generation Box Python SDK, Box TypeScript +SDK, .NET SDK, and Swift SDK are designed to elevate the developer +experience and streamline your integration +with the Box Content Cloud. + +Here's what you can expect from the new SDKs: + +- **Full API Support**: New Box SDKs empower developers with complete coverage of the Box API ecosystem. You can access all the latest features and functionalities offered by Box and build feature-rich applications. +- **Rapid API Updates**: The new auto-generation development approach allows for adding Box APIs to SDKs at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay. +- **Embedded Documentation**: All objects and parameters are documented directly in the source code of the SDK so all the necessary information is stored in one place. +- **Enhanced Convenience Methods**: The newly introduced convenience methods cover various aspects such as authentication, chunk uploads, exponential back-offs, automatic retries, type checkers which help to ensure that you’re using variables correctly, and much more. + [javasdk]: https://github.com/box/box-java-sdk @@ -99,12 +90,8 @@ Refer to [this][android-docs] documentation for more details. [nodesdk]: https://github.com/box/box-node-sdk [iossdk]: https://github.com/box/box-ios-sdk [androidsdk]: https://github.com/box/box-android-sdk -[pythongensdk]: https://github.com/box/box-python-sdk-gen -[tsgensdk]: https://github.com/box/box-typescript-sdk-gen -[dotnetgensdk]: https://github.com/box/box-dotnet-sdk-gen -[swiftgensdk]: https://github.com/box/box-swift-sdk-gen -[javagensdk]: https://github.com/box/box-java-sdk-gen [android-docs]: https://github.com/box/box-java-sdk/blob/main/doc/android.md -[forum]: https://support.box.com/hc/en-us/community/topics/360001932973-Platform-and-Developer-Forum +[versioning]: g://tooling/sdks/sdk-versioning +[forum]: https://community.box.com/sdks-and-tools-7 diff --git a/content/guides/tooling/sdks/java.md b/content/guides/tooling/sdks/java.md index 5ce700596..b5f48c964 100644 --- a/content/guides/tooling/sdks/java.md +++ b/content/guides/tooling/sdks/java.md @@ -1,5 +1,5 @@ --- -rank: 2 +rank: 3 related_endpoints: [] related_guides: - authentication/jwt diff --git a/content/guides/tooling/sdks/node.md b/content/guides/tooling/sdks/node.md index 075e2e9d4..88e94ef75 100644 --- a/content/guides/tooling/sdks/node.md +++ b/content/guides/tooling/sdks/node.md @@ -1,5 +1,5 @@ --- -rank: 4 +rank: 5 related_endpoints: [] related_guides: - authentication/jwt @@ -11,18 +11,11 @@ related_resources: [] alias_paths: [] --- -# Install Node SDK (Deprecated) +# Install Node SDK You can use Box Node SDK to call Box APIs in a Node project. - - [Node SDK][node] is currently in maintenance mode and will be deprecated soon. - This means only critical security updates and bug fixes will be - implemented. - It is recommended to use the [auto-generated TypeScript SDK][ts-gen]. - - Learn more about Node SDK on GitHub @@ -46,5 +39,4 @@ yarn add box-node-sdk [npm]: https://www.npmjs.com/ [yarn]: https://yarnpkg.com/ -[ts-gen]: g://tooling/sdks/typescript-gen [node]: https://github.com/box/box-node-sdk diff --git a/content/guides/tooling/sdks/python-gen.md b/content/guides/tooling/sdks/python-gen.md index ac36f18da..2391e51dd 100644 --- a/content/guides/tooling/sdks/python-gen.md +++ b/content/guides/tooling/sdks/python-gen.md @@ -1,5 +1,5 @@ --- -rank: 3 +rank: 8 related_endpoints: [] related_guides: - authentication/jwt @@ -11,15 +11,17 @@ related_resources: [] alias_paths: [] --- -# Install Python SDK (Generated) +# Deprecated Python SDK + + + In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. **Don’t worry, your existing code will continue to work without changes**. + + To learn more visit our SDK [versioning strategy document][versioning] + You can use the **auto-generated** Box Python SDK to call Box APIs in a Python project. This [next generation SDK][next-gen] brings along new functionality to designed to elevate the developer experience and streamline your integration with the Box Content Cloud. - - Learn more about auto-generated Python SDK on GitHub - - ## Installation To install the auto-generated Python SDK run the following command from your terminal window or command prompt using [pip][pip]. @@ -40,3 +42,4 @@ pip install "box-sdk-gen[jwt]" [jwt]: g://authentication/jwt [next-gen]: g://tooling/sdks#next-generation-sdks [py-gen]: https://github.com/box/box-python-sdk-gen +[versioning]: g://tooling/sdks/sdk-versioning \ No newline at end of file diff --git a/content/guides/tooling/sdks/python.md b/content/guides/tooling/sdks/python.md index f5975b49c..21ca3f963 100644 --- a/content/guides/tooling/sdks/python.md +++ b/content/guides/tooling/sdks/python.md @@ -1,5 +1,5 @@ --- -rank: 3 +rank: 4 related_endpoints: [] related_guides: - authentication/jwt @@ -11,18 +11,10 @@ related_resources: [] alias_paths: [] --- -# Install Python SDK (Deprecated) +# Install Python SDK You can use Box Python SDK to call Box APIs in a Python project. - - [Python SDK](https://github.com/box/box-python-sdk) - is currently in maintenance mode and will be deprecated soon. - This means only critical security updates and bug fixes will be - implemented. - It is recommended to use the [auto-generated Python SDK][python-gen]. - - Learn more about Python SDK on GitHub @@ -46,4 +38,4 @@ pip install "boxsdk[jwt]" [pip]: https://pypi.org/project/pip/ [jwt]: g://authentication/jwt -[python-gen]: g://tooling/sdks/python-gen +[versioning]: g://tooling/sdks/sdk-versioning \ No newline at end of file diff --git a/content/guides/tooling/sdks/salesforce.md b/content/guides/tooling/sdks/salesforce.md index 341bd8e1a..df0e390a0 100644 --- a/content/guides/tooling/sdks/salesforce.md +++ b/content/guides/tooling/sdks/salesforce.md @@ -1,5 +1,5 @@ --- -rank: 5 +rank: 6 related_endpoints: [] related_guides: - authentication/jwt diff --git a/content/guides/tooling/sdks/sdk-versioning.md b/content/guides/tooling/sdks/sdk-versioning.md new file mode 100644 index 000000000..d2199bd62 --- /dev/null +++ b/content/guides/tooling/sdks/sdk-versioning.md @@ -0,0 +1,60 @@ +--- +rank: 1 +related_endpoints: [] +related_guides: + - authentication/jwt + - authentication/oauth2 +related_pages: + - sdks-and-tools +required_guides: [] +related_resources: [] +alias_paths: [] +--- + +# Box SDK versioning strategy + +In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. Don’t worry, your existing code will continue to work without changes. + +## Why we are making this change + +In keeping with industry best practices, we are consolidating the Next Gen and legacy SDKs into a single package. This makes migration efforts much easier and allows you to seamlessly add new capabilities to existing applications still powered by the legacy SDKs. + +Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. Read more to learn the details. + +## How it will work + +Currently, the legacy SDKs and the Next Gen SDKs are separate libraries. Going forward, two new major versions will be available within the legacy SDK artifact: + +- `(n+1)` major version that includes legacy SDK and Next Gen SDK artifacts. This version enables you to leverage coexisting artifacts at the same time, and serve as a transition phase. +- `v10.0.0` version that includes only the Next Gen SDK artifact. + +## How to decide + +1. If you are writing a new application, use the latest major release of the SDK package. +2. If you have an existing application relying on the **Next Gen SDK** and you wish to further develop your project, replace the name of this library in the package manager with the latest major release of the legacy SDK package (`v10.0.0`). Most SDKs object imports persist the same and your code will work as-is; only the TypeScript SDK requires additional steps for migrating. +3. If you have an existing application relying on the **legacy SDK** and you wish to further develop your project, once released, bump the library version by one major release. See the table above, for detailed breakdown of recommended versions. +4. If you have an existing application that you don’t plan to change, ensure your package manager includes the version of SDK you are using to prevent an accidental rebuild that pulls in a version you aren’t expecting. + +## Versioning overview + +### Box SDK versions and artifacts + +| SDK Package Name | Current latest version | Combined legacy and Next Gen artifacts | Next Gen SDK artifact | +|--------------------|---------|--------|----------| +| `box-node-sdk` | `v3.8.2` | `v4.0.0` | `v10.0.0` | +| `box-python-sdk` | `v3.14.0` | `v4.0.0` | `v10.0.0` | +| `box-java-sdk` | `v4.16.3` | `v5.0.0` | `v10.0.0` | +| `box-windows-sdk-v2` | `v5.8.0` | `v6.0.0` | `v10.0.0` | +| `box-ios-sdk` | `v5.6.0` | `v6.0.0` | `v10.0.0` | + +### Box Next Gen SDK deprecation status + +| SDK Package Name | Current latest version | Note +|------------------|-------------------------|-------| +| `box-typescript-sdk-gen` | `v1.16.0` | deprecation in mid-August 2025, use `box-node-sdk` `v10.0.0` | +| `box-python-sdk-gen` | `v1.15.0` | deprecation in mid-August 2025, use `box-python-sdk` `v10.0.0` | +| `box-java-sdk-gen` | `v0.7.0` | deprecation in mid-August 2025, use `box-java-sdk` `v10.0.0` | +| `box-dotnet-sdk-gen` | `v1.10.0` | deprecation in mid-August 2025, use `box-windows-sdk-v2` `v10.0.0` | +| `box-swift-sdk-gen` | `v0.6.1` | deprecation in mid-August 2025, use `box-ios-sdk` `v10.0.0` | + +Follow the change log and Box Developer blog for further instructions and announcements. diff --git a/content/guides/tooling/sdks/swift-gen.md b/content/guides/tooling/sdks/swift-gen.md index 353e9bd39..f1a63fa60 100644 --- a/content/guides/tooling/sdks/swift-gen.md +++ b/content/guides/tooling/sdks/swift-gen.md @@ -1,5 +1,5 @@ --- -rank: 1 +rank: 10 related_endpoints: [] related_guides: [] related_pages: @@ -9,7 +9,13 @@ related_resources: [] alias_paths: [] --- -# Install Swift SDK (Generated) +# Deprecated Swift SDK + + + In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. **Don’t worry, your existing code will continue to work without changes**. + + To learn more visit our SDK [versioning strategy document][versioning] + You can use Box Swift SDK to call Box APIs in a Swift project. @@ -18,10 +24,6 @@ project. Swift SDK is in a Public Beta phase. - - Learn more about Swift SDK on GitHub - - ## Swift Package Manager [Swift Package Manager][spm] is a tool for managing the distribution of Swift code. It is integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies. @@ -60,4 +62,5 @@ For more detailed instructions, please see the [official documentation for Carth [spm]: https://www.swift.org/documentation/package-manager/ [xcode]: https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app -[carthage]: https://github.com/Carthage/Carthage#adding-frameworks-to-an-application \ No newline at end of file +[carthage]: https://github.com/Carthage/Carthage#adding-frameworks-to-an-application +[versioning]: g://tooling/sdks/sdk-versioning \ No newline at end of file diff --git a/content/guides/tooling/sdks/typescript-gen.md b/content/guides/tooling/sdks/typescript-gen.md index 4d5749ee6..20787c074 100644 --- a/content/guides/tooling/sdks/typescript-gen.md +++ b/content/guides/tooling/sdks/typescript-gen.md @@ -1,5 +1,5 @@ --- -rank: 4 +rank: 7 related_endpoints: [] related_guides: - authentication/jwt @@ -11,15 +11,17 @@ related_resources: [] alias_paths: [] --- -# Install Typescript SDK (Generated) +# Deprecated TypeScript SDK + + + In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. **Don’t worry, your existing code will continue to work without changes**. + + To learn more visit our SDK [versioning strategy document][versioning] + You can use the **auto-generated** Box TypeScript SDK to call Box APIs in a TypeScript project. This [next generation SDK][next-gen] brings along new functionality to designed to elevate the developer experience and streamline your integration with the Box Content Cloud. - - Learn more about auto-generated TypeScript SDK on GitHub - - ## NPM installation To install the TypeScript SDK run the following command from your terminal @@ -40,3 +42,4 @@ yarn add box-typescript-sdk-gen [npm]: https://www.npmjs.com/ [yarn]: https://yarnpkg.com/ [next-gen]: g://tooling/sdks#next-generation-sdks +[versioning]: g://tooling/sdks/sdk-versioning \ No newline at end of file diff --git a/content/microcopy/footer.yml b/content/microcopy/footer.yml index 3ef4aa290..393d4613b 100644 --- a/content/microcopy/footer.yml +++ b/content/microcopy/footer.yml @@ -54,12 +54,6 @@ categories: title: Tooling links: - ts_gen_sdk: - // text: Text for link to the TypeScript SDK (Generated) - text: TypeScript SDK (Generated) - // url: link to the TypeScript SDK (Generated) - url: https://github.com/box/box-typescript-sdk-gen - java_sdk: // text: Text for link to the Java SDK text: Java SDK @@ -72,36 +66,12 @@ categories: // url: link to the Python SDK url: https://github.com/box/box-python-sdk - python_gen_sdk: - // text: Text for link to the Python SDK (Generated) - text: Python SDK (Generated) - // url: link to the Python SDK (Generated) - url: https://github.com/box/box-python-sdk-gen - dotnet_sdk: // text: Text for link to the .NET SDK text: .NET SDK // url: link to the .Net SDK url: https://github.com/box/box-windows-sdk-v2 - swift_gen_sdk: - // text: Text for link to the Swift SDK (Generated) - text: Swift SDK (Generated) - // url: link to the Swift SDK (Generated) - url: https://github.com/box/box-swift-sdk-gen - - java_gen_sdk: - // text: Text for link to the Java SDK (Generated) - text: Java SDK (Generated) - // url: link to the Java SDK (Generated) - url: https://github.com/box/box-java-sdk-gen - - dotnet_gen_sdk: - // text: Text for link to the .NET (Generated) SDK - text: .NET SDK (Generated) - // url: link to the .Net SDK (Generated) - url: https://github.com/box/box-dotnet-sdk-gen - node_sdk: // text: Text for link to the Node SDK text: Node SDK diff --git a/content/pages/index.md b/content/pages/index.md index 4dbcdc1f9..e2c88787b 100644 --- a/content/pages/index.md +++ b/content/pages/index.md @@ -90,7 +90,7 @@ All the developer resources to help you get the most from Box products
- Browse by SDK and tools + Browse by SDK and developer tools
Development with Box Platform is easy with SDKs, Box CLI, Postman collection, @@ -102,30 +102,26 @@ All the developer resources to help you get the most from Box products href="/reference/"> *Box API Reference* - - *box-python-sdk-gen* + + *box-python-sdk* *box-java-sdk* - - *box-typescript-sdk-gen* + + *box-node-sdk* - - *box-dotnet-sdk-gen* + + *box-windows-sdk-v2* *box-ios-sdk* - - *box-swift-sdk-gen* - *Box Postman Collection* diff --git a/content/pages/platform/authentication-methods.md b/content/pages/platform/authentication-methods.md index 19195695b..c9c020b90 100644 --- a/content/pages/platform/authentication-methods.md +++ b/content/pages/platform/authentication-methods.md @@ -95,8 +95,6 @@ that: -You can find a great Python CCG tutorial on [Medium][python_ccg]. - ## App Token Auth [App Token Auth][ata]is another server-side authentication option, utilizing @@ -187,7 +185,6 @@ together, see our [security guide][security]. [reference]: page://reference [python_oauth]: https://github.com/box-community/box-python-oauth-template -[python_ccg]: https://medium.com/box-developer-blog/box-python-next-gen-sdk-getting-started-with-ccg-81be0abc82d9 [node_jwt]: https://medium.com/box-developer-blog/authenticate-box-node-js-sdk-with-jwt-47fdd3aeec50 [skill_watson]: https://medium.com/box-developer-blog/box-skills-ibm-watson-speech-to-text-tutorial-b7e3b3c0a8c7 \ No newline at end of file diff --git a/content/pages/sdks-and-tools/index.md b/content/pages/sdks-and-tools/index.md index cb2390e1e..d046fceba 100644 --- a/content/pages/sdks-and-tools/index.md +++ b/content/pages/sdks-and-tools/index.md @@ -18,12 +18,6 @@ The following SDKs and tools are developed and supported by Box. Here you will find a list of SDKs you can use to build your application. -Separately, we have listed the next generation -Python, TypeScript, and .NET SDKs, which are the -newest addition. -.NET is still a beta feature, but we encourage -you to give it a try and explore all the -features they bring along. The tables below list SDKs along with additional information @@ -40,35 +34,7 @@ with partial API parity lack some functionality while we work on bringing these projects to full parity. -### Next generation SDKs - -The latest generation Box Python SDK, Box TypeScript -SDK, .NET SDK, and Swift SDK are designed to elevate the developer -experience and streamline your integration -with the Box Content Cloud. - - -Swift SDK is in a Public Beta phase. - - -Here's what you can expect from the new SDKs: - -- **Full API Support**: New Box SDKs empower developers with complete coverage of the Box API ecosystem. You can access all the latest features and functionalities offered by Box and build feature-rich applications. -- **Rapid API Updates**: The new auto-generation development approach allows for adding Box APIs to SDKs at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay. -- **Embedded Documentation**: All objects and parameters are documented directly in the source code of the SDK so all the necessary information is stored in one place. -- **Enhanced Convenience Methods**: The newly introduced convenience methods cover various aspects such as authentication, chunk uploads, exponential back-offs, automatic retries, type checkers which help to ensure that you’re using variables correctly, and much more. - -Download the **Box Platform** SDK in a programming language of your choice and get started: - -| Platform | Status | API Parity | -| --------------------------------- | ------ | ---------- | -| [Python Gen SDK][pythongensdk] | Active | Full | -| [TypeScript Gen SDK][tsgensdk] | Active | Full | -| [.NET SDK][dotnetgensdk] | Active | Full | -| [Swift SDK][swiftgensdk] (Beta) | Active | Full | -| [Java Gen SDK][javagensdk] (Beta) | Active | Full | - -### Legacy SDKs +### SDKs The table lists legacy Box SDKs that you can use when building your applications. For latest API support and features, use the next @@ -96,6 +62,32 @@ recommend using Java SDK to build apps on Android. Refer to [this][android-docs] documentation for more details. +### Next generation SDKs + + + In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. **Don’t worry, your existing code will continue to work without changes**. + + ## Why we are making this change + + In keeping with industry best practices, we are consolidating the Next Gen and legacy SDKs into a single package. This makes migration efforts much easier and allows you to seamlessly add new capabilities to existing applications still powered by the legacy SDKs. + + Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. Read more to learn the details. + + To learn more visit our SDK [versioning strategy document][versioning] + + +The latest generation Box Python SDK, Box TypeScript +SDK, .NET SDK, and Swift SDK are designed to elevate the developer +experience and streamline your integration +with the Box Content Cloud. + +Here's what you can expect from the new SDKs: + +- **Full API Support**: New Box SDKs empower developers with complete coverage of the Box API ecosystem. You can access all the latest features and functionalities offered by Box and build feature-rich applications. +- **Rapid API Updates**: The new auto-generation development approach allows for adding Box APIs to SDKs at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay. +- **Embedded Documentation**: All objects and parameters are documented directly in the source code of the SDK so all the necessary information is stored in one place. +- **Enhanced Convenience Methods**: The newly introduced convenience methods cover various aspects such as authentication, chunk uploads, exponential back-offs, automatic retries, type checkers which help to ensure that you’re using variables correctly, and much more. + ## Box CLI Box CLI is a user-friendly command line tool which @@ -211,13 +203,9 @@ for these tools. [salesforcesdk]: https://github.com/box/box-salesforce-sdk [rubysdk]: https://github.com/cburnette/boxr [jssdk]: https://github.com/allenmichael/box-javascript-sdk -[pythongensdk]: https://github.com/box/box-python-sdk-gen -[tsgensdk]: https://github.com/box/box-typescript-sdk-gen -[dotnetgensdk]: https://github.com/box/box-dotnet-sdk-gen -[swiftgensdk]: https://github.com/box/box-swift-sdk-gen -[javagensdk]: https://github.com/box/box-java-sdk-gen [postman]: https://postman.com [badges]: https://opensource.box.com/badges/ +[versioning]: g://tooling/sdks/sdk-versioning