pdf_generator_api_client 4.0.25

data/docs/InlineObject14ResponseValue.md

@@ -0,0 +1,46 @@
+# PDFGeneratorAPI::InlineObject14ResponseValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique field identifier | [optional] |
+| **type** | **String** | Field type | [optional] |
+| **name** | **String** | Field name | [optional] |
+| **value** | [**InlineObject14ResponseValueValue**](InlineObject14ResponseValueValue.md) |  | [optional] |
+| **locked** | **Boolean** | Whether the field is locked | [optional] |
+| **pages** | **Array<Integer>** | Pages where the field appears | [optional] |
+| **default** | [**InlineObject14ResponseValueDefault**](InlineObject14ResponseValueDefault.md) |  | [optional] |
+| **defaults** | **Array<String>** | Default values for multi-select fields | [optional] |
+| **values** | **Array<String>** | Selected values for multi-select fields | [optional] |
+| **options** | **Array<String>** | Available options for select fields | [optional] |
+| **format** | **String** | Field format (for date fields) | [optional] |
+| **maxlen** | **Integer** | Maximum field length | [optional] |
+| **multiline** | **Boolean** | Whether text field is multiline | [optional] |
+| **editable** | **Boolean** | Whether combo box is editable | [optional] |
+| **multi** | **Boolean** | Whether list box allows multiple selections | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject14ResponseValue.new(
+  id: 30,
+  type: textfield,
+  name: firstName,
+  value: null,
+  locked: false,
+  pages: [1],
+  default: null,
+  defaults: ["option1","option2"],
+  values: ["option1"],
+  options: ["option1","option2","option3"],
+  format: dd.mm.yyyy,
+  maxlen: 100,
+  multiline: false,
+  editable: true,
+  multi: false
+)
+```
+

data/docs/InlineObject14ResponseValueDefault.md

@@ -0,0 +1,51 @@
+# PDFGeneratorAPI::InlineObject14ResponseValueDefault
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::InlineObject14ResponseValueDefault.openapi_one_of
+# =>
+# [
+#   :'Array<String>',
+#   :'Boolean',
+#   :'String'
+# ]
+```
+
+### 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::InlineObject14ResponseValueDefault.build(data)
+# => #<Array<String>:0x00007fdd4aab02a0>
+
+PDFGeneratorAPI::InlineObject14ResponseValueDefault.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<String>`
+- `Boolean`
+- `String`
+- `nil` (if no type matches)
+

data/docs/InlineObject14ResponseValueValue.md

@@ -0,0 +1,51 @@
+# PDFGeneratorAPI::InlineObject14ResponseValueValue
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::InlineObject14ResponseValueValue.openapi_one_of
+# =>
+# [
+#   :'Array<String>',
+#   :'Boolean',
+#   :'String'
+# ]
+```
+
+### 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::InlineObject14ResponseValueValue.build(data)
+# => #<Array<String>:0x00007fdd4aab02a0>
+
+PDFGeneratorAPI::InlineObject14ResponseValueValue.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<String>`
+- `Boolean`
+- `String`
+- `nil` (if no type matches)
+

data/docs/InlineObject15.md

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

data/docs/InlineObject16.md

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

data/docs/InlineObject17.md

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

data/docs/InlineObject18.md

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

data/docs/InlineObject18Meta.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::InlineObject18Meta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_id** | **String** | Form sharing unique identifier | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject18Meta.new(
+  public_id: 097475c4-dcd5-42ca-814f-b9fa3da66b5a
+)
+```
+

data/docs/InlineObject19.md

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

data/docs/InlineObject1Response.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::InlineObject1Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** | True if template configuration was valid | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject1Response.new(
+  valid: true
+)
+```
+

data/docs/InlineObject2.md

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

data/docs/InlineObject20.md

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

data/docs/InlineObject20Response.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::InlineObject20Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** | Unique job id which is also added to the callback request as header PDF-API-Job-Id | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject20Response.new(
+  job_id: JeLjz9MKNyAwIG9iago8PCA
+)
+```
+

data/docs/InlineObject21.md

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

data/docs/InlineObject22.md

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

data/docs/InlineObject23.md

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

data/docs/InlineObject24.md

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

data/docs/InlineObject25.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::InlineObject25
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Error description | [optional] |
+| **errors** | **Object** | Details about validation errors | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject25.new(
+  message: Incorrect parameter value,
+  errors: null
+)
+```
+

data/docs/InlineObject26.md

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

data/docs/InlineObject27.md

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

data/docs/InlineObject3.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::InlineObject3
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject3.new(
+  response: https://us1.pdfgeneratorapi.com/editor/open/2ff98760d39456c4b2cf974fef005ecf
+)
+```
+

data/docs/InlineObject4.md

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

data/docs/InlineObject5.md

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

data/docs/InlineObject6.md

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

data/docs/InlineObject7.md

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

data/docs/InlineObject7Response.md

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

data/docs/InlineObject8.md

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

data/docs/InlineObject9.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::InlineObject9
+
+## 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** | [**InlineObject9Meta**](InlineObject9Meta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject9.new(
+  response: JVBERi0xLjcKJeLjz9MKNyAwIG9iago8PCAvVHlwZSA...,
+  meta: null
+)
+```
+

data/docs/InlineObject9Meta.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::InlineObject9Meta
+
+## 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, if output=url was used for document storage | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::InlineObject9Meta.new(
+  name: a2bd25b8921f3dc7a440fd7f427f90a4.pdf,
+  display_name: a2bd25b8921f3dc7a440fd7f427f90a4,
+  encoding: base64,
+  content_type: application/pdf,
+  public_id: a2bd25b8921f3dc7a440fd7f427f90a4
+)
+```
+