Dropbox Sign v3 API
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.
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!
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.
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.
Python 3.7+
Install using pip:
python3 -m pip install dropbox-sign==1.7.0
Alternatively:
pip install git+https://github.com/hellosign/dropbox-sign-python.git
Then import the package:
import dropbox_sign
Please follow the installation procedure and then run the following:
from pprint import pprint
from dropbox_sign import ApiClient, ApiException, Configuration, apis, 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(
email_address="newuser@dropboxsign.com",
)
try:
response = account_api.account_create(data)
pprint(response)
except ApiException as e:
print("Exception when calling Dropbox Sign API: %s\n" % e)
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 |
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} | List 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_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 |
Authentication schemes defined for the API:
This Python package is automatically generated by the OpenAPI Generator project:
FAQs
Dropbox Sign API
We found that dropbox-sign demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.