GoCloudmersiveDocumentConvertApiClient

package module
v0.0.0-...-5fa4010 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 11, 2023 License: Apache-2.0 Imports: 21 Imported by: 0

README ¶

Go API client for GoCloudmersiveDocumentConvertApiClient

Convert API lets you effortlessly convert file formats and types.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: v1
  • Package version: 3.3.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./GoCloudmersiveDocumentConvertApiClient"

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

Class Method HTTP request Description
CompareDocumentApi CompareDocumentDocx Post /convert/compare/docx Compare Two Word DOCX
ConvertDataApi ConvertDataCsvToJson Post /convert/csv/to/json Convert CSV to JSON conversion
ConvertDataApi ConvertDataCsvToXml Post /convert/csv/to/xml Convert CSV to XML conversion
ConvertDataApi ConvertDataJsonStringToXml Post /convert/json-string/to/xml Convert JSON String to XML conversion
ConvertDataApi ConvertDataJsonToXml Post /convert/json/to/xml Convert JSON Object to XML conversion
ConvertDataApi ConvertDataXlsToJson Post /convert/xls/to/json Convert Excel (97-2003) XLS to JSON conversion
ConvertDataApi ConvertDataXlsxToJson Post /convert/xlsx/to/json Convert Excel XLSX to JSON conversion
ConvertDataApi ConvertDataXlsxToXml Post /convert/xlsx/to/xml Convert Excel XLSX to XML conversion
ConvertDataApi ConvertDataXmlEditAddAttributeWithXPath Post /convert/xml/edit/xpath/add-attribute Adds an attribute to all XML nodes matching XPath expression
ConvertDataApi ConvertDataXmlEditAddChildWithXPath Post /convert/xml/edit/xpath/add-child Adds an XML node as a child to XML nodes matching XPath expression
ConvertDataApi ConvertDataXmlEditRemoveAllChildNodesWithXPath Post /convert/xml/edit/xpath/remove-all-children Removes, deletes all children of nodes matching XPath expression, but does not remove the nodes
ConvertDataApi ConvertDataXmlEditReplaceWithXPath Post /convert/xml/edit/xpath/replace Replaces XML nodes matching XPath expression with new node
ConvertDataApi ConvertDataXmlEditSetValueWithXPath Post /convert/xml/edit/xpath/set-value Sets the value contents of XML nodes matching XPath expression
ConvertDataApi ConvertDataXmlFilterWithXPath Post /convert/xml/select/xpath Filter, select XML nodes using XPath expression, get results
ConvertDataApi ConvertDataXmlQueryWithXQuery Post /convert/xml/query/xquery Query an XML file using XQuery query, get results
ConvertDataApi ConvertDataXmlQueryWithXQueryMulti Post /convert/xml/query/xquery/multi Query multiple XML files using XQuery query, get results
ConvertDataApi ConvertDataXmlRemoveWithXPath Post /convert/xml/edit/xpath/remove Remove, delete XML nodes and items matching XPath expression
ConvertDataApi ConvertDataXmlToJson Post /convert/xml/to/json Convert XML to JSON conversion
ConvertDataApi ConvertDataXmlTransformWithXsltToXml Post /convert/xml/transform/xslt/to/xml Transform XML document file with XSLT into a new XML document
ConvertDocumentApi ConvertDocumentAutodetectGetInfo Post /convert/autodetect/get-info Get document type information
ConvertDocumentApi ConvertDocumentAutodetectToJpg Post /convert/autodetect/to/jpg Convert Document to JPG/JPEG image array
ConvertDocumentApi ConvertDocumentAutodetectToPdf Post /convert/autodetect/to/pdf Convert Document to PDF
ConvertDocumentApi ConvertDocumentAutodetectToPdfBatchJob Post /convert/autodetect/to/pdf/batch-job Convert Document to PDF as Batch Job
ConvertDocumentApi ConvertDocumentAutodetectToPngArray Post /convert/autodetect/to/png Convert Document to PNG array
ConvertDocumentApi ConvertDocumentAutodetectToThumbnail Post /convert/autodetect/to/thumbnail Convert File to Thumbnail Image
ConvertDocumentApi ConvertDocumentAutodetectToThumbnailsAdvanced Post /convert/autodetect/to/thumbnail/advanced Convert File to Thumbnail Image Object
ConvertDocumentApi ConvertDocumentAutodetectToTxt Post /convert/autodetect/to/txt Convert Document to Text (txt)
ConvertDocumentApi ConvertDocumentCsvMultiToXlsx Post /convert/csv/multi/to/xlsx Convert Multiple CSV Files into a Single XLSX Spreadsheet
ConvertDocumentApi ConvertDocumentCsvToHtml Post /convert/csv/to/html Convert CSV to HTML document
ConvertDocumentApi ConvertDocumentCsvToPdf Post /convert/csv/to/pdf Convert CSV to PDF document
ConvertDocumentApi ConvertDocumentCsvToXlsx Post /convert/csv/to/xlsx Convert CSV to Excel XLSX Spreadsheet
ConvertDocumentApi ConvertDocumentDocToDocx Post /convert/doc/to/docx Convert Word DOC (97-03) Document to DOCX
ConvertDocumentApi ConvertDocumentDocToPdf Post /convert/doc/to/pdf Convert Word DOC (97-03) Document to PDF
ConvertDocumentApi ConvertDocumentDocToTxt Post /convert/doc/to/txt Convert Word DOC (97-03) Document to Text (txt)
ConvertDocumentApi ConvertDocumentDocxToDoc Post /convert/docx/to/doc Convert Word DOCX Document to Legacy Word DOC (97-03)
ConvertDocumentApi ConvertDocumentDocxToHtml Post /convert/docx/to/html Convert Word DOCX Document to HTML Document
ConvertDocumentApi ConvertDocumentDocxToJpg Post /convert/docx/to/jpg Convert Word DOCX Document to JPG/JPEG image array
ConvertDocumentApi ConvertDocumentDocxToPdf Post /convert/docx/to/pdf Convert Word DOCX Document to PDF
ConvertDocumentApi ConvertDocumentDocxToPng Post /convert/docx/to/png Convert Word DOCX Document to PNG image array
ConvertDocumentApi ConvertDocumentDocxToRtf Post /convert/docx/to/rtf Convert Word DOCX Document to RTF
ConvertDocumentApi ConvertDocumentDocxToTxt Post /convert/docx/to/txt Convert Word DOCX Document to Text (txt)
ConvertDocumentApi ConvertDocumentEmlToHtml Post /convert/eml/to/html Convert Email EML file to HTML string
ConvertDocumentApi ConvertDocumentEmlToJpg Post /convert/eml/to/jpg Convert Email EML file to JPG/JPEG image array
ConvertDocumentApi ConvertDocumentEmlToPdf Post /convert/eml/to/pdf Convert Email EML file to PDF document
ConvertDocumentApi ConvertDocumentEmlToPng Post /convert/eml/to/png Convert Email EML file to PNG image array
ConvertDocumentApi ConvertDocumentGetAsyncJobStatus Get /convert/batch-job/status Get the status and result of a Convert Document Batch Job
ConvertDocumentApi ConvertDocumentGetFileTypeIcon Post /convert/autodetect/get-icon Get PNG icon file for the file extension
ConvertDocumentApi ConvertDocumentGetFileTypeIconAdvanced Post /convert/autodetect/get-icon/advanced Get PNG icon byte array for the file extension
ConvertDocumentApi ConvertDocumentHtmlToPdf Post /convert/html/to/pdf Convert HTML document file to PDF Document
ConvertDocumentApi ConvertDocumentHtmlToPng Post /convert/html/to/png Convert HTML document file to PNG image array
ConvertDocumentApi ConvertDocumentHtmlToTxt Post /convert/html/to/txt HTML Document file to Text (txt)
ConvertDocumentApi ConvertDocumentKeynoteToJpg Post /convert/key/to/jpg Convert Keynote Presentation (KEY) to JPG/JPEG image array
ConvertDocumentApi ConvertDocumentKeynoteToPdf Post /convert/key/to/pdf Convert Keynote Presentation (KEY) to PDF
ConvertDocumentApi ConvertDocumentKeynoteToPng Post /convert/key/to/png Convert Keynote Presentation (KEY) to PNG image array
ConvertDocumentApi ConvertDocumentKeynoteToPptx Post /convert/key/to/pptx Convert Keynote Presentation (KEY) to PPTX
ConvertDocumentApi ConvertDocumentMsgToHtml Post /convert/msg/to/html Convert Email MSG file to HTML string
ConvertDocumentApi ConvertDocumentMsgToJpg Post /convert/msg/to/jpg Convert Email MSG file to JPG/JPEG image array
ConvertDocumentApi ConvertDocumentMsgToPdf Post /convert/msg/to/pdf Convert Email MSG file to PDF document
ConvertDocumentApi ConvertDocumentMsgToPng Post /convert/msg/to/png Convert Email MSG file to PNG image array
ConvertDocumentApi ConvertDocumentOdpToJpg Post /convert/odp/to/jpg Convert ODP Presentation to JPG/JPEG image array
ConvertDocumentApi ConvertDocumentOdpToPdf Post /convert/odp/to/pdf Convert ODP Presentation to PDF
ConvertDocumentApi ConvertDocumentOdpToPng Post /convert/odp/to/png Convert ODP Presentation to PNG image array
ConvertDocumentApi ConvertDocumentOdpToPptx Post /convert/odp/to/pptx Convert ODP Presentation to PPTX
ConvertDocumentApi ConvertDocumentOdsToJpg Post /convert/ods/to/jpg Convert ODS Spreadsheet to JPG/JPEG image array
ConvertDocumentApi ConvertDocumentOdsToPdf Post /convert/ods/to/pdf Convert ODS Spreadsheet to PDF
ConvertDocumentApi ConvertDocumentOdsToPng Post /convert/ods/to/png Convert ODS Spreadsheet to PNG image array
ConvertDocumentApi ConvertDocumentOdsToXlsx Post /convert/ods/to/xlsx Convert ODS Spreadsheet to XLSX
ConvertDocumentApi ConvertDocumentOdtToDocx Post /convert/odt/to/docx Convert ODT Text File to Word DOCX
ConvertDocumentApi ConvertDocumentOdtToJpg Post /convert/odt/to/jpg Convert ODT Text File to JPG/JPEG image array
ConvertDocumentApi ConvertDocumentOdtToPdf Post /convert/odt/to/pdf Convert ODT Text File to PDF
ConvertDocumentApi ConvertDocumentOdtToPng Post /convert/odt/to/png Convert ODT Text File to PNG image array
ConvertDocumentApi ConvertDocumentPdfToDocx Post /convert/pdf/to/docx Convert PDF to Word DOCX Document
ConvertDocumentApi ConvertDocumentPdfToDocxRasterize Post /convert/pdf/to/docx/rasterize Convert PDF to Word DOCX Document based on rasterized version of the PDF
ConvertDocumentApi ConvertDocumentPdfToJpg Post /convert/pdf/to/jpg Convert PDF to JPG/JPEG image array
ConvertDocumentApi ConvertDocumentPdfToPngArray Post /convert/pdf/to/png Convert PDF to PNG Image Array
ConvertDocumentApi ConvertDocumentPdfToPngArrayDirect Post /convert/pdf/to/png/direct Convert PDF to PNG Image Array (Direct)
ConvertDocumentApi ConvertDocumentPdfToPngSingle Post /convert/pdf/to/png/merge-single Convert PDF to Single PNG image
ConvertDocumentApi ConvertDocumentPdfToPptx Post /convert/pdf/to/pptx Convert PDF to PowerPoint PPTX Presentation
ConvertDocumentApi ConvertDocumentPdfToTiff Post /convert/pdf/to/tiff Convert PDF to TIFF image
ConvertDocumentApi ConvertDocumentPdfToTxt Post /convert/pdf/to/txt Convert PDF Document to Text (txt)
ConvertDocumentApi ConvertDocumentPngArrayToPdf Post /convert/png/to/pdf Convert PNG Array to PDF
ConvertDocumentApi ConvertDocumentPngArrayToPdfFlattenTransparency Post /convert/png/to/pdf/remove-transparency Convert PNG Array to PDF and remove transparency
ConvertDocumentApi ConvertDocumentPptToPdf Post /convert/ppt/to/pdf Convert PowerPoint PPT (97-03) Presentation to PDF
ConvertDocumentApi ConvertDocumentPptToPptx Post /convert/ppt/to/pptx Convert PowerPoint PPT (97-03) Presentation to PPTX
ConvertDocumentApi ConvertDocumentPptxToPdf Post /convert/pptx/to/pdf Convert PowerPoint PPTX Presentation to PDF
ConvertDocumentApi ConvertDocumentPptxToPng Post /convert/pptx/to/png Convert PowerPoint PPTX to PNG image array
ConvertDocumentApi ConvertDocumentPptxToPpt Post /convert/pptx/to/ppt Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
ConvertDocumentApi ConvertDocumentPptxToTxt Post /convert/pptx/to/txt Convert PowerPoint PPTX Presentation to Text (txt)
ConvertDocumentApi ConvertDocumentRtfToDocx Post /convert/rtf/to/docx Convert Rich Text Format RTF to DOCX Document
ConvertDocumentApi ConvertDocumentRtfToHtml Post /convert/rtf/to/html Convert Rich Text Format RTF to HTML Document
ConvertDocumentApi ConvertDocumentRtfToJpg Post /convert/rtf/to/jpg Convert Rich Text Format RTF to JPG/JPEG image array
ConvertDocumentApi ConvertDocumentRtfToPdf Post /convert/rtf/to/pdf Convert Rich Text Format RTF to PDF
ConvertDocumentApi ConvertDocumentRtfToPng Post /convert/rtf/to/png Convert Rich Text Format RTF to PNG image array
ConvertDocumentApi ConvertDocumentTxtToPdf Post /convert/txt/to/pdf Convert TXT text file to PDF Document
ConvertDocumentApi ConvertDocumentXlsToCsv Post /convert/xls/to/csv Convert Excel XLS (97-03) Spreadsheet to CSV
ConvertDocumentApi ConvertDocumentXlsToPdf Post /convert/xls/to/pdf Convert Excel XLS (97-03) Spreadsheet to PDF
ConvertDocumentApi ConvertDocumentXlsToXlsx Post /convert/xls/to/xlsx Convert Excel XLS (97-03) Spreadsheet to XLSX
ConvertDocumentApi ConvertDocumentXlsxToCsv Post /convert/xlsx/to/csv Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
ConvertDocumentApi ConvertDocumentXlsxToCsvMulti Post /convert/xlsx/to/csv/multi Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
ConvertDocumentApi ConvertDocumentXlsxToHtml Post /convert/xlsx/to/html Convert Excel XLSX Spreadsheet to HTML Document
ConvertDocumentApi ConvertDocumentXlsxToPdf Post /convert/xlsx/to/pdf Convert Excel XLSX Spreadsheet to PDF
ConvertDocumentApi ConvertDocumentXlsxToPng Post /convert/xlsx/to/png Convert Excel XLSX spreadsheet to PNG image array
ConvertDocumentApi ConvertDocumentXlsxToTxt Post /convert/xlsx/to/txt Convert Excel XLSX Spreadsheet to Text (txt)
ConvertDocumentApi ConvertDocumentXlsxToXls Post /convert/xlsx/to/xls Convert Excel XLSX Spreadsheet to Legacy Excel XLS (97-03)
ConvertImageApi ConvertImageGetImageInfo Post /convert/image/get-info Get information about an image
ConvertImageApi ConvertImageImageFormatConvert Post /convert/image/{format1}/to/{format2} Image format conversion
ConvertImageApi ConvertImageImageSetDPI Post /convert/image/set-dpi/{dpi} Change image DPI
ConvertImageApi ConvertImageMultipageImageFormatConvert Post /convert/image-multipage/{format1}/to/{format2} Multi-page image format conversion
ConvertTemplateApi ConvertTemplateApplyDocxTemplate Post /convert/template/docx/apply Apply Word DOCX template
ConvertTemplateApi ConvertTemplateApplyHtmlTemplate Post /convert/template/html/apply Apply HTML template
ConvertWebApi ConvertWebHtmlToDocx Post /convert/html/to/docx Convert HTML to Word DOCX Document
ConvertWebApi ConvertWebHtmlToPdf Post /convert/web/html/to/pdf Convert HTML string to PDF
ConvertWebApi ConvertWebHtmlToPng Post /convert/web/html/to/png Convert HTML string to PNG screenshot
ConvertWebApi ConvertWebHtmlToTxt Post /convert/web/html/to/txt Convert HTML string to text (txt)
ConvertWebApi ConvertWebMdToHtml Post /convert/web/md/to/html Convert Markdown to HTML
ConvertWebApi ConvertWebUrlToPdf Post /convert/web/url/to/pdf Convert a URL to PDF
ConvertWebApi ConvertWebUrlToScreenshot Post /convert/web/url/to/screenshot Take screenshot of URL
ConvertWebApi ConvertWebUrlToTxt Post /convert/web/url/to/txt Convert website URL page to text (txt)
EditDocumentApi EditDocumentBeginEditing Post /convert/edit/begin-editing Begin editing a document
EditDocumentApi EditDocumentDocxAcceptAllTrackChanges Post /convert/edit/docx/track-changes/accept-all Accept all tracked changes, revisions in a Word DOCX document
EditDocumentApi EditDocumentDocxBody Post /convert/edit/docx/get-body Get body from a Word DOCX document
EditDocumentApi EditDocumentDocxCreateBlankDocument Post /convert/edit/docx/create/blank Create a blank Word DOCX document
EditDocumentApi EditDocumentDocxDeletePages Post /convert/edit/docx/delete-pages Delete, remove pages from a Word DOCX document
EditDocumentApi EditDocumentDocxDeleteTableRow Post /convert/edit/docx/delete-table-row Deletes a table row in an existing table in a Word DOCX document
EditDocumentApi EditDocumentDocxDeleteTableRowRange Post /convert/edit/docx/delete-table-row/range Deletes a range of multiple table rows in an existing table in a Word DOCX document
EditDocumentApi EditDocumentDocxDisableTrackChanges Post /convert/edit/docx/track-changes/disable Disable track changes, revisions in a Word DOCX document
EditDocumentApi EditDocumentDocxEnableTrackChanges Post /convert/edit/docx/track-changes/enable Enable track changes, revisions in a Word DOCX document
EditDocumentApi EditDocumentDocxFindParagraph Post /convert/edit/docx/find/paragraph Find matching paragraphs in a Word DOCX document
EditDocumentApi EditDocumentDocxGetComments Post /convert/edit/docx/get-comments/flat-list Get comments from a Word DOCX document as a flat list
EditDocumentApi EditDocumentDocxGetCommentsHierarchical Post /convert/edit/docx/get-comments/hierarchical Get comments from a Word DOCX document hierarchically
EditDocumentApi EditDocumentDocxGetContentControls Post /convert/edit/docx/get-content-controls Get all content controls (form fields) and values in a Word DOCX document
EditDocumentApi EditDocumentDocxGetFormFields Post /convert/edit/docx/get-form-fields Get all form fields in a Word DOCX document
EditDocumentApi EditDocumentDocxGetHeadersAndFooters Post /convert/edit/docx/get-headers-and-footers Get content of a footer from a Word DOCX document
EditDocumentApi EditDocumentDocxGetImages Post /convert/edit/docx/get-images Get images from a Word DOCX document
EditDocumentApi EditDocumentDocxGetMacroInformation Post /convert/edit/docx/get-macros Get macro information from a Word DOCX/DOCM document
EditDocumentApi EditDocumentDocxGetMetadataProperties Post /convert/edit/docx/get-metadata Get all metadata properties in Word DOCX document
EditDocumentApi EditDocumentDocxGetSections Post /convert/edit/docx/get-sections Get sections from a Word DOCX document
EditDocumentApi EditDocumentDocxGetStyles Post /convert/edit/docx/get-styles Get styles from a Word DOCX document
EditDocumentApi EditDocumentDocxGetTableByIndex Post /convert/edit/docx/get-table/by-index Get a specific table by index in a Word DOCX document
EditDocumentApi EditDocumentDocxGetTableRow Post /convert/edit/docx/get-table-row Gets the contents of an existing table row in an existing table in a Word DOCX document
EditDocumentApi EditDocumentDocxGetTables Post /convert/edit/docx/get-tables Get all tables in Word DOCX document
EditDocumentApi EditDocumentDocxInsertCommentOnParagraph Post /convert/edit/docx/insert-comment/on/paragraph Insert a new comment into a Word DOCX document attached to a paragraph
EditDocumentApi EditDocumentDocxInsertImage Post /convert/edit/docx/insert-image Insert image into a Word DOCX document
EditDocumentApi EditDocumentDocxInsertParagraph Post /convert/edit/docx/insert-paragraph Insert a new paragraph into a Word DOCX document
EditDocumentApi EditDocumentDocxInsertTable Post /convert/edit/docx/insert-table Insert a new table into a Word DOCX document
EditDocumentApi EditDocumentDocxInsertTableRow Post /convert/edit/docx/insert-table-row Insert a new row into an existing table in a Word DOCX document
EditDocumentApi EditDocumentDocxPages Post /convert/edit/docx/get-pages Get pages and content from a Word DOCX document
EditDocumentApi EditDocumentDocxRemoveAllComments Post /convert/edit/docx/comments/remove-all Remove all comments from a Word DOCX document
EditDocumentApi EditDocumentDocxRemoveHeadersAndFooters Post /convert/edit/docx/remove-headers-and-footers Remove headers and footers from Word DOCX document
EditDocumentApi EditDocumentDocxRemoveObject Post /convert/edit/docx/remove-object Delete any object in a Word DOCX document
EditDocumentApi EditDocumentDocxReplace Post /convert/edit/docx/replace-all Replace string in Word DOCX document
EditDocumentApi EditDocumentDocxReplaceMulti Post /convert/edit/docx/replace-all/multi Replace multiple strings in Word DOCX document, return result
EditDocumentApi EditDocumentDocxReplaceMultiEditSession Post /convert/edit/docx/replace-all/multi/edit-session Replace multiple strings in Word DOCX document, return edit session
EditDocumentApi EditDocumentDocxReplaceParagraph Post /convert/edit/docx/replace/paragraph Replace matching paragraphs in a Word DOCX document
EditDocumentApi EditDocumentDocxSetCustomMetadataProperties Post /convert/edit/docx/set-metadata/custom-property Set custom property metadata properties in Word DOCX document
EditDocumentApi EditDocumentDocxSetFooter Post /convert/edit/docx/set-footer Set the footer in a Word DOCX document
EditDocumentApi EditDocumentDocxSetFooterAddPageNumber Post /convert/edit/docx/set-footer/add-page-number Add page number to footer in a Word DOCX document
EditDocumentApi EditDocumentDocxSetFormFields Post /convert/edit/docx/set-form-fields Set and fill values for form fields in a Word DOCX document
EditDocumentApi EditDocumentDocxSetHeader Post /convert/edit/docx/set-header Set the header in a Word DOCX document
EditDocumentApi EditDocumentDocxUpdateTableCell Post /convert/edit/docx/update-table-cell Update, set contents of a table cell in an existing table in a Word DOCX document
EditDocumentApi EditDocumentDocxUpdateTableRow Post /convert/edit/docx/update-table-row Update, set contents of a table row in an existing table in a Word DOCX document
EditDocumentApi EditDocumentFinishEditing Post /convert/edit/finish-editing Finish editing document, and download result from document editing
EditDocumentApi EditDocumentPptxDeleteSlides Post /convert/edit/pptx/delete-slides Delete, remove slides from a PowerPoint PPTX presentation document
EditDocumentApi EditDocumentPptxEditSizeAndOrientation Post /convert/edit/pptx/set-size-and-orientation Set the size and/or orientation of a PowerPoint PPTX presentation document
EditDocumentApi EditDocumentPptxGetMacroInformation Post /convert/edit/pptx/get-macros Get macro information from a PowerPoint PPTX/PPTM presentation document
EditDocumentApi EditDocumentPptxGetSizeAndOrientation Post /convert/edit/pptx/get-size-and-orientation Get the page layout information, including size and orientation of a PowerPoint PPTX presentation document
EditDocumentApi EditDocumentPptxReplace Post /convert/edit/pptx/replace-all Replace string in PowerPoint PPTX presentation
EditDocumentApi EditDocumentXlsxAppendRow Post /convert/edit/xlsx/append-row Append row to a Excel XLSX spreadsheet, worksheet
EditDocumentApi EditDocumentXlsxClearCellByIndex Post /convert/edit/xlsx/clear-cell/by-index Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
EditDocumentApi EditDocumentXlsxClearRow Post /convert/edit/xlsx/clear-row Clear row from a Excel XLSX spreadsheet, worksheet
EditDocumentApi EditDocumentXlsxCreateBlankSpreadsheet Post /convert/edit/xlsx/create/blank Create a blank Excel XLSX spreadsheet
EditDocumentApi EditDocumentXlsxCreateSpreadsheetFromData Post /convert/edit/xlsx/create/from/data Create a new Excel XLSX spreadsheet from column and row data
EditDocumentApi EditDocumentXlsxDeleteWorksheet Post /convert/edit/xlsx/delete-worksheet Delete, remove worksheet from an Excel XLSX spreadsheet document
EditDocumentApi EditDocumentXlsxDisableSharedWorkbook Post /convert/edit/xlsx/configuration/disable-shared-workbook Disable Shared Workbook (legacy) in Excel XLSX spreadsheet
EditDocumentApi EditDocumentXlsxEnableSharedWorkbook Post /convert/edit/xlsx/configuration/enable-shared-workbook Enable Shared Workbook (legacy) in Excel XLSX spreadsheet
EditDocumentApi EditDocumentXlsxGetCellByIdentifier Post /convert/edit/xlsx/get-cell/by-identifier Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
EditDocumentApi EditDocumentXlsxGetCellByIndex Post /convert/edit/xlsx/get-cell/by-index Get cell from an Excel XLSX spreadsheet, worksheet by index
EditDocumentApi EditDocumentXlsxGetColumns Post /convert/edit/xlsx/get-columns Get columns from a Excel XLSX spreadsheet, worksheet
EditDocumentApi EditDocumentXlsxGetImages Post /convert/edit/xlsx/get-images Get images from a Excel XLSX spreadsheet, worksheet
EditDocumentApi EditDocumentXlsxGetMacroInformation Post /convert/edit/xlsx/get-macros Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
EditDocumentApi EditDocumentXlsxGetRowsAndCells Post /convert/edit/xlsx/get-rows-and-cells Get rows and cells from a Excel XLSX spreadsheet, worksheet
EditDocumentApi EditDocumentXlsxGetSpecificRow Post /convert/edit/xlsx/get-specific-row Get a specific row from a Excel XLSX spreadsheet, worksheet by path
EditDocumentApi EditDocumentXlsxGetStyles Post /convert/edit/xlsx/get-styles Get styles from a Excel XLSX spreadsheet, worksheet
EditDocumentApi EditDocumentXlsxGetWorksheets Post /convert/edit/xlsx/get-worksheets Get worksheets from a Excel XLSX spreadsheet
EditDocumentApi EditDocumentXlsxInsertWorksheet Post /convert/edit/xlsx/insert-worksheet Insert a new worksheet into an Excel XLSX spreadsheet
EditDocumentApi EditDocumentXlsxRenameWorksheet Post /convert/edit/xlsx/rename-worksheet Rename a specific worksheet in a Excel XLSX spreadsheet
EditDocumentApi EditDocumentXlsxSetCellByIdentifier Post /convert/edit/xlsx/set-cell/by-identifier Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier
EditDocumentApi EditDocumentXlsxSetCellByIndex Post /convert/edit/xlsx/set-cell/by-index Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
EditHtmlApi EditHtmlHtmlAppendHeaderTag Post /convert/edit/html/head/append/tag Append an HTML tag to the HEAD section of an HTML Document
EditHtmlApi EditHtmlHtmlAppendHeading Post /convert/edit/html/append/heading Append a Heading to an HTML Document
EditHtmlApi EditHtmlHtmlAppendImageFromUrl Post /convert/edit/html/append/image/from-url Append an Image to an HTML Document from a URL
EditHtmlApi EditHtmlHtmlAppendImageInline Post /convert/edit/html/append/image/inline Append a Base64 Inline Image to an HTML Document
EditHtmlApi EditHtmlHtmlAppendParagraph Post /convert/edit/html/append/paragraph Append a Paragraph to an HTML Document
EditHtmlApi EditHtmlHtmlCreateBlankDocument Post /convert/edit/html/create/blank Create a Blank HTML Document
EditHtmlApi EditHtmlHtmlGetLanguage Post /convert/edit/html/head/get/language Gets the language for the HTML document
EditHtmlApi EditHtmlHtmlGetLinks Post /convert/edit/html/extract/links Extract resolved link URLs from HTML File
EditHtmlApi EditHtmlHtmlGetRelCanonical Post /convert/edit/html/head/get/rel-canonical-url Gets the rel canonical URL for the HTML document
EditHtmlApi EditHtmlHtmlGetSitemap Post /convert/edit/html/head/get/sitemap-url Gets the sitemap URL for the HTML document
EditHtmlApi EditHtmlHtmlSetLanguage Post /convert/edit/html/head/set/language Sets the language for the HTML document
EditHtmlApi EditHtmlHtmlSetRelCanonical Post /convert/edit/html/head/set/rel-canonical-url Sets the rel canonical URL for the HTML document
EditHtmlApi EditHtmlHtmlSetSitemapUrl Post /convert/edit/html/head/set/sitemap-url Sets the sitemap URL for the HTML document
EditPdfApi EditPdfAddAnnotations Post /convert/edit/pdf/annotations/add-item Add one or more PDF annotations, comments in the PDF document
EditPdfApi EditPdfConvertToPdfA Post /convert/edit/pdf/optimize/pdf-a Convert a PDF file to PDF/A
EditPdfApi EditPdfDecrypt Post /convert/edit/pdf/decrypt Decrypt and password-protect a PDF
EditPdfApi EditPdfDeletePages Post /convert/edit/pdf/pages/delete Remove, delete pages from a PDF document
EditPdfApi EditPdfDeletePagesBatchJob Post /convert/edit/pdf/pages/delete/batch-job Remove, delete pages from a PDF document as Batch Job
EditPdfApi EditPdfEncrypt Post /convert/edit/pdf/encrypt Encrypt and password-protect a PDF
EditPdfApi EditPdfGetAnnotations Post /convert/edit/pdf/annotations/list Get PDF annotations, including comments in the document
EditPdfApi EditPdfGetAsyncJobStatus Get /convert/edit/pdf/batch-job/status Get the status and result of a PDF Batch Job
EditPdfApi EditPdfGetFormFields Post /convert/edit/pdf/form/get-fields Gets PDF Form fields and values
EditPdfApi EditPdfGetMetadata Post /convert/edit/pdf/get-metadata Get PDF document metadata
EditPdfApi EditPdfGetPdfTextByPages Post /convert/edit/pdf/pages/get-text Get text in a PDF document by page
EditPdfApi EditPdfInsertPages Post /convert/edit/pdf/pages/insert Insert, copy pages from one PDF document into another
EditPdfApi EditPdfInsertPagesBatchJob Post /convert/edit/pdf/pages/insert/batch-job Insert, copy pages from one PDF document into another as a batch job
EditPdfApi EditPdfLinearize Post /convert/edit/pdf/optimize/linearize Linearize and optimize a PDF for streaming download
EditPdfApi EditPdfRasterize Post /convert/edit/pdf/rasterize Rasterize a PDF to an image-based PDF
EditPdfApi EditPdfRasterizeBatchJob Post /convert/edit/pdf/rasterize/batch-job Rasterize a PDF to an image-based PDF as Batch Job
EditPdfApi EditPdfReduceFileSize Post /convert/edit/pdf/optimize/reduce-file-size Reduce the file size and optimize a PDF
EditPdfApi EditPdfRemoveAllAnnotations Post /convert/edit/pdf/annotations/remove-all Remove all PDF annotations, including comments in the document
EditPdfApi EditPdfRemoveAnnotationItem Post /convert/edit/pdf/annotations/remove-item Remove a specific PDF annotation, comment in the document
EditPdfApi EditPdfResize Post /convert/edit/pdf/resize Change PDF Document's Paper Size
EditPdfApi EditPdfRotateAllPages Post /convert/edit/pdf/pages/rotate/all Rotate all pages in a PDF document
EditPdfApi EditPdfRotatePageRange Post /convert/edit/pdf/pages/rotate/page-range Rotate a range, subset of pages in a PDF document
EditPdfApi EditPdfSetFormFields Post /convert/edit/pdf/form/set-fields Sets ands fills PDF Form field values
EditPdfApi EditPdfSetMetadata Post /convert/edit/pdf/set-metadata Sets PDF document metadata
EditPdfApi EditPdfSetPermissions Post /convert/edit/pdf/encrypt/set-permissions Encrypt, password-protect and set restricted permissions on a PDF
EditPdfApi EditPdfWatermarkText Post /convert/edit/pdf/watermark/text Add a text watermark to a PDF
EditTextApi EditTextBase64Decode Post /convert/edit/text/encoding/base64/decode Base 64 decode, convert base 64 string to binary content
EditTextApi EditTextBase64Detect Post /convert/edit/text/encoding/base64/detect Detect, check if text string is base 64 encoded
EditTextApi EditTextBase64Encode Post /convert/edit/text/encoding/base64/encode Base 64 encode, convert binary or file data to a text string
EditTextApi EditTextChangeLineEndings Post /convert/edit/text/line-endings/change Set, change line endings of a text file
EditTextApi EditTextDetectLineEndings Post /convert/edit/text/line-endings/detect Detect line endings of a text file
EditTextApi EditTextFindRegex Post /convert/edit/text/find/regex Find a regular expression regex in text input
EditTextApi EditTextFindSimple Post /convert/edit/text/find/string Find a string in text input
EditTextApi EditTextRemoveAllWhitespace Post /convert/edit/text/remove/whitespace/all Remove whitespace from text string
EditTextApi EditTextRemoveHtml Post /convert/edit/text/remove/html Remove HTML from text string
EditTextApi EditTextReplaceRegex Post /convert/edit/text/replace/regex Replace a string in text with a regex regular expression string
EditTextApi EditTextReplaceSimple Post /convert/edit/text/replace/string Replace a string in text with another string value
EditTextApi EditTextTextEncodingDetect Post /convert/edit/text/encoding/detect Detect text encoding of file
EditTextApi EditTextTrimWhitespace Post /convert/edit/text/remove/whitespace/trim Trim leading and trailing whitespace from text string
MergeDocumentApi MergeDocumentBatchJobCreate Post /convert/merge/batch-job/create Merge an array of Documents into a Single Document by Page as a Batch Job
MergeDocumentApi MergeDocumentDocx Post /convert/merge/docx Merge Two Word DOCX Together
MergeDocumentApi MergeDocumentDocxMulti Post /convert/merge/docx/multi Merge Multple Word DOCX Together
MergeDocumentApi MergeDocumentDocxMultiArray Post /convert/merge/docx/multi/array Merge Multple Word DOCX Together from an array
MergeDocumentApi MergeDocumentGetAsyncJobStatus Get /convert/merge/batch-job/status Get the status and result of a Merge Document Batch Job
MergeDocumentApi MergeDocumentHtml Post /convert/merge/html Merge Two HTML (HTM) Files Together
MergeDocumentApi MergeDocumentHtmlMulti Post /convert/merge/html/multi Merge Multple HTML (HTM) Files Together
MergeDocumentApi MergeDocumentHtmlMultiArray Post /convert/merge/html/multi/array Merge Multple HTML (HTM) Files Together from an array
MergeDocumentApi MergeDocumentPdf Post /convert/merge/pdf Merge Two PDF Files Together
MergeDocumentApi MergeDocumentPdfMulti Post /convert/merge/pdf/multi Merge Multple PDF Files Together
MergeDocumentApi MergeDocumentPdfMultiArray Post /convert/merge/pdf/multi/array Merge Multple PDF Files Together from an array
MergeDocumentApi MergeDocumentPng Post /convert/merge/png/vertical Merge Two PNG Files Together
MergeDocumentApi MergeDocumentPngMulti Post /convert/merge/png/vertical/multi Merge Multple PNG Files Together
MergeDocumentApi MergeDocumentPngMultiArray Post /convert/merge/png/vertical/multi/array Merge Multple PNG Files Together from an array
MergeDocumentApi MergeDocumentPptx Post /convert/merge/pptx Merge Two PowerPoint PPTX Together
MergeDocumentApi MergeDocumentPptxMulti Post /convert/merge/pptx/multi Merge Multple PowerPoint PPTX Together
MergeDocumentApi MergeDocumentPptxMultiArray Post /convert/merge/pptx/multi/array Merge Multple PowerPoint PPTX Together from an array
MergeDocumentApi MergeDocumentTxt Post /convert/merge/txt Merge Two Text (TXT) Files Together
MergeDocumentApi MergeDocumentTxtMulti Post /convert/merge/txt/multi Merge Multple Text (TXT) Files Together
MergeDocumentApi MergeDocumentXlsx Post /convert/merge/xlsx Merge Two Excel XLSX Together
MergeDocumentApi MergeDocumentXlsxMulti Post /convert/merge/xlsx/multi Merge Multple Excel XLSX Together
MergeDocumentApi MergeDocumentXlsxMultiArray Post /convert/merge/xlsx/multi/array Merge Multple Excel XLSX Together from an Array
SplitDocumentApi SplitDocumentBatchJobCreate Post /convert/split/batch-job/create Split a single Document into Separate Documents by Page as a Batch Job
SplitDocumentApi SplitDocumentDocx Post /convert/split/docx Split a single Word Document DOCX into Separate Documents by Page
SplitDocumentApi SplitDocumentGetAsyncJobStatus Get /convert/split/batch-job/status Get the status and result of a Split Document Batch Job
SplitDocumentApi SplitDocumentPdfByPage Post /convert/split/pdf Split a PDF file into separate PDF files, one per page
SplitDocumentApi SplitDocumentPptx Post /convert/split/pptx Split a single PowerPoint Presentation PPTX into Separate Slides
SplitDocumentApi SplitDocumentPptxAdvanced Post /convert/split/pptx/advanced Split a single PowerPoint Presentation PPTX into Separate Presentations
SplitDocumentApi SplitDocumentTxtByLine Post /convert/split/txt/by-line Split a single Text file (txt) into lines
SplitDocumentApi SplitDocumentTxtByString Post /convert/split/txt/by-string Split a single Text file (txt) by a string delimiter
SplitDocumentApi SplitDocumentXlsx Post /convert/split/xlsx Split a single Excel XLSX into Separate Worksheets
TransformDocumentApi TransformDocumentDocxReplace Post /convert/transform/docx/replace-all Replace string in Word DOCX document, return result
TransformDocumentApi TransformDocumentDocxReplaceEditSession Post /convert/transform/docx/replace-all/edit-session Replace string in Word DOCX document, return edit session
TransformDocumentApi TransformDocumentDocxTableFillIn Post /convert/transform/docx/table/fill/data Fill in data in a table in a Word DOCX document, return result
TransformDocumentApi TransformDocumentDocxTableFillInEditSession Post /convert/transform/docx/table/fill/data/edit-session Fill in data in a table in a Word DOCX document, return edit session
TransformDocumentApi TransformDocumentDocxTableFillInMulti Post /convert/transform/docx/table/fill/data/multi Fill in data in multiple tables in a Word DOCX document, return result
TransformDocumentApi TransformDocumentPptxReplace Post /convert/transform/pptx/replace-all Replace string in PowerPoint PPTX presentation, return result
ValidateDocumentApi ValidateDocumentAutodetectValidation Post /convert/validate/autodetect Autodetect content type and validate
ValidateDocumentApi ValidateDocumentCsvValidation Post /convert/validate/csv Validate a CSV file document (CSV)
ValidateDocumentApi ValidateDocumentDocValidation Post /convert/validate/doc Validate a Word 97-2003 Legacy document (DOC)
ValidateDocumentApi ValidateDocumentDocxRepair Post /convert/validate/docx/repair Repair a Word document (DOCX) that contains errors
ValidateDocumentApi ValidateDocumentDocxValidation Post /convert/validate/docx Validate a Word document (DOCX)
ValidateDocumentApi ValidateDocumentEmlValidation Post /convert/validate/eml Validate if input file is a valid EML file
ValidateDocumentApi ValidateDocumentExecutableValidation Post /convert/validate/executable Validate if a file is executable
ValidateDocumentApi ValidateDocumentGZipValidation Post /convert/validate/gzip Validate a GZip Archive file (gzip or gz)
ValidateDocumentApi ValidateDocumentHtmlSsrfValidation Post /convert/validate/html/ssrf-threat-check Validate an HTML file and checks for SSRF threats
ValidateDocumentApi ValidateDocumentHtmlValidation Post /convert/validate/html Validate an HTML file
ValidateDocumentApi ValidateDocumentImageValidation Post /convert/validate/image Validate an Image File
ValidateDocumentApi ValidateDocumentJpgValidation Post /convert/validate/jpg Validate a JPG File
ValidateDocumentApi ValidateDocumentJsonValidation Post /convert/validate/json Validate a JSON file
ValidateDocumentApi ValidateDocumentMsgValidation Post /convert/validate/msg Validate if input file is a valid MSG file
ValidateDocumentApi ValidateDocumentPdfValidation Post /convert/validate/pdf Validate a PDF document file
ValidateDocumentApi ValidateDocumentPngValidation Post /convert/validate/png Validate a PNG File
ValidateDocumentApi ValidateDocumentPptValidation Post /convert/validate/ppt Validate a PowerPoint 97-2003 Legacy presentation (PPT)
ValidateDocumentApi ValidateDocumentPptxRepair Post /convert/validate/pptx/repair Repair a PowerPoint presentation (PPTX) that contains errors
ValidateDocumentApi ValidateDocumentPptxValidation Post /convert/validate/pptx Validate a PowerPoint presentation (PPTX)
ValidateDocumentApi ValidateDocumentRarValidation Post /convert/validate/rar Validate a RAR Archive file (RAR)
ValidateDocumentApi ValidateDocumentRtfValidation Post /convert/validate/rtf Validate a Rich Text Format document (RTF)
ValidateDocumentApi ValidateDocumentTarValidation Post /convert/validate/tar Validate a TAR Tarball Archive file (TAR)
ValidateDocumentApi ValidateDocumentTxtValidation Post /convert/validate/txt Validate an TXT file
ValidateDocumentApi ValidateDocumentXlsValidation Post /convert/validate/xls Validate a Excel 97-2003 Legacy spreadsheet (XLS)
ValidateDocumentApi ValidateDocumentXlsxRepair Post /convert/validate/xlsx/repair Repair an Excel spreadsheet (XLSX) that contains errors
ValidateDocumentApi ValidateDocumentXlsxValidation Post /convert/validate/xlsx Validate a Excel document (XLSX)
ValidateDocumentApi ValidateDocumentXmlValidation Post /convert/validate/xml Validate an XML file
ValidateDocumentApi ValidateDocumentXmlXxeThreatValidation Post /convert/validate/xml/xxe-threats Validate an XML file for XML External Entity (XXE) threats
ValidateDocumentApi ValidateDocumentZipValidation Post /convert/validate/zip Validate a Zip Archive file (zip)
ViewerToolsApi ViewerToolsCreateSimple Post /convert/viewer/create/web/simple Create a web-based viewer
ZipArchiveApi ZipArchiveZipCreate Post /convert/archive/zip/create Compress files to create a new zip archive
ZipArchiveApi ZipArchiveZipCreateAdvanced Post /convert/archive/zip/create/advanced Compress files and folders to create a new zip archive with advanced options
ZipArchiveApi ZipArchiveZipCreateEncrypted Post /convert/archive/zip/create/encrypted Compress files to create a new, encrypted and password-protected zip archive
ZipArchiveApi ZipArchiveZipCreateQuarantine Post /convert/archive/zip/create/quarantine Create an encrypted zip file to quarantine a dangerous file
ZipArchiveApi ZipArchiveZipDecrypt Post /convert/archive/zip/decrypt Decrypt and remove password protection on a zip file
ZipArchiveApi ZipArchiveZipEncryptAdvanced Post /convert/archive/zip/encrypt/advanced Encrypt and password protect a zip file
ZipArchiveApi ZipArchiveZipExtract Post /convert/archive/zip/extract Extract, decompress files and folders from a zip archive

