pdf_generator_api_client 4.0.25

data/docs/GenerateDocumentBatchRequest.md

@@ -0,0 +1,28 @@
+# PDFGeneratorAPI::GenerateDocumentBatchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template** | [**Array<TemplateParam>**](TemplateParam.md) |  | [optional] |
+| **format** | [**FormatParam**](FormatParam.md) |  | [optional][default to 'pdf'] |
+| **output** | [**OutputParam**](OutputParam.md) |  | [optional][default to 'base64'] |
+| **name** | **String** | Generated document name (optional) | [optional][default to ''] |
+| **testing** | **Boolean** | When set to true the generation is not counted as merge (monthly usage), but a large PREVIEW stamp is added. | [optional][default to false] |
+| **metadata** | [**MetadataParam**](MetadataParam.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::GenerateDocumentBatchRequest.new(
+  template: null,
+  format: null,
+  output: null,
+  name: Invoice 123,
+  testing: false,
+  metadata: null
+)
+```
+

data/docs/GenerateDocumentRequest.md

@@ -0,0 +1,30 @@
+# PDFGeneratorAPI::GenerateDocumentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template** | [**TemplateParam**](TemplateParam.md) |  | [optional] |
+| **format** | [**FormatParam**](FormatParam.md) |  | [optional][default to 'pdf'] |
+| **output** | [**OutputParam**](OutputParam.md) |  | [optional][default to 'base64'] |
+| **name** | **String** | Generated document name (optional) | [optional][default to ''] |
+| **testing** | **Boolean** | When set to true the generation is not counted as merge (monthly usage), but a large PREVIEW stamp is added. | [optional][default to false] |
+| **make_accessible** | **Boolean** | Enables semantic document tagging. When enabled, a separate Make Accessible action is executed, which consumes additional credits. | [optional][default to false] |
+| **metadata** | [**MetadataParam**](MetadataParam.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::GenerateDocumentRequest.new(
+  template: null,
+  format: null,
+  output: null,
+  name: Invoice 123,
+  testing: false,
+  make_accessible: false,
+  metadata: null
+)
+```
+

data/docs/GenerateQRCode201Response.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::GenerateQRCode201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | **String** | Base64 encoded image if the output=base64. Raw image string if output=file is used | [optional] |
+| **meta** | [**GenerateQRCode201ResponseMeta**](GenerateQRCode201ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::GenerateQRCode201Response.new(
+  response: JVBERi0xLjcKJeLjz9MKNyAwIG9iago8PCAvVHlwZSA...,
+  meta: null
+)
+```
+

data/docs/GenerateQRCode201ResponseMeta.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::GenerateQRCode201ResponseMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **encoding** | **String** | Response encoding | [optional] |
+| **content_type** | **String** | Response content type. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::GenerateQRCode201ResponseMeta.new(
+  encoding: base64,
+  content_type: image/png
+)
+```
+

data/docs/GenerateQRCodeRequest.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::GenerateQRCodeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **String** | The content which is used to generate QR code |  |
+| **color** | **String** | QR code in hexadecimal format | [optional][default to '#000000'] |
+| **logo_base64** | **String** | A logo as a base64 image string to add on the QR code | [optional] |
+| **logo_url** | **String** | A logo URL to an image to add on the QR code | [optional] |
+| **output** | **String** | Response format | [optional][default to 'base64'] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::GenerateQRCodeRequest.new(
+  content: My QR Code,
+  color: #000000,
+  logo_base64: null,
+  logo_url: null,
+  output: base64
+)
+```
+

data/docs/GetStatus200Response.md

@@ -0,0 +1,28 @@
+# PDFGeneratorAPI::GetStatus200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api** | [**StatusParam**](StatusParam.md) |  | [optional][default to 'ok'] |
+| **chart_api** | [**StatusParam**](StatusParam.md) |  | [optional][default to 'ok'] |
+| **conversion_api** | [**StatusParam**](StatusParam.md) |  | [optional][default to 'ok'] |
+| **generator_api_sync** | [**StatusParam**](StatusParam.md) |  | [optional][default to 'ok'] |
+| **generator_api_async** | [**StatusParam**](StatusParam.md) |  | [optional][default to 'ok'] |
+| **e_invoice** | [**StatusParam**](StatusParam.md) |  | [optional][default to 'ok'] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::GetStatus200Response.new(
+  api: null,
+  chart_api: null,
+  conversion_api: null,
+  generator_api_sync: null,
+  generator_api_async: null,
+  e_invoice: null
+)
+```
+

data/docs/GetTemplateLibrary200Response.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::GetTemplateLibrary200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | [**Array<PublicTemplateLibraryItem>**](PublicTemplateLibraryItem.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::GetTemplateLibrary200Response.new(
+  response: null
+)
+```
+

data/docs/GetTemplateVersion422Response.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::GetTemplateVersion422Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::GetTemplateVersion422Response.new(
+  message: Cannot delete production template version.
+)
+```
+

data/docs/ImportFormBase64.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::ImportFormBase64
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_base64** | **String** | PDF file from base64 string to import |  |
+| **form** | [**FormConfigurationNew**](FormConfigurationNew.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::ImportFormBase64.new(
+  file_base64: null,
+  form: null
+)
+```
+

data/docs/ImportFormRequest.md

@@ -0,0 +1,49 @@
+# PDFGeneratorAPI::ImportFormRequest
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::ImportFormRequest.openapi_one_of
+# =>
+# [
+#   :'ImportFormBase64',
+#   :'ImportFormUrl'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::ImportFormRequest.build(data)
+# => #<ImportFormBase64:0x00007fdd4aab02a0>
+
+PDFGeneratorAPI::ImportFormRequest.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ImportFormBase64`
+- `ImportFormUrl`
+- `nil` (if no type matches)
+

data/docs/ImportFormUrl.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::ImportFormUrl
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_url** | **String** | PDF file from remote URL to import |  |
+| **form** | [**FormConfigurationNew**](FormConfigurationNew.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::ImportFormUrl.new(
+  file_url: null,
+  form: null
+)
+```
+

data/docs/ImportTemplateBase64.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::ImportTemplateBase64
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template** | [**ImportTemplateUrlTemplate**](ImportTemplateUrlTemplate.md) |  |  |
+| **file_base64** | **String** | PDF file from base64 string to import |  |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::ImportTemplateBase64.new(
+  template: null,
+  file_base64: null
+)
+```
+

data/docs/ImportTemplateRequest.md

@@ -0,0 +1,49 @@
+# PDFGeneratorAPI::ImportTemplateRequest
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::ImportTemplateRequest.openapi_one_of
+# =>
+# [
+#   :'ImportTemplateBase64',
+#   :'ImportTemplateUrl'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::ImportTemplateRequest.build(data)
+# => #<ImportTemplateBase64:0x00007fdd4aab02a0>
+
+PDFGeneratorAPI::ImportTemplateRequest.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ImportTemplateBase64`
+- `ImportTemplateUrl`
+- `nil` (if no type matches)
+

data/docs/ImportTemplateUrl.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::ImportTemplateUrl
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template** | [**ImportTemplateUrlTemplate**](ImportTemplateUrlTemplate.md) |  |  |
+| **file_url** | **String** | PDF file from remote URL to import |  |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::ImportTemplateUrl.new(
+  template: null,
+  file_url: null
+)
+```
+

data/docs/ImportTemplateUrlTemplate.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::ImportTemplateUrlTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Template name |  |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::ImportTemplateUrlTemplate.new(
+  name: Invoice template
+)
+```
+

data/docs/InlineObject.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::InlineObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | **String** | Base64 encoded XML document if the output=base64 is used. | [optional] |
+| **meta** | [**InlineObjectMeta**](InlineObjectMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject.new(
+  response: JVBERi0xLjcKJeLjz9MKNyAwIG9iago8PCAvVHlwZSA...,
+  meta: null
+)
+```
+

data/docs/InlineObject1.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::InlineObject1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | [**InlineObject1Response**](InlineObject1Response.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject1.new(
+  response: null
+)
+```
+

data/docs/InlineObject10.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::InlineObject10
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | **Array<String>** | Array of base64 encoded images, one per converted page. | [optional] |
+| **meta** | [**InlineObject10Meta**](InlineObject10Meta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject10.new(
+  response: ["iVBORw0KGgoAAAANSUhEUgAA..."],
+  meta: null
+)
+```
+

data/docs/InlineObject10Meta.md

@@ -0,0 +1,24 @@
+# PDFGeneratorAPI::InlineObject10Meta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | File name with extension. Auto-generated if not provided in request. | [optional] |
+| **display_name** | **String** | File name without extension. | [optional] |
+| **encoding** | **String** | Encoding of the response data. | [optional] |
+| **content_type** | **String** | Image content type. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject10Meta.new(
+  name: document.png,
+  display_name: document,
+  encoding: base64,
+  content_type: image/png
+)
+```
+

data/docs/InlineObject11.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::InlineObject11
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | **String** | Public URL to the document. | [optional] |
+| **meta** | [**InlineObject11Meta**](InlineObject11Meta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject11.new(
+  response: https://us1.pdfgeneratorapi.com/api/v4/documents/66/bac8381bce1982e5f6957a0f52371336/share,
+  meta: null
+)
+```
+

data/docs/InlineObject11Meta.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::InlineObject11Meta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Document name. This value is automatically generated if name attribute is not defined in request. | [optional] |
+| **display_name** | **String** | Document name without the file extension. | [optional] |
+| **encoding** | **String** | Document encoding | [optional] |
+| **content_type** | **String** | Document content type. | [optional] |
+| **public_id** | **String** | Document public id | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject11Meta.new(
+  name: a2bd25b8921f3dc7a440fd7f427f90a4.pdf,
+  display_name: a2bd25b8921f3dc7a440fd7f427f90a4,
+  encoding: binary,
+  content_type: application/pdf,
+  public_id: bac8381bce1982e5f6957a0f52371336
+)
+```
+

data/docs/InlineObject12.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::InlineObject12
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | **String** | Base64 encoded document if the output=base64 is used or URL to the document when the output=url is used. | [optional] |
+| **meta** | [**InlineObject12Meta**](InlineObject12Meta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject12.new(
+  response: JVBERi0xLjcKJeLjz9MKNyAwIG9iago8PCAvVHlwZSA...,
+  meta: null
+)
+```
+

data/docs/InlineObject12Meta.md

@@ -0,0 +1,28 @@
+# PDFGeneratorAPI::InlineObject12Meta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Document name. This value is automatically generated if name attribute is not defined in request. | [optional] |
+| **display_name** | **String** | Document name without the file extension. | [optional] |
+| **encoding** | **String** | Document encoding | [optional] |
+| **content_type** | **String** | Document content type. | [optional] |
+| **stats** | [**InlineObject12MetaStats**](InlineObject12MetaStats.md) |  | [optional] |
+| **public_id** | **String** | Document public id, if output=url was used for document storage | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject12Meta.new(
+  name: a2bd25b8921f3dc7a440fd7f427f90a4.pdf,
+  display_name: a2bd25b8921f3dc7a440fd7f427f90a4,
+  encoding: base64,
+  content_type: application/pdf,
+  stats: null,
+  public_id: a2bd25b8921f3dc7a440fd7f427f90a4
+)
+```
+

data/docs/InlineObject12MetaStats.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::InlineObject12MetaStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **original_size** | **Float** | Document original size | [optional] |
+| **optimized_size** | **Float** | Document size after optimization | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject12MetaStats.new(
+  original_size: 1234,
+  optimized_size: 500
+)
+```
+

data/docs/InlineObject13.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::InlineObject13
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** | UUID of the async job. | [optional] |
+| **status** | **String** | Status of the async job. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject13.new(
+  job_id: 968b8a3a-e8ac-49cc-a670-25db545813ed,
+  status: published
+)
+```
+

data/docs/InlineObject14.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::InlineObject14
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | [**Hash<String, InlineObject14ResponseValue>**](InlineObject14ResponseValue.md) | Form fields extracted from the PDF document | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject14.new(
+  response: {"firstName":{"id":"30","type":"textfield","name":"firstName","value":"John","locked":false,"pages":[1],"multiline":false},"dateOfBirth":{"id":"33","type":"datefield","name":"dateOfBirth","value":"01.01.2000","format":"dd.mm.yyyy","locked":false,"pages":[1]}}
+)
+```
+