Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@dropbox/sign

Package Overview
Dependencies
Maintainers
8
Versions
21
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@dropbox/sign

Official Node client for Dropbox Sign

  • 1.7.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
8
Created
Source

@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!

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.

Installation & Usage

From NPM Package

npm install @dropbox/sign

From Repo

  • Clone this repo locally
  • Run npm pack
  • The generated file will be named similar to dropbox-sign-1.0.0.tgz
  • Move this file to your project directory
  • Add the following to your project's package.json under dependencies:
  • "@dropbox/sign": "file:dropbox-sign-1.0.0.tgz"
  • Run npm install

Getting Started

Please follow the installation procedure and then run the following:

TypeScript Example

import * as DropboxSign from "@dropbox/sign";

const accountApi = new DropboxSign.AccountApi();

// Configure HTTP basic authorization: api_key
accountApi.username = "YOUR_API_KEY";

// or, configure Bearer (JWT) authorization: oauth2
// accountApi.accessToken = "YOUR_ACCESS_TOKEN";

const data: DropboxSign.AccountCreateRequest = {
  emailAddress: "newuser@dropboxsign.com",
};

const result = accountApi.accountCreate(data);
result.then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling Dropbox Sign API:");
  console.log(error.body);
});


JavaScript Example

import * as DropboxSign from "@dropbox/sign";

const accountApi = new DropboxSign.AccountApi();

// Configure HTTP basic authorization: api_key
accountApi.username = "YOUR_API_KEY";

// or, configure Bearer (JWT) authorization: oauth2
// accountApi.accessToken = "YOUR_ACCESS_TOKEN";

const data = {
  emailAddress: "newuser@dropboxsign.com",
};

const result = accountApi.accountCreate(data);
result.then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling Dropbox Sign API:");
  console.log(error.body);
});

API Endpoints

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

