Docspring.Api.PDF (docspring v2.0.0)

API calls for all endpoints tagged PDF.

Summary

Functions

Merge submission PDFs, template PDFs, or custom files

Create a new custom file from a cached presign upload

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

Creates a new data request token for form authentication

Create a new PDF template from a cached presign upload

Generated a preview PDF for partially completed data requests

Check the status of a combined submission (merged PDFs)

Fetch the full template attributes

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

Check the status of a submission batch job

Check the status of an uploaded template

Fetch the JSON schema for a template

Get a list of all combined submissions

Get a list of all folders

List all submissions for a given template

Get a list of all templates

Functions

add_fields_to_template(connection, template_id, data, opts \\ [])

Add new fields to a Template

Parameters

  • connection (Docspring.Connection): Connection to server
  • template_id (String.t):
  • data (AddFieldsData):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.TemplateAddFieldsResponse.t} on success
  • {:error, Tesla.Env.t} on failure

batch_generate_pdfs(connection, data, opts \\ [])

Generates multiple PDFs

Parameters

  • connection (Docspring.Connection): Connection to server
  • data (SubmissionBatchData):
  • opts (keyword): Optional parameters
    • :wait (boolean()): Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)

Returns

  • {:ok, Docspring.Model.BatchGeneratePdfs201Response.t} on success
  • {:error, Tesla.Env.t} on failure

combine_pdfs(connection, data, opts \\ [])

Merge submission PDFs, template PDFs, or custom files

Parameters

  • connection (Docspring.Connection): Connection to server
  • data (CombinePdfsData):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.CreateCombinedSubmissionResponse.t} on success
  • {:error, Tesla.Env.t} on failure

combine_submissions(connection, data, opts \\ [])

Merge generated PDFs together

Parameters

  • connection (Docspring.Connection): Connection to server
  • data (CombinedSubmissionData):
  • opts (keyword): Optional parameters
    • :wait (boolean()): Wait for combined submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)

Returns

  • {:ok, Docspring.Model.CreateCombinedSubmissionResponse.t} on success
  • {:error, Tesla.Env.t} on failure

copy_template(connection, template_id, opts \\ [])

@spec copy_template(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.TemplatePreview.t()}
  | {:error, Tesla.Env.t()}

Copy a Template

Parameters

  • connection (Docspring.Connection): Connection to server
  • template_id (String.t):
  • opts (keyword): Optional parameters
    • :body (CopyTemplateOptions):

Returns

  • {:ok, Docspring.Model.TemplatePreview.t} on success
  • {:error, Tesla.Env.t} on failure

create_custom_file_from_upload(connection, data, opts \\ [])

Create a new custom file from a cached presign upload

Parameters

  • connection (Docspring.Connection): Connection to server
  • data (CreateCustomFileData):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.CreateCustomFileResponse.t} on success
  • {:error, Tesla.Env.t} on failure

create_data_request_event(connection, data_request_id, event, opts \\ [])

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

Parameters

  • connection (Docspring.Connection): Connection to server
  • data_request_id (String.t):
  • event (CreateSubmissionDataRequestEventRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.CreateSubmissionDataRequestEventResponse.t} on success
  • {:error, Tesla.Env.t} on failure

create_data_request_token(connection, data_request_id, opts \\ [])

Creates a new data request token for form authentication

Parameters

  • connection (Docspring.Connection): Connection to server
  • data_request_id (String.t):
  • opts (keyword): Optional parameters
    • :type (String.t):

Returns

  • {:ok, Docspring.Model.CreateSubmissionDataRequestTokenResponse.t} on success
  • {:error, Tesla.Env.t} on failure

create_folder(connection, data, opts \\ [])

Create a folder

Parameters

  • connection (Docspring.Connection): Connection to server
  • data (CreateFolderData):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.Folder.t} on success
  • {:error, Tesla.Env.t} on failure

create_html_template(connection, data, opts \\ [])

