@dropbox/sign

Dropbox Sign v3 API

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!

$3

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

Installation & Usage

$3

``npm install @dropbox/sign`

`$3`

* Clone this repo locally * Runnpm pack* The generated file will be named similar todropbox-sign-1.0.0.tgz* Move this file to your project directory * Add the following to your project'spackage.json under dependencies: *"@dropbox/sign": "file:dropbox-sign-1.0.0.tgz"* Runnpm install

`Getting Started`

Please follow the installation procedure and then run the following:

`$3`

`typescript import * as fs from 'fs'; import api from "@dropbox/sign" import models from "@dropbox/sign"

const apiCaller = new api.AccountApi(); apiCaller.username = "YOUR_API_KEY"; // apiCaller.accessToken = "YOUR_ACCESS_TOKEN";

const accountCreateRequest: models.AccountCreateRequest = { emailAddress: "newuser@dropboxsign.com", };

apiCaller.accountCreate( accountCreateRequest, ).then(response => { console.log(response.body); }).catch(error => { console.log("Exception when calling AccountApi#accountCreate:"); console.log(error.body); });

`API Endpoints`

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

| Class | Method | HTTP request | Description | | ---------- | ------------- | ------------- | ------------- | | AccountApi | accountCreate | POST /account/create | Create Account | | AccountApi | accountGet | GET /account | Get Account | | AccountApi | accountUpdate | PUT /account | Update Account | | AccountApi | accountVerify | POST /account/verify | Verify Account | | ApiAppApi | apiAppCreate | POST /api_app | Create API App | | ApiAppApi | apiAppDelete | DELETE /api_app/{client_id} | Delete API App | | ApiAppApi | apiAppGet | GET /api_app/{client_id} | Get API App | | ApiAppApi | apiAppList | GET /api_app/list | List API Apps | | ApiAppApi | apiAppUpdate | PUT /api_app/{client_id} | Update API App | | BulkSendJobApi | bulkSendJobGet | GET /bulk_send_job/{bulk_send_job_id} | Get Bulk Send Job | | BulkSendJobApi | bulkSendJobList | GET /bulk_send_job/list | List Bulk Send Jobs | | EmbeddedApi | embeddedEditUrl | POST /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | | EmbeddedApi | embeddedSignUrl | GET /embedded/sign_url/{signature_id} | Get Embedded Sign URL | | FaxApi | faxDelete | DELETE /fax/{fax_id} | Delete Fax | | FaxApi | faxFiles | GET /fax/files/{fax_id} | Download Fax Files | | FaxApi | faxGet | GET /fax/{fax_id} | Get Fax | | FaxApi | faxList | GET /fax/list | Lists Faxes | | FaxApi | faxSend | POST /fax/send | Send Fax | | FaxLineApi | faxLineAddUser | PUT /fax_line/add_user | Add Fax Line User | | FaxLineApi | faxLineAreaCodeGet | GET /fax_line/area_codes | Get Available Fax Line Area Codes | | FaxLineApi | faxLineCreate | POST /fax_line/create | Purchase Fax Line | | FaxLineApi | faxLineDelete | DELETE /fax_line | Delete Fax Line | | FaxLineApi | faxLineGet | GET /fax_line | Get Fax Line | | FaxLineApi | faxLineList | GET /fax_line/list | List Fax Lines | | FaxLineApi | faxLineRemoveUser | PUT /fax_line/remove_user | Remove Fax Line Access | | OAuthApi | oauthTokenGenerate | POST /oauth/token | OAuth Token Generate | | OAuthApi | oauthTokenRefresh | POST /oauth/token?refresh | OAuth Token Refresh | | ReportApi | reportCreate | POST /report/create | Create Report | | SignatureRequestApi | signatureRequestBulkCreateEmbeddedWithTemplate | POST /signature_request/bulk_create_embedded_with_template | Embedded Bulk Send with Template | | SignatureRequestApi | signatureRequestBulkSendWithTemplate | POST /signature_request/bulk_send_with_template | Bulk Send with Template | | SignatureRequestApi | signatureRequestCancel | POST /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request | | SignatureRequestApi | signatureRequestCreateEmbedded | POST /signature_request/create_embedded | Create Embedded Signature Request | | SignatureRequestApi | signatureRequestCreateEmbeddedWithTemplate | POST /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template | | SignatureRequestApi | signatureRequestEdit | PUT /signature_request/edit/{signature_request_id} | Edit Signature Request | | SignatureRequestApi | signatureRequestEditEmbedded | PUT /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request | | SignatureRequestApi | signatureRequestEditEmbeddedWithTemplate | PUT /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template | | SignatureRequestApi | signatureRequestEditWithTemplate | PUT /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template | | SignatureRequestApi | signatureRequestFiles | GET /signature_request/files/{signature_request_id} | Download Files | | SignatureRequestApi | signatureRequestFilesAsDataUri | GET /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri | | SignatureRequestApi | signatureRequestFilesAsFileUrl | GET /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url | | SignatureRequestApi | signatureRequestGet | GET /signature_request/{signature_request_id} | Get Signature Request | | SignatureRequestApi | signatureRequestList | GET /signature_request/list | List Signature Requests | | SignatureRequestApi | signatureRequestReleaseHold | POST /signature_request/release_hold/{signature_request_id} | Release On-Hold Signature Request | | SignatureRequestApi | signatureRequestRemind | POST /signature_request/remind/{signature_request_id} | Send Request Reminder | | SignatureRequestApi | signatureRequestRemove | POST /signature_request/remove/{signature_request_id} | Remove Signature Request Access | | SignatureRequestApi | signatureRequestSend | POST /signature_request/send | Send Signature Request | | SignatureRequestApi | signatureRequestSendWithTemplate | POST /signature_request/send_with_template | Send with Template | | SignatureRequestApi | signatureRequestUpdate | POST /signature_request/update/{signature_request_id} | Update Signature Request | | TeamApi | teamAddMember | PUT /team/add_member | Add User to Team | | TeamApi | teamCreate | POST /team/create | Create Team | | TeamApi | teamDelete | DELETE /team/destroy | Delete Team | | TeamApi | teamGet | GET /team | Get Team | | TeamApi | teamInfo | GET /team/info | Get Team Info | | TeamApi | teamInvites | GET /team/invites | List Team Invites | | TeamApi | teamMembers | GET /team/members/{team_id} | List Team Members | | TeamApi | teamRemoveMember | POST /team/remove_member | Remove User from Team | | TeamApi | teamSubTeams | GET /team/sub_teams/{team_id} | List Sub Teams | | TeamApi | teamUpdate | PUT /team | Update Team | | TemplateApi | templateAddUser | POST /template/add_user/{template_id} | Add User to Template | | TemplateApi | templateCreate | POST /template/create | Create Template | | TemplateApi | templateCreateEmbeddedDraft | POST /template/create_embedded_draft | Create Embedded Template Draft | | TemplateApi | templateDelete | POST /template/delete/{template_id} | Delete Template | | TemplateApi | templateFiles | GET /template/files/{template_id} | Get Template Files | | TemplateApi | templateFilesAsDataUri | GET /template/files_as_data_uri/{template_id} | Get Template Files as Data Uri | | TemplateApi | templateFilesAsFileUrl | GET /template/files_as_file_url/{template_id} | Get Template Files as File Url | | TemplateApi | templateGet | GET /template/{template_id} | Get Template | | TemplateApi | templateList | GET /template/list | List Templates | | TemplateApi | templateRemoveUser | POST /template/remove_user/{template_id} | Remove User from Template | | TemplateApi | templateUpdateFiles | POST /template/update_files/{template_id} | Update Template Files | | UnclaimedDraftApi | unclaimedDraftCreate | POST /unclaimed_draft/create | Create Unclaimed Draft | | UnclaimedDraftApi | unclaimedDraftCreateEmbedded | POST /unclaimed_draft/create_embedded | Create Embedded Unclaimed Draft | | UnclaimedDraftApi | unclaimedDraftCreateEmbeddedWithTemplate | POST /unclaimed_draft/create_embedded_with_template | Create Embedded Unclaimed Draft with Template | | UnclaimedDraftApi | unclaimedDraftEditAndResend | POST /unclaimed_draft/edit_and_resend/{signature_request_id} | Edit and Resend Unclaimed Draft |

