docspring 4.0.0 → 4.1.0

data/docs/CreateSubmissionBatchRequest.md

@@ -8,6 +8,7 @@
 | **template_id** | **String** | The template for each submission that doesn't name its own `template_id`. | [optional] |
 | **template_version** | **String** | The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published). | [optional] |
 | **test** | **Boolean** | The default `test` for each submission that doesn't set its own. | [optional] |
+| **output_formats** | [**Array<OutputFormat>**](OutputFormat.md) | The default `output_formats` for each submission that doesn't set its own. | [optional] |
 | **submissions** | [**Array<SubmissionInput>**](SubmissionInput.md) | Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests`, plus `template_id` and `template_version` when it uses a different template from the batch. |  |
 
 ## Example
@@ -20,6 +21,7 @@ instance = DocSpring::CreateSubmissionBatchRequest.new(
   template_id: null,
   template_version: null,
   test: null,
+  output_formats: null,
   submissions: null
 )
 ```

data/docs/CreateSubmissionRequest.md

@@ -9,6 +9,7 @@
 | **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] |
@@ -26,6 +27,7 @@ instance = DocSpring::CreateSubmissionRequest.new(
   data: null,
   metadata: null,
   password: null,
+  output_formats: null,
   expires_in: null,
   field_overrides: null,
   html: null,

data/docs/CreateTemplateRequest.md

@@ -32,13 +32,17 @@
 | **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] |
+| **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] |
-| **cache_id** | **String** | A PDF template's document: the `fields.key` of a file you uploaded with the presigned upload (GET /uploads/presign). Required for a PDF template. To upload the PDF with the request, use POST /templates/upload. | [optional] |
-| **filename** | **String** | The PDF's file name, for a `cache_id` (presigned uploads don't send one). | [optional] |
+| **cache_id** | **String** | A PDF template's document: the `fields.key` of a file you uploaded with the presigned upload (GET /uploads/presign). A PDF template needs one of `cache_id`, `document_url` and `document_base64`. To upload the PDF with the request, use POST /templates/upload. | [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] |
 | **detect_fields** | **Boolean** | Set up the PDF's fields as DocSpring's "Automatically detect fields" upload option does: import or detect the fields, name them with AI, and set up conditional logic. `field_source`, `field_naming` and `field_logic` choose how. Default false. `document.page_processing_statuses` and `document.field_logic_status` show how it's going, and `document.state` becomes `processed` once every page's fields are set up. | [optional] |
 | **field_source** | [**FieldSetupSource**](FieldSetupSource.md) | With `detect_fields`, where the fields come from. `auto` (the default) imports the form fields of a fillable PDF and detects the fields of a PDF without them; `pdf_detection` detects the fields from the page layout, even on a fillable PDF; `pdf_form_fields` only imports the PDF's form fields. | [optional] |
 | **field_naming** | [**FieldSetupNaming**](FieldSetupNaming.md) | With `detect_fields`, how the fields are named. `ai` (the default) names them and sets their types and settings with AI; `preserve` keeps the names of the PDF's form fields, and AI only names the fields it detected. `preserve` needs `field_source` `auto` or `pdf_form_fields`. | [optional] |
