Hellosign-sdk NPM

HelloSign v3 API

⚠ This package is not yet ready for production use ⚠

We are working hard on getting this package ready, but it is not there, yet!

You should think twice before using package on anything critical.

The interfaces may change without warning. Backwards compatibility is not yet guaranteed nor implied!

Installation & Usage

From NPM Package

npm install hellosign-sdk@github:HelloFax/hellosign-nodejs-sdk#openapi

From Repo

Clone this repo locally
Run npm pack
The generated file will be named similar to hellosign-sdk-6.0.0.tgz
Move this file to your project directory
Add the following to your project's package.json under dependencies:
"hellosign-sdk": "file:hellosign-sdk-6.0.0.tgz"
Run npm install

Getting Started

Please follow the installation procedure and then run the following:

TypeScript Example

import * as HelloSignSDK from "hellosign-sdk";

const api = new HelloSignSDK.AccountApi();

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

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

const data: HelloSignSDK.AccountCreateRequest = {
  emailAddress: "newuser@hellosign.com",
};

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

JavaScript Example

import * as HelloSignSDK from "hellosign-sdk";

const api = new HelloSignSDK.AccountApi();

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

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

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

const result = api.accountCreate(data);
result.then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling HelloSign API:");
  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
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	signatureRequestFiles	GET /signature_request/files/{signature_request_id}	Download Files
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	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	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	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