asposepdfcloud

package module
Version: v0.0.0-...-e6cef95 Latest Latest
Warning

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

Go to latest
Published: Mar 18, 2022 License: MIT Imports: 18 Imported by: 0

README

GitHub release (latest by date) GitHub license

Go SDK for Aspose.PDF Cloud REST API

Aspose.PDF Cloud is a true REST API that enables you to perform a wide range of document processing operations including creation, manipulation, conversion and rendering of PDF documents in the cloud.

Our Cloud SDKs are wrappers around REST API in various programming languages, allowing you to process documents in language of your choice quickly and easily, gaining all benefits of strong types and IDE highlights. This repository contains new generation SDKs for Aspose.PDF Cloud and examples.

These SDKs are now fully supported. If you have any questions, see any bugs or have enhancement request, feel free to reach out to us at Free Support Forums.

Extract Text & Images of a PDF document online https://products.aspose.app/pdf/parser.

Enhancements in Version 22.3

  • PDFCLOUD-2729: Add StrikeOut, Superscript, Subscript properties to TextState.
  • PDFCLOUD-2623: Underline property is missing in TextState.
  • A new version of Aspose.PDF Cloud was prepared using the latest version of Aspose.PDF for .NET.

Bugs fixed in Version 22.3

  • PDFCLOUD-2714: GetFields API method not extracting PDF form fields.
  • PDFCLOUD-2641: PostSplitDocument returns wrong path.

Installation

    go get -u github.com/aspose-pdf-cloud/aspose-pdf-cloud-go

Getting Started

Please follow the installation instruction and execute the following Go code:

Get PDF Page Circle Annotations in Go

	// Get your ClientId and ClientSecret from https://dashboard.aspose.cloud (free registration required).

	config, _ := models.NewConfiguration("MY_CLIENT_ID", "MY_CLIENT_SECRET", "https://api.aspose.cloud")
	pdfAPI, ctx, _ := api.CreatePdf(config)
	name := "PdfWithAnnotations.pdf"

	args := map[string]interface{} {
		"folder": "path/to/remote/folder",
	}

	return pdfAPI.GetDocumentCircleAnnotations(name, args)

Unit Tests

Aspose PDF Cloud SDK includes a suite of unit tests within the "test" subdirectory. These Unit Tests also serves as examples of how to use the Aspose PDF Cloud SDK.

Licensing

All Aspose.PDF Cloud SDKs are licensed under MIT License.

Documentation for API Endpoints

All URIs are relative to https://api.aspose.cloud/v3.0

