pdf_generator_api_client 8.0.25 → 8.0.27

data/docs/FormsApi.md

@@ -17,7 +17,7 @@ All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
 
 ## create_form
 
-> <InlineObject17> create_form(form_configuration_new)
+> <InlineObject19> create_form(form_configuration_new)
 
 Create form
 
@@ -50,7 +50,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject17>, Integer, Hash)> create_form_with_http_info(form_configuration_new)
+> <Array(<InlineObject19>, Integer, Hash)> create_form_with_http_info(form_configuration_new)
 
 ```ruby
 begin
@@ -58,7 +58,7 @@ begin
   data, status_code, headers = api_instance.create_form_with_http_info(form_configuration_new)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject17>
+  p data # => <InlineObject19>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->create_form_with_http_info: #{e}"
 end
@@ -72,7 +72,7 @@ end
 
 ### Return type
 
-[**InlineObject17**](InlineObject17.md)
+[**InlineObject19**](InlineObject19.md)
 
 ### Authorization
 
@@ -154,7 +154,7 @@ nil (empty response body)
 
 ## get_form
 
-> <InlineObject17> get_form(form_id)
+> <InlineObject19> get_form(form_id)
 
 Get form
 
@@ -187,7 +187,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject17>, Integer, Hash)> get_form_with_http_info(form_id)
+> <Array(<InlineObject19>, Integer, Hash)> get_form_with_http_info(form_id)
 
 ```ruby
 begin
@@ -195,7 +195,7 @@ begin
   data, status_code, headers = api_instance.get_form_with_http_info(form_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject17>
+  p data # => <InlineObject19>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->get_form_with_http_info: #{e}"
 end
@@ -209,7 +209,7 @@ end
 
 ### Return type
 
-[**InlineObject17**](InlineObject17.md)
+[**InlineObject19**](InlineObject19.md)
 
 ### Authorization
 
@@ -296,7 +296,7 @@ end
 
 ## import_form
 
-> <InlineObject17> import_form(import_form_request)
+> <InlineObject19> import_form(import_form_request)
 
 Import Form
 
@@ -329,7 +329,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject17>, Integer, Hash)> import_form_with_http_info(import_form_request)
+> <Array(<InlineObject19>, Integer, Hash)> import_form_with_http_info(import_form_request)
 
 ```ruby
 begin
@@ -337,7 +337,7 @@ begin
   data, status_code, headers = api_instance.import_form_with_http_info(import_form_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject17>
+  p data # => <InlineObject19>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->import_form_with_http_info: #{e}"
 end
@@ -351,7 +351,7 @@ end
 
 ### Return type
 
-[**InlineObject17**](InlineObject17.md)
+[**InlineObject19**](InlineObject19.md)
 
 ### Authorization
 
@@ -365,7 +365,7 @@ end
 
 ## open_form_builder
 
-> <InlineObject19> open_form_builder
+> <InlineObject21> open_form_builder
 
 Open new form builder
 
@@ -397,7 +397,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject19>, Integer, Hash)> open_form_builder_with_http_info
+> <Array(<InlineObject21>, Integer, Hash)> open_form_builder_with_http_info
 
 ```ruby
 begin
@@ -405,7 +405,7 @@ begin
   data, status_code, headers = api_instance.open_form_builder_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject19>
+  p data # => <InlineObject21>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->open_form_builder_with_http_info: #{e}"
 end
@@ -417,7 +417,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**InlineObject19**](InlineObject19.md)
+[**InlineObject21**](InlineObject21.md)
 
 ### Authorization
 
@@ -431,7 +431,7 @@ This endpoint does not need any parameter.
 
 ## open_form_builder_for_existing_form
 
-> <InlineObject19> open_form_builder_for_existing_form(form_id)
+> <InlineObject21> open_form_builder_for_existing_form(form_id)
 
 Open existing form builder
 
@@ -464,7 +464,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject19>, Integer, Hash)> open_form_builder_for_existing_form_with_http_info(form_id)
+> <Array(<InlineObject21>, Integer, Hash)> open_form_builder_for_existing_form_with_http_info(form_id)
 
 ```ruby
 begin
@@ -472,7 +472,7 @@ begin
   data, status_code, headers = api_instance.open_form_builder_for_existing_form_with_http_info(form_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject19>
+  p data # => <InlineObject21>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->open_form_builder_for_existing_form_with_http_info: #{e}"
 end
@@ -486,7 +486,7 @@ end
 
 ### Return type
 
-[**InlineObject19**](InlineObject19.md)
+[**InlineObject21**](InlineObject21.md)
 
 ### Authorization
 
@@ -500,7 +500,7 @@ end
 
 ## share_form
 
-> <InlineObject18> share_form(form_id)
+> <InlineObject20> share_form(form_id)
 
 Share form
 
@@ -533,7 +533,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject18>, Integer, Hash)> share_form_with_http_info(form_id)
+> <Array(<InlineObject20>, Integer, Hash)> share_form_with_http_info(form_id)
 
 ```ruby
 begin
