Skip to content

About

Official Python SDK for the Dropbox Sign API

pypi.org/project/dropbox-sign/

Topics

dropboxdropbox-signhellosignhellosign-apiopenapi

Resources

Readme
MIT license
Activity
Custom properties

Stars

12 stars

Watchers

7 watching

Forks

6 forks
Report repository
BranchesTags

Latest commit

 

History

77 Commits

Folders and files

NameName
Last commit message
Last commit date
.github/workflows
.github/workflows
 
 
bin
bin
 
 
docs
docs
 
 
dropbox_sign
dropbox_sign
 
 
examples
examples
 
 
templates
templates
 
 
test_fixtures
test_fixtures
 
 
tests
tests
 
 
.editorconfig
.editorconfig
 
 
.gitignore
.gitignore
 
 
.gitlab-ci.yml
.gitlab-ci.yml
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.travis.yml
.travis.yml
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
VERSION
VERSION
 
 
composer.json
composer.json
 
 
composer.lock
composer.lock
 
 
git_push.sh
git_push.sh
 
 
openapi-config.yaml
openapi-config.yaml
 
 
openapi-sdk.yaml
openapi-sdk.yaml
 
 
pyproject.toml
pyproject.toml
 
 
requirements.txt
requirements.txt
 
 
run-build
run-build
 
 
setup.cfg
setup.cfg
 
 
setup.py
setup.py
 
 
test-requirements.txt
test-requirements.txt
 
 
tox.ini
tox.ini
 
 

Repository files navigation

dropbox-sign

Dropbox Sign v3 API

Upgrading to 2.0.0

