docspring 3.5.0 → 4.1.0

data/docs/Template.md

@@ -4,69 +4,55 @@
 
 | 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. |  |
+| **field_groups** | [**Array<FieldGroup>**](FieldGroup.md) | The groups of the template's fields, with their settings. A field's name puts it in groups: `address/city` is in the group `address`, and `items/0/price` is in the list `items` and its items' group `items/~`. |  |
+| **predefined_fields** | [**Array<PredefinedField>**](PredefinedField.md) | The field names that people using the embedded template editor choose from, each with the data type and settings a field gets when it's given that name. Setting it replaces the whole list; an empty list turns them off. |  |
+| **predefined_fields_sample_data** | **Hash<String, Object>** | Sample submission data that sets `predefined_fields`: each value becomes a predefined field, with a type that fits it (`string`, `number`, `boolean`, `date`, `email` or `url`) and `required_in_template` true. Nested objects and arrays become names with `/`, such as `customer/email`. Without `predefined_fields` in the same request, it replaces them; with them, it adds to them and sets the types of the ones it has values for. |  |
+| **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 +60,54 @@
 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,
+  field_groups: null,
   predefined_fields: null,
+  predefined_fields_sample_data: null,
+  html: 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()
+```
+

data/docs/TemplateDefaults.md

@@ -0,0 +1,56 @@
+# DocSpring::TemplateDefaults
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **typeface** | [**Typeface**](Typeface.md) | The font of text fields. | [optional] |
+| **font_size** | **Float** | The font size in points, a whole number. | [optional] |
+| **character_spacing** | **Float** | Extra space between characters, in points (0 to 50). | [optional] |
+| **color** | **String** | The text color, as 6 hex digits without `#`, such as `444444`. | [optional] |
+| **background_color** | **String** | The field's background color, as 6 hex digits. | [optional] |
+| **bold** | **Boolean** | Print text in bold. | [optional] |
+| **uppercase** | **Boolean** | Print text in capital letters. | [optional] |
+| **alignment** | [**TextAlignment**](TextAlignment.md) | How text is aligned in its field. `justify` lines up both edges of every line of multiline text except the last of each paragraph. | [optional] |
+| **opacity** | **Float** | The opacity of the field's content, from 0 (invisible) to 1. | [optional] |
+| **date_format** | **String** | How date fields are printed, as a strftime format such as `%m/%d/%Y`. | [optional] |
+| **date_time_format** | **String** | How date-time fields are printed, as a strftime format such as `%m/%d/%Y %H:%M:%S`. | [optional] |
+| **check_color** | **String** | The color of check marks, as 6 hex digits. | [optional] |
+| **check_character** | [**CheckCharacter**](CheckCharacter.md) | The character that a ticked check box prints. | [optional] |
+| **check_background_color** | **String** | The check box's background color, as 6 hex digits. | [optional] |
+| **required_field_background_color** | **String** | The background color that highlights required fields on visual forms and signature request forms, as 6 hex digits. PDFs don't print it. | [optional] |
+| **true_text** | **String** | The text a boolean field prints for `true`. | [optional] |
+| **false_text** | **String** | The text a boolean field prints for `false`. | [optional] |
+| **shape_fill_color** | **String** | The fill color of shapes, as 6 hex digits. | [optional] |
+| **shape_border_color** | **String** | The border color of shapes, as 6 hex digits. | [optional] |
+| **shape_border_width** | **Float** | The border width of shapes, in whole points (at least 1). | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateDefaults.new(
+  typeface: null,
+  font_size: null,
+  character_spacing: null,
+  color: null,
+  background_color: null,
+  bold: null,
+  uppercase: null,
+  alignment: null,
+  opacity: null,
+  date_format: null,
+  date_time_format: null,
+  check_color: null,
+  check_character: null,
+  check_background_color: null,
+  required_field_background_color: null,
+  true_text: null,
+  false_text: null,
+  shape_fill_color: null,
+  shape_border_color: null,
+  shape_border_width: null
+)
+```
+

data/docs/TemplateDefaultsInput.md

@@ -0,0 +1,56 @@
+# DocSpring::TemplateDefaultsInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **typeface** | [**Typeface**](Typeface.md) | The font of text fields. | [optional] |
+| **font_size** | **Integer** | The font size in points, a whole number. | [optional] |
+| **character_spacing** | **Float** | Extra space between characters, in points (0 to 50). | [optional] |
+| **color** | **String** | The text color, as 6 hex digits without `#`, such as `444444`. | [optional] |
+| **background_color** | **String** | The field's background color, as 6 hex digits. | [optional] |
+| **bold** | **Boolean** | Print text in bold. | [optional] |
+| **uppercase** | **Boolean** | Print text in capital letters. | [optional] |
+| **alignment** | [**TextAlignment**](TextAlignment.md) | How text is aligned in its field. `justify` lines up both edges of every line of multiline text except the last of each paragraph. | [optional] |
+| **opacity** | **Float** | The opacity of the field's content, from 0 (invisible) to 1. | [optional] |
+| **date_format** | **String** | How date fields are printed, as a strftime format such as `%m/%d/%Y`. | [optional] |
+| **date_time_format** | **String** | How date-time fields are printed, as a strftime format such as `%m/%d/%Y %H:%M:%S`. | [optional] |
+| **check_color** | **String** | The color of check marks, as 6 hex digits. | [optional] |
+| **check_character** | [**CheckCharacter**](CheckCharacter.md) | The character that a ticked check box prints. | [optional] |
+| **check_background_color** | **String** | The check box's background color, as 6 hex digits. | [optional] |
+| **required_field_background_color** | **String** | The background color that highlights required fields on visual forms and signature request forms, as 6 hex digits. PDFs don't print it. | [optional] |
+| **true_text** | **String** | The text a boolean field prints for `true`. | [optional] |
+| **false_text** | **String** | The text a boolean field prints for `false`. | [optional] |
+| **shape_fill_color** | **String** | The fill color of shapes, as 6 hex digits. | [optional] |
+| **shape_border_color** | **String** | The border color of shapes, as 6 hex digits. | [optional] |
+| **shape_border_width** | **Integer** | The border width of shapes, in whole points (at least 1). | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateDefaultsInput.new(
+  typeface: null,
+  font_size: null,
+  character_spacing: null,
+  color: null,
+  background_color: null,
+  bold: null,
+  uppercase: null,
+  alignment: null,
+  opacity: null,
+  date_format: null,
+  date_time_format: null,
+  check_color: null,
+  check_character: null,
+  check_background_color: null,
+  required_field_background_color: null,
+  true_text: null,
+  false_text: null,
+  shape_fill_color: null,
+  shape_border_color: null,
+  shape_border_width: null
+)
+```
+

data/docs/TemplateDiff.md

@@ -0,0 +1,30 @@
+# DocSpring::TemplateDiff
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | The template's ID. |  |
+| **from_version** | **String** | The earlier version, such as `1.1.0`. Null when no version was published before `to_version`: it's compared with a new template, so all of its fields are added. |  |
+| **to_version** | **String** | The later version, such as `1.2.0`. Null for the draft. |  |
+| **summary** | [**TemplateDiffSummary**](TemplateDiffSummary.md) | How many changes of each kind there are. |  |
+| **fields** | [**TemplateFieldChanges**](TemplateFieldChanges.md) | The fields that changed. |  |
+| **changed_settings** | **Array<String>** | The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `expire_after`, ...). Values aren't included, and secrets like `encrypt_pdfs_password` are named when they change. |  |
+| **document_changed** | **Boolean** | The template's PDF was replaced (or added, when there's no `from_version`). |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateDiff.new(
+  template_id: null,
+  from_version: null,
+  to_version: null,
+  summary: null,
+  fields: null,
+  changed_settings: null,
+  document_changed: null
+)
+```
+

