pdf4me 1.0.0

data/docs/OptimizeRes.md

@@ -0,0 +1,9 @@
+# Pdf4me::OptimizeRes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document** | [**Document**](Document.md) | Stamped Document | [optional] 
+**notification** | [**Notification**](Notification.md) | Set Notification | [optional] 
+
+

data/docs/Page.md

@@ -0,0 +1,14 @@
+# Pdf4me::Page
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document_id** | **String** |  | [optional] 
+**page_id** | **String** |  | [optional] 
+**page_number** | **Integer** |  | [optional] 
+**rotate** | **Float** |  | [optional] 
+**thumbnail** | **String** |  | [optional] 
+**source_document_id** | **String** |  | [optional] 
+**source_page_number** | **Integer** |  | [optional] 
+
+

data/docs/PageSelection.md

@@ -0,0 +1,10 @@
+# Pdf4me::PageSelection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_nrs** | **Array<Integer>** | Give a list of PageNrs to apply the action.<br />  PageNrs overruels PageIds and PageSequence | [optional] 
+**page_ids** | **Array<String>** | Give a List of PagesIds to apply the action.<br />  PageIds overrules the PageSequence | [optional] 
+**page_sequence** | **String** | {default: PageSelection.All} | [optional] 
+
+

data/docs/Pdf4meAction.md

@@ -0,0 +1,12 @@
+# Pdf4me::Pdf4meAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_id** | **String** |  | [optional] 
+**action_type** | **String** |  | [optional] 
+**user_action** | **String** |  | [optional] 
+**action_config** | **String** |  | [optional] 
+**action_properties** | [**Array<KeyValuePairStringObject>**](KeyValuePairStringObject.md) |  | [optional] 
+
+

data/docs/Pdf4meDocument.md

@@ -0,0 +1,32 @@
+# Pdf4me::Pdf4meDocument
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document_type** | **String** |  | [optional] 
+**blob_ref** | **String** |  | [optional] 
+**job_id** | **String** |  | [optional] 
+**ref_document_id** | **String** |  | [optional] 
+**ref_doc_action** | [**DocAction**](DocAction.md) |  | [optional] 
+**document_id** | **String** |  | [optional] 
+**user_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**ratio** | **Float** |  | [optional] 
+**doc_status** | **String** |  | [optional] 
+**in_execution** | **BOOLEAN** |  | [optional] 
+**order** | **Integer** |  | [optional] 
+**show_doc** | **BOOLEAN** |  | [optional] 
+**doc_data** | **String** |  | [optional] 
+**thumbnail** | **String** |  | [optional] 
+**pages** | [**Array<Page>**](Page.md) |  | [optional] 
+**thumbnails** | **Array<String>** |  | [optional] 
+**doc_logs** | [**Array<DocLog>**](DocLog.md) |  | [optional] 
+**doc_metadata** | [**DocMetadata**](DocMetadata.md) |  | [optional] 
+**original_doc_metadata** | [**DocMetadata**](DocMetadata.md) |  | [optional] 
+**storage_provider_broker** | **String** |  | [optional] 
+**storage_provider** | **String** |  | [optional] 
+**storage_account_id** | **String** |  | [optional] 
+**storage_provider_id** | **String** |  | [optional] 
+**storage_provider_folder_id** | **String** |  | [optional] 
+
+

data/docs/Pdf4meException.md

@@ -0,0 +1,8 @@
+# Pdf4me::Pdf4meException
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_message** | **String** | Human Readable Message of the error | [optional] 
+
+

data/docs/PdfAAction.md