Class Method HTTP request Description
PdfApi CopyFile Put /pdf/storage/file/copy/{srcPath} Copy file
PdfApi CopyFolder Put /pdf/storage/folder/copy/{srcPath} Copy folder
PdfApi CreateFolder Put /pdf/storage/folder/{path} Create the folder
PdfApi DeleteAnnotation Delete /pdf/{name}/annotations/{annotationId} Delete document annotation by ID
PdfApi DeleteBookmark Delete /pdf/{name}/bookmarks/bookmark/{bookmarkPath} Delete document bookmark by ID.
PdfApi DeleteDocumentAnnotations Delete /pdf/{name}/annotations Delete all annotations from the document
PdfApi DeleteDocumentBookmarks Delete /pdf/{name}/bookmarks/tree Delete all document bookmarks.
PdfApi DeleteDocumentLinkAnnotations Delete /pdf/{name}/links Delete all link annotations from the document
PdfApi DeleteDocumentStamps Delete /pdf/{name}/stamps Delete all stamps from the document
PdfApi DeleteDocumentTables Delete /pdf/{name}/tables Delete all tables from the document
PdfApi DeleteField Delete /pdf/{name}/fields/{fieldName} Delete document field by name.
PdfApi DeleteFile Delete /pdf/storage/file/{path} Delete file
PdfApi DeleteFolder Delete /pdf/storage/folder/{path} Delete folder
PdfApi DeleteImage Delete /pdf/{name}/images/{imageId} Delete image from document page.
PdfApi DeleteLinkAnnotation Delete /pdf/{name}/links/{linkId} Delete document page link annotation by ID
PdfApi DeletePage Delete /pdf/{name}/pages/{pageNumber} Delete document page by its number.
PdfApi DeletePageAnnotations Delete /pdf/{name}/pages/{pageNumber}/annotations Delete all annotations from the page
PdfApi DeletePageLinkAnnotations Delete /pdf/{name}/pages/{pageNumber}/links Delete all link annotations from the page
PdfApi DeletePageStamps Delete /pdf/{name}/pages/{pageNumber}/stamps Delete all stamps from the page
PdfApi DeletePageTables Delete /pdf/{name}/pages/{pageNumber}/tables Delete all tables from the page
PdfApi DeleteProperties Delete /pdf/{name}/documentproperties Delete custom document properties.
PdfApi DeleteProperty Delete /pdf/{name}/documentproperties/{propertyName} Delete document property.
PdfApi DeleteStamp Delete /pdf/{name}/stamps/{stampId} Delete document stamp by ID
PdfApi DeleteTable Delete /pdf/{name}/tables/{tableId} Delete document table by ID
PdfApi DownloadFile Get /pdf/storage/file/{path} Download file
PdfApi GetBookmark Get /pdf/{name}/bookmarks/bookmark/{bookmarkPath} Read document bookmark.
PdfApi GetBookmarks Get /pdf/{name}/bookmarks/list/{bookmarkPath} Read document bookmarks node list.
PdfApi GetCaretAnnotation Get /pdf/{name}/annotations/caret/{annotationId} Read document page caret annotation by ID.
PdfApi GetCheckBoxField Get /pdf/{name}/fields/checkbox/{fieldName} Read document checkbox field by name.
PdfApi GetCircleAnnotation Get /pdf/{name}/annotations/circle/{annotationId} Read document page circle annotation by ID.
PdfApi GetComboBoxField Get /pdf/{name}/fields/combobox/{fieldName} Read document combobox field by name.
PdfApi GetDiscUsage Get /pdf/storage/disc Get disc usage
PdfApi GetDocument Get /pdf/{name} Read common document info.
PdfApi GetDocumentAnnotations Get /pdf/{name}/annotations Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
PdfApi GetDocumentAttachmentByIndex Get /pdf/{name}/attachments/{attachmentIndex} Read document attachment info by its index.
PdfApi GetDocumentAttachments Get /pdf/{name}/attachments Read document attachments info.
PdfApi GetDocumentBookmarks Get /pdf/{name}/bookmarks/tree Read document bookmarks tree.
PdfApi GetDocumentCaretAnnotations Get /pdf/{name}/annotations/caret Read document caret annotations.
PdfApi GetDocumentCheckBoxFields Get /pdf/{name}/fields/checkbox Read document checkbox fields.
PdfApi GetDocumentCircleAnnotations Get /pdf/{name}/annotations/circle Read document circle annotations.
PdfApi GetDocumentComboBoxFields Get /pdf/{name}/fields/combobox Read document combobox fields.
PdfApi GetDocumentDisplayProperties Get /pdf/{name}/displayproperties Read document display properties.
PdfApi GetDocumentFileAttachmentAnnotations Get /pdf/{name}/annotations/fileattachment Read document FileAttachment annotations.
PdfApi GetDocumentFreeTextAnnotations Get /pdf/{name}/annotations/freetext Read document free text annotations.
PdfApi GetDocumentHighlightAnnotations Get /pdf/{name}/annotations/highlight Read document highlight annotations.
PdfApi GetDocumentInkAnnotations Get /pdf/{name}/annotations/ink Read document ink annotations.
PdfApi GetDocumentLineAnnotations Get /pdf/{name}/annotations/line Read document line annotations.
PdfApi GetDocumentListBoxFields Get /pdf/{name}/fields/listbox Read document listbox fields.
PdfApi GetDocumentMovieAnnotations Get /pdf/{name}/annotations/movie Read document movie annotations.
PdfApi GetDocumentPolyLineAnnotations Get /pdf/{name}/annotations/polyline Read document polyline annotations.
PdfApi GetDocumentPolygonAnnotations Get /pdf/{name}/annotations/polygon Read document polygon annotations.
PdfApi GetDocumentPopupAnnotations Get /pdf/{name}/annotations/popup Read document popup annotations.
PdfApi GetDocumentPopupAnnotationsByParent Get /pdf/{name}/annotations/{annotationId}/popup Read document popup annotations by parent id.
PdfApi GetDocumentProperties Get /pdf/{name}/documentproperties Read document properties.
PdfApi GetDocumentProperty Get /pdf/{name}/documentproperties/{propertyName} Read document property by name.
PdfApi GetDocumentRadioButtonFields Get /pdf/{name}/fields/radiobutton Read document radiobutton fields.
PdfApi GetDocumentRedactionAnnotations Get /pdf/{name}/annotations/redaction Read document redaction annotations.
PdfApi GetDocumentScreenAnnotations Get /pdf/{name}/annotations/screen Read document screen annotations.
PdfApi GetDocumentSignatureFields Get /pdf/{name}/fields/signature Read document signature fields.
PdfApi GetDocumentSoundAnnotations Get /pdf/{name}/annotations/sound Read document sound annotations.
PdfApi GetDocumentSquareAnnotations Get /pdf/{name}/annotations/square Read document square annotations.
PdfApi GetDocumentSquigglyAnnotations Get /pdf/{name}/annotations/squiggly Read document squiggly annotations.
PdfApi GetDocumentStampAnnotations Get /pdf/{name}/annotations/stamp Read document stamp annotations.
PdfApi GetDocumentStamps Get /pdf/{name}/stamps Read document stamps.
PdfApi GetDocumentStrikeOutAnnotations Get /pdf/{name}/annotations/strikeout Read document StrikeOut annotations.
PdfApi GetDocumentTables Get /pdf/{name}/tables Read document tables.
PdfApi GetDocumentTextAnnotations Get /pdf/{name}/annotations/text Read document text annotations.
PdfApi GetDocumentTextBoxFields Get /pdf/{name}/fields/textbox Read document text box fields.
PdfApi GetDocumentUnderlineAnnotations Get /pdf/{name}/annotations/underline Read document underline annotations.
PdfApi GetDownloadDocumentAttachmentByIndex Get /pdf/{name}/attachments/{attachmentIndex}/download Download document attachment content by its index.
PdfApi GetEpubInStorageToPdf Get /pdf/create/epub Convert EPUB file (located on storage) to PDF format and return resulting file in response.
PdfApi GetExportFieldsFromPdfToFdfInStorage Get /pdf/{name}/export/fdf Export fields from from PDF in storage to FDF file.
PdfApi GetExportFieldsFromPdfToXfdfInStorage Get /pdf/{name}/export/xfdf Export fields from from PDF in storage to XFDF file.
PdfApi GetExportFieldsFromPdfToXmlInStorage Get /pdf/{name}/export/xml Export fields from from PDF in storage to XML file.
PdfApi GetField Get /pdf/{name}/fields/{fieldName} Get document field by name.
PdfApi GetFields Get /pdf/{name}/fields Get document fields.
PdfApi GetFileAttachmentAnnotation Get /pdf/{name}/annotations/fileattachment/{annotationId} Read document page FileAttachment annotation by ID.
PdfApi GetFileAttachmentAnnotationData Get /pdf/{name}/annotations/fileattachment/{annotationId}/data Read document page FileAttachment annotation by ID.
PdfApi GetFileVersions Get /pdf/storage/version/{path} Get file versions
PdfApi GetFilesList Get /pdf/storage/folder/{path} Get all files and folders within a folder
PdfApi GetFreeTextAnnotation Get /pdf/{name}/annotations/freetext/{annotationId} Read document page free text annotation by ID.
PdfApi GetHighlightAnnotation Get /pdf/{name}/annotations/highlight/{annotationId} Read document page highlight annotation by ID.
PdfApi GetHtmlInStorageToPdf Get /pdf/create/html Convert HTML file (located on storage) to PDF format and return resulting file in response.
PdfApi GetImage Get /pdf/{name}/images/{imageId} Read document image by ID.
PdfApi GetImageExtractAsGif Get /pdf/{name}/images/{imageId}/extract/gif Extract document image in GIF format
PdfApi GetImageExtractAsJpeg Get /pdf/{name}/images/{imageId}/extract/jpeg Extract document image in JPEG format
PdfApi GetImageExtractAsPng Get /pdf/{name}/images/{imageId}/extract/png Extract document image in PNG format
PdfApi GetImageExtractAsTiff Get /pdf/{name}/images/{imageId}/extract/tiff Extract document image in TIFF format
PdfApi GetImages Get /pdf/{name}/pages/{pageNumber}/images Read document images.
PdfApi GetImportFieldsFromFdfInStorage Get /pdf/{name}/import/fdf Update fields from FDF file in storage.
PdfApi GetImportFieldsFromXfdfInStorage Get /pdf/{name}/import/xfdf Update fields from XFDF file in storage.
PdfApi GetImportFieldsFromXmlInStorage Get /pdf/{name}/import/xml Import from XML file (located on storage) to PDF format and return resulting file in response.
PdfApi GetInkAnnotation Get /pdf/{name}/annotations/ink/{annotationId} Read document page ink annotation by ID.
PdfApi GetLineAnnotation Get /pdf/{name}/annotations/line/{annotationId} Read document page line annotation by ID.
PdfApi GetLinkAnnotation Get /pdf/{name}/links/{linkId} Read document link annotation by ID.
PdfApi GetListBoxField Get /pdf/{name}/fields/listbox/{fieldName} Read document listbox field by name.
PdfApi GetMarkdownInStorageToPdf Get /pdf/create/markdown Convert MD file (located on storage) to PDF format and return resulting file in response.
PdfApi GetMhtInStorageToPdf Get /pdf/create/mht Convert MHT file (located on storage) to PDF format and return resulting file in response.
PdfApi GetMovieAnnotation Get /pdf/{name}/annotations/movie/{annotationId} Read document page movie annotation by ID.
PdfApi GetPage Get /pdf/{name}/pages/{pageNumber} Read document page info.
PdfApi GetPageAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
PdfApi GetPageCaretAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/caret Read document page caret annotations.
PdfApi GetPageCheckBoxFields Get /pdf/{name}/page/{pageNumber}/fields/checkbox Read document page checkbox fields.
PdfApi GetPageCircleAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/circle Read document page circle annotations.
PdfApi GetPageComboBoxFields Get /pdf/{name}/page/{pageNumber}/fields/combobox Read document page combobox fields.
PdfApi GetPageConvertToBmp Get /pdf/{name}/pages/{pageNumber}/convert/bmp Convert document page to Bmp image and return resulting file in response.
PdfApi GetPageConvertToEmf Get /pdf/{name}/pages/{pageNumber}/convert/emf Convert document page to Emf image and return resulting file in response.
PdfApi GetPageConvertToGif Get /pdf/{name}/pages/{pageNumber}/convert/gif Convert document page to Gif image and return resulting file in response.
PdfApi GetPageConvertToJpeg Get /pdf/{name}/pages/{pageNumber}/convert/jpeg Convert document page to Jpeg image and return resulting file in response.
PdfApi GetPageConvertToPng Get /pdf/{name}/pages/{pageNumber}/convert/png Convert document page to Png image and return resulting file in response.
PdfApi GetPageConvertToTiff Get /pdf/{name}/pages/{pageNumber}/convert/tiff Convert document page to Tiff image and return resulting file in response.
PdfApi GetPageFileAttachmentAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/fileattachment Read document page FileAttachment annotations.
PdfApi GetPageFreeTextAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/freetext Read document page free text annotations.
PdfApi GetPageHighlightAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/highlight Read document page highlight annotations.
PdfApi GetPageInkAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/ink Read document page ink annotations.
PdfApi GetPageLineAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/line Read document page line annotations.
PdfApi GetPageLinkAnnotation Get /pdf/{name}/pages/{pageNumber}/links/{linkId} Read document page link annotation by ID.
PdfApi GetPageLinkAnnotations Get /pdf/{name}/pages/{pageNumber}/links Read document page link annotations.
PdfApi GetPageListBoxFields Get /pdf/{name}/page/{pageNumber}/fields/listbox Read document page listbox fields.
PdfApi GetPageMovieAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/movie Read document page movie annotations.
PdfApi GetPagePolyLineAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/polyline Read document page polyline annotations.
PdfApi GetPagePolygonAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/polygon Read document page polygon annotations.
PdfApi GetPagePopupAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/popup Read document page popup annotations.
PdfApi GetPageRadioButtonFields Get /pdf/{name}/page/{pageNumber}/fields/radiobutton Read document page radiobutton fields.
PdfApi GetPageRedactionAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/redaction Read document page redaction annotations.
PdfApi GetPageScreenAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/screen Read document page screen annotations.
PdfApi GetPageSignatureFields Get /pdf/{name}/page/{pageNumber}/fields/signature Read document page signature fields.
PdfApi GetPageSoundAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/sound Read document page sound annotations.
PdfApi GetPageSquareAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/square Read document page square annotations.
PdfApi GetPageSquigglyAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/squiggly Read document page squiggly annotations.
PdfApi GetPageStampAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/stamp Read document page stamp annotations.
PdfApi GetPageStamps Get /pdf/{name}/pages/{pageNumber}/stamps Read page document stamps.
PdfApi GetPageStrikeOutAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/strikeout Read document page StrikeOut annotations.
PdfApi GetPageTables Get /pdf/{name}/pages/{pageNumber}/tables Read document page tables.
PdfApi GetPageText Get /pdf/{name}/pages/{pageNumber}/text Read page text items.
PdfApi GetPageTextAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/text Read document page text annotations.
PdfApi GetPageTextBoxFields Get /pdf/{name}/page/{pageNumber}/fields/textbox Read document page text box fields.
PdfApi GetPageUnderlineAnnotations Get /pdf/{name}/pages/{pageNumber}/annotations/underline Read document page underline annotations.
PdfApi GetPages Get /pdf/{name}/pages Read document pages info.
PdfApi GetPclInStorageToPdf Get /pdf/create/pcl Convert PCL file (located on storage) to PDF format and return resulting file in response.
PdfApi GetPdfAInStorageToPdf Get /pdf/create/pdfa Convert PDFA file (located on storage) to PDF format and return resulting file in response.
PdfApi GetPdfInStorageToDoc Get /pdf/{name}/convert/doc Converts PDF document (located on storage) to DOC format and returns resulting file in response content
PdfApi GetPdfInStorageToEpub Get /pdf/{name}/convert/epub Converts PDF document (located on storage) to EPUB format and returns resulting file in response content
PdfApi GetPdfInStorageToHtml Get /pdf/{name}/convert/html Converts PDF document (located on storage) to Html format and returns resulting file in response content
PdfApi GetPdfInStorageToMobiXml Get /pdf/{name}/convert/mobixml Converts PDF document (located on storage) to MOBIXML format and returns resulting ZIP archive file in response content.
PdfApi GetPdfInStorageToPdfA Get /pdf/{name}/convert/pdfa Converts PDF document (located on storage) to PdfA format and returns resulting file in response content
PdfApi GetPdfInStorageToPptx Get /pdf/{name}/convert/pptx Converts PDF document (located on storage) to PPTX format and returns resulting file in response content
PdfApi GetPdfInStorageToSvg Get /pdf/{name}/convert/svg Converts PDF document (located on storage) to SVG format and returns resulting file in response content
PdfApi GetPdfInStorageToTeX Get /pdf/{name}/convert/tex Converts PDF document (located on storage) to TeX format and returns resulting file in response content
PdfApi GetPdfInStorageToTiff Get /pdf/{name}/convert/tiff Converts PDF document (located on storage) to TIFF format and returns resulting file in response content
PdfApi GetPdfInStorageToXls Get /pdf/{name}/convert/xls Converts PDF document (located on storage) to XLS format and returns resulting file in response content
PdfApi GetPdfInStorageToXlsx Get /pdf/{name}/convert/xlsx Converts PDF document (located on storage) to XLSX format and returns resulting file in response content
PdfApi GetPdfInStorageToXml Get /pdf/{name}/convert/xml Converts PDF document (located on storage) to XML format and returns resulting file in response content
PdfApi GetPdfInStorageToXps Get /pdf/{name}/convert/xps Converts PDF document (located on storage) to XPS format and returns resulting file in response content
PdfApi GetPolyLineAnnotation Get /pdf/{name}/annotations/polyline/{annotationId} Read document page polyline annotation by ID.
PdfApi GetPolygonAnnotation Get /pdf/{name}/annotations/polygon/{annotationId} Read document page polygon annotation by ID.
PdfApi GetPopupAnnotation Get /pdf/{name}/annotations/popup/{annotationId} Read document page popup annotation by ID.
PdfApi GetPsInStorageToPdf Get /pdf/create/ps Convert PS file (located on storage) to PDF format and return resulting file in response.
PdfApi GetRadioButtonField Get /pdf/{name}/fields/radiobutton/{fieldName} Read document RadioButton field by name.
PdfApi GetRedactionAnnotation Get /pdf/{name}/annotations/redaction/{annotationId} Read document page redaction annotation by ID.
PdfApi GetScreenAnnotation Get /pdf/{name}/annotations/screen/{annotationId} Read document page screen annotation by ID.
PdfApi GetScreenAnnotationData Get /pdf/{name}/annotations/screen/{annotationId}/data Read document page screen annotation by ID.
PdfApi GetSignatureField Get /pdf/{name}/fields/signature/{fieldName} Read document signature field by name.
PdfApi GetSoundAnnotation Get /pdf/{name}/annotations/sound/{annotationId} Read document page sound annotation by ID.
PdfApi GetSoundAnnotationData Get /pdf/{name}/annotations/sound/{annotationId}/data Read document page sound annotation by ID.
PdfApi GetSquareAnnotation Get /pdf/{name}/annotations/square/{annotationId} Read document page square annotation by ID.
PdfApi GetSquigglyAnnotation Get /pdf/{name}/annotations/squiggly/{annotationId} Read document page squiggly annotation by ID.
PdfApi GetStampAnnotation Get /pdf/{name}/annotations/stamp/{annotationId} Read document page stamp annotation by ID.
PdfApi GetStampAnnotationData Get /pdf/{name}/annotations/stamp/{annotationId}/data Read document page stamp annotation by ID.
PdfApi GetStrikeOutAnnotation Get /pdf/{name}/annotations/strikeout/{annotationId} Read document page StrikeOut annotation by ID.
PdfApi GetSvgInStorageToPdf Get /pdf/create/svg Convert SVG file (located on storage) to PDF format and return resulting file in response.
PdfApi GetTable Get /pdf/{name}/tables/{tableId} Read document page table by ID.
PdfApi GetTeXInStorageToPdf Get /pdf/create/tex Convert TeX file (located on storage) to PDF format and return resulting file in response.
PdfApi GetText Get /pdf/{name}/text Read document text.
PdfApi GetTextAnnotation Get /pdf/{name}/annotations/text/{annotationId} Read document page text annotation by ID.
PdfApi GetTextBoxField Get /pdf/{name}/fields/textbox/{fieldName} Read document text box field by name.
PdfApi GetUnderlineAnnotation Get /pdf/{name}/annotations/underline/{annotationId} Read document page underline annotation by ID.
PdfApi GetVerifySignature Get /pdf/{name}/verifySignature Verify signature document.
PdfApi GetWebInStorageToPdf Get /pdf/create/web Convert web page to PDF format and return resulting file in response.
PdfApi GetWordsPerPage Get /pdf/{name}/pages/wordCount Get number of words per document page.
PdfApi GetXfaPdfInStorageToAcroForm Get /pdf/{name}/convert/xfatoacroform Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and returns resulting file response content
PdfApi GetXmlInStorageToPdf Get /pdf/create/xml Convert XML file (located on storage) to PDF format and return resulting file in response.
PdfApi GetXpsInStorageToPdf Get /pdf/create/xps Convert XPS file (located on storage) to PDF format and return resulting file in response.
PdfApi GetXslFoInStorageToPdf Get /pdf/create/xslfo Convert XslFo file (located on storage) to PDF format and return resulting file in response.
PdfApi MoveFile Put /pdf/storage/file/move/{srcPath} Move file
PdfApi MoveFolder Put /pdf/storage/folder/move/{srcPath} Move folder
PdfApi ObjectExists Get /pdf/storage/exist/{path} Check if file or folder exists
PdfApi PostAppendDocument Post /pdf/{name}/appendDocument Append document to existing one.
PdfApi PostBookmark Post /pdf/{name}/bookmarks/bookmark/{bookmarkPath} Add document bookmarks.
PdfApi PostChangePasswordDocumentInStorage Post /pdf/{name}/changepassword Change document password in storage.
PdfApi PostCheckBoxFields Post /pdf/{name}/fields/checkbox Add document checkbox fields.
PdfApi PostComboBoxFields Post /pdf/{name}/fields/combobox Add document combobox fields.
PdfApi PostCreateDocument Post /pdf/{name} Create empty document.
PdfApi PostCreateField Post /pdf/{name}/fields Create field.
PdfApi PostDecryptDocumentInStorage Post /pdf/{name}/decrypt Decrypt document in storage.
PdfApi PostDocumentImageFooter Post /pdf/{name}/footer/image Add document image footer.
PdfApi PostDocumentImageHeader Post /pdf/{name}/header/image Add document image header.
PdfApi PostDocumentPageNumberStamps Post /pdf/{name}/stamps/pagenumber Add document page number stamps.
PdfApi PostDocumentTextFooter Post /pdf/{name}/footer/text Add document text footer.
PdfApi PostDocumentTextHeader Post /pdf/{name}/header/text Add document text header.
PdfApi PostDocumentTextReplace Post /pdf/{name}/text/replace Document's replace text method.
PdfApi PostEncryptDocumentInStorage Post /pdf/{name}/encrypt Encrypt document in storage.
PdfApi PostFlattenDocument Post /pdf/{name}/flatten Flatten the document.
PdfApi PostImportFieldsFromFdf Post /pdf/{name}/import/fdf Update fields from FDF file in request.
PdfApi PostImportFieldsFromXfdf Post /pdf/{name}/import/xfdf Update fields from XFDF file in request.
PdfApi PostImportFieldsFromXml Post /pdf/{name}/import/xml Update fields from XML file in request.
PdfApi PostInsertImage Post /pdf/{name}/pages/{pageNumber}/images Insert image to document page.
PdfApi PostListBoxFields Post /pdf/{name}/fields/listbox Add document listbox fields.
PdfApi PostMovePage Post /pdf/{name}/pages/{pageNumber}/movePage Move page to new position.
PdfApi PostOptimizeDocument Post /pdf/{name}/optimize Optimize document.
PdfApi PostPageCaretAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/caret Add document page caret annotations.
PdfApi PostPageCertify Post /pdf/{name}/pages/{pageNumber}/certify Certify document page.
PdfApi PostPageCircleAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/circle Add document page circle annotations.
PdfApi PostPageFileAttachmentAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/fileattachment Add document page FileAttachment annotations.
PdfApi PostPageFreeTextAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/freetext Add document page free text annotations.
PdfApi PostPageHighlightAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/highlight Add document page highlight annotations.
PdfApi PostPageImageStamps Post /pdf/{name}/pages/{pageNumber}/stamps/image Add document page image stamps.
PdfApi PostPageInkAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/ink Add document page ink annotations.
PdfApi PostPageLineAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/line Add document page line annotations.
PdfApi PostPageLinkAnnotations Post /pdf/{name}/pages/{pageNumber}/links Add document page link annotations.
PdfApi PostPageMovieAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/movie Add document page movie annotations.
PdfApi PostPagePdfPageStamps Post /pdf/{name}/pages/{pageNumber}/stamps/pdfpage Add document pdf page stamps.
PdfApi PostPagePolyLineAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/polyline Add document page polyline annotations.
PdfApi PostPagePolygonAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/polygon Add document page polygon annotations.
PdfApi PostPageRedactionAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/redaction Add document page redaction annotations.
PdfApi PostPageScreenAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/screen Add document page screen annotations.
PdfApi PostPageSoundAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/sound Add document page sound annotations.
PdfApi PostPageSquareAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/square Add document page square annotations.
PdfApi PostPageSquigglyAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/squiggly Add document page squiggly annotations.
PdfApi PostPageStampAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/stamp Add document page stamp annotations.
PdfApi PostPageStrikeOutAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/strikeout Add document page StrikeOut annotations.
PdfApi PostPageTables Post /pdf/{name}/pages/{pageNumber}/tables Add document page tables.
PdfApi PostPageTextAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/text Add document page text annotations.
PdfApi PostPageTextReplace Post /pdf/{name}/pages/{pageNumber}/text/replace Page's replace text method.
PdfApi PostPageTextStamps Post /pdf/{name}/pages/{pageNumber}/stamps/text Add document page text stamps.
PdfApi PostPageUnderlineAnnotations Post /pdf/{name}/pages/{pageNumber}/annotations/underline Add document page underline annotations.
PdfApi PostPopupAnnotation Post /pdf/{name}/annotations/{annotationId}/popup Add document popup annotations.
PdfApi PostRadioButtonFields Post /pdf/{name}/fields/radiobutton Add document RadioButton fields.
PdfApi PostSignDocument Post /pdf/{name}/sign Sign document.
PdfApi PostSignPage Post /pdf/{name}/pages/{pageNumber}/sign Sign page.
PdfApi PostSignatureField Post /pdf/{name}/fields/signature Add document signature field.
PdfApi PostSplitDocument Post /pdf/{name}/split Split document to parts.
PdfApi PostTextBoxFields Post /pdf/{name}/fields/textbox Add document text box fields.
PdfApi PutAddNewPage Put /pdf/{name}/pages Add new page to end of the document.
PdfApi PutAddText Put /pdf/{name}/pages/{pageNumber}/text Add text to PDF document page.
PdfApi PutAnnotationsFlatten Put /pdf/{name}/annotations/flatten Flattens the annotations of the specified types
PdfApi PutBookmark Put /pdf/{name}/bookmarks/bookmark/{bookmarkPath} Update document bookmark.
PdfApi PutCaretAnnotation Put /pdf/{name}/annotations/caret/{annotationId} Replace document caret annotation
PdfApi PutChangePasswordDocument Put /pdf/changepassword Change document password from content.
PdfApi PutCheckBoxField Put /pdf/{name}/fields/checkbox/{fieldName} Replace document checkbox field
PdfApi PutCircleAnnotation Put /pdf/{name}/annotations/circle/{annotationId} Replace document circle annotation
PdfApi PutComboBoxField Put /pdf/{name}/fields/combobox/{fieldName} Replace document combobox field
PdfApi PutCreateDocument Put /pdf/{name} Create empty document.
PdfApi PutDecryptDocument Put /pdf/decrypt Decrypt document from content.
PdfApi PutDocumentDisplayProperties Put /pdf/{name}/displayproperties Update document display properties.
PdfApi PutEncryptDocument Put /pdf/encrypt Encrypt document from content.
PdfApi PutEpubInStorageToPdf Put /pdf/{name}/create/epub Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutExportFieldsFromPdfToFdfInStorage Put /pdf/{name}/export/fdf Export fields from from PDF in storage to FDF file in storage.
PdfApi PutExportFieldsFromPdfToXfdfInStorage Put /pdf/{name}/export/xfdf Export fields from from PDF in storage to XFDF file in storage.
PdfApi PutExportFieldsFromPdfToXmlInStorage Put /pdf/{name}/export/xml Export fields from from PDF in storage to XML file in storage.
PdfApi PutFieldsFlatten Put /pdf/{name}/fields/flatten Flatten form fields in document.
PdfApi PutFileAttachmentAnnotation Put /pdf/{name}/annotations/fileattachment/{annotationId} Replace document FileAttachment annotation
PdfApi PutFileAttachmentAnnotationDataExtract Put /pdf/{name}/annotations/fileattachment/{annotationId}/data/extract Extract document FileAttachment annotation content to storage
PdfApi PutFreeTextAnnotation Put /pdf/{name}/annotations/freetext/{annotationId} Replace document free text annotation
PdfApi PutHighlightAnnotation Put /pdf/{name}/annotations/highlight/{annotationId} Replace document highlight annotation
PdfApi PutHtmlInStorageToPdf Put /pdf/{name}/create/html Convert HTML file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutImageExtractAsGif Put /pdf/{name}/images/{imageId}/extract/gif Extract document image in GIF format to folder
PdfApi PutImageExtractAsJpeg Put /pdf/{name}/images/{imageId}/extract/jpeg Extract document image in JPEG format to folder
PdfApi PutImageExtractAsPng Put /pdf/{name}/images/{imageId}/extract/png Extract document image in PNG format to folder
PdfApi PutImageExtractAsTiff Put /pdf/{name}/images/{imageId}/extract/tiff Extract document image in TIFF format to folder
PdfApi PutImageInStorageToPdf Put /pdf/{name}/create/images Convert image file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutImagesExtractAsGif Put /pdf/{name}/pages/{pageNumber}/images/extract/gif Extract document images in GIF format to folder.
PdfApi PutImagesExtractAsJpeg Put /pdf/{name}/pages/{pageNumber}/images/extract/jpeg Extract document images in JPEG format to folder.
PdfApi PutImagesExtractAsPng Put /pdf/{name}/pages/{pageNumber}/images/extract/png Extract document images in PNG format to folder.
PdfApi PutImagesExtractAsTiff Put /pdf/{name}/pages/{pageNumber}/images/extract/tiff Extract document images in TIFF format to folder.
PdfApi PutImportFieldsFromFdfInStorage Put /pdf/{name}/import/fdf Update fields from FDF file in storage.
PdfApi PutImportFieldsFromXfdfInStorage Put /pdf/{name}/import/xfdf Update fields from XFDF file in storage.
PdfApi PutImportFieldsFromXmlInStorage Put /pdf/{name}/import/xml Update fields from XML file in storage.
PdfApi PutInkAnnotation Put /pdf/{name}/annotations/ink/{annotationId} Replace document ink annotation
PdfApi PutLineAnnotation Put /pdf/{name}/annotations/line/{annotationId} Replace document line annotation
PdfApi PutLinkAnnotation Put /pdf/{name}/links/{linkId} Replace document page link annotations
PdfApi PutListBoxField Put /pdf/{name}/fields/listbox/{fieldName} Replace document listbox field
PdfApi PutMarkdownInStorageToPdf Put /pdf/{name}/create/markdown Convert MD file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutMergeDocuments Put /pdf/{name}/merge Merge a list of documents.
PdfApi PutMhtInStorageToPdf Put /pdf/{name}/create/mht Convert MHT file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutMovieAnnotation Put /pdf/{name}/annotations/movie/{annotationId} Replace document movie annotation
PdfApi PutPageAddStamp Put /pdf/{name}/pages/{pageNumber}/stamp Add page stamp.
PdfApi PutPageConvertToBmp Put /pdf/{name}/pages/{pageNumber}/convert/bmp Convert document page to bmp image and upload resulting file to storage.
PdfApi PutPageConvertToEmf Put /pdf/{name}/pages/{pageNumber}/convert/emf Convert document page to emf image and upload resulting file to storage.
PdfApi PutPageConvertToGif Put /pdf/{name}/pages/{pageNumber}/convert/gif Convert document page to gif image and upload resulting file to storage.
PdfApi PutPageConvertToJpeg Put /pdf/{name}/pages/{pageNumber}/convert/jpeg Convert document page to Jpeg image and upload resulting file to storage.
PdfApi PutPageConvertToPng Put /pdf/{name}/pages/{pageNumber}/convert/png Convert document page to png image and upload resulting file to storage.
PdfApi PutPageConvertToTiff Put /pdf/{name}/pages/{pageNumber}/convert/tiff Convert document page to Tiff image and upload resulting file to storage.
PdfApi PutPclInStorageToPdf Put /pdf/{name}/create/pcl Convert PCL file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutPdfAInStorageToPdf Put /pdf/{name}/create/pdfa Convert PDFA file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutPdfInRequestToDoc Put /pdf/convert/doc Converts PDF document (in request content) to DOC format and uploads resulting file to storage.
PdfApi PutPdfInRequestToEpub Put /pdf/convert/epub Converts PDF document (in request content) to EPUB format and uploads resulting file to storage.
PdfApi PutPdfInRequestToHtml Put /pdf/convert/html Converts PDF document (in request content) to Html format and uploads resulting file to storage.
PdfApi PutPdfInRequestToMobiXml Put /pdf/convert/mobixml Converts PDF document (in request content) to MOBIXML format and uploads resulting ZIP archive file to storage.
PdfApi PutPdfInRequestToPdfA Put /pdf/convert/pdfa Converts PDF document (in request content) to PdfA format and uploads resulting file to storage.
PdfApi PutPdfInRequestToPptx Put /pdf/convert/pptx Converts PDF document (in request content) to PPTX format and uploads resulting file to storage.
PdfApi PutPdfInRequestToSvg Put /pdf/convert/svg Converts PDF document (in request content) to SVG format and uploads resulting file to storage.
PdfApi PutPdfInRequestToTeX Put /pdf/convert/tex Converts PDF document (in request content) to TeX format and uploads resulting file to storage.
PdfApi PutPdfInRequestToTiff Put /pdf/convert/tiff Converts PDF document (in request content) to TIFF format and uploads resulting file to storage.
PdfApi PutPdfInRequestToXls Put /pdf/convert/xls Converts PDF document (in request content) to XLS format and uploads resulting file to storage.
PdfApi PutPdfInRequestToXlsx Put /pdf/convert/xlsx Converts PDF document (in request content) to XLSX format and uploads resulting file to storage.
PdfApi PutPdfInRequestToXml Put /pdf/convert/xml Converts PDF document (in request content) to XML format and uploads resulting file to storage.
PdfApi PutPdfInRequestToXps Put /pdf/convert/xps Converts PDF document (in request content) to XPS format and uploads resulting file to storage.
PdfApi PutPdfInStorageToDoc Put /pdf/{name}/convert/doc Converts PDF document (located on storage) to DOC format and uploads resulting file to storage
PdfApi PutPdfInStorageToEpub Put /pdf/{name}/convert/epub Converts PDF document (located on storage) to EPUB format and uploads resulting file to storage
PdfApi PutPdfInStorageToHtml Put /pdf/{name}/convert/html Converts PDF document (located on storage) to Html format and uploads resulting file to storage
PdfApi PutPdfInStorageToMobiXml Put /pdf/{name}/convert/mobixml Converts PDF document (located on storage) to MOBIXML format and uploads resulting ZIP archive file to storage
PdfApi PutPdfInStorageToPdfA Put /pdf/{name}/convert/pdfa Converts PDF document (located on storage) to PdfA format and uploads resulting file to storage
PdfApi PutPdfInStorageToPptx Put /pdf/{name}/convert/pptx Converts PDF document (located on storage) to PPTX format and uploads resulting file to storage
PdfApi PutPdfInStorageToSvg Put /pdf/{name}/convert/svg Converts PDF document (located on storage) to SVG format and uploads resulting file to storage
PdfApi PutPdfInStorageToTeX Put /pdf/{name}/convert/tex Converts PDF document (located on storage) to TeX format and uploads resulting file to storage
PdfApi PutPdfInStorageToTiff Put /pdf/{name}/convert/tiff Converts PDF document (located on storage) to TIFF format and uploads resulting file to storage
PdfApi PutPdfInStorageToXls Put /pdf/{name}/convert/xls Converts PDF document (located on storage) to XLS format and uploads resulting file to storage
PdfApi PutPdfInStorageToXlsx Put /pdf/{name}/convert/xlsx Converts PDF document (located on storage) to XLSX format and uploads resulting file to storage
PdfApi PutPdfInStorageToXml Put /pdf/{name}/convert/xml Converts PDF document (located on storage) to XML format and uploads resulting file to storage
PdfApi PutPdfInStorageToXps Put /pdf/{name}/convert/xps Converts PDF document (located on storage) to XPS format and uploads resulting file to storage
PdfApi PutPolyLineAnnotation Put /pdf/{name}/annotations/polyline/{annotationId} Replace document polyline annotation
PdfApi PutPolygonAnnotation Put /pdf/{name}/annotations/polygon/{annotationId} Replace document polygon annotation
PdfApi PutPopupAnnotation Put /pdf/{name}/annotations/popup/{annotationId} Replace document popup annotation
PdfApi PutPrivileges Put /pdf/{name}/privileges Update privilege document.
PdfApi PutPsInStorageToPdf Put /pdf/{name}/create/ps Convert PS file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutRadioButtonField Put /pdf/{name}/fields/radiobutton/{fieldName} Replace document RadioButton field
PdfApi PutRedactionAnnotation Put /pdf/{name}/annotations/redaction/{annotationId} Replace document redaction annotation
PdfApi PutReplaceImage Put /pdf/{name}/images/{imageId} Replace document image.
PdfApi PutScreenAnnotation Put /pdf/{name}/annotations/screen/{annotationId} Replace document screen annotation
PdfApi PutScreenAnnotationDataExtract Put /pdf/{name}/annotations/screen/{annotationId}/data/extract Extract document screen annotation content to storage
PdfApi PutSearchableDocument Put /pdf/{name}/ocr Create searchable PDF document. Generate OCR layer for images in input PDF document.
PdfApi PutSetProperty Put /pdf/{name}/documentproperties/{propertyName} Add/update document property.
PdfApi PutSignatureField Put /pdf/{name}/fields/signature/{fieldName} Replace document signature field.
PdfApi PutSoundAnnotation Put /pdf/{name}/annotations/sound/{annotationId} Replace document sound annotation
PdfApi PutSoundAnnotationDataExtract Put /pdf/{name}/annotations/sound/{annotationId}/data/extract Extract document sound annotation content to storage
PdfApi PutSquareAnnotation Put /pdf/{name}/annotations/square/{annotationId} Replace document square annotation
PdfApi PutSquigglyAnnotation Put /pdf/{name}/annotations/squiggly/{annotationId} Replace document squiggly annotation
PdfApi PutStampAnnotation Put /pdf/{name}/annotations/stamp/{annotationId} Replace document stamp annotation
PdfApi PutStampAnnotationDataExtract Put /pdf/{name}/annotations/stamp/{annotationId}/data/extract Extract document stamp annotation content to storage
PdfApi PutStrikeOutAnnotation Put /pdf/{name}/annotations/strikeout/{annotationId} Replace document StrikeOut annotation
PdfApi PutSvgInStorageToPdf Put /pdf/{name}/create/svg Convert SVG file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutTable Put /pdf/{name}/tables/{tableId} Replace document page table.
PdfApi PutTeXInStorageToPdf Put /pdf/{name}/create/tex Convert TeX file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutTextAnnotation Put /pdf/{name}/annotations/text/{annotationId} Replace document text annotation
PdfApi PutTextBoxField Put /pdf/{name}/fields/textbox/{fieldName} Replace document text box field
PdfApi PutUnderlineAnnotation Put /pdf/{name}/annotations/underline/{annotationId} Replace document underline annotation
PdfApi PutUpdateField Put /pdf/{name}/fields/{fieldName} Update field.
PdfApi PutUpdateFields Put /pdf/{name}/fields Update fields.
PdfApi PutWebInStorageToPdf Put /pdf/{name}/create/web Convert web page to PDF format and upload resulting file to storage.
PdfApi PutXfaPdfInRequestToAcroForm Put /pdf/convert/xfatoacroform Converts PDF document which contains XFA form (in request content) to PDF with AcroForm and uploads resulting file to storage.
PdfApi PutXfaPdfInStorageToAcroForm Put /pdf/{name}/convert/xfatoacroform Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and uploads resulting file to storage
PdfApi PutXmlInStorageToPdf Put /pdf/{name}/create/xml Convert XML file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutXpsInStorageToPdf Put /pdf/{name}/create/xps Convert XPS file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutXslFoInStorageToPdf Put /pdf/{name}/create/xslfo Convert XslFo file (located on storage) to PDF format and upload resulting file to storage.
PdfApi StorageExists Get /pdf/storage/{storageName}/exist Check if storage exists
PdfApi UploadFile Put /pdf/storage/file/{path} Upload file

Documentation For Models

Documentation

Overview

