pdf4me 1.0.0

data/docs/DropDocumentReq.md

@@ -0,0 +1,20 @@
+# Pdf4me::DropDocumentReq
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notification** | [**Notification**](Notification.md) |  | [optional] 
+**job_id** | **String** |  | [optional] 
+**document_id** | **String** |  | [optional] 
+**user_id** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+**document** | **String** |  | [optional] 
+**file_name** | **String** |  | [optional] 
+**cloud_storage_provider** | **String** |  | [optional] 
+**cloud_storage_files** | **Array<String>** |  | [optional] 
+**cloud_storage_files_desc** | **String** |  | [optional] 
+**get_notified** | **BOOLEAN** | Run the action asynchronously, get notified for any status changes. | [optional] 
+**connection_id** | **String** |  | [optional] 
+**user_fingerprint** | [**UserFingerprint**](UserFingerprint.md) |  | [optional] 
+
+

data/docs/DropDocumentRes.md

@@ -0,0 +1,15 @@
+# Pdf4me::DropDocumentRes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document** | [**Document**](Document.md) |  | [optional] 
+**job_id** | **String** |  | 
+**document_list** | [**Array<Document>**](Document.md) |  | [optional] 
+**doc_logs** | [**Array<DocLog>**](DocLog.md) |  | [optional] 
+**pricing** | [**Pricing**](Pricing.md) |  | [optional] 
+**success** | **BOOLEAN** |  | [optional] 
+**error_msg** | **String** |  | [optional] 
+**exception** | **Object** |  | [optional] 
+
+

data/docs/ExecutionTrigger.md

@@ -0,0 +1,10 @@
+# Pdf4me::ExecutionTrigger
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_time** | **DateTime** |  | [optional] 
+**cron_trigger** | **String** |  | [optional] 
+**continues** | **BOOLEAN** |  | [optional] 
+
+

data/docs/Extract.md

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

data/docs/ExtractAction.md

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

data/docs/ExtractApi.md

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

data/docs/ExtractRes.md

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

data/docs/GetDocumentListRes.md

@@ -0,0 +1,13 @@
+# Pdf4me::GetDocumentListRes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document_list** | [**Array<Document>**](Document.md) |  | [optional] 
+**doc_logs** | [**Array<DocLog>**](DocLog.md) |  | [optional] 
+**pricing** | [**Pricing**](Pricing.md) |  | [optional] 
+**success** | **BOOLEAN** |  | [optional] 
+**error_msg** | **String** |  | [optional] 
+**exception** | **Object** |  | [optional] 
+
+

data/docs/GetDocumentReq.md

@@ -0,0 +1,14 @@
+# Pdf4me::GetDocumentReq
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_id** | **String** |  | [optional] 
+**document_id** | **String** |  | [optional] 
+**thumbnails_only** | **BOOLEAN** |  | [optional] 
+**document_type** | **String** |  | [optional] 
+**get_notified** | **BOOLEAN** | Run the action asynchronously, get notified for any status changes. | [optional] 
+**connection_id** | **String** |  | [optional] 
+**user_fingerprint** | [**UserFingerprint**](UserFingerprint.md) |  | [optional] 
+
+

data/docs/GetDocumentRes.md

@@ -0,0 +1,14 @@
+# Pdf4me::GetDocumentRes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document** | [**Pdf4meDocument**](Pdf4meDocument.md) |  | [optional] 
+**doc_logs** | [**Array<DocLog>**](DocLog.md) |  | [optional] 
+**pricing** | [**Pricing**](Pricing.md) |  | [optional] 
+**document_list** | [**Array<Document>**](Document.md) |  | [optional] 
+**success** | **BOOLEAN** |  | [optional] 
+**error_msg** | **String** |  | [optional] 
+**exception** | **Object** |  | [optional] 
+
+

data/docs/IFormFile.md

@@ -0,0 +1,13 @@
+# Pdf4me::IFormFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content_type** | **String** |  | [optional] 
+**content_disposition** | **String** |  | [optional] 
+**headers** | **Hash<String, Array<String>>** |  | [optional] 
+**length** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+**file_name** | **String** |  | [optional] 
+
+

data/docs/Image.md

@@ -0,0 +1,15 @@
+# Pdf4me::Image
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rectangle** | [**Rectangle**](Rectangle.md) |  | [optional] 
+**image_data** | **String** |  | [optional] 
+**image_type** | **String** |  | [optional] 
+**file_name** | **String** |  | [optional] 
+**compression** | **String** |  | [optional] 
+**rotate** | [**Rotate**](Rotate.md) |  | [optional] 
+**translate** | [**Translate**](Translate.md) |  | [optional] 
+**transform** | [**Transform**](Transform.md) |  | [optional] 
+
+

data/docs/ImageAction.md