Create a new HTML template

Parameters

  • connection (Docspring.Connection): Connection to server
  • data (CreateHtmlTemplate):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.TemplatePreview.t} on success
  • {:error, Tesla.Env.t} on failure

create_pdf_template(connection, template_left_square_bracketdocument_right_square_bracket, template_left_square_bracketname_right_square_bracket, opts \\ [])

@spec create_pdf_template(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.TemplatePreview.t()}
  | {:error, Tesla.Env.t()}

Create a new PDF template with a form POST file upload

Parameters

  • connection (Docspring.Connection): Connection to server
  • template_left_square_bracketdocument_right_square_bracket (String.t):
  • template_left_square_bracketname_right_square_bracket (String.t):
  • opts (keyword): Optional parameters
    • :wait (boolean()): Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)
    • :"template[description]" (String.t):
    • :"template[parent_folder_id]" (String.t):

Returns

  • {:ok, Docspring.Model.TemplatePreview.t} on success
  • {:error, Tesla.Env.t} on failure

create_pdf_template_from_upload(connection, data, opts \\ [])

@spec create_pdf_template_from_upload(
  Tesla.Env.client(),
  Docspring.Model.CreatePdfTemplate.t(),
  keyword()
) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.TemplatePreview.t()}
  | {:error, Tesla.Env.t()}

Create a new PDF template from a cached presign upload

Parameters

  • connection (Docspring.Connection): Connection to server
  • data (CreatePdfTemplate):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.TemplatePreview.t} on success
  • {:error, Tesla.Env.t} on failure

delete_folder(connection, folder_id, opts \\ [])

@spec delete_folder(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.Folder.t()}
  | {:error, Tesla.Env.t()}

Delete a folder

Parameters

  • connection (Docspring.Connection): Connection to server
  • folder_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.Folder.t} on success
  • {:error, Tesla.Env.t} on failure

delete_template(connection, template_id, opts \\ [])

Delete a template

Parameters

  • connection (Docspring.Connection): Connection to server
  • template_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.SuccessMultipleErrorsResponse.t} on success
  • {:error, Tesla.Env.t} on failure

expire_combined_submission(connection, combined_submission_id, opts \\ [])

@spec expire_combined_submission(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.CombinedSubmission.t()}
  | {:error, Tesla.Env.t()}

Expire a combined submission

Parameters

  • connection (Docspring.Connection): Connection to server
  • combined_submission_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.CombinedSubmission.t} on success
  • {:error, Tesla.Env.t} on failure

expire_submission(connection, submission_id, opts \\ [])

@spec expire_submission(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.SubmissionPreview.t()}
  | {:error, Tesla.Env.t()}

Expire a PDF submission

Parameters

  • connection (Docspring.Connection): Connection to server
  • submission_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.SubmissionPreview.t} on success
  • {:error, Tesla.Env.t} on failure

generate_pdf(connection, template_id, submission, opts \\ [])

Generates a new PDF

Parameters

  • connection (Docspring.Connection): Connection to server
  • template_id (String.t):
  • submission (CreatePdfSubmissionData):
  • opts (keyword): Optional parameters
    • :wait (boolean()): Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)

Returns

  • {:ok, Docspring.Model.CreateSubmissionResponse.t} on success
  • {:error, Tesla.Env.t} on failure

generate_pdf_for_html_template(connection, template_id, submission, opts \\ [])

@spec generate_pdf_for_html_template(
  Tesla.Env.client(),
  String.t(),
  Docspring.Model.CreateHtmlSubmissionData.t(),
  keyword()
) ::
  {:ok, Docspring.Model.CreateSubmissionResponse.t()} | {:error, Tesla.Env.t()}

Generates a new PDF for an HTML template

Parameters

  • connection (Docspring.Connection): Connection to server
  • template_id (String.t):
  • submission (CreateHtmlSubmissionData):
  • opts (keyword): Optional parameters
    • :wait (boolean()): Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)

