docspring 4.2.0 → 4.4.0

data/docs/EmailActionTestEmail.md

@@ -0,0 +1,18 @@
+# DocSpring::EmailActionTestEmail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sent_to** | **String** | The address the test email went to, the email address of the API token's user. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::EmailActionTestEmail.new(
+  sent_to: null
+)
+```
+

data/docs/EmailDomain.md

@@ -0,0 +1,38 @@
+# DocSpring::EmailDomain
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The email domain's ID. |  |
+| **domain** | **String** | The domain name, such as `example.com` or `mail.example.com`. Email actions can send from any address at it. |  |
+| **state** | [**EmailDomainState**](EmailDomainState.md) | `pending` until its DNS records are found, then `verified`. `failed`: its records weren't found within 3 days, or were removed. Verify it again after fixing them. |  |
+| **dkim_state** | [**EmailDomainRecordState**](EmailDomainRecordState.md) | Whether the DKIM records were found. |  |
+| **mail_from_state** | [**EmailDomainRecordState**](EmailDomainRecordState.md) | Whether the MAIL FROM records were found. They're optional: they let SPF pass for your domain too. |  |
+| **dns_records** | [**Array<EmailDomainDnsRecord>**](EmailDomainDnsRecord.md) | The DNS records to add to the domain. Empty while DocSpring is still setting the domain up: verify it again in a few minutes to get them. |  |
+| **dmarc_policy** | **String** | The policy (`p=`) of the domain's DMARC record, once it has been found. |  |
+| **last_error** | **String** | Why the domain isn't verified yet, or what to fix. |  |
+| **verified_at** | **Time** | When the domain was verified. |  |
+| **checked_at** | **Time** | When DocSpring last checked the domain's DNS records. |  |
+| **created_at** | **Time** | When the domain was added. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::EmailDomain.new(
+  id: null,
+  domain: null,
+  state: null,
+  dkim_state: null,
+  mail_from_state: null,
+  dns_records: null,
+  dmarc_policy: null,
+  last_error: null,
+  verified_at: null,
+  checked_at: null,
+  created_at: null
+)
+```
+

data/docs/EmailDomainDnsRecord.md

@@ -0,0 +1,24 @@
+# DocSpring::EmailDomainDnsRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **purpose** | [**EmailDomainDnsRecordPurpose**](EmailDomainDnsRecordPurpose.md) | What the record is for. `dkim` signs the emails (required), `mail_from` lets SPF pass for your domain (recommended), and `dmarc` tells inboxes what to do with emails that fail these checks (required). |  |
+| **type** | [**DnsRecordType**](DnsRecordType.md) | The record's type. |  |
+| **name** | **String** | The record's name. Some DNS hosts add the domain to the end of a name by themselves. |  |
+| **value** | **String** | The record's value. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::EmailDomainDnsRecord.new(
+  purpose: null,
+  type: null,
+  name: null,
+  value: null
+)
+```
+

data/docs/EmailDomainDnsRecordPurpose.md

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

data/docs/EmailDomainList.md

@@ -0,0 +1,20 @@
+# DocSpring::EmailDomainList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<EmailDomain>**](EmailDomain.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::EmailDomainList.new(
+  data: null,
+  next_cursor: null
+)
+```
+

data/docs/EmailDomainRecordState.md

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

data/docs/EmailDomainState.md

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

data/docs/ErrorInfo.md

@@ -4,14 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | [**ErrorCode**](ErrorCode.md) | A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `upgrade_required` (403): your plan doesn't include this, such as more templates or the embedded template editor. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the PDF wasn't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): a request with the same Idempotency-Key is still being processed. Send the request again in a few seconds; when the first request has already created its record, its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request. |  |
+| **code** | [**ErrorCode**](ErrorCode.md) | A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `insufficient_credits_to_send` (402): your credit balance can't cover a live signature request that DocSpring would email, so nothing was saved. Add credits and send the request again. `upgrade_required` (403): your plan doesn't include this, such as more templates, another active integration (webhooks count), the embedded template editor, email actions, or live signature requests before your account's first payment. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the files weren't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): the first request with the same Idempotency-Key is still being processed, and the response has a `Retry-After` header: send the request again then. Without the header, the first request was processed but its response is no longer kept. When the first request created a record, its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id`, `template_id`, `folder_id`, `custom_file_id` or `webhook_id`. `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request. `rate_limited` (429): too many API requests. Wait for the `Retry-After` header's seconds. `daily_email_limit_reached` (429): a submission that DocSpring would email would take your account over its daily email limit, so nothing was saved. Send it again after the `Retry-After` header's seconds (midnight UTC), or send the signing links yourself (`send_email: false`). |  |
 | **message** | **String** | A human-readable explanation, safe to show to developers. |  |
 | **details** | [**Array<ErrorDetail>**](ErrorDetail.md) | What was wrong with each part of the request. Empty when the error isn't about one part of it. |  |
 | **request_id** | **String** | The ID of the request. Include it when you contact support. |  |