`Models`

`Authorization`

`$3`

- Type: HTTP basic authentication

`$3`

- Type: Bearer authentication (JWT)

`Author`

apisupport@hellosign.com

`About this package`

This package is automatically generated by the OpenAPI Generator project:

- API version: 3.0.0- Build package:org.openapitools.codegen.languages.TypeScriptNodeClientCodegen`

@dropbox/sign

Dropbox Sign v3 API

Migrating from legacy SDK

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!

$3

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

Installation & Usage

$3

``npm install @dropbox/sign`

`$3`

`Getting Started`

Please follow the installation procedure and then run the following:

`$3`

`typescript import * as fs from 'fs'; import api from "@dropbox/sign" import models from "@dropbox/sign"

const apiCaller = new api.AccountApi(); apiCaller.username = "YOUR_API_KEY"; // apiCaller.accessToken = "YOUR_ACCESS_TOKEN";

const accountCreateRequest: models.AccountCreateRequest = { emailAddress: "newuser@dropboxsign.com", };

`API Endpoints`

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

`Models`

`Authorization`

`$3`

- Type: HTTP basic authentication

`$3`

- Type: Bearer authentication (JWT)

`Author`

apisupport@hellosign.com

`About this package`

This package is automatically generated by the OpenAPI Generator project:

- API version: 3.0.0- Build package:org.openapitools.codegen.languages.TypeScriptNodeClientCodegen`