Skip to content

Latest commit

 

History

History
2068 lines (1426 loc) · 55.3 KB

PDFApi.md

File metadata and controls

2068 lines (1426 loc) · 55.3 KB

DocSpring.PDFApi

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

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

addFieldsToTemplate

TemplateAddFieldsResponse addFieldsToTemplate(templateId, data)

Add new fields to a Template

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_1234567890abcdef02"; // String | 
let data = new DocSpring.AddFieldsData(); // AddFieldsData | 
apiInstance.addFieldsToTemplate(templateId, data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String
data AddFieldsData

Return type

TemplateAddFieldsResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

batchGeneratePdfs

BatchGeneratePdfs201Response batchGeneratePdfs(data, opts)

Generates multiple PDFs

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let data = new DocSpring.SubmissionBatchData(); // SubmissionBatchData | 
let opts = {
  'wait': true // Boolean | Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)
};
apiInstance.batchGeneratePdfs(data, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
data SubmissionBatchData
wait Boolean Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) [optional] [default to true]

Return type

BatchGeneratePdfs201Response

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

combinePdfs

CreateCombinedSubmissionResponse combinePdfs(data)

Merge submission PDFs, template PDFs, or custom files

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let data = new DocSpring.CombinePdfsData(); // CombinePdfsData | 
apiInstance.combinePdfs(data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
data CombinePdfsData

Return type

CreateCombinedSubmissionResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

combineSubmissions

CreateCombinedSubmissionResponse combineSubmissions(data, opts)

Merge generated PDFs together

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let data = new DocSpring.CombinedSubmissionData(); // CombinedSubmissionData | 
let opts = {
  'wait': true // Boolean | Wait for combined submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)
};
apiInstance.combineSubmissions(data, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
data CombinedSubmissionData
wait Boolean Wait for combined submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) [optional] [default to true]

Return type

CreateCombinedSubmissionResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

copyTemplate

TemplatePreview copyTemplate(templateId, opts)

Copy a Template

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_1234567890abcdef01"; // String | 
let opts = {
  'options': new DocSpring.CopyTemplateOptions() // CopyTemplateOptions | 
};
apiInstance.copyTemplate(templateId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String
options CopyTemplateOptions [optional]

Return type

TemplatePreview

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createCustomFileFromUpload

CreateCustomFileResponse createCustomFileFromUpload(data)

Create a new custom file from a cached presign upload

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let data = new DocSpring.CreateCustomFileData(); // CreateCustomFileData | 
apiInstance.createCustomFileFromUpload(data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
data CreateCustomFileData

Return type

CreateCustomFileResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createDataRequestEvent

CreateSubmissionDataRequestEventResponse createDataRequestEvent(dataRequestId, event)

Creates a new event for emailing a signee a request for signature

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let dataRequestId = "drq_1234567890abcdef01"; // String | 
let event = new DocSpring.CreateSubmissionDataRequestEventRequest(); // CreateSubmissionDataRequestEventRequest | 
apiInstance.createDataRequestEvent(dataRequestId, event, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
dataRequestId String
event CreateSubmissionDataRequestEventRequest

Return type

CreateSubmissionDataRequestEventResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createDataRequestToken

CreateSubmissionDataRequestTokenResponse createDataRequestToken(dataRequestId, opts)

Creates a new data request token for form authentication

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let dataRequestId = "drq_1234567890abcdef01"; // String | 
let opts = {
  'type': "api" // String | 
};
apiInstance.createDataRequestToken(dataRequestId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
dataRequestId String
type String [optional]

Return type

CreateSubmissionDataRequestTokenResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

createFolder

Folder createFolder(data)

Create a folder

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let data = new DocSpring.CreateFolderData(); // CreateFolderData | 
apiInstance.createFolder(data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
data CreateFolderData

Return type

Folder

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createHTMLTemplate

TemplatePreview createHTMLTemplate(data)

Create a new HTML template

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let data = new DocSpring.CreateHtmlTemplate(); // CreateHtmlTemplate | 
apiInstance.createHTMLTemplate(data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
data CreateHtmlTemplate

Return type

TemplatePreview

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createPDFTemplate

TemplatePreview createPDFTemplate(templateDocument, templateName, opts)

Create a new PDF template with a form POST file upload

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateDocument = "/path/to/file"; // File | 
let templateName = "templateName_example"; // String | 
let opts = {
  'wait': true, // Boolean | Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)
  'templateDescription': "templateDescription_example", // String | 
  'templateParentFolderId': "templateParentFolderId_example" // String | 
};
apiInstance.createPDFTemplate(templateDocument, templateName, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateDocument File
templateName String
wait Boolean Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) [optional] [default to true]
templateDescription String [optional]
templateParentFolderId String [optional]

Return type

TemplatePreview

Authorization

api_token_basic

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

createPDFTemplateFromUpload

TemplatePreview createPDFTemplateFromUpload(data)

Create a new PDF template from a cached presign upload

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let data = new DocSpring.CreatePdfTemplate(); // CreatePdfTemplate | 
apiInstance.createPDFTemplateFromUpload(data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
data CreatePdfTemplate

Return type

TemplatePreview

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteFolder

Folder deleteFolder(folderId)

Delete a folder

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let folderId = "fld_1234567890abcdef01"; // String | 
apiInstance.deleteFolder(folderId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
folderId String

Return type

Folder

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteTemplate

TemplateDeleteResponse deleteTemplate(templateId, opts)

Delete a template

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_1234567890abcdef01"; // String | 
let opts = {
  'version': "0.1.0" // String | 
};
apiInstance.deleteTemplate(templateId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String
version String [optional]

Return type

TemplateDeleteResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

expireCombinedSubmission

CombinedSubmission expireCombinedSubmission(combinedSubmissionId)

Expire a combined submission

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let combinedSubmissionId = "com_1234567890abcdef01"; // String | 
apiInstance.expireCombinedSubmission(combinedSubmissionId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
combinedSubmissionId String

Return type

CombinedSubmission

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

expireSubmission

SubmissionPreview expireSubmission(submissionId)

Expire a PDF submission

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let submissionId = "sub_1234567890abcdef01"; // String | 
apiInstance.expireSubmission(submissionId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
submissionId String

Return type

SubmissionPreview

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

generatePdf

CreateSubmissionResponse generatePdf(templateId, submission, opts)

Generates a new PDF

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_1234567890abcdef01"; // String | 
let submission = new DocSpring.CreatePdfSubmissionData(); // CreatePdfSubmissionData | 
let opts = {
  'wait': true // Boolean | Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)
};
apiInstance.generatePdf(templateId, submission, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String
submission CreatePdfSubmissionData
wait Boolean Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) [optional] [default to true]

Return type

CreateSubmissionResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

generatePdfForHtmlTemplate

CreateSubmissionResponse generatePdfForHtmlTemplate(templateId, submission, opts)

Generates a new PDF for an HTML template

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_HTML567890abcdef01"; // String | 
let submission = new DocSpring.CreateHtmlSubmissionData(); // CreateHtmlSubmissionData | 
let opts = {
  'wait': true // Boolean | Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)
};
apiInstance.generatePdfForHtmlTemplate(templateId, submission, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String
submission CreateHtmlSubmissionData
wait Boolean Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) [optional] [default to true]

Return type

CreateSubmissionResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

generatePreview

SuccessErrorResponse generatePreview(submissionId)

Generated a preview PDF for partially completed data requests

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let submissionId = "sub_1234567890abcdef01"; // String | 
apiInstance.generatePreview(submissionId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
submissionId String

Return type

SuccessErrorResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getCombinedSubmission

CombinedSubmission getCombinedSubmission(combinedSubmissionId)

Check the status of a combined submission (merged PDFs)

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let combinedSubmissionId = "com_1234567890abcdef01"; // String | 
apiInstance.getCombinedSubmission(combinedSubmissionId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
combinedSubmissionId String

Return type

CombinedSubmission

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getDataRequest

SubmissionDataRequestShow getDataRequest(dataRequestId)

Look up a submission data request

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let dataRequestId = "drq_1234567890abcdef01"; // String | 
apiInstance.getDataRequest(dataRequestId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
dataRequestId String

Return type

SubmissionDataRequestShow

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getFullTemplate

Template getFullTemplate(templateId)

Fetch the full attributes for a PDF template

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_1234567890abcdef01"; // String | 
apiInstance.getFullTemplate(templateId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String

Return type

Template

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getPresignUrl

UploadPresignResponse getPresignUrl()

Get a presigned URL so that you can upload a file to our AWS S3 bucket

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
apiInstance.getPresignUrl((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

UploadPresignResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getSubmission

Submission getSubmission(submissionId, opts)

Check the status of a PDF

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let submissionId = "sub_1234567890abcdef01"; // String | 
let opts = {
  'includeData': true // Boolean | 
};
apiInstance.getSubmission(submissionId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
submissionId String
includeData Boolean [optional]

Return type

Submission

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getSubmissionBatch

SubmissionBatchWithSubmissions getSubmissionBatch(submissionBatchId, opts)

Check the status of a submission batch job

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let submissionBatchId = "sbb_1234567890abcdef01"; // String | 
let opts = {
  'includeSubmissions': true // Boolean | 
};
apiInstance.getSubmissionBatch(submissionBatchId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
submissionBatchId String
includeSubmissions Boolean [optional]

Return type

SubmissionBatchWithSubmissions

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getTemplate

TemplatePreview getTemplate(templateId)

Check the status of an uploaded template

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_1234567890abcdef01"; // String | 
apiInstance.getTemplate(templateId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String

Return type

TemplatePreview

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getTemplateSchema

JsonSchema getTemplateSchema(templateId)

Fetch the JSON schema for a template

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_1234567890abcdef01"; // String | 
apiInstance.getTemplateSchema(templateId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String

Return type

JsonSchema

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listCombinedSubmissions

[CombinedSubmission] listCombinedSubmissions(opts)

Get a list of all combined submissions

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let opts = {
  'page': 2, // Number | Default: 1
  'perPage': 1 // Number | Default: 50
};
apiInstance.listCombinedSubmissions(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
page Number Default: 1 [optional]
perPage Number Default: 50 [optional]

Return type

[CombinedSubmission]

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listFolders

[Folder] listFolders(opts)

Get a list of all folders

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let opts = {
  'parentFolderId': "fld_1234567890abcdef02" // String | Filter By Folder Id
};
apiInstance.listFolders(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
parentFolderId String Filter By Folder Id [optional]

Return type

[Folder]

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listSubmissions

ListSubmissionsResponse listSubmissions(opts)

List all submissions

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let opts = {
  'cursor': "sub_1234567890abcdef12", // String | 
  'limit': 3, // Number | 
  'createdAfter': "2019-01-01T09:00:00-05:00", // String | 
  'createdBefore': "2020-01-01T09:00:00.000+0200", // String | 
  'type': "test", // String | 
  'includeData': true // Boolean | 
};
apiInstance.listSubmissions(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
cursor String [optional]
limit Number [optional]
createdAfter String [optional]
createdBefore String [optional]
type String [optional]
includeData Boolean [optional]

Return type

ListSubmissionsResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listTemplateSubmissions

ListSubmissionsResponse listTemplateSubmissions(templateId, opts)

List all submissions for a given template

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_1234567890abcdef02"; // String | 
let opts = {
  'cursor': "cursor_example", // String | 
  'limit': 3.4, // Number | 
  'createdAfter': "createdAfter_example", // String | 
  'createdBefore': "createdBefore_example", // String | 
  'type': "type_example", // String | 
  'includeData': true // Boolean | 
};
apiInstance.listTemplateSubmissions(templateId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String
cursor String [optional]
limit Number [optional]
createdAfter String [optional]
createdBefore String [optional]
type String [optional]
includeData Boolean [optional]

Return type

ListSubmissionsResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listTemplates

[TemplatePreview] listTemplates(opts)

Get a list of all templates

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let opts = {
  'query': "2", // String | Search By Name
  'parentFolderId': "fld_1234567890abcdef01", // String | Filter By Folder Id
  'page': 2, // Number | Default: 1
  'perPage': 1 // Number | Default: 50
};
apiInstance.listTemplates(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
query String Search By Name [optional]
parentFolderId String Filter By Folder Id [optional]
page Number Default: 1 [optional]
perPage Number Default: 50 [optional]

Return type

[TemplatePreview]

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

moveFolderToFolder

Folder moveFolderToFolder(folderId, data)

Move a folder

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let folderId = "fld_1234567890abcdef01"; // String | 
let data = new DocSpring.MoveFolderData(); // MoveFolderData | 
apiInstance.moveFolderToFolder(folderId, data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
folderId String
data MoveFolderData

Return type

Folder

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

moveTemplateToFolder

TemplatePreview moveTemplateToFolder(templateId, data)

Move Template to folder

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_1234567890abcdef01"; // String | 
let data = new DocSpring.MoveTemplateData(); // MoveTemplateData | 
apiInstance.moveTemplateToFolder(templateId, data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String
data MoveTemplateData

Return type

TemplatePreview

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

publishTemplateVersion

TemplatePublishVersionResponse publishTemplateVersion(templateId, data)

Publish a template version

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_1234567890abcdef01"; // String | 
let data = new DocSpring.PublishVersionData(); // PublishVersionData | 
apiInstance.publishTemplateVersion(templateId, data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String
data PublishVersionData

Return type

TemplatePublishVersionResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

renameFolder

Folder renameFolder(folderId, data)

Rename a folder

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let folderId = "fld_1234567890abcdef01"; // String | 
let data = new DocSpring.RenameFolderData(); // RenameFolderData | 
apiInstance.renameFolder(folderId, data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
folderId String
data RenameFolderData

Return type

Folder

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

restoreTemplateVersion

SuccessErrorResponse restoreTemplateVersion(templateId, data)

Restore a template version

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_1234567890abcdef01"; // String | 
let data = new DocSpring.RestoreVersionData(); // RestoreVersionData | 
apiInstance.restoreTemplateVersion(templateId, data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String
data RestoreVersionData

Return type

SuccessErrorResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

testAuthentication

SuccessErrorResponse testAuthentication()

Test Authentication

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
apiInstance.testAuthentication((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

SuccessErrorResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateDataRequest

CreateSubmissionDataRequestResponse updateDataRequest(dataRequestId, data)

Update a submission data request

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let dataRequestId = "drq_1234567890abcdef01"; // String | 
let data = new DocSpring.UpdateSubmissionDataRequestData(); // UpdateSubmissionDataRequestData | 
apiInstance.updateDataRequest(dataRequestId, data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
dataRequestId String
data UpdateSubmissionDataRequestData

Return type

CreateSubmissionDataRequestResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateTemplate

SuccessMultipleErrorsResponse updateTemplate(templateId, data)

Update a Template

Example

import DocSpring from 'docspring';
let defaultClient = DocSpring.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
let api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME';
api_token_basic.password = 'YOUR PASSWORD';

let apiInstance = new DocSpring.PDFApi();
let templateId = "tpl_1234567890abcdef03"; // String | 
let data = new DocSpring.UpdateHtmlTemplate(); // UpdateHtmlTemplate | 
apiInstance.updateTemplate(templateId, data, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
templateId String
data UpdateHtmlTemplate

Return type

SuccessMultipleErrorsResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json