docspring 3.5.0 → 4.1.0

data/docs/SignatureRequestState.md

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

data/docs/SignatureRequestToken.md

@@ -0,0 +1,30 @@
+# DocSpring::SignatureRequestToken
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The token's ID. |  |
+| **signature_request_id** | **String** | The ID of the signature request the token opens. |  |
+| **type** | [**SignatureRequestTokenType**](SignatureRequestTokenType.md) | `api`: the link opens the signature request for 24 hours. `email`: 7 days. |  |
+| **secret** | **String** | The token's secret. It's only returned when the token is created. |  |
+| **signature_request_url** | **String** | A link that opens the signature request with this token. |  |
+| **expires_at** | **Time** | When the link stops opening the signature request. |  |
+| **created_at** | **Time** | When the token was created. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SignatureRequestToken.new(
+  id: null,
+  signature_request_id: null,
+  type: null,
+  secret: null,
+  signature_request_url: null,
+  expires_at: null,
+  created_at: null
+)
+```
+

data/docs/SignatureRequestTokenType.md

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

data/docs/StringConditionType.md

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

data/docs/Submission.md

@@ -4,33 +4,31 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **batch_id** | **String** |  |  |
-| **data_requests** | [**Array<SubmissionDataRequest>**](SubmissionDataRequest.md) |  |  |
-| **editable** | **Boolean** |  |  |
-| **error_message** | **String** |  |  |
-| **expired** | **Boolean** |  |  |
-| **expires_at** | **String** |  |  |
-| **id** | **String** |  |  |
-| **json_schema_errors** | **Array<String>** |  |  |
-| **metadata** | **Object** |  |  |
-| **password** | **String** |  |  |
-| **processed_at** | **String** |  |  |
-| **state** | **String** |  |  |
-| **template_id** | **String** |  |  |
-| **template_type** | **String** |  |  |
-| **template_version** | **String** |  |  |
-| **test** | **Boolean** |  |  |
-| **truncated_text** | **Object** |  |  |
-| **pdf_hash** | **String** |  |  |
-| **download_url** | **String** |  |  |
-| **permanent_download_url** | **String** |  |  |
-| **preview_download_url** | **String** |  |  |
-| **preview_generated_at** | **String** |  |  |
-| **audit_trail_download_url** | **String** |  |  |
-| **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) |  |  |
-| **source** | **String** |  | [optional] |
-| **referrer** | **String** |  | [optional] |
-| **data** | **Object** |  | [optional] |
+| **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. Lists leave it out (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. |  |
+| **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. |  |
+| **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. |  |
+| **preview_generated_at** | **Time** | When the preview PDF was generated. Null if there is no preview. |  |
+| **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
 
@@ -38,33 +36,31 @@
 require 'docspring'
 
 instance = DocSpring::Submission.new(
-  batch_id: null,
-  data_requests: null,
-  editable: null,
-  error_message: null,
-  expired: null,
-  expires_at: null,
   id: null,
-  json_schema_errors: null,
-  metadata: null,
-  password: null,
-  processed_at: null,
-  state: 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,
+  has_password: null,
+  signature_requests: null,
+  actions: null,
   truncated_text: null,
-  pdf_hash: null,
-  download_url: null,
-  permanent_download_url: null,
-  preview_download_url: null,
+  output_formats: null,
+  files: null,
   preview_generated_at: null,
-  audit_trail_download_url: null,
-  actions: null,
-  source: null,
-  referrer: null,
-  data: null
+  expired: null,
+  expires_at: null,
+  processed_at: null,
+  created_at: null,
+  updated_at: null
 )
 ```
 

data/docs/SubmissionAction.md

@@ -4,13 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **integration_id** | **String** |  |  |
-| **state** | **String** |  |  |
-| **action_type** | **String** |  |  |
-| **action_category** | **String** |  |  |
-| **result_data** | **Object** |  |  |
-| **error_message** | **String** |  |  |
+| **id** | **String** | The upload's ID. |  |
+| **integration_id** | **String** | The ID of the account integration it used. |  |
+| **state** | [**SubmissionActionState**](SubmissionActionState.md) | `pending` until the upload has run, then `processed`. `failed`: your storage rejected it. `error`: it failed in DocSpring. |  |
+| **action_type** | [**SubmissionActionType**](SubmissionActionType.md) | The kind of storage, such as `aws_s3_upload` for an S3 bucket. |  |
+| **result_data** | **Hash<String, Object>** | Where the PDF was uploaded, such as the S3 bucket and key. |  |
+| **error_message** | **String** | Why the upload failed, when `state` is `failed` or `error`. |  |
 
 ## Example
 
