docspring 4.0.0 → 4.2.0

data/docs/FieldInput.md

@@ -0,0 +1,196 @@
+# DocSpring::FieldInput
+
+## 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 (`client/address`, `items/0/price`); write a literal `/` as `~1` and `~` as `~0`. Fields with the same name share one value and their shared settings, and array indexes inside a name are ignored for settings, so `items/0/price` and `items/1/price` share settings but not values. A `#` and a line number (`notes#0`, `notes#1`) splits one value over several fields as lines of text, and names that start with `@@` print submission details such as `@@date`. | [optional] |
+| **page** | **Integer** | The number of the page the field is on, starting at 1. A field added without one goes on page 1, and a field moved to another page without a new `y` keeps its place on the page. | [optional] |
+| **type** | [**FieldType**](FieldType.md) | The data type of the field's value: `string`, `number`, `boolean`, `date`, `address`, `country`, `email`, `url`, `image`, `signature`, `initials`, `barcode`, or `combined` (made from other fields' values, never sent in submission data). It sets how the value is validated and which `display_type`s the field can use. `object` and `array` are the types of field groups (the template's `field_groups`), not of fields. Shared by every field with the same `name`. | [optional] |
+| **static** | **Boolean** | The field prints fixed content, its `default`, instead of a value from submission data, and it's left out of the template's data schema and forms. Static check marks and shapes always print unless `hidden`, and a static number field's `default` can be a formula. Shared by every field with the same `name`. | [optional] |
+| **editable** | **Boolean** | Text and check display only: prints the field as a fillable PDF form field instead of flat content (a text field with an `option_list` becomes a dropdown). A submission's `editable` option, when set, overrides this for every field. Shared by every field with the same `name`. | [optional] |
+| **default** | **String** | The value used when a submission leaves the field out, and the value forms are pre-filled with. A required field still needs a value in each submission. An image field's default is an image URL, a number field's can be a formula, and a static field's is the content it prints. Shared by every field with the same `name`. | [optional] |
+| **title** | **String** | The field's title in the template's data schema and on forms. When it's empty, a title is made from the field's name. Shared by every field with the same `name`. | [optional] |
+| **description** | **String** | Help text for the field, added to the template's data schema and shown on forms. Shared by every field with the same `name`. | [optional] |
+| **placeholder** | **String** | Placeholder text for the field's input on forms, added to the template's data schema as `x-placeholder`. Shared by every field with the same `name`. | [optional] |
+| **metadata** | **String** | Text for your own use, added to the template's data schema as `x-metadata`. DocSpring doesn't use it. Shared by every field with the same `name`. | [optional] |
+| **required** | **Boolean** | Whether each submission must include a value for the field. A submission without one fails validation, and no PDF is generated. Shared by every field with the same `name`. | [optional] |
+| **option_list** | **String** | String fields only: a comma-separated list of the values the field accepts. It's added to the template's data schema as an `enum`, forms show it as a select list, and an `editable` field becomes a dropdown. Shared by every field with the same `name`. | [optional] |
+| **combined_field_names** | **String** | Combined fields only: a comma-separated list of the names of the fields whose values are combined, in order. Shared by every field with the same `name`. | [optional] |
+| **combined_field_type** | [**CombinedFieldType**](CombinedFieldType.md) | Combined fields only: `separator` joins the values with `combined_field_separator`, and `format` puts them into `combined_field_format`. Shared by every field with the same `name`. | [optional] |
+| **combined_field_separator** | **String** | Combined fields only: the text placed between the values when `combined_field_type` is `separator`. Empty values are skipped. Defaults to a space. Shared by every field with the same `name`. | [optional] |
+| **combined_field_format** | **String** | Combined fields only: the text for `combined_field_type` `format`, where `$0`, `$1` and so on are replaced with the values of `combined_field_names` in order, such as `Full name: $0, Occupation: $1`. Shared by every field with the same `name`. | [optional] |
+| **integer** | **Boolean** | Number fields only: the value must be a whole number. Shared by every field with the same `name`. | [optional] |
+| **minimum** | **Float** | Number fields only: the smallest value allowed. Shared by every field with the same `name`. | [optional] |
+| **maximum** | **Float** | Number fields only: the largest value allowed. Shared by every field with the same `name`. | [optional] |
+| **exclusive_minimum** | **Boolean** | Number fields only: the value must be greater than `minimum`, not equal to it. Shared by every field with the same `name`. | [optional] |
+| **exclusive_maximum** | **Boolean** | Number fields only: the value must be less than `maximum`, not equal to it. Shared by every field with the same `name`. | [optional] |
+| **include_time** | **Boolean** | Date fields only: the value is a date and time (`YYYY-MM-DDThh:mm:ss.fffZ`) instead of a date (`YYYY-MM-DD`), and it prints with the template's date-time format unless `date_time_format` is set. Shared by every field with the same `name`. | [optional] |
+| **signature_allow_draw** | **Boolean** | Signature and initials fields only: lets signers draw their signature on forms and in data requests. Shared by every field with the same `name`. | [optional] |
+| **signature_allow_type** | **Boolean** | Signature and initials fields only: lets signers type their name and choose a script font instead of drawing, on forms and in data requests. Shared by every field with the same `name`. | [optional] |
+| **barcode_symbology** | [**BarcodeSymbology**](BarcodeSymbology.md) | Barcode fields only: the barcode format, which the value must match. `code_128` and `pdf417` take any ASCII text; `code_39` and `code_93` take capital letters, digits, spaces and `- . $ / + %`; `code_25` takes digits; `ean_13` takes 12 digits, `ean_8` 7 digits and `upc_a` 11 digits (the check digit is added). Shared by every field with the same `name`. | [optional] |
+| **hidden** | **Boolean** | Leaves the field off the PDF. It stays in the template's data schema (marked `x-hidden`) and on forms, so other fields, such as combined fields, can use its value. A hidden static check mark or shape isn't printed. | [optional] |
+| **x** | **Float** | The distance from the page's left edge to the field's left edge. Positions and sizes are in units where every page is 2480 wide: one unit is the page's width in points divided by 2480 (about 0.247 points on a US Letter page). | [optional] |
+| **y** | **Float** | The distance from the top edge of the field's `page` down to the field's top edge, in the units of `x`. A page is 2480 times its height divided by its width units tall: about 3209 for US Letter and 3508 for A4. | [optional] |
+| **width** | **Float** | The field's width, in the units of `x`. A check mark is sized to the field's width. | [optional] |
+| **height** | **Float** | The field's height, in the units of `x`. The template editor keeps check marks, QR codes, and square and circle shapes square, with `height` equal to `width`. | [optional] |
+| **rotation** | **Float** | Rotates the field clockwise by this many degrees, from -360 to 360 (negative turns it counterclockwise). | [optional] |
+| **display_type** | [**FieldDisplayType**](FieldDisplayType.md) | How the value appears on the PDF: `text`, `check` (a check mark), `shape`, `qrcode`, `barcode`, or `image` (image, signature and initials fields). Check marks and shapes print only when the value meets the field's `condition`, and the field's `type` limits which display types it can use. | [optional] |
+| **opacity** | **Float** | The opacity of the field's content and background, from 0 (invisible) to 1. QR codes and barcodes always print at full opacity. | [optional] |
+| **date_time_format** | **String** | Date fields only: how the date prints, as a strftime format such as `%m/%d/%Y`, or a calculation such as `@years_since`, `@years_until` or `@diff_years` (also months, weeks, days, hours, minutes and seconds), counted to when the PDF is generated. Empty uses the template's date format, or its date-time format with `include_time`. | [optional] |
+| **typeface** | [**Typeface**](Typeface.md) | Text display only: the font, one of `Helvetica`, `Arial`, `Calibri`, `Open Sans`, `Roboto`, `Lato`, `Poppins`, `Public Sans`, `Questrial`, `Times New Roman`, `Dancing Script`, `Lovtony Script`, or the monospace `Courier`, `Inconsolata`, `Menlo`, `Roboto Mono` and `Ubuntu Mono`. Empty uses the template's default typeface. | [optional] |
+| **font_size** | **Integer** | Text display only: the font size in points. Empty uses the template's default font size. | [optional] |
+| **character_spacing** | **Float** | Text display only: extra space between characters, in points. Empty uses the template's default. | [optional] |
+| **bold** | **Boolean** | Text display only: prints the text in bold. | [optional] |
+| **uppercase** | **Boolean** | Text display only: prints the text in capital letters. | [optional] |
+| **strikethrough** | **Boolean** | Text display only: draws a line through the text. | [optional] |
+| **keep_leading_spaces** | **Boolean** | Text display only: keeps the spaces at the start of the text and of each line, so text can be lined up with spaces. | [optional] |
+| **overflow** | [**TextOverflow**](TextOverflow.md) | Text display only: what happens to text that doesn't fit the field. `shrink_to_fit` makes the font smaller, down to 5 points; `truncate` cuts the text off and returns the rest in the submission's `truncated_text`. | [optional] |
+| **multiline** | **Boolean** | Text display only: wraps the text over as many lines as fit in the field's height instead of printing one line, and forms show a multi-line input. | [optional] |
+| **multiline_lines** | **Integer** | Text display only, with `multiline`: spreads the text over exactly this many evenly spaced lines in the field's height (up to 300), to line up with lines printed on the form. Empty uses the font's normal line spacing. | [optional] |
+| **min_length** | **Float** | Text display only: the fewest characters the value can have, added to the template's data schema. Not used for date, address, country or number fields, or fields with an `option_list`. | [optional] |
+| **max_length** | **Integer** | Text display only: the most characters the value can have, added to the template's data schema; it also limits an `editable` field. Not used for date, address, country or number fields, or fields with an `option_list`. | [optional] |
+| **auto_calculate_max_length** | **Boolean** | Text display only, with a monospace `typeface` (`Courier`, `Inconsolata`, `Menlo`, `Roboto Mono` or `Ubuntu Mono`): adds the number of characters that fit in the field to the template's data schema as its maximum length. | [optional] |
+| **color** | **String** | Text display only: the text color, as a hex code such as `444444`. Empty uses the template's default text color. | [optional] |
+| **color_field_name** | **String** | Text display only: the name of a data field whose value, a hex code such as `FF0000`, sets the text color for each submission. That field is added to the template's data schema, with `color` as its default. | [optional] |
+| **color_field_required** | **Boolean** | Makes the `color_field_name` field required. When it isn't required and a submission leaves it out, `color` is used. | [optional] |
+| **background_color** | **String** | Text and check display only: a color that fills the field's area behind its content, as a hex code, to cover what the page shows there. Check fields print it even when unchecked; text fields print it only when they have a value. | [optional] |
+| **background_color_field_name** | **String** | Text and check display only: the name of a data field whose value, a hex code, sets the background color for each submission. That field is added to the template's data schema, with `background_color` as its default. | [optional] |
+| **background_color_field_required** | **Boolean** | Makes the `background_color_field_name` field required. When it isn't required and a submission leaves it out, `background_color` is used. | [optional] |
+| **alignment** | [**TextAlignment**](TextAlignment.md) | Text display only: how the text is aligned across the field: `left`, `center`, `right` or `justify` (both edges of every line of multiline text except the last of each paragraph). | [optional] |
+| **v_alignment** | [**TextVerticalAlignment**](TextVerticalAlignment.md) | Text display only: how the text is aligned vertically in the field: `bottom`, `center` or `top`. | [optional] |
+| **comb** | **Boolean** | Text display only: splits the field into `comb_number_of_cells` boxes of equal width and prints one character, centered, in each. | [optional] |
+| **comb_number_of_cells** | **Integer** | With `comb`: how many boxes the field has. The value's maximum length in the template's data schema is this plus `comb_value_offset`. | [optional] |
+| **comb_value_offset** | **Integer** | With `comb`: the position, from 0, of the first character of the value that this field prints. For an SSN printed in boxes of 3, 2 and 4 digits, three fields named `ssn` use offsets 0, 3 and 5. | [optional] |
+| **shape_type** | [**ShapeType**](ShapeType.md) | Shape display only: `square`, `rectangle`, `circle`, `ellipse`, `triangle` or `polygon`. A square or circle uses the smaller of `width` and `height`. | [optional] |
+| **shape_sides** | **Integer** | Shape display only, with `shape_type` `polygon`: the number of sides, 3 to 12. | [optional] |
+| **shape_border_width** | **Integer** | Shape display only: the width of the shape's border, in points. | [optional] |
+| **shape_border_color** | **String** | Shape display only: the shape's border color, as a hex code. Null draws no border. | [optional] |
+| **shape_border_color_field_name** | **String** | Shape display only: the name of a data field whose value, a hex code, sets the border color for each submission. That field is added to the template's data schema, with `shape_border_color` as its default. | [optional] |
+| **shape_border_color_field_required** | **Boolean** | Makes the `shape_border_color_field_name` field required. When it isn't required and a submission leaves it out, `shape_border_color` is used. | [optional] |
+| **shape_fill_color** | **String** | Shape display only: the color that fills the shape, as a hex code. Null leaves it unfilled. | [optional] |
+| **shape_fill_color_field_name** | **String** | Shape display only: the name of a data field whose value, a hex code, sets the fill color for each submission. That field is added to the template's data schema, with `shape_fill_color` as its default. | [optional] |
+| **shape_fill_color_field_required** | **Boolean** | Makes the `shape_fill_color_field_name` field required. When it isn't required and a submission leaves it out, `shape_fill_color` is used. | [optional] |
+| **check_character** | [**CheckCharacter**](CheckCharacter.md) | Check display only: the character printed, as an HTML entity: `✓` (✓), `✔` (✔, the default), `✖` (✖), `✗` (✗) or `✘` (✘). | [optional] |
+| **check_color** | **String** | Check display only: the check mark's color, as a hex code. Empty uses the template's default check color. | [optional] |
+| **check_color_field_name** | **String** | Check display only: the name of a data field whose value, a hex code, sets the check mark's color for each submission. That field is added to the template's data schema, with `check_color` as its default. | [optional] |
+| **check_color_field_required** | **Boolean** | Makes the `check_color_field_name` field required. When it isn't required and a submission leaves it out, `check_color` is used. | [optional] |
+| **qrcode_color** | **String** | QR code display only: the QR code's color, as a hex code, printed on a white background. Empty prints it in black. | [optional] |
+| **qrcode_color_field_name** | **String** | QR code display only: the name of a data field whose value, a hex code, sets the QR code's color for each submission. That field is added to the template's data schema, with `qrcode_color` as its default. | [optional] |
+| **qrcode_color_field_required** | **Boolean** | Makes the `qrcode_color_field_name` field required. When it isn't required and a submission leaves it out, `qrcode_color` is used. | [optional] |
+| **true_text** | **String** | Boolean fields with text display: the text printed when the value is `true`. Empty uses the template's `true_text`; when neither is set, nothing prints. | [optional] |
+| **false_text** | **String** | Boolean fields with text display: the text printed when the value is `false`. Empty uses the template's `false_text`; when neither is set, nothing prints. | [optional] |
+| **condition** | **String** | Check and shape display only: the value a string or number field's value is compared with, by `string_condition_type` or `number_condition_type`, to decide whether the check mark or shape prints. Boolean fields print when `true` (see `invert_boolean_condition`), and other types print when they have a value. | [optional] |
+| **string_condition_type** | [**StringConditionType**](StringConditionType.md) | String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression the value must match. | [optional] |
+| **number_condition_type** | [**NumberConditionType**](NumberConditionType.md) | Number fields with check or shape display: how the value is compared with `condition`: `equals`, `gt` (greater than), `gte` (greater than or equal to), `lt` (less than), `lte` (less than or equal to), or `range`, between `number_condition_range_min` and `number_condition_range_max`. | [optional] |
+| **number_condition_range_min** | **Float** | With `number_condition_type` `range`: the lower end of the range, included unless `number_condition_range_exclusive_min` is set. | [optional] |
+| **number_condition_range_max** | **Float** | With `number_condition_type` `range`: the upper end of the range, included unless `number_condition_range_exclusive_max` is set. | [optional] |
+| **number_condition_range_exclusive_min** | **Boolean** | With `number_condition_type` `range`: leaves `number_condition_range_min` itself out of the range. | [optional] |
+| **number_condition_range_exclusive_max** | **Boolean** | With `number_condition_type` `range`: leaves `number_condition_range_max` itself out of the range. | [optional] |
+| **invert_boolean_condition** | **Boolean** | Boolean fields with check or shape display: prints the check mark or shape when the value is `false` or missing, instead of `true`. | [optional] |
+| **currency** | **Boolean** | Number fields only: forms show a currency input, and the template's data schema gives the field `format: currency`. It doesn't change how the number prints. | [optional] |
+| **decimal_places** | **Integer** | Number fields with text display: prints the number with this many decimal places, from 0 (rounds to a whole number) to 99. Empty prints the number as it was sent. | [optional] |
+| **image_scale_type** | [**ImageScaleType**](ImageScaleType.md) | Image fields only: how the image is resized to the field. `fit` keeps its proportions and fits it inside the field, which can leave empty space; `fill` keeps its proportions and crops it to fill the field; `stretch` stretches it to the field's size. Signatures and initials always fit. | [optional] |
+| **image_gravity** | [**ImageGravity**](ImageGravity.md) | Image, signature and initials fields: where the image sits in the field with `fit`, or which part is kept with `fill`: `NorthWest` (top left), `North`, `NorthEast`, `West`, `Center`, `East`, `SouthWest`, `South` or `SouthEast` (bottom right). It also aligns typed signatures, and isn't used with `stretch`. | [optional] |
+| **dependencies** | [**FieldDependencyInput**](FieldDependencyInput.md) | The field's own conditional logic rule: when other fields' values meet its conditions, the field is shown, made required, or both. Null when it has none. The template's rules (`field_dependencies`) can apply to the field too. Shared by every field with the same `name`. | [optional] |
+| **id** | **Integer** | The field's ID. Required when updating a field. When adding one, leave it out for the next free ID. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::FieldInput.new(
+  name: null,
+  page: null,
+  type: null,
+  static: null,
+  editable: null,
+  default: null,
+  title: null,
+  description: null,
+  placeholder: null,
+  metadata: null,
+  required: null,
+  option_list: null,
+  combined_field_names: null,
+  combined_field_type: null,
+  combined_field_separator: null,
+  combined_field_format: null,
+  integer: null,
+  minimum: null,
+  maximum: null,
+  exclusive_minimum: null,
+  exclusive_maximum: null,
+  include_time: null,
+  signature_allow_draw: null,
+  signature_allow_type: null,
+  barcode_symbology: null,
+  hidden: null,
+  x: null,
+  y: null,
+  width: null,
+  height: null,
+  rotation: null,
+  display_type: null,
+  opacity: null,
+  date_time_format: null,
+  typeface: null,
+  font_size: null,
+  character_spacing: null,
+  bold: null,
+  uppercase: null,
+  strikethrough: null,
+  keep_leading_spaces: null,
+  overflow: null,
+  multiline: null,
+  multiline_lines: null,
+  min_length: null,
+  max_length: null,
+  auto_calculate_max_length: null,
+  color: null,
+  color_field_name: null,
+  color_field_required: null,
+  background_color: null,
+  background_color_field_name: null,
+  background_color_field_required: null,
+  alignment: null,
+  v_alignment: null,
+  comb: null,
+  comb_number_of_cells: null,
+  comb_value_offset: null,
+  shape_type: null,
+  shape_sides: null,
+  shape_border_width: null,
+  shape_border_color: null,
+  shape_border_color_field_name: null,
+  shape_border_color_field_required: null,
+  shape_fill_color: null,
+  shape_fill_color_field_name: null,
+  shape_fill_color_field_required: null,
+  check_character: null,
+  check_color: null,
+  check_color_field_name: null,
+  check_color_field_required: null,
+  qrcode_color: null,
+  qrcode_color_field_name: null,
+  qrcode_color_field_required: null,
+  true_text: null,
+  false_text: null,
+  condition: null,
+  string_condition_type: null,
+  number_condition_type: null,
+  number_condition_range_min: null,
+  number_condition_range_max: null,
+  number_condition_range_exclusive_min: null,
+  number_condition_range_exclusive_max: null,
+  invert_boolean_condition: null,
+  currency: null,
+  decimal_places: null,
+  image_scale_type: null,
+  image_gravity: null,
+  dependencies: null,
+  id: null
+)
+```
+

data/docs/FieldType.md

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

data/docs/GenerateFilesFormat.md

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

data/docs/GenerateSubmissionFilesRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::GenerateSubmissionFilesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **formats** | [**Array<GenerateFilesFormat>**](GenerateFilesFormat.md) | The formats to add to the submission's files: `png`, an image of each page of the submission's PDF (up to 100 pages). A format the submission already has (or is making) is left as it is. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::GenerateSubmissionFilesRequest.new(
+  formats: null
+)
+```
+

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