ClassMethodHTTP requestDescription
AccountApiaccountCreatePOST /account/createCreate Account
AccountApiaccountGetGET /accountGet Account
AccountApiaccountUpdatePUT /accountUpdate Account
AccountApiaccountVerifyPOST /account/verifyVerify Account
ApiAppApiapiAppCreatePOST /api_appCreate API App
ApiAppApiapiAppDeleteDELETE /api_app/{client_id}Delete API App
ApiAppApiapiAppGetGET /api_app/{client_id}Get API App
ApiAppApiapiAppListGET /api_app/listList API Apps
ApiAppApiapiAppUpdatePUT /api_app/{client_id}Update API App
BulkSendJobApibulkSendJobGetGET /bulk_send_job/{bulk_send_job_id}Get Bulk Send Job
BulkSendJobApibulkSendJobListGET /bulk_send_job/listList Bulk Send Jobs
EmbeddedApiembeddedEditUrlPOST /embedded/edit_url/{template_id}Get Embedded Template Edit URL
EmbeddedApiembeddedSignUrlGET /embedded/sign_url/{signature_id}Get Embedded Sign URL
FaxApifaxDeleteDELETE /fax/{fax_id}Delete Fax
FaxApifaxFilesGET /fax/files/{fax_id}List Fax Files
FaxApifaxGetGET /fax/{fax_id}Get Fax
FaxApifaxListGET /fax/listLists Faxes
FaxApifaxSendPOST /fax/sendSend Fax
FaxLineApifaxLineAddUserPUT /fax_line/add_userAdd Fax Line User
FaxLineApifaxLineAreaCodeGetGET /fax_line/area_codesGet Available Fax Line Area Codes
FaxLineApifaxLineCreatePOST /fax_line/createPurchase Fax Line
FaxLineApifaxLineDeleteDELETE /fax_lineDelete Fax Line
FaxLineApifaxLineGetGET /fax_lineGet Fax Line
FaxLineApifaxLineListGET /fax_line/listList Fax Lines
FaxLineApifaxLineRemoveUserPUT /fax_line/remove_userRemove Fax Line Access
OAuthApioauthTokenGeneratePOST /oauth/tokenOAuth Token Generate
OAuthApioauthTokenRefreshPOST /oauth/token?refreshOAuth Token Refresh
ReportApireportCreatePOST /report/createCreate Report
SignatureRequestApisignatureRequestBulkCreateEmbeddedWithTemplatePOST /signature_request/bulk_create_embedded_with_templateEmbedded Bulk Send with Template
SignatureRequestApisignatureRequestBulkSendWithTemplatePOST /signature_request/bulk_send_with_templateBulk Send with Template
SignatureRequestApisignatureRequestCancelPOST /signature_request/cancel/{signature_request_id}Cancel Incomplete Signature Request
SignatureRequestApisignatureRequestCreateEmbeddedPOST /signature_request/create_embeddedCreate Embedded Signature Request
SignatureRequestApisignatureRequestCreateEmbeddedWithTemplatePOST /signature_request/create_embedded_with_templateCreate Embedded Signature Request with Template
SignatureRequestApisignatureRequestFilesGET /signature_request/files/{signature_request_id}Download Files
SignatureRequestApisignatureRequestFilesAsDataUriGET /signature_request/files_as_data_uri/{signature_request_id}Download Files as Data Uri
SignatureRequestApisignatureRequestFilesAsFileUrlGET /signature_request/files_as_file_url/{signature_request_id}Download Files as File Url
SignatureRequestApisignatureRequestGetGET /signature_request/{signature_request_id}Get Signature Request
SignatureRequestApisignatureRequestListGET /signature_request/listList Signature Requests
SignatureRequestApisignatureRequestReleaseHoldPOST /signature_request/release_hold/{signature_request_id}Release On-Hold Signature Request
SignatureRequestApisignatureRequestRemindPOST /signature_request/remind/{signature_request_id}Send Request Reminder
SignatureRequestApisignatureRequestRemovePOST /signature_request/remove/{signature_request_id}Remove Signature Request Access
SignatureRequestApisignatureRequestSendPOST /signature_request/sendSend Signature Request
SignatureRequestApisignatureRequestSendWithTemplatePOST /signature_request/send_with_templateSend with Template
SignatureRequestApisignatureRequestUpdatePOST /signature_request/update/{signature_request_id}Update Signature Request
TeamApiteamAddMemberPUT /team/add_memberAdd User to Team
TeamApiteamCreatePOST /team/createCreate Team
TeamApiteamDeleteDELETE /team/destroyDelete Team
TeamApiteamGetGET /teamGet Team
TeamApiteamInfoGET /team/infoGet Team Info
TeamApiteamInvitesGET /team/invitesList Team Invites
TeamApiteamMembersGET /team/members/{team_id}List Team Members
TeamApiteamRemoveMemberPOST /team/remove_memberRemove User from Team
TeamApiteamSubTeamsGET /team/sub_teams/{team_id}List Sub Teams
TeamApiteamUpdatePUT /teamUpdate Team
TemplateApitemplateAddUserPOST /template/add_user/{template_id}Add User to Template
TemplateApitemplateCreatePOST /template/createCreate Template
TemplateApitemplateCreateEmbeddedDraftPOST /template/create_embedded_draftCreate Embedded Template Draft
TemplateApitemplateDeletePOST /template/delete/{template_id}Delete Template
TemplateApitemplateFilesGET /template/files/{template_id}Get Template Files
TemplateApitemplateFilesAsDataUriGET /template/files_as_data_uri/{template_id}Get Template Files as Data Uri
TemplateApitemplateFilesAsFileUrlGET /template/files_as_file_url/{template_id}Get Template Files as File Url
TemplateApitemplateGetGET /template/{template_id}Get Template
TemplateApitemplateListGET /template/listList Templates
TemplateApitemplateRemoveUserPOST /template/remove_user/{template_id}Remove User from Template
TemplateApitemplateUpdateFilesPOST /template/update_files/{template_id}Update Template Files
UnclaimedDraftApiunclaimedDraftCreatePOST /unclaimed_draft/createCreate Unclaimed Draft
UnclaimedDraftApiunclaimedDraftCreateEmbeddedPOST /unclaimed_draft/create_embeddedCreate Embedded Unclaimed Draft
UnclaimedDraftApiunclaimedDraftCreateEmbeddedWithTemplatePOST /unclaimed_draft/create_embedded_with_templateCreate Embedded Unclaimed Draft with Template
UnclaimedDraftApiunclaimedDraftEditAndResendPOST /unclaimed_draft/edit_and_resend/{signature_request_id}Edit and Resend Unclaimed Draft

Models

Authorization

api_key

  • Type: HTTP basic authentication

oauth2

  • 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

FAQs

Package last updated on 29 Oct 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc