pdf_generator_api_client 8.0.29 → 8.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 227d8a0d103851d2e66af2da6182e189c87e44e4d9426c0dd6532354655860fe
-  data.tar.gz: 2a342fa09f651854a346da44dc63cfb116447119fccdf74076369ef82a49bfdb
+  metadata.gz: 91581e412ae458e2f98bc35bb164fe08d39e900a761843e7dbeb1647a0d2f107
+  data.tar.gz: 7dfa952287c8f1b88dd51359cab3e49333848985322e5cf0c66e2cdb5de815c7
 SHA512:
-  metadata.gz: 5b23d40b72da750605bd513cd7d778ae36549f8685fc492bea0d6cf32aaaeb40a7fd5c32e563064a024847dd0b24c47a06548fe23784e7d671e9c3b8e95adca1
-  data.tar.gz: 0a1f0eceda8d69b6a11397dfb001d234f374c9bba60df3f6275ee319e1baaf5ddc50ce12dcf9d373200f42a66d8b85cd987720181da88953611745f2f0398473
+  metadata.gz: 4dcc8f0b27464436231a97322da0fe965720d4640d7b72419d41dde94910228ba7416931a0038889123da64794a2ad7feb5b592884568b119b95a52995b8cf1f
+  data.tar.gz: 1f8a20110e8eba927c5f9ea65ab219a0f7ce1a4735f1c82644cb536a43b5ea48e2db83294d5ed216ad10d221a10bbf21b29a75ab33bda59459e484ac877f3519

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.29
-- Package version: 8.0.29
+- API version: 4.0.31
+- Package version: 8.0.31
 - 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.29.gem
+gem install ./pdf_generator_api_client-8.0.31.gem
 ```
 
-(for development, run `gem install --dev ./pdf_generator_api_client-8.0.29.gem` to install the development dependencies)
+(for development, run `gem install --dev ./pdf_generator_api_client-8.0.31.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.29'
+    gem 'pdf_generator_api_client', '~> 8.0.31'
 
 ### Install from Git
 
