Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/guides/representations/supported-file-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
11 changes: 9 additions & 2 deletions content/guides/tooling/sdks/dotnet-gen.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
rank: 1
rank: 9
related_endpoints: []
related_guides:
- authentication/jwt
Expand All @@ -11,7 +11,13 @@ related_resources: []
alias_paths: []
---

# Install .NET SDK (Generated)
# Deprecated .NET SDK

<Message type='warning'>
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]
</Message>

You can use Box .NET SDK to call Box APIs in a .NET
project.
Expand All @@ -31,3 +37,4 @@ PM> Install-Package Box.Sdk.Gen
```

[nuget]: https://www.nuget.org/
[versioning]: g://tooling/sdks/sdk-versioning
13 changes: 2 additions & 11 deletions content/guides/tooling/sdks/dotnet.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
rank: 1
rank: 2
related_endpoints: []
related_guides:
- authentication/jwt
Expand All @@ -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.

<Message type='notice'>
[.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].
</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.

Expand All @@ -50,4 +42,3 @@ PM> Install-Package Box.V2.Core
```

[nuget]: https://www.nuget.org/
[dotnetgensdk]: https://github.com/box/box-dotnet-sdk-gen
79 changes: 33 additions & 46 deletions content/guides/tooling/sdks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Message type='notice'>
The tables below list SDKs along with additional information
Expand All @@ -35,48 +30,18 @@ with partial API parity lack some functionality while we work on bringing
these projects to full parity.
</Message>

## 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.

<Message type='notice'>
Swift SDK is in a Public Beta phase.
</Message>

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 |

<Message type='warning'>
As of May 31, 2023 Android SDK is no
Expand All @@ -91,6 +56,32 @@ build apps on Android.
Refer to [this][android-docs] documentation for more details.
</Message>

## Next generation SDKs

<Message type='warning'>
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]
</Message>

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.

<!-- i18n-enable localize-links -->

[javasdk]: https://github.com/box/box-java-sdk
Expand All @@ -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

<!-- i18n-disable localize-links -->
2 changes: 1 addition & 1 deletion content/guides/tooling/sdks/java.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
rank: 2
rank: 3
related_endpoints: []
related_guides:
- authentication/jwt
Expand Down
12 changes: 2 additions & 10 deletions content/guides/tooling/sdks/node.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
rank: 4
rank: 5
related_endpoints: []
related_guides:
- authentication/jwt
Expand All @@ -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.

<Message type='notice'>
[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].
</Message>

<CTA to="https://github.com/box/box-node-sdk">
Learn more about Node SDK on GitHub
</CTA>
Expand All @@ -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
15 changes: 9 additions & 6 deletions content/guides/tooling/sdks/python-gen.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
rank: 3
rank: 8
related_endpoints: []
related_guides:
- authentication/jwt
Expand All @@ -11,15 +11,17 @@ related_resources: []
alias_paths: []
---

# Install Python SDK (Generated)
# Deprecated Python SDK

<Message type='warning'>
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]
</Message>

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.

<CTA to="https://github.com/box/box-python-sdk-gen">
Learn more about auto-generated Python SDK on GitHub
</CTA>

## Installation

To install the auto-generated Python SDK run the following command from your terminal window or command prompt using [pip][pip].
Expand All @@ -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
14 changes: 3 additions & 11 deletions content/guides/tooling/sdks/python.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
rank: 3
rank: 4
related_endpoints: []
related_guides:
- authentication/jwt
Expand All @@ -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.

<Message type='notice'>
[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].
</Message>

<CTA to="https://github.com/box/box-python-sdk">
Learn more about Python SDK on GitHub
</CTA>
Expand All @@ -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
2 changes: 1 addition & 1 deletion content/guides/tooling/sdks/salesforce.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
rank: 5
rank: 6
related_endpoints: []
related_guides:
- authentication/jwt
Expand Down
60 changes: 60 additions & 0 deletions content/guides/tooling/sdks/sdk-versioning.md
Original file line number Diff line number Diff line change
@@ -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.
Loading
Loading