pdf_generator_api_client 8.0.25 → 8.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87a64351373a16d7a753c6bc6bf11a7588b13f8d153d51fb1b3d385f5309af8f
-  data.tar.gz: 192cc101fa056c751e2ced75a4180a4f283df0a10a856a1c28a0fb60be05cbdb
+  metadata.gz: aed8868b04692c214f895129498b688f247781bc3064ee65c02caf62c250222e
+  data.tar.gz: 0e65a7103c185cfb86b6006c198cc853a51c75110e6725cce0be6bfa8c018141
 SHA512:
-  metadata.gz: a7d01880bd72c39bce7648af01853b02799258144f300dc5096504075ee757a146476629d5a5b0321f09cac0c7780d74bc9ec820be6d3b0241658d79ab1d3720
-  data.tar.gz: fe35fe416936719299f32d2af146e5d24f8102b5ab6727d0108c85571ad62a89aa06d757432fd4c108a421b2b50ea5197c5b39677f2a4f27f6eec284ed3a53d2
+  metadata.gz: 3aa52cb806180a06c1cd7d39f41d95ceec2bfb1f7045bed6ebd16ce206ff80bab1efc0cc8144b4c9d5fc379ce62f88ae1f6947dbca8b7dc34c53468fa58c4ddd
+  data.tar.gz: 98ea5cad0c7e9b0b74f3f9745d2843a350b23edd272c4945cb06a4ac0ac90d811a11abb62a9ef26808f25bd9a813e506b93cb997e7e8f47643195ce0b504d9fd

data/README.md

@@ -234,8 +234,8 @@ You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 4.0.25
-- Package version: 8.0.25
+- API version: 4.0.27
+- Package version: 8.0.27
 - Generator version: 7.14.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://support.pdfgeneratorapi.com](https://support.pdfgeneratorapi.com)
@@ -253,16 +253,16 @@ gem build pdf_generator_api_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./pdf_generator_api_client-8.0.25.gem
+gem install ./pdf_generator_api_client-8.0.27.gem
 ```
 
-(for development, run `gem install --dev ./pdf_generator_api_client-8.0.25.gem` to install the development dependencies)
+(for development, run `gem install --dev ./pdf_generator_api_client-8.0.27.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'pdf_generator_api_client', '~> 8.0.25'
+    gem 'pdf_generator_api_client', '~> 8.0.27'
 
 ### Install from Git
 