Version 2.0.0 is generated with OpenAPI Generator 7.26.0. Existing code keeps working, with these changes:

  • 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.
  • Dependencies: urllib3 >= 2.8.0 and pydantic >= 2.11.
  • 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.
    • 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).
    • 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.
    • SOCKS proxies (for example ALL_PROXY=socks5://...) require pip install "urllib3[socks]".
    • 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.
  • 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.

Migrating from legacy SDK

This SDK is generated from our officially maintained OpenAPI spec. We've made important updates that introduce new functionality and create feature parity between the Dropbox Sign API and the SDK. However, some of these changes are considered "breaking" in the sense that they'll require you to update your existing code in order to continue using the SDK. Please refer to this migration guide for more information.

Contributing

This repo is no longer accepting new issues or Pull Requests. All issues or Pull Requests must be opened against the hellosign/hellosign-openapi repo!

Changes to the SDK code

You must make SDK code changes in the mustache file within the templates directory that corresponds to the file you want updated.

We use OpenAPI Generator to automatically generate this SDK from the OAS, using the template files.

Building

You must have docker (or podman linked to docker) installed. Highly recommended to use rootless docker.

Run the following and everything is done for you:

./run-build

Attention: Any changes you have made to the SDK code that you have not made to the OAS file and/or the mustache template files will be lost when you run this command.

Installation & Usage

Requirements.

Python 3.10+

pip

Install using pip:

python3 -m pip install dropbox-sign==2.0.0

Alternatively:

pip install git+https://github.com/hellosign/dropbox-sign-python.git

Then import the package:

import dropbox_sign

Getting Started

Please follow the installation procedure and then run the following:

import json
from datetime import date, datetime
from pprint import pprint

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

configuration = Configuration(
    username="YOUR_API_KEY",
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    account_create_request = models.AccountCreateRequest(
        email_address="newuser@dropboxsign.com",
    )

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

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

Documentation for API Endpoints

All URIs are relative to https://api.hellosign.com/v3

Class Method HTTP request Description
AccountApi account_create POST /account/create Create Account
AccountApi account_get GET /account Get Account
AccountApi account_update PUT /account Update Account
AccountApi account_verify POST /account/verify Verify Account
ApiAppApi api_app_create POST /api_app Create API App
ApiAppApi api_app_delete DELETE /api_app/{client_id} Delete API App
ApiAppApi api_app_get GET /api_app/{client_id} Get API App
ApiAppApi api_app_list GET /api_app/list List API Apps
ApiAppApi api_app_update PUT /api_app/{client_id} Update API App
BulkSendJobApi bulk_send_job_get GET /bulk_send_job/{bulk_send_job_id} Get Bulk Send Job
BulkSendJobApi bulk_send_job_list GET /bulk_send_job/list List Bulk Send Jobs
DocumentApi document_detect_fields POST /document/detect_fields Detect Document Fields
EmbeddedApi embedded_edit_url POST /embedded/edit_url/{template_id} Get Embedded Template Edit URL
EmbeddedApi embedded_sign_url GET /embedded/sign_url/{signature_id} Get Embedded Sign URL
FaxApi fax_delete DELETE /fax/{fax_id} Delete Fax
FaxApi fax_files GET /fax/files/{fax_id} Download Fax Files
FaxApi fax_get GET /fax/{fax_id} Get Fax
FaxApi fax_list GET /fax/list Lists Faxes
FaxApi fax_send POST /fax/send Send Fax
FaxLineApi fax_line_add_user PUT /fax_line/add_user Add Fax Line User
FaxLineApi fax_line_area_code_get GET /fax_line/area_codes Get Available Fax Line Area Codes
FaxLineApi fax_line_create POST /fax_line/create Purchase Fax Line
FaxLineApi fax_line_delete DELETE /fax_line Delete Fax Line
FaxLineApi fax_line_get GET /fax_line Get Fax Line
FaxLineApi fax_line_list GET /fax_line/list List Fax Lines
FaxLineApi fax_line_remove_user PUT /fax_line/remove_user Remove Fax Line Access
OAuthApi oauth_token_generate POST /oauth/token OAuth Token Generate
OAuthApi oauth_token_refresh POST /oauth/token?refresh OAuth Token Refresh
ReportApi report_create POST /report/create Create Report
SignatureRequestApi signature_request_bulk_create_embedded_with_template POST /signature_request/bulk_create_embedded_with_template Embedded Bulk Send with Template
SignatureRequestApi signature_request_bulk_send_with_template POST /signature_request/bulk_send_with_template Bulk Send with Template
SignatureRequestApi signature_request_cancel POST /signature_request/cancel/{signature_request_id} Cancel Incomplete Signature Request
SignatureRequestApi signature_request_create_embedded POST /signature_request/create_embedded Create Embedded Signature Request
SignatureRequestApi signature_request_create_embedded_with_template POST /signature_request/create_embedded_with_template Create Embedded Signature Request with Template
SignatureRequestApi signature_request_edit PUT /signature_request/edit/{signature_request_id} Edit Signature Request
SignatureRequestApi signature_request_edit_embedded PUT /signature_request/edit_embedded/{signature_request_id} Edit Embedded Signature Request
SignatureRequestApi 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 PUT /signature_request/edit_with_template/{signature_request_id} Edit Signature Request With Template
SignatureRequestApi signature_request_files GET /signature_request/files/{signature_request_id} Download Files
SignatureRequestApi 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 GET /signature_request/files_as_file_url/{signature_request_id} Download Files as File Url
SignatureRequestApi signature_request_get GET /signature_request/{signature_request_id} Get Signature Request
SignatureRequestApi signature_request_list GET /signature_request/list List Signature Requests
SignatureRequestApi signature_request_release_hold POST /signature_request/release_hold/{signature_request_id} Release On-Hold Signature Request
SignatureRequestApi signature_request_remind POST /signature_request/remind/{signature_request_id} Send Request Reminder
SignatureRequestApi signature_request_remove POST /signature_request/remove/{signature_request_id} Remove Signature Request Access
SignatureRequestApi signature_request_send POST /signature_request/send Send Signature Request
SignatureRequestApi signature_request_send_with_template POST /signature_request/send_with_template Send with Template
SignatureRequestApi signature_request_update POST /signature_request/update/{signature_request_id} Update Signature Request
TeamApi team_add_member PUT /team/add_member Add User to Team
TeamApi team_create POST /team/create Create Team
TeamApi team_delete DELETE /team/destroy Delete Team
TeamApi team_get GET /team Get Team
TeamApi team_info GET /team/info Get Team Info
TeamApi team_invites GET /team/invites List Team Invites
TeamApi team_members GET /team/members/{team_id} List Team Members
TeamApi team_remove_member POST /team/remove_member Remove User from Team
TeamApi team_sub_teams GET /team/sub_teams/{team_id} List Sub Teams
TeamApi team_update PUT /team Update Team
TemplateApi template_add_user POST /template/add_user/{template_id} Add User to Template
TemplateApi template_create POST /template/create Create Template
TemplateApi template_create_embedded_draft POST /template/create_embedded_draft Create Embedded Template Draft
TemplateApi template_delete POST /template/delete/{template_id} Delete Template
TemplateApi template_files GET /template/files/{template_id} Get Template Files
TemplateApi template_files_as_data_uri GET /template/files_as_data_uri/{template_id} Get Template Files as Data Uri
TemplateApi template_files_as_file_url GET /template/files_as_file_url/{template_id} Get Template Files as File Url
TemplateApi template_get GET /template/{template_id} Get Template
TemplateApi template_list GET /template/list List Templates
TemplateApi template_remove_user POST /template/remove_user/{template_id} Remove User from Template
TemplateApi template_update_files POST /template/update_files/{template_id} Update Template Files
UnclaimedDraftApi unclaimed_draft_create POST /unclaimed_draft/create Create Unclaimed Draft
UnclaimedDraftApi unclaimed_draft_create_embedded POST /unclaimed_draft/create_embedded Create Embedded Unclaimed Draft
UnclaimedDraftApi unclaimed_draft_create_embedded_with_template POST /unclaimed_draft/create_embedded_with_template Create Embedded Unclaimed Draft with Template
UnclaimedDraftApi unclaimed_draft_edit_and_resend POST /unclaimed_draft/edit_and_resend/{signature_request_id} Edit and Resend Unclaimed Draft

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

api_key

  • Type: HTTP basic authentication

oauth2

  • Type: Bearer authentication (JWT)

Author

apisupport@hellosign.com

About this package

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 3.0.0
  • Package version: 2.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

About

Official Python SDK for the Dropbox Sign API

pypi.org/project/dropbox-sign/

Topics

dropboxdropbox-signhellosignhellosign-apiopenapi

Resources

Readme
MIT license
Activity
Custom properties

Stars

12 stars

Watchers

7 watching

Forks

6 forks
Report repository

Releases

Used by

Contributors

Languages