Skip to content

Latest commit

 

History

History
999 lines (638 loc) · 34.4 KB

PDFApi.md

File metadata and controls

999 lines (638 loc) · 34.4 KB
Raw

\PDFApi

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

Method HTTP request Description
AddFieldsToTemplate Put /templates/{template_id}/add_fields Add new fields to a Template
BatchGeneratePdfV1 Post /templates/{template_id}/submissions/batch Generates multiple PDFs
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
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?desc=html Create a new HTML template
CreatePDFTemplate Post /templates Create a new PDF template with a form POST file upload
CreatePDFTemplateFromUpload Post /templates?desc=cached_upload Create a new PDF template from a cached presign upload
DeleteFolder Delete /folders/{folder_id} Delete a folder
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
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
ListFolders Get /folders/ Get a list of all folders
ListSubmissions Get /submissions List all submissions
ListSubmissions_0 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

AddFieldsTemplateResponse AddFieldsToTemplate(ctx, templateId, addFieldsData) Add new fields to a Template

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string
addFieldsData AddFieldsData

Return type

AddFieldsTemplateResponse

Authorization

api_token_basic

HTTP request headers

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

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

BatchGeneratePdfV1

[]CreateSubmissionResponse BatchGeneratePdfV1(ctx, templateId, mapStringinterface) Generates multiple PDFs

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string
mapStringinterface []map[string]interface{}

Return type

[]CreateSubmissionResponse

Authorization

api_token_basic

HTTP request headers

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

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

BatchGeneratePdfs

CreateSubmissionBatchResponse BatchGeneratePdfs(ctx, submissionBatchData) Generates multiple PDFs

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
submissionBatchData SubmissionBatchData

Return type

CreateSubmissionBatchResponse

Authorization

api_token_basic

HTTP request headers

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

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

CombinePdfs

CreateCombinedSubmissionResponse CombinePdfs(ctx, combinePdfsData) Merge submission PDFs, template PDFs, or custom files

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
combinePdfsData CombinePdfsData

Return type

CreateCombinedSubmissionResponse

Authorization

api_token_basic

HTTP request headers

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

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

CombineSubmissions

CreateCombinedSubmissionResponse CombineSubmissions(ctx, combinedSubmissionData) Merge generated PDFs together

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
combinedSubmissionData CombinedSubmissionData

Return type

CreateCombinedSubmissionResponse

Authorization

api_token_basic

HTTP request headers

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

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

CopyTemplate

Template CopyTemplate(ctx, templateId, copyTemplateData) Copy a Template

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string
copyTemplateData CopyTemplateData

Return type

Template

Authorization

api_token_basic

HTTP request headers

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

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

CreateCustomFileFromUpload

CreateCustomFileResponse CreateCustomFileFromUpload(ctx, createCustomFileData) Create a new custom file from a cached presign upload

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createCustomFileData CreateCustomFileData

Return type

CreateCustomFileResponse

Authorization

api_token_basic

HTTP request headers

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

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

CreateDataRequestToken

CreateSubmissionDataRequestTokenResponse CreateDataRequestToken(ctx, dataRequestId) Creates a new data request token for form authentication

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dataRequestId string

Return type

CreateSubmissionDataRequestTokenResponse

Authorization

api_token_basic

HTTP request headers

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

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

CreateFolder

Folder CreateFolder(ctx, createFolderData) Create a folder

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createFolderData CreateFolderData

Return type

Folder

Authorization

api_token_basic

HTTP request headers

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

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

CreateHTMLTemplate

PendingTemplate CreateHTMLTemplate(ctx, createHtmlTemplateData) Create a new HTML template

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createHtmlTemplateData CreateHtmlTemplateData

Return type

PendingTemplate

Authorization

api_token_basic

HTTP request headers

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

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

CreatePDFTemplate

PendingTemplate CreatePDFTemplate(ctx, templateDocument, templateName, optional) Create a new PDF template with a form POST file upload

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateDocument os.Fileos.File
templateName string
optional *CreatePDFTemplateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreatePDFTemplateOpts struct

Name Type Description Notes

templateParentFolderId | optional.String| |

Return type

PendingTemplate

Authorization

api_token_basic

HTTP request headers

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

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

CreatePDFTemplateFromUpload

PendingTemplate CreatePDFTemplateFromUpload(ctx, createTemplateFromUploadData) Create a new PDF template from a cached presign upload

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createTemplateFromUploadData CreateTemplateFromUploadData

Return type

PendingTemplate

Authorization

api_token_basic

HTTP request headers

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

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

DeleteFolder

Folder DeleteFolder(ctx, folderId) Delete a folder

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
folderId string

Return type

Folder

Authorization

api_token_basic

HTTP request headers

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

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

ExpireCombinedSubmission

CombinedSubmission ExpireCombinedSubmission(ctx, combinedSubmissionId) Expire a combined submission

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
combinedSubmissionId string

Return type

CombinedSubmission

Authorization

api_token_basic

HTTP request headers

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

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

ExpireSubmission

Submission ExpireSubmission(ctx, submissionId) Expire a PDF submission

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
submissionId string

Return type

Submission

Authorization

api_token_basic

HTTP request headers

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

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

GeneratePDF

CreateSubmissionResponse GeneratePDF(ctx, templateId, submissionData) Generates a new PDF

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string
submissionData SubmissionData

Return type

CreateSubmissionResponse

Authorization

api_token_basic

HTTP request headers

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

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

