docspring 3.5.0 → 4.0.0

data/docs/{UpdateWebhookData.md → CombinedFieldType.md}

@@ -1,18 +1,15 @@
-# DocSpring::UpdateWebhookData
+# DocSpring::CombinedFieldType
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **webhook** | **Object** |  |  |
 
 ## Example
 
 ```ruby
 require 'docspring'
 
-instance = DocSpring::UpdateWebhookData.new(
-  webhook: null
-)
+instance = DocSpring::CombinedFieldType.new()
 ```
 

data/docs/CombinedPdf.md

@@ -0,0 +1,44 @@
+# DocSpring::CombinedPdf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The combined PDF's ID. |  |
+| **state** | [**CombinedPdfState**](CombinedPdfState.md) | `pending` until the PDF has been generated, then `processed`. `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. `error`: the PDFs couldn't be merged (see `error_message`). Waiting ends in `error` if it's discarded or takes over 30 days. |  |
+| **source_pdfs** | [**Array<CombinedPdfSource>**](CombinedPdfSource.md) | The PDFs to merge, in order. |  |
+| **metadata** | **Hash<String, Object>** | Your own data about the combined PDF, such as an ID from your app. |  |
+| **has_password** | **Boolean** | Whether the PDF needs a password to open (`password`). |  |
+| **delete_custom_files** | **Boolean** | Delete the custom files in `source_pdfs` once the combined PDF has been generated (they're kept if it fails). Other combined PDFs can't use them after that. A test API token can't delete custom files. |  |
+| **error_message** | **String** | Why the PDFs couldn't be merged, when `state` is `error`. |  |
+| **files** | [**CombinedPdfFiles**](CombinedPdfFiles.md) | The generated files, by format. Empty until the PDF has been generated, and once it has expired. |  |
+| **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) | The uploads of the PDF to your storage (account integrations). |  |
+| **expired** | **Boolean** | An expired combined PDF's PDF, metadata, password and source URLs have been deleted. |  |
+| **expires_at** | **Time** | When the combined PDF expires (`expires_in` after it's generated). Null if it's kept until you delete it. |  |
+| **processed_at** | **Time** | When the PDF was generated. Null until then. |  |
+| **created_at** | **Time** | When the combined PDF was created. |  |
+| **updated_at** | **Time** | When the combined PDF was last updated. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::CombinedPdf.new(
+  id: null,
+  state: null,
+  source_pdfs: null,
+  metadata: null,
+  has_password: null,
+  delete_custom_files: null,
+  error_message: null,
+  files: null,
+  actions: null,
+  expired: null,
+  expires_at: null,
+  processed_at: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/CombinedPdfFiles.md

@@ -0,0 +1,18 @@
+# DocSpring::CombinedPdfFiles
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pdf** | [**GeneratedFile**](GeneratedFile.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::CombinedPdfFiles.new(
+  pdf: null
+)
+```
+

data/docs/CombinedPdfList.md

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

data/docs/CombinedPdfSource.md

@@ -0,0 +1,26 @@
+# DocSpring::CombinedPdfSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**CombinedPdfSourceType**](CombinedPdfSourceType.md) | What the PDF is: a submission's PDF, another combined PDF, a template's PDF, a custom file (POST /custom_files) or a PDF to download from a URL. |  |
+| **id** | **String** | The ID of the submission, combined PDF, template or custom file. | [optional] |
+| **url** | **String** | For a `url` source, the URL to download the PDF from. Removed once the combined PDF has expired. | [optional] |
+| **template_version** | **String** | For a `template` source, the version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published). | [optional] |
+| **processed** | **Boolean** | For a `template` source: true (the default) merges the template's processed PDF, which is the PDF submissions are filled in on (decrypted, with its form fields removed). false merges the PDF as it was uploaded. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::CombinedPdfSource.new(
+  type: null,
+  id: null,
+  url: null,
+  template_version: null,
+  processed: null
+)
+```
+

data/docs/CombinedPdfSourceInput.md

@@ -0,0 +1,88 @@
+# DocSpring::CombinedPdfSourceInput
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'docspring'
+
+DocSpring::CombinedPdfSourceInput.openapi_one_of
+# =>
+# [
+#   :'CombinedPdfSourcePdf',
+#   :'CustomFileSourcePdf',
+#   :'SubmissionSourcePdf',
+#   :'TemplateSourcePdf',
+#   :'UrlSourcePdf'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'docspring'
+
+DocSpring::CombinedPdfSourceInput.openapi_discriminator_name
+# => :'type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'docspring'
+
+DocSpring::CombinedPdfSourceInput.openapi_discriminator_mapping
+# =>
+# {
+#   :'combined_pdf' => :'CombinedPdfSourcePdf',
+#   :'custom_file' => :'CustomFileSourcePdf',
+#   :'submission' => :'SubmissionSourcePdf',
+#   :'template' => :'TemplateSourcePdf',
+#   :'url' => :'UrlSourcePdf'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'docspring'
+
+DocSpring::CombinedPdfSourceInput.build(data)
+# => #<CombinedPdfSourcePdf:0x00007fdd4aab02a0>
+
+DocSpring::CombinedPdfSourceInput.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `CombinedPdfSourcePdf`
+- `CustomFileSourcePdf`
+- `SubmissionSourcePdf`
+- `TemplateSourcePdf`
+- `UrlSourcePdf`
+- `nil` (if no type matches)
+

data/docs/CombinedPdfSourcePdf.md

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

data/docs/CombinedPdfSourceType.md

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

data/docs/CombinedPdfState.md

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

data/docs/CopyTemplateRequest.md

@@ -0,0 +1,22 @@
+# DocSpring::CopyTemplateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Default: the template's name followed by a number, such as "Contract (2)". For a published version, the name followed by the version, such as "Contract (v1.2.0)". | [optional] |
+| **parent_folder_id** | **String** | The folder to put the copy in. Null puts it at the root. Left out, the copy goes in the template's own folder. | [optional] |
+| **version** | **String** | Copy this published version (`1.2.0`, or `1` for the latest 1.x.x) instead of the draft. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::CopyTemplateRequest.new(
+  name: null,
+  parent_folder_id: null,
+  version: null
+)
+```
+

