diff --git a/README.md b/README.md index 967d5a8..2eeb6c2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Aspose.PDF Cloud - API version: 2.0 -- Package version: 18.10.0 +- Package version: 18.11.0 [Aspose.PDF Cloud](https://products.aspose.cloud/pdf) 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. @@ -106,27 +106,37 @@ Class | Method | HTTP request | Description *PdfApi* | [**delete_page_link_annotations**](docs/PdfApi.md#delete_page_link_annotations) | **DELETE** /pdf/\{name}/pages/\{pageNumber}/links | Delete all link annotations from the page *PdfApi* | [**delete_properties**](docs/PdfApi.md#delete_properties) | **DELETE** /pdf/\{name}/documentproperties | Delete custom document properties. *PdfApi* | [**delete_property**](docs/PdfApi.md#delete_property) | **DELETE** /pdf/\{name}/documentproperties/\{propertyName} | Delete document property. +*PdfApi* | [**get_caret_annotation**](docs/PdfApi.md#get_caret_annotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID. *PdfApi* | [**get_circle_annotation**](docs/PdfApi.md#get_circle_annotation) | **GET** /pdf/\{name}/annotations/circle/\{annotationId} | Read document page circle annotation by ID. *PdfApi* | [**get_document**](docs/PdfApi.md#get_document) | **GET** /pdf/\{name} | Read common document info. *PdfApi* | [**get_document_annotations**](docs/PdfApi.md#get_document_annotations) | **GET** /pdf/\{name}/annotations | Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases. *PdfApi* | [**get_document_attachment_by_index**](docs/PdfApi.md#get_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex} | Read document attachment info by its index. *PdfApi* | [**get_document_attachments**](docs/PdfApi.md#get_document_attachments) | **GET** /pdf/\{name}/attachments | Read document attachments info. *PdfApi* | [**get_document_bookmarks**](docs/PdfApi.md#get_document_bookmarks) | **GET** /pdf/\{name}/bookmarks | Read document bookmark/bookmarks (including children). +*PdfApi* | [**get_document_caret_annotations**](docs/PdfApi.md#get_document_caret_annotations) | **GET** /pdf/\{name}/annotations/caret | Read document caret annotations. *PdfApi* | [**get_document_circle_annotations**](docs/PdfApi.md#get_document_circle_annotations) | **GET** /pdf/\{name}/annotations/circle | Read document circle annotations. *PdfApi* | [**get_document_free_text_annotations**](docs/PdfApi.md#get_document_free_text_annotations) | **GET** /pdf/\{name}/annotations/freetext | Read document free text annotations. +*PdfApi* | [**get_document_highlight_annotations**](docs/PdfApi.md#get_document_highlight_annotations) | **GET** /pdf/\{name}/annotations/highlight | Read document highlight annotations. +*PdfApi* | [**get_document_ink_annotations**](docs/PdfApi.md#get_document_ink_annotations) | **GET** /pdf/\{name}/annotations/ink | Read document ink annotations. *PdfApi* | [**get_document_line_annotations**](docs/PdfApi.md#get_document_line_annotations) | **GET** /pdf/\{name}/annotations/line | Read document line annotations. *PdfApi* | [**get_document_poly_line_annotations**](docs/PdfApi.md#get_document_poly_line_annotations) | **GET** /pdf/\{name}/annotations/polyline | Read document polyline annotations. *PdfApi* | [**get_document_polygon_annotations**](docs/PdfApi.md#get_document_polygon_annotations) | **GET** /pdf/\{name}/annotations/polygon | Read document polygon annotations. +*PdfApi* | [**get_document_popup_annotations**](docs/PdfApi.md#get_document_popup_annotations) | **GET** /pdf/\{name}/annotations/popup | Read document popup annotations. +*PdfApi* | [**get_document_popup_annotations_by_parent**](docs/PdfApi.md#get_document_popup_annotations_by_parent) | **GET** /pdf/\{name}/annotations/\{annotationId}/popup | Read document popup annotations by parent id. *PdfApi* | [**get_document_properties**](docs/PdfApi.md#get_document_properties) | **GET** /pdf/\{name}/documentproperties | Read document properties. *PdfApi* | [**get_document_property**](docs/PdfApi.md#get_document_property) | **GET** /pdf/\{name}/documentproperties/\{propertyName} | Read document property by name. *PdfApi* | [**get_document_square_annotations**](docs/PdfApi.md#get_document_square_annotations) | **GET** /pdf/\{name}/annotations/square | Read document square annotations. +*PdfApi* | [**get_document_squiggly_annotations**](docs/PdfApi.md#get_document_squiggly_annotations) | **GET** /pdf/\{name}/annotations/squiggly | Read document squiggly annotations. +*PdfApi* | [**get_document_strike_out_annotations**](docs/PdfApi.md#get_document_strike_out_annotations) | **GET** /pdf/\{name}/annotations/strikeout | Read document StrikeOut annotations. *PdfApi* | [**get_document_text_annotations**](docs/PdfApi.md#get_document_text_annotations) | **GET** /pdf/\{name}/annotations/text | Read document text annotations. +*PdfApi* | [**get_document_underline_annotations**](docs/PdfApi.md#get_document_underline_annotations) | **GET** /pdf/\{name}/annotations/underline | Read document underline annotations. *PdfApi* | [**get_download**](docs/PdfApi.md#get_download) | **GET** /storage/file | Download a specific file *PdfApi* | [**get_download_document_attachment_by_index**](docs/PdfApi.md#get_download_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex}/download | Download document attachment content by its index. *PdfApi* | [**get_epub_in_storage_to_pdf**](docs/PdfApi.md#get_epub_in_storage_to_pdf) | **GET** /pdf/create/epub | Convert EPUB file (located on storage) to PDF format and return resulting file in response. *PdfApi* | [**get_field**](docs/PdfApi.md#get_field) | **GET** /pdf/\{name}/fields/\{fieldName} | Get document field by name. *PdfApi* | [**get_fields**](docs/PdfApi.md#get_fields) | **GET** /pdf/\{name}/fields | Get document fields. *PdfApi* | [**get_free_text_annotation**](docs/PdfApi.md#get_free_text_annotation) | **GET** /pdf/\{name}/annotations/freetext/\{annotationId} | Read document page free text annotation by ID. +*PdfApi* | [**get_highlight_annotation**](docs/PdfApi.md#get_highlight_annotation) | **GET** /pdf/\{name}/annotations/highlight/\{annotationId} | Read document page highlight annotation by ID. *PdfApi* | [**get_html_in_storage_to_pdf**](docs/PdfApi.md#get_html_in_storage_to_pdf) | **GET** /pdf/create/html | Convert HTML file (located on storage) to PDF format and return resulting file in response. *PdfApi* | [**get_image**](docs/PdfApi.md#get_image) | **GET** /pdf/\{name}/images/\{imageId} | Read document image by ID. *PdfApi* | [**get_image_extract_as_gif**](docs/PdfApi.md#get_image_extract_as_gif) | **GET** /pdf/\{name}/images/\{imageId}/extract/gif | Extract document image in GIF format @@ -134,12 +144,15 @@ Class | Method | HTTP request | Description *PdfApi* | [**get_image_extract_as_png**](docs/PdfApi.md#get_image_extract_as_png) | **GET** /pdf/\{name}/images/\{imageId}/extract/png | Extract document image in PNG format *PdfApi* | [**get_image_extract_as_tiff**](docs/PdfApi.md#get_image_extract_as_tiff) | **GET** /pdf/\{name}/images/\{imageId}/extract/tiff | Extract document image in TIFF format *PdfApi* | [**get_images**](docs/PdfApi.md#get_images) | **GET** /pdf/\{name}/pages/\{pageNumber}/images | Read document images. +*PdfApi* | [**get_ink_annotation**](docs/PdfApi.md#get_ink_annotation) | **GET** /pdf/\{name}/annotations/ink/\{annotationId} | Read document page ink annotation by ID. *PdfApi* | [**get_la_te_x_in_storage_to_pdf**](docs/PdfApi.md#get_la_te_x_in_storage_to_pdf) | **GET** /pdf/create/latex | Convert LaTeX file (located on storage) to PDF format and return resulting file in response. *PdfApi* | [**get_line_annotation**](docs/PdfApi.md#get_line_annotation) | **GET** /pdf/\{name}/annotations/line/\{annotationId} | Read document page line annotation by ID. *PdfApi* | [**get_link_annotation**](docs/PdfApi.md#get_link_annotation) | **GET** /pdf/\{name}/links/\{linkId} | Read document link annotation by ID. +*PdfApi* | [**get_list_files**](docs/PdfApi.md#get_list_files) | **GET** /storage/folder | Get the file listing of a specific folder *PdfApi* | [**get_mht_in_storage_to_pdf**](docs/PdfApi.md#get_mht_in_storage_to_pdf) | **GET** /pdf/create/mht | Convert MHT file (located on storage) to PDF format and return resulting file in response. *PdfApi* | [**get_page**](docs/PdfApi.md#get_page) | **GET** /pdf/\{name}/pages/\{pageNumber} | Read document page info. *PdfApi* | [**get_page_annotations**](docs/PdfApi.md#get_page_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations | Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases. +*PdfApi* | [**get_page_caret_annotations**](docs/PdfApi.md#get_page_caret_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Read document page caret annotations. *PdfApi* | [**get_page_circle_annotations**](docs/PdfApi.md#get_page_circle_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Read document page circle annotations. *PdfApi* | [**get_page_convert_to_bmp**](docs/PdfApi.md#get_page_convert_to_bmp) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/bmp | Convert document page to Bmp image and return resulting file in response. *PdfApi* | [**get_page_convert_to_emf**](docs/PdfApi.md#get_page_convert_to_emf) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/emf | Convert document page to Emf image and return resulting file in response. @@ -148,14 +161,20 @@ Class | Method | HTTP request | Description *PdfApi* | [**get_page_convert_to_png**](docs/PdfApi.md#get_page_convert_to_png) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/png | Convert document page to Png image and return resulting file in response. *PdfApi* | [**get_page_convert_to_tiff**](docs/PdfApi.md#get_page_convert_to_tiff) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/tiff | Convert document page to Tiff image and return resulting file in response. *PdfApi* | [**get_page_free_text_annotations**](docs/PdfApi.md#get_page_free_text_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/freetext | Read document page free text annotations. +*PdfApi* | [**get_page_highlight_annotations**](docs/PdfApi.md#get_page_highlight_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/highlight | Read document page highlight annotations. +*PdfApi* | [**get_page_ink_annotations**](docs/PdfApi.md#get_page_ink_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/ink | Read document page ink annotations. *PdfApi* | [**get_page_line_annotations**](docs/PdfApi.md#get_page_line_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/line | Read document page line annotations. *PdfApi* | [**get_page_link_annotation**](docs/PdfApi.md#get_page_link_annotation) | **GET** /pdf/\{name}/pages/\{pageNumber}/links/\{linkId} | Read document page link annotation by ID. *PdfApi* | [**get_page_link_annotations**](docs/PdfApi.md#get_page_link_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/links | Read document page link annotations. *PdfApi* | [**get_page_poly_line_annotations**](docs/PdfApi.md#get_page_poly_line_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Read document page polyline annotations. *PdfApi* | [**get_page_polygon_annotations**](docs/PdfApi.md#get_page_polygon_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Read document page polygon annotations. +*PdfApi* | [**get_page_popup_annotations**](docs/PdfApi.md#get_page_popup_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/popup | Read document page popup annotations. *PdfApi* | [**get_page_square_annotations**](docs/PdfApi.md#get_page_square_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Read document page square annotations. +*PdfApi* | [**get_page_squiggly_annotations**](docs/PdfApi.md#get_page_squiggly_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Read document page squiggly annotations. +*PdfApi* | [**get_page_strike_out_annotations**](docs/PdfApi.md#get_page_strike_out_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/strikeout | Read document page StrikeOut annotations. *PdfApi* | [**get_page_text**](docs/PdfApi.md#get_page_text) | **GET** /pdf/\{name}/pages/\{pageNumber}/text | Read page text items. *PdfApi* | [**get_page_text_annotations**](docs/PdfApi.md#get_page_text_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/text | Read document page text annotations. +*PdfApi* | [**get_page_underline_annotations**](docs/PdfApi.md#get_page_underline_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/underline | Read document page underline annotations. *PdfApi* | [**get_pages**](docs/PdfApi.md#get_pages) | **GET** /pdf/\{name}/pages | Read document pages info. *PdfApi* | [**get_pcl_in_storage_to_pdf**](docs/PdfApi.md#get_pcl_in_storage_to_pdf) | **GET** /pdf/create/pcl | Convert PCL file (located on storage) to PDF format and return resulting file in response. *PdfApi* | [**get_pdf_in_storage_to_doc**](docs/PdfApi.md#get_pdf_in_storage_to_doc) | **GET** /pdf/\{name}/convert/doc | Converts PDF document (located on storage) to DOC format and returns resulting file in response content @@ -172,11 +191,15 @@ Class | Method | HTTP request | Description *PdfApi* | [**get_pdf_in_storage_to_xps**](docs/PdfApi.md#get_pdf_in_storage_to_xps) | **GET** /pdf/\{name}/convert/xps | Converts PDF document (located on storage) to XPS format and returns resulting file in response content *PdfApi* | [**get_poly_line_annotation**](docs/PdfApi.md#get_poly_line_annotation) | **GET** /pdf/\{name}/annotations/polyline/\{annotationId} | Read document page polyline annotation by ID. *PdfApi* | [**get_polygon_annotation**](docs/PdfApi.md#get_polygon_annotation) | **GET** /pdf/\{name}/annotations/polygon/\{annotationId} | Read document page polygon annotation by ID. +*PdfApi* | [**get_popup_annotation**](docs/PdfApi.md#get_popup_annotation) | **GET** /pdf/\{name}/annotations/popup/\{annotationId} | Read document page popup annotation by ID. *PdfApi* | [**get_ps_in_storage_to_pdf**](docs/PdfApi.md#get_ps_in_storage_to_pdf) | **GET** /pdf/create/ps | Convert PS file (located on storage) to PDF format and return resulting file in response. *PdfApi* | [**get_square_annotation**](docs/PdfApi.md#get_square_annotation) | **GET** /pdf/\{name}/annotations/square/\{annotationId} | Read document page square annotation by ID. +*PdfApi* | [**get_squiggly_annotation**](docs/PdfApi.md#get_squiggly_annotation) | **GET** /pdf/\{name}/annotations/squiggly/\{annotationId} | Read document page squiggly annotation by ID. +*PdfApi* | [**get_strike_out_annotation**](docs/PdfApi.md#get_strike_out_annotation) | **GET** /pdf/\{name}/annotations/strikeout/\{annotationId} | Read document page StrikeOut annotation by ID. *PdfApi* | [**get_svg_in_storage_to_pdf**](docs/PdfApi.md#get_svg_in_storage_to_pdf) | **GET** /pdf/create/svg | Convert SVG file (located on storage) to PDF format and return resulting file in response. *PdfApi* | [**get_text**](docs/PdfApi.md#get_text) | **GET** /pdf/\{name}/text | Read document text. *PdfApi* | [**get_text_annotation**](docs/PdfApi.md#get_text_annotation) | **GET** /pdf/\{name}/annotations/text/\{annotationId} | Read document page text annotation by ID. +*PdfApi* | [**get_underline_annotation**](docs/PdfApi.md#get_underline_annotation) | **GET** /pdf/\{name}/annotations/underline/\{annotationId} | Read document page underline annotation by ID. *PdfApi* | [**get_verify_signature**](docs/PdfApi.md#get_verify_signature) | **GET** /pdf/\{name}/verifySignature | Verify signature document. *PdfApi* | [**get_web_in_storage_to_pdf**](docs/PdfApi.md#get_web_in_storage_to_pdf) | **GET** /pdf/create/web | Convert web page to PDF format and return resulting file in response. *PdfApi* | [**get_words_per_page**](docs/PdfApi.md#get_words_per_page) | **GET** /pdf/\{name}/pages/wordCount | Get number of words per document page. @@ -190,26 +213,35 @@ Class | Method | HTTP request | Description *PdfApi* | [**post_insert_image**](docs/PdfApi.md#post_insert_image) | **POST** /pdf/\{name}/pages/\{pageNumber}/images | Insert image to document page. *PdfApi* | [**post_move_page**](docs/PdfApi.md#post_move_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/movePage | Move page to new position. *PdfApi* | [**post_optimize_document**](docs/PdfApi.md#post_optimize_document) | **POST** /pdf/\{name}/optimize | Optimize document. +*PdfApi* | [**post_page_caret_annotations**](docs/PdfApi.md#post_page_caret_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Add document page caret annotations. *PdfApi* | [**post_page_circle_annotations**](docs/PdfApi.md#post_page_circle_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Add document page circle annotations. *PdfApi* | [**post_page_free_text_annotations**](docs/PdfApi.md#post_page_free_text_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/freetext | Add document page free text annotations. +*PdfApi* | [**post_page_highlight_annotations**](docs/PdfApi.md#post_page_highlight_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/highlight | Add document page highlight annotations. +*PdfApi* | [**post_page_ink_annotations**](docs/PdfApi.md#post_page_ink_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/ink | Add document page ink annotations. *PdfApi* | [**post_page_line_annotations**](docs/PdfApi.md#post_page_line_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/line | Add document page line annotations. *PdfApi* | [**post_page_link_annotations**](docs/PdfApi.md#post_page_link_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/links | Add document page link annotations. *PdfApi* | [**post_page_poly_line_annotations**](docs/PdfApi.md#post_page_poly_line_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Add document page polyline annotations. *PdfApi* | [**post_page_polygon_annotations**](docs/PdfApi.md#post_page_polygon_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Add document page polygon annotations. *PdfApi* | [**post_page_square_annotations**](docs/PdfApi.md#post_page_square_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Add document page square annotations. +*PdfApi* | [**post_page_squiggly_annotations**](docs/PdfApi.md#post_page_squiggly_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Add document page squiggly annotations. +*PdfApi* | [**post_page_strike_out_annotations**](docs/PdfApi.md#post_page_strike_out_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/strikeout | Add document page StrikeOut annotations. *PdfApi* | [**post_page_text_annotations**](docs/PdfApi.md#post_page_text_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/text | Add document page text annotations. *PdfApi* | [**post_page_text_replace**](docs/PdfApi.md#post_page_text_replace) | **POST** /pdf/\{name}/pages/\{pageNumber}/text/replace | Page's replace text method. +*PdfApi* | [**post_page_underline_annotations**](docs/PdfApi.md#post_page_underline_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/underline | Add document page underline annotations. +*PdfApi* | [**post_popup_annotation**](docs/PdfApi.md#post_popup_annotation) | **POST** /pdf/\{name}/annotations/\{annotationId}/popup | Add document popup annotations. *PdfApi* | [**post_sign_document**](docs/PdfApi.md#post_sign_document) | **POST** /pdf/\{name}/sign | Sign document. *PdfApi* | [**post_sign_page**](docs/PdfApi.md#post_sign_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/sign | Sign page. *PdfApi* | [**post_split_document**](docs/PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts. *PdfApi* | [**put_add_new_page**](docs/PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document. *PdfApi* | [**put_add_text**](docs/PdfApi.md#put_add_text) | **PUT** /pdf/\{name}/pages/\{pageNumber}/text | Add text to PDF document page. +*PdfApi* | [**put_caret_annotation**](docs/PdfApi.md#put_caret_annotation) | **PUT** /pdf/\{name}/annotations/caret/\{annotationId} | Replace document caret annotation *PdfApi* | [**put_circle_annotation**](docs/PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation *PdfApi* | [**put_create**](docs/PdfApi.md#put_create) | **PUT** /storage/file | Upload a specific file *PdfApi* | [**put_create_document**](docs/PdfApi.md#put_create_document) | **PUT** /pdf/\{name} | Create empty document. *PdfApi* | [**put_epub_in_storage_to_pdf**](docs/PdfApi.md#put_epub_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/epub | Convert EPUB file (located on storage) to PDF format and upload resulting file to storage. *PdfApi* | [**put_fields_flatten**](docs/PdfApi.md#put_fields_flatten) | **PUT** /pdf/\{name}/fields/flatten | Flatten form fields in document. *PdfApi* | [**put_free_text_annotation**](docs/PdfApi.md#put_free_text_annotation) | **PUT** /pdf/\{name}/annotations/freetext/\{annotationId} | Replace document free text annotation +*PdfApi* | [**put_highlight_annotation**](docs/PdfApi.md#put_highlight_annotation) | **PUT** /pdf/\{name}/annotations/highlight/\{annotationId} | Replace document highlight annotation *PdfApi* | [**put_html_in_storage_to_pdf**](docs/PdfApi.md#put_html_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/html | Convert HTML file (located on storage) to PDF format and upload resulting file to storage. *PdfApi* | [**put_image_extract_as_gif**](docs/PdfApi.md#put_image_extract_as_gif) | **PUT** /pdf/\{name}/images/\{imageId}/extract/gif | Extract document image in GIF format to folder *PdfApi* | [**put_image_extract_as_jpeg**](docs/PdfApi.md#put_image_extract_as_jpeg) | **PUT** /pdf/\{name}/images/\{imageId}/extract/jpeg | Extract document image in JPEG format to folder @@ -220,6 +252,7 @@ Class | Method | HTTP request | Description *PdfApi* | [**put_images_extract_as_jpeg**](docs/PdfApi.md#put_images_extract_as_jpeg) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/jpeg | Extract document images in JPEG format to folder. *PdfApi* | [**put_images_extract_as_png**](docs/PdfApi.md#put_images_extract_as_png) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/png | Extract document images in PNG format to folder. *PdfApi* | [**put_images_extract_as_tiff**](docs/PdfApi.md#put_images_extract_as_tiff) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/tiff | Extract document images in TIFF format to folder. +*PdfApi* | [**put_ink_annotation**](docs/PdfApi.md#put_ink_annotation) | **PUT** /pdf/\{name}/annotations/ink/\{annotationId} | Replace document ink annotation *PdfApi* | [**put_la_te_x_in_storage_to_pdf**](docs/PdfApi.md#put_la_te_x_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/latex | Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage. *PdfApi* | [**put_line_annotation**](docs/PdfApi.md#put_line_annotation) | **PUT** /pdf/\{name}/annotations/line/\{annotationId} | Replace document line annotation *PdfApi* | [**put_link_annotation**](docs/PdfApi.md#put_link_annotation) | **PUT** /pdf/\{name}/links/\{linkId} | Replace document page link annotations @@ -259,14 +292,18 @@ Class | Method | HTTP request | Description *PdfApi* | [**put_pdf_in_storage_to_xps**](docs/PdfApi.md#put_pdf_in_storage_to_xps) | **PUT** /pdf/\{name}/convert/xps | Converts PDF document (located on storage) to XPS format and uploads resulting file to storage *PdfApi* | [**put_poly_line_annotation**](docs/PdfApi.md#put_poly_line_annotation) | **PUT** /pdf/\{name}/annotations/polyline/\{annotationId} | Replace document polyline annotation *PdfApi* | [**put_polygon_annotation**](docs/PdfApi.md#put_polygon_annotation) | **PUT** /pdf/\{name}/annotations/polygon/\{annotationId} | Replace document polygon annotation +*PdfApi* | [**put_popup_annotation**](docs/PdfApi.md#put_popup_annotation) | **PUT** /pdf/\{name}/annotations/popup/\{annotationId} | Replace document popup annotation *PdfApi* | [**put_privileges**](docs/PdfApi.md#put_privileges) | **PUT** /pdf/\{name}/privileges | Update privilege document. *PdfApi* | [**put_ps_in_storage_to_pdf**](docs/PdfApi.md#put_ps_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/ps | Convert PS file (located on storage) to PDF format and upload resulting file to storage. *PdfApi* | [**put_replace_image**](docs/PdfApi.md#put_replace_image) | **PUT** /pdf/\{name}/images/\{imageId} | Replace document image. *PdfApi* | [**put_searchable_document**](docs/PdfApi.md#put_searchable_document) | **PUT** /pdf/\{name}/ocr | Create searchable PDF document. Generate OCR layer for images in input PDF document. *PdfApi* | [**put_set_property**](docs/PdfApi.md#put_set_property) | **PUT** /pdf/\{name}/documentproperties/\{propertyName} | Add/update document property. *PdfApi* | [**put_square_annotation**](docs/PdfApi.md#put_square_annotation) | **PUT** /pdf/\{name}/annotations/square/\{annotationId} | Replace document square annotation +*PdfApi* | [**put_squiggly_annotation**](docs/PdfApi.md#put_squiggly_annotation) | **PUT** /pdf/\{name}/annotations/squiggly/\{annotationId} | Replace document squiggly annotation +*PdfApi* | [**put_strike_out_annotation**](docs/PdfApi.md#put_strike_out_annotation) | **PUT** /pdf/\{name}/annotations/strikeout/\{annotationId} | Replace document StrikeOut annotation *PdfApi* | [**put_svg_in_storage_to_pdf**](docs/PdfApi.md#put_svg_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/svg | Convert SVG file (located on storage) to PDF format and upload resulting file to storage. *PdfApi* | [**put_text_annotation**](docs/PdfApi.md#put_text_annotation) | **PUT** /pdf/\{name}/annotations/text/\{annotationId} | Replace document text annotation +*PdfApi* | [**put_underline_annotation**](docs/PdfApi.md#put_underline_annotation) | **PUT** /pdf/\{name}/annotations/underline/\{annotationId} | Replace document underline annotation *PdfApi* | [**put_update_field**](docs/PdfApi.md#put_update_field) | **PUT** /pdf/\{name}/fields/\{fieldName} | Update field. *PdfApi* | [**put_update_fields**](docs/PdfApi.md#put_update_fields) | **PUT** /pdf/\{name}/fields | Update fields. *PdfApi* | [**put_web_in_storage_to_pdf**](docs/PdfApi.md#put_web_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/web | Convert web page to PDF format and upload resulting file to storage. @@ -285,7 +322,9 @@ Class | Method | HTTP request | Description - [AntialiasingProcessingType](docs/AntialiasingProcessingType.md) - [AppendDocument](docs/AppendDocument.md) - [AsposeResponse](docs/AsposeResponse.md) + - [CapStyle](docs/CapStyle.md) - [CaptionPosition](docs/CaptionPosition.md) + - [CaretSymbol](docs/CaretSymbol.md) - [Color](docs/Color.md) - [ColorDepth](docs/ColorDepth.md) - [CompressionType](docs/CompressionType.md) @@ -294,6 +333,7 @@ Class | Method | HTTP request | Description - [DocumentPrivilege](docs/DocumentPrivilege.md) - [EpubRecognitionMode](docs/EpubRecognitionMode.md) - [FieldType](docs/FieldType.md) + - [File](docs/File.md) - [FontEncodingRules](docs/FontEncodingRules.md) - [FontSavingModes](docs/FontSavingModes.md) - [FontStyles](docs/FontStyles.md) @@ -351,6 +391,9 @@ Class | Method | HTTP request | Description - [AttachmentResponse](docs/AttachmentResponse.md) - [Attachments](docs/Attachments.md) - [AttachmentsResponse](docs/AttachmentsResponse.md) + - [CaretAnnotationResponse](docs/CaretAnnotationResponse.md) + - [CaretAnnotations](docs/CaretAnnotations.md) + - [CaretAnnotationsResponse](docs/CaretAnnotationsResponse.md) - [CircleAnnotationResponse](docs/CircleAnnotationResponse.md) - [CircleAnnotations](docs/CircleAnnotations.md) - [CircleAnnotationsResponse](docs/CircleAnnotationsResponse.md) @@ -366,13 +409,20 @@ Class | Method | HTTP request | Description - [FieldResponse](docs/FieldResponse.md) - [Fields](docs/Fields.md) - [FieldsResponse](docs/FieldsResponse.md) + - [FilesResponse](docs/FilesResponse.md) - [FreeTextAnnotationResponse](docs/FreeTextAnnotationResponse.md) - [FreeTextAnnotations](docs/FreeTextAnnotations.md) - [FreeTextAnnotationsResponse](docs/FreeTextAnnotationsResponse.md) + - [HighlightAnnotationResponse](docs/HighlightAnnotationResponse.md) + - [HighlightAnnotations](docs/HighlightAnnotations.md) + - [HighlightAnnotationsResponse](docs/HighlightAnnotationsResponse.md) - [Image](docs/Image.md) - [ImageResponse](docs/ImageResponse.md) - [Images](docs/Images.md) - [ImagesResponse](docs/ImagesResponse.md) + - [InkAnnotationResponse](docs/InkAnnotationResponse.md) + - [InkAnnotations](docs/InkAnnotations.md) + - [InkAnnotationsResponse](docs/InkAnnotationsResponse.md) - [LineAnnotationResponse](docs/LineAnnotationResponse.md) - [LineAnnotations](docs/LineAnnotations.md) - [LineAnnotationsResponse](docs/LineAnnotationsResponse.md) @@ -388,25 +438,45 @@ Class | Method | HTTP request | Description - [PolygonAnnotationResponse](docs/PolygonAnnotationResponse.md) - [PolygonAnnotations](docs/PolygonAnnotations.md) - [PolygonAnnotationsResponse](docs/PolygonAnnotationsResponse.md) + - [PopupAnnotationResponse](docs/PopupAnnotationResponse.md) + - [PopupAnnotations](docs/PopupAnnotations.md) + - [PopupAnnotationsResponse](docs/PopupAnnotationsResponse.md) - [SignatureVerifyResponse](docs/SignatureVerifyResponse.md) - [SplitResultDocument](docs/SplitResultDocument.md) - [SplitResultResponse](docs/SplitResultResponse.md) - [SquareAnnotationResponse](docs/SquareAnnotationResponse.md) - [SquareAnnotations](docs/SquareAnnotations.md) - [SquareAnnotationsResponse](docs/SquareAnnotationsResponse.md) + - [SquigglyAnnotationResponse](docs/SquigglyAnnotationResponse.md) + - [SquigglyAnnotations](docs/SquigglyAnnotations.md) + - [SquigglyAnnotationsResponse](docs/SquigglyAnnotationsResponse.md) + - [StrikeOutAnnotationResponse](docs/StrikeOutAnnotationResponse.md) + - [StrikeOutAnnotations](docs/StrikeOutAnnotations.md) + - [StrikeOutAnnotationsResponse](docs/StrikeOutAnnotationsResponse.md) - [TextAnnotationResponse](docs/TextAnnotationResponse.md) - [TextAnnotations](docs/TextAnnotations.md) - [TextAnnotationsResponse](docs/TextAnnotationsResponse.md) - [TextRectsResponse](docs/TextRectsResponse.md) - [TextReplaceResponse](docs/TextReplaceResponse.md) + - [UnderlineAnnotationResponse](docs/UnderlineAnnotationResponse.md) + - [UnderlineAnnotations](docs/UnderlineAnnotations.md) + - [UnderlineAnnotationsResponse](docs/UnderlineAnnotationsResponse.md) - [WordCountResponse](docs/WordCountResponse.md) - [AnnotationInfo](docs/AnnotationInfo.md) - [MarkupAnnotation](docs/MarkupAnnotation.md) + - [PopupAnnotation](docs/PopupAnnotation.md) + - [CaretAnnotation](docs/CaretAnnotation.md) - [CommonFigureAnnotation](docs/CommonFigureAnnotation.md) - [FreeTextAnnotation](docs/FreeTextAnnotation.md) + - [HighlightAnnotation](docs/HighlightAnnotation.md) + - [InkAnnotation](docs/InkAnnotation.md) - [LineAnnotation](docs/LineAnnotation.md) - [PolyAnnotation](docs/PolyAnnotation.md) + - [PopupAnnotationWithParent](docs/PopupAnnotationWithParent.md) + - [SquigglyAnnotation](docs/SquigglyAnnotation.md) + - [StrikeOutAnnotation](docs/StrikeOutAnnotation.md) - [TextAnnotation](docs/TextAnnotation.md) + - [UnderlineAnnotation](docs/UnderlineAnnotation.md) - [CircleAnnotation](docs/CircleAnnotation.md) - [PolyLineAnnotation](docs/PolyLineAnnotation.md) - [PolygonAnnotation](docs/PolygonAnnotation.md) diff --git a/asposepdfcloud/__init__.py b/asposepdfcloud/__init__.py index f83ca36..5c8e01d 100644 --- a/asposepdfcloud/__init__.py +++ b/asposepdfcloud/__init__.py @@ -37,7 +37,9 @@ from .models.antialiasing_processing_type import AntialiasingProcessingType from .models.append_document import AppendDocument from .models.aspose_response import AsposeResponse +from .models.cap_style import CapStyle from .models.caption_position import CaptionPosition +from .models.caret_symbol import CaretSymbol from .models.color import Color from .models.color_depth import ColorDepth from .models.compression_type import CompressionType @@ -46,6 +48,7 @@ from .models.document_privilege import DocumentPrivilege from .models.epub_recognition_mode import EpubRecognitionMode from .models.field_type import FieldType +from .models.file import File from .models.font_encoding_rules import FontEncodingRules from .models.font_saving_modes import FontSavingModes from .models.font_styles import FontStyles @@ -103,6 +106,9 @@ from .models.attachment_response import AttachmentResponse from .models.attachments import Attachments from .models.attachments_response import AttachmentsResponse +from .models.caret_annotation_response import CaretAnnotationResponse +from .models.caret_annotations import CaretAnnotations +from .models.caret_annotations_response import CaretAnnotationsResponse from .models.circle_annotation_response import CircleAnnotationResponse from .models.circle_annotations import CircleAnnotations from .models.circle_annotations_response import CircleAnnotationsResponse @@ -118,13 +124,20 @@ from .models.field_response import FieldResponse from .models.fields import Fields from .models.fields_response import FieldsResponse +from .models.files_response import FilesResponse from .models.free_text_annotation_response import FreeTextAnnotationResponse from .models.free_text_annotations import FreeTextAnnotations from .models.free_text_annotations_response import FreeTextAnnotationsResponse +from .models.highlight_annotation_response import HighlightAnnotationResponse +from .models.highlight_annotations import HighlightAnnotations +from .models.highlight_annotations_response import HighlightAnnotationsResponse from .models.image import Image from .models.image_response import ImageResponse from .models.images import Images from .models.images_response import ImagesResponse +from .models.ink_annotation_response import InkAnnotationResponse +from .models.ink_annotations import InkAnnotations +from .models.ink_annotations_response import InkAnnotationsResponse from .models.line_annotation_response import LineAnnotationResponse from .models.line_annotations import LineAnnotations from .models.line_annotations_response import LineAnnotationsResponse @@ -140,25 +153,45 @@ from .models.polygon_annotation_response import PolygonAnnotationResponse from .models.polygon_annotations import PolygonAnnotations from .models.polygon_annotations_response import PolygonAnnotationsResponse +from .models.popup_annotation_response import PopupAnnotationResponse +from .models.popup_annotations import PopupAnnotations +from .models.popup_annotations_response import PopupAnnotationsResponse from .models.signature_verify_response import SignatureVerifyResponse from .models.split_result_document import SplitResultDocument from .models.split_result_response import SplitResultResponse from .models.square_annotation_response import SquareAnnotationResponse from .models.square_annotations import SquareAnnotations from .models.square_annotations_response import SquareAnnotationsResponse +from .models.squiggly_annotation_response import SquigglyAnnotationResponse +from .models.squiggly_annotations import SquigglyAnnotations +from .models.squiggly_annotations_response import SquigglyAnnotationsResponse +from .models.strike_out_annotation_response import StrikeOutAnnotationResponse +from .models.strike_out_annotations import StrikeOutAnnotations +from .models.strike_out_annotations_response import StrikeOutAnnotationsResponse from .models.text_annotation_response import TextAnnotationResponse from .models.text_annotations import TextAnnotations from .models.text_annotations_response import TextAnnotationsResponse from .models.text_rects_response import TextRectsResponse from .models.text_replace_response import TextReplaceResponse +from .models.underline_annotation_response import UnderlineAnnotationResponse +from .models.underline_annotations import UnderlineAnnotations +from .models.underline_annotations_response import UnderlineAnnotationsResponse from .models.word_count_response import WordCountResponse from .models.annotation_info import AnnotationInfo from .models.markup_annotation import MarkupAnnotation +from .models.popup_annotation import PopupAnnotation +from .models.caret_annotation import CaretAnnotation from .models.common_figure_annotation import CommonFigureAnnotation from .models.free_text_annotation import FreeTextAnnotation +from .models.highlight_annotation import HighlightAnnotation +from .models.ink_annotation import InkAnnotation from .models.line_annotation import LineAnnotation from .models.poly_annotation import PolyAnnotation +from .models.popup_annotation_with_parent import PopupAnnotationWithParent +from .models.squiggly_annotation import SquigglyAnnotation +from .models.strike_out_annotation import StrikeOutAnnotation from .models.text_annotation import TextAnnotation +from .models.underline_annotation import UnderlineAnnotation from .models.circle_annotation import CircleAnnotation from .models.poly_line_annotation import PolyLineAnnotation from .models.polygon_annotation import PolygonAnnotation diff --git a/asposepdfcloud/api_client.py b/asposepdfcloud/api_client.py index 430e58c..662f2d1 100644 --- a/asposepdfcloud/api_client.py +++ b/asposepdfcloud/api_client.py @@ -713,27 +713,12 @@ def __deserialize_date(self, string): ) def __deserialize_datatime(self, string): - """ - Deserializes string to datetime. - - The string should be in iso8601 datetime format. - - :param string: str. - :return: datetime. - """ - try: - from dateutil.parser import parse - return parse(string) - except ImportError: - return string - except ValueError: - raise ApiException( - status=0, - reason=( - "Failed to parse `{0}` into a datetime object" - .format(string) - ) - ) + match = re.match(r"\/Date\((\d+?)000\+0000\)\/", string) + if match: + dt = datetime.utcfromtimestamp(int(match[1])) + return dt + else: + return None def __deserialize_model(self, data, klass): """ diff --git a/asposepdfcloud/apis/pdf_api.py b/asposepdfcloud/apis/pdf_api.py index c6758d1..4fefeb4 100644 --- a/asposepdfcloud/apis/pdf_api.py +++ b/asposepdfcloud/apis/pdf_api.py @@ -1345,6 +1345,125 @@ def delete_property_with_http_info(self, name, property_name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_caret_annotation(self, name, annotation_id, **kwargs): + """ + Read document page caret annotation by ID. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_caret_annotation(name, annotation_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: CaretAnnotationResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_caret_annotation_with_http_info(name, annotation_id, **kwargs) + else: + (data) = self.get_caret_annotation_with_http_info(name, annotation_id, **kwargs) + return data + + def get_caret_annotation_with_http_info(self, name, annotation_id, **kwargs): + """ + Read document page caret annotation by ID. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_caret_annotation_with_http_info(name, annotation_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: CaretAnnotationResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'annotation_id', 'storage', 'folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_caret_annotation" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_caret_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_caret_annotation`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] + + query_params = [] + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/annotations/caret/{annotationId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='CaretAnnotationResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_circle_annotation(self, name, annotation_id, **kwargs): """ Read document page circle annotation by ID. @@ -2035,50 +2154,50 @@ def get_document_bookmarks_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document_circle_annotations(self, name, **kwargs): + def get_document_caret_annotations(self, name, **kwargs): """ - Read document circle annotations. + Read document caret annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_circle_annotations(name, callback=callback_function) + >>> thread = api.get_document_caret_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: CircleAnnotationsResponse + :return: CaretAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_circle_annotations_with_http_info(name, **kwargs) + return self.get_document_caret_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_document_circle_annotations_with_http_info(name, **kwargs) + (data) = self.get_document_caret_annotations_with_http_info(name, **kwargs) return data - def get_document_circle_annotations_with_http_info(self, name, **kwargs): + def get_document_caret_annotations_with_http_info(self, name, **kwargs): """ - Read document circle annotations. + Read document caret annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_circle_annotations_with_http_info(name, callback=callback_function) + >>> thread = api.get_document_caret_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: CircleAnnotationsResponse + :return: CaretAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -2094,13 +2213,13 @@ def get_document_circle_annotations_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document_circle_annotations" % key + " to method get_document_caret_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_document_circle_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_document_caret_annotations`") collection_formats = {} @@ -2132,14 +2251,14 @@ def get_document_circle_annotations_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/circle', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/caret', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='CircleAnnotationsResponse', + response_type='CaretAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2147,50 +2266,50 @@ def get_document_circle_annotations_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document_free_text_annotations(self, name, **kwargs): + def get_document_circle_annotations(self, name, **kwargs): """ - Read document free text annotations. + Read document circle annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_free_text_annotations(name, callback=callback_function) + >>> thread = api.get_document_circle_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: FreeTextAnnotationsResponse + :return: CircleAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_free_text_annotations_with_http_info(name, **kwargs) + return self.get_document_circle_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_document_free_text_annotations_with_http_info(name, **kwargs) + (data) = self.get_document_circle_annotations_with_http_info(name, **kwargs) return data - def get_document_free_text_annotations_with_http_info(self, name, **kwargs): + def get_document_circle_annotations_with_http_info(self, name, **kwargs): """ - Read document free text annotations. + Read document circle annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_free_text_annotations_with_http_info(name, callback=callback_function) + >>> thread = api.get_document_circle_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: FreeTextAnnotationsResponse + :return: CircleAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -2206,13 +2325,13 @@ def get_document_free_text_annotations_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document_free_text_annotations" % key + " to method get_document_circle_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_document_free_text_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_document_circle_annotations`") collection_formats = {} @@ -2244,14 +2363,14 @@ def get_document_free_text_annotations_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/freetext', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/circle', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FreeTextAnnotationsResponse', + response_type='CircleAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2259,50 +2378,50 @@ def get_document_free_text_annotations_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document_line_annotations(self, name, **kwargs): + def get_document_free_text_annotations(self, name, **kwargs): """ - Read document line annotations. + Read document free text annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_line_annotations(name, callback=callback_function) + >>> thread = api.get_document_free_text_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: LineAnnotationsResponse + :return: FreeTextAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_line_annotations_with_http_info(name, **kwargs) + return self.get_document_free_text_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_document_line_annotations_with_http_info(name, **kwargs) + (data) = self.get_document_free_text_annotations_with_http_info(name, **kwargs) return data - def get_document_line_annotations_with_http_info(self, name, **kwargs): + def get_document_free_text_annotations_with_http_info(self, name, **kwargs): """ - Read document line annotations. + Read document free text annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_line_annotations_with_http_info(name, callback=callback_function) + >>> thread = api.get_document_free_text_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: LineAnnotationsResponse + :return: FreeTextAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -2318,13 +2437,13 @@ def get_document_line_annotations_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document_line_annotations" % key + " to method get_document_free_text_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_document_line_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_document_free_text_annotations`") collection_formats = {} @@ -2356,14 +2475,14 @@ def get_document_line_annotations_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/line', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/freetext', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='LineAnnotationsResponse', + response_type='FreeTextAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2371,50 +2490,50 @@ def get_document_line_annotations_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document_poly_line_annotations(self, name, **kwargs): + def get_document_highlight_annotations(self, name, **kwargs): """ - Read document polyline annotations. + Read document highlight annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_poly_line_annotations(name, callback=callback_function) + >>> thread = api.get_document_highlight_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: PolyLineAnnotationsResponse + :return: HighlightAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_poly_line_annotations_with_http_info(name, **kwargs) + return self.get_document_highlight_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_document_poly_line_annotations_with_http_info(name, **kwargs) + (data) = self.get_document_highlight_annotations_with_http_info(name, **kwargs) return data - def get_document_poly_line_annotations_with_http_info(self, name, **kwargs): + def get_document_highlight_annotations_with_http_info(self, name, **kwargs): """ - Read document polyline annotations. + Read document highlight annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_poly_line_annotations_with_http_info(name, callback=callback_function) + >>> thread = api.get_document_highlight_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: PolyLineAnnotationsResponse + :return: HighlightAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -2430,13 +2549,13 @@ def get_document_poly_line_annotations_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document_poly_line_annotations" % key + " to method get_document_highlight_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_document_poly_line_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_document_highlight_annotations`") collection_formats = {} @@ -2468,14 +2587,14 @@ def get_document_poly_line_annotations_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/polyline', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/highlight', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PolyLineAnnotationsResponse', + response_type='HighlightAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2483,50 +2602,50 @@ def get_document_poly_line_annotations_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document_polygon_annotations(self, name, **kwargs): + def get_document_ink_annotations(self, name, **kwargs): """ - Read document polygon annotations. + Read document ink annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_polygon_annotations(name, callback=callback_function) + >>> thread = api.get_document_ink_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: PolygonAnnotationsResponse + :return: InkAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_polygon_annotations_with_http_info(name, **kwargs) + return self.get_document_ink_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_document_polygon_annotations_with_http_info(name, **kwargs) + (data) = self.get_document_ink_annotations_with_http_info(name, **kwargs) return data - def get_document_polygon_annotations_with_http_info(self, name, **kwargs): + def get_document_ink_annotations_with_http_info(self, name, **kwargs): """ - Read document polygon annotations. + Read document ink annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_polygon_annotations_with_http_info(name, callback=callback_function) + >>> thread = api.get_document_ink_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: PolygonAnnotationsResponse + :return: InkAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -2542,13 +2661,13 @@ def get_document_polygon_annotations_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document_polygon_annotations" % key + " to method get_document_ink_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_document_polygon_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_document_ink_annotations`") collection_formats = {} @@ -2580,14 +2699,14 @@ def get_document_polygon_annotations_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/polygon', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/ink', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PolygonAnnotationsResponse', + response_type='InkAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2595,50 +2714,50 @@ def get_document_polygon_annotations_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document_properties(self, name, **kwargs): + def get_document_line_annotations(self, name, **kwargs): """ - Read document properties. + Read document line annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_properties(name, callback=callback_function) + >>> thread = api.get_document_line_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: (required) - :param str storage: - :param str folder: - :return: DocumentPropertiesResponse + :param str name: The document name. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: LineAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_properties_with_http_info(name, **kwargs) + return self.get_document_line_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_document_properties_with_http_info(name, **kwargs) + (data) = self.get_document_line_annotations_with_http_info(name, **kwargs) return data - def get_document_properties_with_http_info(self, name, **kwargs): + def get_document_line_annotations_with_http_info(self, name, **kwargs): """ - Read document properties. + Read document line annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_properties_with_http_info(name, callback=callback_function) + >>> thread = api.get_document_line_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: (required) - :param str storage: - :param str folder: - :return: DocumentPropertiesResponse + :param str name: The document name. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: LineAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -2654,13 +2773,13 @@ def get_document_properties_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document_properties" % key + " to method get_document_line_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_document_properties`") + raise ValueError("Missing the required parameter `name` when calling `get_document_line_annotations`") collection_formats = {} @@ -2692,14 +2811,14 @@ def get_document_properties_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/documentproperties', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/line', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentPropertiesResponse', + response_type='LineAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2707,57 +2826,55 @@ def get_document_properties_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document_property(self, name, property_name, **kwargs): + def get_document_poly_line_annotations(self, name, **kwargs): """ - Read document property by name. + Read document polyline annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_property(name, property_name, callback=callback_function) + >>> thread = api.get_document_poly_line_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: (required) - :param str property_name: (required) - :param str storage: - :param str folder: - :return: DocumentPropertyResponse - If the method is called asynchronously, - returns the request thread. - """ + :param str name: The document name. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: PolyLineAnnotationsResponse + If the method is called asynchronously, + returns the request thread. + """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_property_with_http_info(name, property_name, **kwargs) + return self.get_document_poly_line_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_document_property_with_http_info(name, property_name, **kwargs) + (data) = self.get_document_poly_line_annotations_with_http_info(name, **kwargs) return data - def get_document_property_with_http_info(self, name, property_name, **kwargs): + def get_document_poly_line_annotations_with_http_info(self, name, **kwargs): """ - Read document property by name. + Read document polyline annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_property_with_http_info(name, property_name, callback=callback_function) + >>> thread = api.get_document_poly_line_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: (required) - :param str property_name: (required) - :param str storage: - :param str folder: - :return: DocumentPropertyResponse + :param str name: The document name. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: PolyLineAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'property_name', 'storage', 'folder'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -2768,16 +2885,13 @@ def get_document_property_with_http_info(self, name, property_name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document_property" % key + " to method get_document_poly_line_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_document_property`") - # verify the required parameter 'property_name' is set - if ('property_name' not in params) or (params['property_name'] is None): - raise ValueError("Missing the required parameter `property_name` when calling `get_document_property`") + raise ValueError("Missing the required parameter `name` when calling `get_document_poly_line_annotations`") collection_formats = {} @@ -2785,8 +2899,6 @@ def get_document_property_with_http_info(self, name, property_name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'property_name' in params: - path_params['propertyName'] = params['property_name'] query_params = [] if 'storage' in params: @@ -2811,14 +2923,14 @@ def get_document_property_with_http_info(self, name, property_name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/documentproperties/{propertyName}', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/polyline', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentPropertyResponse', + response_type='PolyLineAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2826,50 +2938,50 @@ def get_document_property_with_http_info(self, name, property_name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document_square_annotations(self, name, **kwargs): + def get_document_polygon_annotations(self, name, **kwargs): """ - Read document square annotations. + Read document polygon annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_square_annotations(name, callback=callback_function) + >>> thread = api.get_document_polygon_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SquareAnnotationsResponse + :return: PolygonAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_square_annotations_with_http_info(name, **kwargs) + return self.get_document_polygon_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_document_square_annotations_with_http_info(name, **kwargs) + (data) = self.get_document_polygon_annotations_with_http_info(name, **kwargs) return data - def get_document_square_annotations_with_http_info(self, name, **kwargs): + def get_document_polygon_annotations_with_http_info(self, name, **kwargs): """ - Read document square annotations. + Read document polygon annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_square_annotations_with_http_info(name, callback=callback_function) + >>> thread = api.get_document_polygon_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SquareAnnotationsResponse + :return: PolygonAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -2885,13 +2997,13 @@ def get_document_square_annotations_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document_square_annotations" % key + " to method get_document_polygon_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_document_square_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_document_polygon_annotations`") collection_formats = {} @@ -2923,14 +3035,14 @@ def get_document_square_annotations_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/square', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/polygon', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SquareAnnotationsResponse', + response_type='PolygonAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2938,50 +3050,50 @@ def get_document_square_annotations_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document_text_annotations(self, name, **kwargs): + def get_document_popup_annotations(self, name, **kwargs): """ - Read document text annotations. + Read document popup annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_text_annotations(name, callback=callback_function) + >>> thread = api.get_document_popup_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: TextAnnotationsResponse + :return: PopupAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_text_annotations_with_http_info(name, **kwargs) + return self.get_document_popup_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_document_text_annotations_with_http_info(name, **kwargs) + (data) = self.get_document_popup_annotations_with_http_info(name, **kwargs) return data - def get_document_text_annotations_with_http_info(self, name, **kwargs): + def get_document_popup_annotations_with_http_info(self, name, **kwargs): """ - Read document text annotations. + Read document popup annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_document_text_annotations_with_http_info(name, callback=callback_function) + >>> thread = api.get_document_popup_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: TextAnnotationsResponse + :return: PopupAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -2997,13 +3109,13 @@ def get_document_text_annotations_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_document_text_annotations" % key + " to method get_document_popup_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_document_text_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_document_popup_annotations`") collection_formats = {} @@ -3035,14 +3147,14 @@ def get_document_text_annotations_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/text', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/popup', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TextAnnotationsResponse', + response_type='PopupAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3050,55 +3162,57 @@ def get_document_text_annotations_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_download(self, path, **kwargs): + def get_document_popup_annotations_by_parent(self, name, annotation_id, **kwargs): """ - Download a specific file + Read document popup annotations by parent id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_download(path, callback=callback_function) + >>> thread = api.get_document_popup_annotations_by_parent(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str path: Path of the file including the file name and extension e.g. /file.ext (required) - :param str version_id: File's version - :param str storage: User's storage name - :return: file + :param str name: The document name. (required) + :param str annotation_id: The parent annotation ID. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: PopupAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_download_with_http_info(path, **kwargs) + return self.get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_download_with_http_info(path, **kwargs) + (data) = self.get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, **kwargs) return data - def get_download_with_http_info(self, path, **kwargs): + def get_document_popup_annotations_by_parent_with_http_info(self, name, annotation_id, **kwargs): """ - Download a specific file + Read document popup annotations by parent id. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_download_with_http_info(path, callback=callback_function) + >>> thread = api.get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str path: Path of the file including the file name and extension e.g. /file.ext (required) - :param str version_id: File's version - :param str storage: User's storage name - :return: file + :param str name: The document name. (required) + :param str annotation_id: The parent annotation ID. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: PopupAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['path', 'version_id', 'storage'] + all_params = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3109,26 +3223,31 @@ def get_download_with_http_info(self, path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_download" % key + " to method get_document_popup_annotations_by_parent" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'path' is set - if ('path' not in params) or (params['path'] is None): - raise ValueError("Missing the required parameter `path` when calling `get_download`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_document_popup_annotations_by_parent`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_document_popup_annotations_by_parent`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'path' in params: - query_params.append(('path', params['path'])) - if 'version_id' in params: - query_params.append(('versionId', params['version_id'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -3138,7 +3257,7 @@ def get_download_with_http_info(self, path, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -3147,14 +3266,14 @@ def get_download_with_http_info(self, path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/storage/file', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/{annotationId}/popup', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='PopupAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3162,57 +3281,55 @@ def get_download_with_http_info(self, path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_download_document_attachment_by_index(self, name, attachment_index, **kwargs): + def get_document_properties(self, name, **kwargs): """ - Download document attachment content by its index. + Read document properties. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_download_document_attachment_by_index(name, attachment_index, callback=callback_function) + >>> thread = api.get_document_properties(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int attachment_index: The attachment index. (required) - :param str storage: The document storage. - :param str folder: The document folder. - :return: file + :param str name: (required) + :param str storage: + :param str folder: + :return: DocumentPropertiesResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_download_document_attachment_by_index_with_http_info(name, attachment_index, **kwargs) + return self.get_document_properties_with_http_info(name, **kwargs) else: - (data) = self.get_download_document_attachment_by_index_with_http_info(name, attachment_index, **kwargs) + (data) = self.get_document_properties_with_http_info(name, **kwargs) return data - def get_download_document_attachment_by_index_with_http_info(self, name, attachment_index, **kwargs): + def get_document_properties_with_http_info(self, name, **kwargs): """ - Download document attachment content by its index. + Read document properties. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_download_document_attachment_by_index_with_http_info(name, attachment_index, callback=callback_function) + >>> thread = api.get_document_properties_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int attachment_index: The attachment index. (required) - :param str storage: The document storage. - :param str folder: The document folder. - :return: file + :param str name: (required) + :param str storage: + :param str folder: + :return: DocumentPropertiesResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'attachment_index', 'storage', 'folder'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3223,16 +3340,13 @@ def get_download_document_attachment_by_index_with_http_info(self, name, attachm if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_download_document_attachment_by_index" % key + " to method get_document_properties" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_download_document_attachment_by_index`") - # verify the required parameter 'attachment_index' is set - if ('attachment_index' not in params) or (params['attachment_index'] is None): - raise ValueError("Missing the required parameter `attachment_index` when calling `get_download_document_attachment_by_index`") + raise ValueError("Missing the required parameter `name` when calling `get_document_properties`") collection_formats = {} @@ -3240,8 +3354,6 @@ def get_download_document_attachment_by_index_with_http_info(self, name, attachm path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'attachment_index' in params: - path_params['attachmentIndex'] = params['attachment_index'] query_params = [] if 'storage' in params: @@ -3257,7 +3369,7 @@ def get_download_document_attachment_by_index_with_http_info(self, name, attachm body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -3266,14 +3378,14 @@ def get_download_document_attachment_by_index_with_http_info(self, name, attachm # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/attachments/{attachmentIndex}/download', 'GET', + return self.api_client.call_api('/pdf/{name}/documentproperties', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='DocumentPropertiesResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3281,53 +3393,57 @@ def get_download_document_attachment_by_index_with_http_info(self, name, attachm _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_epub_in_storage_to_pdf(self, src_path, **kwargs): + def get_document_property(self, name, property_name, **kwargs): """ - Convert EPUB file (located on storage) to PDF format and return resulting file in response. + Read document property by name. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_epub_in_storage_to_pdf(src_path, callback=callback_function) + >>> thread = api.get_document_property(name, property_name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required) - :param str storage: The document storage. - :return: file + :param str name: (required) + :param str property_name: (required) + :param str storage: + :param str folder: + :return: DocumentPropertyResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_epub_in_storage_to_pdf_with_http_info(src_path, **kwargs) + return self.get_document_property_with_http_info(name, property_name, **kwargs) else: - (data) = self.get_epub_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_document_property_with_http_info(name, property_name, **kwargs) return data - def get_epub_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_document_property_with_http_info(self, name, property_name, **kwargs): """ - Convert EPUB file (located on storage) to PDF format and return resulting file in response. + Read document property by name. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_epub_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) + >>> thread = api.get_document_property_with_http_info(name, property_name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required) - :param str storage: The document storage. - :return: file + :param str name: (required) + :param str property_name: (required) + :param str storage: + :param str folder: + :return: DocumentPropertyResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['src_path', 'storage'] + all_params = ['name', 'property_name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3338,24 +3454,31 @@ def get_epub_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_epub_in_storage_to_pdf" % key + " to method get_document_property" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `get_epub_in_storage_to_pdf`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_document_property`") + # verify the required parameter 'property_name' is set + if ('property_name' not in params) or (params['property_name'] is None): + raise ValueError("Missing the required parameter `property_name` when calling `get_document_property`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'property_name' in params: + path_params['propertyName'] = params['property_name'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -3365,7 +3488,7 @@ def get_epub_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -3374,14 +3497,14 @@ def get_epub_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/create/epub', 'GET', + return self.api_client.call_api('/pdf/{name}/documentproperties/{propertyName}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='DocumentPropertyResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3389,57 +3512,55 @@ def get_epub_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_field(self, name, field_name, **kwargs): + def get_document_square_annotations(self, name, **kwargs): """ - Get document field by name. + Read document square annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_field(name, field_name, callback=callback_function) + >>> thread = api.get_document_square_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str field_name: The field name/ (required) :param str storage: The document storage. :param str folder: The document folder. - :return: FieldResponse + :return: SquareAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_field_with_http_info(name, field_name, **kwargs) + return self.get_document_square_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_field_with_http_info(name, field_name, **kwargs) + (data) = self.get_document_square_annotations_with_http_info(name, **kwargs) return data - def get_field_with_http_info(self, name, field_name, **kwargs): + def get_document_square_annotations_with_http_info(self, name, **kwargs): """ - Get document field by name. + Read document square annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_field_with_http_info(name, field_name, callback=callback_function) + >>> thread = api.get_document_square_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str field_name: The field name/ (required) :param str storage: The document storage. :param str folder: The document folder. - :return: FieldResponse + :return: SquareAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'field_name', 'storage', 'folder'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3450,16 +3571,13 @@ def get_field_with_http_info(self, name, field_name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_field" % key + " to method get_document_square_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_field`") - # verify the required parameter 'field_name' is set - if ('field_name' not in params) or (params['field_name'] is None): - raise ValueError("Missing the required parameter `field_name` when calling `get_field`") + raise ValueError("Missing the required parameter `name` when calling `get_document_square_annotations`") collection_formats = {} @@ -3467,8 +3585,6 @@ def get_field_with_http_info(self, name, field_name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'field_name' in params: - path_params['fieldName'] = params['field_name'] query_params = [] if 'storage' in params: @@ -3493,14 +3609,14 @@ def get_field_with_http_info(self, name, field_name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/fields/{fieldName}', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/square', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FieldResponse', + response_type='SquareAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3508,50 +3624,50 @@ def get_field_with_http_info(self, name, field_name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_fields(self, name, **kwargs): + def get_document_squiggly_annotations(self, name, **kwargs): """ - Get document fields. + Read document squiggly annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_fields(name, callback=callback_function) + >>> thread = api.get_document_squiggly_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: FieldsResponse + :return: SquigglyAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_fields_with_http_info(name, **kwargs) + return self.get_document_squiggly_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_fields_with_http_info(name, **kwargs) + (data) = self.get_document_squiggly_annotations_with_http_info(name, **kwargs) return data - def get_fields_with_http_info(self, name, **kwargs): + def get_document_squiggly_annotations_with_http_info(self, name, **kwargs): """ - Get document fields. + Read document squiggly annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_fields_with_http_info(name, callback=callback_function) + >>> thread = api.get_document_squiggly_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: FieldsResponse + :return: SquigglyAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -3567,13 +3683,13 @@ def get_fields_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_fields" % key + " to method get_document_squiggly_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_fields`") + raise ValueError("Missing the required parameter `name` when calling `get_document_squiggly_annotations`") collection_formats = {} @@ -3605,14 +3721,14 @@ def get_fields_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/fields', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/squiggly', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FieldsResponse', + response_type='SquigglyAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3620,57 +3736,55 @@ def get_fields_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_free_text_annotation(self, name, annotation_id, **kwargs): + def get_document_strike_out_annotations(self, name, **kwargs): """ - Read document page free text annotation by ID. + Read document StrikeOut annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_free_text_annotation(name, annotation_id, callback=callback_function) + >>> thread = api.get_document_strike_out_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: FreeTextAnnotationResponse + :return: StrikeOutAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_free_text_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_document_strike_out_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_free_text_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_document_strike_out_annotations_with_http_info(name, **kwargs) return data - def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_document_strike_out_annotations_with_http_info(self, name, **kwargs): """ - Read document page free text annotation by ID. + Read document StrikeOut annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_free_text_annotation_with_http_info(name, annotation_id, callback=callback_function) + >>> thread = api.get_document_strike_out_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: FreeTextAnnotationResponse + :return: StrikeOutAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'storage', 'folder'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3681,16 +3795,13 @@ def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs) if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_free_text_annotation" % key + " to method get_document_strike_out_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_free_text_annotation`") - # verify the required parameter 'annotation_id' is set - if ('annotation_id' not in params) or (params['annotation_id'] is None): - raise ValueError("Missing the required parameter `annotation_id` when calling `get_free_text_annotation`") + raise ValueError("Missing the required parameter `name` when calling `get_document_strike_out_annotations`") collection_formats = {} @@ -3698,8 +3809,6 @@ def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs) path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'annotation_id' in params: - path_params['annotationId'] = params['annotation_id'] query_params = [] if 'storage' in params: @@ -3724,14 +3833,14 @@ def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/freetext/{annotationId}', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/strikeout', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FreeTextAnnotationResponse', + response_type='StrikeOutAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3739,69 +3848,55 @@ def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs) _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_html_in_storage_to_pdf(self, src_path, html_file_name, **kwargs): + def get_document_text_annotations(self, name, **kwargs): """ - Convert HTML file (located on storage) to PDF format and return resulting file in response. + Read document text annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_html_in_storage_to_pdf(src_path, html_file_name, callback=callback_function) + >>> thread = api.get_document_text_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.zip) (required) - :param str html_file_name: Name of HTML file in ZIP. (required) - :param float height: Page height - :param float width: Page width - :param bool is_landscape: Is page landscaped - :param float margin_left: Page margin left - :param float margin_bottom: Page margin bottom - :param float margin_right: Page margin right - :param float margin_top: Page margin top + :param str name: The document name. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: TextAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_html_in_storage_to_pdf_with_http_info(src_path, html_file_name, **kwargs) + return self.get_document_text_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_html_in_storage_to_pdf_with_http_info(src_path, html_file_name, **kwargs) + (data) = self.get_document_text_annotations_with_http_info(name, **kwargs) return data - def get_html_in_storage_to_pdf_with_http_info(self, src_path, html_file_name, **kwargs): + def get_document_text_annotations_with_http_info(self, name, **kwargs): """ - Convert HTML file (located on storage) to PDF format and return resulting file in response. + Read document text annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_html_in_storage_to_pdf_with_http_info(src_path, html_file_name, callback=callback_function) + >>> thread = api.get_document_text_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.zip) (required) - :param str html_file_name: Name of HTML file in ZIP. (required) - :param float height: Page height - :param float width: Page width - :param bool is_landscape: Is page landscaped - :param float margin_left: Page margin left - :param float margin_bottom: Page margin bottom - :param float margin_right: Page margin right - :param float margin_top: Page margin top + :param str name: The document name. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: TextAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['src_path', 'html_file_name', 'height', 'width', 'is_landscape', 'margin_left', 'margin_bottom', 'margin_right', 'margin_top', 'storage'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3812,43 +3907,26 @@ def get_html_in_storage_to_pdf_with_http_info(self, src_path, html_file_name, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_html_in_storage_to_pdf" % key + " to method get_document_text_annotations" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `get_html_in_storage_to_pdf`") - # verify the required parameter 'html_file_name' is set - if ('html_file_name' not in params) or (params['html_file_name'] is None): - raise ValueError("Missing the required parameter `html_file_name` when calling `get_html_in_storage_to_pdf`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_document_text_annotations`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) - if 'html_file_name' in params: - query_params.append(('htmlFileName', params['html_file_name'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'width' in params: - query_params.append(('width', params['width'])) - if 'is_landscape' in params: - query_params.append(('isLandscape', params['is_landscape'])) - if 'margin_left' in params: - query_params.append(('marginLeft', params['margin_left'])) - if 'margin_bottom' in params: - query_params.append(('marginBottom', params['margin_bottom'])) - if 'margin_right' in params: - query_params.append(('marginRight', params['margin_right'])) - if 'margin_top' in params: - query_params.append(('marginTop', params['margin_top'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -3858,7 +3936,7 @@ def get_html_in_storage_to_pdf_with_http_info(self, src_path, html_file_name, ** body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -3867,14 +3945,14 @@ def get_html_in_storage_to_pdf_with_http_info(self, src_path, html_file_name, ** # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/create/html', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/text', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='TextAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3882,57 +3960,55 @@ def get_html_in_storage_to_pdf_with_http_info(self, src_path, html_file_name, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_image(self, name, image_id, **kwargs): + def get_document_underline_annotations(self, name, **kwargs): """ - Read document image by ID. + Read document underline annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_image(name, image_id, callback=callback_function) + >>> thread = api.get_document_underline_annotations(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: ImageResponse + :return: UnderlineAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_image_with_http_info(name, image_id, **kwargs) + return self.get_document_underline_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_image_with_http_info(name, image_id, **kwargs) + (data) = self.get_document_underline_annotations_with_http_info(name, **kwargs) return data - def get_image_with_http_info(self, name, image_id, **kwargs): + def get_document_underline_annotations_with_http_info(self, name, **kwargs): """ - Read document image by ID. + Read document underline annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_image_with_http_info(name, image_id, callback=callback_function) + >>> thread = api.get_document_underline_annotations_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: ImageResponse + :return: UnderlineAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_id', 'storage', 'folder'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -3943,16 +4019,13 @@ def get_image_with_http_info(self, name, image_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_image" % key + " to method get_document_underline_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_image`") - # verify the required parameter 'image_id' is set - if ('image_id' not in params) or (params['image_id'] is None): - raise ValueError("Missing the required parameter `image_id` when calling `get_image`") + raise ValueError("Missing the required parameter `name` when calling `get_document_underline_annotations`") collection_formats = {} @@ -3960,8 +4033,6 @@ def get_image_with_http_info(self, name, image_id, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'image_id' in params: - path_params['imageId'] = params['image_id'] query_params = [] if 'storage' in params: @@ -3986,14 +4057,14 @@ def get_image_with_http_info(self, name, image_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/images/{imageId}', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/underline', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ImageResponse', + response_type='UnderlineAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4001,61 +4072,55 @@ def get_image_with_http_info(self, name, image_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_image_extract_as_gif(self, name, image_id, **kwargs): + def get_download(self, path, **kwargs): """ - Extract document image in GIF format + Download a specific file This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_image_extract_as_gif(name, image_id, callback=callback_function) + >>> thread = api.get_download(path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str storage: The document storage. - :param str folder: The document folder. + :param str path: Path of the file including the file name and extension e.g. /file.ext (required) + :param str version_id: File's version + :param str storage: User's storage name :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_image_extract_as_gif_with_http_info(name, image_id, **kwargs) + return self.get_download_with_http_info(path, **kwargs) else: - (data) = self.get_image_extract_as_gif_with_http_info(name, image_id, **kwargs) + (data) = self.get_download_with_http_info(path, **kwargs) return data - def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): + def get_download_with_http_info(self, path, **kwargs): """ - Extract document image in GIF format + Download a specific file This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_image_extract_as_gif_with_http_info(name, image_id, callback=callback_function) + >>> thread = api.get_download_with_http_info(path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str storage: The document storage. - :param str folder: The document folder. + :param str path: Path of the file including the file name and extension e.g. /file.ext (required) + :param str version_id: File's version + :param str storage: User's storage name :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder'] + all_params = ['path', 'version_id', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4066,35 +4131,26 @@ def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_image_extract_as_gif" % key + " to method get_download" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_gif`") - # verify the required parameter 'image_id' is set - if ('image_id' not in params) or (params['image_id'] is None): - raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_gif`") + # verify the required parameter 'path' is set + if ('path' not in params) or (params['path'] is None): + raise ValueError("Missing the required parameter `path` when calling `get_download`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - if 'image_id' in params: - path_params['imageId'] = params['image_id'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) + if 'path' in params: + query_params.append(('path', params['path'])) + if 'version_id' in params: + query_params.append(('versionId', params['version_id'])) if 'storage' in params: query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) header_params = {} @@ -4104,7 +4160,7 @@ def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -4113,7 +4169,7 @@ def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/gif', 'GET', + return self.api_client.call_api('/storage/file', 'GET', path_params, query_params, header_params, @@ -4128,23 +4184,21 @@ def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_image_extract_as_jpeg(self, name, image_id, **kwargs): + def get_download_document_attachment_by_index(self, name, attachment_index, **kwargs): """ - Extract document image in JPEG format + Download document attachment content by its index. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_image_extract_as_jpeg(name, image_id, callback=callback_function) + >>> thread = api.get_download_document_attachment_by_index(name, attachment_index, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param int attachment_index: The attachment index. (required) :param str storage: The document storage. :param str folder: The document folder. :return: file @@ -4153,28 +4207,26 @@ def get_image_extract_as_jpeg(self, name, image_id, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs) + return self.get_download_document_attachment_by_index_with_http_info(name, attachment_index, **kwargs) else: - (data) = self.get_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs) + (data) = self.get_download_document_attachment_by_index_with_http_info(name, attachment_index, **kwargs) return data - def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): + def get_download_document_attachment_by_index_with_http_info(self, name, attachment_index, **kwargs): """ - Extract document image in JPEG format + Download document attachment content by its index. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_image_extract_as_jpeg_with_http_info(name, image_id, callback=callback_function) + >>> thread = api.get_download_document_attachment_by_index_with_http_info(name, attachment_index, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param int attachment_index: The attachment index. (required) :param str storage: The document storage. :param str folder: The document folder. :return: file @@ -4182,7 +4234,7 @@ def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): returns the request thread. """ - all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder'] + all_params = ['name', 'attachment_index', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4193,16 +4245,16 @@ def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_image_extract_as_jpeg" % key + " to method get_download_document_attachment_by_index" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_jpeg`") - # verify the required parameter 'image_id' is set - if ('image_id' not in params) or (params['image_id'] is None): - raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_jpeg`") + raise ValueError("Missing the required parameter `name` when calling `get_download_document_attachment_by_index`") + # verify the required parameter 'attachment_index' is set + if ('attachment_index' not in params) or (params['attachment_index'] is None): + raise ValueError("Missing the required parameter `attachment_index` when calling `get_download_document_attachment_by_index`") collection_formats = {} @@ -4210,14 +4262,10 @@ def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'image_id' in params: - path_params['imageId'] = params['image_id'] - + if 'attachment_index' in params: + path_params['attachmentIndex'] = params['attachment_index'] + query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -4231,7 +4279,7 @@ def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -4240,7 +4288,7 @@ def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/jpeg', 'GET', + return self.api_client.call_api('/pdf/{name}/attachments/{attachmentIndex}/download', 'GET', path_params, query_params, header_params, @@ -4255,61 +4303,53 @@ def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_image_extract_as_png(self, name, image_id, **kwargs): + def get_epub_in_storage_to_pdf(self, src_path, **kwargs): """ - Extract document image in PNG format + Convert EPUB file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_image_extract_as_png(name, image_id, callback=callback_function) + >>> thread = api.get_epub_in_storage_to_pdf(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required) :param str storage: The document storage. - :param str folder: The document folder. :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_image_extract_as_png_with_http_info(name, image_id, **kwargs) + return self.get_epub_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.get_image_extract_as_png_with_http_info(name, image_id, **kwargs) + (data) = self.get_epub_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def get_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): + def get_epub_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Extract document image in PNG format + Convert EPUB file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_image_extract_as_png_with_http_info(name, image_id, callback=callback_function) + >>> thread = api.get_epub_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required) :param str storage: The document storage. - :param str folder: The document folder. :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder'] + all_params = ['src_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4320,35 +4360,24 @@ def get_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_image_extract_as_png" % key + " to method get_epub_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_png`") - # verify the required parameter 'image_id' is set - if ('image_id' not in params) or (params['image_id'] is None): - raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_png`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `get_epub_in_storage_to_pdf`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - if 'image_id' in params: - path_params['imageId'] = params['image_id'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) header_params = {} @@ -4358,7 +4387,7 @@ def get_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -4367,7 +4396,7 @@ def get_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/png', 'GET', + return self.api_client.call_api('/pdf/create/epub', 'GET', path_params, query_params, header_params, @@ -4382,61 +4411,57 @@ def get_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_image_extract_as_tiff(self, name, image_id, **kwargs): + def get_field(self, name, field_name, **kwargs): """ - Extract document image in TIFF format + Get document field by name. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_image_extract_as_tiff(name, image_id, callback=callback_function) + >>> thread = api.get_field(name, field_name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param str field_name: The field name/ (required) :param str storage: The document storage. :param str folder: The document folder. - :return: file + :return: FieldResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_image_extract_as_tiff_with_http_info(name, image_id, **kwargs) + return self.get_field_with_http_info(name, field_name, **kwargs) else: - (data) = self.get_image_extract_as_tiff_with_http_info(name, image_id, **kwargs) + (data) = self.get_field_with_http_info(name, field_name, **kwargs) return data - def get_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): + def get_field_with_http_info(self, name, field_name, **kwargs): """ - Extract document image in TIFF format + Get document field by name. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_image_extract_as_tiff_with_http_info(name, image_id, callback=callback_function) + >>> thread = api.get_field_with_http_info(name, field_name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param str field_name: The field name/ (required) :param str storage: The document storage. :param str folder: The document folder. - :return: file + :return: FieldResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder'] + all_params = ['name', 'field_name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4447,16 +4472,16 @@ def get_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_image_extract_as_tiff" % key + " to method get_field" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_tiff`") - # verify the required parameter 'image_id' is set - if ('image_id' not in params) or (params['image_id'] is None): - raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_tiff`") + raise ValueError("Missing the required parameter `name` when calling `get_field`") + # verify the required parameter 'field_name' is set + if ('field_name' not in params) or (params['field_name'] is None): + raise ValueError("Missing the required parameter `field_name` when calling `get_field`") collection_formats = {} @@ -4464,14 +4489,10 @@ def get_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'image_id' in params: - path_params['imageId'] = params['image_id'] + if 'field_name' in params: + path_params['fieldName'] = params['field_name'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -4494,14 +4515,14 @@ def get_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/tiff', 'GET', + return self.api_client.call_api('/pdf/{name}/fields/{fieldName}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='FieldResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4509,57 +4530,55 @@ def get_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_images(self, name, page_number, **kwargs): + def get_fields(self, name, **kwargs): """ - Read document images. + Get document fields. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_images(name, page_number, callback=callback_function) + >>> thread = api.get_fields(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: ImagesResponse + :return: FieldsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_images_with_http_info(name, page_number, **kwargs) + return self.get_fields_with_http_info(name, **kwargs) else: - (data) = self.get_images_with_http_info(name, page_number, **kwargs) + (data) = self.get_fields_with_http_info(name, **kwargs) return data - def get_images_with_http_info(self, name, page_number, **kwargs): + def get_fields_with_http_info(self, name, **kwargs): """ - Read document images. + Get document fields. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_images_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_fields_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: ImagesResponse + :return: FieldsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'storage', 'folder'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4570,16 +4589,13 @@ def get_images_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_images" % key + " to method get_fields" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_images`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_images`") + raise ValueError("Missing the required parameter `name` when calling `get_fields`") collection_formats = {} @@ -4587,8 +4603,6 @@ def get_images_with_http_info(self, name, page_number, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] if 'storage' in params: @@ -4613,14 +4627,14 @@ def get_images_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images', 'GET', + return self.api_client.call_api('/pdf/{name}/fields', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ImagesResponse', + response_type='FieldsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4628,53 +4642,57 @@ def get_images_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_la_te_x_in_storage_to_pdf(self, src_path, **kwargs): + def get_free_text_annotation(self, name, annotation_id, **kwargs): """ - Convert LaTeX file (located on storage) to PDF format and return resulting file in response. + Read document page free text annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_la_te_x_in_storage_to_pdf(src_path, callback=callback_function) + >>> thread = api.get_free_text_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.tex) (required) + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: FreeTextAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_la_te_x_in_storage_to_pdf_with_http_info(src_path, **kwargs) + return self.get_free_text_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_la_te_x_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_free_text_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_la_te_x_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Convert LaTeX file (located on storage) to PDF format and return resulting file in response. + Read document page free text annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_la_te_x_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) + >>> thread = api.get_free_text_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.tex) (required) + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: FreeTextAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['src_path', 'storage'] + all_params = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4685,24 +4703,31 @@ def get_la_te_x_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_la_te_x_in_storage_to_pdf" % key + " to method get_free_text_annotation" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `get_la_te_x_in_storage_to_pdf`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_free_text_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_free_text_annotation`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -4712,7 +4737,7 @@ def get_la_te_x_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -4721,14 +4746,14 @@ def get_la_te_x_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/create/latex', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/freetext/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='FreeTextAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4736,16 +4761,16 @@ def get_la_te_x_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_line_annotation(self, name, annotation_id, **kwargs): + def get_highlight_annotation(self, name, annotation_id, **kwargs): """ - Read document page line annotation by ID. + Read document page highlight annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_line_annotation(name, annotation_id, callback=callback_function) + >>> thread = api.get_highlight_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -4753,27 +4778,27 @@ def get_line_annotation(self, name, annotation_id, **kwargs): :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: LineAnnotationResponse + :return: HighlightAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_line_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_highlight_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_line_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_highlight_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_line_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_highlight_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Read document page line annotation by ID. + Read document page highlight annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_line_annotation_with_http_info(name, annotation_id, callback=callback_function) + >>> thread = api.get_highlight_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -4781,7 +4806,7 @@ def get_line_annotation_with_http_info(self, name, annotation_id, **kwargs): :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: LineAnnotationResponse + :return: HighlightAnnotationResponse If the method is called asynchronously, returns the request thread. """ @@ -4797,16 +4822,16 @@ def get_line_annotation_with_http_info(self, name, annotation_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_line_annotation" % key + " to method get_highlight_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_line_annotation`") + raise ValueError("Missing the required parameter `name` when calling `get_highlight_annotation`") # verify the required parameter 'annotation_id' is set if ('annotation_id' not in params) or (params['annotation_id'] is None): - raise ValueError("Missing the required parameter `annotation_id` when calling `get_line_annotation`") + raise ValueError("Missing the required parameter `annotation_id` when calling `get_highlight_annotation`") collection_formats = {} @@ -4840,14 +4865,14 @@ def get_line_annotation_with_http_info(self, name, annotation_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/line/{annotationId}', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/highlight/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='LineAnnotationResponse', + response_type='HighlightAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4855,57 +4880,69 @@ def get_line_annotation_with_http_info(self, name, annotation_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_link_annotation(self, name, link_id, **kwargs): + def get_html_in_storage_to_pdf(self, src_path, **kwargs): """ - Read document link annotation by ID. + Convert HTML file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_link_annotation(name, link_id, callback=callback_function) + >>> thread = api.get_html_in_storage_to_pdf(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param str link_id: The link ID. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.zip) (required) + :param str html_file_name: Name of HTML file in ZIP. + :param float height: Page height + :param float width: Page width + :param bool is_landscape: Is page landscaped + :param float margin_left: Page margin left + :param float margin_bottom: Page margin bottom + :param float margin_right: Page margin right + :param float margin_top: Page margin top :param str storage: The document storage. - :param str folder: The document folder. - :return: LinkAnnotationResponse + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_link_annotation_with_http_info(name, link_id, **kwargs) + return self.get_html_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.get_link_annotation_with_http_info(name, link_id, **kwargs) + (data) = self.get_html_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def get_link_annotation_with_http_info(self, name, link_id, **kwargs): + def get_html_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Read document link annotation by ID. + Convert HTML file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_link_annotation_with_http_info(name, link_id, callback=callback_function) + >>> thread = api.get_html_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param str link_id: The link ID. (required) - :param str storage: The document storage. - :param str folder: The document folder. - :return: LinkAnnotationResponse - If the method is called asynchronously, + :param str src_path: Full source filename (ex. /folder1/folder2/template.zip) (required) + :param str html_file_name: Name of HTML file in ZIP. + :param float height: Page height + :param float width: Page width + :param bool is_landscape: Is page landscaped + :param float margin_left: Page margin left + :param float margin_bottom: Page margin bottom + :param float margin_right: Page margin right + :param float margin_top: Page margin top + :param str storage: The document storage. + :return: file + If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'link_id', 'storage', 'folder'] + all_params = ['src_path', 'html_file_name', 'height', 'width', 'is_landscape', 'margin_left', 'margin_bottom', 'margin_right', 'margin_top', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4916,31 +4953,40 @@ def get_link_annotation_with_http_info(self, name, link_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_link_annotation" % key + " to method get_html_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_link_annotation`") - # verify the required parameter 'link_id' is set - if ('link_id' not in params) or (params['link_id'] is None): - raise ValueError("Missing the required parameter `link_id` when calling `get_link_annotation`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `get_html_in_storage_to_pdf`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - if 'link_id' in params: - path_params['linkId'] = params['link_id'] query_params = [] + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) + if 'html_file_name' in params: + query_params.append(('htmlFileName', params['html_file_name'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'is_landscape' in params: + query_params.append(('isLandscape', params['is_landscape'])) + if 'margin_left' in params: + query_params.append(('marginLeft', params['margin_left'])) + if 'margin_bottom' in params: + query_params.append(('marginBottom', params['margin_bottom'])) + if 'margin_right' in params: + query_params.append(('marginRight', params['margin_right'])) + if 'margin_top' in params: + query_params.append(('marginTop', params['margin_top'])) if 'storage' in params: query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) header_params = {} @@ -4950,7 +4996,7 @@ def get_link_annotation_with_http_info(self, name, link_id, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -4959,14 +5005,14 @@ def get_link_annotation_with_http_info(self, name, link_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/links/{linkId}', 'GET', + return self.api_client.call_api('/pdf/create/html', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='LinkAnnotationResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4974,53 +5020,57 @@ def get_link_annotation_with_http_info(self, name, link_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_mht_in_storage_to_pdf(self, src_path, **kwargs): + def get_image(self, name, image_id, **kwargs): """ - Convert MHT file (located on storage) to PDF format and return resulting file in response. + Read document image by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_mht_in_storage_to_pdf(src_path, callback=callback_function) + >>> thread = api.get_image(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.mht) (required) + :param str name: The document name. (required) + :param str image_id: Image ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: ImageResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_mht_in_storage_to_pdf_with_http_info(src_path, **kwargs) + return self.get_image_with_http_info(name, image_id, **kwargs) else: - (data) = self.get_mht_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_image_with_http_info(name, image_id, **kwargs) return data - def get_mht_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_image_with_http_info(self, name, image_id, **kwargs): """ - Convert MHT file (located on storage) to PDF format and return resulting file in response. + Read document image by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_mht_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) + >>> thread = api.get_image_with_http_info(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.mht) (required) + :param str name: The document name. (required) + :param str image_id: Image ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: ImageResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['src_path', 'storage'] + all_params = ['name', 'image_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5031,24 +5081,31 @@ def get_mht_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_mht_in_storage_to_pdf" % key + " to method get_image" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `get_mht_in_storage_to_pdf`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_image`") + # verify the required parameter 'image_id' is set + if ('image_id' not in params) or (params['image_id'] is None): + raise ValueError("Missing the required parameter `image_id` when calling `get_image`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'image_id' in params: + path_params['imageId'] = params['image_id'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -5058,7 +5115,7 @@ def get_mht_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -5067,14 +5124,14 @@ def get_mht_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/create/mht', 'GET', + return self.api_client.call_api('/pdf/{name}/images/{imageId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='ImageResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5082,57 +5139,61 @@ def get_mht_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page(self, name, page_number, **kwargs): + def get_image_extract_as_gif(self, name, image_id, **kwargs): """ - Read document page info. + Extract document image in GIF format This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page(name, page_number, callback=callback_function) + >>> thread = api.get_image_extract_as_gif(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str storage: The document storage. :param str folder: The document folder. - :return: DocumentPageResponse + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_with_http_info(name, page_number, **kwargs) + return self.get_image_extract_as_gif_with_http_info(name, image_id, **kwargs) else: - (data) = self.get_page_with_http_info(name, page_number, **kwargs) + (data) = self.get_image_extract_as_gif_with_http_info(name, image_id, **kwargs) return data - def get_page_with_http_info(self, name, page_number, **kwargs): + def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): """ - Read document page info. + Extract document image in GIF format This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_image_extract_as_gif_with_http_info(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str storage: The document storage. :param str folder: The document folder. - :return: DocumentPageResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'storage', 'folder'] + all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5143,16 +5204,16 @@ def get_page_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page" % key + " to method get_image_extract_as_gif" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page`") + raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_gif`") + # verify the required parameter 'image_id' is set + if ('image_id' not in params) or (params['image_id'] is None): + raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_gif`") collection_formats = {} @@ -5160,10 +5221,14 @@ def get_page_with_http_info(self, name, page_number, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'image_id' in params: + path_params['imageId'] = params['image_id'] query_params = [] + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -5186,14 +5251,14 @@ def get_page_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}', 'GET', + return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/gif', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentPageResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5201,57 +5266,61 @@ def get_page_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_annotations(self, name, page_number, **kwargs): + def get_image_extract_as_jpeg(self, name, image_id, **kwargs): """ - Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases. + Extract document image in JPEG format This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_annotations(name, page_number, callback=callback_function) + >>> thread = api.get_image_extract_as_jpeg(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str storage: The document storage. :param str folder: The document folder. - :return: AnnotationsInfoResponse + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_annotations_with_http_info(name, page_number, **kwargs) + return self.get_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs) else: - (data) = self.get_page_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs) return data - def get_page_annotations_with_http_info(self, name, page_number, **kwargs): + def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): """ - Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases. + Extract document image in JPEG format This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_annotations_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_image_extract_as_jpeg_with_http_info(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str storage: The document storage. :param str folder: The document folder. - :return: AnnotationsInfoResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'storage', 'folder'] + all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5262,16 +5331,16 @@ def get_page_annotations_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_annotations" % key + " to method get_image_extract_as_jpeg" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_annotations`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_jpeg`") + # verify the required parameter 'image_id' is set + if ('image_id' not in params) or (params['image_id'] is None): + raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_jpeg`") collection_formats = {} @@ -5279,10 +5348,14 @@ def get_page_annotations_with_http_info(self, name, page_number, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'image_id' in params: + path_params['imageId'] = params['image_id'] query_params = [] + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -5305,14 +5378,14 @@ def get_page_annotations_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations', 'GET', + return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/jpeg', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AnnotationsInfoResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5320,57 +5393,61 @@ def get_page_annotations_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_circle_annotations(self, name, page_number, **kwargs): + def get_image_extract_as_png(self, name, image_id, **kwargs): """ - Read document page circle annotations. + Extract document image in PNG format This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_circle_annotations(name, page_number, callback=callback_function) + >>> thread = api.get_image_extract_as_png(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str storage: The document storage. :param str folder: The document folder. - :return: CircleAnnotationsResponse + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_circle_annotations_with_http_info(name, page_number, **kwargs) + return self.get_image_extract_as_png_with_http_info(name, image_id, **kwargs) else: - (data) = self.get_page_circle_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_image_extract_as_png_with_http_info(name, image_id, **kwargs) return data - def get_page_circle_annotations_with_http_info(self, name, page_number, **kwargs): + def get_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): """ - Read document page circle annotations. + Extract document image in PNG format This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_circle_annotations_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_image_extract_as_png_with_http_info(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str storage: The document storage. :param str folder: The document folder. - :return: CircleAnnotationsResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'storage', 'folder'] + all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5381,16 +5458,16 @@ def get_page_circle_annotations_with_http_info(self, name, page_number, **kwargs if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_circle_annotations" % key + " to method get_image_extract_as_png" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_circle_annotations`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_circle_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_png`") + # verify the required parameter 'image_id' is set + if ('image_id' not in params) or (params['image_id'] is None): + raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_png`") collection_formats = {} @@ -5398,10 +5475,14 @@ def get_page_circle_annotations_with_http_info(self, name, page_number, **kwargs path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] - + if 'image_id' in params: + path_params['imageId'] = params['image_id'] + query_params = [] + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -5424,14 +5505,14 @@ def get_page_circle_annotations_with_http_info(self, name, page_number, **kwargs # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/circle', 'GET', + return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/png', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='CircleAnnotationsResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5439,61 +5520,61 @@ def get_page_circle_annotations_with_http_info(self, name, page_number, **kwargs _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_convert_to_bmp(self, name, page_number, **kwargs): + def get_image_extract_as_tiff(self, name, image_id, **kwargs): """ - Convert document page to Bmp image and return resulting file in response. + Extract document image in TIFF format This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_convert_to_bmp(name, page_number, callback=callback_function) + >>> thread = api.get_image_extract_as_tiff(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) + :param str image_id: Image ID. (required) :param int width: The converted image width. :param int height: The converted image height. - :param str folder: The document folder. :param str storage: The document storage. + :param str folder: The document folder. :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_convert_to_bmp_with_http_info(name, page_number, **kwargs) + return self.get_image_extract_as_tiff_with_http_info(name, image_id, **kwargs) else: - (data) = self.get_page_convert_to_bmp_with_http_info(name, page_number, **kwargs) + (data) = self.get_image_extract_as_tiff_with_http_info(name, image_id, **kwargs) return data - def get_page_convert_to_bmp_with_http_info(self, name, page_number, **kwargs): + def get_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): """ - Convert document page to Bmp image and return resulting file in response. + Extract document image in TIFF format This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_convert_to_bmp_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_image_extract_as_tiff_with_http_info(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) + :param str image_id: Image ID. (required) :param int width: The converted image width. :param int height: The converted image height. - :param str folder: The document folder. :param str storage: The document storage. + :param str folder: The document folder. :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'width', 'height', 'folder', 'storage'] + all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5504,16 +5585,16 @@ def get_page_convert_to_bmp_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_convert_to_bmp" % key + " to method get_image_extract_as_tiff" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_convert_to_bmp`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_convert_to_bmp`") + raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_tiff`") + # verify the required parameter 'image_id' is set + if ('image_id' not in params) or (params['image_id'] is None): + raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_tiff`") collection_formats = {} @@ -5521,18 +5602,18 @@ def get_page_convert_to_bmp_with_http_info(self, name, page_number, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'image_id' in params: + path_params['imageId'] = params['image_id'] query_params = [] if 'width' in params: query_params.append(('width', params['width'])) if 'height' in params: query_params.append(('height', params['height'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -5551,7 +5632,7 @@ def get_page_convert_to_bmp_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/bmp', 'GET', + return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/tiff', 'GET', path_params, query_params, header_params, @@ -5566,61 +5647,57 @@ def get_page_convert_to_bmp_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_convert_to_emf(self, name, page_number, **kwargs): + def get_images(self, name, page_number, **kwargs): """ - Convert document page to Emf image and return resulting file in response. + Read document images. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_convert_to_emf(name, page_number, callback=callback_function) + >>> thread = api.get_images(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: ImagesResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_convert_to_emf_with_http_info(name, page_number, **kwargs) + return self.get_images_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_page_convert_to_emf_with_http_info(name, page_number, **kwargs) + (data) = self.get_images_with_http_info(name, page_number, **kwargs) return data - def get_page_convert_to_emf_with_http_info(self, name, page_number, **kwargs): + def get_images_with_http_info(self, name, page_number, **kwargs): """ - Convert document page to Emf image and return resulting file in response. + Read document images. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_convert_to_emf_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_images_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: ImagesResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'width', 'height', 'folder', 'storage'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5631,16 +5708,16 @@ def get_page_convert_to_emf_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_convert_to_emf" % key + " to method get_images" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_convert_to_emf`") + raise ValueError("Missing the required parameter `name` when calling `get_images`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_convert_to_emf`") + raise ValueError("Missing the required parameter `page_number` when calling `get_images`") collection_formats = {} @@ -5652,14 +5729,10 @@ def get_page_convert_to_emf_with_http_info(self, name, page_number, **kwargs): path_params['pageNumber'] = params['page_number'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -5678,14 +5751,14 @@ def get_page_convert_to_emf_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/emf', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='ImagesResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5693,61 +5766,57 @@ def get_page_convert_to_emf_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_convert_to_gif(self, name, page_number, **kwargs): + def get_ink_annotation(self, name, annotation_id, **kwargs): """ - Convert document page to Gif image and return resulting file in response. + Read document page ink annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_convert_to_gif(name, page_number, callback=callback_function) + >>> thread = api.get_ink_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: InkAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_convert_to_gif_with_http_info(name, page_number, **kwargs) + return self.get_ink_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_page_convert_to_gif_with_http_info(name, page_number, **kwargs) + (data) = self.get_ink_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_page_convert_to_gif_with_http_info(self, name, page_number, **kwargs): + def get_ink_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Convert document page to Gif image and return resulting file in response. + Read document page ink annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_convert_to_gif_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_ink_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: InkAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'width', 'height', 'folder', 'storage'] + all_params = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5758,16 +5827,16 @@ def get_page_convert_to_gif_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_convert_to_gif" % key + " to method get_ink_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_convert_to_gif`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_convert_to_gif`") + raise ValueError("Missing the required parameter `name` when calling `get_ink_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_ink_annotation`") collection_formats = {} @@ -5775,18 +5844,14 @@ def get_page_convert_to_gif_with_http_info(self, name, page_number, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -5805,14 +5870,14 @@ def get_page_convert_to_gif_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/gif', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/ink/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='InkAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5820,24 +5885,20 @@ def get_page_convert_to_gif_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_convert_to_jpeg(self, name, page_number, **kwargs): + def get_la_te_x_in_storage_to_pdf(self, src_path, **kwargs): """ - Convert document page to Jpeg image and return resulting file in response. + Convert LaTeX file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_convert_to_jpeg(name, page_number, callback=callback_function) + >>> thread = api.get_la_te_x_in_storage_to_pdf(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param str src_path: Full source filename (ex. /folder1/folder2/template.tex) (required) :param str storage: The document storage. :return: file If the method is called asynchronously, @@ -5845,36 +5906,32 @@ def get_page_convert_to_jpeg(self, name, page_number, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_convert_to_jpeg_with_http_info(name, page_number, **kwargs) + return self.get_la_te_x_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.get_page_convert_to_jpeg_with_http_info(name, page_number, **kwargs) + (data) = self.get_la_te_x_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def get_page_convert_to_jpeg_with_http_info(self, name, page_number, **kwargs): + def get_la_te_x_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Convert document page to Jpeg image and return resulting file in response. + Convert LaTeX file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_convert_to_jpeg_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_la_te_x_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param str src_path: Full source filename (ex. /folder1/folder2/template.tex) (required) :param str storage: The document storage. :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'width', 'height', 'folder', 'storage'] + all_params = ['src_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -5885,33 +5942,22 @@ def get_page_convert_to_jpeg_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_convert_to_jpeg" % key + " to method get_la_te_x_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_convert_to_jpeg`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_convert_to_jpeg`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `get_la_te_x_in_storage_to_pdf`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -5923,7 +5969,7 @@ def get_page_convert_to_jpeg_with_http_info(self, name, page_number, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -5932,7 +5978,7 @@ def get_page_convert_to_jpeg_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/jpeg', 'GET', + return self.api_client.call_api('/pdf/create/latex', 'GET', path_params, query_params, header_params, @@ -5947,61 +5993,57 @@ def get_page_convert_to_jpeg_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_convert_to_png(self, name, page_number, **kwargs): + def get_line_annotation(self, name, annotation_id, **kwargs): """ - Convert document page to Png image and return resulting file in response. + Read document page line annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_convert_to_png(name, page_number, callback=callback_function) + >>> thread = api.get_line_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: LineAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_convert_to_png_with_http_info(name, page_number, **kwargs) + return self.get_line_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_page_convert_to_png_with_http_info(name, page_number, **kwargs) + (data) = self.get_line_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_page_convert_to_png_with_http_info(self, name, page_number, **kwargs): + def get_line_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Convert document page to Png image and return resulting file in response. + Read document page line annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_convert_to_png_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_line_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: LineAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'width', 'height', 'folder', 'storage'] + all_params = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6012,16 +6054,16 @@ def get_page_convert_to_png_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_convert_to_png" % key + " to method get_line_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_convert_to_png`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_convert_to_png`") + raise ValueError("Missing the required parameter `name` when calling `get_line_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_line_annotation`") collection_formats = {} @@ -6029,18 +6071,14 @@ def get_page_convert_to_png_with_http_info(self, name, page_number, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -6059,14 +6097,14 @@ def get_page_convert_to_png_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/png', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/line/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='LineAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6074,61 +6112,57 @@ def get_page_convert_to_png_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_convert_to_tiff(self, name, page_number, **kwargs): + def get_link_annotation(self, name, link_id, **kwargs): """ - Convert document page to Tiff image and return resulting file in response. + Read document link annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_convert_to_tiff(name, page_number, callback=callback_function) + >>> thread = api.get_link_annotation(name, link_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param str link_id: The link ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: LinkAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_convert_to_tiff_with_http_info(name, page_number, **kwargs) + return self.get_link_annotation_with_http_info(name, link_id, **kwargs) else: - (data) = self.get_page_convert_to_tiff_with_http_info(name, page_number, **kwargs) + (data) = self.get_link_annotation_with_http_info(name, link_id, **kwargs) return data - def get_page_convert_to_tiff_with_http_info(self, name, page_number, **kwargs): + def get_link_annotation_with_http_info(self, name, link_id, **kwargs): """ - Convert document page to Tiff image and return resulting file in response. + Read document link annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_convert_to_tiff_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_link_annotation_with_http_info(name, link_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param str link_id: The link ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: LinkAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'width', 'height', 'folder', 'storage'] + all_params = ['name', 'link_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6139,16 +6173,16 @@ def get_page_convert_to_tiff_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_convert_to_tiff" % key + " to method get_link_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_convert_to_tiff`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_convert_to_tiff`") + raise ValueError("Missing the required parameter `name` when calling `get_link_annotation`") + # verify the required parameter 'link_id' is set + if ('link_id' not in params) or (params['link_id'] is None): + raise ValueError("Missing the required parameter `link_id` when calling `get_link_annotation`") collection_formats = {} @@ -6156,18 +6190,14 @@ def get_page_convert_to_tiff_with_http_info(self, name, page_number, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'link_id' in params: + path_params['linkId'] = params['link_id'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -6186,14 +6216,14 @@ def get_page_convert_to_tiff_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/tiff', 'GET', + return self.api_client.call_api('/pdf/{name}/links/{linkId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='LinkAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6201,57 +6231,53 @@ def get_page_convert_to_tiff_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_free_text_annotations(self, name, page_number, **kwargs): + def get_list_files(self, **kwargs): """ - Read document page free text annotations. + Get the file listing of a specific folder This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_free_text_annotations(name, page_number, callback=callback_function) + >>> thread = api.get_list_files(callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param str storage: The document storage. - :param str folder: The document folder. - :return: FreeTextAnnotationsResponse + :param str path: Start with name of storage e.g. root folder '/'or some folder '/folder1/..' + :param str storage: User's storage name + :return: FilesResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_free_text_annotations_with_http_info(name, page_number, **kwargs) + return self.get_list_files_with_http_info(**kwargs) else: - (data) = self.get_page_free_text_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_list_files_with_http_info(**kwargs) return data - def get_page_free_text_annotations_with_http_info(self, name, page_number, **kwargs): + def get_list_files_with_http_info(self, **kwargs): """ - Read document page free text annotations. + Get the file listing of a specific folder This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_free_text_annotations_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_list_files_with_http_info(callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param str storage: The document storage. - :param str folder: The document folder. - :return: FreeTextAnnotationsResponse + :param str path: Start with name of storage e.g. root folder '/'or some folder '/folder1/..' + :param str storage: User's storage name + :return: FilesResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'storage', 'folder'] + all_params = ['path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6262,31 +6288,21 @@ def get_page_free_text_annotations_with_http_info(self, name, page_number, **kwa if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_free_text_annotations" % key + " to method get_list_files" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_free_text_annotations`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_free_text_annotations`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] + if 'path' in params: + query_params.append(('path', params['path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) header_params = {} @@ -6305,14 +6321,14 @@ def get_page_free_text_annotations_with_http_info(self, name, page_number, **kwa # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/freetext', 'GET', + return self.api_client.call_api('/storage/folder', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FreeTextAnnotationsResponse', + response_type='FilesResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6320,57 +6336,53 @@ def get_page_free_text_annotations_with_http_info(self, name, page_number, **kwa _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_line_annotations(self, name, page_number, **kwargs): + def get_mht_in_storage_to_pdf(self, src_path, **kwargs): """ - Read document page line annotations. + Convert MHT file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_line_annotations(name, page_number, callback=callback_function) + >>> thread = api.get_mht_in_storage_to_pdf(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.mht) (required) :param str storage: The document storage. - :param str folder: The document folder. - :return: LineAnnotationsResponse + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_line_annotations_with_http_info(name, page_number, **kwargs) + return self.get_mht_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.get_page_line_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_mht_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def get_page_line_annotations_with_http_info(self, name, page_number, **kwargs): + def get_mht_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Read document page line annotations. + Convert MHT file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_line_annotations_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_mht_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.mht) (required) :param str storage: The document storage. - :param str folder: The document folder. - :return: LineAnnotationsResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'storage', 'folder'] + all_params = ['src_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6381,31 +6393,24 @@ def get_page_line_annotations_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_line_annotations" % key + " to method get_mht_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_line_annotations`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_line_annotations`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `get_mht_in_storage_to_pdf`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) header_params = {} @@ -6415,7 +6420,7 @@ def get_page_line_annotations_with_http_info(self, name, page_number, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -6424,14 +6429,14 @@ def get_page_line_annotations_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/line', 'GET', + return self.api_client.call_api('/pdf/create/mht', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='LineAnnotationsResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6439,59 +6444,57 @@ def get_page_line_annotations_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_link_annotation(self, name, page_number, link_id, **kwargs): + def get_page(self, name, page_number, **kwargs): """ - Read document page link annotation by ID. + Read document page info. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_link_annotation(name, page_number, link_id, callback=callback_function) + >>> thread = api.get_page(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param str link_id: The link ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: LinkAnnotationResponse + :return: DocumentPageResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_link_annotation_with_http_info(name, page_number, link_id, **kwargs) + return self.get_page_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_page_link_annotation_with_http_info(name, page_number, link_id, **kwargs) + (data) = self.get_page_with_http_info(name, page_number, **kwargs) return data - def get_page_link_annotation_with_http_info(self, name, page_number, link_id, **kwargs): + def get_page_with_http_info(self, name, page_number, **kwargs): """ - Read document page link annotation by ID. + Read document page info. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_link_annotation_with_http_info(name, page_number, link_id, callback=callback_function) + >>> thread = api.get_page_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param str link_id: The link ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: LinkAnnotationResponse + :return: DocumentPageResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'link_id', 'storage', 'folder'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6502,19 +6505,16 @@ def get_page_link_annotation_with_http_info(self, name, page_number, link_id, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_link_annotation" % key + " to method get_page" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_link_annotation`") + raise ValueError("Missing the required parameter `name` when calling `get_page`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_link_annotation`") - # verify the required parameter 'link_id' is set - if ('link_id' not in params) or (params['link_id'] is None): - raise ValueError("Missing the required parameter `link_id` when calling `get_page_link_annotation`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page`") collection_formats = {} @@ -6524,8 +6524,6 @@ def get_page_link_annotation_with_http_info(self, name, page_number, link_id, ** path_params['name'] = params['name'] if 'page_number' in params: path_params['pageNumber'] = params['page_number'] - if 'link_id' in params: - path_params['linkId'] = params['link_id'] query_params = [] if 'storage' in params: @@ -6550,14 +6548,14 @@ def get_page_link_annotation_with_http_info(self, name, page_number, link_id, ** # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/links/{linkId}', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='LinkAnnotationResponse', + response_type='DocumentPageResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6565,16 +6563,16 @@ def get_page_link_annotation_with_http_info(self, name, page_number, link_id, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_link_annotations(self, name, page_number, **kwargs): + def get_page_annotations(self, name, page_number, **kwargs): """ - Read document page link annotations. + Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_link_annotations(name, page_number, callback=callback_function) + >>> thread = api.get_page_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -6582,27 +6580,27 @@ def get_page_link_annotations(self, name, page_number, **kwargs): :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: LinkAnnotationsResponse + :return: AnnotationsInfoResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_link_annotations_with_http_info(name, page_number, **kwargs) + return self.get_page_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_page_link_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_page_annotations_with_http_info(name, page_number, **kwargs) return data - def get_page_link_annotations_with_http_info(self, name, page_number, **kwargs): + def get_page_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page link annotations. + Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_link_annotations_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_page_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -6610,7 +6608,7 @@ def get_page_link_annotations_with_http_info(self, name, page_number, **kwargs): :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: LinkAnnotationsResponse + :return: AnnotationsInfoResponse If the method is called asynchronously, returns the request thread. """ @@ -6626,16 +6624,16 @@ def get_page_link_annotations_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_link_annotations" % key + " to method get_page_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_link_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_page_annotations`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_link_annotations`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_annotations`") collection_formats = {} @@ -6669,14 +6667,14 @@ def get_page_link_annotations_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/links', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='LinkAnnotationsResponse', + response_type='AnnotationsInfoResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6684,16 +6682,16 @@ def get_page_link_annotations_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_poly_line_annotations(self, name, page_number, **kwargs): + def get_page_caret_annotations(self, name, page_number, **kwargs): """ - Read document page polyline annotations. + Read document page caret annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_poly_line_annotations(name, page_number, callback=callback_function) + >>> thread = api.get_page_caret_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -6701,27 +6699,27 @@ def get_page_poly_line_annotations(self, name, page_number, **kwargs): :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: PolyLineAnnotationsResponse + :return: CaretAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_poly_line_annotations_with_http_info(name, page_number, **kwargs) + return self.get_page_caret_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_page_poly_line_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_page_caret_annotations_with_http_info(name, page_number, **kwargs) return data - def get_page_poly_line_annotations_with_http_info(self, name, page_number, **kwargs): + def get_page_caret_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page polyline annotations. + Read document page caret annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_poly_line_annotations_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_page_caret_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -6729,7 +6727,7 @@ def get_page_poly_line_annotations_with_http_info(self, name, page_number, **kwa :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: PolyLineAnnotationsResponse + :return: CaretAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -6745,16 +6743,16 @@ def get_page_poly_line_annotations_with_http_info(self, name, page_number, **kwa if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_poly_line_annotations" % key + " to method get_page_caret_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_poly_line_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_page_caret_annotations`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_poly_line_annotations`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_caret_annotations`") collection_formats = {} @@ -6788,14 +6786,14 @@ def get_page_poly_line_annotations_with_http_info(self, name, page_number, **kwa # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polyline', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/caret', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PolyLineAnnotationsResponse', + response_type='CaretAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6803,16 +6801,16 @@ def get_page_poly_line_annotations_with_http_info(self, name, page_number, **kwa _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_polygon_annotations(self, name, page_number, **kwargs): + def get_page_circle_annotations(self, name, page_number, **kwargs): """ - Read document page polygon annotations. + Read document page circle annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_polygon_annotations(name, page_number, callback=callback_function) + >>> thread = api.get_page_circle_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -6820,27 +6818,27 @@ def get_page_polygon_annotations(self, name, page_number, **kwargs): :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: PolygonAnnotationsResponse + :return: CircleAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_polygon_annotations_with_http_info(name, page_number, **kwargs) + return self.get_page_circle_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_page_polygon_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_page_circle_annotations_with_http_info(name, page_number, **kwargs) return data - def get_page_polygon_annotations_with_http_info(self, name, page_number, **kwargs): + def get_page_circle_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page polygon annotations. + Read document page circle annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_polygon_annotations_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_page_circle_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -6848,7 +6846,7 @@ def get_page_polygon_annotations_with_http_info(self, name, page_number, **kwarg :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: PolygonAnnotationsResponse + :return: CircleAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -6864,16 +6862,16 @@ def get_page_polygon_annotations_with_http_info(self, name, page_number, **kwarg if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_polygon_annotations" % key + " to method get_page_circle_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_polygon_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_page_circle_annotations`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_polygon_annotations`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_circle_annotations`") collection_formats = {} @@ -6907,14 +6905,14 @@ def get_page_polygon_annotations_with_http_info(self, name, page_number, **kwarg # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polygon', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/circle', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PolygonAnnotationsResponse', + response_type='CircleAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -6922,57 +6920,61 @@ def get_page_polygon_annotations_with_http_info(self, name, page_number, **kwarg _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_square_annotations(self, name, page_number, **kwargs): + def get_page_convert_to_bmp(self, name, page_number, **kwargs): """ - Read document page square annotations. + Convert document page to Bmp image and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_square_annotations(name, page_number, callback=callback_function) + >>> thread = api.get_page_convert_to_bmp(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param str storage: The document storage. + :param int width: The converted image width. + :param int height: The converted image height. :param str folder: The document folder. - :return: SquareAnnotationsResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_square_annotations_with_http_info(name, page_number, **kwargs) + return self.get_page_convert_to_bmp_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_page_square_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_page_convert_to_bmp_with_http_info(name, page_number, **kwargs) return data - def get_page_square_annotations_with_http_info(self, name, page_number, **kwargs): + def get_page_convert_to_bmp_with_http_info(self, name, page_number, **kwargs): """ - Read document page square annotations. + Convert document page to Bmp image and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_square_annotations_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_page_convert_to_bmp_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param str storage: The document storage. + :param int width: The converted image width. + :param int height: The converted image height. :param str folder: The document folder. - :return: SquareAnnotationsResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'storage', 'folder'] + all_params = ['name', 'page_number', 'width', 'height', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -6983,16 +6985,16 @@ def get_page_square_annotations_with_http_info(self, name, page_number, **kwargs if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_square_annotations" % key + " to method get_page_convert_to_bmp" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_square_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_page_convert_to_bmp`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_square_annotations`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_convert_to_bmp`") collection_formats = {} @@ -7004,10 +7006,14 @@ def get_page_square_annotations_with_http_info(self, name, page_number, **kwargs path_params['pageNumber'] = params['page_number'] query_params = [] - if 'storage' in params: - query_params.append(('storage', params['storage'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) if 'folder' in params: query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} @@ -7026,14 +7032,14 @@ def get_page_square_annotations_with_http_info(self, name, page_number, **kwargs # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/square', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/bmp', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SquareAnnotationsResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7041,71 +7047,61 @@ def get_page_square_annotations_with_http_info(self, name, page_number, **kwargs _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_text(self, name, page_number, llx, lly, urx, ury, **kwargs): + def get_page_convert_to_emf(self, name, page_number, **kwargs): """ - Read page text items. + Convert document page to Emf image and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_text(name, page_number, llx, lly, urx, ury, callback=callback_function) + >>> thread = api.get_page_convert_to_emf(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: Number of page (starting from 1). (required) - :param float llx: (required) - :param float lly: (required) - :param float urx: (required) - :param float ury: (required) - :param list[str] format: List of formats for search. - :param str regex: Formats are specified as a regular expression. - :param bool split_rects: Split result fragments (default is true). + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str folder: The document folder. :param str storage: The document storage. - :return: TextRectsResponse + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) + return self.get_page_convert_to_emf_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) + (data) = self.get_page_convert_to_emf_with_http_info(name, page_number, **kwargs) return data - def get_page_text_with_http_info(self, name, page_number, llx, lly, urx, ury, **kwargs): + def get_page_convert_to_emf_with_http_info(self, name, page_number, **kwargs): """ - Read page text items. + Convert document page to Emf image and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, callback=callback_function) + >>> thread = api.get_page_convert_to_emf_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: Number of page (starting from 1). (required) - :param float llx: (required) - :param float lly: (required) - :param float urx: (required) - :param float ury: (required) - :param list[str] format: List of formats for search. - :param str regex: Formats are specified as a regular expression. - :param bool split_rects: Split result fragments (default is true). + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str folder: The document folder. :param str storage: The document storage. - :return: TextRectsResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'llx', 'lly', 'urx', 'ury', 'format', 'regex', 'split_rects', 'folder', 'storage'] + all_params = ['name', 'page_number', 'width', 'height', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7116,28 +7112,16 @@ def get_page_text_with_http_info(self, name, page_number, llx, lly, urx, ury, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_text" % key + " to method get_page_convert_to_emf" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_text`") + raise ValueError("Missing the required parameter `name` when calling `get_page_convert_to_emf`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_text`") - # verify the required parameter 'llx' is set - if ('llx' not in params) or (params['llx'] is None): - raise ValueError("Missing the required parameter `llx` when calling `get_page_text`") - # verify the required parameter 'lly' is set - if ('lly' not in params) or (params['lly'] is None): - raise ValueError("Missing the required parameter `lly` when calling `get_page_text`") - # verify the required parameter 'urx' is set - if ('urx' not in params) or (params['urx'] is None): - raise ValueError("Missing the required parameter `urx` when calling `get_page_text`") - # verify the required parameter 'ury' is set - if ('ury' not in params) or (params['ury'] is None): - raise ValueError("Missing the required parameter `ury` when calling `get_page_text`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_convert_to_emf`") collection_formats = {} @@ -7149,23 +7133,12 @@ def get_page_text_with_http_info(self, name, page_number, llx, lly, urx, ury, ** path_params['pageNumber'] = params['page_number'] query_params = [] - if 'format' in params: - query_params.append(('format', params['format'])) - collection_formats['format'] = 'multi' - if 'regex' in params: - query_params.append(('regex', params['regex'])) - if 'split_rects' in params: - query_params.append(('splitRects', params['split_rects'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) if 'folder' in params: query_params.append(('folder', params['folder'])) - if 'llx' in params: - query_params.append(('LLX', params['llx'])) - if 'lly' in params: - query_params.append(('LLY', params['lly'])) - if 'urx' in params: - query_params.append(('URX', params['urx'])) - if 'ury' in params: - query_params.append(('URY', params['ury'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -7186,14 +7159,14 @@ def get_page_text_with_http_info(self, name, page_number, llx, lly, urx, ury, ** # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/text', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/emf', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TextRectsResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7201,57 +7174,61 @@ def get_page_text_with_http_info(self, name, page_number, llx, lly, urx, ury, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_text_annotations(self, name, page_number, **kwargs): + def get_page_convert_to_gif(self, name, page_number, **kwargs): """ - Read document page text annotations. + Convert document page to Gif image and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_text_annotations(name, page_number, callback=callback_function) + >>> thread = api.get_page_convert_to_gif(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param str storage: The document storage. + :param int width: The converted image width. + :param int height: The converted image height. :param str folder: The document folder. - :return: TextAnnotationsResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_text_annotations_with_http_info(name, page_number, **kwargs) + return self.get_page_convert_to_gif_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_page_text_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_page_convert_to_gif_with_http_info(name, page_number, **kwargs) return data - def get_page_text_annotations_with_http_info(self, name, page_number, **kwargs): + def get_page_convert_to_gif_with_http_info(self, name, page_number, **kwargs): """ - Read document page text annotations. + Convert document page to Gif image and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_page_text_annotations_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_page_convert_to_gif_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param str storage: The document storage. + :param int width: The converted image width. + :param int height: The converted image height. :param str folder: The document folder. - :return: TextAnnotationsResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'storage', 'folder'] + all_params = ['name', 'page_number', 'width', 'height', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7262,16 +7239,16 @@ def get_page_text_annotations_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_text_annotations" % key + " to method get_page_convert_to_gif" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_page_text_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_page_convert_to_gif`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `get_page_text_annotations`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_convert_to_gif`") collection_formats = {} @@ -7283,10 +7260,14 @@ def get_page_text_annotations_with_http_info(self, name, page_number, **kwargs): path_params['pageNumber'] = params['page_number'] query_params = [] - if 'storage' in params: - query_params.append(('storage', params['storage'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) if 'folder' in params: query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} @@ -7305,14 +7286,14 @@ def get_page_text_annotations_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/text', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/gif', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TextAnnotationsResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7320,55 +7301,61 @@ def get_page_text_annotations_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pages(self, name, **kwargs): + def get_page_convert_to_jpeg(self, name, page_number, **kwargs): """ - Read document pages info. + Convert document page to Jpeg image and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pages(name, callback=callback_function) + >>> thread = api.get_page_convert_to_jpeg(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str storage: The document storage. + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str folder: The document folder. - :return: DocumentPagesResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pages_with_http_info(name, **kwargs) + return self.get_page_convert_to_jpeg_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pages_with_http_info(name, **kwargs) + (data) = self.get_page_convert_to_jpeg_with_http_info(name, page_number, **kwargs) return data - def get_pages_with_http_info(self, name, **kwargs): + def get_page_convert_to_jpeg_with_http_info(self, name, page_number, **kwargs): """ - Read document pages info. + Convert document page to Jpeg image and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pages_with_http_info(name, callback=callback_function) + >>> thread = api.get_page_convert_to_jpeg_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str storage: The document storage. + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str folder: The document folder. - :return: DocumentPagesResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'storage', 'folder'] + all_params = ['name', 'page_number', 'width', 'height', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7379,13 +7366,16 @@ def get_pages_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pages" % key + " to method get_page_convert_to_jpeg" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pages`") + raise ValueError("Missing the required parameter `name` when calling `get_page_convert_to_jpeg`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_convert_to_jpeg`") collection_formats = {} @@ -7393,12 +7383,18 @@ def get_pages_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'storage' in params: - query_params.append(('storage', params['storage'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) if 'folder' in params: query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} @@ -7417,14 +7413,14 @@ def get_pages_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/jpeg', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentPagesResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7432,20 +7428,24 @@ def get_pages_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pcl_in_storage_to_pdf(self, src_path, **kwargs): + def get_page_convert_to_png(self, name, page_number, **kwargs): """ - Convert PCL file (located on storage) to PDF format and return resulting file in response. + Convert document page to Png image and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pcl_in_storage_to_pdf(src_path, callback=callback_function) + >>> thread = api.get_page_convert_to_png(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.pcl) (required) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. :param str storage: The document storage. :return: file If the method is called asynchronously, @@ -7453,32 +7453,36 @@ def get_pcl_in_storage_to_pdf(self, src_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pcl_in_storage_to_pdf_with_http_info(src_path, **kwargs) + return self.get_page_convert_to_png_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pcl_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_page_convert_to_png_with_http_info(name, page_number, **kwargs) return data - def get_pcl_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_page_convert_to_png_with_http_info(self, name, page_number, **kwargs): """ - Convert PCL file (located on storage) to PDF format and return resulting file in response. + Convert document page to Png image and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pcl_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) + >>> thread = api.get_page_convert_to_png_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.pcl) (required) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. :param str storage: The document storage. :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['src_path', 'storage'] + all_params = ['name', 'page_number', 'width', 'height', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7489,22 +7493,33 @@ def get_pcl_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pcl_in_storage_to_pdf" % key + " to method get_page_convert_to_png" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `get_pcl_in_storage_to_pdf`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_page_convert_to_png`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_convert_to_png`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -7516,7 +7531,7 @@ def get_pcl_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -7525,7 +7540,7 @@ def get_pcl_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/create/pcl', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/png', 'GET', path_params, query_params, header_params, @@ -7540,28 +7555,23 @@ def get_pcl_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_in_storage_to_doc(self, name, **kwargs): + def get_page_convert_to_tiff(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to DOC format and returns resulting file in response content + Convert document page to Tiff image and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_doc(name, callback=callback_function) + >>> thread = api.get_page_convert_to_tiff(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param bool add_return_to_line_end: Add return to line end. - :param str format: Allows to specify .doc or .docx file format. - :param int image_resolution_x: Image resolution X. - :param int image_resolution_y: Image resolution Y. - :param float max_distance_between_text_lines: Max distance between text lines. - :param str mode: Allows to control how a PDF document is converted into a word processing document. - :param bool recognize_bullets: Recognize bullets. - :param float relative_horizontal_proximity: Relative horizontal proximity. + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str folder: The document folder. :param str storage: The document storage. :return: file @@ -7570,33 +7580,28 @@ def get_pdf_in_storage_to_doc(self, name, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_in_storage_to_doc_with_http_info(name, **kwargs) + return self.get_page_convert_to_tiff_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pdf_in_storage_to_doc_with_http_info(name, **kwargs) + (data) = self.get_page_convert_to_tiff_with_http_info(name, page_number, **kwargs) return data - def get_pdf_in_storage_to_doc_with_http_info(self, name, **kwargs): + def get_page_convert_to_tiff_with_http_info(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to DOC format and returns resulting file in response content + Convert document page to Tiff image and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_doc_with_http_info(name, callback=callback_function) + >>> thread = api.get_page_convert_to_tiff_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param bool add_return_to_line_end: Add return to line end. - :param str format: Allows to specify .doc or .docx file format. - :param int image_resolution_x: Image resolution X. - :param int image_resolution_y: Image resolution Y. - :param float max_distance_between_text_lines: Max distance between text lines. - :param str mode: Allows to control how a PDF document is converted into a word processing document. - :param bool recognize_bullets: Recognize bullets. - :param float relative_horizontal_proximity: Relative horizontal proximity. + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str folder: The document folder. :param str storage: The document storage. :return: file @@ -7604,7 +7609,7 @@ def get_pdf_in_storage_to_doc_with_http_info(self, name, **kwargs): returns the request thread. """ - all_params = ['name', 'add_return_to_line_end', 'format', 'image_resolution_x', 'image_resolution_y', 'max_distance_between_text_lines', 'mode', 'recognize_bullets', 'relative_horizontal_proximity', 'folder', 'storage'] + all_params = ['name', 'page_number', 'width', 'height', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7615,13 +7620,16 @@ def get_pdf_in_storage_to_doc_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_in_storage_to_doc" % key + " to method get_page_convert_to_tiff" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_doc`") + raise ValueError("Missing the required parameter `name` when calling `get_page_convert_to_tiff`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_convert_to_tiff`") collection_formats = {} @@ -7629,24 +7637,14 @@ def get_pdf_in_storage_to_doc_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'add_return_to_line_end' in params: - query_params.append(('addReturnToLineEnd', params['add_return_to_line_end'])) - if 'format' in params: - query_params.append(('format', params['format'])) - if 'image_resolution_x' in params: - query_params.append(('imageResolutionX', params['image_resolution_x'])) - if 'image_resolution_y' in params: - query_params.append(('imageResolutionY', params['image_resolution_y'])) - if 'max_distance_between_text_lines' in params: - query_params.append(('maxDistanceBetweenTextLines', params['max_distance_between_text_lines'])) - if 'mode' in params: - query_params.append(('mode', params['mode'])) - if 'recognize_bullets' in params: - query_params.append(('recognizeBullets', params['recognize_bullets'])) - if 'relative_horizontal_proximity' in params: - query_params.append(('relativeHorizontalProximity', params['relative_horizontal_proximity'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) if 'folder' in params: query_params.append(('folder', params['folder'])) if 'storage' in params: @@ -7660,7 +7658,7 @@ def get_pdf_in_storage_to_doc_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -7669,7 +7667,7 @@ def get_pdf_in_storage_to_doc_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/doc', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/tiff', 'GET', path_params, query_params, header_params, @@ -7684,57 +7682,57 @@ def get_pdf_in_storage_to_doc_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_in_storage_to_epub(self, name, **kwargs): + def get_page_free_text_annotations(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to EPUB format and returns resulting file in response content + Read document page free text annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_epub(name, callback=callback_function) + >>> thread = api.get_page_free_text_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content. - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: FreeTextAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_in_storage_to_epub_with_http_info(name, **kwargs) + return self.get_page_free_text_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pdf_in_storage_to_epub_with_http_info(name, **kwargs) + (data) = self.get_page_free_text_annotations_with_http_info(name, page_number, **kwargs) return data - def get_pdf_in_storage_to_epub_with_http_info(self, name, **kwargs): + def get_page_free_text_annotations_with_http_info(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to EPUB format and returns resulting file in response content + Read document page free text annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_epub_with_http_info(name, callback=callback_function) + >>> thread = api.get_page_free_text_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content. - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: FreeTextAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'content_recognition_mode', 'folder', 'storage'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7745,13 +7743,16 @@ def get_pdf_in_storage_to_epub_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_in_storage_to_epub" % key + " to method get_page_free_text_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_epub`") + raise ValueError("Missing the required parameter `name` when calling `get_page_free_text_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_free_text_annotations`") collection_formats = {} @@ -7759,14 +7760,14 @@ def get_pdf_in_storage_to_epub_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'content_recognition_mode' in params: - query_params.append(('contentRecognitionMode', params['content_recognition_mode'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -7776,7 +7777,7 @@ def get_pdf_in_storage_to_epub_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -7785,14 +7786,14 @@ def get_pdf_in_storage_to_epub_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/epub', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/freetext', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='FreeTextAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -7800,111 +7801,57 @@ def get_pdf_in_storage_to_epub_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_in_storage_to_html(self, name, **kwargs): + def get_page_highlight_annotations(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to Html format and returns resulting file in response content + Read document page highlight annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_html(name, callback=callback_function) + >>> thread = api.get_page_highlight_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int additional_margin_width_in_points: Defines width of margin that will be forcibly left around that output HTML-areas. - :param bool compress_svg_graphics_if_any: The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving. - :param bool convert_marked_content_to_layers: 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 str default_font_name: 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 str document_type: Result document type. - :param bool fixed_layout: The value indicating whether that HTML is created as fixed layout. - :param int image_resolution: Resolution for image rendering. - :param int minimal_line_width: 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 bool prevent_glyphs_grouping: 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 bool split_css_into_pages: 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 bool split_into_pages: 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 bool use_z_order: 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 str antialiasing_processing: The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML. - :param str css_class_names_prefix: 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 list[int] explicit_list_of_saved_pages: 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 str font_encoding_strategy: Defines encoding special rule to tune PDF decoding for current document. - :param str font_saving_mode: Defines font saving mode that will be used during saving of PDF to desirable format. - :param str html_markup_generation_mode: 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 str letters_positioning_method: The mode of positioning of letters in words in result HTML. - :param bool pages_flow_type_depends_on_viewers_screen_size: 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 str parts_embedding_mode: 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 str raster_images_saving_mode: Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML. - :param bool remove_empty_areas_on_top_and_bottom: Defines whether in created HTML will be removed top and bottom empty area without any content (if any). - :param bool save_shadowed_texts_as_transparent_texts: 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 bool save_transparent_texts: 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 str special_folder_for_all_images: 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 str special_folder_for_svg_images: 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 bool try_save_text_underlining_and_strikeouting_in_css: 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 str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: HighlightAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_in_storage_to_html_with_http_info(name, **kwargs) + return self.get_page_highlight_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pdf_in_storage_to_html_with_http_info(name, **kwargs) + (data) = self.get_page_highlight_annotations_with_http_info(name, page_number, **kwargs) return data - def get_pdf_in_storage_to_html_with_http_info(self, name, **kwargs): + def get_page_highlight_annotations_with_http_info(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to Html format and returns resulting file in response content + Read document page highlight annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_html_with_http_info(name, callback=callback_function) + >>> thread = api.get_page_highlight_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int additional_margin_width_in_points: Defines width of margin that will be forcibly left around that output HTML-areas. - :param bool compress_svg_graphics_if_any: The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving. - :param bool convert_marked_content_to_layers: 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 str default_font_name: 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 str document_type: Result document type. - :param bool fixed_layout: The value indicating whether that HTML is created as fixed layout. - :param int image_resolution: Resolution for image rendering. - :param int minimal_line_width: 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 bool prevent_glyphs_grouping: 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 bool split_css_into_pages: 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 bool split_into_pages: 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 bool use_z_order: 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 str antialiasing_processing: The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML. - :param str css_class_names_prefix: 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 list[int] explicit_list_of_saved_pages: 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 str font_encoding_strategy: Defines encoding special rule to tune PDF decoding for current document. - :param str font_saving_mode: Defines font saving mode that will be used during saving of PDF to desirable format. - :param str html_markup_generation_mode: 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 str letters_positioning_method: The mode of positioning of letters in words in result HTML. - :param bool pages_flow_type_depends_on_viewers_screen_size: 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 str parts_embedding_mode: 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 str raster_images_saving_mode: Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML. - :param bool remove_empty_areas_on_top_and_bottom: Defines whether in created HTML will be removed top and bottom empty area without any content (if any). - :param bool save_shadowed_texts_as_transparent_texts: 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 bool save_transparent_texts: 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 str special_folder_for_all_images: 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 str special_folder_for_svg_images: 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 bool try_save_text_underlining_and_strikeouting_in_css: 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 str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: HighlightAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'additional_margin_width_in_points', 'compress_svg_graphics_if_any', 'convert_marked_content_to_layers', 'default_font_name', 'document_type', 'fixed_layout', 'image_resolution', 'minimal_line_width', 'prevent_glyphs_grouping', 'split_css_into_pages', 'split_into_pages', 'use_z_order', 'antialiasing_processing', 'css_class_names_prefix', 'explicit_list_of_saved_pages', 'font_encoding_strategy', 'font_saving_mode', 'html_markup_generation_mode', 'letters_positioning_method', 'pages_flow_type_depends_on_viewers_screen_size', 'parts_embedding_mode', 'raster_images_saving_mode', 'remove_empty_areas_on_top_and_bottom', 'save_shadowed_texts_as_transparent_texts', 'save_transparent_texts', 'special_folder_for_all_images', 'special_folder_for_svg_images', 'try_save_text_underlining_and_strikeouting_in_css', 'folder', 'storage'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -7915,13 +7862,16 @@ def get_pdf_in_storage_to_html_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_in_storage_to_html" % key + " to method get_page_highlight_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_html`") + raise ValueError("Missing the required parameter `name` when calling `get_page_highlight_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_highlight_annotations`") collection_formats = {} @@ -7929,69 +7879,14 @@ def get_pdf_in_storage_to_html_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'additional_margin_width_in_points' in params: - query_params.append(('additionalMarginWidthInPoints', params['additional_margin_width_in_points'])) - if 'compress_svg_graphics_if_any' in params: - query_params.append(('compressSvgGraphicsIfAny', params['compress_svg_graphics_if_any'])) - if 'convert_marked_content_to_layers' in params: - query_params.append(('convertMarkedContentToLayers', params['convert_marked_content_to_layers'])) - if 'default_font_name' in params: - query_params.append(('defaultFontName', params['default_font_name'])) - if 'document_type' in params: - query_params.append(('documentType', params['document_type'])) - if 'fixed_layout' in params: - query_params.append(('fixedLayout', params['fixed_layout'])) - if 'image_resolution' in params: - query_params.append(('imageResolution', params['image_resolution'])) - if 'minimal_line_width' in params: - query_params.append(('minimalLineWidth', params['minimal_line_width'])) - if 'prevent_glyphs_grouping' in params: - query_params.append(('preventGlyphsGrouping', params['prevent_glyphs_grouping'])) - if 'split_css_into_pages' in params: - query_params.append(('splitCssIntoPages', params['split_css_into_pages'])) - if 'split_into_pages' in params: - query_params.append(('splitIntoPages', params['split_into_pages'])) - if 'use_z_order' in params: - query_params.append(('useZOrder', params['use_z_order'])) - if 'antialiasing_processing' in params: - query_params.append(('antialiasingProcessing', params['antialiasing_processing'])) - if 'css_class_names_prefix' in params: - query_params.append(('cssClassNamesPrefix', params['css_class_names_prefix'])) - if 'explicit_list_of_saved_pages' in params: - query_params.append(('explicitListOfSavedPages', params['explicit_list_of_saved_pages'])) - collection_formats['explicitListOfSavedPages'] = 'multi' - if 'font_encoding_strategy' in params: - query_params.append(('fontEncodingStrategy', params['font_encoding_strategy'])) - if 'font_saving_mode' in params: - query_params.append(('fontSavingMode', params['font_saving_mode'])) - if 'html_markup_generation_mode' in params: - query_params.append(('htmlMarkupGenerationMode', params['html_markup_generation_mode'])) - if 'letters_positioning_method' in params: - query_params.append(('lettersPositioningMethod', params['letters_positioning_method'])) - if 'pages_flow_type_depends_on_viewers_screen_size' in params: - query_params.append(('pagesFlowTypeDependsOnViewersScreenSize', params['pages_flow_type_depends_on_viewers_screen_size'])) - if 'parts_embedding_mode' in params: - query_params.append(('partsEmbeddingMode', params['parts_embedding_mode'])) - if 'raster_images_saving_mode' in params: - query_params.append(('rasterImagesSavingMode', params['raster_images_saving_mode'])) - if 'remove_empty_areas_on_top_and_bottom' in params: - query_params.append(('removeEmptyAreasOnTopAndBottom', params['remove_empty_areas_on_top_and_bottom'])) - if 'save_shadowed_texts_as_transparent_texts' in params: - query_params.append(('saveShadowedTextsAsTransparentTexts', params['save_shadowed_texts_as_transparent_texts'])) - if 'save_transparent_texts' in params: - query_params.append(('saveTransparentTexts', params['save_transparent_texts'])) - if 'special_folder_for_all_images' in params: - query_params.append(('specialFolderForAllImages', params['special_folder_for_all_images'])) - if 'special_folder_for_svg_images' in params: - query_params.append(('specialFolderForSvgImages', params['special_folder_for_svg_images'])) - if 'try_save_text_underlining_and_strikeouting_in_css' in params: - query_params.append(('trySaveTextUnderliningAndStrikeoutingInCss', params['try_save_text_underlining_and_strikeouting_in_css'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -8001,7 +7896,7 @@ def get_pdf_in_storage_to_html_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -8010,14 +7905,14 @@ def get_pdf_in_storage_to_html_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/html', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/highlight', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='HighlightAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8025,57 +7920,57 @@ def get_pdf_in_storage_to_html_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_in_storage_to_la_te_x(self, name, **kwargs): + def get_page_ink_annotations(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to LaTeX format and returns resulting file in response content + Read document page ink annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_la_te_x(name, callback=callback_function) + >>> thread = api.get_page_ink_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int pages_count: Pages count. - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: InkAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_in_storage_to_la_te_x_with_http_info(name, **kwargs) + return self.get_page_ink_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pdf_in_storage_to_la_te_x_with_http_info(name, **kwargs) + (data) = self.get_page_ink_annotations_with_http_info(name, page_number, **kwargs) return data - def get_pdf_in_storage_to_la_te_x_with_http_info(self, name, **kwargs): + def get_page_ink_annotations_with_http_info(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to LaTeX format and returns resulting file in response content + Read document page ink annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_la_te_x_with_http_info(name, callback=callback_function) + >>> thread = api.get_page_ink_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int pages_count: Pages count. - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: InkAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'pages_count', 'folder', 'storage'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8086,13 +7981,16 @@ def get_pdf_in_storage_to_la_te_x_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_in_storage_to_la_te_x" % key + " to method get_page_ink_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_la_te_x`") + raise ValueError("Missing the required parameter `name` when calling `get_page_ink_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_ink_annotations`") collection_formats = {} @@ -8100,14 +7998,14 @@ def get_pdf_in_storage_to_la_te_x_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'pages_count' in params: - query_params.append(('pagesCount', params['pages_count'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -8117,7 +8015,7 @@ def get_pdf_in_storage_to_la_te_x_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -8126,14 +8024,14 @@ def get_pdf_in_storage_to_la_te_x_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/latex', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/ink', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='InkAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8141,55 +8039,57 @@ def get_pdf_in_storage_to_la_te_x_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_in_storage_to_mobi_xml(self, name, **kwargs): + def get_page_line_annotations(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to MOBIXML format and returns resulting file in response content + Read document page line annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_mobi_xml(name, callback=callback_function) + >>> thread = api.get_page_line_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: LineAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_in_storage_to_mobi_xml_with_http_info(name, **kwargs) + return self.get_page_line_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pdf_in_storage_to_mobi_xml_with_http_info(name, **kwargs) + (data) = self.get_page_line_annotations_with_http_info(name, page_number, **kwargs) return data - def get_pdf_in_storage_to_mobi_xml_with_http_info(self, name, **kwargs): + def get_page_line_annotations_with_http_info(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to MOBIXML format and returns resulting file in response content + Read document page line annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_mobi_xml_with_http_info(name, callback=callback_function) + >>> thread = api.get_page_line_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: LineAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'folder', 'storage'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8200,13 +8100,16 @@ def get_pdf_in_storage_to_mobi_xml_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_in_storage_to_mobi_xml" % key + " to method get_page_line_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_mobi_xml`") + raise ValueError("Missing the required parameter `name` when calling `get_page_line_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_line_annotations`") collection_formats = {} @@ -8214,12 +8117,14 @@ def get_pdf_in_storage_to_mobi_xml_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -8229,7 +8134,7 @@ def get_pdf_in_storage_to_mobi_xml_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -8238,14 +8143,14 @@ def get_pdf_in_storage_to_mobi_xml_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/mobixml', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/line', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='LineAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8253,57 +8158,59 @@ def get_pdf_in_storage_to_mobi_xml_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_in_storage_to_pdf_a(self, name, type, **kwargs): + def get_page_link_annotation(self, name, page_number, link_id, **kwargs): """ - Converts PDF document (located on storage) to PdfA format and returns resulting file in response content + Read document page link annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_pdf_a(name, type, callback=callback_function) + >>> thread = api.get_page_link_annotation(name, page_number, link_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str type: Type of PdfA format. (required) - :param str folder: The document folder. + :param int page_number: The page number. (required) + :param str link_id: The link ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: LinkAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_in_storage_to_pdf_a_with_http_info(name, type, **kwargs) + return self.get_page_link_annotation_with_http_info(name, page_number, link_id, **kwargs) else: - (data) = self.get_pdf_in_storage_to_pdf_a_with_http_info(name, type, **kwargs) + (data) = self.get_page_link_annotation_with_http_info(name, page_number, link_id, **kwargs) return data - def get_pdf_in_storage_to_pdf_a_with_http_info(self, name, type, **kwargs): + def get_page_link_annotation_with_http_info(self, name, page_number, link_id, **kwargs): """ - Converts PDF document (located on storage) to PdfA format and returns resulting file in response content + Read document page link annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_pdf_a_with_http_info(name, type, callback=callback_function) + >>> thread = api.get_page_link_annotation_with_http_info(name, page_number, link_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str type: Type of PdfA format. (required) - :param str folder: The document folder. + :param int page_number: The page number. (required) + :param str link_id: The link ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: LinkAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'type', 'folder', 'storage'] + all_params = ['name', 'page_number', 'link_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8314,16 +8221,19 @@ def get_pdf_in_storage_to_pdf_a_with_http_info(self, name, type, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_in_storage_to_pdf_a" % key + " to method get_page_link_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_pdf_a`") - # verify the required parameter 'type' is set - if ('type' not in params) or (params['type'] is None): - raise ValueError("Missing the required parameter `type` when calling `get_pdf_in_storage_to_pdf_a`") + raise ValueError("Missing the required parameter `name` when calling `get_page_link_annotation`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_link_annotation`") + # verify the required parameter 'link_id' is set + if ('link_id' not in params) or (params['link_id'] is None): + raise ValueError("Missing the required parameter `link_id` when calling `get_page_link_annotation`") collection_formats = {} @@ -8331,14 +8241,16 @@ def get_pdf_in_storage_to_pdf_a_with_http_info(self, name, type, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] + if 'link_id' in params: + path_params['linkId'] = params['link_id'] query_params = [] - if 'type' in params: - query_params.append(('type', params['type'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -8348,7 +8260,7 @@ def get_pdf_in_storage_to_pdf_a_with_http_info(self, name, type, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -8357,14 +8269,14 @@ def get_pdf_in_storage_to_pdf_a_with_http_info(self, name, type, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/pdfa', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/links/{linkId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='LinkAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8372,59 +8284,57 @@ def get_pdf_in_storage_to_pdf_a_with_http_info(self, name, type, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_in_storage_to_pptx(self, name, **kwargs): + def get_page_link_annotations(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to PPTX format and returns resulting file in response content + Read document page link annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_pptx(name, callback=callback_function) + >>> thread = api.get_page_link_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param bool separate_images: Separate images. - :param bool slides_as_images: Slides as images. - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: LinkAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_in_storage_to_pptx_with_http_info(name, **kwargs) + return self.get_page_link_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pdf_in_storage_to_pptx_with_http_info(name, **kwargs) + (data) = self.get_page_link_annotations_with_http_info(name, page_number, **kwargs) return data - def get_pdf_in_storage_to_pptx_with_http_info(self, name, **kwargs): + def get_page_link_annotations_with_http_info(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to PPTX format and returns resulting file in response content + Read document page link annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_pptx_with_http_info(name, callback=callback_function) + >>> thread = api.get_page_link_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param bool separate_images: Separate images. - :param bool slides_as_images: Slides as images. - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: LinkAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'separate_images', 'slides_as_images', 'folder', 'storage'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8435,13 +8345,16 @@ def get_pdf_in_storage_to_pptx_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_in_storage_to_pptx" % key + " to method get_page_link_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_pptx`") + raise ValueError("Missing the required parameter `name` when calling `get_page_link_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_link_annotations`") collection_formats = {} @@ -8449,16 +8362,14 @@ def get_pdf_in_storage_to_pptx_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'separate_images' in params: - query_params.append(('separateImages', params['separate_images'])) - if 'slides_as_images' in params: - query_params.append(('slidesAsImages', params['slides_as_images'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -8468,7 +8379,7 @@ def get_pdf_in_storage_to_pptx_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -8477,14 +8388,14 @@ def get_pdf_in_storage_to_pptx_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/pptx', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/links', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='LinkAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8492,57 +8403,57 @@ def get_pdf_in_storage_to_pptx_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_in_storage_to_svg(self, name, **kwargs): + def get_page_poly_line_annotations(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to SVG format and returns resulting file in response content + Read document page polyline annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_svg(name, callback=callback_function) + >>> thread = api.get_page_poly_line_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param bool compress_output_to_zip_archive: Specifies whether output will be created as one zip-archive. - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: PolyLineAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_in_storage_to_svg_with_http_info(name, **kwargs) + return self.get_page_poly_line_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pdf_in_storage_to_svg_with_http_info(name, **kwargs) + (data) = self.get_page_poly_line_annotations_with_http_info(name, page_number, **kwargs) return data - def get_pdf_in_storage_to_svg_with_http_info(self, name, **kwargs): + def get_page_poly_line_annotations_with_http_info(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to SVG format and returns resulting file in response content + Read document page polyline annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_svg_with_http_info(name, callback=callback_function) + >>> thread = api.get_page_poly_line_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param bool compress_output_to_zip_archive: Specifies whether output will be created as one zip-archive. - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: PolyLineAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'compress_output_to_zip_archive', 'folder', 'storage'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8553,13 +8464,16 @@ def get_pdf_in_storage_to_svg_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_in_storage_to_svg" % key + " to method get_page_poly_line_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_svg`") + raise ValueError("Missing the required parameter `name` when calling `get_page_poly_line_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_poly_line_annotations`") collection_formats = {} @@ -8567,14 +8481,14 @@ def get_pdf_in_storage_to_svg_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'compress_output_to_zip_archive' in params: - query_params.append(('compressOutputToZipArchive', params['compress_output_to_zip_archive'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -8584,7 +8498,7 @@ def get_pdf_in_storage_to_svg_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -8593,14 +8507,14 @@ def get_pdf_in_storage_to_svg_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/svg', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polyline', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='PolyLineAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8608,85 +8522,57 @@ def get_pdf_in_storage_to_svg_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_in_storage_to_tiff(self, name, **kwargs): + def get_page_polygon_annotations(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to TIFF format and returns resulting file in response content + Read document page polygon annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_tiff(name, callback=callback_function) + >>> thread = api.get_page_polygon_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param float brightness: Image brightness. - :param str compression: Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None. - :param str color_depth: Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp. - :param int left_margin: Left image margin. - :param int right_margin: Right image margin. - :param int top_margin: Top image margin. - :param int bottom_margin: Bottom image margin. - :param str orientation: Image orientation. Possible values are: None, Landscape, Portait. - :param bool skip_blank_pages: Skip blank pages flag. - :param int width: Image width. - :param int height: Image height. - :param int x_resolution: Horizontal resolution. - :param int y_resolution: Vertical resolution. - :param int page_index: Start page to export. - :param int page_count: Number of pages to export. - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: PolygonAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_in_storage_to_tiff_with_http_info(name, **kwargs) + return self.get_page_polygon_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pdf_in_storage_to_tiff_with_http_info(name, **kwargs) + (data) = self.get_page_polygon_annotations_with_http_info(name, page_number, **kwargs) return data - def get_pdf_in_storage_to_tiff_with_http_info(self, name, **kwargs): + def get_page_polygon_annotations_with_http_info(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to TIFF format and returns resulting file in response content + Read document page polygon annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_tiff_with_http_info(name, callback=callback_function) + >>> thread = api.get_page_polygon_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param float brightness: Image brightness. - :param str compression: Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None. - :param str color_depth: Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp. - :param int left_margin: Left image margin. - :param int right_margin: Right image margin. - :param int top_margin: Top image margin. - :param int bottom_margin: Bottom image margin. - :param str orientation: Image orientation. Possible values are: None, Landscape, Portait. - :param bool skip_blank_pages: Skip blank pages flag. - :param int width: Image width. - :param int height: Image height. - :param int x_resolution: Horizontal resolution. - :param int y_resolution: Vertical resolution. - :param int page_index: Start page to export. - :param int page_count: Number of pages to export. - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: PolygonAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'brightness', 'compression', 'color_depth', 'left_margin', 'right_margin', 'top_margin', 'bottom_margin', 'orientation', 'skip_blank_pages', 'width', 'height', 'x_resolution', 'y_resolution', 'page_index', 'page_count', 'folder', 'storage'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8697,13 +8583,16 @@ def get_pdf_in_storage_to_tiff_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_in_storage_to_tiff" % key + " to method get_page_polygon_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_tiff`") + raise ValueError("Missing the required parameter `name` when calling `get_page_polygon_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_polygon_annotations`") collection_formats = {} @@ -8711,42 +8600,14 @@ def get_pdf_in_storage_to_tiff_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'brightness' in params: - query_params.append(('brightness', params['brightness'])) - if 'compression' in params: - query_params.append(('compression', params['compression'])) - if 'color_depth' in params: - query_params.append(('colorDepth', params['color_depth'])) - if 'left_margin' in params: - query_params.append(('leftMargin', params['left_margin'])) - if 'right_margin' in params: - query_params.append(('rightMargin', params['right_margin'])) - if 'top_margin' in params: - query_params.append(('topMargin', params['top_margin'])) - if 'bottom_margin' in params: - query_params.append(('bottomMargin', params['bottom_margin'])) - if 'orientation' in params: - query_params.append(('orientation', params['orientation'])) - if 'skip_blank_pages' in params: - query_params.append(('skipBlankPages', params['skip_blank_pages'])) - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'x_resolution' in params: - query_params.append(('xResolution', params['x_resolution'])) - if 'y_resolution' in params: - query_params.append(('yResolution', params['y_resolution'])) - if 'page_index' in params: - query_params.append(('pageIndex', params['page_index'])) - if 'page_count' in params: - query_params.append(('pageCount', params['page_count'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -8756,7 +8617,7 @@ def get_pdf_in_storage_to_tiff_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -8765,14 +8626,14 @@ def get_pdf_in_storage_to_tiff_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/tiff', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polygon', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='PolygonAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8780,63 +8641,57 @@ def get_pdf_in_storage_to_tiff_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_in_storage_to_xls(self, name, **kwargs): + def get_page_popup_annotations(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to XLS format and returns resulting file in response content + Read document page popup annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_xls(name, callback=callback_function) + >>> thread = api.get_page_popup_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param bool insert_blank_column_at_first: Insert blank column at first - :param bool minimize_the_number_of_worksheets: Minimize the number of worksheets - :param float scale_factor: Scale factor - :param bool uniform_worksheets: Uniform worksheets - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: PopupAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_in_storage_to_xls_with_http_info(name, **kwargs) + return self.get_page_popup_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pdf_in_storage_to_xls_with_http_info(name, **kwargs) + (data) = self.get_page_popup_annotations_with_http_info(name, page_number, **kwargs) return data - def get_pdf_in_storage_to_xls_with_http_info(self, name, **kwargs): + def get_page_popup_annotations_with_http_info(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to XLS format and returns resulting file in response content + Read document page popup annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_xls_with_http_info(name, callback=callback_function) + >>> thread = api.get_page_popup_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param bool insert_blank_column_at_first: Insert blank column at first - :param bool minimize_the_number_of_worksheets: Minimize the number of worksheets - :param float scale_factor: Scale factor - :param bool uniform_worksheets: Uniform worksheets - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: PopupAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'insert_blank_column_at_first', 'minimize_the_number_of_worksheets', 'scale_factor', 'uniform_worksheets', 'folder', 'storage'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8847,13 +8702,16 @@ def get_pdf_in_storage_to_xls_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_in_storage_to_xls" % key + " to method get_page_popup_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_xls`") + raise ValueError("Missing the required parameter `name` when calling `get_page_popup_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_popup_annotations`") collection_formats = {} @@ -8861,20 +8719,14 @@ def get_pdf_in_storage_to_xls_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'insert_blank_column_at_first' in params: - query_params.append(('insertBlankColumnAtFirst', params['insert_blank_column_at_first'])) - if 'minimize_the_number_of_worksheets' in params: - query_params.append(('minimizeTheNumberOfWorksheets', params['minimize_the_number_of_worksheets'])) - if 'scale_factor' in params: - query_params.append(('scaleFactor', params['scale_factor'])) - if 'uniform_worksheets' in params: - query_params.append(('uniformWorksheets', params['uniform_worksheets'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -8884,7 +8736,7 @@ def get_pdf_in_storage_to_xls_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -8893,14 +8745,14 @@ def get_pdf_in_storage_to_xls_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/xls', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/popup', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='PopupAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -8908,55 +8760,57 @@ def get_pdf_in_storage_to_xls_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_in_storage_to_xml(self, name, **kwargs): + def get_page_square_annotations(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to XML format and returns resulting file in response content + Read document page square annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_xml(name, callback=callback_function) + >>> thread = api.get_page_square_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: SquareAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_in_storage_to_xml_with_http_info(name, **kwargs) + return self.get_page_square_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pdf_in_storage_to_xml_with_http_info(name, **kwargs) + (data) = self.get_page_square_annotations_with_http_info(name, page_number, **kwargs) return data - def get_pdf_in_storage_to_xml_with_http_info(self, name, **kwargs): + def get_page_square_annotations_with_http_info(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to XML format and returns resulting file in response content + Read document page square annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_xml_with_http_info(name, callback=callback_function) + >>> thread = api.get_page_square_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: SquareAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'folder', 'storage'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -8967,13 +8821,16 @@ def get_pdf_in_storage_to_xml_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_in_storage_to_xml" % key + " to method get_page_square_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_xml`") + raise ValueError("Missing the required parameter `name` when calling `get_page_square_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_square_annotations`") collection_formats = {} @@ -8981,12 +8838,14 @@ def get_pdf_in_storage_to_xml_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -8996,7 +8855,7 @@ def get_pdf_in_storage_to_xml_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -9005,14 +8864,14 @@ def get_pdf_in_storage_to_xml_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/xml', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/square', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='SquareAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9020,55 +8879,57 @@ def get_pdf_in_storage_to_xml_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pdf_in_storage_to_xps(self, name, **kwargs): + def get_page_squiggly_annotations(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to XPS format and returns resulting file in response content + Read document page squiggly annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_xps(name, callback=callback_function) + >>> thread = api.get_page_squiggly_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: SquigglyAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_pdf_in_storage_to_xps_with_http_info(name, **kwargs) + return self.get_page_squiggly_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_pdf_in_storage_to_xps_with_http_info(name, **kwargs) + (data) = self.get_page_squiggly_annotations_with_http_info(name, page_number, **kwargs) return data - def get_pdf_in_storage_to_xps_with_http_info(self, name, **kwargs): + def get_page_squiggly_annotations_with_http_info(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to XPS format and returns resulting file in response content + Read document page squiggly annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_pdf_in_storage_to_xps_with_http_info(name, callback=callback_function) + >>> thread = api.get_page_squiggly_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str folder: The document folder. + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: SquigglyAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'folder', 'storage'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9079,13 +8940,16 @@ def get_pdf_in_storage_to_xps_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_pdf_in_storage_to_xps" % key + " to method get_page_squiggly_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_xps`") + raise ValueError("Missing the required parameter `name` when calling `get_page_squiggly_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_squiggly_annotations`") collection_formats = {} @@ -9093,12 +8957,14 @@ def get_pdf_in_storage_to_xps_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -9108,7 +8974,7 @@ def get_pdf_in_storage_to_xps_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -9117,14 +8983,14 @@ def get_pdf_in_storage_to_xps_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/xps', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/squiggly', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='SquigglyAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9132,57 +8998,57 @@ def get_pdf_in_storage_to_xps_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_poly_line_annotation(self, name, annotation_id, **kwargs): + def get_page_strike_out_annotations(self, name, page_number, **kwargs): """ - Read document page polyline annotation by ID. + Read document page StrikeOut annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_poly_line_annotation(name, annotation_id, callback=callback_function) + >>> thread = api.get_page_strike_out_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) + :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: PolyLineAnnotationResponse + :return: StrikeOutAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_poly_line_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_page_strike_out_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_poly_line_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_page_strike_out_annotations_with_http_info(name, page_number, **kwargs) return data - def get_poly_line_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_page_strike_out_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page polyline annotation by ID. + Read document page StrikeOut annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_poly_line_annotation_with_http_info(name, annotation_id, callback=callback_function) + >>> thread = api.get_page_strike_out_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) + :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: PolyLineAnnotationResponse + :return: StrikeOutAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'storage', 'folder'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9193,16 +9059,16 @@ def get_poly_line_annotation_with_http_info(self, name, annotation_id, **kwargs) if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_poly_line_annotation" % key + " to method get_page_strike_out_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_poly_line_annotation`") - # verify the required parameter 'annotation_id' is set - if ('annotation_id' not in params) or (params['annotation_id'] is None): - raise ValueError("Missing the required parameter `annotation_id` when calling `get_poly_line_annotation`") + raise ValueError("Missing the required parameter `name` when calling `get_page_strike_out_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_strike_out_annotations`") collection_formats = {} @@ -9210,8 +9076,8 @@ def get_poly_line_annotation_with_http_info(self, name, annotation_id, **kwargs) path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'annotation_id' in params: - path_params['annotationId'] = params['annotation_id'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] if 'storage' in params: @@ -9236,14 +9102,14 @@ def get_poly_line_annotation_with_http_info(self, name, annotation_id, **kwargs) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/polyline/{annotationId}', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/strikeout', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PolyLineAnnotationResponse', + response_type='StrikeOutAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9251,57 +9117,71 @@ def get_poly_line_annotation_with_http_info(self, name, annotation_id, **kwargs) _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_polygon_annotation(self, name, annotation_id, **kwargs): + def get_page_text(self, name, page_number, llx, lly, urx, ury, **kwargs): """ - Read document page polygon annotation by ID. + Read page text items. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_polygon_annotation(name, annotation_id, callback=callback_function) + >>> thread = api.get_page_text(name, page_number, llx, lly, urx, ury, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param str storage: The document storage. + :param int page_number: Number of page (starting from 1). (required) + :param float llx: (required) + :param float lly: (required) + :param float urx: (required) + :param float ury: (required) + :param list[str] format: List of formats for search. + :param str regex: Formats are specified as a regular expression. + :param bool split_rects: Split result fragments (default is true). :param str folder: The document folder. - :return: PolygonAnnotationResponse + :param str storage: The document storage. + :return: TextRectsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_polygon_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) else: - (data) = self.get_polygon_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) return data - def get_polygon_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_page_text_with_http_info(self, name, page_number, llx, lly, urx, ury, **kwargs): """ - Read document page polygon annotation by ID. + Read page text items. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_polygon_annotation_with_http_info(name, annotation_id, callback=callback_function) + >>> thread = api.get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param str storage: The document storage. + :param int page_number: Number of page (starting from 1). (required) + :param float llx: (required) + :param float lly: (required) + :param float urx: (required) + :param float ury: (required) + :param list[str] format: List of formats for search. + :param str regex: Formats are specified as a regular expression. + :param bool split_rects: Split result fragments (default is true). :param str folder: The document folder. - :return: PolygonAnnotationResponse + :param str storage: The document storage. + :return: TextRectsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'storage', 'folder'] + all_params = ['name', 'page_number', 'llx', 'lly', 'urx', 'ury', 'format', 'regex', 'split_rects', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9312,16 +9192,28 @@ def get_polygon_annotation_with_http_info(self, name, annotation_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_polygon_annotation" % key + " to method get_page_text" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_polygon_annotation`") - # verify the required parameter 'annotation_id' is set - if ('annotation_id' not in params) or (params['annotation_id'] is None): - raise ValueError("Missing the required parameter `annotation_id` when calling `get_polygon_annotation`") + raise ValueError("Missing the required parameter `name` when calling `get_page_text`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_text`") + # verify the required parameter 'llx' is set + if ('llx' not in params) or (params['llx'] is None): + raise ValueError("Missing the required parameter `llx` when calling `get_page_text`") + # verify the required parameter 'lly' is set + if ('lly' not in params) or (params['lly'] is None): + raise ValueError("Missing the required parameter `lly` when calling `get_page_text`") + # verify the required parameter 'urx' is set + if ('urx' not in params) or (params['urx'] is None): + raise ValueError("Missing the required parameter `urx` when calling `get_page_text`") + # verify the required parameter 'ury' is set + if ('ury' not in params) or (params['ury'] is None): + raise ValueError("Missing the required parameter `ury` when calling `get_page_text`") collection_formats = {} @@ -9329,14 +9221,29 @@ def get_polygon_annotation_with_http_info(self, name, annotation_id, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'annotation_id' in params: - path_params['annotationId'] = params['annotation_id'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'storage' in params: - query_params.append(('storage', params['storage'])) + if 'format' in params: + query_params.append(('format', params['format'])) + collection_formats['format'] = 'multi' + if 'regex' in params: + query_params.append(('regex', params['regex'])) + if 'split_rects' in params: + query_params.append(('splitRects', params['split_rects'])) if 'folder' in params: query_params.append(('folder', params['folder'])) + if 'llx' in params: + query_params.append(('LLX', params['llx'])) + if 'lly' in params: + query_params.append(('LLY', params['lly'])) + if 'urx' in params: + query_params.append(('URX', params['urx'])) + if 'ury' in params: + query_params.append(('URY', params['ury'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} @@ -9355,14 +9262,14 @@ def get_polygon_annotation_with_http_info(self, name, annotation_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/polygon/{annotationId}', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/text', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PolygonAnnotationResponse', + response_type='TextRectsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9370,53 +9277,57 @@ def get_polygon_annotation_with_http_info(self, name, annotation_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_ps_in_storage_to_pdf(self, src_path, **kwargs): + def get_page_text_annotations(self, name, page_number, **kwargs): """ - Convert PS file (located on storage) to PDF format and return resulting file in response. + Read document page text annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_ps_in_storage_to_pdf(src_path, callback=callback_function) + >>> thread = api.get_page_text_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.ps) (required) + :param str name: The document name. (required) + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: TextAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_ps_in_storage_to_pdf_with_http_info(src_path, **kwargs) + return self.get_page_text_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_ps_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_page_text_annotations_with_http_info(name, page_number, **kwargs) return data - def get_ps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_page_text_annotations_with_http_info(self, name, page_number, **kwargs): """ - Convert PS file (located on storage) to PDF format and return resulting file in response. + Read document page text annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_ps_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) + >>> thread = api.get_page_text_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.ps) (required) + :param str name: The document name. (required) + :param int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: TextAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['src_path', 'storage'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9427,24 +9338,31 @@ def get_ps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_ps_in_storage_to_pdf" % key + " to method get_page_text_annotations" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `get_ps_in_storage_to_pdf`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_page_text_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_text_annotations`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -9454,7 +9372,7 @@ def get_ps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -9463,14 +9381,14 @@ def get_ps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/create/ps', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/text', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='TextAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9478,57 +9396,57 @@ def get_ps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_square_annotation(self, name, annotation_id, **kwargs): + def get_page_underline_annotations(self, name, page_number, **kwargs): """ - Read document page square annotation by ID. + Read document page underline annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_square_annotation(name, annotation_id, callback=callback_function) + >>> thread = api.get_page_underline_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) + :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SquareAnnotationResponse + :return: UnderlineAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_square_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_page_underline_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_square_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_page_underline_annotations_with_http_info(name, page_number, **kwargs) return data - def get_square_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_page_underline_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page square annotation by ID. + Read document page underline annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_square_annotation_with_http_info(name, annotation_id, callback=callback_function) + >>> thread = api.get_page_underline_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) + :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SquareAnnotationResponse + :return: UnderlineAnnotationsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'storage', 'folder'] + all_params = ['name', 'page_number', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9539,16 +9457,16 @@ def get_square_annotation_with_http_info(self, name, annotation_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_square_annotation" % key + " to method get_page_underline_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_square_annotation`") - # verify the required parameter 'annotation_id' is set - if ('annotation_id' not in params) or (params['annotation_id'] is None): - raise ValueError("Missing the required parameter `annotation_id` when calling `get_square_annotation`") + raise ValueError("Missing the required parameter `name` when calling `get_page_underline_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `get_page_underline_annotations`") collection_formats = {} @@ -9556,8 +9474,8 @@ def get_square_annotation_with_http_info(self, name, annotation_id, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'annotation_id' in params: - path_params['annotationId'] = params['annotation_id'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] if 'storage' in params: @@ -9582,14 +9500,14 @@ def get_square_annotation_with_http_info(self, name, annotation_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/square/{annotationId}', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/underline', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SquareAnnotationResponse', + response_type='UnderlineAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9597,69 +9515,55 @@ def get_square_annotation_with_http_info(self, name, annotation_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_svg_in_storage_to_pdf(self, src_path, **kwargs): + def get_pages(self, name, **kwargs): """ - Convert SVG file (located on storage) to PDF format and return resulting file in response. + Read document pages info. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_svg_in_storage_to_pdf(src_path, callback=callback_function) + >>> thread = api.get_pages(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.svg) (required) - :param bool adjust_page_size: Adjust page size - :param float height: Page height - :param float width: Page width - :param bool is_landscape: Is page landscaped - :param float margin_left: Page margin left - :param float margin_bottom: Page margin bottom - :param float margin_right: Page margin right - :param float margin_top: Page margin top + :param str name: The document name. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: DocumentPagesResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_svg_in_storage_to_pdf_with_http_info(src_path, **kwargs) + return self.get_pages_with_http_info(name, **kwargs) else: - (data) = self.get_svg_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_pages_with_http_info(name, **kwargs) return data - def get_svg_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_pages_with_http_info(self, name, **kwargs): """ - Convert SVG file (located on storage) to PDF format and return resulting file in response. + Read document pages info. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_svg_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) + >>> thread = api.get_pages_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.svg) (required) - :param bool adjust_page_size: Adjust page size - :param float height: Page height - :param float width: Page width - :param bool is_landscape: Is page landscaped - :param float margin_left: Page margin left - :param float margin_bottom: Page margin bottom - :param float margin_right: Page margin right - :param float margin_top: Page margin top + :param str name: The document name. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: DocumentPagesResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['src_path', 'adjust_page_size', 'height', 'width', 'is_landscape', 'margin_left', 'margin_bottom', 'margin_right', 'margin_top', 'storage'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9670,40 +9574,26 @@ def get_svg_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_svg_in_storage_to_pdf" % key + " to method get_pages" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `get_svg_in_storage_to_pdf`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_pages`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) - if 'adjust_page_size' in params: - query_params.append(('adjustPageSize', params['adjust_page_size'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'width' in params: - query_params.append(('width', params['width'])) - if 'is_landscape' in params: - query_params.append(('isLandscape', params['is_landscape'])) - if 'margin_left' in params: - query_params.append(('marginLeft', params['margin_left'])) - if 'margin_bottom' in params: - query_params.append(('marginBottom', params['margin_bottom'])) - if 'margin_right' in params: - query_params.append(('marginRight', params['margin_right'])) - if 'margin_top' in params: - query_params.append(('marginTop', params['margin_top'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -9713,7 +9603,7 @@ def get_svg_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['multipart/form-data']) + select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -9722,14 +9612,14 @@ def get_svg_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/create/svg', 'GET', + return self.api_client.call_api('/pdf/{name}/pages', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='DocumentPagesResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9737,69 +9627,53 @@ def get_svg_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_text(self, name, llx, lly, urx, ury, **kwargs): + def get_pcl_in_storage_to_pdf(self, src_path, **kwargs): """ - Read document text. + Convert PCL file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_text(name, llx, lly, urx, ury, callback=callback_function) + >>> thread = api.get_pcl_in_storage_to_pdf(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param float llx: (required) - :param float lly: (required) - :param float urx: (required) - :param float ury: (required) - :param list[str] format: List of formats for search. - :param str regex: Formats are specified as a regular expression. - :param bool split_rects: Split result fragments (default is true). - :param str folder: The document folder. + :param str src_path: Full source filename (ex. /folder1/folder2/template.pcl) (required) :param str storage: The document storage. - :return: TextRectsResponse + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_text_with_http_info(name, llx, lly, urx, ury, **kwargs) + return self.get_pcl_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.get_text_with_http_info(name, llx, lly, urx, ury, **kwargs) + (data) = self.get_pcl_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def get_text_with_http_info(self, name, llx, lly, urx, ury, **kwargs): + def get_pcl_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Read document text. + Convert PCL file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_text_with_http_info(name, llx, lly, urx, ury, callback=callback_function) + >>> thread = api.get_pcl_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param float llx: (required) - :param float lly: (required) - :param float urx: (required) - :param float ury: (required) - :param list[str] format: List of formats for search. - :param str regex: Formats are specified as a regular expression. - :param bool split_rects: Split result fragments (default is true). - :param str folder: The document folder. + :param str src_path: Full source filename (ex. /folder1/folder2/template.pcl) (required) :param str storage: The document storage. - :return: TextRectsResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'llx', 'lly', 'urx', 'ury', 'format', 'regex', 'split_rects', 'folder', 'storage'] + all_params = ['src_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9810,51 +9684,22 @@ def get_text_with_http_info(self, name, llx, lly, urx, ury, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_text" % key + " to method get_pcl_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_text`") - # verify the required parameter 'llx' is set - if ('llx' not in params) or (params['llx'] is None): - raise ValueError("Missing the required parameter `llx` when calling `get_text`") - # verify the required parameter 'lly' is set - if ('lly' not in params) or (params['lly'] is None): - raise ValueError("Missing the required parameter `lly` when calling `get_text`") - # verify the required parameter 'urx' is set - if ('urx' not in params) or (params['urx'] is None): - raise ValueError("Missing the required parameter `urx` when calling `get_text`") - # verify the required parameter 'ury' is set - if ('ury' not in params) or (params['ury'] is None): - raise ValueError("Missing the required parameter `ury` when calling `get_text`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `get_pcl_in_storage_to_pdf`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] query_params = [] - if 'format' in params: - query_params.append(('format', params['format'])) - collection_formats['format'] = 'multi' - if 'regex' in params: - query_params.append(('regex', params['regex'])) - if 'split_rects' in params: - query_params.append(('splitRects', params['split_rects'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) - if 'llx' in params: - query_params.append(('LLX', params['llx'])) - if 'lly' in params: - query_params.append(('LLY', params['lly'])) - if 'urx' in params: - query_params.append(('URX', params['urx'])) - if 'ury' in params: - query_params.append(('URY', params['ury'])) + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -9866,7 +9711,7 @@ def get_text_with_http_info(self, name, llx, lly, urx, ury, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -9875,14 +9720,14 @@ def get_text_with_http_info(self, name, llx, lly, urx, ury, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/text', 'GET', + return self.api_client.call_api('/pdf/create/pcl', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TextRectsResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9890,57 +9735,71 @@ def get_text_with_http_info(self, name, llx, lly, urx, ury, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_text_annotation(self, name, annotation_id, **kwargs): + def get_pdf_in_storage_to_doc(self, name, **kwargs): """ - Read document page text annotation by ID. + Converts PDF document (located on storage) to DOC format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_text_annotation(name, annotation_id, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_doc(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param str storage: The document storage. + :param bool add_return_to_line_end: Add return to line end. + :param str format: Allows to specify .doc or .docx file format. + :param int image_resolution_x: Image resolution X. + :param int image_resolution_y: Image resolution Y. + :param float max_distance_between_text_lines: Max distance between text lines. + :param str mode: Allows to control how a PDF document is converted into a word processing document. + :param bool recognize_bullets: Recognize bullets. + :param float relative_horizontal_proximity: Relative horizontal proximity. :param str folder: The document folder. - :return: TextAnnotationResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_text_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_pdf_in_storage_to_doc_with_http_info(name, **kwargs) else: - (data) = self.get_text_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_pdf_in_storage_to_doc_with_http_info(name, **kwargs) return data - def get_text_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_pdf_in_storage_to_doc_with_http_info(self, name, **kwargs): """ - Read document page text annotation by ID. + Converts PDF document (located on storage) to DOC format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_text_annotation_with_http_info(name, annotation_id, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_doc_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param str storage: The document storage. + :param bool add_return_to_line_end: Add return to line end. + :param str format: Allows to specify .doc or .docx file format. + :param int image_resolution_x: Image resolution X. + :param int image_resolution_y: Image resolution Y. + :param float max_distance_between_text_lines: Max distance between text lines. + :param str mode: Allows to control how a PDF document is converted into a word processing document. + :param bool recognize_bullets: Recognize bullets. + :param float relative_horizontal_proximity: Relative horizontal proximity. :param str folder: The document folder. - :return: TextAnnotationResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'storage', 'folder'] + all_params = ['name', 'add_return_to_line_end', 'format', 'image_resolution_x', 'image_resolution_y', 'max_distance_between_text_lines', 'mode', 'recognize_bullets', 'relative_horizontal_proximity', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9951,16 +9810,13 @@ def get_text_annotation_with_http_info(self, name, annotation_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_text_annotation" % key + " to method get_pdf_in_storage_to_doc" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_text_annotation`") - # verify the required parameter 'annotation_id' is set - if ('annotation_id' not in params) or (params['annotation_id'] is None): - raise ValueError("Missing the required parameter `annotation_id` when calling `get_text_annotation`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_doc`") collection_formats = {} @@ -9968,14 +9824,28 @@ def get_text_annotation_with_http_info(self, name, annotation_id, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'annotation_id' in params: - path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'storage' in params: - query_params.append(('storage', params['storage'])) + if 'add_return_to_line_end' in params: + query_params.append(('addReturnToLineEnd', params['add_return_to_line_end'])) + if 'format' in params: + query_params.append(('format', params['format'])) + if 'image_resolution_x' in params: + query_params.append(('imageResolutionX', params['image_resolution_x'])) + if 'image_resolution_y' in params: + query_params.append(('imageResolutionY', params['image_resolution_y'])) + if 'max_distance_between_text_lines' in params: + query_params.append(('maxDistanceBetweenTextLines', params['max_distance_between_text_lines'])) + if 'mode' in params: + query_params.append(('mode', params['mode'])) + if 'recognize_bullets' in params: + query_params.append(('recognizeBullets', params['recognize_bullets'])) + if 'relative_horizontal_proximity' in params: + query_params.append(('relativeHorizontalProximity', params['relative_horizontal_proximity'])) if 'folder' in params: query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} @@ -9985,7 +9855,7 @@ def get_text_annotation_with_http_info(self, name, annotation_id, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -9994,14 +9864,14 @@ def get_text_annotation_with_http_info(self, name, annotation_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/text/{annotationId}', 'GET', + return self.api_client.call_api('/pdf/{name}/convert/doc', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TextAnnotationResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10009,57 +9879,57 @@ def get_text_annotation_with_http_info(self, name, annotation_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_verify_signature(self, name, sign_name, **kwargs): + def get_pdf_in_storage_to_epub(self, name, **kwargs): """ - Verify signature document. + Converts PDF document (located on storage) to EPUB format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_verify_signature(name, sign_name, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_epub(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str sign_name: Sign name. (required) - :param str storage: The document storage. + :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content. :param str folder: The document folder. - :return: SignatureVerifyResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_verify_signature_with_http_info(name, sign_name, **kwargs) + return self.get_pdf_in_storage_to_epub_with_http_info(name, **kwargs) else: - (data) = self.get_verify_signature_with_http_info(name, sign_name, **kwargs) + (data) = self.get_pdf_in_storage_to_epub_with_http_info(name, **kwargs) return data - def get_verify_signature_with_http_info(self, name, sign_name, **kwargs): + def get_pdf_in_storage_to_epub_with_http_info(self, name, **kwargs): """ - Verify signature document. + Converts PDF document (located on storage) to EPUB format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_verify_signature_with_http_info(name, sign_name, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_epub_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str sign_name: Sign name. (required) - :param str storage: The document storage. + :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content. :param str folder: The document folder. - :return: SignatureVerifyResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'sign_name', 'storage', 'folder'] + all_params = ['name', 'content_recognition_mode', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10070,16 +9940,13 @@ def get_verify_signature_with_http_info(self, name, sign_name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_verify_signature" % key + " to method get_pdf_in_storage_to_epub" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_verify_signature`") - # verify the required parameter 'sign_name' is set - if ('sign_name' not in params) or (params['sign_name'] is None): - raise ValueError("Missing the required parameter `sign_name` when calling `get_verify_signature`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_epub`") collection_formats = {} @@ -10089,12 +9956,12 @@ def get_verify_signature_with_http_info(self, name, sign_name, **kwargs): path_params['name'] = params['name'] query_params = [] - if 'sign_name' in params: - query_params.append(('signName', params['sign_name'])) - if 'storage' in params: - query_params.append(('storage', params['storage'])) + if 'content_recognition_mode' in params: + query_params.append(('contentRecognitionMode', params['content_recognition_mode'])) if 'folder' in params: query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} @@ -10104,7 +9971,7 @@ def get_verify_signature_with_http_info(self, name, sign_name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -10113,14 +9980,14 @@ def get_verify_signature_with_http_info(self, name, sign_name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/verifySignature', 'GET', + return self.api_client.call_api('/pdf/{name}/convert/epub', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SignatureVerifyResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10128,27 +9995,49 @@ def get_verify_signature_with_http_info(self, name, sign_name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_web_in_storage_to_pdf(self, url, **kwargs): + def get_pdf_in_storage_to_html(self, name, **kwargs): """ - Convert web page to PDF format and return resulting file in response. + Converts PDF document (located on storage) to Html format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_web_in_storage_to_pdf(url, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_html(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str url: Source url (required) - :param float height: Page height - :param float width: Page width - :param bool is_landscape: Is page landscaped - :param float margin_left: Page margin left - :param float margin_bottom: Page margin bottom - :param float margin_right: Page margin right - :param float margin_top: Page margin top + :param str name: The document name. (required) + :param int additional_margin_width_in_points: Defines width of margin that will be forcibly left around that output HTML-areas. + :param bool compress_svg_graphics_if_any: The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving. + :param bool convert_marked_content_to_layers: 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 str default_font_name: 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 str document_type: Result document type. + :param bool fixed_layout: The value indicating whether that HTML is created as fixed layout. + :param int image_resolution: Resolution for image rendering. + :param int minimal_line_width: 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 bool prevent_glyphs_grouping: 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 bool split_css_into_pages: 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 bool split_into_pages: 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 bool use_z_order: 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 str antialiasing_processing: The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML. + :param str css_class_names_prefix: 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 list[int] explicit_list_of_saved_pages: 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 str font_encoding_strategy: Defines encoding special rule to tune PDF decoding for current document. + :param str font_saving_mode: Defines font saving mode that will be used during saving of PDF to desirable format. + :param str html_markup_generation_mode: 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 str letters_positioning_method: The mode of positioning of letters in words in result HTML. + :param bool pages_flow_type_depends_on_viewers_screen_size: 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 str parts_embedding_mode: 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 str raster_images_saving_mode: Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML. + :param bool remove_empty_areas_on_top_and_bottom: Defines whether in created HTML will be removed top and bottom empty area without any content (if any). + :param bool save_shadowed_texts_as_transparent_texts: 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 bool save_transparent_texts: 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 str special_folder_for_all_images: 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 str special_folder_for_svg_images: 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 bool try_save_text_underlining_and_strikeouting_in_css: 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 str folder: The document folder. :param str storage: The document storage. :return: file If the method is called asynchronously, @@ -10156,39 +10045,61 @@ def get_web_in_storage_to_pdf(self, url, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_web_in_storage_to_pdf_with_http_info(url, **kwargs) + return self.get_pdf_in_storage_to_html_with_http_info(name, **kwargs) else: - (data) = self.get_web_in_storage_to_pdf_with_http_info(url, **kwargs) + (data) = self.get_pdf_in_storage_to_html_with_http_info(name, **kwargs) return data - def get_web_in_storage_to_pdf_with_http_info(self, url, **kwargs): + def get_pdf_in_storage_to_html_with_http_info(self, name, **kwargs): """ - Convert web page to PDF format and return resulting file in response. + Converts PDF document (located on storage) to Html format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_web_in_storage_to_pdf_with_http_info(url, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_html_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str url: Source url (required) - :param float height: Page height - :param float width: Page width - :param bool is_landscape: Is page landscaped - :param float margin_left: Page margin left - :param float margin_bottom: Page margin bottom - :param float margin_right: Page margin right - :param float margin_top: Page margin top + :param str name: The document name. (required) + :param int additional_margin_width_in_points: Defines width of margin that will be forcibly left around that output HTML-areas. + :param bool compress_svg_graphics_if_any: The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving. + :param bool convert_marked_content_to_layers: 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 str default_font_name: 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 str document_type: Result document type. + :param bool fixed_layout: The value indicating whether that HTML is created as fixed layout. + :param int image_resolution: Resolution for image rendering. + :param int minimal_line_width: 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 bool prevent_glyphs_grouping: 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 bool split_css_into_pages: 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 bool split_into_pages: 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 bool use_z_order: 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 str antialiasing_processing: The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML. + :param str css_class_names_prefix: 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 list[int] explicit_list_of_saved_pages: 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 str font_encoding_strategy: Defines encoding special rule to tune PDF decoding for current document. + :param str font_saving_mode: Defines font saving mode that will be used during saving of PDF to desirable format. + :param str html_markup_generation_mode: 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 str letters_positioning_method: The mode of positioning of letters in words in result HTML. + :param bool pages_flow_type_depends_on_viewers_screen_size: 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 str parts_embedding_mode: 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 str raster_images_saving_mode: Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML. + :param bool remove_empty_areas_on_top_and_bottom: Defines whether in created HTML will be removed top and bottom empty area without any content (if any). + :param bool save_shadowed_texts_as_transparent_texts: 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 bool save_transparent_texts: 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 str special_folder_for_all_images: 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 str special_folder_for_svg_images: 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 bool try_save_text_underlining_and_strikeouting_in_css: 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 str folder: The document folder. :param str storage: The document storage. :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['url', 'height', 'width', 'is_landscape', 'margin_left', 'margin_bottom', 'margin_right', 'margin_top', 'storage'] + all_params = ['name', 'additional_margin_width_in_points', 'compress_svg_graphics_if_any', 'convert_marked_content_to_layers', 'default_font_name', 'document_type', 'fixed_layout', 'image_resolution', 'minimal_line_width', 'prevent_glyphs_grouping', 'split_css_into_pages', 'split_into_pages', 'use_z_order', 'antialiasing_processing', 'css_class_names_prefix', 'explicit_list_of_saved_pages', 'font_encoding_strategy', 'font_saving_mode', 'html_markup_generation_mode', 'letters_positioning_method', 'pages_flow_type_depends_on_viewers_screen_size', 'parts_embedding_mode', 'raster_images_saving_mode', 'remove_empty_areas_on_top_and_bottom', 'save_shadowed_texts_as_transparent_texts', 'save_transparent_texts', 'special_folder_for_all_images', 'special_folder_for_svg_images', 'try_save_text_underlining_and_strikeouting_in_css', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10199,36 +10110,81 @@ def get_web_in_storage_to_pdf_with_http_info(self, url, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_web_in_storage_to_pdf" % key + " to method get_pdf_in_storage_to_html" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'url' is set - if ('url' not in params) or (params['url'] is None): - raise ValueError("Missing the required parameter `url` when calling `get_web_in_storage_to_pdf`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_html`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] query_params = [] - if 'url' in params: - query_params.append(('url', params['url'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'width' in params: - query_params.append(('width', params['width'])) - if 'is_landscape' in params: - query_params.append(('isLandscape', params['is_landscape'])) - if 'margin_left' in params: - query_params.append(('marginLeft', params['margin_left'])) - if 'margin_bottom' in params: - query_params.append(('marginBottom', params['margin_bottom'])) - if 'margin_right' in params: - query_params.append(('marginRight', params['margin_right'])) - if 'margin_top' in params: - query_params.append(('marginTop', params['margin_top'])) + if 'additional_margin_width_in_points' in params: + query_params.append(('additionalMarginWidthInPoints', params['additional_margin_width_in_points'])) + if 'compress_svg_graphics_if_any' in params: + query_params.append(('compressSvgGraphicsIfAny', params['compress_svg_graphics_if_any'])) + if 'convert_marked_content_to_layers' in params: + query_params.append(('convertMarkedContentToLayers', params['convert_marked_content_to_layers'])) + if 'default_font_name' in params: + query_params.append(('defaultFontName', params['default_font_name'])) + if 'document_type' in params: + query_params.append(('documentType', params['document_type'])) + if 'fixed_layout' in params: + query_params.append(('fixedLayout', params['fixed_layout'])) + if 'image_resolution' in params: + query_params.append(('imageResolution', params['image_resolution'])) + if 'minimal_line_width' in params: + query_params.append(('minimalLineWidth', params['minimal_line_width'])) + if 'prevent_glyphs_grouping' in params: + query_params.append(('preventGlyphsGrouping', params['prevent_glyphs_grouping'])) + if 'split_css_into_pages' in params: + query_params.append(('splitCssIntoPages', params['split_css_into_pages'])) + if 'split_into_pages' in params: + query_params.append(('splitIntoPages', params['split_into_pages'])) + if 'use_z_order' in params: + query_params.append(('useZOrder', params['use_z_order'])) + if 'antialiasing_processing' in params: + query_params.append(('antialiasingProcessing', params['antialiasing_processing'])) + if 'css_class_names_prefix' in params: + query_params.append(('cssClassNamesPrefix', params['css_class_names_prefix'])) + if 'explicit_list_of_saved_pages' in params: + query_params.append(('explicitListOfSavedPages', params['explicit_list_of_saved_pages'])) + collection_formats['explicitListOfSavedPages'] = 'multi' + if 'font_encoding_strategy' in params: + query_params.append(('fontEncodingStrategy', params['font_encoding_strategy'])) + if 'font_saving_mode' in params: + query_params.append(('fontSavingMode', params['font_saving_mode'])) + if 'html_markup_generation_mode' in params: + query_params.append(('htmlMarkupGenerationMode', params['html_markup_generation_mode'])) + if 'letters_positioning_method' in params: + query_params.append(('lettersPositioningMethod', params['letters_positioning_method'])) + if 'pages_flow_type_depends_on_viewers_screen_size' in params: + query_params.append(('pagesFlowTypeDependsOnViewersScreenSize', params['pages_flow_type_depends_on_viewers_screen_size'])) + if 'parts_embedding_mode' in params: + query_params.append(('partsEmbeddingMode', params['parts_embedding_mode'])) + if 'raster_images_saving_mode' in params: + query_params.append(('rasterImagesSavingMode', params['raster_images_saving_mode'])) + if 'remove_empty_areas_on_top_and_bottom' in params: + query_params.append(('removeEmptyAreasOnTopAndBottom', params['remove_empty_areas_on_top_and_bottom'])) + if 'save_shadowed_texts_as_transparent_texts' in params: + query_params.append(('saveShadowedTextsAsTransparentTexts', params['save_shadowed_texts_as_transparent_texts'])) + if 'save_transparent_texts' in params: + query_params.append(('saveTransparentTexts', params['save_transparent_texts'])) + if 'special_folder_for_all_images' in params: + query_params.append(('specialFolderForAllImages', params['special_folder_for_all_images'])) + if 'special_folder_for_svg_images' in params: + query_params.append(('specialFolderForSvgImages', params['special_folder_for_svg_images'])) + if 'try_save_text_underlining_and_strikeouting_in_css' in params: + query_params.append(('trySaveTextUnderliningAndStrikeoutingInCss', params['try_save_text_underlining_and_strikeouting_in_css'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -10249,7 +10205,7 @@ def get_web_in_storage_to_pdf_with_http_info(self, url, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/create/web', 'GET', + return self.api_client.call_api('/pdf/{name}/convert/html', 'GET', path_params, query_params, header_params, @@ -10264,55 +10220,57 @@ def get_web_in_storage_to_pdf_with_http_info(self, url, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_words_per_page(self, name, **kwargs): + def get_pdf_in_storage_to_la_te_x(self, name, **kwargs): """ - Get number of words per document page. + Converts PDF document (located on storage) to LaTeX format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_words_per_page(name, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_la_te_x(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str storage: The document storage. + :param int pages_count: Pages count. :param str folder: The document folder. - :return: WordCountResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_words_per_page_with_http_info(name, **kwargs) + return self.get_pdf_in_storage_to_la_te_x_with_http_info(name, **kwargs) else: - (data) = self.get_words_per_page_with_http_info(name, **kwargs) + (data) = self.get_pdf_in_storage_to_la_te_x_with_http_info(name, **kwargs) return data - def get_words_per_page_with_http_info(self, name, **kwargs): + def get_pdf_in_storage_to_la_te_x_with_http_info(self, name, **kwargs): """ - Get number of words per document page. + Converts PDF document (located on storage) to LaTeX format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_words_per_page_with_http_info(name, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_la_te_x_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str storage: The document storage. + :param int pages_count: Pages count. :param str folder: The document folder. - :return: WordCountResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'storage', 'folder'] + all_params = ['name', 'pages_count', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10323,13 +10281,13 @@ def get_words_per_page_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_words_per_page" % key + " to method get_pdf_in_storage_to_la_te_x" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_words_per_page`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_la_te_x`") collection_formats = {} @@ -10339,10 +10297,12 @@ def get_words_per_page_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] query_params = [] - if 'storage' in params: - query_params.append(('storage', params['storage'])) + if 'pages_count' in params: + query_params.append(('pagesCount', params['pages_count'])) if 'folder' in params: query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} @@ -10352,7 +10312,7 @@ def get_words_per_page_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -10361,14 +10321,14 @@ def get_words_per_page_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/wordCount', 'GET', + return self.api_client.call_api('/pdf/{name}/convert/latex', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='WordCountResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10376,16 +10336,16 @@ def get_words_per_page_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_xfa_pdf_in_storage_to_acro_form(self, name, **kwargs): + def get_pdf_in_storage_to_mobi_xml(self, name, **kwargs): """ - Converts PDF document which contatins XFA form (located on storage) to PDF with AcroForm and returns resulting file response content + Converts PDF document (located on storage) to MOBIXML format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_xfa_pdf_in_storage_to_acro_form(name, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_mobi_xml(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -10398,21 +10358,21 @@ def get_xfa_pdf_in_storage_to_acro_form(self, name, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, **kwargs) + return self.get_pdf_in_storage_to_mobi_xml_with_http_info(name, **kwargs) else: - (data) = self.get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, **kwargs) + (data) = self.get_pdf_in_storage_to_mobi_xml_with_http_info(name, **kwargs) return data - def get_xfa_pdf_in_storage_to_acro_form_with_http_info(self, name, **kwargs): + def get_pdf_in_storage_to_mobi_xml_with_http_info(self, name, **kwargs): """ - Converts PDF document which contatins XFA form (located on storage) to PDF with AcroForm and returns resulting file response content + Converts PDF document (located on storage) to MOBIXML format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_mobi_xml_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -10435,13 +10395,13 @@ def get_xfa_pdf_in_storage_to_acro_form_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_xfa_pdf_in_storage_to_acro_form" % key + " to method get_pdf_in_storage_to_mobi_xml" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_xfa_pdf_in_storage_to_acro_form`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_mobi_xml`") collection_formats = {} @@ -10473,7 +10433,7 @@ def get_xfa_pdf_in_storage_to_acro_form_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/xfatoacroform', 'GET', + return self.api_client.call_api('/pdf/{name}/convert/mobixml', 'GET', path_params, query_params, header_params, @@ -10488,21 +10448,22 @@ def get_xfa_pdf_in_storage_to_acro_form_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_xml_in_storage_to_pdf(self, src_path, **kwargs): + def get_pdf_in_storage_to_pdf_a(self, name, type, **kwargs): """ - Convert XML file (located on storage) to PDF format and return resulting file in response. + Converts PDF document (located on storage) to PdfA format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_xml_in_storage_to_pdf(src_path, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_pdf_a(name, type, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.xml) (required) - :param str xsl_file_path: Full XSL source filename (ex. /folder1/folder2/template.xsl) + :param str name: The document name. (required) + :param str type: Type of PdfA format. (required) + :param str folder: The document folder. :param str storage: The document storage. :return: file If the method is called asynchronously, @@ -10510,33 +10471,34 @@ def get_xml_in_storage_to_pdf(self, src_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_xml_in_storage_to_pdf_with_http_info(src_path, **kwargs) + return self.get_pdf_in_storage_to_pdf_a_with_http_info(name, type, **kwargs) else: - (data) = self.get_xml_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_pdf_in_storage_to_pdf_a_with_http_info(name, type, **kwargs) return data - def get_xml_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_pdf_in_storage_to_pdf_a_with_http_info(self, name, type, **kwargs): """ - Convert XML file (located on storage) to PDF format and return resulting file in response. + Converts PDF document (located on storage) to PdfA format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_xml_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_pdf_a_with_http_info(name, type, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.xml) (required) - :param str xsl_file_path: Full XSL source filename (ex. /folder1/folder2/template.xsl) + :param str name: The document name. (required) + :param str type: Type of PdfA format. (required) + :param str folder: The document folder. :param str storage: The document storage. :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['src_path', 'xsl_file_path', 'storage'] + all_params = ['name', 'type', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10547,24 +10509,29 @@ def get_xml_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_xml_in_storage_to_pdf" % key + " to method get_pdf_in_storage_to_pdf_a" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `get_xml_in_storage_to_pdf`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_pdf_a`") + # verify the required parameter 'type' is set + if ('type' not in params) or (params['type'] is None): + raise ValueError("Missing the required parameter `type` when calling `get_pdf_in_storage_to_pdf_a`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) - if 'xsl_file_path' in params: - query_params.append(('xslFilePath', params['xsl_file_path'])) + if 'type' in params: + query_params.append(('type', params['type'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -10585,7 +10552,7 @@ def get_xml_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/create/xml', 'GET', + return self.api_client.call_api('/pdf/{name}/convert/pdfa', 'GET', path_params, query_params, header_params, @@ -10600,20 +10567,23 @@ def get_xml_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_xps_in_storage_to_pdf(self, src_path, **kwargs): + def get_pdf_in_storage_to_pptx(self, name, **kwargs): """ - Convert XPS file (located on storage) to PDF format and return resulting file in response. + Converts PDF document (located on storage) to PPTX format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_xps_in_storage_to_pdf(src_path, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_pptx(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.xps) (required) + :param str name: The document name. (required) + :param bool separate_images: Separate images. + :param bool slides_as_images: Slides as images. + :param str folder: The document folder. :param str storage: The document storage. :return: file If the method is called asynchronously, @@ -10621,32 +10591,35 @@ def get_xps_in_storage_to_pdf(self, src_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_xps_in_storage_to_pdf_with_http_info(src_path, **kwargs) + return self.get_pdf_in_storage_to_pptx_with_http_info(name, **kwargs) else: - (data) = self.get_xps_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_pdf_in_storage_to_pptx_with_http_info(name, **kwargs) return data - def get_xps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_pdf_in_storage_to_pptx_with_http_info(self, name, **kwargs): """ - Convert XPS file (located on storage) to PDF format and return resulting file in response. + Converts PDF document (located on storage) to PPTX format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_xps_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_pptx_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.xps) (required) + :param str name: The document name. (required) + :param bool separate_images: Separate images. + :param bool slides_as_images: Slides as images. + :param str folder: The document folder. :param str storage: The document storage. :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['src_path', 'storage'] + all_params = ['name', 'separate_images', 'slides_as_images', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10657,22 +10630,28 @@ def get_xps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_xps_in_storage_to_pdf" % key + " to method get_pdf_in_storage_to_pptx" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `get_xps_in_storage_to_pdf`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_pptx`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) + if 'separate_images' in params: + query_params.append(('separateImages', params['separate_images'])) + if 'slides_as_images' in params: + query_params.append(('slidesAsImages', params['slides_as_images'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -10693,7 +10672,7 @@ def get_xps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/create/xps', 'GET', + return self.api_client.call_api('/pdf/{name}/convert/pptx', 'GET', path_params, query_params, header_params, @@ -10708,20 +10687,22 @@ def get_xps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_xsl_fo_in_storage_to_pdf(self, src_path, **kwargs): + def get_pdf_in_storage_to_svg(self, name, **kwargs): """ - Convert XslFo file (located on storage) to PDF format and return resulting file in response. + Converts PDF document (located on storage) to SVG format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_xsl_fo_in_storage_to_pdf(src_path, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_svg(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.xslfo) (required) + :param str name: The document name. (required) + :param bool compress_output_to_zip_archive: Specifies whether output will be created as one zip-archive. + :param str folder: The document folder. :param str storage: The document storage. :return: file If the method is called asynchronously, @@ -10729,32 +10710,34 @@ def get_xsl_fo_in_storage_to_pdf(self, src_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, **kwargs) + return self.get_pdf_in_storage_to_svg_with_http_info(name, **kwargs) else: - (data) = self.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_pdf_in_storage_to_svg_with_http_info(name, **kwargs) return data - def get_xsl_fo_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_pdf_in_storage_to_svg_with_http_info(self, name, **kwargs): """ - Convert XslFo file (located on storage) to PDF format and return resulting file in response. + Converts PDF document (located on storage) to SVG format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_svg_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src_path: Full source filename (ex. /folder1/folder2/template.xslfo) (required) + :param str name: The document name. (required) + :param bool compress_output_to_zip_archive: Specifies whether output will be created as one zip-archive. + :param str folder: The document folder. :param str storage: The document storage. :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['src_path', 'storage'] + all_params = ['name', 'compress_output_to_zip_archive', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10765,22 +10748,26 @@ def get_xsl_fo_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_xsl_fo_in_storage_to_pdf" % key + " to method get_pdf_in_storage_to_svg" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `get_xsl_fo_in_storage_to_pdf`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_svg`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) + if 'compress_output_to_zip_archive' in params: + query_params.append(('compressOutputToZipArchive', params['compress_output_to_zip_archive'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -10801,7 +10788,7 @@ def get_xsl_fo_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/create/xslfo', 'GET', + return self.api_client.call_api('/pdf/{name}/convert/svg', 'GET', path_params, query_params, header_params, @@ -10816,63 +10803,85 @@ def get_xsl_fo_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_append_document(self, name, **kwargs): + def get_pdf_in_storage_to_tiff(self, name, **kwargs): """ - Append document to existing one. + Converts PDF document (located on storage) to TIFF format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_append_document(name, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_tiff(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The original document name. (required) - :param AppendDocument append_document: with the append document data. - :param str append_file: Append file server path. - :param int start_page: Appending start page. - :param int end_page: Appending end page. - :param str storage: The documents storage. - :param str folder: The original document folder. - :return: DocumentResponse + :param str name: The document name. (required) + :param float brightness: Image brightness. + :param str compression: Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None. + :param str color_depth: Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp. + :param int left_margin: Left image margin. + :param int right_margin: Right image margin. + :param int top_margin: Top image margin. + :param int bottom_margin: Bottom image margin. + :param str orientation: Image orientation. Possible values are: None, Landscape, Portait. + :param bool skip_blank_pages: Skip blank pages flag. + :param int width: Image width. + :param int height: Image height. + :param int x_resolution: Horizontal resolution. + :param int y_resolution: Vertical resolution. + :param int page_index: Start page to export. + :param int page_count: Number of pages to export. + :param str folder: The document folder. + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_append_document_with_http_info(name, **kwargs) + return self.get_pdf_in_storage_to_tiff_with_http_info(name, **kwargs) else: - (data) = self.post_append_document_with_http_info(name, **kwargs) + (data) = self.get_pdf_in_storage_to_tiff_with_http_info(name, **kwargs) return data - def post_append_document_with_http_info(self, name, **kwargs): + def get_pdf_in_storage_to_tiff_with_http_info(self, name, **kwargs): """ - Append document to existing one. + Converts PDF document (located on storage) to TIFF format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_append_document_with_http_info(name, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_tiff_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The original document name. (required) - :param AppendDocument append_document: with the append document data. - :param str append_file: Append file server path. - :param int start_page: Appending start page. - :param int end_page: Appending end page. - :param str storage: The documents storage. - :param str folder: The original document folder. - :return: DocumentResponse + :param str name: The document name. (required) + :param float brightness: Image brightness. + :param str compression: Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None. + :param str color_depth: Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp. + :param int left_margin: Left image margin. + :param int right_margin: Right image margin. + :param int top_margin: Top image margin. + :param int bottom_margin: Bottom image margin. + :param str orientation: Image orientation. Possible values are: None, Landscape, Portait. + :param bool skip_blank_pages: Skip blank pages flag. + :param int width: Image width. + :param int height: Image height. + :param int x_resolution: Horizontal resolution. + :param int y_resolution: Vertical resolution. + :param int page_index: Start page to export. + :param int page_count: Number of pages to export. + :param str folder: The document folder. + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'append_document', 'append_file', 'start_page', 'end_page', 'storage', 'folder'] + all_params = ['name', 'brightness', 'compression', 'color_depth', 'left_margin', 'right_margin', 'top_margin', 'bottom_margin', 'orientation', 'skip_blank_pages', 'width', 'height', 'x_resolution', 'y_resolution', 'page_index', 'page_count', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10883,13 +10892,13 @@ def post_append_document_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_append_document" % key + " to method get_pdf_in_storage_to_tiff" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_append_document`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_tiff`") collection_formats = {} @@ -10899,28 +10908,50 @@ def post_append_document_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] query_params = [] - if 'append_file' in params: - query_params.append(('appendFile', params['append_file'])) - if 'start_page' in params: - query_params.append(('startPage', params['start_page'])) - if 'end_page' in params: - query_params.append(('endPage', params['end_page'])) - if 'storage' in params: - query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) - + if 'brightness' in params: + query_params.append(('brightness', params['brightness'])) + if 'compression' in params: + query_params.append(('compression', params['compression'])) + if 'color_depth' in params: + query_params.append(('colorDepth', params['color_depth'])) + if 'left_margin' in params: + query_params.append(('leftMargin', params['left_margin'])) + if 'right_margin' in params: + query_params.append(('rightMargin', params['right_margin'])) + if 'top_margin' in params: + query_params.append(('topMargin', params['top_margin'])) + if 'bottom_margin' in params: + query_params.append(('bottomMargin', params['bottom_margin'])) + if 'orientation' in params: + query_params.append(('orientation', params['orientation'])) + if 'skip_blank_pages' in params: + query_params.append(('skipBlankPages', params['skip_blank_pages'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'x_resolution' in params: + query_params.append(('xResolution', params['x_resolution'])) + if 'y_resolution' in params: + query_params.append(('yResolution', params['y_resolution'])) + if 'page_index' in params: + query_params.append(('pageIndex', params['page_index'])) + if 'page_count' in params: + query_params.append(('pageCount', params['page_count'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + header_params = {} form_params = [] local_var_files = {} body_params = None - if 'append_document' in params: - body_params = params['append_document'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -10929,14 +10960,14 @@ def post_append_document_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/appendDocument', 'POST', + return self.api_client.call_api('/pdf/{name}/convert/tiff', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10944,59 +10975,63 @@ def post_append_document_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_create_field(self, name, page, **kwargs): + def get_pdf_in_storage_to_xls(self, name, **kwargs): """ - Create field. + Converts PDF document (located on storage) to XLS format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_create_field(name, page, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_xls(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page: Document page number. (required) - :param Field field: with the field data. - :param str storage: The document storage. + :param bool insert_blank_column_at_first: Insert blank column at first + :param bool minimize_the_number_of_worksheets: Minimize the number of worksheets + :param float scale_factor: Scale factor + :param bool uniform_worksheets: Uniform worksheets :param str folder: The document folder. - :return: AsposeResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_create_field_with_http_info(name, page, **kwargs) + return self.get_pdf_in_storage_to_xls_with_http_info(name, **kwargs) else: - (data) = self.post_create_field_with_http_info(name, page, **kwargs) + (data) = self.get_pdf_in_storage_to_xls_with_http_info(name, **kwargs) return data - def post_create_field_with_http_info(self, name, page, **kwargs): + def get_pdf_in_storage_to_xls_with_http_info(self, name, **kwargs): """ - Create field. + Converts PDF document (located on storage) to XLS format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_create_field_with_http_info(name, page, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_xls_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page: Document page number. (required) - :param Field field: with the field data. - :param str storage: The document storage. + :param bool insert_blank_column_at_first: Insert blank column at first + :param bool minimize_the_number_of_worksheets: Minimize the number of worksheets + :param float scale_factor: Scale factor + :param bool uniform_worksheets: Uniform worksheets :param str folder: The document folder. - :return: AsposeResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page', 'field', 'storage', 'folder'] + all_params = ['name', 'insert_blank_column_at_first', 'minimize_the_number_of_worksheets', 'scale_factor', 'uniform_worksheets', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11007,16 +11042,13 @@ def post_create_field_with_http_info(self, name, page, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_create_field" % key + " to method get_pdf_in_storage_to_xls" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_create_field`") - # verify the required parameter 'page' is set - if ('page' not in params) or (params['page'] is None): - raise ValueError("Missing the required parameter `page` when calling `post_create_field`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_xls`") collection_formats = {} @@ -11026,12 +11058,18 @@ def post_create_field_with_http_info(self, name, page, **kwargs): path_params['name'] = params['name'] query_params = [] - if 'page' in params: - query_params.append(('page', params['page'])) - if 'storage' in params: - query_params.append(('storage', params['storage'])) + if 'insert_blank_column_at_first' in params: + query_params.append(('insertBlankColumnAtFirst', params['insert_blank_column_at_first'])) + if 'minimize_the_number_of_worksheets' in params: + query_params.append(('minimizeTheNumberOfWorksheets', params['minimize_the_number_of_worksheets'])) + if 'scale_factor' in params: + query_params.append(('scaleFactor', params['scale_factor'])) + if 'uniform_worksheets' in params: + query_params.append(('uniformWorksheets', params['uniform_worksheets'])) if 'folder' in params: query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} @@ -11039,11 +11077,9 @@ def post_create_field_with_http_info(self, name, page, **kwargs): local_var_files = {} body_params = None - if 'field' in params: - body_params = params['field'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -11052,14 +11088,14 @@ def post_create_field_with_http_info(self, name, page, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/fields', 'POST', + return self.api_client.call_api('/pdf/{name}/convert/xls', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -11067,57 +11103,55 @@ def post_create_field_with_http_info(self, name, page, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_document_text_replace(self, name, text_replace, **kwargs): + def get_pdf_in_storage_to_xml(self, name, **kwargs): """ - Document's replace text method. + Converts PDF document (located on storage) to XML format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_document_text_replace(name, text_replace, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_xml(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: (required) - :param TextReplaceListRequest text_replace: (required) - :param str storage: - :param str folder: - :return: TextReplaceResponse + :param str name: The document name. (required) + :param str folder: The document folder. + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_document_text_replace_with_http_info(name, text_replace, **kwargs) + return self.get_pdf_in_storage_to_xml_with_http_info(name, **kwargs) else: - (data) = self.post_document_text_replace_with_http_info(name, text_replace, **kwargs) + (data) = self.get_pdf_in_storage_to_xml_with_http_info(name, **kwargs) return data - def post_document_text_replace_with_http_info(self, name, text_replace, **kwargs): + def get_pdf_in_storage_to_xml_with_http_info(self, name, **kwargs): """ - Document's replace text method. + Converts PDF document (located on storage) to XML format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_document_text_replace_with_http_info(name, text_replace, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_xml_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: (required) - :param TextReplaceListRequest text_replace: (required) - :param str storage: - :param str folder: - :return: TextReplaceResponse + :param str name: The document name. (required) + :param str folder: The document folder. + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'text_replace', 'storage', 'folder'] + all_params = ['name', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11128,16 +11162,13 @@ def post_document_text_replace_with_http_info(self, name, text_replace, **kwargs if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_document_text_replace" % key + " to method get_pdf_in_storage_to_xml" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_document_text_replace`") - # verify the required parameter 'text_replace' is set - if ('text_replace' not in params) or (params['text_replace'] is None): - raise ValueError("Missing the required parameter `text_replace` when calling `post_document_text_replace`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_xml`") collection_formats = {} @@ -11147,10 +11178,10 @@ def post_document_text_replace_with_http_info(self, name, text_replace, **kwargs path_params['name'] = params['name'] query_params = [] - if 'storage' in params: - query_params.append(('storage', params['storage'])) if 'folder' in params: query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} @@ -11158,11 +11189,9 @@ def post_document_text_replace_with_http_info(self, name, text_replace, **kwargs local_var_files = {} body_params = None - if 'text_replace' in params: - body_params = params['text_replace'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -11171,14 +11200,14 @@ def post_document_text_replace_with_http_info(self, name, text_replace, **kwargs # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/text/replace', 'POST', + return self.api_client.call_api('/pdf/{name}/convert/xml', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TextReplaceResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -11186,69 +11215,55 @@ def post_document_text_replace_with_http_info(self, name, text_replace, **kwargs _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_insert_image(self, name, page_number, llx, lly, urx, ury, **kwargs): + def get_pdf_in_storage_to_xps(self, name, **kwargs): """ - Insert image to document page. + Converts PDF document (located on storage) to XPS format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_insert_image(name, page_number, llx, lly, urx, ury, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_xps(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param float llx: Coordinate lower left X. (required) - :param float lly: Coordinate lower left Y. (required) - :param float urx: Coordinate upper right X. (required) - :param float ury: Coordinate upper right Y. (required) - :param str image_file_path: Path to image file if specified. Request content is used otherwise. - :param str storage: The document storage. :param str folder: The document folder. - :param file image: Image file. - :return: AsposeResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) + return self.get_pdf_in_storage_to_xps_with_http_info(name, **kwargs) else: - (data) = self.post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) + (data) = self.get_pdf_in_storage_to_xps_with_http_info(name, **kwargs) return data - def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury, **kwargs): + def get_pdf_in_storage_to_xps_with_http_info(self, name, **kwargs): """ - Insert image to document page. + Converts PDF document (located on storage) to XPS format and returns resulting file in response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, callback=callback_function) + >>> thread = api.get_pdf_in_storage_to_xps_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param float llx: Coordinate lower left X. (required) - :param float lly: Coordinate lower left Y. (required) - :param float urx: Coordinate upper right X. (required) - :param float ury: Coordinate upper right Y. (required) - :param str image_file_path: Path to image file if specified. Request content is used otherwise. - :param str storage: The document storage. :param str folder: The document folder. - :param file image: Image file. - :return: AsposeResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'llx', 'lly', 'urx', 'ury', 'image_file_path', 'storage', 'folder', 'image'] + all_params = ['name', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11259,28 +11274,13 @@ def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_insert_image" % key + " to method get_pdf_in_storage_to_xps" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_insert_image`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `post_insert_image`") - # verify the required parameter 'llx' is set - if ('llx' not in params) or (params['llx'] is None): - raise ValueError("Missing the required parameter `llx` when calling `post_insert_image`") - # verify the required parameter 'lly' is set - if ('lly' not in params) or (params['lly'] is None): - raise ValueError("Missing the required parameter `lly` when calling `post_insert_image`") - # verify the required parameter 'urx' is set - if ('urx' not in params) or (params['urx'] is None): - raise ValueError("Missing the required parameter `urx` when calling `post_insert_image`") - # verify the required parameter 'ury' is set - if ('ury' not in params) or (params['ury'] is None): - raise ValueError("Missing the required parameter `ury` when calling `post_insert_image`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_xps`") collection_formats = {} @@ -11288,52 +11288,38 @@ def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] - if 'llx' in params: - query_params.append(('llx', params['llx'])) - if 'lly' in params: - query_params.append(('lly', params['lly'])) - if 'urx' in params: - query_params.append(('urx', params['urx'])) - if 'ury' in params: - query_params.append(('ury', params['ury'])) - if 'image_file_path' in params: - query_params.append(('imageFilePath', params['image_file_path'])) - if 'storage' in params: - query_params.append(('storage', params['storage'])) if 'folder' in params: query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} form_params = [] local_var_files = {} - if 'image' in params: - local_var_files['image'] = params['image'] body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images', 'POST', + return self.api_client.call_api('/pdf/{name}/convert/xps', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -11341,59 +11327,57 @@ def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_move_page(self, name, page_number, new_index, **kwargs): + def get_poly_line_annotation(self, name, annotation_id, **kwargs): """ - Move page to new position. + Read document page polyline annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_move_page(name, page_number, new_index, callback=callback_function) + >>> thread = api.get_poly_line_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param int new_index: The new page position/index. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: PolyLineAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_move_page_with_http_info(name, page_number, new_index, **kwargs) + return self.get_poly_line_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.post_move_page_with_http_info(name, page_number, new_index, **kwargs) + (data) = self.get_poly_line_annotation_with_http_info(name, annotation_id, **kwargs) return data - def post_move_page_with_http_info(self, name, page_number, new_index, **kwargs): + def get_poly_line_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Move page to new position. + Read document page polyline annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_move_page_with_http_info(name, page_number, new_index, callback=callback_function) + >>> thread = api.get_poly_line_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param int new_index: The new page position/index. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: PolyLineAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'new_index', 'storage', 'folder'] + all_params = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11404,19 +11388,16 @@ def post_move_page_with_http_info(self, name, page_number, new_index, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_move_page" % key + " to method get_poly_line_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_move_page`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `post_move_page`") - # verify the required parameter 'new_index' is set - if ('new_index' not in params) or (params['new_index'] is None): - raise ValueError("Missing the required parameter `new_index` when calling `post_move_page`") + raise ValueError("Missing the required parameter `name` when calling `get_poly_line_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_poly_line_annotation`") collection_formats = {} @@ -11424,12 +11405,10 @@ def post_move_page_with_http_info(self, name, page_number, new_index, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'new_index' in params: - query_params.append(('newIndex', params['new_index'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -11452,14 +11431,14 @@ def post_move_page_with_http_info(self, name, page_number, new_index, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/movePage', 'POST', + return self.api_client.call_api('/pdf/{name}/annotations/polyline/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='PolyLineAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -11467,57 +11446,57 @@ def post_move_page_with_http_info(self, name, page_number, new_index, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_optimize_document(self, name, **kwargs): + def get_polygon_annotation(self, name, annotation_id, **kwargs): """ - Optimize document. + Read document page polygon annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_optimize_document(name, callback=callback_function) + >>> thread = api.get_polygon_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param OptimizeOptions options: The optimization options. + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: PolygonAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_optimize_document_with_http_info(name, **kwargs) + return self.get_polygon_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.post_optimize_document_with_http_info(name, **kwargs) + (data) = self.get_polygon_annotation_with_http_info(name, annotation_id, **kwargs) return data - def post_optimize_document_with_http_info(self, name, **kwargs): + def get_polygon_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Optimize document. + Read document page polygon annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_optimize_document_with_http_info(name, callback=callback_function) + >>> thread = api.get_polygon_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param OptimizeOptions options: The optimization options. + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: PolygonAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'options', 'storage', 'folder'] + all_params = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11528,13 +11507,16 @@ def post_optimize_document_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_optimize_document" % key + " to method get_polygon_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_optimize_document`") + raise ValueError("Missing the required parameter `name` when calling `get_polygon_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_polygon_annotation`") collection_formats = {} @@ -11542,6 +11524,8 @@ def post_optimize_document_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] if 'storage' in params: @@ -11555,8 +11539,6 @@ def post_optimize_document_with_http_info(self, name, **kwargs): local_var_files = {} body_params = None - if 'options' in params: - body_params = params['options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -11568,14 +11550,14 @@ def post_optimize_document_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/optimize', 'POST', + return self.api_client.call_api('/pdf/{name}/annotations/polygon/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='PolygonAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -11583,59 +11565,57 @@ def post_optimize_document_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_circle_annotations(self, name, page_number, annotations, **kwargs): + def get_popup_annotation(self, name, annotation_id, **kwargs): """ - Add document page circle annotations. + Read document page popup annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_circle_annotations(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_popup_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[CircleAnnotation] annotations: The array of annotation. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: PopupAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_circle_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.get_popup_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.post_page_circle_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.get_popup_annotation_with_http_info(name, annotation_id, **kwargs) return data - def post_page_circle_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def get_popup_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Add document page circle annotations. + Read document page popup annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_circle_annotations_with_http_info(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_popup_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[CircleAnnotation] annotations: The array of annotation. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: PopupAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] + all_params = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11646,19 +11626,16 @@ def post_page_circle_annotations_with_http_info(self, name, page_number, annotat if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_circle_annotations" % key + " to method get_popup_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_page_circle_annotations`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `post_page_circle_annotations`") - # verify the required parameter 'annotations' is set - if ('annotations' not in params) or (params['annotations'] is None): - raise ValueError("Missing the required parameter `annotations` when calling `post_page_circle_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_popup_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_popup_annotation`") collection_formats = {} @@ -11666,8 +11643,8 @@ def post_page_circle_annotations_with_http_info(self, name, page_number, annotat path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] if 'storage' in params: @@ -11681,8 +11658,6 @@ def post_page_circle_annotations_with_http_info(self, name, page_number, annotat local_var_files = {} body_params = None - if 'annotations' in params: - body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -11694,14 +11669,14 @@ def post_page_circle_annotations_with_http_info(self, name, page_number, annotat # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/circle', 'POST', + return self.api_client.call_api('/pdf/{name}/annotations/popup/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='PopupAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -11709,59 +11684,53 @@ def post_page_circle_annotations_with_http_info(self, name, page_number, annotat _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_free_text_annotations(self, name, page_number, annotations, **kwargs): + def get_ps_in_storage_to_pdf(self, src_path, **kwargs): """ - Add document page free text annotations. + Convert PS file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_free_text_annotations(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_ps_in_storage_to_pdf(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[FreeTextAnnotation] annotations: The array of annotation. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.ps) (required) :param str storage: The document storage. - :param str folder: The document folder. - :return: AsposeResponse + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_free_text_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.get_ps_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.post_page_free_text_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.get_ps_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def post_page_free_text_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def get_ps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Add document page free text annotations. + Convert PS file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_free_text_annotations_with_http_info(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_ps_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[FreeTextAnnotation] annotations: The array of annotation. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.ps) (required) :param str storage: The document storage. - :param str folder: The document folder. - :return: AsposeResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] + all_params = ['src_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11772,34 +11741,24 @@ def post_page_free_text_annotations_with_http_info(self, name, page_number, anno if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_free_text_annotations" % key + " to method get_ps_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_page_free_text_annotations`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `post_page_free_text_annotations`") - # verify the required parameter 'annotations' is set - if ('annotations' not in params) or (params['annotations'] is None): - raise ValueError("Missing the required parameter `annotations` when calling `post_page_free_text_annotations`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `get_ps_in_storage_to_pdf`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) header_params = {} @@ -11807,11 +11766,9 @@ def post_page_free_text_annotations_with_http_info(self, name, page_number, anno local_var_files = {} body_params = None - if 'annotations' in params: - body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -11820,14 +11777,14 @@ def post_page_free_text_annotations_with_http_info(self, name, page_number, anno # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/freetext', 'POST', + return self.api_client.call_api('/pdf/create/ps', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -11835,59 +11792,57 @@ def post_page_free_text_annotations_with_http_info(self, name, page_number, anno _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_line_annotations(self, name, page_number, annotations, **kwargs): + def get_square_annotation(self, name, annotation_id, **kwargs): """ - Add document page line annotations. + Read document page square annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_line_annotations(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_square_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[LineAnnotation] annotations: The array of annotation. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: SquareAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_line_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.get_square_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.post_page_line_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.get_square_annotation_with_http_info(name, annotation_id, **kwargs) return data - def post_page_line_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def get_square_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Add document page line annotations. + Read document page square annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_line_annotations_with_http_info(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_square_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[LineAnnotation] annotations: The array of annotation. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: SquareAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] + all_params = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11898,19 +11853,16 @@ def post_page_line_annotations_with_http_info(self, name, page_number, annotatio if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_line_annotations" % key + " to method get_square_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_page_line_annotations`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `post_page_line_annotations`") - # verify the required parameter 'annotations' is set - if ('annotations' not in params) or (params['annotations'] is None): - raise ValueError("Missing the required parameter `annotations` when calling `post_page_line_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_square_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_square_annotation`") collection_formats = {} @@ -11918,8 +11870,8 @@ def post_page_line_annotations_with_http_info(self, name, page_number, annotatio path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] if 'storage' in params: @@ -11933,8 +11885,6 @@ def post_page_line_annotations_with_http_info(self, name, page_number, annotatio local_var_files = {} body_params = None - if 'annotations' in params: - body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -11946,14 +11896,14 @@ def post_page_line_annotations_with_http_info(self, name, page_number, annotatio # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/line', 'POST', + return self.api_client.call_api('/pdf/{name}/annotations/square/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='SquareAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -11961,59 +11911,57 @@ def post_page_line_annotations_with_http_info(self, name, page_number, annotatio _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_link_annotations(self, name, page_number, links, **kwargs): + def get_squiggly_annotation(self, name, annotation_id, **kwargs): """ - Add document page link annotations. + Read document page squiggly annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_link_annotations(name, page_number, links, callback=callback_function) + >>> thread = api.get_squiggly_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[LinkAnnotation] links: Array of link anotation. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: SquigglyAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_link_annotations_with_http_info(name, page_number, links, **kwargs) + return self.get_squiggly_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.post_page_link_annotations_with_http_info(name, page_number, links, **kwargs) + (data) = self.get_squiggly_annotation_with_http_info(name, annotation_id, **kwargs) return data - def post_page_link_annotations_with_http_info(self, name, page_number, links, **kwargs): + def get_squiggly_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Add document page link annotations. + Read document page squiggly annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_link_annotations_with_http_info(name, page_number, links, callback=callback_function) + >>> thread = api.get_squiggly_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[LinkAnnotation] links: Array of link anotation. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: SquigglyAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'links', 'storage', 'folder'] + all_params = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12024,19 +11972,16 @@ def post_page_link_annotations_with_http_info(self, name, page_number, links, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_link_annotations" % key + " to method get_squiggly_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_page_link_annotations`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `post_page_link_annotations`") - # verify the required parameter 'links' is set - if ('links' not in params) or (params['links'] is None): - raise ValueError("Missing the required parameter `links` when calling `post_page_link_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_squiggly_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_squiggly_annotation`") collection_formats = {} @@ -12044,8 +11989,8 @@ def post_page_link_annotations_with_http_info(self, name, page_number, links, ** path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] if 'storage' in params: @@ -12059,8 +12004,6 @@ def post_page_link_annotations_with_http_info(self, name, page_number, links, ** local_var_files = {} body_params = None - if 'links' in params: - body_params = params['links'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -12072,14 +12015,14 @@ def post_page_link_annotations_with_http_info(self, name, page_number, links, ** # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/links', 'POST', + return self.api_client.call_api('/pdf/{name}/annotations/squiggly/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='SquigglyAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12087,59 +12030,57 @@ def post_page_link_annotations_with_http_info(self, name, page_number, links, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_poly_line_annotations(self, name, page_number, annotations, **kwargs): + def get_strike_out_annotation(self, name, annotation_id, **kwargs): """ - Add document page polyline annotations. + Read document page StrikeOut annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_poly_line_annotations(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_strike_out_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[PolyLineAnnotation] annotations: The array of annotation. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: StrikeOutAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_poly_line_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.get_strike_out_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.post_page_poly_line_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.get_strike_out_annotation_with_http_info(name, annotation_id, **kwargs) return data - def post_page_poly_line_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def get_strike_out_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Add document page polyline annotations. + Read document page StrikeOut annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_poly_line_annotations_with_http_info(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_strike_out_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[PolyLineAnnotation] annotations: The array of annotation. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: StrikeOutAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] + all_params = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12150,19 +12091,16 @@ def post_page_poly_line_annotations_with_http_info(self, name, page_number, anno if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_poly_line_annotations" % key + " to method get_strike_out_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_page_poly_line_annotations`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `post_page_poly_line_annotations`") - # verify the required parameter 'annotations' is set - if ('annotations' not in params) or (params['annotations'] is None): - raise ValueError("Missing the required parameter `annotations` when calling `post_page_poly_line_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_strike_out_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_strike_out_annotation`") collection_formats = {} @@ -12170,8 +12108,8 @@ def post_page_poly_line_annotations_with_http_info(self, name, page_number, anno path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] if 'storage' in params: @@ -12185,8 +12123,6 @@ def post_page_poly_line_annotations_with_http_info(self, name, page_number, anno local_var_files = {} body_params = None - if 'annotations' in params: - body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -12198,14 +12134,14 @@ def post_page_poly_line_annotations_with_http_info(self, name, page_number, anno # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polyline', 'POST', + return self.api_client.call_api('/pdf/{name}/annotations/strikeout/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='StrikeOutAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12213,59 +12149,69 @@ def post_page_poly_line_annotations_with_http_info(self, name, page_number, anno _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_polygon_annotations(self, name, page_number, annotations, **kwargs): + def get_svg_in_storage_to_pdf(self, src_path, **kwargs): """ - Add document page polygon annotations. + Convert SVG file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_polygon_annotations(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_svg_in_storage_to_pdf(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[PolygonAnnotation] annotations: The array of annotation. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.svg) (required) + :param bool adjust_page_size: Adjust page size + :param float height: Page height + :param float width: Page width + :param bool is_landscape: Is page landscaped + :param float margin_left: Page margin left + :param float margin_bottom: Page margin bottom + :param float margin_right: Page margin right + :param float margin_top: Page margin top :param str storage: The document storage. - :param str folder: The document folder. - :return: AsposeResponse + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_polygon_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.get_svg_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.post_page_polygon_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.get_svg_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def post_page_polygon_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def get_svg_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Add document page polygon annotations. + Convert SVG file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_polygon_annotations_with_http_info(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_svg_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[PolygonAnnotation] annotations: The array of annotation. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.svg) (required) + :param bool adjust_page_size: Adjust page size + :param float height: Page height + :param float width: Page width + :param bool is_landscape: Is page landscaped + :param float margin_left: Page margin left + :param float margin_bottom: Page margin bottom + :param float margin_right: Page margin right + :param float margin_top: Page margin top :param str storage: The document storage. - :param str folder: The document folder. - :return: AsposeResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] + all_params = ['src_path', 'adjust_page_size', 'height', 'width', 'is_landscape', 'margin_left', 'margin_bottom', 'margin_right', 'margin_top', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12276,34 +12222,40 @@ def post_page_polygon_annotations_with_http_info(self, name, page_number, annota if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_polygon_annotations" % key + " to method get_svg_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_page_polygon_annotations`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `post_page_polygon_annotations`") - # verify the required parameter 'annotations' is set - if ('annotations' not in params) or (params['annotations'] is None): - raise ValueError("Missing the required parameter `annotations` when calling `post_page_polygon_annotations`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `get_svg_in_storage_to_pdf`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) + if 'adjust_page_size' in params: + query_params.append(('adjustPageSize', params['adjust_page_size'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'is_landscape' in params: + query_params.append(('isLandscape', params['is_landscape'])) + if 'margin_left' in params: + query_params.append(('marginLeft', params['margin_left'])) + if 'margin_bottom' in params: + query_params.append(('marginBottom', params['margin_bottom'])) + if 'margin_right' in params: + query_params.append(('marginRight', params['margin_right'])) + if 'margin_top' in params: + query_params.append(('marginTop', params['margin_top'])) if 'storage' in params: query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) header_params = {} @@ -12311,11 +12263,9 @@ def post_page_polygon_annotations_with_http_info(self, name, page_number, annota local_var_files = {} body_params = None - if 'annotations' in params: - body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -12324,14 +12274,14 @@ def post_page_polygon_annotations_with_http_info(self, name, page_number, annota # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polygon', 'POST', + return self.api_client.call_api('/pdf/create/svg', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12339,59 +12289,69 @@ def post_page_polygon_annotations_with_http_info(self, name, page_number, annota _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_square_annotations(self, name, page_number, annotations, **kwargs): + def get_text(self, name, llx, lly, urx, ury, **kwargs): """ - Add document page square annotations. + Read document text. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_square_annotations(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_text(name, llx, lly, urx, ury, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[SquareAnnotation] annotations: The array of annotation. (required) - :param str storage: The document storage. + :param float llx: (required) + :param float lly: (required) + :param float urx: (required) + :param float ury: (required) + :param list[str] format: List of formats for search. + :param str regex: Formats are specified as a regular expression. + :param bool split_rects: Split result fragments (default is true). :param str folder: The document folder. - :return: AsposeResponse + :param str storage: The document storage. + :return: TextRectsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_square_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.get_text_with_http_info(name, llx, lly, urx, ury, **kwargs) else: - (data) = self.post_page_square_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.get_text_with_http_info(name, llx, lly, urx, ury, **kwargs) return data - def post_page_square_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def get_text_with_http_info(self, name, llx, lly, urx, ury, **kwargs): """ - Add document page square annotations. + Read document text. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_square_annotations_with_http_info(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_text_with_http_info(name, llx, lly, urx, ury, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[SquareAnnotation] annotations: The array of annotation. (required) - :param str storage: The document storage. + :param float llx: (required) + :param float lly: (required) + :param float urx: (required) + :param float ury: (required) + :param list[str] format: List of formats for search. + :param str regex: Formats are specified as a regular expression. + :param bool split_rects: Split result fragments (default is true). :param str folder: The document folder. - :return: AsposeResponse + :param str storage: The document storage. + :return: TextRectsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] + all_params = ['name', 'llx', 'lly', 'urx', 'ury', 'format', 'regex', 'split_rects', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12402,19 +12362,25 @@ def post_page_square_annotations_with_http_info(self, name, page_number, annotat if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_square_annotations" % key + " to method get_text" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_page_square_annotations`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `post_page_square_annotations`") - # verify the required parameter 'annotations' is set - if ('annotations' not in params) or (params['annotations'] is None): - raise ValueError("Missing the required parameter `annotations` when calling `post_page_square_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_text`") + # verify the required parameter 'llx' is set + if ('llx' not in params) or (params['llx'] is None): + raise ValueError("Missing the required parameter `llx` when calling `get_text`") + # verify the required parameter 'lly' is set + if ('lly' not in params) or (params['lly'] is None): + raise ValueError("Missing the required parameter `lly` when calling `get_text`") + # verify the required parameter 'urx' is set + if ('urx' not in params) or (params['urx'] is None): + raise ValueError("Missing the required parameter `urx` when calling `get_text`") + # verify the required parameter 'ury' is set + if ('ury' not in params) or (params['ury'] is None): + raise ValueError("Missing the required parameter `ury` when calling `get_text`") collection_formats = {} @@ -12422,14 +12388,27 @@ def post_page_square_annotations_with_http_info(self, name, page_number, annotat path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] - if 'storage' in params: - query_params.append(('storage', params['storage'])) + if 'format' in params: + query_params.append(('format', params['format'])) + collection_formats['format'] = 'multi' + if 'regex' in params: + query_params.append(('regex', params['regex'])) + if 'split_rects' in params: + query_params.append(('splitRects', params['split_rects'])) if 'folder' in params: query_params.append(('folder', params['folder'])) + if 'llx' in params: + query_params.append(('LLX', params['llx'])) + if 'lly' in params: + query_params.append(('LLY', params['lly'])) + if 'urx' in params: + query_params.append(('URX', params['urx'])) + if 'ury' in params: + query_params.append(('URY', params['ury'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} @@ -12437,8 +12416,6 @@ def post_page_square_annotations_with_http_info(self, name, page_number, annotat local_var_files = {} body_params = None - if 'annotations' in params: - body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -12450,14 +12427,14 @@ def post_page_square_annotations_with_http_info(self, name, page_number, annotat # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/square', 'POST', + return self.api_client.call_api('/pdf/{name}/text', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='TextRectsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12465,59 +12442,57 @@ def post_page_square_annotations_with_http_info(self, name, page_number, annotat _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_text_annotations(self, name, page_number, annotations, **kwargs): + def get_text_annotation(self, name, annotation_id, **kwargs): """ - Add document page text annotations. + Read document page text annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_text_annotations(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_text_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[TextAnnotation] annotations: The array of annotation. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: TextAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_text_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.get_text_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.post_page_text_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.get_text_annotation_with_http_info(name, annotation_id, **kwargs) return data - def post_page_text_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def get_text_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Add document page text annotations. + Read document page text annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_text_annotations_with_http_info(name, page_number, annotations, callback=callback_function) + >>> thread = api.get_text_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param list[TextAnnotation] annotations: The array of annotation. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: TextAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] + all_params = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12528,19 +12503,16 @@ def post_page_text_annotations_with_http_info(self, name, page_number, annotatio if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_text_annotations" % key + " to method get_text_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_page_text_annotations`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `post_page_text_annotations`") - # verify the required parameter 'annotations' is set - if ('annotations' not in params) or (params['annotations'] is None): - raise ValueError("Missing the required parameter `annotations` when calling `post_page_text_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_text_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_text_annotation`") collection_formats = {} @@ -12548,8 +12520,8 @@ def post_page_text_annotations_with_http_info(self, name, page_number, annotatio path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] if 'storage' in params: @@ -12563,8 +12535,6 @@ def post_page_text_annotations_with_http_info(self, name, page_number, annotatio local_var_files = {} body_params = None - if 'annotations' in params: - body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -12576,14 +12546,14 @@ def post_page_text_annotations_with_http_info(self, name, page_number, annotatio # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/text', 'POST', + return self.api_client.call_api('/pdf/{name}/annotations/text/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='TextAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12591,59 +12561,57 @@ def post_page_text_annotations_with_http_info(self, name, page_number, annotatio _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_text_replace(self, name, page_number, text_replace_list_request, **kwargs): + def get_underline_annotation(self, name, annotation_id, **kwargs): """ - Page's replace text method. + Read document page underline annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_text_replace(name, page_number, text_replace_list_request, callback=callback_function) + >>> thread = api.get_underline_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: (required) - :param int page_number: (required) - :param TextReplaceListRequest text_replace_list_request: (required) - :param str storage: - :param str folder: - :return: TextReplaceResponse + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: UnderlineAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, **kwargs) + return self.get_underline_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, **kwargs) + (data) = self.get_underline_annotation_with_http_info(name, annotation_id, **kwargs) return data - def post_page_text_replace_with_http_info(self, name, page_number, text_replace_list_request, **kwargs): + def get_underline_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Page's replace text method. + Read document page underline annotation by ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, callback=callback_function) + >>> thread = api.get_underline_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: (required) - :param int page_number: (required) - :param TextReplaceListRequest text_replace_list_request: (required) - :param str storage: - :param str folder: - :return: TextReplaceResponse + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: UnderlineAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'text_replace_list_request', 'storage', 'folder'] + all_params = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12654,19 +12622,16 @@ def post_page_text_replace_with_http_info(self, name, page_number, text_replace_ if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_text_replace" % key + " to method get_underline_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_page_text_replace`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `post_page_text_replace`") - # verify the required parameter 'text_replace_list_request' is set - if ('text_replace_list_request' not in params) or (params['text_replace_list_request'] is None): - raise ValueError("Missing the required parameter `text_replace_list_request` when calling `post_page_text_replace`") + raise ValueError("Missing the required parameter `name` when calling `get_underline_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `get_underline_annotation`") collection_formats = {} @@ -12674,8 +12639,8 @@ def post_page_text_replace_with_http_info(self, name, page_number, text_replace_ path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] if 'storage' in params: @@ -12689,8 +12654,6 @@ def post_page_text_replace_with_http_info(self, name, page_number, text_replace_ local_var_files = {} body_params = None - if 'text_replace_list_request' in params: - body_params = params['text_replace_list_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -12702,14 +12665,14 @@ def post_page_text_replace_with_http_info(self, name, page_number, text_replace_ # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/text/replace', 'POST', + return self.api_client.call_api('/pdf/{name}/annotations/underline/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TextReplaceResponse', + response_type='UnderlineAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12717,57 +12680,57 @@ def post_page_text_replace_with_http_info(self, name, page_number, text_replace_ _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_sign_document(self, name, **kwargs): + def get_verify_signature(self, name, sign_name, **kwargs): """ - Sign document. + Verify signature document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_sign_document(name, callback=callback_function) + >>> thread = api.get_verify_signature(name, sign_name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param Signature signature: Signature object containing signature data. + :param str sign_name: Sign name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: SignatureVerifyResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_sign_document_with_http_info(name, **kwargs) + return self.get_verify_signature_with_http_info(name, sign_name, **kwargs) else: - (data) = self.post_sign_document_with_http_info(name, **kwargs) + (data) = self.get_verify_signature_with_http_info(name, sign_name, **kwargs) return data - def post_sign_document_with_http_info(self, name, **kwargs): + def get_verify_signature_with_http_info(self, name, sign_name, **kwargs): """ - Sign document. + Verify signature document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_sign_document_with_http_info(name, callback=callback_function) + >>> thread = api.get_verify_signature_with_http_info(name, sign_name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param Signature signature: Signature object containing signature data. + :param str sign_name: Sign name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :return: SignatureVerifyResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'signature', 'storage', 'folder'] + all_params = ['name', 'sign_name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12778,13 +12741,16 @@ def post_sign_document_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_sign_document" % key + " to method get_verify_signature" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_sign_document`") + raise ValueError("Missing the required parameter `name` when calling `get_verify_signature`") + # verify the required parameter 'sign_name' is set + if ('sign_name' not in params) or (params['sign_name'] is None): + raise ValueError("Missing the required parameter `sign_name` when calling `get_verify_signature`") collection_formats = {} @@ -12794,6 +12760,8 @@ def post_sign_document_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] query_params = [] + if 'sign_name' in params: + query_params.append(('signName', params['sign_name'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -12805,8 +12773,6 @@ def post_sign_document_with_http_info(self, name, **kwargs): local_var_files = {} body_params = None - if 'signature' in params: - body_params = params['signature'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -12818,14 +12784,14 @@ def post_sign_document_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/sign', 'POST', + return self.api_client.call_api('/pdf/{name}/verifySignature', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='SignatureVerifyResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12833,59 +12799,67 @@ def post_sign_document_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_sign_page(self, name, page_number, **kwargs): + def get_web_in_storage_to_pdf(self, url, **kwargs): """ - Sign page. + Convert web page to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_sign_page(name, page_number, callback=callback_function) + >>> thread = api.get_web_in_storage_to_pdf(url, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param Signature signature: Signature object containing signature data. + :param str url: Source url (required) + :param float height: Page height + :param float width: Page width + :param bool is_landscape: Is page landscaped + :param float margin_left: Page margin left + :param float margin_bottom: Page margin bottom + :param float margin_right: Page margin right + :param float margin_top: Page margin top :param str storage: The document storage. - :param str folder: The document folder. - :return: AsposeResponse + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_sign_page_with_http_info(name, page_number, **kwargs) + return self.get_web_in_storage_to_pdf_with_http_info(url, **kwargs) else: - (data) = self.post_sign_page_with_http_info(name, page_number, **kwargs) + (data) = self.get_web_in_storage_to_pdf_with_http_info(url, **kwargs) return data - def post_sign_page_with_http_info(self, name, page_number, **kwargs): + def get_web_in_storage_to_pdf_with_http_info(self, url, **kwargs): """ - Sign page. + Convert web page to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_sign_page_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_web_in_storage_to_pdf_with_http_info(url, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param Signature signature: Signature object containing signature data. + :param str url: Source url (required) + :param float height: Page height + :param float width: Page width + :param bool is_landscape: Is page landscaped + :param float margin_left: Page margin left + :param float margin_bottom: Page margin bottom + :param float margin_right: Page margin right + :param float margin_top: Page margin top :param str storage: The document storage. - :param str folder: The document folder. - :return: AsposeResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'signature', 'storage', 'folder'] + all_params = ['url', 'height', 'width', 'is_landscape', 'margin_left', 'margin_bottom', 'margin_right', 'margin_top', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12896,31 +12870,38 @@ def post_sign_page_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_sign_page" % key + " to method get_web_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_sign_page`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `post_sign_page`") + # verify the required parameter 'url' is set + if ('url' not in params) or (params['url'] is None): + raise ValueError("Missing the required parameter `url` when calling `get_web_in_storage_to_pdf`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] + if 'url' in params: + query_params.append(('url', params['url'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'is_landscape' in params: + query_params.append(('isLandscape', params['is_landscape'])) + if 'margin_left' in params: + query_params.append(('marginLeft', params['margin_left'])) + if 'margin_bottom' in params: + query_params.append(('marginBottom', params['margin_bottom'])) + if 'margin_right' in params: + query_params.append(('marginRight', params['margin_right'])) + if 'margin_top' in params: + query_params.append(('marginTop', params['margin_top'])) if 'storage' in params: query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) header_params = {} @@ -12928,11 +12909,9 @@ def post_sign_page_with_http_info(self, name, page_number, **kwargs): local_var_files = {} body_params = None - if 'signature' in params: - body_params = params['signature'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -12941,14 +12920,14 @@ def post_sign_page_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/sign', 'POST', + return self.api_client.call_api('/pdf/create/web', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12956,61 +12935,55 @@ def post_sign_page_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_split_document(self, name, **kwargs): + def get_words_per_page(self, name, **kwargs): """ - Split document to parts. + Get number of words per document page. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_split_document(name, callback=callback_function) + >>> thread = api.get_words_per_page(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: Document name. (required) - :param str format: Resulting documents format. - :param int _from: Start page if defined. - :param int to: End page if defined. + :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SplitResultResponse + :return: WordCountResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_split_document_with_http_info(name, **kwargs) + return self.get_words_per_page_with_http_info(name, **kwargs) else: - (data) = self.post_split_document_with_http_info(name, **kwargs) + (data) = self.get_words_per_page_with_http_info(name, **kwargs) return data - def post_split_document_with_http_info(self, name, **kwargs): + def get_words_per_page_with_http_info(self, name, **kwargs): """ - Split document to parts. + Get number of words per document page. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.post_split_document_with_http_info(name, callback=callback_function) + >>> thread = api.get_words_per_page_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: Document name. (required) - :param str format: Resulting documents format. - :param int _from: Start page if defined. - :param int to: End page if defined. + :param str name: The document name. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SplitResultResponse + :return: WordCountResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'format', '_from', 'to', 'storage', 'folder'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13021,13 +12994,13 @@ def post_split_document_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_split_document" % key + " to method get_words_per_page" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `post_split_document`") + raise ValueError("Missing the required parameter `name` when calling `get_words_per_page`") collection_formats = {} @@ -13037,12 +13010,6 @@ def post_split_document_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] query_params = [] - if 'format' in params: - query_params.append(('format', params['format'])) - if '_from' in params: - query_params.append(('from', params['_from'])) - if 'to' in params: - query_params.append(('to', params['to'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -13065,14 +13032,14 @@ def post_split_document_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/split', 'POST', + return self.api_client.call_api('/pdf/{name}/pages/wordCount', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SplitResultResponse', + response_type='WordCountResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13080,55 +13047,55 @@ def post_split_document_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_add_new_page(self, name, **kwargs): + def get_xfa_pdf_in_storage_to_acro_form(self, name, **kwargs): """ - Add new page to end of the document. + Converts PDF document which contatins XFA form (located on storage) to PDF with AcroForm and returns resulting file response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_add_new_page(name, callback=callback_function) + >>> thread = api.get_xfa_pdf_in_storage_to_acro_form(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str storage: The document storage. :param str folder: The document folder. - :return: DocumentPagesResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_add_new_page_with_http_info(name, **kwargs) + return self.get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, **kwargs) else: - (data) = self.put_add_new_page_with_http_info(name, **kwargs) + (data) = self.get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, **kwargs) return data - def put_add_new_page_with_http_info(self, name, **kwargs): + def get_xfa_pdf_in_storage_to_acro_form_with_http_info(self, name, **kwargs): """ - Add new page to end of the document. + Converts PDF document which contatins XFA form (located on storage) to PDF with AcroForm and returns resulting file response content This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_add_new_page_with_http_info(name, callback=callback_function) + >>> thread = api.get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str storage: The document storage. :param str folder: The document folder. - :return: DocumentPagesResponse + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'storage', 'folder'] + all_params = ['name', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13139,13 +13106,13 @@ def put_add_new_page_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_add_new_page" % key + " to method get_xfa_pdf_in_storage_to_acro_form" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_add_new_page`") + raise ValueError("Missing the required parameter `name` when calling `get_xfa_pdf_in_storage_to_acro_form`") collection_formats = {} @@ -13155,10 +13122,10 @@ def put_add_new_page_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] query_params = [] - if 'storage' in params: - query_params.append(('storage', params['storage'])) if 'folder' in params: query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} @@ -13168,7 +13135,7 @@ def put_add_new_page_with_http_info(self, name, **kwargs): body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -13177,14 +13144,14 @@ def put_add_new_page_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages', 'PUT', + return self.api_client.call_api('/pdf/{name}/convert/xfatoacroform', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentPagesResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13192,59 +13159,55 @@ def put_add_new_page_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_add_text(self, name, page_number, **kwargs): + def get_xml_in_storage_to_pdf(self, src_path, **kwargs): """ - Add text to PDF document page. + Convert XML file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_add_text(name, page_number, callback=callback_function) + >>> thread = api.get_xml_in_storage_to_pdf(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: Number of page (starting from 1). (required) - :param Paragraph paragraph: Paragraph data. - :param str folder: Document folder. + :param str src_path: Full source filename (ex. /folder1/folder2/template.xml) (required) + :param str xsl_file_path: Full XSL source filename (ex. /folder1/folder2/template.xsl) :param str storage: The document storage. - :return: AsposeResponse + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_add_text_with_http_info(name, page_number, **kwargs) + return self.get_xml_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.put_add_text_with_http_info(name, page_number, **kwargs) + (data) = self.get_xml_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def put_add_text_with_http_info(self, name, page_number, **kwargs): + def get_xml_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Add text to PDF document page. + Convert XML file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_add_text_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_xml_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: Number of page (starting from 1). (required) - :param Paragraph paragraph: Paragraph data. - :param str folder: Document folder. + :param str src_path: Full source filename (ex. /folder1/folder2/template.xml) (required) + :param str xsl_file_path: Full XSL source filename (ex. /folder1/folder2/template.xsl) :param str storage: The document storage. - :return: AsposeResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'paragraph', 'folder', 'storage'] + all_params = ['src_path', 'xsl_file_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13255,29 +13218,24 @@ def put_add_text_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_add_text" % key + " to method get_xml_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_add_text`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `put_add_text`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `get_xml_in_storage_to_pdf`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] - if 'folder' in params: - query_params.append(('folder', params['folder'])) + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) + if 'xsl_file_path' in params: + query_params.append(('xslFilePath', params['xsl_file_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -13287,11 +13245,9 @@ def put_add_text_with_http_info(self, name, page_number, **kwargs): local_var_files = {} body_params = None - if 'paragraph' in params: - body_params = params['paragraph'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -13300,14 +13256,14 @@ def put_add_text_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/text', 'PUT', + return self.api_client.call_api('/pdf/create/xml', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13315,59 +13271,53 @@ def put_add_text_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_circle_annotation(self, name, annotation_id, annotation, **kwargs): + def get_xps_in_storage_to_pdf(self, src_path, **kwargs): """ - Replace document circle annotation + Convert XPS file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_circle_annotation(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.get_xps_in_storage_to_pdf(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param CircleAnnotation annotation: Annotation. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.xps) (required) :param str storage: The document storage. - :param str folder: The document folder. - :return: CircleAnnotationResponse + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_circle_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.get_xps_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.put_circle_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.get_xps_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def put_circle_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def get_xps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Replace document circle annotation + Convert XPS file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_circle_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.get_xps_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param CircleAnnotation annotation: Annotation. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.xps) (required) :param str storage: The document storage. - :param str folder: The document folder. - :return: CircleAnnotationResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] + all_params = ['src_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13378,34 +13328,24 @@ def put_circle_annotation_with_http_info(self, name, annotation_id, annotation, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_circle_annotation" % key + " to method get_xps_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_circle_annotation`") - # verify the required parameter 'annotation_id' is set - if ('annotation_id' not in params) or (params['annotation_id'] is None): - raise ValueError("Missing the required parameter `annotation_id` when calling `put_circle_annotation`") - # verify the required parameter 'annotation' is set - if ('annotation' not in params) or (params['annotation'] is None): - raise ValueError("Missing the required parameter `annotation` when calling `put_circle_annotation`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `get_xps_in_storage_to_pdf`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - if 'annotation_id' in params: - path_params['annotationId'] = params['annotation_id'] query_params = [] + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) header_params = {} @@ -13413,11 +13353,9 @@ def put_circle_annotation_with_http_info(self, name, annotation_id, annotation, local_var_files = {} body_params = None - if 'annotation' in params: - body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -13426,14 +13364,14 @@ def put_circle_annotation_with_http_info(self, name, annotation_id, annotation, # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/circle/{annotationId}', 'PUT', + return self.api_client.call_api('/pdf/create/xps', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='CircleAnnotationResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13441,57 +13379,53 @@ def put_circle_annotation_with_http_info(self, name, annotation_id, annotation, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_create(self, path, file, **kwargs): + def get_xsl_fo_in_storage_to_pdf(self, src_path, **kwargs): """ - Upload a specific file + Convert XslFo file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_create(path, file, callback=callback_function) + >>> thread = api.get_xsl_fo_in_storage_to_pdf(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str path: Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext (required) - :param file file: File to upload (required) - :param str version_id: Source file's version - :param str storage: User's storage name - :return: AsposeResponse + :param str src_path: Full source filename (ex. /folder1/folder2/template.xslfo) (required) + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_create_with_http_info(path, file, **kwargs) + return self.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.put_create_with_http_info(path, file, **kwargs) + (data) = self.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def put_create_with_http_info(self, path, file, **kwargs): + def get_xsl_fo_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Upload a specific file + Convert XslFo file (located on storage) to PDF format and return resulting file in response. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_create_with_http_info(path, file, callback=callback_function) + >>> thread = api.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str path: Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext (required) - :param file file: File to upload (required) - :param str version_id: Source file's version - :param str storage: User's storage name - :return: AsposeResponse + :param str src_path: Full source filename (ex. /folder1/folder2/template.xslfo) (required) + :param str storage: The document storage. + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['path', 'file', 'version_id', 'storage'] + all_params = ['src_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13502,16 +13436,13 @@ def put_create_with_http_info(self, path, file, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_create" % key + " to method get_xsl_fo_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'path' is set - if ('path' not in params) or (params['path'] is None): - raise ValueError("Missing the required parameter `path` when calling `put_create`") - # verify the required parameter 'file' is set - if ('file' not in params) or (params['file'] is None): - raise ValueError("Missing the required parameter `file` when calling `put_create`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `get_xsl_fo_in_storage_to_pdf`") collection_formats = {} @@ -13519,10 +13450,8 @@ def put_create_with_http_info(self, path, file, **kwargs): path_params = {} query_params = [] - if 'path' in params: - query_params.append(('path', params['path'])) - if 'version_id' in params: - query_params.append(('versionId', params['version_id'])) + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -13530,29 +13459,27 @@ def put_create_with_http_info(self, path, file, **kwargs): form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['File'] = params['file'] body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/storage/file', 'PUT', + return self.api_client.call_api('/pdf/create/xslfo', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13560,55 +13487,63 @@ def put_create_with_http_info(self, path, file, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_create_document(self, name, **kwargs): + def post_append_document(self, name, **kwargs): """ - Create empty document. + Append document to existing one. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_create_document(name, callback=callback_function) + >>> thread = api.post_append_document(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The new document name. (required) - :param str storage: The document storage. - :param str folder: The new document folder. + :param str name: The original document name. (required) + :param AppendDocument append_document: with the append document data. + :param str append_file: Append file server path. + :param int start_page: Appending start page. + :param int end_page: Appending end page. + :param str storage: The documents storage. + :param str folder: The original document folder. :return: DocumentResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_create_document_with_http_info(name, **kwargs) + return self.post_append_document_with_http_info(name, **kwargs) else: - (data) = self.put_create_document_with_http_info(name, **kwargs) + (data) = self.post_append_document_with_http_info(name, **kwargs) return data - def put_create_document_with_http_info(self, name, **kwargs): + def post_append_document_with_http_info(self, name, **kwargs): """ - Create empty document. + Append document to existing one. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_create_document_with_http_info(name, callback=callback_function) + >>> thread = api.post_append_document_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The new document name. (required) - :param str storage: The document storage. - :param str folder: The new document folder. - :return: DocumentResponse - If the method is called asynchronously, + :param str name: The original document name. (required) + :param AppendDocument append_document: with the append document data. + :param str append_file: Append file server path. + :param int start_page: Appending start page. + :param int end_page: Appending end page. + :param str storage: The documents storage. + :param str folder: The original document folder. + :return: DocumentResponse + If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'storage', 'folder'] + all_params = ['name', 'append_document', 'append_file', 'start_page', 'end_page', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13619,13 +13554,13 @@ def put_create_document_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_create_document" % key + " to method post_append_document" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_create_document`") + raise ValueError("Missing the required parameter `name` when calling `post_append_document`") collection_formats = {} @@ -13635,6 +13570,12 @@ def put_create_document_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] query_params = [] + if 'append_file' in params: + query_params.append(('appendFile', params['append_file'])) + if 'start_page' in params: + query_params.append(('startPage', params['start_page'])) + if 'end_page' in params: + query_params.append(('endPage', params['end_page'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -13646,6 +13587,8 @@ def put_create_document_with_http_info(self, name, **kwargs): local_var_files = {} body_params = None + if 'append_document' in params: + body_params = params['append_document'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -13657,7 +13600,7 @@ def put_create_document_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}', 'PUT', + return self.api_client.call_api('/pdf/{name}/appendDocument', 'POST', path_params, query_params, header_params, @@ -13672,57 +13615,59 @@ def put_create_document_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_epub_in_storage_to_pdf(self, name, src_path, **kwargs): + def post_create_field(self, name, page, **kwargs): """ - Convert EPUB file (located on storage) to PDF format and upload resulting file to storage. + Create field. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_epub_in_storage_to_pdf(name, src_path, callback=callback_function) + >>> thread = api.post_create_field(name, page, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required) + :param int page: Document page number. (required) + :param Field field: with the field data. :param str storage: The document storage. - :param str dst_folder: The destination document folder. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_epub_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + return self.post_create_field_with_http_info(name, page, **kwargs) else: - (data) = self.put_epub_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + (data) = self.post_create_field_with_http_info(name, page, **kwargs) return data - def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): + def post_create_field_with_http_info(self, name, page, **kwargs): """ - Convert EPUB file (located on storage) to PDF format and upload resulting file to storage. + Create field. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_epub_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) + >>> thread = api.post_create_field_with_http_info(name, page, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required) + :param int page: Document page number. (required) + :param Field field: with the field data. :param str storage: The document storage. - :param str dst_folder: The destination document folder. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'src_path', 'storage', 'dst_folder'] + all_params = ['name', 'page', 'field', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13733,16 +13678,16 @@ def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_epub_in_storage_to_pdf" % key + " to method post_create_field" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_epub_in_storage_to_pdf`") - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `put_epub_in_storage_to_pdf`") + raise ValueError("Missing the required parameter `name` when calling `post_create_field`") + # verify the required parameter 'page' is set + if ('page' not in params) or (params['page'] is None): + raise ValueError("Missing the required parameter `page` when calling `post_create_field`") collection_formats = {} @@ -13752,12 +13697,12 @@ def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): path_params['name'] = params['name'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) + if 'page' in params: + query_params.append(('page', params['page'])) if 'storage' in params: query_params.append(('storage', params['storage'])) - if 'dst_folder' in params: - query_params.append(('dstFolder', params['dst_folder'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -13765,6 +13710,8 @@ def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): local_var_files = {} body_params = None + if 'field' in params: + body_params = params['field'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -13776,7 +13723,7 @@ def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/create/epub', 'PUT', + return self.api_client.call_api('/pdf/{name}/fields', 'POST', path_params, query_params, header_params, @@ -13791,55 +13738,57 @@ def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_fields_flatten(self, name, **kwargs): + def post_document_text_replace(self, name, text_replace, **kwargs): """ - Flatten form fields in document. + Document's replace text method. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_fields_flatten(name, callback=callback_function) + >>> thread = api.post_document_text_replace(name, text_replace, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param str storage: The document storage. - :param str folder: The document folder. - :return: AsposeResponse + :param str name: (required) + :param TextReplaceListRequest text_replace: (required) + :param str storage: + :param str folder: + :return: TextReplaceResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_fields_flatten_with_http_info(name, **kwargs) + return self.post_document_text_replace_with_http_info(name, text_replace, **kwargs) else: - (data) = self.put_fields_flatten_with_http_info(name, **kwargs) + (data) = self.post_document_text_replace_with_http_info(name, text_replace, **kwargs) return data - def put_fields_flatten_with_http_info(self, name, **kwargs): + def post_document_text_replace_with_http_info(self, name, text_replace, **kwargs): """ - Flatten form fields in document. + Document's replace text method. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_fields_flatten_with_http_info(name, callback=callback_function) + >>> thread = api.post_document_text_replace_with_http_info(name, text_replace, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param str storage: The document storage. - :param str folder: The document folder. - :return: AsposeResponse + :param str name: (required) + :param TextReplaceListRequest text_replace: (required) + :param str storage: + :param str folder: + :return: TextReplaceResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'storage', 'folder'] + all_params = ['name', 'text_replace', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13850,13 +13799,16 @@ def put_fields_flatten_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_fields_flatten" % key + " to method post_document_text_replace" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_fields_flatten`") + raise ValueError("Missing the required parameter `name` when calling `post_document_text_replace`") + # verify the required parameter 'text_replace' is set + if ('text_replace' not in params) or (params['text_replace'] is None): + raise ValueError("Missing the required parameter `text_replace` when calling `post_document_text_replace`") collection_formats = {} @@ -13877,6 +13829,8 @@ def put_fields_flatten_with_http_info(self, name, **kwargs): local_var_files = {} body_params = None + if 'text_replace' in params: + body_params = params['text_replace'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -13888,14 +13842,14 @@ def put_fields_flatten_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/fields/flatten', 'PUT', + return self.api_client.call_api('/pdf/{name}/text/replace', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='TextReplaceResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13903,59 +13857,69 @@ def put_fields_flatten_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_free_text_annotation(self, name, annotation_id, annotation, **kwargs): + def post_insert_image(self, name, page_number, llx, lly, urx, ury, **kwargs): """ - Replace document free text annotation + Insert image to document page. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_free_text_annotation(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.post_insert_image(name, page_number, llx, lly, urx, ury, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param FreeTextAnnotation annotation: Annotation. (required) + :param int page_number: The page number. (required) + :param float llx: Coordinate lower left X. (required) + :param float lly: Coordinate lower left Y. (required) + :param float urx: Coordinate upper right X. (required) + :param float ury: Coordinate upper right Y. (required) + :param str image_file_path: Path to image file if specified. Request content is used otherwise. :param str storage: The document storage. :param str folder: The document folder. - :return: FreeTextAnnotationResponse + :param file image: Image file. + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_free_text_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) else: - (data) = self.put_free_text_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) return data - def put_free_text_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury, **kwargs): """ - Replace document free text annotation + Insert image to document page. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_free_text_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param FreeTextAnnotation annotation: Annotation. (required) + :param int page_number: The page number. (required) + :param float llx: Coordinate lower left X. (required) + :param float lly: Coordinate lower left Y. (required) + :param float urx: Coordinate upper right X. (required) + :param float ury: Coordinate upper right Y. (required) + :param str image_file_path: Path to image file if specified. Request content is used otherwise. :param str storage: The document storage. :param str folder: The document folder. - :return: FreeTextAnnotationResponse + :param file image: Image file. + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] + all_params = ['name', 'page_number', 'llx', 'lly', 'urx', 'ury', 'image_file_path', 'storage', 'folder', 'image'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13966,19 +13930,28 @@ def put_free_text_annotation_with_http_info(self, name, annotation_id, annotatio if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_free_text_annotation" % key + " to method post_insert_image" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_free_text_annotation`") - # verify the required parameter 'annotation_id' is set - if ('annotation_id' not in params) or (params['annotation_id'] is None): - raise ValueError("Missing the required parameter `annotation_id` when calling `put_free_text_annotation`") - # verify the required parameter 'annotation' is set - if ('annotation' not in params) or (params['annotation'] is None): - raise ValueError("Missing the required parameter `annotation` when calling `put_free_text_annotation`") + raise ValueError("Missing the required parameter `name` when calling `post_insert_image`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `post_insert_image`") + # verify the required parameter 'llx' is set + if ('llx' not in params) or (params['llx'] is None): + raise ValueError("Missing the required parameter `llx` when calling `post_insert_image`") + # verify the required parameter 'lly' is set + if ('lly' not in params) or (params['lly'] is None): + raise ValueError("Missing the required parameter `lly` when calling `post_insert_image`") + # verify the required parameter 'urx' is set + if ('urx' not in params) or (params['urx'] is None): + raise ValueError("Missing the required parameter `urx` when calling `post_insert_image`") + # verify the required parameter 'ury' is set + if ('ury' not in params) or (params['ury'] is None): + raise ValueError("Missing the required parameter `ury` when calling `post_insert_image`") collection_formats = {} @@ -13986,10 +13959,20 @@ def put_free_text_annotation_with_http_info(self, name, annotation_id, annotatio path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'annotation_id' in params: - path_params['annotationId'] = params['annotation_id'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] + if 'llx' in params: + query_params.append(('llx', params['llx'])) + if 'lly' in params: + query_params.append(('lly', params['lly'])) + if 'urx' in params: + query_params.append(('urx', params['urx'])) + if 'ury' in params: + query_params.append(('ury', params['ury'])) + if 'image_file_path' in params: + query_params.append(('imageFilePath', params['image_file_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -13999,29 +13982,29 @@ def put_free_text_annotation_with_http_info(self, name, annotation_id, annotatio form_params = [] local_var_files = {} + if 'image' in params: + local_var_files['image'] = params['image'] body_params = None - if 'annotation' in params: - body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) + select_header_content_type(['multipart/form-data']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/freetext/{annotationId}', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FreeTextAnnotationResponse', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -14029,73 +14012,59 @@ def put_free_text_annotation_with_http_info(self, name, annotation_id, annotatio _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_html_in_storage_to_pdf(self, name, src_path, html_file_name, **kwargs): + def post_move_page(self, name, page_number, new_index, **kwargs): """ - Convert HTML file (located on storage) to PDF format and upload resulting file to storage. + Move page to new position. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_html_in_storage_to_pdf(name, src_path, html_file_name, callback=callback_function) + >>> thread = api.post_move_page(name, page_number, new_index, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str src_path: Full source filename (ex. /folder1/folder2/template.zip) (required) - :param str html_file_name: Name of HTML file in ZIP. (required) - :param float height: Page height - :param float width: Page width - :param bool is_landscape: Is page landscaped - :param float margin_left: Page margin left - :param float margin_bottom: Page margin bottom - :param float margin_right: Page margin right - :param float margin_top: Page margin top - :param str dst_folder: The destination document folder. + :param int page_number: The page number. (required) + :param int new_index: The new page position/index. (required) :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_html_in_storage_to_pdf_with_http_info(name, src_path, html_file_name, **kwargs) + return self.post_move_page_with_http_info(name, page_number, new_index, **kwargs) else: - (data) = self.put_html_in_storage_to_pdf_with_http_info(name, src_path, html_file_name, **kwargs) + (data) = self.post_move_page_with_http_info(name, page_number, new_index, **kwargs) return data - def put_html_in_storage_to_pdf_with_http_info(self, name, src_path, html_file_name, **kwargs): + def post_move_page_with_http_info(self, name, page_number, new_index, **kwargs): """ - Convert HTML file (located on storage) to PDF format and upload resulting file to storage. + Move page to new position. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_html_in_storage_to_pdf_with_http_info(name, src_path, html_file_name, callback=callback_function) + >>> thread = api.post_move_page_with_http_info(name, page_number, new_index, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str src_path: Full source filename (ex. /folder1/folder2/template.zip) (required) - :param str html_file_name: Name of HTML file in ZIP. (required) - :param float height: Page height - :param float width: Page width - :param bool is_landscape: Is page landscaped - :param float margin_left: Page margin left - :param float margin_bottom: Page margin bottom - :param float margin_right: Page margin right - :param float margin_top: Page margin top - :param str dst_folder: The destination document folder. + :param int page_number: The page number. (required) + :param int new_index: The new page position/index. (required) :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'src_path', 'html_file_name', 'height', 'width', 'is_landscape', 'margin_left', 'margin_bottom', 'margin_right', 'margin_top', 'dst_folder', 'storage'] + all_params = ['name', 'page_number', 'new_index', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14106,50 +14075,36 @@ def put_html_in_storage_to_pdf_with_http_info(self, name, src_path, html_file_na if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_html_in_storage_to_pdf" % key + " to method post_move_page" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_html_in_storage_to_pdf`") - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `put_html_in_storage_to_pdf`") - # verify the required parameter 'html_file_name' is set - if ('html_file_name' not in params) or (params['html_file_name'] is None): - raise ValueError("Missing the required parameter `html_file_name` when calling `put_html_in_storage_to_pdf`") - + raise ValueError("Missing the required parameter `name` when calling `post_move_page`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `post_move_page`") + # verify the required parameter 'new_index' is set + if ('new_index' not in params) or (params['new_index'] is None): + raise ValueError("Missing the required parameter `new_index` when calling `post_move_page`") + collection_formats = {} path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) - if 'html_file_name' in params: - query_params.append(('htmlFileName', params['html_file_name'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'width' in params: - query_params.append(('width', params['width'])) - if 'is_landscape' in params: - query_params.append(('isLandscape', params['is_landscape'])) - if 'margin_left' in params: - query_params.append(('marginLeft', params['margin_left'])) - if 'margin_bottom' in params: - query_params.append(('marginBottom', params['margin_bottom'])) - if 'margin_right' in params: - query_params.append(('marginRight', params['margin_right'])) - if 'margin_top' in params: - query_params.append(('marginTop', params['margin_top'])) - if 'dst_folder' in params: - query_params.append(('dstFolder', params['dst_folder'])) + if 'new_index' in params: + query_params.append(('newIndex', params['new_index'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -14168,7 +14123,7 @@ def put_html_in_storage_to_pdf_with_http_info(self, name, src_path, html_file_na # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/create/html', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/movePage', 'POST', path_params, query_params, header_params, @@ -14183,63 +14138,57 @@ def put_html_in_storage_to_pdf_with_http_info(self, name, src_path, html_file_na _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_image_extract_as_gif(self, name, image_id, **kwargs): + def post_optimize_document(self, name, **kwargs): """ - Extract document image in GIF format to folder + Optimize document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_image_extract_as_gif(name, image_id, callback=callback_function) + >>> thread = api.post_optimize_document(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param OptimizeOptions options: The optimization options. :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_image_extract_as_gif_with_http_info(name, image_id, **kwargs) + return self.post_optimize_document_with_http_info(name, **kwargs) else: - (data) = self.put_image_extract_as_gif_with_http_info(name, image_id, **kwargs) + (data) = self.post_optimize_document_with_http_info(name, **kwargs) return data - def put_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): + def post_optimize_document_with_http_info(self, name, **kwargs): """ - Extract document image in GIF format to folder + Optimize document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_image_extract_as_gif_with_http_info(name, image_id, callback=callback_function) + >>> thread = api.post_optimize_document_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param OptimizeOptions options: The optimization options. :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params = ['name', 'options', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14250,16 +14199,13 @@ def put_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_image_extract_as_gif" % key + " to method post_optimize_document" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_image_extract_as_gif`") - # verify the required parameter 'image_id' is set - if ('image_id' not in params) or (params['image_id'] is None): - raise ValueError("Missing the required parameter `image_id` when calling `put_image_extract_as_gif`") + raise ValueError("Missing the required parameter `name` when calling `post_optimize_document`") collection_formats = {} @@ -14267,20 +14213,12 @@ def put_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'image_id' in params: - path_params['imageId'] = params['image_id'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: query_params.append(('folder', params['folder'])) - if 'dest_folder' in params: - query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -14288,6 +14226,8 @@ def put_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): local_var_files = {} body_params = None + if 'options' in params: + body_params = params['options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -14299,7 +14239,7 @@ def put_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/gif', 'PUT', + return self.api_client.call_api('/pdf/{name}/optimize', 'POST', path_params, query_params, header_params, @@ -14314,63 +14254,59 @@ def put_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_image_extract_as_jpeg(self, name, image_id, **kwargs): + def post_page_caret_annotations(self, name, page_number, annotations, **kwargs): """ - Extract document image in JPEG format to folder + Add document page caret annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_image_extract_as_jpeg(name, image_id, callback=callback_function) + >>> thread = api.post_page_caret_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param int page_number: The page number. (required) + :param list[CaretAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs) + return self.post_page_caret_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs) + (data) = self.post_page_caret_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): + def post_page_caret_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Extract document image in JPEG format to folder + Add document page caret annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_image_extract_as_jpeg_with_http_info(name, image_id, callback=callback_function) + >>> thread = api.post_page_caret_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param int page_number: The page number. (required) + :param list[CaretAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14381,16 +14317,19 @@ def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_image_extract_as_jpeg" % key + " to method post_page_caret_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_image_extract_as_jpeg`") - # verify the required parameter 'image_id' is set - if ('image_id' not in params) or (params['image_id'] is None): - raise ValueError("Missing the required parameter `image_id` when calling `put_image_extract_as_jpeg`") + raise ValueError("Missing the required parameter `name` when calling `post_page_caret_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `post_page_caret_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_caret_annotations`") collection_formats = {} @@ -14398,20 +14337,14 @@ def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'image_id' in params: - path_params['imageId'] = params['image_id'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: query_params.append(('folder', params['folder'])) - if 'dest_folder' in params: - query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -14419,6 +14352,8 @@ def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): local_var_files = {} body_params = None + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -14430,7 +14365,7 @@ def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/jpeg', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/caret', 'POST', path_params, query_params, header_params, @@ -14445,63 +14380,59 @@ def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_image_extract_as_png(self, name, image_id, **kwargs): + def post_page_circle_annotations(self, name, page_number, annotations, **kwargs): """ - Extract document image in PNG format to folder + Add document page circle annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_image_extract_as_png(name, image_id, callback=callback_function) + >>> thread = api.post_page_circle_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param int page_number: The page number. (required) + :param list[CircleAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_image_extract_as_png_with_http_info(name, image_id, **kwargs) + return self.post_page_circle_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_image_extract_as_png_with_http_info(name, image_id, **kwargs) + (data) = self.post_page_circle_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): + def post_page_circle_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Extract document image in PNG format to folder + Add document page circle annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_image_extract_as_png_with_http_info(name, image_id, callback=callback_function) + >>> thread = api.post_page_circle_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param int page_number: The page number. (required) + :param list[CircleAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14512,16 +14443,19 @@ def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_image_extract_as_png" % key + " to method post_page_circle_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_image_extract_as_png`") - # verify the required parameter 'image_id' is set - if ('image_id' not in params) or (params['image_id'] is None): - raise ValueError("Missing the required parameter `image_id` when calling `put_image_extract_as_png`") + raise ValueError("Missing the required parameter `name` when calling `post_page_circle_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `post_page_circle_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_circle_annotations`") collection_formats = {} @@ -14529,20 +14463,14 @@ def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'image_id' in params: - path_params['imageId'] = params['image_id'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: query_params.append(('folder', params['folder'])) - if 'dest_folder' in params: - query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -14550,6 +14478,8 @@ def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): local_var_files = {} body_params = None + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -14561,7 +14491,7 @@ def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/png', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/circle', 'POST', path_params, query_params, header_params, @@ -14576,63 +14506,59 @@ def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_image_extract_as_tiff(self, name, image_id, **kwargs): + def post_page_free_text_annotations(self, name, page_number, annotations, **kwargs): """ - Extract document image in TIFF format to folder + Add document page free text annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_image_extract_as_tiff(name, image_id, callback=callback_function) + >>> thread = api.post_page_free_text_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param int page_number: The page number. (required) + :param list[FreeTextAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_image_extract_as_tiff_with_http_info(name, image_id, **kwargs) + return self.post_page_free_text_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_image_extract_as_tiff_with_http_info(name, image_id, **kwargs) + (data) = self.post_page_free_text_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): + def post_page_free_text_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Extract document image in TIFF format to folder + Add document page free text annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_image_extract_as_tiff_with_http_info(name, image_id, callback=callback_function) + >>> thread = api.post_page_free_text_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str image_id: Image ID. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param int page_number: The page number. (required) + :param list[FreeTextAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14643,16 +14569,19 @@ def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_image_extract_as_tiff" % key + " to method post_page_free_text_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_image_extract_as_tiff`") - # verify the required parameter 'image_id' is set - if ('image_id' not in params) or (params['image_id'] is None): - raise ValueError("Missing the required parameter `image_id` when calling `put_image_extract_as_tiff`") + raise ValueError("Missing the required parameter `name` when calling `post_page_free_text_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `post_page_free_text_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_free_text_annotations`") collection_formats = {} @@ -14660,20 +14589,14 @@ def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'image_id' in params: - path_params['imageId'] = params['image_id'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: query_params.append(('folder', params['folder'])) - if 'dest_folder' in params: - query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -14681,6 +14604,8 @@ def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): local_var_files = {} body_params = None + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -14692,7 +14617,7 @@ def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/tiff', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/freetext', 'POST', path_params, query_params, header_params, @@ -14707,57 +14632,59 @@ def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_image_in_storage_to_pdf(self, name, image_templates, **kwargs): + def post_page_highlight_annotations(self, name, page_number, annotations, **kwargs): """ - Convert image file (located on storage) to PDF format and upload resulting file to storage. + Add document page highlight annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_image_in_storage_to_pdf(name, image_templates, callback=callback_function) + >>> thread = api.post_page_highlight_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param ImageTemplatesRequest image_templates: Image templates (required) - :param str dst_folder: The destination document folder. + :param int page_number: The page number. (required) + :param list[HighlightAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_image_in_storage_to_pdf_with_http_info(name, image_templates, **kwargs) + return self.post_page_highlight_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_image_in_storage_to_pdf_with_http_info(name, image_templates, **kwargs) + (data) = self.post_page_highlight_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kwargs): + def post_page_highlight_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Convert image file (located on storage) to PDF format and upload resulting file to storage. + Add document page highlight annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_image_in_storage_to_pdf_with_http_info(name, image_templates, callback=callback_function) + >>> thread = api.post_page_highlight_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param ImageTemplatesRequest image_templates: Image templates (required) - :param str dst_folder: The destination document folder. + :param int page_number: The page number. (required) + :param list[HighlightAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_templates', 'dst_folder', 'storage'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14768,16 +14695,19 @@ def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kw if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_image_in_storage_to_pdf" % key + " to method post_page_highlight_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_image_in_storage_to_pdf`") - # verify the required parameter 'image_templates' is set - if ('image_templates' not in params) or (params['image_templates'] is None): - raise ValueError("Missing the required parameter `image_templates` when calling `put_image_in_storage_to_pdf`") + raise ValueError("Missing the required parameter `name` when calling `post_page_highlight_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `post_page_highlight_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_highlight_annotations`") collection_formats = {} @@ -14785,12 +14715,14 @@ def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kw path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'dst_folder' in params: - query_params.append(('dstFolder', params['dst_folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -14798,8 +14730,8 @@ def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kw local_var_files = {} body_params = None - if 'image_templates' in params: - body_params = params['image_templates'] + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -14811,7 +14743,7 @@ def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kw # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/create/images', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/highlight', 'POST', path_params, query_params, header_params, @@ -14826,63 +14758,59 @@ def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kw _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_images_extract_as_gif(self, name, page_number, **kwargs): + def post_page_ink_annotations(self, name, page_number, annotations, **kwargs): """ - Extract document images in GIF format to folder. + Add document page ink annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_images_extract_as_gif(name, page_number, callback=callback_function) + >>> thread = api.post_page_ink_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param list[InkAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_images_extract_as_gif_with_http_info(name, page_number, **kwargs) + return self.post_page_ink_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_images_extract_as_gif_with_http_info(name, page_number, **kwargs) + (data) = self.post_page_ink_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_images_extract_as_gif_with_http_info(self, name, page_number, **kwargs): + def post_page_ink_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Extract document images in GIF format to folder. + Add document page ink annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_images_extract_as_gif_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.post_page_ink_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param list[InkAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14893,16 +14821,19 @@ def put_images_extract_as_gif_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_images_extract_as_gif" % key + " to method post_page_ink_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_images_extract_as_gif`") + raise ValueError("Missing the required parameter `name` when calling `post_page_ink_annotations`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `put_images_extract_as_gif`") + raise ValueError("Missing the required parameter `page_number` when calling `post_page_ink_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_ink_annotations`") collection_formats = {} @@ -14914,16 +14845,10 @@ def put_images_extract_as_gif_with_http_info(self, name, page_number, **kwargs): path_params['pageNumber'] = params['page_number'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: query_params.append(('folder', params['folder'])) - if 'dest_folder' in params: - query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -14931,6 +14856,8 @@ def put_images_extract_as_gif_with_http_info(self, name, page_number, **kwargs): local_var_files = {} body_params = None + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -14942,7 +14869,7 @@ def put_images_extract_as_gif_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/gif', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/ink', 'POST', path_params, query_params, header_params, @@ -14957,63 +14884,59 @@ def put_images_extract_as_gif_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_images_extract_as_jpeg(self, name, page_number, **kwargs): + def post_page_line_annotations(self, name, page_number, annotations, **kwargs): """ - Extract document images in JPEG format to folder. + Add document page line annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_images_extract_as_jpeg(name, page_number, callback=callback_function) + >>> thread = api.post_page_line_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str storage: + :param list[LineAnnotation] annotations: The array of annotation. (required) + :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_images_extract_as_jpeg_with_http_info(name, page_number, **kwargs) + return self.post_page_line_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_images_extract_as_jpeg_with_http_info(name, page_number, **kwargs) + (data) = self.post_page_line_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_images_extract_as_jpeg_with_http_info(self, name, page_number, **kwargs): + def post_page_line_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Extract document images in JPEG format to folder. + Add document page line annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_images_extract_as_jpeg_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.post_page_line_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str storage: + :param list[LineAnnotation] annotations: The array of annotation. (required) + :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15024,16 +14947,19 @@ def put_images_extract_as_jpeg_with_http_info(self, name, page_number, **kwargs) if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_images_extract_as_jpeg" % key + " to method post_page_line_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_images_extract_as_jpeg`") + raise ValueError("Missing the required parameter `name` when calling `post_page_line_annotations`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `put_images_extract_as_jpeg`") + raise ValueError("Missing the required parameter `page_number` when calling `post_page_line_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_line_annotations`") collection_formats = {} @@ -15045,16 +14971,10 @@ def put_images_extract_as_jpeg_with_http_info(self, name, page_number, **kwargs) path_params['pageNumber'] = params['page_number'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: query_params.append(('folder', params['folder'])) - if 'dest_folder' in params: - query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -15062,6 +14982,8 @@ def put_images_extract_as_jpeg_with_http_info(self, name, page_number, **kwargs) local_var_files = {} body_params = None + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -15073,7 +14995,7 @@ def put_images_extract_as_jpeg_with_http_info(self, name, page_number, **kwargs) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/jpeg', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/line', 'POST', path_params, query_params, header_params, @@ -15088,63 +15010,59 @@ def put_images_extract_as_jpeg_with_http_info(self, name, page_number, **kwargs) _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_images_extract_as_png(self, name, page_number, **kwargs): + def post_page_link_annotations(self, name, page_number, links, **kwargs): """ - Extract document images in PNG format to folder. + Add document page link annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_images_extract_as_png(name, page_number, callback=callback_function) + >>> thread = api.post_page_link_annotations(name, page_number, links, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param list[LinkAnnotation] links: Array of link anotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_images_extract_as_png_with_http_info(name, page_number, **kwargs) + return self.post_page_link_annotations_with_http_info(name, page_number, links, **kwargs) else: - (data) = self.put_images_extract_as_png_with_http_info(name, page_number, **kwargs) + (data) = self.post_page_link_annotations_with_http_info(name, page_number, links, **kwargs) return data - def put_images_extract_as_png_with_http_info(self, name, page_number, **kwargs): + def post_page_link_annotations_with_http_info(self, name, page_number, links, **kwargs): """ - Extract document images in PNG format to folder. + Add document page link annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_images_extract_as_png_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.post_page_link_annotations_with_http_info(name, page_number, links, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param list[LinkAnnotation] links: Array of link anotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params = ['name', 'page_number', 'links', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15155,16 +15073,19 @@ def put_images_extract_as_png_with_http_info(self, name, page_number, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_images_extract_as_png" % key + " to method post_page_link_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_images_extract_as_png`") + raise ValueError("Missing the required parameter `name` when calling `post_page_link_annotations`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `put_images_extract_as_png`") + raise ValueError("Missing the required parameter `page_number` when calling `post_page_link_annotations`") + # verify the required parameter 'links' is set + if ('links' not in params) or (params['links'] is None): + raise ValueError("Missing the required parameter `links` when calling `post_page_link_annotations`") collection_formats = {} @@ -15176,16 +15097,10 @@ def put_images_extract_as_png_with_http_info(self, name, page_number, **kwargs): path_params['pageNumber'] = params['page_number'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: query_params.append(('folder', params['folder'])) - if 'dest_folder' in params: - query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -15193,6 +15108,8 @@ def put_images_extract_as_png_with_http_info(self, name, page_number, **kwargs): local_var_files = {} body_params = None + if 'links' in params: + body_params = params['links'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -15204,7 +15121,7 @@ def put_images_extract_as_png_with_http_info(self, name, page_number, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/png', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/links', 'POST', path_params, query_params, header_params, @@ -15219,63 +15136,59 @@ def put_images_extract_as_png_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_images_extract_as_tiff(self, name, page_number, **kwargs): + def post_page_poly_line_annotations(self, name, page_number, annotations, **kwargs): """ - Extract document images in TIFF format to folder. + Add document page polyline annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_images_extract_as_tiff(name, page_number, callback=callback_function) + >>> thread = api.post_page_poly_line_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param list[PolyLineAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_images_extract_as_tiff_with_http_info(name, page_number, **kwargs) + return self.post_page_poly_line_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_images_extract_as_tiff_with_http_info(name, page_number, **kwargs) + (data) = self.post_page_poly_line_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_images_extract_as_tiff_with_http_info(self, name, page_number, **kwargs): + def post_page_poly_line_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Extract document images in TIFF format to folder. + Add document page polyline annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_images_extract_as_tiff_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.post_page_poly_line_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param int width: The converted image width. - :param int height: The converted image height. + :param list[PolyLineAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15286,16 +15199,19 @@ def put_images_extract_as_tiff_with_http_info(self, name, page_number, **kwargs) if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_images_extract_as_tiff" % key + " to method post_page_poly_line_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_images_extract_as_tiff`") + raise ValueError("Missing the required parameter `name` when calling `post_page_poly_line_annotations`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `put_images_extract_as_tiff`") + raise ValueError("Missing the required parameter `page_number` when calling `post_page_poly_line_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_poly_line_annotations`") collection_formats = {} @@ -15307,16 +15223,10 @@ def put_images_extract_as_tiff_with_http_info(self, name, page_number, **kwargs) path_params['pageNumber'] = params['page_number'] query_params = [] - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: query_params.append(('folder', params['folder'])) - if 'dest_folder' in params: - query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -15324,6 +15234,8 @@ def put_images_extract_as_tiff_with_http_info(self, name, page_number, **kwargs) local_var_files = {} body_params = None + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -15335,7 +15247,7 @@ def put_images_extract_as_tiff_with_http_info(self, name, page_number, **kwargs) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/tiff', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polyline', 'POST', path_params, query_params, header_params, @@ -15350,57 +15262,59 @@ def put_images_extract_as_tiff_with_http_info(self, name, page_number, **kwargs) _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_la_te_x_in_storage_to_pdf(self, name, src_path, **kwargs): + def post_page_polygon_annotations(self, name, page_number, annotations, **kwargs): """ - Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage. + Add document page polygon annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_la_te_x_in_storage_to_pdf(name, src_path, callback=callback_function) + >>> thread = api.post_page_polygon_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str src_path: Full source filename (ex. /folder1/folder2/template.tex) (required) - :param str dst_folder: The destination document folder. + :param int page_number: The page number. (required) + :param list[PolygonAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_la_te_x_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + return self.post_page_polygon_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_la_te_x_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + (data) = self.post_page_polygon_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_la_te_x_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): + def post_page_polygon_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage. + Add document page polygon annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_la_te_x_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) + >>> thread = api.post_page_polygon_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str src_path: Full source filename (ex. /folder1/folder2/template.tex) (required) - :param str dst_folder: The destination document folder. + :param int page_number: The page number. (required) + :param list[PolygonAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'src_path', 'dst_folder', 'storage'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15411,16 +15325,19 @@ def put_la_te_x_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs) if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_la_te_x_in_storage_to_pdf" % key + " to method post_page_polygon_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_la_te_x_in_storage_to_pdf`") - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `put_la_te_x_in_storage_to_pdf`") + raise ValueError("Missing the required parameter `name` when calling `post_page_polygon_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `post_page_polygon_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_polygon_annotations`") collection_formats = {} @@ -15428,14 +15345,14 @@ def put_la_te_x_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs) path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) - if 'dst_folder' in params: - query_params.append(('dstFolder', params['dst_folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -15443,6 +15360,8 @@ def put_la_te_x_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs) local_var_files = {} body_params = None + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -15454,7 +15373,7 @@ def put_la_te_x_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/create/latex', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polygon', 'POST', path_params, query_params, header_params, @@ -15469,59 +15388,59 @@ def put_la_te_x_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs) _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_line_annotation(self, name, annotation_id, annotation, **kwargs): + def post_page_square_annotations(self, name, page_number, annotations, **kwargs): """ - Replace document line annotation + Add document page square annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_line_annotation(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.post_page_square_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param LineAnnotation annotation: Annotation. (required) + :param int page_number: The page number. (required) + :param list[SquareAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: LineAnnotationResponse + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_line_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.post_page_square_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_line_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.post_page_square_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_line_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def post_page_square_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Replace document line annotation + Add document page square annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_line_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.post_page_square_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param LineAnnotation annotation: Annotation. (required) + :param int page_number: The page number. (required) + :param list[SquareAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: LineAnnotationResponse + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15532,19 +15451,19 @@ def put_line_annotation_with_http_info(self, name, annotation_id, annotation, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_line_annotation" % key + " to method post_page_square_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_line_annotation`") - # verify the required parameter 'annotation_id' is set - if ('annotation_id' not in params) or (params['annotation_id'] is None): - raise ValueError("Missing the required parameter `annotation_id` when calling `put_line_annotation`") - # verify the required parameter 'annotation' is set - if ('annotation' not in params) or (params['annotation'] is None): - raise ValueError("Missing the required parameter `annotation` when calling `put_line_annotation`") + raise ValueError("Missing the required parameter `name` when calling `post_page_square_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `post_page_square_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_square_annotations`") collection_formats = {} @@ -15552,8 +15471,8 @@ def put_line_annotation_with_http_info(self, name, annotation_id, annotation, ** path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'annotation_id' in params: - path_params['annotationId'] = params['annotation_id'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] if 'storage' in params: @@ -15567,8 +15486,8 @@ def put_line_annotation_with_http_info(self, name, annotation_id, annotation, ** local_var_files = {} body_params = None - if 'annotation' in params: - body_params = params['annotation'] + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -15580,14 +15499,14 @@ def put_line_annotation_with_http_info(self, name, annotation_id, annotation, ** # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/line/{annotationId}', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/square', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='LineAnnotationResponse', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -15595,59 +15514,59 @@ def put_line_annotation_with_http_info(self, name, annotation_id, annotation, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_link_annotation(self, name, link_id, link, **kwargs): + def post_page_squiggly_annotations(self, name, page_number, annotations, **kwargs): """ - Replace document page link annotations + Add document page squiggly annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_link_annotation(name, link_id, link, callback=callback_function) + >>> thread = api.post_page_squiggly_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str link_id: The link ID. (required) - :param LinkAnnotation link: Link anotation. (required) + :param int page_number: The page number. (required) + :param list[SquigglyAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: LinkAnnotationResponse + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_link_annotation_with_http_info(name, link_id, link, **kwargs) + return self.post_page_squiggly_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_link_annotation_with_http_info(name, link_id, link, **kwargs) + (data) = self.post_page_squiggly_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_link_annotation_with_http_info(self, name, link_id, link, **kwargs): + def post_page_squiggly_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Replace document page link annotations + Add document page squiggly annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_link_annotation_with_http_info(name, link_id, link, callback=callback_function) + >>> thread = api.post_page_squiggly_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str link_id: The link ID. (required) - :param LinkAnnotation link: Link anotation. (required) + :param int page_number: The page number. (required) + :param list[SquigglyAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: LinkAnnotationResponse + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'link_id', 'link', 'storage', 'folder'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15658,19 +15577,19 @@ def put_link_annotation_with_http_info(self, name, link_id, link, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_link_annotation" % key + " to method post_page_squiggly_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_link_annotation`") - # verify the required parameter 'link_id' is set - if ('link_id' not in params) or (params['link_id'] is None): - raise ValueError("Missing the required parameter `link_id` when calling `put_link_annotation`") - # verify the required parameter 'link' is set - if ('link' not in params) or (params['link'] is None): - raise ValueError("Missing the required parameter `link` when calling `put_link_annotation`") + raise ValueError("Missing the required parameter `name` when calling `post_page_squiggly_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `post_page_squiggly_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_squiggly_annotations`") collection_formats = {} @@ -15678,8 +15597,8 @@ def put_link_annotation_with_http_info(self, name, link_id, link, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'link_id' in params: - path_params['linkId'] = params['link_id'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] if 'storage' in params: @@ -15693,8 +15612,8 @@ def put_link_annotation_with_http_info(self, name, link_id, link, **kwargs): local_var_files = {} body_params = None - if 'link' in params: - body_params = params['link'] + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -15706,14 +15625,14 @@ def put_link_annotation_with_http_info(self, name, link_id, link, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/links/{linkId}', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/squiggly', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='LinkAnnotationResponse', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -15721,57 +15640,59 @@ def put_link_annotation_with_http_info(self, name, link_id, link, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_merge_documents(self, name, **kwargs): + def post_page_strike_out_annotations(self, name, page_number, annotations, **kwargs): """ - Merge a list of documents. + Add document page StrikeOut annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_merge_documents(name, callback=callback_function) + >>> thread = api.post_page_strike_out_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: Resulting documen name. (required) - :param MergeDocuments merge_documents: with a list of documents. - :param str storage: Resulting document storage. - :param str folder: Resulting document folder. - :return: file + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param list[StrikeOutAnnotation] annotations: The array of annotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_merge_documents_with_http_info(name, **kwargs) + return self.post_page_strike_out_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_merge_documents_with_http_info(name, **kwargs) + (data) = self.post_page_strike_out_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_merge_documents_with_http_info(self, name, **kwargs): + def post_page_strike_out_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Merge a list of documents. + Add document page StrikeOut annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_merge_documents_with_http_info(name, callback=callback_function) + >>> thread = api.post_page_strike_out_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: Resulting documen name. (required) - :param MergeDocuments merge_documents: with a list of documents. - :param str storage: Resulting document storage. - :param str folder: Resulting document folder. - :return: file + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param list[StrikeOutAnnotation] annotations: The array of annotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'merge_documents', 'storage', 'folder'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15782,13 +15703,19 @@ def put_merge_documents_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_merge_documents" % key + " to method post_page_strike_out_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_merge_documents`") + raise ValueError("Missing the required parameter `name` when calling `post_page_strike_out_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `post_page_strike_out_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_strike_out_annotations`") collection_formats = {} @@ -15796,6 +15723,8 @@ def put_merge_documents_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] if 'storage' in params: @@ -15809,8 +15738,8 @@ def put_merge_documents_with_http_info(self, name, **kwargs): local_var_files = {} body_params = None - if 'merge_documents' in params: - body_params = params['merge_documents'] + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -15822,14 +15751,14 @@ def put_merge_documents_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/merge', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/strikeout', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -15837,57 +15766,59 @@ def put_merge_documents_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_mht_in_storage_to_pdf(self, name, src_path, **kwargs): + def post_page_text_annotations(self, name, page_number, annotations, **kwargs): """ - Convert MHT file (located on storage) to PDF format and upload resulting file to storage. + Add document page text annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_mht_in_storage_to_pdf(name, src_path, callback=callback_function) + >>> thread = api.post_page_text_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str src_path: Full source filename (ex. /folder1/folder2/template.mht) (required) - :param str dst_folder: The destination document folder. + :param int page_number: The page number. (required) + :param list[TextAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_mht_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + return self.post_page_text_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_mht_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + (data) = self.post_page_text_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_mht_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): + def post_page_text_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Convert MHT file (located on storage) to PDF format and upload resulting file to storage. + Add document page text annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_mht_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) + >>> thread = api.post_page_text_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str src_path: Full source filename (ex. /folder1/folder2/template.mht) (required) - :param str dst_folder: The destination document folder. + :param int page_number: The page number. (required) + :param list[TextAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'src_path', 'dst_folder', 'storage'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15898,16 +15829,19 @@ def put_mht_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_mht_in_storage_to_pdf" % key + " to method post_page_text_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_mht_in_storage_to_pdf`") - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `put_mht_in_storage_to_pdf`") + raise ValueError("Missing the required parameter `name` when calling `post_page_text_annotations`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `post_page_text_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_text_annotations`") collection_formats = {} @@ -15915,14 +15849,14 @@ def put_mht_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) - if 'dst_folder' in params: - query_params.append(('dstFolder', params['dst_folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -15930,6 +15864,8 @@ def put_mht_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): local_var_files = {} body_params = None + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -15941,7 +15877,7 @@ def put_mht_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/create/mht', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/text', 'POST', path_params, query_params, header_params, @@ -15956,59 +15892,59 @@ def put_mht_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_page_add_stamp(self, name, page_number, stamp, **kwargs): + def post_page_text_replace(self, name, page_number, text_replace_list_request, **kwargs): """ - Add page stamp. + Page's replace text method. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_add_stamp(name, page_number, stamp, callback=callback_function) + >>> thread = api.post_page_text_replace(name, page_number, text_replace_list_request, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param Stamp stamp: with data. (required) - :param str storage: The document storage. - :param str folder: The document folder. - :return: AsposeResponse + :param str name: (required) + :param int page_number: (required) + :param TextReplaceListRequest text_replace_list_request: (required) + :param str storage: + :param str folder: + :return: TextReplaceResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_page_add_stamp_with_http_info(name, page_number, stamp, **kwargs) + return self.post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, **kwargs) else: - (data) = self.put_page_add_stamp_with_http_info(name, page_number, stamp, **kwargs) + (data) = self.post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, **kwargs) return data - def put_page_add_stamp_with_http_info(self, name, page_number, stamp, **kwargs): + def post_page_text_replace_with_http_info(self, name, page_number, text_replace_list_request, **kwargs): """ - Add page stamp. + Page's replace text method. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_add_stamp_with_http_info(name, page_number, stamp, callback=callback_function) + >>> thread = api.post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param Stamp stamp: with data. (required) - :param str storage: The document storage. - :param str folder: The document folder. - :return: AsposeResponse + :param str name: (required) + :param int page_number: (required) + :param TextReplaceListRequest text_replace_list_request: (required) + :param str storage: + :param str folder: + :return: TextReplaceResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'stamp', 'storage', 'folder'] + all_params = ['name', 'page_number', 'text_replace_list_request', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -16019,19 +15955,19 @@ def put_page_add_stamp_with_http_info(self, name, page_number, stamp, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_page_add_stamp" % key + " to method post_page_text_replace" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_page_add_stamp`") + raise ValueError("Missing the required parameter `name` when calling `post_page_text_replace`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `put_page_add_stamp`") - # verify the required parameter 'stamp' is set - if ('stamp' not in params) or (params['stamp'] is None): - raise ValueError("Missing the required parameter `stamp` when calling `put_page_add_stamp`") + raise ValueError("Missing the required parameter `page_number` when calling `post_page_text_replace`") + # verify the required parameter 'text_replace_list_request' is set + if ('text_replace_list_request' not in params) or (params['text_replace_list_request'] is None): + raise ValueError("Missing the required parameter `text_replace_list_request` when calling `post_page_text_replace`") collection_formats = {} @@ -16054,8 +15990,8 @@ def put_page_add_stamp_with_http_info(self, name, page_number, stamp, **kwargs): local_var_files = {} body_params = None - if 'stamp' in params: - body_params = params['stamp'] + if 'text_replace_list_request' in params: + body_params = params['text_replace_list_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -16067,14 +16003,14 @@ def put_page_add_stamp_with_http_info(self, name, page_number, stamp, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/stamp', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/text/replace', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='TextReplaceResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -16082,63 +16018,59 @@ def put_page_add_stamp_with_http_info(self, name, page_number, stamp, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_page_convert_to_bmp(self, name, page_number, out_path, **kwargs): + def post_page_underline_annotations(self, name, page_number, annotations, **kwargs): """ - Convert document page to bmp image and upload resulting file to storage. + Add document page underline annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_convert_to_bmp(name, page_number, out_path, callback=callback_function) + >>> thread = api.post_page_underline_annotations(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param str out_path: The out path of result image. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param list[UnderlineAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_page_convert_to_bmp_with_http_info(name, page_number, out_path, **kwargs) + return self.post_page_underline_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_page_convert_to_bmp_with_http_info(name, page_number, out_path, **kwargs) + (data) = self.post_page_underline_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_page_convert_to_bmp_with_http_info(self, name, page_number, out_path, **kwargs): + def post_page_underline_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Convert document page to bmp image and upload resulting file to storage. + Add document page underline annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_convert_to_bmp_with_http_info(name, page_number, out_path, callback=callback_function) + >>> thread = api.post_page_underline_annotations_with_http_info(name, page_number, annotations, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param str out_path: The out path of result image. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param list[UnderlineAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -16149,19 +16081,19 @@ def put_page_convert_to_bmp_with_http_info(self, name, page_number, out_path, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_page_convert_to_bmp" % key + " to method post_page_underline_annotations" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_page_convert_to_bmp`") + raise ValueError("Missing the required parameter `name` when calling `post_page_underline_annotations`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `put_page_convert_to_bmp`") - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_page_convert_to_bmp`") + raise ValueError("Missing the required parameter `page_number` when calling `post_page_underline_annotations`") + # verify the required parameter 'annotations' is set + if ('annotations' not in params) or (params['annotations'] is None): + raise ValueError("Missing the required parameter `annotations` when calling `post_page_underline_annotations`") collection_formats = {} @@ -16173,16 +16105,10 @@ def put_page_convert_to_bmp_with_http_info(self, name, page_number, out_path, ** path_params['pageNumber'] = params['page_number'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -16190,6 +16116,8 @@ def put_page_convert_to_bmp_with_http_info(self, name, page_number, out_path, ** local_var_files = {} body_params = None + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -16201,7 +16129,7 @@ def put_page_convert_to_bmp_with_http_info(self, name, page_number, out_path, ** # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/bmp', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/underline', 'POST', path_params, query_params, header_params, @@ -16216,63 +16144,59 @@ def put_page_convert_to_bmp_with_http_info(self, name, page_number, out_path, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_page_convert_to_emf(self, name, page_number, out_path, **kwargs): + def post_popup_annotation(self, name, annotation_id, annotation, **kwargs): """ - Convert document page to emf image and upload resulting file to storage. + Add document popup annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_convert_to_emf(name, page_number, out_path, callback=callback_function) + >>> thread = api.post_popup_annotation(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param str out_path: The out path of result image. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param str annotation_id: The parent annotation ID. (required) + :param PopupAnnotation annotation: The annotation. (required) :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_page_convert_to_emf_with_http_info(name, page_number, out_path, **kwargs) + return self.post_popup_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_page_convert_to_emf_with_http_info(name, page_number, out_path, **kwargs) + (data) = self.post_popup_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_page_convert_to_emf_with_http_info(self, name, page_number, out_path, **kwargs): + def post_popup_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Convert document page to emf image and upload resulting file to storage. + Add document popup annotations. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_convert_to_emf_with_http_info(name, page_number, out_path, callback=callback_function) + >>> thread = api.post_popup_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param str out_path: The out path of result image. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param str annotation_id: The parent annotation ID. (required) + :param PopupAnnotation annotation: The annotation. (required) :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -16283,19 +16207,19 @@ def put_page_convert_to_emf_with_http_info(self, name, page_number, out_path, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_page_convert_to_emf" % key + " to method post_popup_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_page_convert_to_emf`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `put_page_convert_to_emf`") - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_page_convert_to_emf`") + raise ValueError("Missing the required parameter `name` when calling `post_popup_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `post_popup_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `post_popup_annotation`") collection_formats = {} @@ -16303,20 +16227,14 @@ def put_page_convert_to_emf_with_http_info(self, name, page_number, out_path, ** path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -16324,6 +16242,8 @@ def put_page_convert_to_emf_with_http_info(self, name, page_number, out_path, ** local_var_files = {} body_params = None + if 'annotation' in params: + body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -16335,7 +16255,7 @@ def put_page_convert_to_emf_with_http_info(self, name, page_number, out_path, ** # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/emf', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/{annotationId}/popup', 'POST', path_params, query_params, header_params, @@ -16350,63 +16270,57 @@ def put_page_convert_to_emf_with_http_info(self, name, page_number, out_path, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_page_convert_to_gif(self, name, page_number, out_path, **kwargs): + def post_sign_document(self, name, **kwargs): """ - Convert document page to gif image and upload resulting file to storage. + Sign document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_convert_to_gif(name, page_number, out_path, callback=callback_function) + >>> thread = api.post_sign_document(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param str out_path: The out path of result image. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param Signature signature: Signature object containing signature data. :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_page_convert_to_gif_with_http_info(name, page_number, out_path, **kwargs) + return self.post_sign_document_with_http_info(name, **kwargs) else: - (data) = self.put_page_convert_to_gif_with_http_info(name, page_number, out_path, **kwargs) + (data) = self.post_sign_document_with_http_info(name, **kwargs) return data - def put_page_convert_to_gif_with_http_info(self, name, page_number, out_path, **kwargs): + def post_sign_document_with_http_info(self, name, **kwargs): """ - Convert document page to gif image and upload resulting file to storage. + Sign document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_convert_to_gif_with_http_info(name, page_number, out_path, callback=callback_function) + >>> thread = api.post_sign_document_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param str out_path: The out path of result image. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param Signature signature: Signature object containing signature data. :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params = ['name', 'signature', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -16417,19 +16331,13 @@ def put_page_convert_to_gif_with_http_info(self, name, page_number, out_path, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_page_convert_to_gif" % key + " to method post_sign_document" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_page_convert_to_gif`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `put_page_convert_to_gif`") - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_page_convert_to_gif`") + raise ValueError("Missing the required parameter `name` when calling `post_sign_document`") collection_formats = {} @@ -16437,20 +16345,12 @@ def put_page_convert_to_gif_with_http_info(self, name, page_number, out_path, ** path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -16458,6 +16358,8 @@ def put_page_convert_to_gif_with_http_info(self, name, page_number, out_path, ** local_var_files = {} body_params = None + if 'signature' in params: + body_params = params['signature'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -16469,7 +16371,7 @@ def put_page_convert_to_gif_with_http_info(self, name, page_number, out_path, ** # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/gif', 'PUT', + return self.api_client.call_api('/pdf/{name}/sign', 'POST', path_params, query_params, header_params, @@ -16484,63 +16386,59 @@ def put_page_convert_to_gif_with_http_info(self, name, page_number, out_path, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_page_convert_to_jpeg(self, name, page_number, out_path, **kwargs): + def post_sign_page(self, name, page_number, **kwargs): """ - Convert document page to Jpeg image and upload resulting file to storage. + Sign page. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_convert_to_jpeg(name, page_number, out_path, callback=callback_function) + >>> thread = api.post_sign_page(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param str out_path: The out path of result image. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param Signature signature: Signature object containing signature data. :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_page_convert_to_jpeg_with_http_info(name, page_number, out_path, **kwargs) + return self.post_sign_page_with_http_info(name, page_number, **kwargs) else: - (data) = self.put_page_convert_to_jpeg_with_http_info(name, page_number, out_path, **kwargs) + (data) = self.post_sign_page_with_http_info(name, page_number, **kwargs) return data - def put_page_convert_to_jpeg_with_http_info(self, name, page_number, out_path, **kwargs): + def post_sign_page_with_http_info(self, name, page_number, **kwargs): """ - Convert document page to Jpeg image and upload resulting file to storage. + Sign page. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_convert_to_jpeg_with_http_info(name, page_number, out_path, callback=callback_function) + >>> thread = api.post_sign_page_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param int page_number: The page number. (required) - :param str out_path: The out path of result image. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param Signature signature: Signature object containing signature data. :param str storage: The document storage. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params = ['name', 'page_number', 'signature', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -16551,19 +16449,16 @@ def put_page_convert_to_jpeg_with_http_info(self, name, page_number, out_path, * if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_page_convert_to_jpeg" % key + " to method post_sign_page" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_page_convert_to_jpeg`") + raise ValueError("Missing the required parameter `name` when calling `post_sign_page`") # verify the required parameter 'page_number' is set if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `put_page_convert_to_jpeg`") - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_page_convert_to_jpeg`") + raise ValueError("Missing the required parameter `page_number` when calling `post_sign_page`") collection_formats = {} @@ -16575,16 +16470,10 @@ def put_page_convert_to_jpeg_with_http_info(self, name, page_number, out_path, * path_params['pageNumber'] = params['page_number'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -16592,6 +16481,8 @@ def put_page_convert_to_jpeg_with_http_info(self, name, page_number, out_path, * local_var_files = {} body_params = None + if 'signature' in params: + body_params = params['signature'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -16603,7 +16494,7 @@ def put_page_convert_to_jpeg_with_http_info(self, name, page_number, out_path, * # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/jpeg', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/sign', 'POST', path_params, query_params, header_params, @@ -16618,63 +16509,61 @@ def put_page_convert_to_jpeg_with_http_info(self, name, page_number, out_path, * _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_page_convert_to_png(self, name, page_number, out_path, **kwargs): + def post_split_document(self, name, **kwargs): """ - Convert document page to png image and upload resulting file to storage. + Split document to parts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_convert_to_png(name, page_number, out_path, callback=callback_function) + >>> thread = api.post_split_document(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param str out_path: The out path of result image. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param str name: Document name. (required) + :param str format: Resulting documents format. + :param int _from: Start page if defined. + :param int to: End page if defined. :param str storage: The document storage. - :return: AsposeResponse + :param str folder: The document folder. + :return: SplitResultResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_page_convert_to_png_with_http_info(name, page_number, out_path, **kwargs) + return self.post_split_document_with_http_info(name, **kwargs) else: - (data) = self.put_page_convert_to_png_with_http_info(name, page_number, out_path, **kwargs) + (data) = self.post_split_document_with_http_info(name, **kwargs) return data - def put_page_convert_to_png_with_http_info(self, name, page_number, out_path, **kwargs): + def post_split_document_with_http_info(self, name, **kwargs): """ - Convert document page to png image and upload resulting file to storage. + Split document to parts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_convert_to_png_with_http_info(name, page_number, out_path, callback=callback_function) + >>> thread = api.post_split_document_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param str out_path: The out path of result image. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. + :param str name: Document name. (required) + :param str format: Resulting documents format. + :param int _from: Start page if defined. + :param int to: End page if defined. :param str storage: The document storage. - :return: AsposeResponse + :param str folder: The document folder. + :return: SplitResultResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params = ['name', 'format', '_from', 'to', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -16685,19 +16574,13 @@ def put_page_convert_to_png_with_http_info(self, name, page_number, out_path, ** if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_page_convert_to_png" % key + " to method post_split_document" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_page_convert_to_png`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `put_page_convert_to_png`") - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_page_convert_to_png`") + raise ValueError("Missing the required parameter `name` when calling `post_split_document`") collection_formats = {} @@ -16705,20 +16588,18 @@ def put_page_convert_to_png_with_http_info(self, name, page_number, out_path, ** path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) + if 'format' in params: + query_params.append(('format', params['format'])) + if '_from' in params: + query_params.append(('from', params['_from'])) + if 'to' in params: + query_params.append(('to', params['to'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -16737,14 +16618,14 @@ def put_page_convert_to_png_with_http_info(self, name, page_number, out_path, ** # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/png', 'PUT', + return self.api_client.call_api('/pdf/{name}/split', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='SplitResultResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -16752,63 +16633,55 @@ def put_page_convert_to_png_with_http_info(self, name, page_number, out_path, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_page_convert_to_tiff(self, name, page_number, out_path, **kwargs): + def put_add_new_page(self, name, **kwargs): """ - Convert document page to Tiff image and upload resulting file to storage. + Add new page to end of the document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_convert_to_tiff(name, page_number, out_path, callback=callback_function) + >>> thread = api.put_add_new_page(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param str out_path: The out path of result image. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. :param str storage: The document storage. - :return: AsposeResponse + :param str folder: The document folder. + :return: DocumentPagesResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_page_convert_to_tiff_with_http_info(name, page_number, out_path, **kwargs) + return self.put_add_new_page_with_http_info(name, **kwargs) else: - (data) = self.put_page_convert_to_tiff_with_http_info(name, page_number, out_path, **kwargs) + (data) = self.put_add_new_page_with_http_info(name, **kwargs) return data - def put_page_convert_to_tiff_with_http_info(self, name, page_number, out_path, **kwargs): + def put_add_new_page_with_http_info(self, name, **kwargs): """ - Convert document page to Tiff image and upload resulting file to storage. + Add new page to end of the document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_page_convert_to_tiff_with_http_info(name, page_number, out_path, callback=callback_function) + >>> thread = api.put_add_new_page_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param int page_number: The page number. (required) - :param str out_path: The out path of result image. (required) - :param int width: The converted image width. - :param int height: The converted image height. - :param str folder: The document folder. :param str storage: The document storage. - :return: AsposeResponse + :param str folder: The document folder. + :return: DocumentPagesResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -16819,19 +16692,13 @@ def put_page_convert_to_tiff_with_http_info(self, name, page_number, out_path, * if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_page_convert_to_tiff" % key + " to method put_add_new_page" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_page_convert_to_tiff`") - # verify the required parameter 'page_number' is set - if ('page_number' not in params) or (params['page_number'] is None): - raise ValueError("Missing the required parameter `page_number` when calling `put_page_convert_to_tiff`") - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_page_convert_to_tiff`") + raise ValueError("Missing the required parameter `name` when calling `put_add_new_page`") collection_formats = {} @@ -16839,20 +16706,12 @@ def put_page_convert_to_tiff_with_http_info(self, name, page_number, out_path, * path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'page_number' in params: - path_params['pageNumber'] = params['page_number'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -16871,14 +16730,14 @@ def put_page_convert_to_tiff_with_http_info(self, name, page_number, out_path, * # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/tiff', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='DocumentPagesResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -16886,22 +16745,23 @@ def put_page_convert_to_tiff_with_http_info(self, name, page_number, out_path, * _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pcl_in_storage_to_pdf(self, name, src_path, **kwargs): + def put_add_text(self, name, page_number, **kwargs): """ - Convert PCL file (located on storage) to PDF format and upload resulting file to storage. + Add text to PDF document page. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pcl_in_storage_to_pdf(name, src_path, callback=callback_function) + >>> thread = api.put_add_text(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str src_path: Full source filename (ex. /folder1/folder2/template.pcl) (required) - :param str dst_folder: The destination document folder. + :param int page_number: Number of page (starting from 1). (required) + :param Paragraph paragraph: Paragraph data. + :param str folder: Document folder. :param str storage: The document storage. :return: AsposeResponse If the method is called asynchronously, @@ -16909,34 +16769,35 @@ def put_pcl_in_storage_to_pdf(self, name, src_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pcl_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + return self.put_add_text_with_http_info(name, page_number, **kwargs) else: - (data) = self.put_pcl_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + (data) = self.put_add_text_with_http_info(name, page_number, **kwargs) return data - def put_pcl_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): + def put_add_text_with_http_info(self, name, page_number, **kwargs): """ - Convert PCL file (located on storage) to PDF format and upload resulting file to storage. + Add text to PDF document page. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pcl_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) + >>> thread = api.put_add_text_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str src_path: Full source filename (ex. /folder1/folder2/template.pcl) (required) - :param str dst_folder: The destination document folder. + :param int page_number: Number of page (starting from 1). (required) + :param Paragraph paragraph: Paragraph data. + :param str folder: Document folder. :param str storage: The document storage. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'src_path', 'dst_folder', 'storage'] + all_params = ['name', 'page_number', 'paragraph', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -16947,16 +16808,16 @@ def put_pcl_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pcl_in_storage_to_pdf" % key + " to method put_add_text" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pcl_in_storage_to_pdf`") - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `put_pcl_in_storage_to_pdf`") + raise ValueError("Missing the required parameter `name` when calling `put_add_text`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `put_add_text`") collection_formats = {} @@ -16964,12 +16825,12 @@ def put_pcl_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) - if 'dst_folder' in params: - query_params.append(('dstFolder', params['dst_folder'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -16979,6 +16840,8 @@ def put_pcl_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): local_var_files = {} body_params = None + if 'paragraph' in params: + body_params = params['paragraph'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -16990,7 +16853,7 @@ def put_pcl_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/create/pcl', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/text', 'PUT', path_params, query_params, header_params, @@ -17005,71 +16868,59 @@ def put_pcl_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_request_to_doc(self, out_path, **kwargs): + def put_caret_annotation(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (in request content) to DOC format and uploads resulting file to storage. + Replace document caret annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_doc(out_path, callback=callback_function) + >>> thread = api.put_caret_annotation(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.doc) (required) - :param bool add_return_to_line_end: Add return to line end. - :param str format: Allows to specify .doc or .docx file format. - :param int image_resolution_x: Image resolution X. - :param int image_resolution_y: Image resolution Y. - :param float max_distance_between_text_lines: Max distance between text lines. - :param str mode: Allows to control how a PDF document is converted into a word processing document. - :param bool recognize_bullets: Recognize bullets. - :param float relative_horizontal_proximity: Relative horizontal proximity. + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param CaretAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :param file file: A file to be converted. - :return: AsposeResponse + :param str folder: The document folder. + :return: CaretAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_request_to_doc_with_http_info(out_path, **kwargs) + return self.put_caret_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_pdf_in_request_to_doc_with_http_info(out_path, **kwargs) + (data) = self.put_caret_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_pdf_in_request_to_doc_with_http_info(self, out_path, **kwargs): + def put_caret_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (in request content) to DOC format and uploads resulting file to storage. + Replace document caret annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_doc_with_http_info(out_path, callback=callback_function) + >>> thread = api.put_caret_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.doc) (required) - :param bool add_return_to_line_end: Add return to line end. - :param str format: Allows to specify .doc or .docx file format. - :param int image_resolution_x: Image resolution X. - :param int image_resolution_y: Image resolution Y. - :param float max_distance_between_text_lines: Max distance between text lines. - :param str mode: Allows to control how a PDF document is converted into a word processing document. - :param bool recognize_bullets: Recognize bullets. - :param float relative_horizontal_proximity: Relative horizontal proximity. + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param CaretAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :param file file: A file to be converted. - :return: AsposeResponse + :param str folder: The document folder. + :return: CaretAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['out_path', 'add_return_to_line_end', 'format', 'image_resolution_x', 'image_resolution_y', 'max_distance_between_text_lines', 'mode', 'recognize_bullets', 'relative_horizontal_proximity', 'storage', 'file'] + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -17080,68 +16931,62 @@ def put_pdf_in_request_to_doc_with_http_info(self, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_request_to_doc" % key + " to method put_caret_annotation" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_doc`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_caret_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `put_caret_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `put_caret_annotation`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'add_return_to_line_end' in params: - query_params.append(('addReturnToLineEnd', params['add_return_to_line_end'])) - if 'format' in params: - query_params.append(('format', params['format'])) - if 'image_resolution_x' in params: - query_params.append(('imageResolutionX', params['image_resolution_x'])) - if 'image_resolution_y' in params: - query_params.append(('imageResolutionY', params['image_resolution_y'])) - if 'max_distance_between_text_lines' in params: - query_params.append(('maxDistanceBetweenTextLines', params['max_distance_between_text_lines'])) - if 'mode' in params: - query_params.append(('mode', params['mode'])) - if 'recognize_bullets' in params: - query_params.append(('recognizeBullets', params['recognize_bullets'])) - if 'relative_horizontal_proximity' in params: - query_params.append(('relativeHorizontalProximity', params['relative_horizontal_proximity'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['file'] = params['file'] body_params = None + if 'annotation' in params: + body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/doc', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/caret/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='CaretAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -17149,57 +16994,59 @@ def put_pdf_in_request_to_doc_with_http_info(self, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_request_to_epub(self, out_path, **kwargs): + def put_circle_annotation(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (in request content) to EPUB format and uploads resulting file to storage. + Replace document circle annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_epub(out_path, callback=callback_function) + >>> thread = api.put_circle_annotation(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.epub) (required) - :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content. + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param CircleAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :param file file: A file to be converted. - :return: AsposeResponse + :param str folder: The document folder. + :return: CircleAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_request_to_epub_with_http_info(out_path, **kwargs) + return self.put_circle_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_pdf_in_request_to_epub_with_http_info(out_path, **kwargs) + (data) = self.put_circle_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_pdf_in_request_to_epub_with_http_info(self, out_path, **kwargs): + def put_circle_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (in request content) to EPUB format and uploads resulting file to storage. + Replace document circle annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_epub_with_http_info(out_path, callback=callback_function) + >>> thread = api.put_circle_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.epub) (required) - :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content. + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param CircleAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :param file file: A file to be converted. - :return: AsposeResponse + :param str folder: The document folder. + :return: CircleAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['out_path', 'content_recognition_mode', 'storage', 'file'] + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -17210,54 +17057,62 @@ def put_pdf_in_request_to_epub_with_http_info(self, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_request_to_epub" % key + " to method put_circle_annotation" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_epub`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_circle_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `put_circle_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `put_circle_annotation`") collection_formats = {} path_params = {} - + if 'name' in params: + path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] + query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'content_recognition_mode' in params: - query_params.append(('contentRecognitionMode', params['content_recognition_mode'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['file'] = params['file'] body_params = None + if 'annotation' in params: + body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/epub', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/circle/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='CircleAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -17265,111 +17120,57 @@ def put_pdf_in_request_to_epub_with_http_info(self, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_request_to_html(self, out_path, **kwargs): + def put_create(self, path, file, **kwargs): """ - Converts PDF document (in request content) to Html format and uploads resulting file to storage. + Upload a specific file This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_html(out_path, callback=callback_function) + >>> thread = api.put_create(path, file, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.html) (required) - :param int additional_margin_width_in_points: Defines width of margin that will be forcibly left around that output HTML-areas. - :param bool compress_svg_graphics_if_any: The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving. - :param bool convert_marked_content_to_layers: 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 str default_font_name: 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 str document_type: Result document type. - :param bool fixed_layout: The value indicating whether that HTML is created as fixed layout. - :param int image_resolution: Resolution for image rendering. - :param int minimal_line_width: 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 bool prevent_glyphs_grouping: 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 bool split_css_into_pages: 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 bool split_into_pages: 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 bool use_z_order: 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 str antialiasing_processing: The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML. - :param str css_class_names_prefix: 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 list[int] explicit_list_of_saved_pages: 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 str font_encoding_strategy: Defines encoding special rule to tune PDF decoding for current document. - :param str font_saving_mode: Defines font saving mode that will be used during saving of PDF to desirable format. - :param str html_markup_generation_mode: 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 str letters_positioning_method: The mode of positioning of letters in words in result HTML. - :param bool pages_flow_type_depends_on_viewers_screen_size: 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 str parts_embedding_mode: 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 str raster_images_saving_mode: Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML. - :param bool remove_empty_areas_on_top_and_bottom: Defines whether in created HTML will be removed top and bottom empty area without any content (if any). - :param bool save_shadowed_texts_as_transparent_texts: 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 bool save_transparent_texts: 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 str special_folder_for_all_images: 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 str special_folder_for_svg_images: 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 bool try_save_text_underlining_and_strikeouting_in_css: 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 str storage: The document storage. - :param file file: A file to be converted. + :param str path: Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext (required) + :param file file: File to upload (required) + :param str version_id: Source file's version + :param str storage: User's storage name :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_request_to_html_with_http_info(out_path, **kwargs) + return self.put_create_with_http_info(path, file, **kwargs) else: - (data) = self.put_pdf_in_request_to_html_with_http_info(out_path, **kwargs) + (data) = self.put_create_with_http_info(path, file, **kwargs) return data - def put_pdf_in_request_to_html_with_http_info(self, out_path, **kwargs): + def put_create_with_http_info(self, path, file, **kwargs): """ - Converts PDF document (in request content) to Html format and uploads resulting file to storage. + Upload a specific file This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_html_with_http_info(out_path, callback=callback_function) + >>> thread = api.put_create_with_http_info(path, file, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.html) (required) - :param int additional_margin_width_in_points: Defines width of margin that will be forcibly left around that output HTML-areas. - :param bool compress_svg_graphics_if_any: The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving. - :param bool convert_marked_content_to_layers: 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 str default_font_name: 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 str document_type: Result document type. - :param bool fixed_layout: The value indicating whether that HTML is created as fixed layout. - :param int image_resolution: Resolution for image rendering. - :param int minimal_line_width: 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 bool prevent_glyphs_grouping: 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 bool split_css_into_pages: 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 bool split_into_pages: 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 bool use_z_order: 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 str antialiasing_processing: The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML. - :param str css_class_names_prefix: 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 list[int] explicit_list_of_saved_pages: 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 str font_encoding_strategy: Defines encoding special rule to tune PDF decoding for current document. - :param str font_saving_mode: Defines font saving mode that will be used during saving of PDF to desirable format. - :param str html_markup_generation_mode: 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 str letters_positioning_method: The mode of positioning of letters in words in result HTML. - :param bool pages_flow_type_depends_on_viewers_screen_size: 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 str parts_embedding_mode: 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 str raster_images_saving_mode: Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML. - :param bool remove_empty_areas_on_top_and_bottom: Defines whether in created HTML will be removed top and bottom empty area without any content (if any). - :param bool save_shadowed_texts_as_transparent_texts: 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 bool save_transparent_texts: 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 str special_folder_for_all_images: 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 str special_folder_for_svg_images: 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 bool try_save_text_underlining_and_strikeouting_in_css: 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 str storage: The document storage. - :param file file: A file to be converted. + :param str path: Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext (required) + :param file file: File to upload (required) + :param str version_id: Source file's version + :param str storage: User's storage name :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['out_path', 'additional_margin_width_in_points', 'compress_svg_graphics_if_any', 'convert_marked_content_to_layers', 'default_font_name', 'document_type', 'fixed_layout', 'image_resolution', 'minimal_line_width', 'prevent_glyphs_grouping', 'split_css_into_pages', 'split_into_pages', 'use_z_order', 'antialiasing_processing', 'css_class_names_prefix', 'explicit_list_of_saved_pages', 'font_encoding_strategy', 'font_saving_mode', 'html_markup_generation_mode', 'letters_positioning_method', 'pages_flow_type_depends_on_viewers_screen_size', 'parts_embedding_mode', 'raster_images_saving_mode', 'remove_empty_areas_on_top_and_bottom', 'save_shadowed_texts_as_transparent_texts', 'save_transparent_texts', 'special_folder_for_all_images', 'special_folder_for_svg_images', 'try_save_text_underlining_and_strikeouting_in_css', 'storage', 'file'] + all_params = ['path', 'file', 'version_id', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -17380,13 +17181,16 @@ def put_pdf_in_request_to_html_with_http_info(self, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_request_to_html" % key + " to method put_create" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_html`") + # verify the required parameter 'path' is set + if ('path' not in params) or (params['path'] is None): + raise ValueError("Missing the required parameter `path` when calling `put_create`") + # verify the required parameter 'file' is set + if ('file' not in params) or (params['file'] is None): + raise ValueError("Missing the required parameter `file` when calling `put_create`") collection_formats = {} @@ -17394,65 +17198,10 @@ def put_pdf_in_request_to_html_with_http_info(self, out_path, **kwargs): path_params = {} query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'additional_margin_width_in_points' in params: - query_params.append(('additionalMarginWidthInPoints', params['additional_margin_width_in_points'])) - if 'compress_svg_graphics_if_any' in params: - query_params.append(('compressSvgGraphicsIfAny', params['compress_svg_graphics_if_any'])) - if 'convert_marked_content_to_layers' in params: - query_params.append(('convertMarkedContentToLayers', params['convert_marked_content_to_layers'])) - if 'default_font_name' in params: - query_params.append(('defaultFontName', params['default_font_name'])) - if 'document_type' in params: - query_params.append(('documentType', params['document_type'])) - if 'fixed_layout' in params: - query_params.append(('fixedLayout', params['fixed_layout'])) - if 'image_resolution' in params: - query_params.append(('imageResolution', params['image_resolution'])) - if 'minimal_line_width' in params: - query_params.append(('minimalLineWidth', params['minimal_line_width'])) - if 'prevent_glyphs_grouping' in params: - query_params.append(('preventGlyphsGrouping', params['prevent_glyphs_grouping'])) - if 'split_css_into_pages' in params: - query_params.append(('splitCssIntoPages', params['split_css_into_pages'])) - if 'split_into_pages' in params: - query_params.append(('splitIntoPages', params['split_into_pages'])) - if 'use_z_order' in params: - query_params.append(('useZOrder', params['use_z_order'])) - if 'antialiasing_processing' in params: - query_params.append(('antialiasingProcessing', params['antialiasing_processing'])) - if 'css_class_names_prefix' in params: - query_params.append(('cssClassNamesPrefix', params['css_class_names_prefix'])) - if 'explicit_list_of_saved_pages' in params: - query_params.append(('explicitListOfSavedPages', params['explicit_list_of_saved_pages'])) - collection_formats['explicitListOfSavedPages'] = 'multi' - if 'font_encoding_strategy' in params: - query_params.append(('fontEncodingStrategy', params['font_encoding_strategy'])) - if 'font_saving_mode' in params: - query_params.append(('fontSavingMode', params['font_saving_mode'])) - if 'html_markup_generation_mode' in params: - query_params.append(('htmlMarkupGenerationMode', params['html_markup_generation_mode'])) - if 'letters_positioning_method' in params: - query_params.append(('lettersPositioningMethod', params['letters_positioning_method'])) - if 'pages_flow_type_depends_on_viewers_screen_size' in params: - query_params.append(('pagesFlowTypeDependsOnViewersScreenSize', params['pages_flow_type_depends_on_viewers_screen_size'])) - if 'parts_embedding_mode' in params: - query_params.append(('partsEmbeddingMode', params['parts_embedding_mode'])) - if 'raster_images_saving_mode' in params: - query_params.append(('rasterImagesSavingMode', params['raster_images_saving_mode'])) - if 'remove_empty_areas_on_top_and_bottom' in params: - query_params.append(('removeEmptyAreasOnTopAndBottom', params['remove_empty_areas_on_top_and_bottom'])) - if 'save_shadowed_texts_as_transparent_texts' in params: - query_params.append(('saveShadowedTextsAsTransparentTexts', params['save_shadowed_texts_as_transparent_texts'])) - if 'save_transparent_texts' in params: - query_params.append(('saveTransparentTexts', params['save_transparent_texts'])) - if 'special_folder_for_all_images' in params: - query_params.append(('specialFolderForAllImages', params['special_folder_for_all_images'])) - if 'special_folder_for_svg_images' in params: - query_params.append(('specialFolderForSvgImages', params['special_folder_for_svg_images'])) - if 'try_save_text_underlining_and_strikeouting_in_css' in params: - query_params.append(('trySaveTextUnderliningAndStrikeoutingInCss', params['try_save_text_underlining_and_strikeouting_in_css'])) + if 'path' in params: + query_params.append(('path', params['path'])) + if 'version_id' in params: + query_params.append(('versionId', params['version_id'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -17461,7 +17210,7 @@ def put_pdf_in_request_to_html_with_http_info(self, out_path, **kwargs): form_params = [] local_var_files = {} if 'file' in params: - local_var_files['file'] = params['file'] + local_var_files['File'] = params['file'] body_params = None # HTTP header `Accept` @@ -17475,7 +17224,7 @@ def put_pdf_in_request_to_html_with_http_info(self, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/html', 'PUT', + return self.api_client.call_api('/storage/file', 'PUT', path_params, query_params, header_params, @@ -17490,57 +17239,55 @@ def put_pdf_in_request_to_html_with_http_info(self, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_request_to_la_te_x(self, out_path, **kwargs): + def put_create_document(self, name, **kwargs): """ - Converts PDF document (in request content) to LaTeX format and uploads resulting file to storage. + Create empty document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_la_te_x(out_path, callback=callback_function) + >>> thread = api.put_create_document(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tex) (required) - :param int pages_count: Pages count. + :param str name: The new document name. (required) :param str storage: The document storage. - :param file file: A file to be converted. - :return: AsposeResponse + :param str folder: The new document folder. + :return: DocumentResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_request_to_la_te_x_with_http_info(out_path, **kwargs) + return self.put_create_document_with_http_info(name, **kwargs) else: - (data) = self.put_pdf_in_request_to_la_te_x_with_http_info(out_path, **kwargs) + (data) = self.put_create_document_with_http_info(name, **kwargs) return data - def put_pdf_in_request_to_la_te_x_with_http_info(self, out_path, **kwargs): + def put_create_document_with_http_info(self, name, **kwargs): """ - Converts PDF document (in request content) to LaTeX format and uploads resulting file to storage. + Create empty document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_la_te_x_with_http_info(out_path, callback=callback_function) + >>> thread = api.put_create_document_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tex) (required) - :param int pages_count: Pages count. + :param str name: The new document name. (required) :param str storage: The document storage. - :param file file: A file to be converted. - :return: AsposeResponse + :param str folder: The new document folder. + :return: DocumentResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['out_path', 'pages_count', 'storage', 'file'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -17551,33 +17298,31 @@ def put_pdf_in_request_to_la_te_x_with_http_info(self, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_request_to_la_te_x" % key + " to method put_create_document" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_la_te_x`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_create_document`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'pages_count' in params: - query_params.append(('pagesCount', params['pages_count'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['file'] = params['file'] body_params = None # HTTP header `Accept` @@ -17586,19 +17331,19 @@ def put_pdf_in_request_to_la_te_x_with_http_info(self, out_path, **kwargs): # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/latex', 'PUT', + return self.api_client.call_api('/pdf/{name}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='DocumentResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -17606,55 +17351,57 @@ def put_pdf_in_request_to_la_te_x_with_http_info(self, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_request_to_mobi_xml(self, out_path, **kwargs): + def put_epub_in_storage_to_pdf(self, name, src_path, **kwargs): """ - Converts PDF document (in request content) to MOBIXML format and uploads resulting file to storage. + Convert EPUB file (located on storage) to PDF format and upload resulting file to storage. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_mobi_xml(out_path, callback=callback_function) + >>> thread = api.put_epub_in_storage_to_pdf(name, src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.mobixml) (required) + :param str name: The document name. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required) :param str storage: The document storage. - :param file file: A file to be converted. + :param str dst_folder: The destination document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_request_to_mobi_xml_with_http_info(out_path, **kwargs) + return self.put_epub_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) else: - (data) = self.put_pdf_in_request_to_mobi_xml_with_http_info(out_path, **kwargs) + (data) = self.put_epub_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) return data - def put_pdf_in_request_to_mobi_xml_with_http_info(self, out_path, **kwargs): + def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): """ - Converts PDF document (in request content) to MOBIXML format and uploads resulting file to storage. + Convert EPUB file (located on storage) to PDF format and upload resulting file to storage. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_mobi_xml_with_http_info(out_path, callback=callback_function) + >>> thread = api.put_epub_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.mobixml) (required) + :param str name: The document name. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required) :param str storage: The document storage. - :param file file: A file to be converted. + :param str dst_folder: The destination document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['out_path', 'storage', 'file'] + all_params = ['name', 'src_path', 'storage', 'dst_folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -17665,31 +17412,36 @@ def put_pdf_in_request_to_mobi_xml_with_http_info(self, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_request_to_mobi_xml" % key + " to method put_epub_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_mobi_xml`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_epub_in_storage_to_pdf`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `put_epub_in_storage_to_pdf`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'dst_folder' in params: + query_params.append(('dstFolder', params['dst_folder'])) header_params = {} form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['file'] = params['file'] body_params = None # HTTP header `Accept` @@ -17698,12 +17450,12 @@ def put_pdf_in_request_to_mobi_xml_with_http_info(self, out_path, **kwargs): # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/mobixml', 'PUT', + return self.api_client.call_api('/pdf/{name}/create/epub', 'PUT', path_params, query_params, header_params, @@ -17718,57 +17470,55 @@ def put_pdf_in_request_to_mobi_xml_with_http_info(self, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_request_to_pdf_a(self, out_path, type, **kwargs): + def put_fields_flatten(self, name, **kwargs): """ - Converts PDF document (in request content) to PdfA format and uploads resulting file to storage. + Flatten form fields in document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_pdf_a(out_path, type, callback=callback_function) + >>> thread = api.put_fields_flatten(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pdf) (required) - :param str type: Type of PdfA format. (required) + :param str name: The document name. (required) :param str storage: The document storage. - :param file file: A file to be converted. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, **kwargs) + return self.put_fields_flatten_with_http_info(name, **kwargs) else: - (data) = self.put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, **kwargs) + (data) = self.put_fields_flatten_with_http_info(name, **kwargs) return data - def put_pdf_in_request_to_pdf_a_with_http_info(self, out_path, type, **kwargs): + def put_fields_flatten_with_http_info(self, name, **kwargs): """ - Converts PDF document (in request content) to PdfA format and uploads resulting file to storage. + Flatten form fields in document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, callback=callback_function) + >>> thread = api.put_fields_flatten_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pdf) (required) - :param str type: Type of PdfA format. (required) + :param str name: The document name. (required) :param str storage: The document storage. - :param file file: A file to be converted. + :param str folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['out_path', 'type', 'storage', 'file'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -17779,36 +17529,31 @@ def put_pdf_in_request_to_pdf_a_with_http_info(self, out_path, type, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_request_to_pdf_a" % key + " to method put_fields_flatten" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_pdf_a`") - # verify the required parameter 'type' is set - if ('type' not in params) or (params['type'] is None): - raise ValueError("Missing the required parameter `type` when calling `put_pdf_in_request_to_pdf_a`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_fields_flatten`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'type' in params: - query_params.append(('type', params['type'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['file'] = params['file'] body_params = None # HTTP header `Accept` @@ -17817,12 +17562,12 @@ def put_pdf_in_request_to_pdf_a_with_http_info(self, out_path, type, **kwargs): # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/pdfa', 'PUT', + return self.api_client.call_api('/pdf/{name}/fields/flatten', 'PUT', path_params, query_params, header_params, @@ -17837,59 +17582,59 @@ def put_pdf_in_request_to_pdf_a_with_http_info(self, out_path, type, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_request_to_pptx(self, out_path, **kwargs): + def put_free_text_annotation(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (in request content) to PPTX format and uploads resulting file to storage. + Replace document free text annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_pptx(out_path, callback=callback_function) + >>> thread = api.put_free_text_annotation(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pptx) (required) - :param bool separate_images: Separate images. - :param bool slides_as_images: Slides as images. + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param FreeTextAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :param file file: A file to be converted. - :return: AsposeResponse + :param str folder: The document folder. + :return: FreeTextAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_request_to_pptx_with_http_info(out_path, **kwargs) + return self.put_free_text_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_pdf_in_request_to_pptx_with_http_info(out_path, **kwargs) + (data) = self.put_free_text_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_pdf_in_request_to_pptx_with_http_info(self, out_path, **kwargs): + def put_free_text_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (in request content) to PPTX format and uploads resulting file to storage. + Replace document free text annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_pptx_with_http_info(out_path, callback=callback_function) + >>> thread = api.put_free_text_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pptx) (required) - :param bool separate_images: Separate images. - :param bool slides_as_images: Slides as images. + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param FreeTextAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :param file file: A file to be converted. - :return: AsposeResponse + :param str folder: The document folder. + :return: FreeTextAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['out_path', 'separate_images', 'slides_as_images', 'storage', 'file'] + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -17900,56 +17645,62 @@ def put_pdf_in_request_to_pptx_with_http_info(self, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_request_to_pptx" % key + " to method put_free_text_annotation" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_pptx`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_free_text_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `put_free_text_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `put_free_text_annotation`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'separate_images' in params: - query_params.append(('separateImages', params['separate_images'])) - if 'slides_as_images' in params: - query_params.append(('slidesAsImages', params['slides_as_images'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['file'] = params['file'] body_params = None + if 'annotation' in params: + body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/pptx', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/freetext/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='FreeTextAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -17957,55 +17708,59 @@ def put_pdf_in_request_to_pptx_with_http_info(self, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_request_to_svg(self, out_path, **kwargs): + def put_highlight_annotation(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (in request content) to SVG format and uploads resulting file to storage. + Replace document highlight annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_svg(out_path, callback=callback_function) + >>> thread = api.put_highlight_annotation(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.svg) (required) + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param HighlightAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :param file file: A file to be converted. - :return: AsposeResponse + :param str folder: The document folder. + :return: HighlightAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_request_to_svg_with_http_info(out_path, **kwargs) + return self.put_highlight_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_pdf_in_request_to_svg_with_http_info(out_path, **kwargs) + (data) = self.put_highlight_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_pdf_in_request_to_svg_with_http_info(self, out_path, **kwargs): + def put_highlight_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (in request content) to SVG format and uploads resulting file to storage. + Replace document highlight annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_svg_with_http_info(out_path, callback=callback_function) + >>> thread = api.put_highlight_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.svg) (required) + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param HighlightAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :param file file: A file to be converted. - :return: AsposeResponse + :param str folder: The document folder. + :return: HighlightAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['out_path', 'storage', 'file'] + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -18016,52 +17771,62 @@ def put_pdf_in_request_to_svg_with_http_info(self, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_request_to_svg" % key + " to method put_highlight_annotation" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_svg`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_highlight_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `put_highlight_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `put_highlight_annotation`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['file'] = params['file'] body_params = None + if 'annotation' in params: + body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/svg', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/highlight/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='HighlightAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -18069,85 +17834,73 @@ def put_pdf_in_request_to_svg_with_http_info(self, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_request_to_tiff(self, out_path, **kwargs): + def put_html_in_storage_to_pdf(self, name, src_path, **kwargs): """ - Converts PDF document (in request content) to TIFF format and uploads resulting file to storage. + Convert HTML file (located on storage) to PDF format and upload resulting file to storage. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_tiff(out_path, callback=callback_function) + >>> thread = api.put_html_in_storage_to_pdf(name, src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tiff) (required) - :param float brightness: Image brightness. - :param str compression: Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None. - :param str color_depth: Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp. - :param int left_margin: Left image margin. - :param int right_margin: Right image margin. - :param int top_margin: Top image margin. - :param int bottom_margin: Bottom image margin. - :param str orientation: Image orientation. Possible values are: None, Landscape, Portait. - :param bool skip_blank_pages: Skip blank pages flag. - :param int width: Image width. - :param int height: Image height. - :param int x_resolution: Horizontal resolution. - :param int y_resolution: Vertical resolution. - :param int page_index: Start page to export. - :param int page_count: Number of pages to export. + :param str name: The document name. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.zip) (required) + :param str html_file_name: Name of HTML file in ZIP. + :param float height: Page height + :param float width: Page width + :param bool is_landscape: Is page landscaped + :param float margin_left: Page margin left + :param float margin_bottom: Page margin bottom + :param float margin_right: Page margin right + :param float margin_top: Page margin top + :param str dst_folder: The destination document folder. :param str storage: The document storage. - :param file file: A file to be converted. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_request_to_tiff_with_http_info(out_path, **kwargs) + return self.put_html_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) else: - (data) = self.put_pdf_in_request_to_tiff_with_http_info(out_path, **kwargs) + (data) = self.put_html_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) return data - def put_pdf_in_request_to_tiff_with_http_info(self, out_path, **kwargs): + def put_html_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): """ - Converts PDF document (in request content) to TIFF format and uploads resulting file to storage. + Convert HTML file (located on storage) to PDF format and upload resulting file to storage. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_tiff_with_http_info(out_path, callback=callback_function) + >>> thread = api.put_html_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tiff) (required) - :param float brightness: Image brightness. - :param str compression: Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None. - :param str color_depth: Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp. - :param int left_margin: Left image margin. - :param int right_margin: Right image margin. - :param int top_margin: Top image margin. - :param int bottom_margin: Bottom image margin. - :param str orientation: Image orientation. Possible values are: None, Landscape, Portait. - :param bool skip_blank_pages: Skip blank pages flag. - :param int width: Image width. - :param int height: Image height. - :param int x_resolution: Horizontal resolution. - :param int y_resolution: Vertical resolution. - :param int page_index: Start page to export. - :param int page_count: Number of pages to export. + :param str name: The document name. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.zip) (required) + :param str html_file_name: Name of HTML file in ZIP. + :param float height: Page height + :param float width: Page width + :param bool is_landscape: Is page landscaped + :param float margin_left: Page margin left + :param float margin_bottom: Page margin bottom + :param float margin_right: Page margin right + :param float margin_top: Page margin top + :param str dst_folder: The destination document folder. :param str storage: The document storage. - :param file file: A file to be converted. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['out_path', 'brightness', 'compression', 'color_depth', 'left_margin', 'right_margin', 'top_margin', 'bottom_margin', 'orientation', 'skip_blank_pages', 'width', 'height', 'x_resolution', 'y_resolution', 'page_index', 'page_count', 'storage', 'file'] + all_params = ['name', 'src_path', 'html_file_name', 'height', 'width', 'is_landscape', 'margin_left', 'margin_bottom', 'margin_right', 'margin_top', 'dst_folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -18158,52 +17911,45 @@ def put_pdf_in_request_to_tiff_with_http_info(self, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_request_to_tiff" % key + " to method put_html_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_tiff`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_html_in_storage_to_pdf`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `put_html_in_storage_to_pdf`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'brightness' in params: - query_params.append(('brightness', params['brightness'])) - if 'compression' in params: - query_params.append(('compression', params['compression'])) - if 'color_depth' in params: - query_params.append(('colorDepth', params['color_depth'])) - if 'left_margin' in params: - query_params.append(('leftMargin', params['left_margin'])) - if 'right_margin' in params: - query_params.append(('rightMargin', params['right_margin'])) - if 'top_margin' in params: - query_params.append(('topMargin', params['top_margin'])) - if 'bottom_margin' in params: - query_params.append(('bottomMargin', params['bottom_margin'])) - if 'orientation' in params: - query_params.append(('orientation', params['orientation'])) - if 'skip_blank_pages' in params: - query_params.append(('skipBlankPages', params['skip_blank_pages'])) - if 'width' in params: - query_params.append(('width', params['width'])) + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) + if 'html_file_name' in params: + query_params.append(('htmlFileName', params['html_file_name'])) if 'height' in params: query_params.append(('height', params['height'])) - if 'x_resolution' in params: - query_params.append(('xResolution', params['x_resolution'])) - if 'y_resolution' in params: - query_params.append(('yResolution', params['y_resolution'])) - if 'page_index' in params: - query_params.append(('pageIndex', params['page_index'])) - if 'page_count' in params: - query_params.append(('pageCount', params['page_count'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'is_landscape' in params: + query_params.append(('isLandscape', params['is_landscape'])) + if 'margin_left' in params: + query_params.append(('marginLeft', params['margin_left'])) + if 'margin_bottom' in params: + query_params.append(('marginBottom', params['margin_bottom'])) + if 'margin_right' in params: + query_params.append(('marginRight', params['margin_right'])) + if 'margin_top' in params: + query_params.append(('marginTop', params['margin_top'])) + if 'dst_folder' in params: + query_params.append(('dstFolder', params['dst_folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -18211,8 +17957,6 @@ def put_pdf_in_request_to_tiff_with_http_info(self, out_path, **kwargs): form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['file'] = params['file'] body_params = None # HTTP header `Accept` @@ -18221,12 +17965,12 @@ def put_pdf_in_request_to_tiff_with_http_info(self, out_path, **kwargs): # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/tiff', 'PUT', + return self.api_client.call_api('/pdf/{name}/create/html', 'PUT', path_params, query_params, header_params, @@ -18241,63 +17985,63 @@ def put_pdf_in_request_to_tiff_with_http_info(self, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_request_to_xls(self, out_path, **kwargs): + def put_image_extract_as_gif(self, name, image_id, **kwargs): """ - Converts PDF document (in request content) to XLS format and uploads resulting file to storage. + Extract document image in GIF format to folder This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_xls(out_path, callback=callback_function) + >>> thread = api.put_image_extract_as_gif(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xls) (required) - :param bool insert_blank_column_at_first: Insert blank column at first - :param bool minimize_the_number_of_worksheets: Minimize the number of worksheets - :param float scale_factor: Scale factor - :param bool uniform_worksheets: Uniform worksheets + :param str name: The document name. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str storage: The document storage. - :param file file: A file to be converted. + :param str folder: The document folder. + :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_request_to_xls_with_http_info(out_path, **kwargs) + return self.put_image_extract_as_gif_with_http_info(name, image_id, **kwargs) else: - (data) = self.put_pdf_in_request_to_xls_with_http_info(out_path, **kwargs) + (data) = self.put_image_extract_as_gif_with_http_info(name, image_id, **kwargs) return data - def put_pdf_in_request_to_xls_with_http_info(self, out_path, **kwargs): + def put_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): """ - Converts PDF document (in request content) to XLS format and uploads resulting file to storage. + Extract document image in GIF format to folder This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_xls_with_http_info(out_path, callback=callback_function) + >>> thread = api.put_image_extract_as_gif_with_http_info(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xls) (required) - :param bool insert_blank_column_at_first: Insert blank column at first - :param bool minimize_the_number_of_worksheets: Minimize the number of worksheets - :param float scale_factor: Scale factor - :param bool uniform_worksheets: Uniform worksheets + :param str name: The document name. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str storage: The document storage. - :param file file: A file to be converted. + :param str folder: The document folder. + :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['out_path', 'insert_blank_column_at_first', 'minimize_the_number_of_worksheets', 'scale_factor', 'uniform_worksheets', 'storage', 'file'] + all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -18308,39 +18052,42 @@ def put_pdf_in_request_to_xls_with_http_info(self, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_request_to_xls" % key + " to method put_image_extract_as_gif" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_xls`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_image_extract_as_gif`") + # verify the required parameter 'image_id' is set + if ('image_id' not in params) or (params['image_id'] is None): + raise ValueError("Missing the required parameter `image_id` when calling `put_image_extract_as_gif`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'image_id' in params: + path_params['imageId'] = params['image_id'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'insert_blank_column_at_first' in params: - query_params.append(('insertBlankColumnAtFirst', params['insert_blank_column_at_first'])) - if 'minimize_the_number_of_worksheets' in params: - query_params.append(('minimizeTheNumberOfWorksheets', params['minimize_the_number_of_worksheets'])) - if 'scale_factor' in params: - query_params.append(('scaleFactor', params['scale_factor'])) - if 'uniform_worksheets' in params: - query_params.append(('uniformWorksheets', params['uniform_worksheets'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) header_params = {} form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['file'] = params['file'] body_params = None # HTTP header `Accept` @@ -18349,12 +18096,12 @@ def put_pdf_in_request_to_xls_with_http_info(self, out_path, **kwargs): # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/xls', 'PUT', + return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/gif', 'PUT', path_params, query_params, header_params, @@ -18369,55 +18116,63 @@ def put_pdf_in_request_to_xls_with_http_info(self, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_request_to_xml(self, out_path, **kwargs): + def put_image_extract_as_jpeg(self, name, image_id, **kwargs): """ - Converts PDF document (in request content) to XML format and uploads resulting file to storage. + Extract document image in JPEG format to folder This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_xml(out_path, callback=callback_function) + >>> thread = api.put_image_extract_as_jpeg(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xml) (required) + :param str name: The document name. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str storage: The document storage. - :param file file: A file to be converted. + :param str folder: The document folder. + :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_request_to_xml_with_http_info(out_path, **kwargs) + return self.put_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs) else: - (data) = self.put_pdf_in_request_to_xml_with_http_info(out_path, **kwargs) + (data) = self.put_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs) return data - def put_pdf_in_request_to_xml_with_http_info(self, out_path, **kwargs): + def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): """ - Converts PDF document (in request content) to XML format and uploads resulting file to storage. + Extract document image in JPEG format to folder This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_xml_with_http_info(out_path, callback=callback_function) + >>> thread = api.put_image_extract_as_jpeg_with_http_info(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xml) (required) + :param str name: The document name. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str storage: The document storage. - :param file file: A file to be converted. + :param str folder: The document folder. + :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['out_path', 'storage', 'file'] + all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -18428,31 +18183,42 @@ def put_pdf_in_request_to_xml_with_http_info(self, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_request_to_xml" % key + " to method put_image_extract_as_jpeg" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_xml`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_image_extract_as_jpeg`") + # verify the required parameter 'image_id' is set + if ('image_id' not in params) or (params['image_id'] is None): + raise ValueError("Missing the required parameter `image_id` when calling `put_image_extract_as_jpeg`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'image_id' in params: + path_params['imageId'] = params['image_id'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) header_params = {} form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['file'] = params['file'] body_params = None # HTTP header `Accept` @@ -18461,12 +18227,12 @@ def put_pdf_in_request_to_xml_with_http_info(self, out_path, **kwargs): # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/xml', 'PUT', + return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/jpeg', 'PUT', path_params, query_params, header_params, @@ -18481,55 +18247,4661 @@ def put_pdf_in_request_to_xml_with_http_info(self, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_request_to_xps(self, out_path, **kwargs): + def put_image_extract_as_png(self, name, image_id, **kwargs): """ - Converts PDF document (in request content) to XPS format and uploads resulting file to storage. + Extract document image in PNG format to folder This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_xps(out_path, callback=callback_function) + >>> thread = api.put_image_extract_as_png(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xps) (required) + :param str name: The document name. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. :param str storage: The document storage. - :param file file: A file to be converted. + :param str folder: The document folder. + :param str dest_folder: The document folder. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_request_to_xps_with_http_info(out_path, **kwargs) + return self.put_image_extract_as_png_with_http_info(name, image_id, **kwargs) else: - (data) = self.put_pdf_in_request_to_xps_with_http_info(out_path, **kwargs) + (data) = self.put_image_extract_as_png_with_http_info(name, image_id, **kwargs) + return data + + def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): + """ + Extract document image in PNG format to folder + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_image_extract_as_png_with_http_info(name, image_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str storage: The document storage. + :param str folder: The document folder. + :param str dest_folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_image_extract_as_png" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_image_extract_as_png`") + # verify the required parameter 'image_id' is set + if ('image_id' not in params) or (params['image_id'] is None): + raise ValueError("Missing the required parameter `image_id` when calling `put_image_extract_as_png`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'image_id' in params: + path_params['imageId'] = params['image_id'] + + query_params = [] + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/png', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_image_extract_as_tiff(self, name, image_id, **kwargs): + """ + Extract document image in TIFF format to folder + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_image_extract_as_tiff(name, image_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str storage: The document storage. + :param str folder: The document folder. + :param str dest_folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_image_extract_as_tiff_with_http_info(name, image_id, **kwargs) + else: + (data) = self.put_image_extract_as_tiff_with_http_info(name, image_id, **kwargs) + return data + + def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): + """ + Extract document image in TIFF format to folder + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_image_extract_as_tiff_with_http_info(name, image_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str image_id: Image ID. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str storage: The document storage. + :param str folder: The document folder. + :param str dest_folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_image_extract_as_tiff" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_image_extract_as_tiff`") + # verify the required parameter 'image_id' is set + if ('image_id' not in params) or (params['image_id'] is None): + raise ValueError("Missing the required parameter `image_id` when calling `put_image_extract_as_tiff`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'image_id' in params: + path_params['imageId'] = params['image_id'] + + query_params = [] + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/tiff', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_image_in_storage_to_pdf(self, name, image_templates, **kwargs): + """ + Convert image file (located on storage) to PDF format and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_image_in_storage_to_pdf(name, image_templates, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param ImageTemplatesRequest image_templates: Image templates (required) + :param str dst_folder: The destination document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_image_in_storage_to_pdf_with_http_info(name, image_templates, **kwargs) + else: + (data) = self.put_image_in_storage_to_pdf_with_http_info(name, image_templates, **kwargs) + return data + + def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kwargs): + """ + Convert image file (located on storage) to PDF format and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_image_in_storage_to_pdf_with_http_info(name, image_templates, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param ImageTemplatesRequest image_templates: Image templates (required) + :param str dst_folder: The destination document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'image_templates', 'dst_folder', 'storage'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_image_in_storage_to_pdf" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_image_in_storage_to_pdf`") + # verify the required parameter 'image_templates' is set + if ('image_templates' not in params) or (params['image_templates'] is None): + raise ValueError("Missing the required parameter `image_templates` when calling `put_image_in_storage_to_pdf`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + if 'dst_folder' in params: + query_params.append(('dstFolder', params['dst_folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'image_templates' in params: + body_params = params['image_templates'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/create/images', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_images_extract_as_gif(self, name, page_number, **kwargs): + """ + Extract document images in GIF format to folder. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_images_extract_as_gif(name, page_number, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str storage: The document storage. + :param str folder: The document folder. + :param str dest_folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_images_extract_as_gif_with_http_info(name, page_number, **kwargs) + else: + (data) = self.put_images_extract_as_gif_with_http_info(name, page_number, **kwargs) + return data + + def put_images_extract_as_gif_with_http_info(self, name, page_number, **kwargs): + """ + Extract document images in GIF format to folder. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_images_extract_as_gif_with_http_info(name, page_number, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str storage: The document storage. + :param str folder: The document folder. + :param str dest_folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_images_extract_as_gif" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_images_extract_as_gif`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `put_images_extract_as_gif`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] + + query_params = [] + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/gif', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_images_extract_as_jpeg(self, name, page_number, **kwargs): + """ + Extract document images in JPEG format to folder. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_images_extract_as_jpeg(name, page_number, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str storage: + :param str folder: The document folder. + :param str dest_folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_images_extract_as_jpeg_with_http_info(name, page_number, **kwargs) + else: + (data) = self.put_images_extract_as_jpeg_with_http_info(name, page_number, **kwargs) + return data + + def put_images_extract_as_jpeg_with_http_info(self, name, page_number, **kwargs): + """ + Extract document images in JPEG format to folder. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_images_extract_as_jpeg_with_http_info(name, page_number, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str storage: + :param str folder: The document folder. + :param str dest_folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_images_extract_as_jpeg" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_images_extract_as_jpeg`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `put_images_extract_as_jpeg`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] + + query_params = [] + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/jpeg', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_images_extract_as_png(self, name, page_number, **kwargs): + """ + Extract document images in PNG format to folder. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_images_extract_as_png(name, page_number, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str storage: The document storage. + :param str folder: The document folder. + :param str dest_folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_images_extract_as_png_with_http_info(name, page_number, **kwargs) + else: + (data) = self.put_images_extract_as_png_with_http_info(name, page_number, **kwargs) + return data + + def put_images_extract_as_png_with_http_info(self, name, page_number, **kwargs): + """ + Extract document images in PNG format to folder. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_images_extract_as_png_with_http_info(name, page_number, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str storage: The document storage. + :param str folder: The document folder. + :param str dest_folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_images_extract_as_png" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_images_extract_as_png`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `put_images_extract_as_png`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] + + query_params = [] + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/png', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_images_extract_as_tiff(self, name, page_number, **kwargs): + """ + Extract document images in TIFF format to folder. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_images_extract_as_tiff(name, page_number, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str storage: The document storage. + :param str folder: The document folder. + :param str dest_folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_images_extract_as_tiff_with_http_info(name, page_number, **kwargs) + else: + (data) = self.put_images_extract_as_tiff_with_http_info(name, page_number, **kwargs) + return data + + def put_images_extract_as_tiff_with_http_info(self, name, page_number, **kwargs): + """ + Extract document images in TIFF format to folder. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_images_extract_as_tiff_with_http_info(name, page_number, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str storage: The document storage. + :param str folder: The document folder. + :param str dest_folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_images_extract_as_tiff" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_images_extract_as_tiff`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `put_images_extract_as_tiff`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] + + query_params = [] + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/tiff', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_ink_annotation(self, name, annotation_id, annotation, **kwargs): + """ + Replace document ink annotation + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_ink_annotation(name, annotation_id, annotation, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param InkAnnotation annotation: Annotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: InkAnnotationResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_ink_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + else: + (data) = self.put_ink_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return data + + def put_ink_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + """ + Replace document ink annotation + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_ink_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param InkAnnotation annotation: Annotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: InkAnnotationResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_ink_annotation" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_ink_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `put_ink_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `put_ink_annotation`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] + + query_params = [] + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'annotation' in params: + body_params = params['annotation'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/annotations/ink/{annotationId}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InkAnnotationResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_la_te_x_in_storage_to_pdf(self, name, src_path, **kwargs): + """ + Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_la_te_x_in_storage_to_pdf(name, src_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.tex) (required) + :param str dst_folder: The destination document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_la_te_x_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + else: + (data) = self.put_la_te_x_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + return data + + def put_la_te_x_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): + """ + Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_la_te_x_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.tex) (required) + :param str dst_folder: The destination document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'src_path', 'dst_folder', 'storage'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_la_te_x_in_storage_to_pdf" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_la_te_x_in_storage_to_pdf`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `put_la_te_x_in_storage_to_pdf`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) + if 'dst_folder' in params: + query_params.append(('dstFolder', params['dst_folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/create/latex', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_line_annotation(self, name, annotation_id, annotation, **kwargs): + """ + Replace document line annotation + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_line_annotation(name, annotation_id, annotation, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param LineAnnotation annotation: Annotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: LineAnnotationResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_line_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + else: + (data) = self.put_line_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return data + + def put_line_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + """ + Replace document line annotation + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_line_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param LineAnnotation annotation: Annotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: LineAnnotationResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_line_annotation" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_line_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `put_line_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `put_line_annotation`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] + + query_params = [] + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'annotation' in params: + body_params = params['annotation'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/annotations/line/{annotationId}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='LineAnnotationResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_link_annotation(self, name, link_id, link, **kwargs): + """ + Replace document page link annotations + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_link_annotation(name, link_id, link, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str link_id: The link ID. (required) + :param LinkAnnotation link: Link anotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: LinkAnnotationResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_link_annotation_with_http_info(name, link_id, link, **kwargs) + else: + (data) = self.put_link_annotation_with_http_info(name, link_id, link, **kwargs) + return data + + def put_link_annotation_with_http_info(self, name, link_id, link, **kwargs): + """ + Replace document page link annotations + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_link_annotation_with_http_info(name, link_id, link, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str link_id: The link ID. (required) + :param LinkAnnotation link: Link anotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: LinkAnnotationResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'link_id', 'link', 'storage', 'folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_link_annotation" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_link_annotation`") + # verify the required parameter 'link_id' is set + if ('link_id' not in params) or (params['link_id'] is None): + raise ValueError("Missing the required parameter `link_id` when calling `put_link_annotation`") + # verify the required parameter 'link' is set + if ('link' not in params) or (params['link'] is None): + raise ValueError("Missing the required parameter `link` when calling `put_link_annotation`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'link_id' in params: + path_params['linkId'] = params['link_id'] + + query_params = [] + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'link' in params: + body_params = params['link'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/links/{linkId}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='LinkAnnotationResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_merge_documents(self, name, **kwargs): + """ + Merge a list of documents. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_merge_documents(name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: Resulting documen name. (required) + :param MergeDocuments merge_documents: with a list of documents. + :param str storage: Resulting document storage. + :param str folder: Resulting document folder. + :return: file + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_merge_documents_with_http_info(name, **kwargs) + else: + (data) = self.put_merge_documents_with_http_info(name, **kwargs) + return data + + def put_merge_documents_with_http_info(self, name, **kwargs): + """ + Merge a list of documents. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_merge_documents_with_http_info(name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: Resulting documen name. (required) + :param MergeDocuments merge_documents: with a list of documents. + :param str storage: Resulting document storage. + :param str folder: Resulting document folder. + :return: file + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'merge_documents', 'storage', 'folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_merge_documents" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_merge_documents`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'merge_documents' in params: + body_params = params['merge_documents'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/merge', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='file', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_mht_in_storage_to_pdf(self, name, src_path, **kwargs): + """ + Convert MHT file (located on storage) to PDF format and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_mht_in_storage_to_pdf(name, src_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.mht) (required) + :param str dst_folder: The destination document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_mht_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + else: + (data) = self.put_mht_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + return data + + def put_mht_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): + """ + Convert MHT file (located on storage) to PDF format and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_mht_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.mht) (required) + :param str dst_folder: The destination document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'src_path', 'dst_folder', 'storage'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_mht_in_storage_to_pdf" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_mht_in_storage_to_pdf`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `put_mht_in_storage_to_pdf`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) + if 'dst_folder' in params: + query_params.append(('dstFolder', params['dst_folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/create/mht', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_page_add_stamp(self, name, page_number, stamp, **kwargs): + """ + Add page stamp. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_add_stamp(name, page_number, stamp, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param Stamp stamp: with data. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_page_add_stamp_with_http_info(name, page_number, stamp, **kwargs) + else: + (data) = self.put_page_add_stamp_with_http_info(name, page_number, stamp, **kwargs) + return data + + def put_page_add_stamp_with_http_info(self, name, page_number, stamp, **kwargs): + """ + Add page stamp. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_add_stamp_with_http_info(name, page_number, stamp, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param Stamp stamp: with data. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', 'stamp', 'storage', 'folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_page_add_stamp" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_page_add_stamp`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `put_page_add_stamp`") + # verify the required parameter 'stamp' is set + if ('stamp' not in params) or (params['stamp'] is None): + raise ValueError("Missing the required parameter `stamp` when calling `put_page_add_stamp`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] + + query_params = [] + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'stamp' in params: + body_params = params['stamp'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/stamp', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_page_convert_to_bmp(self, name, page_number, out_path, **kwargs): + """ + Convert document page to bmp image and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_convert_to_bmp(name, page_number, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param str out_path: The out path of result image. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_page_convert_to_bmp_with_http_info(name, page_number, out_path, **kwargs) + else: + (data) = self.put_page_convert_to_bmp_with_http_info(name, page_number, out_path, **kwargs) + return data + + def put_page_convert_to_bmp_with_http_info(self, name, page_number, out_path, **kwargs): + """ + Convert document page to bmp image and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_convert_to_bmp_with_http_info(name, page_number, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param str out_path: The out path of result image. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_page_convert_to_bmp" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_page_convert_to_bmp`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `put_page_convert_to_bmp`") + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_page_convert_to_bmp`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/bmp', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_page_convert_to_emf(self, name, page_number, out_path, **kwargs): + """ + Convert document page to emf image and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_convert_to_emf(name, page_number, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param str out_path: The out path of result image. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_page_convert_to_emf_with_http_info(name, page_number, out_path, **kwargs) + else: + (data) = self.put_page_convert_to_emf_with_http_info(name, page_number, out_path, **kwargs) + return data + + def put_page_convert_to_emf_with_http_info(self, name, page_number, out_path, **kwargs): + """ + Convert document page to emf image and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_convert_to_emf_with_http_info(name, page_number, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param str out_path: The out path of result image. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_page_convert_to_emf" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_page_convert_to_emf`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `put_page_convert_to_emf`") + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_page_convert_to_emf`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/emf', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_page_convert_to_gif(self, name, page_number, out_path, **kwargs): + """ + Convert document page to gif image and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_convert_to_gif(name, page_number, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param str out_path: The out path of result image. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_page_convert_to_gif_with_http_info(name, page_number, out_path, **kwargs) + else: + (data) = self.put_page_convert_to_gif_with_http_info(name, page_number, out_path, **kwargs) + return data + + def put_page_convert_to_gif_with_http_info(self, name, page_number, out_path, **kwargs): + """ + Convert document page to gif image and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_convert_to_gif_with_http_info(name, page_number, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param str out_path: The out path of result image. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_page_convert_to_gif" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_page_convert_to_gif`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `put_page_convert_to_gif`") + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_page_convert_to_gif`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/gif', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_page_convert_to_jpeg(self, name, page_number, out_path, **kwargs): + """ + Convert document page to Jpeg image and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_convert_to_jpeg(name, page_number, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param str out_path: The out path of result image. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_page_convert_to_jpeg_with_http_info(name, page_number, out_path, **kwargs) + else: + (data) = self.put_page_convert_to_jpeg_with_http_info(name, page_number, out_path, **kwargs) + return data + + def put_page_convert_to_jpeg_with_http_info(self, name, page_number, out_path, **kwargs): + """ + Convert document page to Jpeg image and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_convert_to_jpeg_with_http_info(name, page_number, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param str out_path: The out path of result image. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_page_convert_to_jpeg" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_page_convert_to_jpeg`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `put_page_convert_to_jpeg`") + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_page_convert_to_jpeg`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/jpeg', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_page_convert_to_png(self, name, page_number, out_path, **kwargs): + """ + Convert document page to png image and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_convert_to_png(name, page_number, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param str out_path: The out path of result image. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_page_convert_to_png_with_http_info(name, page_number, out_path, **kwargs) + else: + (data) = self.put_page_convert_to_png_with_http_info(name, page_number, out_path, **kwargs) + return data + + def put_page_convert_to_png_with_http_info(self, name, page_number, out_path, **kwargs): + """ + Convert document page to png image and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_convert_to_png_with_http_info(name, page_number, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param str out_path: The out path of result image. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_page_convert_to_png" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_page_convert_to_png`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `put_page_convert_to_png`") + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_page_convert_to_png`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/png', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_page_convert_to_tiff(self, name, page_number, out_path, **kwargs): + """ + Convert document page to Tiff image and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_convert_to_tiff(name, page_number, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param str out_path: The out path of result image. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_page_convert_to_tiff_with_http_info(name, page_number, out_path, **kwargs) + else: + (data) = self.put_page_convert_to_tiff_with_http_info(name, page_number, out_path, **kwargs) + return data + + def put_page_convert_to_tiff_with_http_info(self, name, page_number, out_path, **kwargs): + """ + Convert document page to Tiff image and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_page_convert_to_tiff_with_http_info(name, page_number, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param str out_path: The out path of result image. (required) + :param int width: The converted image width. + :param int height: The converted image height. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_page_convert_to_tiff" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_page_convert_to_tiff`") + # verify the required parameter 'page_number' is set + if ('page_number' not in params) or (params['page_number'] is None): + raise ValueError("Missing the required parameter `page_number` when calling `put_page_convert_to_tiff`") + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_page_convert_to_tiff`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'page_number' in params: + path_params['pageNumber'] = params['page_number'] + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/tiff', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pcl_in_storage_to_pdf(self, name, src_path, **kwargs): + """ + Convert PCL file (located on storage) to PDF format and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pcl_in_storage_to_pdf(name, src_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.pcl) (required) + :param str dst_folder: The destination document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pcl_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + else: + (data) = self.put_pcl_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + return data + + def put_pcl_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): + """ + Convert PCL file (located on storage) to PDF format and upload resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pcl_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.pcl) (required) + :param str dst_folder: The destination document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'src_path', 'dst_folder', 'storage'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pcl_in_storage_to_pdf" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_pcl_in_storage_to_pdf`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `put_pcl_in_storage_to_pdf`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) + if 'dst_folder' in params: + query_params.append(('dstFolder', params['dst_folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/create/pcl', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_request_to_doc(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to DOC format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_doc(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.doc) (required) + :param bool add_return_to_line_end: Add return to line end. + :param str format: Allows to specify .doc or .docx file format. + :param int image_resolution_x: Image resolution X. + :param int image_resolution_y: Image resolution Y. + :param float max_distance_between_text_lines: Max distance between text lines. + :param str mode: Allows to control how a PDF document is converted into a word processing document. + :param bool recognize_bullets: Recognize bullets. + :param float relative_horizontal_proximity: Relative horizontal proximity. + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_request_to_doc_with_http_info(out_path, **kwargs) + else: + (data) = self.put_pdf_in_request_to_doc_with_http_info(out_path, **kwargs) + return data + + def put_pdf_in_request_to_doc_with_http_info(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to DOC format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_doc_with_http_info(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.doc) (required) + :param bool add_return_to_line_end: Add return to line end. + :param str format: Allows to specify .doc or .docx file format. + :param int image_resolution_x: Image resolution X. + :param int image_resolution_y: Image resolution Y. + :param float max_distance_between_text_lines: Max distance between text lines. + :param str mode: Allows to control how a PDF document is converted into a word processing document. + :param bool recognize_bullets: Recognize bullets. + :param float relative_horizontal_proximity: Relative horizontal proximity. + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['out_path', 'add_return_to_line_end', 'format', 'image_resolution_x', 'image_resolution_y', 'max_distance_between_text_lines', 'mode', 'recognize_bullets', 'relative_horizontal_proximity', 'storage', 'file'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_request_to_doc" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_doc`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'add_return_to_line_end' in params: + query_params.append(('addReturnToLineEnd', params['add_return_to_line_end'])) + if 'format' in params: + query_params.append(('format', params['format'])) + if 'image_resolution_x' in params: + query_params.append(('imageResolutionX', params['image_resolution_x'])) + if 'image_resolution_y' in params: + query_params.append(('imageResolutionY', params['image_resolution_y'])) + if 'max_distance_between_text_lines' in params: + query_params.append(('maxDistanceBetweenTextLines', params['max_distance_between_text_lines'])) + if 'mode' in params: + query_params.append(('mode', params['mode'])) + if 'recognize_bullets' in params: + query_params.append(('recognizeBullets', params['recognize_bullets'])) + if 'relative_horizontal_proximity' in params: + query_params.append(('relativeHorizontalProximity', params['relative_horizontal_proximity'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/convert/doc', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_request_to_epub(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to EPUB format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_epub(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.epub) (required) + :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content. + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_request_to_epub_with_http_info(out_path, **kwargs) + else: + (data) = self.put_pdf_in_request_to_epub_with_http_info(out_path, **kwargs) + return data + + def put_pdf_in_request_to_epub_with_http_info(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to EPUB format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_epub_with_http_info(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.epub) (required) + :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content. + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['out_path', 'content_recognition_mode', 'storage', 'file'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_request_to_epub" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_epub`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'content_recognition_mode' in params: + query_params.append(('contentRecognitionMode', params['content_recognition_mode'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/convert/epub', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_request_to_html(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to Html format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_html(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.html) (required) + :param int additional_margin_width_in_points: Defines width of margin that will be forcibly left around that output HTML-areas. + :param bool compress_svg_graphics_if_any: The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving. + :param bool convert_marked_content_to_layers: 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 str default_font_name: 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 str document_type: Result document type. + :param bool fixed_layout: The value indicating whether that HTML is created as fixed layout. + :param int image_resolution: Resolution for image rendering. + :param int minimal_line_width: 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 bool prevent_glyphs_grouping: 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 bool split_css_into_pages: 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 bool split_into_pages: 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 bool use_z_order: 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 str antialiasing_processing: The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML. + :param str css_class_names_prefix: 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 list[int] explicit_list_of_saved_pages: 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 str font_encoding_strategy: Defines encoding special rule to tune PDF decoding for current document. + :param str font_saving_mode: Defines font saving mode that will be used during saving of PDF to desirable format. + :param str html_markup_generation_mode: 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 str letters_positioning_method: The mode of positioning of letters in words in result HTML. + :param bool pages_flow_type_depends_on_viewers_screen_size: 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 str parts_embedding_mode: 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 str raster_images_saving_mode: Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML. + :param bool remove_empty_areas_on_top_and_bottom: Defines whether in created HTML will be removed top and bottom empty area without any content (if any). + :param bool save_shadowed_texts_as_transparent_texts: 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 bool save_transparent_texts: 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 str special_folder_for_all_images: 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 str special_folder_for_svg_images: 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 bool try_save_text_underlining_and_strikeouting_in_css: 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 str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_request_to_html_with_http_info(out_path, **kwargs) + else: + (data) = self.put_pdf_in_request_to_html_with_http_info(out_path, **kwargs) + return data + + def put_pdf_in_request_to_html_with_http_info(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to Html format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_html_with_http_info(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.html) (required) + :param int additional_margin_width_in_points: Defines width of margin that will be forcibly left around that output HTML-areas. + :param bool compress_svg_graphics_if_any: The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving. + :param bool convert_marked_content_to_layers: 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 str default_font_name: 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 str document_type: Result document type. + :param bool fixed_layout: The value indicating whether that HTML is created as fixed layout. + :param int image_resolution: Resolution for image rendering. + :param int minimal_line_width: 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 bool prevent_glyphs_grouping: 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 bool split_css_into_pages: 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 bool split_into_pages: 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 bool use_z_order: 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 str antialiasing_processing: The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML. + :param str css_class_names_prefix: 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 list[int] explicit_list_of_saved_pages: 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 str font_encoding_strategy: Defines encoding special rule to tune PDF decoding for current document. + :param str font_saving_mode: Defines font saving mode that will be used during saving of PDF to desirable format. + :param str html_markup_generation_mode: 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 str letters_positioning_method: The mode of positioning of letters in words in result HTML. + :param bool pages_flow_type_depends_on_viewers_screen_size: 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 str parts_embedding_mode: 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 str raster_images_saving_mode: Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML. + :param bool remove_empty_areas_on_top_and_bottom: Defines whether in created HTML will be removed top and bottom empty area without any content (if any). + :param bool save_shadowed_texts_as_transparent_texts: 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 bool save_transparent_texts: 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 str special_folder_for_all_images: 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 str special_folder_for_svg_images: 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 bool try_save_text_underlining_and_strikeouting_in_css: 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 str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['out_path', 'additional_margin_width_in_points', 'compress_svg_graphics_if_any', 'convert_marked_content_to_layers', 'default_font_name', 'document_type', 'fixed_layout', 'image_resolution', 'minimal_line_width', 'prevent_glyphs_grouping', 'split_css_into_pages', 'split_into_pages', 'use_z_order', 'antialiasing_processing', 'css_class_names_prefix', 'explicit_list_of_saved_pages', 'font_encoding_strategy', 'font_saving_mode', 'html_markup_generation_mode', 'letters_positioning_method', 'pages_flow_type_depends_on_viewers_screen_size', 'parts_embedding_mode', 'raster_images_saving_mode', 'remove_empty_areas_on_top_and_bottom', 'save_shadowed_texts_as_transparent_texts', 'save_transparent_texts', 'special_folder_for_all_images', 'special_folder_for_svg_images', 'try_save_text_underlining_and_strikeouting_in_css', 'storage', 'file'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_request_to_html" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_html`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'additional_margin_width_in_points' in params: + query_params.append(('additionalMarginWidthInPoints', params['additional_margin_width_in_points'])) + if 'compress_svg_graphics_if_any' in params: + query_params.append(('compressSvgGraphicsIfAny', params['compress_svg_graphics_if_any'])) + if 'convert_marked_content_to_layers' in params: + query_params.append(('convertMarkedContentToLayers', params['convert_marked_content_to_layers'])) + if 'default_font_name' in params: + query_params.append(('defaultFontName', params['default_font_name'])) + if 'document_type' in params: + query_params.append(('documentType', params['document_type'])) + if 'fixed_layout' in params: + query_params.append(('fixedLayout', params['fixed_layout'])) + if 'image_resolution' in params: + query_params.append(('imageResolution', params['image_resolution'])) + if 'minimal_line_width' in params: + query_params.append(('minimalLineWidth', params['minimal_line_width'])) + if 'prevent_glyphs_grouping' in params: + query_params.append(('preventGlyphsGrouping', params['prevent_glyphs_grouping'])) + if 'split_css_into_pages' in params: + query_params.append(('splitCssIntoPages', params['split_css_into_pages'])) + if 'split_into_pages' in params: + query_params.append(('splitIntoPages', params['split_into_pages'])) + if 'use_z_order' in params: + query_params.append(('useZOrder', params['use_z_order'])) + if 'antialiasing_processing' in params: + query_params.append(('antialiasingProcessing', params['antialiasing_processing'])) + if 'css_class_names_prefix' in params: + query_params.append(('cssClassNamesPrefix', params['css_class_names_prefix'])) + if 'explicit_list_of_saved_pages' in params: + query_params.append(('explicitListOfSavedPages', params['explicit_list_of_saved_pages'])) + collection_formats['explicitListOfSavedPages'] = 'multi' + if 'font_encoding_strategy' in params: + query_params.append(('fontEncodingStrategy', params['font_encoding_strategy'])) + if 'font_saving_mode' in params: + query_params.append(('fontSavingMode', params['font_saving_mode'])) + if 'html_markup_generation_mode' in params: + query_params.append(('htmlMarkupGenerationMode', params['html_markup_generation_mode'])) + if 'letters_positioning_method' in params: + query_params.append(('lettersPositioningMethod', params['letters_positioning_method'])) + if 'pages_flow_type_depends_on_viewers_screen_size' in params: + query_params.append(('pagesFlowTypeDependsOnViewersScreenSize', params['pages_flow_type_depends_on_viewers_screen_size'])) + if 'parts_embedding_mode' in params: + query_params.append(('partsEmbeddingMode', params['parts_embedding_mode'])) + if 'raster_images_saving_mode' in params: + query_params.append(('rasterImagesSavingMode', params['raster_images_saving_mode'])) + if 'remove_empty_areas_on_top_and_bottom' in params: + query_params.append(('removeEmptyAreasOnTopAndBottom', params['remove_empty_areas_on_top_and_bottom'])) + if 'save_shadowed_texts_as_transparent_texts' in params: + query_params.append(('saveShadowedTextsAsTransparentTexts', params['save_shadowed_texts_as_transparent_texts'])) + if 'save_transparent_texts' in params: + query_params.append(('saveTransparentTexts', params['save_transparent_texts'])) + if 'special_folder_for_all_images' in params: + query_params.append(('specialFolderForAllImages', params['special_folder_for_all_images'])) + if 'special_folder_for_svg_images' in params: + query_params.append(('specialFolderForSvgImages', params['special_folder_for_svg_images'])) + if 'try_save_text_underlining_and_strikeouting_in_css' in params: + query_params.append(('trySaveTextUnderliningAndStrikeoutingInCss', params['try_save_text_underlining_and_strikeouting_in_css'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/convert/html', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_request_to_la_te_x(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to LaTeX format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_la_te_x(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tex) (required) + :param int pages_count: Pages count. + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_request_to_la_te_x_with_http_info(out_path, **kwargs) + else: + (data) = self.put_pdf_in_request_to_la_te_x_with_http_info(out_path, **kwargs) + return data + + def put_pdf_in_request_to_la_te_x_with_http_info(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to LaTeX format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_la_te_x_with_http_info(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tex) (required) + :param int pages_count: Pages count. + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['out_path', 'pages_count', 'storage', 'file'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_request_to_la_te_x" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_la_te_x`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'pages_count' in params: + query_params.append(('pagesCount', params['pages_count'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/convert/latex', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_request_to_mobi_xml(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to MOBIXML format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_mobi_xml(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.mobixml) (required) + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_request_to_mobi_xml_with_http_info(out_path, **kwargs) + else: + (data) = self.put_pdf_in_request_to_mobi_xml_with_http_info(out_path, **kwargs) + return data + + def put_pdf_in_request_to_mobi_xml_with_http_info(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to MOBIXML format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_mobi_xml_with_http_info(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.mobixml) (required) + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['out_path', 'storage', 'file'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_request_to_mobi_xml" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_mobi_xml`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/convert/mobixml', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_request_to_pdf_a(self, out_path, type, **kwargs): + """ + Converts PDF document (in request content) to PdfA format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_pdf_a(out_path, type, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pdf) (required) + :param str type: Type of PdfA format. (required) + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, **kwargs) + else: + (data) = self.put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, **kwargs) + return data + + def put_pdf_in_request_to_pdf_a_with_http_info(self, out_path, type, **kwargs): + """ + Converts PDF document (in request content) to PdfA format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pdf) (required) + :param str type: Type of PdfA format. (required) + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['out_path', 'type', 'storage', 'file'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_request_to_pdf_a" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_pdf_a`") + # verify the required parameter 'type' is set + if ('type' not in params) or (params['type'] is None): + raise ValueError("Missing the required parameter `type` when calling `put_pdf_in_request_to_pdf_a`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'type' in params: + query_params.append(('type', params['type'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/convert/pdfa', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_request_to_pptx(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to PPTX format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_pptx(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pptx) (required) + :param bool separate_images: Separate images. + :param bool slides_as_images: Slides as images. + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_request_to_pptx_with_http_info(out_path, **kwargs) + else: + (data) = self.put_pdf_in_request_to_pptx_with_http_info(out_path, **kwargs) + return data + + def put_pdf_in_request_to_pptx_with_http_info(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to PPTX format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_pptx_with_http_info(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pptx) (required) + :param bool separate_images: Separate images. + :param bool slides_as_images: Slides as images. + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['out_path', 'separate_images', 'slides_as_images', 'storage', 'file'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_request_to_pptx" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_pptx`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'separate_images' in params: + query_params.append(('separateImages', params['separate_images'])) + if 'slides_as_images' in params: + query_params.append(('slidesAsImages', params['slides_as_images'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/convert/pptx', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_request_to_svg(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to SVG format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_svg(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.svg) (required) + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_request_to_svg_with_http_info(out_path, **kwargs) + else: + (data) = self.put_pdf_in_request_to_svg_with_http_info(out_path, **kwargs) + return data + + def put_pdf_in_request_to_svg_with_http_info(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to SVG format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_svg_with_http_info(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.svg) (required) + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['out_path', 'storage', 'file'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_request_to_svg" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_svg`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/convert/svg', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_request_to_tiff(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to TIFF format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_tiff(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tiff) (required) + :param float brightness: Image brightness. + :param str compression: Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None. + :param str color_depth: Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp. + :param int left_margin: Left image margin. + :param int right_margin: Right image margin. + :param int top_margin: Top image margin. + :param int bottom_margin: Bottom image margin. + :param str orientation: Image orientation. Possible values are: None, Landscape, Portait. + :param bool skip_blank_pages: Skip blank pages flag. + :param int width: Image width. + :param int height: Image height. + :param int x_resolution: Horizontal resolution. + :param int y_resolution: Vertical resolution. + :param int page_index: Start page to export. + :param int page_count: Number of pages to export. + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_request_to_tiff_with_http_info(out_path, **kwargs) + else: + (data) = self.put_pdf_in_request_to_tiff_with_http_info(out_path, **kwargs) + return data + + def put_pdf_in_request_to_tiff_with_http_info(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to TIFF format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_tiff_with_http_info(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tiff) (required) + :param float brightness: Image brightness. + :param str compression: Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None. + :param str color_depth: Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp. + :param int left_margin: Left image margin. + :param int right_margin: Right image margin. + :param int top_margin: Top image margin. + :param int bottom_margin: Bottom image margin. + :param str orientation: Image orientation. Possible values are: None, Landscape, Portait. + :param bool skip_blank_pages: Skip blank pages flag. + :param int width: Image width. + :param int height: Image height. + :param int x_resolution: Horizontal resolution. + :param int y_resolution: Vertical resolution. + :param int page_index: Start page to export. + :param int page_count: Number of pages to export. + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['out_path', 'brightness', 'compression', 'color_depth', 'left_margin', 'right_margin', 'top_margin', 'bottom_margin', 'orientation', 'skip_blank_pages', 'width', 'height', 'x_resolution', 'y_resolution', 'page_index', 'page_count', 'storage', 'file'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_request_to_tiff" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_tiff`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'brightness' in params: + query_params.append(('brightness', params['brightness'])) + if 'compression' in params: + query_params.append(('compression', params['compression'])) + if 'color_depth' in params: + query_params.append(('colorDepth', params['color_depth'])) + if 'left_margin' in params: + query_params.append(('leftMargin', params['left_margin'])) + if 'right_margin' in params: + query_params.append(('rightMargin', params['right_margin'])) + if 'top_margin' in params: + query_params.append(('topMargin', params['top_margin'])) + if 'bottom_margin' in params: + query_params.append(('bottomMargin', params['bottom_margin'])) + if 'orientation' in params: + query_params.append(('orientation', params['orientation'])) + if 'skip_blank_pages' in params: + query_params.append(('skipBlankPages', params['skip_blank_pages'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'x_resolution' in params: + query_params.append(('xResolution', params['x_resolution'])) + if 'y_resolution' in params: + query_params.append(('yResolution', params['y_resolution'])) + if 'page_index' in params: + query_params.append(('pageIndex', params['page_index'])) + if 'page_count' in params: + query_params.append(('pageCount', params['page_count'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/convert/tiff', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_request_to_xls(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to XLS format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_xls(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xls) (required) + :param bool insert_blank_column_at_first: Insert blank column at first + :param bool minimize_the_number_of_worksheets: Minimize the number of worksheets + :param float scale_factor: Scale factor + :param bool uniform_worksheets: Uniform worksheets + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_request_to_xls_with_http_info(out_path, **kwargs) + else: + (data) = self.put_pdf_in_request_to_xls_with_http_info(out_path, **kwargs) + return data + + def put_pdf_in_request_to_xls_with_http_info(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to XLS format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_xls_with_http_info(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xls) (required) + :param bool insert_blank_column_at_first: Insert blank column at first + :param bool minimize_the_number_of_worksheets: Minimize the number of worksheets + :param float scale_factor: Scale factor + :param bool uniform_worksheets: Uniform worksheets + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['out_path', 'insert_blank_column_at_first', 'minimize_the_number_of_worksheets', 'scale_factor', 'uniform_worksheets', 'storage', 'file'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_request_to_xls" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_xls`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'insert_blank_column_at_first' in params: + query_params.append(('insertBlankColumnAtFirst', params['insert_blank_column_at_first'])) + if 'minimize_the_number_of_worksheets' in params: + query_params.append(('minimizeTheNumberOfWorksheets', params['minimize_the_number_of_worksheets'])) + if 'scale_factor' in params: + query_params.append(('scaleFactor', params['scale_factor'])) + if 'uniform_worksheets' in params: + query_params.append(('uniformWorksheets', params['uniform_worksheets'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/convert/xls', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_request_to_xml(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to XML format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_xml(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xml) (required) + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_request_to_xml_with_http_info(out_path, **kwargs) + else: + (data) = self.put_pdf_in_request_to_xml_with_http_info(out_path, **kwargs) + return data + + def put_pdf_in_request_to_xml_with_http_info(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to XML format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_xml_with_http_info(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xml) (required) + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['out_path', 'storage', 'file'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_request_to_xml" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_xml`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/convert/xml', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_request_to_xps(self, out_path, **kwargs): + """ + Converts PDF document (in request content) to XPS format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_xps(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xps) (required) + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_request_to_xps_with_http_info(out_path, **kwargs) + else: + (data) = self.put_pdf_in_request_to_xps_with_http_info(out_path, **kwargs) return data def put_pdf_in_request_to_xps_with_http_info(self, out_path, **kwargs): """ - Converts PDF document (in request content) to XPS format and uploads resulting file to storage. + Converts PDF document (in request content) to XPS format and uploads resulting file to storage. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_request_to_xps_with_http_info(out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xps) (required) + :param str storage: The document storage. + :param file file: A file to be converted. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['out_path', 'storage', 'file'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_request_to_xps" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_xps`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/convert/xps', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_storage_to_doc(self, name, out_path, **kwargs): + """ + Converts PDF document (located on storage) to DOC format and uploads resulting file to storage + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_storage_to_doc(name, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.doc) (required) + :param bool add_return_to_line_end: Add return to line end. + :param str format: Allows to specify .doc or .docx file format. + :param int image_resolution_x: Image resolution X. + :param int image_resolution_y: Image resolution Y. + :param float max_distance_between_text_lines: Max distance between text lines. + :param str mode: Allows to control how a PDF document is converted into a word processing document. + :param bool recognize_bullets: Recognize bullets. + :param float relative_horizontal_proximity: Relative horizontal proximity. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_storage_to_doc_with_http_info(name, out_path, **kwargs) + else: + (data) = self.put_pdf_in_storage_to_doc_with_http_info(name, out_path, **kwargs) + return data + + def put_pdf_in_storage_to_doc_with_http_info(self, name, out_path, **kwargs): + """ + Converts PDF document (located on storage) to DOC format and uploads resulting file to storage + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_storage_to_doc_with_http_info(name, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.doc) (required) + :param bool add_return_to_line_end: Add return to line end. + :param str format: Allows to specify .doc or .docx file format. + :param int image_resolution_x: Image resolution X. + :param int image_resolution_y: Image resolution Y. + :param float max_distance_between_text_lines: Max distance between text lines. + :param str mode: Allows to control how a PDF document is converted into a word processing document. + :param bool recognize_bullets: Recognize bullets. + :param float relative_horizontal_proximity: Relative horizontal proximity. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'out_path', 'add_return_to_line_end', 'format', 'image_resolution_x', 'image_resolution_y', 'max_distance_between_text_lines', 'mode', 'recognize_bullets', 'relative_horizontal_proximity', 'folder', 'storage'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_storage_to_doc" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_doc`") + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_doc`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'add_return_to_line_end' in params: + query_params.append(('addReturnToLineEnd', params['add_return_to_line_end'])) + if 'format' in params: + query_params.append(('format', params['format'])) + if 'image_resolution_x' in params: + query_params.append(('imageResolutionX', params['image_resolution_x'])) + if 'image_resolution_y' in params: + query_params.append(('imageResolutionY', params['image_resolution_y'])) + if 'max_distance_between_text_lines' in params: + query_params.append(('maxDistanceBetweenTextLines', params['max_distance_between_text_lines'])) + if 'mode' in params: + query_params.append(('mode', params['mode'])) + if 'recognize_bullets' in params: + query_params.append(('recognizeBullets', params['recognize_bullets'])) + if 'relative_horizontal_proximity' in params: + query_params.append(('relativeHorizontalProximity', params['relative_horizontal_proximity'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/convert/doc', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_storage_to_epub(self, name, out_path, **kwargs): + """ + Converts PDF document (located on storage) to EPUB format and uploads resulting file to storage + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_storage_to_epub(name, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.epub) (required) + :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_storage_to_epub_with_http_info(name, out_path, **kwargs) + else: + (data) = self.put_pdf_in_storage_to_epub_with_http_info(name, out_path, **kwargs) + return data + + def put_pdf_in_storage_to_epub_with_http_info(self, name, out_path, **kwargs): + """ + Converts PDF document (located on storage) to EPUB format and uploads resulting file to storage + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_storage_to_epub_with_http_info(name, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.epub) (required) + :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content. + :param str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'out_path', 'content_recognition_mode', 'folder', 'storage'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_pdf_in_storage_to_epub" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_epub`") + # verify the required parameter 'out_path' is set + if ('out_path' not in params) or (params['out_path'] is None): + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_epub`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'content_recognition_mode' in params: + query_params.append(('contentRecognitionMode', params['content_recognition_mode'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/convert/epub', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='AsposeResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def put_pdf_in_storage_to_html(self, name, out_path, **kwargs): + """ + Converts PDF document (located on storage) to Html format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_request_to_xps_with_http_info(out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_html(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xps) (required) + :param str name: The document name. (required) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.html) (required) + :param int additional_margin_width_in_points: Defines width of margin that will be forcibly left around that output HTML-areas. + :param bool compress_svg_graphics_if_any: The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving. + :param bool convert_marked_content_to_layers: 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 str default_font_name: 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 str document_type: Result document type. + :param bool fixed_layout: The value indicating whether that HTML is created as fixed layout. + :param int image_resolution: Resolution for image rendering. + :param int minimal_line_width: 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 bool prevent_glyphs_grouping: 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 bool split_css_into_pages: 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 bool split_into_pages: 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 bool use_z_order: 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 str antialiasing_processing: The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML. + :param str css_class_names_prefix: 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 list[int] explicit_list_of_saved_pages: 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 str font_encoding_strategy: Defines encoding special rule to tune PDF decoding for current document. + :param str font_saving_mode: Defines font saving mode that will be used during saving of PDF to desirable format. + :param str html_markup_generation_mode: 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 str letters_positioning_method: The mode of positioning of letters in words in result HTML. + :param bool pages_flow_type_depends_on_viewers_screen_size: 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 str parts_embedding_mode: 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 str raster_images_saving_mode: Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML. + :param bool remove_empty_areas_on_top_and_bottom: Defines whether in created HTML will be removed top and bottom empty area without any content (if any). + :param bool save_shadowed_texts_as_transparent_texts: 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 bool save_transparent_texts: 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 str special_folder_for_all_images: 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 str special_folder_for_svg_images: 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 bool try_save_text_underlining_and_strikeouting_in_css: 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 str folder: The document folder. :param str storage: The document storage. - :param file file: A file to be converted. :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_pdf_in_storage_to_html_with_http_info(name, out_path, **kwargs) + else: + (data) = self.put_pdf_in_storage_to_html_with_http_info(name, out_path, **kwargs) + return data - all_params = ['out_path', 'storage', 'file'] + def put_pdf_in_storage_to_html_with_http_info(self, name, out_path, **kwargs): + """ + Converts PDF document (located on storage) to Html format and uploads resulting file to storage + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_pdf_in_storage_to_html_with_http_info(name, out_path, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.html) (required) + :param int additional_margin_width_in_points: Defines width of margin that will be forcibly left around that output HTML-areas. + :param bool compress_svg_graphics_if_any: The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving. + :param bool convert_marked_content_to_layers: 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 str default_font_name: 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 str document_type: Result document type. + :param bool fixed_layout: The value indicating whether that HTML is created as fixed layout. + :param int image_resolution: Resolution for image rendering. + :param int minimal_line_width: 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 bool prevent_glyphs_grouping: 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 bool split_css_into_pages: 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 bool split_into_pages: 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 bool use_z_order: 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 str antialiasing_processing: The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML. + :param str css_class_names_prefix: 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 list[int] explicit_list_of_saved_pages: 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 str font_encoding_strategy: Defines encoding special rule to tune PDF decoding for current document. + :param str font_saving_mode: Defines font saving mode that will be used during saving of PDF to desirable format. + :param str html_markup_generation_mode: 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 str letters_positioning_method: The mode of positioning of letters in words in result HTML. + :param bool pages_flow_type_depends_on_viewers_screen_size: 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 str parts_embedding_mode: 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 str raster_images_saving_mode: Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML. + :param bool remove_empty_areas_on_top_and_bottom: Defines whether in created HTML will be removed top and bottom empty area without any content (if any). + :param bool save_shadowed_texts_as_transparent_texts: 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 bool save_transparent_texts: 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 str special_folder_for_all_images: 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 str special_folder_for_svg_images: 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 bool try_save_text_underlining_and_strikeouting_in_css: 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 str folder: The document folder. + :param str storage: The document storage. + :return: AsposeResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'out_path', 'additional_margin_width_in_points', 'compress_svg_graphics_if_any', 'convert_marked_content_to_layers', 'default_font_name', 'document_type', 'fixed_layout', 'image_resolution', 'minimal_line_width', 'prevent_glyphs_grouping', 'split_css_into_pages', 'split_into_pages', 'use_z_order', 'antialiasing_processing', 'css_class_names_prefix', 'explicit_list_of_saved_pages', 'font_encoding_strategy', 'font_saving_mode', 'html_markup_generation_mode', 'letters_positioning_method', 'pages_flow_type_depends_on_viewers_screen_size', 'parts_embedding_mode', 'raster_images_saving_mode', 'remove_empty_areas_on_top_and_bottom', 'save_shadowed_texts_as_transparent_texts', 'save_transparent_texts', 'special_folder_for_all_images', 'special_folder_for_svg_images', 'try_save_text_underlining_and_strikeouting_in_css', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -18540,22 +22912,86 @@ def put_pdf_in_request_to_xps_with_http_info(self, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_request_to_xps" % key + " to method put_pdf_in_storage_to_html" % key ) params[key] = val del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_html`") # verify the required parameter 'out_path' is set if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_xps`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_html`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] query_params = [] if 'out_path' in params: query_params.append(('outPath', params['out_path'])) + if 'additional_margin_width_in_points' in params: + query_params.append(('additionalMarginWidthInPoints', params['additional_margin_width_in_points'])) + if 'compress_svg_graphics_if_any' in params: + query_params.append(('compressSvgGraphicsIfAny', params['compress_svg_graphics_if_any'])) + if 'convert_marked_content_to_layers' in params: + query_params.append(('convertMarkedContentToLayers', params['convert_marked_content_to_layers'])) + if 'default_font_name' in params: + query_params.append(('defaultFontName', params['default_font_name'])) + if 'document_type' in params: + query_params.append(('documentType', params['document_type'])) + if 'fixed_layout' in params: + query_params.append(('fixedLayout', params['fixed_layout'])) + if 'image_resolution' in params: + query_params.append(('imageResolution', params['image_resolution'])) + if 'minimal_line_width' in params: + query_params.append(('minimalLineWidth', params['minimal_line_width'])) + if 'prevent_glyphs_grouping' in params: + query_params.append(('preventGlyphsGrouping', params['prevent_glyphs_grouping'])) + if 'split_css_into_pages' in params: + query_params.append(('splitCssIntoPages', params['split_css_into_pages'])) + if 'split_into_pages' in params: + query_params.append(('splitIntoPages', params['split_into_pages'])) + if 'use_z_order' in params: + query_params.append(('useZOrder', params['use_z_order'])) + if 'antialiasing_processing' in params: + query_params.append(('antialiasingProcessing', params['antialiasing_processing'])) + if 'css_class_names_prefix' in params: + query_params.append(('cssClassNamesPrefix', params['css_class_names_prefix'])) + if 'explicit_list_of_saved_pages' in params: + query_params.append(('explicitListOfSavedPages', params['explicit_list_of_saved_pages'])) + collection_formats['explicitListOfSavedPages'] = 'multi' + if 'font_encoding_strategy' in params: + query_params.append(('fontEncodingStrategy', params['font_encoding_strategy'])) + if 'font_saving_mode' in params: + query_params.append(('fontSavingMode', params['font_saving_mode'])) + if 'html_markup_generation_mode' in params: + query_params.append(('htmlMarkupGenerationMode', params['html_markup_generation_mode'])) + if 'letters_positioning_method' in params: + query_params.append(('lettersPositioningMethod', params['letters_positioning_method'])) + if 'pages_flow_type_depends_on_viewers_screen_size' in params: + query_params.append(('pagesFlowTypeDependsOnViewersScreenSize', params['pages_flow_type_depends_on_viewers_screen_size'])) + if 'parts_embedding_mode' in params: + query_params.append(('partsEmbeddingMode', params['parts_embedding_mode'])) + if 'raster_images_saving_mode' in params: + query_params.append(('rasterImagesSavingMode', params['raster_images_saving_mode'])) + if 'remove_empty_areas_on_top_and_bottom' in params: + query_params.append(('removeEmptyAreasOnTopAndBottom', params['remove_empty_areas_on_top_and_bottom'])) + if 'save_shadowed_texts_as_transparent_texts' in params: + query_params.append(('saveShadowedTextsAsTransparentTexts', params['save_shadowed_texts_as_transparent_texts'])) + if 'save_transparent_texts' in params: + query_params.append(('saveTransparentTexts', params['save_transparent_texts'])) + if 'special_folder_for_all_images' in params: + query_params.append(('specialFolderForAllImages', params['special_folder_for_all_images'])) + if 'special_folder_for_svg_images' in params: + query_params.append(('specialFolderForSvgImages', params['special_folder_for_svg_images'])) + if 'try_save_text_underlining_and_strikeouting_in_css' in params: + query_params.append(('trySaveTextUnderliningAndStrikeoutingInCss', params['try_save_text_underlining_and_strikeouting_in_css'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -18563,8 +22999,6 @@ def put_pdf_in_request_to_xps_with_http_info(self, out_path, **kwargs): form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['file'] = params['file'] body_params = None # HTTP header `Accept` @@ -18573,12 +23007,12 @@ def put_pdf_in_request_to_xps_with_http_info(self, out_path, **kwargs): # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/xps', 'PUT', + return self.api_client.call_api('/pdf/{name}/convert/html', 'PUT', path_params, query_params, header_params, @@ -18593,29 +23027,22 @@ def put_pdf_in_request_to_xps_with_http_info(self, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_storage_to_doc(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_la_te_x(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to DOC format and uploads resulting file to storage + Converts PDF document (located on storage) to LaTeX format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_doc(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_la_te_x(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.doc) (required) - :param bool add_return_to_line_end: Add return to line end. - :param str format: Allows to specify .doc or .docx file format. - :param int image_resolution_x: Image resolution X. - :param int image_resolution_y: Image resolution Y. - :param float max_distance_between_text_lines: Max distance between text lines. - :param str mode: Allows to control how a PDF document is converted into a word processing document. - :param bool recognize_bullets: Recognize bullets. - :param float relative_horizontal_proximity: Relative horizontal proximity. + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tex) (required) + :param int pages_count: Pages count. :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -18624,34 +23051,27 @@ def put_pdf_in_storage_to_doc(self, name, out_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_storage_to_doc_with_http_info(name, out_path, **kwargs) + return self.put_pdf_in_storage_to_la_te_x_with_http_info(name, out_path, **kwargs) else: - (data) = self.put_pdf_in_storage_to_doc_with_http_info(name, out_path, **kwargs) + (data) = self.put_pdf_in_storage_to_la_te_x_with_http_info(name, out_path, **kwargs) return data - def put_pdf_in_storage_to_doc_with_http_info(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_la_te_x_with_http_info(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to DOC format and uploads resulting file to storage + Converts PDF document (located on storage) to LaTeX format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_doc_with_http_info(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_la_te_x_with_http_info(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.doc) (required) - :param bool add_return_to_line_end: Add return to line end. - :param str format: Allows to specify .doc or .docx file format. - :param int image_resolution_x: Image resolution X. - :param int image_resolution_y: Image resolution Y. - :param float max_distance_between_text_lines: Max distance between text lines. - :param str mode: Allows to control how a PDF document is converted into a word processing document. - :param bool recognize_bullets: Recognize bullets. - :param float relative_horizontal_proximity: Relative horizontal proximity. + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tex) (required) + :param int pages_count: Pages count. :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -18659,7 +23079,7 @@ def put_pdf_in_storage_to_doc_with_http_info(self, name, out_path, **kwargs): returns the request thread. """ - all_params = ['name', 'out_path', 'add_return_to_line_end', 'format', 'image_resolution_x', 'image_resolution_y', 'max_distance_between_text_lines', 'mode', 'recognize_bullets', 'relative_horizontal_proximity', 'folder', 'storage'] + all_params = ['name', 'out_path', 'pages_count', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -18670,16 +23090,16 @@ def put_pdf_in_storage_to_doc_with_http_info(self, name, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_storage_to_doc" % key + " to method put_pdf_in_storage_to_la_te_x" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_doc`") + raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_la_te_x`") # verify the required parameter 'out_path' is set if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_doc`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_la_te_x`") collection_formats = {} @@ -18691,22 +23111,8 @@ def put_pdf_in_storage_to_doc_with_http_info(self, name, out_path, **kwargs): query_params = [] if 'out_path' in params: query_params.append(('outPath', params['out_path'])) - if 'add_return_to_line_end' in params: - query_params.append(('addReturnToLineEnd', params['add_return_to_line_end'])) - if 'format' in params: - query_params.append(('format', params['format'])) - if 'image_resolution_x' in params: - query_params.append(('imageResolutionX', params['image_resolution_x'])) - if 'image_resolution_y' in params: - query_params.append(('imageResolutionY', params['image_resolution_y'])) - if 'max_distance_between_text_lines' in params: - query_params.append(('maxDistanceBetweenTextLines', params['max_distance_between_text_lines'])) - if 'mode' in params: - query_params.append(('mode', params['mode'])) - if 'recognize_bullets' in params: - query_params.append(('recognizeBullets', params['recognize_bullets'])) - if 'relative_horizontal_proximity' in params: - query_params.append(('relativeHorizontalProximity', params['relative_horizontal_proximity'])) + if 'pages_count' in params: + query_params.append(('pagesCount', params['pages_count'])) if 'folder' in params: query_params.append(('folder', params['folder'])) if 'storage' in params: @@ -18729,7 +23135,7 @@ def put_pdf_in_storage_to_doc_with_http_info(self, name, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/doc', 'PUT', + return self.api_client.call_api('/pdf/{name}/convert/latex', 'PUT', path_params, query_params, header_params, @@ -18744,22 +23150,21 @@ def put_pdf_in_storage_to_doc_with_http_info(self, name, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_storage_to_epub(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_mobi_xml(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to EPUB format and uploads resulting file to storage + Converts PDF document (located on storage) to MOBIXML format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_epub(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_mobi_xml(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.epub) (required) - :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content. + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.mobixml) (required) :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -18768,27 +23173,26 @@ def put_pdf_in_storage_to_epub(self, name, out_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_storage_to_epub_with_http_info(name, out_path, **kwargs) + return self.put_pdf_in_storage_to_mobi_xml_with_http_info(name, out_path, **kwargs) else: - (data) = self.put_pdf_in_storage_to_epub_with_http_info(name, out_path, **kwargs) + (data) = self.put_pdf_in_storage_to_mobi_xml_with_http_info(name, out_path, **kwargs) return data - def put_pdf_in_storage_to_epub_with_http_info(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_mobi_xml_with_http_info(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to EPUB format and uploads resulting file to storage + Converts PDF document (located on storage) to MOBIXML format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_epub_with_http_info(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_mobi_xml_with_http_info(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.epub) (required) - :param str content_recognition_mode: ?roperty tunes conversion for this or that desirable method of recognition of content. + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.mobixml) (required) :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -18796,7 +23200,7 @@ def put_pdf_in_storage_to_epub_with_http_info(self, name, out_path, **kwargs): returns the request thread. """ - all_params = ['name', 'out_path', 'content_recognition_mode', 'folder', 'storage'] + all_params = ['name', 'out_path', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -18807,16 +23211,16 @@ def put_pdf_in_storage_to_epub_with_http_info(self, name, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_storage_to_epub" % key + " to method put_pdf_in_storage_to_mobi_xml" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_epub`") + raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_mobi_xml`") # verify the required parameter 'out_path' is set if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_epub`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_mobi_xml`") collection_formats = {} @@ -18828,8 +23232,6 @@ def put_pdf_in_storage_to_epub_with_http_info(self, name, out_path, **kwargs): query_params = [] if 'out_path' in params: query_params.append(('outPath', params['out_path'])) - if 'content_recognition_mode' in params: - query_params.append(('contentRecognitionMode', params['content_recognition_mode'])) if 'folder' in params: query_params.append(('folder', params['folder'])) if 'storage' in params: @@ -18852,7 +23254,7 @@ def put_pdf_in_storage_to_epub_with_http_info(self, name, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/epub', 'PUT', + return self.api_client.call_api('/pdf/{name}/convert/mobixml', 'PUT', path_params, query_params, header_params, @@ -18867,49 +23269,22 @@ def put_pdf_in_storage_to_epub_with_http_info(self, name, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_storage_to_html(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_pdf_a(self, name, out_path, type, **kwargs): """ - Converts PDF document (located on storage) to Html format and uploads resulting file to storage + Converts PDF document (located on storage) to PdfA format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_html(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_pdf_a(name, out_path, type, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.html) (required) - :param int additional_margin_width_in_points: Defines width of margin that will be forcibly left around that output HTML-areas. - :param bool compress_svg_graphics_if_any: The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving. - :param bool convert_marked_content_to_layers: 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 str default_font_name: 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 str document_type: Result document type. - :param bool fixed_layout: The value indicating whether that HTML is created as fixed layout. - :param int image_resolution: Resolution for image rendering. - :param int minimal_line_width: 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 bool prevent_glyphs_grouping: 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 bool split_css_into_pages: 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 bool split_into_pages: 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 bool use_z_order: 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 str antialiasing_processing: The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML. - :param str css_class_names_prefix: 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 list[int] explicit_list_of_saved_pages: 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 str font_encoding_strategy: Defines encoding special rule to tune PDF decoding for current document. - :param str font_saving_mode: Defines font saving mode that will be used during saving of PDF to desirable format. - :param str html_markup_generation_mode: 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 str letters_positioning_method: The mode of positioning of letters in words in result HTML. - :param bool pages_flow_type_depends_on_viewers_screen_size: 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 str parts_embedding_mode: 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 str raster_images_saving_mode: Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML. - :param bool remove_empty_areas_on_top_and_bottom: Defines whether in created HTML will be removed top and bottom empty area without any content (if any). - :param bool save_shadowed_texts_as_transparent_texts: 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 bool save_transparent_texts: 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 str special_folder_for_all_images: 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 str special_folder_for_svg_images: 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 bool try_save_text_underlining_and_strikeouting_in_css: 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 str out_path: Full resulting filename (ex. /folder1/folder2/result.pdf) (required) + :param str type: Type of PdfA format. (required) :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -18918,54 +23293,27 @@ def put_pdf_in_storage_to_html(self, name, out_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_storage_to_html_with_http_info(name, out_path, **kwargs) + return self.put_pdf_in_storage_to_pdf_a_with_http_info(name, out_path, type, **kwargs) else: - (data) = self.put_pdf_in_storage_to_html_with_http_info(name, out_path, **kwargs) + (data) = self.put_pdf_in_storage_to_pdf_a_with_http_info(name, out_path, type, **kwargs) return data - def put_pdf_in_storage_to_html_with_http_info(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_pdf_a_with_http_info(self, name, out_path, type, **kwargs): """ - Converts PDF document (located on storage) to Html format and uploads resulting file to storage + Converts PDF document (located on storage) to PdfA format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_html_with_http_info(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_pdf_a_with_http_info(name, out_path, type, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.html) (required) - :param int additional_margin_width_in_points: Defines width of margin that will be forcibly left around that output HTML-areas. - :param bool compress_svg_graphics_if_any: The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving. - :param bool convert_marked_content_to_layers: 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 str default_font_name: 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 str document_type: Result document type. - :param bool fixed_layout: The value indicating whether that HTML is created as fixed layout. - :param int image_resolution: Resolution for image rendering. - :param int minimal_line_width: 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 bool prevent_glyphs_grouping: 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 bool split_css_into_pages: 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 bool split_into_pages: 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 bool use_z_order: 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 str antialiasing_processing: The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML. - :param str css_class_names_prefix: 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 list[int] explicit_list_of_saved_pages: 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 str font_encoding_strategy: Defines encoding special rule to tune PDF decoding for current document. - :param str font_saving_mode: Defines font saving mode that will be used during saving of PDF to desirable format. - :param str html_markup_generation_mode: 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 str letters_positioning_method: The mode of positioning of letters in words in result HTML. - :param bool pages_flow_type_depends_on_viewers_screen_size: 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 str parts_embedding_mode: 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 str raster_images_saving_mode: Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML. - :param bool remove_empty_areas_on_top_and_bottom: Defines whether in created HTML will be removed top and bottom empty area without any content (if any). - :param bool save_shadowed_texts_as_transparent_texts: 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 bool save_transparent_texts: 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 str special_folder_for_all_images: 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 str special_folder_for_svg_images: 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 bool try_save_text_underlining_and_strikeouting_in_css: 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 str out_path: Full resulting filename (ex. /folder1/folder2/result.pdf) (required) + :param str type: Type of PdfA format. (required) :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -18973,7 +23321,7 @@ def put_pdf_in_storage_to_html_with_http_info(self, name, out_path, **kwargs): returns the request thread. """ - all_params = ['name', 'out_path', 'additional_margin_width_in_points', 'compress_svg_graphics_if_any', 'convert_marked_content_to_layers', 'default_font_name', 'document_type', 'fixed_layout', 'image_resolution', 'minimal_line_width', 'prevent_glyphs_grouping', 'split_css_into_pages', 'split_into_pages', 'use_z_order', 'antialiasing_processing', 'css_class_names_prefix', 'explicit_list_of_saved_pages', 'font_encoding_strategy', 'font_saving_mode', 'html_markup_generation_mode', 'letters_positioning_method', 'pages_flow_type_depends_on_viewers_screen_size', 'parts_embedding_mode', 'raster_images_saving_mode', 'remove_empty_areas_on_top_and_bottom', 'save_shadowed_texts_as_transparent_texts', 'save_transparent_texts', 'special_folder_for_all_images', 'special_folder_for_svg_images', 'try_save_text_underlining_and_strikeouting_in_css', 'folder', 'storage'] + all_params = ['name', 'out_path', 'type', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -18984,84 +23332,32 @@ def put_pdf_in_storage_to_html_with_http_info(self, name, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_storage_to_html" % key + " to method put_pdf_in_storage_to_pdf_a" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_html`") + raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_pdf_a`") # verify the required parameter 'out_path' is set if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_html`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_pdf_a`") + # verify the required parameter 'type' is set + if ('type' not in params) or (params['type'] is None): + raise ValueError("Missing the required parameter `type` when calling `put_pdf_in_storage_to_pdf_a`") collection_formats = {} path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - - query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'additional_margin_width_in_points' in params: - query_params.append(('additionalMarginWidthInPoints', params['additional_margin_width_in_points'])) - if 'compress_svg_graphics_if_any' in params: - query_params.append(('compressSvgGraphicsIfAny', params['compress_svg_graphics_if_any'])) - if 'convert_marked_content_to_layers' in params: - query_params.append(('convertMarkedContentToLayers', params['convert_marked_content_to_layers'])) - if 'default_font_name' in params: - query_params.append(('defaultFontName', params['default_font_name'])) - if 'document_type' in params: - query_params.append(('documentType', params['document_type'])) - if 'fixed_layout' in params: - query_params.append(('fixedLayout', params['fixed_layout'])) - if 'image_resolution' in params: - query_params.append(('imageResolution', params['image_resolution'])) - if 'minimal_line_width' in params: - query_params.append(('minimalLineWidth', params['minimal_line_width'])) - if 'prevent_glyphs_grouping' in params: - query_params.append(('preventGlyphsGrouping', params['prevent_glyphs_grouping'])) - if 'split_css_into_pages' in params: - query_params.append(('splitCssIntoPages', params['split_css_into_pages'])) - if 'split_into_pages' in params: - query_params.append(('splitIntoPages', params['split_into_pages'])) - if 'use_z_order' in params: - query_params.append(('useZOrder', params['use_z_order'])) - if 'antialiasing_processing' in params: - query_params.append(('antialiasingProcessing', params['antialiasing_processing'])) - if 'css_class_names_prefix' in params: - query_params.append(('cssClassNamesPrefix', params['css_class_names_prefix'])) - if 'explicit_list_of_saved_pages' in params: - query_params.append(('explicitListOfSavedPages', params['explicit_list_of_saved_pages'])) - collection_formats['explicitListOfSavedPages'] = 'multi' - if 'font_encoding_strategy' in params: - query_params.append(('fontEncodingStrategy', params['font_encoding_strategy'])) - if 'font_saving_mode' in params: - query_params.append(('fontSavingMode', params['font_saving_mode'])) - if 'html_markup_generation_mode' in params: - query_params.append(('htmlMarkupGenerationMode', params['html_markup_generation_mode'])) - if 'letters_positioning_method' in params: - query_params.append(('lettersPositioningMethod', params['letters_positioning_method'])) - if 'pages_flow_type_depends_on_viewers_screen_size' in params: - query_params.append(('pagesFlowTypeDependsOnViewersScreenSize', params['pages_flow_type_depends_on_viewers_screen_size'])) - if 'parts_embedding_mode' in params: - query_params.append(('partsEmbeddingMode', params['parts_embedding_mode'])) - if 'raster_images_saving_mode' in params: - query_params.append(('rasterImagesSavingMode', params['raster_images_saving_mode'])) - if 'remove_empty_areas_on_top_and_bottom' in params: - query_params.append(('removeEmptyAreasOnTopAndBottom', params['remove_empty_areas_on_top_and_bottom'])) - if 'save_shadowed_texts_as_transparent_texts' in params: - query_params.append(('saveShadowedTextsAsTransparentTexts', params['save_shadowed_texts_as_transparent_texts'])) - if 'save_transparent_texts' in params: - query_params.append(('saveTransparentTexts', params['save_transparent_texts'])) - if 'special_folder_for_all_images' in params: - query_params.append(('specialFolderForAllImages', params['special_folder_for_all_images'])) - if 'special_folder_for_svg_images' in params: - query_params.append(('specialFolderForSvgImages', params['special_folder_for_svg_images'])) - if 'try_save_text_underlining_and_strikeouting_in_css' in params: - query_params.append(('trySaveTextUnderliningAndStrikeoutingInCss', params['try_save_text_underlining_and_strikeouting_in_css'])) + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + if 'out_path' in params: + query_params.append(('outPath', params['out_path'])) + if 'type' in params: + query_params.append(('type', params['type'])) if 'folder' in params: query_params.append(('folder', params['folder'])) if 'storage' in params: @@ -19084,7 +23380,7 @@ def put_pdf_in_storage_to_html_with_http_info(self, name, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/html', 'PUT', + return self.api_client.call_api('/pdf/{name}/convert/pdfa', 'PUT', path_params, query_params, header_params, @@ -19099,22 +23395,23 @@ def put_pdf_in_storage_to_html_with_http_info(self, name, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_storage_to_la_te_x(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_pptx(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to LaTeX format and uploads resulting file to storage + Converts PDF document (located on storage) to PPTX format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_la_te_x(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_pptx(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tex) (required) - :param int pages_count: Pages count. + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pptx) (required) + :param bool separate_images: Separate images. + :param bool slides_as_images: Slides as images. :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -19123,27 +23420,28 @@ def put_pdf_in_storage_to_la_te_x(self, name, out_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_storage_to_la_te_x_with_http_info(name, out_path, **kwargs) + return self.put_pdf_in_storage_to_pptx_with_http_info(name, out_path, **kwargs) else: - (data) = self.put_pdf_in_storage_to_la_te_x_with_http_info(name, out_path, **kwargs) + (data) = self.put_pdf_in_storage_to_pptx_with_http_info(name, out_path, **kwargs) return data - def put_pdf_in_storage_to_la_te_x_with_http_info(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_pptx_with_http_info(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to LaTeX format and uploads resulting file to storage + Converts PDF document (located on storage) to PPTX format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_la_te_x_with_http_info(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_pptx_with_http_info(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tex) (required) - :param int pages_count: Pages count. + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pptx) (required) + :param bool separate_images: Separate images. + :param bool slides_as_images: Slides as images. :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -19151,7 +23449,7 @@ def put_pdf_in_storage_to_la_te_x_with_http_info(self, name, out_path, **kwargs) returns the request thread. """ - all_params = ['name', 'out_path', 'pages_count', 'folder', 'storage'] + all_params = ['name', 'out_path', 'separate_images', 'slides_as_images', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -19162,16 +23460,16 @@ def put_pdf_in_storage_to_la_te_x_with_http_info(self, name, out_path, **kwargs) if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_storage_to_la_te_x" % key + " to method put_pdf_in_storage_to_pptx" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_la_te_x`") + raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_pptx`") # verify the required parameter 'out_path' is set if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_la_te_x`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_pptx`") collection_formats = {} @@ -19183,8 +23481,10 @@ def put_pdf_in_storage_to_la_te_x_with_http_info(self, name, out_path, **kwargs) query_params = [] if 'out_path' in params: query_params.append(('outPath', params['out_path'])) - if 'pages_count' in params: - query_params.append(('pagesCount', params['pages_count'])) + if 'separate_images' in params: + query_params.append(('separateImages', params['separate_images'])) + if 'slides_as_images' in params: + query_params.append(('slidesAsImages', params['slides_as_images'])) if 'folder' in params: query_params.append(('folder', params['folder'])) if 'storage' in params: @@ -19207,7 +23507,7 @@ def put_pdf_in_storage_to_la_te_x_with_http_info(self, name, out_path, **kwargs) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/latex', 'PUT', + return self.api_client.call_api('/pdf/{name}/convert/pptx', 'PUT', path_params, query_params, header_params, @@ -19222,21 +23522,21 @@ def put_pdf_in_storage_to_la_te_x_with_http_info(self, name, out_path, **kwargs) _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_storage_to_mobi_xml(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_svg(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to MOBIXML format and uploads resulting file to storage + Converts PDF document (located on storage) to SVG format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_mobi_xml(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_svg(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.mobixml) (required) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.svg) (required) :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -19245,26 +23545,26 @@ def put_pdf_in_storage_to_mobi_xml(self, name, out_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_storage_to_mobi_xml_with_http_info(name, out_path, **kwargs) + return self.put_pdf_in_storage_to_svg_with_http_info(name, out_path, **kwargs) else: - (data) = self.put_pdf_in_storage_to_mobi_xml_with_http_info(name, out_path, **kwargs) + (data) = self.put_pdf_in_storage_to_svg_with_http_info(name, out_path, **kwargs) return data - def put_pdf_in_storage_to_mobi_xml_with_http_info(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_svg_with_http_info(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to MOBIXML format and uploads resulting file to storage + Converts PDF document (located on storage) to SVG format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_mobi_xml_with_http_info(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_svg_with_http_info(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.mobixml) (required) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.svg) (required) :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -19283,16 +23583,16 @@ def put_pdf_in_storage_to_mobi_xml_with_http_info(self, name, out_path, **kwargs if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_storage_to_mobi_xml" % key + " to method put_pdf_in_storage_to_svg" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_mobi_xml`") + raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_svg`") # verify the required parameter 'out_path' is set if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_mobi_xml`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_svg`") collection_formats = {} @@ -19326,7 +23626,7 @@ def put_pdf_in_storage_to_mobi_xml_with_http_info(self, name, out_path, **kwargs # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/mobixml', 'PUT', + return self.api_client.call_api('/pdf/{name}/convert/svg', 'PUT', path_params, query_params, header_params, @@ -19341,22 +23641,36 @@ def put_pdf_in_storage_to_mobi_xml_with_http_info(self, name, out_path, **kwargs _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_storage_to_pdf_a(self, name, out_path, type, **kwargs): + def put_pdf_in_storage_to_tiff(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to PdfA format and uploads resulting file to storage + Converts PDF document (located on storage) to TIFF format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_pdf_a(name, out_path, type, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_tiff(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pdf) (required) - :param str type: Type of PdfA format. (required) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tiff) (required) + :param float brightness: Image brightness. + :param str compression: Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None. + :param str color_depth: Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp. + :param int left_margin: Left image margin. + :param int right_margin: Right image margin. + :param int top_margin: Top image margin. + :param int bottom_margin: Bottom image margin. + :param str orientation: Image orientation. Possible values are: None, Landscape, Portait. + :param bool skip_blank_pages: Skip blank pages flag. + :param int width: Image width. + :param int height: Image height. + :param int x_resolution: Horizontal resolution. + :param int y_resolution: Vertical resolution. + :param int page_index: Start page to export. + :param int page_count: Number of pages to export. :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -19365,27 +23679,41 @@ def put_pdf_in_storage_to_pdf_a(self, name, out_path, type, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_storage_to_pdf_a_with_http_info(name, out_path, type, **kwargs) + return self.put_pdf_in_storage_to_tiff_with_http_info(name, out_path, **kwargs) else: - (data) = self.put_pdf_in_storage_to_pdf_a_with_http_info(name, out_path, type, **kwargs) + (data) = self.put_pdf_in_storage_to_tiff_with_http_info(name, out_path, **kwargs) return data - def put_pdf_in_storage_to_pdf_a_with_http_info(self, name, out_path, type, **kwargs): + def put_pdf_in_storage_to_tiff_with_http_info(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to PdfA format and uploads resulting file to storage + Converts PDF document (located on storage) to TIFF format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_pdf_a_with_http_info(name, out_path, type, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_tiff_with_http_info(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pdf) (required) - :param str type: Type of PdfA format. (required) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tiff) (required) + :param float brightness: Image brightness. + :param str compression: Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None. + :param str color_depth: Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp. + :param int left_margin: Left image margin. + :param int right_margin: Right image margin. + :param int top_margin: Top image margin. + :param int bottom_margin: Bottom image margin. + :param str orientation: Image orientation. Possible values are: None, Landscape, Portait. + :param bool skip_blank_pages: Skip blank pages flag. + :param int width: Image width. + :param int height: Image height. + :param int x_resolution: Horizontal resolution. + :param int y_resolution: Vertical resolution. + :param int page_index: Start page to export. + :param int page_count: Number of pages to export. :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -19393,7 +23721,7 @@ def put_pdf_in_storage_to_pdf_a_with_http_info(self, name, out_path, type, **kwa returns the request thread. """ - all_params = ['name', 'out_path', 'type', 'folder', 'storage'] + all_params = ['name', 'out_path', 'brightness', 'compression', 'color_depth', 'left_margin', 'right_margin', 'top_margin', 'bottom_margin', 'orientation', 'skip_blank_pages', 'width', 'height', 'x_resolution', 'y_resolution', 'page_index', 'page_count', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -19404,19 +23732,16 @@ def put_pdf_in_storage_to_pdf_a_with_http_info(self, name, out_path, type, **kwa if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_storage_to_pdf_a" % key + " to method put_pdf_in_storage_to_tiff" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_pdf_a`") + raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_tiff`") # verify the required parameter 'out_path' is set if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_pdf_a`") - # verify the required parameter 'type' is set - if ('type' not in params) or (params['type'] is None): - raise ValueError("Missing the required parameter `type` when calling `put_pdf_in_storage_to_pdf_a`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_tiff`") collection_formats = {} @@ -19428,8 +23753,36 @@ def put_pdf_in_storage_to_pdf_a_with_http_info(self, name, out_path, type, **kwa query_params = [] if 'out_path' in params: query_params.append(('outPath', params['out_path'])) - if 'type' in params: - query_params.append(('type', params['type'])) + if 'brightness' in params: + query_params.append(('brightness', params['brightness'])) + if 'compression' in params: + query_params.append(('compression', params['compression'])) + if 'color_depth' in params: + query_params.append(('colorDepth', params['color_depth'])) + if 'left_margin' in params: + query_params.append(('leftMargin', params['left_margin'])) + if 'right_margin' in params: + query_params.append(('rightMargin', params['right_margin'])) + if 'top_margin' in params: + query_params.append(('topMargin', params['top_margin'])) + if 'bottom_margin' in params: + query_params.append(('bottomMargin', params['bottom_margin'])) + if 'orientation' in params: + query_params.append(('orientation', params['orientation'])) + if 'skip_blank_pages' in params: + query_params.append(('skipBlankPages', params['skip_blank_pages'])) + if 'width' in params: + query_params.append(('width', params['width'])) + if 'height' in params: + query_params.append(('height', params['height'])) + if 'x_resolution' in params: + query_params.append(('xResolution', params['x_resolution'])) + if 'y_resolution' in params: + query_params.append(('yResolution', params['y_resolution'])) + if 'page_index' in params: + query_params.append(('pageIndex', params['page_index'])) + if 'page_count' in params: + query_params.append(('pageCount', params['page_count'])) if 'folder' in params: query_params.append(('folder', params['folder'])) if 'storage' in params: @@ -19452,7 +23805,7 @@ def put_pdf_in_storage_to_pdf_a_with_http_info(self, name, out_path, type, **kwa # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/pdfa', 'PUT', + return self.api_client.call_api('/pdf/{name}/convert/tiff', 'PUT', path_params, query_params, header_params, @@ -19467,23 +23820,25 @@ def put_pdf_in_storage_to_pdf_a_with_http_info(self, name, out_path, type, **kwa _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_storage_to_pptx(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_xls(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to PPTX format and uploads resulting file to storage + Converts PDF document (located on storage) to XLS format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_pptx(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_xls(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pptx) (required) - :param bool separate_images: Separate images. - :param bool slides_as_images: Slides as images. + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xls) (required) + :param bool insert_blank_column_at_first: Insert blank column at first + :param bool minimize_the_number_of_worksheets: Minimize the number of worksheets + :param float scale_factor: Scale factor + :param bool uniform_worksheets: Uniform worksheets :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -19492,28 +23847,30 @@ def put_pdf_in_storage_to_pptx(self, name, out_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_storage_to_pptx_with_http_info(name, out_path, **kwargs) + return self.put_pdf_in_storage_to_xls_with_http_info(name, out_path, **kwargs) else: - (data) = self.put_pdf_in_storage_to_pptx_with_http_info(name, out_path, **kwargs) + (data) = self.put_pdf_in_storage_to_xls_with_http_info(name, out_path, **kwargs) return data - def put_pdf_in_storage_to_pptx_with_http_info(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_xls_with_http_info(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to PPTX format and uploads resulting file to storage + Converts PDF document (located on storage) to XLS format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_pptx_with_http_info(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_xls_with_http_info(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.pptx) (required) - :param bool separate_images: Separate images. - :param bool slides_as_images: Slides as images. + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xls) (required) + :param bool insert_blank_column_at_first: Insert blank column at first + :param bool minimize_the_number_of_worksheets: Minimize the number of worksheets + :param float scale_factor: Scale factor + :param bool uniform_worksheets: Uniform worksheets :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -19521,7 +23878,7 @@ def put_pdf_in_storage_to_pptx_with_http_info(self, name, out_path, **kwargs): returns the request thread. """ - all_params = ['name', 'out_path', 'separate_images', 'slides_as_images', 'folder', 'storage'] + all_params = ['name', 'out_path', 'insert_blank_column_at_first', 'minimize_the_number_of_worksheets', 'scale_factor', 'uniform_worksheets', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -19532,16 +23889,16 @@ def put_pdf_in_storage_to_pptx_with_http_info(self, name, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_storage_to_pptx" % key + " to method put_pdf_in_storage_to_xls" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_pptx`") + raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_xls`") # verify the required parameter 'out_path' is set if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_pptx`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_xls`") collection_formats = {} @@ -19553,10 +23910,14 @@ def put_pdf_in_storage_to_pptx_with_http_info(self, name, out_path, **kwargs): query_params = [] if 'out_path' in params: query_params.append(('outPath', params['out_path'])) - if 'separate_images' in params: - query_params.append(('separateImages', params['separate_images'])) - if 'slides_as_images' in params: - query_params.append(('slidesAsImages', params['slides_as_images'])) + if 'insert_blank_column_at_first' in params: + query_params.append(('insertBlankColumnAtFirst', params['insert_blank_column_at_first'])) + if 'minimize_the_number_of_worksheets' in params: + query_params.append(('minimizeTheNumberOfWorksheets', params['minimize_the_number_of_worksheets'])) + if 'scale_factor' in params: + query_params.append(('scaleFactor', params['scale_factor'])) + if 'uniform_worksheets' in params: + query_params.append(('uniformWorksheets', params['uniform_worksheets'])) if 'folder' in params: query_params.append(('folder', params['folder'])) if 'storage' in params: @@ -19579,7 +23940,7 @@ def put_pdf_in_storage_to_pptx_with_http_info(self, name, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/pptx', 'PUT', + return self.api_client.call_api('/pdf/{name}/convert/xls', 'PUT', path_params, query_params, header_params, @@ -19594,21 +23955,21 @@ def put_pdf_in_storage_to_pptx_with_http_info(self, name, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_storage_to_svg(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_xml(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to SVG format and uploads resulting file to storage + Converts PDF document (located on storage) to XML format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_svg(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_xml(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.svg) (required) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xml) (required) :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -19617,26 +23978,26 @@ def put_pdf_in_storage_to_svg(self, name, out_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_storage_to_svg_with_http_info(name, out_path, **kwargs) + return self.put_pdf_in_storage_to_xml_with_http_info(name, out_path, **kwargs) else: - (data) = self.put_pdf_in_storage_to_svg_with_http_info(name, out_path, **kwargs) + (data) = self.put_pdf_in_storage_to_xml_with_http_info(name, out_path, **kwargs) return data - def put_pdf_in_storage_to_svg_with_http_info(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_xml_with_http_info(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to SVG format and uploads resulting file to storage + Converts PDF document (located on storage) to XML format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_svg_with_http_info(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_xml_with_http_info(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.svg) (required) + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xml) (required) :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -19655,16 +24016,16 @@ def put_pdf_in_storage_to_svg_with_http_info(self, name, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_storage_to_svg" % key + " to method put_pdf_in_storage_to_xml" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_svg`") + raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_xml`") # verify the required parameter 'out_path' is set if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_svg`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_xml`") collection_formats = {} @@ -19698,7 +24059,7 @@ def put_pdf_in_storage_to_svg_with_http_info(self, name, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/svg', 'PUT', + return self.api_client.call_api('/pdf/{name}/convert/xml', 'PUT', path_params, query_params, header_params, @@ -19713,36 +24074,21 @@ def put_pdf_in_storage_to_svg_with_http_info(self, name, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_storage_to_tiff(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_xps(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to TIFF format and uploads resulting file to storage + Converts PDF document (located on storage) to XPS format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_tiff(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_xps(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tiff) (required) - :param float brightness: Image brightness. - :param str compression: Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None. - :param str color_depth: Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp. - :param int left_margin: Left image margin. - :param int right_margin: Right image margin. - :param int top_margin: Top image margin. - :param int bottom_margin: Bottom image margin. - :param str orientation: Image orientation. Possible values are: None, Landscape, Portait. - :param bool skip_blank_pages: Skip blank pages flag. - :param int width: Image width. - :param int height: Image height. - :param int x_resolution: Horizontal resolution. - :param int y_resolution: Vertical resolution. - :param int page_index: Start page to export. - :param int page_count: Number of pages to export. + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xps) (required) :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -19751,41 +24097,26 @@ def put_pdf_in_storage_to_tiff(self, name, out_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_storage_to_tiff_with_http_info(name, out_path, **kwargs) + return self.put_pdf_in_storage_to_xps_with_http_info(name, out_path, **kwargs) else: - (data) = self.put_pdf_in_storage_to_tiff_with_http_info(name, out_path, **kwargs) + (data) = self.put_pdf_in_storage_to_xps_with_http_info(name, out_path, **kwargs) return data - def put_pdf_in_storage_to_tiff_with_http_info(self, name, out_path, **kwargs): + def put_pdf_in_storage_to_xps_with_http_info(self, name, out_path, **kwargs): """ - Converts PDF document (located on storage) to TIFF format and uploads resulting file to storage + Converts PDF document (located on storage) to XPS format and uploads resulting file to storage This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_tiff_with_http_info(name, out_path, callback=callback_function) + >>> thread = api.put_pdf_in_storage_to_xps_with_http_info(name, out_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.tiff) (required) - :param float brightness: Image brightness. - :param str compression: Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None. - :param str color_depth: Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp. - :param int left_margin: Left image margin. - :param int right_margin: Right image margin. - :param int top_margin: Top image margin. - :param int bottom_margin: Bottom image margin. - :param str orientation: Image orientation. Possible values are: None, Landscape, Portait. - :param bool skip_blank_pages: Skip blank pages flag. - :param int width: Image width. - :param int height: Image height. - :param int x_resolution: Horizontal resolution. - :param int y_resolution: Vertical resolution. - :param int page_index: Start page to export. - :param int page_count: Number of pages to export. + :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xps) (required) :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -19793,7 +24124,7 @@ def put_pdf_in_storage_to_tiff_with_http_info(self, name, out_path, **kwargs): returns the request thread. """ - all_params = ['name', 'out_path', 'brightness', 'compression', 'color_depth', 'left_margin', 'right_margin', 'top_margin', 'bottom_margin', 'orientation', 'skip_blank_pages', 'width', 'height', 'x_resolution', 'y_resolution', 'page_index', 'page_count', 'folder', 'storage'] + all_params = ['name', 'out_path', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -19804,16 +24135,16 @@ def put_pdf_in_storage_to_tiff_with_http_info(self, name, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_storage_to_tiff" % key + " to method put_pdf_in_storage_to_xps" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_tiff`") + raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_xps`") # verify the required parameter 'out_path' is set if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_tiff`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_xps`") collection_formats = {} @@ -19825,36 +24156,6 @@ def put_pdf_in_storage_to_tiff_with_http_info(self, name, out_path, **kwargs): query_params = [] if 'out_path' in params: query_params.append(('outPath', params['out_path'])) - if 'brightness' in params: - query_params.append(('brightness', params['brightness'])) - if 'compression' in params: - query_params.append(('compression', params['compression'])) - if 'color_depth' in params: - query_params.append(('colorDepth', params['color_depth'])) - if 'left_margin' in params: - query_params.append(('leftMargin', params['left_margin'])) - if 'right_margin' in params: - query_params.append(('rightMargin', params['right_margin'])) - if 'top_margin' in params: - query_params.append(('topMargin', params['top_margin'])) - if 'bottom_margin' in params: - query_params.append(('bottomMargin', params['bottom_margin'])) - if 'orientation' in params: - query_params.append(('orientation', params['orientation'])) - if 'skip_blank_pages' in params: - query_params.append(('skipBlankPages', params['skip_blank_pages'])) - if 'width' in params: - query_params.append(('width', params['width'])) - if 'height' in params: - query_params.append(('height', params['height'])) - if 'x_resolution' in params: - query_params.append(('xResolution', params['x_resolution'])) - if 'y_resolution' in params: - query_params.append(('yResolution', params['y_resolution'])) - if 'page_index' in params: - query_params.append(('pageIndex', params['page_index'])) - if 'page_count' in params: - query_params.append(('pageCount', params['page_count'])) if 'folder' in params: query_params.append(('folder', params['folder'])) if 'storage' in params: @@ -19877,7 +24178,7 @@ def put_pdf_in_storage_to_tiff_with_http_info(self, name, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/tiff', 'PUT', + return self.api_client.call_api('/pdf/{name}/convert/xps', 'PUT', path_params, query_params, header_params, @@ -19892,65 +24193,59 @@ def put_pdf_in_storage_to_tiff_with_http_info(self, name, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_storage_to_xls(self, name, out_path, **kwargs): + def put_poly_line_annotation(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (located on storage) to XLS format and uploads resulting file to storage + Replace document polyline annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_xls(name, out_path, callback=callback_function) + >>> thread = api.put_poly_line_annotation(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xls) (required) - :param bool insert_blank_column_at_first: Insert blank column at first - :param bool minimize_the_number_of_worksheets: Minimize the number of worksheets - :param float scale_factor: Scale factor - :param bool uniform_worksheets: Uniform worksheets - :param str folder: The document folder. + :param str annotation_id: The annotation ID. (required) + :param PolyLineAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :return: AsposeResponse + :param str folder: The document folder. + :return: PolyLineAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_storage_to_xls_with_http_info(name, out_path, **kwargs) + return self.put_poly_line_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_pdf_in_storage_to_xls_with_http_info(name, out_path, **kwargs) + (data) = self.put_poly_line_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_pdf_in_storage_to_xls_with_http_info(self, name, out_path, **kwargs): + def put_poly_line_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (located on storage) to XLS format and uploads resulting file to storage + Replace document polyline annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_xls_with_http_info(name, out_path, callback=callback_function) + >>> thread = api.put_poly_line_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xls) (required) - :param bool insert_blank_column_at_first: Insert blank column at first - :param bool minimize_the_number_of_worksheets: Minimize the number of worksheets - :param float scale_factor: Scale factor - :param bool uniform_worksheets: Uniform worksheets - :param str folder: The document folder. + :param str annotation_id: The annotation ID. (required) + :param PolyLineAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :return: AsposeResponse + :param str folder: The document folder. + :return: PolyLineAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'out_path', 'insert_blank_column_at_first', 'minimize_the_number_of_worksheets', 'scale_factor', 'uniform_worksheets', 'folder', 'storage'] + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -19961,16 +24256,19 @@ def put_pdf_in_storage_to_xls_with_http_info(self, name, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_storage_to_xls" % key + " to method put_poly_line_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_xls`") - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_xls`") + raise ValueError("Missing the required parameter `name` when calling `put_poly_line_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `put_poly_line_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `put_poly_line_annotation`") collection_formats = {} @@ -19978,22 +24276,14 @@ def put_pdf_in_storage_to_xls_with_http_info(self, name, out_path, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'insert_blank_column_at_first' in params: - query_params.append(('insertBlankColumnAtFirst', params['insert_blank_column_at_first'])) - if 'minimize_the_number_of_worksheets' in params: - query_params.append(('minimizeTheNumberOfWorksheets', params['minimize_the_number_of_worksheets'])) - if 'scale_factor' in params: - query_params.append(('scaleFactor', params['scale_factor'])) - if 'uniform_worksheets' in params: - query_params.append(('uniformWorksheets', params['uniform_worksheets'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -20001,6 +24291,8 @@ def put_pdf_in_storage_to_xls_with_http_info(self, name, out_path, **kwargs): local_var_files = {} body_params = None + if 'annotation' in params: + body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -20012,14 +24304,14 @@ def put_pdf_in_storage_to_xls_with_http_info(self, name, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/xls', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/polyline/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='PolyLineAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -20027,57 +24319,59 @@ def put_pdf_in_storage_to_xls_with_http_info(self, name, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_storage_to_xml(self, name, out_path, **kwargs): + def put_polygon_annotation(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (located on storage) to XML format and uploads resulting file to storage + Replace document polygon annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_xml(name, out_path, callback=callback_function) + >>> thread = api.put_polygon_annotation(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xml) (required) - :param str folder: The document folder. + :param str annotation_id: The annotation ID. (required) + :param PolygonAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :return: AsposeResponse + :param str folder: The document folder. + :return: PolygonAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_storage_to_xml_with_http_info(name, out_path, **kwargs) + return self.put_polygon_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_pdf_in_storage_to_xml_with_http_info(name, out_path, **kwargs) + (data) = self.put_polygon_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_pdf_in_storage_to_xml_with_http_info(self, name, out_path, **kwargs): + def put_polygon_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (located on storage) to XML format and uploads resulting file to storage + Replace document polygon annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_xml_with_http_info(name, out_path, callback=callback_function) + >>> thread = api.put_polygon_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xml) (required) - :param str folder: The document folder. + :param str annotation_id: The annotation ID. (required) + :param PolygonAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :return: AsposeResponse + :param str folder: The document folder. + :return: PolygonAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'out_path', 'folder', 'storage'] + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -20088,16 +24382,19 @@ def put_pdf_in_storage_to_xml_with_http_info(self, name, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_storage_to_xml" % key + " to method put_polygon_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_xml`") - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_xml`") + raise ValueError("Missing the required parameter `name` when calling `put_polygon_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `put_polygon_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `put_polygon_annotation`") collection_formats = {} @@ -20105,14 +24402,14 @@ def put_pdf_in_storage_to_xml_with_http_info(self, name, out_path, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -20120,6 +24417,8 @@ def put_pdf_in_storage_to_xml_with_http_info(self, name, out_path, **kwargs): local_var_files = {} body_params = None + if 'annotation' in params: + body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -20131,14 +24430,14 @@ def put_pdf_in_storage_to_xml_with_http_info(self, name, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/xml', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/polygon/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='PolygonAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -20146,57 +24445,59 @@ def put_pdf_in_storage_to_xml_with_http_info(self, name, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_pdf_in_storage_to_xps(self, name, out_path, **kwargs): + def put_popup_annotation(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (located on storage) to XPS format and uploads resulting file to storage + Replace document popup annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_xps(name, out_path, callback=callback_function) + >>> thread = api.put_popup_annotation(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xps) (required) - :param str folder: The document folder. + :param str annotation_id: The annotation ID. (required) + :param PopupAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :return: AsposeResponse + :param str folder: The document folder. + :return: PopupAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_pdf_in_storage_to_xps_with_http_info(name, out_path, **kwargs) + return self.put_popup_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_pdf_in_storage_to_xps_with_http_info(name, out_path, **kwargs) + (data) = self.put_popup_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_pdf_in_storage_to_xps_with_http_info(self, name, out_path, **kwargs): + def put_popup_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (located on storage) to XPS format and uploads resulting file to storage + Replace document popup annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_pdf_in_storage_to_xps_with_http_info(name, out_path, callback=callback_function) + >>> thread = api.put_popup_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str out_path: Full resulting filename (ex. /folder1/folder2/result.xps) (required) - :param str folder: The document folder. + :param str annotation_id: The annotation ID. (required) + :param PopupAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :return: AsposeResponse + :param str folder: The document folder. + :return: PopupAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'out_path', 'folder', 'storage'] + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -20207,16 +24508,19 @@ def put_pdf_in_storage_to_xps_with_http_info(self, name, out_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_pdf_in_storage_to_xps" % key + " to method put_popup_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_pdf_in_storage_to_xps`") - # verify the required parameter 'out_path' is set - if ('out_path' not in params) or (params['out_path'] is None): - raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_storage_to_xps`") + raise ValueError("Missing the required parameter `name` when calling `put_popup_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `put_popup_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `put_popup_annotation`") collection_formats = {} @@ -20224,14 +24528,14 @@ def put_pdf_in_storage_to_xps_with_http_info(self, name, out_path, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'out_path' in params: - query_params.append(('outPath', params['out_path'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -20239,6 +24543,8 @@ def put_pdf_in_storage_to_xps_with_http_info(self, name, out_path, **kwargs): local_var_files = {} body_params = None + if 'annotation' in params: + body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -20250,14 +24556,14 @@ def put_pdf_in_storage_to_xps_with_http_info(self, name, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/convert/xps', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/popup/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='PopupAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -20265,59 +24571,57 @@ def put_pdf_in_storage_to_xps_with_http_info(self, name, out_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_poly_line_annotation(self, name, annotation_id, annotation, **kwargs): + def put_privileges(self, name, **kwargs): """ - Replace document polyline annotation + Update privilege document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_poly_line_annotation(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.put_privileges(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param PolyLineAnnotation annotation: Annotation. (required) + :param DocumentPrivilege privileges: Document privileges. :param str storage: The document storage. :param str folder: The document folder. - :return: PolyLineAnnotationResponse + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_poly_line_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.put_privileges_with_http_info(name, **kwargs) else: - (data) = self.put_poly_line_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.put_privileges_with_http_info(name, **kwargs) return data - def put_poly_line_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def put_privileges_with_http_info(self, name, **kwargs): """ - Replace document polyline annotation + Update privilege document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_poly_line_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.put_privileges_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param PolyLineAnnotation annotation: Annotation. (required) + :param DocumentPrivilege privileges: Document privileges. :param str storage: The document storage. :param str folder: The document folder. - :return: PolyLineAnnotationResponse + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] + all_params = ['name', 'privileges', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -20328,19 +24632,13 @@ def put_poly_line_annotation_with_http_info(self, name, annotation_id, annotatio if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_poly_line_annotation" % key + " to method put_privileges" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_poly_line_annotation`") - # verify the required parameter 'annotation_id' is set - if ('annotation_id' not in params) or (params['annotation_id'] is None): - raise ValueError("Missing the required parameter `annotation_id` when calling `put_poly_line_annotation`") - # verify the required parameter 'annotation' is set - if ('annotation' not in params) or (params['annotation'] is None): - raise ValueError("Missing the required parameter `annotation` when calling `put_poly_line_annotation`") + raise ValueError("Missing the required parameter `name` when calling `put_privileges`") collection_formats = {} @@ -20348,8 +24646,6 @@ def put_poly_line_annotation_with_http_info(self, name, annotation_id, annotatio path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'annotation_id' in params: - path_params['annotationId'] = params['annotation_id'] query_params = [] if 'storage' in params: @@ -20363,8 +24659,8 @@ def put_poly_line_annotation_with_http_info(self, name, annotation_id, annotatio local_var_files = {} body_params = None - if 'annotation' in params: - body_params = params['annotation'] + if 'privileges' in params: + body_params = params['privileges'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -20376,14 +24672,14 @@ def put_poly_line_annotation_with_http_info(self, name, annotation_id, annotatio # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/polyline/{annotationId}', 'PUT', + return self.api_client.call_api('/pdf/{name}/privileges', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PolyLineAnnotationResponse', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -20391,59 +24687,57 @@ def put_poly_line_annotation_with_http_info(self, name, annotation_id, annotatio _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_polygon_annotation(self, name, annotation_id, annotation, **kwargs): + def put_ps_in_storage_to_pdf(self, name, src_path, **kwargs): """ - Replace document polygon annotation + Convert PS file (located on storage) to PDF format and upload resulting file to storage. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_polygon_annotation(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.put_ps_in_storage_to_pdf(name, src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param PolygonAnnotation annotation: Annotation. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.ps) (required) + :param str dst_folder: The destination document folder. :param str storage: The document storage. - :param str folder: The document folder. - :return: PolygonAnnotationResponse + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_polygon_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.put_ps_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) else: - (data) = self.put_polygon_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.put_ps_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) return data - def put_polygon_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def put_ps_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): """ - Replace document polygon annotation + Convert PS file (located on storage) to PDF format and upload resulting file to storage. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_polygon_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.put_ps_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param PolygonAnnotation annotation: Annotation. (required) + :param str src_path: Full source filename (ex. /folder1/folder2/template.ps) (required) + :param str dst_folder: The destination document folder. :param str storage: The document storage. - :param str folder: The document folder. - :return: PolygonAnnotationResponse + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] + all_params = ['name', 'src_path', 'dst_folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -20454,19 +24748,16 @@ def put_polygon_annotation_with_http_info(self, name, annotation_id, annotation, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_polygon_annotation" % key + " to method put_ps_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_polygon_annotation`") - # verify the required parameter 'annotation_id' is set - if ('annotation_id' not in params) or (params['annotation_id'] is None): - raise ValueError("Missing the required parameter `annotation_id` when calling `put_polygon_annotation`") - # verify the required parameter 'annotation' is set - if ('annotation' not in params) or (params['annotation'] is None): - raise ValueError("Missing the required parameter `annotation` when calling `put_polygon_annotation`") + raise ValueError("Missing the required parameter `name` when calling `put_ps_in_storage_to_pdf`") + # verify the required parameter 'src_path' is set + if ('src_path' not in params) or (params['src_path'] is None): + raise ValueError("Missing the required parameter `src_path` when calling `put_ps_in_storage_to_pdf`") collection_formats = {} @@ -20474,14 +24765,14 @@ def put_polygon_annotation_with_http_info(self, name, annotation_id, annotation, path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'annotation_id' in params: - path_params['annotationId'] = params['annotation_id'] query_params = [] + if 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) + if 'dst_folder' in params: + query_params.append(('dstFolder', params['dst_folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) header_params = {} @@ -20489,8 +24780,6 @@ def put_polygon_annotation_with_http_info(self, name, annotation_id, annotation, local_var_files = {} body_params = None - if 'annotation' in params: - body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -20502,14 +24791,14 @@ def put_polygon_annotation_with_http_info(self, name, annotation_id, annotation, # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/polygon/{annotationId}', 'PUT', + return self.api_client.call_api('/pdf/{name}/create/ps', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PolygonAnnotationResponse', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -20517,57 +24806,61 @@ def put_polygon_annotation_with_http_info(self, name, annotation_id, annotation, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_privileges(self, name, **kwargs): + def put_replace_image(self, name, image_id, **kwargs): """ - Update privilege document. + Replace document image. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_privileges(name, callback=callback_function) + >>> thread = api.put_replace_image(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param DocumentPrivilege privileges: Document privileges. + :param str image_id: The image ID. (required) + :param str image_file_path: Path to image file if specified. Request content is used otherwise. :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :param file image: Image file. + :return: ImageResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_privileges_with_http_info(name, **kwargs) + return self.put_replace_image_with_http_info(name, image_id, **kwargs) else: - (data) = self.put_privileges_with_http_info(name, **kwargs) + (data) = self.put_replace_image_with_http_info(name, image_id, **kwargs) return data - def put_privileges_with_http_info(self, name, **kwargs): + def put_replace_image_with_http_info(self, name, image_id, **kwargs): """ - Update privilege document. + Replace document image. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_privileges_with_http_info(name, callback=callback_function) + >>> thread = api.put_replace_image_with_http_info(name, image_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param DocumentPrivilege privileges: Document privileges. + :param str image_id: The image ID. (required) + :param str image_file_path: Path to image file if specified. Request content is used otherwise. :param str storage: The document storage. :param str folder: The document folder. - :return: AsposeResponse + :param file image: Image file. + :return: ImageResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'privileges', 'storage', 'folder'] + all_params = ['name', 'image_id', 'image_file_path', 'storage', 'folder', 'image'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -20578,13 +24871,16 @@ def put_privileges_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_privileges" % key + " to method put_replace_image" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_privileges`") + raise ValueError("Missing the required parameter `name` when calling `put_replace_image`") + # verify the required parameter 'image_id' is set + if ('image_id' not in params) or (params['image_id'] is None): + raise ValueError("Missing the required parameter `image_id` when calling `put_replace_image`") collection_formats = {} @@ -20592,8 +24888,12 @@ def put_privileges_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'image_id' in params: + path_params['imageId'] = params['image_id'] query_params = [] + if 'image_file_path' in params: + query_params.append(('imageFilePath', params['image_file_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -20603,29 +24903,29 @@ def put_privileges_with_http_info(self, name, **kwargs): form_params = [] local_var_files = {} + if 'image' in params: + local_var_files['image'] = params['image'] body_params = None - if 'privileges' in params: - body_params = params['privileges'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) + select_header_content_type(['multipart/form-data']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/privileges', 'PUT', + return self.api_client.call_api('/pdf/{name}/images/{imageId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='ImageResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -20633,57 +24933,57 @@ def put_privileges_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_ps_in_storage_to_pdf(self, name, src_path, **kwargs): + def put_searchable_document(self, name, **kwargs): """ - Convert PS file (located on storage) to PDF format and upload resulting file to storage. + Create searchable PDF document. Generate OCR layer for images in input PDF document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_ps_in_storage_to_pdf(name, src_path, callback=callback_function) + >>> thread = api.put_searchable_document(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str src_path: Full source filename (ex. /folder1/folder2/template.ps) (required) - :param str dst_folder: The destination document folder. :param str storage: The document storage. + :param str folder: The document folder. + :param str lang: language for OCR engine. 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 :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_ps_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + return self.put_searchable_document_with_http_info(name, **kwargs) else: - (data) = self.put_ps_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + (data) = self.put_searchable_document_with_http_info(name, **kwargs) return data - def put_ps_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): + def put_searchable_document_with_http_info(self, name, **kwargs): """ - Convert PS file (located on storage) to PDF format and upload resulting file to storage. + Create searchable PDF document. Generate OCR layer for images in input PDF document. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_ps_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) + >>> thread = api.put_searchable_document_with_http_info(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) - :param str src_path: Full source filename (ex. /folder1/folder2/template.ps) (required) - :param str dst_folder: The destination document folder. :param str storage: The document storage. + :param str folder: The document folder. + :param str lang: language for OCR engine. 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 :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'src_path', 'dst_folder', 'storage'] + all_params = ['name', 'storage', 'folder', 'lang'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -20694,16 +24994,13 @@ def put_ps_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_ps_in_storage_to_pdf" % key + " to method put_searchable_document" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_ps_in_storage_to_pdf`") - # verify the required parameter 'src_path' is set - if ('src_path' not in params) or (params['src_path'] is None): - raise ValueError("Missing the required parameter `src_path` when calling `put_ps_in_storage_to_pdf`") + raise ValueError("Missing the required parameter `name` when calling `put_searchable_document`") collection_formats = {} @@ -20713,12 +25010,12 @@ def put_ps_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): path_params['name'] = params['name'] query_params = [] - if 'src_path' in params: - query_params.append(('srcPath', params['src_path'])) - if 'dst_folder' in params: - query_params.append(('dstFolder', params['dst_folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + if 'lang' in params: + query_params.append(('lang', params['lang'])) header_params = {} @@ -20737,7 +25034,7 @@ def put_ps_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/create/ps', 'PUT', + return self.api_client.call_api('/pdf/{name}/ocr', 'PUT', path_params, query_params, header_params, @@ -20752,61 +25049,59 @@ def put_ps_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_replace_image(self, name, image_id, **kwargs): + def put_set_property(self, name, property_name, value, **kwargs): """ - Replace document image. + Add/update document property. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_replace_image(name, image_id, callback=callback_function) + >>> thread = api.put_set_property(name, property_name, value, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param str image_id: The image ID. (required) - :param str image_file_path: Path to image file if specified. Request content is used otherwise. - :param str storage: The document storage. - :param str folder: The document folder. - :param file image: Image file. - :return: ImageResponse + :param str name: (required) + :param str property_name: (required) + :param str value: (required) + :param str storage: + :param str folder: + :return: DocumentPropertyResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_replace_image_with_http_info(name, image_id, **kwargs) + return self.put_set_property_with_http_info(name, property_name, value, **kwargs) else: - (data) = self.put_replace_image_with_http_info(name, image_id, **kwargs) + (data) = self.put_set_property_with_http_info(name, property_name, value, **kwargs) return data - def put_replace_image_with_http_info(self, name, image_id, **kwargs): + def put_set_property_with_http_info(self, name, property_name, value, **kwargs): """ - Replace document image. + Add/update document property. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_replace_image_with_http_info(name, image_id, callback=callback_function) + >>> thread = api.put_set_property_with_http_info(name, property_name, value, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: The document name. (required) - :param str image_id: The image ID. (required) - :param str image_file_path: Path to image file if specified. Request content is used otherwise. - :param str storage: The document storage. - :param str folder: The document folder. - :param file image: Image file. - :return: ImageResponse + :param str name: (required) + :param str property_name: (required) + :param str value: (required) + :param str storage: + :param str folder: + :return: DocumentPropertyResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_id', 'image_file_path', 'storage', 'folder', 'image'] + all_params = ['name', 'property_name', 'value', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -20817,16 +25112,19 @@ def put_replace_image_with_http_info(self, name, image_id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_replace_image" % key + " to method put_set_property" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_replace_image`") - # verify the required parameter 'image_id' is set - if ('image_id' not in params) or (params['image_id'] is None): - raise ValueError("Missing the required parameter `image_id` when calling `put_replace_image`") + raise ValueError("Missing the required parameter `name` when calling `put_set_property`") + # verify the required parameter 'property_name' is set + if ('property_name' not in params) or (params['property_name'] is None): + raise ValueError("Missing the required parameter `property_name` when calling `put_set_property`") + # verify the required parameter 'value' is set + if ('value' not in params) or (params['value'] is None): + raise ValueError("Missing the required parameter `value` when calling `put_set_property`") collection_formats = {} @@ -20834,12 +25132,12 @@ def put_replace_image_with_http_info(self, name, image_id, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'image_id' in params: - path_params['imageId'] = params['image_id'] + if 'property_name' in params: + path_params['propertyName'] = params['property_name'] query_params = [] - if 'image_file_path' in params: - query_params.append(('imageFilePath', params['image_file_path'])) + if 'value' in params: + query_params.append(('value', params['value'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -20849,8 +25147,6 @@ def put_replace_image_with_http_info(self, name, image_id, **kwargs): form_params = [] local_var_files = {} - if 'image' in params: - local_var_files['image'] = params['image'] body_params = None # HTTP header `Accept` @@ -20859,19 +25155,19 @@ def put_replace_image_with_http_info(self, name, image_id, **kwargs): # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['multipart/form-data']) + select_header_content_type(['application/json']) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/images/{imageId}', 'PUT', + return self.api_client.call_api('/pdf/{name}/documentproperties/{propertyName}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ImageResponse', + response_type='DocumentPropertyResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -20879,57 +25175,59 @@ def put_replace_image_with_http_info(self, name, image_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_searchable_document(self, name, **kwargs): + def put_square_annotation(self, name, annotation_id, annotation, **kwargs): """ - Create searchable PDF document. Generate OCR layer for images in input PDF document. + Replace document square annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_searchable_document(name, callback=callback_function) + >>> thread = api.put_square_annotation(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param SquareAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str lang: language for OCR engine. 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 - :return: AsposeResponse + :return: SquareAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_searchable_document_with_http_info(name, **kwargs) + return self.put_square_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_searchable_document_with_http_info(name, **kwargs) + (data) = self.put_square_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_searchable_document_with_http_info(self, name, **kwargs): + def put_square_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Create searchable PDF document. Generate OCR layer for images in input PDF document. + Replace document square annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_searchable_document_with_http_info(name, callback=callback_function) + >>> thread = api.put_square_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param SquareAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str lang: language for OCR engine. 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 - :return: AsposeResponse + :return: SquareAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'storage', 'folder', 'lang'] + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -20940,13 +25238,19 @@ def put_searchable_document_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_searchable_document" % key + " to method put_square_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_searchable_document`") + raise ValueError("Missing the required parameter `name` when calling `put_square_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `put_square_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `put_square_annotation`") collection_formats = {} @@ -20954,14 +25258,14 @@ def put_searchable_document_with_http_info(self, name, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: query_params.append(('folder', params['folder'])) - if 'lang' in params: - query_params.append(('lang', params['lang'])) header_params = {} @@ -20969,6 +25273,8 @@ def put_searchable_document_with_http_info(self, name, **kwargs): local_var_files = {} body_params = None + if 'annotation' in params: + body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -20980,14 +25286,14 @@ def put_searchable_document_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/ocr', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/square/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='SquareAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -20995,59 +25301,59 @@ def put_searchable_document_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_set_property(self, name, property_name, value, **kwargs): + def put_squiggly_annotation(self, name, annotation_id, annotation, **kwargs): """ - Add/update document property. + Replace document squiggly annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_set_property(name, property_name, value, callback=callback_function) + >>> thread = api.put_squiggly_annotation(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: (required) - :param str property_name: (required) - :param str value: (required) - :param str storage: - :param str folder: - :return: DocumentPropertyResponse + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param SquigglyAnnotation annotation: Annotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: SquigglyAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_set_property_with_http_info(name, property_name, value, **kwargs) + return self.put_squiggly_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_set_property_with_http_info(name, property_name, value, **kwargs) + (data) = self.put_squiggly_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_set_property_with_http_info(self, name, property_name, value, **kwargs): + def put_squiggly_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Add/update document property. + Replace document squiggly annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_set_property_with_http_info(name, property_name, value, callback=callback_function) + >>> thread = api.put_squiggly_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str name: (required) - :param str property_name: (required) - :param str value: (required) - :param str storage: - :param str folder: - :return: DocumentPropertyResponse + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param SquigglyAnnotation annotation: Annotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: SquigglyAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'property_name', 'value', 'storage', 'folder'] + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -21058,19 +25364,19 @@ def put_set_property_with_http_info(self, name, property_name, value, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_set_property" % key + " to method put_squiggly_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_set_property`") - # verify the required parameter 'property_name' is set - if ('property_name' not in params) or (params['property_name'] is None): - raise ValueError("Missing the required parameter `property_name` when calling `put_set_property`") - # verify the required parameter 'value' is set - if ('value' not in params) or (params['value'] is None): - raise ValueError("Missing the required parameter `value` when calling `put_set_property`") + raise ValueError("Missing the required parameter `name` when calling `put_squiggly_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `put_squiggly_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `put_squiggly_annotation`") collection_formats = {} @@ -21078,12 +25384,10 @@ def put_set_property_with_http_info(self, name, property_name, value, **kwargs): path_params = {} if 'name' in params: path_params['name'] = params['name'] - if 'property_name' in params: - path_params['propertyName'] = params['property_name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] query_params = [] - if 'value' in params: - query_params.append(('value', params['value'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -21095,6 +25399,8 @@ def put_set_property_with_http_info(self, name, property_name, value, **kwargs): local_var_files = {} body_params = None + if 'annotation' in params: + body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -21106,14 +25412,14 @@ def put_set_property_with_http_info(self, name, property_name, value, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/documentproperties/{propertyName}', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/squiggly/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentPropertyResponse', + response_type='SquigglyAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -21121,54 +25427,54 @@ def put_set_property_with_http_info(self, name, property_name, value, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_square_annotation(self, name, annotation_id, annotation, **kwargs): + def put_strike_out_annotation(self, name, annotation_id, annotation, **kwargs): """ - Replace document square annotation + Replace document StrikeOut annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_square_annotation(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.put_strike_out_annotation(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str annotation_id: The annotation ID. (required) - :param SquareAnnotation annotation: Annotation. (required) + :param StrikeOutAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SquareAnnotationResponse + :return: StrikeOutAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_square_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.put_strike_out_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_square_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.put_strike_out_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_square_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def put_strike_out_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Replace document square annotation + Replace document StrikeOut annotation This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.put_square_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.put_strike_out_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str name: The document name. (required) :param str annotation_id: The annotation ID. (required) - :param SquareAnnotation annotation: Annotation. (required) + :param StrikeOutAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SquareAnnotationResponse + :return: StrikeOutAnnotationResponse If the method is called asynchronously, returns the request thread. """ @@ -21184,19 +25490,19 @@ def put_square_annotation_with_http_info(self, name, annotation_id, annotation, if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_square_annotation" % key + " to method put_strike_out_annotation" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'name' is set if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `put_square_annotation`") + raise ValueError("Missing the required parameter `name` when calling `put_strike_out_annotation`") # verify the required parameter 'annotation_id' is set if ('annotation_id' not in params) or (params['annotation_id'] is None): - raise ValueError("Missing the required parameter `annotation_id` when calling `put_square_annotation`") + raise ValueError("Missing the required parameter `annotation_id` when calling `put_strike_out_annotation`") # verify the required parameter 'annotation' is set if ('annotation' not in params) or (params['annotation'] is None): - raise ValueError("Missing the required parameter `annotation` when calling `put_square_annotation`") + raise ValueError("Missing the required parameter `annotation` when calling `put_strike_out_annotation`") collection_formats = {} @@ -21232,14 +25538,14 @@ def put_square_annotation_with_http_info(self, name, annotation_id, annotation, # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/square/{annotationId}', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/strikeout/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SquareAnnotationResponse', + response_type='StrikeOutAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -21524,6 +25830,132 @@ def put_text_annotation_with_http_info(self, name, annotation_id, annotation, ** _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def put_underline_annotation(self, name, annotation_id, annotation, **kwargs): + """ + Replace document underline annotation + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_underline_annotation(name, annotation_id, annotation, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param UnderlineAnnotation annotation: Annotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: UnderlineAnnotationResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_underline_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + else: + (data) = self.put_underline_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return data + + def put_underline_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + """ + Replace document underline annotation + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.put_underline_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str name: The document name. (required) + :param str annotation_id: The annotation ID. (required) + :param UnderlineAnnotation annotation: Annotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: UnderlineAnnotationResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method put_underline_annotation" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `put_underline_annotation`") + # verify the required parameter 'annotation_id' is set + if ('annotation_id' not in params) or (params['annotation_id'] is None): + raise ValueError("Missing the required parameter `annotation_id` when calling `put_underline_annotation`") + # verify the required parameter 'annotation' is set + if ('annotation' not in params) or (params['annotation'] is None): + raise ValueError("Missing the required parameter `annotation` when calling `put_underline_annotation`") + + + collection_formats = {} + + path_params = {} + if 'name' in params: + path_params['name'] = params['name'] + if 'annotation_id' in params: + path_params['annotationId'] = params['annotation_id'] + + query_params = [] + if 'storage' in params: + query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'annotation' in params: + body_params = params['annotation'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/annotations/underline/{annotationId}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='UnderlineAnnotationResponse', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def put_update_field(self, name, field_name, **kwargs): """ Update field. diff --git a/asposepdfcloud/configuration.py b/asposepdfcloud/configuration.py index d3d25e9..d57ac5a 100644 --- a/asposepdfcloud/configuration.py +++ b/asposepdfcloud/configuration.py @@ -202,5 +202,5 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: 2.0\n"\ - "SDK Package Version: 18.10.0".\ + "SDK Package Version: 18.11.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/asposepdfcloud/models/__init__.py b/asposepdfcloud/models/__init__.py index cff4ae2..ca0f39b 100644 --- a/asposepdfcloud/models/__init__.py +++ b/asposepdfcloud/models/__init__.py @@ -37,7 +37,9 @@ from .antialiasing_processing_type import AntialiasingProcessingType from .append_document import AppendDocument from .aspose_response import AsposeResponse +from .cap_style import CapStyle from .caption_position import CaptionPosition +from .caret_symbol import CaretSymbol from .color import Color from .color_depth import ColorDepth from .compression_type import CompressionType @@ -46,6 +48,7 @@ from .document_privilege import DocumentPrivilege from .epub_recognition_mode import EpubRecognitionMode from .field_type import FieldType +from .file import File from .font_encoding_rules import FontEncodingRules from .font_saving_modes import FontSavingModes from .font_styles import FontStyles @@ -103,6 +106,9 @@ from .attachment_response import AttachmentResponse from .attachments import Attachments from .attachments_response import AttachmentsResponse +from .caret_annotation_response import CaretAnnotationResponse +from .caret_annotations import CaretAnnotations +from .caret_annotations_response import CaretAnnotationsResponse from .circle_annotation_response import CircleAnnotationResponse from .circle_annotations import CircleAnnotations from .circle_annotations_response import CircleAnnotationsResponse @@ -118,13 +124,20 @@ from .field_response import FieldResponse from .fields import Fields from .fields_response import FieldsResponse +from .files_response import FilesResponse from .free_text_annotation_response import FreeTextAnnotationResponse from .free_text_annotations import FreeTextAnnotations from .free_text_annotations_response import FreeTextAnnotationsResponse +from .highlight_annotation_response import HighlightAnnotationResponse +from .highlight_annotations import HighlightAnnotations +from .highlight_annotations_response import HighlightAnnotationsResponse from .image import Image from .image_response import ImageResponse from .images import Images from .images_response import ImagesResponse +from .ink_annotation_response import InkAnnotationResponse +from .ink_annotations import InkAnnotations +from .ink_annotations_response import InkAnnotationsResponse from .line_annotation_response import LineAnnotationResponse from .line_annotations import LineAnnotations from .line_annotations_response import LineAnnotationsResponse @@ -140,25 +153,45 @@ from .polygon_annotation_response import PolygonAnnotationResponse from .polygon_annotations import PolygonAnnotations from .polygon_annotations_response import PolygonAnnotationsResponse +from .popup_annotation_response import PopupAnnotationResponse +from .popup_annotations import PopupAnnotations +from .popup_annotations_response import PopupAnnotationsResponse from .signature_verify_response import SignatureVerifyResponse from .split_result_document import SplitResultDocument from .split_result_response import SplitResultResponse from .square_annotation_response import SquareAnnotationResponse from .square_annotations import SquareAnnotations from .square_annotations_response import SquareAnnotationsResponse +from .squiggly_annotation_response import SquigglyAnnotationResponse +from .squiggly_annotations import SquigglyAnnotations +from .squiggly_annotations_response import SquigglyAnnotationsResponse +from .strike_out_annotation_response import StrikeOutAnnotationResponse +from .strike_out_annotations import StrikeOutAnnotations +from .strike_out_annotations_response import StrikeOutAnnotationsResponse from .text_annotation_response import TextAnnotationResponse from .text_annotations import TextAnnotations from .text_annotations_response import TextAnnotationsResponse from .text_rects_response import TextRectsResponse from .text_replace_response import TextReplaceResponse +from .underline_annotation_response import UnderlineAnnotationResponse +from .underline_annotations import UnderlineAnnotations +from .underline_annotations_response import UnderlineAnnotationsResponse from .word_count_response import WordCountResponse from .annotation_info import AnnotationInfo from .markup_annotation import MarkupAnnotation +from .popup_annotation import PopupAnnotation +from .caret_annotation import CaretAnnotation from .common_figure_annotation import CommonFigureAnnotation from .free_text_annotation import FreeTextAnnotation +from .highlight_annotation import HighlightAnnotation +from .ink_annotation import InkAnnotation from .line_annotation import LineAnnotation from .poly_annotation import PolyAnnotation +from .popup_annotation_with_parent import PopupAnnotationWithParent +from .squiggly_annotation import SquigglyAnnotation +from .strike_out_annotation import StrikeOutAnnotation from .text_annotation import TextAnnotation +from .underline_annotation import UnderlineAnnotation from .circle_annotation import CircleAnnotation from .poly_line_annotation import PolyLineAnnotation from .polygon_annotation import PolygonAnnotation diff --git a/asposepdfcloud/models/annotation.py b/asposepdfcloud/models/annotation.py index 9ce435b..c3e5f39 100644 --- a/asposepdfcloud/models/annotation.py +++ b/asposepdfcloud/models/annotation.py @@ -50,9 +50,6 @@ class Annotation(object): swagger_types = { 'links': 'list[Link]', 'contents': 'str', - 'creation_date': 'str', - 'subject': 'str', - 'title': 'str', 'modified': 'str', 'id': 'str', 'flags': 'list[AnnotationFlags]', @@ -67,9 +64,6 @@ class Annotation(object): attribute_map = { 'links': 'Links', 'contents': 'Contents', - 'creation_date': 'CreationDate', - 'subject': 'Subject', - 'title': 'Title', 'modified': 'Modified', 'id': 'Id', 'flags': 'Flags', @@ -81,16 +75,13 @@ class Annotation(object): 'vertical_alignment': 'VerticalAlignment' } - def __init__(self, links=None, contents=None, creation_date=None, subject=None, title=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None): + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None): """ Annotation - a model defined in Swagger """ self._links = None self._contents = None - self._creation_date = None - self._subject = None - self._title = None self._modified = None self._id = None self._flags = None @@ -105,12 +96,6 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.links = links if contents is not None: self.contents = contents - if creation_date is not None: - self.creation_date = creation_date - if subject is not None: - self.subject = subject - if title is not None: - self.title = title if modified is not None: self.modified = modified if id is not None: @@ -176,75 +161,6 @@ def contents(self, contents): self._contents = contents - @property - def creation_date(self): - """ - Gets the creation_date of this Annotation. - The date and time when the annotation was created. - - :return: The creation_date of this Annotation. - :rtype: str - """ - return self._creation_date - - @creation_date.setter - def creation_date(self, creation_date): - """ - Sets the creation_date of this Annotation. - The date and time when the annotation was created. - - :param creation_date: The creation_date of this Annotation. - :type: str - """ - - self._creation_date = creation_date - - @property - def subject(self): - """ - Gets the subject of this Annotation. - Get the annotation subject. - - :return: The subject of this Annotation. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this Annotation. - Get the annotation subject. - - :param subject: The subject of this Annotation. - :type: str - """ - - self._subject = subject - - @property - def title(self): - """ - Gets the title of this Annotation. - Get the annotation title. - - :return: The title of this Annotation. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this Annotation. - Get the annotation title. - - :param title: The title of this Annotation. - :type: str - """ - - self._title = title - @property def modified(self): """ diff --git a/asposepdfcloud/models/annotation_info.py b/asposepdfcloud/models/annotation_info.py index 33c1b1c..2540314 100644 --- a/asposepdfcloud/models/annotation_info.py +++ b/asposepdfcloud/models/annotation_info.py @@ -50,9 +50,6 @@ class AnnotationInfo(object): swagger_types = { 'links': 'list[Link]', 'contents': 'str', - 'creation_date': 'str', - 'subject': 'str', - 'title': 'str', 'modified': 'str', 'id': 'str', 'flags': 'list[AnnotationFlags]', @@ -68,9 +65,6 @@ class AnnotationInfo(object): attribute_map = { 'links': 'Links', 'contents': 'Contents', - 'creation_date': 'CreationDate', - 'subject': 'Subject', - 'title': 'Title', 'modified': 'Modified', 'id': 'Id', 'flags': 'Flags', @@ -83,16 +77,13 @@ class AnnotationInfo(object): 'annotation_type': 'AnnotationType' } - def __init__(self, links=None, contents=None, creation_date=None, subject=None, title=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, annotation_type=None): + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, annotation_type=None): """ AnnotationInfo - a model defined in Swagger """ self._links = None self._contents = None - self._creation_date = None - self._subject = None - self._title = None self._modified = None self._id = None self._flags = None @@ -108,12 +99,6 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.links = links if contents is not None: self.contents = contents - if creation_date is not None: - self.creation_date = creation_date - if subject is not None: - self.subject = subject - if title is not None: - self.title = title if modified is not None: self.modified = modified if id is not None: @@ -181,75 +166,6 @@ def contents(self, contents): self._contents = contents - @property - def creation_date(self): - """ - Gets the creation_date of this AnnotationInfo. - The date and time when the annotation was created. - - :return: The creation_date of this AnnotationInfo. - :rtype: str - """ - return self._creation_date - - @creation_date.setter - def creation_date(self, creation_date): - """ - Sets the creation_date of this AnnotationInfo. - The date and time when the annotation was created. - - :param creation_date: The creation_date of this AnnotationInfo. - :type: str - """ - - self._creation_date = creation_date - - @property - def subject(self): - """ - Gets the subject of this AnnotationInfo. - Get the annotation subject. - - :return: The subject of this AnnotationInfo. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this AnnotationInfo. - Get the annotation subject. - - :param subject: The subject of this AnnotationInfo. - :type: str - """ - - self._subject = subject - - @property - def title(self): - """ - Gets the title of this AnnotationInfo. - Get the annotation title. - - :return: The title of this AnnotationInfo. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this AnnotationInfo. - Get the annotation title. - - :param title: The title of this AnnotationInfo. - :type: str - """ - - self._title = title - @property def modified(self): """ diff --git a/asposepdfcloud/models/cap_style.py b/asposepdfcloud/models/cap_style.py new file mode 100644 index 0000000..d7861c1 --- /dev/null +++ b/asposepdfcloud/models/cap_style.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class CapStyle(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + """ + allowed enum values + """ + RECTANGULAR = "Rectangular" + ROUNDED = "Rounded" + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + + } + + attribute_map = { + + } + + def __init__(self): + """ + CapStyle - a model defined in Swagger + """ + + + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, CapStyle): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/caret_annotation.py b/asposepdfcloud/models/caret_annotation.py new file mode 100644 index 0000000..d6b7e6f --- /dev/null +++ b/asposepdfcloud/models/caret_annotation.py @@ -0,0 +1,618 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class CaretAnnotation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'contents': 'str', + 'modified': 'str', + 'id': 'str', + 'flags': 'list[AnnotationFlags]', + 'name': 'str', + 'rect': 'RectanglePdf', + 'page_index': 'int', + 'z_index': 'int', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', + 'rich_text': 'str', + 'color': 'Color', + 'frame': 'RectanglePdf', + 'symbol': 'CaretSymbol' + } + + attribute_map = { + 'links': 'Links', + 'contents': 'Contents', + 'modified': 'Modified', + 'id': 'Id', + 'flags': 'Flags', + 'name': 'Name', + 'rect': 'Rect', + 'page_index': 'PageIndex', + 'z_index': 'ZIndex', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', + 'rich_text': 'RichText', + 'color': 'Color', + 'frame': 'Frame', + 'symbol': 'Symbol' + } + + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, color=None, frame=None, symbol=None): + """ + CaretAnnotation - a model defined in Swagger + """ + + self._links = None + self._contents = None + self._modified = None + self._id = None + self._flags = None + self._name = None + self._rect = None + self._page_index = None + self._z_index = None + self._horizontal_alignment = None + self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None + self._rich_text = None + self._color = None + self._frame = None + self._symbol = None + + if links is not None: + self.links = links + if contents is not None: + self.contents = contents + if modified is not None: + self.modified = modified + if id is not None: + self.id = id + if flags is not None: + self.flags = flags + if name is not None: + self.name = name + if rect is not None: + self.rect = rect + if page_index is not None: + self.page_index = page_index + if z_index is not None: + self.z_index = z_index + if horizontal_alignment is not None: + self.horizontal_alignment = horizontal_alignment + if vertical_alignment is not None: + self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title + if rich_text is not None: + self.rich_text = rich_text + if color is not None: + self.color = color + if frame is not None: + self.frame = frame + if symbol is not None: + self.symbol = symbol + + @property + def links(self): + """ + Gets the links of this CaretAnnotation. + Link to the document. + + :return: The links of this CaretAnnotation. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this CaretAnnotation. + Link to the document. + + :param links: The links of this CaretAnnotation. + :type: list[Link] + """ + + self._links = links + + @property + def contents(self): + """ + Gets the contents of this CaretAnnotation. + Get the annotation content. + + :return: The contents of this CaretAnnotation. + :rtype: str + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this CaretAnnotation. + Get the annotation content. + + :param contents: The contents of this CaretAnnotation. + :type: str + """ + + self._contents = contents + + @property + def modified(self): + """ + Gets the modified of this CaretAnnotation. + The date and time when the annotation was last modified. + + :return: The modified of this CaretAnnotation. + :rtype: str + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this CaretAnnotation. + The date and time when the annotation was last modified. + + :param modified: The modified of this CaretAnnotation. + :type: str + """ + + self._modified = modified + + @property + def id(self): + """ + Gets the id of this CaretAnnotation. + Gets ID of the annotation. + + :return: The id of this CaretAnnotation. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this CaretAnnotation. + Gets ID of the annotation. + + :param id: The id of this CaretAnnotation. + :type: str + """ + + self._id = id + + @property + def flags(self): + """ + Gets the flags of this CaretAnnotation. + Gets Flags of the annotation. + + :return: The flags of this CaretAnnotation. + :rtype: list[AnnotationFlags] + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this CaretAnnotation. + Gets Flags of the annotation. + + :param flags: The flags of this CaretAnnotation. + :type: list[AnnotationFlags] + """ + + self._flags = flags + + @property + def name(self): + """ + Gets the name of this CaretAnnotation. + Gets Name of the annotation. + + :return: The name of this CaretAnnotation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this CaretAnnotation. + Gets Name of the annotation. + + :param name: The name of this CaretAnnotation. + :type: str + """ + + self._name = name + + @property + def rect(self): + """ + Gets the rect of this CaretAnnotation. + Gets Rect of the annotation. + + :return: The rect of this CaretAnnotation. + :rtype: RectanglePdf + """ + return self._rect + + @rect.setter + def rect(self, rect): + """ + Sets the rect of this CaretAnnotation. + Gets Rect of the annotation. + + :param rect: The rect of this CaretAnnotation. + :type: RectanglePdf + """ + + self._rect = rect + + @property + def page_index(self): + """ + Gets the page_index of this CaretAnnotation. + Gets PageIndex of the annotation. + + :return: The page_index of this CaretAnnotation. + :rtype: int + """ + return self._page_index + + @page_index.setter + def page_index(self, page_index): + """ + Sets the page_index of this CaretAnnotation. + Gets PageIndex of the annotation. + + :param page_index: The page_index of this CaretAnnotation. + :type: int + """ + + self._page_index = page_index + + @property + def z_index(self): + """ + Gets the z_index of this CaretAnnotation. + Gets ZIndex of the annotation. + + :return: The z_index of this CaretAnnotation. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this CaretAnnotation. + Gets ZIndex of the annotation. + + :param z_index: The z_index of this CaretAnnotation. + :type: int + """ + + self._z_index = z_index + + @property + def horizontal_alignment(self): + """ + Gets the horizontal_alignment of this CaretAnnotation. + Gets HorizontalAlignment of the annotation. + + :return: The horizontal_alignment of this CaretAnnotation. + :rtype: HorizontalAlignment + """ + return self._horizontal_alignment + + @horizontal_alignment.setter + def horizontal_alignment(self, horizontal_alignment): + """ + Sets the horizontal_alignment of this CaretAnnotation. + Gets HorizontalAlignment of the annotation. + + :param horizontal_alignment: The horizontal_alignment of this CaretAnnotation. + :type: HorizontalAlignment + """ + + self._horizontal_alignment = horizontal_alignment + + @property + def vertical_alignment(self): + """ + Gets the vertical_alignment of this CaretAnnotation. + Gets VerticalAlignment of the annotation. + + :return: The vertical_alignment of this CaretAnnotation. + :rtype: VerticalAlignment + """ + return self._vertical_alignment + + @vertical_alignment.setter + def vertical_alignment(self, vertical_alignment): + """ + Sets the vertical_alignment of this CaretAnnotation. + Gets VerticalAlignment of the annotation. + + :param vertical_alignment: The vertical_alignment of this CaretAnnotation. + :type: VerticalAlignment + """ + + self._vertical_alignment = vertical_alignment + + @property + def creation_date(self): + """ + Gets the creation_date of this CaretAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this CaretAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this CaretAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this CaretAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this CaretAnnotation. + Get the annotation subject. + + :return: The subject of this CaretAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this CaretAnnotation. + Get the annotation subject. + + :param subject: The subject of this CaretAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this CaretAnnotation. + Get the annotation title. + + :return: The title of this CaretAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this CaretAnnotation. + Get the annotation title. + + :param title: The title of this CaretAnnotation. + :type: str + """ + + self._title = title + + @property + def rich_text(self): + """ + Gets the rich_text of this CaretAnnotation. + Get the annotation RichText. + + :return: The rich_text of this CaretAnnotation. + :rtype: str + """ + return self._rich_text + + @rich_text.setter + def rich_text(self, rich_text): + """ + Sets the rich_text of this CaretAnnotation. + Get the annotation RichText. + + :param rich_text: The rich_text of this CaretAnnotation. + :type: str + """ + + self._rich_text = rich_text + + @property + def color(self): + """ + Gets the color of this CaretAnnotation. + Color of the annotation. + + :return: The color of this CaretAnnotation. + :rtype: Color + """ + return self._color + + @color.setter + def color(self, color): + """ + Sets the color of this CaretAnnotation. + Color of the annotation. + + :param color: The color of this CaretAnnotation. + :type: Color + """ + + self._color = color + + @property + def frame(self): + """ + Gets the frame of this CaretAnnotation. + Gets or sets caret rectangle. + + :return: The frame of this CaretAnnotation. + :rtype: RectanglePdf + """ + return self._frame + + @frame.setter + def frame(self, frame): + """ + Sets the frame of this CaretAnnotation. + Gets or sets caret rectangle. + + :param frame: The frame of this CaretAnnotation. + :type: RectanglePdf + """ + + self._frame = frame + + @property + def symbol(self): + """ + Gets the symbol of this CaretAnnotation. + Gets or sets symbol associated with caret. + + :return: The symbol of this CaretAnnotation. + :rtype: CaretSymbol + """ + return self._symbol + + @symbol.setter + def symbol(self, symbol): + """ + Sets the symbol of this CaretAnnotation. + Gets or sets symbol associated with caret. + + :param symbol: The symbol of this CaretAnnotation. + :type: CaretSymbol + """ + + self._symbol = symbol + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, CaretAnnotation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/caret_annotation_response.py b/asposepdfcloud/models/caret_annotation_response.py new file mode 100644 index 0000000..01e8621 --- /dev/null +++ b/asposepdfcloud/models/caret_annotation_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class CaretAnnotationResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotation': 'CaretAnnotation' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotation': 'Annotation' + } + + def __init__(self, code=None, status=None, annotation=None): + """ + CaretAnnotationResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotation = None + + self.code = code + if status is not None: + self.status = status + if annotation is not None: + self.annotation = annotation + + @property + def code(self): + """ + Gets the code of this CaretAnnotationResponse. + Response status code. + + :return: The code of this CaretAnnotationResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this CaretAnnotationResponse. + Response status code. + + :param code: The code of this CaretAnnotationResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this CaretAnnotationResponse. + Response status. + + :return: The status of this CaretAnnotationResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this CaretAnnotationResponse. + Response status. + + :param status: The status of this CaretAnnotationResponse. + :type: str + """ + + self._status = status + + @property + def annotation(self): + """ + Gets the annotation of this CaretAnnotationResponse. + + :return: The annotation of this CaretAnnotationResponse. + :rtype: CaretAnnotation + """ + return self._annotation + + @annotation.setter + def annotation(self, annotation): + """ + Sets the annotation of this CaretAnnotationResponse. + + :param annotation: The annotation of this CaretAnnotationResponse. + :type: CaretAnnotation + """ + + self._annotation = annotation + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, CaretAnnotationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/caret_annotations.py b/asposepdfcloud/models/caret_annotations.py new file mode 100644 index 0000000..141068b --- /dev/null +++ b/asposepdfcloud/models/caret_annotations.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class CaretAnnotations(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'list': 'list[CaretAnnotation]' + } + + attribute_map = { + 'links': 'Links', + 'list': 'List' + } + + def __init__(self, links=None, list=None): + """ + CaretAnnotations - a model defined in Swagger + """ + + self._links = None + self._list = None + + if links is not None: + self.links = links + if list is not None: + self.list = list + + @property + def links(self): + """ + Gets the links of this CaretAnnotations. + Link to the document. + + :return: The links of this CaretAnnotations. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this CaretAnnotations. + Link to the document. + + :param links: The links of this CaretAnnotations. + :type: list[Link] + """ + + self._links = links + + @property + def list(self): + """ + Gets the list of this CaretAnnotations. + + :return: The list of this CaretAnnotations. + :rtype: list[CaretAnnotation] + """ + return self._list + + @list.setter + def list(self, list): + """ + Sets the list of this CaretAnnotations. + + :param list: The list of this CaretAnnotations. + :type: list[CaretAnnotation] + """ + + self._list = list + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, CaretAnnotations): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/caret_annotations_response.py b/asposepdfcloud/models/caret_annotations_response.py new file mode 100644 index 0000000..249256c --- /dev/null +++ b/asposepdfcloud/models/caret_annotations_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class CaretAnnotationsResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotations': 'CaretAnnotations' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotations': 'Annotations' + } + + def __init__(self, code=None, status=None, annotations=None): + """ + CaretAnnotationsResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotations = None + + self.code = code + if status is not None: + self.status = status + if annotations is not None: + self.annotations = annotations + + @property + def code(self): + """ + Gets the code of this CaretAnnotationsResponse. + Response status code. + + :return: The code of this CaretAnnotationsResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this CaretAnnotationsResponse. + Response status code. + + :param code: The code of this CaretAnnotationsResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this CaretAnnotationsResponse. + Response status. + + :return: The status of this CaretAnnotationsResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this CaretAnnotationsResponse. + Response status. + + :param status: The status of this CaretAnnotationsResponse. + :type: str + """ + + self._status = status + + @property + def annotations(self): + """ + Gets the annotations of this CaretAnnotationsResponse. + + :return: The annotations of this CaretAnnotationsResponse. + :rtype: CaretAnnotations + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this CaretAnnotationsResponse. + + :param annotations: The annotations of this CaretAnnotationsResponse. + :type: CaretAnnotations + """ + + self._annotations = annotations + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, CaretAnnotationsResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/caret_symbol.py b/asposepdfcloud/models/caret_symbol.py new file mode 100644 index 0000000..9123f10 --- /dev/null +++ b/asposepdfcloud/models/caret_symbol.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class CaretSymbol(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + """ + allowed enum values + """ + NONE = "None" + PARAGRAPH = "Paragraph" + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + + } + + attribute_map = { + + } + + def __init__(self): + """ + CaretSymbol - a model defined in Swagger + """ + + + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, CaretSymbol): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/circle_annotation.py b/asposepdfcloud/models/circle_annotation.py index 13036b7..8e9a2c7 100644 --- a/asposepdfcloud/models/circle_annotation.py +++ b/asposepdfcloud/models/circle_annotation.py @@ -50,9 +50,6 @@ class CircleAnnotation(object): swagger_types = { 'links': 'list[Link]', 'contents': 'str', - 'creation_date': 'str', - 'subject': 'str', - 'title': 'str', 'modified': 'str', 'id': 'str', 'flags': 'list[AnnotationFlags]', @@ -62,6 +59,9 @@ class CircleAnnotation(object): 'z_index': 'int', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', 'rich_text': 'str', 'interior_color': 'Color', 'frame': 'RectanglePdf', @@ -71,9 +71,6 @@ class CircleAnnotation(object): attribute_map = { 'links': 'Links', 'contents': 'Contents', - 'creation_date': 'CreationDate', - 'subject': 'Subject', - 'title': 'Title', 'modified': 'Modified', 'id': 'Id', 'flags': 'Flags', @@ -83,22 +80,22 @@ class CircleAnnotation(object): 'z_index': 'ZIndex', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', 'rich_text': 'RichText', 'interior_color': 'InteriorColor', 'frame': 'Frame', 'color': 'Color' } - def __init__(self, links=None, contents=None, creation_date=None, subject=None, title=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, rich_text=None, interior_color=None, frame=None, color=None): + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, interior_color=None, frame=None, color=None): """ CircleAnnotation - a model defined in Swagger """ self._links = None self._contents = None - self._creation_date = None - self._subject = None - self._title = None self._modified = None self._id = None self._flags = None @@ -108,6 +105,9 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self._z_index = None self._horizontal_alignment = None self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None self._rich_text = None self._interior_color = None self._frame = None @@ -117,12 +117,6 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.links = links if contents is not None: self.contents = contents - if creation_date is not None: - self.creation_date = creation_date - if subject is not None: - self.subject = subject - if title is not None: - self.title = title if modified is not None: self.modified = modified if id is not None: @@ -141,6 +135,12 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.horizontal_alignment = horizontal_alignment if vertical_alignment is not None: self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title if rich_text is not None: self.rich_text = rich_text if interior_color is not None: @@ -196,75 +196,6 @@ def contents(self, contents): self._contents = contents - @property - def creation_date(self): - """ - Gets the creation_date of this CircleAnnotation. - The date and time when the annotation was created. - - :return: The creation_date of this CircleAnnotation. - :rtype: str - """ - return self._creation_date - - @creation_date.setter - def creation_date(self, creation_date): - """ - Sets the creation_date of this CircleAnnotation. - The date and time when the annotation was created. - - :param creation_date: The creation_date of this CircleAnnotation. - :type: str - """ - - self._creation_date = creation_date - - @property - def subject(self): - """ - Gets the subject of this CircleAnnotation. - Get the annotation subject. - - :return: The subject of this CircleAnnotation. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this CircleAnnotation. - Get the annotation subject. - - :param subject: The subject of this CircleAnnotation. - :type: str - """ - - self._subject = subject - - @property - def title(self): - """ - Gets the title of this CircleAnnotation. - Get the annotation title. - - :return: The title of this CircleAnnotation. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this CircleAnnotation. - Get the annotation title. - - :param title: The title of this CircleAnnotation. - :type: str - """ - - self._title = title - @property def modified(self): """ @@ -472,6 +403,75 @@ def vertical_alignment(self, vertical_alignment): self._vertical_alignment = vertical_alignment + @property + def creation_date(self): + """ + Gets the creation_date of this CircleAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this CircleAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this CircleAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this CircleAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this CircleAnnotation. + Get the annotation subject. + + :return: The subject of this CircleAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this CircleAnnotation. + Get the annotation subject. + + :param subject: The subject of this CircleAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this CircleAnnotation. + Get the annotation title. + + :return: The title of this CircleAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this CircleAnnotation. + Get the annotation title. + + :param title: The title of this CircleAnnotation. + :type: str + """ + + self._title = title + @property def rich_text(self): """ diff --git a/asposepdfcloud/models/common_figure_annotation.py b/asposepdfcloud/models/common_figure_annotation.py index 5243e25..06fbd54 100644 --- a/asposepdfcloud/models/common_figure_annotation.py +++ b/asposepdfcloud/models/common_figure_annotation.py @@ -50,9 +50,6 @@ class CommonFigureAnnotation(object): swagger_types = { 'links': 'list[Link]', 'contents': 'str', - 'creation_date': 'str', - 'subject': 'str', - 'title': 'str', 'modified': 'str', 'id': 'str', 'flags': 'list[AnnotationFlags]', @@ -62,6 +59,9 @@ class CommonFigureAnnotation(object): 'z_index': 'int', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', 'rich_text': 'str', 'interior_color': 'Color', 'frame': 'RectanglePdf' @@ -70,9 +70,6 @@ class CommonFigureAnnotation(object): attribute_map = { 'links': 'Links', 'contents': 'Contents', - 'creation_date': 'CreationDate', - 'subject': 'Subject', - 'title': 'Title', 'modified': 'Modified', 'id': 'Id', 'flags': 'Flags', @@ -82,21 +79,21 @@ class CommonFigureAnnotation(object): 'z_index': 'ZIndex', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', 'rich_text': 'RichText', 'interior_color': 'InteriorColor', 'frame': 'Frame' } - def __init__(self, links=None, contents=None, creation_date=None, subject=None, title=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, rich_text=None, interior_color=None, frame=None): + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, interior_color=None, frame=None): """ CommonFigureAnnotation - a model defined in Swagger """ self._links = None self._contents = None - self._creation_date = None - self._subject = None - self._title = None self._modified = None self._id = None self._flags = None @@ -106,6 +103,9 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self._z_index = None self._horizontal_alignment = None self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None self._rich_text = None self._interior_color = None self._frame = None @@ -114,12 +114,6 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.links = links if contents is not None: self.contents = contents - if creation_date is not None: - self.creation_date = creation_date - if subject is not None: - self.subject = subject - if title is not None: - self.title = title if modified is not None: self.modified = modified if id is not None: @@ -138,6 +132,12 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.horizontal_alignment = horizontal_alignment if vertical_alignment is not None: self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title if rich_text is not None: self.rich_text = rich_text if interior_color is not None: @@ -191,75 +191,6 @@ def contents(self, contents): self._contents = contents - @property - def creation_date(self): - """ - Gets the creation_date of this CommonFigureAnnotation. - The date and time when the annotation was created. - - :return: The creation_date of this CommonFigureAnnotation. - :rtype: str - """ - return self._creation_date - - @creation_date.setter - def creation_date(self, creation_date): - """ - Sets the creation_date of this CommonFigureAnnotation. - The date and time when the annotation was created. - - :param creation_date: The creation_date of this CommonFigureAnnotation. - :type: str - """ - - self._creation_date = creation_date - - @property - def subject(self): - """ - Gets the subject of this CommonFigureAnnotation. - Get the annotation subject. - - :return: The subject of this CommonFigureAnnotation. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this CommonFigureAnnotation. - Get the annotation subject. - - :param subject: The subject of this CommonFigureAnnotation. - :type: str - """ - - self._subject = subject - - @property - def title(self): - """ - Gets the title of this CommonFigureAnnotation. - Get the annotation title. - - :return: The title of this CommonFigureAnnotation. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this CommonFigureAnnotation. - Get the annotation title. - - :param title: The title of this CommonFigureAnnotation. - :type: str - """ - - self._title = title - @property def modified(self): """ @@ -467,6 +398,75 @@ def vertical_alignment(self, vertical_alignment): self._vertical_alignment = vertical_alignment + @property + def creation_date(self): + """ + Gets the creation_date of this CommonFigureAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this CommonFigureAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this CommonFigureAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this CommonFigureAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this CommonFigureAnnotation. + Get the annotation subject. + + :return: The subject of this CommonFigureAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this CommonFigureAnnotation. + Get the annotation subject. + + :param subject: The subject of this CommonFigureAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this CommonFigureAnnotation. + Get the annotation title. + + :return: The title of this CommonFigureAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this CommonFigureAnnotation. + Get the annotation title. + + :param title: The title of this CommonFigureAnnotation. + :type: str + """ + + self._title = title + @property def rich_text(self): """ diff --git a/asposepdfcloud/models/file.py b/asposepdfcloud/models/file.py new file mode 100644 index 0000000..6862b44 --- /dev/null +++ b/asposepdfcloud/models/file.py @@ -0,0 +1,246 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class File(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'is_folder': 'bool', + 'modified_date': 'datetime', + 'size': 'int', + 'path': 'str' + } + + attribute_map = { + 'name': 'Name', + 'is_folder': 'IsFolder', + 'modified_date': 'ModifiedDate', + 'size': 'Size', + 'path': 'Path' + } + + def __init__(self, name=None, is_folder=None, modified_date=None, size=None, path=None): + """ + File - a model defined in Swagger + """ + + self._name = None + self._is_folder = None + self._modified_date = None + self._size = None + self._path = None + + if name is not None: + self.name = name + self.is_folder = is_folder + if modified_date is not None: + self.modified_date = modified_date + self.size = size + if path is not None: + self.path = path + + @property + def name(self): + """ + Gets the name of this File. + + :return: The name of this File. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this File. + + :param name: The name of this File. + :type: str + """ + + self._name = name + + @property + def is_folder(self): + """ + Gets the is_folder of this File. + + :return: The is_folder of this File. + :rtype: bool + """ + return self._is_folder + + @is_folder.setter + def is_folder(self, is_folder): + """ + Sets the is_folder of this File. + + :param is_folder: The is_folder of this File. + :type: bool + """ + if is_folder is None: + raise ValueError("Invalid value for `is_folder`, must not be `None`") + + self._is_folder = is_folder + + @property + def modified_date(self): + """ + Gets the modified_date of this File. + + :return: The modified_date of this File. + :rtype: datetime + """ + return self._modified_date + + @modified_date.setter + def modified_date(self, modified_date): + """ + Sets the modified_date of this File. + + :param modified_date: The modified_date of this File. + :type: datetime + """ + + self._modified_date = modified_date + + @property + def size(self): + """ + Gets the size of this File. + + :return: The size of this File. + :rtype: int + """ + return self._size + + @size.setter + def size(self, size): + """ + Sets the size of this File. + + :param size: The size of this File. + :type: int + """ + if size is None: + raise ValueError("Invalid value for `size`, must not be `None`") + + self._size = size + + @property + def path(self): + """ + Gets the path of this File. + + :return: The path of this File. + :rtype: str + """ + return self._path + + @path.setter + def path(self, path): + """ + Sets the path of this File. + + :param path: The path of this File. + :type: str + """ + + self._path = path + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, File): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/files_response.py b/asposepdfcloud/models/files_response.py new file mode 100644 index 0000000..1758100 --- /dev/null +++ b/asposepdfcloud/models/files_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class FilesResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'files': 'list[File]' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'files': 'Files' + } + + def __init__(self, code=None, status=None, files=None): + """ + FilesResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._files = None + + self.code = code + if status is not None: + self.status = status + if files is not None: + self.files = files + + @property + def code(self): + """ + Gets the code of this FilesResponse. + Response status code. + + :return: The code of this FilesResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this FilesResponse. + Response status code. + + :param code: The code of this FilesResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this FilesResponse. + Response status. + + :return: The status of this FilesResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this FilesResponse. + Response status. + + :param status: The status of this FilesResponse. + :type: str + """ + + self._status = status + + @property + def files(self): + """ + Gets the files of this FilesResponse. + + :return: The files of this FilesResponse. + :rtype: list[File] + """ + return self._files + + @files.setter + def files(self, files): + """ + Sets the files of this FilesResponse. + + :param files: The files of this FilesResponse. + :type: list[File] + """ + + self._files = files + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, FilesResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/free_text_annotation.py b/asposepdfcloud/models/free_text_annotation.py index b0e169c..af2f0df 100644 --- a/asposepdfcloud/models/free_text_annotation.py +++ b/asposepdfcloud/models/free_text_annotation.py @@ -50,9 +50,6 @@ class FreeTextAnnotation(object): swagger_types = { 'links': 'list[Link]', 'contents': 'str', - 'creation_date': 'str', - 'subject': 'str', - 'title': 'str', 'modified': 'str', 'id': 'str', 'flags': 'list[AnnotationFlags]', @@ -62,6 +59,9 @@ class FreeTextAnnotation(object): 'z_index': 'int', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', 'rich_text': 'str', 'justification': 'Justification', 'intent': 'FreeTextIntent', @@ -72,9 +72,6 @@ class FreeTextAnnotation(object): attribute_map = { 'links': 'Links', 'contents': 'Contents', - 'creation_date': 'CreationDate', - 'subject': 'Subject', - 'title': 'Title', 'modified': 'Modified', 'id': 'Id', 'flags': 'Flags', @@ -84,6 +81,9 @@ class FreeTextAnnotation(object): 'z_index': 'ZIndex', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', 'rich_text': 'RichText', 'justification': 'Justification', 'intent': 'Intent', @@ -91,16 +91,13 @@ class FreeTextAnnotation(object): 'text_style': 'TextStyle' } - def __init__(self, links=None, contents=None, creation_date=None, subject=None, title=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, rich_text=None, justification=None, intent=None, rotate=None, text_style=None): + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, justification=None, intent=None, rotate=None, text_style=None): """ FreeTextAnnotation - a model defined in Swagger """ self._links = None self._contents = None - self._creation_date = None - self._subject = None - self._title = None self._modified = None self._id = None self._flags = None @@ -110,6 +107,9 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self._z_index = None self._horizontal_alignment = None self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None self._rich_text = None self._justification = None self._intent = None @@ -120,12 +120,6 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.links = links if contents is not None: self.contents = contents - if creation_date is not None: - self.creation_date = creation_date - if subject is not None: - self.subject = subject - if title is not None: - self.title = title if modified is not None: self.modified = modified if id is not None: @@ -144,6 +138,12 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.horizontal_alignment = horizontal_alignment if vertical_alignment is not None: self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title if rich_text is not None: self.rich_text = rich_text if justification is not None: @@ -201,75 +201,6 @@ def contents(self, contents): self._contents = contents - @property - def creation_date(self): - """ - Gets the creation_date of this FreeTextAnnotation. - The date and time when the annotation was created. - - :return: The creation_date of this FreeTextAnnotation. - :rtype: str - """ - return self._creation_date - - @creation_date.setter - def creation_date(self, creation_date): - """ - Sets the creation_date of this FreeTextAnnotation. - The date and time when the annotation was created. - - :param creation_date: The creation_date of this FreeTextAnnotation. - :type: str - """ - - self._creation_date = creation_date - - @property - def subject(self): - """ - Gets the subject of this FreeTextAnnotation. - Get the annotation subject. - - :return: The subject of this FreeTextAnnotation. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this FreeTextAnnotation. - Get the annotation subject. - - :param subject: The subject of this FreeTextAnnotation. - :type: str - """ - - self._subject = subject - - @property - def title(self): - """ - Gets the title of this FreeTextAnnotation. - Get the annotation title. - - :return: The title of this FreeTextAnnotation. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this FreeTextAnnotation. - Get the annotation title. - - :param title: The title of this FreeTextAnnotation. - :type: str - """ - - self._title = title - @property def modified(self): """ @@ -477,6 +408,75 @@ def vertical_alignment(self, vertical_alignment): self._vertical_alignment = vertical_alignment + @property + def creation_date(self): + """ + Gets the creation_date of this FreeTextAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this FreeTextAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this FreeTextAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this FreeTextAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this FreeTextAnnotation. + Get the annotation subject. + + :return: The subject of this FreeTextAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this FreeTextAnnotation. + Get the annotation subject. + + :param subject: The subject of this FreeTextAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this FreeTextAnnotation. + Get the annotation title. + + :return: The title of this FreeTextAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this FreeTextAnnotation. + Get the annotation title. + + :param title: The title of this FreeTextAnnotation. + :type: str + """ + + self._title = title + @property def rich_text(self): """ diff --git a/asposepdfcloud/models/highlight_annotation.py b/asposepdfcloud/models/highlight_annotation.py new file mode 100644 index 0000000..2774fd2 --- /dev/null +++ b/asposepdfcloud/models/highlight_annotation.py @@ -0,0 +1,590 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class HighlightAnnotation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'contents': 'str', + 'modified': 'str', + 'id': 'str', + 'flags': 'list[AnnotationFlags]', + 'name': 'str', + 'rect': 'RectanglePdf', + 'page_index': 'int', + 'z_index': 'int', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', + 'rich_text': 'str', + 'color': 'Color', + 'quad_points': 'list[Point]' + } + + attribute_map = { + 'links': 'Links', + 'contents': 'Contents', + 'modified': 'Modified', + 'id': 'Id', + 'flags': 'Flags', + 'name': 'Name', + 'rect': 'Rect', + 'page_index': 'PageIndex', + 'z_index': 'ZIndex', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', + 'rich_text': 'RichText', + 'color': 'Color', + 'quad_points': 'QuadPoints' + } + + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, color=None, quad_points=None): + """ + HighlightAnnotation - a model defined in Swagger + """ + + self._links = None + self._contents = None + self._modified = None + self._id = None + self._flags = None + self._name = None + self._rect = None + self._page_index = None + self._z_index = None + self._horizontal_alignment = None + self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None + self._rich_text = None + self._color = None + self._quad_points = None + + if links is not None: + self.links = links + if contents is not None: + self.contents = contents + if modified is not None: + self.modified = modified + if id is not None: + self.id = id + if flags is not None: + self.flags = flags + if name is not None: + self.name = name + if rect is not None: + self.rect = rect + if page_index is not None: + self.page_index = page_index + if z_index is not None: + self.z_index = z_index + if horizontal_alignment is not None: + self.horizontal_alignment = horizontal_alignment + if vertical_alignment is not None: + self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title + if rich_text is not None: + self.rich_text = rich_text + if color is not None: + self.color = color + if quad_points is not None: + self.quad_points = quad_points + + @property + def links(self): + """ + Gets the links of this HighlightAnnotation. + Link to the document. + + :return: The links of this HighlightAnnotation. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this HighlightAnnotation. + Link to the document. + + :param links: The links of this HighlightAnnotation. + :type: list[Link] + """ + + self._links = links + + @property + def contents(self): + """ + Gets the contents of this HighlightAnnotation. + Get the annotation content. + + :return: The contents of this HighlightAnnotation. + :rtype: str + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this HighlightAnnotation. + Get the annotation content. + + :param contents: The contents of this HighlightAnnotation. + :type: str + """ + + self._contents = contents + + @property + def modified(self): + """ + Gets the modified of this HighlightAnnotation. + The date and time when the annotation was last modified. + + :return: The modified of this HighlightAnnotation. + :rtype: str + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this HighlightAnnotation. + The date and time when the annotation was last modified. + + :param modified: The modified of this HighlightAnnotation. + :type: str + """ + + self._modified = modified + + @property + def id(self): + """ + Gets the id of this HighlightAnnotation. + Gets ID of the annotation. + + :return: The id of this HighlightAnnotation. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this HighlightAnnotation. + Gets ID of the annotation. + + :param id: The id of this HighlightAnnotation. + :type: str + """ + + self._id = id + + @property + def flags(self): + """ + Gets the flags of this HighlightAnnotation. + Gets Flags of the annotation. + + :return: The flags of this HighlightAnnotation. + :rtype: list[AnnotationFlags] + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this HighlightAnnotation. + Gets Flags of the annotation. + + :param flags: The flags of this HighlightAnnotation. + :type: list[AnnotationFlags] + """ + + self._flags = flags + + @property + def name(self): + """ + Gets the name of this HighlightAnnotation. + Gets Name of the annotation. + + :return: The name of this HighlightAnnotation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this HighlightAnnotation. + Gets Name of the annotation. + + :param name: The name of this HighlightAnnotation. + :type: str + """ + + self._name = name + + @property + def rect(self): + """ + Gets the rect of this HighlightAnnotation. + Gets Rect of the annotation. + + :return: The rect of this HighlightAnnotation. + :rtype: RectanglePdf + """ + return self._rect + + @rect.setter + def rect(self, rect): + """ + Sets the rect of this HighlightAnnotation. + Gets Rect of the annotation. + + :param rect: The rect of this HighlightAnnotation. + :type: RectanglePdf + """ + + self._rect = rect + + @property + def page_index(self): + """ + Gets the page_index of this HighlightAnnotation. + Gets PageIndex of the annotation. + + :return: The page_index of this HighlightAnnotation. + :rtype: int + """ + return self._page_index + + @page_index.setter + def page_index(self, page_index): + """ + Sets the page_index of this HighlightAnnotation. + Gets PageIndex of the annotation. + + :param page_index: The page_index of this HighlightAnnotation. + :type: int + """ + + self._page_index = page_index + + @property + def z_index(self): + """ + Gets the z_index of this HighlightAnnotation. + Gets ZIndex of the annotation. + + :return: The z_index of this HighlightAnnotation. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this HighlightAnnotation. + Gets ZIndex of the annotation. + + :param z_index: The z_index of this HighlightAnnotation. + :type: int + """ + + self._z_index = z_index + + @property + def horizontal_alignment(self): + """ + Gets the horizontal_alignment of this HighlightAnnotation. + Gets HorizontalAlignment of the annotation. + + :return: The horizontal_alignment of this HighlightAnnotation. + :rtype: HorizontalAlignment + """ + return self._horizontal_alignment + + @horizontal_alignment.setter + def horizontal_alignment(self, horizontal_alignment): + """ + Sets the horizontal_alignment of this HighlightAnnotation. + Gets HorizontalAlignment of the annotation. + + :param horizontal_alignment: The horizontal_alignment of this HighlightAnnotation. + :type: HorizontalAlignment + """ + + self._horizontal_alignment = horizontal_alignment + + @property + def vertical_alignment(self): + """ + Gets the vertical_alignment of this HighlightAnnotation. + Gets VerticalAlignment of the annotation. + + :return: The vertical_alignment of this HighlightAnnotation. + :rtype: VerticalAlignment + """ + return self._vertical_alignment + + @vertical_alignment.setter + def vertical_alignment(self, vertical_alignment): + """ + Sets the vertical_alignment of this HighlightAnnotation. + Gets VerticalAlignment of the annotation. + + :param vertical_alignment: The vertical_alignment of this HighlightAnnotation. + :type: VerticalAlignment + """ + + self._vertical_alignment = vertical_alignment + + @property + def creation_date(self): + """ + Gets the creation_date of this HighlightAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this HighlightAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this HighlightAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this HighlightAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this HighlightAnnotation. + Get the annotation subject. + + :return: The subject of this HighlightAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this HighlightAnnotation. + Get the annotation subject. + + :param subject: The subject of this HighlightAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this HighlightAnnotation. + Get the annotation title. + + :return: The title of this HighlightAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this HighlightAnnotation. + Get the annotation title. + + :param title: The title of this HighlightAnnotation. + :type: str + """ + + self._title = title + + @property + def rich_text(self): + """ + Gets the rich_text of this HighlightAnnotation. + Get the annotation RichText. + + :return: The rich_text of this HighlightAnnotation. + :rtype: str + """ + return self._rich_text + + @rich_text.setter + def rich_text(self, rich_text): + """ + Sets the rich_text of this HighlightAnnotation. + Get the annotation RichText. + + :param rich_text: The rich_text of this HighlightAnnotation. + :type: str + """ + + self._rich_text = rich_text + + @property + def color(self): + """ + Gets the color of this HighlightAnnotation. + Color of the annotation. + + :return: The color of this HighlightAnnotation. + :rtype: Color + """ + return self._color + + @color.setter + def color(self, color): + """ + Sets the color of this HighlightAnnotation. + Color of the annotation. + + :param color: The color of this HighlightAnnotation. + :type: Color + """ + + self._color = color + + @property + def quad_points(self): + """ + Gets the quad_points of this HighlightAnnotation. + 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. + + :return: The quad_points of this HighlightAnnotation. + :rtype: list[Point] + """ + return self._quad_points + + @quad_points.setter + def quad_points(self, quad_points): + """ + Sets the quad_points of this HighlightAnnotation. + 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. + + :param quad_points: The quad_points of this HighlightAnnotation. + :type: list[Point] + """ + + self._quad_points = quad_points + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, HighlightAnnotation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/highlight_annotation_response.py b/asposepdfcloud/models/highlight_annotation_response.py new file mode 100644 index 0000000..79b5196 --- /dev/null +++ b/asposepdfcloud/models/highlight_annotation_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class HighlightAnnotationResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotation': 'HighlightAnnotation' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotation': 'Annotation' + } + + def __init__(self, code=None, status=None, annotation=None): + """ + HighlightAnnotationResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotation = None + + self.code = code + if status is not None: + self.status = status + if annotation is not None: + self.annotation = annotation + + @property + def code(self): + """ + Gets the code of this HighlightAnnotationResponse. + Response status code. + + :return: The code of this HighlightAnnotationResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this HighlightAnnotationResponse. + Response status code. + + :param code: The code of this HighlightAnnotationResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this HighlightAnnotationResponse. + Response status. + + :return: The status of this HighlightAnnotationResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this HighlightAnnotationResponse. + Response status. + + :param status: The status of this HighlightAnnotationResponse. + :type: str + """ + + self._status = status + + @property + def annotation(self): + """ + Gets the annotation of this HighlightAnnotationResponse. + + :return: The annotation of this HighlightAnnotationResponse. + :rtype: HighlightAnnotation + """ + return self._annotation + + @annotation.setter + def annotation(self, annotation): + """ + Sets the annotation of this HighlightAnnotationResponse. + + :param annotation: The annotation of this HighlightAnnotationResponse. + :type: HighlightAnnotation + """ + + self._annotation = annotation + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, HighlightAnnotationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/highlight_annotations.py b/asposepdfcloud/models/highlight_annotations.py new file mode 100644 index 0000000..60e2720 --- /dev/null +++ b/asposepdfcloud/models/highlight_annotations.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class HighlightAnnotations(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'list': 'list[HighlightAnnotation]' + } + + attribute_map = { + 'links': 'Links', + 'list': 'List' + } + + def __init__(self, links=None, list=None): + """ + HighlightAnnotations - a model defined in Swagger + """ + + self._links = None + self._list = None + + if links is not None: + self.links = links + if list is not None: + self.list = list + + @property + def links(self): + """ + Gets the links of this HighlightAnnotations. + Link to the document. + + :return: The links of this HighlightAnnotations. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this HighlightAnnotations. + Link to the document. + + :param links: The links of this HighlightAnnotations. + :type: list[Link] + """ + + self._links = links + + @property + def list(self): + """ + Gets the list of this HighlightAnnotations. + + :return: The list of this HighlightAnnotations. + :rtype: list[HighlightAnnotation] + """ + return self._list + + @list.setter + def list(self, list): + """ + Sets the list of this HighlightAnnotations. + + :param list: The list of this HighlightAnnotations. + :type: list[HighlightAnnotation] + """ + + self._list = list + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, HighlightAnnotations): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/highlight_annotations_response.py b/asposepdfcloud/models/highlight_annotations_response.py new file mode 100644 index 0000000..1163585 --- /dev/null +++ b/asposepdfcloud/models/highlight_annotations_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class HighlightAnnotationsResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotations': 'HighlightAnnotations' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotations': 'Annotations' + } + + def __init__(self, code=None, status=None, annotations=None): + """ + HighlightAnnotationsResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotations = None + + self.code = code + if status is not None: + self.status = status + if annotations is not None: + self.annotations = annotations + + @property + def code(self): + """ + Gets the code of this HighlightAnnotationsResponse. + Response status code. + + :return: The code of this HighlightAnnotationsResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this HighlightAnnotationsResponse. + Response status code. + + :param code: The code of this HighlightAnnotationsResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this HighlightAnnotationsResponse. + Response status. + + :return: The status of this HighlightAnnotationsResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this HighlightAnnotationsResponse. + Response status. + + :param status: The status of this HighlightAnnotationsResponse. + :type: str + """ + + self._status = status + + @property + def annotations(self): + """ + Gets the annotations of this HighlightAnnotationsResponse. + + :return: The annotations of this HighlightAnnotationsResponse. + :rtype: HighlightAnnotations + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this HighlightAnnotationsResponse. + + :param annotations: The annotations of this HighlightAnnotationsResponse. + :type: HighlightAnnotations + """ + + self._annotations = annotations + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, HighlightAnnotationsResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/ink_annotation.py b/asposepdfcloud/models/ink_annotation.py new file mode 100644 index 0000000..226a118 --- /dev/null +++ b/asposepdfcloud/models/ink_annotation.py @@ -0,0 +1,618 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class InkAnnotation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'contents': 'str', + 'modified': 'str', + 'id': 'str', + 'flags': 'list[AnnotationFlags]', + 'name': 'str', + 'rect': 'RectanglePdf', + 'page_index': 'int', + 'z_index': 'int', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', + 'rich_text': 'str', + 'color': 'Color', + 'ink_list': 'list[list[Point]]', + 'cap_style': 'CapStyle' + } + + attribute_map = { + 'links': 'Links', + 'contents': 'Contents', + 'modified': 'Modified', + 'id': 'Id', + 'flags': 'Flags', + 'name': 'Name', + 'rect': 'Rect', + 'page_index': 'PageIndex', + 'z_index': 'ZIndex', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', + 'rich_text': 'RichText', + 'color': 'Color', + 'ink_list': 'InkList', + 'cap_style': 'CapStyle' + } + + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, color=None, ink_list=None, cap_style=None): + """ + InkAnnotation - a model defined in Swagger + """ + + self._links = None + self._contents = None + self._modified = None + self._id = None + self._flags = None + self._name = None + self._rect = None + self._page_index = None + self._z_index = None + self._horizontal_alignment = None + self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None + self._rich_text = None + self._color = None + self._ink_list = None + self._cap_style = None + + if links is not None: + self.links = links + if contents is not None: + self.contents = contents + if modified is not None: + self.modified = modified + if id is not None: + self.id = id + if flags is not None: + self.flags = flags + if name is not None: + self.name = name + if rect is not None: + self.rect = rect + if page_index is not None: + self.page_index = page_index + if z_index is not None: + self.z_index = z_index + if horizontal_alignment is not None: + self.horizontal_alignment = horizontal_alignment + if vertical_alignment is not None: + self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title + if rich_text is not None: + self.rich_text = rich_text + if color is not None: + self.color = color + if ink_list is not None: + self.ink_list = ink_list + if cap_style is not None: + self.cap_style = cap_style + + @property + def links(self): + """ + Gets the links of this InkAnnotation. + Link to the document. + + :return: The links of this InkAnnotation. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this InkAnnotation. + Link to the document. + + :param links: The links of this InkAnnotation. + :type: list[Link] + """ + + self._links = links + + @property + def contents(self): + """ + Gets the contents of this InkAnnotation. + Get the annotation content. + + :return: The contents of this InkAnnotation. + :rtype: str + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this InkAnnotation. + Get the annotation content. + + :param contents: The contents of this InkAnnotation. + :type: str + """ + + self._contents = contents + + @property + def modified(self): + """ + Gets the modified of this InkAnnotation. + The date and time when the annotation was last modified. + + :return: The modified of this InkAnnotation. + :rtype: str + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this InkAnnotation. + The date and time when the annotation was last modified. + + :param modified: The modified of this InkAnnotation. + :type: str + """ + + self._modified = modified + + @property + def id(self): + """ + Gets the id of this InkAnnotation. + Gets ID of the annotation. + + :return: The id of this InkAnnotation. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this InkAnnotation. + Gets ID of the annotation. + + :param id: The id of this InkAnnotation. + :type: str + """ + + self._id = id + + @property + def flags(self): + """ + Gets the flags of this InkAnnotation. + Gets Flags of the annotation. + + :return: The flags of this InkAnnotation. + :rtype: list[AnnotationFlags] + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this InkAnnotation. + Gets Flags of the annotation. + + :param flags: The flags of this InkAnnotation. + :type: list[AnnotationFlags] + """ + + self._flags = flags + + @property + def name(self): + """ + Gets the name of this InkAnnotation. + Gets Name of the annotation. + + :return: The name of this InkAnnotation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this InkAnnotation. + Gets Name of the annotation. + + :param name: The name of this InkAnnotation. + :type: str + """ + + self._name = name + + @property + def rect(self): + """ + Gets the rect of this InkAnnotation. + Gets Rect of the annotation. + + :return: The rect of this InkAnnotation. + :rtype: RectanglePdf + """ + return self._rect + + @rect.setter + def rect(self, rect): + """ + Sets the rect of this InkAnnotation. + Gets Rect of the annotation. + + :param rect: The rect of this InkAnnotation. + :type: RectanglePdf + """ + + self._rect = rect + + @property + def page_index(self): + """ + Gets the page_index of this InkAnnotation. + Gets PageIndex of the annotation. + + :return: The page_index of this InkAnnotation. + :rtype: int + """ + return self._page_index + + @page_index.setter + def page_index(self, page_index): + """ + Sets the page_index of this InkAnnotation. + Gets PageIndex of the annotation. + + :param page_index: The page_index of this InkAnnotation. + :type: int + """ + + self._page_index = page_index + + @property + def z_index(self): + """ + Gets the z_index of this InkAnnotation. + Gets ZIndex of the annotation. + + :return: The z_index of this InkAnnotation. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this InkAnnotation. + Gets ZIndex of the annotation. + + :param z_index: The z_index of this InkAnnotation. + :type: int + """ + + self._z_index = z_index + + @property + def horizontal_alignment(self): + """ + Gets the horizontal_alignment of this InkAnnotation. + Gets HorizontalAlignment of the annotation. + + :return: The horizontal_alignment of this InkAnnotation. + :rtype: HorizontalAlignment + """ + return self._horizontal_alignment + + @horizontal_alignment.setter + def horizontal_alignment(self, horizontal_alignment): + """ + Sets the horizontal_alignment of this InkAnnotation. + Gets HorizontalAlignment of the annotation. + + :param horizontal_alignment: The horizontal_alignment of this InkAnnotation. + :type: HorizontalAlignment + """ + + self._horizontal_alignment = horizontal_alignment + + @property + def vertical_alignment(self): + """ + Gets the vertical_alignment of this InkAnnotation. + Gets VerticalAlignment of the annotation. + + :return: The vertical_alignment of this InkAnnotation. + :rtype: VerticalAlignment + """ + return self._vertical_alignment + + @vertical_alignment.setter + def vertical_alignment(self, vertical_alignment): + """ + Sets the vertical_alignment of this InkAnnotation. + Gets VerticalAlignment of the annotation. + + :param vertical_alignment: The vertical_alignment of this InkAnnotation. + :type: VerticalAlignment + """ + + self._vertical_alignment = vertical_alignment + + @property + def creation_date(self): + """ + Gets the creation_date of this InkAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this InkAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this InkAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this InkAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this InkAnnotation. + Get the annotation subject. + + :return: The subject of this InkAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this InkAnnotation. + Get the annotation subject. + + :param subject: The subject of this InkAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this InkAnnotation. + Get the annotation title. + + :return: The title of this InkAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this InkAnnotation. + Get the annotation title. + + :param title: The title of this InkAnnotation. + :type: str + """ + + self._title = title + + @property + def rich_text(self): + """ + Gets the rich_text of this InkAnnotation. + Get the annotation RichText. + + :return: The rich_text of this InkAnnotation. + :rtype: str + """ + return self._rich_text + + @rich_text.setter + def rich_text(self, rich_text): + """ + Sets the rich_text of this InkAnnotation. + Get the annotation RichText. + + :param rich_text: The rich_text of this InkAnnotation. + :type: str + """ + + self._rich_text = rich_text + + @property + def color(self): + """ + Gets the color of this InkAnnotation. + Color of the annotation. + + :return: The color of this InkAnnotation. + :rtype: Color + """ + return self._color + + @color.setter + def color(self, color): + """ + Sets the color of this InkAnnotation. + Color of the annotation. + + :param color: The color of this InkAnnotation. + :type: Color + """ + + self._color = color + + @property + def ink_list(self): + """ + Gets the ink_list of this InkAnnotation. + Gets or sets list of gestures that are independent lines which are represented by Point[] arrays. + + :return: The ink_list of this InkAnnotation. + :rtype: list[list[Point]] + """ + return self._ink_list + + @ink_list.setter + def ink_list(self, ink_list): + """ + Sets the ink_list of this InkAnnotation. + Gets or sets list of gestures that are independent lines which are represented by Point[] arrays. + + :param ink_list: The ink_list of this InkAnnotation. + :type: list[list[Point]] + """ + + self._ink_list = ink_list + + @property + def cap_style(self): + """ + Gets the cap_style of this InkAnnotation. + Style of ink annotation line endings. + + :return: The cap_style of this InkAnnotation. + :rtype: CapStyle + """ + return self._cap_style + + @cap_style.setter + def cap_style(self, cap_style): + """ + Sets the cap_style of this InkAnnotation. + Style of ink annotation line endings. + + :param cap_style: The cap_style of this InkAnnotation. + :type: CapStyle + """ + + self._cap_style = cap_style + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InkAnnotation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/ink_annotation_response.py b/asposepdfcloud/models/ink_annotation_response.py new file mode 100644 index 0000000..a3c1de3 --- /dev/null +++ b/asposepdfcloud/models/ink_annotation_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class InkAnnotationResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotation': 'InkAnnotation' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotation': 'Annotation' + } + + def __init__(self, code=None, status=None, annotation=None): + """ + InkAnnotationResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotation = None + + self.code = code + if status is not None: + self.status = status + if annotation is not None: + self.annotation = annotation + + @property + def code(self): + """ + Gets the code of this InkAnnotationResponse. + Response status code. + + :return: The code of this InkAnnotationResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this InkAnnotationResponse. + Response status code. + + :param code: The code of this InkAnnotationResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this InkAnnotationResponse. + Response status. + + :return: The status of this InkAnnotationResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this InkAnnotationResponse. + Response status. + + :param status: The status of this InkAnnotationResponse. + :type: str + """ + + self._status = status + + @property + def annotation(self): + """ + Gets the annotation of this InkAnnotationResponse. + + :return: The annotation of this InkAnnotationResponse. + :rtype: InkAnnotation + """ + return self._annotation + + @annotation.setter + def annotation(self, annotation): + """ + Sets the annotation of this InkAnnotationResponse. + + :param annotation: The annotation of this InkAnnotationResponse. + :type: InkAnnotation + """ + + self._annotation = annotation + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InkAnnotationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/ink_annotations.py b/asposepdfcloud/models/ink_annotations.py new file mode 100644 index 0000000..b827ecb --- /dev/null +++ b/asposepdfcloud/models/ink_annotations.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class InkAnnotations(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'list': 'list[InkAnnotation]' + } + + attribute_map = { + 'links': 'Links', + 'list': 'List' + } + + def __init__(self, links=None, list=None): + """ + InkAnnotations - a model defined in Swagger + """ + + self._links = None + self._list = None + + if links is not None: + self.links = links + if list is not None: + self.list = list + + @property + def links(self): + """ + Gets the links of this InkAnnotations. + Link to the document. + + :return: The links of this InkAnnotations. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this InkAnnotations. + Link to the document. + + :param links: The links of this InkAnnotations. + :type: list[Link] + """ + + self._links = links + + @property + def list(self): + """ + Gets the list of this InkAnnotations. + + :return: The list of this InkAnnotations. + :rtype: list[InkAnnotation] + """ + return self._list + + @list.setter + def list(self, list): + """ + Sets the list of this InkAnnotations. + + :param list: The list of this InkAnnotations. + :type: list[InkAnnotation] + """ + + self._list = list + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InkAnnotations): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/ink_annotations_response.py b/asposepdfcloud/models/ink_annotations_response.py new file mode 100644 index 0000000..6b253f8 --- /dev/null +++ b/asposepdfcloud/models/ink_annotations_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class InkAnnotationsResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotations': 'InkAnnotations' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotations': 'Annotations' + } + + def __init__(self, code=None, status=None, annotations=None): + """ + InkAnnotationsResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotations = None + + self.code = code + if status is not None: + self.status = status + if annotations is not None: + self.annotations = annotations + + @property + def code(self): + """ + Gets the code of this InkAnnotationsResponse. + Response status code. + + :return: The code of this InkAnnotationsResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this InkAnnotationsResponse. + Response status code. + + :param code: The code of this InkAnnotationsResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this InkAnnotationsResponse. + Response status. + + :return: The status of this InkAnnotationsResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this InkAnnotationsResponse. + Response status. + + :param status: The status of this InkAnnotationsResponse. + :type: str + """ + + self._status = status + + @property + def annotations(self): + """ + Gets the annotations of this InkAnnotationsResponse. + + :return: The annotations of this InkAnnotationsResponse. + :rtype: InkAnnotations + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this InkAnnotationsResponse. + + :param annotations: The annotations of this InkAnnotationsResponse. + :type: InkAnnotations + """ + + self._annotations = annotations + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InkAnnotationsResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/line_annotation.py b/asposepdfcloud/models/line_annotation.py index 1b5f6b8..e08efb5 100644 --- a/asposepdfcloud/models/line_annotation.py +++ b/asposepdfcloud/models/line_annotation.py @@ -50,9 +50,6 @@ class LineAnnotation(object): swagger_types = { 'links': 'list[Link]', 'contents': 'str', - 'creation_date': 'str', - 'subject': 'str', - 'title': 'str', 'modified': 'str', 'id': 'str', 'flags': 'list[AnnotationFlags]', @@ -62,6 +59,9 @@ class LineAnnotation(object): 'z_index': 'int', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', 'rich_text': 'str', 'starting': 'Point', 'starting_style': 'LineEnding', @@ -81,9 +81,6 @@ class LineAnnotation(object): attribute_map = { 'links': 'Links', 'contents': 'Contents', - 'creation_date': 'CreationDate', - 'subject': 'Subject', - 'title': 'Title', 'modified': 'Modified', 'id': 'Id', 'flags': 'Flags', @@ -93,6 +90,9 @@ class LineAnnotation(object): 'z_index': 'ZIndex', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', 'rich_text': 'RichText', 'starting': 'Starting', 'starting_style': 'StartingStyle', @@ -109,16 +109,13 @@ class LineAnnotation(object): 'intent': 'Intent' } - def __init__(self, links=None, contents=None, creation_date=None, subject=None, title=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, rich_text=None, starting=None, starting_style=None, ending=None, ending_style=None, interior_color=None, leader_line=None, leader_line_extension=None, leader_line_offset=None, show_caption=None, caption_offset=None, caption_position=None, color=None, intent=None): + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, starting=None, starting_style=None, ending=None, ending_style=None, interior_color=None, leader_line=None, leader_line_extension=None, leader_line_offset=None, show_caption=None, caption_offset=None, caption_position=None, color=None, intent=None): """ LineAnnotation - a model defined in Swagger """ self._links = None self._contents = None - self._creation_date = None - self._subject = None - self._title = None self._modified = None self._id = None self._flags = None @@ -128,6 +125,9 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self._z_index = None self._horizontal_alignment = None self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None self._rich_text = None self._starting = None self._starting_style = None @@ -147,12 +147,6 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.links = links if contents is not None: self.contents = contents - if creation_date is not None: - self.creation_date = creation_date - if subject is not None: - self.subject = subject - if title is not None: - self.title = title if modified is not None: self.modified = modified if id is not None: @@ -171,6 +165,12 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.horizontal_alignment = horizontal_alignment if vertical_alignment is not None: self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title if rich_text is not None: self.rich_text = rich_text if starting is not None: @@ -246,75 +246,6 @@ def contents(self, contents): self._contents = contents - @property - def creation_date(self): - """ - Gets the creation_date of this LineAnnotation. - The date and time when the annotation was created. - - :return: The creation_date of this LineAnnotation. - :rtype: str - """ - return self._creation_date - - @creation_date.setter - def creation_date(self, creation_date): - """ - Sets the creation_date of this LineAnnotation. - The date and time when the annotation was created. - - :param creation_date: The creation_date of this LineAnnotation. - :type: str - """ - - self._creation_date = creation_date - - @property - def subject(self): - """ - Gets the subject of this LineAnnotation. - Get the annotation subject. - - :return: The subject of this LineAnnotation. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this LineAnnotation. - Get the annotation subject. - - :param subject: The subject of this LineAnnotation. - :type: str - """ - - self._subject = subject - - @property - def title(self): - """ - Gets the title of this LineAnnotation. - Get the annotation title. - - :return: The title of this LineAnnotation. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this LineAnnotation. - Get the annotation title. - - :param title: The title of this LineAnnotation. - :type: str - """ - - self._title = title - @property def modified(self): """ @@ -522,6 +453,75 @@ def vertical_alignment(self, vertical_alignment): self._vertical_alignment = vertical_alignment + @property + def creation_date(self): + """ + Gets the creation_date of this LineAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this LineAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this LineAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this LineAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this LineAnnotation. + Get the annotation subject. + + :return: The subject of this LineAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this LineAnnotation. + Get the annotation subject. + + :param subject: The subject of this LineAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this LineAnnotation. + Get the annotation title. + + :return: The title of this LineAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this LineAnnotation. + Get the annotation title. + + :param title: The title of this LineAnnotation. + :type: str + """ + + self._title = title + @property def rich_text(self): """ diff --git a/asposepdfcloud/models/markup_annotation.py b/asposepdfcloud/models/markup_annotation.py index 4ac976d..1482443 100644 --- a/asposepdfcloud/models/markup_annotation.py +++ b/asposepdfcloud/models/markup_annotation.py @@ -50,9 +50,6 @@ class MarkupAnnotation(object): swagger_types = { 'links': 'list[Link]', 'contents': 'str', - 'creation_date': 'str', - 'subject': 'str', - 'title': 'str', 'modified': 'str', 'id': 'str', 'flags': 'list[AnnotationFlags]', @@ -62,15 +59,15 @@ class MarkupAnnotation(object): 'z_index': 'int', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', 'rich_text': 'str' } attribute_map = { 'links': 'Links', 'contents': 'Contents', - 'creation_date': 'CreationDate', - 'subject': 'Subject', - 'title': 'Title', 'modified': 'Modified', 'id': 'Id', 'flags': 'Flags', @@ -80,19 +77,19 @@ class MarkupAnnotation(object): 'z_index': 'ZIndex', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', 'rich_text': 'RichText' } - def __init__(self, links=None, contents=None, creation_date=None, subject=None, title=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, rich_text=None): + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None): """ MarkupAnnotation - a model defined in Swagger """ self._links = None self._contents = None - self._creation_date = None - self._subject = None - self._title = None self._modified = None self._id = None self._flags = None @@ -102,18 +99,15 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self._z_index = None self._horizontal_alignment = None self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None self._rich_text = None if links is not None: self.links = links if contents is not None: self.contents = contents - if creation_date is not None: - self.creation_date = creation_date - if subject is not None: - self.subject = subject - if title is not None: - self.title = title if modified is not None: self.modified = modified if id is not None: @@ -132,6 +126,12 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.horizontal_alignment = horizontal_alignment if vertical_alignment is not None: self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title if rich_text is not None: self.rich_text = rich_text @@ -181,75 +181,6 @@ def contents(self, contents): self._contents = contents - @property - def creation_date(self): - """ - Gets the creation_date of this MarkupAnnotation. - The date and time when the annotation was created. - - :return: The creation_date of this MarkupAnnotation. - :rtype: str - """ - return self._creation_date - - @creation_date.setter - def creation_date(self, creation_date): - """ - Sets the creation_date of this MarkupAnnotation. - The date and time when the annotation was created. - - :param creation_date: The creation_date of this MarkupAnnotation. - :type: str - """ - - self._creation_date = creation_date - - @property - def subject(self): - """ - Gets the subject of this MarkupAnnotation. - Get the annotation subject. - - :return: The subject of this MarkupAnnotation. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this MarkupAnnotation. - Get the annotation subject. - - :param subject: The subject of this MarkupAnnotation. - :type: str - """ - - self._subject = subject - - @property - def title(self): - """ - Gets the title of this MarkupAnnotation. - Get the annotation title. - - :return: The title of this MarkupAnnotation. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this MarkupAnnotation. - Get the annotation title. - - :param title: The title of this MarkupAnnotation. - :type: str - """ - - self._title = title - @property def modified(self): """ @@ -457,6 +388,75 @@ def vertical_alignment(self, vertical_alignment): self._vertical_alignment = vertical_alignment + @property + def creation_date(self): + """ + Gets the creation_date of this MarkupAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this MarkupAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this MarkupAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this MarkupAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this MarkupAnnotation. + Get the annotation subject. + + :return: The subject of this MarkupAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this MarkupAnnotation. + Get the annotation subject. + + :param subject: The subject of this MarkupAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this MarkupAnnotation. + Get the annotation title. + + :return: The title of this MarkupAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this MarkupAnnotation. + Get the annotation title. + + :param title: The title of this MarkupAnnotation. + :type: str + """ + + self._title = title + @property def rich_text(self): """ diff --git a/asposepdfcloud/models/poly_annotation.py b/asposepdfcloud/models/poly_annotation.py index 19ee508..325bf80 100644 --- a/asposepdfcloud/models/poly_annotation.py +++ b/asposepdfcloud/models/poly_annotation.py @@ -50,9 +50,6 @@ class PolyAnnotation(object): swagger_types = { 'links': 'list[Link]', 'contents': 'str', - 'creation_date': 'str', - 'subject': 'str', - 'title': 'str', 'modified': 'str', 'id': 'str', 'flags': 'list[AnnotationFlags]', @@ -62,6 +59,9 @@ class PolyAnnotation(object): 'z_index': 'int', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', 'rich_text': 'str', 'interior_color': 'Color', 'starting_style': 'LineEnding', @@ -73,9 +73,6 @@ class PolyAnnotation(object): attribute_map = { 'links': 'Links', 'contents': 'Contents', - 'creation_date': 'CreationDate', - 'subject': 'Subject', - 'title': 'Title', 'modified': 'Modified', 'id': 'Id', 'flags': 'Flags', @@ -85,6 +82,9 @@ class PolyAnnotation(object): 'z_index': 'ZIndex', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', 'rich_text': 'RichText', 'interior_color': 'InteriorColor', 'starting_style': 'StartingStyle', @@ -93,16 +93,13 @@ class PolyAnnotation(object): 'vertices': 'Vertices' } - def __init__(self, links=None, contents=None, creation_date=None, subject=None, title=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, rich_text=None, interior_color=None, starting_style=None, ending_style=None, intent=None, vertices=None): + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, interior_color=None, starting_style=None, ending_style=None, intent=None, vertices=None): """ PolyAnnotation - a model defined in Swagger """ self._links = None self._contents = None - self._creation_date = None - self._subject = None - self._title = None self._modified = None self._id = None self._flags = None @@ -112,6 +109,9 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self._z_index = None self._horizontal_alignment = None self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None self._rich_text = None self._interior_color = None self._starting_style = None @@ -123,12 +123,6 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.links = links if contents is not None: self.contents = contents - if creation_date is not None: - self.creation_date = creation_date - if subject is not None: - self.subject = subject - if title is not None: - self.title = title if modified is not None: self.modified = modified if id is not None: @@ -147,6 +141,12 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.horizontal_alignment = horizontal_alignment if vertical_alignment is not None: self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title if rich_text is not None: self.rich_text = rich_text if interior_color is not None: @@ -206,75 +206,6 @@ def contents(self, contents): self._contents = contents - @property - def creation_date(self): - """ - Gets the creation_date of this PolyAnnotation. - The date and time when the annotation was created. - - :return: The creation_date of this PolyAnnotation. - :rtype: str - """ - return self._creation_date - - @creation_date.setter - def creation_date(self, creation_date): - """ - Sets the creation_date of this PolyAnnotation. - The date and time when the annotation was created. - - :param creation_date: The creation_date of this PolyAnnotation. - :type: str - """ - - self._creation_date = creation_date - - @property - def subject(self): - """ - Gets the subject of this PolyAnnotation. - Get the annotation subject. - - :return: The subject of this PolyAnnotation. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this PolyAnnotation. - Get the annotation subject. - - :param subject: The subject of this PolyAnnotation. - :type: str - """ - - self._subject = subject - - @property - def title(self): - """ - Gets the title of this PolyAnnotation. - Get the annotation title. - - :return: The title of this PolyAnnotation. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this PolyAnnotation. - Get the annotation title. - - :param title: The title of this PolyAnnotation. - :type: str - """ - - self._title = title - @property def modified(self): """ @@ -482,6 +413,75 @@ def vertical_alignment(self, vertical_alignment): self._vertical_alignment = vertical_alignment + @property + def creation_date(self): + """ + Gets the creation_date of this PolyAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this PolyAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this PolyAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this PolyAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this PolyAnnotation. + Get the annotation subject. + + :return: The subject of this PolyAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this PolyAnnotation. + Get the annotation subject. + + :param subject: The subject of this PolyAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this PolyAnnotation. + Get the annotation title. + + :return: The title of this PolyAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this PolyAnnotation. + Get the annotation title. + + :param title: The title of this PolyAnnotation. + :type: str + """ + + self._title = title + @property def rich_text(self): """ diff --git a/asposepdfcloud/models/poly_line_annotation.py b/asposepdfcloud/models/poly_line_annotation.py index 4caad45..7e60c5f 100644 --- a/asposepdfcloud/models/poly_line_annotation.py +++ b/asposepdfcloud/models/poly_line_annotation.py @@ -50,9 +50,6 @@ class PolyLineAnnotation(object): swagger_types = { 'links': 'list[Link]', 'contents': 'str', - 'creation_date': 'str', - 'subject': 'str', - 'title': 'str', 'modified': 'str', 'id': 'str', 'flags': 'list[AnnotationFlags]', @@ -62,6 +59,9 @@ class PolyLineAnnotation(object): 'z_index': 'int', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', 'rich_text': 'str', 'interior_color': 'Color', 'starting_style': 'LineEnding', @@ -74,9 +74,6 @@ class PolyLineAnnotation(object): attribute_map = { 'links': 'Links', 'contents': 'Contents', - 'creation_date': 'CreationDate', - 'subject': 'Subject', - 'title': 'Title', 'modified': 'Modified', 'id': 'Id', 'flags': 'Flags', @@ -86,6 +83,9 @@ class PolyLineAnnotation(object): 'z_index': 'ZIndex', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', 'rich_text': 'RichText', 'interior_color': 'InteriorColor', 'starting_style': 'StartingStyle', @@ -95,16 +95,13 @@ class PolyLineAnnotation(object): 'color': 'Color' } - def __init__(self, links=None, contents=None, creation_date=None, subject=None, title=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, rich_text=None, interior_color=None, starting_style=None, ending_style=None, intent=None, vertices=None, color=None): + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, interior_color=None, starting_style=None, ending_style=None, intent=None, vertices=None, color=None): """ PolyLineAnnotation - a model defined in Swagger """ self._links = None self._contents = None - self._creation_date = None - self._subject = None - self._title = None self._modified = None self._id = None self._flags = None @@ -114,6 +111,9 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self._z_index = None self._horizontal_alignment = None self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None self._rich_text = None self._interior_color = None self._starting_style = None @@ -126,12 +126,6 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.links = links if contents is not None: self.contents = contents - if creation_date is not None: - self.creation_date = creation_date - if subject is not None: - self.subject = subject - if title is not None: - self.title = title if modified is not None: self.modified = modified if id is not None: @@ -150,6 +144,12 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.horizontal_alignment = horizontal_alignment if vertical_alignment is not None: self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title if rich_text is not None: self.rich_text = rich_text if interior_color is not None: @@ -211,75 +211,6 @@ def contents(self, contents): self._contents = contents - @property - def creation_date(self): - """ - Gets the creation_date of this PolyLineAnnotation. - The date and time when the annotation was created. - - :return: The creation_date of this PolyLineAnnotation. - :rtype: str - """ - return self._creation_date - - @creation_date.setter - def creation_date(self, creation_date): - """ - Sets the creation_date of this PolyLineAnnotation. - The date and time when the annotation was created. - - :param creation_date: The creation_date of this PolyLineAnnotation. - :type: str - """ - - self._creation_date = creation_date - - @property - def subject(self): - """ - Gets the subject of this PolyLineAnnotation. - Get the annotation subject. - - :return: The subject of this PolyLineAnnotation. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this PolyLineAnnotation. - Get the annotation subject. - - :param subject: The subject of this PolyLineAnnotation. - :type: str - """ - - self._subject = subject - - @property - def title(self): - """ - Gets the title of this PolyLineAnnotation. - Get the annotation title. - - :return: The title of this PolyLineAnnotation. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this PolyLineAnnotation. - Get the annotation title. - - :param title: The title of this PolyLineAnnotation. - :type: str - """ - - self._title = title - @property def modified(self): """ @@ -487,6 +418,75 @@ def vertical_alignment(self, vertical_alignment): self._vertical_alignment = vertical_alignment + @property + def creation_date(self): + """ + Gets the creation_date of this PolyLineAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this PolyLineAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this PolyLineAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this PolyLineAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this PolyLineAnnotation. + Get the annotation subject. + + :return: The subject of this PolyLineAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this PolyLineAnnotation. + Get the annotation subject. + + :param subject: The subject of this PolyLineAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this PolyLineAnnotation. + Get the annotation title. + + :return: The title of this PolyLineAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this PolyLineAnnotation. + Get the annotation title. + + :param title: The title of this PolyLineAnnotation. + :type: str + """ + + self._title = title + @property def rich_text(self): """ diff --git a/asposepdfcloud/models/polygon_annotation.py b/asposepdfcloud/models/polygon_annotation.py index cccec73..3a424fe 100644 --- a/asposepdfcloud/models/polygon_annotation.py +++ b/asposepdfcloud/models/polygon_annotation.py @@ -50,9 +50,6 @@ class PolygonAnnotation(object): swagger_types = { 'links': 'list[Link]', 'contents': 'str', - 'creation_date': 'str', - 'subject': 'str', - 'title': 'str', 'modified': 'str', 'id': 'str', 'flags': 'list[AnnotationFlags]', @@ -62,6 +59,9 @@ class PolygonAnnotation(object): 'z_index': 'int', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', 'rich_text': 'str', 'interior_color': 'Color', 'starting_style': 'LineEnding', @@ -74,9 +74,6 @@ class PolygonAnnotation(object): attribute_map = { 'links': 'Links', 'contents': 'Contents', - 'creation_date': 'CreationDate', - 'subject': 'Subject', - 'title': 'Title', 'modified': 'Modified', 'id': 'Id', 'flags': 'Flags', @@ -86,6 +83,9 @@ class PolygonAnnotation(object): 'z_index': 'ZIndex', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', 'rich_text': 'RichText', 'interior_color': 'InteriorColor', 'starting_style': 'StartingStyle', @@ -95,16 +95,13 @@ class PolygonAnnotation(object): 'color': 'Color' } - def __init__(self, links=None, contents=None, creation_date=None, subject=None, title=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, rich_text=None, interior_color=None, starting_style=None, ending_style=None, intent=None, vertices=None, color=None): + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, interior_color=None, starting_style=None, ending_style=None, intent=None, vertices=None, color=None): """ PolygonAnnotation - a model defined in Swagger """ self._links = None self._contents = None - self._creation_date = None - self._subject = None - self._title = None self._modified = None self._id = None self._flags = None @@ -114,6 +111,9 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self._z_index = None self._horizontal_alignment = None self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None self._rich_text = None self._interior_color = None self._starting_style = None @@ -126,12 +126,6 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.links = links if contents is not None: self.contents = contents - if creation_date is not None: - self.creation_date = creation_date - if subject is not None: - self.subject = subject - if title is not None: - self.title = title if modified is not None: self.modified = modified if id is not None: @@ -150,6 +144,12 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.horizontal_alignment = horizontal_alignment if vertical_alignment is not None: self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title if rich_text is not None: self.rich_text = rich_text if interior_color is not None: @@ -211,75 +211,6 @@ def contents(self, contents): self._contents = contents - @property - def creation_date(self): - """ - Gets the creation_date of this PolygonAnnotation. - The date and time when the annotation was created. - - :return: The creation_date of this PolygonAnnotation. - :rtype: str - """ - return self._creation_date - - @creation_date.setter - def creation_date(self, creation_date): - """ - Sets the creation_date of this PolygonAnnotation. - The date and time when the annotation was created. - - :param creation_date: The creation_date of this PolygonAnnotation. - :type: str - """ - - self._creation_date = creation_date - - @property - def subject(self): - """ - Gets the subject of this PolygonAnnotation. - Get the annotation subject. - - :return: The subject of this PolygonAnnotation. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this PolygonAnnotation. - Get the annotation subject. - - :param subject: The subject of this PolygonAnnotation. - :type: str - """ - - self._subject = subject - - @property - def title(self): - """ - Gets the title of this PolygonAnnotation. - Get the annotation title. - - :return: The title of this PolygonAnnotation. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this PolygonAnnotation. - Get the annotation title. - - :param title: The title of this PolygonAnnotation. - :type: str - """ - - self._title = title - @property def modified(self): """ @@ -487,6 +418,75 @@ def vertical_alignment(self, vertical_alignment): self._vertical_alignment = vertical_alignment + @property + def creation_date(self): + """ + Gets the creation_date of this PolygonAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this PolygonAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this PolygonAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this PolygonAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this PolygonAnnotation. + Get the annotation subject. + + :return: The subject of this PolygonAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this PolygonAnnotation. + Get the annotation subject. + + :param subject: The subject of this PolygonAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this PolygonAnnotation. + Get the annotation title. + + :return: The title of this PolygonAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this PolygonAnnotation. + Get the annotation title. + + :param title: The title of this PolygonAnnotation. + :type: str + """ + + self._title = title + @property def rich_text(self): """ diff --git a/asposepdfcloud/models/popup_annotation.py b/asposepdfcloud/models/popup_annotation.py new file mode 100644 index 0000000..2f00878 --- /dev/null +++ b/asposepdfcloud/models/popup_annotation.py @@ -0,0 +1,478 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class PopupAnnotation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'contents': 'str', + 'modified': 'str', + 'id': 'str', + 'flags': 'list[AnnotationFlags]', + 'name': 'str', + 'rect': 'RectanglePdf', + 'page_index': 'int', + 'z_index': 'int', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'color': 'Color', + 'open': 'bool' + } + + attribute_map = { + 'links': 'Links', + 'contents': 'Contents', + 'modified': 'Modified', + 'id': 'Id', + 'flags': 'Flags', + 'name': 'Name', + 'rect': 'Rect', + 'page_index': 'PageIndex', + 'z_index': 'ZIndex', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'color': 'Color', + 'open': 'Open' + } + + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, color=None, open=None): + """ + PopupAnnotation - a model defined in Swagger + """ + + self._links = None + self._contents = None + self._modified = None + self._id = None + self._flags = None + self._name = None + self._rect = None + self._page_index = None + self._z_index = None + self._horizontal_alignment = None + self._vertical_alignment = None + self._color = None + self._open = None + + if links is not None: + self.links = links + if contents is not None: + self.contents = contents + if modified is not None: + self.modified = modified + if id is not None: + self.id = id + if flags is not None: + self.flags = flags + if name is not None: + self.name = name + if rect is not None: + self.rect = rect + if page_index is not None: + self.page_index = page_index + if z_index is not None: + self.z_index = z_index + if horizontal_alignment is not None: + self.horizontal_alignment = horizontal_alignment + if vertical_alignment is not None: + self.vertical_alignment = vertical_alignment + if color is not None: + self.color = color + if open is not None: + self.open = open + + @property + def links(self): + """ + Gets the links of this PopupAnnotation. + Link to the document. + + :return: The links of this PopupAnnotation. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this PopupAnnotation. + Link to the document. + + :param links: The links of this PopupAnnotation. + :type: list[Link] + """ + + self._links = links + + @property + def contents(self): + """ + Gets the contents of this PopupAnnotation. + Get the annotation content. + + :return: The contents of this PopupAnnotation. + :rtype: str + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this PopupAnnotation. + Get the annotation content. + + :param contents: The contents of this PopupAnnotation. + :type: str + """ + + self._contents = contents + + @property + def modified(self): + """ + Gets the modified of this PopupAnnotation. + The date and time when the annotation was last modified. + + :return: The modified of this PopupAnnotation. + :rtype: str + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this PopupAnnotation. + The date and time when the annotation was last modified. + + :param modified: The modified of this PopupAnnotation. + :type: str + """ + + self._modified = modified + + @property + def id(self): + """ + Gets the id of this PopupAnnotation. + Gets ID of the annotation. + + :return: The id of this PopupAnnotation. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this PopupAnnotation. + Gets ID of the annotation. + + :param id: The id of this PopupAnnotation. + :type: str + """ + + self._id = id + + @property + def flags(self): + """ + Gets the flags of this PopupAnnotation. + Gets Flags of the annotation. + + :return: The flags of this PopupAnnotation. + :rtype: list[AnnotationFlags] + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this PopupAnnotation. + Gets Flags of the annotation. + + :param flags: The flags of this PopupAnnotation. + :type: list[AnnotationFlags] + """ + + self._flags = flags + + @property + def name(self): + """ + Gets the name of this PopupAnnotation. + Gets Name of the annotation. + + :return: The name of this PopupAnnotation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this PopupAnnotation. + Gets Name of the annotation. + + :param name: The name of this PopupAnnotation. + :type: str + """ + + self._name = name + + @property + def rect(self): + """ + Gets the rect of this PopupAnnotation. + Gets Rect of the annotation. + + :return: The rect of this PopupAnnotation. + :rtype: RectanglePdf + """ + return self._rect + + @rect.setter + def rect(self, rect): + """ + Sets the rect of this PopupAnnotation. + Gets Rect of the annotation. + + :param rect: The rect of this PopupAnnotation. + :type: RectanglePdf + """ + + self._rect = rect + + @property + def page_index(self): + """ + Gets the page_index of this PopupAnnotation. + Gets PageIndex of the annotation. + + :return: The page_index of this PopupAnnotation. + :rtype: int + """ + return self._page_index + + @page_index.setter + def page_index(self, page_index): + """ + Sets the page_index of this PopupAnnotation. + Gets PageIndex of the annotation. + + :param page_index: The page_index of this PopupAnnotation. + :type: int + """ + + self._page_index = page_index + + @property + def z_index(self): + """ + Gets the z_index of this PopupAnnotation. + Gets ZIndex of the annotation. + + :return: The z_index of this PopupAnnotation. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this PopupAnnotation. + Gets ZIndex of the annotation. + + :param z_index: The z_index of this PopupAnnotation. + :type: int + """ + + self._z_index = z_index + + @property + def horizontal_alignment(self): + """ + Gets the horizontal_alignment of this PopupAnnotation. + Gets HorizontalAlignment of the annotation. + + :return: The horizontal_alignment of this PopupAnnotation. + :rtype: HorizontalAlignment + """ + return self._horizontal_alignment + + @horizontal_alignment.setter + def horizontal_alignment(self, horizontal_alignment): + """ + Sets the horizontal_alignment of this PopupAnnotation. + Gets HorizontalAlignment of the annotation. + + :param horizontal_alignment: The horizontal_alignment of this PopupAnnotation. + :type: HorizontalAlignment + """ + + self._horizontal_alignment = horizontal_alignment + + @property + def vertical_alignment(self): + """ + Gets the vertical_alignment of this PopupAnnotation. + Gets VerticalAlignment of the annotation. + + :return: The vertical_alignment of this PopupAnnotation. + :rtype: VerticalAlignment + """ + return self._vertical_alignment + + @vertical_alignment.setter + def vertical_alignment(self, vertical_alignment): + """ + Sets the vertical_alignment of this PopupAnnotation. + Gets VerticalAlignment of the annotation. + + :param vertical_alignment: The vertical_alignment of this PopupAnnotation. + :type: VerticalAlignment + """ + + self._vertical_alignment = vertical_alignment + + @property + def color(self): + """ + Gets the color of this PopupAnnotation. + Color of the annotation. + + :return: The color of this PopupAnnotation. + :rtype: Color + """ + return self._color + + @color.setter + def color(self, color): + """ + Sets the color of this PopupAnnotation. + Color of the annotation. + + :param color: The color of this PopupAnnotation. + :type: Color + """ + + self._color = color + + @property + def open(self): + """ + Gets the open of this PopupAnnotation. + Gets or sets a flag specifying whether the pop-up annotation should initially be displayed open. + + :return: The open of this PopupAnnotation. + :rtype: bool + """ + return self._open + + @open.setter + def open(self, open): + """ + Sets the open of this PopupAnnotation. + Gets or sets a flag specifying whether the pop-up annotation should initially be displayed open. + + :param open: The open of this PopupAnnotation. + :type: bool + """ + + self._open = open + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, PopupAnnotation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/popup_annotation_response.py b/asposepdfcloud/models/popup_annotation_response.py new file mode 100644 index 0000000..820efbd --- /dev/null +++ b/asposepdfcloud/models/popup_annotation_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class PopupAnnotationResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotation': 'PopupAnnotationWithParent' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotation': 'Annotation' + } + + def __init__(self, code=None, status=None, annotation=None): + """ + PopupAnnotationResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotation = None + + self.code = code + if status is not None: + self.status = status + if annotation is not None: + self.annotation = annotation + + @property + def code(self): + """ + Gets the code of this PopupAnnotationResponse. + Response status code. + + :return: The code of this PopupAnnotationResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this PopupAnnotationResponse. + Response status code. + + :param code: The code of this PopupAnnotationResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this PopupAnnotationResponse. + Response status. + + :return: The status of this PopupAnnotationResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this PopupAnnotationResponse. + Response status. + + :param status: The status of this PopupAnnotationResponse. + :type: str + """ + + self._status = status + + @property + def annotation(self): + """ + Gets the annotation of this PopupAnnotationResponse. + + :return: The annotation of this PopupAnnotationResponse. + :rtype: PopupAnnotationWithParent + """ + return self._annotation + + @annotation.setter + def annotation(self, annotation): + """ + Sets the annotation of this PopupAnnotationResponse. + + :param annotation: The annotation of this PopupAnnotationResponse. + :type: PopupAnnotationWithParent + """ + + self._annotation = annotation + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, PopupAnnotationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/popup_annotation_with_parent.py b/asposepdfcloud/models/popup_annotation_with_parent.py new file mode 100644 index 0000000..77a807c --- /dev/null +++ b/asposepdfcloud/models/popup_annotation_with_parent.py @@ -0,0 +1,506 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class PopupAnnotationWithParent(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'contents': 'str', + 'modified': 'str', + 'id': 'str', + 'flags': 'list[AnnotationFlags]', + 'name': 'str', + 'rect': 'RectanglePdf', + 'page_index': 'int', + 'z_index': 'int', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'color': 'Color', + 'open': 'bool', + 'parent': 'AnnotationInfo' + } + + attribute_map = { + 'links': 'Links', + 'contents': 'Contents', + 'modified': 'Modified', + 'id': 'Id', + 'flags': 'Flags', + 'name': 'Name', + 'rect': 'Rect', + 'page_index': 'PageIndex', + 'z_index': 'ZIndex', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'color': 'Color', + 'open': 'Open', + 'parent': 'Parent' + } + + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, color=None, open=None, parent=None): + """ + PopupAnnotationWithParent - a model defined in Swagger + """ + + self._links = None + self._contents = None + self._modified = None + self._id = None + self._flags = None + self._name = None + self._rect = None + self._page_index = None + self._z_index = None + self._horizontal_alignment = None + self._vertical_alignment = None + self._color = None + self._open = None + self._parent = None + + if links is not None: + self.links = links + if contents is not None: + self.contents = contents + if modified is not None: + self.modified = modified + if id is not None: + self.id = id + if flags is not None: + self.flags = flags + if name is not None: + self.name = name + if rect is not None: + self.rect = rect + if page_index is not None: + self.page_index = page_index + if z_index is not None: + self.z_index = z_index + if horizontal_alignment is not None: + self.horizontal_alignment = horizontal_alignment + if vertical_alignment is not None: + self.vertical_alignment = vertical_alignment + if color is not None: + self.color = color + if open is not None: + self.open = open + if parent is not None: + self.parent = parent + + @property + def links(self): + """ + Gets the links of this PopupAnnotationWithParent. + Link to the document. + + :return: The links of this PopupAnnotationWithParent. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this PopupAnnotationWithParent. + Link to the document. + + :param links: The links of this PopupAnnotationWithParent. + :type: list[Link] + """ + + self._links = links + + @property + def contents(self): + """ + Gets the contents of this PopupAnnotationWithParent. + Get the annotation content. + + :return: The contents of this PopupAnnotationWithParent. + :rtype: str + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this PopupAnnotationWithParent. + Get the annotation content. + + :param contents: The contents of this PopupAnnotationWithParent. + :type: str + """ + + self._contents = contents + + @property + def modified(self): + """ + Gets the modified of this PopupAnnotationWithParent. + The date and time when the annotation was last modified. + + :return: The modified of this PopupAnnotationWithParent. + :rtype: str + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this PopupAnnotationWithParent. + The date and time when the annotation was last modified. + + :param modified: The modified of this PopupAnnotationWithParent. + :type: str + """ + + self._modified = modified + + @property + def id(self): + """ + Gets the id of this PopupAnnotationWithParent. + Gets ID of the annotation. + + :return: The id of this PopupAnnotationWithParent. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this PopupAnnotationWithParent. + Gets ID of the annotation. + + :param id: The id of this PopupAnnotationWithParent. + :type: str + """ + + self._id = id + + @property + def flags(self): + """ + Gets the flags of this PopupAnnotationWithParent. + Gets Flags of the annotation. + + :return: The flags of this PopupAnnotationWithParent. + :rtype: list[AnnotationFlags] + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this PopupAnnotationWithParent. + Gets Flags of the annotation. + + :param flags: The flags of this PopupAnnotationWithParent. + :type: list[AnnotationFlags] + """ + + self._flags = flags + + @property + def name(self): + """ + Gets the name of this PopupAnnotationWithParent. + Gets Name of the annotation. + + :return: The name of this PopupAnnotationWithParent. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this PopupAnnotationWithParent. + Gets Name of the annotation. + + :param name: The name of this PopupAnnotationWithParent. + :type: str + """ + + self._name = name + + @property + def rect(self): + """ + Gets the rect of this PopupAnnotationWithParent. + Gets Rect of the annotation. + + :return: The rect of this PopupAnnotationWithParent. + :rtype: RectanglePdf + """ + return self._rect + + @rect.setter + def rect(self, rect): + """ + Sets the rect of this PopupAnnotationWithParent. + Gets Rect of the annotation. + + :param rect: The rect of this PopupAnnotationWithParent. + :type: RectanglePdf + """ + + self._rect = rect + + @property + def page_index(self): + """ + Gets the page_index of this PopupAnnotationWithParent. + Gets PageIndex of the annotation. + + :return: The page_index of this PopupAnnotationWithParent. + :rtype: int + """ + return self._page_index + + @page_index.setter + def page_index(self, page_index): + """ + Sets the page_index of this PopupAnnotationWithParent. + Gets PageIndex of the annotation. + + :param page_index: The page_index of this PopupAnnotationWithParent. + :type: int + """ + + self._page_index = page_index + + @property + def z_index(self): + """ + Gets the z_index of this PopupAnnotationWithParent. + Gets ZIndex of the annotation. + + :return: The z_index of this PopupAnnotationWithParent. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this PopupAnnotationWithParent. + Gets ZIndex of the annotation. + + :param z_index: The z_index of this PopupAnnotationWithParent. + :type: int + """ + + self._z_index = z_index + + @property + def horizontal_alignment(self): + """ + Gets the horizontal_alignment of this PopupAnnotationWithParent. + Gets HorizontalAlignment of the annotation. + + :return: The horizontal_alignment of this PopupAnnotationWithParent. + :rtype: HorizontalAlignment + """ + return self._horizontal_alignment + + @horizontal_alignment.setter + def horizontal_alignment(self, horizontal_alignment): + """ + Sets the horizontal_alignment of this PopupAnnotationWithParent. + Gets HorizontalAlignment of the annotation. + + :param horizontal_alignment: The horizontal_alignment of this PopupAnnotationWithParent. + :type: HorizontalAlignment + """ + + self._horizontal_alignment = horizontal_alignment + + @property + def vertical_alignment(self): + """ + Gets the vertical_alignment of this PopupAnnotationWithParent. + Gets VerticalAlignment of the annotation. + + :return: The vertical_alignment of this PopupAnnotationWithParent. + :rtype: VerticalAlignment + """ + return self._vertical_alignment + + @vertical_alignment.setter + def vertical_alignment(self, vertical_alignment): + """ + Sets the vertical_alignment of this PopupAnnotationWithParent. + Gets VerticalAlignment of the annotation. + + :param vertical_alignment: The vertical_alignment of this PopupAnnotationWithParent. + :type: VerticalAlignment + """ + + self._vertical_alignment = vertical_alignment + + @property + def color(self): + """ + Gets the color of this PopupAnnotationWithParent. + Color of the annotation. + + :return: The color of this PopupAnnotationWithParent. + :rtype: Color + """ + return self._color + + @color.setter + def color(self, color): + """ + Sets the color of this PopupAnnotationWithParent. + Color of the annotation. + + :param color: The color of this PopupAnnotationWithParent. + :type: Color + """ + + self._color = color + + @property + def open(self): + """ + Gets the open of this PopupAnnotationWithParent. + Gets or sets a flag specifying whether the pop-up annotation should initially be displayed open. + + :return: The open of this PopupAnnotationWithParent. + :rtype: bool + """ + return self._open + + @open.setter + def open(self, open): + """ + Sets the open of this PopupAnnotationWithParent. + Gets or sets a flag specifying whether the pop-up annotation should initially be displayed open. + + :param open: The open of this PopupAnnotationWithParent. + :type: bool + """ + + self._open = open + + @property + def parent(self): + """ + Gets the parent of this PopupAnnotationWithParent. + Parent of annotation. + + :return: The parent of this PopupAnnotationWithParent. + :rtype: AnnotationInfo + """ + return self._parent + + @parent.setter + def parent(self, parent): + """ + Sets the parent of this PopupAnnotationWithParent. + Parent of annotation. + + :param parent: The parent of this PopupAnnotationWithParent. + :type: AnnotationInfo + """ + + self._parent = parent + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, PopupAnnotationWithParent): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/popup_annotations.py b/asposepdfcloud/models/popup_annotations.py new file mode 100644 index 0000000..8e03ae6 --- /dev/null +++ b/asposepdfcloud/models/popup_annotations.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class PopupAnnotations(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'list': 'list[PopupAnnotationWithParent]' + } + + attribute_map = { + 'links': 'Links', + 'list': 'List' + } + + def __init__(self, links=None, list=None): + """ + PopupAnnotations - a model defined in Swagger + """ + + self._links = None + self._list = None + + if links is not None: + self.links = links + if list is not None: + self.list = list + + @property + def links(self): + """ + Gets the links of this PopupAnnotations. + Link to the document. + + :return: The links of this PopupAnnotations. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this PopupAnnotations. + Link to the document. + + :param links: The links of this PopupAnnotations. + :type: list[Link] + """ + + self._links = links + + @property + def list(self): + """ + Gets the list of this PopupAnnotations. + + :return: The list of this PopupAnnotations. + :rtype: list[PopupAnnotationWithParent] + """ + return self._list + + @list.setter + def list(self, list): + """ + Sets the list of this PopupAnnotations. + + :param list: The list of this PopupAnnotations. + :type: list[PopupAnnotationWithParent] + """ + + self._list = list + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, PopupAnnotations): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/popup_annotations_response.py b/asposepdfcloud/models/popup_annotations_response.py new file mode 100644 index 0000000..28b9c2a --- /dev/null +++ b/asposepdfcloud/models/popup_annotations_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class PopupAnnotationsResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotations': 'PopupAnnotations' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotations': 'Annotations' + } + + def __init__(self, code=None, status=None, annotations=None): + """ + PopupAnnotationsResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotations = None + + self.code = code + if status is not None: + self.status = status + if annotations is not None: + self.annotations = annotations + + @property + def code(self): + """ + Gets the code of this PopupAnnotationsResponse. + Response status code. + + :return: The code of this PopupAnnotationsResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this PopupAnnotationsResponse. + Response status code. + + :param code: The code of this PopupAnnotationsResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this PopupAnnotationsResponse. + Response status. + + :return: The status of this PopupAnnotationsResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this PopupAnnotationsResponse. + Response status. + + :param status: The status of this PopupAnnotationsResponse. + :type: str + """ + + self._status = status + + @property + def annotations(self): + """ + Gets the annotations of this PopupAnnotationsResponse. + + :return: The annotations of this PopupAnnotationsResponse. + :rtype: PopupAnnotations + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this PopupAnnotationsResponse. + + :param annotations: The annotations of this PopupAnnotationsResponse. + :type: PopupAnnotations + """ + + self._annotations = annotations + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, PopupAnnotationsResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/square_annotation.py b/asposepdfcloud/models/square_annotation.py index c1888fb..445b319 100644 --- a/asposepdfcloud/models/square_annotation.py +++ b/asposepdfcloud/models/square_annotation.py @@ -50,9 +50,6 @@ class SquareAnnotation(object): swagger_types = { 'links': 'list[Link]', 'contents': 'str', - 'creation_date': 'str', - 'subject': 'str', - 'title': 'str', 'modified': 'str', 'id': 'str', 'flags': 'list[AnnotationFlags]', @@ -62,6 +59,9 @@ class SquareAnnotation(object): 'z_index': 'int', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', 'rich_text': 'str', 'interior_color': 'Color', 'frame': 'RectanglePdf', @@ -71,9 +71,6 @@ class SquareAnnotation(object): attribute_map = { 'links': 'Links', 'contents': 'Contents', - 'creation_date': 'CreationDate', - 'subject': 'Subject', - 'title': 'Title', 'modified': 'Modified', 'id': 'Id', 'flags': 'Flags', @@ -83,22 +80,22 @@ class SquareAnnotation(object): 'z_index': 'ZIndex', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', 'rich_text': 'RichText', 'interior_color': 'InteriorColor', 'frame': 'Frame', 'color': 'Color' } - def __init__(self, links=None, contents=None, creation_date=None, subject=None, title=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, rich_text=None, interior_color=None, frame=None, color=None): + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, interior_color=None, frame=None, color=None): """ SquareAnnotation - a model defined in Swagger """ self._links = None self._contents = None - self._creation_date = None - self._subject = None - self._title = None self._modified = None self._id = None self._flags = None @@ -108,6 +105,9 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self._z_index = None self._horizontal_alignment = None self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None self._rich_text = None self._interior_color = None self._frame = None @@ -117,12 +117,6 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.links = links if contents is not None: self.contents = contents - if creation_date is not None: - self.creation_date = creation_date - if subject is not None: - self.subject = subject - if title is not None: - self.title = title if modified is not None: self.modified = modified if id is not None: @@ -141,6 +135,12 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.horizontal_alignment = horizontal_alignment if vertical_alignment is not None: self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title if rich_text is not None: self.rich_text = rich_text if interior_color is not None: @@ -196,75 +196,6 @@ def contents(self, contents): self._contents = contents - @property - def creation_date(self): - """ - Gets the creation_date of this SquareAnnotation. - The date and time when the annotation was created. - - :return: The creation_date of this SquareAnnotation. - :rtype: str - """ - return self._creation_date - - @creation_date.setter - def creation_date(self, creation_date): - """ - Sets the creation_date of this SquareAnnotation. - The date and time when the annotation was created. - - :param creation_date: The creation_date of this SquareAnnotation. - :type: str - """ - - self._creation_date = creation_date - - @property - def subject(self): - """ - Gets the subject of this SquareAnnotation. - Get the annotation subject. - - :return: The subject of this SquareAnnotation. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this SquareAnnotation. - Get the annotation subject. - - :param subject: The subject of this SquareAnnotation. - :type: str - """ - - self._subject = subject - - @property - def title(self): - """ - Gets the title of this SquareAnnotation. - Get the annotation title. - - :return: The title of this SquareAnnotation. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this SquareAnnotation. - Get the annotation title. - - :param title: The title of this SquareAnnotation. - :type: str - """ - - self._title = title - @property def modified(self): """ @@ -472,6 +403,75 @@ def vertical_alignment(self, vertical_alignment): self._vertical_alignment = vertical_alignment + @property + def creation_date(self): + """ + Gets the creation_date of this SquareAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this SquareAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this SquareAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this SquareAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this SquareAnnotation. + Get the annotation subject. + + :return: The subject of this SquareAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this SquareAnnotation. + Get the annotation subject. + + :param subject: The subject of this SquareAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this SquareAnnotation. + Get the annotation title. + + :return: The title of this SquareAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this SquareAnnotation. + Get the annotation title. + + :param title: The title of this SquareAnnotation. + :type: str + """ + + self._title = title + @property def rich_text(self): """ diff --git a/asposepdfcloud/models/squiggly_annotation.py b/asposepdfcloud/models/squiggly_annotation.py new file mode 100644 index 0000000..323dc1c --- /dev/null +++ b/asposepdfcloud/models/squiggly_annotation.py @@ -0,0 +1,590 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class SquigglyAnnotation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'contents': 'str', + 'modified': 'str', + 'id': 'str', + 'flags': 'list[AnnotationFlags]', + 'name': 'str', + 'rect': 'RectanglePdf', + 'page_index': 'int', + 'z_index': 'int', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', + 'rich_text': 'str', + 'color': 'Color', + 'quad_points': 'list[Point]' + } + + attribute_map = { + 'links': 'Links', + 'contents': 'Contents', + 'modified': 'Modified', + 'id': 'Id', + 'flags': 'Flags', + 'name': 'Name', + 'rect': 'Rect', + 'page_index': 'PageIndex', + 'z_index': 'ZIndex', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', + 'rich_text': 'RichText', + 'color': 'Color', + 'quad_points': 'QuadPoints' + } + + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, color=None, quad_points=None): + """ + SquigglyAnnotation - a model defined in Swagger + """ + + self._links = None + self._contents = None + self._modified = None + self._id = None + self._flags = None + self._name = None + self._rect = None + self._page_index = None + self._z_index = None + self._horizontal_alignment = None + self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None + self._rich_text = None + self._color = None + self._quad_points = None + + if links is not None: + self.links = links + if contents is not None: + self.contents = contents + if modified is not None: + self.modified = modified + if id is not None: + self.id = id + if flags is not None: + self.flags = flags + if name is not None: + self.name = name + if rect is not None: + self.rect = rect + if page_index is not None: + self.page_index = page_index + if z_index is not None: + self.z_index = z_index + if horizontal_alignment is not None: + self.horizontal_alignment = horizontal_alignment + if vertical_alignment is not None: + self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title + if rich_text is not None: + self.rich_text = rich_text + if color is not None: + self.color = color + if quad_points is not None: + self.quad_points = quad_points + + @property + def links(self): + """ + Gets the links of this SquigglyAnnotation. + Link to the document. + + :return: The links of this SquigglyAnnotation. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this SquigglyAnnotation. + Link to the document. + + :param links: The links of this SquigglyAnnotation. + :type: list[Link] + """ + + self._links = links + + @property + def contents(self): + """ + Gets the contents of this SquigglyAnnotation. + Get the annotation content. + + :return: The contents of this SquigglyAnnotation. + :rtype: str + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this SquigglyAnnotation. + Get the annotation content. + + :param contents: The contents of this SquigglyAnnotation. + :type: str + """ + + self._contents = contents + + @property + def modified(self): + """ + Gets the modified of this SquigglyAnnotation. + The date and time when the annotation was last modified. + + :return: The modified of this SquigglyAnnotation. + :rtype: str + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this SquigglyAnnotation. + The date and time when the annotation was last modified. + + :param modified: The modified of this SquigglyAnnotation. + :type: str + """ + + self._modified = modified + + @property + def id(self): + """ + Gets the id of this SquigglyAnnotation. + Gets ID of the annotation. + + :return: The id of this SquigglyAnnotation. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this SquigglyAnnotation. + Gets ID of the annotation. + + :param id: The id of this SquigglyAnnotation. + :type: str + """ + + self._id = id + + @property + def flags(self): + """ + Gets the flags of this SquigglyAnnotation. + Gets Flags of the annotation. + + :return: The flags of this SquigglyAnnotation. + :rtype: list[AnnotationFlags] + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this SquigglyAnnotation. + Gets Flags of the annotation. + + :param flags: The flags of this SquigglyAnnotation. + :type: list[AnnotationFlags] + """ + + self._flags = flags + + @property + def name(self): + """ + Gets the name of this SquigglyAnnotation. + Gets Name of the annotation. + + :return: The name of this SquigglyAnnotation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this SquigglyAnnotation. + Gets Name of the annotation. + + :param name: The name of this SquigglyAnnotation. + :type: str + """ + + self._name = name + + @property + def rect(self): + """ + Gets the rect of this SquigglyAnnotation. + Gets Rect of the annotation. + + :return: The rect of this SquigglyAnnotation. + :rtype: RectanglePdf + """ + return self._rect + + @rect.setter + def rect(self, rect): + """ + Sets the rect of this SquigglyAnnotation. + Gets Rect of the annotation. + + :param rect: The rect of this SquigglyAnnotation. + :type: RectanglePdf + """ + + self._rect = rect + + @property + def page_index(self): + """ + Gets the page_index of this SquigglyAnnotation. + Gets PageIndex of the annotation. + + :return: The page_index of this SquigglyAnnotation. + :rtype: int + """ + return self._page_index + + @page_index.setter + def page_index(self, page_index): + """ + Sets the page_index of this SquigglyAnnotation. + Gets PageIndex of the annotation. + + :param page_index: The page_index of this SquigglyAnnotation. + :type: int + """ + + self._page_index = page_index + + @property + def z_index(self): + """ + Gets the z_index of this SquigglyAnnotation. + Gets ZIndex of the annotation. + + :return: The z_index of this SquigglyAnnotation. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this SquigglyAnnotation. + Gets ZIndex of the annotation. + + :param z_index: The z_index of this SquigglyAnnotation. + :type: int + """ + + self._z_index = z_index + + @property + def horizontal_alignment(self): + """ + Gets the horizontal_alignment of this SquigglyAnnotation. + Gets HorizontalAlignment of the annotation. + + :return: The horizontal_alignment of this SquigglyAnnotation. + :rtype: HorizontalAlignment + """ + return self._horizontal_alignment + + @horizontal_alignment.setter + def horizontal_alignment(self, horizontal_alignment): + """ + Sets the horizontal_alignment of this SquigglyAnnotation. + Gets HorizontalAlignment of the annotation. + + :param horizontal_alignment: The horizontal_alignment of this SquigglyAnnotation. + :type: HorizontalAlignment + """ + + self._horizontal_alignment = horizontal_alignment + + @property + def vertical_alignment(self): + """ + Gets the vertical_alignment of this SquigglyAnnotation. + Gets VerticalAlignment of the annotation. + + :return: The vertical_alignment of this SquigglyAnnotation. + :rtype: VerticalAlignment + """ + return self._vertical_alignment + + @vertical_alignment.setter + def vertical_alignment(self, vertical_alignment): + """ + Sets the vertical_alignment of this SquigglyAnnotation. + Gets VerticalAlignment of the annotation. + + :param vertical_alignment: The vertical_alignment of this SquigglyAnnotation. + :type: VerticalAlignment + """ + + self._vertical_alignment = vertical_alignment + + @property + def creation_date(self): + """ + Gets the creation_date of this SquigglyAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this SquigglyAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this SquigglyAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this SquigglyAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this SquigglyAnnotation. + Get the annotation subject. + + :return: The subject of this SquigglyAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this SquigglyAnnotation. + Get the annotation subject. + + :param subject: The subject of this SquigglyAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this SquigglyAnnotation. + Get the annotation title. + + :return: The title of this SquigglyAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this SquigglyAnnotation. + Get the annotation title. + + :param title: The title of this SquigglyAnnotation. + :type: str + """ + + self._title = title + + @property + def rich_text(self): + """ + Gets the rich_text of this SquigglyAnnotation. + Get the annotation RichText. + + :return: The rich_text of this SquigglyAnnotation. + :rtype: str + """ + return self._rich_text + + @rich_text.setter + def rich_text(self, rich_text): + """ + Sets the rich_text of this SquigglyAnnotation. + Get the annotation RichText. + + :param rich_text: The rich_text of this SquigglyAnnotation. + :type: str + """ + + self._rich_text = rich_text + + @property + def color(self): + """ + Gets the color of this SquigglyAnnotation. + Color of the annotation. + + :return: The color of this SquigglyAnnotation. + :rtype: Color + """ + return self._color + + @color.setter + def color(self, color): + """ + Sets the color of this SquigglyAnnotation. + Color of the annotation. + + :param color: The color of this SquigglyAnnotation. + :type: Color + """ + + self._color = color + + @property + def quad_points(self): + """ + Gets the quad_points of this SquigglyAnnotation. + 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. + + :return: The quad_points of this SquigglyAnnotation. + :rtype: list[Point] + """ + return self._quad_points + + @quad_points.setter + def quad_points(self, quad_points): + """ + Sets the quad_points of this SquigglyAnnotation. + 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. + + :param quad_points: The quad_points of this SquigglyAnnotation. + :type: list[Point] + """ + + self._quad_points = quad_points + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, SquigglyAnnotation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/squiggly_annotation_response.py b/asposepdfcloud/models/squiggly_annotation_response.py new file mode 100644 index 0000000..f5e42fc --- /dev/null +++ b/asposepdfcloud/models/squiggly_annotation_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class SquigglyAnnotationResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotation': 'SquigglyAnnotation' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotation': 'Annotation' + } + + def __init__(self, code=None, status=None, annotation=None): + """ + SquigglyAnnotationResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotation = None + + self.code = code + if status is not None: + self.status = status + if annotation is not None: + self.annotation = annotation + + @property + def code(self): + """ + Gets the code of this SquigglyAnnotationResponse. + Response status code. + + :return: The code of this SquigglyAnnotationResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this SquigglyAnnotationResponse. + Response status code. + + :param code: The code of this SquigglyAnnotationResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this SquigglyAnnotationResponse. + Response status. + + :return: The status of this SquigglyAnnotationResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this SquigglyAnnotationResponse. + Response status. + + :param status: The status of this SquigglyAnnotationResponse. + :type: str + """ + + self._status = status + + @property + def annotation(self): + """ + Gets the annotation of this SquigglyAnnotationResponse. + + :return: The annotation of this SquigglyAnnotationResponse. + :rtype: SquigglyAnnotation + """ + return self._annotation + + @annotation.setter + def annotation(self, annotation): + """ + Sets the annotation of this SquigglyAnnotationResponse. + + :param annotation: The annotation of this SquigglyAnnotationResponse. + :type: SquigglyAnnotation + """ + + self._annotation = annotation + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, SquigglyAnnotationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/squiggly_annotations.py b/asposepdfcloud/models/squiggly_annotations.py new file mode 100644 index 0000000..5e5892a --- /dev/null +++ b/asposepdfcloud/models/squiggly_annotations.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class SquigglyAnnotations(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'list': 'list[SquigglyAnnotation]' + } + + attribute_map = { + 'links': 'Links', + 'list': 'List' + } + + def __init__(self, links=None, list=None): + """ + SquigglyAnnotations - a model defined in Swagger + """ + + self._links = None + self._list = None + + if links is not None: + self.links = links + if list is not None: + self.list = list + + @property + def links(self): + """ + Gets the links of this SquigglyAnnotations. + Link to the document. + + :return: The links of this SquigglyAnnotations. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this SquigglyAnnotations. + Link to the document. + + :param links: The links of this SquigglyAnnotations. + :type: list[Link] + """ + + self._links = links + + @property + def list(self): + """ + Gets the list of this SquigglyAnnotations. + + :return: The list of this SquigglyAnnotations. + :rtype: list[SquigglyAnnotation] + """ + return self._list + + @list.setter + def list(self, list): + """ + Sets the list of this SquigglyAnnotations. + + :param list: The list of this SquigglyAnnotations. + :type: list[SquigglyAnnotation] + """ + + self._list = list + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, SquigglyAnnotations): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/squiggly_annotations_response.py b/asposepdfcloud/models/squiggly_annotations_response.py new file mode 100644 index 0000000..b1f16ec --- /dev/null +++ b/asposepdfcloud/models/squiggly_annotations_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class SquigglyAnnotationsResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotations': 'SquigglyAnnotations' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotations': 'Annotations' + } + + def __init__(self, code=None, status=None, annotations=None): + """ + SquigglyAnnotationsResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotations = None + + self.code = code + if status is not None: + self.status = status + if annotations is not None: + self.annotations = annotations + + @property + def code(self): + """ + Gets the code of this SquigglyAnnotationsResponse. + Response status code. + + :return: The code of this SquigglyAnnotationsResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this SquigglyAnnotationsResponse. + Response status code. + + :param code: The code of this SquigglyAnnotationsResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this SquigglyAnnotationsResponse. + Response status. + + :return: The status of this SquigglyAnnotationsResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this SquigglyAnnotationsResponse. + Response status. + + :param status: The status of this SquigglyAnnotationsResponse. + :type: str + """ + + self._status = status + + @property + def annotations(self): + """ + Gets the annotations of this SquigglyAnnotationsResponse. + + :return: The annotations of this SquigglyAnnotationsResponse. + :rtype: SquigglyAnnotations + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this SquigglyAnnotationsResponse. + + :param annotations: The annotations of this SquigglyAnnotationsResponse. + :type: SquigglyAnnotations + """ + + self._annotations = annotations + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, SquigglyAnnotationsResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/strike_out_annotation.py b/asposepdfcloud/models/strike_out_annotation.py new file mode 100644 index 0000000..29f87c0 --- /dev/null +++ b/asposepdfcloud/models/strike_out_annotation.py @@ -0,0 +1,590 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class StrikeOutAnnotation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'contents': 'str', + 'modified': 'str', + 'id': 'str', + 'flags': 'list[AnnotationFlags]', + 'name': 'str', + 'rect': 'RectanglePdf', + 'page_index': 'int', + 'z_index': 'int', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', + 'rich_text': 'str', + 'color': 'Color', + 'quad_points': 'list[Point]' + } + + attribute_map = { + 'links': 'Links', + 'contents': 'Contents', + 'modified': 'Modified', + 'id': 'Id', + 'flags': 'Flags', + 'name': 'Name', + 'rect': 'Rect', + 'page_index': 'PageIndex', + 'z_index': 'ZIndex', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', + 'rich_text': 'RichText', + 'color': 'Color', + 'quad_points': 'QuadPoints' + } + + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, color=None, quad_points=None): + """ + StrikeOutAnnotation - a model defined in Swagger + """ + + self._links = None + self._contents = None + self._modified = None + self._id = None + self._flags = None + self._name = None + self._rect = None + self._page_index = None + self._z_index = None + self._horizontal_alignment = None + self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None + self._rich_text = None + self._color = None + self._quad_points = None + + if links is not None: + self.links = links + if contents is not None: + self.contents = contents + if modified is not None: + self.modified = modified + if id is not None: + self.id = id + if flags is not None: + self.flags = flags + if name is not None: + self.name = name + if rect is not None: + self.rect = rect + if page_index is not None: + self.page_index = page_index + if z_index is not None: + self.z_index = z_index + if horizontal_alignment is not None: + self.horizontal_alignment = horizontal_alignment + if vertical_alignment is not None: + self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title + if rich_text is not None: + self.rich_text = rich_text + if color is not None: + self.color = color + if quad_points is not None: + self.quad_points = quad_points + + @property + def links(self): + """ + Gets the links of this StrikeOutAnnotation. + Link to the document. + + :return: The links of this StrikeOutAnnotation. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this StrikeOutAnnotation. + Link to the document. + + :param links: The links of this StrikeOutAnnotation. + :type: list[Link] + """ + + self._links = links + + @property + def contents(self): + """ + Gets the contents of this StrikeOutAnnotation. + Get the annotation content. + + :return: The contents of this StrikeOutAnnotation. + :rtype: str + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this StrikeOutAnnotation. + Get the annotation content. + + :param contents: The contents of this StrikeOutAnnotation. + :type: str + """ + + self._contents = contents + + @property + def modified(self): + """ + Gets the modified of this StrikeOutAnnotation. + The date and time when the annotation was last modified. + + :return: The modified of this StrikeOutAnnotation. + :rtype: str + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this StrikeOutAnnotation. + The date and time when the annotation was last modified. + + :param modified: The modified of this StrikeOutAnnotation. + :type: str + """ + + self._modified = modified + + @property + def id(self): + """ + Gets the id of this StrikeOutAnnotation. + Gets ID of the annotation. + + :return: The id of this StrikeOutAnnotation. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this StrikeOutAnnotation. + Gets ID of the annotation. + + :param id: The id of this StrikeOutAnnotation. + :type: str + """ + + self._id = id + + @property + def flags(self): + """ + Gets the flags of this StrikeOutAnnotation. + Gets Flags of the annotation. + + :return: The flags of this StrikeOutAnnotation. + :rtype: list[AnnotationFlags] + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this StrikeOutAnnotation. + Gets Flags of the annotation. + + :param flags: The flags of this StrikeOutAnnotation. + :type: list[AnnotationFlags] + """ + + self._flags = flags + + @property + def name(self): + """ + Gets the name of this StrikeOutAnnotation. + Gets Name of the annotation. + + :return: The name of this StrikeOutAnnotation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this StrikeOutAnnotation. + Gets Name of the annotation. + + :param name: The name of this StrikeOutAnnotation. + :type: str + """ + + self._name = name + + @property + def rect(self): + """ + Gets the rect of this StrikeOutAnnotation. + Gets Rect of the annotation. + + :return: The rect of this StrikeOutAnnotation. + :rtype: RectanglePdf + """ + return self._rect + + @rect.setter + def rect(self, rect): + """ + Sets the rect of this StrikeOutAnnotation. + Gets Rect of the annotation. + + :param rect: The rect of this StrikeOutAnnotation. + :type: RectanglePdf + """ + + self._rect = rect + + @property + def page_index(self): + """ + Gets the page_index of this StrikeOutAnnotation. + Gets PageIndex of the annotation. + + :return: The page_index of this StrikeOutAnnotation. + :rtype: int + """ + return self._page_index + + @page_index.setter + def page_index(self, page_index): + """ + Sets the page_index of this StrikeOutAnnotation. + Gets PageIndex of the annotation. + + :param page_index: The page_index of this StrikeOutAnnotation. + :type: int + """ + + self._page_index = page_index + + @property + def z_index(self): + """ + Gets the z_index of this StrikeOutAnnotation. + Gets ZIndex of the annotation. + + :return: The z_index of this StrikeOutAnnotation. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this StrikeOutAnnotation. + Gets ZIndex of the annotation. + + :param z_index: The z_index of this StrikeOutAnnotation. + :type: int + """ + + self._z_index = z_index + + @property + def horizontal_alignment(self): + """ + Gets the horizontal_alignment of this StrikeOutAnnotation. + Gets HorizontalAlignment of the annotation. + + :return: The horizontal_alignment of this StrikeOutAnnotation. + :rtype: HorizontalAlignment + """ + return self._horizontal_alignment + + @horizontal_alignment.setter + def horizontal_alignment(self, horizontal_alignment): + """ + Sets the horizontal_alignment of this StrikeOutAnnotation. + Gets HorizontalAlignment of the annotation. + + :param horizontal_alignment: The horizontal_alignment of this StrikeOutAnnotation. + :type: HorizontalAlignment + """ + + self._horizontal_alignment = horizontal_alignment + + @property + def vertical_alignment(self): + """ + Gets the vertical_alignment of this StrikeOutAnnotation. + Gets VerticalAlignment of the annotation. + + :return: The vertical_alignment of this StrikeOutAnnotation. + :rtype: VerticalAlignment + """ + return self._vertical_alignment + + @vertical_alignment.setter + def vertical_alignment(self, vertical_alignment): + """ + Sets the vertical_alignment of this StrikeOutAnnotation. + Gets VerticalAlignment of the annotation. + + :param vertical_alignment: The vertical_alignment of this StrikeOutAnnotation. + :type: VerticalAlignment + """ + + self._vertical_alignment = vertical_alignment + + @property + def creation_date(self): + """ + Gets the creation_date of this StrikeOutAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this StrikeOutAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this StrikeOutAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this StrikeOutAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this StrikeOutAnnotation. + Get the annotation subject. + + :return: The subject of this StrikeOutAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this StrikeOutAnnotation. + Get the annotation subject. + + :param subject: The subject of this StrikeOutAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this StrikeOutAnnotation. + Get the annotation title. + + :return: The title of this StrikeOutAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this StrikeOutAnnotation. + Get the annotation title. + + :param title: The title of this StrikeOutAnnotation. + :type: str + """ + + self._title = title + + @property + def rich_text(self): + """ + Gets the rich_text of this StrikeOutAnnotation. + Get the annotation RichText. + + :return: The rich_text of this StrikeOutAnnotation. + :rtype: str + """ + return self._rich_text + + @rich_text.setter + def rich_text(self, rich_text): + """ + Sets the rich_text of this StrikeOutAnnotation. + Get the annotation RichText. + + :param rich_text: The rich_text of this StrikeOutAnnotation. + :type: str + """ + + self._rich_text = rich_text + + @property + def color(self): + """ + Gets the color of this StrikeOutAnnotation. + Color of the annotation. + + :return: The color of this StrikeOutAnnotation. + :rtype: Color + """ + return self._color + + @color.setter + def color(self, color): + """ + Sets the color of this StrikeOutAnnotation. + Color of the annotation. + + :param color: The color of this StrikeOutAnnotation. + :type: Color + """ + + self._color = color + + @property + def quad_points(self): + """ + Gets the quad_points of this StrikeOutAnnotation. + 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. + + :return: The quad_points of this StrikeOutAnnotation. + :rtype: list[Point] + """ + return self._quad_points + + @quad_points.setter + def quad_points(self, quad_points): + """ + Sets the quad_points of this StrikeOutAnnotation. + 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. + + :param quad_points: The quad_points of this StrikeOutAnnotation. + :type: list[Point] + """ + + self._quad_points = quad_points + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, StrikeOutAnnotation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/strike_out_annotation_response.py b/asposepdfcloud/models/strike_out_annotation_response.py new file mode 100644 index 0000000..016cb8d --- /dev/null +++ b/asposepdfcloud/models/strike_out_annotation_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class StrikeOutAnnotationResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotation': 'StrikeOutAnnotation' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotation': 'Annotation' + } + + def __init__(self, code=None, status=None, annotation=None): + """ + StrikeOutAnnotationResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotation = None + + self.code = code + if status is not None: + self.status = status + if annotation is not None: + self.annotation = annotation + + @property + def code(self): + """ + Gets the code of this StrikeOutAnnotationResponse. + Response status code. + + :return: The code of this StrikeOutAnnotationResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this StrikeOutAnnotationResponse. + Response status code. + + :param code: The code of this StrikeOutAnnotationResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this StrikeOutAnnotationResponse. + Response status. + + :return: The status of this StrikeOutAnnotationResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this StrikeOutAnnotationResponse. + Response status. + + :param status: The status of this StrikeOutAnnotationResponse. + :type: str + """ + + self._status = status + + @property + def annotation(self): + """ + Gets the annotation of this StrikeOutAnnotationResponse. + + :return: The annotation of this StrikeOutAnnotationResponse. + :rtype: StrikeOutAnnotation + """ + return self._annotation + + @annotation.setter + def annotation(self, annotation): + """ + Sets the annotation of this StrikeOutAnnotationResponse. + + :param annotation: The annotation of this StrikeOutAnnotationResponse. + :type: StrikeOutAnnotation + """ + + self._annotation = annotation + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, StrikeOutAnnotationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/strike_out_annotations.py b/asposepdfcloud/models/strike_out_annotations.py new file mode 100644 index 0000000..8b1d7bb --- /dev/null +++ b/asposepdfcloud/models/strike_out_annotations.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class StrikeOutAnnotations(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'list': 'list[StrikeOutAnnotation]' + } + + attribute_map = { + 'links': 'Links', + 'list': 'List' + } + + def __init__(self, links=None, list=None): + """ + StrikeOutAnnotations - a model defined in Swagger + """ + + self._links = None + self._list = None + + if links is not None: + self.links = links + if list is not None: + self.list = list + + @property + def links(self): + """ + Gets the links of this StrikeOutAnnotations. + Link to the document. + + :return: The links of this StrikeOutAnnotations. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this StrikeOutAnnotations. + Link to the document. + + :param links: The links of this StrikeOutAnnotations. + :type: list[Link] + """ + + self._links = links + + @property + def list(self): + """ + Gets the list of this StrikeOutAnnotations. + + :return: The list of this StrikeOutAnnotations. + :rtype: list[StrikeOutAnnotation] + """ + return self._list + + @list.setter + def list(self, list): + """ + Sets the list of this StrikeOutAnnotations. + + :param list: The list of this StrikeOutAnnotations. + :type: list[StrikeOutAnnotation] + """ + + self._list = list + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, StrikeOutAnnotations): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/strike_out_annotations_response.py b/asposepdfcloud/models/strike_out_annotations_response.py new file mode 100644 index 0000000..1e3e4e9 --- /dev/null +++ b/asposepdfcloud/models/strike_out_annotations_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class StrikeOutAnnotationsResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotations': 'StrikeOutAnnotations' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotations': 'Annotations' + } + + def __init__(self, code=None, status=None, annotations=None): + """ + StrikeOutAnnotationsResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotations = None + + self.code = code + if status is not None: + self.status = status + if annotations is not None: + self.annotations = annotations + + @property + def code(self): + """ + Gets the code of this StrikeOutAnnotationsResponse. + Response status code. + + :return: The code of this StrikeOutAnnotationsResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this StrikeOutAnnotationsResponse. + Response status code. + + :param code: The code of this StrikeOutAnnotationsResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this StrikeOutAnnotationsResponse. + Response status. + + :return: The status of this StrikeOutAnnotationsResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this StrikeOutAnnotationsResponse. + Response status. + + :param status: The status of this StrikeOutAnnotationsResponse. + :type: str + """ + + self._status = status + + @property + def annotations(self): + """ + Gets the annotations of this StrikeOutAnnotationsResponse. + + :return: The annotations of this StrikeOutAnnotationsResponse. + :rtype: StrikeOutAnnotations + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this StrikeOutAnnotationsResponse. + + :param annotations: The annotations of this StrikeOutAnnotationsResponse. + :type: StrikeOutAnnotations + """ + + self._annotations = annotations + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, StrikeOutAnnotationsResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/text_annotation.py b/asposepdfcloud/models/text_annotation.py index 1c89105..5e10bff 100644 --- a/asposepdfcloud/models/text_annotation.py +++ b/asposepdfcloud/models/text_annotation.py @@ -50,9 +50,6 @@ class TextAnnotation(object): swagger_types = { 'links': 'list[Link]', 'contents': 'str', - 'creation_date': 'str', - 'subject': 'str', - 'title': 'str', 'modified': 'str', 'id': 'str', 'flags': 'list[AnnotationFlags]', @@ -62,6 +59,9 @@ class TextAnnotation(object): 'z_index': 'int', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', 'rich_text': 'str', 'state': 'AnnotationState', 'open': 'bool', @@ -72,9 +72,6 @@ class TextAnnotation(object): attribute_map = { 'links': 'Links', 'contents': 'Contents', - 'creation_date': 'CreationDate', - 'subject': 'Subject', - 'title': 'Title', 'modified': 'Modified', 'id': 'Id', 'flags': 'Flags', @@ -84,6 +81,9 @@ class TextAnnotation(object): 'z_index': 'ZIndex', 'horizontal_alignment': 'HorizontalAlignment', 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', 'rich_text': 'RichText', 'state': 'State', 'open': 'Open', @@ -91,16 +91,13 @@ class TextAnnotation(object): 'icon': 'Icon' } - def __init__(self, links=None, contents=None, creation_date=None, subject=None, title=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, rich_text=None, state=None, open=None, color=None, icon=None): + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, state=None, open=None, color=None, icon=None): """ TextAnnotation - a model defined in Swagger """ self._links = None self._contents = None - self._creation_date = None - self._subject = None - self._title = None self._modified = None self._id = None self._flags = None @@ -110,6 +107,9 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self._z_index = None self._horizontal_alignment = None self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None self._rich_text = None self._state = None self._open = None @@ -120,12 +120,6 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.links = links if contents is not None: self.contents = contents - if creation_date is not None: - self.creation_date = creation_date - if subject is not None: - self.subject = subject - if title is not None: - self.title = title if modified is not None: self.modified = modified if id is not None: @@ -144,6 +138,12 @@ def __init__(self, links=None, contents=None, creation_date=None, subject=None, self.horizontal_alignment = horizontal_alignment if vertical_alignment is not None: self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title if rich_text is not None: self.rich_text = rich_text if state is not None: @@ -201,75 +201,6 @@ def contents(self, contents): self._contents = contents - @property - def creation_date(self): - """ - Gets the creation_date of this TextAnnotation. - The date and time when the annotation was created. - - :return: The creation_date of this TextAnnotation. - :rtype: str - """ - return self._creation_date - - @creation_date.setter - def creation_date(self, creation_date): - """ - Sets the creation_date of this TextAnnotation. - The date and time when the annotation was created. - - :param creation_date: The creation_date of this TextAnnotation. - :type: str - """ - - self._creation_date = creation_date - - @property - def subject(self): - """ - Gets the subject of this TextAnnotation. - Get the annotation subject. - - :return: The subject of this TextAnnotation. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this TextAnnotation. - Get the annotation subject. - - :param subject: The subject of this TextAnnotation. - :type: str - """ - - self._subject = subject - - @property - def title(self): - """ - Gets the title of this TextAnnotation. - Get the annotation title. - - :return: The title of this TextAnnotation. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this TextAnnotation. - Get the annotation title. - - :param title: The title of this TextAnnotation. - :type: str - """ - - self._title = title - @property def modified(self): """ @@ -477,6 +408,75 @@ def vertical_alignment(self, vertical_alignment): self._vertical_alignment = vertical_alignment + @property + def creation_date(self): + """ + Gets the creation_date of this TextAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this TextAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this TextAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this TextAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this TextAnnotation. + Get the annotation subject. + + :return: The subject of this TextAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this TextAnnotation. + Get the annotation subject. + + :param subject: The subject of this TextAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this TextAnnotation. + Get the annotation title. + + :return: The title of this TextAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this TextAnnotation. + Get the annotation title. + + :param title: The title of this TextAnnotation. + :type: str + """ + + self._title = title + @property def rich_text(self): """ diff --git a/asposepdfcloud/models/underline_annotation.py b/asposepdfcloud/models/underline_annotation.py new file mode 100644 index 0000000..d11bb99 --- /dev/null +++ b/asposepdfcloud/models/underline_annotation.py @@ -0,0 +1,590 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class UnderlineAnnotation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'contents': 'str', + 'modified': 'str', + 'id': 'str', + 'flags': 'list[AnnotationFlags]', + 'name': 'str', + 'rect': 'RectanglePdf', + 'page_index': 'int', + 'z_index': 'int', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', + 'rich_text': 'str', + 'color': 'Color', + 'quad_points': 'list[Point]' + } + + attribute_map = { + 'links': 'Links', + 'contents': 'Contents', + 'modified': 'Modified', + 'id': 'Id', + 'flags': 'Flags', + 'name': 'Name', + 'rect': 'Rect', + 'page_index': 'PageIndex', + 'z_index': 'ZIndex', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'CreationDate', + 'subject': 'Subject', + 'title': 'Title', + 'rich_text': 'RichText', + 'color': 'Color', + 'quad_points': 'QuadPoints' + } + + def __init__(self, links=None, contents=None, modified=None, id=None, flags=None, name=None, rect=None, page_index=None, z_index=None, horizontal_alignment=None, vertical_alignment=None, creation_date=None, subject=None, title=None, rich_text=None, color=None, quad_points=None): + """ + UnderlineAnnotation - a model defined in Swagger + """ + + self._links = None + self._contents = None + self._modified = None + self._id = None + self._flags = None + self._name = None + self._rect = None + self._page_index = None + self._z_index = None + self._horizontal_alignment = None + self._vertical_alignment = None + self._creation_date = None + self._subject = None + self._title = None + self._rich_text = None + self._color = None + self._quad_points = None + + if links is not None: + self.links = links + if contents is not None: + self.contents = contents + if modified is not None: + self.modified = modified + if id is not None: + self.id = id + if flags is not None: + self.flags = flags + if name is not None: + self.name = name + if rect is not None: + self.rect = rect + if page_index is not None: + self.page_index = page_index + if z_index is not None: + self.z_index = z_index + if horizontal_alignment is not None: + self.horizontal_alignment = horizontal_alignment + if vertical_alignment is not None: + self.vertical_alignment = vertical_alignment + if creation_date is not None: + self.creation_date = creation_date + if subject is not None: + self.subject = subject + if title is not None: + self.title = title + if rich_text is not None: + self.rich_text = rich_text + if color is not None: + self.color = color + if quad_points is not None: + self.quad_points = quad_points + + @property + def links(self): + """ + Gets the links of this UnderlineAnnotation. + Link to the document. + + :return: The links of this UnderlineAnnotation. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this UnderlineAnnotation. + Link to the document. + + :param links: The links of this UnderlineAnnotation. + :type: list[Link] + """ + + self._links = links + + @property + def contents(self): + """ + Gets the contents of this UnderlineAnnotation. + Get the annotation content. + + :return: The contents of this UnderlineAnnotation. + :rtype: str + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this UnderlineAnnotation. + Get the annotation content. + + :param contents: The contents of this UnderlineAnnotation. + :type: str + """ + + self._contents = contents + + @property + def modified(self): + """ + Gets the modified of this UnderlineAnnotation. + The date and time when the annotation was last modified. + + :return: The modified of this UnderlineAnnotation. + :rtype: str + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this UnderlineAnnotation. + The date and time when the annotation was last modified. + + :param modified: The modified of this UnderlineAnnotation. + :type: str + """ + + self._modified = modified + + @property + def id(self): + """ + Gets the id of this UnderlineAnnotation. + Gets ID of the annotation. + + :return: The id of this UnderlineAnnotation. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this UnderlineAnnotation. + Gets ID of the annotation. + + :param id: The id of this UnderlineAnnotation. + :type: str + """ + + self._id = id + + @property + def flags(self): + """ + Gets the flags of this UnderlineAnnotation. + Gets Flags of the annotation. + + :return: The flags of this UnderlineAnnotation. + :rtype: list[AnnotationFlags] + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this UnderlineAnnotation. + Gets Flags of the annotation. + + :param flags: The flags of this UnderlineAnnotation. + :type: list[AnnotationFlags] + """ + + self._flags = flags + + @property + def name(self): + """ + Gets the name of this UnderlineAnnotation. + Gets Name of the annotation. + + :return: The name of this UnderlineAnnotation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this UnderlineAnnotation. + Gets Name of the annotation. + + :param name: The name of this UnderlineAnnotation. + :type: str + """ + + self._name = name + + @property + def rect(self): + """ + Gets the rect of this UnderlineAnnotation. + Gets Rect of the annotation. + + :return: The rect of this UnderlineAnnotation. + :rtype: RectanglePdf + """ + return self._rect + + @rect.setter + def rect(self, rect): + """ + Sets the rect of this UnderlineAnnotation. + Gets Rect of the annotation. + + :param rect: The rect of this UnderlineAnnotation. + :type: RectanglePdf + """ + + self._rect = rect + + @property + def page_index(self): + """ + Gets the page_index of this UnderlineAnnotation. + Gets PageIndex of the annotation. + + :return: The page_index of this UnderlineAnnotation. + :rtype: int + """ + return self._page_index + + @page_index.setter + def page_index(self, page_index): + """ + Sets the page_index of this UnderlineAnnotation. + Gets PageIndex of the annotation. + + :param page_index: The page_index of this UnderlineAnnotation. + :type: int + """ + + self._page_index = page_index + + @property + def z_index(self): + """ + Gets the z_index of this UnderlineAnnotation. + Gets ZIndex of the annotation. + + :return: The z_index of this UnderlineAnnotation. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this UnderlineAnnotation. + Gets ZIndex of the annotation. + + :param z_index: The z_index of this UnderlineAnnotation. + :type: int + """ + + self._z_index = z_index + + @property + def horizontal_alignment(self): + """ + Gets the horizontal_alignment of this UnderlineAnnotation. + Gets HorizontalAlignment of the annotation. + + :return: The horizontal_alignment of this UnderlineAnnotation. + :rtype: HorizontalAlignment + """ + return self._horizontal_alignment + + @horizontal_alignment.setter + def horizontal_alignment(self, horizontal_alignment): + """ + Sets the horizontal_alignment of this UnderlineAnnotation. + Gets HorizontalAlignment of the annotation. + + :param horizontal_alignment: The horizontal_alignment of this UnderlineAnnotation. + :type: HorizontalAlignment + """ + + self._horizontal_alignment = horizontal_alignment + + @property + def vertical_alignment(self): + """ + Gets the vertical_alignment of this UnderlineAnnotation. + Gets VerticalAlignment of the annotation. + + :return: The vertical_alignment of this UnderlineAnnotation. + :rtype: VerticalAlignment + """ + return self._vertical_alignment + + @vertical_alignment.setter + def vertical_alignment(self, vertical_alignment): + """ + Sets the vertical_alignment of this UnderlineAnnotation. + Gets VerticalAlignment of the annotation. + + :param vertical_alignment: The vertical_alignment of this UnderlineAnnotation. + :type: VerticalAlignment + """ + + self._vertical_alignment = vertical_alignment + + @property + def creation_date(self): + """ + Gets the creation_date of this UnderlineAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this UnderlineAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this UnderlineAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this UnderlineAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this UnderlineAnnotation. + Get the annotation subject. + + :return: The subject of this UnderlineAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this UnderlineAnnotation. + Get the annotation subject. + + :param subject: The subject of this UnderlineAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this UnderlineAnnotation. + Get the annotation title. + + :return: The title of this UnderlineAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this UnderlineAnnotation. + Get the annotation title. + + :param title: The title of this UnderlineAnnotation. + :type: str + """ + + self._title = title + + @property + def rich_text(self): + """ + Gets the rich_text of this UnderlineAnnotation. + Get the annotation RichText. + + :return: The rich_text of this UnderlineAnnotation. + :rtype: str + """ + return self._rich_text + + @rich_text.setter + def rich_text(self, rich_text): + """ + Sets the rich_text of this UnderlineAnnotation. + Get the annotation RichText. + + :param rich_text: The rich_text of this UnderlineAnnotation. + :type: str + """ + + self._rich_text = rich_text + + @property + def color(self): + """ + Gets the color of this UnderlineAnnotation. + Color of the annotation. + + :return: The color of this UnderlineAnnotation. + :rtype: Color + """ + return self._color + + @color.setter + def color(self, color): + """ + Sets the color of this UnderlineAnnotation. + Color of the annotation. + + :param color: The color of this UnderlineAnnotation. + :type: Color + """ + + self._color = color + + @property + def quad_points(self): + """ + Gets the quad_points of this UnderlineAnnotation. + 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. + + :return: The quad_points of this UnderlineAnnotation. + :rtype: list[Point] + """ + return self._quad_points + + @quad_points.setter + def quad_points(self, quad_points): + """ + Sets the quad_points of this UnderlineAnnotation. + 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. + + :param quad_points: The quad_points of this UnderlineAnnotation. + :type: list[Point] + """ + + self._quad_points = quad_points + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, UnderlineAnnotation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/underline_annotation_response.py b/asposepdfcloud/models/underline_annotation_response.py new file mode 100644 index 0000000..10cea88 --- /dev/null +++ b/asposepdfcloud/models/underline_annotation_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class UnderlineAnnotationResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotation': 'UnderlineAnnotation' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotation': 'Annotation' + } + + def __init__(self, code=None, status=None, annotation=None): + """ + UnderlineAnnotationResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotation = None + + self.code = code + if status is not None: + self.status = status + if annotation is not None: + self.annotation = annotation + + @property + def code(self): + """ + Gets the code of this UnderlineAnnotationResponse. + Response status code. + + :return: The code of this UnderlineAnnotationResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this UnderlineAnnotationResponse. + Response status code. + + :param code: The code of this UnderlineAnnotationResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this UnderlineAnnotationResponse. + Response status. + + :return: The status of this UnderlineAnnotationResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this UnderlineAnnotationResponse. + Response status. + + :param status: The status of this UnderlineAnnotationResponse. + :type: str + """ + + self._status = status + + @property + def annotation(self): + """ + Gets the annotation of this UnderlineAnnotationResponse. + + :return: The annotation of this UnderlineAnnotationResponse. + :rtype: UnderlineAnnotation + """ + return self._annotation + + @annotation.setter + def annotation(self, annotation): + """ + Sets the annotation of this UnderlineAnnotationResponse. + + :param annotation: The annotation of this UnderlineAnnotationResponse. + :type: UnderlineAnnotation + """ + + self._annotation = annotation + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, UnderlineAnnotationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/underline_annotations.py b/asposepdfcloud/models/underline_annotations.py new file mode 100644 index 0000000..8606945 --- /dev/null +++ b/asposepdfcloud/models/underline_annotations.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class UnderlineAnnotations(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'links': 'list[Link]', + 'list': 'list[UnderlineAnnotation]' + } + + attribute_map = { + 'links': 'Links', + 'list': 'List' + } + + def __init__(self, links=None, list=None): + """ + UnderlineAnnotations - a model defined in Swagger + """ + + self._links = None + self._list = None + + if links is not None: + self.links = links + if list is not None: + self.list = list + + @property + def links(self): + """ + Gets the links of this UnderlineAnnotations. + Link to the document. + + :return: The links of this UnderlineAnnotations. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this UnderlineAnnotations. + Link to the document. + + :param links: The links of this UnderlineAnnotations. + :type: list[Link] + """ + + self._links = links + + @property + def list(self): + """ + Gets the list of this UnderlineAnnotations. + + :return: The list of this UnderlineAnnotations. + :rtype: list[UnderlineAnnotation] + """ + return self._list + + @list.setter + def list(self, list): + """ + Sets the list of this UnderlineAnnotations. + + :param list: The list of this UnderlineAnnotations. + :type: list[UnderlineAnnotation] + """ + + self._list = list + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, UnderlineAnnotations): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/asposepdfcloud/models/underline_annotations_response.py b/asposepdfcloud/models/underline_annotations_response.py new file mode 100644 index 0000000..7d00790 --- /dev/null +++ b/asposepdfcloud/models/underline_annotations_response.py @@ -0,0 +1,197 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2018 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. + + + + OpenAPI spec version: 2.0 + +""" + + +from pprint import pformat +from six import iteritems +import re + + +class UnderlineAnnotationsResponse(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'code': 'int', + 'status': 'str', + 'annotations': 'UnderlineAnnotations' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotations': 'Annotations' + } + + def __init__(self, code=None, status=None, annotations=None): + """ + UnderlineAnnotationsResponse - a model defined in Swagger + """ + + self._code = None + self._status = None + self._annotations = None + + self.code = code + if status is not None: + self.status = status + if annotations is not None: + self.annotations = annotations + + @property + def code(self): + """ + Gets the code of this UnderlineAnnotationsResponse. + Response status code. + + :return: The code of this UnderlineAnnotationsResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this UnderlineAnnotationsResponse. + Response status code. + + :param code: The code of this UnderlineAnnotationsResponse. + :type: int + """ + if code is None: + raise ValueError("Invalid value for `code`, must not be `None`") + + self._code = code + + @property + def status(self): + """ + Gets the status of this UnderlineAnnotationsResponse. + Response status. + + :return: The status of this UnderlineAnnotationsResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this UnderlineAnnotationsResponse. + Response status. + + :param status: The status of this UnderlineAnnotationsResponse. + :type: str + """ + + self._status = status + + @property + def annotations(self): + """ + Gets the annotations of this UnderlineAnnotationsResponse. + + :return: The annotations of this UnderlineAnnotationsResponse. + :rtype: UnderlineAnnotations + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this UnderlineAnnotationsResponse. + + :param annotations: The annotations of this UnderlineAnnotationsResponse. + :type: UnderlineAnnotations + """ + + self._annotations = annotations + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, UnderlineAnnotationsResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/docs/Annotation.md b/docs/Annotation.md index 016ab2b..3277ef6 100644 --- a/docs/Annotation.md +++ b/docs/Annotation.md @@ -6,9 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**list[Link]**](Link.md) | Link to the document. | [optional] **contents** | **str** | Get the annotation content. | [optional] -**creation_date** | **str** | The date and time when the annotation was created. | [optional] -**subject** | **str** | Get the annotation subject. | [optional] -**title** | **str** | Get the annotation title. | [optional] **modified** | **str** | The date and time when the annotation was last modified. | [optional] **id** | **str** | Gets ID of the annotation. | [optional] **flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] diff --git a/docs/AnnotationInfo.md b/docs/AnnotationInfo.md index d37610a..b250776 100644 --- a/docs/AnnotationInfo.md +++ b/docs/AnnotationInfo.md @@ -6,9 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**list[Link]**](Link.md) | Link to the document. | [optional] **contents** | **str** | Get the annotation content. | [optional] -**creation_date** | **str** | The date and time when the annotation was created. | [optional] -**subject** | **str** | Get the annotation subject. | [optional] -**title** | **str** | Get the annotation title. | [optional] **modified** | **str** | The date and time when the annotation was last modified. | [optional] **id** | **str** | Gets ID of the annotation. | [optional] **flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] diff --git a/docs/CapStyle.md b/docs/CapStyle.md new file mode 100644 index 0000000..3185302 --- /dev/null +++ b/docs/CapStyle.md @@ -0,0 +1,13 @@ +# CapStyle +Style of line ending of Ink annotation line. + +## Enum +Name | Type | Value +------------ | ------------- | ------------- +**RECTANGULAR** | **str** | "Rectangular" +**ROUNDED** | **str** | "Rounded" + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CaretAnnotation.md b/docs/CaretAnnotation.md new file mode 100644 index 0000000..d5a03ad --- /dev/null +++ b/docs/CaretAnnotation.md @@ -0,0 +1,28 @@ +# CaretAnnotation +Provides CaretAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**contents** | **str** | Get the annotation content. | [optional] +**modified** | **str** | The date and time when the annotation was last modified. | [optional] +**id** | **str** | Gets ID of the annotation. | [optional] +**flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] +**name** | **str** | Gets Name of the annotation. | [optional] +**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. | [optional] +**page_index** | **int** | Gets PageIndex of the annotation. | [optional] +**z_index** | **int** | Gets ZIndex of the annotation. | [optional] +**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] +**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] +**rich_text** | **str** | Get the annotation RichText. | [optional] +**color** | [**Color**](Color.md) | Color of the annotation. | [optional] +**frame** | [**RectanglePdf**](RectanglePdf.md) | Gets or sets caret rectangle. | [optional] +**symbol** | [**CaretSymbol**](CaretSymbol.md) | Gets or sets symbol associated with caret. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CaretAnnotationResponse.md b/docs/CaretAnnotationResponse.md new file mode 100644 index 0000000..cb4737c --- /dev/null +++ b/docs/CaretAnnotationResponse.md @@ -0,0 +1,13 @@ +# CaretAnnotationResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotation** | [**CaretAnnotation**](CaretAnnotation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CaretAnnotations.md b/docs/CaretAnnotations.md new file mode 100644 index 0000000..2d3bb85 --- /dev/null +++ b/docs/CaretAnnotations.md @@ -0,0 +1,12 @@ +# CaretAnnotations +List of annotations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**list** | [**list[CaretAnnotation]**](CaretAnnotation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CaretAnnotationsResponse.md b/docs/CaretAnnotationsResponse.md new file mode 100644 index 0000000..d3216aa --- /dev/null +++ b/docs/CaretAnnotationsResponse.md @@ -0,0 +1,13 @@ +# CaretAnnotationsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotations** | [**CaretAnnotations**](CaretAnnotations.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CaretSymbol.md b/docs/CaretSymbol.md new file mode 100644 index 0000000..c1a94cf --- /dev/null +++ b/docs/CaretSymbol.md @@ -0,0 +1,13 @@ +# CaretSymbol +A symbol to be associated with the caret. + +## Enum +Name | Type | Value +------------ | ------------- | ------------- +**NONE** | **str** | "None" +**PARAGRAPH** | **str** | "Paragraph" + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CircleAnnotation.md b/docs/CircleAnnotation.md index 4000561..f12f428 100644 --- a/docs/CircleAnnotation.md +++ b/docs/CircleAnnotation.md @@ -6,9 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**list[Link]**](Link.md) | Link to the document. | [optional] **contents** | **str** | Get the annotation content. | [optional] -**creation_date** | **str** | The date and time when the annotation was created. | [optional] -**subject** | **str** | Get the annotation subject. | [optional] -**title** | **str** | Get the annotation title. | [optional] **modified** | **str** | The date and time when the annotation was last modified. | [optional] **id** | **str** | Gets ID of the annotation. | [optional] **flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] @@ -18,6 +15,9 @@ Name | Type | Description | Notes **z_index** | **int** | Gets ZIndex of the annotation. | [optional] **horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] **vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] **rich_text** | **str** | Get the annotation RichText. | [optional] **interior_color** | [**Color**](Color.md) | Get the annotation InteriorColor. | [optional] **frame** | [**RectanglePdf**](RectanglePdf.md) | Get or set the annotation Rectangle of frame. | [optional] diff --git a/docs/CommonFigureAnnotation.md b/docs/CommonFigureAnnotation.md index 106b938..56f9e98 100644 --- a/docs/CommonFigureAnnotation.md +++ b/docs/CommonFigureAnnotation.md @@ -6,9 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**list[Link]**](Link.md) | Link to the document. | [optional] **contents** | **str** | Get the annotation content. | [optional] -**creation_date** | **str** | The date and time when the annotation was created. | [optional] -**subject** | **str** | Get the annotation subject. | [optional] -**title** | **str** | Get the annotation title. | [optional] **modified** | **str** | The date and time when the annotation was last modified. | [optional] **id** | **str** | Gets ID of the annotation. | [optional] **flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] @@ -18,6 +15,9 @@ Name | Type | Description | Notes **z_index** | **int** | Gets ZIndex of the annotation. | [optional] **horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] **vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] **rich_text** | **str** | Get the annotation RichText. | [optional] **interior_color** | [**Color**](Color.md) | Get the annotation InteriorColor. | [optional] **frame** | [**RectanglePdf**](RectanglePdf.md) | Get or set the annotation Rectangle of frame. | [optional] diff --git a/docs/File.md b/docs/File.md new file mode 100644 index 0000000..9e5e512 --- /dev/null +++ b/docs/File.md @@ -0,0 +1,15 @@ +# File +Represents file DTO. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**is_folder** | **bool** | | +**modified_date** | **datetime** | | [optional] +**size** | **int** | | +**path** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/FilesResponse.md b/docs/FilesResponse.md new file mode 100644 index 0000000..5b18914 --- /dev/null +++ b/docs/FilesResponse.md @@ -0,0 +1,13 @@ +# FilesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**files** | [**list[File]**](File.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/FreeTextAnnotation.md b/docs/FreeTextAnnotation.md index 24f5b50..92ae61a 100644 --- a/docs/FreeTextAnnotation.md +++ b/docs/FreeTextAnnotation.md @@ -6,9 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**list[Link]**](Link.md) | Link to the document. | [optional] **contents** | **str** | Get the annotation content. | [optional] -**creation_date** | **str** | The date and time when the annotation was created. | [optional] -**subject** | **str** | Get the annotation subject. | [optional] -**title** | **str** | Get the annotation title. | [optional] **modified** | **str** | The date and time when the annotation was last modified. | [optional] **id** | **str** | Gets ID of the annotation. | [optional] **flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] @@ -18,6 +15,9 @@ Name | Type | Description | Notes **z_index** | **int** | Gets ZIndex of the annotation. | [optional] **horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] **vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] **rich_text** | **str** | Get the annotation RichText. | [optional] **justification** | [**Justification**](Justification.md) | Gets Justification of the annotation. | [optional] **intent** | [**FreeTextIntent**](FreeTextIntent.md) | Gets or sets the intent of the free text annotation. | [optional] diff --git a/docs/HighlightAnnotation.md b/docs/HighlightAnnotation.md new file mode 100644 index 0000000..ba69447 --- /dev/null +++ b/docs/HighlightAnnotation.md @@ -0,0 +1,27 @@ +# HighlightAnnotation +Provides HighlightAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**contents** | **str** | Get the annotation content. | [optional] +**modified** | **str** | The date and time when the annotation was last modified. | [optional] +**id** | **str** | Gets ID of the annotation. | [optional] +**flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] +**name** | **str** | Gets Name of the annotation. | [optional] +**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. | [optional] +**page_index** | **int** | Gets PageIndex of the annotation. | [optional] +**z_index** | **int** | Gets ZIndex of the annotation. | [optional] +**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] +**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] +**rich_text** | **str** | Get the annotation RichText. | [optional] +**color** | [**Color**](Color.md) | Color of the annotation. | [optional] +**quad_points** | [**list[Point]**](Point.md) | 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. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/HighlightAnnotationResponse.md b/docs/HighlightAnnotationResponse.md new file mode 100644 index 0000000..076ed97 --- /dev/null +++ b/docs/HighlightAnnotationResponse.md @@ -0,0 +1,13 @@ +# HighlightAnnotationResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotation** | [**HighlightAnnotation**](HighlightAnnotation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/HighlightAnnotations.md b/docs/HighlightAnnotations.md new file mode 100644 index 0000000..93fb2ad --- /dev/null +++ b/docs/HighlightAnnotations.md @@ -0,0 +1,12 @@ +# HighlightAnnotations +List of annotations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**list** | [**list[HighlightAnnotation]**](HighlightAnnotation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/HighlightAnnotationsResponse.md b/docs/HighlightAnnotationsResponse.md new file mode 100644 index 0000000..056266d --- /dev/null +++ b/docs/HighlightAnnotationsResponse.md @@ -0,0 +1,13 @@ +# HighlightAnnotationsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotations** | [**HighlightAnnotations**](HighlightAnnotations.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InkAnnotation.md b/docs/InkAnnotation.md new file mode 100644 index 0000000..4a8f138 --- /dev/null +++ b/docs/InkAnnotation.md @@ -0,0 +1,28 @@ +# InkAnnotation +Provides InkAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**contents** | **str** | Get the annotation content. | [optional] +**modified** | **str** | The date and time when the annotation was last modified. | [optional] +**id** | **str** | Gets ID of the annotation. | [optional] +**flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] +**name** | **str** | Gets Name of the annotation. | [optional] +**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. | [optional] +**page_index** | **int** | Gets PageIndex of the annotation. | [optional] +**z_index** | **int** | Gets ZIndex of the annotation. | [optional] +**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] +**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] +**rich_text** | **str** | Get the annotation RichText. | [optional] +**color** | [**Color**](Color.md) | Color of the annotation. | [optional] +**ink_list** | **list[list[Point]]** | Gets or sets list of gestures that are independent lines which are represented by Point[] arrays. | [optional] +**cap_style** | [**CapStyle**](CapStyle.md) | Style of ink annotation line endings. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InkAnnotationResponse.md b/docs/InkAnnotationResponse.md new file mode 100644 index 0000000..578cd24 --- /dev/null +++ b/docs/InkAnnotationResponse.md @@ -0,0 +1,13 @@ +# InkAnnotationResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotation** | [**InkAnnotation**](InkAnnotation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InkAnnotations.md b/docs/InkAnnotations.md new file mode 100644 index 0000000..465f47c --- /dev/null +++ b/docs/InkAnnotations.md @@ -0,0 +1,12 @@ +# InkAnnotations +List of annotations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**list** | [**list[InkAnnotation]**](InkAnnotation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InkAnnotationsResponse.md b/docs/InkAnnotationsResponse.md new file mode 100644 index 0000000..2d89cc6 --- /dev/null +++ b/docs/InkAnnotationsResponse.md @@ -0,0 +1,13 @@ +# InkAnnotationsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotations** | [**InkAnnotations**](InkAnnotations.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LineAnnotation.md b/docs/LineAnnotation.md index bf18b3a..af66070 100644 --- a/docs/LineAnnotation.md +++ b/docs/LineAnnotation.md @@ -6,9 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**list[Link]**](Link.md) | Link to the document. | [optional] **contents** | **str** | Get the annotation content. | [optional] -**creation_date** | **str** | The date and time when the annotation was created. | [optional] -**subject** | **str** | Get the annotation subject. | [optional] -**title** | **str** | Get the annotation title. | [optional] **modified** | **str** | The date and time when the annotation was last modified. | [optional] **id** | **str** | Gets ID of the annotation. | [optional] **flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] @@ -18,6 +15,9 @@ Name | Type | Description | Notes **z_index** | **int** | Gets ZIndex of the annotation. | [optional] **horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] **vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] **rich_text** | **str** | Get the annotation RichText. | [optional] **starting** | [**Point**](Point.md) | Gets or sets starting point of line. | [optional] **starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets line ending style for line starting point. | [optional] diff --git a/docs/MarkupAnnotation.md b/docs/MarkupAnnotation.md index 33c0687..570d0b8 100644 --- a/docs/MarkupAnnotation.md +++ b/docs/MarkupAnnotation.md @@ -6,9 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**list[Link]**](Link.md) | Link to the document. | [optional] **contents** | **str** | Get the annotation content. | [optional] -**creation_date** | **str** | The date and time when the annotation was created. | [optional] -**subject** | **str** | Get the annotation subject. | [optional] -**title** | **str** | Get the annotation title. | [optional] **modified** | **str** | The date and time when the annotation was last modified. | [optional] **id** | **str** | Gets ID of the annotation. | [optional] **flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] @@ -18,6 +15,9 @@ Name | Type | Description | Notes **z_index** | **int** | Gets ZIndex of the annotation. | [optional] **horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] **vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] **rich_text** | **str** | Get the annotation RichText. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PdfApi.md b/docs/PdfApi.md index c1d2c87..095a52c 100644 --- a/docs/PdfApi.md +++ b/docs/PdfApi.md @@ -15,27 +15,37 @@ Method | HTTP request | Description [**delete_page_link_annotations**](PdfApi.md#delete_page_link_annotations) | **DELETE** /pdf/\{name}/pages/\{pageNumber}/links | Delete all link annotations from the page [**delete_properties**](PdfApi.md#delete_properties) | **DELETE** /pdf/\{name}/documentproperties | Delete custom document properties. [**delete_property**](PdfApi.md#delete_property) | **DELETE** /pdf/\{name}/documentproperties/\{propertyName} | Delete document property. +[**get_caret_annotation**](PdfApi.md#get_caret_annotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID. [**get_circle_annotation**](PdfApi.md#get_circle_annotation) | **GET** /pdf/\{name}/annotations/circle/\{annotationId} | Read document page circle annotation by ID. [**get_document**](PdfApi.md#get_document) | **GET** /pdf/\{name} | Read common document info. [**get_document_annotations**](PdfApi.md#get_document_annotations) | **GET** /pdf/\{name}/annotations | Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases. [**get_document_attachment_by_index**](PdfApi.md#get_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex} | Read document attachment info by its index. [**get_document_attachments**](PdfApi.md#get_document_attachments) | **GET** /pdf/\{name}/attachments | Read document attachments info. [**get_document_bookmarks**](PdfApi.md#get_document_bookmarks) | **GET** /pdf/\{name}/bookmarks | Read document bookmark/bookmarks (including children). +[**get_document_caret_annotations**](PdfApi.md#get_document_caret_annotations) | **GET** /pdf/\{name}/annotations/caret | Read document caret annotations. [**get_document_circle_annotations**](PdfApi.md#get_document_circle_annotations) | **GET** /pdf/\{name}/annotations/circle | Read document circle annotations. [**get_document_free_text_annotations**](PdfApi.md#get_document_free_text_annotations) | **GET** /pdf/\{name}/annotations/freetext | Read document free text annotations. +[**get_document_highlight_annotations**](PdfApi.md#get_document_highlight_annotations) | **GET** /pdf/\{name}/annotations/highlight | Read document highlight annotations. +[**get_document_ink_annotations**](PdfApi.md#get_document_ink_annotations) | **GET** /pdf/\{name}/annotations/ink | Read document ink annotations. [**get_document_line_annotations**](PdfApi.md#get_document_line_annotations) | **GET** /pdf/\{name}/annotations/line | Read document line annotations. [**get_document_poly_line_annotations**](PdfApi.md#get_document_poly_line_annotations) | **GET** /pdf/\{name}/annotations/polyline | Read document polyline annotations. [**get_document_polygon_annotations**](PdfApi.md#get_document_polygon_annotations) | **GET** /pdf/\{name}/annotations/polygon | Read document polygon annotations. +[**get_document_popup_annotations**](PdfApi.md#get_document_popup_annotations) | **GET** /pdf/\{name}/annotations/popup | Read document popup annotations. +[**get_document_popup_annotations_by_parent**](PdfApi.md#get_document_popup_annotations_by_parent) | **GET** /pdf/\{name}/annotations/\{annotationId}/popup | Read document popup annotations by parent id. [**get_document_properties**](PdfApi.md#get_document_properties) | **GET** /pdf/\{name}/documentproperties | Read document properties. [**get_document_property**](PdfApi.md#get_document_property) | **GET** /pdf/\{name}/documentproperties/\{propertyName} | Read document property by name. [**get_document_square_annotations**](PdfApi.md#get_document_square_annotations) | **GET** /pdf/\{name}/annotations/square | Read document square annotations. +[**get_document_squiggly_annotations**](PdfApi.md#get_document_squiggly_annotations) | **GET** /pdf/\{name}/annotations/squiggly | Read document squiggly annotations. +[**get_document_strike_out_annotations**](PdfApi.md#get_document_strike_out_annotations) | **GET** /pdf/\{name}/annotations/strikeout | Read document StrikeOut annotations. [**get_document_text_annotations**](PdfApi.md#get_document_text_annotations) | **GET** /pdf/\{name}/annotations/text | Read document text annotations. +[**get_document_underline_annotations**](PdfApi.md#get_document_underline_annotations) | **GET** /pdf/\{name}/annotations/underline | Read document underline annotations. [**get_download**](PdfApi.md#get_download) | **GET** /storage/file | Download a specific file [**get_download_document_attachment_by_index**](PdfApi.md#get_download_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex}/download | Download document attachment content by its index. [**get_epub_in_storage_to_pdf**](PdfApi.md#get_epub_in_storage_to_pdf) | **GET** /pdf/create/epub | Convert EPUB file (located on storage) to PDF format and return resulting file in response. [**get_field**](PdfApi.md#get_field) | **GET** /pdf/\{name}/fields/\{fieldName} | Get document field by name. [**get_fields**](PdfApi.md#get_fields) | **GET** /pdf/\{name}/fields | Get document fields. [**get_free_text_annotation**](PdfApi.md#get_free_text_annotation) | **GET** /pdf/\{name}/annotations/freetext/\{annotationId} | Read document page free text annotation by ID. +[**get_highlight_annotation**](PdfApi.md#get_highlight_annotation) | **GET** /pdf/\{name}/annotations/highlight/\{annotationId} | Read document page highlight annotation by ID. [**get_html_in_storage_to_pdf**](PdfApi.md#get_html_in_storage_to_pdf) | **GET** /pdf/create/html | Convert HTML file (located on storage) to PDF format and return resulting file in response. [**get_image**](PdfApi.md#get_image) | **GET** /pdf/\{name}/images/\{imageId} | Read document image by ID. [**get_image_extract_as_gif**](PdfApi.md#get_image_extract_as_gif) | **GET** /pdf/\{name}/images/\{imageId}/extract/gif | Extract document image in GIF format @@ -43,12 +53,15 @@ Method | HTTP request | Description [**get_image_extract_as_png**](PdfApi.md#get_image_extract_as_png) | **GET** /pdf/\{name}/images/\{imageId}/extract/png | Extract document image in PNG format [**get_image_extract_as_tiff**](PdfApi.md#get_image_extract_as_tiff) | **GET** /pdf/\{name}/images/\{imageId}/extract/tiff | Extract document image in TIFF format [**get_images**](PdfApi.md#get_images) | **GET** /pdf/\{name}/pages/\{pageNumber}/images | Read document images. +[**get_ink_annotation**](PdfApi.md#get_ink_annotation) | **GET** /pdf/\{name}/annotations/ink/\{annotationId} | Read document page ink annotation by ID. [**get_la_te_x_in_storage_to_pdf**](PdfApi.md#get_la_te_x_in_storage_to_pdf) | **GET** /pdf/create/latex | Convert LaTeX file (located on storage) to PDF format and return resulting file in response. [**get_line_annotation**](PdfApi.md#get_line_annotation) | **GET** /pdf/\{name}/annotations/line/\{annotationId} | Read document page line annotation by ID. [**get_link_annotation**](PdfApi.md#get_link_annotation) | **GET** /pdf/\{name}/links/\{linkId} | Read document link annotation by ID. +[**get_list_files**](PdfApi.md#get_list_files) | **GET** /storage/folder | Get the file listing of a specific folder [**get_mht_in_storage_to_pdf**](PdfApi.md#get_mht_in_storage_to_pdf) | **GET** /pdf/create/mht | Convert MHT file (located on storage) to PDF format and return resulting file in response. [**get_page**](PdfApi.md#get_page) | **GET** /pdf/\{name}/pages/\{pageNumber} | Read document page info. [**get_page_annotations**](PdfApi.md#get_page_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations | Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases. +[**get_page_caret_annotations**](PdfApi.md#get_page_caret_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Read document page caret annotations. [**get_page_circle_annotations**](PdfApi.md#get_page_circle_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Read document page circle annotations. [**get_page_convert_to_bmp**](PdfApi.md#get_page_convert_to_bmp) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/bmp | Convert document page to Bmp image and return resulting file in response. [**get_page_convert_to_emf**](PdfApi.md#get_page_convert_to_emf) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/emf | Convert document page to Emf image and return resulting file in response. @@ -57,14 +70,20 @@ Method | HTTP request | Description [**get_page_convert_to_png**](PdfApi.md#get_page_convert_to_png) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/png | Convert document page to Png image and return resulting file in response. [**get_page_convert_to_tiff**](PdfApi.md#get_page_convert_to_tiff) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/tiff | Convert document page to Tiff image and return resulting file in response. [**get_page_free_text_annotations**](PdfApi.md#get_page_free_text_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/freetext | Read document page free text annotations. +[**get_page_highlight_annotations**](PdfApi.md#get_page_highlight_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/highlight | Read document page highlight annotations. +[**get_page_ink_annotations**](PdfApi.md#get_page_ink_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/ink | Read document page ink annotations. [**get_page_line_annotations**](PdfApi.md#get_page_line_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/line | Read document page line annotations. [**get_page_link_annotation**](PdfApi.md#get_page_link_annotation) | **GET** /pdf/\{name}/pages/\{pageNumber}/links/\{linkId} | Read document page link annotation by ID. [**get_page_link_annotations**](PdfApi.md#get_page_link_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/links | Read document page link annotations. [**get_page_poly_line_annotations**](PdfApi.md#get_page_poly_line_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Read document page polyline annotations. [**get_page_polygon_annotations**](PdfApi.md#get_page_polygon_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Read document page polygon annotations. +[**get_page_popup_annotations**](PdfApi.md#get_page_popup_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/popup | Read document page popup annotations. [**get_page_square_annotations**](PdfApi.md#get_page_square_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Read document page square annotations. +[**get_page_squiggly_annotations**](PdfApi.md#get_page_squiggly_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Read document page squiggly annotations. +[**get_page_strike_out_annotations**](PdfApi.md#get_page_strike_out_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/strikeout | Read document page StrikeOut annotations. [**get_page_text**](PdfApi.md#get_page_text) | **GET** /pdf/\{name}/pages/\{pageNumber}/text | Read page text items. [**get_page_text_annotations**](PdfApi.md#get_page_text_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/text | Read document page text annotations. +[**get_page_underline_annotations**](PdfApi.md#get_page_underline_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/underline | Read document page underline annotations. [**get_pages**](PdfApi.md#get_pages) | **GET** /pdf/\{name}/pages | Read document pages info. [**get_pcl_in_storage_to_pdf**](PdfApi.md#get_pcl_in_storage_to_pdf) | **GET** /pdf/create/pcl | Convert PCL file (located on storage) to PDF format and return resulting file in response. [**get_pdf_in_storage_to_doc**](PdfApi.md#get_pdf_in_storage_to_doc) | **GET** /pdf/\{name}/convert/doc | Converts PDF document (located on storage) to DOC format and returns resulting file in response content @@ -81,11 +100,15 @@ Method | HTTP request | Description [**get_pdf_in_storage_to_xps**](PdfApi.md#get_pdf_in_storage_to_xps) | **GET** /pdf/\{name}/convert/xps | Converts PDF document (located on storage) to XPS format and returns resulting file in response content [**get_poly_line_annotation**](PdfApi.md#get_poly_line_annotation) | **GET** /pdf/\{name}/annotations/polyline/\{annotationId} | Read document page polyline annotation by ID. [**get_polygon_annotation**](PdfApi.md#get_polygon_annotation) | **GET** /pdf/\{name}/annotations/polygon/\{annotationId} | Read document page polygon annotation by ID. +[**get_popup_annotation**](PdfApi.md#get_popup_annotation) | **GET** /pdf/\{name}/annotations/popup/\{annotationId} | Read document page popup annotation by ID. [**get_ps_in_storage_to_pdf**](PdfApi.md#get_ps_in_storage_to_pdf) | **GET** /pdf/create/ps | Convert PS file (located on storage) to PDF format and return resulting file in response. [**get_square_annotation**](PdfApi.md#get_square_annotation) | **GET** /pdf/\{name}/annotations/square/\{annotationId} | Read document page square annotation by ID. +[**get_squiggly_annotation**](PdfApi.md#get_squiggly_annotation) | **GET** /pdf/\{name}/annotations/squiggly/\{annotationId} | Read document page squiggly annotation by ID. +[**get_strike_out_annotation**](PdfApi.md#get_strike_out_annotation) | **GET** /pdf/\{name}/annotations/strikeout/\{annotationId} | Read document page StrikeOut annotation by ID. [**get_svg_in_storage_to_pdf**](PdfApi.md#get_svg_in_storage_to_pdf) | **GET** /pdf/create/svg | Convert SVG file (located on storage) to PDF format and return resulting file in response. [**get_text**](PdfApi.md#get_text) | **GET** /pdf/\{name}/text | Read document text. [**get_text_annotation**](PdfApi.md#get_text_annotation) | **GET** /pdf/\{name}/annotations/text/\{annotationId} | Read document page text annotation by ID. +[**get_underline_annotation**](PdfApi.md#get_underline_annotation) | **GET** /pdf/\{name}/annotations/underline/\{annotationId} | Read document page underline annotation by ID. [**get_verify_signature**](PdfApi.md#get_verify_signature) | **GET** /pdf/\{name}/verifySignature | Verify signature document. [**get_web_in_storage_to_pdf**](PdfApi.md#get_web_in_storage_to_pdf) | **GET** /pdf/create/web | Convert web page to PDF format and return resulting file in response. [**get_words_per_page**](PdfApi.md#get_words_per_page) | **GET** /pdf/\{name}/pages/wordCount | Get number of words per document page. @@ -99,26 +122,35 @@ Method | HTTP request | Description [**post_insert_image**](PdfApi.md#post_insert_image) | **POST** /pdf/\{name}/pages/\{pageNumber}/images | Insert image to document page. [**post_move_page**](PdfApi.md#post_move_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/movePage | Move page to new position. [**post_optimize_document**](PdfApi.md#post_optimize_document) | **POST** /pdf/\{name}/optimize | Optimize document. +[**post_page_caret_annotations**](PdfApi.md#post_page_caret_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Add document page caret annotations. [**post_page_circle_annotations**](PdfApi.md#post_page_circle_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Add document page circle annotations. [**post_page_free_text_annotations**](PdfApi.md#post_page_free_text_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/freetext | Add document page free text annotations. +[**post_page_highlight_annotations**](PdfApi.md#post_page_highlight_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/highlight | Add document page highlight annotations. +[**post_page_ink_annotations**](PdfApi.md#post_page_ink_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/ink | Add document page ink annotations. [**post_page_line_annotations**](PdfApi.md#post_page_line_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/line | Add document page line annotations. [**post_page_link_annotations**](PdfApi.md#post_page_link_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/links | Add document page link annotations. [**post_page_poly_line_annotations**](PdfApi.md#post_page_poly_line_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Add document page polyline annotations. [**post_page_polygon_annotations**](PdfApi.md#post_page_polygon_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Add document page polygon annotations. [**post_page_square_annotations**](PdfApi.md#post_page_square_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Add document page square annotations. +[**post_page_squiggly_annotations**](PdfApi.md#post_page_squiggly_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Add document page squiggly annotations. +[**post_page_strike_out_annotations**](PdfApi.md#post_page_strike_out_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/strikeout | Add document page StrikeOut annotations. [**post_page_text_annotations**](PdfApi.md#post_page_text_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/text | Add document page text annotations. [**post_page_text_replace**](PdfApi.md#post_page_text_replace) | **POST** /pdf/\{name}/pages/\{pageNumber}/text/replace | Page's replace text method. +[**post_page_underline_annotations**](PdfApi.md#post_page_underline_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/underline | Add document page underline annotations. +[**post_popup_annotation**](PdfApi.md#post_popup_annotation) | **POST** /pdf/\{name}/annotations/\{annotationId}/popup | Add document popup annotations. [**post_sign_document**](PdfApi.md#post_sign_document) | **POST** /pdf/\{name}/sign | Sign document. [**post_sign_page**](PdfApi.md#post_sign_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/sign | Sign page. [**post_split_document**](PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts. [**put_add_new_page**](PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document. [**put_add_text**](PdfApi.md#put_add_text) | **PUT** /pdf/\{name}/pages/\{pageNumber}/text | Add text to PDF document page. +[**put_caret_annotation**](PdfApi.md#put_caret_annotation) | **PUT** /pdf/\{name}/annotations/caret/\{annotationId} | Replace document caret annotation [**put_circle_annotation**](PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation [**put_create**](PdfApi.md#put_create) | **PUT** /storage/file | Upload a specific file [**put_create_document**](PdfApi.md#put_create_document) | **PUT** /pdf/\{name} | Create empty document. [**put_epub_in_storage_to_pdf**](PdfApi.md#put_epub_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/epub | Convert EPUB file (located on storage) to PDF format and upload resulting file to storage. [**put_fields_flatten**](PdfApi.md#put_fields_flatten) | **PUT** /pdf/\{name}/fields/flatten | Flatten form fields in document. [**put_free_text_annotation**](PdfApi.md#put_free_text_annotation) | **PUT** /pdf/\{name}/annotations/freetext/\{annotationId} | Replace document free text annotation +[**put_highlight_annotation**](PdfApi.md#put_highlight_annotation) | **PUT** /pdf/\{name}/annotations/highlight/\{annotationId} | Replace document highlight annotation [**put_html_in_storage_to_pdf**](PdfApi.md#put_html_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/html | Convert HTML file (located on storage) to PDF format and upload resulting file to storage. [**put_image_extract_as_gif**](PdfApi.md#put_image_extract_as_gif) | **PUT** /pdf/\{name}/images/\{imageId}/extract/gif | Extract document image in GIF format to folder [**put_image_extract_as_jpeg**](PdfApi.md#put_image_extract_as_jpeg) | **PUT** /pdf/\{name}/images/\{imageId}/extract/jpeg | Extract document image in JPEG format to folder @@ -129,6 +161,7 @@ Method | HTTP request | Description [**put_images_extract_as_jpeg**](PdfApi.md#put_images_extract_as_jpeg) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/jpeg | Extract document images in JPEG format to folder. [**put_images_extract_as_png**](PdfApi.md#put_images_extract_as_png) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/png | Extract document images in PNG format to folder. [**put_images_extract_as_tiff**](PdfApi.md#put_images_extract_as_tiff) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/tiff | Extract document images in TIFF format to folder. +[**put_ink_annotation**](PdfApi.md#put_ink_annotation) | **PUT** /pdf/\{name}/annotations/ink/\{annotationId} | Replace document ink annotation [**put_la_te_x_in_storage_to_pdf**](PdfApi.md#put_la_te_x_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/latex | Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage. [**put_line_annotation**](PdfApi.md#put_line_annotation) | **PUT** /pdf/\{name}/annotations/line/\{annotationId} | Replace document line annotation [**put_link_annotation**](PdfApi.md#put_link_annotation) | **PUT** /pdf/\{name}/links/\{linkId} | Replace document page link annotations @@ -168,14 +201,18 @@ Method | HTTP request | Description [**put_pdf_in_storage_to_xps**](PdfApi.md#put_pdf_in_storage_to_xps) | **PUT** /pdf/\{name}/convert/xps | Converts PDF document (located on storage) to XPS format and uploads resulting file to storage [**put_poly_line_annotation**](PdfApi.md#put_poly_line_annotation) | **PUT** /pdf/\{name}/annotations/polyline/\{annotationId} | Replace document polyline annotation [**put_polygon_annotation**](PdfApi.md#put_polygon_annotation) | **PUT** /pdf/\{name}/annotations/polygon/\{annotationId} | Replace document polygon annotation +[**put_popup_annotation**](PdfApi.md#put_popup_annotation) | **PUT** /pdf/\{name}/annotations/popup/\{annotationId} | Replace document popup annotation [**put_privileges**](PdfApi.md#put_privileges) | **PUT** /pdf/\{name}/privileges | Update privilege document. [**put_ps_in_storage_to_pdf**](PdfApi.md#put_ps_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/ps | Convert PS file (located on storage) to PDF format and upload resulting file to storage. [**put_replace_image**](PdfApi.md#put_replace_image) | **PUT** /pdf/\{name}/images/\{imageId} | Replace document image. [**put_searchable_document**](PdfApi.md#put_searchable_document) | **PUT** /pdf/\{name}/ocr | Create searchable PDF document. Generate OCR layer for images in input PDF document. [**put_set_property**](PdfApi.md#put_set_property) | **PUT** /pdf/\{name}/documentproperties/\{propertyName} | Add/update document property. [**put_square_annotation**](PdfApi.md#put_square_annotation) | **PUT** /pdf/\{name}/annotations/square/\{annotationId} | Replace document square annotation +[**put_squiggly_annotation**](PdfApi.md#put_squiggly_annotation) | **PUT** /pdf/\{name}/annotations/squiggly/\{annotationId} | Replace document squiggly annotation +[**put_strike_out_annotation**](PdfApi.md#put_strike_out_annotation) | **PUT** /pdf/\{name}/annotations/strikeout/\{annotationId} | Replace document StrikeOut annotation [**put_svg_in_storage_to_pdf**](PdfApi.md#put_svg_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/svg | Convert SVG file (located on storage) to PDF format and upload resulting file to storage. [**put_text_annotation**](PdfApi.md#put_text_annotation) | **PUT** /pdf/\{name}/annotations/text/\{annotationId} | Replace document text annotation +[**put_underline_annotation**](PdfApi.md#put_underline_annotation) | **PUT** /pdf/\{name}/annotations/underline/\{annotationId} | Replace document underline annotation [**put_update_field**](PdfApi.md#put_update_field) | **PUT** /pdf/\{name}/fields/\{fieldName} | Update field. [**put_update_fields**](PdfApi.md#put_update_fields) | **PUT** /pdf/\{name}/fields | Update fields. [**put_web_in_storage_to_pdf**](PdfApi.md#put_web_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/web | Convert web page to PDF format and upload resulting file to storage. @@ -458,6 +495,31 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_caret_annotation** +> CaretAnnotationResponse get_caret_annotation(name, annotation_id, storage=storage, folder=folder) + +Read document page caret annotation by ID. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**CaretAnnotationResponse**](CaretAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_circle_annotation** > CircleAnnotationResponse get_circle_annotation(name, annotation_id, storage=storage, folder=folder) @@ -605,6 +667,30 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_document_caret_annotations** +> CaretAnnotationsResponse get_document_caret_annotations(name, storage=storage, folder=folder) + +Read document caret annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**CaretAnnotationsResponse**](CaretAnnotationsResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_document_circle_annotations** > CircleAnnotationsResponse get_document_circle_annotations(name, storage=storage, folder=folder) @@ -653,6 +739,54 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_document_highlight_annotations** +> HighlightAnnotationsResponse get_document_highlight_annotations(name, storage=storage, folder=folder) + +Read document highlight annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**HighlightAnnotationsResponse**](HighlightAnnotationsResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_document_ink_annotations** +> InkAnnotationsResponse get_document_ink_annotations(name, storage=storage, folder=folder) + +Read document ink annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**InkAnnotationsResponse**](InkAnnotationsResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_document_line_annotations** > LineAnnotationsResponse get_document_line_annotations(name, storage=storage, folder=folder) @@ -725,6 +859,55 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_document_popup_annotations** +> PopupAnnotationsResponse get_document_popup_annotations(name, storage=storage, folder=folder) + +Read document popup annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**PopupAnnotationsResponse**](PopupAnnotationsResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_document_popup_annotations_by_parent** +> PopupAnnotationsResponse get_document_popup_annotations_by_parent(name, annotation_id, storage=storage, folder=folder) + +Read document popup annotations by parent id. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The parent annotation ID. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**PopupAnnotationsResponse**](PopupAnnotationsResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_document_properties** > DocumentPropertiesResponse get_document_properties(name, storage=storage, folder=folder) @@ -798,6 +981,54 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_document_squiggly_annotations** +> SquigglyAnnotationsResponse get_document_squiggly_annotations(name, storage=storage, folder=folder) + +Read document squiggly annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**SquigglyAnnotationsResponse**](SquigglyAnnotationsResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_document_strike_out_annotations** +> StrikeOutAnnotationsResponse get_document_strike_out_annotations(name, storage=storage, folder=folder) + +Read document StrikeOut annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**StrikeOutAnnotationsResponse**](StrikeOutAnnotationsResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_document_text_annotations** > TextAnnotationsResponse get_document_text_annotations(name, storage=storage, folder=folder) @@ -822,6 +1053,30 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_document_underline_annotations** +> UnderlineAnnotationsResponse get_document_underline_annotations(name, storage=storage, folder=folder) + +Read document underline annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**UnderlineAnnotationsResponse**](UnderlineAnnotationsResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_download** > file get_download(path, version_id=version_id, storage=storage) @@ -968,8 +1223,33 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_highlight_annotation** +> HighlightAnnotationResponse get_highlight_annotation(name, annotation_id, storage=storage, folder=folder) + +Read document page highlight annotation by ID. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**HighlightAnnotationResponse**](HighlightAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_html_in_storage_to_pdf** -> file get_html_in_storage_to_pdf(src_path, html_file_name, height=height, width=width, is_landscape=is_landscape, margin_left=margin_left, margin_bottom=margin_bottom, margin_right=margin_right, margin_top=margin_top, storage=storage) +> file get_html_in_storage_to_pdf(src_path, html_file_name=html_file_name, height=height, width=width, is_landscape=is_landscape, margin_left=margin_left, margin_bottom=margin_bottom, margin_right=margin_right, margin_top=margin_top, storage=storage) Convert HTML file (located on storage) to PDF format and return resulting file in response. @@ -978,7 +1258,7 @@ Convert HTML file (located on storage) to PDF format and return resulting file i Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **src_path** | **str**| Full source filename (ex. /folder1/folder2/template.zip) | - **html_file_name** | **str**| Name of HTML file in ZIP. | + **html_file_name** | **str**| Name of HTML file in ZIP. | [optional] **height** | **float**| Page height | [optional] **width** | **float**| Page width | [optional] **is_landscape** | **bool**| Is page landscaped | [optional] @@ -1157,6 +1437,31 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_ink_annotation** +> InkAnnotationResponse get_ink_annotation(name, annotation_id, storage=storage, folder=folder) + +Read document page ink annotation by ID. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**InkAnnotationResponse**](InkAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_la_te_x_in_storage_to_pdf** > file get_la_te_x_in_storage_to_pdf(src_path, storage=storage) @@ -1230,6 +1535,29 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_list_files** +> FilesResponse get_list_files(path=path, storage=storage) + +Get the file listing of a specific folder + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **str**| Start with name of storage e.g. root folder '/'or some folder '/folder1/..' | [optional] [default to /] + **storage** | **str**| User's storage name | [optional] + +### Return type + +[**FilesResponse**](FilesResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_mht_in_storage_to_pdf** > file get_mht_in_storage_to_pdf(src_path, storage=storage) @@ -1303,6 +1631,31 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_page_caret_annotations** +> CaretAnnotationsResponse get_page_caret_annotations(name, page_number, storage=storage, folder=folder) + +Read document page caret annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**CaretAnnotationsResponse**](CaretAnnotationsResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_page_circle_annotations** > CircleAnnotationsResponse get_page_circle_annotations(name, page_number, storage=storage, folder=folder) @@ -1400,7 +1753,138 @@ Name | Type | Description | Notes ### Return type -**file** +**file** + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_page_convert_to_jpeg** +> file get_page_convert_to_jpeg(name, page_number, width=width, height=height, folder=folder, storage=storage) + +Convert document page to Jpeg image and return resulting file in response. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **width** | **int**| The converted image width. | [optional] + **height** | **int**| The converted image height. | [optional] + **folder** | **str**| The document folder. | [optional] + **storage** | **str**| The document storage. | [optional] + +### Return type + +**file** + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_page_convert_to_png** +> file get_page_convert_to_png(name, page_number, width=width, height=height, folder=folder, storage=storage) + +Convert document page to Png image and return resulting file in response. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **width** | **int**| The converted image width. | [optional] + **height** | **int**| The converted image height. | [optional] + **folder** | **str**| The document folder. | [optional] + **storage** | **str**| The document storage. | [optional] + +### Return type + +**file** + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_page_convert_to_tiff** +> file get_page_convert_to_tiff(name, page_number, width=width, height=height, folder=folder, storage=storage) + +Convert document page to Tiff image and return resulting file in response. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **width** | **int**| The converted image width. | [optional] + **height** | **int**| The converted image height. | [optional] + **folder** | **str**| The document folder. | [optional] + **storage** | **str**| The document storage. | [optional] + +### Return type + +**file** + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_page_free_text_annotations** +> FreeTextAnnotationsResponse get_page_free_text_annotations(name, page_number, storage=storage, folder=folder) + +Read document page free text annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**FreeTextAnnotationsResponse**](FreeTextAnnotationsResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_page_highlight_annotations** +> HighlightAnnotationsResponse get_page_highlight_annotations(name, page_number, storage=storage, folder=folder) + +Read document page highlight annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**HighlightAnnotationsResponse**](HighlightAnnotationsResponse.md) ### HTTP request headers @@ -1409,10 +1893,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_page_convert_to_jpeg** -> file get_page_convert_to_jpeg(name, page_number, width=width, height=height, folder=folder, storage=storage) +# **get_page_ink_annotations** +> InkAnnotationsResponse get_page_ink_annotations(name, page_number, storage=storage, folder=folder) -Convert document page to Jpeg image and return resulting file in response. +Read document page ink annotations. ### Parameters @@ -1420,14 +1904,12 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| The document name. | **page_number** | **int**| The page number. | - **width** | **int**| The converted image width. | [optional] - **height** | **int**| The converted image height. | [optional] - **folder** | **str**| The document folder. | [optional] **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] ### Return type -**file** +[**InkAnnotationsResponse**](InkAnnotationsResponse.md) ### HTTP request headers @@ -1436,10 +1918,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_page_convert_to_png** -> file get_page_convert_to_png(name, page_number, width=width, height=height, folder=folder, storage=storage) +# **get_page_line_annotations** +> LineAnnotationsResponse get_page_line_annotations(name, page_number, storage=storage, folder=folder) -Convert document page to Png image and return resulting file in response. +Read document page line annotations. ### Parameters @@ -1447,14 +1929,12 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| The document name. | **page_number** | **int**| The page number. | - **width** | **int**| The converted image width. | [optional] - **height** | **int**| The converted image height. | [optional] - **folder** | **str**| The document folder. | [optional] **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] ### Return type -**file** +[**LineAnnotationsResponse**](LineAnnotationsResponse.md) ### HTTP request headers @@ -1463,10 +1943,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_page_convert_to_tiff** -> file get_page_convert_to_tiff(name, page_number, width=width, height=height, folder=folder, storage=storage) +# **get_page_link_annotation** +> LinkAnnotationResponse get_page_link_annotation(name, page_number, link_id, storage=storage, folder=folder) -Convert document page to Tiff image and return resulting file in response. +Read document page link annotation by ID. ### Parameters @@ -1474,14 +1954,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| The document name. | **page_number** | **int**| The page number. | - **width** | **int**| The converted image width. | [optional] - **height** | **int**| The converted image height. | [optional] - **folder** | **str**| The document folder. | [optional] + **link_id** | **str**| The link ID. | **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] ### Return type -**file** +[**LinkAnnotationResponse**](LinkAnnotationResponse.md) ### HTTP request headers @@ -1490,10 +1969,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_page_free_text_annotations** -> FreeTextAnnotationsResponse get_page_free_text_annotations(name, page_number, storage=storage, folder=folder) +# **get_page_link_annotations** +> LinkAnnotationsResponse get_page_link_annotations(name, page_number, storage=storage, folder=folder) -Read document page free text annotations. +Read document page link annotations. ### Parameters @@ -1506,7 +1985,7 @@ Name | Type | Description | Notes ### Return type -[**FreeTextAnnotationsResponse**](FreeTextAnnotationsResponse.md) +[**LinkAnnotationsResponse**](LinkAnnotationsResponse.md) ### HTTP request headers @@ -1515,10 +1994,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_page_line_annotations** -> LineAnnotationsResponse get_page_line_annotations(name, page_number, storage=storage, folder=folder) +# **get_page_poly_line_annotations** +> PolyLineAnnotationsResponse get_page_poly_line_annotations(name, page_number, storage=storage, folder=folder) -Read document page line annotations. +Read document page polyline annotations. ### Parameters @@ -1531,7 +2010,7 @@ Name | Type | Description | Notes ### Return type -[**LineAnnotationsResponse**](LineAnnotationsResponse.md) +[**PolyLineAnnotationsResponse**](PolyLineAnnotationsResponse.md) ### HTTP request headers @@ -1540,10 +2019,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_page_link_annotation** -> LinkAnnotationResponse get_page_link_annotation(name, page_number, link_id, storage=storage, folder=folder) +# **get_page_polygon_annotations** +> PolygonAnnotationsResponse get_page_polygon_annotations(name, page_number, storage=storage, folder=folder) -Read document page link annotation by ID. +Read document page polygon annotations. ### Parameters @@ -1551,13 +2030,12 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| The document name. | **page_number** | **int**| The page number. | - **link_id** | **str**| The link ID. | **storage** | **str**| The document storage. | [optional] **folder** | **str**| The document folder. | [optional] ### Return type -[**LinkAnnotationResponse**](LinkAnnotationResponse.md) +[**PolygonAnnotationsResponse**](PolygonAnnotationsResponse.md) ### HTTP request headers @@ -1566,10 +2044,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_page_link_annotations** -> LinkAnnotationsResponse get_page_link_annotations(name, page_number, storage=storage, folder=folder) +# **get_page_popup_annotations** +> PopupAnnotationsResponse get_page_popup_annotations(name, page_number, storage=storage, folder=folder) -Read document page link annotations. +Read document page popup annotations. ### Parameters @@ -1582,7 +2060,7 @@ Name | Type | Description | Notes ### Return type -[**LinkAnnotationsResponse**](LinkAnnotationsResponse.md) +[**PopupAnnotationsResponse**](PopupAnnotationsResponse.md) ### HTTP request headers @@ -1591,10 +2069,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_page_poly_line_annotations** -> PolyLineAnnotationsResponse get_page_poly_line_annotations(name, page_number, storage=storage, folder=folder) +# **get_page_square_annotations** +> SquareAnnotationsResponse get_page_square_annotations(name, page_number, storage=storage, folder=folder) -Read document page polyline annotations. +Read document page square annotations. ### Parameters @@ -1607,7 +2085,7 @@ Name | Type | Description | Notes ### Return type -[**PolyLineAnnotationsResponse**](PolyLineAnnotationsResponse.md) +[**SquareAnnotationsResponse**](SquareAnnotationsResponse.md) ### HTTP request headers @@ -1616,10 +2094,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_page_polygon_annotations** -> PolygonAnnotationsResponse get_page_polygon_annotations(name, page_number, storage=storage, folder=folder) +# **get_page_squiggly_annotations** +> SquigglyAnnotationsResponse get_page_squiggly_annotations(name, page_number, storage=storage, folder=folder) -Read document page polygon annotations. +Read document page squiggly annotations. ### Parameters @@ -1632,7 +2110,7 @@ Name | Type | Description | Notes ### Return type -[**PolygonAnnotationsResponse**](PolygonAnnotationsResponse.md) +[**SquigglyAnnotationsResponse**](SquigglyAnnotationsResponse.md) ### HTTP request headers @@ -1641,10 +2119,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_page_square_annotations** -> SquareAnnotationsResponse get_page_square_annotations(name, page_number, storage=storage, folder=folder) +# **get_page_strike_out_annotations** +> StrikeOutAnnotationsResponse get_page_strike_out_annotations(name, page_number, storage=storage, folder=folder) -Read document page square annotations. +Read document page StrikeOut annotations. ### Parameters @@ -1657,7 +2135,7 @@ Name | Type | Description | Notes ### Return type -[**SquareAnnotationsResponse**](SquareAnnotationsResponse.md) +[**StrikeOutAnnotationsResponse**](StrikeOutAnnotationsResponse.md) ### HTTP request headers @@ -1723,6 +2201,31 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_page_underline_annotations** +> UnderlineAnnotationsResponse get_page_underline_annotations(name, page_number, storage=storage, folder=folder) + +Read document page underline annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**UnderlineAnnotationsResponse**](UnderlineAnnotationsResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_pages** > DocumentPagesResponse get_pages(name, storage=storage, folder=folder) @@ -2169,6 +2672,31 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_popup_annotation** +> PopupAnnotationResponse get_popup_annotation(name, annotation_id, storage=storage, folder=folder) + +Read document page popup annotation by ID. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**PopupAnnotationResponse**](PopupAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_ps_in_storage_to_pdf** > file get_ps_in_storage_to_pdf(src_path, storage=storage) @@ -2217,6 +2745,56 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_squiggly_annotation** +> SquigglyAnnotationResponse get_squiggly_annotation(name, annotation_id, storage=storage, folder=folder) + +Read document page squiggly annotation by ID. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**SquigglyAnnotationResponse**](SquigglyAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_strike_out_annotation** +> StrikeOutAnnotationResponse get_strike_out_annotation(name, annotation_id, storage=storage, folder=folder) + +Read document page StrikeOut annotation by ID. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**StrikeOutAnnotationResponse**](StrikeOutAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_svg_in_storage_to_pdf** > file get_svg_in_storage_to_pdf(src_path, adjust_page_size=adjust_page_size, height=height, width=width, is_landscape=is_landscape, margin_left=margin_left, margin_bottom=margin_bottom, margin_right=margin_right, margin_top=margin_top, storage=storage) @@ -2304,6 +2882,31 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_underline_annotation** +> UnderlineAnnotationResponse get_underline_annotation(name, annotation_id, storage=storage, folder=folder) + +Read document page underline annotation by ID. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**UnderlineAnnotationResponse**](UnderlineAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_verify_signature** > SignatureVerifyResponse get_verify_signature(name, sign_name, storage=storage, folder=folder) @@ -2590,7 +3193,84 @@ Name | Type | Description | Notes # **post_move_page** > AsposeResponse post_move_page(name, page_number, new_index, storage=storage, folder=folder) -Move page to new position. +Move page to new position. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **new_index** | **int**| The new page position/index. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**AsposeResponse**](AsposeResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **post_optimize_document** +> AsposeResponse post_optimize_document(name, options=options, storage=storage, folder=folder) + +Optimize document. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **options** | [**OptimizeOptions**](OptimizeOptions.md)| The optimization options. | [optional] + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**AsposeResponse**](AsposeResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **post_page_caret_annotations** +> AsposeResponse post_page_caret_annotations(name, page_number, annotations, storage=storage, folder=folder) + +Add document page caret annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **annotations** | [**list[CaretAnnotation]**](CaretAnnotation.md)| The array of annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**AsposeResponse**](AsposeResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **post_page_circle_annotations** +> AsposeResponse post_page_circle_annotations(name, page_number, annotations, storage=storage, folder=folder) + +Add document page circle annotations. ### Parameters @@ -2598,7 +3278,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| The document name. | **page_number** | **int**| The page number. | - **new_index** | **int**| The new page position/index. | + **annotations** | [**list[CircleAnnotation]**](CircleAnnotation.md)| The array of annotation. | **storage** | **str**| The document storage. | [optional] **folder** | **str**| The document folder. | [optional] @@ -2613,17 +3293,18 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **post_optimize_document** -> AsposeResponse post_optimize_document(name, options=options, storage=storage, folder=folder) +# **post_page_free_text_annotations** +> AsposeResponse post_page_free_text_annotations(name, page_number, annotations, storage=storage, folder=folder) -Optimize document. +Add document page free text annotations. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| The document name. | - **options** | [**OptimizeOptions**](OptimizeOptions.md)| The optimization options. | [optional] + **page_number** | **int**| The page number. | + **annotations** | [**list[FreeTextAnnotation]**](FreeTextAnnotation.md)| The array of annotation. | **storage** | **str**| The document storage. | [optional] **folder** | **str**| The document folder. | [optional] @@ -2638,10 +3319,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **post_page_circle_annotations** -> AsposeResponse post_page_circle_annotations(name, page_number, annotations, storage=storage, folder=folder) +# **post_page_highlight_annotations** +> AsposeResponse post_page_highlight_annotations(name, page_number, annotations, storage=storage, folder=folder) -Add document page circle annotations. +Add document page highlight annotations. ### Parameters @@ -2649,7 +3330,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| The document name. | **page_number** | **int**| The page number. | - **annotations** | [**list[CircleAnnotation]**](CircleAnnotation.md)| The array of annotation. | + **annotations** | [**list[HighlightAnnotation]**](HighlightAnnotation.md)| The array of annotation. | **storage** | **str**| The document storage. | [optional] **folder** | **str**| The document folder. | [optional] @@ -2664,10 +3345,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **post_page_free_text_annotations** -> AsposeResponse post_page_free_text_annotations(name, page_number, annotations, storage=storage, folder=folder) +# **post_page_ink_annotations** +> AsposeResponse post_page_ink_annotations(name, page_number, annotations, storage=storage, folder=folder) -Add document page free text annotations. +Add document page ink annotations. ### Parameters @@ -2675,7 +3356,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| The document name. | **page_number** | **int**| The page number. | - **annotations** | [**list[FreeTextAnnotation]**](FreeTextAnnotation.md)| The array of annotation. | + **annotations** | [**list[InkAnnotation]**](InkAnnotation.md)| The array of annotation. | **storage** | **str**| The document storage. | [optional] **folder** | **str**| The document folder. | [optional] @@ -2820,6 +3501,58 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **post_page_squiggly_annotations** +> AsposeResponse post_page_squiggly_annotations(name, page_number, annotations, storage=storage, folder=folder) + +Add document page squiggly annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **annotations** | [**list[SquigglyAnnotation]**](SquigglyAnnotation.md)| The array of annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**AsposeResponse**](AsposeResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **post_page_strike_out_annotations** +> AsposeResponse post_page_strike_out_annotations(name, page_number, annotations, storage=storage, folder=folder) + +Add document page StrikeOut annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **annotations** | [**list[StrikeOutAnnotation]**](StrikeOutAnnotation.md)| The array of annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**AsposeResponse**](AsposeResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **post_page_text_annotations** > AsposeResponse post_page_text_annotations(name, page_number, annotations, storage=storage, folder=folder) @@ -2872,6 +3605,58 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **post_page_underline_annotations** +> AsposeResponse post_page_underline_annotations(name, page_number, annotations, storage=storage, folder=folder) + +Add document page underline annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **annotations** | [**list[UnderlineAnnotation]**](UnderlineAnnotation.md)| The array of annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**AsposeResponse**](AsposeResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **post_popup_annotation** +> AsposeResponse post_popup_annotation(name, annotation_id, annotation, storage=storage, folder=folder) + +Add document popup annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The parent annotation ID. | + **annotation** | [**PopupAnnotation**](PopupAnnotation.md)| The annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**AsposeResponse**](AsposeResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **post_sign_document** > AsposeResponse post_sign_document(name, signature=signature, storage=storage, folder=folder) @@ -3000,6 +3785,32 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **put_caret_annotation** +> CaretAnnotationResponse put_caret_annotation(name, annotation_id, annotation, storage=storage, folder=folder) + +Replace document caret annotation + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **annotation** | [**CaretAnnotation**](CaretAnnotation.md)| Annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**CaretAnnotationResponse**](CaretAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **put_circle_annotation** > CircleAnnotationResponse put_circle_annotation(name, annotation_id, annotation, storage=storage, folder=folder) @@ -3150,8 +3961,34 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **put_highlight_annotation** +> HighlightAnnotationResponse put_highlight_annotation(name, annotation_id, annotation, storage=storage, folder=folder) + +Replace document highlight annotation + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **annotation** | [**HighlightAnnotation**](HighlightAnnotation.md)| Annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**HighlightAnnotationResponse**](HighlightAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **put_html_in_storage_to_pdf** -> AsposeResponse put_html_in_storage_to_pdf(name, src_path, html_file_name, height=height, width=width, is_landscape=is_landscape, margin_left=margin_left, margin_bottom=margin_bottom, margin_right=margin_right, margin_top=margin_top, dst_folder=dst_folder, storage=storage) +> AsposeResponse put_html_in_storage_to_pdf(name, src_path, html_file_name=html_file_name, height=height, width=width, is_landscape=is_landscape, margin_left=margin_left, margin_bottom=margin_bottom, margin_right=margin_right, margin_top=margin_top, dst_folder=dst_folder, storage=storage) Convert HTML file (located on storage) to PDF format and upload resulting file to storage. @@ -3161,7 +3998,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| The document name. | **src_path** | **str**| Full source filename (ex. /folder1/folder2/template.zip) | - **html_file_name** | **str**| Name of HTML file in ZIP. | + **html_file_name** | **str**| Name of HTML file in ZIP. | [optional] **height** | **float**| Page height | [optional] **width** | **float**| Page width | [optional] **is_landscape** | **bool**| Is page landscaped | [optional] @@ -3432,6 +4269,32 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **put_ink_annotation** +> InkAnnotationResponse put_ink_annotation(name, annotation_id, annotation, storage=storage, folder=folder) + +Replace document ink annotation + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **annotation** | [**InkAnnotation**](InkAnnotation.md)| Annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**InkAnnotationResponse**](InkAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **put_la_te_x_in_storage_to_pdf** > AsposeResponse put_la_te_x_in_storage_to_pdf(name, src_path, dst_folder=dst_folder, storage=storage) @@ -4538,6 +5401,32 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **put_popup_annotation** +> PopupAnnotationResponse put_popup_annotation(name, annotation_id, annotation, storage=storage, folder=folder) + +Replace document popup annotation + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **annotation** | [**PopupAnnotation**](PopupAnnotation.md)| Annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**PopupAnnotationResponse**](PopupAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **put_privileges** > AsposeResponse put_privileges(name, privileges=privileges, storage=storage, folder=folder) @@ -4692,6 +5581,58 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **put_squiggly_annotation** +> SquigglyAnnotationResponse put_squiggly_annotation(name, annotation_id, annotation, storage=storage, folder=folder) + +Replace document squiggly annotation + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **annotation** | [**SquigglyAnnotation**](SquigglyAnnotation.md)| Annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**SquigglyAnnotationResponse**](SquigglyAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **put_strike_out_annotation** +> StrikeOutAnnotationResponse put_strike_out_annotation(name, annotation_id, annotation, storage=storage, folder=folder) + +Replace document StrikeOut annotation + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **annotation** | [**StrikeOutAnnotation**](StrikeOutAnnotation.md)| Annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**StrikeOutAnnotationResponse**](StrikeOutAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **put_svg_in_storage_to_pdf** > AsposeResponse put_svg_in_storage_to_pdf(name, src_path, adjust_page_size=adjust_page_size, height=height, width=width, is_landscape=is_landscape, margin_left=margin_left, margin_bottom=margin_bottom, margin_right=margin_right, margin_top=margin_top, dst_folder=dst_folder, storage=storage) @@ -4751,6 +5692,32 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **put_underline_annotation** +> UnderlineAnnotationResponse put_underline_annotation(name, annotation_id, annotation, storage=storage, folder=folder) + +Replace document underline annotation + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **annotation** | [**UnderlineAnnotation**](UnderlineAnnotation.md)| Annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**UnderlineAnnotationResponse**](UnderlineAnnotationResponse.md) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **put_update_field** > FieldResponse put_update_field(name, field_name, field=field, storage=storage, folder=folder) diff --git a/docs/PolyAnnotation.md b/docs/PolyAnnotation.md index 8fe734b..c84a215 100644 --- a/docs/PolyAnnotation.md +++ b/docs/PolyAnnotation.md @@ -6,9 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**list[Link]**](Link.md) | Link to the document. | [optional] **contents** | **str** | Get the annotation content. | [optional] -**creation_date** | **str** | The date and time when the annotation was created. | [optional] -**subject** | **str** | Get the annotation subject. | [optional] -**title** | **str** | Get the annotation title. | [optional] **modified** | **str** | The date and time when the annotation was last modified. | [optional] **id** | **str** | Gets ID of the annotation. | [optional] **flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] @@ -18,6 +15,9 @@ Name | Type | Description | Notes **z_index** | **int** | Gets ZIndex of the annotation. | [optional] **horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] **vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] **rich_text** | **str** | Get the annotation RichText. | [optional] **interior_color** | [**Color**](Color.md) | Gets or sets the interior color with which to fill the annotation?s line endings. | [optional] **starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of first line ending. | [optional] diff --git a/docs/PolyLineAnnotation.md b/docs/PolyLineAnnotation.md index c6674f0..2ae5bc4 100644 --- a/docs/PolyLineAnnotation.md +++ b/docs/PolyLineAnnotation.md @@ -6,9 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**list[Link]**](Link.md) | Link to the document. | [optional] **contents** | **str** | Get the annotation content. | [optional] -**creation_date** | **str** | The date and time when the annotation was created. | [optional] -**subject** | **str** | Get the annotation subject. | [optional] -**title** | **str** | Get the annotation title. | [optional] **modified** | **str** | The date and time when the annotation was last modified. | [optional] **id** | **str** | Gets ID of the annotation. | [optional] **flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] @@ -18,6 +15,9 @@ Name | Type | Description | Notes **z_index** | **int** | Gets ZIndex of the annotation. | [optional] **horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] **vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] **rich_text** | **str** | Get the annotation RichText. | [optional] **interior_color** | [**Color**](Color.md) | Gets or sets the interior color with which to fill the annotation?s line endings. | [optional] **starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of first line ending. | [optional] diff --git a/docs/PolygonAnnotation.md b/docs/PolygonAnnotation.md index 75ed6fc..1a684ab 100644 --- a/docs/PolygonAnnotation.md +++ b/docs/PolygonAnnotation.md @@ -6,9 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**list[Link]**](Link.md) | Link to the document. | [optional] **contents** | **str** | Get the annotation content. | [optional] -**creation_date** | **str** | The date and time when the annotation was created. | [optional] -**subject** | **str** | Get the annotation subject. | [optional] -**title** | **str** | Get the annotation title. | [optional] **modified** | **str** | The date and time when the annotation was last modified. | [optional] **id** | **str** | Gets ID of the annotation. | [optional] **flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] @@ -18,6 +15,9 @@ Name | Type | Description | Notes **z_index** | **int** | Gets ZIndex of the annotation. | [optional] **horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] **vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] **rich_text** | **str** | Get the annotation RichText. | [optional] **interior_color** | [**Color**](Color.md) | Gets or sets the interior color with which to fill the annotation?s line endings. | [optional] **starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of first line ending. | [optional] diff --git a/docs/PopupAnnotation.md b/docs/PopupAnnotation.md new file mode 100644 index 0000000..0fb183a --- /dev/null +++ b/docs/PopupAnnotation.md @@ -0,0 +1,23 @@ +# PopupAnnotation +Provides PopupAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**contents** | **str** | Get the annotation content. | [optional] +**modified** | **str** | The date and time when the annotation was last modified. | [optional] +**id** | **str** | Gets ID of the annotation. | [optional] +**flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] +**name** | **str** | Gets Name of the annotation. | [optional] +**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. | [optional] +**page_index** | **int** | Gets PageIndex of the annotation. | [optional] +**z_index** | **int** | Gets ZIndex of the annotation. | [optional] +**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] +**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**color** | [**Color**](Color.md) | Color of the annotation. | [optional] +**open** | **bool** | Gets or sets a flag specifying whether the pop-up annotation should initially be displayed open. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PopupAnnotationResponse.md b/docs/PopupAnnotationResponse.md new file mode 100644 index 0000000..bb92f28 --- /dev/null +++ b/docs/PopupAnnotationResponse.md @@ -0,0 +1,13 @@ +# PopupAnnotationResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotation** | [**PopupAnnotationWithParent**](PopupAnnotationWithParent.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PopupAnnotationWithParent.md b/docs/PopupAnnotationWithParent.md new file mode 100644 index 0000000..6513fb5 --- /dev/null +++ b/docs/PopupAnnotationWithParent.md @@ -0,0 +1,24 @@ +# PopupAnnotationWithParent +Provides PopupAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**contents** | **str** | Get the annotation content. | [optional] +**modified** | **str** | The date and time when the annotation was last modified. | [optional] +**id** | **str** | Gets ID of the annotation. | [optional] +**flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] +**name** | **str** | Gets Name of the annotation. | [optional] +**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. | [optional] +**page_index** | **int** | Gets PageIndex of the annotation. | [optional] +**z_index** | **int** | Gets ZIndex of the annotation. | [optional] +**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] +**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**color** | [**Color**](Color.md) | Color of the annotation. | [optional] +**open** | **bool** | Gets or sets a flag specifying whether the pop-up annotation should initially be displayed open. | [optional] +**parent** | [**AnnotationInfo**](AnnotationInfo.md) | Parent of annotation. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PopupAnnotations.md b/docs/PopupAnnotations.md new file mode 100644 index 0000000..b609935 --- /dev/null +++ b/docs/PopupAnnotations.md @@ -0,0 +1,12 @@ +# PopupAnnotations +List of annotations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**list** | [**list[PopupAnnotationWithParent]**](PopupAnnotationWithParent.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PopupAnnotationsResponse.md b/docs/PopupAnnotationsResponse.md new file mode 100644 index 0000000..4cc59d2 --- /dev/null +++ b/docs/PopupAnnotationsResponse.md @@ -0,0 +1,13 @@ +# PopupAnnotationsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotations** | [**PopupAnnotations**](PopupAnnotations.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SquareAnnotation.md b/docs/SquareAnnotation.md index 0c1adb4..af1d497 100644 --- a/docs/SquareAnnotation.md +++ b/docs/SquareAnnotation.md @@ -6,9 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**list[Link]**](Link.md) | Link to the document. | [optional] **contents** | **str** | Get the annotation content. | [optional] -**creation_date** | **str** | The date and time when the annotation was created. | [optional] -**subject** | **str** | Get the annotation subject. | [optional] -**title** | **str** | Get the annotation title. | [optional] **modified** | **str** | The date and time when the annotation was last modified. | [optional] **id** | **str** | Gets ID of the annotation. | [optional] **flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] @@ -18,6 +15,9 @@ Name | Type | Description | Notes **z_index** | **int** | Gets ZIndex of the annotation. | [optional] **horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] **vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] **rich_text** | **str** | Get the annotation RichText. | [optional] **interior_color** | [**Color**](Color.md) | Get the annotation InteriorColor. | [optional] **frame** | [**RectanglePdf**](RectanglePdf.md) | Get or set the annotation Rectangle of frame. | [optional] diff --git a/docs/SquigglyAnnotation.md b/docs/SquigglyAnnotation.md new file mode 100644 index 0000000..c83bfd9 --- /dev/null +++ b/docs/SquigglyAnnotation.md @@ -0,0 +1,27 @@ +# SquigglyAnnotation +Provides SquigglyAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**contents** | **str** | Get the annotation content. | [optional] +**modified** | **str** | The date and time when the annotation was last modified. | [optional] +**id** | **str** | Gets ID of the annotation. | [optional] +**flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] +**name** | **str** | Gets Name of the annotation. | [optional] +**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. | [optional] +**page_index** | **int** | Gets PageIndex of the annotation. | [optional] +**z_index** | **int** | Gets ZIndex of the annotation. | [optional] +**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] +**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] +**rich_text** | **str** | Get the annotation RichText. | [optional] +**color** | [**Color**](Color.md) | Color of the annotation. | [optional] +**quad_points** | [**list[Point]**](Point.md) | 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. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SquigglyAnnotationResponse.md b/docs/SquigglyAnnotationResponse.md new file mode 100644 index 0000000..25f2db3 --- /dev/null +++ b/docs/SquigglyAnnotationResponse.md @@ -0,0 +1,13 @@ +# SquigglyAnnotationResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotation** | [**SquigglyAnnotation**](SquigglyAnnotation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SquigglyAnnotations.md b/docs/SquigglyAnnotations.md new file mode 100644 index 0000000..2a395d2 --- /dev/null +++ b/docs/SquigglyAnnotations.md @@ -0,0 +1,12 @@ +# SquigglyAnnotations +List of annotations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**list** | [**list[SquigglyAnnotation]**](SquigglyAnnotation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SquigglyAnnotationsResponse.md b/docs/SquigglyAnnotationsResponse.md new file mode 100644 index 0000000..416f0b4 --- /dev/null +++ b/docs/SquigglyAnnotationsResponse.md @@ -0,0 +1,13 @@ +# SquigglyAnnotationsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotations** | [**SquigglyAnnotations**](SquigglyAnnotations.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StrikeOutAnnotation.md b/docs/StrikeOutAnnotation.md new file mode 100644 index 0000000..02c18f9 --- /dev/null +++ b/docs/StrikeOutAnnotation.md @@ -0,0 +1,27 @@ +# StrikeOutAnnotation +Provides StrikeOutAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**contents** | **str** | Get the annotation content. | [optional] +**modified** | **str** | The date and time when the annotation was last modified. | [optional] +**id** | **str** | Gets ID of the annotation. | [optional] +**flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] +**name** | **str** | Gets Name of the annotation. | [optional] +**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. | [optional] +**page_index** | **int** | Gets PageIndex of the annotation. | [optional] +**z_index** | **int** | Gets ZIndex of the annotation. | [optional] +**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] +**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] +**rich_text** | **str** | Get the annotation RichText. | [optional] +**color** | [**Color**](Color.md) | Color of the annotation. | [optional] +**quad_points** | [**list[Point]**](Point.md) | 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. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StrikeOutAnnotationResponse.md b/docs/StrikeOutAnnotationResponse.md new file mode 100644 index 0000000..88def86 --- /dev/null +++ b/docs/StrikeOutAnnotationResponse.md @@ -0,0 +1,13 @@ +# StrikeOutAnnotationResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotation** | [**StrikeOutAnnotation**](StrikeOutAnnotation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StrikeOutAnnotations.md b/docs/StrikeOutAnnotations.md new file mode 100644 index 0000000..93654cc --- /dev/null +++ b/docs/StrikeOutAnnotations.md @@ -0,0 +1,12 @@ +# StrikeOutAnnotations +List of annotations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**list** | [**list[StrikeOutAnnotation]**](StrikeOutAnnotation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StrikeOutAnnotationsResponse.md b/docs/StrikeOutAnnotationsResponse.md new file mode 100644 index 0000000..74caa05 --- /dev/null +++ b/docs/StrikeOutAnnotationsResponse.md @@ -0,0 +1,13 @@ +# StrikeOutAnnotationsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotations** | [**StrikeOutAnnotations**](StrikeOutAnnotations.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TextAnnotation.md b/docs/TextAnnotation.md index 5c1e832..3e1fc34 100644 --- a/docs/TextAnnotation.md +++ b/docs/TextAnnotation.md @@ -6,9 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**list[Link]**](Link.md) | Link to the document. | [optional] **contents** | **str** | Get the annotation content. | [optional] -**creation_date** | **str** | The date and time when the annotation was created. | [optional] -**subject** | **str** | Get the annotation subject. | [optional] -**title** | **str** | Get the annotation title. | [optional] **modified** | **str** | The date and time when the annotation was last modified. | [optional] **id** | **str** | Gets ID of the annotation. | [optional] **flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] @@ -18,6 +15,9 @@ Name | Type | Description | Notes **z_index** | **int** | Gets ZIndex of the annotation. | [optional] **horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] **vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] **rich_text** | **str** | Get the annotation RichText. | [optional] **state** | [**AnnotationState**](AnnotationState.md) | Gets or sets the state to which the original annotation should be set. | [optional] **open** | **bool** | Gets or sets is the annotation open. | [optional] diff --git a/docs/UnderlineAnnotation.md b/docs/UnderlineAnnotation.md new file mode 100644 index 0000000..5527c00 --- /dev/null +++ b/docs/UnderlineAnnotation.md @@ -0,0 +1,27 @@ +# UnderlineAnnotation +Provides UnderlineAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**contents** | **str** | Get the annotation content. | [optional] +**modified** | **str** | The date and time when the annotation was last modified. | [optional] +**id** | **str** | Gets ID of the annotation. | [optional] +**flags** | [**list[AnnotationFlags]**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional] +**name** | **str** | Gets Name of the annotation. | [optional] +**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. | [optional] +**page_index** | **int** | Gets PageIndex of the annotation. | [optional] +**z_index** | **int** | Gets ZIndex of the annotation. | [optional] +**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional] +**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional] +**creation_date** | **str** | The date and time when the annotation was created. | [optional] +**subject** | **str** | Get the annotation subject. | [optional] +**title** | **str** | Get the annotation title. | [optional] +**rich_text** | **str** | Get the annotation RichText. | [optional] +**color** | [**Color**](Color.md) | Color of the annotation. | [optional] +**quad_points** | [**list[Point]**](Point.md) | 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. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UnderlineAnnotationResponse.md b/docs/UnderlineAnnotationResponse.md new file mode 100644 index 0000000..dbdea86 --- /dev/null +++ b/docs/UnderlineAnnotationResponse.md @@ -0,0 +1,13 @@ +# UnderlineAnnotationResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotation** | [**UnderlineAnnotation**](UnderlineAnnotation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UnderlineAnnotations.md b/docs/UnderlineAnnotations.md new file mode 100644 index 0000000..85790ed --- /dev/null +++ b/docs/UnderlineAnnotations.md @@ -0,0 +1,12 @@ +# UnderlineAnnotations +List of annotations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**list** | [**list[UnderlineAnnotation]**](UnderlineAnnotation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UnderlineAnnotationsResponse.md b/docs/UnderlineAnnotationsResponse.md new file mode 100644 index 0000000..2ca4b62 --- /dev/null +++ b/docs/UnderlineAnnotationsResponse.md @@ -0,0 +1,13 @@ +# UnderlineAnnotationsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotations** | [**UnderlineAnnotations**](UnderlineAnnotations.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/setup.py b/setup.py index 02970bf..a0da7d0 100644 --- a/setup.py +++ b/setup.py @@ -32,7 +32,7 @@ from setuptools import setup, find_packages NAME = "asposepdfcloud" -VERSION = "18.10.0" +VERSION = "18.11.0" # To install the library, run the following # # python setup.py install diff --git a/test/pdf_tests.py b/test/pdf_tests.py index 83075b7..151eb20 100644 --- a/test/pdf_tests.py +++ b/test/pdf_tests.py @@ -655,6 +655,598 @@ def testPutTextAnnotation(self): response = self.pdf_api.put_text_annotation(file_name, annotation_id, annotation, folder=self.temp_folder) self.assertEqual(response.code, 201) + + # Highlight Annotations Tests + + def testGetDocumentHighlightAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response = self.pdf_api.get_document_highlight_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetPageHighlightAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 2 + + response = self.pdf_api.get_page_highlight_annotations(file_name, page_number, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetHighlightAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_highlight_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.get_highlight_annotation(file_name, annotation_id, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testPostPageHighlightAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 1 + + annotation = asposepdfcloud.models.HighlightAnnotation() + annotation.name = 'Name' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.rich_text = 'Rich Text' + annotation.subject = 'Subj' + annotation.z_index = 1 + annotation.title = 'Title' + annotation.quad_points = [ + asposepdfcloud.models.Point(10, 10), + asposepdfcloud.models.Point(20, 10), + asposepdfcloud.models.Point(10, 20), + asposepdfcloud.models.Point(10, 10) + ] + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response = self.pdf_api.post_page_highlight_annotations(file_name, page_number, [annotation], folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + def testPutHighlightAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + + annotation = asposepdfcloud.models.HighlightAnnotation() + annotation.name = 'Name Updated' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.rich_text = 'Text Updated' + annotation.subject = 'Subj Updated' + annotation.z_index = 1 + annotation.title = 'Title Updated' + annotation.quad_points = [ + asposepdfcloud.models.Point(10, 10), + asposepdfcloud.models.Point(20, 10), + asposepdfcloud.models.Point(10, 20), + asposepdfcloud.models.Point(10, 10) + ] + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response_annotations = self.pdf_api.get_document_highlight_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.put_highlight_annotation(file_name, annotation_id, annotation, folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + # Underline Annotations Tests + + def testGetDocumentUnderlineAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response = self.pdf_api.get_document_underline_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetPageUnderlineAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 2 + + response = self.pdf_api.get_page_underline_annotations(file_name, page_number, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetUnderlineAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_underline_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.get_underline_annotation(file_name, annotation_id, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testPostPageUnderlineAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 1 + + annotation = asposepdfcloud.models.UnderlineAnnotation() + annotation.name = 'Name' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.rich_text = 'Rich Text' + annotation.subject = 'Subj' + annotation.z_index = 1 + annotation.title = 'Title' + annotation.quad_points = [ + asposepdfcloud.models.Point(10, 10), + asposepdfcloud.models.Point(20, 10), + asposepdfcloud.models.Point(10, 20), + asposepdfcloud.models.Point(10, 10) + ] + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response = self.pdf_api.post_page_underline_annotations(file_name, page_number, [annotation], folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + def testPutUnderlineAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + + annotation = asposepdfcloud.models.UnderlineAnnotation() + annotation.name = 'Name Updated' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.rich_text = 'Text Updated' + annotation.subject = 'Subj Updated' + annotation.z_index = 1 + annotation.title = 'Title Updated' + annotation.quad_points = [ + asposepdfcloud.models.Point(10, 10), + asposepdfcloud.models.Point(20, 10), + asposepdfcloud.models.Point(10, 20), + asposepdfcloud.models.Point(10, 10) + ] + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response_annotations = self.pdf_api.get_document_underline_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.put_underline_annotation(file_name, annotation_id, annotation, folder=self.temp_folder) + self.assertEqual(response.code, 201) + + # Squiggly Annotations Tests + + def testGetDocumentSquigglyAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response = self.pdf_api.get_document_squiggly_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetPageSquigglyAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 2 + + response = self.pdf_api.get_page_squiggly_annotations(file_name, page_number, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetSquigglyAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_squiggly_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.get_squiggly_annotation(file_name, annotation_id, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testPostPageSquigglyAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 1 + + annotation = asposepdfcloud.models.SquigglyAnnotation() + annotation.name = 'Name' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.rich_text = 'Rich Text' + annotation.subject = 'Subj' + annotation.z_index = 1 + annotation.title = 'Title' + annotation.quad_points = [ + asposepdfcloud.models.Point(10, 10), + asposepdfcloud.models.Point(20, 10), + asposepdfcloud.models.Point(10, 20), + asposepdfcloud.models.Point(10, 10) + ] + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response = self.pdf_api.post_page_squiggly_annotations(file_name, page_number, [annotation], folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + def testPutSquigglyAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + + annotation = asposepdfcloud.models.SquigglyAnnotation() + annotation.name = 'Name Updated' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.rich_text = 'Text Updated' + annotation.subject = 'Subj Updated' + annotation.z_index = 1 + annotation.title = 'Title Updated' + annotation.quad_points = [ + asposepdfcloud.models.Point(10, 10), + asposepdfcloud.models.Point(20, 10), + asposepdfcloud.models.Point(10, 20), + asposepdfcloud.models.Point(10, 10) + ] + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response_annotations = self.pdf_api.get_document_squiggly_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.put_squiggly_annotation(file_name, annotation_id, annotation, folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + # StrikeOut Annotations Tests + + def testGetDocumentStrikeOutAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response = self.pdf_api.get_document_strike_out_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetPageStrikeOutAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 2 + + response = self.pdf_api.get_page_strike_out_annotations(file_name, page_number, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetStrikeOutAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_strike_out_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.get_strike_out_annotation(file_name, annotation_id, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testPostPageStrikeOutAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 1 + + annotation = asposepdfcloud.models.StrikeOutAnnotation() + annotation.name = 'Name' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.rich_text = 'Rich Text' + annotation.subject = 'Subj' + annotation.z_index = 1 + annotation.title = 'Title' + annotation.quad_points = [ + asposepdfcloud.models.Point(10, 10), + asposepdfcloud.models.Point(20, 10), + asposepdfcloud.models.Point(10, 20), + asposepdfcloud.models.Point(10, 10) + ] + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response = self.pdf_api.post_page_strike_out_annotations(file_name, page_number, [annotation], folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + def testPutStrikeOutAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + + annotation = asposepdfcloud.models.StrikeOutAnnotation() + annotation.name = 'Name Updated' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.rich_text = 'Text Updated' + annotation.subject = 'Subj Updated' + annotation.z_index = 1 + annotation.title = 'Title Updated' + annotation.quad_points = [ + asposepdfcloud.models.Point(10, 10), + asposepdfcloud.models.Point(20, 10), + asposepdfcloud.models.Point(10, 20), + asposepdfcloud.models.Point(10, 10) + ] + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response_annotations = self.pdf_api.get_document_strike_out_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.put_strike_out_annotation(file_name, annotation_id, annotation, folder=self.temp_folder) + self.assertEqual(response.code, 201) + + # Caret Annotations Tests + + def testGetDocumentCaretAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response = self.pdf_api.get_document_caret_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetPageCaretAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 2 + + response = self.pdf_api.get_page_caret_annotations(file_name, page_number, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetCaretAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_caret_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.get_caret_annotation(file_name, annotation_id, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testPostPageCaretAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 1 + + annotation = asposepdfcloud.models.CaretAnnotation() + annotation.name = 'Name' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.rich_text = 'Rich Text' + annotation.subject = 'Subj' + annotation.z_index = 1 + annotation.title = 'Title' + annotation.frame = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response = self.pdf_api.post_page_caret_annotations(file_name, page_number, [annotation], folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + def testPutCaretAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + + annotation = asposepdfcloud.models.CaretAnnotation() + annotation.name = 'Name Updated' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.rich_text = 'Text Updated' + annotation.subject = 'Subj Updated' + annotation.z_index = 1 + annotation.title = 'Title Updated' + annotation.frame = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response_annotations = self.pdf_api.get_document_caret_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.put_caret_annotation(file_name, annotation_id, annotation, folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + # Ink Annotations Tests + + def testGetDocumentInkAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response = self.pdf_api.get_document_ink_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetPageInkAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 2 + + response = self.pdf_api.get_page_ink_annotations(file_name, page_number, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetInkAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_ink_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.get_ink_annotation(file_name, annotation_id, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testPostPageInkAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 1 + + annotation = asposepdfcloud.models.InkAnnotation() + annotation.name = 'Name' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.rich_text = 'Rich Text' + annotation.subject = 'Subj' + annotation.z_index = 1 + annotation.title = 'Title' + annotation.ink_list = [ + [ + asposepdfcloud.models.Point(10, 40), + asposepdfcloud.models.Point(30, 40), + ], + [ + asposepdfcloud.models.Point(10, 20), + asposepdfcloud.models.Point(20, 20), + asposepdfcloud.models.Point(30, 20), + ] + ] + annotation.cap_style = asposepdfcloud.models.CapStyle.ROUNDED + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response = self.pdf_api.post_page_ink_annotations(file_name, page_number, [annotation], folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + def testPutInkAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + + annotation = asposepdfcloud.models.InkAnnotation() + annotation.name = 'Name Updated' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.rich_text = 'Text Updated' + annotation.subject = 'Subj Updated' + annotation.z_index = 1 + annotation.title = 'Title Updated' + annotation.ink_list = [ + [ + asposepdfcloud.models.Point(10, 40), + asposepdfcloud.models.Point(30, 40), + ], + [ + asposepdfcloud.models.Point(10, 20), + asposepdfcloud.models.Point(20, 20), + asposepdfcloud.models.Point(30, 20), + ] + ] + annotation.cap_style = asposepdfcloud.models.CapStyle.ROUNDED + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response_annotations = self.pdf_api.get_document_ink_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.put_ink_annotation(file_name, annotation_id, annotation, folder=self.temp_folder) + self.assertEqual(response.code, 201) + + # Popup Annotations Tests + + def testGetDocumentPopupAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response = self.pdf_api.get_document_popup_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetDocumentPopupAnnotationsByParent(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + parent_id = 'GI5TAOZRGU3CYNZSGEWDCNZWFQ3TGOI' + + response = self.pdf_api.get_document_popup_annotations_by_parent(file_name, parent_id, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetPagePopupAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 2 + + response = self.pdf_api.get_page_popup_annotations(file_name, page_number, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetPopupAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_popup_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.get_popup_annotation(file_name, annotation_id, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testPostPopupAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + parent_id = 'GI5TCMR3GE2TQLBSGM3CYMJYGUWDENRV' + + annotation = asposepdfcloud.models.PopupAnnotation() + annotation.name = 'Name' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.z_index = 1 + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response = self.pdf_api.post_popup_annotation(file_name, parent_id, annotation, folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + def testPutPopupAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + + annotation = asposepdfcloud.models.PopupAnnotation() + annotation.name = 'Name Updated' + annotation.rect = asposepdfcloud.models.RectanglePdf(llx=100, lly=100, urx=200, ury=200) + annotation.flags = [asposepdfcloud.models.AnnotationFlags.DEFAULT] + annotation.horizontal_alignment = asposepdfcloud.models.HorizontalAlignment.CENTER + annotation.z_index = 1 + annotation.modified = '02/02/2018 00:00:00.000 AM' + + response_annotations = self.pdf_api.get_document_popup_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response_annotations.code, 200) + annotation_id = response_annotations.annotations.list[0].id + + response = self.pdf_api.put_popup_annotation(file_name, annotation_id, annotation, folder=self.temp_folder) + self.assertEqual(response.code, 201) + # Append Tests def testPostAppendDocumentUsingQueryParams(self): @@ -1345,11 +1937,12 @@ def testGetHtmlInStorageToPdf(self): html_file_name = 'HtmlWithImage.html' opts = { - "height" : 650, - "width" : 250 + "height": 650, + "width": 250, + "html_file_name": html_file_name } src_path = self.temp_folder + '/' + file_name - response = self.pdf_api.get_html_in_storage_to_pdf(src_path, html_file_name, **opts) + response = self.pdf_api.get_html_in_storage_to_pdf(src_path, **opts) self.assertIsInstance(response, str) @@ -1364,9 +1957,10 @@ def testPutHtmlInStorageToPdf(self): opts = { "dst_folder" : self.temp_folder, "height" : 650, - "width" : 250 + "width" : 250, + "html_file_name": html_file_name } - response = self.pdf_api.put_html_in_storage_to_pdf(result_name, src_path, html_file_name, **opts) + response = self.pdf_api.put_html_in_storage_to_pdf(result_name, src_path, **opts) self.assertEqual(response.code, 201) @@ -2794,7 +3388,7 @@ def testPutAddText(self): self.assertEqual(response.code, 200) - # Upload / Download Tests + # Storage Tests def testPutCreate(self): file_name = '4pages.pdf' @@ -2807,6 +3401,10 @@ def testGetDownload(self): response = self.pdf_api.get_download(self.temp_folder + '/' + file_name) self.assertIsInstance(response, str) + def testGetListFiles(self): + response = self.pdf_api.get_list_files(path=self.temp_folder) + self.assertEqual(response.code, 200) + if __name__ == '__main__': unittest.main()