-| **submission_id** | **String** | When a submission's data fails validation, the submission is still recorded (state `invalid_data`) so you can see it in the dashboard. This is its ID. With `insufficient_credits`, the submission that waits for credits. With `polling_timeout` or `idempotency_key_in_use`, the submission that's still being processed. | [optional] |
-| **submission_batch_id** | **String** | The ID of the recorded batch, when items in a batch fail validation. With `insufficient_credits`, the batch whose submissions wait for credits. With `polling_timeout` or `idempotency_key_in_use`, the batch that's still being processed. | [optional] |
-| **combined_pdf_id** | **String** | With `insufficient_credits`, the combined PDF that waits for credits. With `polling_timeout` or `idempotency_key_in_use`, the combined PDF that's still being processed. | [optional] |
-| **template_id** | **String** | With `polling_timeout`, the template whose PDF is still being processed. | [optional] |
+| **submission_id** | **String** | When a submission's data fails validation, the submission is still recorded (state `invalid_data`) so you can see it in the dashboard. This is its ID. With `insufficient_credits`, the submission that waits for credits. With `polling_timeout`, the submission that's still being processed. With `idempotency_key_in_use`, the submission the first request with the key created. | [optional] |
+| **submission_batch_id** | **String** | The ID of the recorded batch, when items in a batch fail validation. With `insufficient_credits`, the batch whose submissions wait for credits. With `polling_timeout`, the batch that's still being processed. With `idempotency_key_in_use`, the batch the first request with the key created. | [optional] |
+| **combined_pdf_id** | **String** | With `insufficient_credits`, the combined PDF that waits for credits. With `polling_timeout`, the combined PDF that's still being processed. With `idempotency_key_in_use`, the combined PDF the first request with the key created. | [optional] |
+| **template_id** | **String** | With `polling_timeout`, the template whose PDF is still being processed. With `idempotency_key_in_use`, the template the first request with the key created. | [optional] |
+| **folder_id** | **String** | With `idempotency_key_in_use`, the folder the first request with the key created. | [optional] |
+| **custom_file_id** | **String** | With `idempotency_key_in_use`, the custom file the first request with the key created. | [optional] |
+| **webhook_id** | **String** | With `idempotency_key_in_use`, the webhook the first request with the key created. | [optional] |
 
 ## Example
 
