docspring 3.5.0 → 4.0.0

data/docs/Submission.md

@@ -4,33 +4,30 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **batch_id** | **String** |  |  |
-| **data_requests** | [**Array<SubmissionDataRequest>**](SubmissionDataRequest.md) |  |  |
-| **editable** | **Boolean** |  |  |
-| **error_message** | **String** |  |  |
-| **expired** | **Boolean** |  |  |
-| **expires_at** | **String** |  |  |
-| **id** | **String** |  |  |
-| **json_schema_errors** | **Array<String>** |  |  |
-| **metadata** | **Object** |  |  |
-| **password** | **String** |  |  |
-| **processed_at** | **String** |  |  |
-| **state** | **String** |  |  |
-| **template_id** | **String** |  |  |
-| **template_type** | **String** |  |  |
-| **template_version** | **String** |  |  |
-| **test** | **Boolean** |  |  |
-| **truncated_text** | **Object** |  |  |
-| **pdf_hash** | **String** |  |  |
-| **download_url** | **String** |  |  |
-| **permanent_download_url** | **String** |  |  |
-| **preview_download_url** | **String** |  |  |
-| **preview_generated_at** | **String** |  |  |
-| **audit_trail_download_url** | **String** |  |  |
-| **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) |  |  |
-| **source** | **String** |  | [optional] |
-| **referrer** | **String** |  | [optional] |
-| **data** | **Object** |  | [optional] |
+| **id** | **String** | The submission's ID. |  |
+| **template_id** | **String** | Null once the template has been permanently deleted. |  |
+| **template_type** | [**TemplateType**](TemplateType.md) | The template's type: `pdf` or `html`. |  |
+| **template_version** | **String** | The published version of the template the submission used. Null for the draft. |  |
+| **batch_id** | **String** | The ID of the batch the submission was created in. |  |
+| **source** | [**SubmissionSource**](SubmissionSource.md) | `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again. |  |
+| **state** | [**SubmissionState**](SubmissionState.md) | `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`. |  |
+| **test** | **Boolean** | Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions. |  |
+| **editable** | **Boolean** | `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`. |  |
+| **data** | **Hash<String, Object>** | The submission's data, with the values entered in completed signature requests. Lists leave it out (null) unless you pass `include_data=true`. Empty once the submission has expired. |  |
+| **data_errors** | [**Array<ErrorDetail>**](ErrorDetail.md) | Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired. |  |
+| **error_message** | **String** | Why the PDF couldn't be generated, when `state` is `error`. |  |
+| **metadata** | **Hash<String, Object>** | Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. |  |
+| **has_password** | **Boolean** | Whether the PDF needs a password to open (`password`). |  |
+| **signature_requests** | [**Array<SignatureRequest>**](SignatureRequest.md) | The people asked to sign the submission (and fill in their fields), in order. |  |
+| **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) | The uploads of the submission's PDF to your storage (account integrations). |  |
+| **truncated_text** | **Hash<String, Array<String>>** | The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired. |  |
+| **files** | [**SubmissionFiles**](SubmissionFiles.md) | The generated files: `pdf` once the submission has been processed, `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired. |  |
+| **preview_generated_at** | **Time** | When the preview PDF was generated. Null if there is no preview. |  |
+| **expired** | **Boolean** | An expired submission's data, metadata, password and PDF have been deleted. |  |
+| **expires_at** | **Time** | When the submission expires. Null if it's kept until you delete it. |  |
+| **processed_at** | **Time** | When the PDF was generated. Null until then. |  |
+| **created_at** | **Time** | When the submission was created. |  |
+| **updated_at** | **Time** | When the submission was last updated. |  |
 
 ## Example
 