data/docs/TemplateDiffSummary.md

@@ -0,0 +1,28 @@
+# DocSpring::TemplateDiffSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fields_added** | **Integer** | How many fields were added. |  |
+| **fields_removed** | **Integer** | How many fields were removed. |  |
+| **fields_changed** | **Integer** | How many fields have changed settings. |  |
+| **fields_reordered** | **Integer** | How many fields moved in the template's field order. |  |
+| **settings_changed** | **Integer** | How many of the template's settings changed. |  |
+| **total_changes** | **Integer** | All the changes, counting a new document as one. Zero when the versions are the same. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateDiffSummary.new(
+  fields_added: null,
+  fields_removed: null,
+  fields_changed: null,
+  fields_reordered: null,
+  settings_changed: null,
+  total_changes: null
+)
+```
+

data/docs/TemplateDocument.md

@@ -0,0 +1,40 @@
+# DocSpring::TemplateDocument
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filename** | **String** | The PDF's file name. Null until a `document_url` has been downloaded. |  |
+| **md5** | **String** | The MD5 hash of the PDF. |  |
+| **state** | [**TemplateDocumentState**](TemplateDocumentState.md) | `pending` while DocSpring processes the PDF, then `processed`. `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be. |  |
+| **error_message** | **String** | Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error. |  |
+| **field_reimport_state** | [**FieldReimportState**](FieldReimportState.md) | Whether the fields are being re-imported from this PDF (`reimport_fields` when the PDF was replaced): `requested` while DocSpring processes the PDF, then `imported`, or `no_fields` when the PDF had no fillable fields and the template kept its fields. `none` when no re-import was asked for, or when it couldn't run (the PDF couldn't be processed, or the template was locked or published while it was). |  |
+| **page_count** | **Integer** | 0 until the PDF has been processed. |  |
+| **page_dimensions** | **Array<Array<Float>>** | Each page's width and height in PDF points. Null until the PDF has been processed. |  |
+| **has_fillable_fields** | **Boolean** | Whether the PDF has fillable form fields. Null until DocSpring has read the PDF. |  |
+| **page_processing_statuses** | [**Array<TemplatePageProcessingStatus>**](TemplatePageProcessingStatus.md) | How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF, and for PDFs uploaded before DocSpring recorded page statuses. |  |
+| **field_logic_status** | [**TemplateFieldLogicStatus**](TemplateFieldLogicStatus.md) | AI field setup's last step, which reads the whole form once every page is done and can still rename fields and add conditional logic and required fields: `pending` or `processing` until it finishes, then `processed`, `failed` or `skipped`. Null until every page is done, and when there's no logic step to run (`field_logic` is `none`, or the PDF has no fields). |  |
+| **download_url** | **String** | A temporary link to download the PDF. |  |
+| **permanent_url** | **String** | A link to download the PDF that doesn't expire. Null until the PDF has been processed. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateDocument.new(
+  filename: null,
+  md5: null,
+  state: null,
+  error_message: null,
+  field_reimport_state: null,
+  page_count: null,
+  page_dimensions: null,
+  has_fillable_fields: null,
+  page_processing_statuses: null,
+  field_logic_status: null,
+  download_url: null,
+  permanent_url: null
+)
+```
+

data/docs/TemplateDocumentState.md

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

data/docs/TemplateFieldChange.md

@@ -0,0 +1,24 @@
+# DocSpring::TemplateFieldChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The field's ID. |  |
+| **changed_settings** | **Array<String>** | The names of the settings that changed, such as `x` or `required`. |  |
+| **old** | [**Field**](Field.md) |  |  |
+| **new** | [**Field**](Field.md) |  |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateFieldChange.new(
+  id: null,
+  changed_settings: null,
+  old: null,
+  new: null
+)
+```
+

