pdf_generator_api_client 4.0.25

data/docs/AssetsApi.md

@@ -0,0 +1,77 @@
+# PDFGeneratorAPI::AssetsApi
+
+All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**generate_qr_code**](AssetsApi.md#generate_qr_code) | **POST** /assets/qrcode | Generate QR Code |
+
+
+## generate_qr_code
+
+> <GenerateQRCode201Response> generate_qr_code(generate_qr_code_request)
+
+Generate QR Code
+
+Creates a QR code based on the configuration
+
+### 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::AssetsApi.new
+generate_qr_code_request = PDFGeneratorAPI::GenerateQRCodeRequest.new({content: 'My QR Code'}) # GenerateQRCodeRequest | QR Code configuration
+
+begin
+  # Generate QR Code
+  result = api_instance.generate_qr_code(generate_qr_code_request)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling AssetsApi->generate_qr_code: #{e}"
+end
+```
+
+#### Using the generate_qr_code_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GenerateQRCode201Response>, Integer, Hash)> generate_qr_code_with_http_info(generate_qr_code_request)
+
+```ruby
+begin
+  # Generate QR Code
+  data, status_code, headers = api_instance.generate_qr_code_with_http_info(generate_qr_code_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GenerateQRCode201Response>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling AssetsApi->generate_qr_code_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **generate_qr_code_request** | [**GenerateQRCodeRequest**](GenerateQRCodeRequest.md) | QR Code configuration |  |
+
+### Return type
+
+[**GenerateQRCode201Response**](GenerateQRCode201Response.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AsyncOutputParam.md

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

data/docs/CallbackParam.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::CallbackParam
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Public callback URL that is used to make a POST request when the document is generated. | [optional] |
+| **headers** | **Object** | A key-value pairs of header values sent with the POST request. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::CallbackParam.new(
+  url: https://example.org/document-callback,
+  headers: {"Content-type":"application/json","Custom-header":"ABCDE12345678"}
+)
+```
+

data/docs/Component.md

@@ -0,0 +1,34 @@
+# PDFGeneratorAPI::Component
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cls** | **String** | Defines component class/type | [optional] |
+| **id** | **String** | Component id | [optional] |
+| **width** | **Float** | Width in units | [optional] |
+| **height** | **Float** | Height in units | [optional] |
+| **top** | **Float** | Position from the page top in units | [optional] |
+| **left** | **Float** | Position from the page left in units | [optional] |
+| **zindex** | **Integer** | Defines the rendering order on page. Components with smaller zindex are rendered before | [optional] |
+| **value** | **String** | Component value | [optional] |
+| **data_index** | **String** | Defines data field for Table and Container components which are used to iterate over list of items | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::Component.new(
+  cls: labelComponent,
+  id: component-12313,
+  width: 3.5,
+  height: 1,
+  top: 4.2,
+  left: 2.5,
+  zindex: 102,
+  value: ${price},
+  data_index: line_items
+)
+```
+

data/docs/ConversionApi.md

@@ -0,0 +1,217 @@
+# PDFGeneratorAPI::ConversionApi
+
+All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**convert_html2_pdf**](ConversionApi.md#convert_html2_pdf) | **POST** /conversion/html2pdf | HTML to PDF |
+| [**convert_pdf2_image**](ConversionApi.md#convert_pdf2_image) | **POST** /conversion/pdf2image | PDF to Image |
+| [**convert_url2_pdf**](ConversionApi.md#convert_url2_pdf) | **POST** /conversion/url2pdf | URL to PDF |
+
+
+## convert_html2_pdf
+
+> <InlineObject9> convert_html2_pdf(convert_html2_pdf_request)
+
+HTML to PDF
+
+Converts HTML content to PDF
+
+### 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::ConversionApi.new
+convert_html2_pdf_request = PDFGeneratorAPI::ConvertHTML2PDFRequest.new # ConvertHTML2PDFRequest | 
+
+begin
+  # HTML to PDF
+  result = api_instance.convert_html2_pdf(convert_html2_pdf_request)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling ConversionApi->convert_html2_pdf: #{e}"
+end
+```
+
+#### Using the convert_html2_pdf_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject9>, Integer, Hash)> convert_html2_pdf_with_http_info(convert_html2_pdf_request)
+
+```ruby
+begin
+  # HTML to PDF
+  data, status_code, headers = api_instance.convert_html2_pdf_with_http_info(convert_html2_pdf_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject9>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling ConversionApi->convert_html2_pdf_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **convert_html2_pdf_request** | [**ConvertHTML2PDFRequest**](ConvertHTML2PDFRequest.md) |  |  |
+
+### Return type
+
+[**InlineObject9**](InlineObject9.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## convert_pdf2_image
+
+> <InlineObject10> convert_pdf2_image(convert_pdf2_image_request)
+
+PDF to Image
+
+Converts PDF document to images. Provide either a base64 encoded PDF or a public URL to a PDF file.
+
+### 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::ConversionApi.new
+convert_pdf2_image_request = PDFGeneratorAPI::ConvertPDF2ImageRequest.new # ConvertPDF2ImageRequest | 
+
+begin
+  # PDF to Image
+  result = api_instance.convert_pdf2_image(convert_pdf2_image_request)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling ConversionApi->convert_pdf2_image: #{e}"
+end
+```
+
+#### Using the convert_pdf2_image_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject10>, Integer, Hash)> convert_pdf2_image_with_http_info(convert_pdf2_image_request)
+
+```ruby
+begin
+  # PDF to Image
+  data, status_code, headers = api_instance.convert_pdf2_image_with_http_info(convert_pdf2_image_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject10>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling ConversionApi->convert_pdf2_image_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **convert_pdf2_image_request** | [**ConvertPDF2ImageRequest**](ConvertPDF2ImageRequest.md) |  |  |
+
+### Return type
+
+[**InlineObject10**](InlineObject10.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## convert_url2_pdf
+
+> <InlineObject9> convert_url2_pdf(convert_url2_pdf_request)
+
+URL to PDF
+
+Converts public URL to PDF
+
+### 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::ConversionApi.new
+convert_url2_pdf_request = PDFGeneratorAPI::ConvertURL2PDFRequest.new # ConvertURL2PDFRequest | 
+
+begin
+  # URL to PDF
+  result = api_instance.convert_url2_pdf(convert_url2_pdf_request)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling ConversionApi->convert_url2_pdf: #{e}"
+end
+```
+
+#### Using the convert_url2_pdf_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject9>, Integer, Hash)> convert_url2_pdf_with_http_info(convert_url2_pdf_request)
+
+```ruby
+begin
+  # URL to PDF
+  data, status_code, headers = api_instance.convert_url2_pdf_with_http_info(convert_url2_pdf_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject9>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling ConversionApi->convert_url2_pdf_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **convert_url2_pdf_request** | [**ConvertURL2PDFRequest**](ConvertURL2PDFRequest.md) |  |  |
+
+### Return type
+
+[**InlineObject9**](InlineObject9.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ConvertHTML2PDFRequest.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::ConvertHTML2PDFRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **String** | HTML content | [optional] |
+| **paper_size** | **String** | PDF page size | [optional][default to 'a4'] |
+| **orientation** | **String** |  | [optional][default to 'portrait'] |
+| **output** | **String** | Output | [optional][default to 'base64'] |
+| **filename** | **String** | Document name | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::ConvertHTML2PDFRequest.new(
+  content: <html><title>Test</title><body><h1>Hello world</h1></body></html>,
+  paper_size: a4,
+  orientation: portrait,
+  output: base64,
+  filename: Invoice 12345
+)
+```
+

data/docs/ConvertPDF2ImageRequest.md

@@ -0,0 +1,32 @@
+# PDFGeneratorAPI::ConvertPDF2ImageRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_base64** | **String** | Base64 encoded PDF file. Required if file_url is not provided. | [optional] |
+| **file_url** | **String** | Public HTTPS URL to a PDF file. Required if file_base64 is not provided. | [optional] |
+| **format** | **String** | Output image format | [optional][default to 'png'] |
+| **quality** | **Integer** | Image quality (1-100) | [optional][default to 85] |
+| **resolution** | **Integer** | Image resolution in DPI (72-600) | [optional][default to 150] |
+| **pages** | **String** | Page number or range to convert. Use a single number (e.g. \"1\") or a range (e.g. \"1-4\"). Defaults to all pages. | [optional][default to 'all'] |
+| **output** | **String** | Output format | [optional][default to 'base64'] |
+| **name** | **String** | Document name (max 120 characters). Auto-generated if not provided. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::ConvertPDF2ImageRequest.new(
+  file_base64: JVBERi0xLjcKJeLjz9MKNyAwIG9iago8...,
+  file_url: https://example.org/document.pdf,
+  format: png,
+  quality: 85,
+  resolution: 150,
+  pages: 1-4,
+  output: base64,
+  name: my-document
+)
+```
+

data/docs/ConvertURL2PDFRequest.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::ConvertURL2PDFRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Public URL | [optional] |
+| **paper_size** | **String** | PDF page size | [optional][default to 'a4'] |
+| **orientation** | **String** |  | [optional][default to 'portrait'] |
+| **output** | **String** | Output | [optional][default to 'base64'] |
+| **filename** | **String** | Document name | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::ConvertURL2PDFRequest.new(
+  url: https://example.org,
+  paper_size: a4,
+  orientation: portrait,
+  output: base64,
+  filename: Invoice 12345
+)
+```
+

data/docs/CopyTemplateRequest.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::CopyTemplateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name for the copied template. If name is not specified then the original name is used. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::CopyTemplateRequest.new(
+  name: My copied template
+)
+```
+

data/docs/CreateEInvoiceRequest.md

@@ -0,0 +1,22 @@
+# PDFGeneratorAPI::CreateEInvoiceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Object** | JSON payload that represents the Peppol BIS Billing 3.0 UBL Invoice (https://docs.peppol.eu/poacc/billing/3.0/) Use the Get schema endpoint to see the detailed payload structure. |  |
+| **type** | **String** | Formatting type. | [optional][default to 'UBL'] |
+| **output** | **String** | Response format. When the \"file\" option is used the API returns the file inline. | [optional][default to 'base64'] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::CreateEInvoiceRequest.new(
+  data: null,
+  type: UBL,
+  output: base64
+)
+```
+

data/docs/CreateFacturXEInvoiceRequest.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::CreateFacturXEInvoiceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template** | [**CreateFacturXEInvoiceRequestTemplate**](CreateFacturXEInvoiceRequestTemplate.md) |  |  |
+| **profile** | **String** | Factur-X conformance level. | [optional][default to 'basic'] |
+| **output** | [**OutputParam**](OutputParam.md) |  | [optional][default to 'base64'] |
+| **name** | **String** | Generated document name (optional) | [optional][default to ''] |
+| **metadata** | [**MetadataParam**](MetadataParam.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::CreateFacturXEInvoiceRequest.new(
+  template: null,
+  profile: basic,
+  output: null,
+  name: Invoice 123,
+  metadata: null
+)
+```
+

data/docs/CreateFacturXEInvoiceRequestTemplate.md

@@ -0,0 +1,22 @@
+# PDFGeneratorAPI::CreateFacturXEInvoiceRequestTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Template ID | [optional] |
+| **version_id** | **Integer** | Template version ID | [optional] |
+| **data** | **Object** | JSON payload that represents the Peppol BIS Billing 3.0 UBL Invoice (https://docs.peppol.eu/poacc/billing/3.0/) Use the Get schema endpoint to see the detailed payload structure. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::CreateFacturXEInvoiceRequestTemplate.new(
+  id: null,
+  version_id: 12,
+  data: null
+)
+```
+

data/docs/CreateWorkspaceRequest.md

@@ -0,0 +1,18 @@
+# PDFGeneratorAPI::CreateWorkspaceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier** | **String** | A unique identifier of the workspace. Make sure that you can generate the same identifier for your user. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::CreateWorkspaceRequest.new(
+  identifier: demo.example@actualreports.com
+)
+```
+

data/docs/DataBatchInner.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::DataBatchInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template** | **Integer** | Template id | [optional] |
+| **data** | **Object** | JSON data used to replace data fields in the template | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::DataBatchInner.new(
+  template: null,
+  data: {"id":123,"name":"John Smith","birthdate":"2000-01-01","role":"Developer"}
+)
+```
+

data/docs/Document.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::Document
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_id** | **String** | Document unique identifier | [optional] |
+| **public_url** | **String** | Public URL of the document | [optional] |
+| **template_id** | **Integer** | Template used to generate the document | [optional] |
+| **created_at** | **String** | Date time when the document was generated | [optional] |
+| **expires_at** | **String** | Date time when the document url will expire. Document is stored for 30 days. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::Document.new(
+  public_id: a2bd25b8921f3dc7a440fd7f427f90a4,
+  public_url: https://us1.pdfgeneratorapi.com/api/v4/documents/66/6475768884cecfcd3ed4e6028be8a580/share,
+  template_id: 18905762,
+  created_at: 2022-07-02 13:04:21,
+  expires_at: 2022-08-02 13:04:21
+)
+```
+