docspring 4.0.0 → 4.1.0

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

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **action** | [**TemplateFieldDependencyAction**](TemplateFieldDependencyAction.md) | What the rule does to its targets when its conditions are met. |  |
+| **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. |  |

data/docs/TemplateFieldDependencyInput.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **action** | [**TemplateFieldDependencyAction**](TemplateFieldDependencyAction.md) | What the rule does to its targets when its conditions are met. |  |
+| **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<TemplateFieldDependencyConditionInput>**](TemplateFieldDependencyConditionInput.md) | The conditions on other fields' values. |  |
 | **targets** | **Array<String>** | The names of the fields the rule shows or makes required. |  |

data/docs/TemplateFieldMove.md

@@ -0,0 +1,22 @@
+# DocSpring::TemplateFieldMove
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The field's ID. |  |
+| **old_index** | **Integer** | Its place in `from_version`'s field order, starting at 0. |  |
+| **new_index** | **Integer** | Its place in `to_version`'s field order, starting at 0. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateFieldMove.new(
+  id: null,
+  old_index: null,
+  new_index: null
+)
+```
+

data/docs/TemplateFields.md

@@ -0,0 +1,22 @@
+# DocSpring::TemplateFields
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | The template's ID. |  |
+| **version** | **String** | The published version the fields are of, such as `1.2.0`. Null for the draft. |  |
+| **fields** | [**Array<Field>**](Field.md) | The fields. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateFields.new(
+  template_id: null,
+  version: null,
+  fields: null
+)
+```
+

data/docs/TemplatePageImages.md

@@ -0,0 +1,24 @@
+# DocSpring::TemplatePageImages
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | The template's ID. |  |
+| **version** | **String** | The published version the images are of, such as `1.2.0`. Null for the draft. |  |
+| **page_count** | **Integer** | How many pages the PDF has. |  |
+| **pages** | [**Array<PageImage>**](PageImage.md) | An image of each page, in order: `pages[0]` is page 1. Their `download_url`s expire, so get them again when you need them. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplatePageImages.new(
+  template_id: null,
+  version: null,
+  page_count: null,
+  pages: null
+)
+```
+

data/docs/UpdateTemplateDocumentRequest.md

@@ -4,8 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **cache_id** | **String** | The `fields.key` of the new PDF, uploaded with the presigned upload (GET /uploads/presign). |  |
-| **filename** | **String** | The PDF's file name, for a `cache_id` (presigned uploads don't send one). | [optional] |
+| **cache_id** | **String** | The `fields.key` of the new PDF, uploaded with the presigned upload (GET /uploads/presign). | [optional] |
+| **document_url** | **String** | An https:// link to the template's PDF (up to 100 MB), instead of `cache_id`. DocSpring downloads it after responding, following redirects to other https:// links: the template's `document.state` is `downloading` until then (sync.api hosts wait for it). If it can't be downloaded, the state is `download_failed` and `document.error_message` says why. | [optional] |
+| **document_base64** | **String** | The template's PDF, encoded as base64 (a `data:` URI works too), instead of `cache_id`. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`. | [optional] |
+| **filename** | **String** | The PDF's file name, for a `cache_id` (presigned uploads don't send one) or `document_base64`. A `document_url`'s is the last part of its path unless you set it. | [optional] |
 | **reimport_fields** | **Boolean** | Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields. | [optional] |
 
 ## Example
@@ -15,6 +17,8 @@ require 'docspring'
 
 instance = DocSpring::UpdateTemplateDocumentRequest.new(
   cache_id: null,
+  document_url: null,
+  document_base64: null,
   filename: null,
   reimport_fields: null
 )

data/docs/UpdateTemplateFieldsRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::UpdateTemplateFieldsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fields** | [**Array<FieldInput>**](FieldInput.md) | The changes, each with the `id` of the field it changes. Settings left out keep their values. Changing a shared setting changes it for every field with the same name. Renaming a field moves it to the shared settings of its new name, and conditional logic and formulas that use the old name follow it when no other field has that name. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::UpdateTemplateFieldsRequest.new(
+  fields: null
+)
+```
+

data/docs/UpdateTemplateRequest.md

@@ -31,6 +31,9 @@
 | **slack_webhook_url** | **String** | A Slack incoming webhook URL that is notified about the template's submissions. It's never returned; `has_slack_webhook_url` says if it's set. | [optional] |
 | **defaults** | [**TemplateDefaultsInput**](TemplateDefaultsInput.md) | The default style of the template's fields. Setting it replaces the whole object. | [optional] |
 | **field_dependencies** | [**Array<TemplateFieldDependencyInput>**](TemplateFieldDependencyInput.md) | The template's conditional logic rules. Setting them replaces all of the rules. | [optional] |
+| **field_groups** | [**Array<FieldGroupInput>**](FieldGroupInput.md) | Changes to the settings of the template's field groups, each with the `name` of the group it changes. Settings left out keep their values, and groups left out are unchanged. | [optional] |
+| **predefined_fields** | [**Array<PredefinedFieldInput>**](PredefinedFieldInput.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. | [optional] |
+| **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. | [optional] |
 | **html** | **String** | The HTML of an HTML template, as a Liquid template. Null for PDF templates. | [optional] |
 | **scss** | **String** | The SCSS of an HTML template. | [optional] |
 | **header_html** | **String** | The HTML printed at the top of each page of an HTML template. | [optional] |
@@ -70,6 +73,9 @@ instance = DocSpring::UpdateTemplateRequest.new(
   slack_webhook_url: null,
   defaults: null,
   field_dependencies: null,
+  field_groups: null,
+  predefined_fields: null,
+  predefined_fields_sample_data: null,
   html: null,
   scss: null,
   header_html: null,

data/docs/ValidateSubmissionRequest.md

@@ -0,0 +1,38 @@
+# DocSpring::ValidateSubmissionRequest
+
+## 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, unless `signature_requests` collects the values. | [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] |
+| **output_formats** | [**Array<OutputFormat>**](OutputFormat.md) | What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission. | [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] |
+| **signature_requests** | [**Array<SignatureRequestInput>**](SignatureRequestInput.md) | The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF templates only. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out. Only the signers sign: a value for a signature or initials field in `data` makes the submission `invalid_data`. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::ValidateSubmissionRequest.new(
+  test: null,
+  editable: null,
+  data: null,
+  metadata: null,
+  password: null,
+  output_formats: null,
+  expires_in: null,
+  field_overrides: null,
+  html: null,
+  css: null,
+  signature_requests: null
+)
+```
+