Documentation For Models

Documentation For Authorization

Apikey

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶ 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶ 

type APIClient struct {
	CompareDocumentApi *CompareDocumentApiService

	ConvertDataApi *ConvertDataApiService

	ConvertDocumentApi *ConvertDocumentApiService

	ConvertImageApi *ConvertImageApiService

	ConvertTemplateApi *ConvertTemplateApiService

	ConvertWebApi *ConvertWebApiService

	EditDocumentApi *EditDocumentApiService

	EditHtmlApi *EditHtmlApiService

	EditPdfApi *EditPdfApiService

	EditTextApi *EditTextApiService

	MergeDocumentApi *MergeDocumentApiService

	SplitDocumentApi *SplitDocumentApiService

	TransformDocumentApi *TransformDocumentApiService

	ValidateDocumentApi *ValidateDocumentApiService

	ViewerToolsApi *ViewerToolsApiService

	ZipArchiveApi *ZipArchiveApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the convertapi API vv1 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶ 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶ 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶ 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶ 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶ 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶ 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AddPdfAnnotationRequest ¶ 

type AddPdfAnnotationRequest struct {
	// Input file contents bytes for the file to modify
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Annotations to add to the PDF file
	AnnotationsToAdd []PdfAnnotation `json:"AnnotationsToAdd,omitempty"`
}

Request to add annotations to a PDF

type AlternateFileFormatCandidate ¶ 

type AlternateFileFormatCandidate struct {
	// Probability that this extension is the right one; possible values are between 0.0 (lowest confidence) and 1.0 (highest confidence)
	Probability float64 `json:"Probability,omitempty"`
	// Detected file extension of the file format, with a leading period
	DetectedFileExtension string `json:"DetectedFileExtension,omitempty"`
	// MIME type of this file extension
	DetectedMimeType string `json:"DetectedMimeType,omitempty"`
}

Alternate file format possibility

type AppendXlsxRowRequest ¶ 

type AppendXlsxRowRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Worksheet (tab) within the spreadsheet to get the specific row from; leave blank to default to the first worksheet
	WorksheetToUpdate *XlsxWorksheet `json:"WorksheetToUpdate,omitempty"`
	// Required; Row to be appended to the worksheet.
	Row *XlsxSpreadsheetRow `json:"Row,omitempty"`
}

Input to a Append-Row request

type AppendXlsxRowResponse ¶ 

type AppendXlsxRowResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running an Append-Row command

type AutodetectDocumentValidationResult ¶ 

type AutodetectDocumentValidationResult struct {
	FileFormatExtension string `json:"FileFormatExtension,omitempty"`
	// True if the document is valid and has no errors, false otherwise
	DocumentIsValid bool `json:"DocumentIsValid,omitempty"`
	// Number of validation errors found in the document
	ErrorCount int32 `json:"ErrorCount,omitempty"`
	// Number of validation warnings found in the document
	WarningCount int32 `json:"WarningCount,omitempty"`
	// Details of errors and warnings found
	ErrorsAndWarnings []DocumentValidationError `json:"ErrorsAndWarnings,omitempty"`
}

Document validation result

type AutodetectGetInfoResult ¶ 

type AutodetectGetInfoResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Detected file extension of the file format, with a leading period
	DetectedFileExtension string `json:"DetectedFileExtension,omitempty"`
	// MIME type of this file extension
	DetectedMimeType string `json:"DetectedMimeType,omitempty"`
	// Number of pages in a page-based document; for presentations, this is the number of slides and for a spreadsheet this is the number of worksheets.  Contains 0 when the page count cannot be determined, or if the concept of page count does not apply (e.g. for an image)
	PageCount int64 `json:"PageCount,omitempty"`
	// User name of the creator/author of the document, if available, null if not available
	Author string `json:"Author,omitempty"`
	// The timestamp that the document was last modified, if available, null if not available
	DateModified time.Time `json:"DateModified,omitempty"`
	// Alternate file type options and their probability
	AlternateFileTypeCandidates []AlternateFileFormatCandidate `json:"AlternateFileTypeCandidates,omitempty"`
}

Result of an autodetect/get-info operation

type AutodetectToJpgResult ¶ 

type AutodetectToJpgResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	JpgResultPages []ConvertedJpgPage `json:"JpgResultPages,omitempty"`
}

Result of converting a Autodetected Document input to a JPG array

type AutodetectToPngResult ¶ 

type AutodetectToPngResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngPage `json:"PngResultPages,omitempty"`
}

Result of converting an autodetected input to a PNG array

type AutodetectToThumbnailsResult ¶ 

type AutodetectToThumbnailsResult struct {
	// Index of this thumbnail
	Successful bool `json:"Successful,omitempty"`
	// A PNG thumbnail of the document page
	ThumbnailPages []Thumbnail `json:"ThumbnailPages,omitempty"`
}

Result of converting an entire document to an array of PNG thumbnails

type Base64DecodeRequest ¶ 

type Base64DecodeRequest struct {
	// Input content to decode from Base 64 into binary
	Base64ContentToDecode string `json:"Base64ContentToDecode,omitempty"`
}

Request to decode content from Base 64 into binary

type Base64DecodeResponse ¶ 

type Base64DecodeResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Result of performing a base 64 decode operation, binary file content
	ContentResult string `json:"ContentResult,omitempty"`
}

Result of base 64 decoding

type Base64DetectRequest ¶ 

type Base64DetectRequest struct {
	// Input content text to detect if it is base 64 encoded
	Base64ContentToDetect string `json:"Base64ContentToDetect,omitempty"`
}

Request to detect if input content is base 64 encoded

type Base64DetectResponse ¶ 

type Base64DetectResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// True if the input string is base 64 encoded, false otherwise
	IsBase64Encoded bool `json:"IsBase64Encoded,omitempty"`
}

Result of base 64 detection

type Base64EncodeRequest ¶ 

type Base64EncodeRequest struct {
	// Input content to encode into Base 64
	ContentToEncode string `json:"ContentToEncode,omitempty"`
}

Request to encode content to Base 64

type Base64EncodeResponse ¶ 

type Base64EncodeResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Result of performing a base 64 encoding operation, a text string representing the encoded original file content
	Base64TextContentResult string `json:"Base64TextContentResult,omitempty"`
}

Result of base 64 encoding

type BasicAuth ¶ 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type ChangeLineEndingResponse ¶ 

type ChangeLineEndingResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Text content result
	TextContentResult string `json:"TextContentResult,omitempty"`
}

Result of performing a change line ending operation

type ClearXlsxCellRequest ¶ 

type ClearXlsxCellRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Worksheet (tab) within the spreadsheet to update; leave blank to default to the first worksheet
	WorksheetToUpdate *XlsxWorksheet `json:"WorksheetToUpdate,omitempty"`
	// 0-based index of the row, 0, 1, 2, ... to clear
	RowIndex int32 `json:"RowIndex,omitempty"`
	// 0-based index of the cell, 0, 1, 2, ... in the row to clear
	CellIndex int32 `json:"CellIndex,omitempty"`
}

Input to a Clear Cell in XLSX Worksheet request

type ClearXlsxCellResponse ¶ 

type ClearXlsxCellResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running a Clear XLSX Cell command

type ClearXlsxRowRequest ¶ 

type ClearXlsxRowRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Worksheet (tab) within the spreadsheet to get the specific row from; leave blank to default to the first worksheet
	WorksheetToEdit *XlsxWorksheet `json:"WorksheetToEdit,omitempty"`
	// Required; Index for the desired row to be cleared
	RowIndex int32 `json:"RowIndex,omitempty"`
}

Input to a Clear-Row request

type ClearXlsxRowResponse ¶ 

type ClearXlsxRowResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running a Clear-Row command

type CompareDocumentApiService ¶ 

type CompareDocumentApiService service

func (*CompareDocumentApiService) CompareDocumentDocx ¶ 

func (a *CompareDocumentApiService) CompareDocumentDocx(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File, localVarOptionals *CompareDocumentDocxOpts) (string, *http.Response, error)

type CompareDocumentDocxOpts ¶ 

type CompareDocumentDocxOpts struct {
	Autorepair optional.Bool
}

type Configuration ¶ 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶ 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶ 

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConvertDataApiService ¶ 

type ConvertDataApiService service

func (*ConvertDataApiService) ConvertDataCsvToJson ¶ 

func (a *ConvertDataApiService) ConvertDataCsvToJson(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDataCsvToJsonOpts) (interface{}, *http.Response, error)

func (*ConvertDataApiService) ConvertDataCsvToXml ¶ 

func (a *ConvertDataApiService) ConvertDataCsvToXml(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDataCsvToXmlOpts) (string, *http.Response, error)

func (*ConvertDataApiService) ConvertDataJsonStringToXml ¶ 

func (a *ConvertDataApiService) ConvertDataJsonStringToXml(ctx context.Context, jsonString string) (interface{}, *http.Response, error)

ConvertDataApiService Convert JSON String to XML conversion Convert a JSON object into XML

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param jsonString Input JSON String to convert to XML

@return interface{}

func (*ConvertDataApiService) ConvertDataJsonToXml ¶ 

func (a *ConvertDataApiService) ConvertDataJsonToXml(ctx context.Context, jsonObject interface{}) (string, *http.Response, error)

ConvertDataApiService Convert JSON Object to XML conversion Convert a JSON object into XML

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param jsonObject Input JSON Object to convert to XML

@return string

func (*ConvertDataApiService) ConvertDataXlsToJson ¶ 

func (a *ConvertDataApiService) ConvertDataXlsToJson(ctx context.Context, inputFile *os.File) (interface{}, *http.Response, error)

ConvertDataApiService Convert Excel (97-2003) XLS to JSON conversion Convert an Excel (97-2003) XLS file to a JSON object array

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return interface{}

func (*ConvertDataApiService) ConvertDataXlsxToJson ¶ 

func (a *ConvertDataApiService) ConvertDataXlsxToJson(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDataApiService Convert Excel XLSX to JSON conversion Convert an Excel XLSX file to a JSON object array

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDataApiService) ConvertDataXlsxToXml ¶ 

func (a *ConvertDataApiService) ConvertDataXlsxToXml(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDataApiService Convert Excel XLSX to XML conversion Convert an Excel XLSX file to a XML file

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDataApiService) ConvertDataXmlEditAddAttributeWithXPath ¶ 

func (a *ConvertDataApiService) ConvertDataXmlEditAddAttributeWithXPath(ctx context.Context, inputFile *os.File, xPathExpression string, xmlAttributeName string, xmlAttributeValue string) (XmlAddAttributeWithXPathResult, *http.Response, error)

ConvertDataApiService Adds an attribute to all XML nodes matching XPath expression Return the reuslts of editing an XML document by adding an attribute to all of the nodes that match an input XPath expression.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input XML file to perform the operation on.
  • @param xPathExpression Valid XML XPath query expression
  • @param xmlAttributeName Name of the XML attribute to add
  • @param xmlAttributeValue Value of the XML attribute to add

@return XmlAddAttributeWithXPathResult

func (*ConvertDataApiService) ConvertDataXmlEditAddChildWithXPath ¶ 

func (a *ConvertDataApiService) ConvertDataXmlEditAddChildWithXPath(ctx context.Context, inputFile *os.File, xPathExpression string, xmlNodeToAdd string) (XmlAddChildWithXPathResult, *http.Response, error)

ConvertDataApiService Adds an XML node as a child to XML nodes matching XPath expression Return the reuslts of editing an XML document by adding an XML node as a child to all of the nodes that match an input XPath expression.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input XML file to perform the operation on.
  • @param xPathExpression Valid XML XPath query expression
  • @param xmlNodeToAdd XML Node to add as a child

@return XmlAddChildWithXPathResult

func (*ConvertDataApiService) ConvertDataXmlEditRemoveAllChildNodesWithXPath ¶ 

func (a *ConvertDataApiService) ConvertDataXmlEditRemoveAllChildNodesWithXPath(ctx context.Context, inputFile *os.File, xPathExpression string) (XmlRemoveAllChildrenWithXPathResult, *http.Response, error)

ConvertDataApiService Removes, deletes all children of nodes matching XPath expression, but does not remove the nodes Return the reuslts of editing an XML document by removing all child nodes of the nodes that match an input XPath expression.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input XML file to perform the operation on.
  • @param xPathExpression Valid XML XPath query expression

@return XmlRemoveAllChildrenWithXPathResult

func (*ConvertDataApiService) ConvertDataXmlEditReplaceWithXPath ¶ 

func (a *ConvertDataApiService) ConvertDataXmlEditReplaceWithXPath(ctx context.Context, inputFile *os.File, xPathExpression string, xmlNodeReplacement string) (XmlReplaceWithXPathResult, *http.Response, error)

ConvertDataApiService Replaces XML nodes matching XPath expression with new node Return the reuslts of editing an XML document by replacing all of the nodes that match an input XPath expression with a new XML node expression.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input XML file to perform the operation on.
  • @param xPathExpression Valid XML XPath query expression
  • @param xmlNodeReplacement XML Node replacement content

@return XmlReplaceWithXPathResult

func (*ConvertDataApiService) ConvertDataXmlEditSetValueWithXPath ¶ 

func (a *ConvertDataApiService) ConvertDataXmlEditSetValueWithXPath(ctx context.Context, inputFile *os.File, xPathExpression string, xmlValue string) (XmlSetValueWithXPathResult, *http.Response, error)

ConvertDataApiService Sets the value contents of XML nodes matching XPath expression Return the reuslts of editing an XML document by setting the contents of all of the nodes that match an input XPath expression. Supports elements and attributes.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input XML file to perform the operation on.
  • @param xPathExpression Valid XML XPath query expression
  • @param xmlValue XML Value to set into the matching XML nodes

@return XmlSetValueWithXPathResult

func (*ConvertDataApiService) ConvertDataXmlFilterWithXPath ¶ 

func (a *ConvertDataApiService) ConvertDataXmlFilterWithXPath(ctx context.Context, xPathExpression string, inputFile *os.File) (XmlFilterWithXPathResult, *http.Response, error)

ConvertDataApiService Filter, select XML nodes using XPath expression, get results Return the reuslts of filtering, selecting an XML document with an XPath expression

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param xPathExpression Valid XML XPath query expression
  • @param inputFile Input file to perform the operation on.

@return XmlFilterWithXPathResult

func (*ConvertDataApiService) ConvertDataXmlQueryWithXQuery ¶ 

func (a *ConvertDataApiService) ConvertDataXmlQueryWithXQuery(ctx context.Context, inputFile *os.File, xQuery string) (XmlQueryWithXQueryResult, *http.Response, error)

ConvertDataApiService Query an XML file using XQuery query, get results Return the reuslts of querying a single XML document with an XQuery expression. Supports XQuery 3.1 and earlier. This API is optimized for a single XML document as input. Provided XML document is automatically loaded as the default context; to access elements in the document, simply refer to them without a document reference, such as bookstore/book

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input XML file to perform the operation on.
  • @param xQuery Valid XML XQuery 3.1 or earlier query expression; multi-line expressions are supported

@return XmlQueryWithXQueryResult

func (*ConvertDataApiService) ConvertDataXmlQueryWithXQueryMulti ¶ 

func (a *ConvertDataApiService) ConvertDataXmlQueryWithXQueryMulti(ctx context.Context, inputFile1 *os.File, xQuery string, localVarOptionals *ConvertDataXmlQueryWithXQueryMultiOpts) (XmlQueryWithXQueryMultiResult, *http.Response, error)

func (*ConvertDataApiService) ConvertDataXmlRemoveWithXPath ¶ 

func (a *ConvertDataApiService) ConvertDataXmlRemoveWithXPath(ctx context.Context, xPathExpression string, inputFile *os.File) (XmlRemoveWithXPathResult, *http.Response, error)

ConvertDataApiService Remove, delete XML nodes and items matching XPath expression Return the reuslts of editing an XML document by removing all of the nodes that match an input XPath expression

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param xPathExpression Valid XML XPath query expression
  • @param inputFile Input file to perform the operation on.

@return XmlRemoveWithXPathResult

func (*ConvertDataApiService) ConvertDataXmlToJson ¶ 

func (a *ConvertDataApiService) ConvertDataXmlToJson(ctx context.Context, inputFile *os.File) (interface{}, *http.Response, error)

ConvertDataApiService Convert XML to JSON conversion Convert an XML string or file into JSON

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return interface{}

func (*ConvertDataApiService) ConvertDataXmlTransformWithXsltToXml ¶ 

func (a *ConvertDataApiService) ConvertDataXmlTransformWithXsltToXml(ctx context.Context, inputFile *os.File, transformFile *os.File) (string, *http.Response, error)

ConvertDataApiService Transform XML document file with XSLT into a new XML document Convert an XML string or file into JSON

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input XML file to perform the operation on.
  • @param transformFile Input XSLT file to use to transform the input XML file.

@return string

type ConvertDataCsvToJsonOpts ¶ 

type ConvertDataCsvToJsonOpts struct {
	ColumnNamesFromFirstRow optional.Bool
}

type ConvertDataCsvToXmlOpts ¶ 

type ConvertDataCsvToXmlOpts struct {
	ColumnNamesFromFirstRow optional.Bool
}

type ConvertDataXmlQueryWithXQueryMultiOpts ¶ 

type ConvertDataXmlQueryWithXQueryMultiOpts struct {
	InputFile2  optional.Interface
	InputFile3  optional.Interface
	InputFile4  optional.Interface
	InputFile5  optional.Interface
	InputFile6  optional.Interface
	InputFile7  optional.Interface
	InputFile8  optional.Interface
	InputFile9  optional.Interface
	InputFile10 optional.Interface
}

type ConvertDocumentApiService ¶ 

type ConvertDocumentApiService service

func (*ConvertDocumentApiService) ConvertDocumentAutodetectGetInfo ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentAutodetectGetInfo(ctx context.Context, inputFile *os.File) (AutodetectGetInfoResult, *http.Response, error)

ConvertDocumentApiService Get document type information Auto-detects a document's type information; does not require file extension. Analyzes file contents to confirm file type. Even if no file extension is present, the auto-detect system will reliably analyze the contents of the file and identify its file type. Supports over 100 image file formats, Office document file formats, PDF, and more.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return AutodetectGetInfoResult

