pdf4me 1.0.1 → 2.0.1

data/docs/JobConfig.md

@@ -1,18 +0,0 @@
-# Pdf4me::JobConfig
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**job_config_id** | **String** |  | 
-**enabled** | **BOOLEAN** |  | 
-**active** | **BOOLEAN** |  | [optional] 
-**creation_date** | **DateTime** |  | [optional] 
-**mod_date** | **DateTime** |  | [optional] 
-**name** | **String** |  | 
-**user_id** | **String** |  | 
-**source_folder** | [**StorageFolder**](StorageFolder.md) |  | [optional] 
-**execution_trigger** | [**ExecutionTrigger**](ExecutionTrigger.md) |  | [optional] 
-**action_flow** | [**ActionFlow**](ActionFlow.md) |  | [optional] 
-**target_folder** | [**StorageFolder**](StorageFolder.md) |  | [optional] 
-
-

data/docs/JobConfigRes.md

@@ -1,8 +0,0 @@
-# Pdf4me::JobConfigRes
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**job_config_id** | **String** |  | 
-
-

data/docs/KeyValuePairStringObject.md

@@ -1,9 +0,0 @@
-# Pdf4me::KeyValuePairStringObject
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**key** | **String** |  | [optional] 
-**value** | **Object** |  | [optional] 
-
-

data/docs/KeyValuePairStringString.md

@@ -1,9 +0,0 @@
-# Pdf4me::KeyValuePairStringString
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**key** | **String** |  | [optional] 
-**value** | **String** |  | [optional] 
-
-

data/docs/ManagementApi.md

@@ -1,92 +0,0 @@
-# Pdf4me::ManagementApi
-
-All URIs are relative to *https://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**api_usage**](ManagementApi.md#api_usage) | **POST** /Management/ApiUsage | ApiUsage
-[**version**](ManagementApi.md#version) | **POST** /Management/Version | Version
-
-
-# **api_usage**
-> ApiUsageRes api_usage
-
-ApiUsage
-
-Give an overview of current ApiUsage and if its payment.
-
-### Example
-```ruby
-# load the gem
-require 'pdf4me'
-
-api_instance = Pdf4me::ManagementApi.new
-
-begin
-  #ApiUsage
-  result = api_instance.api_usage
-  p result
-rescue Pdf4me::ApiError => e
-  puts "Exception when calling ManagementApi->api_usage: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**ApiUsageRes**](ApiUsageRes.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: text/plain, application/json, text/json, application/bson
-
-
-
-# **version**
-> VersionRes version
-
-Version
-
-A simple method to get the current Version
-
-### Example
-```ruby
-# load the gem
-require 'pdf4me'
-
-api_instance = Pdf4me::ManagementApi.new
-
-begin
-  #Version
-  result = api_instance.version
-  p result
-rescue Pdf4me::ApiError => e
-  puts "Exception when calling ManagementApi->version: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**VersionRes**](VersionRes.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: text/plain, application/json, text/json, application/bson
-
-
-

data/docs/Merge.md

@@ -1,10 +0,0 @@
-# Pdf4me::Merge
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**documents** | [**Array<Document>**](Document.md) |  | [optional] 
-**merge_action** | [**MergeAction**](MergeAction.md) |  | [optional] 
-**notification** | [**Notification**](Notification.md) | Set Notification | [optional] 
-
-

data/docs/MergeAction.md

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

data/docs/MergeApi.md

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

data/docs/MergeRes.md

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

data/docs/Notification.md

@@ -1,9 +0,0 @@
-# Pdf4me::Notification
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**get_notification** | **BOOLEAN** | Run execution in asynchronous way, get notified over Online WebHook | [optional] 
-**connection_id** | **String** | Will be used for Online WebHook | [optional] 
-
-

data/docs/OcrAction.md

@@ -1,12 +0,0 @@
-# Pdf4me::OcrAction
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**stapel** | **String** |  | [optional] 
-**businesss_card_reco** | **BOOLEAN** |  | [optional] 
-**full_text_search** | **BOOLEAN** |  | [optional] 
-**output_type** | **String** |  | [optional] 
-**custom_properties** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) |  | [optional] 
-
-

data/docs/OcrApi.md

