diff --git a/certified-connectors/Encodian/Readme.md b/certified-connectors/Encodian/Readme.md index d76b46f46..3e28fceb4 100644 --- a/certified-connectors/Encodian/Readme.md +++ b/certified-connectors/Encodian/Readme.md @@ -69,17 +69,17 @@ Split a PDF Document into multiple PDF Documents using barcodes - https://suppor ### Convert Word to PDF Form Convert the Word document provided (Legacy Form Controls Only) to a PDF form document. - https://support.encodian.com/hc/en-gb/articles/360012307133-Convert-Word-to-PDF-Form -### Add Text Watermark -Add a text watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012230494-Add-Text-Watermark +### Add Text Watermark to PDF +Add a text watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012230494 -### Add Image Watermark -Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012484094-Add-Image-Watermark +### Add Image Watermark to PDF +Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012484094 -### Add Text Watermark (Advanced) -Add a text watermark to the specified PDF document using the advanced options - https://support.encodian.com/hc/en-gb/articles/360012345813-Add-Text-Watermark-Advanced +### Add Text Watermark to PDF (Advanced) +Add a text watermark to the specified PDF document using the advanced options - https://support.encodian.com/hc/en-gb/articles/360012345813 -### Add Image Watermark (Advanced) -Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012485874-Add-Image-Watermark-Advanced +### Add Image Watermark to PDF (Advanced) +Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012485874 ### Image Clean Up (Document) Execute image clean up activities focussed on text based images such as Deskew, Rotate, Despeckle + more. @@ -171,3 +171,23 @@ Create a Hash-based message authentication code (HMAC) using a secret key - http ### Create Hash Code Create a Hashcode / message digest - https://support.encodian.com/hc/en-gb/articles/360013996077-Create-Hash-Code +### Add Text Watermark to Image +Add a Text Watermark to the image provided - https://support.encodian.com/hc/en-gb/articles/360013560398-Add-Text-Watermark-To-Image + +### Compare Word Documents +Compare differences between Microsoft Word and PDF Documents - https://support.encodian.com/hc/en-gb/articles/360018576278-Compare-Word-Documents + +### Populate Word Document +Populate a Microsoft Word Document (DOCX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360019620578-Populate-Word-Document + +### Compress PDF +Compress and optimise a PDF document - https://support.encodian.com/hc/en-gb/articles/360019994857-Compress-PDF + +### Send to Encodian Filer +Send data to an Encodian Filer endpoint - https://support.encodian.com/hc/en-gb/articles/4404097189905-Send-to-Encodian-Filer + +### Add Text Watermark to Word +Add a text watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411284008593 + +### Add Image Watermark to Word +Add an image watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411329161361 \ No newline at end of file diff --git a/certified-connectors/Encodian/apiDefinition.swagger.json b/certified-connectors/Encodian/apiDefinition.swagger.json index dca1cdc5b..258def7bf 100644 --- a/certified-connectors/Encodian/apiDefinition.swagger.json +++ b/certified-connectors/Encodian/apiDefinition.swagger.json @@ -795,8 +795,8 @@ } }, "x-ms-visibility": "important", - "summary": "Add Text Watermark", - "description": "Add a text watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012230494-Add-Text-Watermark" + "summary": "Add Text Watermark to PDF", + "description": "Add a text watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012230494" } }, "/api/v1/Core/AddImageWatermark": { @@ -840,8 +840,8 @@ } }, "x-ms-visibility": "important", - "summary": "Add Image Watermark", - "description": "Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012484094-Add-Image-Watermark" + "summary": "Add Image Watermark to PDF", + "description": "Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012484094" } }, "/api/v1/Core/AddTextWatermarkAdvanced": { @@ -885,8 +885,8 @@ } }, "x-ms-visibility": "important", - "summary": "Add Text Watermark (Advanced)", - "description": "Add a text watermark to the specified PDF document using the advanced options - https://support.encodian.com/hc/en-gb/articles/360012345813-Add-Text-Watermark-Advanced-" + "summary": "Add Text Watermark to PDF (Advanced)", + "description": "Add a text watermark to the specified PDF document using the advanced options - https://support.encodian.com/hc/en-gb/articles/360012345813" } }, "/api/v1/Core/AddImageWatermarkAdvanced": { @@ -930,8 +930,8 @@ } }, "x-ms-visibility": "important", - "summary": "Add Image Watermark (Advanced)", - "description": "Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012485874-Add-Image-Watermark-Advanced-" + "summary": "Add Image Watermark to PDF (Advanced)", + "description": "Add an image watermark to the specified PDF document using the standard options - https://support.encodian.com/hc/en-gb/articles/360012485874" } }, "/api/v1/Core/ImageCleanUpDocument": { @@ -2755,6 +2755,7 @@ { "name": "operation", "in": "body", + "description": "Request object, refer to schema definition: DtoEncodianSendToFiler", "required": false, "schema": { "$ref": "#/definitions/DtoEncodianSendToFiler" @@ -2783,6 +2784,96 @@ "description": "Send data to an Encodian Filer endpoint - https://support.encodian.com/hc/en-gb/articles/4404097189905-Send-to-Encodian-Filer" } }, + "/api/v1/Core/AddTextWatermarkWord": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddTextWatermarkWord", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "operation", + "in": "body", + "description": "Request object, refer to schema definition: DtoAddTextWatermarkWord", + "required": false, + "schema": { + "$ref": "#/definitions/DtoAddTextWatermarkWord" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermarkWord" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermarkWord" + } + }, + "400": { + "description": "Bad request" + } + }, + "x-ms-visibility": "important", + "summary": "Add Text Watermark to Word", + "description": "Add a text watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411284008593" + } + }, + "/api/v1/Core/AddImageWatermarkWord": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddImageWatermarkWord", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "operation", + "in": "body", + "description": "Request object, refer to schema definition: DtoAddImageWatermarkWord", + "required": false, + "schema": { + "$ref": "#/definitions/DtoAddImageWatermarkWord" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddImageWatermarkWord" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddImageWatermarkWord" + } + }, + "400": { + "description": "Bad request" + } + }, + "x-ms-visibility": "important", + "summary": "Add Image Watermark to Word", + "description": "Add an image watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411329161361" + } + }, "/api/v1/DynamicSchema/GetDynamicSchemaCreateBarcode": { "get": { "tags": [ @@ -12476,7 +12567,7 @@ "description": "Sets a specfic format for parsing DateTime values." }, "populationOptions": { - "default": "Default", + "default": "InlineErrors", "enum": [ "Default", "AllowMissingMembers", @@ -12783,6 +12874,226 @@ } } }, + "DtoAddTextWatermarkWord": { + "required": [ + "fileName", + "fileContent", + "text" + ], + "type": "object", + "properties": { + "fileName": { + "type": "string", + "x-ms-summary": "Filename", + "description": "The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file'" + }, + "fileContent": { + "format": "byte", + "type": "string", + "x-ms-summary": "File Content", + "description": "The file content of the source Microsoft Word file" + }, + "text": { + "type": "string", + "x-ms-summary": "Text", + "description": "The text to embed as a watermark within the Microsoft Word file" + }, + "orientation": { + "default": "Horizontal", + "enum": [ + "Horizontal", + "Diagonal" + ], + "type": "string", + "x-ms-summary": "Orientation", + "description": "Set the orientation of the text watermark" + }, + "cultureName": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Culture Name", + "description": "Change the thread culture used to process the request" + }, + "font": { + "default": "Calibri", + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Font", + "description": "Set the font type applied to the text watermark, the default font is set to Calibri" + }, + "textColour": { + "default": "#808080", + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Text Colour", + "description": "Set the HTML colour applied to the text watermark, the default colour is set to #808080 (Grey)" + }, + "textSize": { + "format": "int32", + "default": 0, + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "Text Size", + "description": "Set the font size applied to the text watermark, The default size is set to 0 (Auto)" + }, + "isSemiTransparent": { + "default": false, + "type": "boolean", + "x-ms-visibility": "advanced", + "x-ms-summary": "Semi Transparent", + "description": "Set whether the text watermark should be semi transparent" + } + } + }, + "DtoResponseAddTextWatermarkWord": { + "type": "object", + "properties": { + "HttpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "HttpStatusMessage": { + "type": "string", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "OperationId": { + "type": "string", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "Errors": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "Operation Status": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + }, + "Filename": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Filename", + "description": "The filename of the document." + }, + "FileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The processed document." + } + } + }, + "DtoAddImageWatermarkWord": { + "required": [ + "fileName", + "fileContent", + "watermarkFilename", + "watermarkFileContent" + ], + "type": "object", + "properties": { + "fileName": { + "type": "string", + "x-ms-summary": "Filename", + "description": "The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file'" + }, + "fileContent": { + "format": "byte", + "type": "string", + "x-ms-summary": "File Content", + "description": "The file content of the source Microsoft Word file" + }, + "watermarkFilename": { + "type": "string", + "x-ms-summary": "Watermark Filename", + "description": "The filename for the watermark image file, the file extension is mandatory: 'file.jpg' and not 'file'" + }, + "watermarkFileContent": { + "format": "byte", + "type": "string", + "x-ms-summary": "Watermark File Content", + "description": "The content of the watermark image file" + }, + "cultureName": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Culture Name", + "description": "Change the thread culture used to process the request" + }, + "scale": { + "format": "double", + "type": "number", + "x-ms-visibility": "advanced", + "x-ms-summary": "Scale", + "description": "Sets the scale factor expressed as a fraction of the image. The default value is 1, valid values range from 0 to 65.5" + }, + "isSemiTransparent": { + "default": false, + "type": "boolean", + "x-ms-visibility": "advanced", + "x-ms-summary": "Semi Transparent", + "description": "Set whether the text watermark should be semi transparent" + } + } + }, + "DtoResponseAddImageWatermarkWord": { + "type": "object", + "properties": { + "HttpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "HttpStatusMessage": { + "type": "string", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "OperationId": { + "type": "string", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "Errors": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "Operation Status": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + }, + "Filename": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Filename", + "description": "The filename of the document." + }, + "FileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The processed document." + } + } + }, "DtoResponseMgmtGetSubscriptionStatus": { "type": "object", "properties": {