pdf_generator_api_client 4.0.25

data/docs/InlineObjectMeta.md

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

data/docs/KeyFieldParam.md

@@ -0,0 +1,15 @@
+# PDFGeneratorAPI::KeyFieldParam
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::KeyFieldParam.new()
+```
+

data/docs/MakeAccessibleBase64.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::MakeAccessibleBase64
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_base64** | **String** | PDF document in base64 encoded string format |  |
+| **options** | [**Array<AccessibilityOption>**](AccessibilityOption.md) | Accessibility processing options | [optional] |
+| **name** | **String** | Name for the PDF file | [optional] |
+| **output** | **String** | Returned document output format | [optional][default to 'base64'] |
+| **metadata** | [**MetadataParam**](MetadataParam.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::MakeAccessibleBase64.new(
+  file_base64: null,
+  options: null,
+  name: null,
+  output: null,
+  metadata: null
+)
+```
+

data/docs/MakeAccessibleRequest.md

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

data/docs/MakeAccessibleUrl.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::MakeAccessibleUrl
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_url** | **String** | Public URL to a PDF document |  |
+| **options** | [**Array<AccessibilityOption>**](AccessibilityOption.md) | Accessibility processing options | [optional] |
+| **name** | **String** | Name for the PDF file | [optional] |
+| **output** | **String** | Returned document output format | [optional][default to 'base64'] |
+| **metadata** | [**MetadataParam**](MetadataParam.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::MakeAccessibleUrl.new(
+  file_url: null,
+  options: null,
+  name: null,
+  output: null,
+  metadata: null
+)
+```
+

data/docs/MetadataParam.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::MetadataParam
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **author** | **String** | Document author | [optional][default to 'Organization name'] |
+| **language** | **String** | Document language | [optional][default to 'en'] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::MetadataParam.new(
+  author: null,
+  language: null
+)
+```
+

data/docs/MiscApi.md

@@ -0,0 +1,74 @@
+# PDFGeneratorAPI::MiscApi
+
+All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_status**](MiscApi.md#get_status) | **GET** /status | Get Service Status |
+
+
+## get_status
+
+> <GetStatus200Response> get_status
+
+Get Service Status
+
+Returns service status / health
+
+### 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::MiscApi.new
+
+begin
+  # Get Service Status
+  result = api_instance.get_status
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling MiscApi->get_status: #{e}"
+end
+```
+
+#### Using the get_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetStatus200Response>, Integer, Hash)> get_status_with_http_info
+
+```ruby
+begin
+  # Get Service Status
+  data, status_code, headers = api_instance.get_status_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetStatus200Response>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling MiscApi->get_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetStatus200Response**](GetStatus200Response.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/OpenEditorRequest.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::OpenEditorRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**OpenEditorRequestData**](OpenEditorRequestData.md) |  | [optional] |
+| **language** | **String** | Specify the editor UI language. Defaults to organization editor language. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::OpenEditorRequest.new(
+  data: null,
+  language: null
+)
+```
+

data/docs/OpenEditorRequestData.md

@@ -0,0 +1,49 @@
+# PDFGeneratorAPI::OpenEditorRequestData
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::OpenEditorRequestData.openapi_one_of
+# =>
+# [
+#   :'Array<Object>',
+#   :'Object'
+# ]
+```
+
+### 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::OpenEditorRequestData.build(data)
+# => #<Array<Object>:0x00007fdd4aab02a0>
+
+PDFGeneratorAPI::OpenEditorRequestData.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<Object>`
+- `Object`
+- `nil` (if no type matches)
+

data/docs/OptimizeBase64.md

@@ -0,0 +1,22 @@
+# PDFGeneratorAPI::OptimizeBase64
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_base64** | **String** | PDF document in base64 encoded string format |  |
+| **name** | **String** | Name for the PDF file | [optional] |
+| **output** | **String** | Returned document output format | [optional][default to 'base64'] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::OptimizeBase64.new(
+  file_base64: null,
+  name: null,
+  output: null
+)
+```
+

data/docs/OptimizeDocumentRequest.md

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

data/docs/OptimizeUrl.md

@@ -0,0 +1,22 @@
+# PDFGeneratorAPI::OptimizeUrl
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_url** | **String** | Public URL to a PDF document |  |
+| **name** | **String** | Name for the PDF file | [optional] |
+| **output** | **String** | Returned document output format | [optional][default to 'base64'] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::OptimizeUrl.new(
+  file_url: null,
+  name: null,
+  output: null
+)
+```
+

data/docs/OutputParam.md

@@ -0,0 +1,15 @@
+# PDFGeneratorAPI::OutputParam
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::OutputParam.new()
+```
+

data/docs/PaginationMeta.md

@@ -0,0 +1,22 @@
+# PDFGeneratorAPI::PaginationMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **current_page** | **Float** |  | [optional] |
+| **last_page** | **Float** |  | [optional] |
+| **per_page** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::PaginationMeta.new(
+  current_page: 1,
+  last_page: 1,
+  per_page: 15
+)
+```
+

data/docs/PromoteTemplateVersion200Response.md

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

data/docs/PublicTemplateLibraryItem.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::PublicTemplateLibraryItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique public identifier of the template | [optional] |
+| **name** | **String** | Template name | [optional] |
+| **tags** | **Array<String>** | A list of tags assigned to a public template | [optional] |
+| **preview_image_url** | **String** | URL to the template preview image | [optional] |
+| **sample_data_url** | **String** | URL to the template sample data | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::PublicTemplateLibraryItem.new(
+  id: public-template-id,
+  name: Invoice template,
+  tags: ["invoice","orders"],
+  preview_image_url: https://example.com/preview.png,
+  sample_data_url: https://example.com/sample-data.json
+)
+```
+