@@ -0,0 +1,14 @@
+# Pdf4me::PdfAAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fonts_to_subset** | [**Array<PdfFont>**](PdfFont.md) | By default, fonts that are embedded are automatically subset to minimize the file size.   If for any reason, e.g. postprocessing, fonts shall not be subset, set the property   SubsetFonts to false. Whether fonts are subset or not is irrelevant with respect to   the compliance with PDF/A. (Relevant is only that all used glyphs are contained in the font program.)   Additionals Fonts can be given in this FontsToSubset List | [optional] 
+**compliance** | **String** | Other listed entries (e.g. ePDF10, ePDF11, .. .ePDF17, ePDFUnk) are not supported as output compliance   level.  Some files cannot be converted to the compliance requested. This will be  detected and up- (AllowUpgrade) or downgrade (AllowDowngrade) the compliance automatically. | [optional] 
+**allow_downgrade** | **BOOLEAN** | If set to True, automatic downgrade of the PDF/A conformance level is allowed, e.g. from PDF/A-1a to PDF/A-1b.  If this property is set to True, the level is downgraded under the following conditions:    - Downgrade to level B: If a file contains text that is not extractable (i.e.missing ToUnicode information).  Example: Downgrade PDF/A-2u to PDF/A-2b.  - Downgrade to level U (PDF/A-2 and PDF/A-3) or B(PDF/A-1): Level A requires logical structure information and  “tagging” information, so if a file contains no such information, its level is downgraded.  <para>  Logical structure information in a PDF defines the structure of content, such as titles, paragraphs, figures, reading order, tables or articles.Logical structure elements can be “tagged” with descriptions or alternative text.  “Tagging” allows the contents of an image to be described to the visually impaired.  It is not possible for Pdf/A converter to add meaningful tagging information. Adding  tagging information without prior knowledge about the input file’s structure and content is neither possible nor  allowed by the PDF/A standard. For that reason, the conformance level is automatically downgraded to level B or U.  Example: Downgrade PDF/A-1a to PDF/A-1b.  </para><para>  If set to False and an input file cannot be converted to the requested standard, e.g.because of missing “tagging”  information, the conversion is aborted and the ErrorCode set to PDF_E_DOWNGRADE.  </para> | [optional] 
+**allow_upgrade** | **BOOLEAN** |  If set to True, automatic upgrade of the PDF/A version is allowed. If the target standard is PDF/A-1 and a file  contains elements that cannot be converted to PDF/A-1, the target standard is upgraded to PDF/A-2. This avoids  significant visual differences in the output file.  For example, the following elements may lead to an automatic upgrade:  - Transpanrecy  - Optional content groups(OCG, layers)  - Real values that exceed the implementation limit of PDF/A-1  - Embedded OpenType font files  - Predefined CMap encodings in Type0 fonts     If set to False, the compliance is not upgraded.Depeding on the value of the ConversionErrorMask the  conversion this will fail with a conversion error PDF_E_CONVERSION | [optional] 
+**output_intent_profile** | **String** | <para>              Set or get the path to the ICC profile for the output intent.              </para>  <para>              The given profile is embedded only if the input file does not contain a PDF/A output intent already              </para> | [optional] 
+**linearize** | **BOOLEAN** | <para>              Get or set whether to linearize the PDF output file, i.e. optimize file for fast web access.              A linearized document has a slightly larger file size than a non-linearized file and provides the following main features:              - When a document is opened in a PDF viewer of a web browser, the first page can be viewed without downloading the entire               PDF file.In contrast, a non-linearized PDF file must be downloaded completely before the firstpage can be displayed.              - When another page is requested by the user, that page is displayed as quickly as possible and incrementally as              data arrives, without downloading the entire PDF file.              </para>  <para>              Signed files cannot be linearizes.So this property must be set to False if              a digital signature is applied.              </para> | [optional] 
+**custom_properties** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) |  | [optional] 
+
+

data/docs/PdfAApi.md