@@ -26,7 +29,10 @@ instance = DocSpring::ErrorInfo.new(
   submission_id: null,
   submission_batch_id: null,
   combined_pdf_id: null,
-  template_id: null
+  template_id: null,
+  folder_id: null,
+  custom_file_id: null,
+  webhook_id: null
 )
 ```
 

data/docs/Field.md

@@ -83,7 +83,7 @@
 | **true_text** | **String** | Boolean fields with text display: the text printed when the value is `true`. Empty uses the template's `true_text`; when neither is set, nothing prints. |  |
 | **false_text** | **String** | Boolean fields with text display: the text printed when the value is `false`. Empty uses the template's `false_text`; when neither is set, nothing prints. |  |
 | **condition** | **String** | Check and shape display only: the value a string or number field's value is compared with, by `string_condition_type` or `number_condition_type`, to decide whether the check mark or shape prints. Boolean fields print when `true` (see `invert_boolean_condition`), and other types print when they have a value. |  |
-| **string_condition_type** | [**StringConditionType**](StringConditionType.md) | String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression the value must match. |  |
+| **string_condition_type** | [**StringConditionType**](StringConditionType.md) | String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression (RE2 syntax) the value must match; each has a `not_` form that prints when it doesn't match (`not_equals`, `not_regex`, ...). `blank` prints when the value is empty or only spaces and line breaks, and `not_blank` when it isn't; they ignore `condition`. |  |
 | **number_condition_type** | [**NumberConditionType**](NumberConditionType.md) | Number fields with check or shape display: how the value is compared with `condition`: `equals`, `gt` (greater than), `gte` (greater than or equal to), `lt` (less than), `lte` (less than or equal to), or `range`, between `number_condition_range_min` and `number_condition_range_max`. |  |
 | **number_condition_range_min** | **Float** | With `number_condition_type` `range`: the lower end of the range, included unless `number_condition_range_exclusive_min` is set. |  |
 | **number_condition_range_max** | **Float** | With `number_condition_type` `range`: the upper end of the range, included unless `number_condition_range_exclusive_max` is set. |  |

data/docs/FieldGroup.md

@@ -5,12 +5,12 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The group's name: `address` for the field `address/city`. A list's item numbers are written as `~`, so the fields `items/0/price` and `items/1/price` are in the groups `items` and `items/~`, the list's items. |  |
-| **type** | [**FieldGroupType**](FieldGroupType.md) | `array` for a list, whose fields' names number its items after the group's name (`items/0/price`, or `items/~/price` in an HTML template), and `object` for the other groups. |  |
+| **type** | [**FieldGroupType**](FieldGroupType.md) | `array` for a list, whose fields' names number its items after the group's name (`items/0/price`, or `items/~/price` in an HTML or Word template), and `object` for the other groups. |  |
 | **title** | **String** | The group's title in the template's data schema and on forms. When it's empty, a title is made from the group's name. |  |
 | **description** | **String** | Help text for the group, added to the template's data schema and shown on forms. |  |
 | **metadata** | **String** | Text for your own use, added to the template's data schema as `x-metadata`. DocSpring doesn't use it. |  |
 | **min_items** | **Integer** | Lists only (`type` `array`): the fewest items submission data must have. Null for no minimum. |  |
-| **max_items** | **Integer** | HTML templates' lists only: the most items submission data can have. Null for no limit. A PDF template's list takes as many items as its fields are numbered for, or more with `allow_additional_items`. |  |
+| **max_items** | **Integer** | HTML and Word templates' lists only: the most items submission data can have. Null for no limit. A PDF template's list takes as many items as its fields are numbered for, or more with `allow_additional_items`. |  |
 | **allow_additional_items** | **Boolean** | PDF templates' lists only: submission data can have more items than the list's fields are numbered for. Default false. |  |
 
 ## Example

data/docs/FieldGroupInput.md

@@ -9,7 +9,7 @@
 | **description** | **String** | Help text for the group, added to the template's data schema and shown on forms. | [optional] |
 | **metadata** | **String** | Text for your own use, added to the template's data schema as `x-metadata`. DocSpring doesn't use it. | [optional] |
 | **min_items** | **Integer** | Lists only (`type` `array`): the fewest items submission data must have. Null for no minimum. | [optional] |
-| **max_items** | **Integer** | HTML templates' lists only: the most items submission data can have. Null for no limit. A PDF template's list takes as many items as its fields are numbered for, or more with `allow_additional_items`. | [optional] |
+| **max_items** | **Integer** | HTML and Word templates' lists only: the most items submission data can have. Null for no limit. A PDF template's list takes as many items as its fields are numbered for, or more with `allow_additional_items`. | [optional] |
 | **allow_additional_items** | **Boolean** | PDF templates' lists only: submission data can have more items than the list's fields are numbered for. Default false. | [optional] |
 
 ## Example

data/docs/FieldInput.md

@@ -81,7 +81,7 @@
 | **true_text** | **String** | Boolean fields with text display: the text printed when the value is `true`. Empty uses the template's `true_text`; when neither is set, nothing prints. | [optional] |
 | **false_text** | **String** | Boolean fields with text display: the text printed when the value is `false`. Empty uses the template's `false_text`; when neither is set, nothing prints. | [optional] |
 | **condition** | **String** | Check and shape display only: the value a string or number field's value is compared with, by `string_condition_type` or `number_condition_type`, to decide whether the check mark or shape prints. Boolean fields print when `true` (see `invert_boolean_condition`), and other types print when they have a value. | [optional] |
-| **string_condition_type** | [**StringConditionType**](StringConditionType.md) | String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression the value must match. | [optional] |
+| **string_condition_type** | [**StringConditionType**](StringConditionType.md) | String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression (RE2 syntax) the value must match; each has a `not_` form that prints when it doesn't match (`not_equals`, `not_regex`, ...). `blank` prints when the value is empty or only spaces and line breaks, and `not_blank` when it isn't; they ignore `condition`. | [optional] |
 | **number_condition_type** | [**NumberConditionType**](NumberConditionType.md) | Number fields with check or shape display: how the value is compared with `condition`: `equals`, `gt` (greater than), `gte` (greater than or equal to), `lt` (less than), `lte` (less than or equal to), or `range`, between `number_condition_range_min` and `number_condition_range_max`. | [optional] |
 | **number_condition_range_min** | **Float** | With `number_condition_type` `range`: the lower end of the range, included unless `number_condition_range_exclusive_min` is set. | [optional] |
 | **number_condition_range_max** | **Float** | With `number_condition_type` `range`: the upper end of the range, included unless `number_condition_range_exclusive_max` is set. | [optional] |

data/docs/GenerateSubmissionFilesRequest.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **formats** | [**Array<GenerateFilesFormat>**](GenerateFilesFormat.md) | The formats to add to the submission's files: `png`, an image of each page of the submission's PDF (up to 100 pages). A format the submission already has (or is making) is left as it is. |  |
+| **formats** | [**Array<GenerateFilesFormat>**](GenerateFilesFormat.md) | The formats to add to the submission's files: `pdf`, the PDF of a Word template's submission that didn't make one (converted from its Word document); `docx`, the Word document of a Word template's submission that didn't make one (made again from the submission's data and the template version it used); `odt`, the OpenDocument file of a Word template's submission that didn't make one (converted from its Word document); and `png`, an image of each page of the PDF (up to 100 pages), which makes the PDF first if the submission doesn't have one. A submission without a Word document makes it again for `pdf` and `odt`, without keeping it. A format the submission already has (or is making) is left as it is. |  |
 
 ## Example
 

data/docs/GeneratedFile.md

@@ -8,8 +8,8 @@
 | **error_message** | **String** | Why the file couldn't be made, when `state` is `error`. |  |
 | **download_url** | **String** | A temporary link to download the file. Null until the file has been made, and when your account turns off download links for submissions. |  |
 | **permanent_url** | **String** | A link to download the file that doesn't expire: it redirects to a new temporary link. It needs your API token or a signed-in session, except for a submission of a template that makes its submissions public. Null until the file has been made. |  |
-| **filename** | **String** | The file's name, such as `sub_123.pdf`. |  |
-| **content_type** | **String** | The file's media type, such as `application/pdf`. |  |
+| **filename** | **String** | The file's name, such as `sub_123.pdf`, `sub_123.docx` or `sub_123.odt`. |  |
+| **content_type** | **String** | The file's media type: `application/pdf`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document` for a Word document, or `application/vnd.oasis.opendocument.text` for an OpenDocument file. |  |
 | **size** | **Integer** | The file's size in bytes. Null until the file has been made. |  |
 | **sha256** | **String** | The SHA-256 hash of the file. Null until the file has been made. |  |
 

