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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ stages:
- pip install -r test-requirements.txt
- pytest --cov=dropbox_sign

pytest-3.7:
extends: .pytest
image: python:3.7-alpine
pytest-3.8:
extends: .pytest
image: python:3.8-alpine
Expand All @@ -29,3 +26,6 @@ pytest-3.10:
pytest-3.11:
extends: .pytest
image: python:3.11-alpine
pytest-3.12:
extends: .pytest
image: python:3.12-alpine
4 changes: 2 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# ref: https://docs.travis-ci.com/user/languages/python
language: python
python:
- "3.7"
- "3.8"
- "3.9"
- "3.10"
- "3.11"
- "3.12"
# uncomment the following if needed
#- "3.11-dev" # 3.11 development branch
#- "3.12-dev" # 3.12 development branch
#- "nightly" # nightly build
# command to install dependencies
install:
Expand Down
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ this command.

### Requirements.

Python 3.7+
Python 3.8+

### pip

Install using `pip`:

```shell
python3 -m pip install dropbox-sign==1.8.0
python3 -m pip install dropbox-sign==1.9.0
```

Alternatively:
Expand All @@ -69,29 +69,30 @@ Please follow the [installation procedure](#installation--usage) and then run th


```python
import json
from datetime import date, datetime
from pprint import pprint

from dropbox_sign import ApiClient, ApiException, Configuration, apis, models
from dropbox_sign import ApiClient, ApiException, Configuration, api, models

configuration = Configuration(
# Configure HTTP basic authorization: api_key
username="YOUR_API_KEY",
# or, configure Bearer (JWT) authorization: oauth2
# access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
account_api = apis.AccountApi(api_client)

data = models.AccountCreateRequest(
account_create_request = models.AccountCreateRequest(
email_address="newuser@dropboxsign.com",
)

try:
response = account_api.account_create(data)
response = api.AccountApi(api_client).account_create(
account_create_request=account_create_request,
)

pprint(response)
except ApiException as e:
print("Exception when calling Dropbox Sign API: %s\n" % e)
print("Exception when calling AccountApi#account_create: %s\n" % e)

```

Expand All @@ -116,7 +117,7 @@ Class | Method | HTTP request | Description
|```EmbeddedApi``` | [```embedded_edit_url```](docs/EmbeddedApi.md#embedded_edit_url) | ```POST /embedded/edit_url/{template_id}``` | Get Embedded Template Edit URL|
```EmbeddedApi``` | [```embedded_sign_url```](docs/EmbeddedApi.md#embedded_sign_url) | ```GET /embedded/sign_url/{signature_id}``` | Get Embedded Sign URL|
|```FaxApi``` | [```fax_delete```](docs/FaxApi.md#fax_delete) | ```DELETE /fax/{fax_id}``` | Delete Fax|
```FaxApi``` | [```fax_files```](docs/FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | List Fax Files|
```FaxApi``` | [```fax_files```](docs/FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | Download Fax Files|
```FaxApi``` | [```fax_get```](docs/FaxApi.md#fax_get) | ```GET /fax/{fax_id}``` | Get Fax|
```FaxApi``` | [```fax_list```](docs/FaxApi.md#fax_list) | ```GET /fax/list``` | Lists Faxes|
```FaxApi``` | [```fax_send```](docs/FaxApi.md#fax_send) | ```POST /fax/send``` | Send Fax|
Expand All @@ -135,6 +136,10 @@ Class | Method | HTTP request | Description
```SignatureRequestApi``` | [```signature_request_cancel```](docs/SignatureRequestApi.md#signature_request_cancel) | ```POST /signature_request/cancel/{signature_request_id}``` | Cancel Incomplete Signature Request|
```SignatureRequestApi``` | [```signature_request_create_embedded```](docs/SignatureRequestApi.md#signature_request_create_embedded) | ```POST /signature_request/create_embedded``` | Create Embedded Signature Request|
```SignatureRequestApi``` | [```signature_request_create_embedded_with_template```](docs/SignatureRequestApi.md#signature_request_create_embedded_with_template) | ```POST /signature_request/create_embedded_with_template``` | Create Embedded Signature Request with Template|
```SignatureRequestApi``` | [```signature_request_edit```](docs/SignatureRequestApi.md#signature_request_edit) | ```PUT /signature_request/edit/{signature_request_id}``` | Edit Signature Request|
```SignatureRequestApi``` | [```signature_request_edit_embedded```](docs/SignatureRequestApi.md#signature_request_edit_embedded) | ```PUT /signature_request/edit_embedded/{signature_request_id}``` | Edit Embedded Signature Request|
```SignatureRequestApi``` | [```signature_request_edit_embedded_with_template```](docs/SignatureRequestApi.md#signature_request_edit_embedded_with_template) | ```PUT /signature_request/edit_embedded_with_template/{signature_request_id}``` | Edit Embedded Signature Request with Template|
```SignatureRequestApi``` | [```signature_request_edit_with_template```](docs/SignatureRequestApi.md#signature_request_edit_with_template) | ```PUT /signature_request/edit_with_template/{signature_request_id}``` | Edit Signature Request With Template|
```SignatureRequestApi``` | [```signature_request_files```](docs/SignatureRequestApi.md#signature_request_files) | ```GET /signature_request/files/{signature_request_id}``` | Download Files|
```SignatureRequestApi``` | [```signature_request_files_as_data_uri```](docs/SignatureRequestApi.md#signature_request_files_as_data_uri) | ```GET /signature_request/files_as_data_uri/{signature_request_id}``` | Download Files as Data Uri|
```SignatureRequestApi``` | [```signature_request_files_as_file_url```](docs/SignatureRequestApi.md#signature_request_files_as_file_url) | ```GET /signature_request/files_as_file_url/{signature_request_id}``` | Download Files as File Url|
Expand Down Expand Up @@ -238,6 +243,10 @@ Class | Method | HTTP request | Description
- [SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md)
- [SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md)
- [SignatureRequestCreateEmbeddedWithTemplateRequest](docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md)
- [SignatureRequestEditEmbeddedRequest](docs/SignatureRequestEditEmbeddedRequest.md)
- [SignatureRequestEditEmbeddedWithTemplateRequest](docs/SignatureRequestEditEmbeddedWithTemplateRequest.md)
- [SignatureRequestEditRequest](docs/SignatureRequestEditRequest.md)
- [SignatureRequestEditWithTemplateRequest](docs/SignatureRequestEditWithTemplateRequest.md)
- [SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md)
- [SignatureRequestListResponse](docs/SignatureRequestListResponse.md)
- [SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md)
Expand Down Expand Up @@ -391,6 +400,6 @@ apisupport@hellosign.com
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 3.0.0
- Package version: 1.8.0
- Package version: 1.9.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.8.0
1.9.0
1 change: 1 addition & 0 deletions bin/check-clean-git-status
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ if [[ $(git status --porcelain) != '' ]]; then
printf "\t./run-build\n"

git status
git diff

exit 1
else
Expand Down
1 change: 0 additions & 1 deletion bin/generate-examples.php
Original file line number Diff line number Diff line change
Expand Up @@ -271,4 +271,3 @@ protected function getReplaceCodeString(
$generate->setUseSnakeCase(true);

$generate->run();

2 changes: 1 addition & 1 deletion bin/replace
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ rep () {
done
}

rep 'Union\[StrictBytes, StrictStr\]' 'Union[StrictBytes, StrictStr, io.IOBase]'
rep 'Union\[StrictBytes, StrictStr, Tuple\[StrictStr, StrictBytes\]\]' 'Union[StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]]'

printf "\n"
65 changes: 34 additions & 31 deletions docs/AccountApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,29 +23,30 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_
* Bearer (JWT) Authentication (oauth2):

```python
import json
from datetime import date, datetime
from pprint import pprint

from dropbox_sign import ApiClient, ApiException, Configuration, apis, models
from dropbox_sign import ApiClient, ApiException, Configuration, api, models

configuration = Configuration(
# Configure HTTP basic authorization: api_key
username="YOUR_API_KEY",
# or, configure Bearer (JWT) authorization: oauth2
# access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
account_api = apis.AccountApi(api_client)

data = models.AccountCreateRequest(
account_create_request = models.AccountCreateRequest(
email_address="newuser@dropboxsign.com",
)

try:
response = account_api.account_create(data)
response = api.AccountApi(api_client).account_create(
account_create_request=account_create_request,
)

pprint(response)
except ApiException as e:
print("Exception when calling Dropbox Sign API: %s\n" % e)
print("Exception when calling AccountApi#account_create: %s\n" % e)

```
```
Expand Down Expand Up @@ -90,25 +91,24 @@ Returns the properties and settings of your Account.
* Bearer (JWT) Authentication (oauth2):

```python
import json
from datetime import date, datetime
from pprint import pprint

from dropbox_sign import ApiClient, ApiException, Configuration, apis
from dropbox_sign import ApiClient, ApiException, Configuration, api, models

configuration = Configuration(
# Configure HTTP basic authorization: api_key
username="YOUR_API_KEY",
# or, configure Bearer (JWT) authorization: oauth2
# access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
account_api = apis.AccountApi(api_client)

try:
response = account_api.account_get(email_address="jack@example.com")
response = api.AccountApi(api_client).account_get()

pprint(response)
except ApiException as e:
print("Exception when calling Dropbox Sign API: %s\n" % e)
print("Exception when calling AccountApi#account_get: %s\n" % e)

```
```
Expand Down Expand Up @@ -154,29 +154,31 @@ Updates the properties and settings of your Account. Currently only allows for u
* Bearer (JWT) Authentication (oauth2):

```python
import json
from datetime import date, datetime
from pprint import pprint

from dropbox_sign import ApiClient, ApiException, Configuration, apis, models
from dropbox_sign import ApiClient, ApiException, Configuration, api, models

configuration = Configuration(
# Configure HTTP basic authorization: api_key
username="YOUR_API_KEY",
# or, configure Bearer (JWT) authorization: oauth2
# access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
account_api = apis.AccountApi(api_client)

data = models.AccountUpdateRequest(
account_update_request = models.AccountUpdateRequest(
callback_url="https://www.example.com/callback",
locale="en-US",
)

try:
response = account_api.account_update(data)
response = api.AccountApi(api_client).account_update(
account_update_request=account_update_request,
)

pprint(response)
except ApiException as e:
print("Exception when calling Dropbox Sign API: %s\n" % e)
print("Exception when calling AccountApi#account_update: %s\n" % e)

```
```
Expand Down Expand Up @@ -221,29 +223,30 @@ Verifies whether an Dropbox Sign Account exists for the given email address.
* Bearer (JWT) Authentication (oauth2):

```python
import json
from datetime import date, datetime
from pprint import pprint

from dropbox_sign import ApiClient, ApiException, Configuration, apis, models
from dropbox_sign import ApiClient, ApiException, Configuration, api, models

configuration = Configuration(
# Configure HTTP basic authorization: api_key
username="YOUR_API_KEY",
# or, configure Bearer (JWT) authorization: oauth2
# access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
account_api = apis.AccountApi(api_client)

data = models.AccountVerifyRequest(
account_verify_request = models.AccountVerifyRequest(
email_address="some_user@dropboxsign.com",
)

try:
response = account_api.account_verify(data)
response = api.AccountApi(api_client).account_verify(
account_verify_request=account_verify_request,
)

pprint(response)
except ApiException as e:
print("Exception when calling Dropbox Sign API: %s\n" % e)
print("Exception when calling AccountApi#account_verify: %s\n" % e)

```
```
Expand Down
1 change: 1 addition & 0 deletions docs/AccountCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Name | Type | Description | Notes

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/AccountCreateResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Name | Type | Description | Notes

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/AccountGetResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ Name | Type | Description | Notes

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/AccountResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ Name | Type | Description | Notes

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/AccountResponseQuotas.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ Name | Type | Description | Notes

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/AccountResponseUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ Name | Type | Description | Notes

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/AccountUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ Name | Type | Description | Notes

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/AccountVerifyRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ Name | Type | Description | Notes

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/AccountVerifyResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ Name | Type | Description | Notes

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/AccountVerifyResponseAccount.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ Name | Type | Description | Notes

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading
Loading