* * Copyright (c) 2022 Aspose.PDF Cloud * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. *

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 {

	// API Services
	PdfApi *PdfApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Aspose.PDF Cloud API Reference API v3.0 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

func (*APIClient) RequestOauthToken

func (a *APIClient) RequestOauthToken() error

RequestOauthToken function for requests OAuth token

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 Annotation

type Annotation struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the annotation content.
	Contents string `json:"Contents,omitempty"`
	// The date and time when the annotation was last modified.
	Modified string `json:"Modified,omitempty"`
	// Gets ID of the annotation.
	Id string `json:"Id,omitempty"`
	// Gets Flags of the annotation.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Gets Name of the annotation.
	Name string `json:"Name,omitempty"`
	// Gets Rect of the annotation.
	Rect *Rectangle `json:"Rect"`
	// Gets PageIndex of the annotation.
	PageIndex int32 `json:"PageIndex,omitempty"`
	// Gets ZIndex of the annotation.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Gets HorizontalAlignment of the annotation.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the annotation.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
}

Provides annotation.

type AnnotationFlags

type AnnotationFlags string

AnnotationFlags : A set of flags specifying various characteristics of the annotation.

const (
	AnnotationFlagsDefault        AnnotationFlags = "Default"
	AnnotationFlagsInvisible      AnnotationFlags = "Invisible"
	AnnotationFlagsHidden         AnnotationFlags = "Hidden"
	AnnotationFlagsPrint          AnnotationFlags = "Print"
	AnnotationFlagsNoZoom         AnnotationFlags = "NoZoom"
	AnnotationFlagsNoRotate       AnnotationFlags = "NoRotate"
	AnnotationFlagsNoView         AnnotationFlags = "NoView"
	AnnotationFlagsReadOnly       AnnotationFlags = "ReadOnly"
	AnnotationFlagsLocked         AnnotationFlags = "Locked"
	AnnotationFlagsToggleNoView   AnnotationFlags = "ToggleNoView"
	AnnotationFlagsLockedContents AnnotationFlags = "LockedContents"
)

List of AnnotationFlags

type AnnotationInfo

type AnnotationInfo struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the annotation content.
	Contents string `json:"Contents,omitempty"`
	// The date and time when the annotation was last modified.
	Modified string `json:"Modified,omitempty"`
	// Gets ID of the annotation.
	Id string `json:"Id,omitempty"`
	// Gets Flags of the annotation.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Gets Name of the annotation.
	Name string `json:"Name,omitempty"`
	// Gets Rect of the annotation.
	Rect *Rectangle `json:"Rect"`
	// Gets PageIndex of the annotation.
	PageIndex int32 `json:"PageIndex,omitempty"`
	// Gets ZIndex of the annotation.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Gets HorizontalAlignment of the annotation.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the annotation.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// Gets annotation type.
	AnnotationType AnnotationType `json:"AnnotationType"`
}

Provides annotation.

type AnnotationState

type AnnotationState string

AnnotationState : The enumeration of states to which the original annotation can be set.

const (
	AnnotationStateUndefined AnnotationState = "Undefined"
	AnnotationStateMarked    AnnotationState = "Marked"
	AnnotationStateUnmarked  AnnotationState = "Unmarked"
	AnnotationStateAccepted  AnnotationState = "Accepted"
	AnnotationStateRejected  AnnotationState = "Rejected"
	AnnotationStateCancelled AnnotationState = "Cancelled"
	AnnotationStateCompleted AnnotationState = "Completed"
	AnnotationStateNone      AnnotationState = "None"
)

List of AnnotationState

type AnnotationType

type AnnotationType string

AnnotationType :

const (
	AnnotationTypeText           AnnotationType = "Text"
	AnnotationTypeCircle         AnnotationType = "Circle"
	AnnotationTypePolygon        AnnotationType = "Polygon"
	AnnotationTypePolyLine       AnnotationType = "PolyLine"
	AnnotationTypeLine           AnnotationType = "Line"
	AnnotationTypeSquare         AnnotationType = "Square"
	AnnotationTypeFreeText       AnnotationType = "FreeText"
	AnnotationTypeHighlight      AnnotationType = "Highlight"
	AnnotationTypeUnderline      AnnotationType = "Underline"
	AnnotationTypeSquiggly       AnnotationType = "Squiggly"
	AnnotationTypeStrikeOut      AnnotationType = "StrikeOut"
	AnnotationTypeCaret          AnnotationType = "Caret"
	AnnotationTypeInk            AnnotationType = "Ink"
	AnnotationTypeLink           AnnotationType = "Link"
	AnnotationTypePopup          AnnotationType = "Popup"
	AnnotationTypeFileAttachment AnnotationType = "FileAttachment"
	AnnotationTypeSound          AnnotationType = "Sound"
	AnnotationTypeMovie          AnnotationType = "Movie"
	AnnotationTypeScreen         AnnotationType = "Screen"
	AnnotationTypeWidget         AnnotationType = "Widget"
	AnnotationTypeWatermark      AnnotationType = "Watermark"
	AnnotationTypeTrapNet        AnnotationType = "TrapNet"
	AnnotationTypePrinterMark    AnnotationType = "PrinterMark"
	AnnotationTypeRedaction      AnnotationType = "Redaction"
	AnnotationTypeStamp          AnnotationType = "Stamp"
	AnnotationTypeRichMedia      AnnotationType = "RichMedia"
	AnnotationTypeUnknown        AnnotationType = "Unknown"
	AnnotationTypePDF3D          AnnotationType = "PDF3D"
)

List of AnnotationType

type AnnotationsInfo

type AnnotationsInfo struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of annotation info objects.
	List []AnnotationInfo `json:"List,omitempty"`
}

Object representing a list of annotation info objects.

type AnnotationsInfoResponse

type AnnotationsInfoResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Annotations info
	Annotations *AnnotationsInfo `json:"Annotations,omitempty"`
}

Represents multiple annotations info reponse

type AntialiasingProcessingType

type AntialiasingProcessingType string

AntialiasingProcessingType : This enum describes possible antialiasing measures during conversion

const (
	AntialiasingProcessingTypeNoAdditionalProcessing AntialiasingProcessingType = "NoAdditionalProcessing"
	AntialiasingProcessingTypeTryCorrectResultHtml   AntialiasingProcessingType = "TryCorrectResultHtml"
)

List of AntialiasingProcessingType

type ApiInfo

type ApiInfo struct {
	// Product name.
	Name string `json:"Name,omitempty"`
	// API version.
	Version string `json:"Version,omitempty"`
}

Represents response for ApiInfo DTO

type AsposeResponse

type AsposeResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
}

Base class for all responses.

type Attachment

type Attachment struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Gets text associated with the attachment.
	Description string `json:"Description,omitempty"`
	// Gets subtype of the attachment file.
	MimeType string `json:"MimeType,omitempty"`
	// Gets the name of the attachment.
	Name string `json:"Name,omitempty"`
	// The date and time when the embedded file was created.
	CreationDate string `json:"CreationDate,omitempty"`
	// The date and time when the embedded file was last modified.
	ModificationDate string `json:"ModificationDate,omitempty"`
	// The size of the uncompressed embedded file, in bytes.
	Size int32 `json:"Size"`
	// A 16-byte string that is the checksum of the bytes of the uncompressed embedded file.  The checksum is calculated by applying the standard MD5 message-digest algorithm  to the bytes of the embedded file stream.
	CheckSum string `json:"CheckSum,omitempty"`
}

Provides link to attachment.

type AttachmentResponse

type AttachmentResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Attachment object
	Attachment *Attachment `json:"Attachment,omitempty"`
}

Represents response containing single attachment info

type Attachments

type Attachments struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of annotations.
	List []LinkElement `json:"List,omitempty"`
}

Represents list of attachment.

type AttachmentsResponse

type AttachmentsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Attachments object
	Attachments *Attachments `json:"Attachments,omitempty"`
}

Represents response containing multiple attachments info

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 Bookmark

type Bookmark struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Get the Title;
	Title string `json:"Title,omitempty"`
	// Is bookmark italic.
	Italic bool `json:"Italic,omitempty"`
	// Is bookmark bold.
	Bold bool `json:"Bold,omitempty"`
	// Get the color
	Color *Color `json:"Color,omitempty"`
	// Gets or sets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: \"GoTo\", \"GoToR\", \"Launch\", \"Named\".
	Action string `json:"Action,omitempty"`
	// Gets or sets bookmark's hierarchy level.
	Level int32 `json:"Level,omitempty"`
	// Gets or sets bookmark's destination page. Required if action is set as string.Empty.
	Destination string `json:"Destination,omitempty"`
	// Gets or sets the type of display bookmark's destination page.
	PageDisplay string `json:"PageDisplay,omitempty"`
	// Gets or sets the bottom coordinate of page display.
	PageDisplayBottom int32 `json:"PageDisplay_Bottom,omitempty"`
	// Gets or sets the left coordinate of page display.
	PageDisplayLeft int32 `json:"PageDisplay_Left,omitempty"`
	// Gets or sets the right coordinate of page display.
	PageDisplayRight int32 `json:"PageDisplay_Right,omitempty"`
	// Gets or sets the top coordinate of page display.
	PageDisplayTop int32 `json:"PageDisplay_Top,omitempty"`
	// Gets or sets the zoom factor of page display.
	PageDisplayZoom int32 `json:"PageDisplay_Zoom,omitempty"`
	// Gets or sets the number of bookmark's destination page.
	PageNumber int32 `json:"PageNumber,omitempty"`
	// Gets or sets the file (path) which is required for \"GoToR\" action of bookmark.
	RemoteFile string `json:"RemoteFile,omitempty"`
	// The children bookmarks.
	Bookmarks *Bookmarks `json:"Bookmarks,omitempty"`
}

Provides link to bookmark.

type BookmarkResponse

type BookmarkResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Bookmark object
	Bookmark *Bookmark `json:"Bookmark,omitempty"`
}

Represents response containing single bookmark info

type Bookmarks

type Bookmarks struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of bookmarks.
	List []Bookmark `json:"List,omitempty"`
}

Represents list of bookmark.

type BookmarksResponse

type BookmarksResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Bookmarks object
	Bookmarks *Bookmarks `json:"Bookmarks,omitempty"`
}

Represents response containing multiple bookmarks info

type Border

type Border struct {
	// Gets or sets border width.
	Width int32 `json:"Width,omitempty"`
	// Gets or sets effect intencity. Valid range of value is [0..2].
	EffectIntensity int32 `json:"EffectIntensity,omitempty"`
	// Gets or sets border style.
	Style BorderStyle `json:"Style,omitempty"`
	// Gets or sets border effect.
	Effect BorderEffect `json:"Effect,omitempty"`
	// Gets or sets dash pattern.
	Dash *Dash `json:"Dash,omitempty"`
	// Gets or sets border color.
	Color *Color `json:"Color,omitempty"`
}

Class representing characteristics of annotation border.

type BorderCornerStyle

type BorderCornerStyle string

BorderCornerStyle : Enumerates the border corner styles for border.

const (
	BorderCornerStyleNone  BorderCornerStyle = "None"
	BorderCornerStyleRound BorderCornerStyle = "Round"
)

List of BorderCornerStyle

type BorderEffect

type BorderEffect string

BorderEffect : Describes effect which should be applied to the border of the annotations.

const (
	BorderEffectNone   BorderEffect = "None"
	BorderEffectCloudy BorderEffect = "Cloudy"
)

List of BorderEffect

type BorderInfo

type BorderInfo struct {
	// Gets or sets a object that indicates left of the border.
	Left *GraphInfo `json:"Left,omitempty"`
	// Gets or sets a object that indicates right of the border.
	Right *GraphInfo `json:"Right,omitempty"`
	// Gets or sets a object that indicates the top border.
	Top *GraphInfo `json:"Top,omitempty"`
	// Gets or sets a object that indicates bottom of the border.
	Bottom *GraphInfo `json:"Bottom,omitempty"`
	// Gets or sets a rouded border radius
	RoundedBorderRadius float64 `json:"RoundedBorderRadius,omitempty"`
}

This class represents border for graphics elements.

type BorderStyle

type BorderStyle string

BorderStyle : Describes style of the annotation border.

const (
	BorderStyleSolid     BorderStyle = "Solid"
	BorderStyleDashed    BorderStyle = "Dashed"
	BorderStyleBeveled   BorderStyle = "Beveled"
	BorderStyleInset     BorderStyle = "Inset"
	BorderStyleUnderline BorderStyle = "Underline"
)

List of BorderStyle

type BoxStyle

type BoxStyle string

BoxStyle : Represents an enumeration of available BoxStyle types.

const (
	BoxStyleCircle  BoxStyle = "Circle"
	BoxStyleCheck   BoxStyle = "Check"
	BoxStyleCross   BoxStyle = "Cross"
	BoxStyleDiamond BoxStyle = "Diamond"
	BoxStyleSquare  BoxStyle = "Square"
	BoxStyleStar    BoxStyle = "Star"
)

List of BoxStyle

type CapStyle

type CapStyle string

CapStyle : Style of line ending of Ink annotation line.

const (
	CapStyleRectangular CapStyle = "Rectangular"
	CapStyleRounded     CapStyle = "Rounded"
)

List of CapStyle

type CaptionPosition

type CaptionPosition string

CaptionPosition : Enumeration of the annotation’s caption positioning.

const (
	CaptionPositionInline CaptionPosition = "Inline"
	CaptionPositionTop    CaptionPosition = "Top"
)

List of CaptionPosition

type CaretAnnotation

type CaretAnnotation struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the annotation content.
	Contents string `json:"Contents,omitempty"`
	// The date and time when the annotation was last modified.
	Modified string `json:"Modified,omitempty"`
	// Gets ID of the annotation.
	Id string `json:"Id,omitempty"`
	// Gets Flags of the annotation.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Gets Name of the annotation.
	Name string `json:"Name,omitempty"`
	// Gets Rect of the annotation.
	Rect *Rectangle `json:"Rect"`
	// Gets PageIndex of the annotation.
	PageIndex int32 `json:"PageIndex,omitempty"`
	// Gets ZIndex of the annotation.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Gets HorizontalAlignment of the annotation.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the annotation.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// The date and time when the annotation was created.
	CreationDate string `json:"CreationDate,omitempty"`
	// Get the annotation subject.
	Subject string `json:"Subject,omitempty"`
	// Get the annotation title.
	Title string `json:"Title,omitempty"`
	// Get the annotation RichText.
	RichText string `json:"RichText,omitempty"`
	// Gets or sets caret rectangle.
	Frame *Rectangle `json:"Frame,omitempty"`
	// Gets or sets symbol associated with caret.
	Symbol CaretSymbol `json:"Symbol,omitempty"`
}

Provides CaretAnnotation.

type CaretAnnotationResponse

type CaretAnnotationResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Caret annotation object
	Annotation *CaretAnnotation `json:"Annotation,omitempty"`
}

Represents response containing single caret annotation object

type CaretAnnotations

type CaretAnnotations struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of caret annotations.
	List []CaretAnnotation `json:"List,omitempty"`
}

Object representing a list of caret annotations.

type CaretAnnotationsResponse

type CaretAnnotationsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Caret annotations object
	Annotations *CaretAnnotations `json:"Annotations,omitempty"`
}

Represents response containing multiple caret annotation objects

type CaretSymbol

type CaretSymbol string

CaretSymbol : A symbol to be associated with the caret.

const (
	CaretSymbolNone      CaretSymbol = "None"
	CaretSymbolParagraph CaretSymbol = "Paragraph"
)

List of CaretSymbol

type Cell

type Cell struct {
	// Gets or sets the cell have border.
	IsNoBorder bool `json:"IsNoBorder,omitempty"`
	// Gets or sets the padding.
	Margin *MarginInfo `json:"Margin,omitempty"`
	// Gets or sets the border.
	Border *BorderInfo `json:"Border,omitempty"`
	// Gets or sets the background color.
	BackgroundColor *Color `json:"BackgroundColor,omitempty"`
	// Gets or sets the background image file.
	BackgroundImageFile string `json:"BackgroundImageFile,omitempty"`
	// Gets or sets path of the background image file from storage.
	BackgroundImageStorageFile string `json:"BackgroundImageStorageFile,omitempty"`
	// Gets or sets the alignment.
	Alignment HorizontalAlignment `json:"Alignment,omitempty"`
	// Gets or sets the default cell text state.
	DefaultCellTextState *TextState `json:"DefaultCellTextState,omitempty"`
	// Gets or sets the cell's formatted text.
	Paragraphs []TextRect `json:"Paragraphs,omitempty"`
	// Gets or sets the cell's text word wrapped.
	IsWordWrapped bool `json:"IsWordWrapped,omitempty"`
	// Gets or sets the vertical alignment.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// Gets or sets the column span.
	ColSpan int32 `json:"ColSpan,omitempty"`
	// Gets or sets the row span.
	RowSpan int32 `json:"RowSpan,omitempty"`
	// Gets or sets the column width.
	Width float64 `json:"Width,omitempty"`
	// Gets or sets Html fragment.
	HtmlFragment string `json:"HtmlFragment,omitempty"`
	// Gets or sets ImageFragment list.
	Images []ImageFragment `json:"Images,omitempty"`
}

Represents a cell of the table's row.

type CellRecognized

type CellRecognized struct {
	// Gets collection of TextRect objects that describes text containing in the cell
	TextRects *TextRects `json:"TextRects,omitempty"`
	// Gets rectangle that describes position of the cell on page
	Rectangle *Rectangle `json:"Rectangle,omitempty"`
}

type CheckBoxField

type CheckBoxField struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Field name.
	PartialName string `json:"PartialName,omitempty"`
	// Full Field name.
	FullName string `json:"FullName,omitempty"`
	// Field rectangle.
	Rect *Rectangle `json:"Rect,omitempty"`
	// Field value.
	Value string `json:"Value,omitempty"`
	// Page index.
	PageIndex int32 `json:"PageIndex"`
	// Gets or sets height of the field.
	Height float64 `json:"Height,omitempty"`
	// Gets or sets width of the field.
	Width float64 `json:"Width,omitempty"`
	// Z index.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Is group.
	IsGroup bool `json:"IsGroup,omitempty"`
	// Gets field parent.
	Parent *FormField `json:"Parent,omitempty"`
	// Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page.
	IsSharedField bool `json:"IsSharedField,omitempty"`
	// Gets Flags of the field.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the field content.
	Contents string `json:"Contents,omitempty"`
	// Gets or sets a outer margin for paragraph (for pdf generation)
	Margin *MarginInfo `json:"Margin,omitempty"`
	// Field highlighting mode.
	Highlighting LinkHighlightingMode `json:"Highlighting,omitempty"`
	// Gets HorizontalAlignment of the field.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the field.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// Gets or sets annotation border characteristics.
	Border *Border `json:"Border,omitempty"`
	// Returns list of allowed states.
	AllowedStates []string `json:"AllowedStates,omitempty"`
	// Gets or sets style of check box.
	Style BoxStyle `json:"Style,omitempty"`
	// Gets or sets current annotation appearance state.
	ActiveState string `json:"ActiveState,omitempty"`
	// Gets or sets state of check box.
	Checked bool `json:"Checked"`
	// Gets or sets export value of CheckBox field.
	ExportValue string `json:"ExportValue,omitempty"`
}

Provides CheckBoxField.

type CheckBoxFieldResponse

type CheckBoxFieldResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Checkbox field object
	Field *CheckBoxField `json:"Field,omitempty"`
}

Represents response containing single checkbox field object

type CheckBoxFields

type CheckBoxFields struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of checkbox fields.
	List []CheckBoxField `json:"List,omitempty"`
}

Object representing a list of checkbox fields.

type CheckBoxFieldsResponse

type CheckBoxFieldsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Checkbox fields object
	Fields *CheckBoxFields `json:"Fields,omitempty"`
}

Represents response containing multiple checkbox field objects

type ChoiceField

type ChoiceField struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Field name.
	PartialName string `json:"PartialName,omitempty"`
	// Full Field name.
	FullName string `json:"FullName,omitempty"`
	// Field rectangle.
	Rect *Rectangle `json:"Rect,omitempty"`
	// Field value.
	Value string `json:"Value,omitempty"`
	// Page index.
	PageIndex int32 `json:"PageIndex"`
	// Gets or sets height of the field.
	Height float64 `json:"Height,omitempty"`
	// Gets or sets width of the field.
	Width float64 `json:"Width,omitempty"`
	// Z index.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Is group.
	IsGroup bool `json:"IsGroup,omitempty"`
	// Gets field parent.
	Parent *FormField `json:"Parent,omitempty"`
	// Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page.
	IsSharedField bool `json:"IsSharedField,omitempty"`
	// Gets Flags of the field.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the field content.
	Contents string `json:"Contents,omitempty"`
	// Gets or sets a outer margin for paragraph (for pdf generation)
	Margin *MarginInfo `json:"Margin,omitempty"`
	// Field highlighting mode.
	Highlighting LinkHighlightingMode `json:"Highlighting,omitempty"`
	// Gets HorizontalAlignment of the field.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the field.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// Gets or sets annotation border characteristics.
	Border *Border `json:"Border,omitempty"`
	// Gets or sets multiselection flag.
	MultiSelect bool `json:"MultiSelect,omitempty"`
	// Gets or sets index of selected item. Numbering of items is started from 1.
	Selected int32 `json:"Selected,omitempty"`
}

Provides Choice field.

type CircleAnnotation

type CircleAnnotation struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the annotation content.
	Contents string `json:"Contents,omitempty"`
	// The date and time when the annotation was last modified.
	Modified string `json:"Modified,omitempty"`
	// Gets ID of the annotation.
	Id string `json:"Id,omitempty"`
	// Gets Flags of the annotation.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Gets Name of the annotation.
	Name string `json:"Name,omitempty"`
	// Gets Rect of the annotation.
	Rect *Rectangle `json:"Rect"`
	// Gets PageIndex of the annotation.
	PageIndex int32 `json:"PageIndex,omitempty"`
	// Gets ZIndex of the annotation.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Gets HorizontalAlignment of the annotation.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the annotation.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// The date and time when the annotation was created.
	CreationDate string `json:"CreationDate,omitempty"`
	// Get the annotation subject.
	Subject string `json:"Subject,omitempty"`
	// Get the annotation title.
	Title string `json:"Title,omitempty"`
	// Get the annotation RichText.
	RichText string `json:"RichText,omitempty"`
	// Get the annotation InteriorColor.
	InteriorColor *Color `json:"InteriorColor,omitempty"`
	// Get or set the annotation Rectangle of frame.
	Frame *Rectangle `json:"Frame,omitempty"`
}

