pdf_generator_api_client 4.0.25

data/docs/TemplatesApi.md

@@ -0,0 +1,791 @@
+# PDFGeneratorAPI::TemplatesApi
+
+All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**copy_template**](TemplatesApi.md#copy_template) | **POST** /templates/{templateId}/copy | Copy template |
+| [**create_template**](TemplatesApi.md#create_template) | **POST** /templates | Create template |
+| [**delete_template**](TemplatesApi.md#delete_template) | **DELETE** /templates/{templateId} | Delete template |
+| [**get_template**](TemplatesApi.md#get_template) | **GET** /templates/{templateId} | Get template |
+| [**get_template_data**](TemplatesApi.md#get_template_data) | **GET** /templates/{templateId}/data | Get template data fields |
+| [**get_template_schema**](TemplatesApi.md#get_template_schema) | **GET** /templates/schema | Get schema |
+| [**get_templates**](TemplatesApi.md#get_templates) | **GET** /templates | Get templates |
+| [**import_template**](TemplatesApi.md#import_template) | **POST** /templates/import | Import template |
+| [**open_editor**](TemplatesApi.md#open_editor) | **POST** /templates/{templateId}/editor | Open editor |
+| [**update_template**](TemplatesApi.md#update_template) | **PUT** /templates/{templateId} | Update template |
+| [**validate_template**](TemplatesApi.md#validate_template) | **POST** /templates/validate | Validate template |
+
+
+## copy_template
+
+> <InlineObject16> copy_template(template_id, opts)
+
+Copy template
+
+Creates a copy of a template to the workspace specified in authentication parameters.
+
+### 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::TemplatesApi.new
+template_id = 19375 # Integer | Template unique identifier
+opts = {
+  copy_template_request: PDFGeneratorAPI::CopyTemplateRequest.new # CopyTemplateRequest | 
+}
+
+begin
+  # Copy template
+  result = api_instance.copy_template(template_id, opts)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->copy_template: #{e}"
+end
+```
+
+#### Using the copy_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject16>, Integer, Hash)> copy_template_with_http_info(template_id, opts)
+
+```ruby
+begin
+  # Copy template
+  data, status_code, headers = api_instance.copy_template_with_http_info(template_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject16>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->copy_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **Integer** | Template unique identifier |  |
+| **copy_template_request** | [**CopyTemplateRequest**](CopyTemplateRequest.md) |  | [optional] |
+
+### Return type
+
+[**InlineObject16**](InlineObject16.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_template
+
+> <InlineObject16> create_template(template_definition_new)
+
+Create template
+
+Creates a new template. If template configuration is not specified in the request body then an empty template is created. Template is placed to the workspace specified in authentication params. Template configuration must be sent in the request body.
+
+### 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::TemplatesApi.new
+template_definition_new = PDFGeneratorAPI::TemplateDefinitionNew.new({name: 'Invoice template'}) # TemplateDefinitionNew | Template configuration
+
+begin
+  # Create template
+  result = api_instance.create_template(template_definition_new)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->create_template: #{e}"
+end
+```
+
+#### Using the create_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject16>, Integer, Hash)> create_template_with_http_info(template_definition_new)
+
+```ruby
+begin
+  # Create template
+  data, status_code, headers = api_instance.create_template_with_http_info(template_definition_new)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject16>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->create_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_definition_new** | [**TemplateDefinitionNew**](TemplateDefinitionNew.md) | Template configuration |  |
+
+### Return type
+
+[**InlineObject16**](InlineObject16.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_template
+
+> delete_template(template_id)
+
+Delete template
+
+Deletes the template from workspace
+
+### 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::TemplatesApi.new
+template_id = 19375 # Integer | Template unique identifier
+
+begin
+  # Delete template
+  api_instance.delete_template(template_id)
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->delete_template: #{e}"
+end
+```
+
+#### Using the delete_template_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_template_with_http_info(template_id)
+
+```ruby
+begin
+  # Delete template
+  data, status_code, headers = api_instance.delete_template_with_http_info(template_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->delete_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **Integer** | Template unique identifier |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_template
+
+> <InlineObject16> get_template(template_id)
+
+Get template
+
+Returns template 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::TemplatesApi.new
+template_id = 19375 # Integer | Template unique identifier
+
+begin
+  # Get template
+  result = api_instance.get_template(template_id)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->get_template: #{e}"
+end
+```
+
+#### Using the get_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject16>, Integer, Hash)> get_template_with_http_info(template_id)
+
+```ruby
+begin
+  # Get template
+  data, status_code, headers = api_instance.get_template_with_http_info(template_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject16>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->get_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **Integer** | Template unique identifier |  |
+
+### Return type
+
+[**InlineObject16**](InlineObject16.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_template_data
+
+> <InlineObject2> get_template_data(template_id)
+
+Get template data fields
+
+Returns all data fields used in the template. Returns structured JSON data that can be used to check which data fields are used in template or autogenerate sample data. 
+
+### 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::TemplatesApi.new
+template_id = 19375 # Integer | Template unique identifier
+
+begin
+  # Get template data fields
+  result = api_instance.get_template_data(template_id)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->get_template_data: #{e}"
+end
+```
+
+#### Using the get_template_data_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject2>, Integer, Hash)> get_template_data_with_http_info(template_id)
+
+```ruby
+begin
+  # Get template data fields
+  data, status_code, headers = api_instance.get_template_data_with_http_info(template_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject2>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->get_template_data_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **Integer** | Template unique identifier |  |
+
+### Return type
+
+[**InlineObject2**](InlineObject2.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_template_schema
+
+> Object get_template_schema
+
+Get schema
+
+Returns Template JSON Schema which defines the structure of the Template Definition.
+
+### 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::TemplatesApi.new
+
+begin
+  # Get schema
+  result = api_instance.get_template_schema
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->get_template_schema: #{e}"
+end
+```
+
+#### Using the get_template_schema_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> get_template_schema_with_http_info
+
+```ruby
+begin
+  # Get schema
+  data, status_code, headers = api_instance.get_template_schema_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->get_template_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
+
+
+## get_templates
+
+> <InlineObject4> get_templates(opts)
+
+Get templates
+
+Returns a list of templates available for the authenticated workspace
+
+### 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::TemplatesApi.new
+opts = {
+  name: 'name_example', # String | Filter template by name
+  tags: 'tags_example', # String | Filter template by tags
+  access: 'private', # String | Filter template by access type. No values returns all templates. private - returns only private templates, organization - returns only organization templates.
+  page: 1, # Integer | Pagination: page to return
+  per_page: 20 # Integer | Pagination: How many records to return per page
+}
+
+begin
+  # Get templates
+  result = api_instance.get_templates(opts)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->get_templates: #{e}"
+end
+```
+
+#### Using the get_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject4>, Integer, Hash)> get_templates_with_http_info(opts)
+
+```ruby
+begin
+  # Get templates
+  data, status_code, headers = api_instance.get_templates_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject4>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->get_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Filter template by name | [optional] |
+| **tags** | **String** | Filter template by tags | [optional] |
+| **access** | **String** | Filter template by access type. No values returns all templates. private - returns only private templates, organization - returns only organization templates. | [optional][default to &#39;&#39;] |
+| **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] |
+
+### Return type
+
+[**InlineObject4**](InlineObject4.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## import_template
+
+> <InlineObject16> import_template(import_template_request)
+
+Import template
+
+Creates a template from existing 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::TemplatesApi.new
+import_template_request = PDFGeneratorAPI::ImportTemplateBase64.new({template: PDFGeneratorAPI::ImportTemplateUrlTemplate.new({name: 'Invoice template'}), file_base64: 'file_base64_example'}) # ImportTemplateRequest | Import a PDF via URL or base64 string as template
+
+begin
+  # Import template
+  result = api_instance.import_template(import_template_request)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->import_template: #{e}"
+end
+```
+
+#### Using the import_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject16>, Integer, Hash)> import_template_with_http_info(import_template_request)
+
+```ruby
+begin
+  # Import template
+  data, status_code, headers = api_instance.import_template_with_http_info(import_template_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject16>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->import_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **import_template_request** | [**ImportTemplateRequest**](ImportTemplateRequest.md) | Import a PDF via URL or base64 string as template |  |
+
+### Return type
+
+[**InlineObject16**](InlineObject16.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## open_editor
+
+> <InlineObject3> open_editor(template_id, open_editor_request)
+
+Open editor
+
+Returns an unique URL which you can use to redirect your user to the editor from your application or use the generated URL as iframe source to show the editor within your application. When using iframe, make sure that your browser allows third-party cookies. 
+
+### 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::TemplatesApi.new
+template_id = 19375 # Integer | Template unique identifier
+open_editor_request = PDFGeneratorAPI::OpenEditorRequest.new # OpenEditorRequest | 
+
+begin
+  # Open editor
+  result = api_instance.open_editor(template_id, open_editor_request)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->open_editor: #{e}"
+end
+```
+
+#### Using the open_editor_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject3>, Integer, Hash)> open_editor_with_http_info(template_id, open_editor_request)
+
+```ruby
+begin
+  # Open editor
+  data, status_code, headers = api_instance.open_editor_with_http_info(template_id, open_editor_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject3>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->open_editor_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **Integer** | Template unique identifier |  |
+| **open_editor_request** | [**OpenEditorRequest**](OpenEditorRequest.md) |  |  |
+
+### Return type
+
+[**InlineObject3**](InlineObject3.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_template
+
+> <InlineObject16> update_template(template_id, template_definition_new)
+
+Update template
+
+Updates template configuration. The template configuration for pages and layout must be complete as the entire configuration is replaced and not merged.
+
+### 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::TemplatesApi.new
+template_id = 19375 # Integer | Template unique identifier
+template_definition_new = PDFGeneratorAPI::TemplateDefinitionNew.new({name: 'Invoice template'}) # TemplateDefinitionNew | Template configuration
+
+begin
+  # Update template
+  result = api_instance.update_template(template_id, template_definition_new)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->update_template: #{e}"
+end
+```
+
+#### Using the update_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject16>, Integer, Hash)> update_template_with_http_info(template_id, template_definition_new)
+
+```ruby
+begin
+  # Update template
+  data, status_code, headers = api_instance.update_template_with_http_info(template_id, template_definition_new)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject16>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->update_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **Integer** | Template unique identifier |  |
+| **template_definition_new** | [**TemplateDefinitionNew**](TemplateDefinitionNew.md) | Template configuration |  |
+
+### Return type
+
+[**InlineObject16**](InlineObject16.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## validate_template
+
+> <InlineObject1> validate_template(template_definition_new)
+
+Validate template
+
+Validates if the provided template configuration matches the template JSON schema.
+
+### 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::TemplatesApi.new
+template_definition_new = PDFGeneratorAPI::TemplateDefinitionNew.new({name: 'Invoice template'}) # TemplateDefinitionNew | Template configuration
+
+begin
+  # Validate template
+  result = api_instance.validate_template(template_definition_new)
+  p result
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->validate_template: #{e}"
+end
+```
+
+#### Using the validate_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineObject1>, Integer, Hash)> validate_template_with_http_info(template_definition_new)
+
+```ruby
+begin
+  # Validate template
+  data, status_code, headers = api_instance.validate_template_with_http_info(template_definition_new)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineObject1>
+rescue PDFGeneratorAPI::ApiError => e
+  puts "Error when calling TemplatesApi->validate_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_definition_new** | [**TemplateDefinitionNew**](TemplateDefinitionNew.md) | Template configuration |  |
+
+### Return type
+
+[**InlineObject1**](InlineObject1.md)
+
+### Authorization
+
+[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+