API Reference docspring v4.0.0
Modules
API calls for all endpoints tagged Client.
Handle Tesla connections for Docspring.
Helper functions for deserializing responses into models
The language AI field setup names a PDF template's fields in.
Returned when the Authorization header has a valid API token.
A kind of barcode.
A check mark or cross, as the HTML entity of its character: ✓ (✓), ✔ (✔), ✖ (✖), ✗ (✗) or ✘ (✘).
How a combined field joins its fields' values: with combined_field_separator between them (separator), or into combined_field_format (format).
A PDF made by merging other PDFs: submissions, other combined PDFs, templates, custom files and PDFs from URLs.
A combined PDF's generated files, by format.
A page of combined PDFs, newest first.
A PDF to merge.
A PDF to merge.
Another combined PDF to merge.
What a source PDF is.
Where a combined PDF is in its processing.
Settings for the copy.
The PDFs to merge, and the combined PDF's settings.
The uploaded file to create the custom file from.
The folder to create.
The event to record.
The kind of link to make. Send no body for an api token.
The submissions to create, and the settings they share.
The submission's data and settings.
The template to create.
The webhook to create.
A PDF you uploaded to merge with other PDFs (POST /combined_pdfs). Get an upload URL with GET /uploads/presign first.
A page of custom files, newest first.
A custom file to merge (POST /custom_files).
A machine-readable error code. New codes can be added.
One problem with the request, such as a missing or invalid property.
What went wrong.
The body of every error response.
A unit of time.
A condition comparing a number field's value with a number.
The operators a FieldComparisonCondition takes.
How a field's value is drawn on the PDF: as text, a check mark, a QR code, a barcode, an image or a shape.
A condition on whether a field's value is (or isn't) a value.
The operators a FieldEqualsCondition takes.
A condition on whether a field's value is one of a list.
Changes to one field's settings for this submission only. Settings left out keep the template's.
A condition on whether a field has a value.
The operators a FieldPresenceCondition takes.
A condition on whether a number field's value is in a range.
Whether a template's fields are being re-imported from its PDF.
Whether AI field setup sets up conditional logic and required fields.
How AI field setup names a PDF's fields.
Where AI field setup takes a PDF's fields from.
A folder of templates. Folders can contain other folders.
A page of folders, newest first.
A file that DocSpring generated, such as a submission's PDF. A file made after its submission was processed is listed while it's being made: check its state before using its links.
Whether a generated file has been made.
How an HTML template's PDFs are printed.
How an HTML template's PDFs are printed.
A position inside a field, such as NorthWest for the top left corner.
How an image is resized to its field: scaled to fit inside it (fit), scaled to cover it and cropped (fill), or stretched to its shape (stretch).
A language that DocSpring generates typed code in.
Where to move the folder.
Where to move the template.
How a number field's value is compared with a check mark's or shape's condition.
A paper size, or Custom.
The version to publish.
The folder's new name.
The version to restore.
A shape a field can draw.
A request for someone to fill in their fields of a submission and sign it. Someone who only fills in fields for the people who sign later (such as an employer's section) has a signature request too. The submission's PDF is generated once every signature request is completed.
A second factor your app authenticated a person with.
How your app authenticated a person before it showed them a signature request.
Something that happened to a signature request outside DocSpring, for its audit trail: you sent the request to the person (send_request). The audit trail shows it as reported by your account.
Something that happened to a signature request.
A request for someone to fill in their fields of a submission and sign it. Someone who only fills in fields for the people who sign later (such as an employer's section) has a signature request too. The submission's PDF is generated once every signature request is completed.
How a signature request was sent to a person.
Whether a signature request is waiting for its signer, completed or declined.
A token that opens a signature request without signing in to DocSpring, in a form embedded in your app or from a link you send. Create a token each time you open the form or send a link, rather than storing one to reuse later: its link expires. A signing page that opened before then keeps working for 7 more days, so the person can finish the form later.
How long a signature request token's link opens the signature request.
How a string field's value is compared with a check mark's or shape's condition.
Data submitted to a template, and the PDF generated from it.
An upload of a PDF to your storage, such as an S3 bucket.
Where a submission action (an upload to your storage) is.
The kind of storage a submission action uploads the PDF to.
Submissions created together in one request. Their PDFs are only generated when every submission in the batch is valid.
Where a submission batch is in its processing.
A submission's generated files. Each one is left out until it exists.
A submission to create in a batch, with its own template when it doesn't use the batch's.
A page of submissions, newest first.
What created a submission.
A submission's PDF to merge.
Where a submission is in its processing.
A template that generates PDFs from submission data.
A user in your account, an API token, or someone using the embedded template editor.
Who changed a template (a user in your account, an API token, or someone using the embedded template editor).
The default style of the template's fields. Each field can override it.
The default style of the template's fields. Each field can override it.
A PDF template's PDF.
Where a template's PDF is in its processing.
A conditional logic rule: when other fields' values meet its conditions, it shows its target fields, makes them required, or both.
What a conditional logic rule does to its target fields.
A condition on a field's value.
A condition on a field's value.
A conditional logic rule: when other fields' values meet its conditions, it shows its target fields, makes them required, or both.
Whether all of a rule's conditions or any of them must be met.
How a condition compares a field's value.
How AI field setup's logic step is going.
Which hosted form a template's form link opens.
Typed code for the template's submission data, for an app that creates submissions.
Why AI naming failed or was skipped on a page.
Why AI didn't name a page's fields.
How setting up a page's fields is going.
Whether a page's image has been rendered.
How processing is going on one page of a PDF template's PDF.
A template's PDF to merge.
A template in a list. Get a template by its ID for its HTML, defaults, field dependency rules and published versions.
A page of templates (drafts), newest first.
The kind of template: pdf (fields placed on an uploaded PDF) or html (a PDF rendered from HTML).
A published version of a template.
Which part of a version number to increase.
A horizontal text alignment.
What happens to text that doesn't fit in its field.
A vertical text alignment.
One of the template editor's typefaces.
The settings to change. Properties left out keep their values.
The new PDF.
The settings to change. Properties left out keep their values.
The settings to change. Properties left out keep their values.
The HTTP method to upload a file with.
A presigned S3 form for uploading a file. POST fields and the file (as file, last) to url as multipart/form-data. Then use fields.key as the cache_id when you create a custom file.
A PDF to download from a URL and merge.
An endpoint that DocSpring sends a POST request to when a subscribed event happens.
An event that a webhook can subscribe to.
A page of webhooks, newest first.
Which submissions a webhook sends events for, test or live.
Helper functions for building Tesla requests
Checks a request against API v2's request schemas (request_schemas.json, the schemas the API validates requests with) before it's sent, and says what the API would say about it. api_clients/validator_conformance checks that it agrees with the API.
A request the API would reject with a 422, found before it was sent. details are the API's error details
(Docspring.Model.ErrorDetail), each with a code, a message and a pointer into the body (or a parameter for a
query parameter).