Provides CircleAnnotation.

type CircleAnnotationResponse

type CircleAnnotationResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Circle annotation object
	Annotation *CircleAnnotation `json:"Annotation,omitempty"`
}

Represents response containing single circle annotation object

type CircleAnnotations

type CircleAnnotations struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of circle annotations.
	List []CircleAnnotation `json:"List,omitempty"`
}

Object representing a list of circle annotations.

type CircleAnnotationsResponse

type CircleAnnotationsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Circle annotations object
	Annotations *CircleAnnotations `json:"Annotations,omitempty"`
}

Represents response containing multiple circle annotation objects

type Color

type Color struct {
	// Alpha component.
	A int32 `json:"A"`
	// Red component.
	R int32 `json:"R"`
	// Green component.
	G int32 `json:"G"`
	// Blue component.
	B int32 `json:"B"`
}

Represents color DTO.

type ColorDepth

type ColorDepth string

ColorDepth : Used to specify the parameter value passed to a Tiff image device.

const (
	ColorDepthDefault    ColorDepth = "Default"
	ColorDepthFormat8bpp ColorDepth = "Format8bpp"
	ColorDepthFormat4bpp ColorDepth = "Format4bpp"
	ColorDepthFormat1bpp ColorDepth = "Format1bpp"
)

List of ColorDepth

type ColumnAdjustment

type ColumnAdjustment string

ColumnAdjustment : Enumerates column adjustment types.

const (
	ColumnAdjustmentCustomized       ColumnAdjustment = "Customized"
	ColumnAdjustmentAutoFitToContent ColumnAdjustment = "AutoFitToContent"
	ColumnAdjustmentAutoFitToWindow  ColumnAdjustment = "AutoFitToWindow"
)

List of ColumnAdjustment

type ComboBoxField

type ComboBoxField struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Field name.
	PartialName string `json:"PartialName,omitempty"`
	// Full Field name.
	FullName string `json:"FullName,omitempty"`
	// Field rectangle.
	Rect *Rectangle `json:"Rect,omitempty"`
	// Field value.
	Value string `json:"Value,omitempty"`
	// Page index.
	PageIndex int32 `json:"PageIndex"`
	// Gets or sets height of the field.
	Height float64 `json:"Height,omitempty"`
	// Gets or sets width of the field.
	Width float64 `json:"Width,omitempty"`
	// Z index.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Is group.
	IsGroup bool `json:"IsGroup,omitempty"`
	// Gets field parent.
	Parent *FormField `json:"Parent,omitempty"`
	// Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page.
	IsSharedField bool `json:"IsSharedField,omitempty"`
	// Gets Flags of the field.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the field content.
	Contents string `json:"Contents,omitempty"`
	// Gets or sets a outer margin for paragraph (for pdf generation)
	Margin *MarginInfo `json:"Margin,omitempty"`
	// Field highlighting mode.
	Highlighting LinkHighlightingMode `json:"Highlighting,omitempty"`
	// Gets HorizontalAlignment of the field.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the field.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// Gets or sets annotation border characteristics.
	Border *Border `json:"Border,omitempty"`
	// Gets or sets multiselection flag.
	MultiSelect bool `json:"MultiSelect,omitempty"`
	// Gets or sets index of selected item. Numbering of items is started from 1.
	Selected int32 `json:"Selected,omitempty"`
	// Gets collection of options of the combobox.
	Options []Option `json:"Options,omitempty"`
	// Gets or sets current annotation appearance state.
	ActiveState string `json:"ActiveState,omitempty"`
	// Gets or sets editable status of the field.
	Editable bool `json:"Editable,omitempty"`
	// Gets or sets spellchaeck activiity status.
	SpellCheck bool `json:"SpellCheck,omitempty"`
}

Provides ComboBoxField.

type ComboBoxFieldResponse

type ComboBoxFieldResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Combobox field object
	Field *ComboBoxField `json:"Field,omitempty"`
}

Represents response containing single combobox field object

type ComboBoxFields

type ComboBoxFields struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of combobox fields.
	List []ComboBoxField `json:"List,omitempty"`
}

Object representing a list of combobox fields.

type ComboBoxFieldsResponse

type ComboBoxFieldsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Combobox fields object
	Fields *ComboBoxFields `json:"Fields,omitempty"`
}

Represents response containing multiple combobox field objects

type CommonFigureAnnotation

type CommonFigureAnnotation struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the annotation content.
	Contents string `json:"Contents,omitempty"`
	// The date and time when the annotation was last modified.
	Modified string `json:"Modified,omitempty"`
	// Gets ID of the annotation.
	Id string `json:"Id,omitempty"`
	// Gets Flags of the annotation.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Gets Name of the annotation.
	Name string `json:"Name,omitempty"`
	// Gets Rect of the annotation.
	Rect *Rectangle `json:"Rect"`
	// Gets PageIndex of the annotation.
	PageIndex int32 `json:"PageIndex,omitempty"`
	// Gets ZIndex of the annotation.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Gets HorizontalAlignment of the annotation.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the annotation.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// The date and time when the annotation was created.
	CreationDate string `json:"CreationDate,omitempty"`
	// Get the annotation subject.
	Subject string `json:"Subject,omitempty"`
	// Get the annotation title.
	Title string `json:"Title,omitempty"`
	// Get the annotation RichText.
	RichText string `json:"RichText,omitempty"`
	// Get the annotation InteriorColor.
	InteriorColor *Color `json:"InteriorColor,omitempty"`
	// Get or set the annotation Rectangle of frame.
	Frame *Rectangle `json:"Frame,omitempty"`
}

Provides CommonFigureAnnotation.

type CompressionType

type CompressionType string

CompressionType : Used to specify the parameter value passed to a Tiff image device.

const (
	CompressionTypeLZW    CompressionType = "LZW"
	CompressionTypeCCITT4 CompressionType = "CCITT4"
	CompressionTypeCCITT3 CompressionType = "CCITT3"
	CompressionTypeRLE    CompressionType = "RLE"
	CompressionTypeNone   CompressionType = "None"
)

List of CompressionType

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
	AppKey        string
	AppSid        string
	AccessToken   string
}

func NewConfiguration

func NewConfiguration(appSid string, appKey string, basePath string) *Configuration

func (*Configuration) AddDefaultHeader

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

type CryptoAlgorithm

type CryptoAlgorithm string

CryptoAlgorithm : Represent type of cryptographic algorithm that used in encryption/decryption routines.

const (
	CryptoAlgorithmRC4x40  CryptoAlgorithm = "RC4x40"
	CryptoAlgorithmRC4x128 CryptoAlgorithm = "RC4x128"
	CryptoAlgorithmAESx128 CryptoAlgorithm = "AESx128"
	CryptoAlgorithmAESx256 CryptoAlgorithm = "AESx256"
)

List of CryptoAlgorithm

type Dash

type Dash struct {
	// Gets or sets length of dash.
	On int32 `json:"On"`
	// Gets or sets length of gap between dashes.
	Off int32 `json:"Off"`
}

Class representing line dash pattern.

type DefaultPageConfig

type DefaultPageConfig struct {
	// Sets default page Height
	Height float64 `json:"Height,omitempty"`
	// Sets default page Width
	Width float64 `json:"Width,omitempty"`
}

Provides link to DefaultPageConfig.

type Direction

type Direction string

Direction : Text direction.

const (
	DirectionL2R Direction = "L2R"
	DirectionR2L Direction = "R2L"
)

List of Direction

type DiscUsage

type DiscUsage struct {
	// Application used disc space.
	UsedSize int64 `json:"UsedSize"`
	// Total disc space.
	TotalSize int64 `json:"TotalSize"`
}

Class for disc space information.

type DisplayProperties

type DisplayProperties struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Gets or sets flag specifying whether position of the document's window will be centerd on the screen.
	CenterWindow bool `json:"CenterWindow,omitempty"`
	// Gets or sets reading order of text: L2R (left to right) or R2L (right to left).
	Direction Direction `json:"Direction,omitempty"`
	// Gets or sets flag specifying whether document's window title bar should display document title.
	DisplayDocTitle bool `json:"DisplayDocTitle,omitempty"`
	// Gets or sets flag specifying whether menu bar should be hidden when document is active.
	HideMenuBar bool `json:"HideMenuBar,omitempty"`
	// Gets or sets flag specifying whether toolbar should be hidden when document is active.
	HideToolBar bool `json:"HideToolBar,omitempty"`
	// Gets or sets flag specifying whether user interface elements should be hidden when document is active.
	HideWindowUI bool `json:"HideWindowUI,omitempty"`
	// Gets or sets page mode, specifying how to display the document on exiting full-screen mode.
	NonFullScreenPageMode PageMode `json:"NonFullScreenPageMode,omitempty"`
	// Gets or sets page layout which shall be used when the document is opened.
	PageLayout PageLayout `json:"PageLayout,omitempty"`
	// Gets or sets page mode, specifying how document should be displayed when opened.
	PageMode PageMode `json:"PageMode,omitempty"`
}

Provides link to DisplayProperties.

type DisplayPropertiesResponse

type DisplayPropertiesResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// DisplayProperties object
	DisplayProperties *DisplayProperties `json:"DisplayProperties,omitempty"`
}

Represents response containing DisplayProperties

type DocFormat

type DocFormat string

DocFormat : Allows to specify .doc or .docx file format.

const (
	DocFormatDoc  DocFormat = "Doc"
	DocFormatDocX DocFormat = "DocX"
)

List of DocFormat

type DocMdpAccessPermissionType

type DocMdpAccessPermissionType string

DocMdpAccessPermissionType : The access permissions granted for this document. Valid values are: 1 - No changes to the document are permitted; any change to the document invalidates the signature. 2 - Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature. 3 - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature.

const (
	DocMdpAccessPermissionTypeNoChanges              DocMdpAccessPermissionType = "NoChanges"
	DocMdpAccessPermissionTypeFillingInForms         DocMdpAccessPermissionType = "FillingInForms"
	DocMdpAccessPermissionTypeAnnotationModification DocMdpAccessPermissionType = "AnnotationModification"
)

List of DocMDPAccessPermissionType

type DocRecognitionMode

type DocRecognitionMode string

DocRecognitionMode : Allows to control how a PDF document is converted into a word processing document.

const (
	DocRecognitionModeTextbox DocRecognitionMode = "Textbox"
	DocRecognitionModeFlow    DocRecognitionMode = "Flow"
)

List of DocRecognitionMode

type Document

type Document struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Document properties.
	DocumentProperties *DocumentProperties `json:"DocumentProperties,omitempty"`
	// Document display properties.
	DisplayProperties *DisplayProperties `json:"DisplayProperties,omitempty"`
	// Document pages.
	Pages *Pages `json:"Pages,omitempty"`
}

Represents document DTO.

type DocumentConfig

type DocumentConfig struct {
	// Sets DisplayProperties of document
	DisplayProperties *DisplayProperties `json:"DisplayProperties,omitempty"`
	// Sets DocumentProperties of document
	DocumentProperties *DocumentProperties `json:"DocumentProperties,omitempty"`
	// Sets count of pages for new document. From 1 to 100
	PagesCount int32 `json:"PagesCount"`
	// Sets default page config for new document
	DefaultPageConfig *DefaultPageConfig `json:"DefaultPageConfig,omitempty"`
}

Provides link to DocumentConfig.

type DocumentPageResponse

type DocumentPageResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Page object
	Page *Page `json:"Page,omitempty"`
}

Represents response containing single page info

type DocumentPagesResponse

type DocumentPagesResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Page object
	Pages *Pages `json:"Pages,omitempty"`
}

Represents response containing multiple pages info

type DocumentPrivilege

type DocumentPrivilege struct {
	// Sets the permission which allow print or not.  true is allow and false or not set is forbidden.
	AllowPrint bool `json:"AllowPrint,omitempty"`
	// Sets the permission which allow degraded printing or not.  true is allow and false or not set is forbidden.
	AllowDegradedPrinting bool `json:"AllowDegradedPrinting,omitempty"`
	// Sets the permission which allow modify contents or not.  true is allow and false or not set is forbidden.
	AllowModifyContents bool `json:"AllowModifyContents,omitempty"`
	// Sets the permission which allow copy or not.  true is allow and false or not set is forbidden.
	AllowCopy bool `json:"AllowCopy,omitempty"`
	// Sets the permission which allow modify annotations or not.  true is allow and false or not set is forbidden.
	AllowModifyAnnotations bool `json:"AllowModifyAnnotations,omitempty"`
	// Sets the permission which allow fill in forms or not.  true is allow and false or not set is forbidden.
	AllowFillIn bool `json:"AllowFillIn,omitempty"`
	// Sets the permission which allow screen readers or not.  true is allow and false or not set is forbidden.
	AllowScreenReaders bool `json:"AllowScreenReaders,omitempty"`
	// Sets the permission which allow assembly or not.  true is allow and false or not set is forbidden.
	AllowAssembly bool `json:"AllowAssembly,omitempty"`
	// Sets the print level of  document's privilege. Just as the Adobe Professional's Printing Allowed settings. 0: None. 1: Low Resolution (150 dpi). 2: High Resolution.
	PrintAllowLevel int32 `json:"PrintAllowLevel,omitempty"`
	// Sets the change level of  document's privilege. Just as the Adobe Professional's Changes Allowed settings. 0: None. 1: Inserting, Deleting and Rotating pages. 2: Filling in form fields and signing existing signature fields. 3: Commenting, filling in form fields, and signing existing signature fields. 4: Any except extracting pages.
	ChangeAllowLevel int32 `json:"ChangeAllowLevel,omitempty"`
	// Sets the copy level of  document's privilege. Just as the Adobe Professional's permission settings. 0: None. 1: Enable text access for screen reader devices for the visually impaired. 2: Enable copying of text, images and other content.
	CopyAllowLevel int32 `json:"CopyAllowLevel,omitempty"`
}

Represents the privileges for accessing Pdf file.

type DocumentProperties

type DocumentProperties struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of PDF document properties.
	List []DocumentProperty `json:"List,omitempty"`
}

Represents list of PDF document properties.

type DocumentPropertiesResponse

type DocumentPropertiesResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// DocumentProperties object
	DocumentProperties *DocumentProperties `json:"DocumentProperties,omitempty"`
}

Represents response containing multiple document properties info

type DocumentProperty

type DocumentProperty struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Name of the property.
	Name string `json:"Name,omitempty"`
	// Property value.
	Value string `json:"Value,omitempty"`
	// Value indicating whether it is a built-in property.
	BuiltIn bool `json:"BuiltIn"`
}

Pdf document property.

type DocumentPropertyResponse

type DocumentPropertyResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// DocumentProperty object
	DocumentProperty *DocumentProperty `json:"DocumentProperty,omitempty"`
}

Represents response containing single document property info

type DocumentResponse

type DocumentResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Document object
	Document *Document `json:"Document,omitempty"`
	// A list of messages obtained while producing the responce
	Messages []string `json:"Messages,omitempty"`
}

Represents response containing document info

type EpubRecognitionMode

type EpubRecognitionMode string

EpubRecognitionMode : When PDF file (that usually has fixed layout) is being converted, the conversion engine tries to perform grouping and multi-level analysis to restore the original document author's intent and produce result in flow layout. This property tunes that conversion for this or that desirable method of recognition of content.

const (
	EpubRecognitionModeFlow    EpubRecognitionMode = "Flow"
	EpubRecognitionModePdfFlow EpubRecognitionMode = "PdfFlow"
	EpubRecognitionModeFixed   EpubRecognitionMode = "Fixed"
)

List of EpubRecognitionMode

type ErrorDetails

type ErrorDetails struct {
	// The request id
	RequestId string `json:"RequestId,omitempty"`
	// Date
	Date time.Time `json:"Date"`
}

The error details

type Field

type Field struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Field name.
	Name string `json:"Name,omitempty"`
	// Selected items.
	SelectedItems []int32 `json:"SelectedItems,omitempty"`
	// Field type.
	Type_ FieldType `json:"Type,omitempty"`
	// Field rectangle.
	Rect *Rectangle `json:"Rect,omitempty"`
	// Field values.
	Values []string `json:"Values"`
}

Represents form field.

type FieldResponse

type FieldResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Field object
	Field *Field `json:"Field,omitempty"`
}

Represents response containing single field info

type FieldType

type FieldType string

FieldType : Represents an enumeration of available field types.

const (
	FieldTypeText    FieldType = "Text"
	FieldTypeInteger FieldType = "Integer"
	FieldTypeBoolean FieldType = "Boolean"
	FieldTypeList    FieldType = "List"
)

List of FieldType

type Fields

type Fields struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of form fields.
	List []Field `json:"List"`
}

Represents list of form fields.

type FieldsResponse

type FieldsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Fields object
	Fields *Fields `json:"Fields,omitempty"`
}

Represents response containing multiple fields info

type FileAttachmentAnnotation

type FileAttachmentAnnotation struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the annotation content.
	Contents string `json:"Contents,omitempty"`
	// The date and time when the annotation was last modified.
	Modified string `json:"Modified,omitempty"`
	// Gets ID of the annotation.
	Id string `json:"Id,omitempty"`
	// Gets Flags of the annotation.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Gets Name of the annotation.
	Name string `json:"Name,omitempty"`
	// Gets Rect of the annotation.
	Rect *Rectangle `json:"Rect"`
	// Gets PageIndex of the annotation.
	PageIndex int32 `json:"PageIndex,omitempty"`
	// Gets ZIndex of the annotation.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Gets HorizontalAlignment of the annotation.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the annotation.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// The date and time when the annotation was created.
	CreationDate string `json:"CreationDate,omitempty"`
	// Get the annotation subject.
	Subject string `json:"Subject,omitempty"`
	// Get the annotation title.
	Title string `json:"Title,omitempty"`
	// Get the annotation RichText.
	RichText string `json:"RichText,omitempty"`
	// Gets or sets icon that shall be used in displaying annotation.
	Icon FileIcon `json:"Icon,omitempty"`
	// Gets or sets icon's opacity from 0 to 1: 0 - completely transparant, 1 - completely opaque.
	Opacity float64 `json:"Opacity,omitempty"`
	// Gets or sets text associated with the file specification.
	FileDescription string `json:"FileDescription,omitempty"`
	// Gets or sets file specification name.
	FileName string `json:"FileName,omitempty"`
	// Sets content file path.
	FilePath string `json:"FilePath,omitempty"`
}

Provides FileAttachmentAnnotation.

type FileAttachmentAnnotationResponse

type FileAttachmentAnnotationResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// FileAttachment annotation object
	Annotation *FileAttachmentAnnotation `json:"Annotation,omitempty"`
}

Represents response containing single FileAttachment annotation object

type FileAttachmentAnnotations

type FileAttachmentAnnotations struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of FileAttachment annotations.
	List []FileAttachmentAnnotation `json:"List,omitempty"`
}

Object representing a list of FileAttachment annotations.

type FileAttachmentAnnotationsResponse

type FileAttachmentAnnotationsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Free text annotations object
	Annotations *FileAttachmentAnnotations `json:"Annotations,omitempty"`
}

Represents response containing multiple FileAttachment annotation objects

type FileIcon

type FileIcon string

FileIcon : An icon to be used in displaying the annotation.

const (
	FileIconPushPin   FileIcon = "PushPin"
	FileIconGraph     FileIcon = "Graph"
	FileIconPaperclip FileIcon = "Paperclip"
	FileIconTag       FileIcon = "Tag"
)

List of FileIcon

type FileVersion

type FileVersion struct {
	// File or folder name.
	Name string `json:"Name,omitempty"`
	// True if it is a folder.
	IsFolder bool `json:"IsFolder"`
	// File or folder last modified DateTime.
	ModifiedDate time.Time `json:"ModifiedDate,omitempty"`
	// File or folder size.
	Size int64 `json:"Size"`
	// File or folder path.
	Path string `json:"Path,omitempty"`
	// File Version ID.
	VersionId string `json:"VersionId,omitempty"`
	// Specifies whether the file is (true) or is not (false) the latest version of an file.
	IsLatest bool `json:"IsLatest"`
}

File Version

type FileVersions

type FileVersions struct {
	// File versions FileVersion.
	Value []FileVersion `json:"Value,omitempty"`
}

File versions FileVersion.

type FilesList

type FilesList struct {
	// Files and folders contained by folder StorageFile.
	Value []StorageFile `json:"Value,omitempty"`
}

Files list

type FilesList_

type FilesList_ struct {
	// Files and folders contained by folder StorageFile.
	Value []StorageFile_ `json:"Value,omitempty"`
}

type FilesUploadResult

type FilesUploadResult struct {
	// List of uploaded file names
	Uploaded []string `json:"Uploaded,omitempty"`
	// List of errors.
	Errors []ModelError `json:"Errors,omitempty"`
}

File upload result

type FontEncodingRules

type FontEncodingRules string

FontEncodingRules : This enumeration defines rules which tune encoding logic

const (
	FontEncodingRulesDefault                        FontEncodingRules = "Default"
	FontEncodingRulesDecreaseToUnicodePriorityLevel FontEncodingRules = "DecreaseToUnicodePriorityLevel"
)

List of FontEncodingRules

type FontSavingModes

type FontSavingModes string

FontSavingModes : Enumerates modes that can be used for saving of fonts referenced in saved PDF

const (
	FontSavingModesAlwaysSaveAsWOFF FontSavingModes = "AlwaysSaveAsWOFF"
	FontSavingModesAlwaysSaveAsTTF  FontSavingModes = "AlwaysSaveAsTTF"
	FontSavingModesAlwaysSaveAsEOT  FontSavingModes = "AlwaysSaveAsEOT"
	FontSavingModesSaveInAllFormats FontSavingModes = "SaveInAllFormats"
)

List of FontSavingModes

type FontStyles

type FontStyles string

FontStyles : Specifies style information applied to text.

const (
	FontStylesRegular    FontStyles = "Regular"
	FontStylesBold       FontStyles = "Bold"
	FontStylesItalic     FontStyles = "Italic"
	FontStylesBoldItalic FontStyles = "BoldItalic"
)

