docspring 3.5.0 → 4.1.0

data/docs/UpdateTemplateDocumentRequest.md

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

data/docs/UpdateTemplateFieldsRequest.md

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

data/docs/UpdateTemplateRequest.md

@@ -0,0 +1,86 @@
+# DocSpring::UpdateTemplateRequest
+
+## 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] |
+| **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] |
+| **field_groups** | [**Array<FieldGroupInput>**](FieldGroupInput.md) | Changes to the settings of the template's field groups, each with the `name` of the group it changes. Settings left out keep their values, and groups left out are unchanged. | [optional] |
+| **predefined_fields** | [**Array<PredefinedFieldInput>**](PredefinedFieldInput.md) | The field names that people using the embedded template editor choose from, each with the data type and settings a field gets when it's given that name. Setting it replaces the whole list; an empty list turns them off. | [optional] |
+| **predefined_fields_sample_data** | **Hash<String, Object>** | Sample submission data that sets `predefined_fields`: each value becomes a predefined field, with a type that fits it (`string`, `number`, `boolean`, `date`, `email` or `url`) and `required_in_template` true. Nested objects and arrays become names with `/`, such as `customer/email`. Without `predefined_fields` in the same request, it replaces them; with them, it adds to them and sets the types of the ones it has values for. | [optional] |
+| **html** | **String** | The HTML of an HTML template, as a Liquid template. Null for PDF templates. | [optional] |
+| **scss** | **String** | The SCSS of an HTML template. | [optional] |
+| **header_html** | **String** | The HTML printed at the top of each page of an HTML template. | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::UpdateTemplateRequest.new(
+  name: null,
+  description: 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,
+  field_groups: null,
+  predefined_fields: null,
+  predefined_fields_sample_data: null,
+  html: null,
+  scss: null,
+  header_html: null,
+  footer_html: null,
+  html_engine_options: null
+)
+```
+

data/docs/UpdateWebhookRequest.md

@@ -0,0 +1,38 @@
+# DocSpring::UpdateWebhookRequest
+
+## 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. | [optional] |
+| **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. | [optional] |
+| **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::UpdateWebhookRequest.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/UploadMethod.md

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

data/docs/UploadPresign.md

@@ -0,0 +1,24 @@
+# DocSpring::UploadPresign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The S3 URL to upload the file to. |  |
+| **method** | [**UploadMethod**](UploadMethod.md) | The HTTP method for the upload. |  |
+| **fields** | **Hash<String, String>** | Form fields to send with the file. Send them all, as they are. `key` is the uploaded file's ID: pass it as `cache_id`. |  |
+| **headers** | **Hash<String, String>** | Headers to send with the upload. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::UploadPresign.new(
+  url: null,
+  method: null,
+  fields: null,
+  headers: null
+)
+```
+

data/docs/UrlSourcePdf.md

@@ -0,0 +1,20 @@
+# DocSpring::UrlSourcePdf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Must be `url`. | [default to 'url'] |
+| **url** | **String** | For a `url` source, the URL to download the PDF from. Removed once the combined PDF has expired. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::UrlSourcePdf.new(
+  type: null,
+  url: null
+)
+```
+

data/docs/ValidateSubmissionRequest.md

@@ -0,0 +1,38 @@
+# DocSpring::ValidateSubmissionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **test** | **Boolean** | Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions. | [optional] |
+| **editable** | **Boolean** | `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`. | [optional] |
+| **data** | **Hash<String, Object>** | The values of the template's fields, by field name. Required for a PDF template, unless `signature_requests` collects the values. | [optional] |
+| **metadata** | **Hash<String, Object>** | Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. | [optional] |
+| **password** | **String** | A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. | [optional] |
+| **output_formats** | [**Array<OutputFormat>**](OutputFormat.md) | What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission. | [optional] |
+| **expires_in** | **Integer** | Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours. | [optional] |
+| **field_overrides** | [**Hash<String, FieldOverride>**](FieldOverride.md) | Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. With `signature_requests`, `editable: true` is a 422, and a `default` for a signature or initials field makes the submission `invalid_data`. | [optional] |
+| **html** | **String** | For an HTML template, HTML to use instead of the template's. | [optional] |
+| **css** | **String** | For an HTML template, CSS to use instead of the template's. | [optional] |
+| **signature_requests** | [**Array<SignatureRequestInput>**](SignatureRequestInput.md) | The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF templates only. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out. Only the signers sign: a value for a signature or initials field in `data` makes the submission `invalid_data`. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::ValidateSubmissionRequest.new(
+  test: null,
+  editable: null,
+  data: null,
+  metadata: null,
+  password: null,
+  output_formats: null,
+  expires_in: null,
+  field_overrides: null,
+  html: null,
+  css: null,
+  signature_requests: null
+)
+```
+

data/docs/Webhook.md

@@ -4,26 +4,26 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **name** | **String** |  |  |
-| **url** | **String** |  |  |
-| **enabled** | **Boolean** |  |  |
-| **event_types** | **Array<String>** |  |  |
-| **mode** | **String** |  |  |
-| **version** | **Integer** |  |  |
-| **api_token_ids** | **Array<String>** |  |  |
-| **template_ids** | **Array<String>** |  |  |
-| **folder_ids** | **Array<String>** |  |  |
-| **include_submission_data** | **Boolean** |  |  |
-| **strip_fields** | **Array<String>** |  |  |
-| **headers** | **Hash<String, String>** |  |  |
-| **consecutive_failures** | **Integer** |  |  |
-| **last_failure_at** | **String** |  |  |
-| **disabled_at** | **String** |  |  |
-| **disabled_reason** | **String** |  |  |
-| **secret** | **String** |  |  |
-| **created_at** | **String** |  |  |
-| **updated_at** | **String** |  |  |
+| **id** | **String** | The webhook's ID. |  |
+| **name** | **String** | A name for the webhook, shown in the dashboard. |  |
+| **url** | **String** | The endpoint that receives webhook POST requests. |  |
+| **enabled** | **Boolean** | Whether DocSpring sends events to the webhook. Webhooks are disabled after repeated failures. |  |
+| **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. |  |
+| **version** | **Integer** | The format of the requests DocSpring sends. Webhooks created with API v2 use 4: each event's `data` is the resource as API v2 returns it. Webhooks made in the dashboard or with API v1 use 3, which has API v1's resources and names (`combined_submission`, `submission_data_request`). Versions 1 and 2 are legacy formats for submission events. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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). |  |
+| **headers** | **Hash<String, String>** | Headers to send with each request. |  |
+| **consecutive_failures** | **Integer** | How many deliveries in a row have failed. |  |
+| **last_failure_at** | **Time** | When a delivery last failed. |  |
+| **disabled_at** | **Time** | When the webhook was disabled. Null while it is enabled. |  |
+| **disabled_reason** | **String** | Why the webhook was disabled, such as after repeated failures. |  |
+| **secret** | **String** | The key that signs each request (the X-DocSpring-Signature header), so you can check that a request came from DocSpring. Null for some webhooks created before signing existed. |  |
+| **created_at** | **Time** | When the webhook was created. |  |
+| **updated_at** | **Time** | When the webhook was last updated. |  |
 
 ## Example
 

data/docs/WebhookEventType.md

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

data/docs/WebhookList.md

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

data/docs/WebhookMode.md

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

data/docspring.gemspec

@@ -3,12 +3,12 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: v2
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.16.0-DOCSPRING
+Generator version: 7.26.0-DOCSPRING
 
 =end