pdf4me 1.0.0

data/docs/SplitRes.md

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

data/docs/Stamp.md

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

data/docs/StampAction.md

@@ -0,0 +1,22 @@
+# Pdf4me::StampAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_sequence** | **String** |  | [optional] 
+**relative_pos_x** | **Integer** |  | [optional] 
+**relative_pos_y** | **Integer** |  | [optional] 
+**size_x** | **Integer** |  | [optional] 
+**size_y** | **Integer** |  | [optional] 
+**rotate** | **Float** |  | [optional] 
+**autoorientation** | **BOOLEAN** |  | [optional] 
+**alpha** | **Float** | The opacity of the stamp as a whole. 1.0 for fully opaque, 0.0 for fully transparent.  Default: 1.0  The PDF/A-1 standard does not allow transparency.Therefore, for PDF/A-1 conforming input files you must  not set alpha to a value other than 1.0 | [optional] 
+**scale** | **String** | Modify scale of stamp. Allowed values for ‹scale_set› are:   - relToA4: Scale the stamp relative to the page size. For example, make stamp half as large on a A5 and  twice as large on a A3 page as specified. | [optional] 
+**align_x** | **String** |  | [optional] 
+**align_y** | **String** |  | [optional] 
+**stamp_type** | **String** |  | [optional] 
+**text** | [**Text**](Text.md) |  | [optional] 
+**image** | [**Image**](Image.md) |  | [optional] 
+**custom_properties** | [**Array<KeyValuePairStringString>**](KeyValuePairStringString.md) |  | [optional] 
+
+

data/docs/StampApi.md