@@ -322,8 +322,11 @@ Class | Method | HTTP request | Description
 *PDFGeneratorAPI::DocumentsApi* | [**generate_document_asynchronous**](docs/DocumentsApi.md#generate_document_asynchronous) | **POST** /documents/generate/async | Generate document (async)
 *PDFGeneratorAPI::DocumentsApi* | [**generate_document_batch**](docs/DocumentsApi.md#generate_document_batch) | **POST** /documents/generate/batch | Generate document (batch)
 *PDFGeneratorAPI::DocumentsApi* | [**generate_document_batch_asynchronous**](docs/DocumentsApi.md#generate_document_batch_asynchronous) | **POST** /documents/generate/batch/async | Generate document (batch + async)
+*PDFGeneratorAPI::DocumentsApi* | [**generate_viewer_url**](docs/DocumentsApi.md#generate_viewer_url) | **POST** /documents/{publicId} | Get document with prefill
 *PDFGeneratorAPI::DocumentsApi* | [**get_async_job_status**](docs/DocumentsApi.md#get_async_job_status) | **GET** /documents/async/{jobId} | Get job status
 *PDFGeneratorAPI::DocumentsApi* | [**get_document**](docs/DocumentsApi.md#get_document) | **GET** /documents/{publicId} | Get document
+*PDFGeneratorAPI::DocumentsApi* | [**get_document_actions**](docs/DocumentsApi.md#get_document_actions) | **GET** /documents/{publicId}/actions | Get document actions
+*PDFGeneratorAPI::DocumentsApi* | [**get_document_versions**](docs/DocumentsApi.md#get_document_versions) | **GET** /documents/{publicId}/versions | Get document versions
 *PDFGeneratorAPI::DocumentsApi* | [**get_documents**](docs/DocumentsApi.md#get_documents) | **GET** /documents | Get documents
 *PDFGeneratorAPI::DocumentsApi* | [**store_document**](docs/DocumentsApi.md#store_document) | **POST** /documents | Store document
 *PDFGeneratorAPI::EInvoicesApi* | [**create_e_invoice**](docs/EInvoicesApi.md#create_e_invoice) | **POST** /einvoice | Create eInvoice
@@ -387,6 +390,9 @@ Class | Method | HTTP request | Description
  - [PDFGeneratorAPI::CreateWorkspaceRequest](docs/CreateWorkspaceRequest.md)
  - [PDFGeneratorAPI::DataBatchInner](docs/DataBatchInner.md)
  - [PDFGeneratorAPI::Document](docs/Document.md)
+ - [PDFGeneratorAPI::DocumentAction](docs/DocumentAction.md)
+ - [PDFGeneratorAPI::DocumentUser](docs/DocumentUser.md)
+ - [PDFGeneratorAPI::DocumentVersion](docs/DocumentVersion.md)
  - [PDFGeneratorAPI::EncryptAndDecryptBase64](docs/EncryptAndDecryptBase64.md)
  - [PDFGeneratorAPI::EncryptAndDecryptUrl](docs/EncryptAndDecryptUrl.md)
  - [PDFGeneratorAPI::EncryptDocumentRequest](docs/EncryptDocumentRequest.md)
@@ -413,6 +419,9 @@ Class | Method | HTTP request | Description
  - [PDFGeneratorAPI::GenerateQRCode201Response](docs/GenerateQRCode201Response.md)
  - [PDFGeneratorAPI::GenerateQRCode201ResponseMeta](docs/GenerateQRCode201ResponseMeta.md)
  - [PDFGeneratorAPI::GenerateQRCodeRequest](docs/GenerateQRCodeRequest.md)
+ - [PDFGeneratorAPI::GenerateViewerUrl200Response](docs/GenerateViewerUrl200Response.md)
+ - [PDFGeneratorAPI::GenerateViewerUrl200ResponseMeta](docs/GenerateViewerUrl200ResponseMeta.md)
+ - [PDFGeneratorAPI::GenerateViewerUrlRequest](docs/GenerateViewerUrlRequest.md)
  - [PDFGeneratorAPI::GetStatus200Response](docs/GetStatus200Response.md)
  - [PDFGeneratorAPI::GetTemplateLibrary200Response](docs/GetTemplateLibrary200Response.md)
  - [PDFGeneratorAPI::GetTemplateVersion422Response](docs/GetTemplateVersion422Response.md)
@@ -441,19 +450,21 @@ Class | Method | HTTP request | Description
  - [PDFGeneratorAPI::InlineObject16](docs/InlineObject16.md)
  - [PDFGeneratorAPI::InlineObject17](docs/InlineObject17.md)
  - [PDFGeneratorAPI::InlineObject18](docs/InlineObject18.md)
- - [PDFGeneratorAPI::InlineObject18Meta](docs/InlineObject18Meta.md)
  - [PDFGeneratorAPI::InlineObject19](docs/InlineObject19.md)
  - [PDFGeneratorAPI::InlineObject1Response](docs/InlineObject1Response.md)
  - [PDFGeneratorAPI::InlineObject2](docs/InlineObject2.md)
  - [PDFGeneratorAPI::InlineObject20](docs/InlineObject20.md)
- - [PDFGeneratorAPI::InlineObject20Response](docs/InlineObject20Response.md)
+ - [PDFGeneratorAPI::InlineObject20Meta](docs/InlineObject20Meta.md)
  - [PDFGeneratorAPI::InlineObject21](docs/InlineObject21.md)
  - [PDFGeneratorAPI::InlineObject22](docs/InlineObject22.md)
+ - [PDFGeneratorAPI::InlineObject22Response](docs/InlineObject22Response.md)
  - [PDFGeneratorAPI::InlineObject23](docs/InlineObject23.md)
  - [PDFGeneratorAPI::InlineObject24](docs/InlineObject24.md)
  - [PDFGeneratorAPI::InlineObject25](docs/InlineObject25.md)
  - [PDFGeneratorAPI::InlineObject26](docs/InlineObject26.md)
  - [PDFGeneratorAPI::InlineObject27](docs/InlineObject27.md)
+ - [PDFGeneratorAPI::InlineObject28](docs/InlineObject28.md)
+ - [PDFGeneratorAPI::InlineObject29](docs/InlineObject29.md)
  - [PDFGeneratorAPI::InlineObject3](docs/InlineObject3.md)
  - [PDFGeneratorAPI::InlineObject4](docs/InlineObject4.md)
  - [PDFGeneratorAPI::InlineObject5](docs/InlineObject5.md)
@@ -476,6 +487,7 @@ Class | Method | HTTP request | Description
  - [PDFGeneratorAPI::OptimizeUrl](docs/OptimizeUrl.md)
  - [PDFGeneratorAPI::OutputParam](docs/OutputParam.md)
  - [PDFGeneratorAPI::PaginationMeta](docs/PaginationMeta.md)
+ - [PDFGeneratorAPI::PrefillParam](docs/PrefillParam.md)
  - [PDFGeneratorAPI::PromoteTemplateVersion200Response](docs/PromoteTemplateVersion200Response.md)
  - [PDFGeneratorAPI::PublicTemplateLibraryItem](docs/PublicTemplateLibraryItem.md)
  - [PDFGeneratorAPI::StatusParam](docs/StatusParam.md)

data/docs/DocumentAction.md

@@ -0,0 +1,22 @@
+# PDFGeneratorAPI::DocumentAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | The action performed on the document. | [optional] |
+| **person** | [**DocumentUser**](DocumentUser.md) |  | [optional] |
+| **created_at** | **String** | Action timestamp (Y-m-d H:i:s). | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::DocumentAction.new(
+  action: signed,
+  person: null,
+  created_at: 2026-06-01 10:03:11
+)
+```
+

data/docs/DocumentUser.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::DocumentUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **id_code** | **String** | National identification code, when provided. | [optional] |
+| **ip** | **String** | IP address captured when the action was performed. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::DocumentUser.new(
+  first_name: John,
+  last_name: Smith,
+  email: john@smith.com,
+  id_code: 39010101010,
+  ip: 203.0.113.42
+)
+```
+

data/docs/DocumentVersion.md

@@ -0,0 +1,24 @@
+# PDFGeneratorAPI::DocumentVersion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version_id** | **String** | Version identifier (hash). | [optional] |
+| **name** | **String** | Version name. | [optional] |
+| **person** | [**DocumentUser**](DocumentUser.md) |  | [optional] |
+| **created_at** | **String** | Creation timestamp (Y-m-d H:i:s). | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::DocumentVersion.new(
+  version_id: 5f3c2b1a9d8e7f6a,
+  name: yellow,
+  person: null,
+  created_at: 2026-06-01 10:03:11
+)
+```
+

data/docs/DocumentsApi.md

@@ -9,8 +9,11 @@ All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
 | [**generate_document_asynchronous**](DocumentsApi.md#generate_document_asynchronous) | **POST** /documents/generate/async | Generate document (async) |
 | [**generate_document_batch**](DocumentsApi.md#generate_document_batch) | **POST** /documents/generate/batch | Generate document (batch) |
 | [**generate_document_batch_asynchronous**](DocumentsApi.md#generate_document_batch_asynchronous) | **POST** /documents/generate/batch/async | Generate document (batch + async) |
+| [**generate_viewer_url**](DocumentsApi.md#generate_viewer_url) | **POST** /documents/{publicId} | Get document with prefill |
 | [**get_async_job_status**](DocumentsApi.md#get_async_job_status) | **GET** /documents/async/{jobId} | Get job status |
 | [**get_document**](DocumentsApi.md#get_document) | **GET** /documents/{publicId} | Get document |
+| [**get_document_actions**](DocumentsApi.md#get_document_actions) | **GET** /documents/{publicId}/actions | Get document actions |
+| [**get_document_versions**](DocumentsApi.md#get_document_versions) | **GET** /documents/{publicId}/versions | Get document versions |
 | [**get_documents**](DocumentsApi.md#get_documents) | **GET** /documents | Get documents |
 | [**store_document**](DocumentsApi.md#store_document) | **POST** /documents | Store document |
 
@@ -154,7 +157,7 @@ end
 
 ## generate_document_asynchronous
 
-> <InlineObject20> generate_document_asynchronous(generate_document_asynchronous_request)
+> <InlineObject22> generate_document_asynchronous(generate_document_asynchronous_request)
 
 Generate document (async)
 
@@ -187,7 +190,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject20>, Integer, Hash)> generate_document_asynchronous_with_http_info(generate_document_asynchronous_request)
+> <Array(<InlineObject22>, Integer, Hash)> generate_document_asynchronous_with_http_info(generate_document_asynchronous_request)
 
 ```ruby
 begin
@@ -195,7 +198,7 @@ begin
   data, status_code, headers = api_instance.generate_document_asynchronous_with_http_info(generate_document_asynchronous_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject20>
+  p data # => <InlineObject22>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling DocumentsApi->generate_document_asynchronous_with_http_info: #{e}"
 end
@@ -209,7 +212,7 @@ end
 
 ### Return type
 
-[**InlineObject20**](InlineObject20.md)
+[**InlineObject22**](InlineObject22.md)
 
 ### Authorization
 
@@ -292,7 +295,7 @@ end
 
 ## generate_document_batch_asynchronous
 
-> <InlineObject20> generate_document_batch_asynchronous(generate_document_batch_asynchronous_request)
+> <InlineObject22> generate_document_batch_asynchronous(generate_document_batch_asynchronous_request)
 
 Generate document (batch + async)
 
@@ -325,7 +328,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<InlineObject20>, Integer, Hash)> generate_document_batch_asynchronous_with_http_info(generate_document_batch_asynchronous_request)
+> <Array(<InlineObject22>, Integer, Hash)> generate_document_batch_asynchronous_with_http_info(generate_document_batch_asynchronous_request)
 
 ```ruby
 begin
@@ -333,7 +336,7 @@ begin
   data, status_code, headers = api_instance.generate_document_batch_asynchronous_with_http_info(generate_document_batch_asynchronous_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <InlineObject20>
+  p data # => <InlineObject22>
 rescue PDFGeneratorAPI::ApiError => e
   puts "Error when calling DocumentsApi->generate_document_batch_asynchronous_with_http_info: #{e}"
 end
@@ -347,7 +350,80 @@ end
 
 ### Return type
 
-[**InlineObject20**](InlineObject20.md)
+[**InlineObject22**](InlineObject22.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## generate_viewer_url
+
+> <GenerateViewerUrl200Response> generate_viewer_url(public_id, opts)
+
+Get document with prefill
+
+Returns a URL for a stored document, optionally with viewer prefill data. The prefill is encrypted server-side and embedded in the viewer URL, so the caller does not have to handle encryption. Prefill is only applied when `output` is `viewer`. 
+
+### 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::DocumentsApi.new
+public_id = 'bac8381bce1982e5f6957a0f52371336' # String | Resource public id
+opts = {
+  generate_viewer_url_request: PDFGeneratorAPI::GenerateViewerUrlRequest.new # GenerateViewerUrlRequest | Optional response format and viewer prefill data.
+}
+
+begin
+  # Get document with prefill
+  result = api_instance.generate_viewer_url(public_id, opts)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling DocumentsApi->generate_viewer_url: #{e}"
+end
+```
+
+#### Using the generate_viewer_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GenerateViewerUrl200Response>, Integer, Hash)> generate_viewer_url_with_http_info(public_id, opts)
+
+```ruby
+begin
+  # Get document with prefill
+  data, status_code, headers = api_instance.generate_viewer_url_with_http_info(public_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GenerateViewerUrl200Response>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling DocumentsApi->generate_viewer_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_id** | **String** | Resource public id |  |
+| **generate_viewer_url_request** | [**GenerateViewerUrlRequest**](GenerateViewerUrlRequest.md) | Optional response format and viewer prefill data. | [optional] |
+
+### Return type
+
+[**GenerateViewerUrl200Response**](GenerateViewerUrl200Response.md)
 
 ### Authorization
 
@@ -497,6 +573,144 @@ end
 - **Accept**: application/json
 
 
+## get_document_actions
+
+> <InlineObject17> get_document_actions(public_id)
+
+Get document actions
+
+Returns a list of actions performed on a stored document
+
+### 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::DocumentsApi.new
+public_id = 'bac8381bce1982e5f6957a0f52371336' # String | Resource public id
+
+begin
+  # Get document actions
+  result = api_instance.get_document_actions(public_id)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling DocumentsApi->get_document_actions: #{e}"
+end
+```
+
+#### Using the get_document_actions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject17>, Integer, Hash)> get_document_actions_with_http_info(public_id)
+
+```ruby
+begin
+  # Get document actions
+  data, status_code, headers = api_instance.get_document_actions_with_http_info(public_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject17>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling DocumentsApi->get_document_actions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_id** | **String** | Resource public id |  |
+
+### Return type
+
+[**InlineObject17**](InlineObject17.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_document_versions
+
+> <InlineObject16> get_document_versions(public_id)
+
+Get document versions
+
+Returns a list of versions for a stored document
+
+### 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::DocumentsApi.new
+public_id = 'bac8381bce1982e5f6957a0f52371336' # String | Resource public id
+
+begin
+  # Get document versions
+  result = api_instance.get_document_versions(public_id)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling DocumentsApi->get_document_versions: #{e}"
+end
+```
+
+#### Using the get_document_versions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject16>, Integer, Hash)> get_document_versions_with_http_info(public_id)
+
+```ruby
+begin
+  # Get document versions
+  data, status_code, headers = api_instance.get_document_versions_with_http_info(public_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject16>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling DocumentsApi->get_document_versions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_id** | **String** | Resource public id |  |
+
+### Return type
+
+[**InlineObject16**](InlineObject16.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_documents
 
 > <InlineObject15> get_documents(opts)