List of FontStyles

type FormField

type FormField struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Field name.
	PartialName string `json:"PartialName,omitempty"`
	// Full Field name.
	FullName string `json:"FullName,omitempty"`
	// Field rectangle.
	Rect *Rectangle `json:"Rect,omitempty"`
	// Field value.
	Value string `json:"Value,omitempty"`
	// Page index.
	PageIndex int32 `json:"PageIndex"`
	// Gets or sets height of the field.
	Height float64 `json:"Height,omitempty"`
	// Gets or sets width of the field.
	Width float64 `json:"Width,omitempty"`
	// Z index.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Is group.
	IsGroup bool `json:"IsGroup,omitempty"`
	// Gets field parent.
	Parent *FormField `json:"Parent,omitempty"`
	// Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page.
	IsSharedField bool `json:"IsSharedField,omitempty"`
	// Gets Flags of the field.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the field content.
	Contents string `json:"Contents,omitempty"`
	// Gets or sets a outer margin for paragraph (for pdf generation)
	Margin *MarginInfo `json:"Margin,omitempty"`
	// Field highlighting mode.
	Highlighting LinkHighlightingMode `json:"Highlighting,omitempty"`
	// Gets HorizontalAlignment of the field.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the field.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// Gets or sets annotation border characteristics.
	Border *Border `json:"Border,omitempty"`
}

Provides form field.

type FreeTextAnnotation

type FreeTextAnnotation struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the annotation content.
	Contents string `json:"Contents,omitempty"`
	// The date and time when the annotation was last modified.
	Modified string `json:"Modified,omitempty"`
	// Gets ID of the annotation.
	Id string `json:"Id,omitempty"`
	// Gets Flags of the annotation.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Gets Name of the annotation.
	Name string `json:"Name,omitempty"`
	// Gets Rect of the annotation.
	Rect *Rectangle `json:"Rect"`
	// Gets PageIndex of the annotation.
	PageIndex int32 `json:"PageIndex,omitempty"`
	// Gets ZIndex of the annotation.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Gets HorizontalAlignment of the annotation.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the annotation.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// The date and time when the annotation was created.
	CreationDate string `json:"CreationDate,omitempty"`
	// Get the annotation subject.
	Subject string `json:"Subject,omitempty"`
	// Get the annotation title.
	Title string `json:"Title,omitempty"`
	// Get the annotation RichText.
	RichText string `json:"RichText,omitempty"`
	// Gets Justification of the annotation.
	Justification Justification `json:"Justification,omitempty"`
	// Gets or sets the intent of the free text annotation.
	Intent FreeTextIntent `json:"Intent,omitempty"`
	// Angle of annotation rotation.
	Rotate Rotation `json:"Rotate,omitempty"`
	// Text style of the annotation.
	TextStyle *TextStyle `json:"TextStyle"`
}

Provides FreeTextAnnotation.

type FreeTextAnnotationResponse

type FreeTextAnnotationResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Free text annotation object
	Annotation *FreeTextAnnotation `json:"Annotation,omitempty"`
}

Represents response containing single free text annotation object

type FreeTextAnnotations

type FreeTextAnnotations struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of free text annotations.
	List []FreeTextAnnotation `json:"List,omitempty"`
}

Object representing a list of free text annotations.

type FreeTextAnnotationsResponse

type FreeTextAnnotationsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Free text annotations object
	Annotations *FreeTextAnnotations `json:"Annotations,omitempty"`
}

Represents response containing multiple free text annotation objects

type FreeTextIntent

type FreeTextIntent string

FreeTextIntent : Enumerates the intents of the free text annotation.

const (
	FreeTextIntentUndefined          FreeTextIntent = "Undefined"
	FreeTextIntentFreeTextCallout    FreeTextIntent = "FreeTextCallout"
	FreeTextIntentFreeTextTypeWriter FreeTextIntent = "FreeTextTypeWriter"
)

List of FreeTextIntent

type GraphInfo

type GraphInfo struct {
	// Gets or sets a float value that indicates the line width of the graph.
	LineWidth float64 `json:"LineWidth,omitempty"`
	// Gets or sets a Color object that indicates the color of the graph.
	Color *Color `json:"Color,omitempty"`
	// Gets or sets a dash array.
	DashArray []int32 `json:"DashArray,omitempty"`
	// Gets or sets a dash phase.
	DashPhase int32 `json:"DashPhase,omitempty"`
	// Gets or sets a Color object that indicates the fill color of the graph.
	FillColor *Color `json:"FillColor,omitempty"`
	// Gets or sets is border doubled.
	IsDoubled bool `json:"IsDoubled,omitempty"`
	// Gets or sets a float value that indicates the skew angle of the x-coordinate when transforming a coordinate system.
	SkewAngleX float64 `json:"SkewAngleX,omitempty"`
	// Gets or sets a float value that indicates the skew angle of the y-coordinate when transforming a coordinate system.
	SkewAngleY float64 `json:"SkewAngleY,omitempty"`
	// Gets or sets a float value that indicates the scaling rate of the x-coordinate when transforming a coordinate system.
	ScalingRateX float64 `json:"ScalingRateX,omitempty"`
	// Gets or sets a float value that indicates the scaling rate of the y-coordinate when transforming a coordinate system.
	ScalingRateY float64 `json:"ScalingRateY,omitempty"`
	// Gets or sets a float value that indicates the rotation angle of the coordinate system  when transforming a coordinate system.
	RotationAngle float64 `json:"RotationAngle,omitempty"`
}

Represents graphics info.

type HighlightAnnotation

type HighlightAnnotation struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the annotation content.
	Contents string `json:"Contents,omitempty"`
	// The date and time when the annotation was last modified.
	Modified string `json:"Modified,omitempty"`
	// Gets ID of the annotation.
	Id string `json:"Id,omitempty"`
	// Gets Flags of the annotation.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Gets Name of the annotation.
	Name string `json:"Name,omitempty"`
	// Gets Rect of the annotation.
	Rect *Rectangle `json:"Rect"`
	// Gets PageIndex of the annotation.
	PageIndex int32 `json:"PageIndex,omitempty"`
	// Gets ZIndex of the annotation.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Gets HorizontalAlignment of the annotation.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the annotation.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// The date and time when the annotation was created.
	CreationDate string `json:"CreationDate,omitempty"`
	// Get the annotation subject.
	Subject string `json:"Subject,omitempty"`
	// Get the annotation title.
	Title string `json:"Title,omitempty"`
	// Get the annotation RichText.
	RichText string `json:"RichText,omitempty"`
	// Gets or sets an array of points specifying the coordinates of n quadrilaterals.   Each quadrilateral encompasses a word or group of contiguous words in the text   underlying the annotation.
	QuadPoints []Point `json:"QuadPoints,omitempty"`
}

Provides HighlightAnnotation.

type HighlightAnnotationResponse

type HighlightAnnotationResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Highlight annotation object
	Annotation *HighlightAnnotation `json:"Annotation,omitempty"`
}

Represents response containing single highlight annotation object

type HighlightAnnotations

type HighlightAnnotations struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of highlight annotations.
	List []HighlightAnnotation `json:"List,omitempty"`
}

Object representing a list of highlight annotations.

type HighlightAnnotationsResponse

type HighlightAnnotationsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Highlight annotations object
	Annotations *HighlightAnnotations `json:"Annotations,omitempty"`
}

Represents response containing multiple highlight annotation objects

type HorizontalAlignment

type HorizontalAlignment string

HorizontalAlignment : Describes horizontal alignment.

const (
	HorizontalAlignmentNone   HorizontalAlignment = "None"
	HorizontalAlignmentLeft   HorizontalAlignment = "Left"
	HorizontalAlignmentCenter HorizontalAlignment = "Center"
	HorizontalAlignmentRight  HorizontalAlignment = "Right"
)

List of HorizontalAlignment

type HtmlDocumentType

type HtmlDocumentType string

HtmlDocumentType : Represents enumeration of the Html document types.

const (
	HtmlDocumentTypeXhtml HtmlDocumentType = "Xhtml"
	HtmlDocumentTypeHtml5 HtmlDocumentType = "Html5"
)

List of HtmlDocumentType

type HtmlMarkupGenerationModes

type HtmlMarkupGenerationModes string

HtmlMarkupGenerationModes : Sometimes specific reqirments to created HTML are present. This enum defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.

const (
	HtmlMarkupGenerationModesWriteAllHtml         HtmlMarkupGenerationModes = "WriteAllHtml"
	HtmlMarkupGenerationModesWriteOnlyBodyContent HtmlMarkupGenerationModes = "WriteOnlyBodyContent"
)

List of HtmlMarkupGenerationModes

type Image

type Image struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Gets width of the image.
	Width int32 `json:"Width"`
	// Gets height of the image.
	Height int32 `json:"Height"`
	// Gets ID of the image.
	Id string `json:"Id,omitempty"`
	// Gets rectangle of the image.
	Rectangle *Rectangle `json:"Rectangle,omitempty"`
	// Gets page number.
	PageNumber int32 `json:"PageNumber"`
}

Represents image DTO.

type ImageCompressionVersion

type ImageCompressionVersion string

ImageCompressionVersion : Describes versions of image compression algorithm.

const (
	ImageCompressionVersionStandard ImageCompressionVersion = "Standard"
	ImageCompressionVersionFast     ImageCompressionVersion = "Fast"
	ImageCompressionVersionMixed    ImageCompressionVersion = "Mixed"
)

List of ImageCompressionVersion

type ImageEncoding

type ImageEncoding string

ImageEncoding : Image encoding type.

const (
	ImageEncodingUnchanged ImageEncoding = "Unchanged"
	ImageEncodingJpeg      ImageEncoding = "Jpeg"
	ImageEncodingFlate     ImageEncoding = "Flate"
	ImageEncodingJpeg2000  ImageEncoding = "Jpeg2000"
)

List of ImageEncoding

type ImageFooter

type ImageFooter struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top.
	Background bool `json:"Background,omitempty"`
	// Gets or sets Horizontal alignment of stamp on the page.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0.
	Opacity float64 `json:"Opacity,omitempty"`
	// Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property.  If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
	Rotate Rotation `json:"Rotate,omitempty"`
	// Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle.
	RotateAngle float64 `json:"RotateAngle,omitempty"`
	// Horizontal stamp coordinate, starting from the left.
	XIndent float64 `json:"XIndent,omitempty"`
	// Vertical stamp coordinate, starting from the bottom.
	YIndent float64 `json:"YIndent,omitempty"`
	// Zooming factor of the stamp. Allows to scale stamp.
	Zoom float64 `json:"Zoom,omitempty"`
	// Gets or sets the file name.
	FileName string `json:"FileName,omitempty"`
	// Gets or sets image width. Setting this property allos to scal image horizontally.
	Width float64 `json:"Width,omitempty"`
	// Gets or sets image height. Setting this image allows to scale image vertically.
	Height float64 `json:"Height,omitempty"`
	// Gets or sets bottom margin of stamp.
	BottomMargin float64 `json:"BottomMargin,omitempty"`
	// Gets or sets left margin of stamp.
	LeftMargin float64 `json:"LeftMargin,omitempty"`
	// Gets or sets right margin of stamp.
	RightMargin float64 `json:"RightMargin,omitempty"`
}

Represents Pdf image footer.

type ImageFragment

type ImageFragment struct {
	// Gets or sets full storage path of image.
	ImageFile string `json:"ImageFile"`
	// Gets or sets fix width of the image.
	FixWidth float64 `json:"FixWidth,omitempty"`
	// Gets or sets fix height of the image.
	FixHeight float64 `json:"FixHeight,omitempty"`
	// Gets or sets horizontal alignment of the image.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets or sets vertical alignment of the image.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// Gets or sets ImageScale of the image.
	ImageScale float64 `json:"ImageScale,omitempty"`
	// Gets or sets Margin of the image.
	Margin *MarginInfo `json:"Margin,omitempty"`
}

Represents Image Fragment DTO.

type ImageHeader

type ImageHeader struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top.
	Background bool `json:"Background,omitempty"`
	// Gets or sets Horizontal alignment of stamp on the page.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0.
	Opacity float64 `json:"Opacity,omitempty"`
	// Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property.  If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
	Rotate Rotation `json:"Rotate,omitempty"`
	// Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle.
	RotateAngle float64 `json:"RotateAngle,omitempty"`
	// Horizontal stamp coordinate, starting from the left.
	XIndent float64 `json:"XIndent,omitempty"`
	// Vertical stamp coordinate, starting from the bottom.
	YIndent float64 `json:"YIndent,omitempty"`
	// Zooming factor of the stamp. Allows to scale stamp.
	Zoom float64 `json:"Zoom,omitempty"`
	// Gets or sets the file name.
	FileName string `json:"FileName,omitempty"`
	// Gets or sets image width. Setting this property allos to scal image horizontally.
	Width float64 `json:"Width,omitempty"`
	// Gets or sets image height. Setting this image allows to scale image vertically.
	Height float64 `json:"Height,omitempty"`
	// Gets or sets left margin of stamp.
	LeftMargin float64 `json:"LeftMargin,omitempty"`
	// Gets or sets top margin of stamp.
	TopMargin float64 `json:"TopMargin,omitempty"`
	// Gets or sets right margin of stamp.
	RightMargin float64 `json:"RightMargin,omitempty"`
}

Represents Pdf image header.

type ImageResponse

type ImageResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Image object
	Image *Image `json:"Image,omitempty"`
}

Represents response containing single image info

type ImageSrcType

type ImageSrcType string

ImageSrcType : Allows to specify image file format.

const (
	ImageSrcTypeCommon ImageSrcType = "Common"
	ImageSrcTypeEmf    ImageSrcType = "Emf"
)

List of ImageSrcType

type ImageStamp

type ImageStamp struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top.
	Background bool `json:"Background,omitempty"`
	// Gets or sets Horizontal alignment of stamp on the page.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0.
	Opacity float64 `json:"Opacity,omitempty"`
	// Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property.  If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
	Rotate Rotation `json:"Rotate,omitempty"`
	// Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle.
	RotateAngle float64 `json:"RotateAngle,omitempty"`
	// Horizontal stamp coordinate, starting from the left.
	XIndent float64 `json:"XIndent,omitempty"`
	// Vertical stamp coordinate, starting from the bottom.
	YIndent float64 `json:"YIndent,omitempty"`
	// Zooming factor of the stamp. Allows to scale stamp.
	Zoom float64 `json:"Zoom,omitempty"`
	// Gets or sets the file name.
	FileName string `json:"FileName,omitempty"`
	// Gets or sets image width. Setting this property allos to scal image horizontally.
	Width float64 `json:"Width,omitempty"`
	// Gets or sets image height. Setting this image allows to scale image vertically.
	Height float64 `json:"Height,omitempty"`
	// Gets or sets vertical alignment of stamp on page.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// Gets or sets bottom margin of stamp.
	BottomMargin float64 `json:"BottomMargin,omitempty"`
	// Gets or sets left margin of stamp.
	LeftMargin float64 `json:"LeftMargin,omitempty"`
	// Gets or sets top margin of stamp.
	TopMargin float64 `json:"TopMargin,omitempty"`
	// Gets or sets right margin of stamp.
	RightMargin float64 `json:"RightMargin,omitempty"`
}

Represents Pdf stamps.

type ImageTemplate

type ImageTemplate struct {
	// A path for image.
	ImagePath string `json:"ImagePath"`
	// Image type.
	ImageSrcType ImageSrcType `json:"ImageSrcType"`
	LeftMargin   float64      `json:"LeftMargin,omitempty"`
	RightMargin  float64      `json:"RightMargin,omitempty"`
	TopMargin    float64      `json:"TopMargin,omitempty"`
	BottomMargin float64      `json:"BottomMargin,omitempty"`
	PageWidth    float64      `json:"PageWidth,omitempty"`
	PageHeight   float64      `json:"PageHeight,omitempty"`
	MarginInfo   *MarginInfo  `json:"MarginInfo,omitempty"`
}

Template of image.

type ImageTemplatesRequest

type ImageTemplatesRequest struct {
	// Using OCR function.
	IsOCR bool `json:"IsOCR"`
	// Language for recognition possible values: eng, ara, bel, ben, bul, ces, dan, deu, ell, fin, fra, heb, hin, ind, isl, ita, jpn, kor, nld, nor, pol, por, ron, rus, spa, swe, tha, tur, ukr, vie, chi_sim, chi_tra      or thier combination e.g. eng+rus
	OCRLangs string `json:"OCRLangs,omitempty"`
	// A List of objects describing images to be added.
	ImagesList []ImageTemplate `json:"ImagesList"`
}

Create document from images request.

type Images

type Images struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of images.
	List []Image `json:"List,omitempty"`
}

Represents list of images.

type ImagesResponse

type ImagesResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Images object
	Images *Images `json:"Images,omitempty"`
}

Represents response containing multiple images info

type InkAnnotation

type InkAnnotation struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the annotation content.
	Contents string `json:"Contents,omitempty"`
	// The date and time when the annotation was last modified.
	Modified string `json:"Modified,omitempty"`
	// Gets ID of the annotation.
	Id string `json:"Id,omitempty"`
	// Gets Flags of the annotation.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Gets Name of the annotation.
	Name string `json:"Name,omitempty"`
	// Gets Rect of the annotation.
	Rect *Rectangle `json:"Rect"`
	// Gets PageIndex of the annotation.
	PageIndex int32 `json:"PageIndex,omitempty"`
	// Gets ZIndex of the annotation.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Gets HorizontalAlignment of the annotation.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the annotation.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// The date and time when the annotation was created.
	CreationDate string `json:"CreationDate,omitempty"`
	// Get the annotation subject.
	Subject string `json:"Subject,omitempty"`
	// Get the annotation title.
	Title string `json:"Title,omitempty"`
	// Get the annotation RichText.
	RichText string `json:"RichText,omitempty"`
	// Gets or sets list of gestures that are independent lines which are represented by Point[] arrays.
	InkList [][]Point `json:"InkList,omitempty"`
	// Style of ink annotation line endings.
	CapStyle CapStyle `json:"CapStyle,omitempty"`
}

Provides InkAnnotation.

type InkAnnotationResponse

type InkAnnotationResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Ink annotation object
	Annotation *InkAnnotation `json:"Annotation,omitempty"`
}

Represents response containing single ink annotation object

type InkAnnotations

type InkAnnotations struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of ink annotations.
	List []InkAnnotation `json:"List,omitempty"`
}

Object representing a list of ink annotations.

type InkAnnotationsResponse

type InkAnnotationsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Ink annotations object
	Annotations *InkAnnotations `json:"Annotations,omitempty"`
}

Represents response containing multiple ink annotation objects

type Justification

type Justification string

Justification : Enumerates the forms of quadding (justification) to be used in displaying the annotation’s text.

const (
	JustificationLeft   Justification = "Left"
	JustificationCenter Justification = "Center"
	JustificationRight  Justification = "Right"
)

List of Justification

type LettersPositioningMethods

type LettersPositioningMethods string

LettersPositioningMethods : It enumerates possible modes of positioning of letters in words in result HTML

const (
	LettersPositioningMethodsUseEmUnitsAndCompensationOfRoundingErrorsInCss LettersPositioningMethods = "UseEmUnitsAndCompensationOfRoundingErrorsInCss"
	LettersPositioningMethodsUsePixelUnitsInCssLetterSpacingForIE           LettersPositioningMethods = "UsePixelUnitsInCssLetterSpacingForIE"
)

List of LettersPositioningMethods

type LineAnnotation

type LineAnnotation struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the annotation content.
	Contents string `json:"Contents,omitempty"`
	// The date and time when the annotation was last modified.
	Modified string `json:"Modified,omitempty"`
	// Gets ID of the annotation.
	Id string `json:"Id,omitempty"`
	// Gets Flags of the annotation.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Gets Name of the annotation.
	Name string `json:"Name,omitempty"`
	// Gets Rect of the annotation.
	Rect *Rectangle `json:"Rect"`
	// Gets PageIndex of the annotation.
	PageIndex int32 `json:"PageIndex,omitempty"`
	// Gets ZIndex of the annotation.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Gets HorizontalAlignment of the annotation.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the annotation.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// The date and time when the annotation was created.
	CreationDate string `json:"CreationDate,omitempty"`
	// Get the annotation subject.
	Subject string `json:"Subject,omitempty"`
	// Get the annotation title.
	Title string `json:"Title,omitempty"`
	// Get the annotation RichText.
	RichText string `json:"RichText,omitempty"`
	// Gets or sets starting point of line.
	Starting *Point `json:"Starting"`
	// Gets or sets line ending style for line starting point.
	StartingStyle LineEnding `json:"StartingStyle,omitempty"`
	// Gets or sets ending point of line.
	Ending *Point `json:"Ending"`
	// Gets or sets ending style for end point of line.
	EndingStyle LineEnding `json:"EndingStyle,omitempty"`
	// Gets or sets interior color of the annotation.
	InteriorColor *Color `json:"InteriorColor,omitempty"`
	// Gets or sets leader line length.
	LeaderLine float64 `json:"LeaderLine,omitempty"`
	// Gets or sets length of leader line extension.
	LeaderLineExtension float64 `json:"LeaderLineExtension,omitempty"`
	// Gets or sets leader line offset.
	LeaderLineOffset float64 `json:"LeaderLineOffset,omitempty"`
	// Gets or sets boolean flag which determinies is contents must be shown as caption.
	ShowCaption bool `json:"ShowCaption,omitempty"`
	// Gets or sets caption text offset from its normal position.
	CaptionOffset *Point `json:"CaptionOffset,omitempty"`
	// Gets or sets annotation caption position.
	CaptionPosition CaptionPosition `json:"CaptionPosition,omitempty"`
	// Gets or sets the intent of the line annotation.
	Intent LineIntent `json:"Intent,omitempty"`
}

Provides LineAnnotation.

type LineAnnotationResponse

type LineAnnotationResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Line annotation object
	Annotation *LineAnnotation `json:"Annotation,omitempty"`
}

Represents response containing single line annotation object

type LineAnnotations

type LineAnnotations struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of line annotations.
	List []LineAnnotation `json:"List,omitempty"`
}

Object representing a list of line annotations.