@@ -78,12 +82,16 @@ instance = DocSpring::CreateTemplateRequest.new(
   slack_webhook_url: null,
   defaults: null,
   field_dependencies: null,
+  predefined_fields: null,
+  predefined_fields_sample_data: null,
   html: null,
   scss: null,
   header_html: null,
   footer_html: null,
   html_engine_options: null,
   cache_id: null,
+  document_url: null,
+  document_base64: null,
   filename: null,
   detect_fields: null,
   field_source: null,

data/docs/Field.md

@@ -0,0 +1,198 @@
+# DocSpring::Field
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The field's ID, an integer that's unique within the template. |  |
+| **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`. |  |
+| **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. |  |
+| **acroform_name** | **String** | The name of the PDF form field this field was made from, when the template's PDF had fillable fields. Null for fields added in DocSpring. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **integer** | **Boolean** | Number fields only: the value must be a whole number. Shared by every field with the same `name`. |  |
+| **minimum** | **Float** | Number fields only: the smallest value allowed. Shared by every field with the same `name`. |  |
+| **maximum** | **Float** | Number fields only: the largest value allowed. Shared by every field with the same `name`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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`. |  |
+| **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. |  |
+| **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). |  |
+| **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. |  |
+| **width** | **Float** | The field's width, in the units of `x`. A check mark is sized to the field's width. |  |
+| **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`. |  |
+| **rotation** | **Float** | Rotates the field clockwise by this many degrees, from -360 to 360 (negative turns it counterclockwise). |  |
+| **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. |  |
+| **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. |  |
+| **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`. |  |
+| **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. |  |
+| **font_size** | **Integer** | Text display only: the font size in points. Empty uses the template's default font size. |  |
+| **character_spacing** | **Float** | Text display only: extra space between characters, in points. Empty uses the template's default. |  |
+| **bold** | **Boolean** | Text display only: prints the text in bold. |  |
+| **uppercase** | **Boolean** | Text display only: prints the text in capital letters. |  |
+| **strikethrough** | **Boolean** | Text display only: draws a line through the text. |  |
+| **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. |  |
+| **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`. |  |
+| **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. |  |
+| **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. |  |
+| **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`. |  |
+| **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`. |  |
+| **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. |  |
+| **color** | **String** | Text display only: the text color, as a hex code such as `444444`. Empty uses the template's default text color. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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). |  |
+| **v_alignment** | [**TextVerticalAlignment**](TextVerticalAlignment.md) | Text display only: how the text is aligned vertically in the field: `bottom`, `center` or `top`. |  |
+| **comb** | **Boolean** | Text display only: splits the field into `comb_number_of_cells` boxes of equal width and prints one character, centered, in each. |  |
+| **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`. |  |
+| **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. |  |
+| **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`. |  |
+| **shape_sides** | **Integer** | Shape display only, with `shape_type` `polygon`: the number of sides, 3 to 12. |  |
+| **shape_border_width** | **Integer** | Shape display only: the width of the shape's border, in points. |  |
+| **shape_border_color** | **String** | Shape display only: the shape's border color, as a hex code. Null draws no border. |  |
+| **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. |  |
+| **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. |  |
+| **shape_fill_color** | **String** | Shape display only: the color that fills the shape, as a hex code. Null leaves it unfilled. |  |
+| **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. |  |
+| **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. |  |
+| **check_character** | [**CheckCharacter**](CheckCharacter.md) | Check display only: the character printed, as an HTML entity: `✓` (✓), `✔` (✔, the default), `✖` (✖), `✗` (✗) or `✘` (✘). |  |
+| **check_color** | **String** | Check display only: the check mark's color, as a hex code. Empty uses the template's default check color. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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`. |  |
+| **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. |  |
+| **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. |  |
+| **number_condition_range_exclusive_min** | **Boolean** | With `number_condition_type` `range`: leaves `number_condition_range_min` itself out of the range. |  |
+| **number_condition_range_exclusive_max** | **Boolean** | With `number_condition_type` `range`: leaves `number_condition_range_max` itself out of the range. |  |
+| **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`. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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`. |  |
+| **dependencies** | [**FieldDependency**](FieldDependency.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`. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::Field.new(
+  id: null,
+  name: null,
+  page: null,
+  acroform_name: 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
+)
+```
+

data/docs/FieldDependency.md

@@ -0,0 +1,22 @@
+# DocSpring::FieldDependency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | [**TemplateFieldDependencyAction**](TemplateFieldDependencyAction.md) | What the rule does to the fields it applies to when its conditions are met. |  |
+| **match** | [**TemplateFieldDependencyMatch**](TemplateFieldDependencyMatch.md) | Whether all of the conditions (the default) or any of them must be met. | [optional] |
+| **conditions** | [**Array<TemplateFieldDependencyCondition>**](TemplateFieldDependencyCondition.md) | The conditions on other fields' values. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::FieldDependency.new(
+  action: null,
+  match: null,
+  conditions: null
+)
+```
+

data/docs/FieldDependencyInput.md

@@ -0,0 +1,22 @@
+# DocSpring::FieldDependencyInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | [**TemplateFieldDependencyAction**](TemplateFieldDependencyAction.md) | What the rule does to the fields it applies to when its conditions are met. |  |
+| **match** | [**TemplateFieldDependencyMatch**](TemplateFieldDependencyMatch.md) | Whether all of the conditions (the default) or any of them must be met. | [optional] |
+| **conditions** | [**Array<TemplateFieldDependencyConditionInput>**](TemplateFieldDependencyConditionInput.md) | The conditions on other fields' values. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::FieldDependencyInput.new(
+  action: null,
+  match: null,
+  conditions: null
+)
+```
+

