pdf4me 1.0.1 → 2.0.1

data/Gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :development, :test do
-  gem 'rake', '~> 12.0.0'
-end

data/Rakefile

@@ -1,8 +0,0 @@
-begin
-  require 'rspec/core/rake_task'
-
-  RSpec::Core::RakeTask.new(:spec)
-  task default: :spec
-rescue LoadError
-  # no rspec available
-end

data/docs/ActionFlow.md

@@ -1,8 +0,0 @@
-# Pdf4me::ActionFlow
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**actions** | [**Array<Pdf4meAction>**](Pdf4meAction.md) |  | [optional] 
-
-

data/docs/ApiUsageRes.md

@@ -1,11 +0,0 @@
-# Pdf4me::ApiUsageRes
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**api_usage** | **Integer** | Api usage since last payment. | [optional] 
-**payed_usage** | **Integer** | Total Usage payed. | [optional] 
-**last_payment** | **DateTime** | Date of last payment | [optional] 
-**payment_profile** | **String** | Profile of selected payment | [optional] 
-
-

data/docs/ArchiveConfig.md

@@ -1,11 +0,0 @@
-# Pdf4me::ArchiveConfig
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**archive_metadata** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) | Give the documents metadata for archiving. | 
-**stamp_action** | [**StampAction**](StampAction.md) | Place a signature stamp on to the document. | [optional] 
-**signature_config** | [**SignatureConfig**](SignatureConfig.md) | Give your Signature Configure to get the electronical Identity. | [optional] 
-**use_tsa** | **BOOLEAN** | To guarantee the time of change use a Time Stamp Service. | [optional] 
-
-

data/docs/ArchiveJobReq.md

@@ -1,12 +0,0 @@
-# Pdf4me::ArchiveJobReq
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**job_id** | **String** |  | 
-**source_folder** | [**StorageFolder**](StorageFolder.md) |  | 
-**execution_trigger** | [**ExecutionTrigger**](ExecutionTrigger.md) |  | 
-**archive_config** | [**ArchiveConfig**](ArchiveConfig.md) |  | 
-**target_folder** | [**StorageFolder**](StorageFolder.md) |  | 
-
-

data/docs/ArchiveJobRes.md

@@ -1,9 +0,0 @@
-# Pdf4me::ArchiveJobRes
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**job_id** | **String** |  | 
-**created_successfully** | **BOOLEAN** |  | 
-
-

data/docs/Color.md

@@ -1,10 +0,0 @@
-# Pdf4me::Color
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**red** | **Integer** |  | [optional] 
-**green** | **Integer** |  | [optional] 
-**blue** | **Integer** |  | [optional] 
-
-

data/docs/ConvertApi.md