@@ -0,0 +1,30 @@
+# Pdf4me::ImageAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_selection** | [**PageSelection**](PageSelection.md) | Set the Pages wo apply the convertion.    {default: PageSelection.All} | [optional] 
+**center** | **BOOLEAN** | Set or get the center mode. When set to True, the document is horizontally and vertically centered on the page.  When set to False, the document is printed to the upper left corner of the page.    {default: false} | [optional] 
+**fit_page** | **BOOLEAN** | set the fit page mode. If set to True, the page is scaled to fit the image (in either width or height). If set to  False, the page is rendered with its true size.  {default: true} | [optional] 
+**bits_per_pixel** | **Integer** | Get or set the color depth. Bi-tonal: 1, gray scale: 8, RGB true color: 24, CMYK: 32.    {default: 24} | [optional] 
+**bilevel_threshold** | **Integer** | Set the threshold for converting from gray to bi-tonal when Dithering is eDitherNone. Value must be in  the range of 0 to 255.    {default: 181} | [optional] 
+**width_pixel** | **Integer** |  | [optional] 
+**height_pixel** | **Integer** |  | [optional] 
+**width_point** | **Integer** |  | [optional] 
+**height_point** | **Integer** |  | [optional] 
+**render_options** | **Array<String>** | Set a specific rendering option. | [optional] 
+**rotate_mode** | **String** | Set the rotation mode of the page.    Attribute: Set the rotation to the viewing rotation attribute of the PDF page, i.e. rendering the  page with the same rotation as it is displayed in a PDF viewer.    {default: Attribute} | [optional] 
+**preserve_aspect_ratio** | **BOOLEAN** | If True a uniform up- or down-scaling is applied, i.e. the output image has the same ratio of width to height as the  input file and its size will fit into the defined dimensions, given by SetBitmapDimensions.    {default: true} | [optional] 
+**image_quality** | **Integer** | 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: 80} | [optional] 
+**cms_engine** | **String** | Set the Color Management System (CMS) Engine.     {default: 80} | [optional] 
+**custom_cms_config** | [**CustomCMSConfig**](CustomCMSConfig.md) | Set the Color Management System (CMS) Engine.     {default: 80} | [optional] 
+**dithering** | **String** | Set the dithering algorithm.Dithering refers to the procedure of simulating colors or grayscales.This is mainly  useful for low color depth (e.g.black and white or indexed) images.  The supported values for TPDFDithering are listed in the corresponding enumeration.  {default: DitherFloydSteinberg} | [optional] 
+**dpi** | **Integer** | <p>              Get or set the resolution of the image in DPI (dots per inch).              Set Both the resolutions for the x- and y-axis are set to the same value.              </p>  <p>              Setting DPI is redundant to setting the specialized properties XDPI and YDPI.              </p>  {default: 150} | [optional] 
+**fill_order** | **String** | Set the bit fill order.  MSB (Most significant bit) or LSB (Least significant bit) first.    {default: MostSignificantBit} | [optional] 
+**filter_ratio** | **Integer** | <p>              This property is used to enable and parameterize super-sampling, a technique to initially render the image at a              higher resolution and then sample it down to the target resolution.As a result of that process the final image              appears smoother, i.e.anti-aliased.              </p>  <p>              Applying super-sampling improves the image quality when rendering at low target resolutions(72 DPI or less); the              higher the target resolution the less the visual impact.              This property requires memory and CPU time quadratically to the ratio, therefore only small values, such as 2 or 3              should be used.              </p>  <p>              If a too high value (in combination with the original image size) is set, it is ignored.              </p>  {default: 1} | [optional] 
+**image_extension** | **String** | Set output Type for image file. | [optional] 
+**color_space** | **String** | Set color space of the output image, see enumeration TPDFColorSpace.  For black white bi-tonal images, a gray color space must be selected    {default: ColorRGB} | [optional] 
+**compression** | **String** | Get or set the compression type of TIFF images. For any other image format, the compression is automatically  defined by the file extension(the file name).  The supported values for TPDFCompression are listed in the corresponding enumeration.                {default: ComprLZW} | [optional] 
+**custom_properties** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) |  | [optional] 
+
+

data/docs/ImageApi.md

