docspring 3.5.0 → 4.1.0

data/docs/TemplateFieldDependencyConditionInput.md

@@ -0,0 +1,93 @@
+# DocSpring::TemplateFieldDependencyConditionInput
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'docspring'
+
+DocSpring::TemplateFieldDependencyConditionInput.openapi_one_of
+# =>
+# [
+#   :'FieldComparisonCondition',
+#   :'FieldEqualsCondition',
+#   :'FieldInCondition',
+#   :'FieldPresenceCondition',
+#   :'FieldRangeCondition'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'docspring'
+
+DocSpring::TemplateFieldDependencyConditionInput.openapi_discriminator_name
+# => :'operator'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'docspring'
+
+DocSpring::TemplateFieldDependencyConditionInput.openapi_discriminator_mapping
+# =>
+# {
+#   :'blank' => :'FieldPresenceCondition',
+#   :'equals' => :'FieldEqualsCondition',
+#   :'gt' => :'FieldComparisonCondition',
+#   :'gte' => :'FieldComparisonCondition',
+#   :'in' => :'FieldInCondition',
+#   :'lt' => :'FieldComparisonCondition',
+#   :'lte' => :'FieldComparisonCondition',
+#   :'not_equals' => :'FieldEqualsCondition',
+#   :'present' => :'FieldPresenceCondition',
+#   :'range' => :'FieldRangeCondition'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'docspring'
+
+DocSpring::TemplateFieldDependencyConditionInput.build(data)
+# => #<FieldComparisonCondition:0x00007fdd4aab02a0>
+
+DocSpring::TemplateFieldDependencyConditionInput.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `FieldComparisonCondition`
+- `FieldEqualsCondition`
+- `FieldInCondition`
+- `FieldPresenceCondition`
+- `FieldRangeCondition`
+- `nil` (if no type matches)
+

data/docs/TemplateFieldDependencyInput.md

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

data/docs/TemplateFieldDependencyMatch.md

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

data/docs/TemplateFieldDependencyOperator.md

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

data/docs/TemplateFieldLogicStatus.md

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

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/TemplateFormMode.md

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

data/docs/TemplateModelCode.md

@@ -0,0 +1,22 @@
+# DocSpring::TemplateModelCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lang** | [**ModelCodeLanguage**](ModelCodeLanguage.md) | The language of `code`. |  |
+| **root_type_name** | **String** | The name of the type for the whole submission data object. |  |
+| **code** | **String** | The source code of the types, starting with `root_type_name`. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateModelCode.new(
+  lang: null,
+  root_type_name: null,
+  code: null
+)
+```
+

data/docs/TemplatePageAiError.md

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

data/docs/TemplatePageAiNamingStatus.md

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

data/docs/TemplatePageFieldsStatus.md

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

data/docs/TemplatePageImageStatus.md

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

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/TemplatePageProcessingStatus.md

@@ -0,0 +1,26 @@
+# DocSpring::TemplatePageProcessingStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image** | [**TemplatePageImageStatus**](TemplatePageImageStatus.md) | The page's image, which the template editor shows. `pending` until it's rendered. |  |
+| **fields** | [**TemplatePageFieldsStatus**](TemplatePageFieldsStatus.md) | Setting up the page's fields: `pending` while they're imported or detected, `naming` while AI names them, then `processed` or `failed`. `disabled` when DocSpring doesn't set up the page's fields. |  |
+| **ai_naming** | [**TemplatePageAiNamingStatus**](TemplatePageAiNamingStatus.md) | `failed` or `skipped` when AI didn't name the page's fields as asked (`ai_error` says why), and the fields kept plain names. Null otherwise. |  |
+| **ai_error** | [**TemplatePageAiError**](TemplatePageAiError.md) | Why AI naming failed or was skipped: `unavailable` (the AI service was unavailable: set up the fields again later), `error`, `credits` (the account had no free AI pages or credits left) or `skipped` (someone skipped AI setup in the template editor). Null when `ai_naming` is. |  |
+| **detected_boxes** | **Array<Array<Float>>** | While AI names the page's fields, the boxes field detection found: `[x, y, width, height]` in PDF points from the page's top-left corner. Null otherwise. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplatePageProcessingStatus.new(
+  image: null,
+  fields: null,
+  ai_naming: null,
+  ai_error: null,
+  detected_boxes: null
+)
+```
+

data/docs/TemplateSourcePdf.md

@@ -0,0 +1,24 @@
+# DocSpring::TemplateSourcePdf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Must be `template`. | [default to 'template'] |
+| **id** | **String** | The ID of the submission, combined PDF, template or custom file. |  |
+| **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::TemplateSourcePdf.new(
+  type: null,
+  id: null,
+  template_version: null,
+  processed: null
+)
+```
+

data/docs/TemplateSummary.md

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

data/docs/TemplateSummaryList.md

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

data/docs/TemplateType.md

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

data/docs/TemplateVersion.md

@@ -0,0 +1,24 @@
+# DocSpring::TemplateVersion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | The version number, such as `1.2.0`. |  |
+| **description** | **String** | What changed in the version, as written when it was published. |  |
+| **published_at** | **Time** | When the version was published. |  |
+| **published_by** | [**TemplateActor**](TemplateActor.md) | Who published the version. Null when that wasn't recorded. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateVersion.new(
+  version: null,
+  description: null,
+  published_at: null,
+  published_by: null
+)
+```
+

data/docs/TemplateVersionType.md

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

data/docs/TextAlignment.md

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

data/docs/TextOverflow.md

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

data/docs/TextVerticalAlignment.md

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

data/docs/Typeface.md

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

data/docs/UpdateSignatureRequestRequest.md

@@ -0,0 +1,34 @@
+# DocSpring::UpdateSignatureRequestRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | **Hash<String, Object>** | Your own data about the signature request, such as an ID from your app. | [optional] |
+| **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] |
+| **auth_session_id_hash** | **String** | A hash of your app's session ID, for the audit trail. | [optional] |
+| **auth_user_id_hash** | **String** | Their user ID in your app, or a SHA-256 hash of a salt and the user ID. | [optional] |
+| **auth_username_hash** | **String** | Their username in your app, or a SHA-256 hash of a salt and the username. | [optional] |
+| **auth_phone_number_hash** | **String** | The phone number they authenticated with, or a SHA-256 hash of a salt and the phone number. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::UpdateSignatureRequestRequest.new(
+  metadata: null,
+  auth_type: null,
+  auth_second_factor_type: null,
+  auth_provider: null,
+  auth_session_started_at: null,
+  auth_session_id_hash: null,
+  auth_user_id_hash: null,
+  auth_username_hash: null,
+  auth_phone_number_hash: null
+)
+```
+