@@ -13,21 +13,22 @@
 | **state** | [**SubmissionState**](SubmissionState.md) | `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`. |  |
 | **test** | **Boolean** | Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions. |  |
 | **editable** | **Boolean** | `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`. |  |
-| **data** | **Hash<String, Object>** | The submission's data, with the values entered in completed signature requests. Lists leave it out (null) unless you pass `include_data=true`. Empty once the submission has expired. |  |
+| **data** | **Hash<String, Object>** | The submission's data, with the values entered in completed signature requests. Empty once the submission has expired. Null in a batch's submissions unless you pass `include_data=true`, and in the events of a webhook that leaves out submission data. |  |
 | **data_errors** | [**Array<ErrorDetail>**](ErrorDetail.md) | Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired. |  |
 | **error_message** | **String** | Why the PDF couldn't be generated, when `state` is `error`. |  |
-| **metadata** | **Hash<String, Object>** | Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. |  |
-| **has_password** | **Boolean** | Whether the PDF needs a password to open (`password`). |  |
-| **signature_requests** | [**Array<SignatureRequest>**](SignatureRequest.md) | The people asked to sign the submission (and fill in their fields), in order. |  |
-| **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) | The uploads of the submission's PDF to your storage (account integrations). |  |
-| **truncated_text** | **Hash<String, Array<String>>** | The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired. |  |
-| **files** | [**SubmissionFiles**](SubmissionFiles.md) | The generated files: `pdf` once the submission has been processed, `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired. |  |
-| **preview_generated_at** | **Time** | When the preview PDF was generated. Null if there is no preview. |  |
+| **metadata** | **Hash<String, Object>** | Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`). |  |
+| **files** | [**SubmissionFiles**](SubmissionFiles.md) | The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired. |  |
 | **expired** | **Boolean** | An expired submission's data, metadata, password and PDF have been deleted. |  |
 | **expires_at** | **Time** | When the submission expires. Null if it's kept until you delete it. |  |
 | **processed_at** | **Time** | When the PDF was generated. Null until then. |  |
 | **created_at** | **Time** | When the submission was created. |  |
 | **updated_at** | **Time** | When the submission was last updated. |  |
