Giter VIP home page Giter VIP logo

signrequest-node-client's Introduction

signrequest-client

SignrequestClient - JavaScript client for SignRequest.com

npm version

Installation

npm

Then install it via:

npm install signrequest-client --save

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ];
}

API Documentation

Full API documentation, including code samples, can be found here: https://signrequest.com/api/v1/docs/

Getting Started

Please follow the installation instruction and execute the following JS code:

var SignrequestClient = require("signrequest-client");

var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications["Token"];
Token.apiKey = "YOUR API KEY";
Token.apiKeyPrefix["Authorization"] = "Token";

var api = new SignrequestClient.DocumentsApi();

var data = new SignrequestClient.Document();
data.file_from_url =
  "https://docs.google.com/document/d/1oI2R1SxfMNZXiz3jCQvorpoklF9xq_dCJnOpkI-zo80/edit?usp=sharing";

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
};
api.documentsCreate(data, callback);

Documentation for API Endpoints

All URIs are relative to https://signrequest.com/api/v1

Class Method HTTP request Description
SignrequestClient.ApiTokensApi apiTokensCreate POST /api-tokens/ Create an API token
SignrequestClient.ApiTokensApi apiTokensDelete DELETE /api-tokens/{key}/ Delete an API token
SignrequestClient.ApiTokensApi apiTokensList GET /api-tokens/ Retrieve a list of API tokens
SignrequestClient.ApiTokensApi apiTokensRead GET /api-tokens/{key}/ Retrieve an API token
SignrequestClient.DocumentAttachmentsApi documentAttachmentsCreate POST /document-attachments/ Create a Document Attachment
SignrequestClient.DocumentAttachmentsApi documentAttachmentsList GET /document-attachments/ Retrieve a list of Document Attachments
SignrequestClient.DocumentAttachmentsApi documentAttachmentsRead GET /document-attachments/{uuid}/ Retrieve a Document Attachment
SignrequestClient.DocumentsApi documentsCreate POST /documents/ Create a Document
SignrequestClient.DocumentsApi documentsDelete DELETE /documents/{uuid}/ Delete a Document
SignrequestClient.DocumentsApi documentsList GET /documents/ Retrieve a list of Documents
SignrequestClient.DocumentsApi documentsRead GET /documents/{uuid}/ Retrieve a Document
SignrequestClient.DocumentsSearchApi documentsSearchList GET /documents-search/ Search documents
SignrequestClient.EventsApi eventsList GET /events/ Retrieve a list of Events
SignrequestClient.EventsApi eventsRead GET /events/{id}/ Retrieve an Event
SignrequestClient.SignrequestQuickCreateApi signrequestQuickCreateCreate POST /signrequest-quick-create/ Quick create a SignRequest
SignrequestClient.SignrequestsApi signrequestsCancelSignrequest POST /signrequests/{uuid}/cancel_signrequest/ Cancel a SignRequest
SignrequestClient.SignrequestsApi signrequestsCreate POST /signrequests/ Create a SignRequest
SignrequestClient.SignrequestsApi signrequestsList GET /signrequests/ Retrieve a list of SignRequests
SignrequestClient.SignrequestsApi signrequestsRead GET /signrequests/{uuid}/ Retrieve a SignRequest
SignrequestClient.SignrequestsApi signrequestsResendSignrequestEmail POST /signrequests/{uuid}/resend_signrequest_email/ Resend a SignRequest
SignrequestClient.TeamMembersApi teamMembersList GET /team-members/ Retrieve a list of Team Members
SignrequestClient.TeamMembersApi teamMembersRead GET /team-members/{uuid}/ Retrieve a Team Member
SignrequestClient.TeamsApi teamsCreate POST /teams/ Create a Team
SignrequestClient.TeamsApi teamsInviteMember POST /teams/{subdomain}/invite_member/ Invite a Team Member
SignrequestClient.TeamsApi teamsList GET /teams/ Retrieve a list of Teams
SignrequestClient.TeamsApi teamsPartialUpdate PATCH /teams/{subdomain}/ Update a Team
SignrequestClient.TeamsApi teamsRead GET /teams/{subdomain}/ Retrieve a Team
SignrequestClient.TemplatesApi templatesList GET /templates/ Retrieve a list of Templates
SignrequestClient.TemplatesApi templatesRead GET /templates/{uuid}/ Retrieve a Template
SignrequestClient.WebhooksApi webhooksCreate POST /webhooks/ Create a Webhook
SignrequestClient.WebhooksApi webhooksDelete DELETE /webhooks/{uuid}/ Delete a Webhook
SignrequestClient.WebhooksApi webhooksList GET /webhooks/ Retrieve a list of Webhooks
SignrequestClient.WebhooksApi webhooksPartialUpdate PATCH /webhooks/{uuid}/ Partially update a Webhook
SignrequestClient.WebhooksApi webhooksRead GET /webhooks/{uuid}/ Retrieve a Webhook
SignrequestClient.WebhooksApi webhooksUpdate PUT /webhooks/{uuid}/ Update a Webhook

Documentation for Models

Documentation for Authorization

Token

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.