pdf_generator_api_client 4.0.25

data/docs/EInvoicesApi.md

@@ -0,0 +1,284 @@
+# PDFGeneratorAPI::EInvoicesApi
+
+All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_e_invoice**](EInvoicesApi.md#create_e_invoice) | **POST** /einvoice | Create eInvoice |
+| [**create_factur_xe_invoice**](EInvoicesApi.md#create_factur_xe_invoice) | **POST** /einvoice/facturx | Create Factur-X eInvoice |
+| [**create_x_rechnung_e_invoice**](EInvoicesApi.md#create_x_rechnung_e_invoice) | **POST** /einvoice/xrechnung | Create XRechnung eInvoice |
+| [**get_e_invoice_schema**](EInvoicesApi.md#get_e_invoice_schema) | **GET** /einvoice/schema | Get schema |
+
+
+## create_e_invoice
+
+> <InlineObject> create_e_invoice(create_e_invoice_request)
+
+Create eInvoice
+
+This endpoint transforms a JSON payload into an XML-based e-invoice that is fully compliant with the European EN 16931 standard. The generated output can be formatted in either UBL (Universal Business Language) or CII (Cross-Industry Invoice) syntax, ensuring interoperability across B2B and B2G platforms. The JSON payload follows Peppol BIS Billing 3.0 UBL Invoice described here: https://docs.peppol.eu/poacc/billing/3.0/
+
+### 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::EInvoicesApi.new
+create_e_invoice_request = PDFGeneratorAPI::CreateEInvoiceRequest.new({data: 3.56}) # CreateEInvoiceRequest | eInvoice conversion
+
+begin
+  # Create eInvoice
+  result = api_instance.create_e_invoice(create_e_invoice_request)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling EInvoicesApi->create_e_invoice: #{e}"
+end
+```
+
+#### Using the create_e_invoice_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject>, Integer, Hash)> create_e_invoice_with_http_info(create_e_invoice_request)
+
+```ruby
+begin
+  # Create eInvoice
+  data, status_code, headers = api_instance.create_e_invoice_with_http_info(create_e_invoice_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling EInvoicesApi->create_e_invoice_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_e_invoice_request** | [**CreateEInvoiceRequest**](CreateEInvoiceRequest.md) | eInvoice conversion |  |
+
+### Return type
+
+[**InlineObject**](InlineObject.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_factur_xe_invoice
+
+> <InlineObject9> create_factur_xe_invoice(create_factur_xe_invoice_request)
+
+Create Factur-X eInvoice
+
+This endpoint transforms a JSON payload a Factur-X e-invoice that is fully compliant with the European EN 16931 standard. The generated output is always a PDF document, embedding a structured CII (Cross-Industry Invoice) XML according to the Factur-X format into a human-readable invoice, ensuring interoperability across B2B and B2G platforms. The JSON payload follows Peppol BIS Billing 3.0 UBL Invoice described here: https://docs.peppol.eu/poacc/billing/3.0/
+
+### 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::EInvoicesApi.new
+create_factur_xe_invoice_request = PDFGeneratorAPI::CreateFacturXEInvoiceRequest.new({template: PDFGeneratorAPI::CreateFacturXEInvoiceRequestTemplate.new}) # CreateFacturXEInvoiceRequest | eInvoice conversion
+
+begin
+  # Create Factur-X eInvoice
+  result = api_instance.create_factur_xe_invoice(create_factur_xe_invoice_request)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling EInvoicesApi->create_factur_xe_invoice: #{e}"
+end
+```
+
+#### Using the create_factur_xe_invoice_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject9>, Integer, Hash)> create_factur_xe_invoice_with_http_info(create_factur_xe_invoice_request)
+
+```ruby
+begin
+  # Create Factur-X eInvoice
+  data, status_code, headers = api_instance.create_factur_xe_invoice_with_http_info(create_factur_xe_invoice_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject9>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling EInvoicesApi->create_factur_xe_invoice_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_factur_xe_invoice_request** | [**CreateFacturXEInvoiceRequest**](CreateFacturXEInvoiceRequest.md) | eInvoice conversion |  |
+
+### Return type
+
+[**InlineObject9**](InlineObject9.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_x_rechnung_e_invoice
+
+> <InlineObject> create_x_rechnung_e_invoice(create_e_invoice_request)
+
+Create XRechnung eInvoice
+
+This endpoint transforms a JSON payload into an XML-based XRechnung e-invoice that is fully compliant with the European EN 16931 standard. The generated output follows the XRechnung format and can be formatted in either UBL (Universal Business Language) or CII (Cross-Industry Invoice) syntax, ensuring interoperability across B2B and B2G platforms. The JSON payload follows Peppol BIS Billing 3.0 UBL Invoice described here: https://docs.peppol.eu/poacc/billing/3.0/
+
+### 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::EInvoicesApi.new
+create_e_invoice_request = PDFGeneratorAPI::CreateEInvoiceRequest.new({data: 3.56}) # CreateEInvoiceRequest | eInvoice conversion
+
+begin
+  # Create XRechnung eInvoice
+  result = api_instance.create_x_rechnung_e_invoice(create_e_invoice_request)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling EInvoicesApi->create_x_rechnung_e_invoice: #{e}"
+end
+```
+
+#### Using the create_x_rechnung_e_invoice_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject>, Integer, Hash)> create_x_rechnung_e_invoice_with_http_info(create_e_invoice_request)
+
+```ruby
+begin
+  # Create XRechnung eInvoice
+  data, status_code, headers = api_instance.create_x_rechnung_e_invoice_with_http_info(create_e_invoice_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling EInvoicesApi->create_x_rechnung_e_invoice_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_e_invoice_request** | [**CreateEInvoiceRequest**](CreateEInvoiceRequest.md) | eInvoice conversion |  |
+
+### Return type
+
+[**InlineObject**](InlineObject.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_e_invoice_schema
+
+> Object get_e_invoice_schema
+
+Get schema
+
+Returns e-invoice JSON schema which defines the structure of the e-invoice.
+
+### 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::EInvoicesApi.new
+
+begin
+  # Get schema
+  result = api_instance.get_e_invoice_schema
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling EInvoicesApi->get_e_invoice_schema: #{e}"
+end
+```
+
+#### Using the get_e_invoice_schema_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> get_e_invoice_schema_with_http_info
+
+```ruby
+begin
+  # Get schema
+  data, status_code, headers = api_instance.get_e_invoice_schema_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling EInvoicesApi->get_e_invoice_schema_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/EncryptAndDecryptBase64.md

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

data/docs/EncryptAndDecryptUrl.md

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

data/docs/EncryptDocumentRequest.md

@@ -0,0 +1,49 @@
+# PDFGeneratorAPI::EncryptDocumentRequest
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::EncryptDocumentRequest.openapi_one_of
+# =>
+# [
+#   :'EncryptAndDecryptBase64',
+#   :'EncryptAndDecryptUrl'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::EncryptDocumentRequest.build(data)
+# => #<EncryptAndDecryptBase64:0x00007fdd4aab02a0>
+
+PDFGeneratorAPI::EncryptDocumentRequest.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `EncryptAndDecryptBase64`
+- `EncryptAndDecryptUrl`
+- `nil` (if no type matches)
+

data/docs/ExtractFormFieldsRequest.md

@@ -0,0 +1,49 @@
+# PDFGeneratorAPI::ExtractFormFieldsRequest
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::ExtractFormFieldsRequest.openapi_one_of
+# =>
+# [
+#   :'FormFieldsBase64',
+#   :'FormFieldsUrl'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::ExtractFormFieldsRequest.build(data)
+# => #<FormFieldsBase64:0x00007fdd4aab02a0>
+
+PDFGeneratorAPI::ExtractFormFieldsRequest.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `FormFieldsBase64`
+- `FormFieldsUrl`
+- `nil` (if no type matches)
+

data/docs/FillFormFieldsRequest.md

@@ -0,0 +1,49 @@
+# PDFGeneratorAPI::FillFormFieldsRequest
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::FillFormFieldsRequest.openapi_one_of
+# =>
+# [
+#   :'FormFillBase64',
+#   :'FormFillUrl'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+PDFGeneratorAPI::FillFormFieldsRequest.build(data)
+# => #<FormFillBase64:0x00007fdd4aab02a0>
+
+PDFGeneratorAPI::FillFormFieldsRequest.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `FormFillBase64`
+- `FormFillUrl`
+- `nil` (if no type matches)
+

data/docs/FormActionDownload.md

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

data/docs/FormActionSend.md

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

data/docs/FormActionSendSendDocument.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::FormActionSendSendDocument
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | HTTPS URL where the generated document will be delivered. |  |
+| **headers** | [**Array<FormActionSendSendDocumentHeadersInner>**](FormActionSendSendDocumentHeadersInner.md) | Optional HTTP headers to include with the delivery request. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormActionSendSendDocument.new(
+  url: https://example.com/webhook,
+  headers: null
+)
+```
+

data/docs/FormActionSendSendDocumentHeadersInner.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::FormActionSendSendDocumentHeadersInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Header name |  |
+| **value** | **String** | Header value |  |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormActionSendSendDocumentHeadersInner.new(
+  name: Authorization,
+  value: Bearer your-token-here
+)
+```
+

data/docs/FormActionStore.md

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

data/docs/FormConfiguration.md

@@ -0,0 +1,22 @@
+# PDFGeneratorAPI::FormConfiguration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | Form title displayed above the form | [optional] |
+| **intro** | **String** | Introductory text displayed above the form fields. Supports rich text. | [optional] |
+| **outro** | **String** | Closing text displayed below the form fields. Supports rich text. | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormConfiguration.new(
+  title: Employment application,
+  intro: Please fill in all required fields.,
+  outro: Thank you for your submission.
+)
+```
+

data/docs/FormConfigurationNew.md

@@ -0,0 +1,26 @@
+# PDFGeneratorAPI::FormConfigurationNew
+
+## 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 | [optional] |
+| **fields** | [**Array<FormFieldsInner>**](FormFieldsInner.md) | A list of form field objects | [optional] |
+| **configuration** | [**FormConfiguration**](FormConfiguration.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormConfigurationNew.new(
+  template_id: 123123,
+  name: Certificate creator,
+  actions: null,
+  fields: null,
+  configuration: null
+)
+```
+

data/docs/FormConfigurationNewActionsInner.md

@@ -0,0 +1,22 @@
+# PDFGeneratorAPI::FormConfigurationNewActionsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **store_document** | **Boolean** |  | [optional] |
+| **download_document** | **Boolean** |  | [optional] |
+| **send_document** | [**FormActionSendSendDocument**](FormActionSendSendDocument.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormConfigurationNewActionsInner.new(
+  store_document: true,
+  download_document: true,
+  send_document: null
+)
+```
+

data/docs/FormFieldsBase64.md

@@ -0,0 +1,20 @@
+# PDFGeneratorAPI::FormFieldsBase64
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_base64** | **String** | PDF document in base64 encoded string format |  |
+| **key_field** | [**KeyFieldParam**](KeyFieldParam.md) |  | [optional][default to 'name'] |
+
+## Example
+
+```ruby
+require 'pdf_generator_api_client'
+
+instance = PDFGeneratorAPI::FormFieldsBase64.new(
+  file_base64: null,
+  key_field: null
+)
+```
+