@@ -541,7 +541,7 @@ begin
   data, status_code, headers = api_instance.share_form_with_http_info(form_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject18>
+  p data # => <InlineObject20>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->share_form_with_http_info: #{e}"
 end
@@ -555,7 +555,7 @@ end
 
 ### Return type
 
-[**InlineObject18**](InlineObject18.md)
+[**InlineObject20**](InlineObject20.md)
 
 ### Authorization
 
@@ -569,7 +569,7 @@ end
 
 ## update_form
 
-> <InlineObject17> update_form(form_id, form_configuration_new)
+> <InlineObject19> update_form(form_id, form_configuration_new)
 
 Update form
 
@@ -603,7 +603,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject17>, Integer, Hash)> update_form_with_http_info(form_id, form_configuration_new)
+> <Array(<InlineObject19>, Integer, Hash)> update_form_with_http_info(form_id, form_configuration_new)
 
 ```ruby
 begin
@@ -611,7 +611,7 @@ begin
   data, status_code, headers = api_instance.update_form_with_http_info(form_id, form_configuration_new)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject17>
+  p data # => <InlineObject19>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->update_form_with_http_info: #{e}"
 end
@@ -626,7 +626,7 @@ end
 
 ### Return type
 
-[**InlineObject17**](InlineObject17.md)
+[**InlineObject19**](InlineObject19.md)
 
 ### Authorization
 

data/docs/GenerateViewerUrl200Response.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::GenerateViewerUrl200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | **String** | Public URL to the PDF viewer. | [optional] |
+| **meta** | [**GenerateViewerUrl200ResponseMeta**](GenerateViewerUrl200ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::GenerateViewerUrl200Response.new(
+  response: null,
+  meta: null
+)
+```
+

data/docs/GenerateViewerUrl200ResponseMeta.md

@@ -0,0 +1,22 @@
+# PDFGeneratorAPI::GenerateViewerUrl200ResponseMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **display_name** | **String** |  | [optional] |
+| **public_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::GenerateViewerUrl200ResponseMeta.new(
+  name: null,
+  display_name: null,
+  public_id: null
+)
+```
+

data/docs/GenerateViewerUrlRequest.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::GenerateViewerUrlRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **output** | **String** | Response format. `url` returns a public URL to the stored document; `viewer` returns a public URL to the PDF viewer (with encrypted prefill when provided). | [optional][default to 'url'] |
+| **prefill** | [**PrefillParam**](PrefillParam.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::GenerateViewerUrlRequest.new(
+  output: viewer,
+  prefill: null
+)
+```
+

data/docs/InlineObject16.md

@@ -4,8 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **response** | [**TemplateDefinition**](TemplateDefinition.md) |  | [optional] |
-| **meta** | **Object** |  | [optional] |
+| **response** | [**Array<DocumentVersion>**](DocumentVersion.md) |  | [optional] |
 
 ## Example
 
@@ -13,8 +12,7 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject16.new(
-  response: null,
-  meta: null
+  response: null
 )
 ```
 

data/docs/InlineObject17.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **response** | [**FormConfiguration**](FormConfiguration.md) |  | [optional] |
+| **response** | [**Array<DocumentAction>**](DocumentAction.md) |  | [optional] |
 
 ## Example
 

data/docs/InlineObject18.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **response** | **String** | Public URL for form data collection | [optional] |
-| **meta** | [**InlineObject18Meta**](InlineObject18Meta.md) |  | [optional] |
+| **response** | [**TemplateDefinition**](TemplateDefinition.md) |  | [optional] |
+| **meta** | **Object** |  | [optional] |
 
 ## Example
 
@@ -13,7 +13,7 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject18.new(
-  response: https://app.pdfgeneratorapi.com/forms/097475c4-dcd5-42ca-814f-b9fa3da66b5a/share,
+  response: null,
   meta: null
 )
 ```

data/docs/InlineObject19.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **response** | **String** | URL to open the embeddable Form Builder | [optional] |
+| **response** | [**FormConfiguration**](FormConfiguration.md) |  | [optional] |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject19.new(
-  response: https://app.pdfgeneratorapi.com/forms/builder/097475c4-dcd5-42ca-814f-b9fa3da66b5a
+  response: null
 )
 ```
 

data/docs/InlineObject20.md

@@ -4,7 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **response** | [**InlineObject20Response**](InlineObject20Response.md) |  | [optional] |
+| **response** | **String** | Public URL for form data collection | [optional] |
+| **meta** | [**InlineObject20Meta**](InlineObject20Meta.md) |  | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject20.new(
-  response: null
+  response: https://app.pdfgeneratorapi.com/forms/097475c4-dcd5-42ca-814f-b9fa3da66b5a/share,
+  meta: null
 )
 ```
 

data/docs/{InlineObject18Meta.md → InlineObject20Meta.md}

@@ -1,4 +1,4 @@
-# PDFGeneratorAPI::InlineObject18Meta
+# PDFGeneratorAPI::InlineObject20Meta
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'pdf_generator_api_client'
 
