From 7ceca46c7a40e331fa0de8a78053dd2bf9a439a1 Mon Sep 17 00:00:00 2001 From: Encodian <45834050+Encodian@users.noreply.github.com> Date: Mon, 15 Jul 2024 14:40:00 +0100 Subject: [PATCH] Encodian - July 24 (#3569) --- certified-connectors/Encodian/Readme.md | 602 +- .../Encodian/apiDefinition.swagger.json | 11962 +++++++++++----- 2 files changed, 8372 insertions(+), 4192 deletions(-) diff --git a/certified-connectors/Encodian/Readme.md b/certified-connectors/Encodian/Readme.md index dff9602d2..969b3f456 100644 --- a/certified-connectors/Encodian/Readme.md +++ b/certified-connectors/Encodian/Readme.md @@ -12,314 +12,347 @@ The [Encodian Support Portal](https://support.encodian.com/hc/en-gb/sections/360 ## Standard Actions -### Add Attachments to PDF -Attaches (also referred to as embeds) the files provided within the 'Attachments' property to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/8087678202653 +### AI - Translate Text (Single) +Translate the text provided into a single designated language - https://support.encodian.com/hc/en-gb/articles/13568846675996 -### Add HTML Header or Footer -Add a HTML header, footer or both to the specified PDF document - https://support.encodian.com/hc/en-gb/articles/360013808614 +### AI - Translate Text (Multiple) +Translate the text provided into multiple designated languages - https://support.encodian.com/hc/en-gb/articles/13670267593628 -### Add Image Watermark to Image -Adds the specified image to the image provided - https://support.encodian.com/hc/en-gb/articles/8967068141597 +### AI - Translate File +Translate the file provided into the designated language - https://support.encodian.com/hc/en-gb/articles/13790274285724 -### 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 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 - -### Add Image Watermark to Word -Add an image watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411329161361 - -### Add Page Numbers -Add page numbers to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360014464534 - -### Add Rows to Excel -Enables you to add rows to the file provided - https://support.encodian.com/hc/en-gb/articles/11551842583581 - -### 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 PDF -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 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 Text Watermark to Word -Add a text watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411284008593 - -### Add to Archive (ZIP) +### Archive (ZIP) - Create Add the files provided to an archive (.zip) file - https://support.encodian.com/hc/en-gb/articles/360002674918 -### Compare Word Documents -Compare differences between Microsoft Word and PDF Documents - https://support.encodian.com/hc/en-gb/articles/360018576278 - -### Compress an Image -Compress the image provided - https://support.encodian.com/hc/en-gb/articles/360027350513 - -### Compress PDF -Compress and optimise a PDF document - https://support.encodian.com/hc/en-gb/articles/360019994857 - -### Compress PowerPoint -Applies compression to the PowerPoint or presentation file provided - https://support.encodian.com/hc/en-gb/articles/7621965500189 - -### Convert CAD -Convert CAD files to another document format - https://support.encodian.com/hc/en-gb/articles/4542607350417 - -### Convert Email Message -Converts an email message file (MSG or EML) and optionally its contained attachments to a PDF document - https://support.encodian.com/hc/en-gb/articles/360011566298 - -### Convert Excel -Convert Microsoft Excel and CSV documents to PDF, XSLX, HTML, CSV, TIFF, PNG or TXT file formats - https://support.encodian.com/hc/en-gb/articles/360011804178 - -### Convert HTML to PDF -Convert the HTML or Web URL provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360022205154 - -### Convert HTML to Word -Convert the HTML or Web URL provided to a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/360011823213 - -### Convert Image Format -Convert the format of the image provided - https://support.encodian.com/hc/en-gb/articles/360006617857 - -### Convert JSON to Excel -Convert the JSON data to provided to a Microsoft Excel or CSV document - https://support.encodian.com/hc/en-gb/articles/7690520790045 - -### Convert PDF to Images -Convert a PDF document into an array of images (PNG or JPG) - https://support.encodian.com/hc/en-gb/articles/4418101623441 - -### Convert PDF to JPG -Converts every page contained within the PDF document provided to a single JPG image - https://support.encodian.com/hc/en-gb/articles/11096881397277 - -### Convert PDF to PDFA -Convert a PDF document to PDF/A format - https://support.encodian.com/hc/en-gb/articles/360010578413 - -### Convert PDF to PNG -Converts every page contained within the PDF document provided to a single PNG image - https://support.encodian.com/hc/en-gb/articles/10086003836701 - -### Convert PDF to TIFF -Convert a PDF document to TIFF (tiff) format - https://support.encodian.com/hc/en-gb/articles/4418024925457 - -### Convert PDF to Word -Convert a PDF document to Microsoft Word (docx) format - https://support.encodian.com/hc/en-gb/articles/360027229294 - -### Convert PowerPoint -Enables you to convert PPT and PPTX file formats to either PDF, HTML, PPTX, PPT, TXT, TIFF or PNG files - https://support.encodian.com/hc/en-gb/articles/360015879777 - -### Convert Text to PDF -Convert the text provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360011683054 - -### Convert to PDF -Convert a document to PDF or PDF/A format - https://support.encodian.com/hc/en-gb/articles/360011123574 - -### Convert Visio -Convert Microsoft Visio documents to another document format - https://support.encodian.com/hc/en-gb/articles/5306216347665 - -### Convert Word -Convert Microsoft Word documents to PDF, HTML, DOCX, DOC, TXT, TIFF or PNG file formats - https://support.encodian.com/hc/en-gb/articles/360015616117 - -### 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 - -### Create Barcode -Create a Barcode in the specified image format - https://support.encodian.com/hc/en-gb/articles/360006165457-Create-Barcode - -### Create QR Code -Create a QR code in the specified image format - https://support.encodian.com/hc/en-gb/articles/360005178237-Create-QR-Code - -### Crop an Image -Crop the image provided to the specified configuration - https://support.encodian.com/hc/en-gb/articles/10860483459740 - -### Delete Rows from Excel -Enables you to delete rows from the file provided - https://support.encodian.com/hc/en-gb/articles/9936160309148 - -### Disable Tracked Changes -Disables tracked changes for the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6695370804125 - -### Enable Tracked Changes -Enables tracked changes for the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6695385009053 - -### Extract Attachments from PDF -Extracts and returns embedded files from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/9896328763932 - -### Extract Excel Worksheets -Extract specified worksheets from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/13230802892316 - -### Extract from Archive +### Archive (ZIP) - Extract Enables files contained within supported archive package formats to be extracted - https://support.encodian.com/hc/en-gb/articles/11853992723484 -### Extract Images from PDF -Extract images from PDF using specified regions - https://support.encodian.com/hc/en-gb/articles/360006998058 +### Barcode - Create +Create a Barcode in the specified image format - https://support.encodian.com/hc/en-gb/articles/360006165457 -### Extract Text from Image (OCR) -Extract text from the image provided - https://support.encodian.com/hc/en-gb/articles/360006998078 - -### Extract Text from Regions -Extract text using OCR from 70+ files types using specified regions - https://support.encodian.com/hc/en-gb/articles/360015612353 - -### Fill a PDF Form -Fill the PDF Form provided with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360008556077 - -### Flatten PDF -Flatten a PDF Document or PDF Form - https://support.encodian.com/hc/en-gb/articles/4416473033105 - -### Flip an Image -Flips the image provided to the specified configuration - https://support.encodian.com/hc/en-gb/articles/9798473339292 - -### Get Email Attachments -Extracts and returns all attachments contained within the email provided - https://support.encodian.com/hc/en-gb/articles/10531671561629 - -### Get Email Information -Collects and returns detailed information about the email provided - https://support.encodian.com/hc/en-gb/articles/12237799140252 - -### Get Image Information -Get Image Information (Height, Width, Resolution, Format, File Size + more) - https://support.encodian.com/hc/en-gb/articles/4431662425489 - -### Get PDF Document Information -Get PDF Document Information (Number of Pages, File Size + more) - https://support.encodian.com/hc/en-gb/articles/360002949358 - -### Get PDF Form Data -Extract PDF form data from a PDF Form - https://support.encodian.com/hc/en-gb/articles/360035107433 - -### Get PDF Text Layer -Get the text layer for the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360015539373 - -### Get Rows from Excel -Obtains and returns rows as JSON from the file provided - https://support.encodian.com/hc/en-gb/articles/9390845334172 - -### Get Text from Word -Extracts and returns text contained within the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/10583756977180 - -### Get Tracked Changes -Get all the tracked changes (Revisions and comments) for the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6634950400669 - -### Image Clean Up (Document) -Execute image clean up activities focussed on text based images such as Deskew, Rotate, Despeckle + more - https://support.encodian.com/hc/en-gb/articles/360006654298 - -### Image Clean Up (Photo) -Execute image clean up activities for standard photo images - https://support.encodian.com/hc/en-gb/articles/360006654238 - -### Insert HTML to PDF -Insert the HTML provided into a PDF document - https://support.encodian.com/hc/en-gb/articles/360011784354 - -### Manage Tracked Changes -Enables all types of tracked change revisions contained within a Word document to be accepted or rejected, it also allows comments to be removed from the document - https://support.encodian.com/hc/en-gb/articles/10074318228765 - -### Merge document array to PDF -Convert and merge an array of documents to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360014632213 - -### Merge documents to PDF -Convert and merge the documents provided to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360011886173 - -### Merge Excel Files -Merge an array of Microsoft Excel files to a single file (multiple formats) - https://support.encodian.com/hc/en-gb/articles/4469865776529 - -### Merge Excel Rows -Merges the rows contained witthin up to 1,000 Microsoft Excel files (and related formats) into single Microsoft Excel worksheet - https://support.encodian.com/hc/en-gb/articles/11345445953820 - -### Merge Presentations -Merge an array of presentations to a single presentation - https://support.encodian.com/hc/en-gb/articles/4425652063761 - -### Merge Word Documents -Merge an array of Microsoft Word documents to a single Microsoft Word document (DOCX) - https://support.encodian.com/hc/en-gb/articles/360023972213 - -### OCR a PDF Document -Perform OCR on an existing PDF document - https://support.encodian.com/hc/en-gb/articles/360012686653 - -### Parse CSV -Parse CSV and return the extracted data in JSON format - https://support.encodian.com/hc/en-gb/articles/360005177297 - -### Populate Excel -Populate a Microsoft Excel workbook (XLSX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/12736409527324 - -### Populate PowerPoint -Populate a Microsoft PowerPoint file (PPTX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/9715390966300 - -### 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 - -### Read Barcode - Document +### Barcode - Read from Document Read barcode(s) from the document provided - https://support.encodian.com/hc/en-gb/articles/360006170938 -### Read Barcode - Image +### Barcode - Read from Image Read a barcode from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170918 -### Read QR Code - Document -Read a QR code(s) from the document provided - https://support.encodian.com/hc/en-gb/articles/360006165437 +### Convert - CAD +Convert CAD files to another document format - https://support.encodian.com/hc/en-gb/articles/4542607350417 -### Read QR Code - Image -Read a QR code from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170898 +### Convert - Email Message +Converts an email message file (MSG or EML) and optionally its contained attachments to a PDF document - https://support.encodian.com/hc/en-gb/articles/360011566298 -### Redact PDF -Apply the specified redactions to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360018607954 +### Convert - Excel +Convert Microsoft Excel and CSV documents to PDF, XSLX, HTML, CSV, TIFF, PNG or TXT file formats - https://support.encodian.com/hc/en-gb/articles/360011804178 -### Remove EXIF Tags from Image -Remove EXIF tags from the specified image - https://support.encodian.com/hc/en-gb/articles/4415700524817 +### Convert - File to PDF +Convert a document to PDF or PDF/A format - https://support.encodian.com/hc/en-gb/articles/360011123574 -### Remove Watermark from Word -Remove both an image and text watermark from the Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/7752587767965 +### Convert - HTML to PDF +Convert the HTML or Web URL provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360022205154 -### Remove Watermarks from PDF -Removes all or targeted watermarks from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7751328751645 +### Convert - HTML to Word +Convert the HTML or Web URL provided to a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/360011823213 -### Repair PDF -Repair a PDF File - https://support.encodian.com/hc/en-gb/articles/4418809972753 +### Convert - Image Format +Convert the format of the image provided - https://support.encodian.com/hc/en-gb/articles/360006617857 -### Replace Text with Image -Find and replace text contained within a PDF or DOCX document with an image - https://support.encodian.com/hc/en-gb/articles/360027234874 +### Convert - JSON to Excel +Convert the JSON data to provided to a Microsoft Excel or CSV document - https://support.encodian.com/hc/en-gb/articles/7690520790045 -### Resize an Image -Resize and compress the image provided - https://support.encodian.com/hc/en-gb/articles/360018591034-Resize-an-Image +### Convert - PDF to Images +Convert a PDF document into an array of images (PNG or JPG) - https://support.encodian.com/hc/en-gb/articles/4418101623441 -### Resize PDF -Resize the pages contained within the PDF document provided to the specified configuration - https://support.encodian.com/hc/en-gb/articles/12292028562588 +### Convert - PDF to JPG +Converts every page contained within the PDF document provided to a single JPG image - https://support.encodian.com/hc/en-gb/articles/11096881397277 -### Rotate an Image -Rotates the image provided to configuration specified - https://support.encodian.com/hc/en-gb/articles/10041551840796 +### Convert - PDF to PDFA +Convert a PDF document to PDF/A format - https://support.encodian.com/hc/en-gb/articles/360010578413 -### Search and Replace Text -Find and replace text contained within a PDF or DOCX document - https://support.encodian.com/hc/en-gb/articles/360020937853 +### Convert - PDF to PNG +Converts every page contained within the PDF document provided to a single PNG image - https://support.encodian.com/hc/en-gb/articles/10086003836701 -### Secure PDF Document -Encrypt and protect a PDF document - https://support.encodian.com/hc/en-gb/articles/360011330134 +### Convert - PDF to TIFF +Convert a PDF document to TIFF (tiff) format - https://support.encodian.com/hc/en-gb/articles/4418024925457 -### Secure Word Document -Secure and protect a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/6634150180253 +### Convert - PDF to Word +Convert a PDF document to Microsoft Word (docx) format - https://support.encodian.com/hc/en-gb/articles/360027229294 -### Send to Encodian Filer -Send data to an Encodian Filer endpoint - https://support.encodian.com/hc/en-gb/articles/4404097189905 +### Convert - PowerPoint +Enables you to convert PPT and PPTX file formats to either PDF, HTML, PPTX, PPT, TXT, TIFF or PNG files - https://support.encodian.com/hc/en-gb/articles/360015879777 -### Set PDF Document Privileges -Set the privledges assigned to the PDF document - https://support.encodian.com/hc/en-gb/articles/360011337094 +### Convert - Text to PDF +Convert the text provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360011683054 -### Sign PDF -Apply a digital signature to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7117159708189 +### Convert - Visio +Convert Microsoft Visio documents to another document format - https://support.encodian.com/hc/en-gb/articles/5306216347665 -### Split PDF -Split a PDF Document into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360002953277 +### Convert - Word +Convert Microsoft Word documents to PDF, HTML, DOCX, DOC, TXT, TIFF or PNG file formats - https://support.encodian.com/hc/en-gb/articles/360015616117 -### Split PDF by Barcode -Split a PDF Document into multiple PDF Documents using barcodes - https://support.encodian.com/hc/en-gb/articles/360013629457 +### 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 -### Split PDF by Text -Split a PDF Document into multiple PDF Documents using Text Search or Regular Expressions - https://support.encodian.com/hc/en-gb/articles/360012726397 +### CSV - Parse +Parse CSV and return the extracted data in JSON format - https://support.encodian.com/hc/en-gb/articles/360005177297 -### Unlock PDF Document -Decrypt and remove password protection from a PDF document - https://support.encodian.com/hc/en-gb/articles/360003714237 +### Email - Extract Attachments +Extracts and returns all attachments contained within the email provided - https://support.encodian.com/hc/en-gb/articles/10531671561629 -### Update Rows In Excel +### Email - Extract Metadata +Collects and returns detailed information about the email provided - https://support.encodian.com/hc/en-gb/articles/12237799140252 + +### Excel - Add Text Watermark +Add a text watermark to a Microsoft Excel file - https://support.encodian.com/hc/en-gb/articles/14428316059420 + +### Excel - Add Rows +Enables you to add rows to the file provided - https://support.encodian.com/hc/en-gb/articles/11551842583581 + +### Excel - Delete Rows +Enables you to delete rows from the file provided - https://support.encodian.com/hc/en-gb/articles/9936160309148 + +### Excel - Delete Worksheets +Delete specified worksheets from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/13233342312220 + +### Excel - Extract Rows +Obtains and returns rows as JSON from the file provided - https://support.encodian.com/hc/en-gb/articles/9390845334172 + +### Excel - Extract Worksheets +Extract specified worksheets from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/13230802892316 + +### Excel - Merge Rows +Merges the rows contained witthin up to 1,000 Microsoft Excel files (and related formats) into single Microsoft Excel worksheet - https://support.encodian.com/hc/en-gb/articles/11345445953820 + +### Excel - Remove Text Watermark +Remove text watermark(s) from a Microsoft Excel file - https://support.encodian.com/hc/en-gb/articles/14449860203548 + +### Excel - Secure +Secure and protect a Microsoft Excel file - https://support.encodian.com/hc/en-gb/articles/14332917020188 + +### Excel - Unlock +Unlock / remove protection from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/14358530634140 + +### Excel - Update Rows Update the specified rows in the Excel file provided - https://support.encodian.com/hc/en-gb/articles/11205752671004 -### Update Word - Add Headers and Footers +### File - Replace Text with Image +Find and replace text contained within a PDF or DOCX document with an image - https://support.encodian.com/hc/en-gb/articles/360027234874 + +### File - Search and Replace Text +Find and replace text contained within a PDF or DOCX document - https://support.encodian.com/hc/en-gb/articles/360020937853 + +### File - Send to Encodian Filer +Send data to an Encodian Filer endpoint - https://support.encodian.com/hc/en-gb/articles/4404097189905 + +### Image - Add Image Watermark +Adds the specified image to the image provided - https://support.encodian.com/hc/en-gb/articles/8967068141597 + +### Image - Add Text Watermark +Add a Text Watermark to the image provided - https://support.encodian.com/hc/en-gb/articles/360013560398 + +### Image - Compress +Compress the image provided - https://support.encodian.com/hc/en-gb/articles/360027350513 + +### Image - Crop +Crop the image provided to the specified configuration - https://support.encodian.com/hc/en-gb/articles/10860483459740 + +### Image - Clean Up (Document) +Execute image clean up activities focussed on text based images such as Deskew, Rotate, Despeckle + more - https://support.encodian.com/hc/en-gb/articles/360006654298 + +### Image - Clean Up (Photo) +Execute image clean up activities for standard photo images - https://support.encodian.com/hc/en-gb/articles/360006654238 + +### Image - Extract Text (OCR) +Extract text from the image provided - https://support.encodian.com/hc/en-gb/articles/360006998078 + +### Image - Flip +Flips the image provided to the specified configuration - https://support.encodian.com/hc/en-gb/articles/9798473339292 + +### Image - Extract Metadata +Get Image Information (Height, Width, Resolution, Format, File Size + more) - https://support.encodian.com/hc/en-gb/articles/4431662425489 + +### Image - Remove EXIF Tags +Remove EXIF tags from the specified image - https://support.encodian.com/hc/en-gb/articles/4415700524817 + +### Image - Resize an Image +Resize and compress the image provided - https://support.encodian.com/hc/en-gb/articles/360018591034 + +### Image - Rotate an Image +Rotates the image provided to configuration specified - https://support.encodian.com/hc/en-gb/articles/10041551840796 + +### Merge - Excel Files +Merge an array of Microsoft Excel files to a single file (multiple formats) - https://support.encodian.com/hc/en-gb/articles/4469865776529 + +### Merge - File Array to PDF +Convert and merge an array of documents to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360014632213 + +### Merge - Files Array to PDF +Convert and merge the documents provided to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360011886173 + +### Merge - Presentations +Merge an array of presentations to a single presentation - https://support.encodian.com/hc/en-gb/articles/4425652063761 + +### Merge - Word Documents +Merge an array of Microsoft Word documents to a single Microsoft Word document (DOCX) - https://support.encodian.com/hc/en-gb/articles/360023972213 + +### PDF - Add Attachments +Attaches (also referred to as embeds) the files provided within the 'Attachments' property to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/8087678202653 + +### PDF - Add HTML Header or Footer +Add a HTML header, footer or both to the specified PDF document - https://support.encodian.com/hc/en-gb/articles/360013808614 + +### PDF - 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 + +### PDF - 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 + +### PDF - 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 + +### PDF - Add Page Numbers +Add page numbers to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360014464534 + +### PDF - 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 + +### PDF - Apply OCR (Standard) +Perform OCR on an existing PDF document - https://support.encodian.com/hc/en-gb/articles/360012686653 + +### PDF - Compress +Compress and optimise a PDF document - https://support.encodian.com/hc/en-gb/articles/360019994857 + +### PDF - Delete Pages +Delete specified pages from the pdf file provided - https://support.encodian.com/hc/en-gb/articles/13690317983132 + +### PDF - Extract Attachments +Extracts and returns embedded files from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/9896328763932 + +### PDF - Extract Images from Regions +Extract images from PDF using specified regions - https://support.encodian.com/hc/en-gb/articles/360006998058 + +### PDF - Extract Pages +Extract specified pages from the pdf file provided - https://support.encodian.com/hc/en-gb/articles/13958097048732 + +### PDF - Extract Text from Regions +Extract text using OCR from 70+ files types using specified regions - https://support.encodian.com/hc/en-gb/articles/360015612353 + +### PDF - Extract Metadata +Get PDF Document Information (Number of Pages, File Size + more) - https://support.encodian.com/hc/en-gb/articles/360002949358 + +### PDF - Extract Form Data +Extract PDF form data from a PDF Form - https://support.encodian.com/hc/en-gb/articles/360035107433 + +### PDF - Extract Text +Get the text layer for the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360015539373 + +### PDF - Fill Form +Fill the PDF Form provided with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360008556077 + +### PDF - Flatten +Flatten a PDF Document or PDF Form - https://support.encodian.com/hc/en-gb/articles/4416473033105 + +### PDF - Insert HTML +Insert the HTML provided into a PDF document - https://support.encodian.com/hc/en-gb/articles/360011784354 + +### PDF - Redact +Apply the specified redactions to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360018607954 + +### PDF - Remove Watermarks +Removes all or targeted watermarks from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7751328751645 + +### PDF - Repair +Repair a PDF File - https://support.encodian.com/hc/en-gb/articles/4418809972753 + +### PDF - Resize +Resize the pages contained within the PDF document provided to the specified configuration - https://support.encodian.com/hc/en-gb/articles/12292028562588 + +### PDF - Secure +Encrypt and protect a PDF document - https://support.encodian.com/hc/en-gb/articles/360011330134 + +### PDF - Set Privileges +Set the privledges assigned to the PDF document - https://support.encodian.com/hc/en-gb/articles/360011337094 + +### PDF - Sign +Apply a digital signature to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7117159708189 + +### PDF - Split +Split a PDF Document into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360002953277 + +### PDF - Split by Barcode +Split a PDF Document into multiple PDF Documents using barcodes - https://support.encodian.com/hc/en-gb/articles/360013629457 + +### PDF - Split by Text +Split a PDF Document into multiple PDF Documents using Text Search or Regular Expressions - https://support.encodian.com/hc/en-gb/articles/360012726397 + +### PDF - Unlock +Decrypt and remove password protection from a PDF document - https://support.encodian.com/hc/en-gb/articles/360003714237 + +### Populate - Excel +Populate a Microsoft Excel workbook (XLSX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/12736409527324 + +### Populate - PowerPoint +Populate a Microsoft PowerPoint file (PPTX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/9715390966300 + +### Populate - Word Document +Populate a Microsoft Word Document (DOCX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360019620578 + +### PowerPoint - Compress +Applies compression to the PowerPoint or presentation file provided - https://support.encodian.com/hc/en-gb/articles/7621965500189 + +### QR Code - Create +Create a QR code in the specified image format - https://support.encodian.com/hc/en-gb/articles/360005178237 + +### QR Code - Read from Document +Read a QR code(s) from the document provided - https://support.encodian.com/hc/en-gb/articles/360006165437 + +### QR Code - Read from Image +Read a QR code from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170898 + +### Word - Add Headers and Footers Add a HTML header and/or footer to the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/11348579020572 -### Update Word - Hyperlinks +### Word - Add Image Watermark +Add an image watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411329161361 + +### Word - Add Text Watermark +Add a text watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411284008593 + +### Word - Compare +Compare differences between Microsoft Word and PDF Documents - https://support.encodian.com/hc/en-gb/articles/360018576278 + +### Word - Disable Tracked Changes +Disables tracked changes for the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6695370804125 + +### Word - Enable Tracked Changes +Enables tracked changes for the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6695385009053 + +### Word - Extract Text +Extracts and returns text contained within the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/10583756977180 + +### Word - Extract Tracked Changes +Get all the tracked changes (Revisions and comments) for the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6634950400669 + +### Word - Manage Tracked Changes +Enables all types of tracked change revisions contained within a Word document to be accepted or rejected, it also allows comments to be removed from the document - https://support.encodian.com/hc/en-gb/articles/10074318228765 + +### Word - Update Hyperlinks Search for and update hyperlinks within a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/7136687719837 -### Update Word - Remove Headers and Footers +### Word - Update Table of Contents +Updates the 'Table of Contents' in the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/10594864447260 + +### Word - Remove Headers and Footers Removes the specified headers and/or footers from the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/11349707504540 -### Update Word - Table of Contents -Updates the 'Table of Contents' in the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/10594864447260 +### Word - Remove Watermark +Remove both an image and text watermark from the Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/7752587767965 + +### Word - Secure +Secure and protect a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/6634150180253 + +### Word - Split +Split the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/14575340646940 ## Utility Actions @@ -327,7 +360,7 @@ Updates the 'Table of Contents' in the Microsoft Word document provided - https: Decrypts a plain text value (string) using the AES decryption configuration set - https://support.encodian.com/hc/en-gb/articles/13200819253660 ### Utility - AES Encryption -Encrypts a plain text value (string) using the AES encryption configuration set - set.https://support.encodian.com/hc/en-gb/articles/13200698504860 +Encrypts a plain text value (string) using the AES encryption configuration set - https://support.encodian.com/hc/en-gb/articles/13200698504860 ### Utility - Array Add Items Adds the item(s) provided to the JSON array provided or targeted using a JSONPath expression - https://support.encodian.com/hc/en-gb/articles/10565757970332 @@ -338,6 +371,12 @@ Checks whether the JSON array provided or selected using a JSONPath expression c ### Utility - Array Count Items Counts the total number of items contained within the array provided - https://support.encodian.com/hc/en-gb/articles/10284117199004 +### Utility - Array Filter Items +Filter items from a JSON Array - https://support.encodian.com/hc/en-gb/articles/14460654575900 + +### Utility - Array Filter Items via Regex +Filter items from a JSON Array using a Regular Expression - https://support.encodian.com/hc/en-gb/articles/14610830128796 + ### Utility - Array Get Item(s) Selects and returns an item from the JSON array provided or targeted using a JSONPath expression - https://support.encodian.com/hc/en-gb/articles/10564816481564 @@ -356,9 +395,18 @@ Replace targeted values found within the JSON array provided or targeted using a ### Utility - Array Reverse Items Reverses the order of the items contained with the JSON array provided or selected using a JSONPath expression - https://support.encodian.com/hc/en-gb/articles/9993904693660 +### Utility - Array Sort Items +Sort the items in the JSON array provided - https://support.encodian.com/hc/en-gb/articles/14510233816092 + ### Utility - Array to JSON Converts the array provided (or selected from a JSON object) to a named JSON object - https://support.encodian.com/hc/en-gb/articles/12731808723612 +### Utility - Array to XML +Convert an array to a XML Object - https://support.encodian.com/hc/en-gb/articles/13964382131484 + +### Utility - Array Split Items +Split the Array provided by match value or index - https://support.encodian.com/hc/en-gb/articles/14508988206108 + ### Utility - Calculate Date Format the date value provided to the date format provided - https://support.encodian.com/hc/en-gb/articles/11311253860508 @@ -371,9 +419,15 @@ Compares the two text values provided, confirming whether they are equal - https ### Utility - Concatenate Text Concatenates the text values provided to a single text value, optionally delimited by the 'Delimiter' value provided - https://support.encodian.com/hc/en-gb/articles/11873576674077 +### Utility - Convert JSON to XML +Convert the JSON provided to XML - https://support.encodian.com/hc/en-gb/articles/14125966342428 + ### Utility - Convert Time Zone Convert the date value provided to the time zone configuration set - https://support.encodian.com/hc/en-gb/articles/11316002119196 +### Utility - Convert XML to JSON +Convert the XML provided to JSON - https://support.encodian.com/hc/en-gb/articles/14125831121948 + ### Utility - Create GUID Generates a new GUID - https://support.encodian.com/hc/en-gb/articles/9563119917597 @@ -383,6 +437,18 @@ Create a Hash-based message authentication code (HMAC) using a secret key - http ### Utility - Create Hash Code Create a Hashcode / message digest - https://support.encodian.com/hc/en-gb/articles/360013996077 +### Utility - Create JWT +Create a JSON Web Token (JWT) - https://support.encodian.com/hc/en-gb/articles/14501991985564 + +### Utility - RSA Create Key Pair +Creates an RSA key pair - https://support.encodian.com/hc/en-gb/articles/13955455670044 + +### Utility - RSA Decryption +Decrypts an RSA encrypted string using RSA decryption - https://support.encodian.com/hc/en-gb/articles/13727862311580 + +### Utility - RSA Encryption +Encrypts a plain text value (string) using RSA encryption - https://support.encodian.com/hc/en-gb/articles/13727847862300 + ### Utility - Escape HTML Escapes or also known as encodes the HTML string value provided - https://support.encodian.com/hc/en-gb/articles/11749992433437 diff --git a/certified-connectors/Encodian/apiDefinition.swagger.json b/certified-connectors/Encodian/apiDefinition.swagger.json index 9018ab6e4..0b4d56270 100644 --- a/certified-connectors/Encodian/apiDefinition.swagger.json +++ b/certified-connectors/Encodian/apiDefinition.swagger.json @@ -28,1199 +28,12 @@ "propertyName": "Categories", "propertyValue": "Content and Files;Collaboration" } - ], + ], "host": "api.apps-encodian.com", "schemes": [ "https" ], "paths": { - "/api/v1/Core/GetEmailAttachments": { - "post": { - "tags": [ - "Core" - ], - "operationId": "GetEmailAttachments", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoGetEmailAttachments", - "schema": { - "$ref": "#/definitions/DtoGetEmailAttachments" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseGetEmailAttachments" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseGetEmailAttachments" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseGetEmailAttachments" - } - } - }, - "x-ms-visibility": "important", - "summary": "Get Email Attachments", - "description": "Extract attachments from the email provided and return an array of files - https://support.encodian.com/hc/en-gb/articles/10531671561629" - } - }, - "/api/v1/Core/ConvertPdfToJpg": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ConvertPdfToJpg", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoConvertPdfToJpg", - "schema": { - "$ref": "#/definitions/DtoConvertPdfToJpg" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToJpg" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToJpg" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToJpg" - } - } - }, - "x-ms-visibility": "important", - "summary": "Convert PDF to JPG", - "description": "Convert a PDF document to a JPG - https://support.encodian.com/hc/en-gb/articles/11096881397277" - } - }, - "/api/v1/Core/ManageTrackedChanges": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ManageTrackedChanges", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoManageTrackedChanges", - "schema": { - "$ref": "#/definitions/DtoManageTrackedChanges" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseManageTrackedChanges" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseManageTrackedChanges" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseManageTrackedChanges" - } - } - }, - "x-ms-visibility": "important", - "summary": "Manage Tracked Changes", - "description": "Process Tracked Changes within the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/10074318228765" - } - }, - "/api/v1/Core/AddRowsToExcel": { - "post": { - "tags": [ - "Core" - ], - "operationId": "AddRowsToExcel", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoAddRowsToExcel", - "schema": { - "$ref": "#/definitions/DtoAddRowsToExcel" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseAddRowsToExcel" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseAddRowsToExcel" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseAddRowsToExcel" - } - } - }, - "x-ms-visibility": "important", - "summary": "Add Rows to Excel", - "description": "Add rows to the Excel file provided - https://support.encodian.com/hc/en-gb/articles/11551842583581" - } - }, - "/api/v1/Core/FlipImage": { - "post": { - "tags": [ - "Core" - ], - "operationId": "FlipImage", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoFlipImage", - "schema": { - "$ref": "#/definitions/DtoFlipImage" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseFlipImage" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseFlipImage" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseFlipImage" - } - } - }, - "x-ms-visibility": "important", - "summary": "Flip an Image", - "description": "Flip the image provided - https://support.encodian.com/hc/en-gb/articles/9798473339292" - } - }, - "/api/v1/Core/RotateImage": { - "post": { - "tags": [ - "Core" - ], - "operationId": "RotateImage", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoResponseRotateImage", - "schema": { - "$ref": "#/definitions/DtoRotateImage" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseRotateImage" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseRotateImage" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseRotateImage" - } - } - }, - "x-ms-visibility": "important", - "summary": "Rotate an Image", - "description": "Rotate an image by specified degrees - https://support.encodian.com/hc/en-gb/articles/10041551840796" - } - }, - "/api/v1/Core/ExtractAttachmentsFromPdf": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ExtractAttachmentsFromPdf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoExtractAttachmentsFromPdf", - "schema": { - "$ref": "#/definitions/DtoExtractAttachmentsFromPdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseExtractAttachmentsFromPdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseExtractAttachmentsFromPdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseExtractAttachmentsFromPdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Extract Attachments from PDF", - "description": "Extract attachments from the PDF provided - https://support.encodian.com/hc/en-gb/articles/9896328763932" - } - }, - "/api/v1/Core/GetRowsFromExcel": { - "post": { - "tags": [ - "Core" - ], - "operationId": "GetRowsFromExcel", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoGetRowsFromExcel", - "schema": { - "$ref": "#/definitions/DtoGetRowsFromExcel" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseGetRowsFromExcel" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseGetRowsFromExcel" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseGetRowsFromExcel" - } - } - }, - "x-ms-visibility": "important", - "summary": "Get Rows from Excel", - "description": "Get rows from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/9390845334172" - } - }, - "/api/v1/Core/PopulatePowerPoint": { - "post": { - "tags": [ - "Core" - ], - "operationId": "PopulatePowerPoint", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoPopulatePowerPoint", - "schema": { - "$ref": "#/definitions/DtoPopulatePowerPoint" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponsePopulatePowerPoint" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponsePopulatePowerPoint" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponsePopulatePowerPoint" - } - } - }, - "x-ms-visibility": "important", - "summary": "Populate PowerPoint", - "description": "Populate a Microsoft PowerPoint file (PPTX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/9715390966300" - } - }, - "/api/v1/Core/DeleteRowsFromExcel": { - "post": { - "tags": [ - "Core" - ], - "operationId": "DeleteRowsFromExcel", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoDeleteRowsFromExcel", - "schema": { - "$ref": "#/definitions/DtoDeleteRowsFromExcel" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseDeleteRowsFromExcel" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseDeleteRowsFromExcel" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseDeleteRowsFromExcel" - } - } - }, - "x-ms-visibility": "important", - "summary": "Delete Rows from Excel", - "description": "Delete rows from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/9936160309148" - } - }, - "/api/v1/Core/UpdateWordTableOfContents": { - "post": { - "tags": [ - "Core" - ], - "operationId": "UpdateWordTableOfContents", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoUpdateWordTableOfContents", - "schema": { - "$ref": "#/definitions/DtoUpdateWordTableOfContents" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseUpdateWordTableOfContents" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseUpdateWordTableOfContents" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseUpdateWordTableOfContents" - } - } - }, - "x-ms-visibility": "important", - "summary": "Update Word - Table of Contents", - "description": "Update the 'Table of Contents' in the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/10594864447260" - } - }, - "/api/v1/Core/CropImage": { - "post": { - "tags": [ - "Core" - ], - "operationId": "CropImage", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "cropTypeParameter", - "description": "Set the crop type action", - "type": "string", - "enum": [ - "Border", - "Rectangle" - ], - "x-ms-visibility": "important", - "x-ms-summary": "Crop Type" - }, - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoCropImage", - "schema": { - "$ref": "#/definitions/DtoCropImage" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseCropImage" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseCropImage" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseCropImage" - } - } - }, - "x-ms-visibility": "important", - "summary": "Crop an Image", - "description": "Crop an image using border values or a rectangle - https://support.encodian.com/hc/en-gb/articles/10860483459740/" - } - }, - "/api/v1/Core/AddHtmlHeaderFooterWord": { - "post": { - "tags": [ - "Core" - ], - "operationId": "AddHtmlHeaderFooterWord", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoAddHtmlHeaderFooterWord", - "schema": { - "$ref": "#/definitions/DtoAddHtmlHeaderFooterWord" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooterWord" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooterWord" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooterWord" - } - } - }, - "x-ms-visibility": "important", - "summary": "Update Word - Add Headers and Footers", - "description": "Add HTML headers and/or footers to the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/11348579020572" - } - }, - "/api/v1/Core/RemoveHeaderFooterWord": { - "post": { - "tags": [ - "Core" - ], - "operationId": "RemoveHeaderFooterWord", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoRemoveHeaderFooterWord", - "schema": { - "$ref": "#/definitions/DtoRemoveHeaderFooterWord" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseRemoveHeaderFooterWord" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseRemoveHeaderFooterWord" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseRemoveHeaderFooterWord" - } - } - }, - "x-ms-visibility": "important", - "summary": "Update Word - Remove Headers and Footers", - "description": "Remove headers and/or footers from the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/11349707504540" - } - }, - "/api/v1/Core/GetTextFromWord": { - "post": { - "tags": [ - "Core" - ], - "operationId": "GetTextFromWord", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoGetTextFromWord", - "schema": { - "$ref": "#/definitions/DtoGetTextFromWord" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseGetTextFromWord" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseGetTextFromWord" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseGetTextFromWord" - } - } - }, - "x-ms-visibility": "important", - "summary": "Get Text from Word", - "description": "Get the text contained within the Microsoft Word file provided - https://support.encodian.com/hc/en-gb/articles/10583756977180" - } - }, - "/api/v1/Core/UpdateRowsInExcel": { - "post": { - "tags": [ - "Core" - ], - "operationId": "UpdateRowsInExcel", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoUpdateRowsInExcel", - "schema": { - "$ref": "#/definitions/DtoUpdateRowsInExcel" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseUpdateRowsInExcel" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseUpdateRowsInExcel" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseUpdateRowsInExcel" - } - } - }, - "x-ms-visibility": "important", - "summary": "Update Rows in Excel", - "description": "Update the specified rows in the Excel file provided - https://support.encodian.com/hc/en-gb/articles/11205752671004" - } - }, - "/api/v1/Core/ExtractFromArchive": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ExtractFromArchive", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoExtractFromArchive", - "schema": { - "$ref": "#/definitions/DtoExtractFromArchive" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseExtractFromArchive" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseExtractFromArchive" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseExtractFromArchive" - } - } - }, - "x-ms-visibility": "important", - "summary": "Extract from Archive", - "description": "Extract files from the archive provided (ZIP, GZip, RAR, TAR, 7Zip + more) - https://support.encodian.com/hc/en-gb/articles/11853992723484" - } - }, - "/api/v1/Core/GetEmailInfo": { - "post": { - "tags": [ - "Core" - ], - "operationId": "GetEmailInfo", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoGetEmailInformation", - "schema": { - "$ref": "#/definitions/DtoGetEmailInfo" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseGetEmailInfo" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseGetEmailInfo" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseGetEmailInfo" - } - } - }, - "x-ms-visibility": "important", - "summary": "Get Email Information", - "description": "Get detailed information about the email provided (Email Format, Sender, Priority + more) - https://support.encodian.com/hc/en-gb/articles/12237799140252" - } - }, - "/api/v1/Core/ResizePdf": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ResizePdf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoPdfResize", - "schema": { - "$ref": "#/definitions/DtoResizePdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseResizePdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseResizePdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseResizePdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Resize PDF", - "description": "Resize a PDF document - https://support.encodian.com/hc/en-gb/articles/12292028562588" - } - }, - "/api/v1/Core/MergeExcelRows": { - "post": { - "tags": [ - "Core" - ], - "operationId": "MergeExcelRows", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoMergeExcelFileContent", - "schema": { - "$ref": "#/definitions/DtoMergeExcelRows" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseMergeExcelRows" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseMergeExcelRows" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseMergeExcelRows" - } - } - }, - "x-ms-visibility": "important", - "summary": "Merge Excel Rows", - "description": "Merge the rows contained within Excel files provided into a single worksheet - https://support.encodian.com/hc/en-gb/articles/11345445953820" - } - }, - "/api/v1/Core/PopulateExcel": { - "post": { - "tags": [ - "Core" - ], - "operationId": "PopulateExcel", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoPopulateExcel", - "schema": { - "$ref": "#/definitions/DtoPopulateExcel" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponsePopulateExcel" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponsePopulateExcel" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponsePopulateExcel" - } - } - }, - "x-ms-visibility": "important", - "summary": "Populate Excel", - "description": "Populate a Microsoft Excel workbook (XLSX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/12736409527324" - } - }, - "/api/v1/Core/ExtractExcelWorksheets": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ExtractExcelWorksheets", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoResponseExtractExcelWorksheets", - "schema": { - "$ref": "#/definitions/DtoExtractExcelWorksheets" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseExtractExcelWorksheets" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseExtractExcelWorksheets" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseExtractExcelWorksheets" - } - } - }, - "x-ms-visibility": "important", - "summary": "Extract Excel Worksheets", - "description": "Extract specified worksheets from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/13230802892316" - } - }, - "/api/v1/Core/BasicConversion": { - "post": { - "tags": [ - "Core" - ], - "operationId": "BasicConversion", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "conversion", - "description": "Request object, refer to schema definition: DtoBasicConversion", - "schema": { - "$ref": "#/definitions/DtoBasicConversion" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseBasicConversion" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseBasicConversion" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseBasicConversion" - } - } - }, - "x-ms-visibility": "important", - "summary": "Convert to PDF", - "description": "Convert a document to PDF or PDF/A format - https://support.encodian.com/hc/en-gb/articles/360011123574-Convert-to-PDF" - } - }, - "/api/v1/Core/ConvertToPdfA": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ConvertToPdfA", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoConvertToPdfA", - "schema": { - "$ref": "#/definitions/DtoConvertToPdfA" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseConvertToPdfA" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseConvertToPdfA" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseConvertToPdfA" - } - } - }, - "x-ms-visibility": "important", - "summary": "Convert PDF to PDFA", - "description": "Convert a PDF document to PDF/A format - https://support.encodian.com/hc/en-gb/articles/360010578413-Convert-PDF-to-PDFA" - } - }, - "/api/v1/Core/SecurePdfDocument": { - "post": { - "tags": [ - "Core" - ], - "operationId": "SecurePdfDocument", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoSecurePdf", - "schema": { - "$ref": "#/definitions/DtoSecurePdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseSecurePdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseSecurePdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseSecurePdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Secure PDF Document", - "description": "Encrypt and protect a PDF document - https://support.encodian.com/hc/en-gb/articles/360011330134-Secure-PDF-Document" - } - }, "/api/v1/Core/SetPdfPrivileges": { "post": { "tags": [ @@ -1264,16 +77,16 @@ } }, "x-ms-visibility": "important", - "summary": "Set PDF Document Privileges", + "summary": "PDF - Set Privileges", "description": "Set the privledges assigned to the PDF document - https://support.encodian.com/hc/en-gb/articles/360011337094-Set-PDF-Document-Privileges" } }, - "/api/v1/Core/TextToPDF": { + "/api/v1/Core/SignPdf": { "post": { "tags": [ "Core" ], - "operationId": "TextToPDF", + "operationId": "SignPdf", "consumes": [ "application/json" ], @@ -1282,58 +95,23 @@ ], "parameters": [ { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoTextToPdf", - "schema": { - "$ref": "#/definitions/DtoTextToPdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseTextToPdf" - } + "in": "query", + "name": "certificateTypeParameter", + "description": "Set the certificate type", + "type": "string", + "enum": [ + "Standard", + "Custom" + ], + "x-ms-visibility": "important", + "x-ms-summary": "Certificate Type" }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseTextToPdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseTextToPdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Convert Text to PDF", - "description": "Convert the text provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360011683054-Convert-Text-to-PDF" - } - }, - "/api/v1/Core/HtmlToPDF": { - "post": { - "tags": [ - "Core" - ], - "operationId": "HtmlToPDF", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoHtmlToPdf", + "description": "Request object, refer to schema definition: DtoSignPdf", "schema": { - "$ref": "#/definitions/DtoHtmlToPdf" + "$ref": "#/definitions/DtoSignPdf" } } ], @@ -1341,354 +119,25 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseHtmlToPdf" + "$ref": "#/definitions/DtoResponseSignPdf" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseHtmlToPdf" + "$ref": "#/definitions/DtoResponseSignPdf" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseHtmlToPdf" + "$ref": "#/definitions/DtoResponseSignPdf" } } }, "x-ms-visibility": "important", - "summary": "Convert HTML to PDF", - "description": "Convert the HTML or Web URL provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360022205154-Convert-HTML-to-PDF" - } - }, - "/api/v1/Core/HtmlToWord": { - "post": { - "tags": [ - "Core" - ], - "operationId": "HtmlToWord", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoHtmlToWord", - "schema": { - "$ref": "#/definitions/DtoHtmlToWord" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseHtmlToWord" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseHtmlToWord" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseHtmlToWord" - } - } - }, - "x-ms-visibility": "important", - "summary": "Convert HTML to Word", - "description": "Convert the HTML or Web URL provided to a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/360011823213-Convert-HTML-to-Word" - } - }, - "/api/v1/Core/InsertHtmlToPdf": { - "post": { - "tags": [ - "Core" - ], - "operationId": "InsertHtmlToPdf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoInsertHtmlToPdf", - "schema": { - "$ref": "#/definitions/DtoInsertHtmlToPdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseInsertHtmlToPdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseInsertHtmlToPdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseInsertHtmlToPdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Insert HTML to PDF", - "description": "Insert the HTML provided into a PDF document - https://support.encodian.com/hc/en-gb/articles/360011784354-Insert-HTML-to-PDF" - } - }, - "/api/v1/Core/MergeDocumentsToPdf": { - "post": { - "tags": [ - "Core" - ], - "operationId": "MergeDocumentsToPdf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoMergeDocumentsToPdf", - "schema": { - "$ref": "#/definitions/DtoMergeDocumentsToPdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseMergeDocumentsToPdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseMergeDocumentsToPdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseMergeDocumentsToPdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Merge documents to PDF", - "description": "Convert and merge the documents provided to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360011886173-Merge-documents-to-PDF" - } - }, - "/api/v1/Core/MergeArrayOfDocumentsToPdf": { - "post": { - "tags": [ - "Core" - ], - "operationId": "MergeArrayOfDocumentsToPdf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoMergeArrayOfDocumentsToPdf", - "schema": { - "$ref": "#/definitions/DtoMergeArrayOfDocumentsToPdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToPdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToPdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToPdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Merge document array to PDF", - "description": "Convert and merge an array of documents to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360014632213-Merge-document-array-to-PDF" - } - }, - "/api/v1/Core/MergeArrayOfDocumentsToWord": { - "post": { - "tags": [ - "Core" - ], - "operationId": "MergeArrayOfDocumentsToWord", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoMergeArrayOfDocumentsToWord", - "schema": { - "$ref": "#/definitions/DtoMergeArrayOfDocumentsToWord" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToWord" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToWord" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToWord" - } - } - }, - "x-ms-visibility": "important", - "summary": "Merge Word Documents", - "description": "Merge an array of Microsoft Word documents to a single Microsoft Word document (DOCX) - https://support.encodian.com/hc/en-gb/articles/360023972213-Merge-document-array-to-Word" - } - }, - "/api/v1/Core/MergeArrayOfExcelDocuments": { - "post": { - "tags": [ - "Core" - ], - "operationId": "MergeArrayOfExcelDocuments", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoMergeArrayOfExcelDocuments", - "schema": { - "$ref": "#/definitions/DtoMergeArrayOfExcelDocuments" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseMergeArrayOfExcelDocuments" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseMergeArrayOfExcelDocuments" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseMergeArrayOfExcelDocuments" - } - } - }, - "x-ms-visibility": "important", - "summary": "Merge Excel Files", - "description": "Merge an array of Microsoft Excel files to a single file (multiple formats) - https://support.encodian.com/hc/en-gb/articles/4469865776529" - } - }, - "/api/v1/Core/OcrPdfDocument": { - "post": { - "tags": [ - "Core" - ], - "operationId": "OcrPdfDocument", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoOcrPdf", - "schema": { - "$ref": "#/definitions/DtoOcrPdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseOcrPdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseOcrPdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseOcrPdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "OCR a PDF Document", - "description": "Perform OCR on an existing PDF document - https://support.encodian.com/hc/en-gb/articles/360012686653-OCR-a-PDF-Document" + "summary": "PDF - Sign", + "description": "Apply a digital signature to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7117159708189" } }, "/api/v1/Core/SplitDocument": { @@ -1734,57 +183,10 @@ } }, "x-ms-visibility": "important", - "summary": "Split PDF", + "summary": "PDF - Split", "description": "Split a PDF Document into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360002953277-Split-PDF" } }, - "/api/v1/Core/SplitPdfByText": { - "post": { - "tags": [ - "Core" - ], - "operationId": "SplitPdfByText", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoSplitPdfByText", - "schema": { - "$ref": "#/definitions/DtoSplitPdfByText" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseSplitPdfByText" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseSplitPdfByText" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseSplitPdfByText" - } - } - }, - "x-ms-visibility": "important", - "summary": "Split PDF by Text", - "description": "Split a PDF Document by text into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360012726397-Split-PDF-by-Text" - } - }, "/api/v1/Core/SplitPdfByBarcode": { "post": { "tags": [ @@ -1828,16 +230,16 @@ } }, "x-ms-visibility": "important", - "summary": "Split PDF by Barcode", + "summary": "PDF - Split by Barcode", "description": "Split a PDF Document by Barcode, returning multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360013629457-Split-PDF-by-Barcode" } }, - "/api/v1/Core/WordToPdfForm": { + "/api/v1/Core/SplitPdfByText": { "post": { "tags": [ "Core" ], - "operationId": "WordToPdfForm", + "operationId": "SplitPdfByText", "consumes": [ "application/json" ], @@ -1848,9 +250,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoWordToPdfForm", + "description": "Request object, refer to schema definition: DtoSplitPdfByText", "schema": { - "$ref": "#/definitions/DtoWordToPdfForm" + "$ref": "#/definitions/DtoSplitPdfByText" } } ], @@ -1858,965 +260,25 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseWordToPdfForm" + "$ref": "#/definitions/DtoResponseSplitPdfByText" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseWordToPdfForm" + "$ref": "#/definitions/DtoResponseSplitPdfByText" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseWordToPdfForm" + "$ref": "#/definitions/DtoResponseSplitPdfByText" } } }, "x-ms-visibility": "important", - "summary": "Convert Word to PDF Form", - "description": "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" - } - }, - "/api/v1/Core/AddTextWatermark": { - "post": { - "tags": [ - "Core" - ], - "operationId": "AddTextWatermark", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoAddTextWatermark", - "schema": { - "$ref": "#/definitions/DtoAddTextWatermark" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseAddTextWatermark" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseAddTextWatermark" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseAddTextWatermark" - } - } - }, - "x-ms-visibility": "important", - "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": { - "post": { - "tags": [ - "Core" - ], - "operationId": "AddImageWatermark", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoAddImageWatermark", - "schema": { - "$ref": "#/definitions/DtoAddImageWatermark" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseAddImageWatermark" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseAddImageWatermark" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseAddImageWatermark" - } - } - }, - "x-ms-visibility": "important", - "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": { - "post": { - "tags": [ - "Core" - ], - "operationId": "AddTextWatermarkAdvanced", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoAddTextWatermarkAdv", - "schema": { - "$ref": "#/definitions/DtoAddTextWatermarkAdv" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseAddTextWatermarkAdv" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseAddTextWatermarkAdv" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseAddTextWatermarkAdv" - } - } - }, - "x-ms-visibility": "important", - "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": { - "post": { - "tags": [ - "Core" - ], - "operationId": "AddImageWatermarkAdvanced", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoAddImageWatermarkAdv", - "schema": { - "$ref": "#/definitions/DtoAddImageWatermarkAdv" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseAddImageWatermarkAdv" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseAddImageWatermarkAdv" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseAddImageWatermarkAdv" - } - } - }, - "x-ms-visibility": "important", - "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": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ImageCleanUpDocument", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoImageCleanUpDoc", - "schema": { - "$ref": "#/definitions/DtoImageCleanUpDoc" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseImageCleanUpDoc" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseImageCleanUpDoc" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseImageCleanUpDoc" - } - } - }, - "x-ms-visibility": "important", - "summary": "Image Clean Up (Document)", - "description": "Execute image clean up activities focussed on text based images such as Deskew, Rotate, Despeckle + more." - } - }, - "/api/v1/Core/ImageCleanUpPhoto": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ImageCleanUpPhoto", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoImageCleanUpPhoto", - "schema": { - "$ref": "#/definitions/DtoImageCleanUpPhoto" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseImageCleanUpPhoto" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseImageCleanUpPhoto" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseImageCleanUpPhoto" - } - } - }, - "x-ms-visibility": "important", - "summary": "Image Clean Up (Photo)", - "description": "Execute image clean up activities for standard photo images." - } - }, - "/api/v1/Core/ExtractTextRegions": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ExtractTextRegions", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoExtractTextRegion", - "schema": { - "$ref": "#/definitions/DtoExtractTextRegion" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseExtractTextRegion" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseExtractTextRegion" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseExtractTextRegion" - } - } - }, - "x-ms-visibility": "important", - "summary": "Extract Text from Regions", - "description": "Extract text using OCR from 70+ files types using specified regions - https://support.encodian.com/hc/en-gb/articles/360015612353-Extract-Text-from-Regions" - } - }, - "/api/v1/Core/AddHtmlHeaderFooter": { - "post": { - "tags": [ - "Core" - ], - "operationId": "AddHtmlHeaderFooter", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoAddHtmlHeaderFooter", - "schema": { - "$ref": "#/definitions/DtoAddHtmlHeaderFooter" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooter" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooter" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooter" - } - } - }, - "x-ms-visibility": "important", - "summary": "Add HTML Header or Footer to PDF", - "description": "Add a HTML header, footer or both to the specified PDF document - https://support.encodian.com/hc/en-gb/articles/360013808614-Add-HTML-Header-or-Footer" - } - }, - "/api/v1/Core/AddPageNumbers": { - "post": { - "tags": [ - "Core" - ], - "operationId": "AddPageNumbers", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoAddPageNumbers", - "schema": { - "$ref": "#/definitions/DtoAddPageNumbers" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseAddPageNumbers" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseAddPageNumbers" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseAddPageNumbers" - } - } - }, - "x-ms-visibility": "important", - "summary": "Add Page Numbers", - "description": "Add page numbers to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360014464534-Add-Page-Numbers" - } - }, - "/api/v1/Core/GetPdfTextLayer": { - "post": { - "tags": [ - "Core" - ], - "operationId": "GetPdfTextLayer", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoGetPdfTextLayer", - "schema": { - "$ref": "#/definitions/DtoGetPdfTextLayer" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseGetPdfTextLayer" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseGetPdfTextLayer" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseGetPdfTextLayer" - } - } - }, - "x-ms-visibility": "important", - "summary": "Get PDF Text Layer", - "description": "Get the text layer for the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360015539373-Get-PDF-Text-Layer" - } - }, - "/api/v1/Core/RedactPdf": { - "post": { - "tags": [ - "Core" - ], - "operationId": "RedactPdf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoRedactPdf", - "schema": { - "$ref": "#/definitions/DtoRedactPdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseRedactPdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseRedactPdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseRedactPdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Redact PDF", - "description": "Apply the specified redactions to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360018607954-Redact-PDF-" - } - }, - "/api/v1/Core/ResizeImage": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ResizeImage", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoImageResize", - "schema": { - "$ref": "#/definitions/DtoImageResize" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseImageResize" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseImageResize" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseImageResize" - } - } - }, - "x-ms-visibility": "important", - "summary": "Resize an Image", - "description": "Resize and compress the image provided - https://support.encodian.com/hc/en-gb/articles/360018591034-Resize-an-Image" - } - }, - "/api/v1/Core/GetPdfFormData": { - "post": { - "tags": [ - "Core" - ], - "operationId": "GetPdfFormData", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoGetPdfFormData", - "schema": { - "$ref": "#/definitions/DtoGetPdfFormData" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseGetPdfFormData" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseGetPdfFormData" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseGetPdfFormData" - } - } - }, - "x-ms-visibility": "important", - "summary": "Get PDF Form Data", - "description": "Extract PDF form data from a PDF Form - https://support.encodian.com/hc/en-gb/articles/360035107433-Get-PDF-Form-Data" - } - }, - "/api/v1/Core/SearchAndReplaceText": { - "post": { - "tags": [ - "Core" - ], - "operationId": "SearchAndReplaceText", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoSearchAndReplaceText", - "schema": { - "$ref": "#/definitions/DtoSearchAndReplaceText" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseSearchAndReplaceText" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseSearchAndReplaceText" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseSearchAndReplaceText" - } - } - }, - "x-ms-visibility": "important", - "summary": "Search and Replace Text", - "description": "Find and replace text contained within a PDF or DOCX document - https://support.encodian.com/hc/en-gb/articles/360020937853-Search-and-Replace-Text" - } - }, - "/api/v1/Core/SearchAndReplaceHyperlink": { - "post": { - "tags": [ - "Core" - ], - "operationId": "SearchAndReplaceHyperlink", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoSearchAndReplaceHyperlink", - "schema": { - "$ref": "#/definitions/DtoSearchAndReplaceHyperlink" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseSearchAndReplaceHyperlink" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseSearchAndReplaceHyperlink" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseSearchAndReplaceHyperlink" - } - } - }, - "x-ms-visibility": "important", - "summary": "Update Word - Hyperlinks", - "description": "Find and update hyperlinks contained within a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/7136687719837" - } - }, - "/api/v1/Core/SearchAndReplaceTextWithImage": { - "post": { - "tags": [ - "Core" - ], - "operationId": "SearchAndReplaceTextWithImage", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoSearchAndReplaceTextWithImage", - "schema": { - "$ref": "#/definitions/DtoSearchAndReplaceTextWithImage" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseSearchAndReplaceTextWithImage" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseSearchAndReplaceTextWithImage" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseSearchAndReplaceTextWithImage" - } - } - }, - "x-ms-visibility": "important", - "summary": "Replace Text with Image", - "description": "Find and replace text contained within a PDF or DOCX document with an image - https://support.encodian.com/hc/en-gb/articles/360027234874" - } - }, - "/api/v1/Core/ConvertPdfToWord": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ConvertPdfToWord", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoConvertPdfToWord", - "schema": { - "$ref": "#/definitions/DtoConvertPdfToWord" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToWord" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToWord" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToWord" - } - } - }, - "x-ms-visibility": "important", - "summary": "Convert PDF to Word", - "description": "Convert a PDF document to Microsoft Word (docx) format - https://support.encodian.com/hc/en-gb/articles/360027229294-Convert-PDF-to-Word" - } - }, - "/api/v1/Core/CompressImage": { - "post": { - "tags": [ - "Core" - ], - "operationId": "CompressImage", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoImageCompress", - "schema": { - "$ref": "#/definitions/DtoImageCompress" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseImageCompress" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseImageCompress" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseImageCompress" - } - } - }, - "x-ms-visibility": "important", - "summary": "Compress an Image", - "description": "Compress the image provided - https://support.encodian.com/hc/en-gb/articles/360027350513-Compress-an-Image" - } - }, - "/api/v1/Core/AddToZip": { - "post": { - "tags": [ - "Core" - ], - "operationId": "AddToZip", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoZipArrayOfDocuments", - "schema": { - "$ref": "#/definitions/DtoZipArrayOfDocuments" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseZipArrayOfDocuments" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseZipArrayOfDocuments" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseZipArrayOfDocuments" - } - } - }, - "x-ms-visibility": "important", - "summary": "Add to Archive (ZIP)", - "description": "Add the files provided to an archive (.zip) file - https://support.encodian.com/hc/en-gb/articles/360002674918-Add-to-Archive-ZIP" - } - }, - "/api/v1/Core/GetPdfDocumentInfo": { - "post": { - "tags": [ - "Core" - ], - "operationId": "GetPdfDocumentInfo", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoGetPdfDocumentInfo", - "schema": { - "$ref": "#/definitions/DtoGetPdfDocumentInfo" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseGetPdfDocumentInfo" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseGetPdfDocumentInfo" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseGetPdfDocumentInfo" - } - } - }, - "x-ms-visibility": "important", - "summary": "Get PDF Document Information", - "description": "Get PDF Document Information (Number of Pages, File Size + more) - https://support.encodian.com/hc/en-gb/articles/360002949358-Get-PDF-Document-Information" + "summary": "PDF - Split by Text", + "description": "Split a PDF Document by text into multiple PDF Documents - https://support.encodian.com/hc/en-gb/articles/360012726397-Split-PDF-by-Text" } }, "/api/v1/Core/UnlockPdfDocument": { @@ -2862,16 +324,16 @@ } }, "x-ms-visibility": "important", - "summary": "Unlock PDF Document", + "summary": "PDF - Unlock", "description": "Decrypt and remove password protection from a PDF document - https://support.encodian.com/hc/en-gb/articles/360003714237-Unlock-PDF-Document" } }, - "/api/v1/Core/ParseCsv": { + "/api/v1/Core/GetPdfFormData": { "post": { "tags": [ "Core" ], - "operationId": "ParseCsv", + "operationId": "GetPdfFormData", "consumes": [ "application/json" ], @@ -2882,9 +344,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoParseCsv", + "description": "Request object, refer to schema definition: DtoGetPdfFormData", "schema": { - "$ref": "#/definitions/DtoParseCsv" + "$ref": "#/definitions/DtoGetPdfFormData" } } ], @@ -2892,33 +354,33 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseParseCsv" + "$ref": "#/definitions/DtoResponseGetPdfFormData" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseParseCsv" + "$ref": "#/definitions/DtoResponseGetPdfFormData" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseParseCsv" + "$ref": "#/definitions/DtoResponseGetPdfFormData" } } }, "x-ms-visibility": "important", - "summary": "Parse CSV", - "description": "Parse CSV and return the extracted data in JSON format - https://support.encodian.com/hc/en-gb/articles/360005177297-Parse-CSV" + "summary": "PDF - Extract Form Data", + "description": "Extract PDF form data from a PDF Form - https://support.encodian.com/hc/en-gb/articles/360035107433-Get-PDF-Form-Data" } }, - "/api/v1/Core/CreateQrCode": { + "/api/v1/Core/FillPdfForm": { "post": { "tags": [ "Core" ], - "operationId": "CreateQrCode", + "operationId": "FillPdfForm", "consumes": [ "application/json" ], @@ -2929,9 +391,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoCreateQrCode", + "description": "Request object, refer to schema definition: DtoFillPdfForm", "schema": { - "$ref": "#/definitions/DtoCreateQrCode" + "$ref": "#/definitions/DtoFillPdfForm" } } ], @@ -2939,33 +401,33 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseCreateQrCode" + "$ref": "#/definitions/DtoResponseFillPdfForm" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseCreateQrCode" + "$ref": "#/definitions/DtoResponseFillPdfForm" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseCreateQrCode" + "$ref": "#/definitions/DtoResponseFillPdfForm" } } }, "x-ms-visibility": "important", - "summary": "Create QR Code", - "description": "Create a QR code in the specified image format - https://support.encodian.com/hc/en-gb/articles/360005178237-Create-QR-Code" + "summary": "PDF - Fill Form", + "description": "Fill the PDF Form provided with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360008556077-Fill-a-PDF-Form" } }, - "/api/v1/Core/ReadQrCodeFromImage": { + "/api/v1/Core/PopulateExcel": { "post": { "tags": [ "Core" ], - "operationId": "ReadQrCodeFromImage", + "operationId": "PopulateExcel", "consumes": [ "application/json" ], @@ -2976,9 +438,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoReadQrCodeFromImage", + "description": "Request object, refer to schema definition: DtoPopulateExcel", "schema": { - "$ref": "#/definitions/DtoReadQrCodeFromImage" + "$ref": "#/definitions/DtoPopulateExcel" } } ], @@ -2986,33 +448,33 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseReadQrCodeFromImage" + "$ref": "#/definitions/DtoResponsePopulateExcel" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseReadQrCodeFromImage" + "$ref": "#/definitions/DtoResponsePopulateExcel" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseReadQrCodeFromImage" + "$ref": "#/definitions/DtoResponsePopulateExcel" } } }, "x-ms-visibility": "important", - "summary": "Read QR Code - Image", - "description": "Read a QR code from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170898-Read-QR-Code-Image" + "summary": "Populate - Excel", + "description": "Populate a Microsoft Excel workbook (XLSX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/12736409527324" } }, - "/api/v1/Core/ReadQrCodeFromDocument": { + "/api/v1/Core/PopulatePowerPoint": { "post": { "tags": [ "Core" ], - "operationId": "ReadQrCodeFromDocument", + "operationId": "PopulatePowerPoint", "consumes": [ "application/json" ], @@ -3023,9 +485,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoReadQrCodeFromDocument", + "description": "Request object, refer to schema definition: DtoPopulatePowerPoint", "schema": { - "$ref": "#/definitions/DtoReadQrCodeFromDocument" + "$ref": "#/definitions/DtoPopulatePowerPoint" } } ], @@ -3033,25 +495,1218 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseReadQrCodeFromDocument" + "$ref": "#/definitions/DtoResponsePopulatePowerPoint" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseReadQrCodeFromDocument" + "$ref": "#/definitions/DtoResponsePopulatePowerPoint" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseReadQrCodeFromDocument" + "$ref": "#/definitions/DtoResponsePopulatePowerPoint" } } }, "x-ms-visibility": "important", - "summary": "Read QR Code - Document", - "description": "Read a QR code(s) from the document provided - https://support.encodian.com/hc/en-gb/articles/360006165437-Read-QR-Code-Document" + "summary": "Populate - PowerPoint", + "description": "Populate a Microsoft PowerPoint file (PPTX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/9715390966300" + } + }, + "/api/v1/Core/PopulateWordDocument": { + "post": { + "tags": [ + "Core" + ], + "operationId": "PopulateWordDocument", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoPopulateWordDocument", + "schema": { + "$ref": "#/definitions/DtoPopulateWordDocument" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponsePopulateWordDocument" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponsePopulateWordDocument" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponsePopulateWordDocument" + } + } + }, + "x-ms-visibility": "important", + "summary": "Populate - Word", + "description": "Populate a Microsoft Word Document (DOCX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360019620578-Populate-Word-Document" + } + }, + "/api/v1/Core/CompressPowerPoint": { + "post": { + "tags": [ + "Core" + ], + "operationId": "CompressPowerPoint", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoCompressPowerPoint", + "schema": { + "$ref": "#/definitions/DtoCompressPowerPoint" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseCompressPowerPoint" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseCompressPowerPoint" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseCompressPowerPoint" + } + } + }, + "x-ms-visibility": "important", + "summary": "PowerPoint - Compress", + "description": "Compress the PowerPoint file provided - https://support.encodian.com/hc/en-gb/articles/7621965500189" + } + }, + "/api/v1/Core/AddHtmlHeaderFooterWord": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddHtmlHeaderFooterWord", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoAddHtmlHeaderFooterWord", + "schema": { + "$ref": "#/definitions/DtoAddHtmlHeaderFooterWord" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooterWord" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooterWord" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooterWord" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Add Headers and Footers", + "description": "Add HTML headers and/or footers to the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/11348579020572" + } + }, + "/api/v1/Core/AddImageWatermarkWord": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddImageWatermarkWord", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoAddImageWatermarkWord", + "schema": { + "$ref": "#/definitions/DtoAddImageWatermarkWord" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddImageWatermarkWord" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddImageWatermarkWord" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAddImageWatermarkWord" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Add Image Watermark", + "description": "Add an image watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411329161361" + } + }, + "/api/v1/Core/AddTextWatermarkWord": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddTextWatermarkWord", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoAddTextWatermarkWord", + "schema": { + "$ref": "#/definitions/DtoAddTextWatermarkWord" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermarkWord" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermarkWord" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermarkWord" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Add Text Watermark", + "description": "Add a text watermark to the specified Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/4411284008593" + } + }, + "/api/v1/Core/CompareWordDocuments": { + "post": { + "tags": [ + "Core" + ], + "operationId": "CompareWordDocuments", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoCompareWordDocuments", + "schema": { + "$ref": "#/definitions/DtoCompareWordDocuments" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseCompareWordDocuments" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseCompareWordDocuments" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseCompareWordDocuments" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Compare", + "description": "Compare differences between Microsoft Word Documents - https://support.encodian.com/hc/en-gb/articles/360018576278-Compare-Word-Documents" + } + }, + "/api/v1/Core/DisableTrackedChanges": { + "post": { + "tags": [ + "Core" + ], + "operationId": "DisableTrackedChanges", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoDisableTrackedChanges", + "schema": { + "$ref": "#/definitions/DtoDisableTrackedChanges" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseDisableTrackedChanges" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseDisableTrackedChanges" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseDisableTrackedChanges" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Disable Tracked Changes", + "description": "Disable tracked changes on the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6695370804125" + } + }, + "/api/v1/Core/EnableTrackedChanges": { + "post": { + "tags": [ + "Core" + ], + "operationId": "EnableTrackedChanges", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoEnableTrackedChanges", + "schema": { + "$ref": "#/definitions/DtoEnableTrackedChanges" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseEnableTrackedChanges" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseEnableTrackedChanges" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseEnableTrackedChanges" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Enable Tracked Changes", + "description": "Enable tracked changes on the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6695385009053" + } + }, + "/api/v1/Core/GetTextFromWord": { + "post": { + "tags": [ + "Core" + ], + "operationId": "GetTextFromWord", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoGetTextFromWord", + "schema": { + "$ref": "#/definitions/DtoGetTextFromWord" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseGetTextFromWord" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseGetTextFromWord" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseGetTextFromWord" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Extract Text", + "description": "Extract text contained within the Microsoft Word file provided - https://support.encodian.com/hc/en-gb/articles/10583756977180" + } + }, + "/api/v1/Core/GetTrackedChanges": { + "post": { + "tags": [ + "Core" + ], + "operationId": "GetTrackedChanges", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoGetTrackedChanges", + "schema": { + "$ref": "#/definitions/DtoGetTrackedChanges" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseGetTrackedChanges" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseGetTrackedChanges" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseGetTrackedChanges" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Extract Tracked Changes", + "description": "Extract all the tracked changes (Revisions and comments) for the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6634950400669" + } + }, + "/api/v1/Core/ManageTrackedChanges": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ManageTrackedChanges", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoManageTrackedChanges", + "schema": { + "$ref": "#/definitions/DtoManageTrackedChanges" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseManageTrackedChanges" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseManageTrackedChanges" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseManageTrackedChanges" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Manage Tracked Changes", + "description": "Process Tracked Changes within the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/10074318228765" + } + }, + "/api/v1/Core/RemoveHeaderFooterWord": { + "post": { + "tags": [ + "Core" + ], + "operationId": "RemoveHeaderFooterWord", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoRemoveHeaderFooterWord", + "schema": { + "$ref": "#/definitions/DtoRemoveHeaderFooterWord" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseRemoveHeaderFooterWord" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseRemoveHeaderFooterWord" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseRemoveHeaderFooterWord" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Remove Headers and Footers", + "description": "Remove headers and/or footers from the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/11349707504540" + } + }, + "/api/v1/Core/RemoveWatermarksFromWord": { + "post": { + "tags": [ + "Core" + ], + "operationId": "RemoveWatermarksFromWord", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoRemoveWatermarkFromWord", + "schema": { + "$ref": "#/definitions/DtoRemoveWatermarksFromWord" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseRemoveWatermarksFromWord" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseRemoveWatermarksFromWord" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseRemoveWatermarksFromWord" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Remove Watermark", + "description": "Remove the watermark from the Word file provided - https://support.encodian.com/hc/en-gb/articles/7752587767965" + } + }, + "/api/v1/Core/SecureWordDocument": { + "post": { + "tags": [ + "Core" + ], + "operationId": "SecureWordDocument", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoSecureWord", + "schema": { + "$ref": "#/definitions/DtoSecureWordDocument" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseSecureWordDocument" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseSecureWordDocument" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseSecureWordDocument" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Secure", + "description": "Secure and protect a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/6634150180253" + } + }, + "/api/v1/Core/SplitWordDocument": { + "post": { + "tags": [ + "Core" + ], + "operationId": "SplitWordDocument", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoSplitWordDocument", + "schema": { + "$ref": "#/definitions/DtoSplitWordDocument" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseSplitWordDocument" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseSplitWordDocument" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseSplitWordDocument" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Split", + "description": "Split the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/14575340646940" + } + }, + "/api/v1/Core/SearchAndReplaceHyperlink": { + "post": { + "tags": [ + "Core" + ], + "operationId": "SearchAndReplaceHyperlink", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoSearchAndReplaceHyperlink", + "schema": { + "$ref": "#/definitions/DtoSearchAndReplaceHyperlink" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseSearchAndReplaceHyperlink" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseSearchAndReplaceHyperlink" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseSearchAndReplaceHyperlink" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Update Hyperlinks", + "description": "Find and update hyperlinks contained within a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/7136687719837" + } + }, + "/api/v1/Core/UpdateWordTableOfContents": { + "post": { + "tags": [ + "Core" + ], + "operationId": "UpdateWordTableOfContents", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoUpdateWordTableOfContents", + "schema": { + "$ref": "#/definitions/DtoUpdateWordTableOfContents" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseUpdateWordTableOfContents" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseUpdateWordTableOfContents" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseUpdateWordTableOfContents" + } + } + }, + "x-ms-visibility": "important", + "summary": "Word - Update Table of Contents", + "description": "Update the 'Table of Contents' in the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/10594864447260" + } + }, + "/api/v1/Core/AITranslateText": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AITranslateText", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoAITranslateText", + "schema": { + "$ref": "#/definitions/DtoAITranslateText" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateText" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateText" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateText" + } + }, + "429": { + "description": "Too Many Requests", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateText" + } + } + }, + "x-ms-visibility": "important", + "summary": "AI - Translate Text (Single)", + "description": "Translate the text provided into a single designated language - https://support.encodian.com/hc/en-gb/articles/13568846675996" + } + }, + "/api/v1/Core/AITranslateTextMultiple": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AITranslateTextMultiple", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoAITranslateTextMultiple", + "schema": { + "$ref": "#/definitions/DtoAITranslateTextMultiple" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateTextMultiple" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateTextMultiple" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateTextMultiple" + } + }, + "429": { + "description": "Too Many Requests", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateTextMultiple" + } + } + }, + "x-ms-visibility": "important", + "summary": "AI - Translate Text (Multiple)", + "description": "Translate the text provided into multiple designated languages - https://support.encodian.com/hc/en-gb/articles/13670267593628" + } + }, + "/api/v1/Core/AITranslateFile": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AITranslateFile", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoAITranslateFile", + "schema": { + "$ref": "#/definitions/DtoAITranslateFile" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateFile" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateFile" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateFile" + } + }, + "429": { + "description": "Too Many Requests", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateFile" + } + } + }, + "x-ms-visibility": "important", + "summary": "AI - Translate File", + "description": "Translate the file provided into the designated language - https://support.encodian.com/hc/en-gb/articles/13790274285724" + } + }, + "/api/v1/Core/CreateHashCode": { + "post": { + "tags": [ + "Core" + ], + "operationId": "CreateHashCode", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoCreateHashCode", + "schema": { + "$ref": "#/definitions/DtoCreateHashCode" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseCreateHashCode" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseCreateHashCode" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseCreateHashCode" + } + } + }, + "x-ms-visibility": "internal", + "summary": "Deprecated - Create Hash Code", + "description": "Create a hashcode for the string provided - https://support.encodian.com/hc/en-gb/articles/360013996077-Create-Hash-Code" + } + }, + "/api/v1/Core/CreateHMAC": { + "post": { + "tags": [ + "Core" + ], + "operationId": "CreateHMAC", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoCreateHMAC", + "schema": { + "$ref": "#/definitions/DtoCreateHMAC" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseCreateHMAC" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseCreateHMAC" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseCreateHMAC" + } + } + }, + "x-ms-visibility": "internal", + "summary": "Deprecated - Create HMAC", + "description": "Create a Hash-based message authentication code (HMAC) using a secret key - https://support.encodian.com/hc/en-gb/articles/360012782058-Create-HMAC" + } + }, + "/api/v1/Core/RegexSearchText": { + "post": { + "tags": [ + "Core" + ], + "operationId": "RegexSearchText", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoRegexSearchText", + "schema": { + "$ref": "#/definitions/DtoRegexSearchText" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseRegexSearchText" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseRegexSearchText" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseRegexSearchText" + } + } + }, + "x-ms-visibility": "internal", + "summary": "Deprecated - Search Text - Regex", + "description": "Search the text provided to find matches using the regex provided - https://support.encodian.com/hc/en-gb/articles/360006764638-Search-Text-Regex" + } + }, + "/api/v1/Core/AddToZip": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddToZip", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoZipArrayOfDocuments", + "schema": { + "$ref": "#/definitions/DtoZipArrayOfDocuments" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseZipArrayOfDocuments" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseZipArrayOfDocuments" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseZipArrayOfDocuments" + } + } + }, + "x-ms-visibility": "important", + "summary": "Archive (ZIP) - Create", + "description": "Add the files provided to an archive (.zip) file - https://support.encodian.com/hc/en-gb/articles/360002674918-Add-to-Archive-ZIP" + } + }, + "/api/v1/Core/ExtractFromArchive": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ExtractFromArchive", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoExtractFromArchive", + "schema": { + "$ref": "#/definitions/DtoExtractFromArchive" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseExtractFromArchive" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseExtractFromArchive" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseExtractFromArchive" + } + } + }, + "x-ms-visibility": "important", + "summary": "Archive (ZIP) - Extract", + "description": "Extract files from the archive provided (ZIP, GZip, RAR, TAR, 7Zip + more) - https://support.encodian.com/hc/en-gb/articles/11853992723484" } }, "/api/v1/Core/CreateBarcode": { @@ -3144,57 +1799,10 @@ } }, "x-ms-visibility": "important", - "summary": "Create Barcode", + "summary": "Barcode - Create", "description": "Create a Barcode in the specified image format - https://support.encodian.com/hc/en-gb/articles/360006165457-Create-Barcode" } }, - "/api/v1/Core/ReadBarcodeFromImage": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ReadBarcodeFromImage", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoReadBarcodeFromImage", - "schema": { - "$ref": "#/definitions/DtoReadBarcodeFromImage" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseReadBarcodeFromImage" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseReadBarcodeFromImage" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseReadBarcodeFromImage" - } - } - }, - "x-ms-visibility": "important", - "summary": "Read Barcode - Image", - "description": "Read a barcode from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170918-Read-Barcode-Image" - } - }, "/api/v1/Core/ReadBarcodeFromDocument": { "post": { "tags": [ @@ -3238,16 +1846,16 @@ } }, "x-ms-visibility": "important", - "summary": "Read Barcode - Document", + "summary": "Barcode - Read from Document", "description": "Read barcode(s) from the document provided - https://support.encodian.com/hc/en-gb/articles/360006170938-Read-Barcode-Document" } }, - "/api/v1/Core/ImageConvertFormat": { + "/api/v1/Core/ReadBarcodeFromImage": { "post": { "tags": [ "Core" ], - "operationId": "ImageConvertFormat", + "operationId": "ReadBarcodeFromImage", "consumes": [ "application/json" ], @@ -3258,9 +1866,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoImageConvertFormat", + "description": "Request object, refer to schema definition: DtoReadBarcodeFromImage", "schema": { - "$ref": "#/definitions/DtoImageConvertFormat" + "$ref": "#/definitions/DtoReadBarcodeFromImage" } } ], @@ -3268,33 +1876,33 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseImageConvertFormat" + "$ref": "#/definitions/DtoResponseReadBarcodeFromImage" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseImageConvertFormat" + "$ref": "#/definitions/DtoResponseReadBarcodeFromImage" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseImageConvertFormat" + "$ref": "#/definitions/DtoResponseReadBarcodeFromImage" } } }, "x-ms-visibility": "important", - "summary": "Convert Image Format", - "description": "Convert the format of the image provided - https://support.encodian.com/hc/en-gb/articles/360006617857-Convert-Image-Format" + "summary": "Barcode - Read from Image", + "description": "Read a barcode from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170918-Read-Barcode-Image" } }, - "/api/v1/Core/RegexSearchText": { + "/api/v1/Core/CreateQrCode": { "post": { "tags": [ "Core" ], - "operationId": "RegexSearchText", + "operationId": "CreateQrCode", "consumes": [ "application/json" ], @@ -3305,9 +1913,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoRegexSearchText", + "description": "Request object, refer to schema definition: DtoCreateQrCode", "schema": { - "$ref": "#/definitions/DtoRegexSearchText" + "$ref": "#/definitions/DtoCreateQrCode" } } ], @@ -3315,80 +1923,33 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseRegexSearchText" + "$ref": "#/definitions/DtoResponseCreateQrCode" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseRegexSearchText" + "$ref": "#/definitions/DtoResponseCreateQrCode" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseRegexSearchText" - } - } - }, - "x-ms-visibility": "internal", - "summary": "Search Text - Regex", - "description": "Search the text provided to find matches using the regex provided - https://support.encodian.com/hc/en-gb/articles/360006764638-Search-Text-Regex" - } - }, - "/api/v1/Core/ExtractImages": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ExtractImages", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoExtractTextRegion", - "schema": { - "$ref": "#/definitions/DtoExtractImage" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseExtractImage" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseExtractImage" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseExtractImage" + "$ref": "#/definitions/DtoResponseCreateQrCode" } } }, "x-ms-visibility": "important", - "summary": "Extract Images from PDF", - "description": "Extract images from PDF using specified regions - https://support.encodian.com/hc/en-gb/articles/360006998058-Extract-Images-from-PDF" + "summary": "QR Code - Create", + "description": "Create a QR code in the specified image format - https://support.encodian.com/hc/en-gb/articles/360005178237-Create-QR-Code" } }, - "/api/v1/Core/ImageExtractText": { + "/api/v1/Core/ReadQrCodeFromDocument": { "post": { "tags": [ "Core" ], - "operationId": "ImageExtractText", + "operationId": "ReadQrCodeFromDocument", "consumes": [ "application/json" ], @@ -3399,9 +1960,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoImageExtractText", + "description": "Request object, refer to schema definition: DtoReadQrCodeFromDocument", "schema": { - "$ref": "#/definitions/DtoImageExtractText" + "$ref": "#/definitions/DtoReadQrCodeFromDocument" } } ], @@ -3409,33 +1970,33 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseImageExtractText" + "$ref": "#/definitions/DtoResponseReadQrCodeFromDocument" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseImageExtractText" + "$ref": "#/definitions/DtoResponseReadQrCodeFromDocument" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseImageExtractText" + "$ref": "#/definitions/DtoResponseReadQrCodeFromDocument" } } }, "x-ms-visibility": "important", - "summary": "Extract Text from Image (OCR)", - "description": "Extract text from the image provided - https://support.encodian.com/hc/en-gb/articles/360006998078-Extract-Text-from-Image-OCR" + "summary": "QR Code - Read from Document", + "description": "Read a QR code(s) from the document provided - https://support.encodian.com/hc/en-gb/articles/360006165437-Read-QR-Code-Document" } }, - "/api/v1/Core/FillPdfForm": { + "/api/v1/Core/ReadQrCodeFromImage": { "post": { "tags": [ "Core" ], - "operationId": "FillPdfForm", + "operationId": "ReadQrCodeFromImage", "consumes": [ "application/json" ], @@ -3446,9 +2007,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoFillPdfForm", + "description": "Request object, refer to schema definition: DtoReadQrCodeFromImage", "schema": { - "$ref": "#/definitions/DtoFillPdfForm" + "$ref": "#/definitions/DtoReadQrCodeFromImage" } } ], @@ -3456,25 +2017,88 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseFillPdfForm" + "$ref": "#/definitions/DtoResponseReadQrCodeFromImage" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseFillPdfForm" + "$ref": "#/definitions/DtoResponseReadQrCodeFromImage" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseFillPdfForm" + "$ref": "#/definitions/DtoResponseReadQrCodeFromImage" } } }, "x-ms-visibility": "important", - "summary": "Fill a PDF Form", - "description": "Fill the PDF Form provided with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360008556077-Fill-a-PDF-Form" + "summary": "QR Code - Read from Image", + "description": "Read a QR code from the image provided - https://support.encodian.com/hc/en-gb/articles/360006170898-Read-QR-Code-Image" + } + }, + "/api/v1/Core/ConvertCad": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ConvertCad", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "outputFormatParameter", + "description": "Set the output file type", + "type": "string", + "enum": [ + "PDF", + "BMP", + "GIF", + "JPG", + "PNG", + "TIFF" + ], + "x-ms-visibility": "important", + "x-ms-summary": "Output Format" + }, + { + "in": "body", + "name": "conversion", + "description": "Request object, refer to schema definition: DtoConvertCad", + "schema": { + "$ref": "#/definitions/DtoConvertCad" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseConvertCad" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseConvertCad" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseConvertCad" + } + } + }, + "x-ms-visibility": "important", + "summary": "Convert - CAD", + "description": "Convert CAD files to another document format - https://support.encodian.com/hc/en-gb/articles/4542607350417" } }, "/api/v1/Core/ConvertMailMessage": { @@ -3520,8 +2144,8 @@ } }, "x-ms-visibility": "important", - "summary": "Convert Email Message", - "description": "Convert an email to PDF - https://support.encodian.com/hc/en-gb/articles/360011566298-Convert-Mail-Message" + "summary": "Convert - Email", + "description": "Convert an email and attachments to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360011566298-Convert-Mail-Message" } }, "/api/v1/Core/ConvertExcel": { @@ -3586,16 +2210,486 @@ } }, "x-ms-visibility": "important", - "summary": "Convert Excel", + "summary": "Convert - Excel", "description": "Convert Microsoft Excel documents to another document format - https://support.encodian.com/hc/en-gb/articles/360011804178-Convert-Excel" } }, - "/api/v1/Core/ConvertWord": { + "/api/v1/Core/BasicConversion": { "post": { "tags": [ "Core" ], - "operationId": "ConvertWord", + "operationId": "BasicConversion", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "conversion", + "description": "Request object, refer to schema definition: DtoBasicConversion", + "schema": { + "$ref": "#/definitions/DtoBasicConversion" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseBasicConversion" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseBasicConversion" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseBasicConversion" + } + } + }, + "x-ms-visibility": "important", + "summary": "Convert - File to PDF", + "description": "Convert a document to PDF or PDF/A format - https://support.encodian.com/hc/en-gb/articles/360011123574-Convert-to-PDF" + } + }, + "/api/v1/Core/HtmlToPDF": { + "post": { + "tags": [ + "Core" + ], + "operationId": "HtmlToPDF", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoHtmlToPdf", + "schema": { + "$ref": "#/definitions/DtoHtmlToPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseHtmlToPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseHtmlToPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseHtmlToPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "Convert - HTML to PDF", + "description": "Convert the HTML or Web URL provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360022205154-Convert-HTML-to-PDF" + } + }, + "/api/v1/Core/HtmlToWord": { + "post": { + "tags": [ + "Core" + ], + "operationId": "HtmlToWord", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoHtmlToWord", + "schema": { + "$ref": "#/definitions/DtoHtmlToWord" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseHtmlToWord" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseHtmlToWord" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseHtmlToWord" + } + } + }, + "x-ms-visibility": "important", + "summary": "Convert - HTML to Word", + "description": "Convert the HTML or Web URL provided to a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/360011823213-Convert-HTML-to-Word" + } + }, + "/api/v1/Core/ConvertJsonToExcel": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ConvertJsonToExcel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoConvertJsonToExcel", + "schema": { + "$ref": "#/definitions/DtoConvertJsonToExcel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseConvertJsonToExcel" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseConvertJsonToExcel" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseConvertJsonToExcel" + } + } + }, + "x-ms-visibility": "important", + "summary": "Convert - JSON to Excel", + "description": "Convert JSON into a Microsft Excel file - https://support.encodian.com/hc/en-gb/articles/7690520790045" + } + }, + "/api/v1/Core/ConvertPdfToImages": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ConvertPdfToImages", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoConvertPdfToImages", + "schema": { + "$ref": "#/definitions/DtoConvertPdfToImages" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToImages" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToImages" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToImages" + } + } + }, + "x-ms-visibility": "important", + "summary": "Convert - PDF to Images", + "description": "Convert a PDF document into an array of images (PNG or JPG) - https://support.encodian.com/hc/en-gb/articles/4418101623441" + } + }, + "/api/v1/Core/ConvertPdfToJpg": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ConvertPdfToJpg", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoConvertPdfToJpg", + "schema": { + "$ref": "#/definitions/DtoConvertPdfToJpg" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToJpg" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToJpg" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToJpg" + } + } + }, + "x-ms-visibility": "important", + "summary": "Convert - PDF to JPG", + "description": "Convert a PDF document to a JPG - https://support.encodian.com/hc/en-gb/articles/11096881397277" + } + }, + "/api/v1/Core/ConvertToPdfA": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ConvertToPdfA", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoConvertToPdfA", + "schema": { + "$ref": "#/definitions/DtoConvertToPdfA" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseConvertToPdfA" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseConvertToPdfA" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseConvertToPdfA" + } + } + }, + "x-ms-visibility": "important", + "summary": "Convert - PDF to PDFA", + "description": "Convert a PDF document to PDF/A format - https://support.encodian.com/hc/en-gb/articles/360010578413-Convert-PDF-to-PDFA" + } + }, + "/api/v1/Core/ConvertPdfToPng": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ConvertPdfToPng", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoConvertPdfToPng", + "schema": { + "$ref": "#/definitions/DtoConvertPdfToPng" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToPng" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToPng" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToPng" + } + } + }, + "x-ms-visibility": "important", + "summary": "Convert - PDF to PNG", + "description": "Convert a PDF document to a PNG - https://support.encodian.com/hc/en-gb/articles/10086003836701" + } + }, + "/api/v1/Core/ConvertPdfToTiff": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ConvertPdfToTiff", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoConvertPdfToTiff", + "schema": { + "$ref": "#/definitions/DtoConvertPdfToTiff" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToTiff" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToTiff" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToTiff" + } + } + }, + "x-ms-visibility": "important", + "summary": "Convert - PDF to TIFF", + "description": "Convert a PDF document to TIFF (tiff) format - https://support.encodian.com/hc/en-gb/articles/4418024925457" + } + }, + "/api/v1/Core/ConvertPdfToWord": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ConvertPdfToWord", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoConvertPdfToWord", + "schema": { + "$ref": "#/definitions/DtoConvertPdfToWord" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToWord" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToWord" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseConvertPdfToWord" + } + } + }, + "x-ms-visibility": "important", + "summary": "Convert - PDF to Word", + "description": "Convert a PDF document to Microsoft Word (docx) format - https://support.encodian.com/hc/en-gb/articles/360027229294-Convert-PDF-to-Word" + } + }, + "/api/v1/Core/ConvertPowerPoint": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ConvertPowerPoint", "consumes": [ "application/json" ], @@ -3610,11 +2704,9 @@ "type": "string", "enum": [ "PDF", - "DOCX", - "DOC", - "DOTX", - "RTF", "HTML", + "POTX", + "PPTX", "TXT", "PNG", "TIFF" @@ -3625,9 +2717,9 @@ { "in": "body", "name": "conversion", - "description": "Request object, refer to schema definition: DtoConvertWord", + "description": "Request object, refer to schema definition: DtoConvertPowerPoint", "schema": { - "$ref": "#/definitions/DtoConvertWord" + "$ref": "#/definitions/DtoConvertPowerPoint" } } ], @@ -3635,25 +2727,72 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseConvertWord" + "$ref": "#/definitions/DtoResponseConvertPowerPoint" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseConvertWord" + "$ref": "#/definitions/DtoResponseConvertPowerPoint" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseConvertWord" + "$ref": "#/definitions/DtoResponseConvertPowerPoint" } } }, "x-ms-visibility": "important", - "summary": "Convert Word", - "description": "Convert Microsoft Word documents to another document format - https://support.encodian.com/hc/en-gb/articles/360015616117-Convert-Word" + "summary": "Convert - PowerPoint", + "description": "Convert Microsoft PowerPoint documents to another document format - https://support.encodian.com/hc/en-gb/articles/360015879777-Convert-PowerPoint" + } + }, + "/api/v1/Core/TextToPDF": { + "post": { + "tags": [ + "Core" + ], + "operationId": "TextToPDF", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoTextToPdf", + "schema": { + "$ref": "#/definitions/DtoTextToPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseTextToPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseTextToPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseTextToPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "Convert - Text to PDF", + "description": "Convert the text provided to a PDF document - https://support.encodian.com/hc/en-gb/articles/360011683054-Convert-Text-to-PDF" } }, "/api/v1/Core/ConvertVisio": { @@ -3718,16 +2857,16 @@ } }, "x-ms-visibility": "important", - "summary": "Convert Visio", + "summary": "Convert - Visio", "description": "Convert Microsoft Visio documents to another document format - https://support.encodian.com/hc/en-gb/articles/5306216347665" } }, - "/api/v1/Core/ConvertPowerPoint": { + "/api/v1/Core/ConvertWord": { "post": { "tags": [ "Core" ], - "operationId": "ConvertPowerPoint", + "operationId": "ConvertWord", "consumes": [ "application/json" ], @@ -3742,9 +2881,11 @@ "type": "string", "enum": [ "PDF", + "DOCX", + "DOC", + "DOTX", + "RTF", "HTML", - "POTX", - "PPTX", "TXT", "PNG", "TIFF" @@ -3755,9 +2896,9 @@ { "in": "body", "name": "conversion", - "description": "Request object, refer to schema definition: DtoConvertPowerPoint", + "description": "Request object, refer to schema definition: DtoConvertWord", "schema": { - "$ref": "#/definitions/DtoConvertPowerPoint" + "$ref": "#/definitions/DtoConvertWord" } } ], @@ -3765,96 +2906,33 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseConvertPowerPoint" + "$ref": "#/definitions/DtoResponseConvertWord" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseConvertPowerPoint" + "$ref": "#/definitions/DtoResponseConvertWord" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseConvertPowerPoint" + "$ref": "#/definitions/DtoResponseConvertWord" } } }, "x-ms-visibility": "important", - "summary": "Convert PowerPoint", - "description": "Convert Microsoft PowerPoint documents to another document format - https://support.encodian.com/hc/en-gb/articles/360015879777-Convert-PowerPoint" + "summary": "Convert - Word", + "description": "Convert Microsoft Word documents to another document format - https://support.encodian.com/hc/en-gb/articles/360015616117-Convert-Word" } }, - "/api/v1/Core/ConvertCad": { + "/api/v1/Core/WordToPdfForm": { "post": { "tags": [ "Core" ], - "operationId": "ConvertCad", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "outputFormatParameter", - "description": "Set the output file type", - "type": "string", - "enum": [ - "PDF", - "BMP", - "GIF", - "JPG", - "PNG", - "TIFF" - ], - "x-ms-visibility": "important", - "x-ms-summary": "Output Format" - }, - { - "in": "body", - "name": "conversion", - "description": "Request object, refer to schema definition: DtoConvertCad", - "schema": { - "$ref": "#/definitions/DtoConvertCad" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseConvertCad" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseConvertCad" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseConvertCad" - } - } - }, - "x-ms-visibility": "important", - "summary": "Convert CAD", - "description": "Convert CAD files to another document format - https://support.encodian.com/hc/en-gb/articles/4542607350417" - } - }, - "/api/v1/Core/CreateHMAC": { - "post": { - "tags": [ - "Core" - ], - "operationId": "CreateHMAC", + "operationId": "WordToPdfForm", "consumes": [ "application/json" ], @@ -3865,9 +2943,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoCreateHMAC", + "description": "Request object, refer to schema definition: DtoWordToPdfForm", "schema": { - "$ref": "#/definitions/DtoCreateHMAC" + "$ref": "#/definitions/DtoWordToPdfForm" } } ], @@ -3875,127 +2953,33 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseCreateHMAC" + "$ref": "#/definitions/DtoResponseWordToPdfForm" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseCreateHMAC" + "$ref": "#/definitions/DtoResponseWordToPdfForm" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseCreateHMAC" - } - } - }, - "x-ms-visibility": "internal", - "summary": "Create HMAC", - "description": "Create a Hash-based message authentication code (HMAC) using a secret key - https://support.encodian.com/hc/en-gb/articles/360012782058-Create-HMAC" - } - }, - "/api/v1/Core/CreateHashCode": { - "post": { - "tags": [ - "Core" - ], - "operationId": "CreateHashCode", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoCreateHashCode", - "schema": { - "$ref": "#/definitions/DtoCreateHashCode" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseCreateHashCode" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseCreateHashCode" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseCreateHashCode" - } - } - }, - "x-ms-visibility": "internal", - "summary": "Create Hash Code", - "description": "Create a hashcode for the string provided - https://support.encodian.com/hc/en-gb/articles/360013996077-Create-Hash-Code" - } - }, - "/api/v1/Core/AddTextWatermarkToImage": { - "post": { - "tags": [ - "Core" - ], - "operationId": "AddTextWatermarkToImage", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoCreateHashCode", - "schema": { - "$ref": "#/definitions/DtoAddTextWatermarkToImage" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseAddTextWatermarkToImage" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseAddTextWatermarkToImage" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseAddTextWatermarkToImage" + "$ref": "#/definitions/DtoResponseWordToPdfForm" } } }, "x-ms-visibility": "important", - "summary": "Add Text Watermark to Image", - "description": "Add a Text Watermark to the image provided - https://support.encodian.com/hc/en-gb/articles/360013560398-Add-Text-Watermark-To-Image" + "summary": "Convert - Word to PDF Form", + "description": "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" } }, - "/api/v1/Core/CompareWordDocuments": { + "/api/v1/Core/ParseCsv": { "post": { "tags": [ "Core" ], - "operationId": "CompareWordDocuments", + "operationId": "ParseCsv", "consumes": [ "application/json" ], @@ -4006,9 +2990,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoCompareWordDocuments", + "description": "Request object, refer to schema definition: DtoParseCsv", "schema": { - "$ref": "#/definitions/DtoCompareWordDocuments" + "$ref": "#/definitions/DtoParseCsv" } } ], @@ -4016,33 +3000,33 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseCompareWordDocuments" + "$ref": "#/definitions/DtoResponseParseCsv" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseCompareWordDocuments" + "$ref": "#/definitions/DtoResponseParseCsv" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseCompareWordDocuments" + "$ref": "#/definitions/DtoResponseParseCsv" } } }, "x-ms-visibility": "important", - "summary": "Compare Word Documents", - "description": "Compare differences between Microsoft Word and PDF Documents - https://support.encodian.com/hc/en-gb/articles/360018576278-Compare-Word-Documents" + "summary": "CSV - Parse", + "description": "Parse CSV and return the extracted data in JSON format - https://support.encodian.com/hc/en-gb/articles/360005177297-Parse-CSV" } }, - "/api/v1/Core/PopulateWordDocument": { + "/api/v1/Core/AddRowsToExcel": { "post": { "tags": [ "Core" ], - "operationId": "PopulateWordDocument", + "operationId": "AddRowsToExcel", "consumes": [ "application/json" ], @@ -4053,9 +3037,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoPopulateWordDocument", + "description": "Request object, refer to schema definition: DtoAddRowsToExcel", "schema": { - "$ref": "#/definitions/DtoPopulateWordDocument" + "$ref": "#/definitions/DtoAddRowsToExcel" } } ], @@ -4063,33 +3047,33 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponsePopulateWordDocument" + "$ref": "#/definitions/DtoResponseAddRowsToExcel" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponsePopulateWordDocument" + "$ref": "#/definitions/DtoResponseAddRowsToExcel" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponsePopulateWordDocument" + "$ref": "#/definitions/DtoResponseAddRowsToExcel" } } }, "x-ms-visibility": "important", - "summary": "Populate Word Document", - "description": "Populate a Microsoft Word Document (DOCX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/360019620578-Populate-Word-Document" + "summary": "Excel - Add Rows", + "description": "Add rows to the Excel file provided - https://support.encodian.com/hc/en-gb/articles/11551842583581" } }, - "/api/v1/Core/CompressPdf": { + "/api/v1/Core/ExcelWatermarkText": { "post": { "tags": [ "Core" ], - "operationId": "CompressPdf", + "operationId": "ExcelWatermarkText", "consumes": [ "application/json" ], @@ -4100,9 +3084,9 @@ { "in": "body", "name": "operation", - "description": "Request object, refer to schema definition: DtoCompressPdf", + "description": "Request object, refer to schema definition: DtoExcelWatermarkText", "schema": { - "$ref": "#/definitions/DtoCompressPdf" + "$ref": "#/definitions/DtoExcelWatermarkText" } } ], @@ -4110,25 +3094,636 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DtoResponseCompressPdf" + "$ref": "#/definitions/DtoResponseExcelWatermarkText" } }, "202": { "description": "Accepted", "schema": { - "$ref": "#/definitions/DtoResponseCompressPdf" + "$ref": "#/definitions/DtoResponseExcelWatermarkText" } }, "400": { "description": "Bad request", "schema": { - "$ref": "#/definitions/DtoResponseCompressPdf" + "$ref": "#/definitions/DtoResponseExcelWatermarkText" } } }, "x-ms-visibility": "important", - "summary": "Compress PDF", - "description": "Compress and optimise a PDF document - https://support.encodian.com/hc/en-gb/articles/360019994857-Compress-PDF" + "summary": "Excel - Add Text Watermark", + "description": "Add a text watermark to a Microsoft Excel file - https://support.encodian.com/hc/en-gb/articles/14428316059420" + } + }, + "/api/v1/Core/DeleteRowsFromExcel": { + "post": { + "tags": [ + "Core" + ], + "operationId": "DeleteRowsFromExcel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoDeleteRowsFromExcel", + "schema": { + "$ref": "#/definitions/DtoDeleteRowsFromExcel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseDeleteRowsFromExcel" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseDeleteRowsFromExcel" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseDeleteRowsFromExcel" + } + } + }, + "x-ms-visibility": "important", + "summary": "Excel - Delete Rows", + "description": "Delete rows from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/9936160309148" + } + }, + "/api/v1/Core/DeleteExcelWorksheets": { + "post": { + "tags": [ + "Core" + ], + "operationId": "DeleteExcelWorksheets", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoDeleteExcelWorksheets", + "schema": { + "$ref": "#/definitions/DtoDeleteExcelWorksheets" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseDeleteExcelWorksheets" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseDeleteExcelWorksheets" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseDeleteExcelWorksheets" + } + } + }, + "x-ms-visibility": "important", + "summary": "Excel - Delete Worksheets", + "description": "Delete specified worksheets from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/13233342312220" + } + }, + "/api/v1/Core/GetRowsFromExcel": { + "post": { + "tags": [ + "Core" + ], + "operationId": "GetRowsFromExcel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoGetRowsFromExcel", + "schema": { + "$ref": "#/definitions/DtoGetRowsFromExcel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseGetRowsFromExcel" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseGetRowsFromExcel" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseGetRowsFromExcel" + } + } + }, + "x-ms-visibility": "important", + "summary": "Excel - Extract Rows", + "description": "Extract rows from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/9390845334172" + } + }, + "/api/v1/Core/ExtractExcelWorksheets": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ExtractExcelWorksheets", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoResponseExtractExcelWorksheets", + "schema": { + "$ref": "#/definitions/DtoExtractExcelWorksheets" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseExtractExcelWorksheets" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseExtractExcelWorksheets" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseExtractExcelWorksheets" + } + } + }, + "x-ms-visibility": "important", + "summary": "Excel - Extract Worksheets", + "description": "Extract specified worksheets from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/13230802892316" + } + }, + "/api/v1/Core/MergeExcelRows": { + "post": { + "tags": [ + "Core" + ], + "operationId": "MergeExcelRows", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoMergeExcelFileContent", + "schema": { + "$ref": "#/definitions/DtoMergeExcelRows" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseMergeExcelRows" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseMergeExcelRows" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseMergeExcelRows" + } + } + }, + "x-ms-visibility": "important", + "summary": "Excel - Merge Rows", + "description": "Merge the rows contained within Excel files provided into a single worksheet - https://support.encodian.com/hc/en-gb/articles/11345445953820" + } + }, + "/api/v1/Core/ExcelWatermarkTextRemove": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ExcelWatermarkTextRemove", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoExcelWatermarkTextRemove", + "schema": { + "$ref": "#/definitions/DtoExcelWatermarkTextRemove" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseExcelWatermarkTextRemove" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseExcelWatermarkTextRemove" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseExcelWatermarkTextRemove" + } + } + }, + "x-ms-visibility": "important", + "summary": "Excel - Remove Text Watermark", + "description": "Remove text watermark(s) from a Microsoft Excel file - https://support.encodian.com/hc/en-gb/articles/14449860203548" + } + }, + "/api/v1/Core/SecureExcel": { + "post": { + "tags": [ + "Core" + ], + "operationId": "SecureExcel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoSecureExcel", + "schema": { + "$ref": "#/definitions/DtoSecureExcel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseSecureExcel" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseSecureExcel" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseSecureExcel" + } + } + }, + "x-ms-visibility": "important", + "summary": "Excel - Secure", + "description": "Secure and protect a Microsoft Excel file - https://support.encodian.com/hc/en-gb/articles/14332917020188" + } + }, + "/api/v1/Core/UnlockExcel": { + "post": { + "tags": [ + "Core" + ], + "operationId": "UnlockExcel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoUnlockExcel", + "schema": { + "$ref": "#/definitions/DtoUnlockExcel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseUnlockExcel" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseUnlockExcel" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseUnlockExcel" + } + } + }, + "x-ms-visibility": "important", + "summary": "Excel - Unlock", + "description": "Unlock / remove protection from the Excel file provided - https://support.encodian.com/hc/en-gb/articles/14358530634140" + } + }, + "/api/v1/Core/UpdateRowsInExcel": { + "post": { + "tags": [ + "Core" + ], + "operationId": "UpdateRowsInExcel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoUpdateRowsInExcel", + "schema": { + "$ref": "#/definitions/DtoUpdateRowsInExcel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseUpdateRowsInExcel" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseUpdateRowsInExcel" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseUpdateRowsInExcel" + } + } + }, + "x-ms-visibility": "important", + "summary": "Excel - Update Rows", + "description": "Update the specified rows in the Excel file provided - https://support.encodian.com/hc/en-gb/articles/11205752671004" + } + }, + "/api/v1/Core/GetEmailAttachments": { + "post": { + "tags": [ + "Core" + ], + "operationId": "GetEmailAttachments", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoGetEmailAttachments", + "schema": { + "$ref": "#/definitions/DtoGetEmailAttachments" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseGetEmailAttachments" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseGetEmailAttachments" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseGetEmailAttachments" + } + } + }, + "x-ms-visibility": "important", + "summary": "Email - Extract Attachments", + "description": "Extract attachments from the email provided and return an array of files - https://support.encodian.com/hc/en-gb/articles/10531671561629" + } + }, + "/api/v1/Core/GetEmailInfo": { + "post": { + "tags": [ + "Core" + ], + "operationId": "GetEmailInfo", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoGetEmailInformation", + "schema": { + "$ref": "#/definitions/DtoGetEmailInfo" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseGetEmailInfo" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseGetEmailInfo" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseGetEmailInfo" + } + } + }, + "x-ms-visibility": "important", + "summary": "Email - Extract Metadata", + "description": "Extract detailed information about the email provided (Email Format, Sender, Priority + more) - https://support.encodian.com/hc/en-gb/articles/12237799140252" + } + }, + "/api/v1/Core/SearchAndReplaceTextWithImage": { + "post": { + "tags": [ + "Core" + ], + "operationId": "SearchAndReplaceTextWithImage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoSearchAndReplaceTextWithImage", + "schema": { + "$ref": "#/definitions/DtoSearchAndReplaceTextWithImage" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseSearchAndReplaceTextWithImage" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseSearchAndReplaceTextWithImage" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseSearchAndReplaceTextWithImage" + } + } + }, + "x-ms-visibility": "important", + "summary": "File - Replace Text with Image", + "description": "Find and replace text contained within a PDF or DOCX document with an image - https://support.encodian.com/hc/en-gb/articles/360027234874" + } + }, + "/api/v1/Core/SearchAndReplaceText": { + "post": { + "tags": [ + "Core" + ], + "operationId": "SearchAndReplaceText", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoSearchAndReplaceText", + "schema": { + "$ref": "#/definitions/DtoSearchAndReplaceText" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseSearchAndReplaceText" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseSearchAndReplaceText" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseSearchAndReplaceText" + } + } + }, + "x-ms-visibility": "important", + "summary": "File - Search and Replace Text", + "description": "Find and replace text contained within a PDF or DOCX document - https://support.encodian.com/hc/en-gb/articles/360020937853-Search-and-Replace-Text" } }, "/api/v1/Core/EncodianSendToFiler": { @@ -4174,962 +3769,10 @@ } }, "x-ms-visibility": "important", - "summary": "Send to Encodian Filer", + "summary": "File - Send to Encodian Filer", "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": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoAddTextWatermarkWord", - "schema": { - "$ref": "#/definitions/DtoAddTextWatermarkWord" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseAddTextWatermarkWord" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseAddTextWatermarkWord" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseAddTextWatermarkWord" - } - } - }, - "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": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoAddImageWatermarkWord", - "schema": { - "$ref": "#/definitions/DtoAddImageWatermarkWord" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseAddImageWatermarkWord" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseAddImageWatermarkWord" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseAddImageWatermarkWord" - } - } - }, - "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/Core/ImageRemoveExifTags": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ImageRemoveExifTags", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoImageRemoveExifTags", - "schema": { - "$ref": "#/definitions/DtoImageRemoveExifTags" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseImageRemoveExifTags" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseImageRemoveExifTags" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseImageRemoveExifTags" - } - } - }, - "x-ms-visibility": "important", - "summary": "Remove EXIF Tags from Image", - "description": "Remove EXIF tags from the specified image - https://support.encodian.com/hc/en-gb/articles/4415700524817" - } - }, - "/api/v1/Core/ConvertPdfToTiff": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ConvertPdfToTiff", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoConvertPdfToTiff", - "schema": { - "$ref": "#/definitions/DtoConvertPdfToTiff" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToTiff" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToTiff" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToTiff" - } - } - }, - "x-ms-visibility": "important", - "summary": "Convert PDF to TIFF", - "description": "Convert a PDF document to TIFF (tiff) format - https://support.encodian.com/hc/en-gb/articles/4418024925457" - } - }, - "/api/v1/Core/FlattenPdf": { - "post": { - "tags": [ - "Core" - ], - "operationId": "FlattenPdf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoFlattenPdf", - "schema": { - "$ref": "#/definitions/DtoFlattenPdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseFlattenPdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseFlattenPdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseFlattenPdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Flatten PDF", - "description": "Flatten a PDF document or PDF form - https://support.encodian.com/hc/en-gb/articles/4416473033105" - } - }, - "/api/v1/Core/ConvertPdfToImages": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ConvertPdfToImages", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoConvertPdfToImages", - "schema": { - "$ref": "#/definitions/DtoConvertPdfToImages" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToImages" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToImages" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToImages" - } - } - }, - "x-ms-visibility": "important", - "summary": "Convert PDF to Images", - "description": "Convert a PDF document into an array of images (PNG or JPG) - https://support.encodian.com/hc/en-gb/articles/4418101623441" - } - }, - "/api/v1/Core/RepairPdf": { - "post": { - "tags": [ - "Core" - ], - "operationId": "RepairPdf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoRepairPdf", - "schema": { - "$ref": "#/definitions/DtoRepairPdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseRepairPdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseRepairPdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseRepairPdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Repair PDF", - "description": "Repair a PDF document - https://support.encodian.com/hc/en-gb/articles/4418809972753" - } - }, - "/api/v1/Core/MergePresentations": { - "post": { - "tags": [ - "Core" - ], - "operationId": "MergePresentations", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoMergePresentations", - "schema": { - "$ref": "#/definitions/DtoMergePresentations" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseMergePresentations" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseMergePresentations" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseMergePresentations" - } - } - }, - "x-ms-visibility": "important", - "summary": "Merge Presentations", - "description": "Merge an array of presentations to a single presentation - https://support.encodian.com/hc/en-gb/articles/4425652063761" - } - }, - "/api/v1/Core/GetImageInfo": { - "post": { - "tags": [ - "Core" - ], - "operationId": "GetImageInfo", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoGetImageInfo", - "schema": { - "$ref": "#/definitions/DtoGetImageInfo" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseGetImageInfo" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseGetImageInfo" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseGetImageInfo" - } - } - }, - "x-ms-visibility": "important", - "summary": "Get Image Information", - "description": "Get Image Information (Height, Width, Resolution, Format, File Size + more) - https://support.encodian.com/hc/en-gb/articles/4431662425489" - } - }, - "/api/v1/Core/SecureWordDocument": { - "post": { - "tags": [ - "Core" - ], - "operationId": "SecureWordDocument", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoSecureWord", - "schema": { - "$ref": "#/definitions/DtoSecureWordDocument" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseSecureWordDocument" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseSecureWordDocument" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseSecureWordDocument" - } - } - }, - "x-ms-visibility": "important", - "summary": "Secure Word Document", - "description": "Secure and protect a Microsoft Word document - https://support.encodian.com/hc/en-gb/articles/6634150180253" - } - }, - "/api/v1/Core/GetTrackedChanges": { - "post": { - "tags": [ - "Core" - ], - "operationId": "GetTrackedChanges", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoGetTrackedChanges", - "schema": { - "$ref": "#/definitions/DtoGetTrackedChanges" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseGetTrackedChanges" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseGetTrackedChanges" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseGetTrackedChanges" - } - } - }, - "x-ms-visibility": "important", - "summary": "Get Tracked Changes", - "description": "Get all the tracked changes (Revisions and comments) for the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6634950400669" - } - }, - "/api/v1/Core/SignPdf": { - "post": { - "tags": [ - "Core" - ], - "operationId": "SignPdf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "certificateTypeParameter", - "description": "Set the certificate type", - "type": "string", - "enum": [ - "Standard", - "Custom" - ], - "x-ms-visibility": "important", - "x-ms-summary": "Certificate Type" - }, - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoSignPdf", - "schema": { - "$ref": "#/definitions/DtoSignPdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseSignPdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseSignPdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseSignPdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Sign PDF", - "description": "Apply a digital signature to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7117159708189" - } - }, - "/api/v1/Core/EnableTrackedChanges": { - "post": { - "tags": [ - "Core" - ], - "operationId": "EnableTrackedChanges", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoEnableTrackedChanges", - "schema": { - "$ref": "#/definitions/DtoEnableTrackedChanges" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseEnableTrackedChanges" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseEnableTrackedChanges" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseEnableTrackedChanges" - } - } - }, - "x-ms-visibility": "important", - "summary": "Enable Tracked Changes", - "description": "Enable tracked changes on the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6695385009053" - } - }, - "/api/v1/Core/DisableTrackedChanges": { - "post": { - "tags": [ - "Core" - ], - "operationId": "DisableTrackedChanges", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoDisableTrackedChanges", - "schema": { - "$ref": "#/definitions/DtoDisableTrackedChanges" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseDisableTrackedChanges" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseDisableTrackedChanges" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseDisableTrackedChanges" - } - } - }, - "x-ms-visibility": "important", - "summary": "Disable Tracked Changes", - "description": "Disable tracked changes on the Microsoft Word document provided - https://support.encodian.com/hc/en-gb/articles/6695370804125" - } - }, - "/api/v1/Core/CompressPowerPoint": { - "post": { - "tags": [ - "Core" - ], - "operationId": "CompressPowerPoint", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoCompressPowerPoint", - "schema": { - "$ref": "#/definitions/DtoCompressPowerPoint" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseCompressPowerPoint" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseCompressPowerPoint" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseCompressPowerPoint" - } - } - }, - "x-ms-visibility": "important", - "summary": "Compress PowerPoint", - "description": "Compress the PowerPoint file provided - https://support.encodian.com/hc/en-gb/articles/7621965500189" - } - }, - "/api/v1/Core/RemoveWatermarksFromPdf": { - "post": { - "tags": [ - "Core" - ], - "operationId": "RemoveWatermarksFromPdf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoRemoveWatermarkFromPdf", - "schema": { - "$ref": "#/definitions/DtoRemoveWatermarksFromPdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseRemoveWatermarksFromPdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseRemoveWatermarksFromPdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseRemoveWatermarksFromPdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Remove Watermarks from PDF", - "description": "Remove specified watermark(s) from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7751328751645" - } - }, - "/api/v1/Core/RemoveWatermarksFromWord": { - "post": { - "tags": [ - "Core" - ], - "operationId": "RemoveWatermarksFromWord", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoRemoveWatermarkFromWord", - "schema": { - "$ref": "#/definitions/DtoRemoveWatermarksFromWord" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseRemoveWatermarksFromWord" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseRemoveWatermarksFromWord" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseRemoveWatermarksFromWord" - } - } - }, - "x-ms-visibility": "important", - "summary": "Remove Watermark from Word", - "description": "Remove the watermark from the Word file provided - https://support.encodian.com/hc/en-gb/articles/7752587767965" - } - }, - "/api/v1/Core/AddAttachmentsToPdf": { - "post": { - "tags": [ - "Core" - ], - "operationId": "AddAttachmentsToPdf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoResponseAddAttachmentsToPdf", - "schema": { - "$ref": "#/definitions/DtoAddAttachmentsToPdf" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseAddAttachmentsToPdf" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseAddAttachmentsToPdf" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseAddAttachmentsToPdf" - } - } - }, - "x-ms-visibility": "important", - "summary": "Add Attachments to PDF", - "description": "Add one or more attachments to the PDF file provided - https://support.encodian.com/hc/en-gb/articles/8087678202653" - } - }, - "/api/v1/Core/ConvertJsonToExcel": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ConvertJsonToExcel", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoConvertJsonToExcel", - "schema": { - "$ref": "#/definitions/DtoConvertJsonToExcel" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseConvertJsonToExcel" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseConvertJsonToExcel" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseConvertJsonToExcel" - } - } - }, - "x-ms-visibility": "important", - "summary": "Convert JSON to Excel", - "description": "Convert JSON into a Microsft Excel file - https://support.encodian.com/hc/en-gb/articles/7690520790045" - } - }, - "/api/v1/Core/ConvertPdfToPng": { - "post": { - "tags": [ - "Core" - ], - "operationId": "ConvertPdfToPng", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "operation", - "description": "Request object, refer to schema definition: DtoConvertPdfToPng", - "schema": { - "$ref": "#/definitions/DtoConvertPdfToPng" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToPng" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToPng" - } - }, - "400": { - "description": "Bad request", - "schema": { - "$ref": "#/definitions/DtoResponseConvertPdfToPng" - } - } - }, - "x-ms-visibility": "important", - "summary": "Convert PDF to PNG", - "description": "Convert a PDF document to a PNG - https://support.encodian.com/hc/en-gb/articles/10086003836701" - } - }, "/api/v1/Core/AddImageWatermarkToImage": { "post": { "tags": [ @@ -5173,10 +3816,1902 @@ } }, "x-ms-visibility": "important", - "summary": "Add Image Watermark to Image", + "summary": "Image - Add Image Watermark", "description": "Add an image watermark to the image provided - https://support.encodian.com/hc/en-gb/articles/8967068141597" } }, + "/api/v1/Core/AddTextWatermarkToImage": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddTextWatermarkToImage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoCreateHashCode", + "schema": { + "$ref": "#/definitions/DtoAddTextWatermarkToImage" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermarkToImage" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermarkToImage" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermarkToImage" + } + } + }, + "x-ms-visibility": "important", + "summary": "Image - Add Text Watermark", + "description": "Add a Text Watermark to the image provided - https://support.encodian.com/hc/en-gb/articles/360013560398-Add-Text-Watermark-To-Image" + } + }, + "/api/v1/Core/ImageCleanUpDocument": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ImageCleanUpDocument", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoImageCleanUpDoc", + "schema": { + "$ref": "#/definitions/DtoImageCleanUpDoc" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseImageCleanUpDoc" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseImageCleanUpDoc" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseImageCleanUpDoc" + } + } + }, + "x-ms-visibility": "important", + "summary": "Image - Clean Up (Document)", + "description": "Execute image clean up activities focussed on text based images such as Deskew, Rotate, Despeckle + more." + } + }, + "/api/v1/Core/ImageCleanUpPhoto": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ImageCleanUpPhoto", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoImageCleanUpPhoto", + "schema": { + "$ref": "#/definitions/DtoImageCleanUpPhoto" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseImageCleanUpPhoto" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseImageCleanUpPhoto" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseImageCleanUpPhoto" + } + } + }, + "x-ms-visibility": "important", + "summary": "Image - Clean Up (Photo)", + "description": "Execute image clean up activities for standard photo images." + } + }, + "/api/v1/Core/CompressImage": { + "post": { + "tags": [ + "Core" + ], + "operationId": "CompressImage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoImageCompress", + "schema": { + "$ref": "#/definitions/DtoImageCompress" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseImageCompress" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseImageCompress" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseImageCompress" + } + } + }, + "x-ms-visibility": "important", + "summary": "Image - Compress", + "description": "Compress the image provided - https://support.encodian.com/hc/en-gb/articles/360027350513-Compress-an-Image" + } + }, + "/api/v1/Core/ImageConvertFormat": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ImageConvertFormat", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoImageConvertFormat", + "schema": { + "$ref": "#/definitions/DtoImageConvertFormat" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseImageConvertFormat" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseImageConvertFormat" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseImageConvertFormat" + } + } + }, + "x-ms-visibility": "important", + "summary": "Image - Convert Format", + "description": "Convert the format of the image provided - https://support.encodian.com/hc/en-gb/articles/360006617857-Convert-Image-Format" + } + }, + "/api/v1/Core/CropImage": { + "post": { + "tags": [ + "Core" + ], + "operationId": "CropImage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "cropTypeParameter", + "description": "Set the crop type action", + "type": "string", + "enum": [ + "Border", + "Rectangle" + ], + "x-ms-visibility": "important", + "x-ms-summary": "Crop Type" + }, + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoCropImage", + "schema": { + "$ref": "#/definitions/DtoCropImage" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseCropImage" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseCropImage" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseCropImage" + } + } + }, + "x-ms-visibility": "important", + "summary": "Image - Crop", + "description": "Crop an image using border values or a rectangle - https://support.encodian.com/hc/en-gb/articles/10860483459740/" + } + }, + "/api/v1/Core/GetImageInfo": { + "post": { + "tags": [ + "Core" + ], + "operationId": "GetImageInfo", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoGetImageInfo", + "schema": { + "$ref": "#/definitions/DtoGetImageInfo" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseGetImageInfo" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseGetImageInfo" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseGetImageInfo" + } + } + }, + "x-ms-visibility": "important", + "summary": "Image - Extract Metadata", + "description": "Extract metadata from the image provided (Height, Width, Resolution, Format, File Size + more) - https://support.encodian.com/hc/en-gb/articles/4431662425489" + } + }, + "/api/v1/Core/ImageExtractText": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ImageExtractText", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoImageExtractText", + "schema": { + "$ref": "#/definitions/DtoImageExtractText" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseImageExtractText" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseImageExtractText" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseImageExtractText" + } + } + }, + "x-ms-visibility": "important", + "summary": "Image - Extract Text (OCR)", + "description": "Extract text from the image provided - https://support.encodian.com/hc/en-gb/articles/360006998078-Extract-Text-from-Image-OCR" + } + }, + "/api/v1/Core/FlipImage": { + "post": { + "tags": [ + "Core" + ], + "operationId": "FlipImage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoFlipImage", + "schema": { + "$ref": "#/definitions/DtoFlipImage" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseFlipImage" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseFlipImage" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseFlipImage" + } + } + }, + "x-ms-visibility": "important", + "summary": "Image - Flip", + "description": "Flip the image provided - https://support.encodian.com/hc/en-gb/articles/9798473339292" + } + }, + "/api/v1/Core/ImageRemoveExifTags": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ImageRemoveExifTags", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoImageRemoveExifTags", + "schema": { + "$ref": "#/definitions/DtoImageRemoveExifTags" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseImageRemoveExifTags" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseImageRemoveExifTags" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseImageRemoveExifTags" + } + } + }, + "x-ms-visibility": "important", + "summary": "Image - Remove EXIF Tags", + "description": "Remove EXIF tags from the specified image - https://support.encodian.com/hc/en-gb/articles/4415700524817" + } + }, + "/api/v1/Core/ResizeImage": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ResizeImage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoImageResize", + "schema": { + "$ref": "#/definitions/DtoImageResize" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseImageResize" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseImageResize" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseImageResize" + } + } + }, + "x-ms-visibility": "important", + "summary": "Image - Resize", + "description": "Resize and compress the image provided - https://support.encodian.com/hc/en-gb/articles/360018591034-Resize-an-Image" + } + }, + "/api/v1/Core/RotateImage": { + "post": { + "tags": [ + "Core" + ], + "operationId": "RotateImage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoResponseRotateImage", + "schema": { + "$ref": "#/definitions/DtoRotateImage" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseRotateImage" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseRotateImage" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseRotateImage" + } + } + }, + "x-ms-visibility": "important", + "summary": "Image - Rotate", + "description": "Rotate an image by specified degrees - https://support.encodian.com/hc/en-gb/articles/10041551840796" + } + }, + "/api/v1/Core/MergeArrayOfDocumentsToPdf": { + "post": { + "tags": [ + "Core" + ], + "operationId": "MergeArrayOfDocumentsToPdf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoMergeArrayOfDocumentsToPdf", + "schema": { + "$ref": "#/definitions/DtoMergeArrayOfDocumentsToPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "Merge - File Array to PDF", + "description": "Convert and merge an array of files to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360014632213-Merge-document-array-to-PDF" + } + }, + "/api/v1/Core/MergeDocumentsToPdf": { + "post": { + "tags": [ + "Core" + ], + "operationId": "MergeDocumentsToPdf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoMergeDocumentsToPdf", + "schema": { + "$ref": "#/definitions/DtoMergeDocumentsToPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseMergeDocumentsToPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseMergeDocumentsToPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseMergeDocumentsToPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "Merge - Files to PDF", + "description": "Convert and merge the files provided to a single PDF document - https://support.encodian.com/hc/en-gb/articles/360011886173-Merge-documents-to-PDF" + } + }, + "/api/v1/Core/MergeArrayOfExcelDocuments": { + "post": { + "tags": [ + "Core" + ], + "operationId": "MergeArrayOfExcelDocuments", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoMergeArrayOfExcelDocuments", + "schema": { + "$ref": "#/definitions/DtoMergeArrayOfExcelDocuments" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseMergeArrayOfExcelDocuments" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseMergeArrayOfExcelDocuments" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseMergeArrayOfExcelDocuments" + } + } + }, + "x-ms-visibility": "important", + "summary": "Merge - Excel Files", + "description": "Merge an array of Microsoft Excel files to a single file (multiple formats) - https://support.encodian.com/hc/en-gb/articles/4469865776529" + } + }, + "/api/v1/Core/MergePresentations": { + "post": { + "tags": [ + "Core" + ], + "operationId": "MergePresentations", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoMergePresentations", + "schema": { + "$ref": "#/definitions/DtoMergePresentations" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseMergePresentations" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseMergePresentations" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseMergePresentations" + } + } + }, + "x-ms-visibility": "important", + "summary": "Merge - Presentations", + "description": "Merge an array of presentations to a single presentation - https://support.encodian.com/hc/en-gb/articles/4425652063761" + } + }, + "/api/v1/Core/MergeArrayOfDocumentsToWord": { + "post": { + "tags": [ + "Core" + ], + "operationId": "MergeArrayOfDocumentsToWord", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoMergeArrayOfDocumentsToWord", + "schema": { + "$ref": "#/definitions/DtoMergeArrayOfDocumentsToWord" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToWord" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToWord" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseMergeArrayOfDocumentsToWord" + } + } + }, + "x-ms-visibility": "important", + "summary": "Merge - Word Documents", + "description": "Merge an array of Microsoft Word documents to a single Microsoft Word document (DOCX) - https://support.encodian.com/hc/en-gb/articles/360023972213-Merge-document-array-to-Word" + } + }, + "/api/v1/Core/AddAttachmentsToPdf": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddAttachmentsToPdf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoResponseAddAttachmentsToPdf", + "schema": { + "$ref": "#/definitions/DtoAddAttachmentsToPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddAttachmentsToPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddAttachmentsToPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAddAttachmentsToPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Add Attachments", + "description": "Add one or more attachments to the PDF file provided - https://support.encodian.com/hc/en-gb/articles/8087678202653" + } + }, + "/api/v1/Core/AddHtmlHeaderFooter": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddHtmlHeaderFooter", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoAddHtmlHeaderFooter", + "schema": { + "$ref": "#/definitions/DtoAddHtmlHeaderFooter" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooter" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooter" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAddHtmlHeaderFooter" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Add HTML Header or Footer", + "description": "Add a HTML header, footer or both to the specified PDF document - https://support.encodian.com/hc/en-gb/articles/360013808614-Add-HTML-Header-or-Footer" + } + }, + "/api/v1/Core/AddImageWatermark": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddImageWatermark", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoAddImageWatermark", + "schema": { + "$ref": "#/definitions/DtoAddImageWatermark" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddImageWatermark" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddImageWatermark" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAddImageWatermark" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - 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" + } + }, + "/api/v1/Core/AddImageWatermarkAdvanced": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddImageWatermarkAdvanced", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoAddImageWatermarkAdv", + "schema": { + "$ref": "#/definitions/DtoAddImageWatermarkAdv" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddImageWatermarkAdv" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddImageWatermarkAdv" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAddImageWatermarkAdv" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - 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" + } + }, + "/api/v1/Core/AddPageNumbers": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddPageNumbers", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoAddPageNumbers", + "schema": { + "$ref": "#/definitions/DtoAddPageNumbers" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddPageNumbers" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddPageNumbers" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAddPageNumbers" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Add Page Numbers", + "description": "Add page numbers to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360014464534-Add-Page-Numbers" + } + }, + "/api/v1/Core/AddTextWatermark": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddTextWatermark", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoAddTextWatermark", + "schema": { + "$ref": "#/definitions/DtoAddTextWatermark" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermark" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermark" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermark" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - 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" + } + }, + "/api/v1/Core/AddTextWatermarkAdvanced": { + "post": { + "tags": [ + "Core" + ], + "operationId": "AddTextWatermarkAdvanced", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoAddTextWatermarkAdv", + "schema": { + "$ref": "#/definitions/DtoAddTextWatermarkAdv" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermarkAdv" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermarkAdv" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAddTextWatermarkAdv" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - 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" + } + }, + "/api/v1/Core/OcrPdfDocument": { + "post": { + "tags": [ + "Core" + ], + "operationId": "OcrPdfDocument", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoOcrPdf", + "schema": { + "$ref": "#/definitions/DtoOcrPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseOcrPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseOcrPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseOcrPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Apply OCR (Standard)", + "description": "Perform OCR on an existing PDF document - https://support.encodian.com/hc/en-gb/articles/360012686653-OCR-a-PDF-Document" + } + }, + "/api/v1/Core/CompressPdf": { + "post": { + "tags": [ + "Core" + ], + "operationId": "CompressPdf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoCompressPdf", + "schema": { + "$ref": "#/definitions/DtoCompressPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseCompressPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseCompressPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseCompressPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Compress", + "description": "Compress and optimise a PDF document - https://support.encodian.com/hc/en-gb/articles/360019994857-Compress-PDF" + } + }, + "/api/v1/Core/DeletePdfPages": { + "post": { + "tags": [ + "Core" + ], + "operationId": "DeletePdfPages", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoDeletePdfPages", + "schema": { + "$ref": "#/definitions/DtoDeletePdfPages" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseDeletePdfPages" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseDeletePdfPages" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseDeletePdfPages" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Delete Pages", + "description": "Delete specified pages from the pdf file provided - https://support.encodian.com/hc/en-gb/articles/13690317983132/" + } + }, + "/api/v1/Core/ExtractAttachmentsFromPdf": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ExtractAttachmentsFromPdf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoExtractAttachmentsFromPdf", + "schema": { + "$ref": "#/definitions/DtoExtractAttachmentsFromPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseExtractAttachmentsFromPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseExtractAttachmentsFromPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseExtractAttachmentsFromPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Extract Attachments", + "description": "Extract attachments from the PDF provided - https://support.encodian.com/hc/en-gb/articles/9896328763932" + } + }, + "/api/v1/Core/ExtractImages": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ExtractImages", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoExtractTextRegion", + "schema": { + "$ref": "#/definitions/DtoExtractImage" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseExtractImage" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseExtractImage" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseExtractImage" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Extract Images from Regions", + "description": "Extract images from PDF using specified regions - https://support.encodian.com/hc/en-gb/articles/360006998058-Extract-Images-from-PDF" + } + }, + "/api/v1/Core/GetPdfDocumentInfo": { + "post": { + "tags": [ + "Core" + ], + "operationId": "GetPdfDocumentInfo", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoGetPdfDocumentInfo", + "schema": { + "$ref": "#/definitions/DtoGetPdfDocumentInfo" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseGetPdfDocumentInfo" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseGetPdfDocumentInfo" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseGetPdfDocumentInfo" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Extract Metadata", + "description": "Extract PDF Metadata information from the PDF docucment provided (Number of Pages, File Size + more) - https://support.encodian.com/hc/en-gb/articles/360002949358-Get-PDF-Document-Information" + } + }, + "/api/v1/Core/ExtractPdfPages": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ExtractPdfPages", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoExtractPdfPages", + "schema": { + "$ref": "#/definitions/DtoExtractPdfPages" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseExtractPdfPages" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseExtractPdfPages" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseExtractPdfPages" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Extract Pages", + "description": "Extract specified pages from the pdf file provided - https://support.encodian.com/hc/en-gb/articles/13958097048732" + } + }, + "/api/v1/Core/GetPdfTextLayer": { + "post": { + "tags": [ + "Core" + ], + "operationId": "GetPdfTextLayer", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoGetPdfTextLayer", + "schema": { + "$ref": "#/definitions/DtoGetPdfTextLayer" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseGetPdfTextLayer" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseGetPdfTextLayer" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseGetPdfTextLayer" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Extract Text", + "description": "Extract the text layer from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360015539373-Get-PDF-Text-Layer" + } + }, + "/api/v1/Core/ExtractTextRegions": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ExtractTextRegions", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoExtractTextRegion", + "schema": { + "$ref": "#/definitions/DtoExtractTextRegion" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseExtractTextRegion" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseExtractTextRegion" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseExtractTextRegion" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Extract Text from Regions", + "description": "Extract text using OCR from 70+ files types using specified regions - https://support.encodian.com/hc/en-gb/articles/360015612353-Extract-Text-from-Regions" + } + }, + "/api/v1/Core/FlattenPdf": { + "post": { + "tags": [ + "Core" + ], + "operationId": "FlattenPdf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoFlattenPdf", + "schema": { + "$ref": "#/definitions/DtoFlattenPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseFlattenPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseFlattenPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseFlattenPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Flatten", + "description": "Flatten a PDF document or PDF form - https://support.encodian.com/hc/en-gb/articles/4416473033105" + } + }, + "/api/v1/Core/InsertHtmlToPdf": { + "post": { + "tags": [ + "Core" + ], + "operationId": "InsertHtmlToPdf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoInsertHtmlToPdf", + "schema": { + "$ref": "#/definitions/DtoInsertHtmlToPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseInsertHtmlToPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseInsertHtmlToPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseInsertHtmlToPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Insert HTML", + "description": "Insert the HTML provided into a PDF document - https://support.encodian.com/hc/en-gb/articles/360011784354-Insert-HTML-to-PDF" + } + }, + "/api/v1/Core/RedactPdf": { + "post": { + "tags": [ + "Core" + ], + "operationId": "RedactPdf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoRedactPdf", + "schema": { + "$ref": "#/definitions/DtoRedactPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseRedactPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseRedactPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseRedactPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Redact", + "description": "Apply the specified redactions to the PDF document provided - https://support.encodian.com/hc/en-gb/articles/360018607954-Redact-PDF-" + } + }, + "/api/v1/Core/RemoveWatermarksFromPdf": { + "post": { + "tags": [ + "Core" + ], + "operationId": "RemoveWatermarksFromPdf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoRemoveWatermarkFromPdf", + "schema": { + "$ref": "#/definitions/DtoRemoveWatermarksFromPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseRemoveWatermarksFromPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseRemoveWatermarksFromPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseRemoveWatermarksFromPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Remove Watermarks", + "description": "Remove specified watermark(s) from the PDF document provided - https://support.encodian.com/hc/en-gb/articles/7751328751645" + } + }, + "/api/v1/Core/RepairPdf": { + "post": { + "tags": [ + "Core" + ], + "operationId": "RepairPdf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoRepairPdf", + "schema": { + "$ref": "#/definitions/DtoRepairPdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseRepairPdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseRepairPdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseRepairPdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Repair", + "description": "Repair a PDF document - https://support.encodian.com/hc/en-gb/articles/4418809972753" + } + }, + "/api/v1/Core/ResizePdf": { + "post": { + "tags": [ + "Core" + ], + "operationId": "ResizePdf", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoPdfResize", + "schema": { + "$ref": "#/definitions/DtoResizePdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseResizePdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseResizePdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseResizePdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Resize", + "description": "Resize a PDF document - https://support.encodian.com/hc/en-gb/articles/12292028562588" + } + }, + "/api/v1/Core/SecurePdfDocument": { + "post": { + "tags": [ + "Core" + ], + "operationId": "SecurePdfDocument", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoSecurePdf", + "schema": { + "$ref": "#/definitions/DtoSecurePdf" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseSecurePdf" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseSecurePdf" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseSecurePdf" + } + } + }, + "x-ms-visibility": "important", + "summary": "PDF - Secure", + "description": "Encrypt and protect a PDF document - https://support.encodian.com/hc/en-gb/articles/360011330134-Secure-PDF-Document" + } + }, "/api/v1/DynamicSchema/GetDynamicSchemaCreateBarcode": { "get": { "tags": [ @@ -5460,7 +5995,7 @@ ], "produces": [ "application/json" - ], + ], "responses": { "200": { "description": "Success", @@ -5482,7 +6017,7 @@ } }, "x-ms-visibility": "important", - "summary": "Get Subscription Status – Flowr and Vertr", + "summary": "Subscription Status – Flowr and Vertr", "description": "Get the the status of your Encodian Subscription - https://support.encodian.com/hc/en-gb/articles/360010176717-Get-Subscription-Status" } }, @@ -5519,7 +6054,7 @@ } }, "x-ms-visibility": "important", - "summary": "Get Subscription Status - Trigr", + "summary": "Subscription Status - Trigr", "description": "Get the the status of your Encodian Subscription - https://support.encodian.com/hc/en-gb/articles/7297080207133" } }, @@ -6603,6 +7138,51 @@ "description": "Get the operation status of the operation ID provided." } }, + "/api/v1/Mgmt/GetOperationStatusAddWatermarkFileOnly": { + "get": { + "tags": [ + "Mgmt" + ], + "operationId": "GetOperationStatusAddWatermarkFileOnly", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "operationId", + "description": "Retrieve the operation status of an AddImageWatermark, AddImageWatermarkAdv, AddTextWatermark or AddTextWatermarkAdv operation for the Operation ID provided.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoBaseMgmtResponseFileOnlyWatermark" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoBaseMgmtResponseFileOnlyWatermark" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoBaseMgmtResponseFileOnlyWatermark" + } + } + }, + "x-ms-visibility": "internal", + "summary": "Get an Operation Status for Add Watermark Actions (File Only)", + "description": "Get the operation status of the operation ID provided." + } + }, "/api/v1/Mgmt/GetOperationStatusGetRowsFromExcel": { "get": { "tags": [ @@ -6738,6 +7318,51 @@ "description": "Get the operation status of the operation ID provided." } }, + "/api/v1/Mgmt/GetOperationStatusAITranslateText": { + "get": { + "tags": [ + "Mgmt" + ], + "operationId": "GetOperationStatusAITranslateText", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "operationId", + "description": "Retrieve the operation status of a GetOperationStatusAITranslateText operation for the Operation ID provided.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateText" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateText" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseAITranslateText" + } + } + }, + "x-ms-visibility": "internal", + "summary": "Get an Operation Status for AITranslateText", + "description": "Retrieve the operation status of a AITranslateText operation for the Operation ID provided." + } + }, "/api/v1/Mgmt/GetOperationStatusUtilityBool": { "get": { "tags": [ @@ -9170,6 +9795,511 @@ "summary": "Utility - AES Decryption", "description": "Decrypts an AES encrypted string using AES decryption - https://support.encodian.com/hc/en-gb/articles/13200819253660" } + }, + "/api/v1/Utility/RsaEncryption": { + "post": { + "tags": [ + "Utility" + ], + "operationId": "RsaEncryption", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoRsaEncryption", + "schema": { + "$ref": "#/definitions/DtoRsaEncryption" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseRsaEncryption" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseRsaEncryption" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseRsaEncryption" + } + } + }, + "x-ms-visibility": "important", + "summary": "Utility - RSA Encryption", + "description": "Encrypts a plain text value (string) using RSA encryption - https://support.encodian.com/hc/en-gb/articles/13727847862300" + } + }, + "/api/v1/Utility/RsaDecryption": { + "post": { + "tags": [ + "Utility" + ], + "operationId": "RsaDecryption", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoRsaDecryption", + "schema": { + "$ref": "#/definitions/DtoRsaDecryption" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseRsaDecryption" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseRsaDecryption" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseRsaDecryption" + } + } + }, + "x-ms-visibility": "important", + "summary": "Utility - RSA Decryption", + "description": "Decrypts an RSA encrypted string using RSA decryption - https://support.encodian.com/hc/en-gb/articles/13727862311580" + } + }, + "/api/v1/Utility/CreateRsaKeyPair": { + "post": { + "tags": [ + "Utility" + ], + "operationId": "CreateRsaKeyPair", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoCreateRsaKeyPair", + "schema": { + "$ref": "#/definitions/DtoCreateRsaKeyPair" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseCreateRsaKeyPair" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseCreateRsaKeyPair" + } + } + }, + "x-ms-visibility": "important", + "summary": "Utility - RSA Create Key Pair", + "description": "Creates an RSA key pair - https://support.encodian.com/hc/en-gb/articles/13955455670044" + } + }, + "/api/v1/Utility/ArrayConvertToXml": { + "post": { + "tags": [ + "Utility" + ], + "operationId": "ArrayConvertToXml", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoArrayConvertToXml", + "schema": { + "$ref": "#/definitions/DtoArrayConvertToXml" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseArrayConvertToXml" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseArrayConvertToXml" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseArrayConvertToXml" + } + } + }, + "x-ms-visibility": "important", + "summary": "Utility - Array to XML", + "description": "Convert an array to a XML Object - https://support.encodian.com/hc/en-gb/articles/13964382131484" + } + }, + "/api/v1/Utility/ConvertXmlToJson": { + "post": { + "tags": [ + "Utility" + ], + "operationId": "ConvertXmlToJson", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoConvertXmlToJson", + "schema": { + "$ref": "#/definitions/DtoConvertXmlToJson" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseConvertXmlToJson" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseConvertXmlToJson" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseConvertXmlToJson" + } + } + }, + "x-ms-visibility": "important", + "summary": "Utility - Convert XML to JSON", + "description": "Convert the XML provided to JSON - https://support.encodian.com/hc/en-gb/articles/14125831121948" + } + }, + "/api/v1/Utility/ConvertJsonToXml": { + "post": { + "tags": [ + "Utility" + ], + "operationId": "ConvertJsonToXml", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoConvertJsonToXml", + "schema": { + "$ref": "#/definitions/DtoConvertJsonToXml" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseConvertJsonToXml" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseConvertJsonToXml" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseConvertJsonToXml" + } + } + }, + "x-ms-visibility": "important", + "summary": "Utility - Convert JSON To XML", + "description": "Convert the JSON provided to XML - https://support.encodian.com/hc/en-gb/articles/14125966342428" + } + }, + "/api/v1/Utility/ArraySortItems": { + "post": { + "tags": [ + "Utility" + ], + "operationId": "ArraySortItems", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoArraySortItems", + "schema": { + "$ref": "#/definitions/DtoArraySortItems" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseArraySortItems" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseArraySortItems" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseArraySortItems" + } + } + }, + "x-ms-visibility": "important", + "summary": "Utility - Array Sort Items", + "description": "Sort the items in the JSON array provided - https://support.encodian.com/hc/en-gb/articles/14510233816092" + } + }, + "/api/v1/Utility/CreateJWT": { + "post": { + "tags": [ + "Utility" + ], + "operationId": "CreateJWT", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoCreateJwt", + "schema": { + "$ref": "#/definitions/DtoCreateJwt" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseCreateJwt" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseCreateJwt" + } + } + }, + "x-ms-visibility": "important", + "summary": "Utility - Create JWT", + "description": "Create a JSON Web Token (JWT) - https://support.encodian.com/hc/en-gb/articles/14501991985564" + } + }, + "/api/v1/Utility/ArraySplitItems": { + "post": { + "tags": [ + "Utility" + ], + "operationId": "ArraySplitItems", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoArraySplitItems", + "schema": { + "$ref": "#/definitions/DtoArraySplitItems" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseArraySplitItems" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseArraySplitItems" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseArraySplitItems" + } + } + }, + "x-ms-visibility": "important", + "summary": "Utility - Array Split Items", + "description": "Split the Array provided by match value or index - https://support.encodian.com/hc/en-gb/articles/14508988206108" + } + }, + "/api/v1/Utility/ArrayFilterItems": { + "post": { + "tags": [ + "Utility" + ], + "operationId": "ArrayFilterItems", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoArrayFilterItems", + "schema": { + "$ref": "#/definitions/DtoArrayFilterItems" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseArrayFilterItems" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseArrayFilterItems" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseArrayFilterItems" + } + } + }, + "x-ms-visibility": "important", + "summary": "Utility - Array Filter Items", + "description": "Filter items from a JSON Array - https://support.encodian.com/hc/en-gb/articles/14460654575900" + } + }, + "/api/v1/Utility/ArrayFilterItemsViaRegex": { + "post": { + "tags": [ + "Utility" + ], + "operationId": "ArrayFilterItemsViaRegex", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "operation", + "description": "Request object, refer to schema definition: DtoArrayFilterItemsViaRegex", + "schema": { + "$ref": "#/definitions/DtoArrayFilterItemsViaRegex" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DtoResponseArrayFilterItemsViaRegex" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DtoResponseArrayFilterItemsViaRegex" + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/DtoResponseArrayFilterItemsViaRegex" + } + } + }, + "x-ms-visibility": "important", + "summary": "Utility - Array Filter Items via Regex", + "description": "Filter items from a JSON Array using a Regular Expression - https://support.encodian.com/hc/en-gb/articles/14610830128796/" + } } }, "definitions": { @@ -9355,6 +10485,982 @@ } } }, + "DtoAITranslateFile": { + "required": [ + "fileContent", + "fileName", + "targetLanguage" + ], + "type": "object", + "properties": { + "fileName": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Filename", + "description": "The filename of the source file, the file extension is mandatory: 'file.pdf' and not 'file'" + }, + "fileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The file content of the source file" + }, + "sourceLanguage": { + "default": "AUTO", + "enum": [ + "AUTO", + "Afrikaans", + "Albanian", + "Amharic", + "Arabic", + "Armenian", + "Assamese", + "AzerbaijaniLatin", + "Bangla", + "Bashkir", + "Basque", + "Bhojpuri", + "Bodo", + "BosnianLatin", + "Bulgarian", + "CantoneseTraditional", + "Catalan", + "ChineseLiterary", + "ChineseSimplified", + "ChineseTraditional", + "ChiShona", + "Croatian", + "Czech", + "Danish", + "Dari", + "Divehi", + "Dogri", + "Dutch", + "English", + "Estonian", + "Faroese", + "Fijian", + "Filipino", + "Finnish", + "French", + "FrenchCanadian", + "Galician", + "Georgian", + "German", + "Greek", + "Gujarati", + "HaitianCreole", + "Hausa", + "Hebrew", + "Hindi", + "HmongDawLatin", + "Hungarian", + "Icelandic", + "Igbo", + "Indonesian", + "Inuinnaqtun", + "Inuktitut", + "InuktitutLatin", + "Irish", + "Italian", + "Japanese", + "Kannada", + "Kashmiri", + "Kazakh", + "Khmer", + "Kinyarwanda", + "Klingon", + "KlingonPlqaD", + "Konkani", + "Korean", + "KurdishCentral", + "KurdishNorthern", + "KyrgyzCyrillic", + "Lao", + "Latvian", + "Lithuanian", + "Lingala", + "LowerSorbian", + "Luganda", + "Macedonian", + "Maithili", + "Malagasy", + "MalayLatin", + "Malayalam", + "Maltese", + "Maori", + "Marathi", + "MongolianCyrillic", + "MongolianTraditional", + "Myanmar", + "Nepali", + "Norwegian", + "Nyanja", + "Odia", + "Pashto", + "Persian", + "Polish", + "PortugueseBrazil", + "PortuguesePortugal", + "Punjabi", + "QueretaroOtomi", + "Romanian", + "Rundi", + "Russian", + "SamoanLatin", + "SerbianCyrillic", + "SerbianLatin", + "Sesotho", + "SesothoSaLeboa", + "Setswana", + "Sindhi", + "Sinhala", + "Slovak", + "Slovenian", + "SomaliArabic", + "Spanish", + "SwahiliLatin", + "Swedish", + "Tahitian", + "Tamil", + "TatarLatin", + "Telugu", + "Thai", + "Tibetan", + "Tigrinya", + "Tongan", + "Turkish", + "TurkmenLatin", + "Ukrainian", + "UpperSorbian", + "Urdu", + "UyghurArabic", + "UzbekLatin", + "Vietnamese", + "Welsh", + "Xhosa", + "Yoruba", + "YucatecMaya", + "Zulu" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Source Language", + "description": "The language of the source file, select 'AUTO' to automatically detect" + }, + "targetLanguage": { + "enum": [ + "Afrikaans", + "Albanian", + "Amharic", + "Arabic", + "Armenian", + "Assamese", + "AzerbaijaniLatin", + "Bangla", + "Bashkir", + "Basque", + "Bhojpuri", + "Bodo", + "BosnianLatin", + "Bulgarian", + "CantoneseTraditional", + "Catalan", + "ChineseLiterary", + "ChineseSimplified", + "ChineseTraditional", + "ChiShona", + "Croatian", + "Czech", + "Danish", + "Dari", + "Divehi", + "Dogri", + "Dutch", + "English", + "Estonian", + "Faroese", + "Fijian", + "Filipino", + "Finnish", + "French", + "FrenchCanadian", + "Galician", + "Georgian", + "German", + "Greek", + "Gujarati", + "HaitianCreole", + "Hausa", + "Hebrew", + "Hindi", + "HmongDawLatin", + "Hungarian", + "Icelandic", + "Igbo", + "Indonesian", + "Inuinnaqtun", + "Inuktitut", + "InuktitutLatin", + "Irish", + "Italian", + "Japanese", + "Kannada", + "Kashmiri", + "Kazakh", + "Khmer", + "Kinyarwanda", + "Klingon", + "KlingonPlqaD", + "Konkani", + "Korean", + "KurdishCentral", + "KurdishNorthern", + "KyrgyzCyrillic", + "Lao", + "Latvian", + "Lithuanian", + "Lingala", + "LowerSorbian", + "Luganda", + "Macedonian", + "Maithili", + "Malagasy", + "MalayLatin", + "Malayalam", + "Maltese", + "Maori", + "Marathi", + "MongolianCyrillic", + "MongolianTraditional", + "Myanmar", + "Nepali", + "Norwegian", + "Nyanja", + "Odia", + "Pashto", + "Persian", + "Polish", + "PortugueseBrazil", + "PortuguesePortugal", + "Punjabi", + "QueretaroOtomi", + "Romanian", + "Rundi", + "Russian", + "SamoanLatin", + "SerbianCyrillic", + "SerbianLatin", + "Sesotho", + "SesothoSaLeboa", + "Setswana", + "Sindhi", + "Sinhala", + "Slovak", + "Slovenian", + "SomaliArabic", + "Spanish", + "SwahiliLatin", + "Swedish", + "Tahitian", + "Tamil", + "TatarLatin", + "Telugu", + "Thai", + "Tibetan", + "Tigrinya", + "Tongan", + "Turkish", + "TurkmenLatin", + "Ukrainian", + "UpperSorbian", + "Urdu", + "UyghurArabic", + "UzbekLatin", + "Vietnamese", + "Welsh", + "Xhosa", + "Yoruba", + "YucatecMaya", + "Zulu" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Target Language", + "description": "The language to convert the source file to" + } + } + }, + "DtoAITranslateText": { + "required": [ + "targetLanguage", + "text" + ], + "type": "object", + "properties": { + "text": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Text", + "description": "The text to translate" + }, + "sourceLanguage": { + "default": "AUTO", + "enum": [ + "AUTO", + "Afrikaans", + "Albanian", + "Amharic", + "Arabic", + "Armenian", + "Assamese", + "AzerbaijaniLatin", + "Bangla", + "Bashkir", + "Basque", + "Bhojpuri", + "Bodo", + "BosnianLatin", + "Bulgarian", + "CantoneseTraditional", + "Catalan", + "ChineseLiterary", + "ChineseSimplified", + "ChineseTraditional", + "ChiShona", + "Croatian", + "Czech", + "Danish", + "Dari", + "Divehi", + "Dogri", + "Dutch", + "English", + "Estonian", + "Faroese", + "Fijian", + "Filipino", + "Finnish", + "French", + "FrenchCanadian", + "Galician", + "Georgian", + "German", + "Greek", + "Gujarati", + "HaitianCreole", + "Hausa", + "Hebrew", + "Hindi", + "HmongDawLatin", + "Hungarian", + "Icelandic", + "Igbo", + "Indonesian", + "Inuinnaqtun", + "Inuktitut", + "InuktitutLatin", + "Irish", + "Italian", + "Japanese", + "Kannada", + "Kashmiri", + "Kazakh", + "Khmer", + "Kinyarwanda", + "Klingon", + "KlingonPlqaD", + "Konkani", + "Korean", + "KurdishCentral", + "KurdishNorthern", + "KyrgyzCyrillic", + "Lao", + "Latvian", + "Lithuanian", + "Lingala", + "LowerSorbian", + "Luganda", + "Macedonian", + "Maithili", + "Malagasy", + "MalayLatin", + "Malayalam", + "Maltese", + "Maori", + "Marathi", + "MongolianCyrillic", + "MongolianTraditional", + "Myanmar", + "Nepali", + "Norwegian", + "Nyanja", + "Odia", + "Pashto", + "Persian", + "Polish", + "PortugueseBrazil", + "PortuguesePortugal", + "Punjabi", + "QueretaroOtomi", + "Romanian", + "Rundi", + "Russian", + "SamoanLatin", + "SerbianCyrillic", + "SerbianLatin", + "Sesotho", + "SesothoSaLeboa", + "Setswana", + "Sindhi", + "Sinhala", + "Slovak", + "Slovenian", + "SomaliArabic", + "Spanish", + "SwahiliLatin", + "Swedish", + "Tahitian", + "Tamil", + "TatarLatin", + "Telugu", + "Thai", + "Tibetan", + "Tigrinya", + "Tongan", + "Turkish", + "TurkmenLatin", + "Ukrainian", + "UpperSorbian", + "Urdu", + "UyghurArabic", + "UzbekLatin", + "Vietnamese", + "Welsh", + "Xhosa", + "Yoruba", + "YucatecMaya", + "Zulu" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Source Language", + "description": "The language of the source text, select 'AUTO' to automatically detect" + }, + "targetLanguage": { + "enum": [ + "Afrikaans", + "Albanian", + "Amharic", + "Arabic", + "Armenian", + "Assamese", + "AzerbaijaniLatin", + "Bangla", + "Bashkir", + "Basque", + "Bhojpuri", + "Bodo", + "BosnianLatin", + "Bulgarian", + "CantoneseTraditional", + "Catalan", + "ChineseLiterary", + "ChineseSimplified", + "ChineseTraditional", + "ChiShona", + "Croatian", + "Czech", + "Danish", + "Dari", + "Divehi", + "Dogri", + "Dutch", + "English", + "Estonian", + "Faroese", + "Fijian", + "Filipino", + "Finnish", + "French", + "FrenchCanadian", + "Galician", + "Georgian", + "German", + "Greek", + "Gujarati", + "HaitianCreole", + "Hausa", + "Hebrew", + "Hindi", + "HmongDawLatin", + "Hungarian", + "Icelandic", + "Igbo", + "Indonesian", + "Inuinnaqtun", + "Inuktitut", + "InuktitutLatin", + "Irish", + "Italian", + "Japanese", + "Kannada", + "Kashmiri", + "Kazakh", + "Khmer", + "Kinyarwanda", + "Klingon", + "KlingonPlqaD", + "Konkani", + "Korean", + "KurdishCentral", + "KurdishNorthern", + "KyrgyzCyrillic", + "Lao", + "Latvian", + "Lithuanian", + "Lingala", + "LowerSorbian", + "Luganda", + "Macedonian", + "Maithili", + "Malagasy", + "MalayLatin", + "Malayalam", + "Maltese", + "Maori", + "Marathi", + "MongolianCyrillic", + "MongolianTraditional", + "Myanmar", + "Nepali", + "Norwegian", + "Nyanja", + "Odia", + "Pashto", + "Persian", + "Polish", + "PortugueseBrazil", + "PortuguesePortugal", + "Punjabi", + "QueretaroOtomi", + "Romanian", + "Rundi", + "Russian", + "SamoanLatin", + "SerbianCyrillic", + "SerbianLatin", + "Sesotho", + "SesothoSaLeboa", + "Setswana", + "Sindhi", + "Sinhala", + "Slovak", + "Slovenian", + "SomaliArabic", + "Spanish", + "SwahiliLatin", + "Swedish", + "Tahitian", + "Tamil", + "TatarLatin", + "Telugu", + "Thai", + "Tibetan", + "Tigrinya", + "Tongan", + "Turkish", + "TurkmenLatin", + "Ukrainian", + "UpperSorbian", + "Urdu", + "UyghurArabic", + "UzbekLatin", + "Vietnamese", + "Welsh", + "Xhosa", + "Yoruba", + "YucatecMaya", + "Zulu" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Target Language", + "description": "The language to convert the source 'Text' value to" + }, + "format": { + "default": "Text", + "enum": [ + "HTML", + "Text" + ], + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Format", + "description": "Set the format of the 'Text' value" + }, + "profanityAction": { + "default": "Keep", + "enum": [ + "Delete", + "Keep", + "Replace" + ], + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Profanity Action", + "description": "Define how to handle profanity detected within the 'Text' value" + }, + "profanityReplace": { + "default": "Asterisk", + "enum": [ + "Asterisk", + "Tag" + ], + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Profanity Replace", + "description": "Set the value used to replace profanity detected within the 'Text' value. This setting only applies when the 'Profanity Action' is set to 'Replace'" + } + } + }, + "DtoAITranslateTextMultiple": { + "required": [ + "targetLanguages", + "text" + ], + "type": "object", + "properties": { + "text": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Text", + "description": "The text to translate" + }, + "sourceLanguage": { + "default": "AUTO", + "enum": [ + "AUTO", + "Afrikaans", + "Albanian", + "Amharic", + "Arabic", + "Armenian", + "Assamese", + "AzerbaijaniLatin", + "Bangla", + "Bashkir", + "Basque", + "Bhojpuri", + "Bodo", + "BosnianLatin", + "Bulgarian", + "CantoneseTraditional", + "Catalan", + "ChineseLiterary", + "ChineseSimplified", + "ChineseTraditional", + "ChiShona", + "Croatian", + "Czech", + "Danish", + "Dari", + "Divehi", + "Dogri", + "Dutch", + "English", + "Estonian", + "Faroese", + "Fijian", + "Filipino", + "Finnish", + "French", + "FrenchCanadian", + "Galician", + "Georgian", + "German", + "Greek", + "Gujarati", + "HaitianCreole", + "Hausa", + "Hebrew", + "Hindi", + "HmongDawLatin", + "Hungarian", + "Icelandic", + "Igbo", + "Indonesian", + "Inuinnaqtun", + "Inuktitut", + "InuktitutLatin", + "Irish", + "Italian", + "Japanese", + "Kannada", + "Kashmiri", + "Kazakh", + "Khmer", + "Kinyarwanda", + "Klingon", + "KlingonPlqaD", + "Konkani", + "Korean", + "KurdishCentral", + "KurdishNorthern", + "KyrgyzCyrillic", + "Lao", + "Latvian", + "Lithuanian", + "Lingala", + "LowerSorbian", + "Luganda", + "Macedonian", + "Maithili", + "Malagasy", + "MalayLatin", + "Malayalam", + "Maltese", + "Maori", + "Marathi", + "MongolianCyrillic", + "MongolianTraditional", + "Myanmar", + "Nepali", + "Norwegian", + "Nyanja", + "Odia", + "Pashto", + "Persian", + "Polish", + "PortugueseBrazil", + "PortuguesePortugal", + "Punjabi", + "QueretaroOtomi", + "Romanian", + "Rundi", + "Russian", + "SamoanLatin", + "SerbianCyrillic", + "SerbianLatin", + "Sesotho", + "SesothoSaLeboa", + "Setswana", + "Sindhi", + "Sinhala", + "Slovak", + "Slovenian", + "SomaliArabic", + "Spanish", + "SwahiliLatin", + "Swedish", + "Tahitian", + "Tamil", + "TatarLatin", + "Telugu", + "Thai", + "Tibetan", + "Tigrinya", + "Tongan", + "Turkish", + "TurkmenLatin", + "Ukrainian", + "UpperSorbian", + "Urdu", + "UyghurArabic", + "UzbekLatin", + "Vietnamese", + "Welsh", + "Xhosa", + "Yoruba", + "YucatecMaya", + "Zulu" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Source Language", + "description": "The language of the source text, select 'AUTO' to automatically detect" + }, + "targetLanguages": { + "type": "array", + "items": { + "enum": [ + "Afrikaans", + "Albanian", + "Amharic", + "Arabic", + "Armenian", + "Assamese", + "AzerbaijaniLatin", + "Bangla", + "Bashkir", + "Basque", + "Bhojpuri", + "Bodo", + "BosnianLatin", + "Bulgarian", + "CantoneseTraditional", + "Catalan", + "ChineseLiterary", + "ChineseSimplified", + "ChineseTraditional", + "ChiShona", + "Croatian", + "Czech", + "Danish", + "Dari", + "Divehi", + "Dogri", + "Dutch", + "English", + "Estonian", + "Faroese", + "Fijian", + "Filipino", + "Finnish", + "French", + "FrenchCanadian", + "Galician", + "Georgian", + "German", + "Greek", + "Gujarati", + "HaitianCreole", + "Hausa", + "Hebrew", + "Hindi", + "HmongDawLatin", + "Hungarian", + "Icelandic", + "Igbo", + "Indonesian", + "Inuinnaqtun", + "Inuktitut", + "InuktitutLatin", + "Irish", + "Italian", + "Japanese", + "Kannada", + "Kashmiri", + "Kazakh", + "Khmer", + "Kinyarwanda", + "Klingon", + "KlingonPlqaD", + "Konkani", + "Korean", + "KurdishCentral", + "KurdishNorthern", + "KyrgyzCyrillic", + "Lao", + "Latvian", + "Lithuanian", + "Lingala", + "LowerSorbian", + "Luganda", + "Macedonian", + "Maithili", + "Malagasy", + "MalayLatin", + "Malayalam", + "Maltese", + "Maori", + "Marathi", + "MongolianCyrillic", + "MongolianTraditional", + "Myanmar", + "Nepali", + "Norwegian", + "Nyanja", + "Odia", + "Pashto", + "Persian", + "Polish", + "PortugueseBrazil", + "PortuguesePortugal", + "Punjabi", + "QueretaroOtomi", + "Romanian", + "Rundi", + "Russian", + "SamoanLatin", + "SerbianCyrillic", + "SerbianLatin", + "Sesotho", + "SesothoSaLeboa", + "Setswana", + "Sindhi", + "Sinhala", + "Slovak", + "Slovenian", + "SomaliArabic", + "Spanish", + "SwahiliLatin", + "Swedish", + "Tahitian", + "Tamil", + "TatarLatin", + "Telugu", + "Thai", + "Tibetan", + "Tigrinya", + "Tongan", + "Turkish", + "TurkmenLatin", + "Ukrainian", + "UpperSorbian", + "Urdu", + "UyghurArabic", + "UzbekLatin", + "Vietnamese", + "Welsh", + "Xhosa", + "Yoruba", + "YucatecMaya", + "Zulu" + ], + "type": "string" + }, + "x-ms-visibility": "important", + "x-ms-summary": "Target Languages", + "description": "The languages to convert the source 'Text' value to" + }, + "format": { + "default": "Text", + "enum": [ + "HTML", + "Text" + ], + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Format", + "description": "Set the format of the 'Text' value" + }, + "profanityAction": { + "default": "Keep", + "enum": [ + "Delete", + "Keep", + "Replace" + ], + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Profanity Action", + "description": "Define how to handle profanity detected within the 'Text' value" + }, + "profanityReplace": { + "default": "Asterisk", + "enum": [ + "Asterisk", + "Tag" + ], + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Profanity Replace", + "description": "Set the value used to replace profanity detected within the 'Text' value. This setting only applies when the 'Profanity Action' is set to 'Replace'" + } + } + }, "DtoAddAttachmentsToPdf": { "required": [ "attachments", @@ -10682,8 +12788,8 @@ }, "DtoAesDecryption": { "required": [ - "inputDataEncodingMethod", "data", + "inputDataEncodingMethod", "key", "mode" ], @@ -10701,7 +12807,10 @@ "BASE64", "HEX" ], - "type": "string" + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Input Type", + "description": "Set the data format of the encrypted string" }, "key": { "type": "string", @@ -10746,10 +12855,10 @@ }, "DtoAesEncryption": { "required": [ - "outputDataEncodingMethod", "data", "key", - "mode" + "mode", + "outputDataEncodingMethod" ], "type": "object", "properties": { @@ -10765,7 +12874,10 @@ "BASE64", "HEX" ], - "type": "string" + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Output Type", + "description": "Set the data format of the encrypted string" }, "key": { "type": "string", @@ -10916,6 +13028,40 @@ } } }, + "DtoArrayConvertToXml": { + "required": [ + "data", + "item", + "root" + ], + "type": "object", + "properties": { + "data": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Data", + "description": "An array or a JSON object to select an array for conversion to a XML object" + }, + "root": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Root Name", + "description": "The name of the root XML node" + }, + "item": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Item Name", + "description": "The name of the item node XML for each array item" + }, + "path": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Path", + "description": "Select a specific array within the 'Data' using a JSONPath expression" + } + } + }, "DtoArrayCountItems": { "required": [ "data" @@ -10926,7 +13072,7 @@ "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Data", - "description": "The JSON data to modify" + "description": "The JSON array or object to evaluate" }, "path": { "type": "string", @@ -10936,6 +13082,100 @@ } } }, + "DtoArrayFilterItems": { + "required": [ + "data", + "keywords", + "matchType" + ], + "type": "object", + "properties": { + "data": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Data", + "description": "The JSON data to filter" + }, + "keywords": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Keywords", + "description": "A comma-separated list of keywords used to filter the JSON data provided" + }, + "matchType": { + "default": "Any", + "enum": [ + "All", + "Any", + "None" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Match Type", + "description": "Set how items should be filtered using the keywords provided" + }, + "ignoreCase": { + "default": false, + "type": "boolean", + "x-ms-visibility": "advanced", + "x-ms-summary": "Ignore Case", + "description": "Set whether text case should be ignored when filtering items" + }, + "path": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Path", + "description": "Select a specific node within the 'Data' using a JSONPath expression" + } + } + }, + "DtoArrayFilterItemsViaRegex": { + "required": [ + "data", + "matchType", + "regex" + ], + "type": "object", + "properties": { + "data": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Data", + "description": "The JSON data to filter" + }, + "regex": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Regex", + "description": "The regular expression used to find and filter matches in the 'Data' provided" + }, + "matchType": { + "default": "Any", + "enum": [ + "All", + "Any", + "None" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Match Type", + "description": "Set how items should be filtered using the keywords provided" + }, + "ignoreCase": { + "default": false, + "type": "boolean", + "x-ms-visibility": "advanced", + "x-ms-summary": "Ignore Case", + "description": "Set whether text case should be ignored when filtering items" + }, + "path": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Path", + "description": "Select a specific node within the 'Data' using a JSONPath expression" + } + } + }, "DtoArrayGetItems": { "required": [ "data", @@ -11081,7 +13321,7 @@ "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Data", - "description": "The JSON data to evaluate" + "description": "The JSON data to modify" }, "searchValue": { "type": "string", @@ -11123,6 +13363,88 @@ } } }, + "DtoArraySortItems": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Data", + "description": "The JSON array or object to evaluate" + }, + "sortType": { + "default": "Alphabetic", + "enum": [ + "Alphabetic", + "Numeric" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Sort Type", + "description": "Set whether the data should be sorted numerically or alphabetically" + }, + "sortOrder": { + "default": "Ascending", + "enum": [ + "Ascending", + "Descending" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Sort Order", + "description": "Set whether the data should be sorted in Ascending or Descending order" + }, + "path": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Path", + "description": "Select a specific node within the 'Data' using a JSONPath expression" + } + } + }, + "DtoArraySplitItems": { + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Data", + "description": "The JSON data to modify" + }, + "splitValue": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Split Value", + "description": "Optional - Search the array for and split on the value provided" + }, + "itemIndex": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "important", + "x-ms-summary": "Item Index", + "description": "Optional - Set the 'Index' of the item to split on" + }, + "ignoreCase": { + "default": false, + "type": "boolean", + "x-ms-visibility": "advanced", + "x-ms-summary": "Ignore Case", + "description": "Set whether the text case should be ignored when executing the split" + }, + "path": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Path", + "description": "Select a specific node within the 'Data' using a JSONPath expression" + } + } + }, "DtoBaseMgmtResponse": { "type": "object", "properties": { @@ -11211,6 +13533,54 @@ } } }, + "DtoBaseMgmtResponseFileOnlyWatermark": { + "type": "object", + "properties": { + "watermarkId": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "important", + "x-ms-summary": "Watermark ID", + "description": "The identifier applied to the watermark" + }, + "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": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "OperationStatus": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + }, + "FileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The processed document." + } + } + }, "DtoBasicConversion": { "required": [ "fileContent", @@ -12508,6 +14878,33 @@ } } }, + "DtoConvertJsonToXml": { + "required": [ + "json" + ], + "type": "object", + "properties": { + "json": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "JSON", + "description": "The JSON to convert to XML" + }, + "rootName": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Root Name", + "description": "Set the name of the the 'Root' XML element" + }, + "includeArrayAttribute": { + "default": false, + "type": "boolean", + "x-ms-visibility": "advanced", + "x-ms-summary": "Include Array Attribute", + "description": "Set whether to include an array attribute for collections" + } + } + }, "DtoConvertMailMessage": { "required": [ "fileContent", @@ -14203,6 +16600,27 @@ } } }, + "DtoConvertXmlToJson": { + "required": [ + "xml" + ], + "type": "object", + "properties": { + "xml": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "XML", + "description": "The XML to convert to JSON" + }, + "omitRootObject": { + "default": false, + "type": "boolean", + "x-ms-visibility": "advanced", + "x-ms-summary": "Omit Root Object", + "description": "Set whether the root object should be omitted" + } + } + }, "DtoCreateBarcode": { "required": [ "dotCodemask" @@ -15304,6 +17722,99 @@ } } }, + "DtoCreateJwt": { + "required": [ + "key", + "securityAlgorithm" + ], + "type": "object", + "properties": { + "claims": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Claims", + "description": "Set the 'Claims' to be added to the JWT" + }, + "securityAlgorithm": { + "default": "HmacSha256", + "enum": [ + "HmacSha256Signature", + "HmacSha384Signature", + "HmacSha512Signature", + "HmacSha256", + "HmacSha384", + "HmacSha512", + "RsaSha256Signature", + "RsaSha384Signature", + "RsaSha512Signature", + "RsaSha256", + "RsaSha384", + "RsaSha512", + "Es256", + "Es384", + "Es512", + "Es256Signature", + "Es384Signature", + "Es512Signature" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Algorithm", + "description": "Set the JWT security algorithm to use: HmacSha*, RsaSha*, Es*" + }, + "key": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Key", + "description": "Set the JWT key to be used within the selected algorithm" + }, + "issuer": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Issuer", + "description": "The issuer of the JWT" + }, + "subject": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Subject", + "description": "The subject of the JWT (the user)" + }, + "audience": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Audience", + "description": "The recipient for which the JWT is intended" + }, + "expirationTime": { + "format": "int64", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "Expiration Time", + "description": "The time after which the JWT expires (Unix TimeStamp)" + }, + "notBeforeTime": { + "format": "int64", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "Before Time", + "description": "The time before which the JWT must not be accepted for processing (Unix TimeStamp)" + }, + "issuedAtTime": { + "format": "int64", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "IssuedTime", + "description": "The time at which the JWT was issued; can be used to determine age of the JWT (Unix TimeStamp)" + }, + "uniqueIdentifier": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Unique Identifier", + "description": "The unique identifier; can be used to prevent the JWT from being replayed (allows a token to be used only once)" + } + } + }, "DtoCreateQrCode": { "required": [ "barcodeData", @@ -15856,6 +18367,48 @@ } } }, + "DtoCreateRsaKeyPair": { + "required": [ + "addHeaderAndFooter", + "keySize", + "privateKeyFormat" + ], + "type": "object", + "properties": { + "keySize": { + "default": "Size1024", + "enum": [ + "Size512", + "Size1024", + "Size2048", + "Size3072", + "Size4096" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Key Size", + "description": "Set the key size" + }, + "privateKeyFormat": { + "default": "PKCS8", + "enum": [ + "PKCS1", + "PKCS8" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Key Format", + "description": "Set the private key format" + }, + "addHeaderAndFooter": { + "default": false, + "type": "boolean", + "x-ms-visibility": "advanced", + "x-ms-summary": "Add Header and Footer", + "description": "Set whether the header and footer should be added" + } + } + }, "DtoCropImage": { "required": [ "cropType", @@ -15947,6 +18500,68 @@ } } }, + "DtoDeleteExcelWorksheets": { + "required": [ + "fileContent" + ], + "type": "object", + "properties": { + "fileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The file content of the source Microsoft Excel file" + }, + "worksheetNames": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Worksheet Names", + "description": "A comma separated list of the names of the worksheets to extract: Sales, Totals, Year to Date" + }, + "worksheetIndexes": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Worksheet Indexes", + "description": "A comma separated list of indexes of the worksheets to extract: 1,3,4" + } + } + }, + "DtoDeletePdfPages": { + "required": [ + "fileContent" + ], + "type": "object", + "properties": { + "fileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The file content of the source PDF file" + }, + "StartPage": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "important", + "x-ms-summary": "Start Page", + "description": "Set the page number to begin deleting pages from" + }, + "EndPage": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "important", + "x-ms-summary": "End Page", + "description": "Set the page number to stop deleting pages on. The default value is set to the last page of the PDF document provided" + }, + "pageNumbers": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Page Numbers", + "description": "A comma separated list of page numbers of the pages to delete: 1,3,4" + } + } + }, "DtoDeleteRowsFromExcel": { "required": [ "fileContent" @@ -16099,6 +18714,174 @@ } } }, + "DtoExcelWatermarkText": { + "required": [ + "columnPosition", + "fileContent", + "height", + "rowPosition", + "text", + "width" + ], + "type": "object", + "properties": { + "fileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The file content of the source Microsoft Excel file" + }, + "text": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Text", + "description": "The text to embed as a watermark within the Microsoft Excel file" + }, + "rowPosition": { + "format": "int32", + "default": 1, + "type": "integer", + "x-ms-visibility": "important", + "x-ms-summary": "Row Position", + "description": "Set the numeric row that the watermark should be inserted from" + }, + "columnPosition": { + "format": "int32", + "default": 1, + "type": "integer", + "x-ms-visibility": "important", + "x-ms-summary": "Column Position", + "description": "Set the numeric column that the watermark should be inserted from" + }, + "height": { + "format": "int32", + "default": 100, + "type": "integer", + "x-ms-visibility": "important", + "x-ms-summary": "Container Height", + "description": "Set the height of the container which contains the watermark text (in pixels)" + }, + "width": { + "format": "int32", + "default": 800, + "type": "integer", + "x-ms-visibility": "important", + "x-ms-summary": "Container Width", + "description": "Set the width of the container which contains the watermark text (in pixels)" + }, + "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)" + }, + "italic": { + "default": false, + "type": "boolean", + "x-ms-visibility": "advanced", + "x-ms-summary": "Italic", + "description": "Set whether to apply the 'Italic' format to the text" + }, + "bold": { + "default": false, + "type": "boolean", + "x-ms-visibility": "advanced", + "x-ms-summary": "Bold", + "description": "Set whether to apply the 'Bold' format to the text" + }, + "opacity": { + "format": "float", + "default": 0.7, + "type": "number", + "x-ms-visibility": "advanced", + "x-ms-summary": "Opacity", + "description": "The opacity of the text watermark, valid values range from 0 to 1 (Hidden), the default value is 0.7" + }, + "rotationAngle": { + "format": "float", + "default": 0, + "type": "number", + "x-ms-visibility": "advanced", + "x-ms-summary": "Rotation Angle", + "description": "Set the rotation angle of the watermark in degrees" + }, + "worksheetNames": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Worksheet Names", + "description": "A comma separated list of the names of the worksheets to add the watermark to: Sales, Totals, Year to Date" + }, + "worksheetIndexes": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Worksheet Indexes", + "description": "A comma separated list of indexes of the worksheets to add the watermark to: 1,3,4" + }, + "watermarkId": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "Watermark ID", + "description": "Override and manually set an identifier for the applied watermark" + }, + "cultureName": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Culture Name", + "description": "Change the thread culture used to process the request." + } + } + }, + "DtoExcelWatermarkTextRemove": { + "required": [ + "fileContent", + "watermarkId" + ], + "type": "object", + "properties": { + "fileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The file content of the source Microsoft Excel file" + }, + "watermarkId": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "important", + "x-ms-summary": "Watermark ID", + "description": "The watermark identifier of the watermark to remove, as provided by the Encodian 'Excel - Add Text Watermark' action" + }, + "worksheetNames": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Worksheet Names", + "description": "A comma separated list of the names of the worksheets to remove the watermark from: Sales, Totals, Year to Date" + }, + "worksheetIndexes": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Worksheet Indexes", + "description": "A comma separated list of indexes of the worksheets to remove the watermark from: 1,3,4" + }, + "cultureName": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Culture Name", + "description": "Change the thread culture used to process the request." + } + } + }, "DtoExtractAllTextInstancesBetweenValues": { "required": [ "text" @@ -16289,6 +19072,41 @@ } } }, + "DtoExtractPdfPages": { + "required": [ + "fileContent" + ], + "type": "object", + "properties": { + "fileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The file content of the source PDF file" + }, + "StartPage": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "important", + "x-ms-summary": "Start Page", + "description": "Set the page number to begin extracting pages from" + }, + "EndPage": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "important", + "x-ms-summary": "End Page", + "description": "Set the page number to stop extracting pages on. The default value is set to the last page of the PDF document provided" + }, + "pageNumbers": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Page Numbers", + "description": "A comma separated list of page numbers of the pages to extract: 1,3,4" + } + } + }, "DtoExtractTextBetweenValues": { "required": [ "text" @@ -19355,6 +22173,13 @@ "x-ms-visibility": "advanced", "x-ms-summary": "Content Filter", "description": "Set that only table cells which match the specified type will be parsed" + }, + "generateHeaders": { + "default": false, + "type": "boolean", + "x-ms-visibility": "advanced", + "x-ms-summary": "Generate Headers ", + "description": "When table header tags () are not present, generate headers using the first row ()" } } }, @@ -20481,6 +23306,141 @@ } } }, + "DtoResponseAITranslateFile": { + "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": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "OperationStatus": { + "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." + } + } + }, + "DtoResponseAITranslateText": { + "type": "object", + "properties": { + "translation": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Translation", + "description": "The translated text" + }, + "HttpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "HttpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "OperationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "Errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "OperationStatus": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, + "DtoResponseAITranslateTextMultiple": { + "type": "object", + "properties": { + "translations": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Translations", + "description": "The translated text as JSON" + }, + "HttpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "HttpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "OperationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "Errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "OperationStatus": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, "DtoResponseAddAttachmentsToPdf": { "type": "object", "properties": { @@ -21333,6 +24293,51 @@ } } }, + "DtoResponseArrayConvertToXml": { + "type": "object", + "properties": { + "result": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Result", + "description": "The response value for the request" + }, + "httpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "httpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "operationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "operationStatus": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, "DtoResponseArrayCountItems": { "type": "object", "properties": { @@ -21379,6 +24384,96 @@ } } }, + "DtoResponseArrayFilterItems": { + "type": "object", + "properties": { + "result": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Result", + "description": "The response value for the request" + }, + "httpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "httpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "operationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "operationStatus": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, + "DtoResponseArrayFilterItemsViaRegex": { + "type": "object", + "properties": { + "result": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Result", + "description": "The response value for the request" + }, + "httpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "httpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "operationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "operationStatus": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, "DtoResponseArrayGetItems": { "type": "object", "properties": { @@ -21649,6 +24744,96 @@ } } }, + "DtoResponseArraySortItems": { + "type": "object", + "properties": { + "result": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Result", + "description": "The response value for the request" + }, + "httpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "httpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "operationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "operationStatus": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, + "DtoResponseArraySplitItems": { + "type": "object", + "properties": { + "result": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Result", + "description": "The response value for the request" + }, + "httpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "httpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "operationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "operationStatus": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, "DtoResponseBasicConversion": { "type": "object", "properties": { @@ -22158,6 +25343,51 @@ } } }, + "DtoResponseConvertJsonToXml": { + "type": "object", + "properties": { + "result": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Result", + "description": "The response value for the request" + }, + "httpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "httpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "operationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "operationStatus": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, "DtoResponseConvertMailMessage": { "type": "object", "properties": { @@ -22676,6 +25906,51 @@ } } }, + "DtoResponseConvertXmlToJson": { + "type": "object", + "properties": { + "result": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Result", + "description": "The response value for the request" + }, + "httpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "httpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "operationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "operationStatus": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, "DtoResponseCreateBarcode": { "type": "object", "properties": { @@ -22862,6 +26137,51 @@ } } }, + "DtoResponseCreateJwt": { + "type": "object", + "properties": { + "result": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Result", + "description": "The response value for the request" + }, + "httpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "httpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "operationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "operationStatus": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, "DtoResponseCreateQrCode": { "type": "object", "properties": { @@ -22909,6 +26229,51 @@ } } }, + "DtoResponseCreateRsaKeyPair": { + "type": "object", + "properties": { + "result": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Result", + "description": "The response value for the request" + }, + "httpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "httpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "operationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "operationStatus": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, "DtoResponseCropImage": { "type": "object", "properties": { @@ -22950,6 +26315,88 @@ } } }, + "DtoResponseDeleteExcelWorksheets": { + "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": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "OperationStatus": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + }, + "FileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The processed document." + } + } + }, + "DtoResponseDeletePdfPages": { + "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": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "OperationStatus": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + }, + "FileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The processed document." + } + } + }, "DtoResponseDeleteRowsFromExcel": { "type": "object", "properties": { @@ -23177,6 +26624,95 @@ } } }, + "DtoResponseExcelWatermarkText": { + "type": "object", + "properties": { + "watermarkId": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "important", + "x-ms-summary": "Watermark ID", + "description": "The identifier applied to the watermark" + }, + "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": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "OperationStatus": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + }, + "FileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The processed document." + } + } + }, + "DtoResponseExcelWatermarkTextRemove": { + "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": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "OperationStatus": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + }, + "FileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The processed document." + } + } + }, "DtoResponseExtractAllTextInstancesBetweenValues": { "type": "object", "properties": { @@ -23517,6 +27053,47 @@ } } }, + "DtoResponseExtractPdfPages": { + "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": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "OperationStatus": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + }, + "FileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The processed document." + } + } + }, "DtoResponseExtractTextBetweenValues": { "type": "object", "properties": { @@ -26784,6 +30361,96 @@ } } }, + "DtoResponseRsaDecryption": { + "type": "object", + "properties": { + "result": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Result", + "description": "The response value for the request" + }, + "httpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "httpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "operationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "operationStatus": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, + "DtoResponseRsaEncryption": { + "type": "object", + "properties": { + "result": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Result", + "description": "The response value for the request" + }, + "httpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "httpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "operationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "operationStatus": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, "DtoResponseSearchAndReplaceHyperlink": { "type": "object", "properties": { @@ -26925,6 +30592,47 @@ } } }, + "DtoResponseSecureExcel": { + "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": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "OperationStatus": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + }, + "FileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The processed document." + } + } + }, "DtoResponseSecurePdf": { "type": "object", "properties": { @@ -27261,6 +30969,56 @@ } } }, + "DtoResponseSplitWordDocument": { + "required": [ + "documents" + ], + "type": "object", + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/DocumentArray" + }, + "x-ms-visibility": "important", + "x-ms-summary": "Documents", + "description": "The array of documents to be processed" + }, + "HttpStatusCode": { + "format": "int32", + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Code", + "description": "The HTTP Status code for the response." + }, + "HttpStatusMessage": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "HTTP Status Message", + "description": "The HTTP Status message for the response." + }, + "OperationId": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Operation ID", + "description": "The unique ID assigned to this operation." + }, + "Errors": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-visibility": "advanced", + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "OperationStatus": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + } + } + }, "DtoResponseTextContainsValue": { "type": "object", "properties": { @@ -27443,6 +31201,47 @@ } } }, + "DtoResponseUnlockExcel": { + "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": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-summary": "Errors", + "description": "An array of error messages should an error occur." + }, + "OperationStatus": { + "type": "string", + "x-ms-summary": "Operation Status", + "description": "Indicates whether the operation has completed, has been queued or has failed." + }, + "FileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The processed document." + } + } + }, "DtoResponseUnlockPdf": { "type": "object", "properties": { @@ -28089,6 +31888,144 @@ } } }, + "DtoRsaDecryption": { + "required": [ + "data", + "key", + "keyType", + "mode", + "rsaInputDataType" + ], + "type": "object", + "properties": { + "data": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Data", + "description": "The cipher (string) to decrypt" + }, + "rsaInputDataType": { + "default": "BASE64", + "enum": [ + "BASE64", + "HEX" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Input Type", + "description": "Set the data format of the encrypted string" + }, + "mode": { + "default": "RSA", + "enum": [ + "RSA", + "RSA_PKCS1_PADDING", + "RSA_OAEP_PADDING" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Mode", + "description": "Set the RSA encryption algorithm" + }, + "keyType": { + "default": "PRIVATE", + "enum": [ + "PUBLIC", + "PRIVATE" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Key Type", + "description": "Set the type of key used within the algorithm" + }, + "privateKeyFormat": { + "default": "PKCS8", + "enum": [ + "PKCS1", + "PKCS8" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Private Key Format", + "description": "Set the private key format" + }, + "key": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Key", + "description": "Set the key used within the algorithm" + } + } + }, + "DtoRsaEncryption": { + "required": [ + "data", + "key", + "keyType", + "mode", + "rsaOutputDataType" + ], + "type": "object", + "properties": { + "data": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Data", + "description": "The input string to encrypt" + }, + "rsaOutputDataType": { + "default": "BASE64", + "enum": [ + "BASE64", + "HEX" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Output Type", + "description": "Set the data format of the encrypted string" + }, + "mode": { + "default": "RSA", + "enum": [ + "RSA", + "RSA_PKCS1_PADDING", + "RSA_OAEP_PADDING" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Mode", + "description": "Set the RSA encryption algorithm" + }, + "keyType": { + "default": "PUBLIC", + "enum": [ + "PUBLIC", + "PRIVATE" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Key Type", + "description": "Set the type of key used within the algorithm" + }, + "privateKeyFormat": { + "default": "PKCS8", + "enum": [ + "PKCS1", + "PKCS8" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Private Key Format", + "description": "Set the private key format" + }, + "key": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Key", + "description": "Set the key used within the algorithm" + } + } + }, "DtoSearchAndReplaceHyperlink": { "required": [ "fileContent", @@ -28284,6 +32221,84 @@ } } }, + "DtoSecureExcel": { + "required": [ + "fileContent" + ], + "type": "object", + "properties": { + "fileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The file content of the source Microsoft Excel file" + }, + "secureOnOpenPassword": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Secure on Open Password", + "description": "Set the password used to open the Microsoft Excel file" + }, + "workbookProtectionType": { + "default": "None", + "enum": [ + "All", + "Structure", + "Windows", + "None" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Workbook Protection Type", + "description": "Set the protection type to apply to the Excel Workbook" + }, + "workbookProtectionPassword": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Workbook Protection Password", + "description": "Set the password used to protect the Excel Workbook" + }, + "worksheetProtectionType": { + "default": "None", + "enum": [ + "All", + "Contents", + "Objects", + "Scenarios", + "None" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Worksheet Protection Type", + "description": "Set the protection type to apply to the Excel worksheets" + }, + "worksheetProtectionPassword": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Worksheet Protection Password", + "description": "Set the password used to protect the specified Excel worksheets (All by default)" + }, + "worksheetNames": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Worksheet Names", + "description": "A comma separated list of the names of the worksheets to protect: Sales, Totals, Year to Date" + }, + "worksheetIndexes": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Worksheet Indexes", + "description": "A comma separated list of indexes of the worksheets to protect: 1,3,4" + }, + "cultureName": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Culture Name", + "description": "Change the thread culture used to process the request." + } + } + }, "DtoSecurePdf": { "required": [ "FileName", @@ -29257,6 +33272,54 @@ } } }, + "DtoSplitWordDocument": { + "required": [ + "fileContent", + "fileName", + "splitType" + ], + "type": "object", + "properties": { + "fileName": { + "type": "string", + "x-ms-visibility": "important", + "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-visibility": "important", + "x-ms-summary": "File Content", + "description": "The file content of the Microsoft Word file" + }, + "splitType": { + "default": "AllPages", + "enum": [ + "AllPages", + "Array", + "NumberOfPages", + "Section" + ], + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Split Type", + "description": "Select how to split the file" + }, + "splitConfiguration": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Split Configuration", + "description": "Provide a split configuration" + }, + "cultureName": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Culture Name", + "description": "Change the thread culture used to process the request" + } + } + }, "DtoTextContainsValue": { "required": [ "text", @@ -29408,6 +33471,57 @@ } } }, + "DtoUnlockExcel": { + "required": [ + "fileContent" + ], + "type": "object", + "properties": { + "fileContent": { + "format": "byte", + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "File Content", + "description": "The file content of the source Microsoft Excel file" + }, + "secureOnOpenPassword": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Secure on Open Password", + "description": "Set the password used to open the Microsoft Excel file" + }, + "workbookProtectionPassword": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Workbook Protection Password", + "description": "Set the password used to remove protection from the Excel Workbook" + }, + "worksheetProtectionPassword": { + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Worksheet Protection Password", + "description": "Set the password used to remove protection from the specified Excel worksheets (All by default)" + }, + "worksheetNames": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Worksheet Names", + "description": "A comma separated list of the names of the worksheets to remove protection from: Sales, Totals, Year to Date" + }, + "worksheetIndexes": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Worksheet Indexes", + "description": "A comma separated list of indexes of the worksheets to remove protection from: 1,3,4" + }, + "cultureName": { + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Culture Name", + "description": "Change the thread culture used to process the request." + } + } + }, "DtoUnlockPdf": { "required": [ "FileName",