+| **has_password** | **Boolean** | Whether the PDF needs a password to open (`password`). |  |
+| **signature_requests** | [**Array<SignatureRequest>**](SignatureRequest.md) | The people asked to sign the submission (and fill in their fields), in order. |  |
+| **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) | The uploads of the submission's PDF to your storage (account integrations). |  |
+| **truncated_text** | **Hash<String, Array<String>>** | The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired. |  |
+| **output_formats** | [**Array<OutputFormat>**](OutputFormat.md) | What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission. |  |
+| **preview_generated_at** | **Time** | When the preview PDF was generated. Null if there is no preview. |  |
 
 ## Example
 
@@ -48,17 +49,18 @@ instance = DocSpring::Submission.new(
   data_errors: null,
   error_message: null,
   metadata: null,
-  has_password: null,
-  signature_requests: null,
-  actions: null,
-  truncated_text: null,
   files: null,
-  preview_generated_at: null,
   expired: null,
   expires_at: null,
   processed_at: null,
   created_at: null,
-  updated_at: null
+  updated_at: null,
+  has_password: null,
+  signature_requests: null,
+  actions: null,
+  truncated_text: null,
+  output_formats: null,
+  preview_generated_at: null
 )
 ```
 

data/docs/SubmissionFiles.md

@@ -7,6 +7,7 @@
 | **pdf** | [**GeneratedFile**](GeneratedFile.md) | The submission's PDF. | [optional] |
 | **audit_trail** | [**GeneratedFile**](GeneratedFile.md) | The audit trail of a submission with signature requests: who signed, when and how. It's also added to the end of the PDF when the template's `merge_audit_trail_pdf` is on. | [optional] |
 | **preview** | [**GeneratedFile**](GeneratedFile.md) | The preview PDF from POST /submissions/{submission_id}/generate_preview, such as for a submission still waiting for its signature requests. | [optional] |
+| **png** | [**PageImages**](PageImages.md) |  | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'docspring'
 instance = DocSpring::SubmissionFiles.new(
   pdf: null,
   audit_trail: null,
-  preview: null
+  preview: null,
+  png: null
 )
 ```
 