@@ -38,33 +35,30 @@
 require 'docspring'
 
 instance = DocSpring::Submission.new(
-  batch_id: null,
-  data_requests: null,
-  editable: null,
-  error_message: null,
-  expired: null,
-  expires_at: null,
   id: null,
-  json_schema_errors: null,
-  metadata: null,
-  password: null,
-  processed_at: null,
-  state: null,
   template_id: null,
   template_type: null,
   template_version: null,
+  batch_id: null,
+  source: null,
+  state: null,
   test: null,
+  editable: null,
+  data: null,
+  data_errors: null,
+  error_message: null,
+  metadata: null,
+  has_password: null,
+  signature_requests: null,
+  actions: null,
   truncated_text: null,
-  pdf_hash: null,
-  download_url: null,
-  permanent_download_url: null,
-  preview_download_url: null,
+  files: null,
   preview_generated_at: null,
-  audit_trail_download_url: null,
-  actions: null,
-  source: null,
-  referrer: null,
-  data: null
+  expired: null,
+  expires_at: null,
+  processed_at: null,
+  created_at: null,
+  updated_at: null
 )
 ```
 

data/docs/SubmissionAction.md

@@ -4,13 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **integration_id** | **String** |  |  |
-| **state** | **String** |  |  |
-| **action_type** | **String** |  |  |
-| **action_category** | **String** |  |  |
-| **result_data** | **Object** |  |  |
-| **error_message** | **String** |  |  |
+| **id** | **String** | The upload's ID. |  |
+| **integration_id** | **String** | The ID of the account integration it used. |  |
+| **state** | [**SubmissionActionState**](SubmissionActionState.md) | `pending` until the upload has run, then `processed`. `failed`: your storage rejected it. `error`: it failed in DocSpring. |  |
+| **action_type** | [**SubmissionActionType**](SubmissionActionType.md) | The kind of storage, such as `aws_s3_upload` for an S3 bucket. |  |
+| **result_data** | **Hash<String, Object>** | Where the PDF was uploaded, such as the S3 bucket and key. |  |
+| **error_message** | **String** | Why the upload failed, when `state` is `failed` or `error`. |  |
 
 ## Example
 
@@ -22,7 +21,6 @@ instance = DocSpring::SubmissionAction.new(
   integration_id: null,
   state: null,
   action_type: null,
-  action_category: null,
   result_data: null,
   error_message: null
 )

data/docs/SubmissionActionState.md

@@ -0,0 +1,15 @@
+# DocSpring::SubmissionActionState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionActionState.new()
+```
+

data/docs/SubmissionActionType.md

@@ -0,0 +1,15 @@
+# DocSpring::SubmissionActionType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionActionType.new()
+```
+

data/docs/SubmissionBatch.md

@@ -4,14 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **state** | **String** |  |  |
-| **metadata** | **Object** |  |  |
-| **processed_at** | **String** |  |  |
-| **total_count** | **Integer** |  |  |
-| **pending_count** | **Integer** |  |  |
-| **error_count** | **Integer** |  |  |
-| **completion_percentage** | **Float** |  |  |
+| **id** | **String** | The batch's ID. |  |
+| **state** | [**SubmissionBatchState**](SubmissionBatchState.md) | `pending` while the PDFs are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set. |  |
+| **metadata** | **Hash<String, Object>** | Your own data about the batch, such as an ID from your app. |  |
+| **total_count** | **Integer** | The number of submissions in the request. |  |
+| **pending_count** | **Integer** | The submissions whose PDFs haven't been generated yet. |  |
+| **error_count** | **Integer** | The submissions that were invalid or whose PDFs couldn't be generated. |  |
+| **completion_percentage** | **Integer** | The percentage of the batch's submissions that have finished, from 0 to 100. |  |
+| **submissions** | [**Array<Submission>**](Submission.md) | The batch's submissions, in the order of the request. Their `data` is null unless you pass `include_data=true`. A batch that failed validation only has the submissions that were recorded as `invalid_data`. |  |
+| **processed_at** | **Time** | When every submission had finished. |  |
+| **created_at** | **Time** | When the batch was created. |  |
+| **updated_at** | **Time** | When the batch was last updated. |  |
 
 ## Example
 
@@ -22,11 +25,14 @@ instance = DocSpring::SubmissionBatch.new(
   id: null,
   state: null,
   metadata: null,
-  processed_at: null,
   total_count: null,
   pending_count: null,
   error_count: null,
-  completion_percentage: null
+  completion_percentage: null,
+  submissions: null,
+  processed_at: null,
+  created_at: null,
+  updated_at: null
 )
 ```
 