data/docs/HtmlEngineOptions.md

@@ -7,7 +7,7 @@
 | **format** | [**PageFormat**](PageFormat.md) | The paper size. `Custom` uses `width` and `height`. |  |
 | **width** | **String** | The page width for the `Custom` format, with a unit (`8.5in`, `210mm`). | [optional] |
 | **height** | **String** | The page height for the `Custom` format, with a unit. | [optional] |
-| **scale** | **Float** | How much to scale the page, such as `0.8`. `1` prints it at its normal size. |  |
+| **scale** | **Float** | How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size. |  |
 | **landscape** | **Boolean** | Print pages in landscape orientation. |  |
 | **print_background** | **Boolean** | Print background colors and images. |  |
 | **margin_top** | **String** | The top margin, with a unit, such as `1in` or `20mm`. |  |

data/docs/HtmlEngineOptionsInput.md

@@ -7,7 +7,7 @@
 | **format** | [**PageFormat**](PageFormat.md) | The paper size. `Custom` uses `width` and `height`. | [optional] |
 | **width** | **String** | The page width for the `Custom` format, with a unit (`8.5in`, `210mm`). | [optional] |
 | **height** | **String** | The page height for the `Custom` format, with a unit. | [optional] |
-| **scale** | **Float** | How much to scale the page, such as `0.8`. `1` prints it at its normal size. | [optional] |
+| **scale** | **Float** | How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size. | [optional] |
 | **landscape** | **Boolean** | Print pages in landscape orientation. | [optional] |
 | **print_background** | **Boolean** | Print background colors and images. | [optional] |
 | **margin_top** | **String** | The top margin, with a unit, such as `1in` or `20mm`. | [optional] |

data/docs/SendAccountEmailActionTestEmailRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::SendAccountEmailActionTestEmailRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | A template the email action sends for: the test uses its PDF and name. Left out, it uses the one that changed most recently. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SendAccountEmailActionTestEmailRequest.new(
+  template_id: null
+)
+```
+

data/docs/SignatureRequest.md

@@ -7,11 +7,15 @@
 | **id** | **String** | The signature request's ID. |  |
 | **submission_id** | **String** | The ID of the submission the signature request belongs to. |  |
 | **name** | **String** | The name of the person the request is for. |  |
-| **email** | **String** | Their email address. |  |
+| **email** | **String** | Their email address. Null when they have none. |  |
 | **fields** | **Array<String>** | The fields this person fills in. Null for a signature request created with API v1 without a field list: it asks for every field the submission's data doesn't have. |  |
 | **metadata** | **Hash<String, Object>** | Your own data about the signature request, such as an ID from your app. |  |
 | **role** | **String** | Which of the template's signers the person is. Until templates have roles of their own, a template's signers are `Signer 1`, `Signer 2` and so on, up to `Signer 100`: `Signer 1` is the one whose details the template's `@@signature_requests/0` fields print. |  |
 | **sort_order** | **Integer** | The signer's position, from 0: `Signer 1` is 0. The template's `@@signature_requests/<sort_order>` fields print this signature request's details. |  |
+| **send_email** | **Boolean** | Whether DocSpring emails this person their signing link. |  |
+| **signing_step** | **Integer** | When this person signs, when the submission's `signing_order` is `sequential`: everyone in step 1 first, then step 2, and so on. Null when everyone can sign at once. |  |
+| **sent_at** | **Time** | When DocSpring first emailed this person their signing link. Null until it has, and when it doesn't email them (`send_email` is false). |  |
+| **email_status** | [**SignatureRequestEmailStatus**](SignatureRequestEmailStatus.md) | What happened to the latest email DocSpring sent this person with their signing link: `sent` until the email service reports on it, then `delayed` (still trying), `delivered`, `undelivered` (it stopped trying, as with a full mailbox), `bounced` (the address doesn't exist) or `complained` (marked as spam). `failed` means DocSpring couldn't send the first email with their link, and `unknown` that it couldn't tell whether that email went: neither is sent again. Null until DocSpring has emailed them or tried to. |  |
 | **state** | [**SignatureRequestState**](SignatureRequestState.md) | `pending` until the person completes the signature request (`completed`) or declines it (`declined`). |  |
 | **data** | **Hash<String, Object>** | The values this person entered for their own fields (`fields`). Null when their submission's data is left out: in lists without `include_data=true`, in the events of a webhook that leaves out submission data, and once the submission has expired. |  |
 | **viewed_at** | **Time** | When the person first opened the signature request. |  |
@@ -44,6 +48,10 @@ instance = DocSpring::SignatureRequest.new(
   metadata: null,
   role: null,
   sort_order: null,
+  send_email: null,
+  signing_step: null,
+  sent_at: null,
+  email_status: null,
   state: null,
   data: null,
   viewed_at: null,

data/docs/SignatureRequestEmailAttachments.md

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

data/docs/SignatureRequestEmailStatus.md

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

data/docs/SignatureRequestInput.md

@@ -5,11 +5,11 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the person the request is for. | [optional] |
-| **email** | **String** | Their email address. | [optional] |
+| **email** | **String** | Their email address. Null when they have none. | [optional] |
 | **fields** | **Array<String>** | The fields this person fills in. Each field can only be in one signature request, and a field that `data` fills in needs `prefilled_values_editable`. |  |
 | **metadata** | **Hash<String, Object>** | Your own data about the signature request, such as an ID from your app. | [optional] |
 | **role** | **String** | Which of the template's signers the person is: `Signer 1`, `Signer 2` and so on, up to `Signer 100`, until templates have roles of their own. Either every signature request has a `role` or none does, and each role can only have one. | [optional] |
-| **auth_type** | [**SignatureRequestAuthType**](SignatureRequestAuthType.md) | How your app authenticated the person before it showed them the signature request. |  |
+| **auth_type** | [**SignatureRequestAuthType**](SignatureRequestAuthType.md) | How your app authenticated the person before it showed them the signature request. | [optional] |
 | **auth_second_factor_type** | [**SignatureRequestAuthSecondFactorType**](SignatureRequestAuthSecondFactorType.md) | The second factor your app authenticated them with, if any. | [optional] |
 | **auth_provider** | **String** | The service that authenticated them, such as `google`. Required when `auth_type` is `oauth`. | [optional] |
 | **auth_session_started_at** | **Time** | When your app authenticated them. Set for you with `email_link`. | [optional] |
@@ -19,6 +19,8 @@
 | **auth_phone_number_hash** | **String** | The phone number they authenticated with, or a SHA-256 hash of a salt and the phone number. | [optional] |
 | **ignore_unknown_fields** | **Boolean** | Leave out names in `fields` that the template doesn't have, for one field list that you send with several templates. Without it, an unknown name makes the submission `invalid_data`. | [optional] |
 | **prefilled_values_editable** | **Boolean** | Let the person change the values that `data` already has for fields in `fields`. Without it, those fields are a 422. | [optional] |
+| **send_email** | **Boolean** | Whether DocSpring emails this person their signing link. Default: the submission's `send_email`. Set it to false for someone who signs in your app (embedded signing) or whose link you send yourself. When DocSpring emails them, `email` is required and `auth_type` is `email_link` (the default). Otherwise `auth_type` is required. | [optional] |
+| **signing_step** | **Integer** | When this person signs, with `signing_order: sequential`: everyone in step 1 first, then step 2, and so on. People in the same step sign in any order. Only the order of the numbers matters. Either every signature request has a `signing_step` or none does; without them, each person is a step of their own, in the order of `signature_requests`. | [optional] |
 
 ## Example
 
@@ -40,7 +42,9 @@ instance = DocSpring::SignatureRequestInput.new(
   auth_username_hash: null,
   auth_phone_number_hash: null,
   ignore_unknown_fields: null,
-  prefilled_values_editable: null
+  prefilled_values_editable: null,
+  send_email: null,
+  signing_step: null
 )
 ```
 