@@ -0,0 +1,107 @@
+# Pdf4me::ImageApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_images**](ImageApi.md#create_images) | **POST** /Image/CreateImages | 
+[**create_thumbnail**](ImageApi.md#create_thumbnail) | **POST** /Image/CreateThumbnail | 
+
+
+# **create_images**
+> CreateImagesRes create_images(opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'pdf4me'
+
+api_instance = Pdf4me::ImageApi.new
+
+opts = { 
+  req: Pdf4me::CreateImages.new # CreateImages | 
+}
+
+begin
+  result = api_instance.create_images(opts)
+  p result
+rescue Pdf4me::ApiError => e
+  puts "Exception when calling ImageApi->create_images: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req** | [**CreateImages**](CreateImages.md)|  | [optional] 
+
+### Return type
+
+[**CreateImagesRes**](CreateImagesRes.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
+
+
+
+# **create_thumbnail**
+> File create_thumbnail(width, opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'pdf4me'
+
+api_instance = Pdf4me::ImageApi.new
+
+width = 56 # Integer | 
+
+opts = { 
+  page_nr: "page_nr_example", # String | 
+  image_format: "image_format_example", # String | 
+  file: "file_example" # String | 
+}
+
+begin
+  result = api_instance.create_thumbnail(width, opts)
+  p result
+rescue Pdf4me::ApiError => e
+  puts "Exception when calling ImageApi->create_thumbnail: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **width** | **Integer**|  | 
+ **page_nr** | **String**|  | [optional] 
+ **image_format** | **String**|  | [optional] 
+ **file** | **String**|  | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/octet-stream
+
+
+

data/docs/Job.md

@@ -0,0 +1,10 @@
+# Pdf4me::Job
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_id** | **String** |  | [optional] 
+**job_config_id** | **String** |  | 
+**documents** | [**Array<Document>**](Document.md) |  | [optional] 
+
+

data/docs/JobApi.md

@@ -0,0 +1,197 @@
+# Pdf4me::JobApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_archive_job_config**](JobApi.md#create_archive_job_config) | **POST** /Job/CreateArchiveJobConfig | CreateArchiveJobConfig
+[**job_configs**](JobApi.md#job_configs) | **GET** /Job/JobConfigs | JobConfigs
+[**run_job**](JobApi.md#run_job) | **POST** /Job/RunJob | RunJob
+[**save_job_config**](JobApi.md#save_job_config) | **POST** /Job/SaveJobConfig | SaveJobConfig
+
+
+# **create_archive_job_config**
+> ArchiveJobReq create_archive_job_config(opts)
+
+CreateArchiveJobConfig
+
+Create Archive Job which continuesly converts your PDF to Pdf-A.
+
+### Example
+```ruby
+# load the gem
+require 'pdf4me'
+
+api_instance = Pdf4me::JobApi.new
+
+opts = { 
+  req: Pdf4me::ArchiveJobReq.new # ArchiveJobReq | 
+}
+
+begin
+  #CreateArchiveJobConfig
+  result = api_instance.create_archive_job_config(opts)
+  p result
+rescue Pdf4me::ApiError => e
+  puts "Exception when calling JobApi->create_archive_job_config: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req** | [**ArchiveJobReq**](ArchiveJobReq.md)|  | [optional] 
+
+### Return type
+
+[**ArchiveJobReq**](ArchiveJobReq.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
+
+
+
+# **job_configs**
+> Array<JobConfig> job_configs
+
+JobConfigs
+
+Give a list of user defined Job Configurations.
+
+### Example
+```ruby
+# load the gem
+require 'pdf4me'
+
+api_instance = Pdf4me::JobApi.new
+
+begin
+  #JobConfigs
+  result = api_instance.job_configs
+  p result
+rescue Pdf4me::ApiError => e
+  puts "Exception when calling JobApi->job_configs: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<JobConfig>**](JobConfig.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain, application/json, text/json, application/bson
+
+
+
+# **run_job**
+> RunJobRes run_job(opts)
+
+RunJob
+
+Run a JobConfig with given Document Data. Documents can be given directly in the Job or as a Documen Reference.
+
+### Example
+```ruby
+# load the gem
+require 'pdf4me'
+
+api_instance = Pdf4me::JobApi.new
+
+opts = { 
+  req: Pdf4me::Job.new # Job | 
+}
+
+begin
+  #RunJob
+  result = api_instance.run_job(opts)
+  p result
+rescue Pdf4me::ApiError => e
+  puts "Exception when calling JobApi->run_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req** | [**Job**](Job.md)|  | [optional] 
+
+### Return type
+
+[**RunJobRes**](RunJobRes.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
+
+
+
+# **save_job_config**
+> JobConfigRes save_job_config(opts)
+
+SaveJobConfig
+
+Create a Job Configuration for recurring executions or pipelining of pdf4me functionality.  With pipelining it is possible to run pdf4me base functionality in a specific order as a single execution.
+
+### Example
+```ruby
+# load the gem
+require 'pdf4me'
+
+api_instance = Pdf4me::JobApi.new
+
+opts = { 
+  req: Pdf4me::JobConfig.new # JobConfig | 
+}
+
+begin
+  #SaveJobConfig
+  result = api_instance.save_job_config(opts)
+  p result
+rescue Pdf4me::ApiError => e
+  puts "Exception when calling JobApi->save_job_config: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req** | [**JobConfig**](JobConfig.md)|  | [optional] 
+
+### Return type
+
+[**JobConfigRes**](JobConfigRes.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
+
+
+