data/docs/SubmissionBatchState.md

@@ -0,0 +1,15 @@
+# DocSpring::SubmissionBatchState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionBatchState.new()
+```
+

data/docs/SubmissionFiles.md

@@ -0,0 +1,22 @@
+# DocSpring::SubmissionFiles
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pdf** | [**GeneratedFile**](GeneratedFile.md) | The submission's PDF. | [optional] |
+| **audit_trail** | [**GeneratedFile**](GeneratedFile.md) | The audit trail of a submission with signature requests: who signed, when and how. It's also added to the end of the PDF when the template's `merge_audit_trail_pdf` is on. | [optional] |
+| **preview** | [**GeneratedFile**](GeneratedFile.md) | The preview PDF from POST /submissions/{submission_id}/generate_preview, such as for a submission still waiting for its signature requests. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionFiles.new(
+  pdf: null,
+  audit_trail: null,
+  preview: null
+)
+```
+

data/docs/SubmissionInput.md

@@ -0,0 +1,38 @@
+# DocSpring::SubmissionInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **test** | **Boolean** | Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions. | [optional] |
+| **editable** | **Boolean** | `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`. | [optional] |
+| **data** | **Hash<String, Object>** | The values of the template's fields, by field name. Required for a PDF template. | [optional] |
+| **metadata** | **Hash<String, Object>** | Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. | [optional] |
+| **password** | **String** | A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. | [optional] |
+| **expires_in** | **Integer** | Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours. | [optional] |
+| **field_overrides** | [**Hash<String, FieldOverride>**](FieldOverride.md) | Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. With `signature_requests`, `editable: true` is a 422, and a `default` for a signature or initials field makes the submission `invalid_data`. | [optional] |
+| **html** | **String** | For an HTML template, HTML to use instead of the template's. | [optional] |
+| **css** | **String** | For an HTML template, CSS to use instead of the template's. | [optional] |
+| **template_id** | **String** | The submission's template. Default the batch's `template_id`. | [optional] |
+| **template_version** | **String** | The version of the submission's template. Default the batch's `template_version`. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionInput.new(
+  test: null,
+  editable: null,
+  data: null,
+  metadata: null,
+  password: null,
+  expires_in: null,
+  field_overrides: null,
+  html: null,
+  css: null,
+  template_id: null,
+  template_version: null
+)
+```
+

data/docs/SubmissionList.md

@@ -0,0 +1,20 @@
+# DocSpring::SubmissionList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Submission>**](Submission.md) | The items on this page. |  |
+| **next_cursor** | **String** | Pass it as `cursor` to get the next page. Null on the last page. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionList.new(
+  data: null,
+  next_cursor: null
+)
+```
+

data/docs/SubmissionSource.md

@@ -0,0 +1,15 @@
+# DocSpring::SubmissionSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionSource.new()
+```
+

data/docs/SubmissionSourcePdf.md

@@ -0,0 +1,20 @@
+# DocSpring::SubmissionSourcePdf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Must be `submission`. | [default to 'submission'] |
+| **id** | **String** | The ID of the submission, combined PDF, template or custom file. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionSourcePdf.new(
+  type: null,
+  id: null
+)
+```
+

data/docs/SubmissionState.md

