pdf_generator_api_client 4.0.25

data/docs/TemplateDefinitionNewEditor.md

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

data/docs/TemplateDefinitionNewLayout.md

@@ -0,0 +1,34 @@
+# PDFGeneratorAPI::TemplateDefinitionNewLayout
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **format** | **String** | Defines template page size | [optional][default to 'A4'] |
+| **width** | **Float** | Page width in units | [optional] |
+| **height** | **Float** | Page height in units | [optional] |
+| **unit** | **String** | Measure unit | [optional][default to 'cm'] |
+| **orientation** | **String** | Page orientation | [optional] |
+| **rotation** | **Integer** | Page rotation in degrees | [optional] |
+| **margins** | [**TemplateDefinitionNewLayoutMargins**](TemplateDefinitionNewLayoutMargins.md) |  | [optional] |
+| **repeat_layout** | [**TemplateDefinitionNewLayoutRepeatLayout**](TemplateDefinitionNewLayoutRepeatLayout.md) |  | [optional] |
+| **empty_labels** | **Integer** | Specifies how many blank lables to add to sheet label. | [optional][default to 0] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::TemplateDefinitionNewLayout.new(
+  format: A4,
+  width: 21,
+  height: 29.7,
+  unit: cm,
+  orientation: portrait,
+  rotation: 0,
+  margins: null,
+  repeat_layout: null,
+  empty_labels: 0
+)
+```
+

data/docs/TemplateDefinitionNewLayoutMargins.md

@@ -0,0 +1,24 @@
+# PDFGeneratorAPI::TemplateDefinitionNewLayoutMargins
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **top** | **Float** |  | [optional] |
+| **right** | **Float** |  | [optional] |
+| **bottom** | **Float** |  | [optional] |
+| **left** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::TemplateDefinitionNewLayoutMargins.new(
+  top: 0.5,
+  right: 0.5,
+  bottom: 0.5,
+  left: 0.5
+)
+```
+

data/docs/TemplateDefinitionNewLayoutRepeatLayout.md

@@ -0,0 +1,22 @@
+# PDFGeneratorAPI::TemplateDefinitionNewLayoutRepeatLayout
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **format** | **String** | Defines template page size | [optional] |
+| **width** | **Float** | Page width in units | [optional] |
+| **height** | **Float** | Page height in units | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::TemplateDefinitionNewLayoutRepeatLayout.new(
+  format: A4,
+  width: 21,
+  height: 29.7
+)
+```
+

data/docs/TemplateDefinitionNewPagesInner.md

@@ -0,0 +1,32 @@
+# PDFGeneratorAPI::TemplateDefinitionNewPagesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **width** | **Float** | Page width in units | [optional] |
+| **height** | **Float** | Page height in units | [optional] |
+| **margins** | [**TemplateDefinitionNewPagesInnerMargins**](TemplateDefinitionNewPagesInnerMargins.md) |  | [optional] |
+| **border** | **Boolean** |  | [optional][default to false] |
+| **components** | **Array<Object>** |  | [optional] |
+| **layout** | **Object** | Defines page specific layout which can differ from the main template layout (e.g page format, margins). | [optional] |
+| **conditional_formats** | **Array<Object>** |  | [optional] |
+| **background_image** | **String** | Defines background image for the page. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::TemplateDefinitionNewPagesInner.new(
+  width: 21,
+  height: 29.7,
+  margins: null,
+  border: false,
+  components: [],
+  layout: null,
+  conditional_formats: [],
+  background_image: null
+)
+```
+

data/docs/TemplateDefinitionNewPagesInnerMargins.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::TemplateDefinitionNewPagesInnerMargins
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **right** | **Float** | Page or label margin from right | [optional] |
+| **bottom** | **Float** | Page or label margin from bottom | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::TemplateDefinitionNewPagesInnerMargins.new(
+  right: 0.5,
+  bottom: 0.5
+)
+```
+

data/docs/TemplateDefinitionPagesInner.md

@@ -0,0 +1,24 @@
+# PDFGeneratorAPI::TemplateDefinitionPagesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **width** | **Float** | Page width in units | [optional] |
+| **height** | **Float** | Page height in units | [optional] |
+| **margins** | [**TemplateDefinitionNewPagesInnerMargins**](TemplateDefinitionNewPagesInnerMargins.md) |  | [optional] |
+| **components** | **Array<Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::TemplateDefinitionPagesInner.new(
+  width: 21,
+  height: 29.7,
+  margins: null,
+  components: null
+)
+```
+

