|
1 | 1 | # dropbox-sign |
2 | 2 | Dropbox Sign v3 API |
3 | 3 |
|
| 4 | +## Upgrading to 2.0.0 |
| 5 | + |
| 6 | +Version 2.0.0 is generated with OpenAPI Generator 7.26.0. Existing code keeps working, with these changes: |
| 7 | + |
| 8 | +- **Python 3.10 or later is required.** Python 3.8 and 3.9 are no longer supported; pip keeps installing 1.x on those versions. |
| 9 | +- **Dependencies:** `urllib3 >= 2.8.0` and `pydantic >= 2.11`. |
| 10 | +- **Proxy settings are now detected automatically.** When `Configuration.proxy` is not set, the SDK uses the proxy configured in the environment (`HTTPS_PROXY`, `HTTP_PROXY`, `ALL_PROXY`) and, on macOS and Windows, the system proxy settings. Previously, a proxy was only used when set explicitly. |
| 11 | + - To bypass the proxy for the Dropbox Sign API, set `NO_PROXY=hellosign.com` or `configuration.no_proxy = "hellosign.com"`. This covers both `api.hellosign.com` and `app.hellosign.com` (used by the OAuth endpoints). |
| 12 | + - To ignore all proxy settings, set `configuration.proxy = None` after creating the `Configuration` and before creating the `ApiClient`. Passing `proxy=None` to the constructor does not disable detection. |
| 13 | + - SOCKS proxies (for example `ALL_PROXY=socks5://...`) require `pip install "urllib3[socks]"`. |
| 14 | + - Known limitations: the proxy decision is made once per `ApiClient` for the configured host, and macOS/Windows proxy exclusion lists and PAC files are not applied. If you rely on them, set `NO_PROXY` or `configuration.no_proxy` explicitly. |
| 15 | +- **Behaviour changes:** `to_json()` now serializes datetimes, `to_dict()` keeps `None` items in lists, boolean query parameters are sent as `true` / `false`, and the `ApiException` message lists the response body and data separately. |
| 16 | + |
4 | 17 | ## Migrating from legacy SDK |
5 | 18 |
|
6 | 19 | This SDK is generated from our officially maintained [OpenAPI spec](https://github.com/hellosign/hellosign-openapi/blob/main/openapi.yaml). |
@@ -42,14 +55,14 @@ this command. |
42 | 55 |
|
43 | 56 | ### Requirements. |
44 | 57 |
|
45 | | -Python 3.8+ |
| 58 | +Python 3.10+ |
46 | 59 |
|
47 | 60 | ### pip |
48 | 61 |
|
49 | 62 | Install using `pip`: |
50 | 63 |
|
51 | 64 | ```shell |
52 | | -python3 -m pip install dropbox-sign==1.14.1 |
| 65 | +python3 -m pip install dropbox-sign==2.0.0 |
53 | 66 | ``` |
54 | 67 |
|
55 | 68 | Alternatively: |
@@ -404,6 +417,5 @@ apisupport@hellosign.com |
404 | 417 | This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: |
405 | 418 |
|
406 | 419 | - API version: 3.0.0 |
407 | | -- Package version: 1.14.1 |
| 420 | +- Package version: 2.0.0 |
408 | 421 | - Build package: org.openapitools.codegen.languages.PythonClientCodegen |
409 | | - |
|
0 commit comments