docspring 3.5.0 → 4.1.0

data/docs/HtmlEngineOptions.md

@@ -0,0 +1,36 @@
+# DocSpring::HtmlEngineOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **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`. |  |
+| **margin_bottom** | **String** | The bottom margin, with a unit. |  |
+| **margin_left** | **String** | The left margin, with a unit. |  |
+| **margin_right** | **String** | The right margin, with a unit. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::HtmlEngineOptions.new(
+  format: null,
+  width: null,
+  height: null,
+  scale: null,
+  landscape: null,
+  print_background: null,
+  margin_top: null,
+  margin_bottom: null,
+  margin_left: null,
+  margin_right: null
+)
+```
+

data/docs/HtmlEngineOptionsInput.md

@@ -0,0 +1,36 @@
+# DocSpring::HtmlEngineOptionsInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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] |
+| **margin_bottom** | **String** | The bottom margin, with a unit. | [optional] |
+| **margin_left** | **String** | The left margin, with a unit. | [optional] |
+| **margin_right** | **String** | The right margin, with a unit. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::HtmlEngineOptionsInput.new(
+  format: null,
+  width: null,
+  height: null,
+  scale: null,
+  landscape: null,
+  print_background: null,
+  margin_top: null,
+  margin_bottom: null,
+  margin_left: null,
+  margin_right: null
+)
+```
+

data/docs/ImageGravity.md

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

data/docs/ImageScaleType.md

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

data/docs/ModelCodeLanguage.md

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

data/docs/MoveFolderRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::MoveFolderRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **parent_folder_id** | **String** | The ID of the folder this folder is in. Null for a folder at the root. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::MoveFolderRequest.new(
+  parent_folder_id: null
+)
+```
+

data/docs/MoveTemplateRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::MoveTemplateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **parent_folder_id** | **String** | The folder to move the template and all of its published versions to. Null moves them to the root. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::MoveTemplateRequest.new(
+  parent_folder_id: null
+)
+```
+

data/docs/NumberConditionType.md

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

data/docs/OutputFormat.md

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

data/docs/PageFormat.md

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

data/docs/PageImage.md

@@ -0,0 +1,34 @@
+# DocSpring::PageImage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | The page number, from 1. |  |
+| **width** | **Integer** | The image's width in pixels. |  |
+| **height** | **Integer** | The image's height in pixels. |  |
+| **download_url** | **String** | A temporary link to download the image. A submission's is null when your account turns off download links for submissions. |  |
+| **permanent_url** | **String** | A link to download a submission's image 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 for a template's page images. |  |
+| **filename** | **String** | The image's file name, such as `sub_123_page_1.png`. |  |
+| **content_type** | **String** | The image's media type, `image/png` for a submission's pages or `image/jpeg` for a template's. |  |
+| **size** | **Integer** | The image's size in bytes. |  |
+| **sha256** | **String** | The SHA-256 hash of the image. Null for a template's page images. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::PageImage.new(
+  page: null,
+  width: null,
+  height: null,
+  download_url: null,
+  permanent_url: null,
+  filename: null,
+  content_type: null,
+  size: null,
+  sha256: null
+)
+```
+

data/docs/PageImages.md

@@ -0,0 +1,24 @@
+# DocSpring::PageImages
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **state** | [**GeneratedFileState**](GeneratedFileState.md) | `processed` once the images have been made, with the PDF or by POST /submissions/{submission_id}/generate_files. `pending` until then, and `error` if they couldn't be made (see `error_message`). |  |
+| **error_message** | **String** | Why the images couldn't be made, when `state` is `error`. |  |
+| **page_count** | **Integer** | How many pages have an image. Null until the images have been made. |  |
+| **pages** | [**Array<PageImage>**](PageImage.md) | An image of each page, in order: `pages[0]` is page 1. Lists of submissions leave it out (null): get the submission to see them. Empty until the images have been made. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::PageImages.new(
+  state: null,
+  error_message: null,
+  page_count: null,
+  pages: null
+)
+```
+