data/docs/CreateCombinedPdfRequest.md

@@ -0,0 +1,26 @@
+# DocSpring::CreateCombinedPdfRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source_pdfs** | [**Array<CombinedPdfSourceInput>**](CombinedPdfSourceInput.md) | The PDFs to merge, in order. |  |
+| **metadata** | **Hash<String, Object>** | Your own data about the combined PDF, such as an ID from your app. | [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] |
+| **delete_custom_files** | **Boolean** | Delete the custom files in `source_pdfs` once the combined PDF has been generated (they're kept if it fails). Other combined PDFs can't use them after that. A test API token can't delete custom files. | [optional] |
+| **expires_in** | **Integer** | Seconds after the PDF is generated until the combined PDF expires, up to 10 years (315360000). One that fails is kept for at least 48 hours. Without it, the combined PDF is kept until you delete it. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::CreateCombinedPdfRequest.new(
+  source_pdfs: null,
+  metadata: null,
+  password: null,
+  delete_custom_files: null,
+  expires_in: null
+)
+```
+

data/docs/CreateCustomFileFromUploadRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::CreateCustomFileFromUploadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cache_id** | **String** | The `fields.key` from GET /uploads/presign, after you upload the file to its URL. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::CreateCustomFileFromUploadRequest.new(
+  cache_id: null
+)
+```
+

data/docs/CreateFolderRequest.md

@@ -0,0 +1,20 @@
+# DocSpring::CreateFolderRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The folder's name. It can't contain `/`, and is unique within its parent folder. |  |
+| **parent_folder_id** | **String** | The ID of the folder this folder is in. Null for a folder at the root. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::CreateFolderRequest.new(
+  name: null,
+  parent_folder_id: null
+)
+```
+

data/docs/CreateSignatureRequestEventRequest.md

@@ -0,0 +1,24 @@
+# DocSpring::CreateSignatureRequestEventRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_type** | [**SignatureRequestEventType**](SignatureRequestEventType.md) | `send_request`: you sent the signature request to the person (`message_type` and `message_recipient` are required). It's the only event the API records: DocSpring records everything that happens in the signing form itself, and people decline a signature request in its form. |  |
+| **message_type** | [**SignatureRequestMessageType**](SignatureRequestMessageType.md) | How you sent the request. Required for `send_request`. | [optional] |
+| **message_recipient** | **String** | Where you sent the request, such as an email address or a phone number. Required for `send_request`. | [optional] |
+| **occurred_at** | **Time** | When it happened. Default now. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::CreateSignatureRequestEventRequest.new(
+  event_type: null,
+  message_type: null,
+  message_recipient: null,
+  occurred_at: null
+)
+```
+

data/docs/CreateSignatureRequestTokenRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::CreateSignatureRequestTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**SignatureRequestTokenType**](SignatureRequestTokenType.md) | `api` (the default): the link opens the signature request for 24 hours, for a form your app opens or a link it gives the person right away. `email`: 7 days, for a link you send by email. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::CreateSignatureRequestTokenRequest.new(
+  type: null
+)
+```
+

data/docs/CreateSubmissionBatchRequest.md

@@ -0,0 +1,26 @@
+# DocSpring::CreateSubmissionBatchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | **Hash<String, Object>** | Your own data about the batch, such as an ID from your app. | [optional] |
+| **template_id** | **String** | The template for each submission that doesn't name its own `template_id`. | [optional] |
+| **template_version** | **String** | The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published). | [optional] |
+| **test** | **Boolean** | The default `test` for each submission that doesn't set its own. | [optional] |
+| **submissions** | [**Array<SubmissionInput>**](SubmissionInput.md) | Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests`, plus `template_id` and `template_version` when it uses a different template from the batch. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::CreateSubmissionBatchRequest.new(
+  metadata: null,
+  template_id: null,
+  template_version: null,
+  test: null,
+  submissions: null
+)
+```
+

data/docs/CreateSubmissionRequest.md

@@ -0,0 +1,36 @@
+# DocSpring::CreateSubmissionRequest
+
+## 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] |
+| **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::CreateSubmissionRequest.new(
+  test: null,
+  editable: null,
+  data: null,
+  metadata: null,
+  password: null,
+  expires_in: null,
+  field_overrides: null,
+  html: null,
+  css: null,
+  signature_requests: null
+)
+```
+