Returns

  • {:ok, Docspring.Model.CreateSubmissionResponse.t} on success
  • {:error, Tesla.Env.t} on failure

generate_preview(connection, submission_id, opts \\ [])

@spec generate_preview(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.SuccessErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Generated a preview PDF for partially completed data requests

Parameters

  • connection (Docspring.Connection): Connection to server
  • submission_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.SuccessErrorResponse.t} on success
  • {:error, Tesla.Env.t} on failure

get_combined_submission(connection, combined_submission_id, opts \\ [])

@spec get_combined_submission(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.CombinedSubmission.t()}
  | {:error, Tesla.Env.t()}

Check the status of a combined submission (merged PDFs)

Parameters

  • connection (Docspring.Connection): Connection to server
  • combined_submission_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.CombinedSubmission.t} on success
  • {:error, Tesla.Env.t} on failure

get_data_request(connection, data_request_id, opts \\ [])

Look up a submission data request

Parameters

  • connection (Docspring.Connection): Connection to server
  • data_request_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.SubmissionDataRequestShow.t} on success
  • {:error, Tesla.Env.t} on failure

get_full_template(connection, template_id, opts \\ [])

@spec get_full_template(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.Template.t()}
  | {:error, Tesla.Env.t()}

Fetch the full template attributes

Parameters

  • connection (Docspring.Connection): Connection to server
  • template_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.Template.t} on success
  • {:error, Tesla.Env.t} on failure

get_presign_url(connection, opts \\ [])

@spec get_presign_url(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.UploadPresignResponse.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (Docspring.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.UploadPresignResponse.t} on success
  • {:error, Tesla.Env.t} on failure

get_submission(connection, submission_id, opts \\ [])

@spec get_submission(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.Submission.t()}
  | {:error, Tesla.Env.t()}

Check the status of a PDF

Parameters

  • connection (Docspring.Connection): Connection to server
  • submission_id (String.t):
  • opts (keyword): Optional parameters
    • :include_data (boolean()):

Returns

  • {:ok, Docspring.Model.Submission.t} on success
  • {:error, Tesla.Env.t} on failure

get_submission_batch(connection, submission_batch_id, opts \\ [])

Check the status of a submission batch job

Parameters

  • connection (Docspring.Connection): Connection to server
  • submission_batch_id (String.t):
  • opts (keyword): Optional parameters
    • :include_submissions (boolean()):

Returns

  • {:ok, Docspring.Model.SubmissionBatchWithSubmissions.t} on success
  • {:error, Tesla.Env.t} on failure

get_template(connection, template_id, opts \\ [])

@spec get_template(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.TemplatePreview.t()}
  | {:error, Tesla.Env.t()}

Check the status of an uploaded template

Parameters

  • connection (Docspring.Connection): Connection to server
  • template_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.TemplatePreview.t} on success
  • {:error, Tesla.Env.t} on failure

get_template_schema(connection, template_id, opts \\ [])

@spec get_template_schema(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.JsonSchema.t()}
  | {:error, Tesla.Env.t()}

Fetch the JSON schema for a template

Parameters

  • connection (Docspring.Connection): Connection to server
  • template_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.JsonSchema.t} on success
  • {:error, Tesla.Env.t} on failure

list_combined_submissions(connection, opts \\ [])

@spec list_combined_submissions(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, [Docspring.Model.CombinedSubmission.t()]}
  | {:error, Tesla.Env.t()}

Get a list of all combined submissions

