pdf_generator_api_client 8.0.28 → 8.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 591820f19c2df20011d71cd1f2e3d36bbde01ad4f16ecbefd3ea66dafa4d91ba
-  data.tar.gz: ecc29986fc9c1b7d1ad7b956b09140359b559e28339737083d375f1994f30fef
+  metadata.gz: 91581e412ae458e2f98bc35bb164fe08d39e900a761843e7dbeb1647a0d2f107
+  data.tar.gz: 7dfa952287c8f1b88dd51359cab3e49333848985322e5cf0c66e2cdb5de815c7
 SHA512:
-  metadata.gz: 7509d6cc7c0043d7da017e57cee2d70e5bd21fc6cd024dd800658b18f34094be0ec3eb599c77c9e91d4f91b9a0d2a1c090f7e98a541c7f697eb008aee1b88a9b
-  data.tar.gz: aa558a1bdc612ed864dc6ef63d60d7b699c9f68cf2e71349591f5fb660b5dd3a16d9cfe957ce2890159be295d2deeedd7d0df4582447edc9b571949d1e0ebc10
+  metadata.gz: 4dcc8f0b27464436231a97322da0fe965720d4640d7b72419d41dde94910228ba7416931a0038889123da64794a2ad7feb5b592884568b119b95a52995b8cf1f
+  data.tar.gz: 1f8a20110e8eba927c5f9ea65ab219a0f7ce1a4735f1c82644cb536a43b5ea48e2db83294d5ed216ad10d221a10bbf21b29a75ab33bda59459e484ac877f3519

data/README.md

@@ -234,8 +234,8 @@ You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 4.0.28
-- Package version: 8.0.28
+- API version: 4.0.31
+- Package version: 8.0.31
 - Generator version: 7.14.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://support.pdfgeneratorapi.com](https://support.pdfgeneratorapi.com)
@@ -253,16 +253,16 @@ gem build pdf_generator_api_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./pdf_generator_api_client-8.0.28.gem
+gem install ./pdf_generator_api_client-8.0.31.gem
 ```
 
-(for development, run `gem install --dev ./pdf_generator_api_client-8.0.28.gem` to install the development dependencies)
+(for development, run `gem install --dev ./pdf_generator_api_client-8.0.31.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'pdf_generator_api_client', '~> 8.0.28'
+    gem 'pdf_generator_api_client', '~> 8.0.31'
 
 ### Install from Git
 
