Skip to content

Commit eaa4775

Browse files
Merge pull request #29 from hellosign/release-2.0.0
Release 2.0.0
2 parents 8136f90 + 1f2cbfb commit eaa4775

272 files changed

Lines changed: 3565 additions & 1704 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ docs/_build/
6262
# PyBuilder
6363
target/
6464

65-
#Ipython Notebook
65+
# Ipython Notebook
6666
.ipynb_checkpoints
6767

6868
.openapi-generator

‎.gitlab-ci.yml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,6 @@ stages:
1414
- pip install -r test-requirements.txt
1515
- pytest --cov=dropbox_sign
1616

17-
pytest-3.8:
18-
extends: .pytest
19-
image: python:3.8-alpine
20-
pytest-3.9:
21-
extends: .pytest
22-
image: python:3.9-alpine
2317
pytest-3.10:
2418
extends: .pytest
2519
image: python:3.10-alpine
@@ -29,3 +23,9 @@ pytest-3.11:
2923
pytest-3.12:
3024
extends: .pytest
3125
image: python:3.12-alpine
26+
pytest-3.13:
27+
extends: .pytest
28+
image: python:3.13-alpine
29+
pytest-3.14:
30+
extends: .pytest
31+
image: python:3.14-alpine

‎.travis.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# ref: https://docs.travis-ci.com/user/languages/python
22
language: python
33
python:
4-
- "3.8"
5-
- "3.9"
64
- "3.10"
75
- "3.11"
86
- "3.12"
7+
- "3.13"
8+
- "3.14"
99
# uncomment the following if needed
10-
#- "3.12-dev" # 3.12 development branch
10+
#- "3.14-dev" # 3.14 development branch
1111
#- "nightly" # nightly build
1212
# command to install dependencies
1313
install:

‎README.md‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
# dropbox-sign
22
Dropbox Sign v3 API
33

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+
417
## Migrating from legacy SDK
518

619
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.
4255

4356
### Requirements.
4457

45-
Python 3.8+
58+
Python 3.10+
4659

4760
### pip
4861

4962
Install using `pip`:
5063

5164
```shell
52-
python3 -m pip install dropbox-sign==1.14.1
65+
python3 -m pip install dropbox-sign==2.0.0
5366
```
5467

5568
Alternatively:
@@ -404,6 +417,5 @@ apisupport@hellosign.com
404417
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
405418

406419
- API version: 3.0.0
407-
- Package version: 1.14.1
420+
- Package version: 2.0.0
408421
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
409-

‎VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.14.1
1+
2.0.0

‎docs/ApiAppCreateRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
| `domains`<sup>*_required_</sup> | ```List[str]``` | The domain names the ApiApp will be associated with. | |
99
| `name`<sup>*_required_</sup> | ```str``` | The name you want to assign to the ApiApp. | |
1010
| `callback_url` | ```str``` | The URL at which the ApiApp should receive event callbacks. | |
11-
| `custom_logo_file` | ```io.IOBase``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | |
11+
| `custom_logo_file` | ```bytes``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | |
1212
| `oauth` | [```SubOAuth```](SubOAuth.md) | | |
1313
| `options` | [```SubOptions```](SubOptions.md) | | |
1414
| `white_labeling_options` | [```SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | | |

‎docs/ApiAppUpdateRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
| `callback_url` | ```str``` | The URL at which the API App should receive event callbacks. | |
9-
| `custom_logo_file` | ```io.IOBase``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | |
9+
| `custom_logo_file` | ```bytes``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | |
1010
| `domains` | ```List[str]``` | The domain names the ApiApp will be associated with. | |
1111
| `name` | ```str``` | The name you want to assign to the ApiApp. | |
1212
| `oauth` | [```SubOAuth```](SubOAuth.md) | | |

‎docs/DocumentFieldDetectionRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
| `detection_mode`<sup>*_required_</sup> | ```str``` | The field detection method to use. Set to `annotations` to detect PDF form annotations or `text_tags` to detect Dropbox Sign text tags. | |
9-
| `file` | ```io.IOBase``` | The PDF file to analyze.<br><br>This endpoint requires either `file` or `file_url`, but not both. | |
9+
| `file` | ```bytes``` | The PDF file to analyze.<br><br>This endpoint requires either `file` or `file_url`, but not both. | |
1010
| `file_url` | ```str``` | The URL of the PDF file to analyze.<br><br>This endpoint requires either `file` or `file_url`, but not both. | |
1111
| `page_range` | ```str``` | The zero-based page indexes to analyze. Accepts `all`, individual pages, inclusive ranges, or comma-separated combinations, such as `0-2,5,7-9`. Defaults to `all`. | |
1212

‎docs/FaxApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ void (empty response body)
7272
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
7373
7474
# ```fax_files```
75-
> ```io.IOBase fax_files(fax_id)```
75+
> ```bytes fax_files(fax_id)```
7676
7777
Download Fax Files
7878
@@ -113,7 +113,7 @@ with ApiClient(configuration) as api_client:
113113
114114
### Return type
115115
116-
**io.IOBase**
116+
**bytes**
117117
118118
### Authorization
119119

‎docs/FaxSendRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
| `recipient`<sup>*_required_</sup> | ```str``` | Recipient of the fax Can be a phone number in E.164 format or email address | |
99
| `sender` | ```str``` | Fax Send From Sender (used only with fax number) | |
10-
| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to fax<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
10+
| `files` | ```List[bytes]``` | Use `files[]` to indicate the uploaded file(s) to fax<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
1111
| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
1212
| `test_mode` | ```bool``` | API Test Mode Setting | [default to False] |
1313
| `cover_page_to` | ```str``` | Fax cover page recipient information | |

0 commit comments

Comments
 (0)