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 template attributes
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
renameFolder	POST /folders/{folder_id}/rename	Rename a folder
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(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiAddFieldsToTemplateRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiAddFieldsToTemplateRequest = {
  
  templateId: "tpl_1234567890abcdef02",
  
  data: {
    fields: [
      {},
    ],
  },
};

const data = await apiInstance.addFieldsToTemplate(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
data	AddFieldsData
templateId	[string]		defaults to undefined

Return type

TemplateAddFieldsResponse

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	add fields success	-
422	add fields error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

batchGeneratePdfs

BatchGeneratePdfs201Response batchGeneratePdfs(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiBatchGeneratePdfsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiBatchGeneratePdfsRequest = {
  
  data: {
    metadata: {},
    submissions: [
      {},
    ],
    test: true,
  },
    // Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional)
  wait: true,
};

const data = await apiInstance.batchGeneratePdfs(request);
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) defaults to true

Return type

BatchGeneratePdfs201Response

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	submissions created	-
200	some PDFs with invalid data	-
401	authentication failed	-
422	array of arrays	-
400	invalid JSON	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

combinePdfs

CreateCombinedSubmissionResponse combinePdfs(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiCombinePdfsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiCombinePdfsRequest = {
  
  data: {
    deleteCustomFiles: true,
    expiresIn: 1,
    metadata: {},
    password: "password_example",
    sourcePdfs: [
      {},
    ],
    test: true,
  },
};

const data = await apiInstance.combinePdfs(request);
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

HTTP response details

Status code	Description	Response headers
201	combined submission created	-
422	invalid request	-
400	invalid JSON	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

combineSubmissions

CreateCombinedSubmissionResponse combineSubmissions(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiCombineSubmissionsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiCombineSubmissionsRequest = {
  
  data: {
    expiresIn: 1,
    metadata: {},
    password: "password_example",
    submissionIds: [
      "submissionIds_example",
    ],
    test: true,
  },
    // Wait for combined submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional)
  wait: true,
};

const data = await apiInstance.combineSubmissions(request);
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) defaults to true

Return type

CreateCombinedSubmissionResponse

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	combined submission created	-
422	invalid request	-
400	invalid JSON	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

copyTemplate

TemplatePreview copyTemplate()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiCopyTemplateRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiCopyTemplateRequest = {
  
  templateId: "tpl_1234567890abcdef01",
  
  options: {
    name: "name_example",
    parentFolderId: "parentFolderId_example",
  },
};

const data = await apiInstance.copyTemplate(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
options	CopyTemplateOptions
templateId	[string]		defaults to undefined

Return type

TemplatePreview

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	copy template success	-
404	folder not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createCustomFileFromUpload

CreateCustomFileResponse createCustomFileFromUpload(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiCreateCustomFileFromUploadRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiCreateCustomFileFromUploadRequest = {
  
  data: {
    cacheId: "cacheId_example",
  },
};

const data = await apiInstance.createCustomFileFromUpload(request);
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

HTTP response details

Status code	Description	Response headers
201	returns the custom file	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createDataRequestEvent

CreateSubmissionDataRequestEventResponse createDataRequestEvent(event)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiCreateDataRequestEventRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiCreateDataRequestEventRequest = {
  
  dataRequestId: "drq_1234567890abcdef01",
  
  event: {
    eventType: "send_request",
    messageType: "email",
  },
};

const data = await apiInstance.createDataRequestEvent(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
event	CreateSubmissionDataRequestEventRequest
dataRequestId	[string]		defaults to undefined

Return type

CreateSubmissionDataRequestEventResponse

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	event created	-
401	authentication failed	-
422	message recipient must not be blank	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createDataRequestToken

CreateSubmissionDataRequestTokenResponse createDataRequestToken()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiCreateDataRequestTokenRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiCreateDataRequestTokenRequest = {
  
  dataRequestId: "drq_1234567890abcdef01",
  
  type: "api",
};

const data = await apiInstance.createDataRequestToken(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
dataRequestId	[string]		defaults to undefined
type	[**'api'	'email']Array<'api' \| 'email'>**

Return type

CreateSubmissionDataRequestTokenResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	token created	-
401	authentication failed	-
422	invalid request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createFolder

Folder createFolder(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiCreateFolderRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiCreateFolderRequest = {
  
  data: {
    folder: {},
  },
};

const data = await apiInstance.createFolder(request);
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

HTTP response details

Status code	Description	Response headers
422	name already exist	-
404	parent folder doesn't exist	-
200	folder created inside another folder	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createHTMLTemplate

TemplatePreview createHTMLTemplate(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiCreateHTMLTemplateRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiCreateHTMLTemplateRequest = {
  
  data: {
    template: {},
  },
};

const data = await apiInstance.createHTMLTemplate(request);
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

HTTP response details

Status code	Description	Response headers
201	returns a created template	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createPDFTemplate

TemplatePreview createPDFTemplate()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiCreatePDFTemplateRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiCreatePDFTemplateRequest = {
  
  templateDocument: { data: Buffer.from(fs.readFileSync('<Uploaded File>', 'utf-8')), name: '<Uploaded File>' },
  
  templateName: "Test Template",
    // Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional)
  wait: true,
  
  templateDescription: "templateDescription_example",
  
  templateParentFolderId: "fld_1234567890abcdef01",
};

const data = await apiInstance.createPDFTemplate(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
templateDocument	[HttpFile]		defaults to undefined
templateName	[string]		defaults to undefined
wait	[boolean]	Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)	(optional) defaults to true
templateDescription	[string]		(optional) defaults to undefined
templateParentFolderId	[string]		(optional) defaults to undefined

Return type

TemplatePreview

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	returns a pending template	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createPDFTemplateFromUpload

TemplatePreview createPDFTemplateFromUpload(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiCreatePDFTemplateFromUploadRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiCreatePDFTemplateFromUploadRequest = {
  
  data: {
    template: {},
  },
};

const data = await apiInstance.createPDFTemplateFromUpload(request);
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

HTTP response details

Status code	Description	Response headers
201	returns a pending template	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteFolder

Folder deleteFolder()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiDeleteFolderRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiDeleteFolderRequest = {
  
  folderId: "fld_1234567890abcdef01",
};

const data = await apiInstance.deleteFolder(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
folderId	[string]		defaults to undefined

Return type

Folder

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
404	folder doesn't exist	-
422	folder has contents	-
200	folder is empty	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteTemplate

SuccessMultipleErrorsResponse deleteTemplate()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiDeleteTemplateRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiDeleteTemplateRequest = {
  
  templateId: "tpl_1234567890abcdef01",
};

const data = await apiInstance.deleteTemplate(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
templateId	[string]		defaults to undefined

Return type

SuccessMultipleErrorsResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	template deleted	-
404	template not found	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

expireCombinedSubmission

CombinedSubmission expireCombinedSubmission()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiExpireCombinedSubmissionRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiExpireCombinedSubmissionRequest = {
  
  combinedSubmissionId: "com_1234567890abcdef01",
};

const data = await apiInstance.expireCombinedSubmission(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
combinedSubmissionId	[string]		defaults to undefined

Return type

CombinedSubmission

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	submission was expired	-
404	combined submission not found	-
403	test API token used	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

expireSubmission

SubmissionPreview expireSubmission()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiExpireSubmissionRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiExpireSubmissionRequest = {
  
  submissionId: "sub_1234567890abcdef01",
};

const data = await apiInstance.expireSubmission(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
submissionId	[string]		defaults to undefined

Return type

SubmissionPreview

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	submission was expired	-
404	submission not found	-
401	authentication failed	-
403	test API token used	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generatePdf

CreateSubmissionResponse generatePdf(submission)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiGeneratePdfRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiGeneratePdfRequest = {
  
  templateId: "tpl_1234567890abcdef01",
  
  submission: {
    data: {},
    dataRequests: [
      {
        authSecondFactorType: "none",
        authType: "none",
        fields: [
          "fields_example",
        ],
        metadata: {},
        order: 1,
      },
    ],
    editable: true,
    expiresIn: 1,
    fieldOverrides: {},
    metadata: {},
    password: "password_example",
    test: true,
  },
    // Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional)
  wait: true,
};

const data = await apiInstance.generatePdf(request);
console.log('API called successfully. Returned data:', data);

Parameters

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

Return type

CreateSubmissionResponse

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	submission created	-
422	invalid request	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generatePdfForHtmlTemplate

CreateSubmissionResponse generatePdfForHtmlTemplate(submission)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiGeneratePdfForHtmlTemplateRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiGeneratePdfForHtmlTemplateRequest = {
  
  templateId: "tpl_HTML567890abcdef01",
  
  submission: {
    css: "css_example",
    data: {},
    editable: true,
    expiresIn: 1,
    fieldOverrides: {},
    html: "html_example",
    metadata: {},
    password: "password_example",
    test: true,
  },
    // Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (optional)
  wait: true,
};

const data = await apiInstance.generatePdfForHtmlTemplate(request);
console.log('API called successfully. Returned data:', data);

Parameters

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

Return type

CreateSubmissionResponse

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	submission created	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generatePreview

SuccessErrorResponse generatePreview()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiGeneratePreviewRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiGeneratePreviewRequest = {
  
  submissionId: "sub_1234567890abcdef01",
};

const data = await apiInstance.generatePreview(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
submissionId	[string]		defaults to undefined

Return type

SuccessErrorResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	preview was successfully requested	-
404	submission not found	-
422	error requesting preview	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCombinedSubmission

CombinedSubmission getCombinedSubmission()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiGetCombinedSubmissionRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiGetCombinedSubmissionRequest = {
  
  combinedSubmissionId: "com_1234567890abcdef01",
};

const data = await apiInstance.getCombinedSubmission(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
combinedSubmissionId	[string]		defaults to undefined

Return type

CombinedSubmission

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	processed combined submission found	-
404	combined submission not found	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDataRequest

SubmissionDataRequestShow getDataRequest()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiGetDataRequestRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiGetDataRequestRequest = {
  
  dataRequestId: "drq_1234567890abcdef01",
};

const data = await apiInstance.getDataRequest(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
dataRequestId	[string]		defaults to undefined

Return type

SubmissionDataRequestShow

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	completed submission data request found	-
404	submission data request not found	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFullTemplate

Template getFullTemplate()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiGetFullTemplateRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiGetFullTemplateRequest = {
  
  templateId: "tpl_1234567890abcdef01",
};

const data = await apiInstance.getFullTemplate(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
templateId	[string]		defaults to undefined

Return type

Template

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	template found	-
404	template not found	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPresignUrl

UploadPresignResponse getPresignUrl()

Example

import { createConfiguration, PDFApi } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request = {};

const data = await apiInstance.getPresignUrl(request);
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

HTTP response details

Status code	Description	Response headers
200	presign URL generated	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSubmission

Submission getSubmission()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiGetSubmissionRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiGetSubmissionRequest = {
  
  submissionId: "sub_1234567890abcdef01",
  
  includeData: true,
};

const data = await apiInstance.getSubmission(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
submissionId	[string]		defaults to undefined
includeData	[boolean]		(optional) defaults to undefined

Return type

Submission

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	processed submission found	-
404	submission not found	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSubmissionBatch

SubmissionBatchWithSubmissions getSubmissionBatch()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiGetSubmissionBatchRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiGetSubmissionBatchRequest = {
  
  submissionBatchId: "sbb_1234567890abcdef01",
  
  includeSubmissions: true,
};

const data = await apiInstance.getSubmissionBatch(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
submissionBatchId	[string]		defaults to undefined
includeSubmissions	[boolean]		(optional) defaults to undefined

Return type

SubmissionBatchWithSubmissions

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	processed submission batch found	-
404	submission batch not found	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTemplate

TemplatePreview getTemplate()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiGetTemplateRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiGetTemplateRequest = {
  
  templateId: "tpl_1234567890abcdef01",
};

const data = await apiInstance.getTemplate(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
templateId	[string]		defaults to undefined

Return type

TemplatePreview

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	template found	-
404	template not found	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTemplateSchema

JsonSchema getTemplateSchema()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiGetTemplateSchemaRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiGetTemplateSchemaRequest = {
  
  templateId: "tpl_1234567890abcdef01",
};

const data = await apiInstance.getTemplateSchema(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
templateId	[string]		defaults to undefined

Return type

JsonSchema

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	template found	-
404	template not found	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listCombinedSubmissions

Array listCombinedSubmissions()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiListCombinedSubmissionsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiListCombinedSubmissionsRequest = {
    // Default: 1 (optional)
  page: 2,
    // Default: 50 (optional)
  perPage: 1,
};

const data = await apiInstance.listCombinedSubmissions(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
page	[number]	Default: 1	(optional) defaults to undefined
perPage	[number]	Default: 50	(optional) defaults to undefined

Return type

Array

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	enumerate all combined submissions	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listFolders

Array listFolders()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiListFoldersRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiListFoldersRequest = {
    // Filter By Folder Id (optional)
  parentFolderId: "fld_1234567890abcdef02",
};

const data = await apiInstance.listFolders(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
parentFolderId	[string]	Filter By Folder Id	(optional) defaults to undefined

Return type

Array

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	enumerate all folders	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listSubmissions

ListSubmissionsResponse listSubmissions()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiListSubmissionsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiListSubmissionsRequest = {
  
  cursor: "sub_1234567890abcdef12",
  
  limit: 3,
  
  createdAfter: "2019-01-01T09:00:00-05:00",
  
  createdBefore: "2020-01-01T09:00:00.000+0200",
  
  type: "test",
  
  includeData: true,
};

const data = await apiInstance.listSubmissions(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Notes
cursor	[string]	(optional) defaults to undefined
limit	[number]	(optional) defaults to undefined
createdAfter	[string]	(optional) defaults to undefined
createdBefore	[string]	(optional) defaults to undefined
type	[string]	(optional) defaults to undefined
includeData	[boolean]	(optional) defaults to undefined

Return type

ListSubmissionsResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	listing submissions	-
422	invalid type	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listTemplateSubmissions

ListSubmissionsResponse listTemplateSubmissions()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiListTemplateSubmissionsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiListTemplateSubmissionsRequest = {
  
  templateId: "tpl_1234567890abcdef02",
  
  cursor: "cursor_example",
  
  limit: 3.14,
  
  createdAfter: "created_after_example",
  
  createdBefore: "created_before_example",
  
  type: "type_example",
  
  includeData: true,
};

const data = await apiInstance.listTemplateSubmissions(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Notes
templateId	[string]	defaults to undefined
cursor	[string]	(optional) defaults to undefined
limit	[number]	(optional) defaults to undefined
createdAfter	[string]	(optional) defaults to undefined
createdBefore	[string]	(optional) defaults to undefined
type	[string]	(optional) defaults to undefined
includeData	[boolean]	(optional) defaults to undefined

Return type

ListSubmissionsResponse

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	listing submissions	-
404	invalid template id	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listTemplates

Array listTemplates()

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiListTemplatesRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiListTemplatesRequest = {
    // Search By Name (optional)
  query: "2",
    // Filter By Folder Id (optional)
  parentFolderId: "fld_1234567890abcdef01",
    // Default: 1 (optional)
  page: 2,
    // Default: 50 (optional)
  perPage: 1,
};

const data = await apiInstance.listTemplates(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
query	[string]	Search By Name	(optional) defaults to undefined
parentFolderId	[string]	Filter By Folder Id	(optional) defaults to undefined
page	[number]	Default: 1	(optional) defaults to undefined
perPage	[number]	Default: 50	(optional) defaults to undefined

Return type

Array

Authorization

api_token_basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	enumerate all templates	-
404	filter templates by invalid folder id	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

moveFolderToFolder

Folder moveFolderToFolder(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiMoveFolderToFolderRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiMoveFolderToFolderRequest = {
  
  folderId: "fld_1234567890abcdef01",
  
  data: {
    parentFolderId: "parentFolderId_example",
  },
};

const data = await apiInstance.moveFolderToFolder(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
data	MoveFolderData
folderId	[string]		defaults to undefined

Return type

Folder

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
404	parent folder doesn't exist	-
200	move to root folder	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

moveTemplateToFolder

TemplatePreview moveTemplateToFolder(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiMoveTemplateToFolderRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiMoveTemplateToFolderRequest = {
  
  templateId: "tpl_1234567890abcdef01",
  
  data: {
    parentFolderId: "parentFolderId_example",
  },
};

const data = await apiInstance.moveTemplateToFolder(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
data	MoveTemplateData
templateId	[string]		defaults to undefined

Return type

TemplatePreview

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	move template success	-
404	folder not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

renameFolder

Folder renameFolder(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiRenameFolderRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiRenameFolderRequest = {
  
  folderId: "fld_1234567890abcdef01",
  
  data: {
    name: "name_example",
  },
};

const data = await apiInstance.renameFolder(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
data	RenameFolderData
folderId	[string]		defaults to undefined

Return type

Folder

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
422	name already exist	-
404	folder doesn't belong to me	-
200	successful rename	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

testAuthentication

SuccessErrorResponse testAuthentication()

Example

import { createConfiguration, PDFApi } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request = {};

const data = await apiInstance.testAuthentication(request);
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

HTTP response details

Status code	Description	Response headers
200	authentication succeeded	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateDataRequest

CreateSubmissionDataRequestResponse updateDataRequest(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiUpdateDataRequestRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiUpdateDataRequestRequest = {
  
  dataRequestId: "drq_1234567890abcdef01",
  
  data: {
    authType: "none",
    fields: [
      "fields_example",
    ],
    metadata: {},
    order: 1,
  },
};

const data = await apiInstance.updateDataRequest(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
data	UpdateSubmissionDataRequestData
dataRequestId	[string]		defaults to undefined

Return type

CreateSubmissionDataRequestResponse

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	submission data request updated	-
422	invalid request	-
404	submission data request not found	-
401	authentication failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateTemplate

SuccessMultipleErrorsResponse updateTemplate(data)

Example

import { createConfiguration, PDFApi } from '';
import type { PDFApiUpdateTemplateRequest } from '';

const configuration = createConfiguration();
const apiInstance = new PDFApi(configuration);

const request: PDFApiUpdateTemplateRequest = {
  
  templateId: "tpl_1234567890abcdef03",
  
  data: {
    template: {},
  },
};

const data = await apiInstance.updateTemplate(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
data	UpdateHtmlTemplate
templateId	[string]		defaults to undefined

Return type

SuccessMultipleErrorsResponse

Authorization

api_token_basic

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	update template success	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

PDFApi.md

Latest commit

History

PDFApi.md

File metadata and controls

DocSpring.PDFApi

addFieldsToTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

batchGeneratePdfs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

combinePdfs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

combineSubmissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

copyTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createCustomFileFromUpload

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createDataRequestEvent

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createDataRequestToken

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createFolder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createHTMLTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createPDFTemplate

Example

Parameters