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
Copy file name to clipboardExpand all lines: content/guides/tooling/sdks/dotnet-gen.md
+9-2Lines changed: 9 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
rank: 1
2
+
rank: 9
3
3
related_endpoints: []
4
4
related_guides:
5
5
- authentication/jwt
@@ -11,7 +11,13 @@ related_resources: []
11
11
alias_paths: []
12
12
---
13
13
14
-
# Install .NET SDK (Generated)
14
+
# Deprecated .NET SDK
15
+
16
+
<Messagetype='warning'>
17
+
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**.
18
+
19
+
To learn more visit our SDK [versioning strategy document][versioning]
20
+
</Message>
15
21
16
22
You can use Box .NET SDK to call Box APIs in a .NET
Copy file name to clipboardExpand all lines: content/guides/tooling/sdks/index.md
+33-46Lines changed: 33 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,11 +14,6 @@ alias_paths:
14
14
15
15
Box offers a set of SDKs
16
16
you can use to build your application.
17
-
The next generation .NET SDK is the
18
-
newest addition to the set.
19
-
It is still a beta feature, but you can
20
-
give them a try to explore all the
21
-
features they bring along.
22
17
23
18
<Messagetype='notice'>
24
19
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
35
30
these projects to full parity.
36
31
</Message>
37
32
38
-
## Next generation SDKs
39
-
40
-
The latest generation Box Python SDK, Box TypeScript
41
-
SDK, .NET SDK, and Swift SDK are designed to elevate the developer
42
-
experience and streamline your integration
43
-
with the Box Content Cloud.
44
-
45
-
<Messagetype='notice'>
46
-
Swift SDK is in a Public Beta phase.
47
-
</Message>
48
-
49
-
Here's what you can expect from the new SDKs:
50
-
51
-
-**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.
52
-
-**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.
53
-
-**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.
54
-
-**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.
55
-
56
-
Download the **Box Platform** SDK in a programming language of your choice and get started:
|[Swift Gen SDK][swiftgensdk] (Beta) | Yes | Full |
64
-
|[Java Gen SDK][javagensdk] (Beta) | Yes | Full |
65
-
66
-
## Legacy SDKs
67
-
68
33
The table lists legacy Box SDKs that you can use when building your
69
34
applications. For latest API support and features, use the next
70
35
generation SDKs.
71
36
72
37
| Platform | Maintained? | API Parity |
73
38
| --- | ------- |-------- |
74
-
|[Java SDK][javasdk]| Yes |Full|
75
-
|[iOS Content SDK][iossdk]| Yes |Full|
39
+
|[Java SDK][javasdk]| Yes |Partial|
40
+
|[iOS Content SDK][iossdk]| Yes |Partial|
76
41
|[Android Content SDK][androidsdk]| No | Partial |
77
-
|[.NET SDK][dotnetsdk]|Deprecated. Only critical security updates and bug fixes are implemented. |Full|
78
-
|[Python SDK][pythonsdk]|Deprecated. Only critical security updates and bug fixes are implemented. |Full|
79
-
|[Node SDK][nodesdk]|Deprecated. Only critical security updates and bug fixes are implemented. |Full|
42
+
|[.NET SDK][dotnetsdk]|Yes |Partial|
43
+
|[Python SDK][pythonsdk]|Yes |Partial|
44
+
|[Node SDK][nodesdk]|Yes |Partial|
80
45
81
46
<Messagetype='warning'>
82
47
As of May 31, 2023 Android SDK is no
@@ -91,6 +56,32 @@ build apps on Android.
91
56
Refer to [this][android-docs] documentation for more details.
92
57
</Message>
93
58
59
+
## Next generation SDKs
60
+
61
+
<Messagetype='warning'>
62
+
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**.
63
+
64
+
## Why we are making this change
65
+
66
+
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.
67
+
68
+
Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. Read more to learn the details.
69
+
70
+
To learn more visit our SDK [versioning strategy document][versioning]
71
+
</Message>
72
+
73
+
The latest generation Box Python SDK, Box TypeScript
74
+
SDK, .NET SDK, and Swift SDK are designed to elevate the developer
75
+
experience and streamline your integration
76
+
with the Box Content Cloud.
77
+
78
+
Here's what you can expect from the new SDKs:
79
+
80
+
-**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.
81
+
-**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.
82
+
-**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.
83
+
-**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.
84
+
94
85
<!-- i18n-enable localize-links -->
95
86
96
87
[javasdk]: https://github.com/box/box-java-sdk
@@ -99,12 +90,8 @@ Refer to [this][android-docs] documentation for more details.
Copy file name to clipboardExpand all lines: content/guides/tooling/sdks/python-gen.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
rank: 3
2
+
rank: 8
3
3
related_endpoints: []
4
4
related_guides:
5
5
- authentication/jwt
@@ -11,15 +11,17 @@ related_resources: []
11
11
alias_paths: []
12
12
---
13
13
14
-
# Install Python SDK (Generated)
14
+
# Deprecated Python SDK
15
+
16
+
<Messagetype='warning'>
17
+
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**.
18
+
19
+
To learn more visit our SDK [versioning strategy document][versioning]
20
+
</Message>
15
21
16
22
You can use the **auto-generated** Box Python SDK to call Box APIs in a Python project.
17
23
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.
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.
17
+
18
+
## Why we are making this change
19
+
20
+
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.
21
+
22
+
Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. Read more to learn the details.
23
+
24
+
## How it will work
25
+
26
+
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:
27
+
28
+
-`(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.
29
+
-`v10.0.0` version that includes only the Next Gen SDK artifact.
30
+
31
+
## How to decide
32
+
33
+
1. If you are writing a new application, use the latest major release of the SDK package.
34
+
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.
35
+
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.
36
+
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.
37
+
38
+
## Versioning overview
39
+
40
+
### Box SDK versions and artifacts
41
+
42
+
| SDK Package Name | Current latest version | Combined legacy and Next Gen artifacts | Next Gen SDK artifact |
0 commit comments