type LineAnnotationsResponse

type LineAnnotationsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Line annotations object
	Annotations *LineAnnotations `json:"Annotations,omitempty"`
}

Represents response containing multiple line annotation objects

type LineEnding

type LineEnding string

LineEnding : Enumerates the line ending styles to be used in drawing the line.

const (
	LineEndingNone         LineEnding = "None"
	LineEndingSquare       LineEnding = "Square"
	LineEndingCircle       LineEnding = "Circle"
	LineEndingDiamond      LineEnding = "Diamond"
	LineEndingOpenArrow    LineEnding = "OpenArrow"
	LineEndingClosedArrow  LineEnding = "ClosedArrow"
	LineEndingButt         LineEnding = "Butt"
	LineEndingROpenArrow   LineEnding = "ROpenArrow"
	LineEndingRClosedArrow LineEnding = "RClosedArrow"
	LineEndingSlash        LineEnding = "Slash"
)

List of LineEnding

type LineIntent

type LineIntent string

LineIntent : Enumerates the intents of the line annotation.

const (
	LineIntentUndefined     LineIntent = "Undefined"
	LineIntentLineArrow     LineIntent = "LineArrow"
	LineIntentLineDimension LineIntent = "LineDimension"
)

List of LineIntent

type LineSpacing

type LineSpacing string

LineSpacing : Defines line spacing specifics

const (
	LineSpacingFontSize LineSpacing = "FontSize"
	LineSpacingFullSize LineSpacing = "FullSize"
)

List of LineSpacing

type Link struct {
	// The \"href\" attribute contains the link's IRI. atom:link elements MUST have an href attribute, whose value MUST be a IRI reference
	Href string `json:"Href,omitempty"`
	// atom:link elements MAY have a \"rel\" attribute that indicates the link relation type.  If the \"rel\" attribute is not present, the link element MUST be interpreted as if the link relation type is \"alternate\".
	Rel string `json:"Rel,omitempty"`
	// On the link element, the \"type\" attribute's value is an advisory media type: it is a hint about the type of the representation that is expected to be returned when the value of the href attribute is dereferenced.  Note that the type attribute does not override the actual media type returned with the representation.
	Type_ string `json:"Type,omitempty"`
	// The \"title\" attribute conveys human-readable information about the link.  The content of the \"title\" attribute is Language-Sensitive.
	Title string `json:"Title,omitempty"`
}

Provides information for the object link. This is supposed to be an atom:link, therefore it should have all attributes specified here http://tools.ietf.org/html/rfc4287#section-4.2.7

type LinkActionType

type LinkActionType string

LinkActionType : Represents list of link action types.

const (
	LinkActionTypeGoToAction       LinkActionType = "GoToAction"
	LinkActionTypeGoToURIAction    LinkActionType = "GoToURIAction"
	LinkActionTypeJavascriptAction LinkActionType = "JavascriptAction"
	LinkActionTypeLaunchAction     LinkActionType = "LaunchAction"
	LinkActionTypeNamedAction      LinkActionType = "NamedAction"
	LinkActionTypeSubmitFormAction LinkActionType = "SubmitFormAction"
)

List of LinkActionType

type LinkAnnotation

type LinkAnnotation struct {
	// Link to the document.
	Links        []Link               `json:"Links,omitempty"`
	ActionType   LinkActionType       `json:"ActionType"`
	Action       string               `json:"Action"`
	Highlighting LinkHighlightingMode `json:"Highlighting"`
	Color        *Color               `json:"Color,omitempty"`
	Rect         *Rectangle           `json:"Rect"`
	Id           string               `json:"Id,omitempty"`
}

Provides link to linkAnnotation.

type LinkAnnotationResponse

type LinkAnnotationResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// LinkAnnotation object
	Link *LinkAnnotation `json:"Link,omitempty"`
}

Represents response containing single link info

type LinkAnnotations

type LinkAnnotations struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of link annotations.
	List []LinkAnnotation `json:"List,omitempty"`
}

Object representing a list of link annotations.

type LinkAnnotationsResponse

type LinkAnnotationsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// LinkAnnotations object
	Links *LinkAnnotations `json:"Links,omitempty"`
}

Represents response containing multiple links info

type LinkElement

type LinkElement struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
}

Represents base DTO object.

type LinkHighlightingMode

type LinkHighlightingMode string

LinkHighlightingMode : Enumerates the annotation’s highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area.

const (
	LinkHighlightingModeNone    LinkHighlightingMode = "None"
	LinkHighlightingModeInvert  LinkHighlightingMode = "Invert"
	LinkHighlightingModeOutline LinkHighlightingMode = "Outline"
	LinkHighlightingModePush    LinkHighlightingMode = "Push"
	LinkHighlightingModeToggle  LinkHighlightingMode = "Toggle"
)

List of LinkHighlightingMode

type ListBoxField

type ListBoxField struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Field name.
	PartialName string `json:"PartialName,omitempty"`
	// Full Field name.
	FullName string `json:"FullName,omitempty"`
	// Field rectangle.
	Rect *Rectangle `json:"Rect,omitempty"`
	// Field value.
	Value string `json:"Value,omitempty"`
	// Page index.
	PageIndex int32 `json:"PageIndex"`
	// Gets or sets height of the field.
	Height float64 `json:"Height,omitempty"`
	// Gets or sets width of the field.
	Width float64 `json:"Width,omitempty"`
	// Z index.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Is group.
	IsGroup bool `json:"IsGroup,omitempty"`
	// Gets field parent.
	Parent *FormField `json:"Parent,omitempty"`
	// Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page.
	IsSharedField bool `json:"IsSharedField,omitempty"`
	// Gets Flags of the field.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the field content.
	Contents string `json:"Contents,omitempty"`
	// Gets or sets a outer margin for paragraph (for pdf generation)
	Margin *MarginInfo `json:"Margin,omitempty"`
	// Field highlighting mode.
	Highlighting LinkHighlightingMode `json:"Highlighting,omitempty"`
	// Gets HorizontalAlignment of the field.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the field.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// Gets or sets annotation border characteristics.
	Border *Border `json:"Border,omitempty"`
	// Gets or sets multiselection flag.
	MultiSelect bool `json:"MultiSelect,omitempty"`
	// Gets or sets index of selected item. Numbering of items is started from 1.
	Selected int32 `json:"Selected,omitempty"`
	// Gets collection of options of the listbox.
	Options []Option `json:"Options,omitempty"`
	// Gets or sets current annotation appearance state.
	ActiveState string `json:"ActiveState,omitempty"`
	// Gets or sets index of the top visible element of the list.
	TopIndex int32 `json:"TopIndex,omitempty"`
	// Gets or sets array of the selected items in the multiselect list. For single-select list returns array with single item.
	SelectedItems []int32 `json:"SelectedItems,omitempty"`
}

Provides ListBoxField.

type ListBoxFieldResponse

type ListBoxFieldResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Listbox field object
	Field *ListBoxField `json:"Field,omitempty"`
}

Represents response containing single listbox field object

type ListBoxFields

type ListBoxFields struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of listbox fields.
	List []ListBoxField `json:"List,omitempty"`
}

Object representing a list of listbox fields.

type ListBoxFieldsResponse

type ListBoxFieldsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Listbox fields object
	Fields *ListBoxFields `json:"Fields,omitempty"`
}

Represents response containing multiple listbox field objects

type MarginInfo

type MarginInfo struct {
	// Gets or sets a float value that indicates the left margin.
	Left float64 `json:"Left,omitempty"`
	// Gets or sets a float value that indicates the right margin.
	Right float64 `json:"Right,omitempty"`
	// Gets or sets a float value that indicates the top margin.
	Top float64 `json:"Top,omitempty"`
	// Gets or sets a float value that indicates the bottom margin.
	Bottom float64 `json:"Bottom,omitempty"`
}

This class represents a margin for different objects.

type MarkupAnnotation

type MarkupAnnotation struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the annotation content.
	Contents string `json:"Contents,omitempty"`
	// The date and time when the annotation was last modified.
	Modified string `json:"Modified,omitempty"`
	// Gets ID of the annotation.
	Id string `json:"Id,omitempty"`
	// Gets Flags of the annotation.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Gets Name of the annotation.
	Name string `json:"Name,omitempty"`
	// Gets Rect of the annotation.
	Rect *Rectangle `json:"Rect"`
	// Gets PageIndex of the annotation.
	PageIndex int32 `json:"PageIndex,omitempty"`
	// Gets ZIndex of the annotation.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Gets HorizontalAlignment of the annotation.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the annotation.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// The date and time when the annotation was created.
	CreationDate string `json:"CreationDate,omitempty"`
	// Get the annotation subject.
	Subject string `json:"Subject,omitempty"`
	// Get the annotation title.
	Title string `json:"Title,omitempty"`
	// Get the annotation RichText.
	RichText string `json:"RichText,omitempty"`
}

Provides MarkupAnnotation.

type MergeDocuments

type MergeDocuments struct {
	// List of documents for merging.
	List []string `json:"List"`
}

Documents for merging.

type ModelError

type ModelError struct {
	// Code
	Code string `json:"Code,omitempty"`
	// Message
	Message string `json:"Message,omitempty"`
	// Description
	Description string `json:"Description,omitempty"`
	// Inner Error
	InnerError *ErrorDetails `json:"InnerError,omitempty"`
}

Error

type MovieAnnotation

type MovieAnnotation struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Color of the annotation.
	Color *Color `json:"Color,omitempty"`
	// Get the annotation content.
	Contents string `json:"Contents,omitempty"`
	// The date and time when the annotation was last modified.
	Modified string `json:"Modified,omitempty"`
	// Gets ID of the annotation.
	Id string `json:"Id,omitempty"`
	// Gets Flags of the annotation.
	Flags []AnnotationFlags `json:"Flags,omitempty"`
	// Gets Name of the annotation.
	Name string `json:"Name,omitempty"`
	// Gets Rect of the annotation.
	Rect *Rectangle `json:"Rect"`
	// Gets PageIndex of the annotation.
	PageIndex int32 `json:"PageIndex,omitempty"`
	// Gets ZIndex of the annotation.
	ZIndex int32 `json:"ZIndex,omitempty"`
	// Gets HorizontalAlignment of the annotation.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets VerticalAlignment of the annotation.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// Get the annotation title.
	Title string `json:"Title,omitempty"`
	// Gets or sets file specification name.
	FileName string `json:"FileName,omitempty"`
	// Sets content file path.
	FilePath string `json:"FilePath,omitempty"`
}

Provides MovieAnnotation.

type MovieAnnotationResponse

type MovieAnnotationResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Movie annotation object
	Annotation *MovieAnnotation `json:"Annotation,omitempty"`
}

Represents response containing single movie annotation object

type MovieAnnotations

type MovieAnnotations struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of movie annotations.
	List []MovieAnnotation `json:"List,omitempty"`
}

Object representing a list of movie annotations.

type MovieAnnotationsResponse

type MovieAnnotationsResponse struct {
	// Response status code.
	Code int32 `json:"Code"`
	// Response status.
	Status string `json:"Status,omitempty"`
	// Movie annotations object
	Annotations *MovieAnnotations `json:"Annotations,omitempty"`
}

Represents response containing multiple movie annotation objects

type ObjectExist

type ObjectExist struct {
	// Indicates that the file or folder exists.
	Exists bool `json:"Exists"`
	// True if it is a folder, false if it is a file.
	IsFolder bool `json:"IsFolder"`
}

Object exists

type OptimizeOptions

type OptimizeOptions struct {
	// If true page contents will be reused when document is optimized for equal pages.
	AllowReusePageContent bool `json:"AllowReusePageContent,omitempty"`
	// If this flag is set to true images will be compressed in the document. Compression level is specified with ImageQuality property.
	CompressImages bool `json:"CompressImages,omitempty"`
	// Specifies level of image compression when CompressImages flag is used.
	ImageQuality int32 `json:"ImageQuality,omitempty"`
	// If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then thees streams will be stored as one object.  This allows to decrease document size in some cases (for example, when same document was concatenated multiple times).
	LinkDuplcateStreams bool `json:"LinkDuplcateStreams,omitempty"`
	// If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document.
	RemoveUnusedObjects bool `json:"RemoveUnusedObjects,omitempty"`
	// If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document.
	RemoveUnusedStreams bool `json:"RemoveUnusedStreams,omitempty"`
	// Make fonts not embedded if set to true.
	UnembedFonts bool `json:"UnembedFonts,omitempty"`
	// If this flag set to true and CompressImages is true images will be resized if image resolution is greater then specified MaxResolution parameter.
	ResizeImages bool `json:"ResizeImages,omitempty"`
	// Specifies maximum resolution of images. If image has higher resolution it will be scaled.
	MaxResolution int32 `json:"MaxResolution,omitempty"`
	// Fonts will be converted into subsets if set to true.
	SubsetFonts bool `json:"SubsetFonts,omitempty"`
	// Remove private information (page piece info).
	RemovePrivateInfo bool `json:"RemovePrivateInfo,omitempty"`
	// Image encode which will be used.
	ImageEncoding ImageEncoding `json:"ImageEncoding,omitempty"`
	// Version of compression algorithm. Possible values are: \"Standard\" - standard compression, \"Fast\" - fast (improved compression which is faster then standard but may be applicable not for all images), \"Mixed\" - mixed (standard compression is applied to images which can not be compressed by  faster algorithm, this may give best compression but more slow then \"Fast\" algorithm. Version \"Fast\" is not applicable for resizing images (standard method will be used). Default is \"Standard\".
	ImageCompressionVersion ImageCompressionVersion `json:"ImageCompressionVersion,omitempty"`
}

Represents Pdf optimize options.

type Option

type Option struct {
	// Gets or sets option export value.
	Value string `json:"Value,omitempty"`
	// Gets or sets name of option.
	Name string `json:"Name,omitempty"`
	// Gets or sets selected status of option. Returns true if option is selected.
	Selected bool `json:"Selected,omitempty"`
	// Gets index of the option.
	Index int32 `json:"Index,omitempty"`
}

Provides form option.

type OutputFormat

type OutputFormat string

OutputFormat : Enumeration for output type format.

const (
	OutputFormatZip    OutputFormat = "Zip"
	OutputFormatFolder OutputFormat = "Folder"
)

List of OutputFormat

type Page

type Page struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Page's id.
	Id int32 `json:"Id"`
	// Page's images
	Images *Images `json:"Images,omitempty"`
	// Page's rectangle
	Rectangle *Rectangle `json:"Rectangle,omitempty"`
}

Provides link to page.

type PageLayout

type PageLayout string

PageLayout : Descibes page layout.

const (
	PageLayoutSinglePage     PageLayout = "SinglePage"
	PageLayoutOneColumn      PageLayout = "OneColumn"
	PageLayoutTwoColumnLeft  PageLayout = "TwoColumnLeft"
	PageLayoutTwoColumnRight PageLayout = "TwoColumnRight"
	PageLayoutTwoPageLeft    PageLayout = "TwoPageLeft"
	PageLayoutTwoPageRight   PageLayout = "TwoPageRight"
	PageLayoutDefault        PageLayout = "Default"
)

List of PageLayout

type PageMode

type PageMode string

PageMode : Class descibes used components of the document page.

const (
	PageModeUseNone        PageMode = "UseNone"
	PageModeUseOutlines    PageMode = "UseOutlines"
	PageModeUseThumbs      PageMode = "UseThumbs"
	PageModeFullScreen     PageMode = "FullScreen"
	PageModeUseOC          PageMode = "UseOC"
	PageModeUseAttachments PageMode = "UseAttachments"
)

List of PageMode

type PageNumberStamp

type PageNumberStamp struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top.
	Background bool `json:"Background,omitempty"`
	// Gets or sets Horizontal alignment of stamp on the page.
	HorizontalAlignment HorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0.
	Opacity float64 `json:"Opacity,omitempty"`
	// Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property.  If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
	Rotate Rotation `json:"Rotate,omitempty"`
	// Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle.
	RotateAngle float64 `json:"RotateAngle,omitempty"`
	// Horizontal stamp coordinate, starting from the left.
	XIndent float64 `json:"XIndent,omitempty"`
	// Vertical stamp coordinate, starting from the bottom.
	YIndent float64 `json:"YIndent,omitempty"`
	// Zooming factor of the stamp. Allows to scale stamp.
	Zoom float64 `json:"Zoom,omitempty"`
	// Gets or sets string value which is used as stamp on the page.
	Value string `json:"Value,omitempty"`
	// Gets or sets value of the number of starting page. Other pages will be numbered starting from this value.
	StartingNumber int32 `json:"StartingNumber,omitempty"`
	// Gets or sets vertical alignment of stamp on page.
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// Gets or sets bottom margin of stamp.
	BottomMargin float64 `json:"BottomMargin,omitempty"`
	// Gets or sets left margin of stamp.
	LeftMargin float64 `json:"LeftMargin,omitempty"`
	// Gets or sets top margin of stamp.
	TopMargin float64 `json:"TopMargin,omitempty"`
	// Gets or sets right margin of stamp.
	RightMargin float64 `json:"RightMargin,omitempty"`
}

Represents Pdf stamps.

type PageWordCount

type PageWordCount struct {
	// Page number.
	PageNumber int32 `json:"PageNumber"`
	// Number of words at the page.
	Count int32 `json:"Count"`
}

Page words count.

type Pages

type Pages struct {
	// Link to the document.
	Links []Link `json:"Links,omitempty"`
	// List of pages.
	List []Page `json:"List,omitempty"`
}

Represents list of pages.

type Paragraph

type Paragraph struct {
	// Line spacing mode.
	LineSpacing LineSpacing `json:"LineSpacing,omitempty"`
	// Word wrap mode.
	WrapMode WrapMode `json:"WrapMode,omitempty"`
	// Horizontal alignment for the text inside paragraph's rectangle.
	HorizontalAlignment TextHorizontalAlignment `json:"HorizontalAlignment,omitempty"`
	// Left margin.
	LeftMargin float64 `json:"LeftMargin,omitempty"`
	// Right margin.
	RightMargin float64 `json:"RightMargin,omitempty"`
	// Top margin.
	TopMargin float64 `json:"TopMargin,omitempty"`
	// Bottom margin.
	BottomMargin float64 `json:"BottomMargin,omitempty"`
	// Rectangle of the paragraph.
	Rectangle *Rectangle `json:"Rectangle,omitempty"`
	// Rotation angle in degrees.
	Rotation float64 `json:"Rotation,omitempty"`
	// Subsequent lines indent value.
	SubsequentLinesIndent float64 `json:"SubsequentLinesIndent,omitempty"`
	// Vertical alignment for the text inside paragraph's rectangle
	VerticalAlignment VerticalAlignment `json:"VerticalAlignment,omitempty"`
	// An array of text lines.
	Lines []TextLine `json:"Lines"`
}

Represents text paragraphs as multiline text object.

type PartsEmbeddingModes

type PartsEmbeddingModes string

PartsEmbeddingModes : This enum enumerates possible modes of embedding of files referenced in HTML It allows to control whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities

const (
	PartsEmbeddingModesEmbedAllIntoHtml PartsEmbeddingModes = "EmbedAllIntoHtml"
	PartsEmbeddingModesEmbedCssOnly     PartsEmbeddingModes = "EmbedCssOnly"
	PartsEmbeddingModesNoEmbedding      PartsEmbeddingModes = "NoEmbedding"
)

List of PartsEmbeddingModes

type PdfAType

type PdfAType string

PdfAType : Allows to specify PdfA file format.

const (
	PdfATypePDFA1A PdfAType = "PDFA1A"
	PdfATypePDFA1B PdfAType = "PDFA1B"
	PdfATypePDFA3A PdfAType = "PDFA3A"
)

List of PdfAType

type PdfApiService

type PdfApiService service

func NewPdfApiService

func NewPdfApiService(appSid string, appKey string, basePath string) *PdfApiService

Create Instance of PdfApiService @param appSid string Application SID @param appKey string Application Key @param basePath string Base service path. Set "" for default @return *PdfApiService

func (*PdfApiService) CopyFile

func (a *PdfApiService) CopyFile(srcPath string, destPath string, localVarOptionals map[string]interface{}) (*http.Response, error)

PdfApiService Copy file @param srcPath Source file path e.g. '/folder/file.ext' @param destPath Destination file path @param optional (nil or map[string]interface{}) with one or more of:

@param "srcStorageName" (string) Source storage name
@param "destStorageName" (string) Destination storage name
@param "versionId" (string) File version ID to copy

@return

func (*PdfApiService) CopyFolder

func (a *PdfApiService) CopyFolder(srcPath string, destPath string, localVarOptionals map[string]interface{}) (*http.Response, error)

PdfApiService Copy folder @param srcPath Source folder path e.g. '/src' @param destPath Destination folder path e.g. '/dst' @param optional (nil or map[string]interface{}) with one or more of:

@param "srcStorageName" (string) Source storage name
@param "destStorageName" (string) Destination storage name

@return

func (*PdfApiService) CreateFolder

func (a *PdfApiService) CreateFolder(path string, localVarOptionals map[string]interface{}) (*http.Response, error)

PdfApiService Create the folder @param path Folder path to create e.g. 'folder_1/folder_2/' @param optional (nil or map[string]interface{}) with one or more of:

@param "storageName" (string) Storage name

@return

func (*PdfApiService) DeleteAnnotation