@@ -337,6 +337,7 @@ Class | Method | HTTP request | Description
 *PDFGeneratorAPI::FormsApi* | [**create_form**](docs/FormsApi.md#create_form) | **POST** /forms | Create form
 *PDFGeneratorAPI::FormsApi* | [**delete_form**](docs/FormsApi.md#delete_form) | **DELETE** /forms/{formId} | Delete form
 *PDFGeneratorAPI::FormsApi* | [**get_form**](docs/FormsApi.md#get_form) | **GET** /forms/{formId} | Get form
+*PDFGeneratorAPI::FormsApi* | [**get_form_schema**](docs/FormsApi.md#get_form_schema) | **GET** /forms/schema | Get schema
 *PDFGeneratorAPI::FormsApi* | [**get_forms**](docs/FormsApi.md#get_forms) | **GET** /forms | Get forms
 *PDFGeneratorAPI::FormsApi* | [**import_form**](docs/FormsApi.md#import_form) | **POST** /forms/import | Import Form
 *PDFGeneratorAPI::FormsApi* | [**open_form_builder**](docs/FormsApi.md#open_form_builder) | **POST** /forms/open | Open new form builder
@@ -405,15 +406,20 @@ Class | Method | HTTP request | Description
  - [PDFGeneratorAPI::FormActionSend](docs/FormActionSend.md)
  - [PDFGeneratorAPI::FormActionSendSendDocument](docs/FormActionSendSendDocument.md)
  - [PDFGeneratorAPI::FormActionSendSendDocumentHeadersInner](docs/FormActionSendSendDocumentHeadersInner.md)
+ - [PDFGeneratorAPI::FormActionSign](docs/FormActionSign.md)
  - [PDFGeneratorAPI::FormActionStore](docs/FormActionStore.md)
  - [PDFGeneratorAPI::FormConfiguration](docs/FormConfiguration.md)
+ - [PDFGeneratorAPI::FormConfigurationImport](docs/FormConfigurationImport.md)
  - [PDFGeneratorAPI::FormConfigurationNew](docs/FormConfigurationNew.md)
  - [PDFGeneratorAPI::FormConfigurationNewActionsInner](docs/FormConfigurationNewActionsInner.md)
+ - [PDFGeneratorAPI::FormField](docs/FormField.md)
+ - [PDFGeneratorAPI::FormFieldOptions](docs/FormFieldOptions.md)
+ - [PDFGeneratorAPI::FormFieldSubRowsInner](docs/FormFieldSubRowsInner.md)
  - [PDFGeneratorAPI::FormFieldsBase64](docs/FormFieldsBase64.md)
- - [PDFGeneratorAPI::FormFieldsInner](docs/FormFieldsInner.md)
  - [PDFGeneratorAPI::FormFieldsUrl](docs/FormFieldsUrl.md)
  - [PDFGeneratorAPI::FormFillBase64](docs/FormFillBase64.md)
  - [PDFGeneratorAPI::FormFillUrl](docs/FormFillUrl.md)
+ - [PDFGeneratorAPI::FormTableColumn](docs/FormTableColumn.md)
  - [PDFGeneratorAPI::FormatParam](docs/FormatParam.md)
  - [PDFGeneratorAPI::GenerateDocumentAsynchronousRequest](docs/GenerateDocumentAsynchronousRequest.md)
  - [PDFGeneratorAPI::GenerateDocumentBatchAsynchronousRequest](docs/GenerateDocumentBatchAsynchronousRequest.md)

data/docs/ConversionApi.md

@@ -153,7 +153,7 @@ end
 
 URL to PDF
 
-Converts public URL to PDF
+Converts public URL to PDF.  By default the page is printed once its network activity settles. Pages that keep making background requests (e.g. single-page applications) can signal when they have finished rendering with `wait_for_css` and/or `wait_for_js`; the page is then printed as soon as the signal is met. When both are given, both must be met. 
 
 ### Examples
 

data/docs/ConvertURL2PDFRequest.md

@@ -9,6 +9,11 @@
 | **orientation** | **String** |  | [optional][default to 'portrait'] |
 | **output** | **String** | Output | [optional][default to 'base64'] |
 | **filename** | **String** | Document name | [optional] |
+| **wait_for_css** | **String** | CSS selector of an element to wait for before the page is printed; see `wait_for_css_state` | [optional] |
+| **wait_for_css_state** | **String** | How `wait_for_css` matches. `present` waits until the element exists, even if it is empty or hidden (e.g. a `<div id=\"report-ready\"></div>` marker); `visible` waits until it is also visible with a non-empty size (e.g. a chart that appears when data has loaded). | [optional][default to 'present'] |
+| **wait_for_js** | **String** | JavaScript expression evaluated in the page every 100ms; the page is printed once it is truthy. Promises are awaited, and an expression that throws counts as not ready yet. | [optional] |
+| **wait_timeout** | **Integer** | Seconds to wait for `wait_for_css` / `wait_for_js` before applying `on_wait_timeout` | [optional][default to 30] |
+| **on_wait_timeout** | **String** | What to do when the wait signal is not met within `wait_timeout`. `error` returns a 422 response; `print` prints the page as it is. | [optional][default to 'error'] |
 
 ## Example
 
@@ -20,7 +25,12 @@ instance = PDFGeneratorAPI::ConvertURL2PDFRequest.new(
   paper_size: a4,
   orientation: portrait,
   output: base64,
-  filename: Invoice 12345
+  filename: Invoice 12345,
+  wait_for_css: #report-ready,
+  wait_for_css_state: present,
+  wait_for_js: window.renderComplete === true,
+  wait_timeout: 30,
+  on_wait_timeout: error
 )
 ```
 

data/docs/FormActionSendSendDocument.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **url** | **String** | HTTPS URL where the generated document will be delivered. |  |
+| **url** | **String** | URL where the generated document will be delivered. Must use HTTPS. |  |
 | **headers** | [**Array<FormActionSendSendDocumentHeadersInner>**](FormActionSendSendDocumentHeadersInner.md) | Optional HTTP headers to include with the delivery request. | [optional] |
 
 ## Example

data/docs/FormActionSign.md

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

data/docs/FormConfigurationImport.md

@@ -0,0 +1,24 @@
+# PDFGeneratorAPI::FormConfigurationImport
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **Integer** | Template ID which is connected to the form | [optional] |
+| **name** | **String** | Form name | [optional] |
+| **actions** | [**Array<FormConfigurationNewActionsInner>**](FormConfigurationNewActionsInner.md) | Array of action configurations. Each action is a separate object with a single key; leave an action out to disable it. | [optional] |
+| **configuration** | [**FormConfiguration**](FormConfiguration.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormConfigurationImport.new(
+  template_id: 123123,
+  name: Certificate creator,
+  actions: null,
+  configuration: null
+)
+```
+

data/docs/FormConfigurationNew.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **template_id** | **Integer** | Template ID which is connected to the form | [optional] |
-| **name** | **String** | Form name | [optional] |
-| **actions** | [**Array<FormConfigurationNewActionsInner>**](FormConfigurationNewActionsInner.md) | Array of action configurations | [optional] |
-| **fields** | [**Array<FormFieldsInner>**](FormFieldsInner.md) | A list of form field objects | [optional] |
+| **name** | **String** | Form name |  |
+| **actions** | [**Array<FormConfigurationNewActionsInner>**](FormConfigurationNewActionsInner.md) | Array of action configurations. Each action is a separate object with a single key; leave an action out to disable it. |  |
+| **fields** | [**Array<FormField>**](FormField.md) | Input fields shown on the form, in display order. Field names must be unique within the form. |  |
 | **configuration** | [**FormConfiguration**](FormConfiguration.md) |  | [optional] |
 
 ## Example

data/docs/FormConfigurationNewActionsInner.md

@@ -7,6 +7,7 @@
 | **store_document** | **Boolean** |  | [optional] |
 | **download_document** | **Boolean** |  | [optional] |
 | **send_document** | [**FormActionSendSendDocument**](FormActionSendSendDocument.md) |  | [optional] |
+| **sign_document** | **Boolean** |  | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'pdf_generator_api_client'
 instance = PDFGeneratorAPI::FormConfigurationNewActionsInner.new(
   store_document: true,
   download_document: true,
-  send_document: null
+  send_document: null,
+  sign_document: true
 )
 ```
 

data/docs/FormField.md

@@ -0,0 +1,30 @@
+# PDFGeneratorAPI::FormField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | Field label displayed in the form |  |
+| **name** | **String** | Data field name. For example \"name\" can be used as \"{name}\" in the document as placeholder. |  |
+| **type** | **String** | Field type * `text` - Free text input * `integer` - Whole number input * `number` - Decimal number input * `date` - Date picker * `signature` - Hand-drawn signature, stored as an image * `select` - Dropdown with a single choice. Requires `subRows` with options and a `default` value * `multi-select` - Dropdown with multiple choices. Requires `subRows` with options * `table` - Repeating rows of values. Its columns are defined in `subRows` * `image` - Image upload * `pdf` - PDF file upload  |  |
+| **required** | **Boolean** | Specifies if the field is required or not |  |
+| **default** | **String** | Value pre-filled in the field. Required for `select` fields and must be one of the options. Not used by `table` fields. | [optional] |
+| **description** | **String** | Help text shown with the field | [optional] |
+| **sub_rows** | [**Array<FormFieldSubRowsInner>**](FormFieldSubRowsInner.md) | Options for `select` and `multi-select` fields (a single object), columns for `table` fields. Not used by other field types. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormField.new(
+  label: Full name,
+  name: name,
+  type: text,
+  required: false,
+  default: Medium,
+  description: Enter your name as shown in your passport,
+  sub_rows: null
+)
+```
+

data/docs/FormFieldOptions.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::FormFieldOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **options** | **String** | Comma-separated list of choices. Whitespace around each choice is trimmed and choices must be unique. |  |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormFieldOptions.new(
+  options: Small,Medium,Large
+)
+```
+

data/docs/FormFieldSubRowsInner.md

@@ -0,0 +1,30 @@
+# PDFGeneratorAPI::FormFieldSubRowsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **options** | **String** | Comma-separated list of choices. Whitespace around each choice is trimmed and choices must be unique. |  |
+| **label** | **String** | Column label displayed in the form |  |
+| **name** | **String** | Data field name of the column |  |
+| **type** | **String** | Column type. `select` columns require `subRows` with options and a `default` value. |  |
+| **required** | **Boolean** | Specifies if the column is required or not |  |
+| **default** | **String** | Value pre-filled in the column. Required for `select` columns and must be one of the options. | [optional] |
+| **sub_rows** | [**Array<FormFieldOptions>**](FormFieldOptions.md) | Options for `select` columns (a single object). Not used by other column types. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormFieldSubRowsInner.new(
+  options: Small,Medium,Large,
+  label: Product,
+  name: product,
+  type: text,
+  required: false,
+  default: Medium,
+  sub_rows: null
+)
+```
+

data/docs/FormTableColumn.md

@@ -0,0 +1,28 @@
+# PDFGeneratorAPI::FormTableColumn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | Column label displayed in the form |  |
+| **name** | **String** | Data field name of the column |  |
+| **type** | **String** | Column type. `select` columns require `subRows` with options and a `default` value. |  |
+| **required** | **Boolean** | Specifies if the column is required or not |  |
+| **default** | **String** | Value pre-filled in the column. Required for `select` columns and must be one of the options. | [optional] |
+| **sub_rows** | [**Array<FormFieldOptions>**](FormFieldOptions.md) | Options for `select` columns (a single object). Not used by other column types. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormTableColumn.new(
+  label: Product,
+  name: product,
+  type: text,
+  required: false,
+  default: Medium,
+  sub_rows: null
+)
+```
+

data/docs/FormsApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
 | [**create_form**](FormsApi.md#create_form) | **POST** /forms | Create form |
 | [**delete_form**](FormsApi.md#delete_form) | **DELETE** /forms/{formId} | Delete form |
 | [**get_form**](FormsApi.md#get_form) | **GET** /forms/{formId} | Get form |
+| [**get_form_schema**](FormsApi.md#get_form_schema) | **GET** /forms/schema | Get schema |
 | [**get_forms**](FormsApi.md#get_forms) | **GET** /forms | Get forms |
 | [**import_form**](FormsApi.md#import_form) | **POST** /forms/import | Import Form |
 | [**open_form_builder**](FormsApi.md#open_form_builder) | **POST** /forms/open | Open new form builder |
@@ -35,7 +36,7 @@ PDFGeneratorAPI.configure do |config|
 end
 
 api_instance = PDFGeneratorAPI::FormsApi.new
-form_configuration_new = PDFGeneratorAPI::FormConfigurationNew.new # FormConfigurationNew | Form configuration
+form_configuration_new = PDFGeneratorAPI::FormConfigurationNew.new({name: 'Certificate creator', actions: [PDFGeneratorAPI::FormConfigurationNewActionsInner.new], fields: [PDFGeneratorAPI::FormField.new({label: 'Full name', name: 'name', type: 'text', required: false})]}) # FormConfigurationNew | Form configuration
 
 begin
   # Create form
@@ -221,6 +222,67 @@ end
 - **Accept**: application/json
 
 
+## get_form_schema
+
+> Object get_form_schema
+
+Get schema
+
+Returns Form JSON Schema which defines the structure of the Form Definition.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pdf_generator_api_client'
+
+api_instance = PDFGeneratorAPI::FormsApi.new
+
+begin
+  # Get schema
+  result = api_instance.get_form_schema
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling FormsApi->get_form_schema: #{e}"
+end
+```
+
+#### Using the get_form_schema_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> get_form_schema_with_http_info
+
+```ruby
+begin
+  # Get schema
+  data, status_code, headers = api_instance.get_form_schema_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling FormsApi->get_form_schema_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_forms
 
 > <InlineObject6> get_forms(opts)
@@ -243,7 +305,10 @@ end
 api_instance = PDFGeneratorAPI::FormsApi.new
 opts = {
   page: 1, # Integer | Pagination: page to return
-  per_page: 20 # Integer | Pagination: How many records to return per page
+  per_page: 20, # Integer | Pagination: How many records to return per page
+  order_by: 'id', # String | Field to sort the forms by
+  order_direction: 'asc', # String | Sort direction
+  search: 'Certificate' # String | Returns forms whose name or ID contains the search value
 }
 
 begin
@@ -279,6 +344,9 @@ end
 | ---- | ---- | ----------- | ----- |
 | **page** | **Integer** | Pagination: page to return | [optional][default to 1] |
 | **per_page** | **Integer** | Pagination: How many records to return per page | [optional][default to 15] |
+| **order_by** | **String** | Field to sort the forms by | [optional][default to &#39;id&#39;] |
+| **order_direction** | **String** | Sort direction | [optional][default to &#39;desc&#39;] |
+| **search** | **String** | Returns forms whose name or ID contains the search value | [optional] |
 
 ### Return type
 
@@ -300,7 +368,7 @@ end
 
 Import Form
 
-Creates a new form based on editable PDF
+Creates a new form based on editable PDF. Form fields are created from the editable fields of the PDF. The optional `form` object sets the form name, template, actions and configuration.
 
 ### Examples
 
@@ -588,7 +656,7 @@ end
 
 api_instance = PDFGeneratorAPI::FormsApi.new
 form_id = 1 # Integer | Form unique identifier
-form_configuration_new = PDFGeneratorAPI::FormConfigurationNew.new # FormConfigurationNew | Form configuration
+form_configuration_new = PDFGeneratorAPI::FormConfigurationNew.new({name: 'Certificate creator', actions: [PDFGeneratorAPI::FormConfigurationNewActionsInner.new], fields: [PDFGeneratorAPI::FormField.new({label: 'Full name', name: 'name', type: 'text', required: false})]}) # FormConfigurationNew | Form configuration
 
 begin
   # Update form

data/docs/ImportFormBase64.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **file_base64** | **String** | PDF file from base64 string to import |  |
-| **form** | [**FormConfigurationNew**](FormConfigurationNew.md) |  | [optional] |
+| **form** | [**FormConfigurationImport**](FormConfigurationImport.md) |  | [optional] |
 
 ## Example
 

data/docs/ImportFormUrl.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **file_url** | **String** | PDF file from remote URL to import |  |
-| **form** | [**FormConfigurationNew**](FormConfigurationNew.md) |  | [optional] |
+| **form** | [**FormConfigurationImport**](FormConfigurationImport.md) |  | [optional] |
 
 ## Example
 

data/lib/pdf_generator_api_client/api/assets_api.rb

@@ -3,7 +3,7 @@
 
 ## Introduction [PDF Generator API](https://pdfgeneratorapi.com) allows you easily generate transactional PDF documents and reduce the development and support costs by enabling your users to create and manage their document templates using a browser-based drag-and-drop document editor.  The PDF Generator API features a web API architecture, allowing you to code in the language of your choice. This API supports the JSON media type, and uses UTF-8 character encoding.  ## Base URL The base URL for all the API endpoints is `https://us1.pdfgeneratorapi.com/api/v4`  For example * `https://us1.pdfgeneratorapi.com/api/v4/templates` * `https://us1.pdfgeneratorapi.com/api/v4/workspaces` * `https://us1.pdfgeneratorapi.com/api/v4/templates/123123`  ## Editor PDF Generator API comes with a powerful drag & drop editor that allows to create any kind of document templates, from barcode labels to invoices, quotes and reports. You can find tutorials and videos from our [Support Portal](https://support.pdfgeneratorapi.com). * [Component specification](https://support.pdfgeneratorapi.com/en/category/components-1ffseaj/) * [Expression Language documentation](https://support.pdfgeneratorapi.com/en/category/expression-language-q203pa/) * [Frequently asked questions and answers](https://support.pdfgeneratorapi.com/en/category/qanda-1ov519d/)  ## Definitions  ### Organization Organization is a group of workspaces owned by your account.  ### Workspace Workspace contains templates. Each workspace has access to their own templates and organization default templates.  ### Master Workspace Master Workspace is the main/default workspace of your Organization. The Master Workspace identifier is the email you signed up with.  ### Default Template Default template is a template that is available for all workspaces by default. You can set the template access type under Page Setup. If template has \"Organization\" access then your users can use them from the \"New\" menu in the Editor.  ### Data Field Data Field is a placeholder for the specific data in your JSON data set. In this example JSON you can access the buyer name using Data Field `{paymentDetails::buyerName}`. The separator between depth levels is :: (two colons). When designing the template you don’t have to know every Data Field, our editor automatically extracts all the available fields from your data set and provides an easy way to insert them into the template. ``` {     \"documentNumber\": 1,     \"paymentDetails\": {         \"method\": \"Credit Card\",         \"buyerName\": \"John Smith\"     },     \"items\": [         {             \"id\": 1,             \"name\": \"Item one\"         }     ] } ```  ## Rate limiting Our API endpoints use IP-based rate limiting and allow you to make up to 2 requests per second and 60 requests per minute. If you make more requests, you will receive a response with HTTP code 429.  Response headers contain additional values:  | Header   | Description                    | |--------|--------------------------------| | X-RateLimit-Limit    | Maximum requests per minute                   | | X-RateLimit-Remaining    | The requests remaining in the current minute               | | Retry-After     | How many seconds you need to wait until you are allowed to make requests |  *  *  *  *  *  # Libraries and SDKs ## Postman Collection We have created a [Postman Collection](https://www.postman.com/pdfgeneratorapi/workspace/pdf-generator-api-public-workspace/overview) so you can easily test all the API endpoints without developing and code.   ## Client Libraries All our Client Libraries are auto-generated using [OpenAPI Generator](https://openapi-generator.tech/) which uses the OpenAPI v3 specification to automatically generate a client library in specific programming language.  * [PHP Client](https://github.com/pdfgeneratorapi/php-client) * [Java Client](https://github.com/pdfgeneratorapi/java-client) * [Ruby Client](https://github.com/pdfgeneratorapi/ruby-client) * [Python Client](https://github.com/pdfgeneratorapi/python-client) * [Javascript Client](https://github.com/pdfgeneratorapi/javascript-client)  We have validated the generated libraries, but let us know if you find any anomalies in the client code.  ## Model Context Protocol (MCP) Server Integrate document generation directly into your AI agents and LLM applications using our official Model Context Protocol (MCP) Server.  The MCP server provides a standardized interface that allows AI assistants (like Claude Desktop and other MCP-compatible clients) to securely interact with the PDF Generator API. With it, your AI applications can automatically fetch workspaces, retrieve templates, merge data, and generate PDF documents on the fly.  [Get PDF Generator API MCP Server](https://github.com/pdfgeneratorapi/mcp-server) *  *  *  *  *   # Authentication The PDF Generator API uses __JSON Web Tokens (JWT)__ to authenticate all API requests. These tokens offer a method to establish secure server-to-server authentication by transferring a compact JSON object with a signed payload of your account’s API Key and Secret. When authenticating to the PDF Generator API, a JWT should be generated uniquely by a __server-side application__ and included as a __Bearer Token__ in the header of each request.   <SecurityDefinitions />  ## Accessing your API Key and Secret You can find your __API Key__ and __API Secret__ from the __Account Settings__ page after you login to PDF Generator API [here](https://pdfgeneratorapi.com/login).  ## Creating a JWT JSON Web Tokens are composed of three sections: a header, a payload (containing a claim set), and a signature. The header and payload are JSON objects, which are serialized to UTF-8 bytes, then encoded using base64url encoding.  The JWT's header, payload, and signature are concatenated with periods (.). As a result, a JWT typically takes the following form: ``` {Base64url encoded header}.{Base64url encoded payload}.{Base64url encoded signature} ```  We recommend and support libraries provided on [jwt.io](https://jwt.io/). While other libraries can create JWT, these recommended libraries are the most robust.  ### Header Property `alg` defines which signing algorithm is being used. PDF Generator API users HS256. Property `typ` defines the type of token and it is always JWT. ``` {   \"alg\": \"HS256\",   \"typ\": \"JWT\" } ```  ### Payload The second part of the token is the payload, which contains the claims  or the pieces of information being passed about the user and any metadata required. It is mandatory to specify the following claims: * issuer (`iss`): Your API key * subject (`sub`): Workspace identifier * expiration time (`exp`): Timestamp (unix epoch time) until the token is valid. It is highly recommended to set the exp timestamp for a short period, i.e. a matter of seconds. This way, if a token is intercepted or shared, the token will only be valid for a short period of time.  ``` {   \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\",   \"sub\": \"demo.example@actualreports.com\",   \"exp\": 1586112639 } ```  ### Payload for Partners Our partners can send their unique identifier (provided by us) in JWT's partner_id claim. If the `partner_id` value is specified in the JWT, the organization making the request is automatically connected to the partner account. * Partner ID (`partner_id`): Unique identifier provide by PDF Generator API team  ``` {   \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\",   \"sub\": \"demo.example@actualreports.com\",   \"partner_id\": \"my-partner-identifier\",   \"exp\": 1586112639 } ```  ### Signature To create the signature part you have to take the encoded header, the encoded payload, a secret, the algorithm specified in the header, and sign that. The signature is used to verify the message wasn't changed along the way, and, in the case of tokens signed with a private key, it can also verify that the sender of the JWT is who it says it is. ``` HMACSHA256(     base64UrlEncode(header) + \".\" +     base64UrlEncode(payload),     API_SECRET) ```  ### Putting all together The output is three Base64-URL strings separated by dots. The following shows a JWT that has the previous header and payload encoded, and it is signed with a secret. ``` eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0.SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q  // Base64 encoded header: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 // Base64 encoded payload: eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0 // Signature: SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q ```  ## Temporary JWTs You can create a temporary token in [Account Settings](https://pdfgeneratorapi.com/account/organization) page after you login to PDF Generator API. The generated token uses your email address as the subject (`sub`) value and is valid for __15 minutes__. You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API calls. These test tokens should never be used in production applications. *  *  *  *  *  # Error codes  | Code   | Description                    | |--------|--------------------------------| | 401    | Unauthorized                   | | 402    | Payment Required               | | 403    | Forbidden                      | | 404    | Not Found                      | | 422    | Unprocessable Entity           | | 429    | Too Many Requests              | | 500    | Internal Server Error          |  ## 401 Unauthorized | Description                                                             | |-------------------------------------------------------------------------| | Authentication failed: request expired                                  | | Authentication failed: workspace missing                                | | Authentication failed: key missing                                      | | Authentication failed: property 'iss' (issuer) missing in JWT           | | Authentication failed: property 'sub' (subject) missing in JWT          | | Authentication failed: property 'exp' (expiration time) missing in JWT  | | Authentication failed: incorrect signature                              |  ## 402 Payment Required | Description                                                             | |-------------------------------------------------------------------------| | Your account is suspended, please upgrade your account                  |  ## 403 Forbidden | Description                                                             | |-------------------------------------------------------------------------| | Your account has exceeded the monthly document generation limit.        | | Access not granted: You cannot delete master workspace via API          | | Access not granted: Template is not accessible by this organization     | | Your session has expired, please close and reopen the editor.           |  ## 404 Entity not found | Description                                                             | |-------------------------------------------------------------------------| | Entity not found                                                        | | Resource not found                                                      | | None of the templates is available for the workspace.                   |  ## 422 Unprocessable Entity | Description                                                             | |-------------------------------------------------------------------------| | Unable to parse JSON, please check formatting                           | | Required parameter missing                                              | | Required parameter missing: template definition not defined             | | Required parameter missing: template not defined                        |  ## 429 Too Many Requests | Description                                                             | |-------------------------------------------------------------------------| | You can make up to 2 requests per second and 60 requests per minute.   |  *  *  *  *  * 
 
-The version of the OpenAPI document: 4.0.29
+The version of the OpenAPI document: 4.0.31
 Contact: support@pdfgeneratorapi.com
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/pdf_generator_api_client/api/conversion_api.rb

@@ -3,7 +3,7 @@
 
 ## Introduction [PDF Generator API](https://pdfgeneratorapi.com) allows you easily generate transactional PDF documents and reduce the development and support costs by enabling your users to create and manage their document templates using a browser-based drag-and-drop document editor.  The PDF Generator API features a web API architecture, allowing you to code in the language of your choice. This API supports the JSON media type, and uses UTF-8 character encoding.  ## Base URL The base URL for all the API endpoints is `https://us1.pdfgeneratorapi.com/api/v4`  For example * `https://us1.pdfgeneratorapi.com/api/v4/templates` * `https://us1.pdfgeneratorapi.com/api/v4/workspaces` * `https://us1.pdfgeneratorapi.com/api/v4/templates/123123`  ## Editor PDF Generator API comes with a powerful drag & drop editor that allows to create any kind of document templates, from barcode labels to invoices, quotes and reports. You can find tutorials and videos from our [Support Portal](https://support.pdfgeneratorapi.com). * [Component specification](https://support.pdfgeneratorapi.com/en/category/components-1ffseaj/) * [Expression Language documentation](https://support.pdfgeneratorapi.com/en/category/expression-language-q203pa/) * [Frequently asked questions and answers](https://support.pdfgeneratorapi.com/en/category/qanda-1ov519d/)  ## Definitions  ### Organization Organization is a group of workspaces owned by your account.  ### Workspace Workspace contains templates. Each workspace has access to their own templates and organization default templates.  ### Master Workspace Master Workspace is the main/default workspace of your Organization. The Master Workspace identifier is the email you signed up with.  ### Default Template Default template is a template that is available for all workspaces by default. You can set the template access type under Page Setup. If template has \"Organization\" access then your users can use them from the \"New\" menu in the Editor.  ### Data Field Data Field is a placeholder for the specific data in your JSON data set. In this example JSON you can access the buyer name using Data Field `{paymentDetails::buyerName}`. The separator between depth levels is :: (two colons). When designing the template you don’t have to know every Data Field, our editor automatically extracts all the available fields from your data set and provides an easy way to insert them into the template. ``` {     \"documentNumber\": 1,     \"paymentDetails\": {         \"method\": \"Credit Card\",         \"buyerName\": \"John Smith\"     },     \"items\": [         {             \"id\": 1,             \"name\": \"Item one\"         }     ] } ```  ## Rate limiting Our API endpoints use IP-based rate limiting and allow you to make up to 2 requests per second and 60 requests per minute. If you make more requests, you will receive a response with HTTP code 429.  Response headers contain additional values:  | Header   | Description                    | |--------|--------------------------------| | X-RateLimit-Limit    | Maximum requests per minute                   | | X-RateLimit-Remaining    | The requests remaining in the current minute               | | Retry-After     | How many seconds you need to wait until you are allowed to make requests |  *  *  *  *  *  # Libraries and SDKs ## Postman Collection We have created a [Postman Collection](https://www.postman.com/pdfgeneratorapi/workspace/pdf-generator-api-public-workspace/overview) so you can easily test all the API endpoints without developing and code.   ## Client Libraries All our Client Libraries are auto-generated using [OpenAPI Generator](https://openapi-generator.tech/) which uses the OpenAPI v3 specification to automatically generate a client library in specific programming language.  * [PHP Client](https://github.com/pdfgeneratorapi/php-client) * [Java Client](https://github.com/pdfgeneratorapi/java-client) * [Ruby Client](https://github.com/pdfgeneratorapi/ruby-client) * [Python Client](https://github.com/pdfgeneratorapi/python-client) * [Javascript Client](https://github.com/pdfgeneratorapi/javascript-client)  We have validated the generated libraries, but let us know if you find any anomalies in the client code.  ## Model Context Protocol (MCP) Server Integrate document generation directly into your AI agents and LLM applications using our official Model Context Protocol (MCP) Server.  The MCP server provides a standardized interface that allows AI assistants (like Claude Desktop and other MCP-compatible clients) to securely interact with the PDF Generator API. With it, your AI applications can automatically fetch workspaces, retrieve templates, merge data, and generate PDF documents on the fly.  [Get PDF Generator API MCP Server](https://github.com/pdfgeneratorapi/mcp-server) *  *  *  *  *   # Authentication The PDF Generator API uses __JSON Web Tokens (JWT)__ to authenticate all API requests. These tokens offer a method to establish secure server-to-server authentication by transferring a compact JSON object with a signed payload of your account’s API Key and Secret. When authenticating to the PDF Generator API, a JWT should be generated uniquely by a __server-side application__ and included as a __Bearer Token__ in the header of each request.   <SecurityDefinitions />  ## Accessing your API Key and Secret You can find your __API Key__ and __API Secret__ from the __Account Settings__ page after you login to PDF Generator API [here](https://pdfgeneratorapi.com/login).  ## Creating a JWT JSON Web Tokens are composed of three sections: a header, a payload (containing a claim set), and a signature. The header and payload are JSON objects, which are serialized to UTF-8 bytes, then encoded using base64url encoding.  The JWT's header, payload, and signature are concatenated with periods (.). As a result, a JWT typically takes the following form: ``` {Base64url encoded header}.{Base64url encoded payload}.{Base64url encoded signature} ```  We recommend and support libraries provided on [jwt.io](https://jwt.io/). While other libraries can create JWT, these recommended libraries are the most robust.  ### Header Property `alg` defines which signing algorithm is being used. PDF Generator API users HS256. Property `typ` defines the type of token and it is always JWT. ``` {   \"alg\": \"HS256\",   \"typ\": \"JWT\" } ```  ### Payload The second part of the token is the payload, which contains the claims  or the pieces of information being passed about the user and any metadata required. It is mandatory to specify the following claims: * issuer (`iss`): Your API key * subject (`sub`): Workspace identifier * expiration time (`exp`): Timestamp (unix epoch time) until the token is valid. It is highly recommended to set the exp timestamp for a short period, i.e. a matter of seconds. This way, if a token is intercepted or shared, the token will only be valid for a short period of time.  ``` {   \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\",   \"sub\": \"demo.example@actualreports.com\",   \"exp\": 1586112639 } ```  ### Payload for Partners Our partners can send their unique identifier (provided by us) in JWT's partner_id claim. If the `partner_id` value is specified in the JWT, the organization making the request is automatically connected to the partner account. * Partner ID (`partner_id`): Unique identifier provide by PDF Generator API team  ``` {   \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\",   \"sub\": \"demo.example@actualreports.com\",   \"partner_id\": \"my-partner-identifier\",   \"exp\": 1586112639 } ```  ### Signature To create the signature part you have to take the encoded header, the encoded payload, a secret, the algorithm specified in the header, and sign that. The signature is used to verify the message wasn't changed along the way, and, in the case of tokens signed with a private key, it can also verify that the sender of the JWT is who it says it is. ``` HMACSHA256(     base64UrlEncode(header) + \".\" +     base64UrlEncode(payload),     API_SECRET) ```  ### Putting all together The output is three Base64-URL strings separated by dots. The following shows a JWT that has the previous header and payload encoded, and it is signed with a secret. ``` eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0.SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q  // Base64 encoded header: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 // Base64 encoded payload: eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0 // Signature: SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q ```  ## Temporary JWTs You can create a temporary token in [Account Settings](https://pdfgeneratorapi.com/account/organization) page after you login to PDF Generator API. The generated token uses your email address as the subject (`sub`) value and is valid for __15 minutes__. You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API calls. These test tokens should never be used in production applications. *  *  *  *  *  # Error codes  | Code   | Description                    | |--------|--------------------------------| | 401    | Unauthorized                   | | 402    | Payment Required               | | 403    | Forbidden                      | | 404    | Not Found                      | | 422    | Unprocessable Entity           | | 429    | Too Many Requests              | | 500    | Internal Server Error          |  ## 401 Unauthorized | Description                                                             | |-------------------------------------------------------------------------| | Authentication failed: request expired                                  | | Authentication failed: workspace missing                                | | Authentication failed: key missing                                      | | Authentication failed: property 'iss' (issuer) missing in JWT           | | Authentication failed: property 'sub' (subject) missing in JWT          | | Authentication failed: property 'exp' (expiration time) missing in JWT  | | Authentication failed: incorrect signature                              |  ## 402 Payment Required | Description                                                             | |-------------------------------------------------------------------------| | Your account is suspended, please upgrade your account                  |  ## 403 Forbidden | Description                                                             | |-------------------------------------------------------------------------| | Your account has exceeded the monthly document generation limit.        | | Access not granted: You cannot delete master workspace via API          | | Access not granted: Template is not accessible by this organization     | | Your session has expired, please close and reopen the editor.           |  ## 404 Entity not found | Description                                                             | |-------------------------------------------------------------------------| | Entity not found                                                        | | Resource not found                                                      | | None of the templates is available for the workspace.                   |  ## 422 Unprocessable Entity | Description                                                             | |-------------------------------------------------------------------------| | Unable to parse JSON, please check formatting                           | | Required parameter missing                                              | | Required parameter missing: template definition not defined             | | Required parameter missing: template not defined                        |  ## 429 Too Many Requests | Description                                                             | |-------------------------------------------------------------------------| | You can make up to 2 requests per second and 60 requests per minute.   |  *  *  *  *  * 
 
-The version of the OpenAPI document: 4.0.29
+The version of the OpenAPI document: 4.0.31
 Contact: support@pdfgeneratorapi.com
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0
@@ -156,7 +156,7 @@ module PDFGeneratorAPI
     end
 
     # URL to PDF
-    # Converts public URL to PDF
+    # Converts public URL to PDF.  By default the page is printed once its network activity settles. Pages that keep making background requests (e.g. single-page applications) can signal when they have finished rendering with `wait_for_css` and/or `wait_for_js`; the page is then printed as soon as the signal is met. When both are given, both must be met. 
     # @param convert_url2_pdf_request [ConvertURL2PDFRequest] 
     # @param [Hash] opts the optional parameters
     # @return [InlineObject9]
@@ -166,7 +166,7 @@ module PDFGeneratorAPI
     end
 
     # URL to PDF
-    # Converts public URL to PDF
+    # Converts public URL to PDF.  By default the page is printed once its network activity settles. Pages that keep making background requests (e.g. single-page applications) can signal when they have finished rendering with &#x60;wait_for_css&#x60; and/or &#x60;wait_for_js&#x60;; the page is then printed as soon as the signal is met. When both are given, both must be met. 
     # @param convert_url2_pdf_request [ConvertURL2PDFRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(InlineObject9, Integer, Hash)>] InlineObject9 data, response status code and response headers

data/lib/pdf_generator_api_client/api/documents_api.rb

@@ -3,7 +3,7 @@
 
 ## Introduction [PDF Generator API](https://pdfgeneratorapi.com) allows you easily generate transactional PDF documents and reduce the development and support costs by enabling your users to create and manage their document templates using a browser-based drag-and-drop document editor.  The PDF Generator API features a web API architecture, allowing you to code in the language of your choice. This API supports the JSON media type, and uses UTF-8 character encoding.  ## Base URL The base URL for all the API endpoints is `https://us1.pdfgeneratorapi.com/api/v4`  For example * `https://us1.pdfgeneratorapi.com/api/v4/templates` * `https://us1.pdfgeneratorapi.com/api/v4/workspaces` * `https://us1.pdfgeneratorapi.com/api/v4/templates/123123`  ## Editor PDF Generator API comes with a powerful drag & drop editor that allows to create any kind of document templates, from barcode labels to invoices, quotes and reports. You can find tutorials and videos from our [Support Portal](https://support.pdfgeneratorapi.com). * [Component specification](https://support.pdfgeneratorapi.com/en/category/components-1ffseaj/) * [Expression Language documentation](https://support.pdfgeneratorapi.com/en/category/expression-language-q203pa/) * [Frequently asked questions and answers](https://support.pdfgeneratorapi.com/en/category/qanda-1ov519d/)  ## Definitions  ### Organization Organization is a group of workspaces owned by your account.  ### Workspace Workspace contains templates. Each workspace has access to their own templates and organization default templates.  ### Master Workspace Master Workspace is the main/default workspace of your Organization. The Master Workspace identifier is the email you signed up with.  ### Default Template Default template is a template that is available for all workspaces by default. You can set the template access type under Page Setup. If template has \"Organization\" access then your users can use them from the \"New\" menu in the Editor.  ### Data Field Data Field is a placeholder for the specific data in your JSON data set. In this example JSON you can access the buyer name using Data Field `{paymentDetails::buyerName}`. The separator between depth levels is :: (two colons). When designing the template you don’t have to know every Data Field, our editor automatically extracts all the available fields from your data set and provides an easy way to insert them into the template. ``` {     \"documentNumber\": 1,     \"paymentDetails\": {         \"method\": \"Credit Card\",         \"buyerName\": \"John Smith\"     },     \"items\": [         {             \"id\": 1,             \"name\": \"Item one\"         }     ] } ```  ## Rate limiting Our API endpoints use IP-based rate limiting and allow you to make up to 2 requests per second and 60 requests per minute. If you make more requests, you will receive a response with HTTP code 429.  Response headers contain additional values:  | Header   | Description                    | |--------|--------------------------------| | X-RateLimit-Limit    | Maximum requests per minute                   | | X-RateLimit-Remaining    | The requests remaining in the current minute               | | Retry-After     | How many seconds you need to wait until you are allowed to make requests |  *  *  *  *  *  # Libraries and SDKs ## Postman Collection We have created a [Postman Collection](https://www.postman.com/pdfgeneratorapi/workspace/pdf-generator-api-public-workspace/overview) so you can easily test all the API endpoints without developing and code.   ## Client Libraries All our Client Libraries are auto-generated using [OpenAPI Generator](https://openapi-generator.tech/) which uses the OpenAPI v3 specification to automatically generate a client library in specific programming language.  * [PHP Client](https://github.com/pdfgeneratorapi/php-client) * [Java Client](https://github.com/pdfgeneratorapi/java-client) * [Ruby Client](https://github.com/pdfgeneratorapi/ruby-client) * [Python Client](https://github.com/pdfgeneratorapi/python-client) * [Javascript Client](https://github.com/pdfgeneratorapi/javascript-client)  We have validated the generated libraries, but let us know if you find any anomalies in the client code.  ## Model Context Protocol (MCP) Server Integrate document generation directly into your AI agents and LLM applications using our official Model Context Protocol (MCP) Server.  The MCP server provides a standardized interface that allows AI assistants (like Claude Desktop and other MCP-compatible clients) to securely interact with the PDF Generator API. With it, your AI applications can automatically fetch workspaces, retrieve templates, merge data, and generate PDF documents on the fly.  [Get PDF Generator API MCP Server](https://github.com/pdfgeneratorapi/mcp-server) *  *  *  *  *   # Authentication The PDF Generator API uses __JSON Web Tokens (JWT)__ to authenticate all API requests. These tokens offer a method to establish secure server-to-server authentication by transferring a compact JSON object with a signed payload of your account’s API Key and Secret. When authenticating to the PDF Generator API, a JWT should be generated uniquely by a __server-side application__ and included as a __Bearer Token__ in the header of each request.   <SecurityDefinitions />  ## Accessing your API Key and Secret You can find your __API Key__ and __API Secret__ from the __Account Settings__ page after you login to PDF Generator API [here](https://pdfgeneratorapi.com/login).  ## Creating a JWT JSON Web Tokens are composed of three sections: a header, a payload (containing a claim set), and a signature. The header and payload are JSON objects, which are serialized to UTF-8 bytes, then encoded using base64url encoding.  The JWT's header, payload, and signature are concatenated with periods (.). As a result, a JWT typically takes the following form: ``` {Base64url encoded header}.{Base64url encoded payload}.{Base64url encoded signature} ```  We recommend and support libraries provided on [jwt.io](https://jwt.io/). While other libraries can create JWT, these recommended libraries are the most robust.  ### Header Property `alg` defines which signing algorithm is being used. PDF Generator API users HS256. Property `typ` defines the type of token and it is always JWT. ``` {   \"alg\": \"HS256\",   \"typ\": \"JWT\" } ```  ### Payload The second part of the token is the payload, which contains the claims  or the pieces of information being passed about the user and any metadata required. It is mandatory to specify the following claims: * issuer (`iss`): Your API key * subject (`sub`): Workspace identifier * expiration time (`exp`): Timestamp (unix epoch time) until the token is valid. It is highly recommended to set the exp timestamp for a short period, i.e. a matter of seconds. This way, if a token is intercepted or shared, the token will only be valid for a short period of time.  ``` {   \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\",   \"sub\": \"demo.example@actualreports.com\",   \"exp\": 1586112639 } ```  ### Payload for Partners Our partners can send their unique identifier (provided by us) in JWT's partner_id claim. If the `partner_id` value is specified in the JWT, the organization making the request is automatically connected to the partner account. * Partner ID (`partner_id`): Unique identifier provide by PDF Generator API team  ``` {   \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\",   \"sub\": \"demo.example@actualreports.com\",   \"partner_id\": \"my-partner-identifier\",   \"exp\": 1586112639 } ```  ### Signature To create the signature part you have to take the encoded header, the encoded payload, a secret, the algorithm specified in the header, and sign that. The signature is used to verify the message wasn't changed along the way, and, in the case of tokens signed with a private key, it can also verify that the sender of the JWT is who it says it is. ``` HMACSHA256(     base64UrlEncode(header) + \".\" +     base64UrlEncode(payload),     API_SECRET) ```  ### Putting all together The output is three Base64-URL strings separated by dots. The following shows a JWT that has the previous header and payload encoded, and it is signed with a secret. ``` eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0.SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q  // Base64 encoded header: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 // Base64 encoded payload: eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0 // Signature: SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q ```  ## Temporary JWTs You can create a temporary token in [Account Settings](https://pdfgeneratorapi.com/account/organization) page after you login to PDF Generator API. The generated token uses your email address as the subject (`sub`) value and is valid for __15 minutes__. You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API calls. These test tokens should never be used in production applications. *  *  *  *  *  # Error codes  | Code   | Description                    | |--------|--------------------------------| | 401    | Unauthorized                   | | 402    | Payment Required               | | 403    | Forbidden                      | | 404    | Not Found                      | | 422    | Unprocessable Entity           | | 429    | Too Many Requests              | | 500    | Internal Server Error          |  ## 401 Unauthorized | Description                                                             | |-------------------------------------------------------------------------| | Authentication failed: request expired                                  | | Authentication failed: workspace missing                                | | Authentication failed: key missing                                      | | Authentication failed: property 'iss' (issuer) missing in JWT           | | Authentication failed: property 'sub' (subject) missing in JWT          | | Authentication failed: property 'exp' (expiration time) missing in JWT  | | Authentication failed: incorrect signature                              |  ## 402 Payment Required | Description                                                             | |-------------------------------------------------------------------------| | Your account is suspended, please upgrade your account                  |  ## 403 Forbidden | Description                                                             | |-------------------------------------------------------------------------| | Your account has exceeded the monthly document generation limit.        | | Access not granted: You cannot delete master workspace via API          | | Access not granted: Template is not accessible by this organization     | | Your session has expired, please close and reopen the editor.           |  ## 404 Entity not found | Description                                                             | |-------------------------------------------------------------------------| | Entity not found                                                        | | Resource not found                                                      | | None of the templates is available for the workspace.                   |  ## 422 Unprocessable Entity | Description                                                             | |-------------------------------------------------------------------------| | Unable to parse JSON, please check formatting                           | | Required parameter missing                                              | | Required parameter missing: template definition not defined             | | Required parameter missing: template not defined                        |  ## 429 Too Many Requests | Description                                                             | |-------------------------------------------------------------------------| | You can make up to 2 requests per second and 60 requests per minute.   |  *  *  *  *  * 
 
-The version of the OpenAPI document: 4.0.29
+The version of the OpenAPI document: 4.0.31
 Contact: support@pdfgeneratorapi.com
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0

data/lib/pdf_generator_api_client/api/e_invoices_api.rb

@@ -3,7 +3,7 @@
 
 ## Introduction [PDF Generator API](https://pdfgeneratorapi.com) allows you easily generate transactional PDF documents and reduce the development and support costs by enabling your users to create and manage their document templates using a browser-based drag-and-drop document editor.  The PDF Generator API features a web API architecture, allowing you to code in the language of your choice. This API supports the JSON media type, and uses UTF-8 character encoding.  ## Base URL The base URL for all the API endpoints is `https://us1.pdfgeneratorapi.com/api/v4`  For example * `https://us1.pdfgeneratorapi.com/api/v4/templates` * `https://us1.pdfgeneratorapi.com/api/v4/workspaces` * `https://us1.pdfgeneratorapi.com/api/v4/templates/123123`  ## Editor PDF Generator API comes with a powerful drag & drop editor that allows to create any kind of document templates, from barcode labels to invoices, quotes and reports. You can find tutorials and videos from our [Support Portal](https://support.pdfgeneratorapi.com). * [Component specification](https://support.pdfgeneratorapi.com/en/category/components-1ffseaj/) * [Expression Language documentation](https://support.pdfgeneratorapi.com/en/category/expression-language-q203pa/) * [Frequently asked questions and answers](https://support.pdfgeneratorapi.com/en/category/qanda-1ov519d/)  ## Definitions  ### Organization Organization is a group of workspaces owned by your account.  ### Workspace Workspace contains templates. Each workspace has access to their own templates and organization default templates.  ### Master Workspace Master Workspace is the main/default workspace of your Organization. The Master Workspace identifier is the email you signed up with.  ### Default Template Default template is a template that is available for all workspaces by default. You can set the template access type under Page Setup. If template has \"Organization\" access then your users can use them from the \"New\" menu in the Editor.  ### Data Field Data Field is a placeholder for the specific data in your JSON data set. In this example JSON you can access the buyer name using Data Field `{paymentDetails::buyerName}`. The separator between depth levels is :: (two colons). When designing the template you don’t have to know every Data Field, our editor automatically extracts all the available fields from your data set and provides an easy way to insert them into the template. ``` {     \"documentNumber\": 1,     \"paymentDetails\": {         \"method\": \"Credit Card\",         \"buyerName\": \"John Smith\"     },     \"items\": [         {             \"id\": 1,             \"name\": \"Item one\"         }     ] } ```  ## Rate limiting Our API endpoints use IP-based rate limiting and allow you to make up to 2 requests per second and 60 requests per minute. If you make more requests, you will receive a response with HTTP code 429.  Response headers contain additional values:  | Header   | Description                    | |--------|--------------------------------| | X-RateLimit-Limit    | Maximum requests per minute                   | | X-RateLimit-Remaining    | The requests remaining in the current minute               | | Retry-After     | How many seconds you need to wait until you are allowed to make requests |  *  *  *  *  *  # Libraries and SDKs ## Postman Collection We have created a [Postman Collection](https://www.postman.com/pdfgeneratorapi/workspace/pdf-generator-api-public-workspace/overview) so you can easily test all the API endpoints without developing and code.   ## Client Libraries All our Client Libraries are auto-generated using [OpenAPI Generator](https://openapi-generator.tech/) which uses the OpenAPI v3 specification to automatically generate a client library in specific programming language.  * [PHP Client](https://github.com/pdfgeneratorapi/php-client) * [Java Client](https://github.com/pdfgeneratorapi/java-client) * [Ruby Client](https://github.com/pdfgeneratorapi/ruby-client) * [Python Client](https://github.com/pdfgeneratorapi/python-client) * [Javascript Client](https://github.com/pdfgeneratorapi/javascript-client)  We have validated the generated libraries, but let us know if you find any anomalies in the client code.  ## Model Context Protocol (MCP) Server Integrate document generation directly into your AI agents and LLM applications using our official Model Context Protocol (MCP) Server.  The MCP server provides a standardized interface that allows AI assistants (like Claude Desktop and other MCP-compatible clients) to securely interact with the PDF Generator API. With it, your AI applications can automatically fetch workspaces, retrieve templates, merge data, and generate PDF documents on the fly.  [Get PDF Generator API MCP Server](https://github.com/pdfgeneratorapi/mcp-server) *  *  *  *  *   # Authentication The PDF Generator API uses __JSON Web Tokens (JWT)__ to authenticate all API requests. These tokens offer a method to establish secure server-to-server authentication by transferring a compact JSON object with a signed payload of your account’s API Key and Secret. When authenticating to the PDF Generator API, a JWT should be generated uniquely by a __server-side application__ and included as a __Bearer Token__ in the header of each request.   <SecurityDefinitions />  ## Accessing your API Key and Secret You can find your __API Key__ and __API Secret__ from the __Account Settings__ page after you login to PDF Generator API [here](https://pdfgeneratorapi.com/login).  ## Creating a JWT JSON Web Tokens are composed of three sections: a header, a payload (containing a claim set), and a signature. The header and payload are JSON objects, which are serialized to UTF-8 bytes, then encoded using base64url encoding.  The JWT's header, payload, and signature are concatenated with periods (.). As a result, a JWT typically takes the following form: ``` {Base64url encoded header}.{Base64url encoded payload}.{Base64url encoded signature} ```  We recommend and support libraries provided on [jwt.io](https://jwt.io/). While other libraries can create JWT, these recommended libraries are the most robust.  ### Header Property `alg` defines which signing algorithm is being used. PDF Generator API users HS256. Property `typ` defines the type of token and it is always JWT. ``` {   \"alg\": \"HS256\",   \"typ\": \"JWT\" } ```  ### Payload The second part of the token is the payload, which contains the claims  or the pieces of information being passed about the user and any metadata required. It is mandatory to specify the following claims: * issuer (`iss`): Your API key * subject (`sub`): Workspace identifier * expiration time (`exp`): Timestamp (unix epoch time) until the token is valid. It is highly recommended to set the exp timestamp for a short period, i.e. a matter of seconds. This way, if a token is intercepted or shared, the token will only be valid for a short period of time.  ``` {   \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\",   \"sub\": \"demo.example@actualreports.com\",   \"exp\": 1586112639 } ```  ### Payload for Partners Our partners can send their unique identifier (provided by us) in JWT's partner_id claim. If the `partner_id` value is specified in the JWT, the organization making the request is automatically connected to the partner account. * Partner ID (`partner_id`): Unique identifier provide by PDF Generator API team  ``` {   \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\",   \"sub\": \"demo.example@actualreports.com\",   \"partner_id\": \"my-partner-identifier\",   \"exp\": 1586112639 } ```  ### Signature To create the signature part you have to take the encoded header, the encoded payload, a secret, the algorithm specified in the header, and sign that. The signature is used to verify the message wasn't changed along the way, and, in the case of tokens signed with a private key, it can also verify that the sender of the JWT is who it says it is. ``` HMACSHA256(     base64UrlEncode(header) + \".\" +     base64UrlEncode(payload),     API_SECRET) ```  ### Putting all together The output is three Base64-URL strings separated by dots. The following shows a JWT that has the previous header and payload encoded, and it is signed with a secret. ``` eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0.SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q  // Base64 encoded header: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 // Base64 encoded payload: eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0 // Signature: SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q ```  ## Temporary JWTs You can create a temporary token in [Account Settings](https://pdfgeneratorapi.com/account/organization) page after you login to PDF Generator API. The generated token uses your email address as the subject (`sub`) value and is valid for __15 minutes__. You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API calls. These test tokens should never be used in production applications. *  *  *  *  *  # Error codes  | Code   | Description                    | |--------|--------------------------------| | 401    | Unauthorized                   | | 402    | Payment Required               | | 403    | Forbidden                      | | 404    | Not Found                      | | 422    | Unprocessable Entity           | | 429    | Too Many Requests              | | 500    | Internal Server Error          |  ## 401 Unauthorized | Description                                                             | |-------------------------------------------------------------------------| | Authentication failed: request expired                                  | | Authentication failed: workspace missing                                | | Authentication failed: key missing                                      | | Authentication failed: property 'iss' (issuer) missing in JWT           | | Authentication failed: property 'sub' (subject) missing in JWT          | | Authentication failed: property 'exp' (expiration time) missing in JWT  | | Authentication failed: incorrect signature                              |  ## 402 Payment Required | Description                                                             | |-------------------------------------------------------------------------| | Your account is suspended, please upgrade your account                  |  ## 403 Forbidden | Description                                                             | |-------------------------------------------------------------------------| | Your account has exceeded the monthly document generation limit.        | | Access not granted: You cannot delete master workspace via API          | | Access not granted: Template is not accessible by this organization     | | Your session has expired, please close and reopen the editor.           |  ## 404 Entity not found | Description                                                             | |-------------------------------------------------------------------------| | Entity not found                                                        | | Resource not found                                                      | | None of the templates is available for the workspace.                   |  ## 422 Unprocessable Entity | Description                                                             | |-------------------------------------------------------------------------| | Unable to parse JSON, please check formatting                           | | Required parameter missing                                              | | Required parameter missing: template definition not defined             | | Required parameter missing: template not defined                        |  ## 429 Too Many Requests | Description                                                             | |-------------------------------------------------------------------------| | You can make up to 2 requests per second and 60 requests per minute.   |  *  *  *  *  * 
 
-The version of the OpenAPI document: 4.0.29
+The version of the OpenAPI document: 4.0.31
 Contact: support@pdfgeneratorapi.com
 Generated by: https://openapi-generator.tech
 Generator version: 7.14.0