@@ -1,102 +0,0 @@
-# Pdf4me::ConvertApi
-
-All URIs are relative to *https://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**convert_file_to_pdf**](ConvertApi.md#convert_file_to_pdf) | **POST** /Convert/ConvertFileToPdf | 
-[**convert_to_pdf**](ConvertApi.md#convert_to_pdf) | **POST** /Convert/ConvertToPdf | 
-
-
-# **convert_file_to_pdf**
-> File convert_file_to_pdf(opts)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'pdf4me'
-
-api_instance = Pdf4me::ConvertApi.new
-
-opts = { 
-  file_name: "file_name_example", # String | 
-  file: "file_example" # String | 
-}
-
-begin
-  result = api_instance.convert_file_to_pdf(opts)
-  p result
-rescue Pdf4me::ApiError => e
-  puts "Exception when calling ConvertApi->convert_file_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **file_name** | **String**|  | [optional] 
- **file** | **String**|  | [optional] 
-
-### Return type
-
-**File**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/octet-stream
-
-
-
-# **convert_to_pdf**
-> ConvertToPdfRes convert_to_pdf(opts)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'pdf4me'
-
-api_instance = Pdf4me::ConvertApi.new
-
-opts = { 
-  req: Pdf4me::ConvertToPdf.new # ConvertToPdf | 
-}
-
-begin
-  result = api_instance.convert_to_pdf(opts)
-  p result
-rescue Pdf4me::ApiError => e
-  puts "Exception when calling ConvertApi->convert_to_pdf: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **req** | [**ConvertToPdf**](ConvertToPdf.md)|  | [optional] 
-
-### Return type
-
-[**ConvertToPdfRes**](ConvertToPdfRes.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json, application/bson
- - **Accept**: text/plain, application/json, text/json, application/bson
-
-
-

data/docs/ConvertToPdf.md

@@ -1,10 +0,0 @@
-# Pdf4me::ConvertToPdf
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**notification** | [**Notification**](Notification.md) | Set Notification | [optional] 
-**document** | [**Document**](Document.md) | Document containing the data | [optional] 
-**convert_to_pdf_action** | [**ConvertToPdfAction**](ConvertToPdfAction.md) | Conversion configuration | [optional] 
-
-

data/docs/ConvertToPdfAction.md

@@ -1,10 +0,0 @@
-# Pdf4me::ConvertToPdfAction
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pdf_conformance** | **String** |  | [optional] 
-**conversion_mode** | **String** |  | [optional] 
-**custom_properties** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) |  | [optional] 
-
-

data/docs/ConvertToPdfRes.md

@@ -1,8 +0,0 @@
-# Pdf4me::ConvertToPdfRes
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**document** | [**Document**](Document.md) | Converted Document | [optional] 
-
-

data/docs/CreateImages.md

@@ -1,10 +0,0 @@
-# Pdf4me::CreateImages
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**document** | [**Document**](Document.md) | Stamped Document | [optional] 
-**image_action** | [**ImageAction**](ImageAction.md) | MrcAction configuration | [optional] 
-**notification** | [**Notification**](Notification.md) | Set Notification | [optional] 
-
-

data/docs/CreateImagesRes.md

@@ -1,8 +0,0 @@
-# Pdf4me::CreateImagesRes
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**document** | [**Document**](Document.md) | Document containing the data | [optional] 
-
-

data/docs/CreatePdfA.md

@@ -1,10 +0,0 @@
-# Pdf4me::CreatePdfA
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**document** | [**Document**](Document.md) | Document containing the data | [optional] 
-**pdf_a_action** | [**PdfAAction**](PdfAAction.md) | PdfAAction configuration | [optional] 
-**notification** | [**Notification**](Notification.md) | Set Notification | [optional] 
-
-

data/docs/CreatePdfARes.md

@@ -1,8 +0,0 @@
-# Pdf4me::CreatePdfARes
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**document** | [**Document**](Document.md) | Stamped Document | [optional] 
-
-

data/docs/CustomCMSConfig.md

@@ -1,23 +0,0 @@
-# Pdf4me::CustomCMSConfig
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**white** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**c** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**m** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**y** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**k** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**cm** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**cy** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**ck** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**my** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**mk** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**yk** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**cmy** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**cmk** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**cyk** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**myk** | [**RGBSet**](RGBSet.md) |  | [optional] 
-**cmyk** | [**RGBSet**](RGBSet.md) |  | [optional] 
-
-

data/docs/DocAction.md

@@ -1,8 +0,0 @@
-# Pdf4me::DocAction
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**custom_properties** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) |  | [optional] 
-
-

data/docs/DocLog.md

@@ -1,12 +0,0 @@
-# Pdf4me::DocLog
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message_type** | **String** |  | [optional] 
-**message** | **String** |  | [optional] 
-**timestamp** | **DateTime** |  | [optional] 
-**doc_log_level** | **String** |  | [optional] 
-**duration_milliseconds** | **Integer** |  | [optional] 
-
-

data/docs/DocMetadata.md

@@ -1,16 +0,0 @@
-# Pdf4me::DocMetadata
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | **String** |  | [optional] 
-**subject** | **String** |  | [optional] 
-**page_count** | **Integer** |  | 
-**size** | **Integer** |  | 
-**is_encrypted** | **BOOLEAN** |  | 
-**pdf_compliance** | **String** |  | [optional] 
-**is_signed** | **BOOLEAN** |  | 
-**uploaded_mime_type** | **String** |  | [optional] 
-**uploaded_file_size** | **Integer** |  | 
-
-

data/docs/Document.md

@@ -1,16 +0,0 @@
-# Pdf4me::Document
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**job_id** | **String** | JobId of Documents WorkingSet | [optional] 
-**document_id** | **String** | DocumentId | [optional] 
-**name** | **String** | Give filename inlcuding filetype | [optional] 
-**doc_status** | **String** | Returns the Status of the Document | [optional] 
-**pages** | [**Array<Page>**](Page.md) | Description of pages | [optional] 
-**doc_data** | **String** |  | [optional] 
-**doc_metadata** | [**DocMetadata**](DocMetadata.md) |  | [optional] 
-**doc_logs** | [**Array<DocLog>**](DocLog.md) |  | [optional] 
-**notification** | [**Notification**](Notification.md) |  | [optional] 
-
-