@@ -22,7 +21,6 @@ instance = DocSpring::SubmissionAction.new(
   integration_id: null,
   state: null,
   action_type: null,
-  action_category: null,
   result_data: null,
   error_message: null
 )

data/docs/SubmissionActionState.md

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

data/docs/SubmissionActionType.md

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

data/docs/SubmissionBatch.md

@@ -4,14 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **state** | **String** |  |  |
-| **metadata** | **Object** |  |  |
-| **processed_at** | **String** |  |  |
-| **total_count** | **Integer** |  |  |
-| **pending_count** | **Integer** |  |  |
-| **error_count** | **Integer** |  |  |
-| **completion_percentage** | **Float** |  |  |
+| **id** | **String** | The batch's ID. |  |
+| **state** | [**SubmissionBatchState**](SubmissionBatchState.md) | `pending` while the PDFs are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set. |  |
+| **metadata** | **Hash<String, Object>** | Your own data about the batch, such as an ID from your app. |  |
+| **total_count** | **Integer** | The number of submissions in the request. |  |
+| **pending_count** | **Integer** | The submissions whose PDFs haven't been generated yet. |  |
+| **error_count** | **Integer** | The submissions that were invalid or whose PDFs couldn't be generated. |  |
+| **completion_percentage** | **Integer** | The percentage of the batch's submissions that have finished, from 0 to 100. |  |
+| **submissions** | [**Array<Submission>**](Submission.md) | The batch's submissions, in the order of the request. Their `data` is null unless you pass `include_data=true`. A batch that failed validation only has the submissions that were recorded as `invalid_data`. |  |
+| **processed_at** | **Time** | When every submission had finished. |  |
+| **created_at** | **Time** | When the batch was created. |  |
+| **updated_at** | **Time** | When the batch was last updated. |  |
 
 ## Example
 
@@ -22,11 +25,14 @@ instance = DocSpring::SubmissionBatch.new(
   id: null,
   state: null,
   metadata: null,
-  processed_at: null,
   total_count: null,
   pending_count: null,
   error_count: null,
-  completion_percentage: null
+  completion_percentage: null,
+  submissions: null,
+  processed_at: null,
+  created_at: null,
+  updated_at: null
 )
 ```
 

data/docs/SubmissionBatchState.md

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

data/docs/SubmissionFiles.md

@@ -0,0 +1,24 @@
+# DocSpring::SubmissionFiles
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionFiles.new(
+  pdf: null,
+  audit_trail: null,
+  preview: null,
+  png: null
+)
+```
+

data/docs/SubmissionInput.md

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

data/docs/SubmissionList.md

@@ -0,0 +1,20 @@
+# DocSpring::SubmissionList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Submission>**](Submission.md) | The items on this page. |  |
+| **next_cursor** | **String** | Pass it as `cursor` to get the next page. Null on the last page. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionList.new(
+  data: null,
+  next_cursor: null
+)
+```
+

data/docs/SubmissionSource.md

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

data/docs/SubmissionSourcePdf.md

@@ -0,0 +1,20 @@
+# DocSpring::SubmissionSourcePdf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Must be `submission`. | [default to 'submission'] |
+| **id** | **String** | The ID of the submission, combined PDF, template or custom file. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionSourcePdf.new(
+  type: null,
+  id: null
+)
+```
+

data/docs/SubmissionState.md

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

data/docs/SubmissionValidation.md

@@ -0,0 +1,24 @@
+# DocSpring::SubmissionValidation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** | True when creating the submission would succeed. |  |
+| **template_id** | **String** | The template's ID. |  |
+| **template_version** | **String** | The published version the request was checked against, such as `1.2.0`. Null for the draft. |  |
+| **error** | [**ErrorInfo**](ErrorInfo.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionValidation.new(
+  valid: null,
+  template_id: null,
+  template_version: null,
+  error: null
+)
+```
+