pdf_generator_api_client 8.0.28 → 8.0.31

data/docs/FormsApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
 | [**create_form**](FormsApi.md#create_form) | **POST** /forms | Create form |
 | [**delete_form**](FormsApi.md#delete_form) | **DELETE** /forms/{formId} | Delete form |
 | [**get_form**](FormsApi.md#get_form) | **GET** /forms/{formId} | Get form |
+| [**get_form_schema**](FormsApi.md#get_form_schema) | **GET** /forms/schema | Get schema |
 | [**get_forms**](FormsApi.md#get_forms) | **GET** /forms | Get forms |
 | [**import_form**](FormsApi.md#import_form) | **POST** /forms/import | Import Form |
 | [**open_form_builder**](FormsApi.md#open_form_builder) | **POST** /forms/open | Open new form builder |
@@ -17,7 +18,7 @@ All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
 
 ## create_form
 
-> <InlineObject19> create_form(form_configuration_new)
+> <InlineObject20> create_form(form_configuration_new)
 
 Create form
 
@@ -35,7 +36,7 @@ PDFGeneratorAPI.configure do |config|
 end
 
 api_instance = PDFGeneratorAPI::FormsApi.new
-form_configuration_new = PDFGeneratorAPI::FormConfigurationNew.new # FormConfigurationNew | Form configuration
+form_configuration_new = PDFGeneratorAPI::FormConfigurationNew.new({name: 'Certificate creator', actions: [PDFGeneratorAPI::FormConfigurationNewActionsInner.new], fields: [PDFGeneratorAPI::FormField.new({label: 'Full name', name: 'name', type: 'text', required: false})]}) # FormConfigurationNew | Form configuration
 
 begin
   # Create form
@@ -50,7 +51,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject19>, Integer, Hash)> create_form_with_http_info(form_configuration_new)
+> <Array(<InlineObject20>, Integer, Hash)> create_form_with_http_info(form_configuration_new)
 
 ```ruby
 begin
@@ -58,7 +59,7 @@ begin
   data, status_code, headers = api_instance.create_form_with_http_info(form_configuration_new)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject19>
+  p data # => <InlineObject20>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->create_form_with_http_info: #{e}"
 end
@@ -72,7 +73,7 @@ end
 
 ### Return type
 
-[**InlineObject19**](InlineObject19.md)
+[**InlineObject20**](InlineObject20.md)
 
 ### Authorization
 
@@ -154,7 +155,7 @@ nil (empty response body)
 
 ## get_form
 
-> <InlineObject19> get_form(form_id)
+> <InlineObject20> get_form(form_id)
 
 Get form
 
@@ -187,7 +188,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject19>, Integer, Hash)> get_form_with_http_info(form_id)
+> <Array(<InlineObject20>, Integer, Hash)> get_form_with_http_info(form_id)
 
 ```ruby
 begin
@@ -195,7 +196,7 @@ begin
   data, status_code, headers = api_instance.get_form_with_http_info(form_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject19>
+  p data # => <InlineObject20>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->get_form_with_http_info: #{e}"
 end
@@ -209,7 +210,7 @@ end
 
 ### Return type
 
-[**InlineObject19**](InlineObject19.md)
+[**InlineObject20**](InlineObject20.md)
 
 ### Authorization
 
@@ -221,6 +222,67 @@ end
 - **Accept**: application/json
 
 
+## get_form_schema
+
+> Object get_form_schema
+
+Get schema
+
+Returns Form JSON Schema which defines the structure of the Form Definition.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pdf_generator_api_client'
+
+api_instance = PDFGeneratorAPI::FormsApi.new
+
+begin
+  # Get schema
+  result = api_instance.get_form_schema
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling FormsApi->get_form_schema: #{e}"
+end
+```
+
+#### Using the get_form_schema_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> get_form_schema_with_http_info
+
+```ruby
+begin
+  # Get schema
+  data, status_code, headers = api_instance.get_form_schema_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling FormsApi->get_form_schema_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_forms
 
 > <InlineObject6> get_forms(opts)
@@ -243,7 +305,10 @@ end
 api_instance = PDFGeneratorAPI::FormsApi.new
 opts = {
   page: 1, # Integer | Pagination: page to return
-  per_page: 20 # Integer | Pagination: How many records to return per page
+  per_page: 20, # Integer | Pagination: How many records to return per page
+  order_by: 'id', # String | Field to sort the forms by
+  order_direction: 'asc', # String | Sort direction
+  search: 'Certificate' # String | Returns forms whose name or ID contains the search value
 }
 
 begin
@@ -279,6 +344,9 @@ end
 | ---- | ---- | ----------- | ----- |
 | **page** | **Integer** | Pagination: page to return | [optional][default to 1] |
 | **per_page** | **Integer** | Pagination: How many records to return per page | [optional][default to 15] |
+| **order_by** | **String** | Field to sort the forms by | [optional][default to &#39;id&#39;] |
+| **order_direction** | **String** | Sort direction | [optional][default to &#39;desc&#39;] |
+| **search** | **String** | Returns forms whose name or ID contains the search value | [optional] |
 
 ### Return type
 
@@ -296,11 +364,11 @@ end
 
 ## import_form
 
-> <InlineObject19> import_form(import_form_request)
+> <InlineObject20> import_form(import_form_request)
 
 Import Form
 
-Creates a new form based on editable PDF
+Creates a new form based on editable PDF. Form fields are created from the editable fields of the PDF. The optional `form` object sets the form name, template, actions and configuration.
 
 ### Examples
 
@@ -329,7 +397,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject19>, Integer, Hash)> import_form_with_http_info(import_form_request)
+> <Array(<InlineObject20>, Integer, Hash)> import_form_with_http_info(import_form_request)
 
 ```ruby
 begin
@@ -337,7 +405,7 @@ begin
   data, status_code, headers = api_instance.import_form_with_http_info(import_form_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject19>
+  p data # => <InlineObject20>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->import_form_with_http_info: #{e}"
 end
@@ -351,7 +419,7 @@ end
 
 ### Return type
 
-[**InlineObject19**](InlineObject19.md)
+[**InlineObject20**](InlineObject20.md)
 
 ### Authorization
 
@@ -365,7 +433,7 @@ end
 
 ## open_form_builder
 
-> <InlineObject21> open_form_builder
+> <InlineObject22> open_form_builder
 
 Open new form builder
 
@@ -397,7 +465,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject21>, Integer, Hash)> open_form_builder_with_http_info
+> <Array(<InlineObject22>, Integer, Hash)> open_form_builder_with_http_info
 
 ```ruby
 begin
@@ -405,7 +473,7 @@ begin
   data, status_code, headers = api_instance.open_form_builder_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject21>
+  p data # => <InlineObject22>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->open_form_builder_with_http_info: #{e}"
 end
@@ -417,7 +485,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**InlineObject21**](InlineObject21.md)
+[**InlineObject22**](InlineObject22.md)
 
 ### Authorization
 
@@ -431,7 +499,7 @@ This endpoint does not need any parameter.
 
 ## open_form_builder_for_existing_form
 
-> <InlineObject21> open_form_builder_for_existing_form(form_id)
+> <InlineObject22> open_form_builder_for_existing_form(form_id)
 
 Open existing form builder
 
@@ -464,7 +532,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject21>, Integer, Hash)> open_form_builder_for_existing_form_with_http_info(form_id)
+> <Array(<InlineObject22>, Integer, Hash)> open_form_builder_for_existing_form_with_http_info(form_id)
 
 ```ruby
 begin
@@ -472,7 +540,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 # => <InlineObject21>
+  p data # => <InlineObject22>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->open_form_builder_for_existing_form_with_http_info: #{e}"
 end
@@ -486,7 +554,7 @@ end
 
 ### Return type
 
-[**InlineObject21**](InlineObject21.md)
+[**InlineObject22**](InlineObject22.md)
 
 ### Authorization
 
@@ -500,7 +568,7 @@ end
 
 ## share_form
 
-> <InlineObject20> share_form(form_id)
+> <InlineObject21> share_form(form_id)
 
 Share form
 
@@ -533,7 +601,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject20>, Integer, Hash)> share_form_with_http_info(form_id)
+> <Array(<InlineObject21>, Integer, Hash)> share_form_with_http_info(form_id)
 
 ```ruby
 begin
@@ -541,7 +609,7 @@ begin
   data, status_code, headers = api_instance.share_form_with_http_info(form_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject20>
+  p data # => <InlineObject21>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->share_form_with_http_info: #{e}"
 end
@@ -555,7 +623,7 @@ end
 
 ### Return type
 
-[**InlineObject20**](InlineObject20.md)
+[**InlineObject21**](InlineObject21.md)
 
 ### Authorization
 
@@ -569,7 +637,7 @@ end
 
 ## update_form
 
-> <InlineObject19> update_form(form_id, form_configuration_new)
+> <InlineObject20> update_form(form_id, form_configuration_new)
 
 Update form
 
@@ -588,7 +656,7 @@ end
 
 api_instance = PDFGeneratorAPI::FormsApi.new
 form_id = 1 # Integer | Form unique identifier
-form_configuration_new = PDFGeneratorAPI::FormConfigurationNew.new # FormConfigurationNew | Form configuration
+form_configuration_new = PDFGeneratorAPI::FormConfigurationNew.new({name: 'Certificate creator', actions: [PDFGeneratorAPI::FormConfigurationNewActionsInner.new], fields: [PDFGeneratorAPI::FormField.new({label: 'Full name', name: 'name', type: 'text', required: false})]}) # FormConfigurationNew | Form configuration
 
 begin
   # Update form
@@ -603,7 +671,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject19>, Integer, Hash)> update_form_with_http_info(form_id, form_configuration_new)
+> <Array(<InlineObject20>, Integer, Hash)> update_form_with_http_info(form_id, form_configuration_new)
 
 ```ruby
 begin
@@ -611,7 +679,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 # => <InlineObject19>
+  p data # => <InlineObject20>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling FormsApi->update_form_with_http_info: #{e}"
 end
@@ -626,7 +694,7 @@ end
 
 ### Return type
 
-[**InlineObject19**](InlineObject19.md)
+[**InlineObject20**](InlineObject20.md)
 
 ### Authorization
 

data/docs/ImportFormBase64.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **file_base64** | **String** | PDF file from base64 string to import |  |
-| **form** | [**FormConfigurationNew**](FormConfigurationNew.md) |  | [optional] |
+| **form** | [**FormConfigurationImport**](FormConfigurationImport.md) |  | [optional] |
 
 ## Example
 

data/docs/ImportFormUrl.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **file_url** | **String** | PDF file from remote URL to import |  |
-| **form** | [**FormConfigurationNew**](FormConfigurationNew.md) |  | [optional] |
+| **form** | [**FormConfigurationImport**](FormConfigurationImport.md) |  | [optional] |
 
 ## Example
 

data/docs/InlineObject17.md

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

data/docs/InlineObject18.md

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

data/docs/InlineObject19.md

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

data/docs/InlineObject20.md

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

data/docs/InlineObject21.md

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

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

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

data/docs/InlineObject22.md

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

data/docs/InlineObject23.md

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

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

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

data/docs/InlineObject24.md

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

data/docs/InlineObject25.md

@@ -12,7 +12,7 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject25.new(
-  message: Access not granted
+  message: Account Suspended
 )
 ```
 

data/docs/InlineObject26.md

@@ -12,7 +12,7 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject26.new(
-  message: Entity not found
+  message: Access not granted
 )
 ```
 

data/docs/InlineObject27.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::InlineObject27.new(
-  message: Incorrect parameter value,
-  errors: null
+  message: Entity not found
 )
 ```
 

data/docs/InlineObject28.md

@@ -12,7 +12,7 @@
 require 'pdf_generator_api_client'
 
 instance = PDFGeneratorAPI::InlineObject28.new(
-  message: You can make up to 2 requests per second and 60 requests per minute.
+  message: The document is no longer available
 )
 ```
 

data/docs/InlineObject29.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::InlineObject29.new(
-  message: Internal error
+  message: Incorrect parameter value,
+  errors: null
 )
 ```
 

data/docs/InlineObject30.md

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

data/docs/InlineObject31.md

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