func (a *PdfApiService) DeleteAnnotation(name string, annotationId string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete document annotation by ID @param name The document name. @param annotationId The annotation ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeleteBookmark

func (a *PdfApiService) DeleteBookmark(name string, bookmarkPath string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete document bookmark by ID. @param name The document name. @param bookmarkPath The bookmark path. @param optional (nil or map[string]interface{}) with one or more of:

@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return AsposeResponse

func (*PdfApiService) DeleteDocumentAnnotations

func (a *PdfApiService) DeleteDocumentAnnotations(name string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete all annotations from the document @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeleteDocumentBookmarks

func (a *PdfApiService) DeleteDocumentBookmarks(name string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete all document bookmarks. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return AsposeResponse

func (*PdfApiService) DeleteDocumentLinkAnnotations

func (a *PdfApiService) DeleteDocumentLinkAnnotations(name string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete all link annotations from the document @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeleteDocumentStamps

func (a *PdfApiService) DeleteDocumentStamps(name string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete all stamps from the document @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeleteDocumentTables

func (a *PdfApiService) DeleteDocumentTables(name string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete all tables from the document @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeleteField

func (a *PdfApiService) DeleteField(name string, fieldName string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete document field by name. @param name The document name. @param fieldName The field name/ @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeleteFile

func (a *PdfApiService) DeleteFile(path string, localVarOptionals map[string]interface{}) (*http.Response, error)

PdfApiService Delete file @param path File path e.g. '/folder/file.ext' @param optional (nil or map[string]interface{}) with one or more of:

@param "storageName" (string) Storage name
@param "versionId" (string) File version ID to delete

@return

func (*PdfApiService) DeleteFolder

func (a *PdfApiService) DeleteFolder(path string, localVarOptionals map[string]interface{}) (*http.Response, error)

PdfApiService Delete folder @param path Folder path e.g. '/folder' @param optional (nil or map[string]interface{}) with one or more of:

@param "storageName" (string) Storage name
@param "recursive" (bool) Enable to delete folders, subfolders and files

@return

func (*PdfApiService) DeleteImage

func (a *PdfApiService) DeleteImage(name string, imageId string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete image from document page. @param name The document name. @param imageId Image ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeleteLinkAnnotation

func (a *PdfApiService) DeleteLinkAnnotation(name string, linkId string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete document page link annotation by ID @param name The document name. @param linkId The link ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeletePage

func (a *PdfApiService) DeletePage(name string, pageNumber int32, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete document page by its number. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeletePageAnnotations

func (a *PdfApiService) DeletePageAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete all annotations from the page @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeletePageLinkAnnotations

func (a *PdfApiService) DeletePageLinkAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete all link annotations from the page @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeletePageStamps

func (a *PdfApiService) DeletePageStamps(name string, pageNumber int32, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete all stamps from the page @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeletePageTables

func (a *PdfApiService) DeletePageTables(name string, pageNumber int32, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete all tables from the page @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeleteProperties

func (a *PdfApiService) DeleteProperties(name string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete custom document properties. @param name @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string)
@param "folder" (string)

@return AsposeResponse

func (*PdfApiService) DeleteProperty

func (a *PdfApiService) DeleteProperty(name string, propertyName string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete document property. @param name @param propertyName @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string)
@param "folder" (string)

@return AsposeResponse

func (*PdfApiService) DeleteStamp

func (a *PdfApiService) DeleteStamp(name string, stampId string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete document stamp by ID @param name The document name. @param stampId The stamp ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DeleteTable

func (a *PdfApiService) DeleteTable(name string, tableId string, localVarOptionals map[string]interface{}) (AsposeResponse, *http.Response, error)

PdfApiService Delete document table by ID @param name The document name. @param tableId The table ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AsposeResponse

func (*PdfApiService) DownloadFile

func (a *PdfApiService) DownloadFile(path string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Download file @param path File path e.g. '/folder/file.ext' @param optional (nil or map[string]interface{}) with one or more of:

@param "storageName" (string) Storage name
@param "versionId" (string) File version ID to download

@return []byte

func (*PdfApiService) GetBookmark

func (a *PdfApiService) GetBookmark(name string, bookmarkPath string, localVarOptionals map[string]interface{}) (BookmarkResponse, *http.Response, error)

PdfApiService Read document bookmark. @param name The document name. @param bookmarkPath The bookmark path. @param optional (nil or map[string]interface{}) with one or more of:

@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return BookmarkResponse

func (*PdfApiService) GetBookmarks

func (a *PdfApiService) GetBookmarks(name string, bookmarkPath string, localVarOptionals map[string]interface{}) (BookmarksResponse, *http.Response, error)

PdfApiService Read document bookmarks node list. @param name The document name. @param bookmarkPath The bookmark path. @param optional (nil or map[string]interface{}) with one or more of:

@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return BookmarksResponse

func (*PdfApiService) GetCaretAnnotation

func (a *PdfApiService) GetCaretAnnotation(name string, annotationId string, localVarOptionals map[string]interface{}) (CaretAnnotationResponse, *http.Response, error)

PdfApiService Read document page caret annotation by ID. @param name The document name. @param annotationId The annotation ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return CaretAnnotationResponse

func (*PdfApiService) GetCheckBoxField

func (a *PdfApiService) GetCheckBoxField(name string, fieldName string, localVarOptionals map[string]interface{}) (CheckBoxFieldResponse, *http.Response, error)

PdfApiService Read document checkbox field by name. @param name The document name. @param fieldName The field name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return CheckBoxFieldResponse

func (*PdfApiService) GetCircleAnnotation

func (a *PdfApiService) GetCircleAnnotation(name string, annotationId string, localVarOptionals map[string]interface{}) (CircleAnnotationResponse, *http.Response, error)

PdfApiService Read document page circle annotation by ID. @param name The document name. @param annotationId The annotation ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return CircleAnnotationResponse

func (*PdfApiService) GetComboBoxField

func (a *PdfApiService) GetComboBoxField(name string, fieldName string, localVarOptionals map[string]interface{}) (ComboBoxFieldResponse, *http.Response, error)

PdfApiService Read document combobox field by name. @param name The document name. @param fieldName The field name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return ComboBoxFieldResponse

func (*PdfApiService) GetDiscUsage

func (a *PdfApiService) GetDiscUsage(localVarOptionals map[string]interface{}) (DiscUsage, *http.Response, error)

PdfApiService Get disc usage @param optional (nil or map[string]interface{}) with one or more of:

@param "storageName" (string) Storage name

@return DiscUsage

func (*PdfApiService) GetDocument

func (a *PdfApiService) GetDocument(name string, localVarOptionals map[string]interface{}) (DocumentResponse, *http.Response, error)

PdfApiService Read common document info. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return DocumentResponse

func (*PdfApiService) GetDocumentAnnotations

func (a *PdfApiService) GetDocumentAnnotations(name string, localVarOptionals map[string]interface{}) (AnnotationsInfoResponse, *http.Response, error)

PdfApiService Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AnnotationsInfoResponse

func (*PdfApiService) GetDocumentAttachmentByIndex

func (a *PdfApiService) GetDocumentAttachmentByIndex(name string, attachmentIndex int32, localVarOptionals map[string]interface{}) (AttachmentResponse, *http.Response, error)

PdfApiService Read document attachment info by its index. @param name The document name. @param attachmentIndex The attachment index. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AttachmentResponse

func (*PdfApiService) GetDocumentAttachments

func (a *PdfApiService) GetDocumentAttachments(name string, localVarOptionals map[string]interface{}) (AttachmentsResponse, *http.Response, error)

PdfApiService Read document attachments info. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AttachmentsResponse

func (*PdfApiService) GetDocumentBookmarks

func (a *PdfApiService) GetDocumentBookmarks(name string, localVarOptionals map[string]interface{}) (BookmarksResponse, *http.Response, error)

PdfApiService Read document bookmarks tree. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return BookmarksResponse

func (*PdfApiService) GetDocumentCaretAnnotations

func (a *PdfApiService) GetDocumentCaretAnnotations(name string, localVarOptionals map[string]interface{}) (CaretAnnotationsResponse, *http.Response, error)

PdfApiService Read document caret annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return CaretAnnotationsResponse

func (*PdfApiService) GetDocumentCheckBoxFields

func (a *PdfApiService) GetDocumentCheckBoxFields(name string, localVarOptionals map[string]interface{}) (CheckBoxFieldsResponse, *http.Response, error)

PdfApiService Read document checkbox fields. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return CheckBoxFieldsResponse

func (*PdfApiService) GetDocumentCircleAnnotations

func (a *PdfApiService) GetDocumentCircleAnnotations(name string, localVarOptionals map[string]interface{}) (CircleAnnotationsResponse, *http.Response, error)

PdfApiService Read document circle annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return CircleAnnotationsResponse

func (*PdfApiService) GetDocumentComboBoxFields

func (a *PdfApiService) GetDocumentComboBoxFields(name string, localVarOptionals map[string]interface{}) (ComboBoxFieldsResponse, *http.Response, error)

PdfApiService Read document combobox fields. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return ComboBoxFieldsResponse

func (*PdfApiService) GetDocumentDisplayProperties

func (a *PdfApiService) GetDocumentDisplayProperties(name string, localVarOptionals map[string]interface{}) (DisplayPropertiesResponse, *http.Response, error)

PdfApiService Read document display properties. @param name @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string)
@param "folder" (string)

@return DisplayPropertiesResponse

func (*PdfApiService) GetDocumentFileAttachmentAnnotations

func (a *PdfApiService) GetDocumentFileAttachmentAnnotations(name string, localVarOptionals map[string]interface{}) (FileAttachmentAnnotationsResponse, *http.Response, error)

PdfApiService Read document FileAttachment annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return FileAttachmentAnnotationsResponse

func (*PdfApiService) GetDocumentFreeTextAnnotations

func (a *PdfApiService) GetDocumentFreeTextAnnotations(name string, localVarOptionals map[string]interface{}) (FreeTextAnnotationsResponse, *http.Response, error)

PdfApiService Read document free text annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return FreeTextAnnotationsResponse

func (*PdfApiService) GetDocumentHighlightAnnotations

func (a *PdfApiService) GetDocumentHighlightAnnotations(name string, localVarOptionals map[string]interface{}) (HighlightAnnotationsResponse, *http.Response, error)

PdfApiService Read document highlight annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return HighlightAnnotationsResponse

func (*PdfApiService) GetDocumentInkAnnotations

func (a *PdfApiService) GetDocumentInkAnnotations(name string, localVarOptionals map[string]interface{}) (InkAnnotationsResponse, *http.Response, error)

PdfApiService Read document ink annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return InkAnnotationsResponse

func (*PdfApiService) GetDocumentLineAnnotations

func (a *PdfApiService) GetDocumentLineAnnotations(name string, localVarOptionals map[string]interface{}) (LineAnnotationsResponse, *http.Response, error)

PdfApiService Read document line annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return LineAnnotationsResponse

func (*PdfApiService) GetDocumentListBoxFields

func (a *PdfApiService) GetDocumentListBoxFields(name string, localVarOptionals map[string]interface{}) (ListBoxFieldsResponse, *http.Response, error)

PdfApiService Read document listbox fields. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return ListBoxFieldsResponse

func (*PdfApiService) GetDocumentMovieAnnotations

func (a *PdfApiService) GetDocumentMovieAnnotations(name string, localVarOptionals map[string]interface{}) (MovieAnnotationsResponse, *http.Response, error)

PdfApiService Read document movie annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return MovieAnnotationsResponse

func (*PdfApiService) GetDocumentPolyLineAnnotations

func (a *PdfApiService) GetDocumentPolyLineAnnotations(name string, localVarOptionals map[string]interface{}) (PolyLineAnnotationsResponse, *http.Response, error)

PdfApiService Read document polyline annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return PolyLineAnnotationsResponse

func (*PdfApiService) GetDocumentPolygonAnnotations

func (a *PdfApiService) GetDocumentPolygonAnnotations(name string, localVarOptionals map[string]interface{}) (PolygonAnnotationsResponse, *http.Response, error)

PdfApiService Read document polygon annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return PolygonAnnotationsResponse

func (*PdfApiService) GetDocumentPopupAnnotations

func (a *PdfApiService) GetDocumentPopupAnnotations(name string, localVarOptionals map[string]interface{}) (PopupAnnotationsResponse, *http.Response, error)

PdfApiService Read document popup annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return PopupAnnotationsResponse

func (*PdfApiService) GetDocumentPopupAnnotationsByParent

func (a *PdfApiService) GetDocumentPopupAnnotationsByParent(name string, annotationId string, localVarOptionals map[string]interface{}) (PopupAnnotationsResponse, *http.Response, error)

PdfApiService Read document popup annotations by parent id. @param name The document name. @param annotationId The parent annotation ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return PopupAnnotationsResponse

func (*PdfApiService) GetDocumentProperties

func (a *PdfApiService) GetDocumentProperties(name string, localVarOptionals map[string]interface{}) (DocumentPropertiesResponse, *http.Response, error)

PdfApiService Read document properties. @param name @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string)
@param "folder" (string)

@return DocumentPropertiesResponse

func (*PdfApiService) GetDocumentProperty

func (a *PdfApiService) GetDocumentProperty(name string, propertyName string, localVarOptionals map[string]interface{}) (DocumentPropertyResponse, *http.Response, error)

PdfApiService Read document property by name. @param name @param propertyName @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string)
@param "folder" (string)

@return DocumentPropertyResponse

func (*PdfApiService) GetDocumentRadioButtonFields

func (a *PdfApiService) GetDocumentRadioButtonFields(name string, localVarOptionals map[string]interface{}) (RadioButtonFieldsResponse, *http.Response, error)

PdfApiService Read document radiobutton fields. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return RadioButtonFieldsResponse

func (*PdfApiService) GetDocumentRedactionAnnotations

func (a *PdfApiService) GetDocumentRedactionAnnotations(name string, localVarOptionals map[string]interface{}) (RedactionAnnotationsResponse, *http.Response, error)

PdfApiService Read document redaction annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return RedactionAnnotationsResponse

func (*PdfApiService) GetDocumentScreenAnnotations

func (a *PdfApiService) GetDocumentScreenAnnotations(name string, localVarOptionals map[string]interface{}) (ScreenAnnotationsResponse, *http.Response, error)

PdfApiService Read document screen annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return ScreenAnnotationsResponse

func (*PdfApiService) GetDocumentSignatureFields

func (a *PdfApiService) GetDocumentSignatureFields(name string, localVarOptionals map[string]interface{}) (SignatureFieldsResponse, *http.Response, error)

PdfApiService Read document signature fields. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return SignatureFieldsResponse

func (*PdfApiService) GetDocumentSoundAnnotations

func (a *PdfApiService) GetDocumentSoundAnnotations(name string, localVarOptionals map[string]interface{}) (SoundAnnotationsResponse, *http.Response, error)

PdfApiService Read document sound annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return SoundAnnotationsResponse

func (*PdfApiService) GetDocumentSquareAnnotations

func (a *PdfApiService) GetDocumentSquareAnnotations(name string, localVarOptionals map[string]interface{}) (SquareAnnotationsResponse, *http.Response, error)

PdfApiService Read document square annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return SquareAnnotationsResponse

func (*PdfApiService) GetDocumentSquigglyAnnotations

func (a *PdfApiService) GetDocumentSquigglyAnnotations(name string, localVarOptionals map[string]interface{}) (SquigglyAnnotationsResponse, *http.Response, error)

PdfApiService Read document squiggly annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return SquigglyAnnotationsResponse

func (*PdfApiService) GetDocumentStampAnnotations

func (a *PdfApiService) GetDocumentStampAnnotations(name string, localVarOptionals map[string]interface{}) (StampAnnotationsResponse, *http.Response, error)

PdfApiService Read document stamp annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return StampAnnotationsResponse

func (*PdfApiService) GetDocumentStamps

func (a *PdfApiService) GetDocumentStamps(name string, localVarOptionals map[string]interface{}) (StampsInfoResponse, *http.Response, error)

PdfApiService Read document stamps. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return StampsInfoResponse

func (*PdfApiService) GetDocumentStrikeOutAnnotations

func (a *PdfApiService) GetDocumentStrikeOutAnnotations(name string, localVarOptionals map[string]interface{}) (StrikeOutAnnotationsResponse, *http.Response, error)

PdfApiService Read document StrikeOut annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return StrikeOutAnnotationsResponse

func (*PdfApiService) GetDocumentTables

func (a *PdfApiService) GetDocumentTables(name string, localVarOptionals map[string]interface{}) (TablesRecognizedResponse, *http.Response, error)

PdfApiService Read document tables. @param name @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string)
@param "folder" (string)

@return TablesRecognizedResponse

func (*PdfApiService) GetDocumentTextAnnotations

func (a *PdfApiService) GetDocumentTextAnnotations(name string, localVarOptionals map[string]interface{}) (TextAnnotationsResponse, *http.Response, error)

PdfApiService Read document text annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return TextAnnotationsResponse

func (*PdfApiService) GetDocumentTextBoxFields

func (a *PdfApiService) GetDocumentTextBoxFields(name string, localVarOptionals map[string]interface{}) (TextBoxFieldsResponse, *http.Response, error)

PdfApiService Read document text box fields. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return TextBoxFieldsResponse

func (*PdfApiService) GetDocumentUnderlineAnnotations

func (a *PdfApiService) GetDocumentUnderlineAnnotations(name string, localVarOptionals map[string]interface{}) (UnderlineAnnotationsResponse, *http.Response, error)

PdfApiService Read document underline annotations. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return UnderlineAnnotationsResponse

func (*PdfApiService) GetDownloadDocumentAttachmentByIndex

func (a *PdfApiService) GetDownloadDocumentAttachmentByIndex(name string, attachmentIndex int32, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Download document attachment content by its index. @param name The document name. @param attachmentIndex The attachment index. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return []byte

func (*PdfApiService) GetEpubInStorageToPdf

func (a *PdfApiService) GetEpubInStorageToPdf(srcPath string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Convert EPUB file (located on storage) to PDF format and return resulting file in response. @param srcPath Full source filename (ex. /folder1/folder2/template.epub) @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetExportFieldsFromPdfToFdfInStorage

func (a *PdfApiService) GetExportFieldsFromPdfToFdfInStorage(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Export fields from from PDF in storage to FDF file. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return []byte

func (*PdfApiService) GetExportFieldsFromPdfToXfdfInStorage

func (a *PdfApiService) GetExportFieldsFromPdfToXfdfInStorage(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Export fields from from PDF in storage to XFDF file. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return []byte

func (*PdfApiService) GetExportFieldsFromPdfToXmlInStorage

func (a *PdfApiService) GetExportFieldsFromPdfToXmlInStorage(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Export fields from from PDF in storage to XML file. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return []byte

func (*PdfApiService) GetField

func (a *PdfApiService) GetField(name string, fieldName string, localVarOptionals map[string]interface{}) (FieldResponse, *http.Response, error)

PdfApiService Get document field by name. @param name The document name. @param fieldName The field name (name should be encoded). @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return FieldResponse

func (*PdfApiService) GetFields

func (a *PdfApiService) GetFields(name string, localVarOptionals map[string]interface{}) (FieldsResponse, *http.Response, error)

PdfApiService Get document fields. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return FieldsResponse

func (*PdfApiService) GetFileAttachmentAnnotation

func (a *PdfApiService) GetFileAttachmentAnnotation(name string, annotationId string, localVarOptionals map[string]interface{}) (FileAttachmentAnnotationResponse, *http.Response, error)

PdfApiService Read document page FileAttachment annotation by ID. @param name The document name. @param annotationId The annotation ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return FileAttachmentAnnotationResponse

func (*PdfApiService) GetFileAttachmentAnnotationData

func (a *PdfApiService) GetFileAttachmentAnnotationData(name string, annotationId string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Read document page FileAttachment annotation by ID. @param name The document name. @param annotationId The annotation ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return []byte

func (*PdfApiService) GetFileVersions

func (a *PdfApiService) GetFileVersions(path string, localVarOptionals map[string]interface{}) (FileVersions, *http.Response, error)

PdfApiService Get file versions @param path File path e.g. '/file.ext' @param optional (nil or map[string]interface{}) with one or more of:

@param "storageName" (string) Storage name

@return FileVersions

func (*PdfApiService) GetFilesList

func (a *PdfApiService) GetFilesList(path string, localVarOptionals map[string]interface{}) (FilesList, *http.Response, error)

PdfApiService Get all files and folders within a folder @param path Folder path e.g. '/folder' @param optional (nil or map[string]interface{}) with one or more of:

@param "storageName" (string) Storage name

@return FilesList

func (*PdfApiService) GetFreeTextAnnotation

func (a *PdfApiService) GetFreeTextAnnotation(name string, annotationId string, localVarOptionals map[string]interface{}) (FreeTextAnnotationResponse, *http.Response, error)

PdfApiService Read document page free text annotation by ID. @param name The document name. @param annotationId The annotation ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return FreeTextAnnotationResponse

func (*PdfApiService) GetHighlightAnnotation

func (a *PdfApiService) GetHighlightAnnotation(name string, annotationId string, localVarOptionals map[string]interface{}) (HighlightAnnotationResponse, *http.Response, error)

PdfApiService Read document page highlight annotation by ID. @param name The document name. @param annotationId The annotation ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return HighlightAnnotationResponse

func (*PdfApiService) GetHtmlInStorageToPdf

func (a *PdfApiService) GetHtmlInStorageToPdf(srcPath string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Convert HTML file (located on storage) to PDF format and return resulting file in response. @param srcPath Full source filename (ex. /folder1/folder2/template.zip) @param optional (nil or map[string]interface{}) with one or more of:

@param "htmlFileName" (string) Name of HTML file in ZIP.
@param "height" (float64) Page height
@param "width" (float64) Page width
@param "isLandscape" (bool) Is page landscaped
@param "marginLeft" (float64) Page margin left
@param "marginBottom" (float64) Page margin bottom
@param "marginRight" (float64) Page margin right
@param "marginTop" (float64) Page margin top
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetImage

func (a *PdfApiService) GetImage(name string, imageId string, localVarOptionals map[string]interface{}) (ImageResponse, *http.Response, error)

PdfApiService Read document image by ID. @param name The document name. @param imageId Image ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return ImageResponse

func (*PdfApiService) GetImageExtractAsGif

func (a *PdfApiService) GetImageExtractAsGif(name string, imageId string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Extract document image in GIF format @param name The document name. @param imageId Image ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "width" (int32) The converted image width.
@param "height" (int32) The converted image height.
@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return []byte

func (*PdfApiService) GetImageExtractAsJpeg

func (a *PdfApiService) GetImageExtractAsJpeg(name string, imageId string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Extract document image in JPEG format @param name The document name. @param imageId Image ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "width" (int32) The converted image width.
@param "height" (int32) The converted image height.
@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return []byte

func (*PdfApiService) GetImageExtractAsPng

func (a *PdfApiService) GetImageExtractAsPng(name string, imageId string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Extract document image in PNG format @param name The document name. @param imageId Image ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "width" (int32) The converted image width.
@param "height" (int32) The converted image height.
@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return []byte

func (*PdfApiService) GetImageExtractAsTiff

func (a *PdfApiService) GetImageExtractAsTiff(name string, imageId string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Extract document image in TIFF format @param name The document name. @param imageId Image ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "width" (int32) The converted image width.
@param "height" (int32) The converted image height.
@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return []byte

func (*PdfApiService) GetImages

func (a *PdfApiService) GetImages(name string, pageNumber int32, localVarOptionals map[string]interface{}) (ImagesResponse, *http.Response, error)

PdfApiService Read document images. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return ImagesResponse

func (*PdfApiService) GetImportFieldsFromFdfInStorage

func (a *PdfApiService) GetImportFieldsFromFdfInStorage(name string, fdfFilePath string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Update fields from FDF file in storage. @param name The document name. @param fdfFilePath The Fdf file path. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return []byte

func (*PdfApiService) GetImportFieldsFromXfdfInStorage

func (a *PdfApiService) GetImportFieldsFromXfdfInStorage(name string, xfdfFilePath string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Update fields from XFDF file in storage. @param name The document name. @param xfdfFilePath The XFDF file path. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return []byte

func (*PdfApiService) GetImportFieldsFromXmlInStorage

func (a *PdfApiService) GetImportFieldsFromXmlInStorage(name string, xmlFilePath string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Import from XML file (located on storage) to PDF format and return resulting file in response. @param name The document name. @param xmlFilePath Full source filename (ex. /folder1/folder2/template.xml) @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return []byte

func (*PdfApiService) GetInkAnnotation

func (a *PdfApiService) GetInkAnnotation(name string, annotationId string, localVarOptionals map[string]interface{}) (InkAnnotationResponse, *http.Response, error)

PdfApiService Read document page ink annotation by ID. @param name The document name. @param annotationId The annotation ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return InkAnnotationResponse

func (*PdfApiService) GetLineAnnotation

func (a *PdfApiService) GetLineAnnotation(name string, annotationId string, localVarOptionals map[string]interface{}) (LineAnnotationResponse, *http.Response, error)

PdfApiService Read document page line annotation by ID. @param name The document name. @param annotationId The annotation ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return LineAnnotationResponse

func (*PdfApiService) GetLinkAnnotation

func (a *PdfApiService) GetLinkAnnotation(name string, linkId string, localVarOptionals map[string]interface{}) (LinkAnnotationResponse, *http.Response, error)

PdfApiService Read document link annotation by ID. @param name The document name. @param linkId The link ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return LinkAnnotationResponse

func (*PdfApiService) GetListBoxField

func (a *PdfApiService) GetListBoxField(name string, fieldName string, localVarOptionals map[string]interface{}) (ListBoxFieldResponse, *http.Response, error)

PdfApiService Read document listbox field by name. @param name The document name. @param fieldName The field name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return ListBoxFieldResponse

func (*PdfApiService) GetMarkdownInStorageToPdf

func (a *PdfApiService) GetMarkdownInStorageToPdf(srcPath string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Convert MD file (located on storage) to PDF format and return resulting file in response. @param srcPath Full source filename (ex. /folder1/folder2/template.md) @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetMhtInStorageToPdf

func (a *PdfApiService) GetMhtInStorageToPdf(srcPath string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Convert MHT file (located on storage) to PDF format and return resulting file in response. @param srcPath Full source filename (ex. /folder1/folder2/template.mht) @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetMovieAnnotation

func (a *PdfApiService) GetMovieAnnotation(name string, annotationId string, localVarOptionals map[string]interface{}) (MovieAnnotationResponse, *http.Response, error)

PdfApiService Read document page movie annotation by ID. @param name The document name. @param annotationId The annotation ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return MovieAnnotationResponse

func (*PdfApiService) GetPage

func (a *PdfApiService) GetPage(name string, pageNumber int32, localVarOptionals map[string]interface{}) (DocumentPageResponse, *http.Response, error)

PdfApiService Read document page info. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return DocumentPageResponse

func (*PdfApiService) GetPageAnnotations

func (a *PdfApiService) GetPageAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (AnnotationsInfoResponse, *http.Response, error)

PdfApiService Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return AnnotationsInfoResponse

func (*PdfApiService) GetPageCaretAnnotations

func (a *PdfApiService) GetPageCaretAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (CaretAnnotationsResponse, *http.Response, error)

PdfApiService Read document page caret annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return CaretAnnotationsResponse

func (*PdfApiService) GetPageCheckBoxFields

func (a *PdfApiService) GetPageCheckBoxFields(name string, pageNumber int32, localVarOptionals map[string]interface{}) (CheckBoxFieldsResponse, *http.Response, error)

PdfApiService Read document page checkbox fields. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return CheckBoxFieldsResponse

func (*PdfApiService) GetPageCircleAnnotations

func (a *PdfApiService) GetPageCircleAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (CircleAnnotationsResponse, *http.Response, error)

PdfApiService Read document page circle annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return CircleAnnotationsResponse

func (*PdfApiService) GetPageComboBoxFields

func (a *PdfApiService) GetPageComboBoxFields(name string, pageNumber int32, localVarOptionals map[string]interface{}) (ComboBoxFieldsResponse, *http.Response, error)

PdfApiService Read document page combobox fields. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return ComboBoxFieldsResponse

func (*PdfApiService) GetPageConvertToBmp

func (a *PdfApiService) GetPageConvertToBmp(name string, pageNumber int32, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Convert document page to Bmp image and return resulting file in response. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "width" (int32) The converted image width.
@param "height" (int32) The converted image height.
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPageConvertToEmf

func (a *PdfApiService) GetPageConvertToEmf(name string, pageNumber int32, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Convert document page to Emf image and return resulting file in response. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "width" (int32) The converted image width.
@param "height" (int32) The converted image height.
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPageConvertToGif

func (a *PdfApiService) GetPageConvertToGif(name string, pageNumber int32, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Convert document page to Gif image and return resulting file in response. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "width" (int32) The converted image width.
@param "height" (int32) The converted image height.
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPageConvertToJpeg

func (a *PdfApiService) GetPageConvertToJpeg(name string, pageNumber int32, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Convert document page to Jpeg image and return resulting file in response. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "width" (int32) The converted image width.
@param "height" (int32) The converted image height.
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPageConvertToPng

func (a *PdfApiService) GetPageConvertToPng(name string, pageNumber int32, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Convert document page to Png image and return resulting file in response. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "width" (int32) The converted image width.
@param "height" (int32) The converted image height.
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPageConvertToTiff

func (a *PdfApiService) GetPageConvertToTiff(name string, pageNumber int32, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Convert document page to Tiff image and return resulting file in response. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "width" (int32) The converted image width.
@param "height" (int32) The converted image height.
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPageFileAttachmentAnnotations

func (a *PdfApiService) GetPageFileAttachmentAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (FileAttachmentAnnotationsResponse, *http.Response, error)

PdfApiService Read document page FileAttachment annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return FileAttachmentAnnotationsResponse

func (*PdfApiService) GetPageFreeTextAnnotations

func (a *PdfApiService) GetPageFreeTextAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (FreeTextAnnotationsResponse, *http.Response, error)

PdfApiService Read document page free text annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return FreeTextAnnotationsResponse

func (*PdfApiService) GetPageHighlightAnnotations

func (a *PdfApiService) GetPageHighlightAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (HighlightAnnotationsResponse, *http.Response, error)

PdfApiService Read document page highlight annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return HighlightAnnotationsResponse

func (*PdfApiService) GetPageInkAnnotations

func (a *PdfApiService) GetPageInkAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (InkAnnotationsResponse, *http.Response, error)

PdfApiService Read document page ink annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return InkAnnotationsResponse

func (*PdfApiService) GetPageLineAnnotations

func (a *PdfApiService) GetPageLineAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (LineAnnotationsResponse, *http.Response, error)

PdfApiService Read document page line annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return LineAnnotationsResponse

func (*PdfApiService) GetPageLinkAnnotation

func (a *PdfApiService) GetPageLinkAnnotation(name string, pageNumber int32, linkId string, localVarOptionals map[string]interface{}) (LinkAnnotationResponse, *http.Response, error)

PdfApiService Read document page link annotation by ID. @param name The document name. @param pageNumber The page number. @param linkId The link ID. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return LinkAnnotationResponse

func (*PdfApiService) GetPageLinkAnnotations

func (a *PdfApiService) GetPageLinkAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (LinkAnnotationsResponse, *http.Response, error)

PdfApiService Read document page link annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return LinkAnnotationsResponse

func (*PdfApiService) GetPageListBoxFields

func (a *PdfApiService) GetPageListBoxFields(name string, pageNumber int32, localVarOptionals map[string]interface{}) (ListBoxFieldsResponse, *http.Response, error)

PdfApiService Read document page listbox fields. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return ListBoxFieldsResponse

func (*PdfApiService) GetPageMovieAnnotations

func (a *PdfApiService) GetPageMovieAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (MovieAnnotationsResponse, *http.Response, error)

PdfApiService Read document page movie annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return MovieAnnotationsResponse

func (*PdfApiService) GetPagePolyLineAnnotations

func (a *PdfApiService) GetPagePolyLineAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (PolyLineAnnotationsResponse, *http.Response, error)

PdfApiService Read document page polyline annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return PolyLineAnnotationsResponse

func (*PdfApiService) GetPagePolygonAnnotations

func (a *PdfApiService) GetPagePolygonAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (PolygonAnnotationsResponse, *http.Response, error)

PdfApiService Read document page polygon annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return PolygonAnnotationsResponse

func (*PdfApiService) GetPagePopupAnnotations

func (a *PdfApiService) GetPagePopupAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (PopupAnnotationsResponse, *http.Response, error)

PdfApiService Read document page popup annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return PopupAnnotationsResponse

func (*PdfApiService) GetPageRadioButtonFields

func (a *PdfApiService) GetPageRadioButtonFields(name string, pageNumber int32, localVarOptionals map[string]interface{}) (RadioButtonFieldsResponse, *http.Response, error)

PdfApiService Read document page radiobutton fields. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return RadioButtonFieldsResponse

func (*PdfApiService) GetPageRedactionAnnotations

func (a *PdfApiService) GetPageRedactionAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (RedactionAnnotationsResponse, *http.Response, error)

PdfApiService Read document page redaction annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return RedactionAnnotationsResponse

func (*PdfApiService) GetPageScreenAnnotations

func (a *PdfApiService) GetPageScreenAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (ScreenAnnotationsResponse, *http.Response, error)

PdfApiService Read document page screen annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return ScreenAnnotationsResponse

func (*PdfApiService) GetPageSignatureFields

func (a *PdfApiService) GetPageSignatureFields(name string, pageNumber int32, localVarOptionals map[string]interface{}) (SignatureFieldsResponse, *http.Response, error)

PdfApiService Read document page signature fields. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return SignatureFieldsResponse

func (*PdfApiService) GetPageSoundAnnotations

func (a *PdfApiService) GetPageSoundAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (SoundAnnotationsResponse, *http.Response, error)

PdfApiService Read document page sound annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return SoundAnnotationsResponse

func (*PdfApiService) GetPageSquareAnnotations

func (a *PdfApiService) GetPageSquareAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (SquareAnnotationsResponse, *http.Response, error)

PdfApiService Read document page square annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return SquareAnnotationsResponse

func (*PdfApiService) GetPageSquigglyAnnotations

func (a *PdfApiService) GetPageSquigglyAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (SquigglyAnnotationsResponse, *http.Response, error)

PdfApiService Read document page squiggly annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return SquigglyAnnotationsResponse

func (*PdfApiService) GetPageStampAnnotations

func (a *PdfApiService) GetPageStampAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (StampAnnotationsResponse, *http.Response, error)

PdfApiService Read document page stamp annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return StampAnnotationsResponse

func (*PdfApiService) GetPageStamps

func (a *PdfApiService) GetPageStamps(name string, pageNumber int32, localVarOptionals map[string]interface{}) (StampsInfoResponse, *http.Response, error)

PdfApiService Read page document stamps. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return StampsInfoResponse

func (*PdfApiService) GetPageStrikeOutAnnotations

func (a *PdfApiService) GetPageStrikeOutAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (StrikeOutAnnotationsResponse, *http.Response, error)

PdfApiService Read document page StrikeOut annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return StrikeOutAnnotationsResponse

func (*PdfApiService) GetPageTables

func (a *PdfApiService) GetPageTables(name string, pageNumber int32, localVarOptionals map[string]interface{}) (TablesRecognizedResponse, *http.Response, error)

PdfApiService Read document page tables. @param name @param pageNumber @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string)
@param "folder" (string)

@return TablesRecognizedResponse

func (*PdfApiService) GetPageText

func (a *PdfApiService) GetPageText(name string, pageNumber int32, lLX float64, lLY float64, uRX float64, uRY float64, localVarOptionals map[string]interface{}) (TextRectsResponse, *http.Response, error)

PdfApiService Read page text items. @param name The document name. @param pageNumber Number of page (starting from 1). @param lLX X-coordinate of lower - left corner. @param lLY Y - coordinate of lower-left corner. @param uRX X - coordinate of upper-right corner. @param uRY Y - coordinate of upper-right corner. @param optional (nil or map[string]interface{}) with one or more of:

@param "format" ([]string) List of formats for search.
@param "regex" (string) Formats are specified as a regular expression.
@param "splitRects" (bool) Split result fragments (default is true).
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return TextRectsResponse

func (*PdfApiService) GetPageTextAnnotations

func (a *PdfApiService) GetPageTextAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (TextAnnotationsResponse, *http.Response, error)

PdfApiService Read document page text annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return TextAnnotationsResponse

func (*PdfApiService) GetPageTextBoxFields

func (a *PdfApiService) GetPageTextBoxFields(name string, pageNumber int32, localVarOptionals map[string]interface{}) (TextBoxFieldsResponse, *http.Response, error)

PdfApiService Read document page text box fields. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return TextBoxFieldsResponse

func (*PdfApiService) GetPageUnderlineAnnotations

func (a *PdfApiService) GetPageUnderlineAnnotations(name string, pageNumber int32, localVarOptionals map[string]interface{}) (UnderlineAnnotationsResponse, *http.Response, error)

PdfApiService Read document page underline annotations. @param name The document name. @param pageNumber The page number. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return UnderlineAnnotationsResponse

func (*PdfApiService) GetPages

func (a *PdfApiService) GetPages(name string, localVarOptionals map[string]interface{}) (DocumentPagesResponse, *http.Response, error)

PdfApiService Read document pages info. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.
@param "folder" (string) The document folder.

@return DocumentPagesResponse

func (*PdfApiService) GetPclInStorageToPdf

func (a *PdfApiService) GetPclInStorageToPdf(srcPath string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Convert PCL file (located on storage) to PDF format and return resulting file in response. @param srcPath Full source filename (ex. /folder1/folder2/template.pcl) @param optional (nil or map[string]interface{}) with one or more of:

@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPdfAInStorageToPdf

func (a *PdfApiService) GetPdfAInStorageToPdf(srcPath string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Convert PDFA file (located on storage) to PDF format and return resulting file in response. @param srcPath Full source filename (ex. /folder1/folder2/template.pdf) @param optional (nil or map[string]interface{}) with one or more of:

@param "dontOptimize" (bool) If set, document resources will not be optimized.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPdfInStorageToDoc

func (a *PdfApiService) GetPdfInStorageToDoc(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Converts PDF document (located on storage) to DOC format and returns resulting file in response content @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "addReturnToLineEnd" (bool) Add return to line end.
@param "format" (string) Allows to specify .doc or .docx file format.
@param "imageResolutionX" (int32) Image resolution X.
@param "imageResolutionY" (int32) Image resolution Y.
@param "maxDistanceBetweenTextLines" (float64) Max distance between text lines.
@param "mode" (string) Allows to control how a PDF document is converted into a word processing document.
@param "recognizeBullets" (bool) Recognize bullets.
@param "relativeHorizontalProximity" (float64) Relative horizontal proximity.
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPdfInStorageToEpub

func (a *PdfApiService) GetPdfInStorageToEpub(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Converts PDF document (located on storage) to EPUB format and returns resulting file in response content @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "contentRecognitionMode" (string) Property tunes conversion for this or that desirable method of recognition of content.
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPdfInStorageToHtml

func (a *PdfApiService) GetPdfInStorageToHtml(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Converts PDF document (located on storage) to Html format and returns resulting file in response content @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "additionalMarginWidthInPoints" (int32) Defines width of margin that will be forcibly left around that output HTML-areas.
@param "compressSvgGraphicsIfAny" (bool) The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving.
@param "convertMarkedContentToLayers" (bool) If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with \"data-pdflayer\" attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.
@param "defaultFontName" (string) Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.
@param "documentType" (string) Result document type.
@param "fixedLayout" (bool) The value indicating whether that HTML is created as fixed layout.
@param "imageResolution" (int32) Resolution for image rendering.
@param "minimalLineWidth" (int32) This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.
@param "preventGlyphsGrouping" (bool) This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.
@param "splitCssIntoPages" (bool) When multipage-mode selected(i.e 'SplitIntoPages' is 'true'), then this attribute defines whether should be created separate CSS-file for each result HTML page.
@param "splitIntoPages" (bool) The flag that indicates whether each page of source document will be converted into it's own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.
@param "useZOrder" (bool) If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.
@param "antialiasingProcessing" (string) The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML.
@param "cssClassNamesPrefix" (string) When PDFtoHTML converter generates result CSSs, CSS class names (something like \".stl_01 {}\" ... \".stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix.
@param "explicitListOfSavedPages" ([]int32) With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1...[NumberOfPagesInConvertedDocument]) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF.
@param "fontEncodingStrategy" (string) Defines encoding special rule to tune PDF decoding for current document.
@param "fontSavingMode" (string) Defines font saving mode that will be used during saving of PDF to desirable format.
@param "htmlMarkupGenerationMode" (string) Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.
@param "lettersPositioningMethod" (string) The mode of positioning of letters in words in result HTML.
@param "pagesFlowTypeDependsOnViewersScreenSize" (bool) If attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer.
@param "partsEmbeddingMode" (string) It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities.
@param "rasterImagesSavingMode" (string) Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML.
@param "removeEmptyAreasOnTopAndBottom" (bool) Defines whether in created HTML will be removed top and bottom empty area without any content (if any).
@param "saveShadowedTextsAsTransparentTexts" (bool) Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard).
@param "saveTransparentTexts" (bool) Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML.
@param "specialFolderForAllImages" (string) The path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.
@param "specialFolderForSvgImages" (string) The path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.
@param "trySaveTextUnderliningAndStrikeoutingInCss" (bool) PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text's underlining and put this info into CSS instead of drawing of underlining graphically.
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.
@param "flowLayoutParagraphFullWidth" (bool) This attribute specifies full width paragraph text for Flow mode, FixedLayout = false.

@return []byte

func (*PdfApiService) GetPdfInStorageToMobiXml

func (a *PdfApiService) GetPdfInStorageToMobiXml(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Converts PDF document (located on storage) to MOBIXML format and returns resulting ZIP archive file in response content. @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPdfInStorageToPdfA

func (a *PdfApiService) GetPdfInStorageToPdfA(name string, type_ string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Converts PDF document (located on storage) to PdfA format and returns resulting file in response content @param name The document name. @param type_ Type of PdfA format. @param optional (nil or map[string]interface{}) with one or more of:

@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPdfInStorageToPptx

func (a *PdfApiService) GetPdfInStorageToPptx(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Converts PDF document (located on storage) to PPTX format and returns resulting file in response content @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "separateImages" (bool) Separate images.
@param "slidesAsImages" (bool) Slides as images.
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPdfInStorageToSvg

func (a *PdfApiService) GetPdfInStorageToSvg(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Converts PDF document (located on storage) to SVG format and returns resulting file in response content @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "compressOutputToZipArchive" (bool) Specifies whether output will be created as one zip-archive.
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPdfInStorageToTeX

func (a *PdfApiService) GetPdfInStorageToTeX(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Converts PDF document (located on storage) to TeX format and returns resulting file in response content @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPdfInStorageToTiff

func (a *PdfApiService) GetPdfInStorageToTiff(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Converts PDF document (located on storage) to TIFF format and returns resulting file in response content @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "brightness" (float64) Image brightness.
@param "compression" (string) Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None.
@param "colorDepth" (string) Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp.
@param "leftMargin" (int32) Left image margin.
@param "rightMargin" (int32) Right image margin.
@param "topMargin" (int32) Top image margin.
@param "bottomMargin" (int32) Bottom image margin.
@param "orientation" (string) Image orientation. Possible values are: None, Landscape, Portait.
@param "skipBlankPages" (bool) Skip blank pages flag.
@param "width" (int32) Image width.
@param "height" (int32) Image height.
@param "xResolution" (int32) Horizontal resolution.
@param "yResolution" (int32) Vertical resolution.
@param "pageIndex" (int32) Start page to export.
@param "pageCount" (int32) Number of pages to export.
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPdfInStorageToXls

func (a *PdfApiService) GetPdfInStorageToXls(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Converts PDF document (located on storage) to XLS format and returns resulting file in response content @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "insertBlankColumnAtFirst" (bool) Insert blank column at first
@param "minimizeTheNumberOfWorksheets" (bool) Minimize the number of worksheets
@param "scaleFactor" (float64) Scale factor (Obsolete)
@param "uniformWorksheets" (bool) Uniform worksheets
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte

func (*PdfApiService) GetPdfInStorageToXlsx

func (a *PdfApiService) GetPdfInStorageToXlsx(name string, localVarOptionals map[string]interface{}) ([]byte, *http.Response, error)

PdfApiService Converts PDF document (located on storage) to XLSX format and returns resulting file in response content @param name The document name. @param optional (nil or map[string]interface{}) with one or more of:

@param "insertBlankColumnAtFirst" (bool) Insert blank column at first
@param "minimizeTheNumberOfWorksheets" (bool) Minimize the number of worksheets
@param "scaleFactor" (float64) Scale factor (Obsolete)
@param "uniformWorksheets" (bool) Uniform worksheets
@param "folder" (string) The document folder.
@param "storage" (string) The document storage.

@return []byte