@@ -1,57 +0,0 @@
-# Pdf4me::OcrApi
-
-All URIs are relative to *https://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**recognize_document**](OcrApi.md#recognize_document) | **POST** /Ocr/RecognizeDocument | RecognizeDocument
-
-
-# **recognize_document**
-> RecognizeDocumentRes recognize_document(opts)
-
-RecognizeDocument
-
-Recognize a Document with OCR and more advanced recognition possibilities like reading out structured business data in form of table.
-
-### Example
-```ruby
-# load the gem
-require 'pdf4me'
-
-api_instance = Pdf4me::OcrApi.new
-
-opts = { 
-  req: Pdf4me::RecognizeDocument.new # RecognizeDocument | 
-}
-
-begin
-  #RecognizeDocument
-  result = api_instance.recognize_document(opts)
-  p result
-rescue Pdf4me::ApiError => e
-  puts "Exception when calling OcrApi->recognize_document: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **req** | [**RecognizeDocument**](RecognizeDocument.md)|  | [optional] 
-
-### Return type
-
-[**RecognizeDocumentRes**](RecognizeDocumentRes.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/Optimize.md

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

data/docs/OptimizeAction.md

@@ -1,35 +0,0 @@
-# Pdf4me::OptimizeAction
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**profile** | **String** | With this property one of the predefined optimization profiles can be set. If a profile is set then all the properties  listed in TPDFOptimizationProfile(table Profile Settings) are set to their respective values.Properties not  listed in this table are left unchanged.  One way of quickly arriving at a specific setting is to first set the Profile and then adapt the configuration by  setting some of the individual properties. | [optional] 
-**use_profile** | **BOOLEAN** |  | [optional] 
-**remove_redundant_objects** | **BOOLEAN** | Get or set whether redundant objects should be removed. If this property is  set to True, duplicate objects are removed in order to reduce the file size.    {default: false} | [optional] 
-**subset_fonts** | **BOOLEAN** | This property influences two optimizations related to subsetted fonts:  - Subset embedded fonts.  - Merge embedded font programs of different subsets of the same font, granted they can be merged.   <para>  Sub-setting refers to removing those glyphs in a font that are not actually  used in any text contained in the PDF.   </para>{default: false} | [optional] 
-**optimize_resources** | **BOOLEAN** | Get or set whether resources should be optimized. If set, unused resources  such as images, fonts, and color spaces are removed.Also content streams  are re-built.    {default: false} | [optional] 
-**force_compression_types** | **BOOLEAN** | If this option is set, then re-compression of images is forced if an image in the  input PDF has a compression type that differs from the compression types  given in ContinuousCompressions, BitonalCompressions, or IndexedCompressions. Use this option if you want to allow only the given  compression types for images in the output PDF.  {default: false} | [optional] 
-**force_recompression** | **BOOLEAN** | If set, all images are always recompressed.If not set (default), images are only  recompressed if the resulting image is smaller than the original, i.e.requires  less bytes to store in the file.    {default: false} | [optional] 
-**reduce_color_complexity** | **BOOLEAN** | This property is used to enable color complexity reduction of images. (See  also Provided Features for Optimizing Images.)  If enabled then images with device color spaces(DeviceRGB, DeviceCMYK,  or DeviceGray) and indexed images with a device color space as base color  space are analyzed and if possible converted as follows:  - An image with DeviceRGB or DeviceCMYK color space in which all pixels  are gray is converted to a grayscale image with DeviceGray color space.  - An image that contains only black and white pixels is converted into a bitonal image.  - An image in which all the pixels have the same color is down-sampled to one pixel.  Furthermore, images’ masks and soft masks are optimized as follows:  - A soft mask that contains only black and white pixels is converted to a mask.  - A (soft) mask that is opaque is removed.    {default: false} | [optional] 
-**merge_embedded_fonts** | **BOOLEAN** | Merge embedded font programs. Font programs can be merged, if they  originate from the same font, e.g.they are of the same type, have the same  name and encoding.Merging of Type1(PostScript) and TrueType fonts is supported. | [optional] 
-**bitonal_compressions** | **Array<String>** | Get or set the compression types for bi-tonal images.  Several values can be combined.The following values are allowed:  ComprAttemptNone  ComprAttemptRaw  ComprAttemptFlate  ComprAttemptLZW  ComprAttemptGroup3  ComprAttemptGroup4  ComprAttemptSource  ComprAttemptJBIG2  Other values are ignored.   <para>  During optimization, all set compression types are tried and the one resulting in the least memory footprint is taken.  Typically, CCITT Group 4 or JBIG2 is used for bi-tonal compression. Due to the simpler algorithm CCITT Group 4 has  the advantage of being faster. JBIG2 can achieve compression ratios that are up to twice as high as CCITT Group 4  at the cost of longer computation time.   </para>{default: ComprAttemptNone} | [optional] 
-**bitonal_resolution_dpi** | **Float** | Get or set the target resolution in dots per inch (DPI) after re-sampling images  for bi-tonal images.See also ResolutionDPI.    {default: 200} | [optional] 
-**bitonal_threshold_dpi** | **Float** | Get or set the threshold resolution in dots per inch (DPI) to selectively activate  re-sampling for bi-tonal images.The value -1 deactivates re-sampling for bitonal images. See also ThresholdDPI.    {default: -1} | [optional] 
-**clip_images** | **BOOLEAN** | Get or set the option to clip images. When enabled, then invisible parts of images are clipped (cropped).   While this does not affect visual parts of images, it may have a minor visual impact because clipped   images are re-compressed. Pre-blended images are not clipped. Enabling this property will also   enable the OptimizeResources property.                {default: false} | [optional] 
-**continuous_compressions** | **Array<String>** | Get or set the compression types to be tried for continuous images, i.e. RGB, CMYK, and grayscale images.  See also TPDFComprAttempt. Several values can be combined with bitwise or operators.  Other values are ignored. During optimization, all set compression types are tried and the one resulting in   the least memory footprint is taken.    {default: ComprAttemptNone} | [optional] 
-**linearize** | **BOOLEAN** | 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 first page 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>  Signed files cannot be linearizes. So this property must be set to False if a digital signature is applied.   </para>{default: false} | [optional] 
-**image_quality** | **Integer** | Get or set the quality index of lossy compression types. This value ranges   from 1 to 100 and is applied to JPEG and JPEG2000 compression.For  JPEG2000, a quality index of 100 means lossless compression.JPEG compression is always lossy.    {default: 75} | [optional] 
-**indexed_compressions** | **Array<String>** | Get or set the compression types for images that have an indexed (“palette”)  color space.See also TPDFComprAttempt.  Several values can be combined with bitwise or operators.The following values are allowed:  - ComprAttemptNone  - ComprAttemptRaw  - ComprAttemptFlate  - ComprAttemptLZW  - ComprAttemptSource  Other values are ignored.   <para>  During optimization, all set compression types are tried and the one resulting in the least memory footprint is taken.   </para>{default: ComprAttemptFlate} | [optional] 
-**dithering_mode** | **String** | This option enables or disables dithering when down-sampling bi-tonal images.  The only values supported are eDitherNone and eDitherFloydSteinberg.  Some bi-tonal images try to evoke the impression of different levels of gray   by randomly setting pixels to black.If dithering is applied during downsampling    then the gray levels of such images are preserved better.If dithering is switched    off then lines (e.g.text glyphs) are preserved better.      {default: DitherNone} | [optional] 
-**color_resolution_dpi** | **Float** | Get or set the target resolution in dots per inch (DPI) after re-sampling images  for color images.See also ResolutionDPI.    {default: 150} | [optional] 
-**color_threshold_dpi** | **Float** | Get or set the threshold resolution in dots per inch (DPI) to selectively activate  re-sampling for color images.The value -1 deactivates re-sampling for color  images. See also ThresholdDPI.    {default: -1} | [optional] 
-**monochrome_resolution_dpi** | **Float** | Get or set target resolution in dots per inch (DPI) after re-sampling images  for monochrome images.See also ResolutionDPI.    {default: 150} | [optional] 
-**monochrome_threshold_dpi** | **Float** | Get or set the threshold resolution in dots per inch (DPI) to selectively activate  re-sampling for monochrome images.The value -1 deactivates re-sampling  for monochrome images. See also ThresholdDPI.    {default: -1} | [optional] 
-**resolution_dpi** | **Integer** | Get or set the resolution in DPI (dots per inch) after re-sampling images.  This property affects all three image compression types(BitonalResolutionDPI, ColorResolutionDPI, MonochromeResolutionDPI).  A typical value for the resolution when optimizing for the web is 150 DPI.For  printing typically no re-sampling is applied(see property ThresholdDPI).  Pre-blended images, images with a color key mask, mask, and soft mask images are not re-sampled.  When getting ResolutionDPI, the property returns the target resolution in DPI for color images.    {default: Different defaults apply to different image types} | [optional] 
-**threshold_dpi** | **Integer** | Set the threshold in DPI (dots per inch) to selectively activate re-sampling.  Only images with a resolution above the threshold DPI will be re-sampled.  This property affects all three image compression types(BitonalThresholdDPI, ColorThresholdDPI, MonochromeThresholdDPI). The  value -1 deactivates re-sampling.    {default: -1} | [optional] 
-**strip** | **Array<String>** |  Get or set the stripping mode. This mode can be configured to remove unneeded data of a PDF document such as Threads, Metadata, the PieceInfo,  the StructTreeRoot entry, embedded Thumbs and the SpiderInfo entry.Also  this mode is used to indicate whether to flatten form fields, links, and other  annotations.Multiple values of TPDFStripType can be combined with the  bitwise or operator.     {default: StripThreads} | [optional] 
-**info_entries** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) |  Set a key-value pair in the document info dictionary. Values of predefined keys are also stored in the XMP metadata.  Popular entries specified in the PDF Reference 1.7 and accepted by most PDF viewers are \"Title\", \"Author\",  \"Subject\", \"Creator\" (sometimes referred to as Application), and \"Producer\" (sometimes referred to as   PDF Creator). | [optional] 
-**flatten_signature_fields** | **BOOLEAN** | A signature in a PDF consist of two parts:  a.The invisible digital signature in the PDF.  b.The visual appearance that was attributed to the signature.  Part (a) can be used by a viewing application, to verify that a document has not changed since it has been signed  and report this to the user.Part(b) is merely a “decorative” element on the page without further significance.  When optimizing a PDF, the PDF is altered and hence the digital signature is broken.Therefore, all signatures are removed  , including parts(a) and(b).  When the property FlattenSignatureFields is set to True, then digital signatures(parts (a)) are still removed,  but their visual appearances(parts (b)) are flattened.I.e.the latter are retained and drawn as non-editable graphic  onto the page.  <para>  Note: The resulting PDF can be misleading as it visually appears to be signed,  but it has no digital signature and hence, a viewer application does not report any  broken signature.In most cases, such a behavior is undesirable</para> | [optional] 
-**custom_properties** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) |  | [optional] 
-
-

data/docs/OptimizeApi.md

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