Add info about SDK v10 - #821
Merged
Merged
Conversation
lszal
requested changes
Sep 17, 2025
lszal
left a comment
lszal
left a comment
Collaborator
There was a problem hiding this comment.
Please make the suggested updates. Thanks!
| <CTA to="https://github.com/box/box-dotnet-sdk-gen"> | ||
| Learn more about .NET SDK on GitHub | ||
| </CTA> | ||
| All future development, including new features and updates for the Next Generation SDKs, will be delivered through Box core SDKs starting with version `v10`. Currently, `v10` available as a separate branch. |
Collaborator
There was a problem hiding this comment.
Suggested change
| All future development, including new features and updates for the Next Generation SDKs, will be delivered through Box core SDKs starting with version `v10`. Currently, `v10` available as a separate branch. | |
| All future development, including new features and updates for the Next Generation SDKs, will be delivered through Box core SDKs starting with version `v10`. Currently, `v10` is available as a separate branch. |
|
|
||
| Don't worry, your existing code will continue to work without changes. You can still use your applications based on Box Next Generation SDKs with no impact, but you won't receive new features, updates, or bug fixes. | ||
|
|
||
| In keeping with industry best practices, we are consolidating the Box Next Generation SDKs and Box core SDKs into a single package for each programming language. This makes migration efforts much easier and allows to seamlessly add new capabilities to existing applications still powered by the manually maintained Box core SDKs. |
Collaborator
There was a problem hiding this comment.
Suggested change
| In keeping with industry best practices, we are consolidating the Box Next Generation SDKs and Box core SDKs into a single package for each programming language. This makes migration efforts much easier and allows to seamlessly add new capabilities to existing applications still powered by the manually maintained Box core SDKs. | |
| In keeping with industry best practices, we are consolidating the Box Next Generation SDKs and Box core SDKs into a single package for each programming language. This makes migration efforts much easier and allows seamless additions of new capabilities to existing applications still powered by Box core SDKs, which are maintained manually. |
|
|
||
| In keeping with industry best practices, we are consolidating the Box Next Generation SDKs and Box core SDKs into a single package for each programming language. This makes migration efforts much easier and allows to seamlessly add new capabilities to existing applications still powered by the manually maintained Box core SDKs. | ||
|
|
||
| All future development, including new features and updates for the Next Generation SDKs, will be delivered through Box core SDKs starting with version `v10`. Currently, `v10` available as a separate branch. |
Collaborator
There was a problem hiding this comment.
Suggested change
| All future development, including new features and updates for the Next Generation SDKs, will be delivered through Box core SDKs starting with version `v10`. Currently, `v10` available as a separate branch. | |
| All future development, including new features and updates for the Next Generation SDKs, will be delivered through Box core SDKs starting with version `v10`. Currently, `v10` is available as a separate branch. |
| 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. |
Collaborator
There was a problem hiding this comment.
Suggested change
| with the Box Content Cloud. | |
| with 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. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - **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. | |
| - **Rapid API updates**: The new auto-generation development approach allows you to add 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. |
| Here's what you can expect from generated 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. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - **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. | |
| - **Rapid API updates**: The new auto-generation development approach allows you to add 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. |
|
|
||
| - **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. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - **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. | |
| - **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. |
| - **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. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - **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. | |
| - **Enhanced convenience methods**: The newly introduced convenience methods cover various aspects such as authentication, chunk uploads, exponential back-offs, automatic retries, type checkers that help to ensure that you’re using variables correctly, and much more. |
|
|
||
| ## Box CLI | ||
|
|
||
| Box CLI is a user-friendly command line tool which |
Collaborator
There was a problem hiding this comment.
Suggested change
| Box CLI is a user-friendly command line tool which | |
| Box CLI is a user-friendly command line tool that |
|
|
||
| ## Box CLI | ||
|
|
||
| Box CLI is a user-friendly command line tool which |
Collaborator
Author
There was a problem hiding this comment.
This is an SDK and tools page, it covers all tooling
| <CTA to="https://github.com/box/box-dotnet-sdk-gen"> | ||
| Learn more about .NET SDK on GitHub | ||
| </CTA> | ||
| All future development, including new features and updates for the Next Generation SDKs, will be delivered through Box core SDKs starting with version `v10`. Currently, `v10` available as a separate branch. |
Collaborator
There was a problem hiding this comment.
| </Message> | ||
|
|
||
| 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. |
Collaborator
There was a problem hiding this comment.
The SDK is available for both .NET Framework 4.6.2 and .NET 8.0 or
above.
Collaborator
There was a problem hiding this comment.
PM> Install-Package Box.V2.CoreOlga please change installation command - now this package will support .NET Framework as well.
| | --- | ------- |-------- | | ||
| | [Java SDK][javasdk] | Yes | Full | | ||
| | [iOS Content SDK][iossdk] | Yes | Full | | ||
| | [Java SDK][javasdk] | Yes | Partial | |
Collaborator
There was a problem hiding this comment.
API Parity should be full everywhere now, as v10 support all endpoints
| For more details, see our [SDK versioning strategy document][versioning]. | ||
| </Message> | ||
|
|
||
| The latest generation Box Python SDK, Box TypeScript |
Collaborator
There was a problem hiding this comment.
Not consistant naming - put Box before .NET SDK and Swift SDK as well
| [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 |
| </CTA> | ||
| Don’t worry, your existing code will continue to work without changes. You can still use your applications based on Box Next Generation SDKs with no impact, but you won't receive new features, updates, or bug fixes. | ||
|
|
||
| All future development, including new features and updates for the Next Generation SDKs, will be delivered through Box core SDKs starting with version `v10`. Currently, `v10` available as a separate branch. |
Collaborator
There was a problem hiding this comment.
| *box-python-sdk* | ||
| </Tile> | ||
| <Tile type="java" title="Box Java SDK" | ||
| href="https://github.com/box/box-java-sdk#readme"> |
Collaborator
There was a problem hiding this comment.
remove #readme to be consistent (optionally)
Collaborator
Author
There was a problem hiding this comment.
added to all
| *box-windows-sdk-v2* | ||
| </Tile> | ||
| <Tile type="tool" title="Box iOS SDK" | ||
| href="https://github.com/box/box-ios-sdk#readme"> |
Collaborator
There was a problem hiding this comment.
remove #readme to be consistent (optionally)
Collaborator
Author
There was a problem hiding this comment.
added to all
| - **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. |
Collaborator
There was a problem hiding this comment.
- Enhanced Convenience Methods: The newly introduced convenience methods cover various aspects such as authentication, automatic retries, customisable network layer, chunk uploads and much more.
lszal
previously requested changes
Sep 17, 2025
|
|
||
| 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. | ||
| Up to version `5.8.0` the SDK is available for both .NET Framework `4.5` and .NET Core `1.0` or above. Starting from version `10.0.0` SDK is available for both .NET Framework `4.6.2` and .NET `8.0` or above. The installation of the SDK depends on the framework used. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Up to version `5.8.0` the SDK is available for both .NET Framework `4.5` and .NET Core `1.0` or above. Starting from version `10.0.0` SDK is available for both .NET Framework `4.6.2` and .NET `8.0` or above. The installation of the SDK depends on the framework used. | |
| Up to version `5.8.0`, the SDK is available for both .NET Framework `4.5` and .NET Core `1.0` or above. Starting from version `10.0.0`, the SDK is available for both .NET Framework `4.6.2` and .NET `8.0` or above. The installation of the SDK depends on the framework used. |
| ## How to decide | ||
|
|
||
| 1. If you are creating a new application, use `v10` of the Box core SDK package. | ||
| 2. If you have an existing application relying on the **Box Next Generation SDK** and you wish to further develop your project, replace the name of this library in the package manager with the Box core SDK package (`v10.0.0`). Object imports for most SDKs will persist the same and your code will work as-is; the TypeScript SDK requires additional steps for migrating. Check section below for detailed guides. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 2. If you have an existing application relying on the **Box Next Generation SDK** and you wish to further develop your project, replace the name of this library in the package manager with the Box core SDK package (`v10.0.0`). Object imports for most SDKs will persist the same and your code will work as-is; the TypeScript SDK requires additional steps for migrating. Check section below for detailed guides. | |
| 2. If you have an existing application relying on the **Box Next Generation SDK** and you wish to further develop your project, replace the name of this library in the package manager with the Box core SDK package (`v10.0.0`). Object imports for most SDKs will persist the same and your code will work as-is; the TypeScript SDK requires additional steps for migrating. Check the section below for detailed guides. |
| ```shell | ||
| npm install box-typescript-sdk-gen | ||
| ``` | ||
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to code Box SDK `v10`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to code Box SDK `v10`. | |
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to Box core SDK `v10`. |
| </Message> | ||
|
|
||
| For more detailed instructions, please see the [official documentation for Carthage][carthage]. | ||
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to code Box SDK `v10`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to code Box SDK `v10`. | |
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to Box core SDK `v10`. |
| - **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 you to add 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. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - **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. | |
| - **Enhanced convenience methods**: The newly introduced convenience methods cover various aspects such as authentication, chunk uploads, exponential back-offs, automatic retries, type checkers that help to ensure that you’re using variables correctly, and much more. |
| - **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 you to add 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. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - **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. | |
| - **Enhanced convenience methods**: The newly introduced convenience methods cover various aspects such as authentication, chunk uploads, exponential back-offs, automatic retries, type checkers that help to ensure that you’re using variables correctly, and much more. |
| <!--alex ignore executed--> | ||
|
|
||
| The Box CLI is a user-friendly command line tool which allows both technical and | ||
| The Box CLI is a user-friendly command line tool that allows both technical and |
Collaborator
There was a problem hiding this comment.
Suggested change
| The Box CLI is a user-friendly command line tool that allows both technical and | |
| Box CLI is a user-friendly command line tool that allows both technical and |
| ```shell | ||
| PM> Install-Package Box.Sdk.Gen | ||
| ``` | ||
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to code Box SDK `v10`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to code Box SDK `v10`. | |
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to Box core SDK `v10`. |
| For more details, see our [SDK versioning strategy document][versioning]. | ||
| </Message> | ||
|
|
||
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to code Box SDK `v10`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to code Box SDK `v10`. | |
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to Box core SDK `v10`. |
| </Message> | ||
|
|
||
| To install the auto-generated Python SDK run the following command from your terminal window or command prompt using [pip][pip]. | ||
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to code Box SDK `v10`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to code Box SDK `v10`. | |
| Check the [migration guide][migration] to learn how to switch from Box Next Generation SDK to Box core SDK `v10`. |
lukaszsocha2
approved these changes
Sep 17, 2025
lszal
approved these changes
Sep 17, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Please include a summary of the change and which issue is fixed.
If you are a Boxer, please also reference the related
DDOCorAPIWGtickets.If you do not have a related
Jiraticket and this is more than a bug fix, thencreate one now.
Fixes # (issue)
Re
DDOC-#(Jiraticket)Re
APIWG-#(Jiraticket)Checklist
yarn lintto make sure my changes pass all lintersContribution guidelines
For contribution guidelines, styleguide, and other helpful information please
see the
CONTRIBUTING.mdfile in the root of this project.