data/docs/PredefinedField.md

@@ -0,0 +1,30 @@
+# DocSpring::PredefinedField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The field's name, the key of its value in submission data. A `/` nests the key in objects and arrays (`customer/email`, `signers/0/name`). |  |
+| **display_name** | **String** | The name the template editor shows instead of `name`, where a `/` puts it in a folder, such as `Defendant/Name`. Null shows `name`. Two names can't share a display name. | [optional] |
+| **title** | **String** | The Title setting a field gets when it's given this name. Null leaves the field's title as it is. | [optional] |
+| **type** | [**FieldType**](FieldType.md) | The data type a field gets when it's given this name, as a field's `type`. |  |
+| **option_list** | **String** | String fields only: the values allowed, separated by commas, such as `Yes,No`. Null allows any value. | [optional] |
+| **required_in_template** | **Boolean** | Whether the template must have a field with this name. The embedded editor shows the names that are missing, and with `disableDoneButtonIfPredefinedFieldsMissing` keeps its Done button disabled until the template has them. Default false. | [optional] |
+| **field_required** | **Boolean** | The Required setting a field gets when it's given this name. Default true. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::PredefinedField.new(
+  name: null,
+  display_name: null,
+  title: null,
+  type: null,
+  option_list: null,
+  required_in_template: null,
+  field_required: null
+)
+```
+

data/docs/PredefinedFieldInput.md

@@ -0,0 +1,30 @@
+# DocSpring::PredefinedFieldInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The field's name, the key of its value in submission data. A `/` nests the key in objects and arrays (`customer/email`, `signers/0/name`). |  |
+| **display_name** | **String** | The name the template editor shows instead of `name`, where a `/` puts it in a folder, such as `Defendant/Name`. Null shows `name`. Two names can't share a display name. | [optional] |
+| **title** | **String** | The Title setting a field gets when it's given this name. Null leaves the field's title as it is. | [optional] |
+| **type** | [**FieldType**](FieldType.md) | The data type a field gets when it's given this name, as a field's `type`. |  |
+| **option_list** | **String** | String fields only: the values allowed, separated by commas, such as `Yes,No`. Null allows any value. | [optional] |
+| **required_in_template** | **Boolean** | Whether the template must have a field with this name. The embedded editor shows the names that are missing, and with `disableDoneButtonIfPredefinedFieldsMissing` keeps its Done button disabled until the template has them. Default false. | [optional] |
+| **field_required** | **Boolean** | The Required setting a field gets when it's given this name. Default true. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::PredefinedFieldInput.new(
+  name: null,
+  display_name: null,
+  title: null,
+  type: null,
+  option_list: null,
+  required_in_template: null,
+  field_required: null
+)
+```
+

data/docs/PublishTemplateVersionRequest.md

@@ -0,0 +1,20 @@
+# DocSpring::PublishTemplateVersionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version_type** | [**TemplateVersionType**](TemplateVersionType.md) | Which part of the latest version number to increase. |  |
+| **description** | **String** | What changed in the version, shown with it in DocSpring. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::PublishTemplateVersionRequest.new(
+  version_type: null,
+  description: null
+)
+```
+

data/docs/RemoveTemplateFieldsRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::RemoveTemplateFieldsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_ids** | **Array<Integer>** | The IDs of the fields to remove. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::RemoveTemplateFieldsRequest.new(
+  field_ids: null
+)
+```
+

data/docs/RenameFolderRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::RenameFolderRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The folder's name. It can't contain `/`, and is unique within its parent folder. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::RenameFolderRequest.new(
+  name: null
+)
+```
+

data/docs/ReorderTemplateFieldsRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::ReorderTemplateFieldsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_ids** | **Array<Integer>** | The ID of every field, in the new order. Each field stays on its page, and a page's fields take the order their IDs have here: the order they're printed in (a later field prints over an earlier one where they overlap), and the order of their values in the template's data schema and forms. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::ReorderTemplateFieldsRequest.new(
+  field_ids: null
+)
+```
+