data/docs/CreateTemplateRequest.md

@@ -0,0 +1,94 @@
+# DocSpring::CreateTemplateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The template's name. | [optional] |
+| **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. | [optional] |
+| **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. |  |
+| **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. | [optional] |
+| **locked** | **Boolean** | A locked template can't be changed or deleted until it's unlocked (`locked` can always be changed). | [optional] |
+| **add_signature_request_submission_id_footers** | **Boolean** | Print the submission ID in the footer of each page of PDFs signed through signature requests. | [optional] |
+| **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. | [optional] |
+| **allow_additional_properties** | **Boolean** | Accept submission data with properties that aren't fields of the template. | [optional] |
+| **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. | [optional] |
+| **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. | [optional] |
+| **editable_submissions** | **Boolean** | Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it. | [optional] |
+| **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. | [optional] |
+| **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). | [optional] |
+| **embed_edit_allow_versioning** | **Boolean** | Allow the embedded template editor to publish, restore, compare and delete published versions. | [optional] |
+| **embed_edit_allow_document_replacement** | **Boolean** | Allow the embedded template editor to replace the template's PDF. | [optional] |
+| **encrypt_pdfs** | **Boolean** | Encrypt generated PDFs with `encrypt_pdfs_password`. | [optional] |
+| **encrypt_pdfs_password** | **String** | The password that opens encrypted PDFs. It's never returned; `has_encrypt_pdfs_password` says if it's set. | [optional] |
+| **expire_submissions** | **Boolean** | Delete each submission's data and PDF after `expire_after` `expiration_interval`. | [optional] |
+| **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). | [optional] |
+| **expiration_interval** | [**ExpirationInterval**](ExpirationInterval.md) | The unit of `expire_after`. | [optional] |
+| **merge_audit_trail_pdf** | **Boolean** | Add the audit trail to the end of PDFs signed through signature requests. | [optional] |
+| **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. | [optional] |
+| **public_submissions** | **Boolean** | Allow anyone with a submission's ID to download its PDF. | [optional] |
+| **public_web_form** | **Boolean** | Allow anyone to fill in the template's web form. | [optional] |
+| **redirect_url** | **String** | Where the web form sends people after they submit it. | [optional] |
+| **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] |
+| **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] |
+| **footer_html** | **String** | The HTML printed at the bottom of each page of an HTML template. | [optional] |
+| **html_engine_options** | [**HtmlEngineOptionsInput**](HtmlEngineOptionsInput.md) | Null resets the options to their defaults. | [optional] |
+| **cache_id** | **String** | A PDF template's document: the `fields.key` of a file you uploaded with the presigned upload (GET /uploads/presign). Required for a PDF template. To upload the PDF with the request, use POST /templates/upload. | [optional] |
+| **filename** | **String** | The PDF's file name, for a `cache_id` (presigned uploads don't send one). | [optional] |
+| **detect_fields** | **Boolean** | Set up the PDF's fields as DocSpring's "Automatically detect fields" upload option does: import or detect the fields, name them with AI, and set up conditional logic. `field_source`, `field_naming` and `field_logic` choose how. Default false. `document.page_processing_statuses` and `document.field_logic_status` show how it's going, and `document.state` becomes `processed` once every page's fields are set up. | [optional] |
+| **field_source** | [**FieldSetupSource**](FieldSetupSource.md) | With `detect_fields`, where the fields come from. `auto` (the default) imports the form fields of a fillable PDF and detects the fields of a PDF without them; `pdf_detection` detects the fields from the page layout, even on a fillable PDF; `pdf_form_fields` only imports the PDF's form fields. | [optional] |
+| **field_naming** | [**FieldSetupNaming**](FieldSetupNaming.md) | With `detect_fields`, how the fields are named. `ai` (the default) names them and sets their types and settings with AI; `preserve` keeps the names of the PDF's form fields, and AI only names the fields it detected. `preserve` needs `field_source` `auto` or `pdf_form_fields`. | [optional] |
+| **field_logic** | [**FieldSetupLogic**](FieldSetupLogic.md) | With `detect_fields`, whether AI reads the whole form once the fields are named and sets up conditional logic and required fields (`ai`) or not (`none`). Default: your account's template settings. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::CreateTemplateRequest.new(
+  name: null,
+  description: null,
+  template_type: null,
+  parent_folder_id: 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: null,
+  encrypt_pdfs_password: null,
+  expire_submissions: null,
+  expire_after: null,
+  expiration_interval: null,
+  merge_audit_trail_pdf: null,
+  parse_dates_using_template_date_format: null,
+  public_submissions: null,
+  public_web_form: null,
+  redirect_url: null,
+  slack_webhook_url: null,
+  defaults: null,
+  field_dependencies: null,
+  html: null,
+  scss: null,
+  header_html: null,
+  footer_html: null,
+  html_engine_options: null,
+  cache_id: null,
+  filename: null,
+  detect_fields: null,
+  field_source: null,
+  field_naming: null,
+  field_logic: null
+)
+```
+

data/docs/CreateWebhookRequest.md

@@ -0,0 +1,38 @@
+# DocSpring::CreateWebhookRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name for the webhook, shown in the dashboard. | [optional] |
+| **url** | **String** | The endpoint that receives webhook POST requests. |  |
+| **enabled** | **Boolean** | Whether DocSpring sends events to the webhook. Webhooks are disabled after repeated failures. | [optional] |
+| **event_types** | [**Array<WebhookEventType>**](WebhookEventType.md) | The events the webhook subscribes to. A webhook made in the dashboard can also subscribe to API token, account integration and user events, which are listed with their own names. |  |
+| **mode** | [**WebhookMode**](WebhookMode.md) | Only send events for test or live submissions. Null sends both. | [optional] |
+| **api_token_ids** | **Array<String>** | Only send events from these API tokens. Combined with the other scope lists using OR. Applies to submission, signature request, combined PDF, submission batch and custom file events. | [optional] |
+| **template_ids** | **Array<String>** | Only send events for these templates. Combined with the other scope lists using OR. Applies to submission, signature request and template events. | [optional] |
+| **folder_ids** | **Array<String>** | Only send events for templates in these folders, including their subfolders. Combined with the other scope lists using OR. Applies to submission, signature request, template and folder events. | [optional] |
+| **include_submission_data** | **Boolean** | Include the submission's field data in the payload. When false, the submission's data and truncated_text, and each signature request's data, ip_address and user_agent, are null. | [optional] |
+| **strip_fields** | **Array<String>** | Dot-separated paths to remove from the event's data object. Form fields live under `data` (`data.ssn` removes the ssn field). A bare name removes a top-level key (`metadata` removes the whole metadata object). | [optional] |
+| **headers** | **Hash<String, String>** | Headers to send with each request. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::CreateWebhookRequest.new(
+  name: null,
+  url: null,
+  enabled: null,
+  event_types: null,
+  mode: null,
+  api_token_ids: null,
+  template_ids: null,
+  folder_ids: null,
+  include_submission_data: null,
+  strip_fields: null,
+  headers: null
+)
+```
+

data/docs/CustomFile.md

@@ -4,8 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **url** | **String** |  |  |
+| **id** | **String** | The custom file's ID. |  |
+| **download_url** | **String** | A temporary link to download the file. |  |
+| **size** | **Integer** | The file's size in bytes. |  |
+| **content_type** | **String** | The file's media type, such as `application/pdf`. |  |
+| **created_at** | **Time** | When the custom file was created. |  |
+| **updated_at** | **Time** | When the custom file was last updated. |  |
 
 ## Example
 
@@ -14,7 +18,11 @@ require 'docspring'
 
 instance = DocSpring::CustomFile.new(
   id: null,
-  url: null
+  download_url: null,
+  size: null,
+  content_type: null,
+  created_at: null,
+  updated_at: null
 )
 ```