data/docs/DocumentApi.md

@@ -1,203 +0,0 @@
-# Pdf4me::DocumentApi
-
-All URIs are relative to *https://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**drop_document**](DocumentApi.md#drop_document) | **POST** /Document/DropDocument | DropDocument
-[**drop_document_0**](DocumentApi.md#drop_document_0) | **POST** /Document/ProduceDocuments | ProduceDocuments
-[**get_document**](DocumentApi.md#get_document) | **POST** /Document/GetDocument | GetDocument
-[**get_documents**](DocumentApi.md#get_documents) | **GET** /Document/GetDocuments | GetDocuments
-
-
-# **drop_document**
-> DropDocumentRes drop_document(opts)
-
-DropDocument
-
-Drop a document from local FIlesystem or give a cloud storage from where the files will be downloaded.
-
-### Example
-```ruby
-# load the gem
-require 'pdf4me'
-
-api_instance = Pdf4me::DocumentApi.new
-
-opts = { 
-  req: Pdf4me::DropDocumentReq.new # DropDocumentReq | 
-}
-
-begin
-  #DropDocument
-  result = api_instance.drop_document(opts)
-  p result
-rescue Pdf4me::ApiError => e
-  puts "Exception when calling DocumentApi->drop_document: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **req** | [**DropDocumentReq**](DropDocumentReq.md)|  | [optional] 
-
-### Return type
-
-[**DropDocumentRes**](DropDocumentRes.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json, application/bson
- - **Accept**: text/plain, application/json, text/json, application/bson
-
-
-
-# **drop_document_0**
-> ProduceDocumentsRes drop_document_0(opts)
-
-ProduceDocuments
-
-Produce the requested new Order Documents.
-
-### Example
-```ruby
-# load the gem
-require 'pdf4me'
-
-api_instance = Pdf4me::DocumentApi.new
-
-opts = { 
-  req: Pdf4me::ProduceDocuments.new # ProduceDocuments | 
-}
-
-begin
-  #ProduceDocuments
-  result = api_instance.drop_document_0(opts)
-  p result
-rescue Pdf4me::ApiError => e
-  puts "Exception when calling DocumentApi->drop_document_0: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **req** | [**ProduceDocuments**](ProduceDocuments.md)|  | [optional] 
-
-### Return type
-
-[**ProduceDocumentsRes**](ProduceDocumentsRes.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json, application/bson
- - **Accept**: text/plain, application/json, text/json, application/bson
-
-
-
-# **get_document**
-> GetDocumentRes get_document(opts)
-
-GetDocument
-
-Get the content of a document in its full datastructure and content.
-
-### Example
-```ruby
-# load the gem
-require 'pdf4me'
-
-api_instance = Pdf4me::DocumentApi.new
-
-opts = { 
-  req: Pdf4me::GetDocumentReq.new # GetDocumentReq | 
-}
-
-begin
-  #GetDocument
-  result = api_instance.get_document(opts)
-  p result
-rescue Pdf4me::ApiError => e
-  puts "Exception when calling DocumentApi->get_document: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **req** | [**GetDocumentReq**](GetDocumentReq.md)|  | [optional] 
-
-### Return type
-
-[**GetDocumentRes**](GetDocumentRes.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json, application/bson
- - **Accept**: text/plain, application/json, text/json, application/bson
-
-
-
-# **get_documents**
-> GetDocumentRes get_documents(job_id)
-
-GetDocuments
-
-Get the workingset of documents by the JobId.
-
-### Example
-```ruby
-# load the gem
-require 'pdf4me'
-
-api_instance = Pdf4me::DocumentApi.new
-
-job_id = "job_id_example" # String | 
-
-
-begin
-  #GetDocuments
-  result = api_instance.get_documents(job_id)
-  p result
-rescue Pdf4me::ApiError => e
-  puts "Exception when calling DocumentApi->get_documents: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **job_id** | [**String**](.md)|  | 
-
-### Return type
-
-[**GetDocumentRes**](GetDocumentRes.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: text/plain, application/json, text/json, application/bson
-
-
-