data/docs/SubmissionInput.md

@@ -7,12 +7,13 @@
 | **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. | [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] |
+| **metadata** | **Hash<String, Object>** | Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`). | [optional] |
 | **password** | **String** | A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. | [optional] |
+| **output_formats** | [**Array<OutputFormat>**](OutputFormat.md) | What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission. | [optional] |
 | **expires_in** | **Integer** | Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours. | [optional] |
 | **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] |
+| **css** | **String** | For an HTML template, SCSS (plain CSS works too) added after the template's styles, on the page and in its header and footer. It doesn't replace them: its rules come later, so they win over the template's rules of the same specificity. | [optional] |
 | **template_id** | **String** | The submission's template. Default the batch's `template_id`. | [optional] |
 | **template_version** | **String** | The version of the submission's template. Default the batch's `template_version`. | [optional] |
 
@@ -27,6 +28,7 @@ instance = DocSpring::SubmissionInput.new(
   data: null,
   metadata: null,
   password: null,
+  output_formats: null,
   expires_in: null,
   field_overrides: null,
   html: null,

data/docs/SubmissionList.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**Array<Submission>**](Submission.md) | The items on this page. |  |
+| **data** | [**Array<SubmissionSummary>**](SubmissionSummary.md) | The items on this page. |  |
 | **next_cursor** | **String** | Pass it as `cursor` to get the next page. Null on the last page. |  |
 
 ## Example

data/docs/SubmissionSummary.md

@@ -0,0 +1,54 @@
+# DocSpring::SubmissionSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The submission's ID. |  |
+| **template_id** | **String** | Null once the template has been permanently deleted. |  |
+| **template_type** | [**TemplateType**](TemplateType.md) | The template's type: `pdf` or `html`. |  |
+| **template_version** | **String** | The published version of the template the submission used. Null for the draft. |  |
+| **batch_id** | **String** | The ID of the batch the submission was created in. |  |
+| **source** | [**SubmissionSource**](SubmissionSource.md) | `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again. |  |
+| **state** | [**SubmissionState**](SubmissionState.md) | `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`. |  |
+| **test** | **Boolean** | Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions. |  |
+| **editable** | **Boolean** | `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`. |  |
+| **data** | **Hash<String, Object>** | The submission's data, with the values entered in completed signature requests. Null unless you pass `include_data=true`. Empty once the submission has expired. |  |
+| **data_errors** | [**Array<ErrorDetail>**](ErrorDetail.md) | Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired. |  |
+| **error_message** | **String** | Why the PDF couldn't be generated, when `state` is `error`. |  |
+| **metadata** | **Hash<String, Object>** | Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`). |  |
+| **files** | [**SubmissionFiles**](SubmissionFiles.md) | Empty unless you pass `include_files=true`: then the generated files, as when you get the submission, without the `png` pages' links (`files.png.pages` is null). Get the submission for its page images. |  |
+| **expired** | **Boolean** | An expired submission's data, metadata, password and PDF have been deleted. |  |
+| **expires_at** | **Time** | When the submission expires. Null if it's kept until you delete it. |  |
+| **processed_at** | **Time** | When the PDF was generated. Null until then. |  |
+| **created_at** | **Time** | When the submission was created. |  |
+| **updated_at** | **Time** | When the submission was last updated. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionSummary.new(
+  id: null,
+  template_id: null,
+  template_type: null,
+  template_version: null,
+  batch_id: null,
+  source: null,
+  state: null,
+  test: null,
+  editable: null,
+  data: null,
+  data_errors: null,
+  error_message: null,
+  metadata: null,
+  files: null,
+  expired: null,
+  expires_at: null,
+  processed_at: null,
+  created_at: null,
+  updated_at: null
+)
+```
+