Parameters

  • connection (Docspring.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :page (integer()): Default: 1
    • :per_page (integer()): Default: 50

Returns

  • {:ok, [%CombinedSubmission{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

list_folders(connection, opts \\ [])

@spec list_folders(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, [Docspring.Model.Folder.t()]}
  | {:error, Tesla.Env.t()}

Get a list of all folders

Parameters

  • connection (Docspring.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :parent_folder_id (String.t): Filter By Folder Id

Returns

  • {:ok, [%Folder{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

list_submissions(connection, opts \\ [])

@spec list_submissions(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.ListSubmissionsResponse.t()}
  | {:error, Tesla.Env.t()}

List all submissions

Parameters

  • connection (Docspring.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :cursor (String.t):
    • :limit (float()):
    • :created_after (String.t):
    • :created_before (String.t):
    • :type (String.t):
    • :include_data (boolean()):

Returns

  • {:ok, Docspring.Model.ListSubmissionsResponse.t} on success
  • {:error, Tesla.Env.t} on failure

list_template_submissions(connection, template_id, opts \\ [])

@spec list_template_submissions(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.ListSubmissionsResponse.t()}
  | {:error, Tesla.Env.t()}

List all submissions for a given template

Parameters

  • connection (Docspring.Connection): Connection to server
  • template_id (String.t):
  • opts (keyword): Optional parameters
    • :cursor (String.t):
    • :limit (float()):
    • :created_after (String.t):
    • :created_before (String.t):
    • :type (String.t):
    • :include_data (boolean()):

Returns

  • {:ok, Docspring.Model.ListSubmissionsResponse.t} on success
  • {:error, Tesla.Env.t} on failure

list_templates(connection, opts \\ [])

@spec list_templates(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, [Docspring.Model.TemplatePreview.t()]}
  | {:error, Tesla.Env.t()}

Get a list of all templates

Parameters

  • connection (Docspring.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :query (String.t): Search By Name
    • :parent_folder_id (String.t): Filter By Folder Id
    • :page (integer()): Default: 1
    • :per_page (integer()): Default: 50

Returns

  • {:ok, [%TemplatePreview{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

move_folder_to_folder(connection, folder_id, data, opts \\ [])

@spec move_folder_to_folder(
  Tesla.Env.client(),
  String.t(),
  Docspring.Model.MoveFolderData.t(),
  keyword()
) ::
  {:ok, Docspring.Model.ErrorResponse.t()}
  | {:ok, Docspring.Model.Folder.t()}
  | {:error, Tesla.Env.t()}

Move a folder

Parameters

  • connection (Docspring.Connection): Connection to server
  • folder_id (String.t):
  • data (MoveFolderData):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.Folder.t} on success
  • {:error, Tesla.Env.t} on failure

move_template_to_folder(connection, template_id, data, opts \\ [])

Move Template to folder

Parameters

  • connection (Docspring.Connection): Connection to server
  • template_id (String.t):
  • data (MoveTemplateData):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.TemplatePreview.t} on success
  • {:error, Tesla.Env.t} on failure

rename_folder(connection, folder_id, data, opts \\ [])

Rename a folder

Parameters

  • connection (Docspring.Connection): Connection to server
  • folder_id (String.t):
  • data (RenameFolderData):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.Folder.t} on success
  • {:error, Tesla.Env.t} on failure

test_authentication(connection, opts \\ [])

@spec test_authentication(
  Tesla.Env.client(),
  keyword()
) :: {:ok, Docspring.Model.SuccessErrorResponse.t()} | {:error, Tesla.Env.t()}

Test Authentication

Parameters

  • connection (Docspring.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.SuccessErrorResponse.t} on success
  • {:error, Tesla.Env.t} on failure

update_data_request(connection, data_request_id, data, opts \\ [])

Update a submission data request

Parameters

  • connection (Docspring.Connection): Connection to server
  • data_request_id (String.t):
  • data (UpdateSubmissionDataRequestData):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.CreateSubmissionDataRequestResponse.t} on success
  • {:error, Tesla.Env.t} on failure

update_template(connection, template_id, data, opts \\ [])

Update a Template

Parameters

  • connection (Docspring.Connection): Connection to server
  • template_id (String.t):
  • data (UpdateHtmlTemplate):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Docspring.Model.SuccessMultipleErrorsResponse.t} on success
  • {:error, Tesla.Env.t} on failure