data/docs/FieldGroup.md

@@ -0,0 +1,32 @@
+# DocSpring::FieldGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The group's name: `address` for the field `address/city`. A list's item numbers are written as `~`, so the fields `items/0/price` and `items/1/price` are in the groups `items` and `items/~`, the list's items. |  |
+| **type** | [**FieldGroupType**](FieldGroupType.md) | `array` for a list, whose fields' names number its items after the group's name (`items/0/price`, or `items/~/price` in an HTML template), and `object` for the other groups. |  |
+| **title** | **String** | The group's title in the template's data schema and on forms. When it's empty, a title is made from the group's name. |  |
+| **description** | **String** | Help text for the group, added to the template's data schema and shown on forms. |  |
+| **metadata** | **String** | Text for your own use, added to the template's data schema as `x-metadata`. DocSpring doesn't use it. |  |
+| **min_items** | **Integer** | Lists only (`type` `array`): the fewest items submission data must have. Null for no minimum. |  |
+| **max_items** | **Integer** | HTML templates' lists only: the most items submission data can have. Null for no limit. A PDF template's list takes as many items as its fields are numbered for, or more with `allow_additional_items`. |  |
+| **allow_additional_items** | **Boolean** | PDF templates' lists only: submission data can have more items than the list's fields are numbered for. Default false. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::FieldGroup.new(
+  name: null,
+  type: null,
+  title: null,
+  description: null,
+  metadata: null,
+  min_items: null,
+  max_items: null,
+  allow_additional_items: null
+)
+```
+

data/docs/FieldGroupInput.md

@@ -0,0 +1,30 @@
+# DocSpring::FieldGroupInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The group's name: `address` for the field `address/city`. A list's item numbers are written as `~`, so the fields `items/0/price` and `items/1/price` are in the groups `items` and `items/~`, the list's items. |  |
+| **title** | **String** | The group's title in the template's data schema and on forms. When it's empty, a title is made from the group's name. | [optional] |
+| **description** | **String** | Help text for the group, added to the template's data schema and shown on forms. | [optional] |
+| **metadata** | **String** | Text for your own use, added to the template's data schema as `x-metadata`. DocSpring doesn't use it. | [optional] |
+| **min_items** | **Integer** | Lists only (`type` `array`): the fewest items submission data must have. Null for no minimum. | [optional] |
+| **max_items** | **Integer** | HTML templates' lists only: the most items submission data can have. Null for no limit. A PDF template's list takes as many items as its fields are numbered for, or more with `allow_additional_items`. | [optional] |
+| **allow_additional_items** | **Boolean** | PDF templates' lists only: submission data can have more items than the list's fields are numbered for. Default false. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::FieldGroupInput.new(
+  name: null,
+  title: null,
+  description: null,
+  metadata: null,
+  min_items: null,
+  max_items: null,
+  allow_additional_items: null
+)
+```
+

data/docs/FieldGroupType.md

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