@@ -0,0 +1,15 @@
+# DocSpring::SubmissionState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionState.new()
+```
+

data/docs/Template.md

@@ -4,69 +4,52 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **add_data_request_submission_id_footers** | **Boolean** |  |  |
-| **allow_additional_properties** | **Boolean** |  |  |
-| **description** | **String** |  |  |
-| **document_filename** | **String** |  |  |
-| **document_md5** | **String** |  |  |
-| **document_parse_error** | **Boolean** |  |  |
-| **document_processed** | **Boolean** |  |  |
-| **document_state** | **String** |  |  |
-| **document_url** | **String** |  |  |
-| **editable_submissions** | **Boolean** |  |  |
-| **embed_domains** | **String** |  |  |
-| **embed_edit_allow_settings** | **Boolean** |  |  |
-| **embed_edit_allow_versioning** | **Boolean** |  |  |
-| **embed_edit_allow_document_replacement** | **Boolean** |  |  |
-| **encrypt_pdfs_password** | **String** |  |  |
-| **encrypt_pdfs** | **Boolean** |  |  |
-| **expiration_interval** | **String** |  |  |
-| **expire_after** | **Integer** |  |  |
-| **expire_submissions** | **Boolean** |  |  |
-| **external_predefined_fields_template_id** | **String** |  |  |
-| **external_predefined_fields_template_name** | **String** |  |  |
-| **first_template** | **Boolean** |  |  |
-| **id** | **String** |  |  |
-| **locked** | **Boolean** |  |  |
-| **merge_audit_trail_pdf** | **Boolean** |  |  |
-| **name** | **String** |  |  |
-| **page_count** | **Integer** |  |  |
-| **page_dimensions** | **Array<Array<Float>>** |  |  |
-| **parent_folder_id** | **String** |  |  |
-| **parse_dates_using_template_date_format** | **Boolean** |  |  |
-| **path** | **String** |  |  |
-| **permanent_document_url** | **String** |  |  |
-| **public_submissions** | **Boolean** |  |  |
-| **public_web_form** | **Boolean** |  |  |
-| **redirect_url** | **String** |  |  |
-| **slack_webhook_url** | **String** |  |  |
-| **template_type** | **String** |  |  |
-| **updated_at** | **String** |  |  |
-| **version_published_at** | **String** |  |  |
-| **version** | **String** |  |  |
-| **webhook_url** | **String** |  |  |
-| **embed_edit_token** | **String** |  | [optional] |
-| **demo** | **Boolean** |  |  |
-| **latest_version** | **String** |  |  |
-| **last_changed_at** | **String** |  |  |
-| **last_changed_by_type** | **String** |  |  |
-| **last_changed_by_id** | **String** |  |  |
-| **last_changed_by_external_name** | **String** |  |  |
-| **last_changed_by_external_email** | **String** |  |  |
-| **last_changed_by_external_id** | **String** |  |  |
-| **defaults** | **Object** |  |  |
-| **field_dependencies** | **Array<Object>** |  |  |
-| **field_order** | **Array<Array<Float>>** |  |  |
-| **fields** | **Object** |  |  |
-| **footer_html** | **String** |  |  |
-| **header_html** | **String** |  |  |
-| **html_engine_options** | **Object** |  |  |
-| **html** | **String** |  |  |
-| **predefined_fields** | **Array<Object>** |  |  |
-| **scss** | **String** |  |  |
-| **shared_field_data** | **Object** |  |  |
-| **template_schema_version** | **Integer** |  |  |
-| **versions** | **Array<Object>** |  |  |
+| **id** | **String** | The template's ID. |  |
+| **name** | **String** | The template's name. |  |
+| **description** | **String** | Shown under the template's name at the top of its hosted forms, and used as their meta description. Not shown on embedded forms or signature requests. |  |
+| **template_type** | [**TemplateType**](TemplateType.md) | `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. It can't be changed after the template is created. |  |
+| **ready** | **Boolean** | Whether the template can generate PDFs. HTML templates are always ready. A PDF template is ready once its document has been processed (`document.state` is `processed`). |  |
+| **document** | [**TemplateDocument**](TemplateDocument.md) | The PDF of a PDF template. Null for HTML templates, and for a PDF template that has no PDF yet. |  |
+| **parent_folder_id** | **String** | The ID of the folder the template is in. Null for a template at the root. Setting it moves the template and all of its published versions. |  |
+| **path** | **String** | The path of the folder the template is in, such as `/Contracts`. `/` for a template at the root. |  |
+| **version** | **String** | The published version this is, such as `1.2.0`. Null for the draft. |  |
+| **latest_version** | **String** | The template's latest published version. Null if no version has been published. |  |
+| **version_published_at** | **Time** | When this version was published. Null for the draft. |  |
+| **locked** | **Boolean** | A locked template can't be changed or deleted until it's unlocked (`locked` can always be changed). |  |
+| **add_signature_request_submission_id_footers** | **Boolean** | Print the submission ID in the footer of each page of PDFs signed through signature requests. |  |
+| **ai_field_naming_language** | [**AiFieldNamingLanguage**](AiFieldNamingLanguage.md) | The language AI field setup names fields in: `auto` uses the form's language when it's written in the Latin alphabet without accents, and English otherwise; `english` always uses English; `form_language` uses the form's language and script. New templates take it from your account's template settings. Null for HTML templates. |  |
+| **allow_additional_properties** | **Boolean** | Accept submission data with properties that aren't fields of the template. |  |
+| **allow_skipping_optional_fields** | **Boolean** | Visual forms and signature request forms show the Continue button as soon as the required fields are filled in, without visiting each optional field. The `allowSkippingOptionalFields` embed option overrides it. |  |
+| **default_form_mode** | [**TemplateFormMode**](TemplateFormMode.md) | The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs). HTML templates have no visual form, so `web` is the only value they accept. |  |
+| **editable_submissions** | **Boolean** | Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it. |  |
+| **embed_domains** | **Array<String>** | The sites where the template's signature requests, forms and embedded template editor can be loaded: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site. |  |
+| **embed_edit_allow_settings** | **Boolean** | Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on). |  |
+| **embed_edit_allow_versioning** | **Boolean** | Allow the embedded template editor to publish, restore, compare and delete published versions. |  |
+| **embed_edit_allow_document_replacement** | **Boolean** | Allow the embedded template editor to replace the template's PDF. |  |
+| **encrypt_pdfs** | **Boolean** | Encrypt generated PDFs with `encrypt_pdfs_password`. |  |
+| **has_encrypt_pdfs_password** | **Boolean** | Whether `encrypt_pdfs_password` is set. |  |
+| **expire_submissions** | **Boolean** | Delete each submission's data and PDF after `expire_after` `expiration_interval`. |  |
+| **expire_after** | **Integer** | How many `expiration_interval`s a submission's data and PDF are kept for, when `expire_submissions` is on. At most 5256000 (10 years in minutes). |  |
+| **expiration_interval** | [**ExpirationInterval**](ExpirationInterval.md) | The unit of `expire_after`. |  |
+| **merge_audit_trail_pdf** | **Boolean** | Add the audit trail to the end of PDFs signed through signature requests. |  |
+| **parse_dates_using_template_date_format** | **Boolean** | Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way. |  |
+| **public_submissions** | **Boolean** | Allow anyone with a submission's ID to download its PDF. |  |
+| **public_web_form** | **Boolean** | Allow anyone to fill in the template's web form. |  |
+| **redirect_url** | **String** | Where the web form sends people after they submit it. |  |
+| **has_slack_webhook_url** | **Boolean** | Whether `slack_webhook_url` is set. |  |
+| **last_changed_at** | **Time** | When the draft was last changed. |  |
+| **last_changed_by** | [**TemplateActor**](TemplateActor.md) | Who last changed the draft: a user in your account, an API token, or someone using the embedded template editor. Null if no change has been recorded. |  |
+| **created_at** | **Time** | When the template was created. |  |
+| **updated_at** | **Time** | When the template was last updated. |  |
+| **defaults** | [**TemplateDefaults**](TemplateDefaults.md) |  |  |
+| **field_dependencies** | [**Array<TemplateFieldDependency>**](TemplateFieldDependency.md) | Conditional logic: each rule shows or hides its target fields, or makes them required, depending on the values of other fields. |  |
+| **html** | **String** | The HTML of an HTML template, as a Liquid template. Null for PDF templates. |  |
+| **scss** | **String** | The SCSS of an HTML template. |  |
+| **header_html** | **String** | The HTML printed at the top of each page of an HTML template. |  |
+| **footer_html** | **String** | The HTML printed at the bottom of each page of an HTML template. |  |
+| **html_engine_options** | [**HtmlEngineOptions**](HtmlEngineOptions.md) | How an HTML template's PDFs are printed. Null for PDF templates. Setting it replaces the whole object: options left out use their defaults. |  |
+| **embed_edit_token** | **String** | The token that opens the template in the embedded template editor. |  |
+| **versions** | [**Array<TemplateVersion>**](TemplateVersion.md) | The template's published versions, newest first (up to 100). |  |
 
 ## Example
 