data/docs/TemplateFieldChanges.md

@@ -0,0 +1,24 @@
+# DocSpring::TemplateFieldChanges
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **added** | [**Array<Field>**](Field.md) | The fields that `to_version` has and `from_version` doesn't. |  |
+| **removed** | [**Array<Field>**](Field.md) | The fields that `from_version` has and `to_version` doesn't, as they were. |  |
+| **changed** | [**Array<TemplateFieldChange>**](TemplateFieldChange.md) | The fields with changed settings. |  |
+| **reordered** | [**Array<TemplateFieldMove>**](TemplateFieldMove.md) | The fields that moved in the template's field order (the order of its fields across all its pages, as the fields endpoint lists them): fields that swapped places, or the field that moved the furthest. The fields that a move pushed along aren't listed. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateFieldChanges.new(
+  added: null,
+  removed: null,
+  changed: null,
+  reordered: null
+)
+```
+

data/docs/TemplateFieldDependency.md

@@ -0,0 +1,26 @@
+# DocSpring::TemplateFieldDependency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | [**TemplateFieldDependencyAction**](TemplateFieldDependencyAction.md) | What the rule does to the fields it applies to when its conditions are met. |  |
+| **match** | [**TemplateFieldDependencyMatch**](TemplateFieldDependencyMatch.md) | Whether all of the conditions (the default) or any of them must be met. | [optional] |
+| **conditions** | [**Array<TemplateFieldDependencyCondition>**](TemplateFieldDependencyCondition.md) | The conditions on other fields' values. |  |
+| **targets** | **Array<String>** | The names of the fields the rule shows or makes required. |  |
+| **group** | **String** | Marks a rule made for a field group in the template editor. Its targets outside the group are removed when the template is saved, and the rule is removed once the group has no fields. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateFieldDependency.new(
+  action: null,
+  match: null,
+  conditions: null,
+  targets: null,
+  group: null
+)
+```
+

data/docs/TemplateFieldDependencyAction.md

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

data/docs/TemplateFieldDependencyCondition.md

@@ -0,0 +1,24 @@
+# DocSpring::TemplateFieldDependencyCondition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | The name of the field whose value is compared. |  |
+| **operator** | [**TemplateFieldDependencyOperator**](TemplateFieldDependencyOperator.md) | How the field's value is compared with `value`. `in`: one of a list. `range`: from `value` to `range_max`. |  |
+| **value** | **Object** | The value to compare the field's value with. | [optional] |
+| **range_max** | **Object** | The upper end of a `range`, a number (or a number as a string, as the template editor saves it). | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateFieldDependencyCondition.new(
+  field: null,
+  operator: null,
+  value: null,
+  range_max: null
+)
+```
+