-instance = PDFGeneratorAPI::InlineObject18Meta.new(
+instance = PDFGeneratorAPI::InlineObject20Meta.new(
   public_id: 097475c4-dcd5-42ca-814f-b9fa3da66b5a
 )
 ```

data/docs/InlineObject21.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **message** | **String** | Error description | [optional] |
+| **response** | **String** | URL to open the embeddable Form Builder | [optional] |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject21.new(
-  message: Authentication failed
+  response: https://app.pdfgeneratorapi.com/forms/builder/097475c4-dcd5-42ca-814f-b9fa3da66b5a
 )
 ```
 

data/docs/InlineObject22.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **message** | **String** | Error description | [optional] |
+| **response** | [**InlineObject22Response**](InlineObject22Response.md) |  | [optional] |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject22.new(
-  message: Account Suspended
+  response: null
 )
 ```
 

data/docs/{InlineObject20Response.md → InlineObject22Response.md}

@@ -1,4 +1,4 @@
-# PDFGeneratorAPI::InlineObject20Response
+# PDFGeneratorAPI::InlineObject22Response
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'pdf_generator_api_client'
 
-instance = PDFGeneratorAPI::InlineObject20Response.new(
+instance = PDFGeneratorAPI::InlineObject22Response.new(
   job_id: JeLjz9MKNyAwIG9iago8PCA
 )
 ```

data/docs/InlineObject23.md

@@ -12,7 +12,7 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject23.new(
-  message: Access not granted
+  message: Authentication failed
 )
 ```
 

data/docs/InlineObject24.md

@@ -12,7 +12,7 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject24.new(
-  message: Entity not found
+  message: Account Suspended
 )
 ```
 

data/docs/InlineObject25.md

@@ -5,7 +5,6 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **message** | **String** | Error description | [optional] |
-| **errors** | **Object** | Details about validation errors | [optional] |
 
 ## Example
 
@@ -13,8 +12,7 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject25.new(
-  message: Incorrect parameter value,
-  errors: null
+  message: Access not granted
 )
 ```
 

data/docs/InlineObject26.md

@@ -12,7 +12,7 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject26.new(
-  message: You can make up to 2 requests per second and 60 requests per minute.
+  message: Entity not found
 )
 ```
 

data/docs/InlineObject27.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **message** | **String** | Error description | [optional] |
+| **errors** | **Object** | Details about validation errors | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject27.new(
-  message: Internal error
+  message: Incorrect parameter value,
+  errors: null
 )
 ```
 

data/docs/InlineObject28.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::InlineObject28
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Error description | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject28.new(
+  message: You can make up to 2 requests per second and 60 requests per minute.
+)
+```
+

data/docs/InlineObject29.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::InlineObject29
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Error description | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject29.new(
+  message: Internal error
+)
+```
+

data/docs/PrefillParam.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::PrefillParam
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id_code** | **String** |  | [optional] |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **editable** | **Boolean** |  | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::PrefillParam.new(
+  id_code: null,
+  first_name: null,
+  last_name: null,
+  email: null,
+  editable: null
+)
+```
+

data/docs/StoreDocumentRequest.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **file_base64** | **String** | Base64 encoded PDF file. Required if file_url is not provided. | [optional] |
 | **file_url** | **String** | Public HTTPS URL to a PDF file. Required if file_base64 is not provided. | [optional] |
+| **prefill** | [**PrefillParam**](PrefillParam.md) |  | [optional] |
 | **name** | **String** | Generated document name (optional) | [optional][default to ''] |
 | **output** | **String** | Response format. `url` returns a public URL to the stored document; `viewer` returns a public URL to the PDF viewer. | [optional][default to 'url'] |
 
@@ -17,6 +18,7 @@ require 'pdf_generator_api_client'
 instance = PDFGeneratorAPI::StoreDocumentRequest.new(
   file_base64: JVBERi0xLjcKJeLjz9MKNyAwIG9iago8...,
   file_url: https://example.org/document.pdf,
+  prefill: null,
   name: Invoice 123,
   output: url
 )

data/docs/TemplateLibraryApi.md

@@ -76,7 +76,7 @@ No authorization required
 
 ## get_template_library_item
 
-> <InlineObject16> get_template_library_item(public_id)
+> <InlineObject18> get_template_library_item(public_id)
 
 Open template from the library
 
@@ -104,7 +104,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject16>, Integer, Hash)> get_template_library_item_with_http_info(public_id)
+> <Array(<InlineObject18>, Integer, Hash)> get_template_library_item_with_http_info(public_id)
 
 ```ruby
 begin
@@ -112,7 +112,7 @@ begin
   data, status_code, headers = api_instance.get_template_library_item_with_http_info(public_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject16>
+  p data # => <InlineObject18>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling TemplateLibraryApi->get_template_library_item_with_http_info: #{e}"
 end
@@ -126,7 +126,7 @@ end
 
 ### Return type
 
-[**InlineObject16**](InlineObject16.md)
+[**InlineObject18**](InlineObject18.md)
 
 ### Authorization