@@ -0,0 +1,102 @@
+# Pdf4me::PdfAApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_pdf_a**](PdfAApi.md#create_pdf_a) | **POST** /PdfA/CreatePdfA | 
+[**pdf_a**](PdfAApi.md#pdf_a) | **POST** /PdfA/PdfA | 
+
+
+# **create_pdf_a**
+> File create_pdf_a(opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'pdf4me'
+
+api_instance = Pdf4me::PdfAApi.new
+
+opts = { 
+  pdf_compliance: "pdf_compliance_example", # String | 
+  file: "file_example" # String | 
+}
+
+begin
+  result = api_instance.create_pdf_a(opts)
+  p result
+rescue Pdf4me::ApiError => e
+  puts "Exception when calling PdfAApi->create_pdf_a: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pdf_compliance** | **String**|  | [optional] 
+ **file** | **String**|  | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/octet-stream
+
+
+
+# **pdf_a**
+> CreatePdfARes pdf_a(opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'pdf4me'
+
+api_instance = Pdf4me::PdfAApi.new
+
+opts = { 
+  req: Pdf4me::CreatePdfA.new # CreatePdfA | 
+}
+
+begin
+  result = api_instance.pdf_a(opts)
+  p result
+rescue Pdf4me::ApiError => e
+  puts "Exception when calling PdfAApi->pdf_a: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req** | [**CreatePdfA**](CreatePdfA.md)|  | [optional] 
+
+### Return type
+
+[**CreatePdfARes**](CreatePdfARes.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/PdfFont.md

@@ -0,0 +1,9 @@
+# Pdf4me::PdfFont
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**font_content** | **String** |  | [optional] 
+
+

data/docs/Pricing.md

@@ -0,0 +1,13 @@
+# Pdf4me::Pricing
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency** | **String** |  | [optional] 
+**total_cost** | **Float** |  | [optional] 
+**page_cnt** | **Integer** |  | [optional] 
+**document_cnt** | **Integer** |  | [optional] 
+**pricing_type_required** | **String** |  | [optional] 
+**pricing_type_of_user** | **String** |  | [optional] 
+
+

data/docs/ProduceDocuments.md

@@ -0,0 +1,14 @@
+# Pdf4me::ProduceDocuments
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_id** | **String** | Document containing the data | [optional] 
+**documents** | [**Array<Document>**](Document.md) | Document containing the data | [optional] 
+**ocr_action** | [**OcrAction**](OcrAction.md) | Document containing the data | [optional] 
+**pdf_a_action** | [**PdfAAction**](PdfAAction.md) | Document containing the data | [optional] 
+**optimize_action** | [**OptimizeAction**](OptimizeAction.md) | Document containing the data | [optional] 
+**produce_output** | [**ProduceOutput**](ProduceOutput.md) | Document containing the data | [optional] 
+**notification** | [**Notification**](Notification.md) | Set Notification | [optional] 
+
+

data/docs/ProduceDocumentsRes.md

@@ -0,0 +1,8 @@
+# Pdf4me::ProduceDocumentsRes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documents** | [**Array<Document>**](Document.md) | Stamped Document | [optional] 
+
+

data/docs/ProduceOutput.md

@@ -0,0 +1,8 @@
+# Pdf4me::ProduceOutput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file_type** | **String** |  | [optional] 
+
+

data/docs/RGBSet.md

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

data/docs/RecognizeDocument.md

@@ -0,0 +1,10 @@
+# Pdf4me::RecognizeDocument
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document** | [**Document**](Document.md) | Give the document to change or use JobId/DocumentId to reference an uploaded document. | [optional] 
+**ocr_action** | [**OcrAction**](OcrAction.md) | Give an image stamp | [optional] 
+**notification** | [**Notification**](Notification.md) | Set Notification | [optional] 
+
+

data/docs/RecognizeDocumentRes.md

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

data/docs/Rectangle.md

@@ -0,0 +1,11 @@
+# Pdf4me::Rectangle
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**x** | **Integer** |  | [optional] 
+**y** | **Integer** |  | [optional] 
+**width** | **Integer** |  | [optional] 
+**height** | **Integer** |  | [optional] 
+
+

data/docs/Rotate.md

@@ -0,0 +1,10 @@
+# Pdf4me::Rotate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**angle** | **Float** |  | 
+**origin_x** | **Integer** |  | 
+**origin_y** | **Integer** |  | 
+
+

data/docs/RunJobRes.md

@@ -0,0 +1,10 @@
+# Pdf4me::RunJobRes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_id** | **String** |  | 
+**documents** | [**Array<Document>**](Document.md) | List of Document Result | [optional] 
+**notification** | [**Notification**](Notification.md) | Set Notification | [optional] 
+
+

data/docs/SignatureConfig.md

@@ -0,0 +1,7 @@
+# Pdf4me::SignatureConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/Split.md

@@ -0,0 +1,10 @@
+# Pdf4me::Split
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document** | [**Document**](Document.md) |  | [optional] 
+**split_action** | [**SplitAction**](SplitAction.md) |  | [optional] 
+**notification** | [**Notification**](Notification.md) | Set Notification | [optional] 
+
+

data/docs/SplitAction.md

@@ -0,0 +1,11 @@
+# Pdf4me::SplitAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**split_after_page** | **Integer** |  | [optional] 
+**split_sequence** | **Array<Integer>** |  | [optional] 
+**recurring_split_after_page** | **Integer** |  | [optional] 
+**custom_properties** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) |  | [optional] 
+
+

data/docs/SplitApi.md

@@ -0,0 +1,103 @@
+# Pdf4me::SplitApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**split**](SplitApi.md#split) | **POST** /Split/Split | 
+[**split_by_page_nr**](SplitApi.md#split_by_page_nr) | **POST** /Split/SplitByPageNr | 
+
+
+# **split**
+> SplitRes split(opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'pdf4me'
+
+api_instance = Pdf4me::SplitApi.new
+
+opts = { 
+  req: Pdf4me::Split.new # Split | 
+}
+
+begin
+  result = api_instance.split(opts)
+  p result
+rescue Pdf4me::ApiError => e
+  puts "Exception when calling SplitApi->split: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req** | [**Split**](Split.md)|  | [optional] 
+
+### Return type
+
+[**SplitRes**](SplitRes.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
+
+
+
+# **split_by_page_nr**
+> SplitRes split_by_page_nr(page_nr, opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'pdf4me'
+
+api_instance = Pdf4me::SplitApi.new
+
+page_nr = 56 # Integer | 
+
+opts = { 
+  file: "file_example" # String | 
+}
+
+begin
+  result = api_instance.split_by_page_nr(page_nr, opts)
+  p result
+rescue Pdf4me::ApiError => e
+  puts "Exception when calling SplitApi->split_by_page_nr: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page_nr** | **Integer**|  | 
+ **file** | **String**|  | [optional] 
+
+### Return type
+
+[**SplitRes**](SplitRes.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain, application/json, text/json, application/bson
+
+
+