Skip to content

Latest commit

 

History

History
225 lines (180 loc) · 12.1 KB

README.md

File metadata and controls

225 lines (180 loc) · 12.1 KB
Raw

docspring

DocSpring - JavaScript client for docspring DocSpring is a service that helps you fill out and sign PDF templates. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.5.0
  • Build package: com.docspring.codegen.DocSpringJavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install docspring --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your docspring from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('docspring') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

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
      }
    }
  ]
}

Getting Started

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

var DocSpring = require('docspring');

var defaultClient = DocSpring.ApiClient.instance;

// Configure HTTP basic authorization: api_token_basic
var api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME'
api_token_basic.password = 'YOUR PASSWORD'

var api = new DocSpring.PDFApi()
var templateId = tpl_000000000000000002; // {String} 
var addFieldsData = new DocSpring.AddFieldsData(); // {AddFieldsData} 

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

Documentation for API Endpoints

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

Class Method HTTP request Description
DocSpring.PDFApi addFieldsToTemplate PUT /templates/{template_id}/add_fields Add new fields to a Template
DocSpring.PDFApi batchGeneratePdfV1 POST /templates/{template_id}/submissions/batch Generates multiple PDFs
DocSpring.PDFApi batchGeneratePdfs POST /submissions/batches Generates multiple PDFs
DocSpring.PDFApi combinePdfs POST /combined_submissions?v=2 Merge submission PDFs, template PDFs, or custom files
DocSpring.PDFApi combineSubmissions POST /combined_submissions Merge generated PDFs together
DocSpring.PDFApi copyTemplate POST /templates/{template_id}/copy Copy a Template
DocSpring.PDFApi createCustomFileFromUpload POST /custom_files Create a new custom file from a cached presign upload
DocSpring.PDFApi createDataRequestToken POST /data_requests/{data_request_id}/tokens Creates a new data request token for form authentication
DocSpring.PDFApi createFolder POST /folders/ Create a folder
DocSpring.PDFApi createHTMLTemplate POST /templates?desc=html Create a new HTML template
DocSpring.PDFApi createPDFTemplate POST /templates Create a new PDF template with a form POST file upload
DocSpring.PDFApi createPDFTemplateFromUpload POST /templates?desc=cached_upload Create a new PDF template from a cached presign upload
DocSpring.PDFApi deleteFolder DELETE /folders/{folder_id} Delete a folder
DocSpring.PDFApi deleteTemplate DELETE /templates/{template_id} Delete a template
DocSpring.PDFApi expireCombinedSubmission DELETE /combined_submissions/{combined_submission_id} Expire a combined submission
DocSpring.PDFApi expireSubmission DELETE /submissions/{submission_id} Expire a PDF submission
DocSpring.PDFApi generatePDF POST /templates/{template_id}/submissions Generates a new PDF
DocSpring.PDFApi getCombinedSubmission GET /combined_submissions/{combined_submission_id} Check the status of a combined submission (merged PDFs)
DocSpring.PDFApi getDataRequest GET /data_requests/{data_request_id} Look up a submission data request
DocSpring.PDFApi getFullTemplate GET /templates/{template_id}?full=true Fetch the full template attributes
DocSpring.PDFApi getPresignUrl GET /uploads/presign Get a presigned URL so that you can upload a file to our AWS S3 bucket
DocSpring.PDFApi getSubmission GET /submissions/{submission_id} Check the status of a PDF
DocSpring.PDFApi getSubmissionBatch GET /submissions/batches/{submission_batch_id} Check the status of a submission batch job
DocSpring.PDFApi getTemplate GET /templates/{template_id} Check the status of an uploaded template
DocSpring.PDFApi getTemplateSchema GET /templates/{template_id}/schema Fetch the JSON schema for a template
DocSpring.PDFApi listCombinedSubmissions GET /combined_submissions Get a list of all combined submissions
DocSpring.PDFApi listFolders GET /folders/ Get a list of all folders
DocSpring.PDFApi listSubmissions GET /submissions List all submissions
DocSpring.PDFApi listSubmissions_0 GET /templates/{template_id}/submissions List all submissions for a given template
DocSpring.PDFApi listTemplates GET /templates Get a list of all templates
DocSpring.PDFApi moveFolderToFolder POST /folders/{folder_id}/move Move a folder
DocSpring.PDFApi moveTemplateToFolder POST /templates/{template_id}/move Move Template to folder
DocSpring.PDFApi renameFolder POST /folders/{folder_id}/rename Rename a folder
DocSpring.PDFApi testAuthentication GET /authentication Test Authentication
DocSpring.PDFApi updateDataRequest PUT /data_requests/{data_request_id} Update a submission data request
DocSpring.PDFApi updateTemplate PUT /templates/{template_id} Update a Template

Documentation for Models

Documentation for Authorization

api_token_basic

  • Type: HTTP basic authentication