@@ -74,68 +57,51 @@
 require 'docspring'
 
 instance = DocSpring::Template.new(
-  add_data_request_submission_id_footers: null,
-  allow_additional_properties: null,
+  id: null,
+  name: null,
   description: null,
-  document_filename: null,
-  document_md5: null,
-  document_parse_error: null,
-  document_processed: null,
-  document_state: null,
-  document_url: null,
+  template_type: null,
+  ready: null,
+  document: null,
+  parent_folder_id: null,
+  path: null,
+  version: null,
+  latest_version: null,
+  version_published_at: null,
+  locked: null,
+  add_signature_request_submission_id_footers: null,
+  ai_field_naming_language: null,
+  allow_additional_properties: null,
+  allow_skipping_optional_fields: null,
+  default_form_mode: null,
   editable_submissions: null,
   embed_domains: null,
   embed_edit_allow_settings: null,
   embed_edit_allow_versioning: null,
   embed_edit_allow_document_replacement: null,
-  encrypt_pdfs_password: null,
   encrypt_pdfs: null,
-  expiration_interval: null,
-  expire_after: null,
+  has_encrypt_pdfs_password: null,
   expire_submissions: null,
-  external_predefined_fields_template_id: null,
-  external_predefined_fields_template_name: null,
-  first_template: null,
-  id: null,
-  locked: null,
+  expire_after: null,
+  expiration_interval: null,
   merge_audit_trail_pdf: null,
-  name: null,
-  page_count: null,
-  page_dimensions: null,
-  parent_folder_id: null,
   parse_dates_using_template_date_format: null,
-  path: null,
-  permanent_document_url: null,
   public_submissions: null,
   public_web_form: null,
   redirect_url: null,
-  slack_webhook_url: null,
-  template_type: null,
-  updated_at: null,
-  version_published_at: null,
-  version: null,
-  webhook_url: null,
-  embed_edit_token: null,
-  demo: null,
-  latest_version: null,
+  has_slack_webhook_url: null,
   last_changed_at: null,
-  last_changed_by_type: null,
-  last_changed_by_id: null,
-  last_changed_by_external_name: null,
-  last_changed_by_external_email: null,
-  last_changed_by_external_id: null,
+  last_changed_by: null,
+  created_at: null,
+  updated_at: null,
   defaults: null,
   field_dependencies: null,
-  field_order: null,
-  fields: null,
-  footer_html: null,
-  header_html: null,
-  html_engine_options: null,
   html: null,
-  predefined_fields: null,
   scss: null,
-  shared_field_data: null,
-  template_schema_version: null,
+  header_html: null,
+  footer_html: null,
+  html_engine_options: null,
+  embed_edit_token: null,
   versions: null
 )
 ```

data/docs/TemplateActor.md

@@ -0,0 +1,26 @@
+# DocSpring::TemplateActor
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**TemplateActorType**](TemplateActorType.md) | `user`: a user in your account. `api`: an API token. `external_user`: someone using the embedded template editor, as identified by your app. |  |
+| **user_id** | **String** | The user's ID, for `user`. |  |
+| **external_id** | **String** | The ID your app gave the embedded editor's user, for `external_user`. |  |
+| **name** | **String** | The user's name, or the name your app gave the embedded editor's user. |  |
+| **email** | **String** | The email address your app gave the embedded editor's user, for `external_user`. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateActor.new(
+  type: null,
+  user_id: null,
+  external_id: null,
+  name: null,
+  email: null
+)
+```
+

data/docs/TemplateActorType.md

@@ -0,0 +1,15 @@
+# DocSpring::TemplateActorType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateActorType.new()
+```
+