data/docs/RestoreTemplateVersionRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::RestoreTemplateVersionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | The published version to restore to the draft (`1.2.0`, or `1` for the latest 1.x.x). |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::RestoreTemplateVersionRequest.new(
+  version: null
+)
+```
+

data/docs/ShapeType.md

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

data/docs/SignatureRequest.md

@@ -0,0 +1,66 @@
+# DocSpring::SignatureRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **completed_at** | **Time** | When they completed it. |  |
+| **declined_at** | **Time** | When they declined it. |  |
+| **auth_type** | [**SignatureRequestAuthType**](SignatureRequestAuthType.md) | How your app authenticated the person before it showed them the signature request. |  |
+| **auth_second_factor_type** | [**SignatureRequestAuthSecondFactorType**](SignatureRequestAuthSecondFactorType.md) | The second factor your app authenticated them with, if any. |  |
+| **auth_provider** | **String** | The service that authenticated them, such as `google`. Required when `auth_type` is `oauth`. |  |
+| **auth_session_started_at** | **Time** | When your app authenticated them. Set for you with `email_link`. |  |
+| **auth_session_id_hash** | **String** | A hash of your app's session ID, for the audit trail. |  |
+| **auth_user_id_hash** | **String** | Their user ID in your app, or a SHA-256 hash of a salt and the user ID. |  |
+| **auth_username_hash** | **String** | Their username in your app, or a SHA-256 hash of a salt and the username. |  |
+| **auth_phone_number_hash** | **String** | The phone number they authenticated with, or a SHA-256 hash of a salt and the phone number. |  |
+| **ip_address** | **String** | The IP address they completed the signature request from. Null in the events of a webhook that leaves out submission data. |  |
+| **user_agent** | **String** | The User-Agent header of the browser they completed the signature request with. Null in the events of a webhook that leaves out submission data. |  |
+| **created_at** | **Time** | When the signature request was created. |  |
+| **updated_at** | **Time** | When the signature request was last updated. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SignatureRequest.new(
+  id: null,
+  submission_id: null,
+  name: null,
+  email: null,
+  fields: null,
+  metadata: null,
+  role: null,
+  sort_order: null,
+  state: null,
+  data: null,
+  viewed_at: null,
+  completed_at: null,
+  declined_at: 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,
+  ip_address: null,
+  user_agent: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/SignatureRequestAuthSecondFactorType.md

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

data/docs/SignatureRequestAuthType.md

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

data/docs/SignatureRequestEvent.md

@@ -0,0 +1,32 @@
+# DocSpring::SignatureRequestEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The event's ID. |  |
+| **submission_id** | **String** | The ID of the signature request's submission. |  |
+| **signature_request_id** | **String** | The ID of the signature request. |  |
+| **event_type** | [**SignatureRequestEventType**](SignatureRequestEventType.md) | What happened. |  |
+| **message_type** | [**SignatureRequestMessageType**](SignatureRequestMessageType.md) | How you sent the request. Required for `send_request`. |  |
+| **message_recipient** | **String** | Where you sent the request, such as an email address or a phone number. Required for `send_request`. |  |
+| **occurred_at** | **Time** | When it happened. Default now. |  |
+| **created_at** | **Time** | When the event was recorded. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SignatureRequestEvent.new(
+  id: null,
+  submission_id: null,
+  signature_request_id: null,
+  event_type: null,
+  message_type: null,
+  message_recipient: null,
+  occurred_at: null,
+  created_at: null
+)
+```
+

data/docs/SignatureRequestEventType.md

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

data/docs/SignatureRequestInput.md

@@ -0,0 +1,46 @@
+# DocSpring::SignatureRequestInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the person the request is for. | [optional] |
+| **email** | **String** | Their email address. | [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_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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SignatureRequestInput.new(
+  name: null,
+  email: null,
+  fields: null,
+  metadata: null,
+  role: 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,
+  ignore_unknown_fields: null,
+  prefilled_values_editable: null
+)
+```
+

data/docs/SignatureRequestMessageType.md

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