func (*ConvertDocumentApiService) ConvertDocumentAutodetectToJpg ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentAutodetectToJpg(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentAutodetectToJpgOpts) (AutodetectToJpgResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentAutodetectToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentAutodetectToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Document to PDF Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, text files, and even multi-page TIFF files.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentAutodetectToPdfBatchJob ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentAutodetectToPdfBatchJob(ctx context.Context, inputFile *os.File) (ConvertDocumentBatchJobCreateResult, *http.Response, error)

ConvertDocumentApiService Convert Document to PDF as Batch Job Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, text files, and even multi-page TIFF files. This API is designed for large jobs that could take a long time to create and so runs as a batch job that returns a Job ID that you can use with the GetAsyncJobStatus API to check on the status of the Job and ultimately get the output result. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return ConvertDocumentBatchJobCreateResult

func (*ConvertDocumentApiService) ConvertDocumentAutodetectToPngArray ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentAutodetectToPngArray(ctx context.Context, inputFile *os.File) (AutodetectToPngResult, *http.Response, error)

ConvertDocumentApiService Convert Document to PNG array Automatically detect file type and convert it to an array of PNG images. Supports all of the major Office document file formats, over 100 image formats, and even multi-page TIFF files.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return AutodetectToPngResult

func (*ConvertDocumentApiService) ConvertDocumentAutodetectToThumbnail ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentAutodetectToThumbnail(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentAutodetectToThumbnailOpts) (string, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentAutodetectToThumbnailsAdvanced ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentAutodetectToThumbnailsAdvanced(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentAutodetectToThumbnailsAdvancedOpts) (AutodetectToThumbnailsResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentAutodetectToTxt ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentAutodetectToTxt(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentAutodetectToTxtOpts) (TextConversionResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentCsvMultiToXlsx ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentCsvMultiToXlsx(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File, localVarOptionals *ConvertDocumentCsvMultiToXlsxOpts) (string, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentCsvToHtml ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentCsvToHtml(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert CSV to HTML document Convert Comma-Separated Values (CSV) file to HTML document.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentCsvToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentCsvToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert CSV to PDF document Convert Comma-Separated Values (CSV) file to PDF document.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentCsvToXlsx ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentCsvToXlsx(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert CSV to Excel XLSX Spreadsheet Convert CSV file to Office Excel XLSX Workbooks file format.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentDocToDocx ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentDocToDocx(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Word DOC (97-03) Document to DOCX Convert/upgrade Office Word (97-2003 Format) Documents (doc) to the modern DOCX format

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentDocToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentDocToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Word DOC (97-03) Document to PDF Convert Office Word (97-2003 Format) Documents (doc) to standard PDF

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentDocToTxt ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentDocToTxt(ctx context.Context, inputFile *os.File) (TextConversionResult, *http.Response, error)

ConvertDocumentApiService Convert Word DOC (97-03) Document to Text (txt) Convert Office Word DOC (97-03) Document (doc) to text

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return TextConversionResult

func (*ConvertDocumentApiService) ConvertDocumentDocxToDoc ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentDocxToDoc(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Word DOCX Document to Legacy Word DOC (97-03) Convert/downgrade modern Office Word DOCX Documents (DOCX) to the legacy Word DOC (97-2003 Format) format

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentDocxToHtml ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentDocxToHtml(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Word DOCX Document to HTML Document Convert Office Word Document (DOCX) to HTML Document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentDocxToJpg ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentDocxToJpg(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentDocxToJpgOpts) (DocxToJpgResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentDocxToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentDocxToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Word DOCX Document to PDF Convert Office Word Documents (docx) to standard PDF

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentDocxToPng ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentDocxToPng(ctx context.Context, inputFile *os.File) (DocxToPngResult, *http.Response, error)

ConvertDocumentApiService Convert Word DOCX Document to PNG image array Converts an Office Word Document (DOCX) file to an array of PNG images, one for each page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocxToPngResult

func (*ConvertDocumentApiService) ConvertDocumentDocxToRtf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentDocxToRtf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Word DOCX Document to RTF Convert an Office Word Document (DOCX) to Rich Text Format Document (RTF)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentDocxToTxt ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentDocxToTxt(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentDocxToTxtOpts) (TextConversionResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentEmlToHtml ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentEmlToHtml(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentEmlToHtmlOpts) (EmlToHtmlResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentEmlToJpg ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentEmlToJpg(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentEmlToJpgOpts) (EmlToJpgResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentEmlToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentEmlToPdf(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentEmlToPdfOpts) (string, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentEmlToPng ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentEmlToPng(ctx context.Context, inputFile *os.File) (EmlToPngResult, *http.Response, error)

ConvertDocumentApiService Convert Email EML file to PNG image array Converts an Outlook Email File (EML) to an array of PNG images, one for each page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return EmlToPngResult

func (*ConvertDocumentApiService) ConvertDocumentGetAsyncJobStatus ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentGetAsyncJobStatus(ctx context.Context, asyncJobID string) (ConvertDocumentJobStatusResult, *http.Response, error)

ConvertDocumentApiService Get the status and result of a Convert Document Batch Job Returns the result of the Async Job - possible states can be STARTED or COMPLETED. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param asyncJobID

@return ConvertDocumentJobStatusResult

func (*ConvertDocumentApiService) ConvertDocumentGetFileTypeIcon ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentGetFileTypeIcon(ctx context.Context, fileExtension string, localVarOptionals *ConvertDocumentGetFileTypeIconOpts) (string, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentGetFileTypeIconAdvanced ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentGetFileTypeIconAdvanced(ctx context.Context, fileExtension string, localVarOptionals *ConvertDocumentGetFileTypeIconAdvancedOpts) (GetFileTypeIconResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentHtmlToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentHtmlToPdf(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentHtmlToPdfOpts) (string, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentHtmlToPng ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentHtmlToPng(ctx context.Context, inputFile *os.File) (PdfToPngResult, *http.Response, error)

ConvertDocumentApiService Convert HTML document file to PNG image array Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page. To use external files in your HTML such as images, use an absolute URL to the file.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return PdfToPngResult

func (*ConvertDocumentApiService) ConvertDocumentHtmlToTxt ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentHtmlToTxt(ctx context.Context, inputFile *os.File) (TextConversionResult, *http.Response, error)

ConvertDocumentApiService HTML Document file to Text (txt) HTML document to text

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return TextConversionResult

func (*ConvertDocumentApiService) ConvertDocumentKeynoteToJpg ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentKeynoteToJpg(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentKeynoteToJpgOpts) (KeynoteToJpgResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentKeynoteToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentKeynoteToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Keynote Presentation (KEY) to PDF Convert Mac Keynote Presentation (KEY) to standard PDF

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentKeynoteToPng ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentKeynoteToPng(ctx context.Context, inputFile *os.File) (KeynoteToPngResult, *http.Response, error)

ConvertDocumentApiService Convert Keynote Presentation (KEY) to PNG image array Converts a Mac Keynote Presentation (KEY) to an array of PNG images, one for each page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return KeynoteToPngResult

func (*ConvertDocumentApiService) ConvertDocumentKeynoteToPptx ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentKeynoteToPptx(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Keynote Presentation (KEY) to PPTX Convert Mac Keynote Presentation (KEY) to PowerPoint Presentation (PPTX)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentMsgToHtml ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentMsgToHtml(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentMsgToHtmlOpts) (MsgToHtmlResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentMsgToJpg ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentMsgToJpg(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentMsgToJpgOpts) (MsgToJpgResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentMsgToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentMsgToPdf(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentMsgToPdfOpts) (string, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentMsgToPng ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentMsgToPng(ctx context.Context, inputFile *os.File) (MsgToPngResult, *http.Response, error)

ConvertDocumentApiService Convert Email MSG file to PNG image array Converts an Outlook Email Message File (MSG) to an array of PNG images, one for each page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return MsgToPngResult

func (*ConvertDocumentApiService) ConvertDocumentOdpToJpg ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentOdpToJpg(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentOdpToJpgOpts) (OdpToJpgResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentOdpToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentOdpToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert ODP Presentation to PDF Convert Office Open Document Presentation (ODP) to standard PDF

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentOdpToPng ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentOdpToPng(ctx context.Context, inputFile *os.File) (OdpToPngResult, *http.Response, error)

ConvertDocumentApiService Convert ODP Presentation to PNG image array Converts an Office Open Document Presentation (ODP) to an array of PNG images, one for each page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return OdpToPngResult

func (*ConvertDocumentApiService) ConvertDocumentOdpToPptx ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentOdpToPptx(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert ODP Presentation to PPTX Convert Office Open Document Presentation (ODP) to PowerPoint Presentation (PPTX)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentOdsToJpg ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentOdsToJpg(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentOdsToJpgOpts) (OdsToJpgResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentOdsToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentOdsToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert ODS Spreadsheet to PDF Convert Office Open Document Spreadsheet (ODS) to standard PDF

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentOdsToPng ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentOdsToPng(ctx context.Context, inputFile *os.File) (OdsToPngResult, *http.Response, error)

ConvertDocumentApiService Convert ODS Spreadsheet to PNG image array Converts an Office Open Document Spreadsheet (ODS) to an array of PNG images, one for each page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return OdsToPngResult

func (*ConvertDocumentApiService) ConvertDocumentOdsToXlsx ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentOdsToXlsx(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert ODS Spreadsheet to XLSX Convert Office Open Document Spreadsheet (ODS) to Excel Spreadsheet (XLSX)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentOdtToDocx ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentOdtToDocx(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert ODT Text File to Word DOCX Convert Office Open Document Text File (ODT) to Word DOCX Document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentOdtToJpg ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentOdtToJpg(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentOdtToJpgOpts) (OdtToJpgResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentOdtToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentOdtToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert ODT Text File to PDF Convert Office Open Document Text File (ODT) to standard PDF

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentOdtToPng ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentOdtToPng(ctx context.Context, inputFile *os.File) (OdtToPngResult, *http.Response, error)

ConvertDocumentApiService Convert ODT Text File to PNG image array Converts an Office Open Document Text File (ODT) to an array of PNG images, one for each page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return OdtToPngResult

func (*ConvertDocumentApiService) ConvertDocumentPdfToDocx ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPdfToDocx(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert PDF to Word DOCX Document Convert standard PDF to Office Word Documents (docx). Converts a PDF at high fidelity into Word format, where it can be easily edited and processed.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentPdfToDocxRasterize ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPdfToDocxRasterize(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert PDF to Word DOCX Document based on rasterized version of the PDF Convert standard PDF to Office Word Documents (docx), but first rasterize the PDF. Converts a PDF at high fidelity into Word format.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentPdfToJpg ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPdfToJpg(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentPdfToJpgOpts) (PdfToJpgResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentPdfToPngArray ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPdfToPngArray(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentPdfToPngArrayOpts) (PdfToPngResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentPdfToPngArrayDirect ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPdfToPngArrayDirect(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentPdfToPngArrayDirectOpts) (PdfToPngDirectResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentPdfToPngSingle ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPdfToPngSingle(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert PDF to Single PNG image Convert PDF document to a single tall PNG image, by stacking/concatenating the images vertically into a single \"tall\" image

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentPdfToPptx ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPdfToPptx(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert PDF to PowerPoint PPTX Presentation Convert standard PDF to Office PowerPoint Presentation (pptx). Converts a PDF file at high fidelity into PowerPoint format, where it can be easily edited and processed.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentPdfToTiff ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPdfToTiff(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentPdfToTiffOpts) (string, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentPdfToTxt ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPdfToTxt(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentPdfToTxtOpts) (TextConversionResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentPngArrayToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPngArrayToPdf(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File, localVarOptionals *ConvertDocumentPngArrayToPdfOpts) (string, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentPngArrayToPdfFlattenTransparency ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPngArrayToPdfFlattenTransparency(ctx context.Context) (interface{}, *http.Response, error)

ConvertDocumentApiService Convert PNG Array to PDF and remove transparency Convert an array of PNG images, remove transparency in source images, one image per page, into a newly-created PDF. Supports images of different sizes as input.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return interface{}

func (*ConvertDocumentApiService) ConvertDocumentPptToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPptToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert PowerPoint PPT (97-03) Presentation to PDF Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentPptToPptx ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPptToPptx(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert PowerPoint PPT (97-03) Presentation to PPTX Convert/upgrade Office PowerPoint (97-2003) Documents (ppt) to modern PPTX

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentPptxToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPptxToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert PowerPoint PPTX Presentation to PDF Convert Office PowerPoint Documents (pptx) to standard PDF

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentPptxToPng ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPptxToPng(ctx context.Context, inputFile *os.File) (PptxToPngResult, *http.Response, error)

ConvertDocumentApiService Convert PowerPoint PPTX to PNG image array Converts a PowerPoint Presentation (PPTX) file to an array of PNG images, one for each page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return PptxToPngResult

func (*ConvertDocumentApiService) ConvertDocumentPptxToPpt ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPptxToPpt(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03) Convert/downgrade modern Office PowerPoint PPTX Presentation to the legacy PowerPoint PPT (97-2003 Format) format

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentPptxToTxt ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentPptxToTxt(ctx context.Context, inputFile *os.File) (TextConversionResult, *http.Response, error)

ConvertDocumentApiService Convert PowerPoint PPTX Presentation to Text (txt) Convert Office PowerPoint Documents (pptx) to standard Text

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return TextConversionResult

func (*ConvertDocumentApiService) ConvertDocumentRtfToDocx ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentRtfToDocx(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Rich Text Format RTF to DOCX Document Convert Rich Text Format Document (RTF) to Word DOCX Document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentRtfToHtml ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentRtfToHtml(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Rich Text Format RTF to HTML Document Convert Rich Text Format Document (RTF) to HTML Document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentRtfToJpg ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentRtfToJpg(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentRtfToJpgOpts) (RtfToJpgResult, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentRtfToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentRtfToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Rich Text Format RTF to PDF Convert Rich Text Format Document (RTF) to standard PDF

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentRtfToPng ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentRtfToPng(ctx context.Context, inputFile *os.File) (RtfToPngResult, *http.Response, error)

ConvertDocumentApiService Convert Rich Text Format RTF to PNG image array Converts a Rich Text Format Document (RTF) to an array of PNG images, one for each page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return RtfToPngResult

func (*ConvertDocumentApiService) ConvertDocumentTxtToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentTxtToPdf(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentTxtToPdfOpts) (string, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentXlsToCsv ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentXlsToCsv(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Excel XLS (97-03) Spreadsheet to CSV Convert/upgrade Office Excel (97-2003) Workbooks (xls) to standard CSV format.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentXlsToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentXlsToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Excel XLS (97-03) Spreadsheet to PDF Convert Office Excel (97-2003) Workbooks (xls) to standard PDF. Converts all worksheets in the workbook to PDF.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentXlsToXlsx ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentXlsToXlsx(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Excel XLS (97-03) Spreadsheet to XLSX Convert/upgrade Office Excel (97-2003) Workbooks (xls) to modern XLSX format.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentXlsxToCsv ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentXlsxToCsv(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentXlsxToCsvOpts) (string, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentXlsxToCsvMulti ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentXlsxToCsvMulti(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertDocumentXlsxToCsvMultiOpts) (CsvCollection, *http.Response, error)

func (*ConvertDocumentApiService) ConvertDocumentXlsxToHtml ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentXlsxToHtml(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Excel XLSX Spreadsheet to HTML Document Convert Office Excel Spreadsheet (XLSX) to HTML Document. Converts all worksheets to HTML. Supports both XLSX and XLSB Excel file formats.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentXlsxToPdf ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentXlsxToPdf(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Excel XLSX Spreadsheet to PDF Convert Office Excel Workbooks (XLSX) to standard PDF. Converts all worksheets in the workbook to PDF. Supports both XLSX and XLSB Excel file formats.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertDocumentApiService) ConvertDocumentXlsxToPng ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentXlsxToPng(ctx context.Context, inputFile *os.File) (XlsxToPngResult, *http.Response, error)

ConvertDocumentApiService Convert Excel XLSX spreadsheet to PNG image array Converts an Excel Spreadsheet (XLSX) file to an array of PNG images, one for each page.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return XlsxToPngResult

func (*ConvertDocumentApiService) ConvertDocumentXlsxToTxt ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentXlsxToTxt(ctx context.Context, inputFile *os.File) (TextConversionResult, *http.Response, error)

ConvertDocumentApiService Convert Excel XLSX Spreadsheet to Text (txt) Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats. When a spreadsheet contains multiple worksheets, will export all of the text from all of the worksheets. If you wish to export the text from only one worksheet, try using the Split XLSX API to split the spreadsheet into multiple worksheet files, and then run XLSX to Text on the individual worksheet file that you need to extract the text from.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return TextConversionResult

func (*ConvertDocumentApiService) ConvertDocumentXlsxToXls ¶ 

func (a *ConvertDocumentApiService) ConvertDocumentXlsxToXls(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ConvertDocumentApiService Convert Excel XLSX Spreadsheet to Legacy Excel XLS (97-03) Convert/downgrade modern Office Excel XLSX Spreadsheet to the legacy Excel XLS (97-2003 Format) format

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

type ConvertDocumentAutodetectToJpgOpts ¶ 

type ConvertDocumentAutodetectToJpgOpts struct {
	Quality optional.Int32
}

type ConvertDocumentAutodetectToThumbnailOpts ¶ 

type ConvertDocumentAutodetectToThumbnailOpts struct {
	MaxWidth  optional.Int32
	MaxHeight optional.Int32
	Extension optional.String
}

type ConvertDocumentAutodetectToThumbnailsAdvancedOpts ¶ 

type ConvertDocumentAutodetectToThumbnailsAdvancedOpts struct {
	Pages     optional.Int32
	MaxWidth  optional.Int32
	MaxHeight optional.Int32
	Extension optional.String
}

type ConvertDocumentAutodetectToTxtOpts ¶ 

type ConvertDocumentAutodetectToTxtOpts struct {
	TextFormattingMode optional.String
}

type ConvertDocumentBatchJobCreateResult ¶ 

type ConvertDocumentBatchJobCreateResult struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// When creating a job, an Async Job ID is returned.  Use the GetAsyncJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes
	AsyncJobID string `json:"AsyncJobID,omitempty"`
}

Result of performing a convert documentbatch job operation

type ConvertDocumentCsvMultiToXlsxOpts ¶ 

type ConvertDocumentCsvMultiToXlsxOpts struct {
	InputFile3     optional.Interface
	InputFile4     optional.Interface
	InputFile5     optional.Interface
	InputFile6     optional.Interface
	InputFile7     optional.Interface
	InputFile8     optional.Interface
	InputFile9     optional.Interface
	InputFile10    optional.Interface
	WorksheetNames optional.String
}

type ConvertDocumentDocxToJpgOpts ¶ 

type ConvertDocumentDocxToJpgOpts struct {
	Quality optional.Int32
}

type ConvertDocumentDocxToTxtOpts ¶ 

type ConvertDocumentDocxToTxtOpts struct {
	TextFormattingMode optional.String
}

type ConvertDocumentEmlToHtmlOpts ¶ 

type ConvertDocumentEmlToHtmlOpts struct {
	BodyOnly           optional.Bool
	IncludeAttachments optional.Bool
}

type ConvertDocumentEmlToJpgOpts ¶ 

type ConvertDocumentEmlToJpgOpts struct {
	Quality optional.Int32
}

type ConvertDocumentEmlToPdfOpts ¶ 

type ConvertDocumentEmlToPdfOpts struct {
	BodyOnly optional.Bool
}

type ConvertDocumentGetFileTypeIconAdvancedOpts ¶ 

type ConvertDocumentGetFileTypeIconAdvancedOpts struct {
	IconSize optional.Int32
}

type ConvertDocumentGetFileTypeIconOpts ¶ 

type ConvertDocumentGetFileTypeIconOpts struct {
	IconSize optional.Int32
}

type ConvertDocumentHtmlToPdfOpts ¶ 

type ConvertDocumentHtmlToPdfOpts struct {
	IncludeBackgroundGraphics optional.Bool
	ScaleFactor               optional.Int32
}

type ConvertDocumentJobStatusResult ¶ 

type ConvertDocumentJobStatusResult struct {
	// Tru eif the operation to check the status of the job was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Returns the job status of the Async Job, if applicable.  Possible states are STARTED and COMPLETED
	AsyncJobStatus string `json:"AsyncJobStatus,omitempty"`
	// When the job exceeds 25 pages, an Async Job ID is returned.  Use the CheckPdfOcrJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes
	AsyncJobID string `json:"AsyncJobID,omitempty"`
	// Output file result (if applicable)
	OutputFileResult string `json:"OutputFileResult,omitempty"`
	// Error message (if any)
	ErrorMessage string `json:"ErrorMessage,omitempty"`
}

Result of performing a batch job operation

type ConvertDocumentKeynoteToJpgOpts ¶ 

type ConvertDocumentKeynoteToJpgOpts struct {
	Quality optional.Int32
}

type ConvertDocumentMsgToHtmlOpts ¶ 

type ConvertDocumentMsgToHtmlOpts struct {
	BodyOnly           optional.Bool
	IncludeAttachments optional.Bool
}

type ConvertDocumentMsgToJpgOpts ¶ 

type ConvertDocumentMsgToJpgOpts struct {
	Quality optional.Int32
}

type ConvertDocumentMsgToPdfOpts ¶ 

type ConvertDocumentMsgToPdfOpts struct {
	BodyOnly optional.Bool
}

type ConvertDocumentOdpToJpgOpts ¶ 

type ConvertDocumentOdpToJpgOpts struct {
	Quality optional.Int32
}

type ConvertDocumentOdsToJpgOpts ¶ 

type ConvertDocumentOdsToJpgOpts struct {
	Quality optional.Int32
}

type ConvertDocumentOdtToJpgOpts ¶ 

type ConvertDocumentOdtToJpgOpts struct {
	Quality optional.Int32
}

type ConvertDocumentPdfToJpgOpts ¶ 

type ConvertDocumentPdfToJpgOpts struct {
	Quality optional.Int32
}

type ConvertDocumentPdfToPngArrayDirectOpts ¶ 

type ConvertDocumentPdfToPngArrayDirectOpts struct {
	Dpi optional.Int32
}

type ConvertDocumentPdfToPngArrayOpts ¶ 

type ConvertDocumentPdfToPngArrayOpts struct {
	Dpi optional.Int32
}

type ConvertDocumentPdfToTiffOpts ¶ 

type ConvertDocumentPdfToTiffOpts struct {
	Dpi            optional.Int32
	LzwCompression optional.Bool
}

type ConvertDocumentPdfToTxtOpts ¶ 

type ConvertDocumentPdfToTxtOpts struct {
	TextFormattingMode optional.String
}

type ConvertDocumentPngArrayToPdfOpts ¶ 

type ConvertDocumentPngArrayToPdfOpts struct {
	InputFile3  optional.Interface
	InputFile4  optional.Interface
	InputFile5  optional.Interface
	InputFile6  optional.Interface
	InputFile7  optional.Interface
	InputFile8  optional.Interface
	InputFile9  optional.Interface
	InputFile10 optional.Interface
}

type ConvertDocumentRtfToJpgOpts ¶ 

type ConvertDocumentRtfToJpgOpts struct {
	Quality optional.Int32
}

type ConvertDocumentTxtToPdfOpts ¶ 

type ConvertDocumentTxtToPdfOpts struct {
	ScaleFactor optional.Int32
}

type ConvertDocumentXlsxToCsvMultiOpts ¶ 

type ConvertDocumentXlsxToCsvMultiOpts struct {
	OutputEncoding optional.String
}

type ConvertDocumentXlsxToCsvOpts ¶ 

type ConvertDocumentXlsxToCsvOpts struct {
	OutputEncoding optional.String
}

type ConvertImageApiService ¶ 

type ConvertImageApiService service

func (*ConvertImageApiService) ConvertImageGetImageInfo ¶ 

func (a *ConvertImageApiService) ConvertImageGetImageInfo(ctx context.Context, inputFile *os.File) (GetImageInfoResult, *http.Response, error)

ConvertImageApiService Get information about an image Get details from an image such as size, format and MIME type, compression, EXIF data such as location, DPI, unique colors, transparency information, and more

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return GetImageInfoResult

func (*ConvertImageApiService) ConvertImageImageFormatConvert ¶ 

func (a *ConvertImageApiService) ConvertImageImageFormatConvert(ctx context.Context, format1 string, format2 string, inputFile *os.File) (string, *http.Response, error)

ConvertImageApiService Image format conversion Convert between over 100 file formats, including key formats such as Photoshop (PSD), PNG, JPG, GIF, NEF, and BMP.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param format1 Input file format as a 3+ letter file extension. You can also provide UNKNOWN for unknown file formats. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
  • @param format2 Output (convert to this format) file format as a 3+ letter file extension. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertImageApiService) ConvertImageImageSetDPI ¶ 

func (a *ConvertImageApiService) ConvertImageImageSetDPI(ctx context.Context, dpi int32, inputFile *os.File) (string, *http.Response, error)

ConvertImageApiService Change image DPI Resize an image to have a different DPI

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param dpi New DPI in pixels-per-inch, for example 300 DPI or 600 DPI
  • @param inputFile Input file to perform the operation on.

@return string

func (*ConvertImageApiService) ConvertImageMultipageImageFormatConvert ¶ 

func (a *ConvertImageApiService) ConvertImageMultipageImageFormatConvert(ctx context.Context, format1 string, format2 string, inputFile *os.File, localVarOptionals *ConvertImageMultipageImageFormatConvertOpts) (MultipageImageFormatConversionResult, *http.Response, error)

type ConvertImageMultipageImageFormatConvertOpts ¶ 

type ConvertImageMultipageImageFormatConvertOpts struct {
	Dpi optional.Int32
}

type ConvertTemplateApiService ¶ 

type ConvertTemplateApiService service

func (*ConvertTemplateApiService) ConvertTemplateApplyDocxTemplate ¶ 

func (a *ConvertTemplateApiService) ConvertTemplateApplyDocxTemplate(ctx context.Context, inputFile *os.File, localVarOptionals *ConvertTemplateApplyDocxTemplateOpts) (string, *http.Response, error)

func (*ConvertTemplateApiService) ConvertTemplateApplyHtmlTemplate ¶ 

func (a *ConvertTemplateApiService) ConvertTemplateApplyHtmlTemplate(ctx context.Context, value HtmlTemplateApplicationRequest) (HtmlTemplateApplicationResponse, *http.Response, error)

ConvertTemplateApiService Apply HTML template Apply operations to fill in an HTML template, generating a final HTML result

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param value Operations to apply to template

@return HtmlTemplateApplicationResponse

type ConvertTemplateApplyDocxTemplateOpts ¶ 

type ConvertTemplateApplyDocxTemplateOpts struct {
	TemplateDefinition optional.Interface
}

type ConvertWebApiService ¶ 

type ConvertWebApiService service

func (*ConvertWebApiService) ConvertWebHtmlToDocx ¶ 

func (a *ConvertWebApiService) ConvertWebHtmlToDocx(ctx context.Context, inputRequest HtmlToOfficeRequest) (string, *http.Response, error)

ConvertWebApiService Convert HTML to Word DOCX Document Convert HTML to Office Word Document (DOCX) format

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputRequest HTML input to convert to DOCX

@return string

func (*ConvertWebApiService) ConvertWebHtmlToPdf ¶ 

func (a *ConvertWebApiService) ConvertWebHtmlToPdf(ctx context.Context, input HtmlToPdfRequest) (string, *http.Response, error)

ConvertWebApiService Convert HTML string to PDF Fully renders a website and returns a PDF of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input HTML to PDF request parameters

@return string

func (*ConvertWebApiService) ConvertWebHtmlToPng ¶ 

func (a *ConvertWebApiService) ConvertWebHtmlToPng(ctx context.Context, input HtmlToPngRequest) (string, *http.Response, error)

ConvertWebApiService Convert HTML string to PNG screenshot Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input HTML to PNG request parameters

@return string

func (*ConvertWebApiService) ConvertWebHtmlToTxt ¶ 

func (a *ConvertWebApiService) ConvertWebHtmlToTxt(ctx context.Context, input HtmlToTextRequest) (HtmlToTextResponse, *http.Response, error)

ConvertWebApiService Convert HTML string to text (txt) Converts an HTML string input into text (txt); extracts text from HTML

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input HTML to Text request parameters

@return HtmlToTextResponse

func (*ConvertWebApiService) ConvertWebMdToHtml ¶ 

func (a *ConvertWebApiService) ConvertWebMdToHtml(ctx context.Context, inputFile *os.File) (HtmlMdResult, *http.Response, error)

ConvertWebApiService Convert Markdown to HTML Convert a markdown file (.md) to HTML

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return HtmlMdResult

func (*ConvertWebApiService) ConvertWebUrlToPdf ¶ 

func (a *ConvertWebApiService) ConvertWebUrlToPdf(ctx context.Context, input UrlToPdfRequest) (string, *http.Response, error)

ConvertWebApiService Convert a URL to PDF Fully renders a website and returns a PDF of the full page. Javascript, HTML5, CSS and other advanced features are all supported.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input URL to PDF request parameters

@return string

func (*ConvertWebApiService) ConvertWebUrlToScreenshot ¶ 

func (a *ConvertWebApiService) ConvertWebUrlToScreenshot(ctx context.Context, input ScreenshotRequest) (string, *http.Response, error)

ConvertWebApiService Take screenshot of URL Fully renders a website and returns a PNG screenshot of the full page image. Javascript, HTML5, CSS and other advanced features are all supported.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Screenshot request parameters

@return string

func (*ConvertWebApiService) ConvertWebUrlToTxt ¶ 

func (a *ConvertWebApiService) ConvertWebUrlToTxt(ctx context.Context, input UrlToTextRequest) (UrlToTextResponse, *http.Response, error)

ConvertWebApiService Convert website URL page to text (txt) Converts a website URL page into text (txt); extracts text from HTML

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input HTML to Text request parameters

@return UrlToTextResponse

type ConvertedJpgPage ¶ 

type ConvertedJpgPage struct {
	// Page number of the converted page, starting with 1
	PageNumber int32 `json:"PageNumber,omitempty"`
	// The JPG file of this page as a byte array
	Content string `json:"Content,omitempty"`
}

A single converted page

type ConvertedPngDirectPage ¶ 

type ConvertedPngDirectPage struct {
	// Page number of the converted page, starting with 1
	PageNumber int32 `json:"PageNumber,omitempty"`
	// PNG binary image file data in bytes
	ImageData string `json:"ImageData,omitempty"`
}

A single converted page

type ConvertedPngPage ¶ 

type ConvertedPngPage struct {
	// Page number of the converted page, starting with 1
	PageNumber int32 `json:"PageNumber,omitempty"`
	// URL to the PNG file of this page; file is stored in an in-memory cache and will be deleted
	URL string `json:"URL,omitempty"`
}

A single converted page

type CreateBlankDocxRequest ¶ 

type CreateBlankDocxRequest struct {
	// Optional; initial text to include in the document
	InitialText string `json:"InitialText,omitempty"`
}

Input to a Create Blank Word Document request

type CreateBlankDocxResponse ¶ 

type CreateBlankDocxResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of creating a blank Word document

type CreateBlankSpreadsheetRequest ¶ 

type CreateBlankSpreadsheetRequest struct {
	// The blank Spreadsheet will have a default Worksheet in it; supply a name, or if left empty, will default to Worksheet1
	WorksheetName string `json:"WorksheetName,omitempty"`
}

Input to a Create Blank Spreadsheet request

type CreateBlankSpreadsheetResponse ¶ 

type CreateBlankSpreadsheetResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of creating a blank worksheet

type CreateSpreadsheetFromDataRequest ¶ 

type CreateSpreadsheetFromDataRequest struct {
	// Optional; The new Spreadsheet will have a default Worksheet in it; supply a name, or if left empty, will default to Worksheet1
	WorksheetName string `json:"WorksheetName,omitempty"`
	// Required; Rows and cells to populate the spreadsheet with
	Rows []XlsxSpreadsheetRow `json:"Rows,omitempty"`
}

Input to Create a new Spreadsheet request

type CreateSpreadsheetFromDataResponse ¶ 

type CreateSpreadsheetFromDataResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of creating a new worksheet from rows and cells

type CreateZipArchiveRequest ¶ 

type CreateZipArchiveRequest struct {
	// Top-level files in the root directory fo the zip file
	FilesInZip []ZipFile `json:"FilesInZip,omitempty"`
	// Top-level directories in the root directory of the zip; directories can contain sub-directories and files
	DirectoriesInZip []ZipDirectory `json:"DirectoriesInZip,omitempty"`
}

Request to create a Zip Archive

type CsvCollection ¶ 

type CsvCollection struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of CSV File results
	CsvFiles []CsvFileResult `json:"CsvFiles,omitempty"`
	// Count of the number of CSV files produced
	FileCount int32 `json:"FileCount,omitempty"`
}

Collection of CSV Files

type CsvFileResult ¶ 

type CsvFileResult struct {
	// Title of the CSV file
	Title string `json:"Title,omitempty"`
	// Contents of the CSV file
	FileContents string `json:"FileContents,omitempty"`
}

CSV file result

type DeleteDocxTableRowRangeRequest ¶ 

type DeleteDocxTableRowRangeRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Path to the table to delete the row from
	TablePath string `json:"TablePath,omitempty"`
	// 0-based index of the row to begin deleting rows (e.g. 0, 1, 2, ...) in the table
	TableRowRowIndexStart int32 `json:"TableRowRowIndexStart,omitempty"`
	// 0-based index of the row to stop deleting rows (e.g. 0, 1, 2, ...) in the table
	TableRowRowIndexEnd int32 `json:"TableRowRowIndexEnd,omitempty"`
}

Input to a delete DOCX table row range request

type DeleteDocxTableRowRangeResponse ¶ 

type DeleteDocxTableRowRangeResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running an Delete Table Row Range command

type DeleteDocxTableRowRequest ¶ 

type DeleteDocxTableRowRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Path to the table to delete the row from
	TablePath string `json:"TablePath,omitempty"`
	// 0-based index of the row to delete (e.g. 0, 1, 2, ...) in the table
	TableRowRowIndex int32 `json:"TableRowRowIndex,omitempty"`
}

Input to a delete DOCX table row request

type DeleteDocxTableRowResponse ¶ 

type DeleteDocxTableRowResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running an Delete Table Row command

type DetectLineEndingsResponse ¶ 

type DetectLineEndingsResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Type of newline in the file; possible vlaues are \"Mac\" (legacy Mac OS uses carriage return only); \"Unix\" (Unix and Linux OSes, and modern Mac OS); \"Windows\" (Windows operating systems)
	PrimaryNewlineType string `json:"PrimaryNewlineType,omitempty"`
	// Characters used to terminate a newline; can be carriage return, linefeed, or carriage return + linefeed
	PrimaryNewlineTerminator string `json:"PrimaryNewlineTerminator,omitempty"`
	// Length of the input string in characters
	InputLength int32 `json:"InputLength,omitempty"`
}

Result of base 64 decoding

type DisableSharedWorkbookRequest ¶ 

type DisableSharedWorkbookRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Disable Shared Workbook request

type DisableSharedWorkbookResponse ¶ 

type DisableSharedWorkbookResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running a Disable Shared Workbook command

type DocumentArrayInput ¶ 

type DocumentArrayInput struct {
	// Array of document objects
	Documents []DocumentItem `json:"Documents,omitempty"`
}

Input array of documents to be processed for a merge operation

type DocumentEditingEditSession ¶ 

type DocumentEditingEditSession struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Document editing session URL; in-memory temporary cache link with TTL (Time-to-Live expiration) of 30 minutes.  To retrieve the document, use the Finish Editing API.
	EditSessionURL string `json:"EditSessionURL,omitempty"`
}

Active document editing session result. To retrieve the document, use the Finish Editing API.

type DocumentItem ¶ 

type DocumentItem struct {
	// File name of the document
	DocumentFileName string `json:"DocumentFileName,omitempty"`
	// Contents of the document as a binary byte array
	DocumentContent string `json:"DocumentContent,omitempty"`
}

Object representing one document

type DocumentTransformEditSession ¶ 

type DocumentTransformEditSession struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Document editing session URL; in-memory temporary cache link with TTL (Time-to-Live expiration) of 30 minutes.  To retrieve the document, use the Finish Editing API.
	EditSessionURL string `json:"EditSessionURL,omitempty"`
}

Active document editing session result. To retrieve the document, use the Finish Editing API.

type DocumentValidationError ¶ 

type DocumentValidationError struct {
	// Description of the error
	Description string `json:"Description,omitempty"`
	// XPath to the error
	Path string `json:"Path,omitempty"`
	// URI of the part in question
	Uri string `json:"Uri,omitempty"`
	// True if this is an error, false otherwise
	IsError bool `json:"IsError,omitempty"`
}

Validation error found in document

type DocumentValidationResult ¶ 

type DocumentValidationResult struct {
	// True if the document is valid and has no errors, false otherwise
	DocumentIsValid bool `json:"DocumentIsValid,omitempty"`
	// True if the document is password protected, false otherwise
	PasswordProtected bool `json:"PasswordProtected,omitempty"`
	// Number of validation errors found in the document
	ErrorCount int32 `json:"ErrorCount,omitempty"`
	// Number of validation warnings found in the document
	WarningCount int32 `json:"WarningCount,omitempty"`
	// Details of errors and warnings found
	ErrorsAndWarnings []DocumentValidationError `json:"ErrorsAndWarnings,omitempty"`
}

Document validation result

type DocxBody ¶ 

type DocxBody struct {
	// The Path of the location of this object; leave blank for new tables
	Path string `json:"Path,omitempty"`
	// All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document
	AllParagraphs []DocxParagraph `json:"AllParagraphs,omitempty"`
	// All tables anywhere in the document; these objects are not sequentially placed but are scatted across the document
	AllTables []DocxTable `json:"AllTables,omitempty"`
}

type DocxCellStyle ¶ 

type DocxCellStyle struct {
	// The Path of the location of this object; leave blank for new rows
	Path string `json:"Path,omitempty"`
	// Name of the style
	Name string `json:"Name,omitempty"`
	// Format ID of the cell style
	FormatID int32 `json:"FormatID,omitempty"`
	// Built=in ID of the cell style
	BuiltInID int32 `json:"BuiltInID,omitempty"`
}

Style in an Excel spreadsheet

type DocxComment ¶ 

type DocxComment struct {
	// Path to the comment in the document
	Path string `json:"Path,omitempty"`
	// Author name of the comment
	Author string `json:"Author,omitempty"`
	// Initials of the author of the comment
	AuthorInitials string `json:"AuthorInitials,omitempty"`
	// Text content of the comment
	CommentText string `json:"CommentText,omitempty"`
	// Date timestamp of the comment
	CommentDate time.Time `json:"CommentDate,omitempty"`
	// True if the comment is at the top level, false if this comment is a child reply of another comment
	IsTopLevel bool `json:"IsTopLevel,omitempty"`
	// True if this comment is a reply to another comment, false otherwise
	IsReply bool `json:"IsReply,omitempty"`
	// Path to the parent of this comment, if this comment is a reply, otherwise this value will be null
	ParentCommentPath string `json:"ParentCommentPath,omitempty"`
	// True if this comment is marked as Done in Word, otherwise it is false
	Done bool `json:"Done,omitempty"`
}

Comment in a Word Document

type DocxContentControl ¶ 

type DocxContentControl struct {
	// Text content value in the content control; text entered into the control
	Value string `json:"Value,omitempty"`
}

Content Control instance

type DocxFooter ¶ 

type DocxFooter struct {
	// The Path of the location of this object; leave blank for new tables
	Path string `json:"Path,omitempty"`
	// Paragraphs in this footer
	Paragraphs []DocxParagraph `json:"Paragraphs,omitempty"`
	// Sections that the footer is applied to
	SectionsWithFooter []DocxSection `json:"SectionsWithFooter,omitempty"`
}

Footer in a Word Document (DOCX)

type DocxHeader ¶ 

type DocxHeader struct {
	// The Path of the location of this object; leave blank for new tables
	Path string `json:"Path,omitempty"`
	// Paragraphs in this header
	Paragraphs []DocxParagraph `json:"Paragraphs,omitempty"`
	// Sections that the header is applied to
	SectionsWithHeader []DocxSection `json:"SectionsWithHeader,omitempty"`
}

Header of a Word Document (DOCX)

type DocxImage ¶ 

type DocxImage struct {
	// The Path of the location of this object; leave blank for new tables
	Path string `json:"Path,omitempty"`
	// The Name of the image
	ImageName string `json:"ImageName,omitempty"`
	// The Id of the image
	ImageId int64 `json:"ImageId,omitempty"`
	// The Description of the image
	ImageDescription string `json:"ImageDescription,omitempty"`
	// Width of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height
	ImageWidth int64 `json:"ImageWidth,omitempty"`
	// Height of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height
	ImageHeight int64 `json:"ImageHeight,omitempty"`
	// X (horizontal) offset of the image
	XOffset int64 `json:"XOffset,omitempty"`
	// Y (vertical) offset of the image
	YOffset int64 `json:"YOffset,omitempty"`
	// Read-only; internal ID for the image contents
	ImageDataEmbedId string `json:"ImageDataEmbedId,omitempty"`
	// Read-only; image data MIME content-type
	ImageDataContentType string `json:"ImageDataContentType,omitempty"`
	// Read-only; internal file name/path for the image
	ImageInternalFileName string `json:"ImageInternalFileName,omitempty"`
	// URL to the image contents; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the contents.
	ImageContentsURL string `json:"ImageContentsURL,omitempty"`
	// True if the image is inline with the text; false if it is floating
	InlineWithText bool `json:"InlineWithText,omitempty"`
}

type DocxInsertCommentOnParagraphRequest ¶ 

type DocxInsertCommentOnParagraphRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Path to the paragraph to attach the comment to.  You can get the Path by retrieving all of the Paragraphs in document by calling Get Body and taking the Path property of the desired paragraph to add the comment to.
	ParagraphPath string `json:"ParagraphPath,omitempty"`
	// Comment to insert
	CommentToInsert *DocxComment `json:"CommentToInsert,omitempty"`
}

Input to a Insert Comment on Paragraph request

type DocxInsertImageRequest ¶ 

type DocxInsertImageRequest struct {
	// Optional: Bytes of the input file to operate on
	InputDocumentFileBytes string `json:"InputDocumentFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputDocumentFileUrl string `json:"InputDocumentFileUrl,omitempty"`
	// Optional: Bytes of the input image file to operate on; if you supply this value do not supply InputImageFileUrl or ImageToAdd.
	InputImageFileBytes string `json:"InputImageFileBytes,omitempty"`
	// Optional: URL of an image file to operate on as input; if you supply this value do not supply InputImageFileBytes or ImageToAdd.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputImageFileUrl string `json:"InputImageFileUrl,omitempty"`
	// Optional: Image to add; if you supply in this object, do not supply InputImageFileBytes or InputImageFileUrl.
	ImageToAdd *DocxImage `json:"ImageToAdd,omitempty"`
	// Optional; default is DocumentEnd.  Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)
	InsertPlacement string `json:"InsertPlacement,omitempty"`
	// Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object.  Used with InsertPlacement of BeforeExistingObject or AfterExistingObject
	InsertPath string `json:"InsertPath,omitempty"`
	// Optional: The width of the image in EMUs
	WidthInEMUs int64 `json:"WidthInEMUs,omitempty"`
	// Optional: The height of the image in EMUs
	HeightInEMUs int64 `json:"HeightInEMUs,omitempty"`
}

Input to set-footer command

type DocxInsertImageResponse ¶ 

type DocxInsertImageResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running a set-footer command

type DocxMetadataCustomProperty ¶ 

type DocxMetadataCustomProperty struct {
	// Name of the property
	PropertyName string `json:"PropertyName,omitempty"`
	// Data type of the property; possible values are \"string\", \"integer\", \"double\" or \"date\"
	PropertyDataType string `json:"PropertyDataType,omitempty"`
	// If the property is of a string data type, then provides the string value if available
	StringValue string `json:"StringValue,omitempty"`
	// If the property is of a integer data type, then provides the integer value if available
	IntegerValue int64 `json:"IntegerValue,omitempty"`
	// If the property is of a double floating point data type, then provides the double value if available
	DoubleValue float64 `json:"DoubleValue,omitempty"`
	// If the property is of a date time data type, then provides the date time value if available
	DateValue time.Time `json:"DateValue,omitempty"`
}

Name and value pair for a custom-defined DOCX metadata property

type DocxPage ¶ 

type DocxPage struct {
	// Page number of this page, 1-based
	PageNumber int32 `json:"PageNumber,omitempty"`
	// All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document
	Paragraphs []DocxParagraph `json:"Paragraphs,omitempty"`
}

One page in a Word Document DOCX

type DocxParagraph ¶ 

type DocxParagraph struct {
	// The index of the paragraph; 0-based
	ParagraphIndex int32 `json:"ParagraphIndex,omitempty"`
	// The Path of the location of this Paragraph object; leave blank during creation
	Path string `json:"Path,omitempty"`
	// The content runs in the paragraph - this is where text is stored; similar to a span in HTML
	ContentRuns []DocxRun `json:"ContentRuns,omitempty"`
	// Style ID of the style applied to the paragraph; null if no style is applied
	StyleID string `json:"StyleID,omitempty"`
}

A paragraph in a Word Document (DOCX) file; there is where text, content and formatting are stored - similar to the paragraph tag in HTML

type DocxRemoveObjectRequest ¶ 

type DocxRemoveObjectRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Path within the document of the object to delete; fill in the PathToObjectToRemove field using the Path value from an existing object.
	PathToObjectToRemove string `json:"PathToObjectToRemove,omitempty"`
}

Input to a Insert Paragraph request

type DocxRemoveObjectResponse ¶ 

type DocxRemoveObjectResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running an Remove-Object command

type DocxRun ¶ 

type DocxRun struct {
	// Index of the run, 0-based
	RunIndex int32 `json:"RunIndex,omitempty"`
	// The Path of the location of this Run object; leave blank for creation
	Path string `json:"Path,omitempty"`
	// Text items inside the run; this is where the actual text content is stored
	TextItems []DocxText `json:"TextItems,omitempty"`
	// True to make the text bold, false otherwise
	Bold bool `json:"Bold,omitempty"`
	// True to make the text italic, false otherwise
	Italic bool `json:"Italic,omitempty"`
	// Underline mode for the text; possible values are: Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble, None
	Underline string `json:"Underline,omitempty"`
	// Font Family name for the text, e.g. \"Arial\" or \"Times New Roman\"
	FontFamily string `json:"FontFamily,omitempty"`
	// Font size in font points (e.g. \"24\")
	FontSize string `json:"FontSize,omitempty"`
}

A content run in a Word Document (DOCX) file

type DocxSection ¶ 

type DocxSection struct {
	// Page numbers that the section starts at, typically just one
	StartingPageNumbers []int32 `json:"StartingPageNumbers,omitempty"`
	// The Path of the location of this object; leave blank for new tables
	Path string `json:"Path,omitempty"`
}

Section of a Word Document (DOCX)

type DocxSetCustomMetadataPropertiesRequest ¶ 

type DocxSetCustomMetadataPropertiesRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Required: properties to set in the Word Document; provide one or more property definitions to set - be sure to specify the data type and value, together with the property name
	PropertiesToSet []DocxMetadataCustomProperty `json:"PropertiesToSet,omitempty"`
}

Request to set Word custom metadata properties

type DocxSetFooterAddPageNumberRequest ¶ 

type DocxSetFooterAddPageNumberRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional: extra text to add before the page number, for example if you want to show \"Page 1\" then you can set PrependText to \"Page\"
	PrependText string `json:"PrependText,omitempty"`
}

Input to set-footer/add-page-number command

type DocxSetFooterRequest ¶ 

type DocxSetFooterRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Footer to apply
	FooterToApply *DocxFooter `json:"FooterToApply,omitempty"`
}

Input to set-footer command

type DocxSetFooterResponse ¶ 

type DocxSetFooterResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running a set-footer command

type DocxSetFormFieldsRequest ¶ 

type DocxSetFormFieldsRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Handlebar style form fields to fill in; form field that is handlebar style, such as \"{{FieldName}}\"
	HandlebarFieldsToFill []FillHandlebarFormField `json:"HandlebarFieldsToFill,omitempty"`
}

Request for DocxSetFormFields operation

type DocxSetHeaderRequest ¶ 

type DocxSetHeaderRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Header to apply
	HeaderToApply *DocxHeader `json:"HeaderToApply,omitempty"`
}

Input to a set-header command

type DocxSetHeaderResponse ¶ 

type DocxSetHeaderResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running a set-header command

type DocxStyle ¶ 

type DocxStyle struct {
	// ID of the style
	StyleID string `json:"StyleID,omitempty"`
	// The Path of the location of this object; leave blank for new tables
	Path string `json:"Path,omitempty"`
	// Style applies bold formatting
	Bold bool `json:"Bold,omitempty"`
	// Style applies italic formatting
	Italic bool `json:"Italic,omitempty"`
	// Style applies underline formatting
	Underline bool `json:"Underline,omitempty"`
	// Font size
	FontSize string `json:"FontSize,omitempty"`
	// Font family
	FontFamily string `json:"FontFamily,omitempty"`
}

Style in a DOCX Word Document

type DocxTable ¶ 

type DocxTable struct {
	// The ID of the table; leave blank for new tables
	TableID string `json:"TableID,omitempty"`
	// The Path of the location of this table object; leave blank for new tables
	Path string `json:"Path,omitempty"`
	// The Width of the table, or 0 if not specified
	Width string `json:"Width,omitempty"`
	// The Width configuration type of the table
	WidthType string `json:"WidthType,omitempty"`
	// Rows in the table; this is where the contents is located
	TableRows []DocxTableRow `json:"TableRows,omitempty"`
	// Type for the top border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave
	TopBorderType string `json:"TopBorderType,omitempty"`
	// Width of the border in points (1/72nd of an inch)
	TopBorderSize int32 `json:"TopBorderSize,omitempty"`
	// Spacing around the border in points (1/72nd of an inch)
	TopBorderSpace int32 `json:"TopBorderSpace,omitempty"`
	// HTML-style color hex value (do not include a #)
	TopBorderColor string `json:"TopBorderColor,omitempty"`
	// Type for the bottom border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave
	BottomBorderType string `json:"BottomBorderType,omitempty"`
	// Width of the border in points (1/72nd of an inch)
	BottomBorderSize int32 `json:"BottomBorderSize,omitempty"`
	// Spacing around the border in points (1/72nd of an inch)
	BottomBorderSpace int32 `json:"BottomBorderSpace,omitempty"`
	// HTML-style color hex value (do not include a #)
	BottomBorderColor string `json:"BottomBorderColor,omitempty"`
	// Type for the left border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave
	LeftBorderType string `json:"LeftBorderType,omitempty"`
	// Width of the border in points (1/72nd of an inch)
	LeftBorderSize int32 `json:"LeftBorderSize,omitempty"`
	// Spacing around the border in points (1/72nd of an inch)
	LeftBorderSpace int32 `json:"LeftBorderSpace,omitempty"`
	// HTML-style color hex value (do not include a #)
	LeftBorderColor string `json:"LeftBorderColor,omitempty"`
	// Type for the right border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave
	RightBorderType string `json:"RightBorderType,omitempty"`
	// Width of the border in points (1/72nd of an inch)
	RightBorderSize int32 `json:"RightBorderSize,omitempty"`
	// Spacing around the border in points (1/72nd of an inch)
	RightBorderSpace int32 `json:"RightBorderSpace,omitempty"`
	// HTML-style color hex value (do not include a #)
	RightBorderColor string `json:"RightBorderColor,omitempty"`
	// Type for the cell horizontal border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave
	CellHorizontalBorderType string `json:"CellHorizontalBorderType,omitempty"`
	// Width of the border in points (1/72nd of an inch)
	CellHorizontalBorderSize int32 `json:"CellHorizontalBorderSize,omitempty"`
	// Spacing around the border in points (1/72nd of an inch)
	CellHorizontalBorderSpace int32 `json:"CellHorizontalBorderSpace,omitempty"`
	// HTML-style color hex value (do not include a #)
	CellHorizontalBorderColor string `json:"CellHorizontalBorderColor,omitempty"`
	// Type for the cell vertical border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave
	CellVerticalBorderType string `json:"CellVerticalBorderType,omitempty"`
	// Width of the border in points (1/72nd of an inch)
	CellVerticalBorderSize int32 `json:"CellVerticalBorderSize,omitempty"`
	// Spacing around the border in points (1/72nd of an inch)
	CellVerticalBorderSpace int32 `json:"CellVerticalBorderSpace,omitempty"`
	// HTML-style color hex value (do not include a #)
	CellVerticalBorderColor string `json:"CellVerticalBorderColor,omitempty"`
	// Type for the start border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave
	StartBorderType string `json:"StartBorderType,omitempty"`
	// Width of the border in points (1/72nd of an inch)
	StartBorderSize int32 `json:"StartBorderSize,omitempty"`
	// Spacing around the border in points (1/72nd of an inch)
	StartBorderSpace int32 `json:"StartBorderSpace,omitempty"`
	// HTML-style color hex value (do not include a #)
	StartBorderColor string `json:"StartBorderColor,omitempty"`
	// Type for the end border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave
	EndBorderType string `json:"EndBorderType,omitempty"`
	// Width of the border in points (1/72nd of an inch)
	EndBorderSize int32 `json:"EndBorderSize,omitempty"`
	// Spacing around the border in points (1/72nd of an inch)
	EndBorderSpace int32 `json:"EndBorderSpace,omitempty"`
	// HTML-style color hex value (do not include a #)
	EndBorderColor string `json:"EndBorderColor,omitempty"`
	// Table indentation type
	TableIndentationMode string `json:"TableIndentationMode,omitempty"`
	// Table indentation width
	TableIndentationWidth int32 `json:"TableIndentationWidth,omitempty"`
}

A table in a Word Document (DOCX) file

type DocxTableCell ¶ 

type DocxTableCell struct {
	// The index of the cell, 0-based
	CellIndex int32 `json:"CellIndex,omitempty"`
	// The Path of the location of this object; leave blank for new tables
	Path string `json:"Path,omitempty"`
	// Paragraphs inside the cell; this is where the contents of the cell are stored
	Paragraphs []DocxParagraph `json:"Paragraphs,omitempty"`
	// Color of the cell shading
	CellShadingColor string `json:"CellShadingColor,omitempty"`
	// Fill of the cell shading
	CellShadingFill string `json:"CellShadingFill,omitempty"`
	// Pattern of the cell shading
	CellShadingPattern string `json:"CellShadingPattern,omitempty"`
	// Width mode of the cell; can be auto (for automatic) or manual
	CellWidthMode string `json:"CellWidthMode,omitempty"`
	// Width of the cell
	CellWidth string `json:"CellWidth,omitempty"`
}

A cell in a Word Document (DOCX) file

type DocxTableRow ¶ 

type DocxTableRow struct {
	// Index of the row, 0-based
	RowIndex int32 `json:"RowIndex,omitempty"`
	// The Path of the location of this table row object; leave blank for new tables
	Path string `json:"Path,omitempty"`
	// Cells in the row; this is where the contents of the row is stored
	RowCells []DocxTableCell `json:"RowCells,omitempty"`
}

A row in a Word Document (DOCX) file

type DocxTableSingleTableFill ¶ 

type DocxTableSingleTableFill struct {
	// Start tag that delineates the beginning of the table
	TableStartTag string `json:"TableStartTag,omitempty"`
	// End tag that delineates the end of the table
	TableEndTag string `json:"TableEndTag,omitempty"`
	// Data set to populate the table with
	DataToFillIn []DocxTableTableFillTableRow `json:"DataToFillIn,omitempty"`
}

Single table fill request in a multi-table fill operation

type DocxTableTableFillMultiRequest ¶ 

type DocxTableTableFillMultiRequest struct {
	// Optional; Input URL of the document; use BeginEditing to create this
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Input Word Document file content for the operation
	InputFileData string `json:"InputFileData,omitempty"`
	// Tables and datasets to fill into the document
	TablesToFill []DocxTableSingleTableFill `json:"TablesToFill,omitempty"`
}

Request to update data in a table in a Word DOCX Document

type DocxTableTableFillRequest ¶ 

type DocxTableTableFillRequest struct {
	// Optional; Input URL of the document; use BeginEditing to create this
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Input Word Document file content for the operation
	InputFileData string `json:"InputFileData,omitempty"`
	// Start tag that delineates the beginning of the table
	TableStartTag string `json:"TableStartTag,omitempty"`
	// End tag that delineates the end of the table
	TableEndTag string `json:"TableEndTag,omitempty"`
	// Data set to populate the table with
	DataToFillIn []DocxTableTableFillTableRow `json:"DataToFillIn,omitempty"`
}

Request to update data in a table in a Word DOCX Document

type DocxTableTableFillTableCell ¶ 

type DocxTableTableFillTableCell struct {
	// Target tag to replace
	TargetTag string `json:"TargetTag,omitempty"`
	// Replacement value for the target tag
	ReplacementValue string `json:"ReplacementValue,omitempty"`
}

Cell data to fill in to the DOCX Table

type DocxTableTableFillTableRow ¶ 

type DocxTableTableFillTableRow struct {
	// Cells in the row to fill in
	Cells []DocxTableTableFillTableCell `json:"Cells,omitempty"`
}

Row data to fill in to the DOCX Table

type DocxTemplateApplicationRequest ¶ 

type DocxTemplateApplicationRequest struct {
	// Operations to apply to this template
	Operations []DocxTemplateOperation `json:"Operations,omitempty"`
}

Word DOCX template application request

type DocxTemplateOperation ¶ 

type DocxTemplateOperation struct {
	// Operation action to take; possible values are \"Replace\"
	Action int32 `json:"Action,omitempty"`
	// For Replace operations, the string to match against (to be replaced with ReplaceWith string)
	MatchAgainst string `json:"MatchAgainst,omitempty"`
	// For Replace operations, the string to Replace the original string with
	ReplaceWith string `json:"ReplaceWith,omitempty"`
}

type DocxText ¶ 

type DocxText struct {
	// Index of the text content in the run; 0-based
	TextIndex int32 `json:"TextIndex,omitempty"`
	// The Path of the location of this Text object; leave blank for creation
	Path string `json:"Path,omitempty"`
	// Text string containing the text content of this text content item
	TextContent string `json:"TextContent,omitempty"`
}

Unit of text content in a Word Document (DOCX) file

type DocxToJpgResult ¶ 

type DocxToJpgResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	JpgResultPages []ConvertedJpgPage `json:"JpgResultPages,omitempty"`
}

Result of converting a DOCX input to a JPG array

type DocxToPngResult ¶ 

type DocxToPngResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngPage `json:"PngResultPages,omitempty"`
}

Result of converting a DOCX input to a PNG array

type DocxTopLevelComment ¶ 

type DocxTopLevelComment struct {
	// Path to the comment in the document
	Path string `json:"Path,omitempty"`
	// Author name of the comment
	Author string `json:"Author,omitempty"`
	// Initials of the author of the comment
	AuthorInitials string `json:"AuthorInitials,omitempty"`
	// Text content of the comment
	CommentText string `json:"CommentText,omitempty"`
	// Date timestamp of the comment
	CommentDate time.Time `json:"CommentDate,omitempty"`
	// Child comments, that are replies to this one
	ReplyChildComments []DocxComment `json:"ReplyChildComments,omitempty"`
	// True if this comment is marked as Done in Word, otherwise it is false
	Done bool `json:"Done,omitempty"`
}

Top-level Comment in a Word Document

type EditDocumentApiService ¶ 

type EditDocumentApiService service

func (*EditDocumentApiService) EditDocumentBeginEditing ¶ 

func (a *EditDocumentApiService) EditDocumentBeginEditing(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

EditDocumentApiService Begin editing a document Uploads a document to Cloudmersive to begin a series of one or more editing operations. To edit a document, first call Begin Editing on the document. Then perform operations on the document using the secure URL returned from BeginEditing, such as Word DOCX Delete Pages and Insert Table. Finally, perform finish editing on the URL to return the resulting edited document. The editing URL is temporary and only stored in-memory cache, and will automatically expire from the cache after 30 minutes, and cannot be directly accessed.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*EditDocumentApiService) EditDocumentDocxAcceptAllTrackChanges ¶ 

func (a *EditDocumentApiService) EditDocumentDocxAcceptAllTrackChanges(ctx context.Context, inputFile *os.File, localVarOptionals *EditDocumentDocxAcceptAllTrackChangesOpts) (string, *http.Response, error)

func (*EditDocumentApiService) EditDocumentDocxBody ¶ 

func (a *EditDocumentApiService) EditDocumentDocxBody(ctx context.Context, reqConfig GetDocxBodyRequest) (GetDocxBodyResponse, *http.Response, error)

EditDocumentApiService Get body from a Word DOCX document Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return GetDocxBodyResponse

func (*EditDocumentApiService) EditDocumentDocxCreateBlankDocument ¶ 

func (a *EditDocumentApiService) EditDocumentDocxCreateBlankDocument(ctx context.Context, input CreateBlankDocxRequest) (CreateBlankDocxResponse, *http.Response, error)

EditDocumentApiService Create a blank Word DOCX document Returns a blank Word DOCX Document format file. The file is blank, with no contents. Use additional editing commands such as Insert Paragraph or Insert Table or Insert Image to populate the document.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return CreateBlankDocxResponse

func (*EditDocumentApiService) EditDocumentDocxDeletePages ¶ 

func (a *EditDocumentApiService) EditDocumentDocxDeletePages(ctx context.Context, reqConfig RemoveDocxPagesRequest) (string, *http.Response, error)

EditDocumentApiService Delete, remove pages from a Word DOCX document Returns the edited Word Document in the Word Document (DOCX) format file with the specified pages removed

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return string

func (*EditDocumentApiService) EditDocumentDocxDeleteTableRow ¶ 

func (a *EditDocumentApiService) EditDocumentDocxDeleteTableRow(ctx context.Context, reqConfig DeleteDocxTableRowRequest) (DeleteDocxTableRowResponse, *http.Response, error)

EditDocumentApiService Deletes a table row in an existing table in a Word DOCX document Deletes an existing table row in a Word DOCX Document and returns the result.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return DeleteDocxTableRowResponse

func (*EditDocumentApiService) EditDocumentDocxDeleteTableRowRange ¶ 

func (a *EditDocumentApiService) EditDocumentDocxDeleteTableRowRange(ctx context.Context, reqConfig DeleteDocxTableRowRangeRequest) (DeleteDocxTableRowRangeResponse, *http.Response, error)

EditDocumentApiService Deletes a range of multiple table rows in an existing table in a Word DOCX document Deletes a range of 1 or more existing table rows in a Word DOCX Document and returns the result.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return DeleteDocxTableRowRangeResponse

func (*EditDocumentApiService) EditDocumentDocxDisableTrackChanges ¶ 

func (a *EditDocumentApiService) EditDocumentDocxDisableTrackChanges(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

EditDocumentApiService Disable track changes, revisions in a Word DOCX document Diables tracking of changes and revisions in a Word DOCX document, and accepts any pending changes. Users editing the document will no longer see changes tracked automatically.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*EditDocumentApiService) EditDocumentDocxEnableTrackChanges ¶ 

func (a *EditDocumentApiService) EditDocumentDocxEnableTrackChanges(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

EditDocumentApiService Enable track changes, revisions in a Word DOCX document Enables tracking of changes and revisions in a Word DOCX document. Users editing the document will see changes tracked automatically, with edits highlighted, and the ability to accept or reject changes made to the document.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*EditDocumentApiService) EditDocumentDocxFindParagraph ¶ 

func (a *EditDocumentApiService) EditDocumentDocxFindParagraph(ctx context.Context, reqConfig FindDocxParagraphRequest) (FindDocxParagraphResponse, *http.Response, error)

EditDocumentApiService Find matching paragraphs in a Word DOCX document Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return FindDocxParagraphResponse

func (*EditDocumentApiService) EditDocumentDocxGetComments ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetComments(ctx context.Context, reqConfig GetDocxGetCommentsRequest) (GetDocxCommentsResponse, *http.Response, error)

EditDocumentApiService Get comments from a Word DOCX document as a flat list Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return GetDocxCommentsResponse

func (*EditDocumentApiService) EditDocumentDocxGetCommentsHierarchical ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetCommentsHierarchical(ctx context.Context, reqConfig GetDocxGetCommentsHierarchicalRequest) (GetDocxCommentsHierarchicalResponse, *http.Response, error)

EditDocumentApiService Get comments from a Word DOCX document hierarchically Returns the comments and review annotations stored in the Word Document (DOCX) format file hierarchically, where reply comments are nested as children under top-level comments in the results returned.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return GetDocxCommentsHierarchicalResponse

func (*EditDocumentApiService) EditDocumentDocxGetContentControls ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetContentControls(ctx context.Context, inputFile *os.File) (GetDocxContentControlsResponse, *http.Response, error)

EditDocumentApiService Get all content controls (form fields) and values in a Word DOCX document Returns all the content controls, used for creating form fields, in a Office Word Document (docx)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return GetDocxContentControlsResponse

func (*EditDocumentApiService) EditDocumentDocxGetFormFields ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetFormFields(ctx context.Context, inputFile *os.File) (GetDocxGetFormFieldsResponse, *http.Response, error)

EditDocumentApiService Get all form fields in a Word DOCX document Returns all the content controls, used for creating form fields, as well as handlebar style text-based form fields such as \"{{FieldName}}\", in a Office Word Document (docx)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return GetDocxGetFormFieldsResponse

func (*EditDocumentApiService) EditDocumentDocxGetHeadersAndFooters ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetHeadersAndFooters(ctx context.Context, reqConfig GetDocxHeadersAndFootersRequest) (GetDocxHeadersAndFootersResponse, *http.Response, error)

EditDocumentApiService Get content of a footer from a Word DOCX document Returns the footer content from a Word Document (DOCX) format file

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return GetDocxHeadersAndFootersResponse

func (*EditDocumentApiService) EditDocumentDocxGetImages ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetImages(ctx context.Context, reqConfig GetDocxImagesRequest) (GetDocxImagesResponse, *http.Response, error)

EditDocumentApiService Get images from a Word DOCX document Returns the images defined in the Word Document (DOCX) format file

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return GetDocxImagesResponse

func (*EditDocumentApiService) EditDocumentDocxGetMacroInformation ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetMacroInformation(ctx context.Context, inputFile *os.File) (GetMacrosResponse, *http.Response, error)

EditDocumentApiService Get macro information from a Word DOCX/DOCM document Returns information about the Macros (e.g. VBA) defined in the Word Document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return GetMacrosResponse

func (*EditDocumentApiService) EditDocumentDocxGetMetadataProperties ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetMetadataProperties(ctx context.Context, inputFile *os.File) (GetDocxMetadataPropertiesResponse, *http.Response, error)

EditDocumentApiService Get all metadata properties in Word DOCX document Returns all the metadata properties in an Office Word Document (docx)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return GetDocxMetadataPropertiesResponse

func (*EditDocumentApiService) EditDocumentDocxGetSections ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetSections(ctx context.Context, reqConfig GetDocxSectionsRequest) (GetDocxSectionsResponse, *http.Response, error)

EditDocumentApiService Get sections from a Word DOCX document Returns the sections defined in the Word Document (DOCX) format file

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return GetDocxSectionsResponse

func (*EditDocumentApiService) EditDocumentDocxGetStyles ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetStyles(ctx context.Context, reqConfig GetDocxStylesRequest) (GetDocxStylesResponse, *http.Response, error)

EditDocumentApiService Get styles from a Word DOCX document Returns the styles defined in the Word Document (DOCX) format file

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return GetDocxStylesResponse

func (*EditDocumentApiService) EditDocumentDocxGetTableByIndex ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetTableByIndex(ctx context.Context, reqConfig GetDocxTableByIndexRequest) (GetDocxTableByIndexResponse, *http.Response, error)

EditDocumentApiService Get a specific table by index in a Word DOCX document Returns the specific table object by its 0-based index in an Office Word Document (DOCX)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return GetDocxTableByIndexResponse

func (*EditDocumentApiService) EditDocumentDocxGetTableRow ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetTableRow(ctx context.Context, reqConfig GetDocxTableRowRequest) (GetDocxTableRowResponse, *http.Response, error)

EditDocumentApiService Gets the contents of an existing table row in an existing table in a Word DOCX document Gets the contents of an existing table row in a Word DOCX Document and returns the result.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return GetDocxTableRowResponse

func (*EditDocumentApiService) EditDocumentDocxGetTables ¶ 

func (a *EditDocumentApiService) EditDocumentDocxGetTables(ctx context.Context, reqConfig GetDocxTablesRequest) (GetDocxTablesResponse, *http.Response, error)

EditDocumentApiService Get all tables in Word DOCX document Returns all the table objects in an Office Word Document (docx)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return GetDocxTablesResponse

func (*EditDocumentApiService) EditDocumentDocxInsertCommentOnParagraph ¶ 

func (a *EditDocumentApiService) EditDocumentDocxInsertCommentOnParagraph(ctx context.Context, reqConfig DocxInsertCommentOnParagraphRequest) (InsertDocxCommentOnParagraphResponse, *http.Response, error)

EditDocumentApiService Insert a new comment into a Word DOCX document attached to a paragraph Adds a new comment into a Word DOCX document attached to a paragraph and returns the result. Call Finish Editing on the output URL to complete the operation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return InsertDocxCommentOnParagraphResponse

func (*EditDocumentApiService) EditDocumentDocxInsertImage ¶ 

func (a *EditDocumentApiService) EditDocumentDocxInsertImage(ctx context.Context, reqConfig DocxInsertImageRequest) (DocxInsertImageResponse, *http.Response, error)

EditDocumentApiService Insert image into a Word DOCX document Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return DocxInsertImageResponse

func (*EditDocumentApiService) EditDocumentDocxInsertParagraph ¶ 

func (a *EditDocumentApiService) EditDocumentDocxInsertParagraph(ctx context.Context, reqConfig InsertDocxInsertParagraphRequest) (InsertDocxInsertParagraphResponse, *http.Response, error)

EditDocumentApiService Insert a new paragraph into a Word DOCX document Adds a new paragraph into a DOCX and returns the result. You can insert at the beginning/end of a document, or before/after an existing object using its Path (location within the document). Call Finish Editing on the output URL to complete the operation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return InsertDocxInsertParagraphResponse

func (*EditDocumentApiService) EditDocumentDocxInsertTable ¶ 

func (a *EditDocumentApiService) EditDocumentDocxInsertTable(ctx context.Context, reqConfig InsertDocxTablesRequest) (InsertDocxTablesResponse, *http.Response, error)

EditDocumentApiService Insert a new table into a Word DOCX document Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return InsertDocxTablesResponse

func (*EditDocumentApiService) EditDocumentDocxInsertTableRow ¶ 

func (a *EditDocumentApiService) EditDocumentDocxInsertTableRow(ctx context.Context, reqConfig InsertDocxTableRowRequest) (InsertDocxTableRowResponse, *http.Response, error)

EditDocumentApiService Insert a new row into an existing table in a Word DOCX document Adds a new table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return InsertDocxTableRowResponse

func (*EditDocumentApiService) EditDocumentDocxPages ¶ 

func (a *EditDocumentApiService) EditDocumentDocxPages(ctx context.Context, reqConfig GetDocxPagesRequest) (GetDocxPagesResponse, *http.Response, error)

EditDocumentApiService Get pages and content from a Word DOCX document Returns the pages and contents of each page defined in the Word Document (DOCX) format file

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return GetDocxPagesResponse

func (*EditDocumentApiService) EditDocumentDocxRemoveAllComments ¶ 

func (a *EditDocumentApiService) EditDocumentDocxRemoveAllComments(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

EditDocumentApiService Remove all comments from a Word DOCX document Removes all of the comments from a Word Document.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*EditDocumentApiService) EditDocumentDocxRemoveHeadersAndFooters ¶ 

func (a *EditDocumentApiService) EditDocumentDocxRemoveHeadersAndFooters(ctx context.Context, reqConfig RemoveDocxHeadersAndFootersRequest) (RemoveDocxHeadersAndFootersResponse, *http.Response, error)

EditDocumentApiService Remove headers and footers from Word DOCX document Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return RemoveDocxHeadersAndFootersResponse

func (*EditDocumentApiService) EditDocumentDocxRemoveObject ¶ 

func (a *EditDocumentApiService) EditDocumentDocxRemoveObject(ctx context.Context, reqConfig DocxRemoveObjectRequest) (DocxRemoveObjectResponse, *http.Response, error)

EditDocumentApiService Delete any object in a Word DOCX document Delete any object, such as a paragraph, table, image, etc. from a Word Document (DOCX). Pass in the Path of the object you would like to delete. You can call other functions such as Get-Tables, Get-Images, Get-Body, etc. to get the paths of the objects in the document. Call Finish Editing on the output URL to complete the operation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return DocxRemoveObjectResponse

func (*EditDocumentApiService) EditDocumentDocxReplace ¶ 

func (a *EditDocumentApiService) EditDocumentDocxReplace(ctx context.Context, reqConfig ReplaceStringRequest) (string, *http.Response, error)

EditDocumentApiService Replace string in Word DOCX document Replace all instances of a string in an Office Word Document (docx)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document string replacement configuration input

@return string

func (*EditDocumentApiService) EditDocumentDocxReplaceMulti ¶ 

func (a *EditDocumentApiService) EditDocumentDocxReplaceMulti(ctx context.Context, reqConfig MultiReplaceStringRequest) (string, *http.Response, error)

EditDocumentApiService Replace multiple strings in Word DOCX document, return result Replace all instances of multiple strings in an Office Word Document (docx)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document string replacement configuration input

@return string

func (*EditDocumentApiService) EditDocumentDocxReplaceMultiEditSession ¶ 

func (a *EditDocumentApiService) EditDocumentDocxReplaceMultiEditSession(ctx context.Context, reqConfig MultiReplaceStringRequest) (DocumentEditingEditSession, *http.Response, error)

EditDocumentApiService Replace multiple strings in Word DOCX document, return edit session Replace all instances of multiple strings in an Office Word Document (docx). Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document string replacement configuration input

@return DocumentEditingEditSession

func (*EditDocumentApiService) EditDocumentDocxReplaceParagraph ¶ 

func (a *EditDocumentApiService) EditDocumentDocxReplaceParagraph(ctx context.Context, reqConfig ReplaceDocxParagraphRequest) (ReplaceDocxParagraphResponse, *http.Response, error)

EditDocumentApiService Replace matching paragraphs in a Word DOCX document Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested. Replace a paragraph with another object such as an image. Useful for performing templating operations.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return ReplaceDocxParagraphResponse

func (*EditDocumentApiService) EditDocumentDocxSetCustomMetadataProperties ¶ 

func (a *EditDocumentApiService) EditDocumentDocxSetCustomMetadataProperties(ctx context.Context, input DocxSetCustomMetadataPropertiesRequest) (string, *http.Response, error)

EditDocumentApiService Set custom property metadata properties in Word DOCX document Sets the custom property metadata for the metadata properties in an Office Word Document (docx)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input

@return string

func (*EditDocumentApiService) EditDocumentDocxSetFooter ¶ 

func (a *EditDocumentApiService) EditDocumentDocxSetFooter(ctx context.Context, reqConfig DocxSetFooterRequest) (DocxSetFooterResponse, *http.Response, error)

EditDocumentApiService Set the footer in a Word DOCX document Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return DocxSetFooterResponse

func (*EditDocumentApiService) EditDocumentDocxSetFooterAddPageNumber ¶ 

func (a *EditDocumentApiService) EditDocumentDocxSetFooterAddPageNumber(ctx context.Context, reqConfig DocxSetFooterAddPageNumberRequest) (DocxSetFooterResponse, *http.Response, error)

EditDocumentApiService Add page number to footer in a Word DOCX document Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return DocxSetFooterResponse

func (*EditDocumentApiService) EditDocumentDocxSetFormFields ¶ 

func (a *EditDocumentApiService) EditDocumentDocxSetFormFields(ctx context.Context, reqConfig DocxSetFormFieldsRequest) (string, *http.Response, error)

EditDocumentApiService Set and fill values for form fields in a Word DOCX document Modifies a Office Word Document (docx) by filling in form fields using the provided values.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig

@return string

func (*EditDocumentApiService) EditDocumentDocxSetHeader ¶ 

func (a *EditDocumentApiService) EditDocumentDocxSetHeader(ctx context.Context, reqConfig DocxSetHeaderRequest) (DocxSetHeaderResponse, *http.Response, error)

EditDocumentApiService Set the header in a Word DOCX document Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return DocxSetHeaderResponse

func (*EditDocumentApiService) EditDocumentDocxUpdateTableCell ¶ 

func (a *EditDocumentApiService) EditDocumentDocxUpdateTableCell(ctx context.Context, reqConfig UpdateDocxTableCellRequest) (UpdateDocxTableCellResponse, *http.Response, error)

EditDocumentApiService Update, set contents of a table cell in an existing table in a Word DOCX document Sets the contents of a table cell into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return UpdateDocxTableCellResponse

func (*EditDocumentApiService) EditDocumentDocxUpdateTableRow ¶ 

func (a *EditDocumentApiService) EditDocumentDocxUpdateTableRow(ctx context.Context, reqConfig UpdateDocxTableRowRequest) (UpdateDocxTableRowResponse, *http.Response, error)

EditDocumentApiService Update, set contents of a table row in an existing table in a Word DOCX document Sets the contents of a table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Document input request

@return UpdateDocxTableRowResponse

func (*EditDocumentApiService) EditDocumentFinishEditing ¶ 

func (a *EditDocumentApiService) EditDocumentFinishEditing(ctx context.Context, reqConfig FinishEditingRequest) (string, *http.Response, error)

EditDocumentApiService Finish editing document, and download result from document editing Once done editing a document, download the result. Begin editing a document by calling begin-editing, then perform operations, then call finish-editing to get the result.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Cloudmersive Document URL to complete editing on

@return string

func (*EditDocumentApiService) EditDocumentPptxDeleteSlides ¶ 

func (a *EditDocumentApiService) EditDocumentPptxDeleteSlides(ctx context.Context, reqConfig RemovePptxSlidesRequest) (string, *http.Response, error)

EditDocumentApiService Delete, remove slides from a PowerPoint PPTX presentation document Edits the input PowerPoint PPTX presentation document to remove the specified slides

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Presentation input request

@return string

func (*EditDocumentApiService) EditDocumentPptxEditSizeAndOrientation ¶ 

func (a *EditDocumentApiService) EditDocumentPptxEditSizeAndOrientation(ctx context.Context, inputFile *os.File, localVarOptionals *EditDocumentPptxEditSizeAndOrientationOpts) (string, *http.Response, error)

func (*EditDocumentApiService) EditDocumentPptxGetMacroInformation ¶ 

func (a *EditDocumentApiService) EditDocumentPptxGetMacroInformation(ctx context.Context, inputFile *os.File) (GetMacrosResponse, *http.Response, error)

EditDocumentApiService Get macro information from a PowerPoint PPTX/PPTM presentation document Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return GetMacrosResponse

func (*EditDocumentApiService) EditDocumentPptxGetSizeAndOrientation ¶ 

func (a *EditDocumentApiService) EditDocumentPptxGetSizeAndOrientation(ctx context.Context, inputFile *os.File) (PptxPageLayoutInformation, *http.Response, error)

EditDocumentApiService Get the page layout information, including size and orientation of a PowerPoint PPTX presentation document Gets size and orientation of an input PowerPoint PPTX presentation

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return PptxPageLayoutInformation

func (*EditDocumentApiService) EditDocumentPptxReplace ¶ 

func (a *EditDocumentApiService) EditDocumentPptxReplace(ctx context.Context, reqConfig ReplaceStringRequest) (string, *http.Response, error)

EditDocumentApiService Replace string in PowerPoint PPTX presentation Replace all instances of a string in an Office PowerPoint Document (pptx)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Replacement document configuration input

@return string

func (*EditDocumentApiService) EditDocumentXlsxAppendRow ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxAppendRow(ctx context.Context, input AppendXlsxRowRequest) (AppendXlsxRowResponse, *http.Response, error)

EditDocumentApiService Append row to a Excel XLSX spreadsheet, worksheet Appends a row to the end of an Excel Spreadsheet worksheet.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return AppendXlsxRowResponse

func (*EditDocumentApiService) EditDocumentXlsxClearCellByIndex ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxClearCellByIndex(ctx context.Context, input ClearXlsxCellRequest) (ClearXlsxCellResponse, *http.Response, error)

EditDocumentApiService Clear cell contents in an Excel XLSX spreadsheet, worksheet by index Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return ClearXlsxCellResponse

func (*EditDocumentApiService) EditDocumentXlsxClearRow ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxClearRow(ctx context.Context, input ClearXlsxRowRequest) (ClearXlsxRowResponse, *http.Response, error)

EditDocumentApiService Clear row from a Excel XLSX spreadsheet, worksheet Clears data from a specific row in the Excel Spreadsheet worksheet, leaving a blank row. Use the Get Rows And Cells API to enumerate available rows in a spreadsheet.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return ClearXlsxRowResponse

func (*EditDocumentApiService) EditDocumentXlsxCreateBlankSpreadsheet ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxCreateBlankSpreadsheet(ctx context.Context, input CreateBlankSpreadsheetRequest) (CreateBlankSpreadsheetResponse, *http.Response, error)

EditDocumentApiService Create a blank Excel XLSX spreadsheet Returns a blank Excel XLSX Spreadsheet (XLSX) format file

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return CreateBlankSpreadsheetResponse

func (*EditDocumentApiService) EditDocumentXlsxCreateSpreadsheetFromData ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxCreateSpreadsheetFromData(ctx context.Context, input CreateSpreadsheetFromDataRequest) (CreateSpreadsheetFromDataResponse, *http.Response, error)

EditDocumentApiService Create a new Excel XLSX spreadsheet from column and row data Returns a new Excel XLSX Spreadsheet (XLSX) format file populated with column and row data specified as input

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return CreateSpreadsheetFromDataResponse

func (*EditDocumentApiService) EditDocumentXlsxDeleteWorksheet ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxDeleteWorksheet(ctx context.Context, reqConfig RemoveXlsxWorksheetRequest) (string, *http.Response, error)

EditDocumentApiService Delete, remove worksheet from an Excel XLSX spreadsheet document Edits the input Excel XLSX spreadsheet document to remove the specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param reqConfig Spreadsheet input request

@return string

func (*EditDocumentApiService) EditDocumentXlsxDisableSharedWorkbook ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxDisableSharedWorkbook(ctx context.Context, input DisableSharedWorkbookRequest) (DisableSharedWorkbookResponse, *http.Response, error)

EditDocumentApiService Disable Shared Workbook (legacy) in Excel XLSX spreadsheet Disable the Shared Workbook (legacy) mode in an Excel XLSX spreadsheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return DisableSharedWorkbookResponse

func (*EditDocumentApiService) EditDocumentXlsxEnableSharedWorkbook ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxEnableSharedWorkbook(ctx context.Context, input EnableSharedWorkbookRequest) (EnableSharedWorkbookResponse, *http.Response, error)

EditDocumentApiService Enable Shared Workbook (legacy) in Excel XLSX spreadsheet Enables the Shared Workbook (legacy) mode in an Excel XLSX spreadsheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return EnableSharedWorkbookResponse

func (*EditDocumentApiService) EditDocumentXlsxGetCellByIdentifier ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxGetCellByIdentifier(ctx context.Context, input GetXlsxCellByIdentifierRequest) (GetXlsxCellByIdentifierResponse, *http.Response, error)

EditDocumentApiService Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier Returns the value of a specific cell based on its identifier (e.g. A1, B22, C33, etc.) in the Excel Spreadsheet worksheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return GetXlsxCellByIdentifierResponse

func (*EditDocumentApiService) EditDocumentXlsxGetCellByIndex ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxGetCellByIndex(ctx context.Context, input GetXlsxCellRequest) (GetXlsxCellResponse, *http.Response, error)

EditDocumentApiService Get cell from an Excel XLSX spreadsheet, worksheet by index Returns the value and definition of a specific cell in a specific row in the Excel Spreadsheet worksheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return GetXlsxCellResponse

func (*EditDocumentApiService) EditDocumentXlsxGetColumns ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxGetColumns(ctx context.Context, input GetXlsxColumnsRequest) (GetXlsxColumnsResponse, *http.Response, error)

EditDocumentApiService Get columns from a Excel XLSX spreadsheet, worksheet Returns the columns defined in the Excel Spreadsheet worksheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return GetXlsxColumnsResponse

func (*EditDocumentApiService) EditDocumentXlsxGetImages ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxGetImages(ctx context.Context, input GetXlsxImagesRequest) (GetXlsxImagesResponse, *http.Response, error)

EditDocumentApiService Get images from a Excel XLSX spreadsheet, worksheet Returns the images defined in the Excel Spreadsheet worksheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return GetXlsxImagesResponse

func (*EditDocumentApiService) EditDocumentXlsxGetMacroInformation ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxGetMacroInformation(ctx context.Context, inputFile *os.File) (GetMacrosResponse, *http.Response, error)

EditDocumentApiService Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return GetMacrosResponse

func (*EditDocumentApiService) EditDocumentXlsxGetRowsAndCells ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxGetRowsAndCells(ctx context.Context, input GetXlsxRowsAndCellsRequest) (GetXlsxRowsAndCellsResponse, *http.Response, error)

EditDocumentApiService Get rows and cells from a Excel XLSX spreadsheet, worksheet Returns the rows and cells defined in the Excel Spreadsheet worksheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return GetXlsxRowsAndCellsResponse

func (*EditDocumentApiService) EditDocumentXlsxGetSpecificRow ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxGetSpecificRow(ctx context.Context, input GetXlsxSpecificRowRequest) (GetXlsxSpecificRowResponse, *http.Response, error)

EditDocumentApiService Get a specific row from a Excel XLSX spreadsheet, worksheet by path Returns the specific row and its cells defined in the Excel Spreadsheet worksheet based on the specified path.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return GetXlsxSpecificRowResponse

func (*EditDocumentApiService) EditDocumentXlsxGetStyles ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxGetStyles(ctx context.Context, input GetXlsxStylesRequest) (GetXlsxStylesResponse, *http.Response, error)

EditDocumentApiService Get styles from a Excel XLSX spreadsheet, worksheet Returns the style defined in the Excel Spreadsheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return GetXlsxStylesResponse

func (*EditDocumentApiService) EditDocumentXlsxGetWorksheets ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxGetWorksheets(ctx context.Context, input GetXlsxWorksheetsRequest) (GetXlsxWorksheetsResponse, *http.Response, error)

EditDocumentApiService Get worksheets from a Excel XLSX spreadsheet Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return GetXlsxWorksheetsResponse

func (*EditDocumentApiService) EditDocumentXlsxInsertWorksheet ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxInsertWorksheet(ctx context.Context, input InsertXlsxWorksheetRequest) (InsertXlsxWorksheetResponse, *http.Response, error)

EditDocumentApiService Insert a new worksheet into an Excel XLSX spreadsheet Inserts a new worksheet into an Excel Spreadsheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return InsertXlsxWorksheetResponse

func (*EditDocumentApiService) EditDocumentXlsxRenameWorksheet ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxRenameWorksheet(ctx context.Context, input RenameXlsxWorksheetRequest) (RenameXlsxWorksheetResponse, *http.Response, error)

EditDocumentApiService Rename a specific worksheet in a Excel XLSX spreadsheet Edits the input Excel XLSX spreadsheet document to rename a specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return RenameXlsxWorksheetResponse

func (*EditDocumentApiService) EditDocumentXlsxSetCellByIdentifier ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxSetCellByIdentifier(ctx context.Context, input SetXlsxCellByIdentifierRequest) (SetXlsxCellByIdentifierResponse, *http.Response, error)

EditDocumentApiService Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet using its cell identifier (e.g. A1, B22, C33) in the worksheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return SetXlsxCellByIdentifierResponse

func (*EditDocumentApiService) EditDocumentXlsxSetCellByIndex ¶ 

func (a *EditDocumentApiService) EditDocumentXlsxSetCellByIndex(ctx context.Context, input SetXlsxCellRequest) (SetXlsxCellResponse, *http.Response, error)

EditDocumentApiService Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Document input request

@return SetXlsxCellResponse

type EditDocumentDocxAcceptAllTrackChangesOpts ¶ 

type EditDocumentDocxAcceptAllTrackChangesOpts struct {
	Autorepair optional.Bool
}

type EditDocumentPptxEditSizeAndOrientationOpts ¶ 

type EditDocumentPptxEditSizeAndOrientationOpts struct {
	Orientation optional.String
	Width       optional.Int32
	Height      optional.Int32
}

type EditHtmlApiService ¶ 

type EditHtmlApiService service

func (*EditHtmlApiService) EditHtmlHtmlAppendHeaderTag ¶ 

func (a *EditHtmlApiService) EditHtmlHtmlAppendHeaderTag(ctx context.Context, htmlTag string, localVarOptionals *EditHtmlHtmlAppendHeaderTagOpts) (string, *http.Response, error)

func (*EditHtmlApiService) EditHtmlHtmlAppendHeading ¶ 

func (a *EditHtmlApiService) EditHtmlHtmlAppendHeading(ctx context.Context, headingText string, localVarOptionals *EditHtmlHtmlAppendHeadingOpts) (string, *http.Response, error)

func (*EditHtmlApiService) EditHtmlHtmlAppendImageFromUrl ¶ 

func (a *EditHtmlApiService) EditHtmlHtmlAppendImageFromUrl(ctx context.Context, imageUrl string, localVarOptionals *EditHtmlHtmlAppendImageFromUrlOpts) (string, *http.Response, error)

func (*EditHtmlApiService) EditHtmlHtmlAppendImageInline ¶ 

func (a *EditHtmlApiService) EditHtmlHtmlAppendImageInline(ctx context.Context, localVarOptionals *EditHtmlHtmlAppendImageInlineOpts) (string, *http.Response, error)

func (*EditHtmlApiService) EditHtmlHtmlAppendParagraph ¶ 

func (a *EditHtmlApiService) EditHtmlHtmlAppendParagraph(ctx context.Context, paragraphText string, localVarOptionals *EditHtmlHtmlAppendParagraphOpts) (string, *http.Response, error)

func (*EditHtmlApiService) EditHtmlHtmlCreateBlankDocument ¶ 

func (a *EditHtmlApiService) EditHtmlHtmlCreateBlankDocument(ctx context.Context, localVarOptionals *EditHtmlHtmlCreateBlankDocumentOpts) (string, *http.Response, error)

func (*EditHtmlApiService) EditHtmlHtmlGetLanguage ¶ 

func (a *EditHtmlApiService) EditHtmlHtmlGetLanguage(ctx context.Context, localVarOptionals *EditHtmlHtmlGetLanguageOpts) (HtmlGetLanguageResult, *http.Response, error)
func (a *EditHtmlApiService) EditHtmlHtmlGetLinks(ctx context.Context, localVarOptionals *EditHtmlHtmlGetLinksOpts) (HtmlGetLinksResponse, *http.Response, error)

func (*EditHtmlApiService) EditHtmlHtmlGetRelCanonical ¶ 

func (a *EditHtmlApiService) EditHtmlHtmlGetRelCanonical(ctx context.Context, localVarOptionals *EditHtmlHtmlGetRelCanonicalOpts) (HtmlGetRelCanonicalUrlResult, *http.Response, error)

func (*EditHtmlApiService) EditHtmlHtmlGetSitemap ¶ 

func (a *EditHtmlApiService) EditHtmlHtmlGetSitemap(ctx context.Context, localVarOptionals *EditHtmlHtmlGetSitemapOpts) (HtmlGetSitemapUrlResult, *http.Response, error)

func (*EditHtmlApiService) EditHtmlHtmlSetLanguage ¶ 

func (a *EditHtmlApiService) EditHtmlHtmlSetLanguage(ctx context.Context, languageCode string, localVarOptionals *EditHtmlHtmlSetLanguageOpts) (string, *http.Response, error)

func (*EditHtmlApiService) EditHtmlHtmlSetRelCanonical ¶ 

func (a *EditHtmlApiService) EditHtmlHtmlSetRelCanonical(ctx context.Context, canonicalUrl string, localVarOptionals *EditHtmlHtmlSetRelCanonicalOpts) (string, *http.Response, error)

func (*EditHtmlApiService) EditHtmlHtmlSetSitemapUrl ¶ 

func (a *EditHtmlApiService) EditHtmlHtmlSetSitemapUrl(ctx context.Context, sitemapUrl string, localVarOptionals *EditHtmlHtmlSetSitemapUrlOpts) (string, *http.Response, error)

type EditHtmlHtmlAppendHeaderTagOpts ¶ 

type EditHtmlHtmlAppendHeaderTagOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
}

type EditHtmlHtmlAppendHeadingOpts ¶ 

type EditHtmlHtmlAppendHeadingOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
	HeadingSize  optional.Int32
	CssStyle     optional.String
}

type EditHtmlHtmlAppendImageFromUrlOpts ¶ 

type EditHtmlHtmlAppendImageFromUrlOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
	CssStyle     optional.String
}

type EditHtmlHtmlAppendImageInlineOpts ¶ 

type EditHtmlHtmlAppendImageInlineOpts struct {
	InputFile      optional.Interface
	InputFileUrl   optional.String
	ImageFile      optional.Interface
	ImageUrl       optional.String
	CssStyle       optional.String
	ImageExtension optional.String
}

type EditHtmlHtmlAppendParagraphOpts ¶ 

type EditHtmlHtmlAppendParagraphOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
	CssStyle     optional.String
}

type EditHtmlHtmlCreateBlankDocumentOpts ¶ 

type EditHtmlHtmlCreateBlankDocumentOpts struct {
	Title            optional.String
	CssUrl           optional.String
	CssInline        optional.String
	JavascriptUrl    optional.String
	JavascriptInline optional.String
}

type EditHtmlHtmlGetLanguageOpts ¶ 

type EditHtmlHtmlGetLanguageOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
}

type EditHtmlHtmlGetLinksOpts ¶ 

type EditHtmlHtmlGetLinksOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
	BaseUrl      optional.String
}

type EditHtmlHtmlGetRelCanonicalOpts ¶ 

type EditHtmlHtmlGetRelCanonicalOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
}

type EditHtmlHtmlGetSitemapOpts ¶ 

type EditHtmlHtmlGetSitemapOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
}

type EditHtmlHtmlSetLanguageOpts ¶ 

type EditHtmlHtmlSetLanguageOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
}

type EditHtmlHtmlSetRelCanonicalOpts ¶ 

type EditHtmlHtmlSetRelCanonicalOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
}

type EditHtmlHtmlSetSitemapUrlOpts ¶ 

type EditHtmlHtmlSetSitemapUrlOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
}

type EditPdfApiService ¶ 

type EditPdfApiService service

func (*EditPdfApiService) EditPdfAddAnnotations ¶ 

func (a *EditPdfApiService) EditPdfAddAnnotations(ctx context.Context, request AddPdfAnnotationRequest) (string, *http.Response, error)

EditPdfApiService Add one or more PDF annotations, comments in the PDF document Adds one or more annotations, comments to a PDF document.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request

@return string

func (*EditPdfApiService) EditPdfConvertToPdfA ¶ 

func (a *EditPdfApiService) EditPdfConvertToPdfA(ctx context.Context, inputFile *os.File, localVarOptionals *EditPdfConvertToPdfAOpts) (string, *http.Response, error)

func (*EditPdfApiService) EditPdfDecrypt ¶ 

func (a *EditPdfApiService) EditPdfDecrypt(ctx context.Context, password string, inputFile *os.File) (string, *http.Response, error)

EditPdfApiService Decrypt and password-protect a PDF Decrypt a PDF document with a password. Decrypted PDF will no longer require a password to open.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param password Valid password for the PDF file
  • @param inputFile Input file to perform the operation on.

@return string

func (*EditPdfApiService) EditPdfDeletePages ¶ 

func (a *EditPdfApiService) EditPdfDeletePages(ctx context.Context, inputFile *os.File, pageStart int32, pageEnd int32) (string, *http.Response, error)

EditPdfApiService Remove, delete pages from a PDF document Remove one or more pages from a PDF document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.
  • @param pageStart Page number (1 based) to start deleting pages from (inclusive).
  • @param pageEnd Page number (1 based) to stop deleting pages from (inclusive).

@return string

func (*EditPdfApiService) EditPdfDeletePagesBatchJob ¶ 

func (a *EditPdfApiService) EditPdfDeletePagesBatchJob(ctx context.Context, inputFile *os.File, pageStart int32, pageEnd int32) (EditPdfBatchJobCreateResult, *http.Response, error)

EditPdfApiService Remove, delete pages from a PDF document as Batch Job Remove one or more pages from a PDF document. Runs as a batch job async and returns a batch job ID that you can check the status of to get the result. Requires Cloudmersive Private Cloud or Managed Instance.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.
  • @param pageStart Page number (1 based) to start deleting pages from (inclusive).
  • @param pageEnd Page number (1 based) to stop deleting pages from (inclusive).

@return EditPdfBatchJobCreateResult

func (*EditPdfApiService) EditPdfEncrypt ¶ 

func (a *EditPdfApiService) EditPdfEncrypt(ctx context.Context, inputFile *os.File, localVarOptionals *EditPdfEncryptOpts) (string, *http.Response, error)

func (*EditPdfApiService) EditPdfGetAnnotations ¶ 

func (a *EditPdfApiService) EditPdfGetAnnotations(ctx context.Context, inputFile *os.File) (GetPdfAnnotationsResult, *http.Response, error)

EditPdfApiService Get PDF annotations, including comments in the document Enumerates the annotations, including comments and notes, in a PDF document.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return GetPdfAnnotationsResult

func (*EditPdfApiService) EditPdfGetAsyncJobStatus ¶ 

func (a *EditPdfApiService) EditPdfGetAsyncJobStatus(ctx context.Context, asyncJobID string) (EditPdfJobStatusResult, *http.Response, error)

EditPdfApiService Get the status and result of a PDF Batch Job Returns the result of the Async Job - possible states can be STARTED or COMPLETED. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param asyncJobID

@return EditPdfJobStatusResult

func (*EditPdfApiService) EditPdfGetFormFields ¶ 

func (a *EditPdfApiService) EditPdfGetFormFields(ctx context.Context, inputFile *os.File) (PdfFormFields, *http.Response, error)

EditPdfApiService Gets PDF Form fields and values Encrypt a PDF document with a password. Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF. Set the password fields null to omit the given password.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return PdfFormFields

func (*EditPdfApiService) EditPdfGetMetadata ¶ 

func (a *EditPdfApiService) EditPdfGetMetadata(ctx context.Context, inputFile *os.File) (PdfMetadata, *http.Response, error)

EditPdfApiService Get PDF document metadata Returns the metadata from the PDF document, including Title, Author, etc.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return PdfMetadata

func (*EditPdfApiService) EditPdfGetPdfTextByPages ¶ 

func (a *EditPdfApiService) EditPdfGetPdfTextByPages(ctx context.Context, inputFile *os.File, localVarOptionals *EditPdfGetPdfTextByPagesOpts) (PdfTextByPageResult, *http.Response, error)

func (*EditPdfApiService) EditPdfInsertPages ¶ 

func (a *EditPdfApiService) EditPdfInsertPages(ctx context.Context, sourceFile *os.File, destinationFile *os.File, pageStartSource int32, pageEndSource int32, pageInsertBeforeDesitnation int32) (string, *http.Response, error)

EditPdfApiService Insert, copy pages from one PDF document into another Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document).

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sourceFile Source PDF file to copy pages from.
  • @param destinationFile Destination PDF file to copy pages into.
  • @param pageStartSource Page number (1 based) to start copying pages from (inclusive) in the Source file.
  • @param pageEndSource Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
  • @param pageInsertBeforeDesitnation Page number (1 based) to insert the pages before in the Destination file.

@return string

func (*EditPdfApiService) EditPdfInsertPagesBatchJob ¶ 

func (a *EditPdfApiService) EditPdfInsertPagesBatchJob(ctx context.Context, sourceFile *os.File, destinationFile *os.File, pageStartSource int32, pageEndSource int32, pageInsertBeforeDesitnation int32) (EditPdfBatchJobCreateResult, *http.Response, error)

EditPdfApiService Insert, copy pages from one PDF document into another as a batch job Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document). Runs as a batch job async and returns a batch job ID that you can check the status of to get the result. Requires Cloudmersive Private Cloud or Managed Instance.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sourceFile Source PDF file to copy pages from.
  • @param destinationFile Destination PDF file to copy pages into.
  • @param pageStartSource Page number (1 based) to start copying pages from (inclusive) in the Source file.
  • @param pageEndSource Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
  • @param pageInsertBeforeDesitnation Page number (1 based) to insert the pages before in the Destination file.

@return EditPdfBatchJobCreateResult

func (*EditPdfApiService) EditPdfLinearize ¶ 

func (a *EditPdfApiService) EditPdfLinearize(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

EditPdfApiService Linearize and optimize a PDF for streaming download Linearizes the content of a PDF to optimize it for streaming download, particularly over web streaming.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*EditPdfApiService) EditPdfRasterize ¶ 

func (a *EditPdfApiService) EditPdfRasterize(ctx context.Context, inputFile *os.File, localVarOptionals *EditPdfRasterizeOpts) (string, *http.Response, error)

func (*EditPdfApiService) EditPdfRasterizeBatchJob ¶ 

func (a *EditPdfApiService) EditPdfRasterizeBatchJob(ctx context.Context, inputFile *os.File) (EditPdfBatchJobCreateResult, *http.Response, error)

EditPdfApiService Rasterize a PDF to an image-based PDF as Batch Job Rasterize a PDF into an image-based PDF. The output is a PDF where each page is comprised of a high-resolution image, with all text, figures and other components removed.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return EditPdfBatchJobCreateResult

func (*EditPdfApiService) EditPdfReduceFileSize ¶ 

func (a *EditPdfApiService) EditPdfReduceFileSize(ctx context.Context, inputFile *os.File, localVarOptionals *EditPdfReduceFileSizeOpts) (string, *http.Response, error)

func (*EditPdfApiService) EditPdfRemoveAllAnnotations ¶ 

func (a *EditPdfApiService) EditPdfRemoveAllAnnotations(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

EditPdfApiService Remove all PDF annotations, including comments in the document Removes all of the annotations, including comments and notes, in a PDF document.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*EditPdfApiService) EditPdfRemoveAnnotationItem ¶ 

func (a *EditPdfApiService) EditPdfRemoveAnnotationItem(ctx context.Context, inputFile *os.File, annotationIndex int32) (string, *http.Response, error)

EditPdfApiService Remove a specific PDF annotation, comment in the document Removes a specific annotation in a PDF document, using the AnnotationIndex. To enumerate AnnotationIndex for all of the annotations in the PDF document, use the /edit/pdf/annotations/list API.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.
  • @param annotationIndex The 0-based index of the annotation in the document

@return string

func (*EditPdfApiService) EditPdfResize ¶ 

func (a *EditPdfApiService) EditPdfResize(ctx context.Context, inputFile *os.File, paperSize string) (string, *http.Response, error)

EditPdfApiService Change PDF Document's Paper Size Resizes a PDF document's paper size.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.
  • @param paperSize The desired paper size for the resized PDF document. Size ranges from A7 (smallest) to A0 (largest).

@return string

func (*EditPdfApiService) EditPdfRotateAllPages ¶ 

func (a *EditPdfApiService) EditPdfRotateAllPages(ctx context.Context, inputFile *os.File, rotationAngle int32) (string, *http.Response, error)

EditPdfApiService Rotate all pages in a PDF document Rotate all of the pages in a PDF document by a multiple of 90 degrees

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.
  • @param rotationAngle The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc.

@return string

func (*EditPdfApiService) EditPdfRotatePageRange ¶ 

func (a *EditPdfApiService) EditPdfRotatePageRange(ctx context.Context, inputFile *os.File, rotationAngle int32, pageStart int32, pageEnd int32) (string, *http.Response, error)

EditPdfApiService Rotate a range, subset of pages in a PDF document Rotate a range of specific pages in a PDF document by a multiple of 90 degrees

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.
  • @param rotationAngle The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc.
  • @param pageStart Page number (1 based) to start rotating pages from (inclusive).
  • @param pageEnd Page number (1 based) to stop rotating pages from (inclusive).

@return string

func (*EditPdfApiService) EditPdfSetFormFields ¶ 

func (a *EditPdfApiService) EditPdfSetFormFields(ctx context.Context, fieldValues SetPdfFormFieldsRequest) (string, *http.Response, error)

EditPdfApiService Sets ands fills PDF Form field values Fill in the form fields in a PDF form with specific values. Use form/get-fields to enumerate the available fields and their data types in an input form.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param fieldValues

@return string

func (*EditPdfApiService) EditPdfSetMetadata ¶ 

func (a *EditPdfApiService) EditPdfSetMetadata(ctx context.Context, request SetPdfMetadataRequest) (string, *http.Response, error)

EditPdfApiService Sets PDF document metadata Sets (writes) metadata into the input PDF document, including Title, Author, etc.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request

@return string

func (*EditPdfApiService) EditPdfSetPermissions ¶ 

func (a *EditPdfApiService) EditPdfSetPermissions(ctx context.Context, ownerPassword string, userPassword string, inputFile *os.File, localVarOptionals *EditPdfSetPermissionsOpts) (string, *http.Response, error)

func (*EditPdfApiService) EditPdfWatermarkText ¶ 

func (a *EditPdfApiService) EditPdfWatermarkText(ctx context.Context, watermarkText string, inputFile *os.File, localVarOptionals *EditPdfWatermarkTextOpts) (string, *http.Response, error)

type EditPdfBatchJobCreateResult ¶ 

type EditPdfBatchJobCreateResult struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// When creating a job, an Async Job ID is returned.  Use the GetAsyncJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes
	AsyncJobID string `json:"AsyncJobID,omitempty"`
}

Result of performing an edit PDF batch job operation

type EditPdfConvertToPdfAOpts ¶ 

type EditPdfConvertToPdfAOpts struct {
	ConformanceLevel optional.String
}

type EditPdfEncryptOpts ¶ 

type EditPdfEncryptOpts struct {
	UserPassword        optional.String
	OwnerPassword       optional.String
	EncryptionKeyLength optional.String
}

type EditPdfGetPdfTextByPagesOpts ¶ 

type EditPdfGetPdfTextByPagesOpts struct {
	TextFormattingMode optional.String
}

type EditPdfJobStatusResult ¶ 

type EditPdfJobStatusResult struct {
	// Tru eif the operation to check the status of the job was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Returns the job status of the Async Job, if applicable.  Possible states are STARTED and COMPLETED
	AsyncJobStatus string `json:"AsyncJobStatus,omitempty"`
	// When the job exceeds 25 pages, an Async Job ID is returned.  Use the CheckPdfOcrJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes
	AsyncJobID string `json:"AsyncJobID,omitempty"`
	// Output file result (if applicable)
	OutputFileResult string `json:"OutputFileResult,omitempty"`
	// Error message (if any)
	ErrorMessage string `json:"ErrorMessage,omitempty"`
}

Result of performing a batch job operation

type EditPdfRasterizeOpts ¶ 

type EditPdfRasterizeOpts struct {
	Dpi optional.Int32
}

type EditPdfReduceFileSizeOpts ¶ 

type EditPdfReduceFileSizeOpts struct {
	Quality optional.Float32
}

type EditPdfSetPermissionsOpts ¶ 

type EditPdfSetPermissionsOpts struct {
	EncryptionKeyLength    optional.String
	AllowPrinting          optional.Bool
	AllowDocumentAssembly  optional.Bool
	AllowContentExtraction optional.Bool
	AllowFormFilling       optional.Bool
	AllowEditing           optional.Bool
	AllowAnnotations       optional.Bool
	AllowDegradedPrinting  optional.Bool
}

type EditPdfWatermarkTextOpts ¶ 

type EditPdfWatermarkTextOpts struct {
	FontName         optional.String
	FontSize         optional.Float32
	FontColor        optional.String
	FontTransparency optional.Float32
}

type EditTextApiService ¶ 

type EditTextApiService service

func (*EditTextApiService) EditTextBase64Decode ¶ 

func (a *EditTextApiService) EditTextBase64Decode(ctx context.Context, request Base64DecodeRequest) (Base64DecodeResponse, *http.Response, error)

EditTextApiService Base 64 decode, convert base 64 string to binary content Decodes / converts base 64 UTF-8 text string to binary content

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request Input request

@return Base64DecodeResponse

func (*EditTextApiService) EditTextBase64Detect ¶ 

func (a *EditTextApiService) EditTextBase64Detect(ctx context.Context, request Base64DetectRequest) (Base64DetectResponse, *http.Response, error)

EditTextApiService Detect, check if text string is base 64 encoded Checks, detects if input string is base 64 encoded

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request Input request

@return Base64DetectResponse

func (*EditTextApiService) EditTextBase64Encode ¶ 

func (a *EditTextApiService) EditTextBase64Encode(ctx context.Context, request Base64EncodeRequest) (Base64EncodeResponse, *http.Response, error)

EditTextApiService Base 64 encode, convert binary or file data to a text string Encodes / converts binary or file data to a text string

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request Input request

@return Base64EncodeResponse

func (*EditTextApiService) EditTextChangeLineEndings ¶ 

func (a *EditTextApiService) EditTextChangeLineEndings(ctx context.Context, lineEndingType string, inputFile *os.File) (ChangeLineEndingResponse, *http.Response, error)

EditTextApiService Set, change line endings of a text file Sets the line ending type of a text file; set to Windows, Unix or Mac.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param lineEndingType Required; 'Windows' will use carriage return and line feed, 'Unix' will use newline, and 'Mac' will use carriage return
  • @param inputFile Input file to perform the operation on.

@return ChangeLineEndingResponse

func (*EditTextApiService) EditTextDetectLineEndings ¶ 

func (a *EditTextApiService) EditTextDetectLineEndings(ctx context.Context, inputFile *os.File) (DetectLineEndingsResponse, *http.Response, error)

EditTextApiService Detect line endings of a text file Detect line ending type (Windows, Unix or Mac) of an input file.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DetectLineEndingsResponse

func (*EditTextApiService) EditTextFindRegex ¶ 

func (a *EditTextApiService) EditTextFindRegex(ctx context.Context, request FindStringRegexRequest) (FindStringRegexResponse, *http.Response, error)

EditTextApiService Find a regular expression regex in text input Find all occurrences of the input regular expression in the input content, and returns the matches

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request Input request

@return FindStringRegexResponse

func (*EditTextApiService) EditTextFindSimple ¶ 

func (a *EditTextApiService) EditTextFindSimple(ctx context.Context, request FindStringSimpleRequest) (FindStringSimpleResponse, *http.Response, error)

EditTextApiService Find a string in text input Finds all occurrences of the input string in the input content, and returns the matches

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request Input request

@return FindStringSimpleResponse

func (*EditTextApiService) EditTextRemoveAllWhitespace ¶ 

func (a *EditTextApiService) EditTextRemoveAllWhitespace(ctx context.Context, request RemoveWhitespaceFromTextRequest) (RemoveWhitespaceFromTextResponse, *http.Response, error)

EditTextApiService Remove whitespace from text string Removes all whitespace from text, leaving behind only non-whitespace characters. Whitespace includes newlines, spaces and other whitespace characters.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request Input request

@return RemoveWhitespaceFromTextResponse

func (*EditTextApiService) EditTextRemoveHtml ¶ 

func (a *EditTextApiService) EditTextRemoveHtml(ctx context.Context, request RemoveHtmlFromTextRequest) (RemoveHtmlFromTextResponse, *http.Response, error)

EditTextApiService Remove HTML from text string Removes HTML from text, leaving behind only text. Formatted text will become plain text. Important for protecting against HTML and Cross-Site-Scripting attacks.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request Input request

@return RemoveHtmlFromTextResponse

func (*EditTextApiService) EditTextReplaceRegex ¶ 

func (a *EditTextApiService) EditTextReplaceRegex(ctx context.Context, request ReplaceStringRegexRequest) (ReplaceStringRegexResponse, *http.Response, error)

EditTextApiService Replace a string in text with a regex regular expression string Replaces all occurrences of the input regular expression regex string in the input content, and returns the result

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request Input request

@return ReplaceStringRegexResponse

func (*EditTextApiService) EditTextReplaceSimple ¶ 

func (a *EditTextApiService) EditTextReplaceSimple(ctx context.Context, request ReplaceStringSimpleRequest) (ReplaceStringSimpleResponse, *http.Response, error)

EditTextApiService Replace a string in text with another string value Replaces all occurrences of the input string in the input content, and returns the result

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request Input request

@return ReplaceStringSimpleResponse

func (*EditTextApiService) EditTextTextEncodingDetect ¶ 

func (a *EditTextApiService) EditTextTextEncodingDetect(ctx context.Context, inputFile *os.File) (TextEncodingDetectResponse, *http.Response, error)

EditTextApiService Detect text encoding of file Checks text encoding of file

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return TextEncodingDetectResponse

func (*EditTextApiService) EditTextTrimWhitespace ¶ 

func (a *EditTextApiService) EditTextTrimWhitespace(ctx context.Context, request RemoveWhitespaceFromTextRequest) (RemoveWhitespaceFromTextResponse, *http.Response, error)

EditTextApiService Trim leading and trailing whitespace from text string Trim leading and trailing whitespace from text, leaving behind a trimmed string. Whitespace includes newlines, spaces and other whitespace characters.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request Input request

@return RemoveWhitespaceFromTextResponse

type EmlAttachment ¶ 

type EmlAttachment struct {
	// Name of the attachment, including file extension
	Name string `json:"Name,omitempty"`
	// The EML attachment as a byte[]
	Content string `json:"Content,omitempty"`
}

An EML file attachment

type EmlToHtmlResult ¶ 

type EmlToHtmlResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// An HTML string version of the EML file
	Content string `json:"Content,omitempty"`
	// The main body of the EML file's email as an HTML string
	Body string `json:"Body,omitempty"`
	// The From sender of the EML file's email
	From string `json:"From,omitempty"`
	// The To recipients of the EML file's email
	To string `json:"To,omitempty"`
	// The CC recipients of the EML file's email
	Cc string `json:"Cc,omitempty"`
	// The date and time that the EML file's email was sent
	DateSent string `json:"DateSent,omitempty"`
	// The subject of the EML file's email
	Subject string `json:"Subject,omitempty"`
	// List of all attachments for the EML file
	Attachments []EmlAttachment `json:"Attachments,omitempty"`
}

Result of converting an EML file to HTML string

type EmlToJpgResult ¶ 

type EmlToJpgResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	JpgResultPages []ConvertedJpgPage `json:"JpgResultPages,omitempty"`
}

Result of converting an EML input to a JPG array

type EmlToPngResult ¶ 

type EmlToPngResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngPage `json:"PngResultPages,omitempty"`
}

Result of converting an EML input to a PNG array

type EnableSharedWorkbookRequest ¶ 

type EnableSharedWorkbookRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Enabled Shared Workbook request

type EnableSharedWorkbookResponse ¶ 

type EnableSharedWorkbookResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running a Enable Shared Workbook command

type ExifValue ¶ 

type ExifValue struct {
	// Tag name for the EXIF value
	Tag string `json:"Tag,omitempty"`
	// Date type of the EXIF value
	DataType string `json:"DataType,omitempty"`
	// Value, formatted as a string of the EXIF value
	DataValue string `json:"DataValue,omitempty"`
}

EXIF tag and value

type FillHandlebarFormField ¶ 

type FillHandlebarFormField struct {
	// Name of the field without the curly braces, e.g. \"FieldName\" for a field that is included in the text of the DOCX as \"{{FieldName}}\"
	FieldName string `json:"FieldName,omitempty"`
	// Text value to fill in for the field in the resulting document
	ValueToFill string `json:"ValueToFill,omitempty"`
}

Handlebar style form fields to fill in; form field that is handlebar style, such as \"{{FieldName}}\"

type FindDocxParagraphRequest ¶ 

type FindDocxParagraphRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Required: The target string to search for in the paragraphs of the document
	FindString string `json:"FindString,omitempty"`
	// Optional: True to match case, false to ignore case when matching
	MatchCase bool `json:"MatchCase,omitempty"`
}

Input to a request to find matching paragraphs in a Word DOCX document

type FindDocxParagraphResponse ¶ 

type FindDocxParagraphResponse struct {
	// True if successful; false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Matching paragraphs
	MatchingParagraphs []DocxParagraph `json:"MatchingParagraphs,omitempty"`
	// Count of matching paragraphs
	Count int32 `json:"Count,omitempty"`
}

Result of performing a find matching paragraphs operation on a Word Document

type FindRegexMatch ¶ 

type FindRegexMatch struct {
	// 0-based index of the start of the match
	CharacterOffsetStart int32 `json:"CharacterOffsetStart,omitempty"`
	// 0-based index of the end of the match
	CharacterOffsetEnd int32 `json:"CharacterOffsetEnd,omitempty"`
	// Text content of the line containing the match
	ContainingLine string `json:"ContainingLine,omitempty"`
	// The match value
	MatchValue string `json:"MatchValue,omitempty"`
	// Regular expression regex match groups; these correspond to the match values
	MatchGroups []string `json:"MatchGroups,omitempty"`
}

Individual regular expression match result of finding a target regex in a longer text string

type FindStringMatch ¶ 

type FindStringMatch struct {
	// 0-based index of the start of the match
	CharacterOffsetStart int32 `json:"CharacterOffsetStart,omitempty"`
	// 0-based index of the end of the match
	CharacterOffsetEnd int32 `json:"CharacterOffsetEnd,omitempty"`
	// Text content of the line containing the match
	ContainingLine string `json:"ContainingLine,omitempty"`
}

Individual match result of finding a target string in a longer text string

type FindStringRegexRequest ¶ 

type FindStringRegexRequest struct {
	// Input text content
	TextContent string `json:"TextContent,omitempty"`
	// Target input regular expression (regex) to find
	TargetRegex string `json:"TargetRegex,omitempty"`
	// Set to True to match case, False to ignore case
	MatchCase bool `json:"MatchCase,omitempty"`
}

Request to find a string in a string

type FindStringRegexResponse ¶ 

type FindStringRegexResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Regular expression matches
	Matches []FindRegexMatch `json:"Matches,omitempty"`
	// The number of matches
	MatchCount int32 `json:"MatchCount,omitempty"`
}

Result of finding a string

type FindStringSimpleRequest ¶ 

type FindStringSimpleRequest struct {
	// Input text content
	TextContent string `json:"TextContent,omitempty"`
	// Target input string to find
	TargetString string `json:"TargetString,omitempty"`
}

Request to find a string in a string

type FindStringSimpleResponse ¶ 

type FindStringSimpleResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Found matches
	Matches []FindStringMatch `json:"Matches,omitempty"`
	// The number of matches
	MatchCount int32 `json:"MatchCount,omitempty"`
}

Result of finding a string

type FinishEditingRequest ¶ 

type FinishEditingRequest struct {
	// URL of a document being edited to get the contents of.
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Finish Editing request

type GenericSwaggerError ¶ 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶ 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶ 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶ 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetDocxBodyRequest ¶ 

type GetDocxBodyRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Get Body request

type GetDocxBodyResponse ¶ 

type GetDocxBodyResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Body in the DOCX document
	Body *DocxBody `json:"Body,omitempty"`
}

Result of running a Get-Body command

type GetDocxCommentsHierarchicalResponse ¶ 

type GetDocxCommentsHierarchicalResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Comments in the document
	Comments []DocxTopLevelComment `json:"Comments,omitempty"`
	// The number of comments in the document
	TopLevelCommentCount int32 `json:"TopLevelCommentCount,omitempty"`
}

Result of getting comments hierarchically from a Word Document DOCX

type GetDocxCommentsResponse ¶ 

type GetDocxCommentsResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Comments in the document
	Comments []DocxComment `json:"Comments,omitempty"`
	// The number of comments in the document
	CommentCount int32 `json:"CommentCount,omitempty"`
}

Result of getting comments from a Word Document DOCX

type GetDocxContentControlsResponse ¶ 

type GetDocxContentControlsResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Content controls in the DOCX
	ContentControls []DocxContentControl `json:"ContentControls,omitempty"`
}

Result of running a DocxGetContentControls command

type GetDocxGetCommentsHierarchicalRequest ¶ 

type GetDocxGetCommentsHierarchicalRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Get Word DOCX Document comments hierarchically request

type GetDocxGetCommentsRequest ¶ 

type GetDocxGetCommentsRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Get Word DOCX Document comments request

type GetDocxGetFormFieldsResponse ¶ 

type GetDocxGetFormFieldsResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Content controls in the DOCX
	ContentControls []DocxContentControl `json:"ContentControls,omitempty"`
	// Form fields that comply with the Handlebar style, that is they are surrounded by two curly braces on either side such as \"{{FieldName}}\", in the DOCX
	HandlebarFormFields []HandlebarFormField `json:"HandlebarFormFields,omitempty"`
}

Result of running a DocxGetFormFields command

type GetDocxHeadersAndFootersRequest ¶ 

type GetDocxHeadersAndFootersRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Get Tables request

type GetDocxHeadersAndFootersResponse ¶ 

type GetDocxHeadersAndFootersResponse struct {
	// True if successful, false otherwise
	Successful bool         `json:"Successful,omitempty"`
	Headers    []DocxHeader `json:"Headers,omitempty"`
	Footers    []DocxFooter `json:"Footers,omitempty"`
}

Result of running a Get-Tables command

type GetDocxImagesRequest ¶ 

type GetDocxImagesRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Get Images request

type GetDocxImagesResponse ¶ 

type GetDocxImagesResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Images in the DOCX document
	Images []DocxImage `json:"Images,omitempty"`
}

Result of running a Get-Images command

type GetDocxMetadataPropertiesResponse ¶ 

type GetDocxMetadataPropertiesResponse struct {
	// Name of the Company that authored the document, if available
	Company string `json:"Company,omitempty"`
	// Name of the Manager that authored the document, if available
	Manager string `json:"Manager,omitempty"`
	// Application version that authored the document, if available
	ApplicationVersion string `json:"ApplicationVersion,omitempty"`
	// Word count of the document
	WordCount int64 `json:"WordCount,omitempty"`
	// Line count of the document
	LineCount int64 `json:"LineCount,omitempty"`
	// Paragraph count of the document
	ParagraphCount int64 `json:"ParagraphCount,omitempty"`
	// Page count of the document
	PageCount int64 `json:"PageCount,omitempty"`
	// Custom properties applied to the document
	CustomProperties []DocxMetadataCustomProperty `json:"CustomProperties,omitempty"`
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
}

Result of running a DocxGetMetadataProperties command

type GetDocxPagesRequest ¶ 

type GetDocxPagesRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional: Maximum number of pages to return; set to 0 or do not supply to return all pages
	MaximumPages int32 `json:"MaximumPages,omitempty"`
}

Input to a Get Word DOCX Document Pages request

type GetDocxPagesResponse ¶ 

type GetDocxPagesResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Pages in the document
	Pages []DocxPage `json:"Pages,omitempty"`
	// Count of pages
	PageCount int32 `json:"PageCount,omitempty"`
}

Result of getting pages from a Word Document DOCX

type GetDocxSectionsRequest ¶ 

type GetDocxSectionsRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Get Sections request

type GetDocxSectionsResponse ¶ 

type GetDocxSectionsResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Sections in the DOCX document
	Sections []DocxSection `json:"Sections,omitempty"`
}

Result of running a Get-Sections command

type GetDocxStylesRequest ¶ 

type GetDocxStylesRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Get Tables request

type GetDocxStylesResponse ¶ 

type GetDocxStylesResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Styles in the DOCX document
	Styles []DocxStyle `json:"Styles,omitempty"`
}

Result of running a Get-Tables command

type GetDocxTableByIndexRequest ¶ 

type GetDocxTableByIndexRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// 0-based index of the table to retrieve from the Word Document
	TableIndex int32 `json:"TableIndex,omitempty"`
}

Input to a Get Tables by Index request

type GetDocxTableByIndexResponse ¶ 

type GetDocxTableByIndexResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Requested Table in the DOCX file
	Table *DocxTable `json:"Table,omitempty"`
}

Result of running a Get-Tables by Index command

type GetDocxTableRowRequest ¶ 

type GetDocxTableRowRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Path to the table to retrievew the row from
	TablePath string `json:"TablePath,omitempty"`
	// 0-based index of the row to retrieve (e.g. 0, 1, 2, ...) in the table
	TableRowRowIndex int32 `json:"TableRowRowIndex,omitempty"`
}

Input to a get DOCX table row request

type GetDocxTableRowResponse ¶ 

type GetDocxTableRowResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Contents of the table row that was requested
	RowResult *DocxTableRow `json:"RowResult,omitempty"`
}

Result of running an Get Table Row command

type GetDocxTablesRequest ¶ 

type GetDocxTablesRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Get Tables request

type GetDocxTablesResponse ¶ 

type GetDocxTablesResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Tables in the DOCX file
	Tables []DocxTable `json:"Tables,omitempty"`
}

Result of running a Get-Tables command

type GetFileTypeIconResult ¶ 

type GetFileTypeIconResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// PNG icon as a byte array
	Icon string `json:"Icon,omitempty"`
	// Extension used for the icon
	Extension string `json:"Extension,omitempty"`
}

Result of getting a file type icon from a file extension

type GetImageInfoResult ¶ 

type GetImageInfoResult struct {
	Successful bool `json:"Successful,omitempty"`
	// Color space of the image
	ColorSpace string `json:"ColorSpace,omitempty"`
	// Color type of the image
	ColorType string `json:"ColorType,omitempty"`
	// Width in pixels of the image
	Width int32 `json:"Width,omitempty"`
	// Height in pixels of the image
	Height int32 `json:"Height,omitempty"`
	// Compression level value from 0 (lowest quality) to 100 (highest quality)
	CompressionLevel int32 `json:"CompressionLevel,omitempty"`
	// SHA256 hash signature of the image
	ImageHashSignature string `json:"ImageHashSignature,omitempty"`
	// True if the image contains transparency, otherwise false
	HasTransparency bool `json:"HasTransparency,omitempty"`
	// MIME type of the image format
	MimeType string `json:"MimeType,omitempty"`
	// Image format
	ImageFormat string `json:"ImageFormat,omitempty"`
	// Units of the DPI measurement; can be either in Inches or Centimeters
	DPIUnit string `json:"DPIUnit,omitempty"`
	// DPI (pixels per unit, e.g. pixels per inch) of the image
	DPI float64 `json:"DPI,omitempty"`
	// Unique colors in the image
	ColorCount int32 `json:"ColorCount,omitempty"`
	// Bit depth of the image
	BitDepth int32 `json:"BitDepth,omitempty"`
	// Comment string in the image
	Comment string `json:"Comment,omitempty"`
	// Name of the EXIF profile used
	ExifProfileName string `json:"ExifProfileName,omitempty"`
	// EXIF tags and values embedded in the image
	ExifValues []ExifValue `json:"ExifValues,omitempty"`
}

Result of running a get-info operation on an image

type GetMacrosResponse ¶ 

type GetMacrosResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// True if the document contains VBA macros, false otherwise
	ContainsVbaMacros bool `json:"ContainsVbaMacros,omitempty"`
}

Result of running a Get Macro Information command

type GetPdfAnnotationsResult ¶ 

type GetPdfAnnotationsResult struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Annotations in the PDF file, ordered by placement from start to finish in the document
	Annotations []PdfAnnotation `json:"Annotations,omitempty"`
}

Result of retrieving annotations from a PDF document

type GetXlsxCellByIdentifierRequest ¶ 

type GetXlsxCellByIdentifierRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Worksheet (tab) within the spreadsheet to get the rows and cells of; leave blank to default to the first worksheet
	WorksheetToQuery *XlsxWorksheet `json:"WorksheetToQuery,omitempty"`
	// Required; Excel cell identifier, e.g. A1, B22, C33, etc.
	CellIdentifier string `json:"CellIdentifier,omitempty"`
}

Input to a Get Cell by cell identifier request

type GetXlsxCellByIdentifierResponse ¶ 

type GetXlsxCellByIdentifierResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Requested Cell in the Excel XLSX document
	Cell *XlsxSpreadsheetCell `json:"Cell,omitempty"`
}

Result of running a Get-Cell command

type GetXlsxCellRequest ¶ 

type GetXlsxCellRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Worksheet (tab) within the spreadsheet to get the rows and cells of; leave blank to default to the first worksheet
	WorksheetToQuery *XlsxWorksheet `json:"WorksheetToQuery,omitempty"`
	// 0-based index of the row, 0, 1, 2, ... to retrieve
	RowIndex int32 `json:"RowIndex,omitempty"`
	// 0-based index of the cell, 0, 1, 2, ... in the row to retrieve
	CellIndex int32 `json:"CellIndex,omitempty"`
}

Input to a Get Cell request

type GetXlsxCellResponse ¶ 

type GetXlsxCellResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Requested Cell in the Excel XLSX document
	Cell *XlsxSpreadsheetCell `json:"Cell,omitempty"`
}

Result of running a Get-Cell command

type GetXlsxColumnsRequest ¶ 

type GetXlsxColumnsRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Worksheet (tab) within the spreadsheet to get the columns of; leave blank to default to the first worksheet
	WorksheetToQuery *XlsxWorksheet `json:"WorksheetToQuery,omitempty"`
}

Input to a Get Columns request

type GetXlsxColumnsResponse ¶ 

type GetXlsxColumnsResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Spreadsheet Columns in the XLSX document
	Columns []XlsxSpreadsheetColumn `json:"Columns,omitempty"`
}

Result of running a Get-Columns command

type GetXlsxImagesRequest ¶ 

type GetXlsxImagesRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Worksheet (tab) within the spreadsheet to get the images of; leave blank to default to the first worksheet
	WorksheetToQuery *XlsxWorksheet `json:"WorksheetToQuery,omitempty"`
}

Input to a Get Images request

type GetXlsxImagesResponse ¶ 

type GetXlsxImagesResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Spreadsheet Images in the XLSX document
	Images []XlsxImage `json:"Images,omitempty"`
}

Result of running a Get-Images command

type GetXlsxRowsAndCellsRequest ¶ 

type GetXlsxRowsAndCellsRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Worksheet (tab) within the spreadsheet to get the rows and cells of; leave blank to default to the first worksheet
	WorksheetToQuery *XlsxWorksheet `json:"WorksheetToQuery,omitempty"`
}

Input to a Get Worksheets request

type GetXlsxRowsAndCellsResponse ¶ 

type GetXlsxRowsAndCellsResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Spreadsheet Rows in the Excel XLSX document
	Rows []XlsxSpreadsheetRow `json:"Rows,omitempty"`
}

Result of running a Get-Worksheets command

type GetXlsxSpecificRowRequest ¶ 

type GetXlsxSpecificRowRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Worksheet (tab) within the spreadsheet to get the specific row from; leave blank to default to the first worksheet
	WorksheetToQuery *XlsxWorksheet `json:"WorksheetToQuery,omitempty"`
	// Required; Full path for the desired row
	Path string `json:"Path,omitempty"`
}

Input to a Get-Specific-Row request

type GetXlsxSpecificRowResponse ¶ 

type GetXlsxSpecificRowResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Spreadsheet Row from the Excel XLSX document
	Row *XlsxSpreadsheetRow `json:"Row,omitempty"`
}

Result of running a Get-Specific-Row command

type GetXlsxStylesRequest ¶ 

type GetXlsxStylesRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Get Worksheets request

type GetXlsxStylesResponse ¶ 

type GetXlsxStylesResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Cell styles
	CellStyles []DocxCellStyle `json:"CellStyles,omitempty"`
}

Result of running a Get-Worksheets command

type GetXlsxWorksheetsRequest ¶ 

type GetXlsxWorksheetsRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
}

Input to a Get Worksheets request

type GetXlsxWorksheetsResponse ¶ 

type GetXlsxWorksheetsResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Worksheets in the Excel XLSX spreadsheet
	Worksheets []XlsxWorksheet `json:"Worksheets,omitempty"`
}

Result of running a Get-Worksheets command

type HandlebarFormField ¶ 

type HandlebarFormField struct {
	// Title of the handlebar style form field, such as \"FieldName\" in the case of \"{{FieldName}}\"
	FormFieldTitle string `json:"FormFieldTitle,omitempty"`
}

Instance of a form field that is handlebar style, such as \"{{FieldName}}\"

type HtmlGetLanguageResult ¶ 

type HtmlGetLanguageResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// HTML language code of the HTML document, e.g. \"en\" or \"de\"
	LanguageCode string `json:"LanguageCode,omitempty"`
}

Result of getting the language of the input HTML document

type HtmlGetLinksResponse ¶ 

type HtmlGetLinksResponse struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// All hyperlinks in the HTML document
	Links []HtmlHyperlink `json:"Links,omitempty"`
}

Result of extracting links from an HTML file

type HtmlGetRelCanonicalUrlResult ¶ 

type HtmlGetRelCanonicalUrlResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// HTML canonical URL if present
	CanonicalUrl string `json:"CanonicalUrl,omitempty"`
}

Result of getting the canonical URL of the input HTML document

type HtmlGetSitemapUrlResult ¶ 

type HtmlGetSitemapUrlResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// HTML sitemap URL if present
	CanonicalUrl string `json:"CanonicalUrl,omitempty"`
}

Result of getting the sitemap URL of the input HTML document 

type HtmlHyperlink struct {
	// Anchor text of the hyperlink, e.g. Click Here
	Anchortext string `json:"Anchortext,omitempty"`
	// URL of the hyperlink; fully-qualified if possible, otherwise relative
	Url string `json:"Url,omitempty"`
}

Individual hyperlink in an HTML File

type HtmlMdResult ¶ 

type HtmlMdResult struct {
	// True if operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Resulting HTML from the conversion
	Html string `json:"Html,omitempty"`
}

Result from converting a Markdown file to HTML

type HtmlSsrfThreatCheckResult ¶ 

type HtmlSsrfThreatCheckResult struct {
	// True if the document is valid and has no errors, false otherwise
	IsValid bool `json:"IsValid,omitempty"`
	// True if the document contains an SSRF threat, false otherwise
	IsThreat bool `json:"IsThreat,omitempty"`
	// Links found in the input HTML that contains threats
	ThreatLinks []HtmlThreatLink `json:"ThreatLinks,omitempty"`
}

HTML SSRF validation result

type HtmlTemplateApplicationRequest ¶ 

type HtmlTemplateApplicationRequest struct {
	// HTML template input as a string
	HtmlTemplate string `json:"HtmlTemplate,omitempty"`
	// URL to HTML template input
	HtmlTemplateUrl string `json:"HtmlTemplateUrl,omitempty"`
	// Operations to apply to this template
	Operations []HtmlTemplateOperation `json:"Operations,omitempty"`
}

HTML template application request

type HtmlTemplateApplicationResponse ¶ 

type HtmlTemplateApplicationResponse struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Final HTML result of all operations on input
	FinalHtml string `json:"FinalHtml,omitempty"`
}

Response from an HTML template application

type HtmlTemplateOperation ¶ 

type HtmlTemplateOperation struct {
	// Operation action to take; possible values are \"Replace\"
	Action int32 `json:"Action,omitempty"`
	// For Replace operations, the string to match against (to be replaced with ReplaceWith string)
	MatchAgsint string `json:"MatchAgsint,omitempty"`
	// For Replace operations, the string to Replace the original string with
	ReplaceWith string `json:"ReplaceWith,omitempty"`
}
type HtmlThreatLink struct {
	// URL of the link
	LinkUrl string `json:"LinkUrl,omitempty"`
	// Threat assessment level; possible values are None, Low, Medium and High
	ThreatLevel string `json:"ThreatLevel,omitempty"`
}

Threat assessment for a hyperlink URL

type HtmlToOfficeRequest ¶ 

type HtmlToOfficeRequest struct {
	// HTML to render to Office format
	Html string `json:"Html,omitempty"`
}

Details of the HTML to Office request

type HtmlToPdfRequest ¶ 

type HtmlToPdfRequest struct {
	// HTML to render to PDF
	Html string `json:"Html,omitempty"`
	// Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites. Provide a value of 0 for the default of 5000 milliseconds (5 seconds). Maximum is 30000 milliseconds (30 seconds).
	ExtraLoadingWait int32 `json:"ExtraLoadingWait,omitempty"`
	// Optional: Set to true to include background graphics in the PDF, or false to not include.  Default is true.
	IncludeBackgroundGraphics bool `json:"IncludeBackgroundGraphics,omitempty"`
	// Optional: Set to 100 to scale at 100%, set to 50% to scale down to 50% scale, set to 200% to scale up to 200% scale, etc.  Default is 100%. Maximum is 1000%.
	ScaleFactor int32 `json:"ScaleFactor,omitempty"`
}

Details of the HTML to PDF request

type HtmlToPngRequest ¶ 

type HtmlToPngRequest struct {
	// HTML to render to PNG (screenshot)
	Html string `json:"Html,omitempty"`
	// Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites. Provide a value of 0 for the default of 5000 milliseconds (5 seconds). Maximum is 30000 milliseconds (30 seconds).
	ExtraLoadingWait int32 `json:"ExtraLoadingWait,omitempty"`
	// Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot
	ScreenshotWidth int32 `json:"ScreenshotWidth,omitempty"`
	// Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot
	ScreenshotHeight int32 `json:"ScreenshotHeight,omitempty"`
}

Details of the HTML to PNG request

type HtmlToTextRequest ¶ 

type HtmlToTextRequest struct {
	// HTML to extract the text from
	Html string `json:"Html,omitempty"`
}

Details of the HTML to Text request

type HtmlToTextResponse ¶ 

type HtmlToTextResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Text content result from the HTML input
	TextContentResult string `json:"TextContentResult,omitempty"`
}

Result of running the HTML to Text operation

type InsertDocxCommentOnParagraphResponse ¶ 

type InsertDocxCommentOnParagraphResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running an Insert-Comment-on-Paragraph command

type InsertDocxInsertParagraphRequest ¶ 

type InsertDocxInsertParagraphRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Table you would like to insert
	ParagraphToInsert *DocxParagraph `json:"ParagraphToInsert,omitempty"`
	// Optional; default is DocumentEnd.  Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)
	InsertPlacement string `json:"InsertPlacement,omitempty"`
	// Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object.  Used with InsertPlacement of BeforeExistingObject or AfterExistingObject
	InsertPath string `json:"InsertPath,omitempty"`
}

Input to a Insert Paragraph request

type InsertDocxInsertParagraphResponse ¶ 

type InsertDocxInsertParagraphResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running an Insert-Paragraph command

type InsertDocxTableRowRequest ¶ 

type InsertDocxTableRowRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Table you would like to insert
	RowToInsert *DocxTableRow `json:"RowToInsert,omitempty"`
	// Optional; default is TableEnd.  Placement Type of the insert; possible values are: TableStart (very beginning of the table), TableEnd (very end of the document), or a 0-based row index number as an integer, 0 being the first row in the table, 1 being the second row in the table, 2 being the third row in the table, etc. to insert this row after
	InsertPlacement string `json:"InsertPlacement,omitempty"`
	// Required; the path to the existing table to modify
	ExistingTablePath string `json:"ExistingTablePath,omitempty"`
}

Input to a Insert Table Row request

type InsertDocxTableRowResponse ¶ 

type InsertDocxTableRowResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running an Insert-Table Row command

type InsertDocxTablesRequest ¶ 

type InsertDocxTablesRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Table you would like to insert
	TableToInsert *DocxTable `json:"TableToInsert,omitempty"`
	// Optional; default is DocumentEnd.  Placement Type of the insert; possible values are: DocumentStart (very beginning of the document), DocumentEnd (very end of the document), BeforeExistingObject (right before an existing object - fill in the InsertPath field using the Path value from an existing object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object)
	InsertPlacement string `json:"InsertPlacement,omitempty"`
	// Optional; location within the document to insert the object; fill in the InsertPath field using the Path value from an existing object.  Used with InsertPlacement of BeforeExistingObject or AfterExistingObject
	InsertPath string `json:"InsertPath,omitempty"`
}

Input to a Insert Tables request

type InsertDocxTablesResponse ¶ 

type InsertDocxTablesResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running an Insert-Tables command

type InsertXlsxWorksheetRequest ¶ 

type InsertXlsxWorksheetRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Workersheet to insert
	WorksheetToInsert *XlsxWorksheet `json:"WorksheetToInsert,omitempty"`
}

Input to a Insert Worksheets request

type InsertXlsxWorksheetResponse ¶ 

type InsertXlsxWorksheetResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running a insert worksheet command

type JobStatusResult ¶ 

type JobStatusResult struct {
	// True if the operation to check the status of the job was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Returns the job status of the Async Job, if applicable.  Possible states are STARTED and COMPLETED
	AsyncJobStatus string `json:"AsyncJobStatus,omitempty"`
	// When the job exceeds 25 pages, an Async Job ID is returned.  Use the CheckPdfOcrJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes
	AsyncJobID string `json:"AsyncJobID,omitempty"`
	// PowerPoint split result (if applicable)
	PptxResult *SplitPptxPresentationResult `json:"PptxResult,omitempty"`
	// Error message (if any)
	ErrorMessage string `json:"ErrorMessage,omitempty"`
}

Result of performing a batch job operation

type KeynoteToJpgResult ¶ 

type KeynoteToJpgResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	JpgResultPages []ConvertedJpgPage `json:"JpgResultPages,omitempty"`
}

Result of converting a Keynote input to a JPG array

type KeynoteToPngResult ¶ 

type KeynoteToPngResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngPage `json:"PngResultPages,omitempty"`
}

Result of converting a Keynote input to a PNG array

type MergeBatchJobCreateResult ¶ 

type MergeBatchJobCreateResult struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// When creating a job, an Async Job ID is returned.  Use the GetAsyncJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes
	AsyncJobID string `json:"AsyncJobID,omitempty"`
}

Result of performing a merge document batch job

type MergeDocumentApiService ¶ 

type MergeDocumentApiService service

func (*MergeDocumentApiService) MergeDocumentBatchJobCreate ¶ 

func (a *MergeDocumentApiService) MergeDocumentBatchJobCreate(ctx context.Context, input DocumentArrayInput) (MergeBatchJobCreateResult, *http.Response, error)

MergeDocumentApiService Merge an array of Documents into a Single Document by Page as a Batch Job Merge an array of Documents (PDF supported), into a single document. This API is designed for large jobs that could take a long time to create and so runs as a batch job that returns a Job ID that you can use with the GetAsyncJobStatus API to check on the status of the Job and ultimately get the output result. This API automatically detects the document type and then performs the split by using the document type-specific API needed to perform the split. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input

@return MergeBatchJobCreateResult

func (*MergeDocumentApiService) MergeDocumentDocx ¶ 

func (a *MergeDocumentApiService) MergeDocumentDocx(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File) (string, *http.Response, error)

MergeDocumentApiService Merge Two Word DOCX Together Combine two Office Word Documents (docx) into one single Office Word document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile1 First input file to perform the operation on.
  • @param inputFile2 Second input file to perform the operation on (more than 2 can be supplied).

@return string

func (*MergeDocumentApiService) MergeDocumentDocxMulti ¶ 

func (a *MergeDocumentApiService) MergeDocumentDocxMulti(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File, localVarOptionals *MergeDocumentDocxMultiOpts) (string, *http.Response, error)

func (*MergeDocumentApiService) MergeDocumentDocxMultiArray ¶ 

func (a *MergeDocumentApiService) MergeDocumentDocxMultiArray(ctx context.Context, input DocumentArrayInput) (interface{}, *http.Response, error)

MergeDocumentApiService Merge Multple Word DOCX Together from an array Combine multiple Office Word Documents (docx), stored in an array, into one single Office Word document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Array of input files

@return interface{}

func (*MergeDocumentApiService) MergeDocumentGetAsyncJobStatus ¶ 

func (a *MergeDocumentApiService) MergeDocumentGetAsyncJobStatus(ctx context.Context, asyncJobID string) (MergeJobStatusResult, *http.Response, error)

MergeDocumentApiService Get the status and result of a Merge Document Batch Job Returns the result of the Async Job - possible states can be STARTED or COMPLETED. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param asyncJobID

@return MergeJobStatusResult

func (*MergeDocumentApiService) MergeDocumentHtml ¶ 

func (a *MergeDocumentApiService) MergeDocumentHtml(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File) (string, *http.Response, error)

MergeDocumentApiService Merge Two HTML (HTM) Files Together Combine two HTML (.HTM) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile1 First input file to perform the operation on.
  • @param inputFile2 Second input file to perform the operation on (more than 2 can be supplied).

@return string

func (*MergeDocumentApiService) MergeDocumentHtmlMulti ¶ 

func (a *MergeDocumentApiService) MergeDocumentHtmlMulti(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File, localVarOptionals *MergeDocumentHtmlMultiOpts) (string, *http.Response, error)

func (*MergeDocumentApiService) MergeDocumentHtmlMultiArray ¶ 

func (a *MergeDocumentApiService) MergeDocumentHtmlMultiArray(ctx context.Context, input DocumentArrayInput) (interface{}, *http.Response, error)

MergeDocumentApiService Merge Multple HTML (HTM) Files Together from an array Combine multiple HTML (.HTM) files, from an array, into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Array of input files

@return interface{}

func (*MergeDocumentApiService) MergeDocumentPdf ¶ 

func (a *MergeDocumentApiService) MergeDocumentPdf(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File) (string, *http.Response, error)

MergeDocumentApiService Merge Two PDF Files Together Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile1 First input file to perform the operation on.
  • @param inputFile2 Second input file to perform the operation on (more than 2 can be supplied).

@return string

func (*MergeDocumentApiService) MergeDocumentPdfMulti ¶ 

func (a *MergeDocumentApiService) MergeDocumentPdfMulti(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File, localVarOptionals *MergeDocumentPdfMultiOpts) (string, *http.Response, error)

func (*MergeDocumentApiService) MergeDocumentPdfMultiArray ¶ 

func (a *MergeDocumentApiService) MergeDocumentPdfMultiArray(ctx context.Context, input DocumentArrayInput) (interface{}, *http.Response, error)

MergeDocumentApiService Merge Multple PDF Files Together from an array Combine multiple PDF files (pdf), as an array, into a single PDF document, preserving the order of the input documents in the combined document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Array of input files

@return interface{}

func (*MergeDocumentApiService) MergeDocumentPng ¶ 

func (a *MergeDocumentApiService) MergeDocumentPng(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File) (string, *http.Response, error)

MergeDocumentApiService Merge Two PNG Files Together Combine two PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile1 First input file to perform the operation on.
  • @param inputFile2 Second input file to perform the operation on (more than 2 can be supplied).

@return string

func (*MergeDocumentApiService) MergeDocumentPngMulti ¶ 

func (a *MergeDocumentApiService) MergeDocumentPngMulti(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File, localVarOptionals *MergeDocumentPngMultiOpts) (string, *http.Response, error)

func (*MergeDocumentApiService) MergeDocumentPngMultiArray ¶ 

func (a *MergeDocumentApiService) MergeDocumentPngMultiArray(ctx context.Context, input DocumentArrayInput) (interface{}, *http.Response, error)

MergeDocumentApiService Merge Multple PNG Files Together from an array Combine multiple PNG files, from an array, into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Array of input files

@return interface{}

func (*MergeDocumentApiService) MergeDocumentPptx ¶ 

func (a *MergeDocumentApiService) MergeDocumentPptx(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File) (string, *http.Response, error)

MergeDocumentApiService Merge Two PowerPoint PPTX Together Combine two Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile1 First input file to perform the operation on.
  • @param inputFile2 Second input file to perform the operation on (more than 2 can be supplied).

@return string

func (*MergeDocumentApiService) MergeDocumentPptxMulti ¶ 

func (a *MergeDocumentApiService) MergeDocumentPptxMulti(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File, localVarOptionals *MergeDocumentPptxMultiOpts) (string, *http.Response, error)

func (*MergeDocumentApiService) MergeDocumentPptxMultiArray ¶ 

func (a *MergeDocumentApiService) MergeDocumentPptxMultiArray(ctx context.Context, input DocumentArrayInput) (interface{}, *http.Response, error)

MergeDocumentApiService Merge Multple PowerPoint PPTX Together from an array Combine multiple Office PowerPoint presentations (pptx), from an array, into one single Office PowerPoint presentation

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Array of input files

@return interface{}

func (*MergeDocumentApiService) MergeDocumentTxt ¶ 

func (a *MergeDocumentApiService) MergeDocumentTxt(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File) (interface{}, *http.Response, error)

MergeDocumentApiService Merge Two Text (TXT) Files Together Combine two Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile1 First input file to perform the operation on.
  • @param inputFile2 Second input file to perform the operation on (more than 2 can be supplied).

@return interface{}

func (*MergeDocumentApiService) MergeDocumentTxtMulti ¶ 

func (a *MergeDocumentApiService) MergeDocumentTxtMulti(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File, localVarOptionals *MergeDocumentTxtMultiOpts) (string, *http.Response, error)

func (*MergeDocumentApiService) MergeDocumentXlsx ¶ 

func (a *MergeDocumentApiService) MergeDocumentXlsx(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File) (string, *http.Response, error)

MergeDocumentApiService Merge Two Excel XLSX Together Combine two Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile1 First input file to perform the operation on.
  • @param inputFile2 Second input file to perform the operation on (more than 2 can be supplied).

@return string

func (*MergeDocumentApiService) MergeDocumentXlsxMulti ¶ 

func (a *MergeDocumentApiService) MergeDocumentXlsxMulti(ctx context.Context, inputFile1 *os.File, inputFile2 *os.File, localVarOptionals *MergeDocumentXlsxMultiOpts) (string, *http.Response, error)

func (*MergeDocumentApiService) MergeDocumentXlsxMultiArray ¶ 

func (a *MergeDocumentApiService) MergeDocumentXlsxMultiArray(ctx context.Context, input DocumentArrayInput) (interface{}, *http.Response, error)

MergeDocumentApiService Merge Multple Excel XLSX Together from an Array Combine multiple Office Excel spreadsheets (xlsx), as an array, into a single Office Excel spreadsheet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param input Array of input files

@return interface{}

type MergeDocumentDocxMultiOpts ¶ 

type MergeDocumentDocxMultiOpts struct {
	InputFile3  optional.Interface
	InputFile4  optional.Interface
	InputFile5  optional.Interface
	InputFile6  optional.Interface
	InputFile7  optional.Interface
	InputFile8  optional.Interface
	InputFile9  optional.Interface
	InputFile10 optional.Interface
}

type MergeDocumentHtmlMultiOpts ¶ 

type MergeDocumentHtmlMultiOpts struct {
	InputFile3  optional.Interface
	InputFile4  optional.Interface
	InputFile5  optional.Interface
	InputFile6  optional.Interface
	InputFile7  optional.Interface
	InputFile8  optional.Interface
	InputFile9  optional.Interface
	InputFile10 optional.Interface
}

type MergeDocumentPdfMultiOpts ¶ 

type MergeDocumentPdfMultiOpts struct {
	InputFile3  optional.Interface
	InputFile4  optional.Interface
	InputFile5  optional.Interface
	InputFile6  optional.Interface
	InputFile7  optional.Interface
	InputFile8  optional.Interface
	InputFile9  optional.Interface
	InputFile10 optional.Interface
}

type MergeDocumentPngMultiOpts ¶ 

type MergeDocumentPngMultiOpts struct {
	InputFile3  optional.Interface
	InputFile4  optional.Interface
	InputFile5  optional.Interface
	InputFile6  optional.Interface
	InputFile7  optional.Interface
	InputFile8  optional.Interface
	InputFile9  optional.Interface
	InputFile10 optional.Interface
}

type MergeDocumentPptxMultiOpts ¶ 

type MergeDocumentPptxMultiOpts struct {
	InputFile3  optional.Interface
	InputFile4  optional.Interface
	InputFile5  optional.Interface
	InputFile6  optional.Interface
	InputFile7  optional.Interface
	InputFile8  optional.Interface
	InputFile9  optional.Interface
	InputFile10 optional.Interface
}

type MergeDocumentTxtMultiOpts ¶ 

type MergeDocumentTxtMultiOpts struct {
	InputFile3  optional.Interface
	InputFile4  optional.Interface
	InputFile5  optional.Interface
	InputFile6  optional.Interface
	InputFile7  optional.Interface
	InputFile8  optional.Interface
	InputFile9  optional.Interface
	InputFile10 optional.Interface
}

type MergeDocumentXlsxMultiOpts ¶ 

type MergeDocumentXlsxMultiOpts struct {
	InputFile3  optional.Interface
	InputFile4  optional.Interface
	InputFile5  optional.Interface
	InputFile6  optional.Interface
	InputFile7  optional.Interface
	InputFile8  optional.Interface
	InputFile9  optional.Interface
	InputFile10 optional.Interface
}

type MergeJobStatusResult ¶ 

type MergeJobStatusResult struct {
	// True if the operation to check the status of the job was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Returns the job status of the Async Job, if applicable.  Possible states are STARTED and COMPLETED
	AsyncJobStatus string `json:"AsyncJobStatus,omitempty"`
	// When the job exceeds 25 pages, an Async Job ID is returned.  Use the CheckPdfOcrJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes
	AsyncJobID string `json:"AsyncJobID,omitempty"`
	// Resulting file output (if applicable)
	FileOutputResult string `json:"FileOutputResult,omitempty"`
	// Error message (if any)
	ErrorMessage string `json:"ErrorMessage,omitempty"`
}

Result of performing a batch job operation

type MsgAttachment ¶ 

type MsgAttachment struct {
	// Name of the attachment, including file extension
	Name string `json:"Name,omitempty"`
	// The MSG attachment as a byte[]
	Content string `json:"Content,omitempty"`
}

An MSG file attachment

type MsgToHtmlResult ¶ 

type MsgToHtmlResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// An HTML string version of the MSG file
	Content string `json:"Content,omitempty"`
	// The main body of the MSG file's email as an HTML string
	Body string `json:"Body,omitempty"`
	// The From sender of the MSG file's email
	From string `json:"From,omitempty"`
	// The To recipients of the MSG file's email
	To string `json:"To,omitempty"`
	// The CC recipients of the MSG file's email
	Cc string `json:"Cc,omitempty"`
	// The time that the MSG file's email was received
	ReceivedTime string `json:"ReceivedTime,omitempty"`
	// The subject of the MSG file's email
	Subject string `json:"Subject,omitempty"`
	// List of all attachments for the MSG file
	Attachments []MsgAttachment `json:"Attachments,omitempty"`
}

Result of converting an MSG file to HTML string

type MsgToJpgResult ¶ 

type MsgToJpgResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	JpgResultPages []ConvertedJpgPage `json:"JpgResultPages,omitempty"`
}

Result of converting a MSG input to a JPG array

type MsgToPngResult ¶ 

type MsgToPngResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngPage `json:"PngResultPages,omitempty"`
}

Result of converting a MSG input to a PNG array

type MultiReplaceStringRequest ¶ 

type MultiReplaceStringRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// An array of individual string replacement requests
	ReplaceStrings []SingleReplaceString `json:"ReplaceStrings,omitempty"`
}

Input to a multiple string replacement request

type MultipageImageFormatConversionResult ¶ 

type MultipageImageFormatConversionResult struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// The number of pages in the converted output
	PageCount int32 `json:"PageCount,omitempty"`
	// Converted page results
	Pages []PageConversionResult `json:"Pages,omitempty"`
}

Result of converting a multi-page image into individual pages with a different format

type OdpToJpgResult ¶ 

type OdpToJpgResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	JpgResultPages []ConvertedJpgPage `json:"JpgResultPages,omitempty"`
}

Result of converting an ODP input to a JPG array

type OdpToPngResult ¶ 

type OdpToPngResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngPage `json:"PngResultPages,omitempty"`
}

Result of converting an ODP input to a PNG array

type OdsToJpgResult ¶ 

type OdsToJpgResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	JpgResultPages []ConvertedJpgPage `json:"JpgResultPages,omitempty"`
}

Result of converting an ODS input to a JPG array

type OdsToPngResult ¶ 

type OdsToPngResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngPage `json:"PngResultPages,omitempty"`
}

Result of converting an ODS input to a PNG array

type OdtToJpgResult ¶ 

type OdtToJpgResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	JpgResultPages []ConvertedJpgPage `json:"JpgResultPages,omitempty"`
}

Result of converting an ODT input to a JPG array

type OdtToPngResult ¶ 

type OdtToPngResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngPage `json:"PngResultPages,omitempty"`
}

Result of converting an ODT input to a PNG array

type PageConversionResult ¶ 

type PageConversionResult struct {
	// File name of the image in the converted file format
	Filename string `json:"Filename,omitempty"`
	// File bytes (contents) of the image in converted file format
	FileBytes string `json:"FileBytes,omitempty"`
}

Converted page as an image

type PdfAnnotation ¶ 

type PdfAnnotation struct {
	// Title of the annotation; this is often the author of the annotation in Acrobat-created PDF files
	Title string `json:"Title,omitempty"`
	// Type of the annotation; possible values are Text
	AnnotationType string `json:"AnnotationType,omitempty"`
	// The 1-based index of the page containing the annotation
	PageNumber int32 `json:"PageNumber,omitempty"`
	// The 0-based index of the annotation in the document
	AnnotationIndex int32 `json:"AnnotationIndex,omitempty"`
	// Subject of the annotation
	Subject string `json:"Subject,omitempty"`
	// Text contents of the annotation
	TextContents string `json:"TextContents,omitempty"`
	// Date that the annotation was created
	CreationDate time.Time `json:"CreationDate,omitempty"`
	// Date that the annotation was last modified
	ModifiedDate time.Time `json:"ModifiedDate,omitempty"`
	// Left X coordinate for the location of the annotation
	LeftX float64 `json:"LeftX,omitempty"`
	// Top Y coordination of the location of the annotation
	TopY float64 `json:"TopY,omitempty"`
	// Width of the annotation
	Width float64 `json:"Width,omitempty"`
	// Height of the annotation
	Height float64 `json:"Height,omitempty"`
}

PDF Annotation details

type PdfDocument ¶ 

type PdfDocument struct {
	// Page number of the converted page, starting with 1 for the first page
	PageNumber int32 `json:"PageNumber,omitempty"`
	// URL to the PDF file of this worksheet; file is stored in an in-memory cache and will be deleted
	URL string `json:"URL,omitempty"`
	// If returnDocumentContents is set to true, will contain the contents of the document; otherwise will be set to null and the document contents will be available via the URL parameter
	DocumentContents string `json:"DocumentContents,omitempty"`
}

A single PDF file corresponding to one page in the original document

type PdfFormField ¶ 

type PdfFormField struct {
	// Name of the form field
	FieldName string `json:"FieldName,omitempty"`
	// The data type of the field; possible values are Text (FieldValue will be a string), Checkbox (FieldValue can be \"true\" or \"false\"), ComboBox (FieldComboBoxSelectedIndex will also be populated), Other
	FieldType string `json:"FieldType,omitempty"`
	// Value of the form field
	FieldValue string `json:"FieldValue,omitempty"`
	// Applies to ComboBox field types only; specifies the selected index of the combo box selection if available
	FieldComboBoxSelectedIndex int32 `json:"FieldComboBoxSelectedIndex,omitempty"`
}

Field definition and value in the form

type PdfFormFields ¶ 

type PdfFormFields struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Fields and field values found in the form
	FormFields []PdfFormField `json:"FormFields,omitempty"`
}

Result of retrieving PDF form fields

type PdfMetadata ¶ 

type PdfMetadata struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Details of any errors if the operation was unsucessful
	ErrorDetails string `json:"ErrorDetails,omitempty"`
	// Title of the document
	Title string `json:"Title,omitempty"`
	// Keywords of the document
	Keywords string `json:"Keywords,omitempty"`
	// Subject of the document
	Subject string `json:"Subject,omitempty"`
	// User name of the creator/author of the document, if available, null if not available
	Author string `json:"Author,omitempty"`
	// Creator of the document
	Creator string `json:"Creator,omitempty"`
	// The timestamp that the document was last modified, if available, null if not available
	DateModified time.Time `json:"DateModified,omitempty"`
	// The timestamp that the document was created, if available, null if not available
	DateCreated time.Time `json:"DateCreated,omitempty"`
	// The number of pages in the document
	PageCount int32 `json:"PageCount,omitempty"`
	// True if the PDF document is encrypted, false otherwise
	Encrypted bool `json:"Encrypted,omitempty"`
}

Result of an autodetect/get-info operation

type PdfPageText ¶ 

type PdfPageText struct {
	// Page number of the page (1-based)
	PageNumber int32 `json:"PageNumber,omitempty"`
	// Text of the page
	PageText string `json:"PageText,omitempty"`
}

Text of a single page of a PDF

type PdfTextByPageResult ¶ 

type PdfTextByPageResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Pages in the PDF
	Pages []PdfPageText `json:"Pages,omitempty"`
}

Text of the PDF, broken down by page

type PdfToJpgResult ¶ 

type PdfToJpgResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	JpgResultPages []ConvertedJpgPage `json:"JpgResultPages,omitempty"`
}

Result of converting a PDF input to a JPG array

type PdfToPngDirectResult ¶ 

type PdfToPngDirectResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngDirectPage `json:"PngResultPages,omitempty"`
}

Result of converting a PDF to a PNG array

type PdfToPngResult ¶ 

type PdfToPngResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngPage `json:"PngResultPages,omitempty"`
}

Result of converting a PDF to a PNG array

type PptxPageLayoutInformation ¶ 

type PptxPageLayoutInformation struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Orientation of the presentation, either portrait or landscape
	Orientation string `json:"Orientation,omitempty"`
	// Width of the presentation in Emu, where 1 inch equals 914400 emu.
	Width int32 `json:"Width,omitempty"`
	// Height of the presentation in Emu, where 1 inch equals 914400 emu.
	Height int32 `json:"Height,omitempty"`
}

Result of getting the page layout information of a PowerPoint PPTX presentation

type PptxSplitAdvancedRequest ¶ 

type PptxSplitAdvancedRequest struct {
	// Input file
	InputFile string `json:"InputFile,omitempty"`
	// Slides per presentation for result
	SlidesPerPresentation int32 `json:"SlidesPerPresentation,omitempty"`
}

Request to split a PowerPoint presentation

type PptxSplitAdvancedResponse ¶ 

type PptxSplitAdvancedResponse struct {
	ResultPresentations []PresentationAdvancedResult `json:"ResultPresentations,omitempty"`
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
}

Result of splitting a single PowerPoint Presentation PPTX into Separate Presentations

type PptxToPngResult ¶ 

type PptxToPngResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngPage `json:"PngResultPages,omitempty"`
}

Result of converting a PPTX input to a PNG array

type PresentationAdvancedResult ¶ 

type PresentationAdvancedResult struct {
	// Presentation number of the converted page, starting with 1 for the left-most worksheet
	SlideNumber int32 `json:"SlideNumber,omitempty"`
	// Contents of the presentation in bytes
	PresentationContents string `json:"PresentationContents,omitempty"`
}

A single PowerPoint PPTX file corresponding to one worksheet (tab) in the original spreadsheet

type PresentationResult ¶ 

type PresentationResult struct {
	// Worksheet number of the converted page, starting with 1 for the left-most worksheet
	SlideNumber int32 `json:"SlideNumber,omitempty"`
	// URL to the PPTX file of this slide; file is stored in an in-memory cache and will be deleted
	URL string `json:"URL,omitempty"`
	// Contents of the presentation in bytes
	PresentationContents string `json:"PresentationContents,omitempty"`
}

A single PowerPoint PPTX file corresponding to one slide in the original presentation

type RemoveDocxHeadersAndFootersRequest ¶ 

type RemoveDocxHeadersAndFootersRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// True if you would like to remove all headers from the input document, false otherwise
	RemoveHeaders bool `json:"RemoveHeaders,omitempty"`
	// True if you would like to remove all footers from the input document, false otherwise
	RemoveFooters bool `json:"RemoveFooters,omitempty"`
}

Input to a Remove Headers and Footers request

type RemoveDocxHeadersAndFootersResponse ¶ 

type RemoveDocxHeadersAndFootersResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL of the resulting edited document; this is a secure URL and cannot be downloaded without adding the Apikey header; it is also temporary, stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running a Remove Headers and Footers command

type RemoveDocxPagesRequest ¶ 

type RemoveDocxPagesRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Page number (1-based) to start deleting pages; inclusive
	StartDeletePageNumber int32 `json:"StartDeletePageNumber,omitempty"`
	// Page number (1-based) to stop deleting pages; inclusive
	EndDeletePageNumber int32 `json:"EndDeletePageNumber,omitempty"`
}

Input to a Remove Word DOCX Document Pages request

type RemoveHtmlFromTextRequest ¶ 

type RemoveHtmlFromTextRequest struct {
	// Input text string to remove the HTML from
	TextContainingHtml string `json:"TextContainingHtml,omitempty"`
}

Request to remove HTML from a string

type RemoveHtmlFromTextResponse ¶ 

type RemoveHtmlFromTextResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Result of performing a remove HTML from string operation
	TextContentResult string `json:"TextContentResult,omitempty"`
}

Result of removing HTML from a string

type RemovePptxSlidesRequest ¶ 

type RemovePptxSlidesRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Slide number (1-based) to start deleting slides; inclusive
	StartDeleteSlideNumber int32 `json:"StartDeleteSlideNumber,omitempty"`
	// Slide number (1-based) to stop deleting slides; inclusive
	EndDeleteSlideNumber int32 `json:"EndDeleteSlideNumber,omitempty"`
}

Input to a Remove PowerPoint PPTX Presentation Slides request

type RemoveWhitespaceFromTextRequest ¶ 

type RemoveWhitespaceFromTextRequest struct {
	// Input text string to remove the whitespace from
	TextContainingWhitespace string `json:"TextContainingWhitespace,omitempty"`
}

Request to remove whitespace from a string

type RemoveWhitespaceFromTextResponse ¶ 

type RemoveWhitespaceFromTextResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Result of performing a remove whitespace from string operation
	TextContentResult string `json:"TextContentResult,omitempty"`
}

Result of removing whitespace from a string

type RemoveXlsxWorksheetRequest ¶ 

type RemoveXlsxWorksheetRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Required; Worksheet (tab) within the spreadsheet to delete; leave blank to default to the first worksheet.  Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.
	WorksheetToRemove *XlsxWorksheet `json:"WorksheetToRemove,omitempty"`
}

Input to a Remove Excel XLSX Spreadsheet worksheet request

type RenameXlsxWorksheetRequest ¶ 

type RenameXlsxWorksheetRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Worksheet (tab) within the spreadsheet to get the specific row from; leave blank to default to the first worksheet
	WorksheetToRename *XlsxWorksheet `json:"WorksheetToRename,omitempty"`
	// Required; The new name to be used for the worksheet
	NewWorksheetName string `json:"NewWorksheetName,omitempty"`
}

Input to a Rename-Worksheet request

type RenameXlsxWorksheetResponse ¶ 

type RenameXlsxWorksheetResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running a Rename-Worksheet command

type ReplaceDocxParagraphRequest ¶ 

type ReplaceDocxParagraphRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Required: The target string to search for in the paragraphs of the document
	FindString string `json:"FindString,omitempty"`
	// Optional: True to match case, false to ignore case when matching
	MatchCase bool `json:"MatchCase,omitempty"`
	// Optional: Image to replace the paragraph with; note that most of the fields in this object are optional and do not need to be supplied
	ReplacementImage *DocxImage `json:"Replacement_Image,omitempty"`
}

Input to a request to replace matching paragraphs in a Word DOCX document

type ReplaceDocxParagraphResponse ¶ 

type ReplaceDocxParagraphResponse struct {
	// True if successful; false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL of the edited document
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of performing a replace matching paragraphs operation on a Word Document

type ReplaceStringRegexRequest ¶ 

type ReplaceStringRegexRequest struct {
	// Input text content
	TextContent string `json:"TextContent,omitempty"`
	// Target input regular expression (regex) string to match and be replaced; supports all regular expression values
	RegularExpressionString string `json:"RegularExpressionString,omitempty"`
	// Replacement for target string; supports referencing indexed regex matched values from RegularExpressionString, such as $1, $2, and so on
	ReplaceWithString string `json:"ReplaceWithString,omitempty"`
}

Request to replace a regex string in a string

type ReplaceStringRegexResponse ¶ 

type ReplaceStringRegexResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Result of performing a base 64 decode operation, binary file content
	TextContentResult string `json:"TextContentResult,omitempty"`
}

Result of replacing a regex string

type ReplaceStringRequest ¶ 

type ReplaceStringRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// String to search for and match against, to be replaced
	MatchString string `json:"MatchString,omitempty"`
	// String to replace the matched values with
	ReplaceString string `json:"ReplaceString,omitempty"`
	// True if the case should be matched, false for case insensitive match
	MatchCase bool `json:"MatchCase,omitempty"`
}

Input to a string replacement request

type ReplaceStringSimpleRequest ¶ 

type ReplaceStringSimpleRequest struct {
	// Input text content
	TextContent string `json:"TextContent,omitempty"`
	// Target input string to match and be replaced
	TargetString string `json:"TargetString,omitempty"`
	// Replacement for target string
	ReplaceWithString string `json:"ReplaceWithString,omitempty"`
}

Request to replace a string in a string

type ReplaceStringSimpleResponse ¶ 

type ReplaceStringSimpleResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Result of performing a replace string operation
	TextContentResult string `json:"TextContentResult,omitempty"`
}

Result of replacing a string

type RtfToJpgResult ¶ 

type RtfToJpgResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	JpgResultPages []ConvertedJpgPage `json:"JpgResultPages,omitempty"`
}

Result of converting a RTF input to a JPG array

type RtfToPngResult ¶ 

type RtfToPngResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngPage `json:"PngResultPages,omitempty"`
}

Result of converting a RTF input to a PNG array

type ScreenshotRequest ¶ 

type ScreenshotRequest struct {
	// URL address of the website to screenshot.  HTTP and HTTPS are both supported, as are custom ports.
	Url string `json:"Url,omitempty"`
	// Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites.  Provide a value of 0 for the default of 5000 milliseconds (5 seconds). Maximum is 20000 milliseconds (20 seconds).
	ExtraLoadingWait int32 `json:"ExtraLoadingWait,omitempty"`
	// Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024
	ScreenshotWidth int32 `json:"ScreenshotWidth,omitempty"`
	// Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot
	ScreenshotHeight int32 `json:"ScreenshotHeight,omitempty"`
}

Details of the screenshot request

type SetFormFieldValue ¶ 

type SetFormFieldValue struct {
	// Name of the field to set; you can call /convert/edit/pdf/form/get-fields to enumerate field names in a form
	FieldName string `json:"FieldName,omitempty"`
	// For fields of type Text, the text value to put into the field
	TextValue string `json:"TextValue,omitempty"`
	// For fields of type Checkbox, the value to put into the field
	CheckboxValue bool `json:"CheckboxValue,omitempty"`
	// For fields of type ComboBox; specifies the selected index of the combo box selection
	ComboBoxSelectedIndex int32 `json:"ComboBoxSelectedIndex,omitempty"`
}

Individual field value to set in a PDF form

type SetPdfFormFieldsRequest ¶ 

type SetPdfFormFieldsRequest struct {
	// Field values to set
	FieldValues []SetFormFieldValue `json:"FieldValues,omitempty"`
	// Contents of the input file to set the fields on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
}

Request to set the fields in a PDF form

type SetPdfMetadataRequest ¶ 

type SetPdfMetadataRequest struct {
	// Input file contents bytes for the file to modify
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// PDF metadata to set on the file
	MetadataToSet *PdfMetadata `json:"MetadataToSet,omitempty"`
}

Request to set PDF metadata

type SetXlsxCellByIdentifierRequest ¶ 

type SetXlsxCellByIdentifierRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Worksheet (tab) within the spreadsheet to update; leave blank to default to the first worksheet
	WorksheetToUpdate *XlsxWorksheet `json:"WorksheetToUpdate,omitempty"`
	// The Excel cell identifier (e.g. A1, B2, C33, etc.) of the cell to update
	CellIdentifier string `json:"CellIdentifier,omitempty"`
	// New Cell value to update/overwrite into the Excel XLSX spreadsheet
	CellValue *XlsxSpreadsheetCell `json:"CellValue,omitempty"`
}

Input to a Set Cell by identifier in XLSX Worksheets request

type SetXlsxCellByIdentifierResponse ¶ 

type SetXlsxCellByIdentifierResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running a Set Cell by identifier in XLSX Worksheets command

type SetXlsxCellRequest ¶ 

type SetXlsxCellRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Optional; Worksheet (tab) within the spreadsheet to update; leave blank to default to the first worksheet
	WorksheetToUpdate *XlsxWorksheet `json:"WorksheetToUpdate,omitempty"`
	// 0-based index of the row, 0, 1, 2, ... to set
	RowIndex int32 `json:"RowIndex,omitempty"`
	// 0-based index of the cell, 0, 1, 2, ... in the row to set
	CellIndex int32 `json:"CellIndex,omitempty"`
	// New Cell value to update/overwrite into the Excel XLSX spreadsheet
	CellValue *XlsxSpreadsheetCell `json:"CellValue,omitempty"`
}

Input to a Set Cell in XLSX Worksheets request

type SetXlsxCellResponse ¶ 

type SetXlsxCellResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running a Set Cell in XLSX Worksheets command

type SingleReplaceString ¶ 

type SingleReplaceString struct {
	// String to search for and match against, to be replaced
	MatchString string `json:"MatchString,omitempty"`
	// String to replace the matched values with
	ReplaceString string `json:"ReplaceString,omitempty"`
	// True if the case should be matched, false for case insensitive match
	MatchCase bool `json:"MatchCase,omitempty"`
}

A single string replacement request

type SplitBatchJobCreateResult ¶ 

type SplitBatchJobCreateResult struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// When creating a job, an Async Job ID is returned.  Use the GetAsyncJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes
	AsyncJobID string `json:"AsyncJobID,omitempty"`
}

Result of performing a split document batch job

type SplitDocumentApiService ¶ 

type SplitDocumentApiService service

func (*SplitDocumentApiService) SplitDocumentBatchJobCreate ¶ 

func (a *SplitDocumentApiService) SplitDocumentBatchJobCreate(ctx context.Context, inputFile *os.File, localVarOptionals *SplitDocumentBatchJobCreateOpts) (SplitBatchJobCreateResult, *http.Response, error)

func (*SplitDocumentApiService) SplitDocumentDocx ¶ 

func (a *SplitDocumentApiService) SplitDocumentDocx(ctx context.Context, inputFile *os.File, localVarOptionals *SplitDocumentDocxOpts) (SplitDocxDocumentResult, *http.Response, error)

func (*SplitDocumentApiService) SplitDocumentGetAsyncJobStatus ¶ 

func (a *SplitDocumentApiService) SplitDocumentGetAsyncJobStatus(ctx context.Context, asyncJobID string) (JobStatusResult, *http.Response, error)

SplitDocumentApiService Get the status and result of a Split Document Batch Job Returns the result of the Async Job - possible states can be STARTED or COMPLETED. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param asyncJobID

@return JobStatusResult

func (*SplitDocumentApiService) SplitDocumentPdfByPage ¶ 

func (a *SplitDocumentApiService) SplitDocumentPdfByPage(ctx context.Context, inputFile *os.File, localVarOptionals *SplitDocumentPdfByPageOpts) (SplitPdfResult, *http.Response, error)

func (*SplitDocumentApiService) SplitDocumentPptx ¶ 

func (a *SplitDocumentApiService) SplitDocumentPptx(ctx context.Context, inputFile *os.File, localVarOptionals *SplitDocumentPptxOpts) (SplitPptxPresentationResult, *http.Response, error)

func (*SplitDocumentApiService) SplitDocumentPptxAdvanced ¶ 

func (a *SplitDocumentApiService) SplitDocumentPptxAdvanced(ctx context.Context, request PptxSplitAdvancedRequest) (PptxSplitAdvancedResponse, *http.Response, error)

SplitDocumentApiService Split a single PowerPoint Presentation PPTX into Separate Presentations Split a PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentations of customizeable size.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request

@return PptxSplitAdvancedResponse

func (*SplitDocumentApiService) SplitDocumentTxtByLine ¶ 

func (a *SplitDocumentApiService) SplitDocumentTxtByLine(ctx context.Context, inputFile *os.File) (SplitTextDocumentByLinesResult, *http.Response, error)

SplitDocumentApiService Split a single Text file (txt) into lines Split a Text (txt) Document by line, returning each line separately in order. Supports multiple types of newlines.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return SplitTextDocumentByLinesResult

func (*SplitDocumentApiService) SplitDocumentTxtByString ¶ 

func (a *SplitDocumentApiService) SplitDocumentTxtByString(ctx context.Context, inputFile *os.File, splitDelimiter string, localVarOptionals *SplitDocumentTxtByStringOpts) (SplitTextDocumentByStringResult, *http.Response, error)

func (*SplitDocumentApiService) SplitDocumentXlsx ¶ 

func (a *SplitDocumentApiService) SplitDocumentXlsx(ctx context.Context, inputFile *os.File, localVarOptionals *SplitDocumentXlsxOpts) (SplitXlsxWorksheetResult, *http.Response, error)

type SplitDocumentBatchJobCreateOpts ¶ 

type SplitDocumentBatchJobCreateOpts struct {
	ReturnDocumentContents optional.Bool
}

type SplitDocumentDocxOpts ¶ 

type SplitDocumentDocxOpts struct {
	ReturnDocumentContents optional.Bool
}

type SplitDocumentPdfByPageOpts ¶ 

type SplitDocumentPdfByPageOpts struct {
	ReturnDocumentContents optional.Bool
}

type SplitDocumentPptxOpts ¶ 

type SplitDocumentPptxOpts struct {
	ReturnDocumentContents optional.Bool
}

type SplitDocumentResult ¶ 

type SplitDocumentResult struct {
	// Page number of the converted page, starting with 1 for the first page
	PageNumber int32 `json:"PageNumber,omitempty"`
	// URL to the DOCX file of this slide; file is stored in an in-memory cache and will be deleted
	URL string `json:"URL,omitempty"`
	// Contents of the document in bytes
	DocumentContents string `json:"DocumentContents,omitempty"`
}

A single Word DOCX file corresponding to one page in the original document

type SplitDocumentTxtByStringOpts ¶ 

type SplitDocumentTxtByStringOpts struct {
	SkipEmptyElements optional.Bool
}

type SplitDocumentXlsxOpts ¶ 

type SplitDocumentXlsxOpts struct {
	ReturnDocumentContents optional.Bool
}

type SplitDocxDocumentResult ¶ 

type SplitDocxDocumentResult struct {
	ResultDocuments []SplitDocumentResult `json:"ResultDocuments,omitempty"`
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
}

The result of splitting a Word document into individual Word DOCX pages

type SplitPdfResult ¶ 

type SplitPdfResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// PDF documents as output
	Documents []PdfDocument `json:"Documents,omitempty"`
}

Result of performing a PDF file split operation

type SplitPptxPresentationResult ¶ 

type SplitPptxPresentationResult struct {
	ResultPresentations []PresentationResult `json:"ResultPresentations,omitempty"`
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
}

The result of splitting a presentation into individual PowerPoint PPTX slides

type SplitTextDocumentByLinesResult ¶ 

type SplitTextDocumentByLinesResult struct {
	ResultLines []TextDocumentLine `json:"ResultLines,omitempty"`
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// The count of lines in the text file
	LineCount int32 `json:"LineCount,omitempty"`
}

The result of splitting a Text document into separate lines

type SplitTextDocumentByStringResult ¶ 

type SplitTextDocumentByStringResult struct {
	ResultElements []TextDocumentElement `json:"ResultElements,omitempty"`
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// The count of elements in the text file
	ElementCount int32 `json:"ElementCount,omitempty"`
}

The result of splitting a Text document into separate elements

type SplitXlsxWorksheetResult ¶ 

type SplitXlsxWorksheetResult struct {
	ResultWorksheets []WorksheetResult `json:"ResultWorksheets,omitempty"`
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
}

The result of splitting a spreadsheet into individual Excel XLSX worksheets

type TextConversionResult ¶ 

type TextConversionResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Plain Text (TXT) format conversion result of the input document.  The text result is returned as a string.
	TextResult string `json:"TextResult,omitempty"`
}

Text conversion result from converting a document to Plain Text (TXT) format

type TextDocumentElement ¶ 

type TextDocumentElement struct {
	// The 1-based line index of the element
	ElementNumber int32 `json:"ElementNumber,omitempty"`
	// The text contents of a single element of a text file
	ElementContents string `json:"ElementContents,omitempty"`
}

A single element of a Text document

type TextDocumentLine ¶ 

type TextDocumentLine struct {
	// The 1-based line index of the line
	LineNumber int32 `json:"LineNumber,omitempty"`
	// The text contents of a single line of a text file
	LineContents string `json:"LineContents,omitempty"`
}

A single line of a Text document

type TextEncodingDetectResponse ¶ 

type TextEncodingDetectResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Text encoding used in file; possible values are ASCII, UTF7, UTF8, UTF16, BigEndianUnicode and UTF32
	TextEncoding string `json:"TextEncoding,omitempty"`
}

Result of detecting text encoding

type Thumbnail ¶ 

type Thumbnail struct {
	// Index of this thumbnail
	Index int32 `json:"Index,omitempty"`
	// A PNG thumbnail of the document page
	Content string `json:"Content,omitempty"`
}

Result of converting a single document page to a PNG thumbnail

type TransformDocumentApiService ¶ 

type TransformDocumentApiService service

func (*TransformDocumentApiService) TransformDocumentDocxReplace ¶ 

func (a *TransformDocumentApiService) TransformDocumentDocxReplace(ctx context.Context, matchString string, replaceString string, localVarOptionals *TransformDocumentDocxReplaceOpts) (string, *http.Response, error)

func (*TransformDocumentApiService) TransformDocumentDocxReplaceEditSession ¶ 

func (a *TransformDocumentApiService) TransformDocumentDocxReplaceEditSession(ctx context.Context, matchString string, replaceString string, localVarOptionals *TransformDocumentDocxReplaceEditSessionOpts) (DocumentTransformEditSession, *http.Response, error)

func (*TransformDocumentApiService) TransformDocumentDocxTableFillIn ¶ 

func (a *TransformDocumentApiService) TransformDocumentDocxTableFillIn(ctx context.Context, request DocxTableTableFillRequest) (string, *http.Response, error)

TransformDocumentApiService Fill in data in a table in a Word DOCX document, return result Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request

@return string

func (*TransformDocumentApiService) TransformDocumentDocxTableFillInEditSession ¶ 

func (a *TransformDocumentApiService) TransformDocumentDocxTableFillInEditSession(ctx context.Context, request DocxTableTableFillRequest) (DocumentTransformEditSession, *http.Response, error)

TransformDocumentApiService Fill in data in a table in a Word DOCX document, return edit session Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates. Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request

@return DocumentTransformEditSession

func (*TransformDocumentApiService) TransformDocumentDocxTableFillInMulti ¶ 

func (a *TransformDocumentApiService) TransformDocumentDocxTableFillInMulti(ctx context.Context, request DocxTableTableFillMultiRequest) (string, *http.Response, error)

TransformDocumentApiService Fill in data in multiple tables in a Word DOCX document, return result Replace placeholder rows in multiple tables in an Office Word Document (docx) using one or more templates

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request

@return string

func (*TransformDocumentApiService) TransformDocumentPptxReplace ¶ 

func (a *TransformDocumentApiService) TransformDocumentPptxReplace(ctx context.Context, matchString string, replaceString string, localVarOptionals *TransformDocumentPptxReplaceOpts) (string, *http.Response, error)

type TransformDocumentDocxReplaceEditSessionOpts ¶ 

type TransformDocumentDocxReplaceEditSessionOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
	MatchCase    optional.Bool
}

type TransformDocumentDocxReplaceOpts ¶ 

type TransformDocumentDocxReplaceOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
	MatchCase    optional.Bool
}

type TransformDocumentPptxReplaceOpts ¶ 

type TransformDocumentPptxReplaceOpts struct {
	InputFile    optional.Interface
	InputFileUrl optional.String
	MatchCase    optional.Bool
}

type UpdateDocxTableCellRequest ¶ 

type UpdateDocxTableCellRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Table cell contents you would like to update the cell with
	CellToUpdate *DocxTableCell `json:"CellToUpdate,omitempty"`
	// 0-based index of the Table Row to update
	TableRowIndex int32 `json:"TableRowIndex,omitempty"`
	// 0-based index of the Table Cell (within the row) to update
	TableCellIndex int32 `json:"TableCellIndex,omitempty"`
	// Required; the path to the existing table to modify
	ExistingTablePath string `json:"ExistingTablePath,omitempty"`
}

Input to a Update Table Cell request

type UpdateDocxTableCellResponse ¶ 

type UpdateDocxTableCellResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running an Update Table Cell command

type UpdateDocxTableRowRequest ¶ 

type UpdateDocxTableRowRequest struct {
	// Optional: Bytes of the input file to operate on
	InputFileBytes string `json:"InputFileBytes,omitempty"`
	// Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
	InputFileUrl string `json:"InputFileUrl,omitempty"`
	// Table row contents you would like to update the row with
	RowToUpdate *DocxTableRow `json:"RowToUpdate,omitempty"`
	// 0-based index of the Table Row to update
	TableRowIndex int32 `json:"TableRowIndex,omitempty"`
	// Required; the path to the existing table to modify
	ExistingTablePath string `json:"ExistingTablePath,omitempty"`
}

Input to a Update Table Row request

type UpdateDocxTableRowResponse ¶ 

type UpdateDocxTableRowResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents.
	EditedDocumentURL string `json:"EditedDocumentURL,omitempty"`
}

Result of running an Update Table Row command

type UrlToPdfRequest ¶ 

type UrlToPdfRequest struct {
	// URL address of the website to screenshot.  HTTP and HTTPS are both supported, as are custom ports.
	Url string `json:"Url,omitempty"`
	// Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites.  Provide a value of 0 for the default of 5000 milliseconds (5 seconds). Maximum is 20000 milliseconds (20 seconds).
	ExtraLoadingWait int32 `json:"ExtraLoadingWait,omitempty"`
	// Optional: Set to true to include background graphics in the PDF, or false to not include.  Default is true.
	IncludeBackgroundGraphics bool `json:"IncludeBackgroundGraphics,omitempty"`
	// Optional: Set to 100 to scale at 100%, set to 50% to scale down to 50% scale, set to 200% to scale up to 200% scale, etc.  Default is 100%. Maximum is 1000%
	ScaleFactor int32 `json:"ScaleFactor,omitempty"`
}

Request to convert a URL to a PDF file

type UrlToTextRequest ¶ 

type UrlToTextRequest struct {
	// URL of the website to extract the text from
	Url string `json:"Url,omitempty"`
}

Details of the URL website to Text request

type UrlToTextResponse ¶ 

type UrlToTextResponse struct {
	// True if successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Text content result from the URL website input
	TextContentResult string `json:"TextContentResult,omitempty"`
}

Result of running the URL website to Text operation

type ValidateDocumentApiService ¶ 

type ValidateDocumentApiService service

func (*ValidateDocumentApiService) ValidateDocumentAutodetectValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentAutodetectValidation(ctx context.Context, inputFile *os.File) (AutodetectDocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Autodetect content type and validate Automatically detect the type of content, verify and validate that the content is indeed fully valid at depth, and then report the validation result.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return AutodetectDocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentCsvValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentCsvValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a CSV file document (CSV) Validate a CSV file document (CSV); if the document is not valid, identifies the errors in the document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentDocValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentDocValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a Word 97-2003 Legacy document (DOC) Validate a Word 97-2003 Legacy document (DOC)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentDocxRepair ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentDocxRepair(ctx context.Context, inputFile *os.File, localVarOptionals *ValidateDocumentDocxRepairOpts) (string, *http.Response, error)

func (*ValidateDocumentApiService) ValidateDocumentDocxValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentDocxValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a Word document (DOCX) Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentEmlValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentEmlValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate if input file is a valid EML file Validate if an input file is an EML email file; if the document is not valid

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentExecutableValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentExecutableValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate if a file is executable Validate if an input file is a binary executable file; if the document is not valid

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentGZipValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentGZipValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a GZip Archive file (gzip or gz) Validate a GZip archive file (GZIP or GZ)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentHtmlSsrfValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentHtmlSsrfValidation(ctx context.Context, inputFile *os.File) (HtmlSsrfThreatCheckResult, *http.Response, error)

ValidateDocumentApiService Validate an HTML file and checks for SSRF threats Validate an HTML document file and checks for SSRF (Server-side Request Forgery) threats in the file; if the document is not valid, identifies the errors in the document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return HtmlSsrfThreatCheckResult

func (*ValidateDocumentApiService) ValidateDocumentHtmlValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentHtmlValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate an HTML file Validate an HTML document file; if the document is not valid, identifies the errors in the document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentImageValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentImageValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate an Image File Validate an image file; if the document is not valid, identifies the errors in the document. Formats supported include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentJpgValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentJpgValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a JPG File Validate a JPEG image file; if the document is not valid, identifies the errors in the document..

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentJsonValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentJsonValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a JSON file Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentMsgValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentMsgValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate if input file is a valid MSG file Validate if an input file is an MSG email file; if the document is not valid

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentPdfValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentPdfValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a PDF document file Validate a PDF document; if the document is not valid, identifies the errors in the document. Also checks if the PDF is password protected.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentPngValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentPngValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a PNG File Validate a PNG image file; if the document is not valid, identifies the errors in the document.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentPptValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentPptValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a PowerPoint 97-2003 Legacy presentation (PPT) Validate a PowerPoint 97-2003 Legacy presentation (PPT)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentPptxRepair ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentPptxRepair(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ValidateDocumentApiService Repair a PowerPoint presentation (PPTX) that contains errors Repair a PowerPoint presentation document (PPTX) that contains errors or corruption, if possible.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ValidateDocumentApiService) ValidateDocumentPptxValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentPptxValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a PowerPoint presentation (PPTX) Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentRarValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentRarValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a RAR Archive file (RAR) Validate a RAR archive file (RAR)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentRtfValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentRtfValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a Rich Text Format document (RTF) Validate a Rich Text Format document (RTF)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentTarValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentTarValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a TAR Tarball Archive file (TAR) Validate a TAR tarball archive file (TAR)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentTxtValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentTxtValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate an TXT file Validate an TXT document file; if the document is not valid, identifies the errors in the document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentXlsValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentXlsValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a Excel 97-2003 Legacy spreadsheet (XLS) Validate a Excel 97-2003 Legacy spreadsheet (XLS)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentXlsxRepair ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentXlsxRepair(ctx context.Context, inputFile *os.File) (string, *http.Response, error)

ValidateDocumentApiService Repair an Excel spreadsheet (XLSX) that contains errors Repair an Excel spreadsheet document (XLSX) that contains errors or corruption, if possible.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return string

func (*ValidateDocumentApiService) ValidateDocumentXlsxValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentXlsxValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a Excel document (XLSX) Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentXmlValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentXmlValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate an XML file Validate an XML document file; if the document is not valid, identifies the errors in the document

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

func (*ValidateDocumentApiService) ValidateDocumentXmlXxeThreatValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentXmlXxeThreatValidation(ctx context.Context, inputFile *os.File) (XxeThreatDetectionResult, *http.Response, error)

ValidateDocumentApiService Validate an XML file for XML External Entity (XXE) threats Validate an XML document file for XML External Entity (XXE) threats; if the document is not valid, identifies the errors in the document. XXE threats are a type of threat that exploits vulnerabilities in the XML standard relating to external or local entity URIs in XML documents.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return XxeThreatDetectionResult

func (*ValidateDocumentApiService) ValidateDocumentZipValidation ¶ 

func (a *ValidateDocumentApiService) ValidateDocumentZipValidation(ctx context.Context, inputFile *os.File) (DocumentValidationResult, *http.Response, error)

ValidateDocumentApiService Validate a Zip Archive file (zip) Validate a Zip archive file (ZIP)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return DocumentValidationResult

type ValidateDocumentDocxRepairOpts ¶ 

type ValidateDocumentDocxRepairOpts struct {
	RepairMode optional.String
}

type ViewerResponse ¶ 

type ViewerResponse struct {
	HtmlEmbed  string `json:"HtmlEmbed,omitempty"`
	Successful bool   `json:"Successful,omitempty"`
}

Result of creating a viewer

type ViewerToolsApiService ¶ 

type ViewerToolsApiService service

func (*ViewerToolsApiService) ViewerToolsCreateSimple ¶ 

func (a *ViewerToolsApiService) ViewerToolsCreateSimple(ctx context.Context, inputFile *os.File, localVarOptionals *ViewerToolsCreateSimpleOpts) (ViewerResponse, *http.Response, error)

type ViewerToolsCreateSimpleOpts ¶ 

type ViewerToolsCreateSimpleOpts struct {
	Width  optional.Int32
	Height optional.Int32
}

type WorksheetResult ¶ 

type WorksheetResult struct {
	// Worksheet number of the converted page, starting with 1 for the left-most worksheet
	WorksheetNumber int32 `json:"WorksheetNumber,omitempty"`
	// The name of the worksheet
	WorksheetName string `json:"WorksheetName,omitempty"`
	// URL to the XLSX file of this worksheet; file is stored in an in-memory cache and will be deleted
	URL string `json:"URL,omitempty"`
	// Contents of the worksheet in bytes
	WorksheetContents string `json:"WorksheetContents,omitempty"`
}

A single Excel XLSX file corresponding to one worksheet (tab) in the original spreadsheet

type XlsxImage ¶ 

type XlsxImage struct {
	// The Path of the location of this object; leave blank for new rows
	Path string `json:"Path,omitempty"`
	// Read-only; internal ID for the image contents
	ImageDataEmbedId string `json:"ImageDataEmbedId,omitempty"`
	// Read-only; image data MIME content-type
	ImageDataContentType string `json:"ImageDataContentType,omitempty"`
	// Read-only; internal file name/path for the image
	ImageInternalFileName string `json:"ImageInternalFileName,omitempty"`
	// URL to the image contents; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the contents.
	ImageContentsURL string `json:"ImageContentsURL,omitempty"`
}

type XlsxSpreadsheetCell ¶ 

type XlsxSpreadsheetCell struct {
	// The Path of the location of this object; leave blank for new rows
	Path string `json:"Path,omitempty"`
	// Text value of the cell
	TextValue string `json:"TextValue,omitempty"`
	// Cell reference of the cell, e.g. A1, Z22, etc.
	CellIdentifier string `json:"CellIdentifier,omitempty"`
	// Identifier for the style to apply to this style
	StyleIndex int32  `json:"StyleIndex,omitempty"`
	Formula    string `json:"Formula,omitempty"`
}

Cell in an Excel Spreadsheet worksheet

type XlsxSpreadsheetColumn ¶ 

type XlsxSpreadsheetColumn struct {
	// The Path of the location of this object; leave blank for new rows
	Path string `json:"Path,omitempty"`
	// Heading cell for this column
	HeadingCell *XlsxSpreadsheetCell `json:"HeadingCell,omitempty"`
}

Column in an Excel spreadsheet worksheet

type XlsxSpreadsheetRow ¶ 

type XlsxSpreadsheetRow struct {
	// The Path of the location of this object; leave blank for new rows
	Path string `json:"Path,omitempty"`
	// Spreadsheet Cells in the spreadsheet row
	Cells []XlsxSpreadsheetCell `json:"Cells,omitempty"`
}

Row in an Excel spreadsheet worksheet

type XlsxToPngResult ¶ 

type XlsxToPngResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Array of converted pages
	PngResultPages []ConvertedPngPage `json:"PngResultPages,omitempty"`
}

Result of converting an XLSX input to a PNG array

type XlsxWorksheet ¶ 

type XlsxWorksheet struct {
	// The Path of the location of this object; leave blank for new worksheets
	Path string `json:"Path,omitempty"`
	// User-facing name of the worksheet tab
	WorksheetName string `json:"WorksheetName,omitempty"`
}

A worksheet (tab) in an Excel (XLSX) spreadsheet

type XmlAddAttributeWithXPathResult ¶ 

type XmlAddAttributeWithXPathResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Resulting, modified XML document
	ResultingXmlDocument string `json:"ResultingXmlDocument,omitempty"`
	// Count of the matching results
	NodesEditedCount int32 `json:"NodesEditedCount,omitempty"`
}

Result of performing a add attribute node operation on XML input using XPath

type XmlAddChildWithXPathResult ¶ 

type XmlAddChildWithXPathResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Resulting, modified XML document
	ResultingXmlDocument string `json:"ResultingXmlDocument,omitempty"`
	// Count of the matching results
	NodesEditedCount int32 `json:"NodesEditedCount,omitempty"`
}

Result of performing a add child node operation on XML input using XPath

type XmlFilterWithXPathResult ¶ 

type XmlFilterWithXPathResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Matching selected XML nodes as strings
	XmlNodes []string `json:"XmlNodes,omitempty"`
	// Count of the matching results
	ResultCount int32 `json:"ResultCount,omitempty"`
}

Result of performing a filter operation on XML input using XPath

type XmlQueryWithXQueryMultiResult ¶ 

type XmlQueryWithXQueryMultiResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Resulting XML result output
	ResultingXml string `json:"ResultingXml,omitempty"`
	// If an error occurs, additional details on the error
	ErrorMessage string `json:"ErrorMessage,omitempty"`
}

Result of performing an XQuery operation on multiple XML documents.

type XmlQueryWithXQueryResult ¶ 

type XmlQueryWithXQueryResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Resulting XML result output
	ResultingXml string `json:"ResultingXml,omitempty"`
	// If an error occurs, additional details on the error
	ErrorMessage string `json:"ErrorMessage,omitempty"`
}

Result of performing an XQuery operation on an XML document.

type XmlRemoveAllChildrenWithXPathResult ¶ 

type XmlRemoveAllChildrenWithXPathResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Resulting, modified XML document
	ResultingXmlDocument string `json:"ResultingXmlDocument,omitempty"`
	// Count of the matching results
	NodesEditedCount int32 `json:"NodesEditedCount,omitempty"`
}

Result of performing a remove all child nodes operation on XML input using XPath

type XmlRemoveWithXPathResult ¶ 

type XmlRemoveWithXPathResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Resulting, modified XML document with matching nodes removed as a string
	ResultingXmlDocument string `json:"ResultingXmlDocument,omitempty"`
	// Matching selected XML nodes as strings
	XmlNodesRemoved []string `json:"XmlNodesRemoved,omitempty"`
	// Count of the matching results
	NodesRemovedCount int32 `json:"NodesRemovedCount,omitempty"`
}

Result of performing a filter operation on XML input using XPath

type XmlReplaceWithXPathResult ¶ 

type XmlReplaceWithXPathResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Resulting, modified XML document
	ResultingXmlDocument string `json:"ResultingXmlDocument,omitempty"`
	// Count of the matching results
	NodesEditedCount int32 `json:"NodesEditedCount,omitempty"`
}

Result of performing a replace node operation on XML input using XPath

type XmlSetValueWithXPathResult ¶ 

type XmlSetValueWithXPathResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Resulting, modified XML document
	ResultingXmlDocument string `json:"ResultingXmlDocument,omitempty"`
	// Count of the matching results
	NodesEditedCount int32 `json:"NodesEditedCount,omitempty"`
}

Result of performing a set value operation on XML input using XPath

type XxeThreatDetectionResult ¶ 

type XxeThreatDetectionResult struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// True if the XML input contains XXE threats, false otherwise
	ContainsXxeThreat bool `json:"ContainsXxeThreat,omitempty"`
}

Result of performing an XXE threat detection operation

type ZipArchiveApiService ¶ 

type ZipArchiveApiService service

func (*ZipArchiveApiService) ZipArchiveZipCreate ¶ 

func (a *ZipArchiveApiService) ZipArchiveZipCreate(ctx context.Context, inputFile1 *os.File, localVarOptionals *ZipArchiveZipCreateOpts) (string, *http.Response, error)

func (*ZipArchiveApiService) ZipArchiveZipCreateAdvanced ¶ 

func (a *ZipArchiveApiService) ZipArchiveZipCreateAdvanced(ctx context.Context, request CreateZipArchiveRequest) (interface{}, *http.Response, error)

ZipArchiveApiService Compress files and folders to create a new zip archive with advanced options Create a new zip archive by compressing input files, folders and leverage advanced options to control the structure of the resulting zip archive.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param request Input request

@return interface{}

func (*ZipArchiveApiService) ZipArchiveZipCreateEncrypted ¶ 

func (a *ZipArchiveApiService) ZipArchiveZipCreateEncrypted(ctx context.Context, password string, inputFile1 *os.File, localVarOptionals *ZipArchiveZipCreateEncryptedOpts) (string, *http.Response, error)

func (*ZipArchiveApiService) ZipArchiveZipCreateQuarantine ¶ 

func (a *ZipArchiveApiService) ZipArchiveZipCreateQuarantine(ctx context.Context, password string, inputFile1 *os.File, localVarOptionals *ZipArchiveZipCreateQuarantineOpts) (interface{}, *http.Response, error)

func (*ZipArchiveApiService) ZipArchiveZipDecrypt ¶ 

func (a *ZipArchiveApiService) ZipArchiveZipDecrypt(ctx context.Context, inputFile *os.File, zipPassword string) (interface{}, *http.Response, error)

ZipArchiveApiService Decrypt and remove password protection on a zip file Decrypts and removes password protection from an encrypted zip file with the specified password

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.
  • @param zipPassword Required; Password for the input archive

@return interface{}

func (*ZipArchiveApiService) ZipArchiveZipEncryptAdvanced ¶ 

func (a *ZipArchiveApiService) ZipArchiveZipEncryptAdvanced(ctx context.Context, encryptionRequest ZipEncryptionAdvancedRequest) (interface{}, *http.Response, error)

ZipArchiveApiService Encrypt and password protect a zip file Encrypts and password protects an existing zip file with the specified password and encryption algorithm

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param encryptionRequest Encryption request

@return interface{}

func (*ZipArchiveApiService) ZipArchiveZipExtract ¶ 

func (a *ZipArchiveApiService) ZipArchiveZipExtract(ctx context.Context, inputFile *os.File) (ZipExtractResponse, *http.Response, error)

ZipArchiveApiService Extract, decompress files and folders from a zip archive Extracts a zip archive by decompressing files, and folders.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param inputFile Input file to perform the operation on.

@return ZipExtractResponse

type ZipArchiveZipCreateEncryptedOpts ¶ 

type ZipArchiveZipCreateEncryptedOpts struct {
	EncryptionAlgorithm optional.String
	InputFile2          optional.Interface
	InputFile3          optional.Interface
	InputFile4          optional.Interface
	InputFile5          optional.Interface
	InputFile6          optional.Interface
	InputFile7          optional.Interface
	InputFile8          optional.Interface
	InputFile9          optional.Interface
	InputFile10         optional.Interface
}

type ZipArchiveZipCreateOpts ¶ 

type ZipArchiveZipCreateOpts struct {
	InputFile2  optional.Interface
	InputFile3  optional.Interface
	InputFile4  optional.Interface
	InputFile5  optional.Interface
	InputFile6  optional.Interface
	InputFile7  optional.Interface
	InputFile8  optional.Interface
	InputFile9  optional.Interface
	InputFile10 optional.Interface
}

type ZipArchiveZipCreateQuarantineOpts ¶ 

type ZipArchiveZipCreateQuarantineOpts struct {
	EncryptionAlgorithm optional.String
}

type ZipDirectory ¶ 

type ZipDirectory struct {
	// Name of this directory
	DirectoryName string `json:"DirectoryName,omitempty"`
	// Child directories contained directly in this directory
	DirectoriesInDirectory []ZipDirectory `json:"DirectoriesInDirectory,omitempty"`
	// Child files contained directly in this directory
	FilesInDirectory []ZipFile `json:"FilesInDirectory,omitempty"`
}

Representation of a directory in a zip file

type ZipEncryptionAdvancedRequest ¶ 

type ZipEncryptionAdvancedRequest struct {
	// Input Zip File archive contents in bytes
	InputFileContents string `json:"InputFileContents,omitempty"`
	// Password to place on the Zip file; the longer the password, the more secure
	Password string `json:"Password,omitempty"`
	// Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm).  Default is AES-256.
	EncryptionAlgorithm string `json:"EncryptionAlgorithm,omitempty"`
}

Request to encrypt an existing Zip Archive file and protect it with a password

type ZipExtractResponse ¶ 

type ZipExtractResponse struct {
	// True if the operation was successful, false otherwise
	Successful bool `json:"Successful,omitempty"`
	// Top-level files in the root directory fo the zip file
	FilesInZip []ZipFile `json:"FilesInZip,omitempty"`
	// Top-level directories in the root directory of the zip; directories can contain sub-directories and files
	DirectoriesInZip []ZipDirectory `json:"DirectoriesInZip,omitempty"`
}

Result of performing a zip extract operation

type ZipFile ¶ 

type ZipFile struct {
	// Name of this file
	FileName string `json:"FileName,omitempty"`
	// Contents of this file
	FileContents string `json:"FileContents,omitempty"`
}

Representation of a file in a zip file

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.