GetCombinedSubmission

CombinedSubmission GetCombinedSubmission(ctx, combinedSubmissionId) Check the status of a combined submission (merged PDFs)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
combinedSubmissionId string

Return type

CombinedSubmission

Authorization

api_token_basic

HTTP request headers

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

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

GetDataRequest

SubmissionDataRequest GetDataRequest(ctx, dataRequestId) Look up a submission data request

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dataRequestId string

Return type

SubmissionDataRequest

Authorization

api_token_basic

HTTP request headers

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

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

GetFullTemplate

Template1 GetFullTemplate(ctx, templateId) Fetch the full template attributes

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Return type

Template1

Authorization

api_token_basic

HTTP request headers

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

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

GetPresignUrl

map[string]map[string]interface{} GetPresignUrl(ctx, ) Get a presigned URL so that you can upload a file to our AWS S3 bucket

Required Parameters

This endpoint does not need any parameter.

Return type

map[string]map[string]interface{}

Authorization

api_token_basic

HTTP request headers

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

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

GetSubmission

Submission GetSubmission(ctx, submissionId, optional) Check the status of a PDF

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
submissionId string
optional *GetSubmissionOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetSubmissionOpts struct

Name Type Description Notes

includeData | optional.Bool| |

Return type

Submission

Authorization

api_token_basic

HTTP request headers

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

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

GetSubmissionBatch

SubmissionBatch GetSubmissionBatch(ctx, submissionBatchId, optional) Check the status of a submission batch job

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
submissionBatchId string
optional *GetSubmissionBatchOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetSubmissionBatchOpts struct

Name Type Description Notes

includeSubmissions | optional.Bool| |

Return type

SubmissionBatch

Authorization

api_token_basic

HTTP request headers

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

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

GetTemplate

Template GetTemplate(ctx, templateId) Check the status of an uploaded template

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Return type

Template

Authorization

api_token_basic

HTTP request headers

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

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

GetTemplateSchema

map[string]map[string]interface{} GetTemplateSchema(ctx, templateId) Fetch the JSON schema for a template

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string

Return type

map[string]map[string]interface{}

Authorization

api_token_basic

HTTP request headers

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

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

ListFolders

[]Folder ListFolders(ctx, optional) Get a list of all folders

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ListFoldersOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListFoldersOpts struct

Name Type Description Notes
parentFolderId optional.String Filter By Folder Id

Return type

[]Folder

Authorization

api_token_basic

HTTP request headers

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

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

ListSubmissions

ListSubmissionsResponse ListSubmissions(ctx, optional) List all submissions

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ListSubmissionsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListSubmissionsOpts struct

Name Type Description Notes
cursor optional.String
limit optional.Float32
createdAfter optional.String
createdBefore optional.String
type_ optional.String
includeData optional.Bool

Return type

ListSubmissionsResponse

Authorization

api_token_basic

HTTP request headers

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

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

ListSubmissions_0

ListSubmissionsResponse ListSubmissions_0(ctx, templateId, optional) List all submissions for a given template

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string
optional *ListSubmissions_1Opts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListSubmissions_1Opts struct

Name Type Description Notes

cursor | optional.String| | limit | optional.Float32| | createdAfter | optional.String| | createdBefore | optional.String| | type_ | optional.String| | includeData | optional.Bool| |

Return type

ListSubmissionsResponse

Authorization

api_token_basic

HTTP request headers

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

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

ListTemplates

[]Template ListTemplates(ctx, optional) Get a list of all templates

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ListTemplatesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListTemplatesOpts struct

Name Type Description Notes
query optional.String Search By Name
parentFolderId optional.String Filter By Folder Id
page optional.Int32 Default: 1
perPage optional.Int32 Default: 50

Return type

[]Template

Authorization

api_token_basic

HTTP request headers

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

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

MoveFolderToFolder

Folder MoveFolderToFolder(ctx, folderId, moveFolderData) Move a folder

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
folderId string
moveFolderData MoveFolderData

Return type

Folder

Authorization

api_token_basic

HTTP request headers

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

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

MoveTemplateToFolder

Template MoveTemplateToFolder(ctx, templateId, moveTemplateData) Move Template to folder

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string
moveTemplateData MoveTemplateData

Return type

Template

Authorization

api_token_basic

HTTP request headers

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

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

RenameFolder

RenameFolder(ctx, folderId, renameFolderData) Rename a folder

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
folderId string
renameFolderData RenameFolderData

Return type

(empty response body)

Authorization

api_token_basic

HTTP request headers

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

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

TestAuthentication

AuthenticationSuccessResponse TestAuthentication(ctx, ) Test Authentication

Required Parameters

This endpoint does not need any parameter.

Return type

AuthenticationSuccessResponse

Authorization

api_token_basic

HTTP request headers

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

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

UpdateDataRequest

UpdateDataRequestResponse UpdateDataRequest(ctx, dataRequestId, updateSubmissionDataRequestData) Update a submission data request

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dataRequestId string
updateSubmissionDataRequestData UpdateSubmissionDataRequestData

Return type

UpdateDataRequestResponse

Authorization

api_token_basic

HTTP request headers

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

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

UpdateTemplate

UpdateTemplateResponse UpdateTemplate(ctx, templateId, updateTemplateData) Update a Template

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
templateId string
updateTemplateData UpdateTemplateData

Return type

UpdateTemplateResponse

Authorization

api_token_basic

HTTP request headers

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

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