data/docs/SignatureRequestReminders.md

@@ -0,0 +1,20 @@
+# DocSpring::SignatureRequestReminders
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **interval_days** | **Integer** | Days between reminders. |  |
+| **max_count** | **Integer** | The most reminders each person gets. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SignatureRequestReminders.new(
+  interval_days: null,
+  max_count: null
+)
+```
+

data/docs/SigningOrder.md

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

data/docs/Submission.md

@@ -6,18 +6,18 @@
 | ---- | ---- | ----------- | ----- |
 | **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_type** | [**TemplateType**](TemplateType.md) | The template's type: `pdf`, `html` or `docx`. |  |
 | **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. |  |
+| **state** | [**SubmissionState**](SubmissionState.md) | `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are 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 files: `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 files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `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, and the demo API token's are always live. |  |
 | **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. Empty once the submission has expired. Null in a batch's submissions unless you pass `include_data=true`, and in the events of a webhook that leaves out submission data. |  |
 | **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. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`). |  |
-| **files** | [**SubmissionFiles**](SubmissionFiles.md) | The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired. |  |
+| **files** | [**SubmissionFiles**](SubmissionFiles.md) | The generated files: `pdf`, `docx` and `odt` (by `output_formats`) once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired. |  |
 | **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. |  |
@@ -25,9 +25,10 @@
 | **updated_at** | **Time** | When the submission was last updated. |  |
 | **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). |  |
+| **signing_order** | [**SigningOrder**](SigningOrder.md) | `parallel`: everyone can sign at once. `sequential`: people sign one step at a time (each signature request's `signing_step`). |  |
+| **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) | The uploads of the submission's PDF to your storage (account integrations), and the emails its template's email actions sent. |  |
 | **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. |  |
-| **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. |  |
+| **output_formats** | [**Array<OutputFormat>**](OutputFormat.md) | What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission. |  |
 | **preview_generated_at** | **Time** | When the preview PDF was generated. Null if there is no preview. |  |
 
 ## Example
@@ -57,6 +58,7 @@ instance = DocSpring::Submission.new(
   updated_at: null,
   has_password: null,
   signature_requests: null,
+  signing_order: null,
   actions: null,
   truncated_text: null,
   output_formats: null,

data/docs/SubmissionAction.md

@@ -6,9 +6,10 @@
 | ---- | ---- | ----------- | ----- |
 | **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. |  |
+| **email_action_id** | **String** | The ID of the email action that sent the email. Null for an upload, or once the email action is deleted. |  |
+| **state** | [**SubmissionActionState**](SubmissionActionState.md) | `pending` until the upload or email has run, then `processed`. `failed`: your storage or the email service 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, or `email` for an email action's email. |  |
+| **result_data** | **Hash<String, Object>** | Where the PDF was uploaded, such as the S3 bucket and key. For an email: its `subject`, `recipients`, each with its `address`, `kind` (`to`, `cc` or `bcc`), `source`, `field` or `metadata` when the address came from one, and `status` (`sent`, `delivered`, `bounced`, `complained`, `skipped` and others), `sent_at`, `delivery`, and `files` (the files it sent: `pdf`, `docx`, `odt`). An email whose submission didn't meet the email action's `send_when` conditions has only `skipped`, `conditions_not_met`, and its state is `processed`. An email whose submission made none of the files the email action sends has `skipped`, `no_files` and the action's `file_formats`, and its state is `processed` too. When the submission's data is left out (a batch, or a webhook without submission data), the subject and the addresses that came from fields or metadata are null. |  |
 | **error_message** | **String** | Why the upload failed, when `state` is `failed` or `error`. |  |
 
 ## Example
@@ -19,6 +20,7 @@ require 'docspring'
 instance = DocSpring::SubmissionAction.new(
   id: null,
   integration_id: null,
+  email_action_id: null,
   state: null,
   action_type: null,
   result_data: null,

data/docs/SubmissionBatch.md

@@ -5,11 +5,11 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **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. |  |
+| **state** | [**SubmissionBatchState**](SubmissionBatchState.md) | `pending` while the files 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. |  |
+| **pending_count** | **Integer** | The submissions whose files haven't been generated yet. |  |
+| **error_count** | **Integer** | The submissions that were invalid or whose files 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. |  |

data/docs/SubmissionFiles.md

@@ -7,6 +7,8 @@
 | **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] |
+| **docx** | [**GeneratedFile**](GeneratedFile.md) | The Word document of a Word template's submission, when the submission makes one (`output_formats`). | [optional] |
+| **odt** | [**GeneratedFile**](GeneratedFile.md) | The OpenDocument file (.odt, the format LibreOffice uses) of a Word template's submission, converted from its Word document, when the submission makes one (`output_formats`). | [optional] |
 | **png** | [**PageImages**](PageImages.md) |  | [optional] |
 
 ## Example
@@ -18,6 +20,8 @@ instance = DocSpring::SubmissionFiles.new(
   pdf: null,
   audit_trail: null,
   preview: null,
+  docx: null,
+  odt: null,
   png: null
 )
 ```

data/docs/SubmissionInput.md

@@ -4,13 +4,13 @@
 
 | 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] |
+| **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, and the demo API token's are always live. | [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] |
+| **data** | **Hash<String, Object>** | The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs. | [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. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.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] |
+| **password** | **String** | A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. Word documents and OpenDocument files can't be password-protected, so a submission with a password can't make them. | [optional] |
+| **output_formats** | [**Array<OutputFormat>**](OutputFormat.md) | What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, 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. The demo API token's submissions expire within an hour: up to 3600, and that's their default. | [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, SCSS (plain CSS works too) added after the template's styles, on the page and in its header and footer. It doesn't replace them: its rules come later, so they win over the template's rules of the same specificity. | [optional] |