@@ -0,0 +1,110 @@
+# Pdf4me::StampApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**stamp**](StampApi.md#stamp) | **POST** /Stamp/Stamp | 
+[**text_stamp**](StampApi.md#text_stamp) | **POST** /Stamp/TextStamp | 
+
+
+# **stamp**
+> StampRes stamp(opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'pdf4me'
+
+api_instance = Pdf4me::StampApi.new
+
+opts = { 
+  req: Pdf4me::Stamp.new # Stamp | 
+}
+
+begin
+  result = api_instance.stamp(opts)
+  p result
+rescue Pdf4me::ApiError => e
+  puts "Exception when calling StampApi->stamp: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **req** | [**Stamp**](Stamp.md)|  | [optional] 
+
+### Return type
+
+[**StampRes**](StampRes.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
+
+
+
+# **text_stamp**
+> File text_stamp(align_x, align_y, opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'pdf4me'
+
+api_instance = Pdf4me::StampApi.new
+
+align_x = "align_x_example" # String | 
+
+align_y = "align_y_example" # String | 
+
+opts = { 
+  text: "text_example", # String | 
+  pages: "pages_example", # String | 
+  file: "file_example" # String | 
+}
+
+begin
+  result = api_instance.text_stamp(align_x, align_y, opts)
+  p result
+rescue Pdf4me::ApiError => e
+  puts "Exception when calling StampApi->text_stamp: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **align_x** | **String**|  | 
+ **align_y** | **String**|  | 
+ **text** | **String**|  | [optional] 
+ **pages** | **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/StampRes.md

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

data/docs/StorageFolder.md

@@ -0,0 +1,10 @@
+# Pdf4me::StorageFolder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**storage_type** | **String** |  | [optional] 
+**folder_name** | **String** |  | [optional] 
+**host** | **String** |  | [optional] 
+
+

data/docs/Text.md

@@ -0,0 +1,17 @@
+# Pdf4me::Text
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**format** | **BOOLEAN** |  | [optional] 
+**size** | **Integer** | The font size in points, e.g. 12. If set to 0, the size is chosen such that text fits stamp size (not allowed if operator is within transformation operator). | [optional] 
+**font** | **String** |  | [optional] 
+**color** | [**Color**](Color.md) |  | [optional] 
+**font_encoding** | **String** |  | [optional] 
+**value** | **String** |  | 
+**mode** | **String** |  | [optional] 
+**rotate** | [**Rotate**](Rotate.md) |  | [optional] 
+**translate** | [**Translate**](Translate.md) |  | [optional] 
+**transform** | [**Transform**](Transform.md) |  | [optional] 
+
+

data/docs/Transform.md

@@ -0,0 +1,13 @@
+# Pdf4me::Transform
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**a** | **Integer** |  | 
+**b** | **Integer** |  | 
+**c** | **Integer** |  | 
+**d** | **Integer** |  | 
+**x** | **Integer** |  | 
+**y** | **Integer** |  | 
+
+

data/docs/Translate.md

@@ -0,0 +1,9 @@
+# Pdf4me::Translate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**offset_x** | **Integer** |  | 
+**offset_y** | **Integer** |  | 
+
+

data/docs/UserFingerprint.md

@@ -0,0 +1,9 @@
+# Pdf4me::UserFingerprint
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip_adress** | **String** |  | [optional] 
+**browser** | **String** |  | [optional] 
+
+

data/docs/VersionRes.md

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

data/docs/java.md

@@ -0,0 +1,425 @@
+
+#UniversalFunctionStructure
+```java
+// <Merge>: Merge is just a placeholder and can be replaced with any other Universal Function
+
+// create object
+<Merge> merge = new <Merge>();
+
+// document
+Document document = new Document();
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+document.setDocData(file);
+merge.setDocument(document);
+
+// action
+<MergeAction> mergeAction = new <MergeAction>();
+// set properties
+// ...
+merge.<setMergeAction>(mergeAction);
+
+// perform function action
+<MergeRes> res = <MergeClient>.<merge>(merge);
+
+// new PDF
+byte[] resultingPdf = res.getDocument().getDocData();
+```
+
+#Authorization
+```java
+// Either you store them in the config.properties file with keys clientId and secret
+// Do not use any quotes:
+// Correct: clientId=sample-not-working-key-aaaaaaa
+// Incorrect: clientId="sample-not-working-key-aaaaaaa"
+Pdf4meClient pdf4meClient = new Pdf4meClient();
+
+// or you pass them as arguments when constructing the Pdf4meClient object
+Pdf4meClient pdf4meClient = new Pdf4meClient(clientId, secret);
+
+// The pdf4meClient object delivers the necessary authentication when instantiating the different pdf4meClients such as for instance Merge
+MergeClient mergeClient = new MergeClient(pdf4meClient);
+byte[] file1 = Files.readAllBytes(Paths.get("myFirstPdf.pdf"));
+byte[] file2 = Files.readAllBytes(Paths.get("mySecondPdf.pdf"));
+byte[] mergedPdf = mergeClient.merge2Pdfs(file1, file2);
+```
+
+<!-- ---------------------------------------------------------Convert----------------------------------------------------------->
+
+#Convert/ConvertToPdf
+```java
+// setup the convertClient
+ConvertClient convertClient = new ConvertClient(pdf4meClient);
+
+// setup convertToPdf object
+ConvertToPdf convertToPdf = new ConvertToPdf();
+
+// document
+Document document = new Document();
+byte[] file = Files.readAllBytes(Paths.get("myWordDoc.docx"));
+document.setDocData(file);
+document.setName("myWordDoc.docx");
+convertToPdf.setDocument(document);
+
+// action
+ConvertToPdfAction convertToPdfAction = new ConvertToPdfAction();
+convertToPdf.setConvertToPdfAction(convertToPdfAction);
+
+// conversion
+ConvertToPdfRes res = convertClient.convertToPdf(convertToPdf);
+
+// extract generated PDF
+byte[] generatedPdf = res.getDocument().getDocData();
+```
+
+#Convert/ConvertFileToPdf
+```java
+// setup the convertClient
+ConvertClient convertClient = new ConvertClient(pdf4meClient);
+
+// document
+String fileName = "myWordDoc.docx";
+byte[] file = Files.readAllBytes(Paths.get(fileName));
+
+// generated PDF
+byte[] generatedPdf = convertClient.convertFileToPdf(file, fileName);
+```
+
+<!-- ---------------------------------------------------------Extract----------------------------------------------------------->
+
+#Extract/Extract
+```java
+// setup the extractClient
+ExtractClient extractClient = new ExtractClient(pdf4meClient);
+
+// list of pages to be extracted
+List<Integer> pageNrs = Arrays.asList(1, 4);
+
+// create extract object
+Extract extract = new Extract();
+
+// document
+Document document = new Document();
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+document.setDocData(file);
+extract.setDocument(document);
+
+// action
+ExtractAction extractAction = new ExtractAction();
+extractAction.setExtractPages(pageNrs);
+extract.setExtractAction(extractAction);
+
+// extract
+ExtractRes res = extractClient.extract(extract);
+
+// new PDF
+byte[] extractedPdf = res.getDocument().getDocData();
+```
+
+#Extract/ExtractPages
+```java
+// setup the extractClient
+ExtractClient extractClient = new ExtractClient(pdf4meClient);
+
+// list of pages to be extracted
+List<Integer> pageNrs = Arrays.asList(1, 4);
+
+// document
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+
+// extract
+byte[] extractedPdf = extractClient.extractPages(pageNrs, file);
+```
+
+<!-- ---------------------------------------------------------Image----------------------------------------------------------->
+
+#Image/CreateImages
+```java
+// setup the imageClient
+ImageClient imageClient = new ImageClient(pdf4meClient);
+
+// prepare parameters
+int width = 4000;
+String imagePageNr = "1";
+ImageExtensionEnum imageFormat = ImageExtensionEnum.JPEG;
+
+// create createImages object
+CreateImages createImages = new CreateImages();
+
+// document
+Document document = new Document();
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+document.setDocData(file);
+createImages.setDocument(document);
+
+// action
+ImageAction imageAction = new ImageAction();
+imageAction.setWidthPixel(width);
+PageSelection pageSelection = new PageSelection();
+pageSelection.addPageNrsItem(Integer.parseInt(imagePageNr));
+imageAction.setImageExtension(imageFormat);
+imageAction.setPageSelection(pageSelection);
+createImages.setImageAction(imageAction);
+
+// create image
+CreateImagesRes res = imageClient.createImages(createImages);
+
+// extract thumbnail
+byte[] thumbnail = res.getDocument().getPages().get(0).getThumbnail();
+```
+
+#Image/CreateThumbnail
+```java
+// setup the imageClient
+ImageClient imageClient = new ImageClient(pdf4meClient);
+
+// prepare arguments
+int width = 4000;
+String imagePageNr = "1";
+ImageExtensionEnum imageFormat = ImageExtensionEnum.JPEG;
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+
+// create Thumbnail
+byte[] thumbnail = imageClient.createThumbnail(width, imagePageNr, imageFormat, file);
+```
+
+<!-- ---------------------------------------------------------Merge----------------------------------------------------------->
+
+#Merge/Merge
+```java
+// setup the mergeClient
+MergeClient mergeClient = new MergeClient(pdf4meClient);
+
+// create merge object
+Merge merge = new Merge();
+
+// files
+byte[] file1 = Files.readAllBytes(Paths.get("myFirstPdf.pdf"));
+byte[] file2 = Files.readAllBytes(Paths.get("mySecondPdf.pdf"));
+
+// documents
+List<Document> documents = new ArrayList<Document>();
+Document doc1 = new Document();
+Document doc2 = new Document();
+doc1.setDocData(file1);
+doc2.setDocData(file2);
+documents.add(doc1);
+documents.add(doc2);
+merge.setDocuments(documents);
+
+// action
+MergeAction mergeAction = new MergeAction();
+merge.setMergeAction(mergeAction);
+
+// merge
+MergeRes res = mergeClient.merge(merge);
+
+// extract merged PDF
+byte[] mergedPdf = res.getDocument().getDocData();
+```
+
+#Merge/Merge2Pdfs
+```java
+// setup the mergeClient
+MergeClient mergeClient = new MergeClient(pdf4meClient);
+
+// files
+byte[] file1 = Files.readAllBytes(Paths.get("myFirstPdf.pdf"));
+byte[] file2 = Files.readAllBytes(Paths.get("mySecondPdf.pdf"));
+
+// merge
+byte[] mergedPdf = mergeClient.merge2Pdfs(file1, file2);
+```
+
+<!-- ---------------------------------------------------------Optimize----------------------------------------------------------->
+
+#Optimize/Optimize
+```java
+// setup the optimizeClient
+OptimizeClient optimizeClient = new OptimizeClient(pdf4meClient);
+
+// create optimize object
+Optimize optimize = new Optimize();
+
+// document
+Document document = new Document();
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+document.setDocData(file);
+optimize.setDocument(document);
+
+// action
+OptimizeAction optimizeAction = new OptimizeAction();
+optimizeAction.useProfile(true);
+optimizeAction.profile(ProfileEnum.MAX);
+optimize.setOptimizeAction(optimizeAction);
+
+// optimize
+OptimizeRes res = optimizeClient.optimize(optimize);
+
+// extract optimized PDF
+byte[] optimizedPdf = res.getDocument().getDocData();
+```
+
+#Optimize/OptimizeByProfile
+```java
+// setup the optimizeClient
+OptimizeClient optimizeClient = new OptimizeClient(pdf4meClient);
+
+// document
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+
+// optimization for maximal memory size reduction (profile: max)
+byte[] optimizedPdf = optimizeClient.optimizeByProfile(ProfileEnum.MAX, file);
+```
+
+<!-- ---------------------------------------------------------PdfA----------------------------------------------------------->
+
+#PdfA/PdfA
+```java
+// setup the pdfAClient
+PdfAClient pdfAClient = new PdfAClient(pdf4meClient);
+
+// create createPdfA object
+CreatePdfA createPdfA = new CreatePdfA();
+
+// document
+Document document = new Document();
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+document.setDocData(file);
+createPdfA.setDocument(document);
+
+// action
+PdfAAction pdfAAction = new PdfAAction();
+pdfAAction.setCompliance(ComplianceEnum.PDFA2U);
+createPdfA.setPdfAAction(pdfAAction);
+
+// create PDF/A
+CreatePdfARes res = pdfAClient.pdfA(createPdfA);
+
+// PDF/A
+byte[] pdfA = res.getDocument().getDocData();
+```
+
+#PdfA/CreatePdfA
+```java
+// setup the pdfAClient
+PdfAClient pdfAClient = new PdfAClient(pdf4meClient);
+
+// parameter
+ComplianceEnum pdfCompliance = ComplianceEnum.PDFA2U;
+
+// document
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+
+// create PDF/A - only providing the file
+byte[] pdfA = pdfAClient.createPdfA(file);
+
+// create PDF/A - providing the file and the desired pdfCompliance
+byte[] pdfA = pdfAClient.createPdfA(file, pdfCompliance);
+```
+<!-- ---------------------------------------------------------Split----------------------------------------------------------->
+
+#Split/Split
+```java
+// setup the splitClient
+SplitClient splitClient = new SplitClient(pdf4meClient);
+
+// parameter
+int pageNr = 2;
+
+//create split object
+Split split = new Split();
+
+// document
+Document document = new Document();
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+document.setDocData(file);
+split.setDocument(document);
+
+// action
+SplitAction splitAction = new SplitAction();
+splitAction.setSplitAfterPage(pageNr);
+split.setSplitAction(splitAction);
+
+// split
+SplitRes res = splitClient.split(split);
+
+// extract the resulting documents
+List<Document> documents = res.getDocuments();
+byte[] pdf1 = documents.get(0).getDocData();
+byte[] pdf2 = documents.get(1).getDocData();
+```
+
+#Split/SplitByPageNr
+```java
+// setup the splitClient
+SplitClient splitClient = new SplitClient(pdf4meClient);
+
+// parameter
+int pageNr = 2;
+
+// document
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+
+// split PDF into two
+List<byte[]> res = splitClient.splitByPageNr(pageNr, file);
+byte[] pdf1 = res.get(0);
+byte[] pdf2 = res.get(1);
+```
+
+<!-- ---------------------------------------------------------Stamp----------------------------------------------------------->
+
+#Stamp/Stamp
+```java
+// setup the stampClient
+StampClient stampClient = new StampClient(pdf4meClient);
+
+// prepare parameters
+String text = "EXAMPLE TEXT";
+String pages = "1,4";
+AlignXEnum alignX = AlignXEnum.CENTER;
+AlignYEnum alignY = AlignYEnum.MIDDLE;
+
+// create stamp object
+Stamp stamp = new Stamp();
+
+// document
+Document document = new Document();
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+document.setDocData(file);
+stamp.setDocument(document);
+
+// action
+StampAction stampAction = new StampAction();
+Text textObj = new Text();
+textObj.setValue(text);
+stampAction.setText(textObj);
+stampAction.setAlpha(1.0); // opacity of the stamp: 1.0 for fully opaque, 0.0 for fully transparent.
+stampAction.setPageSequence(pages);
+stampAction.setAlignX(alignX);
+stampAction.setAlignY(alignY);
+stamp.setStampAction(stampAction);
+
+// stamp
+StampRes res = stampClient.stamp(stamp);
+
+// extract stamped PDF
+byte[] stampedPdf = res.getDocument().getDocData();
+```
+
+#Stamp/TextStamp
+```java
+// setup the stampClient
+StampClient stampClient = new StampClient(pdf4meClient);
+
+// prepare parameters
+String text = "EXAMPLE TEXT";
+String pages = "1,4";
+AlignXEnum alignX = AlignXEnum.CENTER;
+AlignYEnum alignY = AlignYEnum.MIDDLE;
+
+// document
+byte[] file = Files.readAllBytes(Paths.get("myPdf.pdf"));
+
+// stamp
+byte[] stampedPdf = stampClient.textStamp(text, pages, alignX, alignY, file);
+```