@@ -326,6 +326,7 @@ Class | Method | HTTP request | Description
 *PDFGeneratorAPI::DocumentsApi* | [**get_async_job_status**](docs/DocumentsApi.md#get_async_job_status) | **GET** /documents/async/{jobId} | Get job status
 *PDFGeneratorAPI::DocumentsApi* | [**get_document**](docs/DocumentsApi.md#get_document) | **GET** /documents/{publicId} | Get document
 *PDFGeneratorAPI::DocumentsApi* | [**get_document_actions**](docs/DocumentsApi.md#get_document_actions) | **GET** /documents/{publicId}/actions | Get document actions
+*PDFGeneratorAPI::DocumentsApi* | [**get_document_signatures**](docs/DocumentsApi.md#get_document_signatures) | **GET** /documents/{publicId}/signatures | Validate document signatures
 *PDFGeneratorAPI::DocumentsApi* | [**get_document_versions**](docs/DocumentsApi.md#get_document_versions) | **GET** /documents/{publicId}/versions | Get document versions
 *PDFGeneratorAPI::DocumentsApi* | [**get_documents**](docs/DocumentsApi.md#get_documents) | **GET** /documents | Get documents
 *PDFGeneratorAPI::DocumentsApi* | [**store_document**](docs/DocumentsApi.md#store_document) | **POST** /documents | Store document
@@ -336,6 +337,7 @@ Class | Method | HTTP request | Description
 *PDFGeneratorAPI::FormsApi* | [**create_form**](docs/FormsApi.md#create_form) | **POST** /forms | Create form
 *PDFGeneratorAPI::FormsApi* | [**delete_form**](docs/FormsApi.md#delete_form) | **DELETE** /forms/{formId} | Delete form
 *PDFGeneratorAPI::FormsApi* | [**get_form**](docs/FormsApi.md#get_form) | **GET** /forms/{formId} | Get form
+*PDFGeneratorAPI::FormsApi* | [**get_form_schema**](docs/FormsApi.md#get_form_schema) | **GET** /forms/schema | Get schema
 *PDFGeneratorAPI::FormsApi* | [**get_forms**](docs/FormsApi.md#get_forms) | **GET** /forms | Get forms
 *PDFGeneratorAPI::FormsApi* | [**import_form**](docs/FormsApi.md#import_form) | **POST** /forms/import | Import Form
 *PDFGeneratorAPI::FormsApi* | [**open_form_builder**](docs/FormsApi.md#open_form_builder) | **POST** /forms/open | Open new form builder
@@ -391,6 +393,8 @@ Class | Method | HTTP request | Description
  - [PDFGeneratorAPI::DataBatchInner](docs/DataBatchInner.md)
  - [PDFGeneratorAPI::Document](docs/Document.md)
  - [PDFGeneratorAPI::DocumentAction](docs/DocumentAction.md)
+ - [PDFGeneratorAPI::DocumentSignature](docs/DocumentSignature.md)
+ - [PDFGeneratorAPI::DocumentSignatures](docs/DocumentSignatures.md)
  - [PDFGeneratorAPI::DocumentUser](docs/DocumentUser.md)
  - [PDFGeneratorAPI::DocumentVersion](docs/DocumentVersion.md)
  - [PDFGeneratorAPI::EncryptAndDecryptBase64](docs/EncryptAndDecryptBase64.md)
@@ -402,15 +406,20 @@ Class | Method | HTTP request | Description
  - [PDFGeneratorAPI::FormActionSend](docs/FormActionSend.md)
  - [PDFGeneratorAPI::FormActionSendSendDocument](docs/FormActionSendSendDocument.md)
  - [PDFGeneratorAPI::FormActionSendSendDocumentHeadersInner](docs/FormActionSendSendDocumentHeadersInner.md)
+ - [PDFGeneratorAPI::FormActionSign](docs/FormActionSign.md)
  - [PDFGeneratorAPI::FormActionStore](docs/FormActionStore.md)
  - [PDFGeneratorAPI::FormConfiguration](docs/FormConfiguration.md)
+ - [PDFGeneratorAPI::FormConfigurationImport](docs/FormConfigurationImport.md)
  - [PDFGeneratorAPI::FormConfigurationNew](docs/FormConfigurationNew.md)
  - [PDFGeneratorAPI::FormConfigurationNewActionsInner](docs/FormConfigurationNewActionsInner.md)
+ - [PDFGeneratorAPI::FormField](docs/FormField.md)
+ - [PDFGeneratorAPI::FormFieldOptions](docs/FormFieldOptions.md)
+ - [PDFGeneratorAPI::FormFieldSubRowsInner](docs/FormFieldSubRowsInner.md)
  - [PDFGeneratorAPI::FormFieldsBase64](docs/FormFieldsBase64.md)
- - [PDFGeneratorAPI::FormFieldsInner](docs/FormFieldsInner.md)
  - [PDFGeneratorAPI::FormFieldsUrl](docs/FormFieldsUrl.md)
  - [PDFGeneratorAPI::FormFillBase64](docs/FormFillBase64.md)
  - [PDFGeneratorAPI::FormFillUrl](docs/FormFillUrl.md)
+ - [PDFGeneratorAPI::FormTableColumn](docs/FormTableColumn.md)
  - [PDFGeneratorAPI::FormatParam](docs/FormatParam.md)
  - [PDFGeneratorAPI::GenerateDocumentAsynchronousRequest](docs/GenerateDocumentAsynchronousRequest.md)
  - [PDFGeneratorAPI::GenerateDocumentBatchAsynchronousRequest](docs/GenerateDocumentBatchAsynchronousRequest.md)
@@ -454,11 +463,11 @@ Class | Method | HTTP request | Description
  - [PDFGeneratorAPI::InlineObject1Response](docs/InlineObject1Response.md)
  - [PDFGeneratorAPI::InlineObject2](docs/InlineObject2.md)
  - [PDFGeneratorAPI::InlineObject20](docs/InlineObject20.md)
- - [PDFGeneratorAPI::InlineObject20Meta](docs/InlineObject20Meta.md)
  - [PDFGeneratorAPI::InlineObject21](docs/InlineObject21.md)
+ - [PDFGeneratorAPI::InlineObject21Meta](docs/InlineObject21Meta.md)
  - [PDFGeneratorAPI::InlineObject22](docs/InlineObject22.md)
- - [PDFGeneratorAPI::InlineObject22Response](docs/InlineObject22Response.md)
  - [PDFGeneratorAPI::InlineObject23](docs/InlineObject23.md)
+ - [PDFGeneratorAPI::InlineObject23Response](docs/InlineObject23Response.md)
  - [PDFGeneratorAPI::InlineObject24](docs/InlineObject24.md)
  - [PDFGeneratorAPI::InlineObject25](docs/InlineObject25.md)
  - [PDFGeneratorAPI::InlineObject26](docs/InlineObject26.md)
@@ -466,6 +475,8 @@ Class | Method | HTTP request | Description
  - [PDFGeneratorAPI::InlineObject28](docs/InlineObject28.md)
  - [PDFGeneratorAPI::InlineObject29](docs/InlineObject29.md)
  - [PDFGeneratorAPI::InlineObject3](docs/InlineObject3.md)
+ - [PDFGeneratorAPI::InlineObject30](docs/InlineObject30.md)
+ - [PDFGeneratorAPI::InlineObject31](docs/InlineObject31.md)
  - [PDFGeneratorAPI::InlineObject4](docs/InlineObject4.md)
  - [PDFGeneratorAPI::InlineObject5](docs/InlineObject5.md)
  - [PDFGeneratorAPI::InlineObject6](docs/InlineObject6.md)

data/docs/ConversionApi.md

@@ -153,7 +153,7 @@ end
 
 URL to PDF
 
-Converts public URL to PDF
+Converts public URL to PDF.  By default the page is printed once its network activity settles. Pages that keep making background requests (e.g. single-page applications) can signal when they have finished rendering with `wait_for_css` and/or `wait_for_js`; the page is then printed as soon as the signal is met. When both are given, both must be met. 
 
 ### Examples
 

data/docs/ConvertURL2PDFRequest.md

@@ -9,6 +9,11 @@
 | **orientation** | **String** |  | [optional][default to 'portrait'] |
 | **output** | **String** | Output | [optional][default to 'base64'] |
 | **filename** | **String** | Document name | [optional] |
+| **wait_for_css** | **String** | CSS selector of an element to wait for before the page is printed; see `wait_for_css_state` | [optional] |
+| **wait_for_css_state** | **String** | How `wait_for_css` matches. `present` waits until the element exists, even if it is empty or hidden (e.g. a `<div id=\"report-ready\"></div>` marker); `visible` waits until it is also visible with a non-empty size (e.g. a chart that appears when data has loaded). | [optional][default to 'present'] |
+| **wait_for_js** | **String** | JavaScript expression evaluated in the page every 100ms; the page is printed once it is truthy. Promises are awaited, and an expression that throws counts as not ready yet. | [optional] |
+| **wait_timeout** | **Integer** | Seconds to wait for `wait_for_css` / `wait_for_js` before applying `on_wait_timeout` | [optional][default to 30] |
+| **on_wait_timeout** | **String** | What to do when the wait signal is not met within `wait_timeout`. `error` returns a 422 response; `print` prints the page as it is. | [optional][default to 'error'] |
 
 ## Example
 
@@ -20,7 +25,12 @@ instance = PDFGeneratorAPI::ConvertURL2PDFRequest.new(
   paper_size: a4,
   orientation: portrait,
   output: base64,
-  filename: Invoice 12345
+  filename: Invoice 12345,
+  wait_for_css: #report-ready,
+  wait_for_css_state: present,
+  wait_for_js: window.renderComplete === true,
+  wait_timeout: 30,
+  on_wait_timeout: error
 )
 ```
 

data/docs/DocumentSignature.md

@@ -0,0 +1,42 @@
+# PDFGeneratorAPI::DocumentSignature
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_name** | **String** | Name of the signature field in the document. | [optional] |
+| **signer_name** | **String** | The name the signer signed under. | [optional] |
+| **signer** | **String** | Subject of the certificate that sealed it — an organization, not a person. | [optional] |
+| **issuer** | **String** | Subject of the certificate authority that issued it. | [optional] |
+| **signed_at** | **String** | When a timestamp authority attested the signature (ISO-8601). This is the defensible time; the signer's own clock proves nothing.  | [optional] |
+| **claimed_signed_at** | **String** | The time the signer's own software recorded (ISO-8601). | [optional] |
+| **timestamp_authority** | **String** | The timestamp authority that attested the signature. | [optional] |
+| **intact** | **Boolean** | The bytes this signature covers are unchanged. | [optional] |
+| **valid** | **Boolean** | The signature block itself adds up. On its own this does NOT mean the document is unchanged: a tampered file reports `valid` true with `intact` false, so a verdict needs intact AND valid AND trusted.  | [optional] |
+| **trusted** | **Boolean** | The certificate chains to a trusted root. | [optional] |
+| **coverage** | **String** | How much of the file this signature protects. | [optional] |
+| **ades_indication** | **String** | The ETSI EN 319 102-1 indication, when the AdES engine could run. | [optional] |
+| **ades_sub_indication** | **String** | The AdES sub-indication, naming why an indication is not PASSED. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::DocumentSignature.new(
+  field_name: disclosing_party_signature,
+  signer_name: Jane Doe,
+  signer: Common Name: Actual Reports OÜ, Organization: Actual Reports OÜ, Country: EE,
+  issuer: Common Name: SSL.com Client Certificate Intermediate CA RSA R2, Country: US,
+  signed_at: 2026-08-21T09:17:08+00:00,
+  claimed_signed_at: 2026-08-21T09:17:06+00:00,
+  timestamp_authority: Common Name: SSL.com Timestamping Unit 2025 E1, Country: US,
+  intact: true,
+  valid: true,
+  trusted: true,
+  coverage: ENTIRE_FILE,
+  ades_indication: PASSED,
+  ades_sub_indication: OK
+)
+```
+

data/docs/DocumentSignatures.md

@@ -0,0 +1,28 @@
+# PDFGeneratorAPI::DocumentSignatures
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The one-line answer, reduced from every signature worst case first. `unavailable` means signature validation is not enabled on this deployment — it says nothing about the document.  | [optional] |
+| **status_label** | **String** | The status in words, ready to display. | [optional] |
+| **has_long_term_validation** | **Boolean** | The document carries the certificate and revocation data needed to verify it after the signing certificates expire.  | [optional] |
+| **covers_whole_document** | **Boolean** | The last signature covers every byte, so nothing was appended after it. | [optional] |
+| **document_timestamps** | **Integer** | Timestamp-only signatures, counted rather than listed: they are machinery, not people, and would double every signer.  | [optional] |
+| **signatures** | [**Array<DocumentSignature>**](DocumentSignature.md) | One entry per signature, excluding document timestamps. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::DocumentSignatures.new(
+  status: valid,
+  status_label: Signed, and every signature is valid,
+  has_long_term_validation: true,
+  covers_whole_document: true,
+  document_timestamps: 2,
+  signatures: null
+)
+```
+

data/docs/DocumentsApi.md

@@ -13,6 +13,7 @@ All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
 | [**get_async_job_status**](DocumentsApi.md#get_async_job_status) | **GET** /documents/async/{jobId} | Get job status |
 | [**get_document**](DocumentsApi.md#get_document) | **GET** /documents/{publicId} | Get document |
 | [**get_document_actions**](DocumentsApi.md#get_document_actions) | **GET** /documents/{publicId}/actions | Get document actions |
+| [**get_document_signatures**](DocumentsApi.md#get_document_signatures) | **GET** /documents/{publicId}/signatures | Validate document signatures |
 | [**get_document_versions**](DocumentsApi.md#get_document_versions) | **GET** /documents/{publicId}/versions | Get document versions |
 | [**get_documents**](DocumentsApi.md#get_documents) | **GET** /documents | Get documents |
 | [**store_document**](DocumentsApi.md#store_document) | **POST** /documents | Store document |
@@ -157,7 +158,7 @@ end
 
 ## generate_document_asynchronous
 
-> <InlineObject22> generate_document_asynchronous(generate_document_asynchronous_request)
+> <InlineObject23> generate_document_asynchronous(generate_document_asynchronous_request)
 
 Generate document (async)
 
@@ -190,7 +191,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject22>, Integer, Hash)> generate_document_asynchronous_with_http_info(generate_document_asynchronous_request)
+> <Array(<InlineObject23>, Integer, Hash)> generate_document_asynchronous_with_http_info(generate_document_asynchronous_request)
 
 ```ruby
 begin
@@ -198,7 +199,7 @@ begin
   data, status_code, headers = api_instance.generate_document_asynchronous_with_http_info(generate_document_asynchronous_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject22>
+  p data # => <InlineObject23>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling DocumentsApi->generate_document_asynchronous_with_http_info: #{e}"
 end
@@ -212,7 +213,7 @@ end
 
 ### Return type
 
-[**InlineObject22**](InlineObject22.md)
+[**InlineObject23**](InlineObject23.md)
 
 ### Authorization
 
@@ -295,7 +296,7 @@ end
 
 ## generate_document_batch_asynchronous
 
-> <InlineObject22> generate_document_batch_asynchronous(generate_document_batch_asynchronous_request)
+> <InlineObject23> generate_document_batch_asynchronous(generate_document_batch_asynchronous_request)
 
 Generate document (batch + async)
 
@@ -328,7 +329,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject22>, Integer, Hash)> generate_document_batch_asynchronous_with_http_info(generate_document_batch_asynchronous_request)
+> <Array(<InlineObject23>, Integer, Hash)> generate_document_batch_asynchronous_with_http_info(generate_document_batch_asynchronous_request)
 
 ```ruby
 begin
@@ -336,7 +337,7 @@ begin
   data, status_code, headers = api_instance.generate_document_batch_asynchronous_with_http_info(generate_document_batch_asynchronous_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject22>
+  p data # => <InlineObject23>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling DocumentsApi->generate_document_batch_asynchronous_with_http_info: #{e}"
 end
@@ -350,7 +351,7 @@ end
 
 ### Return type
 
-[**InlineObject22**](InlineObject22.md)
+[**InlineObject23**](InlineObject23.md)
 
 ### Authorization
 
@@ -575,7 +576,7 @@ end
 
 ## get_document_actions
 
-> <InlineObject17> get_document_actions(public_id)
+> <InlineObject18> get_document_actions(public_id)
 
 Get document actions
 
@@ -608,7 +609,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject17>, Integer, Hash)> get_document_actions_with_http_info(public_id)
+> <Array(<InlineObject18>, Integer, Hash)> get_document_actions_with_http_info(public_id)
 
 ```ruby
 begin
@@ -616,7 +617,7 @@ begin
   data, status_code, headers = api_instance.get_document_actions_with_http_info(public_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject17>
+  p data # => <InlineObject18>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling DocumentsApi->get_document_actions_with_http_info: #{e}"
 end
@@ -630,6 +631,79 @@ end
 
 ### Return type
 
+[**InlineObject18**](InlineObject18.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_document_signatures
+
+> <InlineObject17> get_document_signatures(public_id, opts)
+
+Validate document signatures
+
+Reports on every digital signature a stored document carries: who signed, when a timestamp authority attested it, whether the signed bytes are unchanged and whether the certificate chains to a trusted root.  Facts are reported separately from the verdict, because a reader and a validation library can disagree in both directions. `status` reduces them to one answer, worst case first.  Each request consumes one credit. A request that reports `unavailable` — signature validation not being enabled on the deployment — validates nothing and is not charged. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'pdf_generator_api_client'
+# setup authorization
+PDFGeneratorAPI.configure do |config|
+  # Configure Bearer authorization (JWT): JSONWebTokenAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PDFGeneratorAPI::DocumentsApi.new
+public_id = 'bac8381bce1982e5f6957a0f52371336' # String | Resource public id
+opts = {
+  version: '5f3c2b1a9d8e7f6a' # String | Which stored version to report on. A version identifier reports on that version, `initial` on the document as first generated. Defaults to the latest version. A version is always reported on as itself: reporting the latest would describe bytes the caller is not holding. 
+}
+
+begin
+  # Validate document signatures
+  result = api_instance.get_document_signatures(public_id, opts)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling DocumentsApi->get_document_signatures: #{e}"
+end
+```
+
+#### Using the get_document_signatures_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject17>, Integer, Hash)> get_document_signatures_with_http_info(public_id, opts)
+
+```ruby
+begin
+  # Validate document signatures
+  data, status_code, headers = api_instance.get_document_signatures_with_http_info(public_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject17>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling DocumentsApi->get_document_signatures_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_id** | **String** | Resource public id |  |
+| **version** | **String** | Which stored version to report on. A version identifier reports on that version, &#x60;initial&#x60; on the document as first generated. Defaults to the latest version. A version is always reported on as itself: reporting the latest would describe bytes the caller is not holding.  | [optional] |
+
+### Return type
+
 [**InlineObject17**](InlineObject17.md)
 
 ### Authorization

data/docs/FormActionSendSendDocument.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **url** | **String** | HTTPS URL where the generated document will be delivered. |  |
+| **url** | **String** | URL where the generated document will be delivered. Must use HTTPS. |  |
 | **headers** | [**Array<FormActionSendSendDocumentHeadersInner>**](FormActionSendSendDocumentHeadersInner.md) | Optional HTTP headers to include with the delivery request. | [optional] |
 
 ## Example

data/docs/FormActionSign.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::FormActionSign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sign_document** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormActionSign.new(
+  sign_document: true
+)
+```
+

data/docs/FormConfigurationImport.md

@@ -0,0 +1,24 @@
+# PDFGeneratorAPI::FormConfigurationImport
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **Integer** | Template ID which is connected to the form | [optional] |
+| **name** | **String** | Form name | [optional] |
+| **actions** | [**Array<FormConfigurationNewActionsInner>**](FormConfigurationNewActionsInner.md) | Array of action configurations. Each action is a separate object with a single key; leave an action out to disable it. | [optional] |
+| **configuration** | [**FormConfiguration**](FormConfiguration.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormConfigurationImport.new(
+  template_id: 123123,
+  name: Certificate creator,
+  actions: null,
+  configuration: null
+)
+```
+

data/docs/FormConfigurationNew.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **template_id** | **Integer** | Template ID which is connected to the form | [optional] |
-| **name** | **String** | Form name | [optional] |
-| **actions** | [**Array<FormConfigurationNewActionsInner>**](FormConfigurationNewActionsInner.md) | Array of action configurations | [optional] |
-| **fields** | [**Array<FormFieldsInner>**](FormFieldsInner.md) | A list of form field objects | [optional] |
+| **name** | **String** | Form name |  |
+| **actions** | [**Array<FormConfigurationNewActionsInner>**](FormConfigurationNewActionsInner.md) | Array of action configurations. Each action is a separate object with a single key; leave an action out to disable it. |  |
+| **fields** | [**Array<FormField>**](FormField.md) | Input fields shown on the form, in display order. Field names must be unique within the form. |  |
 | **configuration** | [**FormConfiguration**](FormConfiguration.md) |  | [optional] |
 
 ## Example

data/docs/FormConfigurationNewActionsInner.md

@@ -7,6 +7,7 @@
 | **store_document** | **Boolean** |  | [optional] |
 | **download_document** | **Boolean** |  | [optional] |
 | **send_document** | [**FormActionSendSendDocument**](FormActionSendSendDocument.md) |  | [optional] |
+| **sign_document** | **Boolean** |  | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'pdf_generator_api_client'
 instance = PDFGeneratorAPI::FormConfigurationNewActionsInner.new(
   store_document: true,
   download_document: true,
-  send_document: null
+  send_document: null,
+  sign_document: true
 )
 ```
 

data/docs/FormField.md

@@ -0,0 +1,30 @@
+# PDFGeneratorAPI::FormField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | Field label displayed in the form |  |
+| **name** | **String** | Data field name. For example \"name\" can be used as \"{name}\" in the document as placeholder. |  |
+| **type** | **String** | Field type * `text` - Free text input * `integer` - Whole number input * `number` - Decimal number input * `date` - Date picker * `signature` - Hand-drawn signature, stored as an image * `select` - Dropdown with a single choice. Requires `subRows` with options and a `default` value * `multi-select` - Dropdown with multiple choices. Requires `subRows` with options * `table` - Repeating rows of values. Its columns are defined in `subRows` * `image` - Image upload * `pdf` - PDF file upload  |  |
+| **required** | **Boolean** | Specifies if the field is required or not |  |
+| **default** | **String** | Value pre-filled in the field. Required for `select` fields and must be one of the options. Not used by `table` fields. | [optional] |
+| **description** | **String** | Help text shown with the field | [optional] |
+| **sub_rows** | [**Array<FormFieldSubRowsInner>**](FormFieldSubRowsInner.md) | Options for `select` and `multi-select` fields (a single object), columns for `table` fields. Not used by other field types. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormField.new(
+  label: Full name,
+  name: name,
+  type: text,
+  required: false,
+  default: Medium,
+  description: Enter your name as shown in your passport,
+  sub_rows: null
+)
+```
+

data/docs/FormFieldOptions.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::FormFieldOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **options** | **String** | Comma-separated list of choices. Whitespace around each choice is trimmed and choices must be unique. |  |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormFieldOptions.new(
+  options: Small,Medium,Large
+)
+```
+

data/docs/FormFieldSubRowsInner.md

@@ -0,0 +1,30 @@
+# PDFGeneratorAPI::FormFieldSubRowsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **options** | **String** | Comma-separated list of choices. Whitespace around each choice is trimmed and choices must be unique. |  |
+| **label** | **String** | Column label displayed in the form |  |
+| **name** | **String** | Data field name of the column |  |
+| **type** | **String** | Column type. `select` columns require `subRows` with options and a `default` value. |  |
+| **required** | **Boolean** | Specifies if the column is required or not |  |
+| **default** | **String** | Value pre-filled in the column. Required for `select` columns and must be one of the options. | [optional] |
+| **sub_rows** | [**Array<FormFieldOptions>**](FormFieldOptions.md) | Options for `select` columns (a single object). Not used by other column types. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormFieldSubRowsInner.new(
+  options: Small,Medium,Large,
+  label: Product,
+  name: product,
+  type: text,
+  required: false,
+  default: Medium,
+  sub_rows: null
+)
+```
+

data/docs/FormTableColumn.md

@@ -0,0 +1,28 @@
+# PDFGeneratorAPI::FormTableColumn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | Column label displayed in the form |  |
+| **name** | **String** | Data field name of the column |  |
+| **type** | **String** | Column type. `select` columns require `subRows` with options and a `default` value. |  |
+| **required** | **Boolean** | Specifies if the column is required or not |  |
+| **default** | **String** | Value pre-filled in the column. Required for `select` columns and must be one of the options. | [optional] |
+| **sub_rows** | [**Array<FormFieldOptions>**](FormFieldOptions.md) | Options for `select` columns (a single object). Not used by other column types. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormTableColumn.new(
+  label: Product,
+  name: product,
+  type: text,
+  required: false,
+  default: Medium,
+  sub_rows: null
+)
+```
+