data/docs/TemplateLibraryApi.md

@@ -0,0 +1,139 @@
+# PDFGeneratorAPI::TemplateLibraryApi
+
+All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_template_library**](TemplateLibraryApi.md#get_template_library) | **GET** /templates/library | Get template library |
+| [**get_template_library_item**](TemplateLibraryApi.md#get_template_library_item) | **GET** /templates/library/{publicId} | Open template from the library |
+
+
+## get_template_library
+
+> <GetTemplateLibrary200Response> get_template_library(opts)
+
+Get template library
+
+Returns a list of publicly available templates from the template library. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'pdf_generator_api_client'
+
+api_instance = PDFGeneratorAPI::TemplateLibraryApi.new
+opts = {
+  tags: 'tags_example' # String | Filter template by tags
+}
+
+begin
+  # Get template library
+  result = api_instance.get_template_library(opts)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplateLibraryApi->get_template_library: #{e}"
+end
+```
+
+#### Using the get_template_library_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetTemplateLibrary200Response>, Integer, Hash)> get_template_library_with_http_info(opts)
+
+```ruby
+begin
+  # Get template library
+  data, status_code, headers = api_instance.get_template_library_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetTemplateLibrary200Response>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplateLibraryApi->get_template_library_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tags** | **String** | Filter template by tags | [optional] |
+
+### Return type
+
+[**GetTemplateLibrary200Response**](GetTemplateLibrary200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_template_library_item
+
+> <InlineObject16> get_template_library_item(public_id)
+
+Open template from the library
+
+Returns the template definition for a public template identified by its `public_id`. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'pdf_generator_api_client'
+
+api_instance = PDFGeneratorAPI::TemplateLibraryApi.new
+public_id = 'bac8381bce1982e5f6957a0f52371336' # String | Resource public id
+
+begin
+  # Open template from the library
+  result = api_instance.get_template_library_item(public_id)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplateLibraryApi->get_template_library_item: #{e}"
+end
+```
+
+#### Using the get_template_library_item_with_http_info variant
+
+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)
+
+```ruby
+begin
+  # Open template from the library
+  data, status_code, headers = api_instance.get_template_library_item_with_http_info(public_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject16>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplateLibraryApi->get_template_library_item_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_id** | **String** | Resource public id |  |
+
+### Return type
+
+[**InlineObject16**](InlineObject16.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TemplateParam.md

@@ -0,0 +1,22 @@
+# PDFGeneratorAPI::TemplateParam
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | [**TemplateParamId**](TemplateParamId.md) |  | [optional] |
+| **version_id** | **Integer** | Template version ID | [optional] |
+| **data** | [**TemplateParamData**](TemplateParamData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::TemplateParam.new(
+  id: null,
+  version_id: 12,
+  data: null
+)
+```
+

data/docs/TemplateParamData.md

@@ -0,0 +1,49 @@
+# PDFGeneratorAPI::TemplateParamData
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::TemplateParamData.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::TemplateParamData.build(data)
+# => #<Array<Object>:0x00007fdd4aab02a0>
+
+PDFGeneratorAPI::TemplateParamData.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/TemplateParamId.md

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

data/docs/TemplateVersion.md

@@ -0,0 +1,36 @@
+# PDFGeneratorAPI::TemplateVersion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **template_id** | **Integer** |  | [optional] |
+| **template_name** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **checksum** | **String** |  | [optional] |
+| **user_id** | **Integer** |  | [optional] |
+| **user_name** | **String** |  | [optional] |
+| **is_production** | **Boolean** |  | [optional] |
+| **created_at** | **String** |  | [optional] |
+| **updated_at** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::TemplateVersion.new(
+  id: 25,
+  template_id: 343123,
+  template_name: withered-star-1234,
+  name: plain-mouse-9765,
+  checksum: ab12345940035a392019ca6386a037ae01234567,
+  user_id: null,
+  user_name: 13243,
+  is_production: true,
+  created_at: 2025-11-13 14:38:02,
+  updated_at: 2025-11-13 14:38:05
+)
+```
+

data/docs/TemplateVersionCollection.md

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

data/docs/TemplateVersionCollectionMeta.md

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