diff --git a/.gitignore b/.gitignore index 8c3a3ef..097503b 100644 --- a/.gitignore +++ b/.gitignore @@ -203,3 +203,4 @@ src/Settings/servercreds.json dist/ *.egg-info +.vscode \ No newline at end of file diff --git a/LICENSE b/LICENSE index f216bb4..22aafcb 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2018 Aspose Pty Ltd +Copyright (c) 2019 Aspose Pty Ltd Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 27cf837..c1e0dba 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Aspose.PDF Cloud - API version: 2.0 -- Package version: 18.12.0 +- Package version: 19.1.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. @@ -118,16 +118,20 @@ Class | Method | HTTP request | Description *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_file_attachment_annotations**](docs/PdfApi.md#get_document_file_attachment_annotations) | **GET** /pdf/\{name}/annotations/fileattachment | Read document FileAttachment 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_movie_annotations**](docs/PdfApi.md#get_document_movie_annotations) | **GET** /pdf/\{name}/annotations/movie | Read document movie 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_redaction_annotations**](docs/PdfApi.md#get_document_redaction_annotations) | **GET** /pdf/\{name}/annotations/redaction | Read document redaction annotations. +*PdfApi* | [**get_document_sound_annotations**](docs/PdfApi.md#get_document_sound_annotations) | **GET** /pdf/\{name}/annotations/sound | Read document sound annotations. *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. @@ -138,6 +142,8 @@ Class | Method | HTTP request | Description *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_file_attachment_annotation**](docs/PdfApi.md#get_file_attachment_annotation) | **GET** /pdf/\{name}/annotations/fileattachment/\{annotationId} | Read document page FileAttachment annotation by ID. +*PdfApi* | [**get_file_attachment_annotation_data**](docs/PdfApi.md#get_file_attachment_annotation_data) | **GET** /pdf/\{name}/annotations/fileattachment/\{annotationId}/data | Read document page FileAttachment annotation by ID. *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. @@ -156,6 +162,7 @@ Class | Method | HTTP request | Description *PdfApi* | [**get_list_file_versions**](docs/PdfApi.md#get_list_file_versions) | **GET** /storage/version | Get the file's versions list *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_movie_annotation**](docs/PdfApi.md#get_movie_annotation) | **GET** /pdf/\{name}/annotations/movie/\{annotationId} | Read document page movie annotation by ID. *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. @@ -166,15 +173,19 @@ Class | Method | HTTP request | Description *PdfApi* | [**get_page_convert_to_jpeg**](docs/PdfApi.md#get_page_convert_to_jpeg) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/jpeg | Convert document page to Jpeg image and return resulting file in response. *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_file_attachment_annotations**](docs/PdfApi.md#get_page_file_attachment_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/fileattachment | Read document page FileAttachment annotations. *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_movie_annotations**](docs/PdfApi.md#get_page_movie_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/movie | Read document page movie 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_redaction_annotations**](docs/PdfApi.md#get_page_redaction_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/redaction | Read document page redaction annotations. +*PdfApi* | [**get_page_sound_annotations**](docs/PdfApi.md#get_page_sound_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/sound | Read document page sound 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. @@ -199,6 +210,9 @@ Class | Method | HTTP request | Description *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_redaction_annotation**](docs/PdfApi.md#get_redaction_annotation) | **GET** /pdf/\{name}/annotations/redaction/\{annotationId} | Read document page redaction annotation by ID. +*PdfApi* | [**get_sound_annotation**](docs/PdfApi.md#get_sound_annotation) | **GET** /pdf/\{name}/annotations/sound/\{annotationId} | Read document page sound annotation by ID. +*PdfApi* | [**get_sound_annotation_data**](docs/PdfApi.md#get_sound_annotation_data) | **GET** /pdf/\{name}/annotations/sound/\{annotationId}/data | Read document page sound annotation by ID. *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. @@ -216,7 +230,7 @@ Class | Method | HTTP request | Description *PdfApi* | [**post_append_document**](docs/PdfApi.md#post_append_document) | **POST** /pdf/\{name}/appendDocument | Append document to existing one. *PdfApi* | [**post_create_field**](docs/PdfApi.md#post_create_field) | **POST** /pdf/\{name}/fields | Create field. *PdfApi* | [**post_document_text_replace**](docs/PdfApi.md#post_document_text_replace) | **POST** /pdf/\{name}/text/replace | Document's replace text method. -*PdfApi* | [**post_flatten_document**](docs/PdfApi.md#post_flatten_document) | **POST** /pdf/\{name}/flatten | Removes all fields from the document and place their values instead. +*PdfApi* | [**post_flatten_document**](docs/PdfApi.md#post_flatten_document) | **POST** /pdf/\{name}/flatten | Flatten the document. *PdfApi* | [**post_insert_image**](docs/PdfApi.md#post_insert_image) | **POST** /pdf/\{name}/pages/\{pageNumber}/images | Insert image to document page. *PdfApi* | [**post_move_file**](docs/PdfApi.md#post_move_file) | **POST** /storage/file | Move a specific file *PdfApi* | [**post_move_folder**](docs/PdfApi.md#post_move_folder) | **POST** /storage/folder | Move a specific folder @@ -224,13 +238,17 @@ Class | Method | HTTP request | Description *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_file_attachment_annotations**](docs/PdfApi.md#post_page_file_attachment_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/fileattachment | Add document page FileAttachment 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_movie_annotations**](docs/PdfApi.md#post_page_movie_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/movie | Add document page movie 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_redaction_annotations**](docs/PdfApi.md#post_page_redaction_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/redaction | Add document page redaction annotations. +*PdfApi* | [**post_page_sound_annotations**](docs/PdfApi.md#post_page_sound_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/sound | Add document page sound 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. @@ -250,6 +268,8 @@ Class | Method | HTTP request | Description *PdfApi* | [**put_create_folder**](docs/PdfApi.md#put_create_folder) | **PUT** /storage/folder | Create the folder *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_file_attachment_annotation**](docs/PdfApi.md#put_file_attachment_annotation) | **PUT** /pdf/\{name}/annotations/fileattachment/\{annotationId} | Replace document FileAttachment annotation +*PdfApi* | [**put_file_attachment_annotation_data_extract**](docs/PdfApi.md#put_file_attachment_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/fileattachment/\{annotationId}/data/extract | Extract document FileAttachment annotation content to storage *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. @@ -268,6 +288,7 @@ Class | Method | HTTP request | Description *PdfApi* | [**put_link_annotation**](docs/PdfApi.md#put_link_annotation) | **PUT** /pdf/\{name}/links/\{linkId} | Replace document page link annotations *PdfApi* | [**put_merge_documents**](docs/PdfApi.md#put_merge_documents) | **PUT** /pdf/\{name}/merge | Merge a list of documents. *PdfApi* | [**put_mht_in_storage_to_pdf**](docs/PdfApi.md#put_mht_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/mht | Convert MHT file (located on storage) to PDF format and upload resulting file to storage. +*PdfApi* | [**put_movie_annotation**](docs/PdfApi.md#put_movie_annotation) | **PUT** /pdf/\{name}/annotations/movie/\{annotationId} | Replace document movie annotation *PdfApi* | [**put_page_add_stamp**](docs/PdfApi.md#put_page_add_stamp) | **PUT** /pdf/\{name}/pages/\{pageNumber}/stamp | Add page stamp. *PdfApi* | [**put_page_convert_to_bmp**](docs/PdfApi.md#put_page_convert_to_bmp) | **PUT** /pdf/\{name}/pages/\{pageNumber}/convert/bmp | Convert document page to bmp image and upload resulting file to storage. *PdfApi* | [**put_page_convert_to_emf**](docs/PdfApi.md#put_page_convert_to_emf) | **PUT** /pdf/\{name}/pages/\{pageNumber}/convert/emf | Convert document page to emf image and upload resulting file to storage. @@ -305,9 +326,12 @@ Class | Method | HTTP request | Description *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_redaction_annotation**](docs/PdfApi.md#put_redaction_annotation) | **PUT** /pdf/\{name}/annotations/redaction/\{annotationId} | Replace document redaction annotation *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_sound_annotation**](docs/PdfApi.md#put_sound_annotation) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId} | Replace document sound annotation +*PdfApi* | [**put_sound_annotation_data_extract**](docs/PdfApi.md#put_sound_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId}/data/extract | Extract document sound annotation content to storage *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 @@ -346,6 +370,7 @@ Class | Method | HTTP request | Description - [FieldType](docs/FieldType.md) - [File](docs/File.md) - [FileExist](docs/FileExist.md) + - [FileIcon](docs/FileIcon.md) - [FontEncodingRules](docs/FontEncodingRules.md) - [FontSavingModes](docs/FontSavingModes.md) - [FontStyles](docs/FontStyles.md) @@ -381,6 +406,8 @@ Class | Method | HTTP request | Description - [ShapeType](docs/ShapeType.md) - [Signature](docs/Signature.md) - [SignatureType](docs/SignatureType.md) + - [SoundEncoding](docs/SoundEncoding.md) + - [SoundIcon](docs/SoundIcon.md) - [SplitResult](docs/SplitResult.md) - [Stamp](docs/Stamp.md) - [StampType](docs/StampType.md) @@ -422,6 +449,9 @@ Class | Method | HTTP request | Description - [FieldResponse](docs/FieldResponse.md) - [Fields](docs/Fields.md) - [FieldsResponse](docs/FieldsResponse.md) + - [FileAttachmentAnnotationResponse](docs/FileAttachmentAnnotationResponse.md) + - [FileAttachmentAnnotations](docs/FileAttachmentAnnotations.md) + - [FileAttachmentAnnotationsResponse](docs/FileAttachmentAnnotationsResponse.md) - [FileExistResponse](docs/FileExistResponse.md) - [FileVersion](docs/FileVersion.md) - [FileVersionsResponse](docs/FileVersionsResponse.md) @@ -446,6 +476,9 @@ Class | Method | HTTP request | Description - [LinkAnnotationResponse](docs/LinkAnnotationResponse.md) - [LinkAnnotations](docs/LinkAnnotations.md) - [LinkAnnotationsResponse](docs/LinkAnnotationsResponse.md) + - [MovieAnnotationResponse](docs/MovieAnnotationResponse.md) + - [MovieAnnotations](docs/MovieAnnotations.md) + - [MovieAnnotationsResponse](docs/MovieAnnotationsResponse.md) - [Page](docs/Page.md) - [Pages](docs/Pages.md) - [PolyLineAnnotationResponse](docs/PolyLineAnnotationResponse.md) @@ -457,7 +490,13 @@ Class | Method | HTTP request | Description - [PopupAnnotationResponse](docs/PopupAnnotationResponse.md) - [PopupAnnotations](docs/PopupAnnotations.md) - [PopupAnnotationsResponse](docs/PopupAnnotationsResponse.md) + - [RedactionAnnotationResponse](docs/RedactionAnnotationResponse.md) + - [RedactionAnnotations](docs/RedactionAnnotations.md) + - [RedactionAnnotationsResponse](docs/RedactionAnnotationsResponse.md) - [SignatureVerifyResponse](docs/SignatureVerifyResponse.md) + - [SoundAnnotationResponse](docs/SoundAnnotationResponse.md) + - [SoundAnnotations](docs/SoundAnnotations.md) + - [SoundAnnotationsResponse](docs/SoundAnnotationsResponse.md) - [SplitResultDocument](docs/SplitResultDocument.md) - [SplitResultResponse](docs/SplitResultResponse.md) - [SquareAnnotationResponse](docs/SquareAnnotationResponse.md) @@ -481,15 +520,19 @@ Class | Method | HTTP request | Description - [WordCountResponse](docs/WordCountResponse.md) - [AnnotationInfo](docs/AnnotationInfo.md) - [MarkupAnnotation](docs/MarkupAnnotation.md) + - [MovieAnnotation](docs/MovieAnnotation.md) - [PopupAnnotation](docs/PopupAnnotation.md) + - [RedactionAnnotation](docs/RedactionAnnotation.md) - [CaretAnnotation](docs/CaretAnnotation.md) - [CommonFigureAnnotation](docs/CommonFigureAnnotation.md) + - [FileAttachmentAnnotation](docs/FileAttachmentAnnotation.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) + - [SoundAnnotation](docs/SoundAnnotation.md) - [SquigglyAnnotation](docs/SquigglyAnnotation.md) - [StrikeOutAnnotation](docs/StrikeOutAnnotation.md) - [TextAnnotation](docs/TextAnnotation.md) diff --git a/__init__.py b/__init__.py index 7134c29..7d9b5e2 100644 --- a/__init__.py +++ b/__init__.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/__init__.py b/asposepdfcloud/__init__.py index e9ee6c8..317e2f5 100644 --- a/asposepdfcloud/__init__.py +++ b/asposepdfcloud/__init__.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 @@ -51,6 +51,7 @@ from .models.field_type import FieldType from .models.file import File from .models.file_exist import FileExist +from .models.file_icon import FileIcon from .models.font_encoding_rules import FontEncodingRules from .models.font_saving_modes import FontSavingModes from .models.font_styles import FontStyles @@ -86,6 +87,8 @@ from .models.shape_type import ShapeType from .models.signature import Signature from .models.signature_type import SignatureType +from .models.sound_encoding import SoundEncoding +from .models.sound_icon import SoundIcon from .models.split_result import SplitResult from .models.stamp import Stamp from .models.stamp_type import StampType @@ -127,6 +130,9 @@ from .models.field_response import FieldResponse from .models.fields import Fields from .models.fields_response import FieldsResponse +from .models.file_attachment_annotation_response import FileAttachmentAnnotationResponse +from .models.file_attachment_annotations import FileAttachmentAnnotations +from .models.file_attachment_annotations_response import FileAttachmentAnnotationsResponse from .models.file_exist_response import FileExistResponse from .models.file_version import FileVersion from .models.file_versions_response import FileVersionsResponse @@ -151,6 +157,9 @@ from .models.link_annotation_response import LinkAnnotationResponse from .models.link_annotations import LinkAnnotations from .models.link_annotations_response import LinkAnnotationsResponse +from .models.movie_annotation_response import MovieAnnotationResponse +from .models.movie_annotations import MovieAnnotations +from .models.movie_annotations_response import MovieAnnotationsResponse from .models.page import Page from .models.pages import Pages from .models.poly_line_annotation_response import PolyLineAnnotationResponse @@ -162,7 +171,13 @@ from .models.popup_annotation_response import PopupAnnotationResponse from .models.popup_annotations import PopupAnnotations from .models.popup_annotations_response import PopupAnnotationsResponse +from .models.redaction_annotation_response import RedactionAnnotationResponse +from .models.redaction_annotations import RedactionAnnotations +from .models.redaction_annotations_response import RedactionAnnotationsResponse from .models.signature_verify_response import SignatureVerifyResponse +from .models.sound_annotation_response import SoundAnnotationResponse +from .models.sound_annotations import SoundAnnotations +from .models.sound_annotations_response import SoundAnnotationsResponse from .models.split_result_document import SplitResultDocument from .models.split_result_response import SplitResultResponse from .models.square_annotation_response import SquareAnnotationResponse @@ -186,15 +201,19 @@ from .models.word_count_response import WordCountResponse from .models.annotation_info import AnnotationInfo from .models.markup_annotation import MarkupAnnotation +from .models.movie_annotation import MovieAnnotation from .models.popup_annotation import PopupAnnotation +from .models.redaction_annotation import RedactionAnnotation from .models.caret_annotation import CaretAnnotation from .models.common_figure_annotation import CommonFigureAnnotation +from .models.file_attachment_annotation import FileAttachmentAnnotation 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.sound_annotation import SoundAnnotation from .models.squiggly_annotation import SquigglyAnnotation from .models.strike_out_annotation import StrikeOutAnnotation from .models.text_annotation import TextAnnotation diff --git a/asposepdfcloud/api_client.py b/asposepdfcloud/api_client.py index 662f2d1..486e380 100644 --- a/asposepdfcloud/api_client.py +++ b/asposepdfcloud/api_client.py @@ -3,7 +3,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 @@ -166,10 +166,6 @@ def __call_api(self, resource_path, method, guess_type(filename)[0] or 'application/octet-stream' header_params['Content-Type'] = mimetype - - # auth setting - self.update_params_for_auth(header_params, query_params, auth_settings) - # body if body: body = self.sanitize_for_serialization(body) @@ -611,33 +607,6 @@ def select_header_content_type(self, content_types): else: return content_types[0] - def update_params_for_auth(self, headers, querys, auth_settings): - """ - Updates header and query params based on authentication setting. - - :param headers: Header parameters dict to be updated. - :param querys: Query parameters tuple list to be updated. - :param auth_settings: Authentication setting identifiers list. - """ - config = Configuration() - - if not auth_settings: - return - - for auth in auth_settings: - auth_setting = config.auth_settings().get(auth) - if auth_setting: - if not auth_setting['value']: - continue - elif auth_setting['in'] == 'header': - headers[auth_setting['key']] = auth_setting['value'] - elif auth_setting['in'] == 'query': - querys.append((auth_setting['key'], auth_setting['value'])) - else: - raise ValueError( - 'Authentication token must be in `query` or `header`' - ) - def __deserialize_file(self, response): """ Saves response body into a file in a temporary folder, @@ -653,7 +622,7 @@ def __deserialize_file(self, response): os.remove(path) content_disposition = response.getheader("Content-Disposition") - if content_disposition: + if content_disposition and content_disposition != "attachment": filename = re.\ search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', content_disposition).\ group(1) @@ -713,9 +682,9 @@ def __deserialize_date(self, string): ) def __deserialize_datatime(self, string): - match = re.match(r"\/Date\((\d+?)000\+0000\)\/", string) + match = re.match(r'/Date\((\d+?)000\+0000\)/', string, flags=re.UNICODE) if match: - dt = datetime.utcfromtimestamp(int(match[1])) + dt = datetime.utcfromtimestamp(int(match.group(1))) return dt else: return None diff --git a/asposepdfcloud/apis/__init__.py b/asposepdfcloud/apis/__init__.py index cb98c20..439a651 100644 --- a/asposepdfcloud/apis/__init__.py +++ b/asposepdfcloud/apis/__init__.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/apis/pdf_api.py b/asposepdfcloud/apis/pdf_api.py index 1427c4c..8ec7d5e 100644 --- a/asposepdfcloud/apis/pdf_api.py +++ b/asposepdfcloud/apis/pdf_api.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 @@ -2703,6 +2703,118 @@ def get_document_circle_annotations_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_document_file_attachment_annotations(self, name, **kwargs): + """ + Read document FileAttachment 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_file_attachment_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: FileAttachmentAnnotationsResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_document_file_attachment_annotations_with_http_info(name, **kwargs) + else: + (data) = self.get_document_file_attachment_annotations_with_http_info(name, **kwargs) + return data + + def get_document_file_attachment_annotations_with_http_info(self, name, **kwargs): + """ + Read document FileAttachment 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_file_attachment_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: FileAttachmentAnnotationsResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', '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_document_file_attachment_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_file_attachment_annotations`") + + + 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 + # 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/fileattachment', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='FileAttachmentAnnotationsResponse', + 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_document_free_text_annotations(self, name, **kwargs): """ Read document free text annotations. @@ -3151,6 +3263,118 @@ def get_document_line_annotations_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_document_movie_annotations(self, name, **kwargs): + """ + Read document movie 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_movie_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: MovieAnnotationsResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_document_movie_annotations_with_http_info(name, **kwargs) + else: + (data) = self.get_document_movie_annotations_with_http_info(name, **kwargs) + return data + + def get_document_movie_annotations_with_http_info(self, name, **kwargs): + """ + Read document movie 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_movie_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: MovieAnnotationsResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', '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_document_movie_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_movie_annotations`") + + + 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 + # 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/movie', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='MovieAnnotationsResponse', + 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_document_poly_line_annotations(self, name, **kwargs): """ Read document polyline annotations. @@ -3837,50 +4061,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_redaction_annotations(self, name, **kwargs): """ - Read document square annotations. + Read document redaction 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_redaction_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: RedactionAnnotationsResponse 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_redaction_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_document_square_annotations_with_http_info(name, **kwargs) + (data) = self.get_document_redaction_annotations_with_http_info(name, **kwargs) return data - def get_document_square_annotations_with_http_info(self, name, **kwargs): + def get_document_redaction_annotations_with_http_info(self, name, **kwargs): """ - Read document square annotations. + Read document redaction 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_redaction_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: RedactionAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -3896,13 +4120,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_redaction_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_redaction_annotations`") collection_formats = {} @@ -3934,14 +4158,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/redaction', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SquareAnnotationsResponse', + response_type='RedactionAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3949,50 +4173,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_squiggly_annotations(self, name, **kwargs): + def get_document_sound_annotations(self, name, **kwargs): """ - Read document squiggly annotations. + Read document sound 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_squiggly_annotations(name, callback=callback_function) + >>> thread = api.get_document_sound_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: SquigglyAnnotationsResponse + :return: SoundAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_document_squiggly_annotations_with_http_info(name, **kwargs) + return self.get_document_sound_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_document_squiggly_annotations_with_http_info(name, **kwargs) + (data) = self.get_document_sound_annotations_with_http_info(name, **kwargs) return data - def get_document_squiggly_annotations_with_http_info(self, name, **kwargs): + def get_document_sound_annotations_with_http_info(self, name, **kwargs): """ - Read document squiggly annotations. + Read document sound 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_squiggly_annotations_with_http_info(name, callback=callback_function) + >>> thread = api.get_document_sound_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: SquigglyAnnotationsResponse + :return: SoundAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -4008,13 +4232,13 @@ def get_document_squiggly_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_squiggly_annotations" % key + " to method get_document_sound_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_squiggly_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_document_sound_annotations`") collection_formats = {} @@ -4046,14 +4270,14 @@ def get_document_squiggly_annotations_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/squiggly', 'GET', + return self.api_client.call_api('/pdf/{name}/annotations/sound', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SquigglyAnnotationsResponse', + response_type='SoundAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4061,50 +4285,50 @@ def get_document_squiggly_annotations_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_document_strike_out_annotations(self, name, **kwargs): + def get_document_square_annotations(self, name, **kwargs): """ - Read document StrikeOut annotations. + 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_document_strike_out_annotations(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 storage: The document storage. :param str folder: The document folder. - :return: StrikeOutAnnotationsResponse + :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_document_strike_out_annotations_with_http_info(name, **kwargs) + return self.get_document_square_annotations_with_http_info(name, **kwargs) else: - (data) = self.get_document_strike_out_annotations_with_http_info(name, **kwargs) + (data) = self.get_document_square_annotations_with_http_info(name, **kwargs) return data - def get_document_strike_out_annotations_with_http_info(self, name, **kwargs): + def get_document_square_annotations_with_http_info(self, name, **kwargs): """ - Read document StrikeOut annotations. + 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_document_strike_out_annotations_with_http_info(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 storage: The document storage. :param str folder: The document folder. - :return: StrikeOutAnnotationsResponse + :return: SquareAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -4120,13 +4344,13 @@ def get_document_strike_out_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_strike_out_annotations" % 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_document_strike_out_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_document_square_annotations`") collection_formats = {} @@ -4158,14 +4382,14 @@ def get_document_strike_out_annotations_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/strikeout', '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='StrikeOutAnnotationsResponse', + response_type='SquareAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -4173,9 +4397,233 @@ def get_document_strike_out_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_squiggly_annotations(self, name, **kwargs): """ - Read document text annotations. + 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_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: SquigglyAnnotationsResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_document_squiggly_annotations_with_http_info(name, **kwargs) + else: + (data) = self.get_document_squiggly_annotations_with_http_info(name, **kwargs) + return data + + def get_document_squiggly_annotations_with_http_info(self, name, **kwargs): + """ + 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_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: SquigglyAnnotationsResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', '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_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_document_squiggly_annotations`") + + + 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 + # 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/squiggly', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='SquigglyAnnotationsResponse', + 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_document_strike_out_annotations(self, name, **kwargs): + """ + 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_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 storage: The document storage. + :param str folder: The document folder. + :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_document_strike_out_annotations_with_http_info(name, **kwargs) + else: + (data) = self.get_document_strike_out_annotations_with_http_info(name, **kwargs) + return data + + def get_document_strike_out_annotations_with_http_info(self, name, **kwargs): + """ + 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_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 storage: The document storage. + :param str folder: The document folder. + :return: StrikeOutAnnotationsResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', '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_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_document_strike_out_annotations`") + + + 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 + # 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/strikeout', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='StrikeOutAnnotationsResponse', + 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_document_text_annotations(self, name, **kwargs): + """ + 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. @@ -4967,16 +5415,16 @@ 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_file_attachment_annotation(self, name, annotation_id, **kwargs): """ - Read document page free text annotation by ID. + Read document page FileAttachment 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_free_text_annotation(name, annotation_id, callback=callback_function) + >>> thread = api.get_file_attachment_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -4984,27 +5432,27 @@ def get_free_text_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: FreeTextAnnotationResponse + :return: FileAttachmentAnnotationResponse 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_file_attachment_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_free_text_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_file_attachment_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_file_attachment_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Read document page free text annotation by ID. + Read document page FileAttachment 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_free_text_annotation_with_http_info(name, annotation_id, callback=callback_function) + >>> thread = api.get_file_attachment_annotation_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -5012,7 +5460,7 @@ def get_free_text_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: FreeTextAnnotationResponse + :return: FileAttachmentAnnotationResponse If the method is called asynchronously, returns the request thread. """ @@ -5028,16 +5476,16 @@ 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_file_attachment_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_free_text_annotation`") + raise ValueError("Missing the required parameter `name` when calling `get_file_attachment_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 `annotation_id` when calling `get_file_attachment_annotation`") collection_formats = {} @@ -5071,14 +5519,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/fileattachment/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FreeTextAnnotationResponse', + response_type='FileAttachmentAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -5086,16 +5534,16 @@ 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_highlight_annotation(self, name, annotation_id, **kwargs): + def get_file_attachment_annotation_data(self, name, annotation_id, **kwargs): """ - Read document page highlight annotation by ID. + Read document page FileAttachment 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_highlight_annotation(name, annotation_id, callback=callback_function) + >>> thread = api.get_file_attachment_annotation_data(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -5103,27 +5551,27 @@ def get_highlight_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: HighlightAnnotationResponse + :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_highlight_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_file_attachment_annotation_data_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_highlight_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_file_attachment_annotation_data_with_http_info(name, annotation_id, **kwargs) return data - def get_highlight_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_file_attachment_annotation_data_with_http_info(self, name, annotation_id, **kwargs): """ - Read document page highlight annotation by ID. + Read document page FileAttachment 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_highlight_annotation_with_http_info(name, annotation_id, callback=callback_function) + >>> thread = api.get_file_attachment_annotation_data_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -5131,7 +5579,7 @@ def get_highlight_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: HighlightAnnotationResponse + :return: file If the method is called asynchronously, returns the request thread. """ @@ -5147,16 +5595,16 @@ def get_highlight_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_highlight_annotation" % key + " to method get_file_attachment_annotation_data" % 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_highlight_annotation`") + raise ValueError("Missing the required parameter `name` when calling `get_file_attachment_annotation_data`") # 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_highlight_annotation`") + raise ValueError("Missing the required parameter `annotation_id` when calling `get_file_attachment_annotation_data`") collection_formats = {} @@ -5181,7 +5629,245 @@ def get_highlight_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.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api('/pdf/{name}/annotations/fileattachment/{annotationId}/data', 'GET', + 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 get_free_text_annotation(self, name, annotation_id, **kwargs): + """ + 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_free_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 str annotation_id: The annotation ID. (required) + :param str storage: The document storage. + :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_free_text_annotation_with_http_info(name, annotation_id, **kwargs) + else: + (data) = self.get_free_text_annotation_with_http_info(name, annotation_id, **kwargs) + return data + + def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs): + """ + 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_free_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 str annotation_id: The annotation ID. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: FreeTextAnnotationResponse + 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_free_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 `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 '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/freetext/{annotationId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='FreeTextAnnotationResponse', + 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_highlight_annotation(self, name, annotation_id, **kwargs): + """ + 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_highlight_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: HighlightAnnotationResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_highlight_annotation_with_http_info(name, annotation_id, **kwargs) + else: + (data) = self.get_highlight_annotation_with_http_info(name, annotation_id, **kwargs) + return data + + def get_highlight_annotation_with_http_info(self, name, annotation_id, **kwargs): + """ + 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_highlight_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: HighlightAnnotationResponse + 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_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_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_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 '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.\ @@ -7093,57 +7779,57 @@ 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_movie_annotation(self, name, annotation_id, **kwargs): """ - Read document page info. + Read document page movie 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(name, page_number, callback=callback_function) + >>> thread = api.get_movie_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 str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: DocumentPageResponse + :return: MovieAnnotationResponse 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_movie_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_page_with_http_info(name, page_number, **kwargs) + (data) = self.get_movie_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_page_with_http_info(self, name, page_number, **kwargs): + def get_movie_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Read document page info. + Read document page movie 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_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_movie_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 str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: DocumentPageResponse + :return: MovieAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', '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') @@ -7154,14 +7840,133 @@ 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_movie_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`") - # verify the required parameter 'page_number' is set + raise ValueError("Missing the required parameter `name` when calling `get_movie_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_movie_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/movie/{annotationId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='MovieAnnotationResponse', + 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_page(self, name, page_number, **kwargs): + """ + 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(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 str folder: The document folder. + :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_with_http_info(name, page_number, **kwargs) + else: + (data) = self.get_page_with_http_info(name, page_number, **kwargs) + return data + + def get_page_with_http_info(self, name, page_number, **kwargs): + """ + 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_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 str folder: The document folder. + :return: DocumentPageResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', '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_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`") + # 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`") @@ -8331,6 +9136,125 @@ 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_file_attachment_annotations(self, name, page_number, **kwargs): + """ + Read document page FileAttachment 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_file_attachment_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 page_number: The page number. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: FileAttachmentAnnotationsResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_page_file_attachment_annotations_with_http_info(name, page_number, **kwargs) + else: + (data) = self.get_page_file_attachment_annotations_with_http_info(name, page_number, **kwargs) + return data + + def get_page_file_attachment_annotations_with_http_info(self, name, page_number, **kwargs): + """ + Read document page FileAttachment 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_file_attachment_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 page_number: The page number. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: FileAttachmentAnnotationsResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['name', 'page_number', '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_page_file_attachment_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_file_attachment_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_file_attachment_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 '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}/pages/{pageNumber}/annotations/fileattachment', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='FileAttachmentAnnotationsResponse', + 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_page_free_text_annotations(self, name, page_number, **kwargs): """ Read document page free text annotations. @@ -9052,16 +9976,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_movie_annotations(self, name, page_number, **kwargs): """ - Read document page polyline annotations. + Read document page movie 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_movie_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -9069,27 +9993,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: MovieAnnotationsResponse 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_movie_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_movie_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_movie_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page polyline annotations. + Read document page movie 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_movie_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -9097,7 +10021,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: MovieAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -9113,16 +10037,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_movie_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_movie_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_movie_annotations`") collection_formats = {} @@ -9156,14 +10080,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/movie', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PolyLineAnnotationsResponse', + response_type='MovieAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9171,16 +10095,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_poly_line_annotations(self, name, page_number, **kwargs): """ - Read document page polygon annotations. + 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_page_polygon_annotations(name, page_number, 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) @@ -9188,27 +10112,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: PolyLineAnnotationsResponse 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_poly_line_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_poly_line_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_poly_line_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page polygon annotations. + 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_page_polygon_annotations_with_http_info(name, page_number, 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) @@ -9216,7 +10140,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: PolyLineAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -9232,16 +10156,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_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_page_polygon_annotations`") + 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_polygon_annotations`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_poly_line_annotations`") collection_formats = {} @@ -9275,14 +10199,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/polyline', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PolygonAnnotationsResponse', + response_type='PolyLineAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9290,16 +10214,16 @@ 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_popup_annotations(self, name, page_number, **kwargs): + def get_page_polygon_annotations(self, name, page_number, **kwargs): """ - Read document page popup annotations. + 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_page_popup_annotations(name, page_number, 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) @@ -9307,27 +10231,27 @@ def get_page_popup_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: PopupAnnotationsResponse + :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_page_popup_annotations_with_http_info(name, page_number, **kwargs) + return self.get_page_polygon_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_page_popup_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_page_polygon_annotations_with_http_info(name, page_number, **kwargs) return data - def get_page_popup_annotations_with_http_info(self, name, page_number, **kwargs): + def get_page_polygon_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page popup annotations. + 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_page_popup_annotations_with_http_info(name, page_number, 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) @@ -9335,7 +10259,7 @@ def get_page_popup_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: PopupAnnotationsResponse + :return: PolygonAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -9351,16 +10275,16 @@ def get_page_popup_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_popup_annotations" % 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_page_popup_annotations`") + 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_popup_annotations`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_polygon_annotations`") collection_formats = {} @@ -9394,14 +10318,14 @@ def get_page_popup_annotations_with_http_info(self, name, page_number, **kwargs) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/popup', '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='PopupAnnotationsResponse', + response_type='PolygonAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9409,16 +10333,16 @@ def get_page_popup_annotations_with_http_info(self, name, page_number, **kwargs) _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_square_annotations(self, name, page_number, **kwargs): + def get_page_popup_annotations(self, name, page_number, **kwargs): """ - Read document page square annotations. + 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_page_square_annotations(name, page_number, 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) @@ -9426,27 +10350,27 @@ def get_page_square_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: SquareAnnotationsResponse + :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_page_square_annotations_with_http_info(name, page_number, **kwargs) + return self.get_page_popup_annotations_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_popup_annotations_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_popup_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page square annotations. + 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_page_square_annotations_with_http_info(name, page_number, 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) @@ -9454,7 +10378,7 @@ def get_page_square_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: SquareAnnotationsResponse + :return: PopupAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -9470,16 +10394,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_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_page_square_annotations`") + 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_square_annotations`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_popup_annotations`") collection_formats = {} @@ -9513,14 +10437,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}/annotations/popup', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SquareAnnotationsResponse', + response_type='PopupAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9528,16 +10452,16 @@ 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_squiggly_annotations(self, name, page_number, **kwargs): + def get_page_redaction_annotations(self, name, page_number, **kwargs): """ - Read document page squiggly annotations. + Read document page redaction 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_squiggly_annotations(name, page_number, callback=callback_function) + >>> thread = api.get_page_redaction_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -9545,27 +10469,27 @@ def get_page_squiggly_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: SquigglyAnnotationsResponse + :return: RedactionAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_squiggly_annotations_with_http_info(name, page_number, **kwargs) + return self.get_page_redaction_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_page_squiggly_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_page_redaction_annotations_with_http_info(name, page_number, **kwargs) return data - def get_page_squiggly_annotations_with_http_info(self, name, page_number, **kwargs): + def get_page_redaction_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page squiggly annotations. + Read document page redaction 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_squiggly_annotations_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_page_redaction_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -9573,7 +10497,7 @@ def get_page_squiggly_annotations_with_http_info(self, name, page_number, **kwar :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SquigglyAnnotationsResponse + :return: RedactionAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -9589,16 +10513,16 @@ def get_page_squiggly_annotations_with_http_info(self, name, page_number, **kwar if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_squiggly_annotations" % key + " to method get_page_redaction_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_squiggly_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_page_redaction_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`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_redaction_annotations`") collection_formats = {} @@ -9632,14 +10556,14 @@ def get_page_squiggly_annotations_with_http_info(self, name, page_number, **kwar # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/squiggly', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/redaction', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SquigglyAnnotationsResponse', + response_type='RedactionAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9647,16 +10571,16 @@ def get_page_squiggly_annotations_with_http_info(self, name, page_number, **kwar _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_page_strike_out_annotations(self, name, page_number, **kwargs): + def get_page_sound_annotations(self, name, page_number, **kwargs): """ - Read document page StrikeOut annotations. + Read document page sound 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_strike_out_annotations(name, page_number, callback=callback_function) + >>> thread = api.get_page_sound_annotations(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -9664,27 +10588,27 @@ def get_page_strike_out_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: StrikeOutAnnotationsResponse + :return: SoundAnnotationsResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_page_strike_out_annotations_with_http_info(name, page_number, **kwargs) + return self.get_page_sound_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_page_strike_out_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_page_sound_annotations_with_http_info(name, page_number, **kwargs) return data - def get_page_strike_out_annotations_with_http_info(self, name, page_number, **kwargs): + def get_page_sound_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page StrikeOut annotations. + Read document page sound 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_strike_out_annotations_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.get_page_sound_annotations_with_http_info(name, page_number, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -9692,7 +10616,7 @@ def get_page_strike_out_annotations_with_http_info(self, name, page_number, **kw :param int page_number: The page number. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: StrikeOutAnnotationsResponse + :return: SoundAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -9708,16 +10632,16 @@ def get_page_strike_out_annotations_with_http_info(self, name, page_number, **kw if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_page_strike_out_annotations" % key + " to method get_page_sound_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_strike_out_annotations`") + raise ValueError("Missing the required parameter `name` when calling `get_page_sound_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`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_sound_annotations`") collection_formats = {} @@ -9751,14 +10675,14 @@ def get_page_strike_out_annotations_with_http_info(self, name, page_number, **kw # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/strikeout', 'GET', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/sound', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='StrikeOutAnnotationsResponse', + response_type='SoundAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9766,71 +10690,57 @@ def get_page_strike_out_annotations_with_http_info(self, name, page_number, **kw _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_square_annotations(self, name, page_number, **kwargs): """ - Read page text items. + 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_page_text(name, page_number, llx, lly, urx, ury, 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 int page_number: Number of page (starting from 1). (required) - :param float llx: X-coordinate of lower - left corner. (required) - :param float lly: Y - coordinate of lower-left corner. (required) - :param float urx: X - coordinate of upper-right corner. (required) - :param float ury: Y - coordinate of upper-right corner. (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 int page_number: The page number. (required) :param str storage: The document storage. - :return: TextRectsResponse + :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_page_text_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) + return self.get_page_square_annotations_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_square_annotations_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_square_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read page text items. + 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_page_text_with_http_info(name, page_number, llx, lly, urx, ury, 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 int page_number: Number of page (starting from 1). (required) - :param float llx: X-coordinate of lower - left corner. (required) - :param float lly: Y - coordinate of lower-left corner. (required) - :param float urx: X - coordinate of upper-right corner. (required) - :param float ury: Y - coordinate of upper-right corner. (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 int page_number: The page number. (required) :param str storage: The document storage. - :return: TextRectsResponse + :param str folder: The document folder. + :return: SquareAnnotationsResponse 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', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -9841,28 +10751,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_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_page_text`") + 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_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_square_annotations`") collection_formats = {} @@ -9874,25 +10772,10 @@ 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 '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'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -9911,14 +10794,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}/annotations/square', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TextRectsResponse', + response_type='SquareAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -9926,16 +10809,16 @@ 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_squiggly_annotations(self, name, page_number, **kwargs): """ - Read document page text annotations. + 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_page_text_annotations(name, page_number, 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) @@ -9943,27 +10826,27 @@ def get_page_text_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: TextAnnotationsResponse + :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_page_text_annotations_with_http_info(name, page_number, **kwargs) + return self.get_page_squiggly_annotations_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_squiggly_annotations_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_squiggly_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page text annotations. + 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_page_text_annotations_with_http_info(name, page_number, 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) @@ -9971,7 +10854,7 @@ def get_page_text_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: TextAnnotationsResponse + :return: SquigglyAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -9987,16 +10870,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_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_page_text_annotations`") + 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_text_annotations`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_squiggly_annotations`") collection_formats = {} @@ -10030,14 +10913,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}/annotations/squiggly', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TextAnnotationsResponse', + response_type='SquigglyAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10045,16 +10928,16 @@ 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_page_underline_annotations(self, name, page_number, **kwargs): + def get_page_strike_out_annotations(self, name, page_number, **kwargs): """ - Read document page underline annotations. + 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_page_underline_annotations(name, page_number, 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) @@ -10062,27 +10945,27 @@ def get_page_underline_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: UnderlineAnnotationsResponse + :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_page_underline_annotations_with_http_info(name, page_number, **kwargs) + return self.get_page_strike_out_annotations_with_http_info(name, page_number, **kwargs) else: - (data) = self.get_page_underline_annotations_with_http_info(name, page_number, **kwargs) + (data) = self.get_page_strike_out_annotations_with_http_info(name, page_number, **kwargs) return data - def get_page_underline_annotations_with_http_info(self, name, page_number, **kwargs): + def get_page_strike_out_annotations_with_http_info(self, name, page_number, **kwargs): """ - Read document page underline annotations. + 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_page_underline_annotations_with_http_info(name, page_number, 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) @@ -10090,7 +10973,7 @@ def get_page_underline_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: UnderlineAnnotationsResponse + :return: StrikeOutAnnotationsResponse If the method is called asynchronously, returns the request thread. """ @@ -10106,16 +10989,16 @@ def get_page_underline_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_underline_annotations" % 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_page_underline_annotations`") + 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_underline_annotations`") + raise ValueError("Missing the required parameter `page_number` when calling `get_page_strike_out_annotations`") collection_formats = {} @@ -10149,14 +11032,14 @@ def get_page_underline_annotations_with_http_info(self, name, page_number, **kwa # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/underline', '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='UnderlineAnnotationsResponse', + response_type='StrikeOutAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10164,55 +11047,71 @@ def get_page_underline_annotations_with_http_info(self, name, page_number, **kwa _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_pages(self, name, **kwargs): + def get_page_text(self, name, page_number, llx, lly, urx, ury, **kwargs): """ - Read document pages info. + 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_pages(name, 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 storage: The document storage. - :param str folder: The document folder. - :return: DocumentPagesResponse - If the method is called asynchronously, - returns the request thread. + :param int page_number: Number of page (starting from 1). (required) + :param float llx: X-coordinate of lower - left corner. (required) + :param float lly: Y - coordinate of lower-left corner. (required) + :param float urx: X - coordinate of upper-right corner. (required) + :param float ury: Y - coordinate of upper-right corner. (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 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_pages_with_http_info(name, **kwargs) + return self.get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) else: - (data) = self.get_pages_with_http_info(name, **kwargs) + (data) = self.get_page_text_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) return data - def get_pages_with_http_info(self, name, **kwargs): + def get_page_text_with_http_info(self, name, page_number, llx, lly, urx, ury, **kwargs): """ - Read document pages info. + 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_pages_with_http_info(name, 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 storage: The document storage. + :param int page_number: Number of page (starting from 1). (required) + :param float llx: X-coordinate of lower - left corner. (required) + :param float lly: Y - coordinate of lower-left corner. (required) + :param float urx: X - coordinate of upper-right corner. (required) + :param float ury: Y - coordinate of upper-right corner. (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: DocumentPagesResponse + :param str storage: The document storage. + :return: TextRectsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', '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') @@ -10223,13 +11122,28 @@ 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_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_pages`") + 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 = {} @@ -10237,12 +11151,29 @@ 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 '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 = {} @@ -10261,14 +11192,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}/text', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentPagesResponse', + response_type='TextRectsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10276,53 +11207,57 @@ 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_text_annotations(self, name, page_number, **kwargs): """ - Convert PCL 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_pcl_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.pcl) (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_pcl_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_pcl_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_pcl_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 PCL 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_pcl_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.pcl) (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') @@ -10333,24 +11268,31 @@ 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_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_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_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 = {} @@ -10360,7 +11302,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.\ @@ -10369,14 +11311,14 @@ 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}/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'), @@ -10384,71 +11326,57 @@ 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_underline_annotations(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to DOC format and returns resulting file in response content + 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_pdf_in_storage_to_doc(name, 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 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 int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :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_pdf_in_storage_to_doc_with_http_info(name, **kwargs) + return self.get_page_underline_annotations_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_underline_annotations_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_underline_annotations_with_http_info(self, name, page_number, **kwargs): """ - Converts PDF document (located on storage) to DOC format and returns resulting file in response content + 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_pdf_in_storage_to_doc_with_http_info(name, 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 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 int page_number: The page number. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: UnderlineAnnotationsResponse If the method is called asynchronously, 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', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10459,13 +11387,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_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_pdf_in_storage_to_doc`") + 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 = {} @@ -10473,28 +11404,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 '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 = {} @@ -10504,7 +11421,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.\ @@ -10513,14 +11430,14 @@ 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}/annotations/underline', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='UnderlineAnnotationsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -10528,57 +11445,55 @@ 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_pages(self, name, **kwargs): """ - Converts PDF document (located on storage) to EPUB format and returns resulting file in response content + 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_pdf_in_storage_to_epub(name, callback=callback_function) + >>> thread = api.get_pages(name, 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: Property 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: 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_pdf_in_storage_to_epub_with_http_info(name, **kwargs) + return self.get_pages_with_http_info(name, **kwargs) else: - (data) = self.get_pdf_in_storage_to_epub_with_http_info(name, **kwargs) + (data) = self.get_pages_with_http_info(name, **kwargs) return data - def get_pdf_in_storage_to_epub_with_http_info(self, name, **kwargs): + def get_pages_with_http_info(self, name, **kwargs): """ - Converts PDF document (located on storage) to EPUB format and returns resulting file in response content + 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_pdf_in_storage_to_epub_with_http_info(name, 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 name: The document name. (required) - :param str content_recognition_mode: Property 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: file + :param str folder: The document folder. + :return: DocumentPagesResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'content_recognition_mode', 'folder', 'storage'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10589,13 +11504,13 @@ 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_pages" % 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_pages`") collection_formats = {} @@ -10605,12 +11520,10 @@ def get_pdf_in_storage_to_epub_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] 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 = {} @@ -10620,7 +11533,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.\ @@ -10629,14 +11542,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', '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'), @@ -10644,49 +11557,20 @@ 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_pcl_in_storage_to_pdf(self, src_path, **kwargs): """ - Converts PDF document (located on storage) to Html format and returns resulting file in response content + 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_pdf_in_storage_to_html(name, 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 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 src_path: Full source filename (ex. /folder1/folder2/template.pcl) (required) :param str storage: The document storage. :return: file If the method is called asynchronously, @@ -10694,61 +11578,32 @@ def get_pdf_in_storage_to_html(self, name, **kwargs): """ 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_pcl_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.get_pdf_in_storage_to_html_with_http_info(name, **kwargs) + (data) = self.get_pcl_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def get_pdf_in_storage_to_html_with_http_info(self, name, **kwargs): + def get_pcl_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Converts PDF document (located on storage) to Html format and returns resulting file in response content + 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_pdf_in_storage_to_html_with_http_info(name, 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 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 src_path: Full source filename (ex. /folder1/folder2/template.pcl) (required) :param str storage: The document storage. :return: file 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 = ['src_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -10759,81 +11614,22 @@ 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_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_pdf_in_storage_to_html`") + # 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 '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 'src_path' in params: + query_params.append(('srcPath', params['src_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -10854,7 +11650,7 @@ 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/create/pcl', 'GET', path_params, query_params, header_params, @@ -10869,21 +11665,28 @@ 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_pdf_in_storage_to_doc(self, name, **kwargs): """ - Converts PDF document (located on storage) to LaTeX format and returns resulting file in response content + 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_pdf_in_storage_to_la_te_x(name, 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 int pages_count: Pages count. + :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: file @@ -10892,26 +11695,33 @@ def get_pdf_in_storage_to_la_te_x(self, name, **kwargs): """ 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_pdf_in_storage_to_doc_with_http_info(name, **kwargs) else: - (data) = self.get_pdf_in_storage_to_la_te_x_with_http_info(name, **kwargs) + (data) = self.get_pdf_in_storage_to_doc_with_http_info(name, **kwargs) return data - def get_pdf_in_storage_to_la_te_x_with_http_info(self, name, **kwargs): + def get_pdf_in_storage_to_doc_with_http_info(self, name, **kwargs): """ - Converts PDF document (located on storage) to LaTeX format and returns resulting file in response content + 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_pdf_in_storage_to_la_te_x_with_http_info(name, 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 int pages_count: Pages count. + :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: file @@ -10919,7 +11729,7 @@ def get_pdf_in_storage_to_la_te_x_with_http_info(self, name, **kwargs): returns the request thread. """ - all_params = ['name', 'pages_count', 'folder', 'storage'] + 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') @@ -10930,13 +11740,13 @@ 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_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_pdf_in_storage_to_la_te_x`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_doc`") collection_formats = {} @@ -10946,8 +11756,22 @@ def get_pdf_in_storage_to_la_te_x_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] query_params = [] - if 'pages_count' in params: - query_params.append(('pagesCount', params['pages_count'])) + 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: @@ -10970,7 +11794,7 @@ 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}/convert/doc', 'GET', path_params, query_params, header_params, @@ -10985,20 +11809,21 @@ 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_pdf_in_storage_to_epub(self, name, **kwargs): """ - Converts PDF document (located on storage) to MOBIXML format and returns resulting file in response content + 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_pdf_in_storage_to_mobi_xml(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 content_recognition_mode: Property 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: file @@ -11007,25 +11832,26 @@ def get_pdf_in_storage_to_mobi_xml(self, name, **kwargs): """ 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_pdf_in_storage_to_epub_with_http_info(name, **kwargs) else: - (data) = self.get_pdf_in_storage_to_mobi_xml_with_http_info(name, **kwargs) + (data) = self.get_pdf_in_storage_to_epub_with_http_info(name, **kwargs) return data - def get_pdf_in_storage_to_mobi_xml_with_http_info(self, name, **kwargs): + def get_pdf_in_storage_to_epub_with_http_info(self, name, **kwargs): """ - Converts PDF document (located on storage) to MOBIXML format and returns resulting file in response content + 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_pdf_in_storage_to_mobi_xml_with_http_info(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 content_recognition_mode: Property 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: file @@ -11033,7 +11859,7 @@ def get_pdf_in_storage_to_mobi_xml_with_http_info(self, name, **kwargs): returns the request thread. """ - all_params = ['name', 'folder', 'storage'] + all_params = ['name', 'content_recognition_mode', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11044,13 +11870,13 @@ 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_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_pdf_in_storage_to_mobi_xml`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_epub`") collection_formats = {} @@ -11060,6 +11886,8 @@ def get_pdf_in_storage_to_mobi_xml_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] 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: @@ -11082,7 +11910,7 @@ 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}/convert/epub', 'GET', path_params, query_params, header_params, @@ -11097,49 +11925,103 @@ 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_pdf_in_storage_to_html(self, name, **kwargs): """ - Converts PDF document (located on storage) to PdfA format and returns resulting file in response content + 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_pdf_in_storage_to_pdf_a(name, type, 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 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. + :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. """ 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_pdf_in_storage_to_html_with_http_info(name, **kwargs) else: - (data) = self.get_pdf_in_storage_to_pdf_a_with_http_info(name, type, **kwargs) + (data) = self.get_pdf_in_storage_to_html_with_http_info(name, **kwargs) return data - def get_pdf_in_storage_to_pdf_a_with_http_info(self, name, type, **kwargs): + def get_pdf_in_storage_to_html_with_http_info(self, name, **kwargs): """ - Converts PDF document (located on storage) to PdfA format and returns resulting file in response content + 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_pdf_in_storage_to_pdf_a_with_http_info(name, type, 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 name: The document name. (required) - :param str type: Type of PdfA format. (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 @@ -11147,7 +12029,7 @@ def get_pdf_in_storage_to_pdf_a_with_http_info(self, name, type, **kwargs): returns the request thread. """ - all_params = ['name', 'type', 'folder', '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') @@ -11158,16 +12040,13 @@ 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_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 `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_pdf_in_storage_to_html`") collection_formats = {} @@ -11177,8 +12056,63 @@ def get_pdf_in_storage_to_pdf_a_with_http_info(self, name, type, **kwargs): path_params['name'] = params['name'] query_params = [] - if 'type' in params: - query_params.append(('type', params['type'])) + 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: @@ -11201,7 +12135,7 @@ 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}/convert/html', 'GET', path_params, query_params, header_params, @@ -11216,22 +12150,21 @@ 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_pdf_in_storage_to_la_te_x(self, name, **kwargs): """ - Converts PDF document (located on storage) to PPTX format and returns resulting file in response content + 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_pdf_in_storage_to_pptx(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 bool separate_images: Separate images. - :param bool slides_as_images: Slides as images. + :param int pages_count: Pages count. :param str folder: The document folder. :param str storage: The document storage. :return: file @@ -11240,27 +12173,26 @@ def get_pdf_in_storage_to_pptx(self, name, **kwargs): """ 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_pdf_in_storage_to_la_te_x_with_http_info(name, **kwargs) else: - (data) = self.get_pdf_in_storage_to_pptx_with_http_info(name, **kwargs) + (data) = self.get_pdf_in_storage_to_la_te_x_with_http_info(name, **kwargs) return data - def get_pdf_in_storage_to_pptx_with_http_info(self, name, **kwargs): + def get_pdf_in_storage_to_la_te_x_with_http_info(self, name, **kwargs): """ - Converts PDF document (located on storage) to PPTX format and returns resulting file in response content + 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_pdf_in_storage_to_pptx_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 bool separate_images: Separate images. - :param bool slides_as_images: Slides as images. + :param int pages_count: Pages count. :param str folder: The document folder. :param str storage: The document storage. :return: file @@ -11268,7 +12200,7 @@ def get_pdf_in_storage_to_pptx_with_http_info(self, name, **kwargs): returns the request thread. """ - all_params = ['name', 'separate_images', 'slides_as_images', 'folder', 'storage'] + all_params = ['name', 'pages_count', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11279,13 +12211,13 @@ 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_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_pdf_in_storage_to_pptx`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_la_te_x`") collection_formats = {} @@ -11295,10 +12227,8 @@ def get_pdf_in_storage_to_pptx_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] 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 '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: @@ -11321,7 +12251,7 @@ 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}/convert/latex', 'GET', path_params, query_params, header_params, @@ -11336,21 +12266,20 @@ 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_pdf_in_storage_to_mobi_xml(self, name, **kwargs): """ - Converts PDF document (located on storage) to SVG format and returns resulting file in 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_pdf_in_storage_to_svg(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) :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 @@ -11359,26 +12288,25 @@ def get_pdf_in_storage_to_svg(self, name, **kwargs): """ 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_pdf_in_storage_to_mobi_xml_with_http_info(name, **kwargs) else: - (data) = self.get_pdf_in_storage_to_svg_with_http_info(name, **kwargs) + (data) = self.get_pdf_in_storage_to_mobi_xml_with_http_info(name, **kwargs) return data - def get_pdf_in_storage_to_svg_with_http_info(self, name, **kwargs): + def get_pdf_in_storage_to_mobi_xml_with_http_info(self, name, **kwargs): """ - Converts PDF document (located on storage) to SVG format and returns resulting file in 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_pdf_in_storage_to_svg_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) :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 @@ -11386,7 +12314,7 @@ def get_pdf_in_storage_to_svg_with_http_info(self, name, **kwargs): returns the request thread. """ - all_params = ['name', 'compress_output_to_zip_archive', 'folder', 'storage'] + all_params = ['name', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11397,13 +12325,13 @@ 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_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_pdf_in_storage_to_svg`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_mobi_xml`") collection_formats = {} @@ -11413,8 +12341,6 @@ def get_pdf_in_storage_to_svg_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] 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: @@ -11437,7 +12363,7 @@ 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}/convert/mobixml', 'GET', path_params, query_params, header_params, @@ -11452,35 +12378,21 @@ 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_pdf_in_storage_to_pdf_a(self, name, type, **kwargs): """ - Converts PDF document (located on storage) to TIFF format and returns resulting file in response content + 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_pdf_in_storage_to_tiff(name, 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 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 type: Type of PdfA format. (required) :param str folder: The document folder. :param str storage: The document storage. :return: file @@ -11489,40 +12401,26 @@ def get_pdf_in_storage_to_tiff(self, name, **kwargs): """ 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_pdf_in_storage_to_pdf_a_with_http_info(name, type, **kwargs) else: - (data) = self.get_pdf_in_storage_to_tiff_with_http_info(name, **kwargs) + (data) = self.get_pdf_in_storage_to_pdf_a_with_http_info(name, type, **kwargs) return data - def get_pdf_in_storage_to_tiff_with_http_info(self, name, **kwargs): + def get_pdf_in_storage_to_pdf_a_with_http_info(self, name, type, **kwargs): """ - Converts PDF document (located on storage) to TIFF format and returns resulting file in response content + 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_pdf_in_storage_to_tiff_with_http_info(name, 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 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 type: Type of PdfA format. (required) :param str folder: The document folder. :param str storage: The document storage. :return: file @@ -11530,7 +12428,7 @@ def get_pdf_in_storage_to_tiff_with_http_info(self, name, **kwargs): 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', 'type', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11541,13 +12439,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_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 `get_pdf_in_storage_to_tiff`") + 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 = {} @@ -11557,36 +12458,8 @@ def get_pdf_in_storage_to_tiff_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] 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 'type' in params: + query_params.append(('type', params['type'])) if 'folder' in params: query_params.append(('folder', params['folder'])) if 'storage' in params: @@ -11609,7 +12482,7 @@ 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}/convert/pdfa', 'GET', path_params, query_params, header_params, @@ -11624,24 +12497,22 @@ 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_pdf_in_storage_to_pptx(self, name, **kwargs): """ - Converts PDF document (located on storage) to XLS format and returns resulting file in response content + 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_pdf_in_storage_to_xls(name, 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 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 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 @@ -11650,29 +12521,27 @@ def get_pdf_in_storage_to_xls(self, name, **kwargs): """ 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_pdf_in_storage_to_pptx_with_http_info(name, **kwargs) else: - (data) = self.get_pdf_in_storage_to_xls_with_http_info(name, **kwargs) + (data) = self.get_pdf_in_storage_to_pptx_with_http_info(name, **kwargs) return data - def get_pdf_in_storage_to_xls_with_http_info(self, name, **kwargs): + def get_pdf_in_storage_to_pptx_with_http_info(self, name, **kwargs): """ - Converts PDF document (located on storage) to XLS format and returns resulting file in response content + 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_pdf_in_storage_to_xls_with_http_info(name, 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 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 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 @@ -11680,7 +12549,7 @@ def get_pdf_in_storage_to_xls_with_http_info(self, name, **kwargs): 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', 'separate_images', 'slides_as_images', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -11691,13 +12560,13 @@ 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_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 `get_pdf_in_storage_to_xls`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_pptx`") collection_formats = {} @@ -11707,14 +12576,10 @@ def get_pdf_in_storage_to_xls_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] 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 '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: @@ -11737,7 +12602,7 @@ 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}/convert/pptx', 'GET', path_params, query_params, header_params, @@ -11752,20 +12617,21 @@ 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_pdf_in_storage_to_svg(self, name, **kwargs): """ - Converts PDF document (located on storage) to XML format and returns resulting file in response content + 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_pdf_in_storage_to_xml(name, 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 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 @@ -11774,25 +12640,26 @@ def get_pdf_in_storage_to_xml(self, name, **kwargs): """ 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_pdf_in_storage_to_svg_with_http_info(name, **kwargs) else: - (data) = self.get_pdf_in_storage_to_xml_with_http_info(name, **kwargs) + (data) = self.get_pdf_in_storage_to_svg_with_http_info(name, **kwargs) return data - def get_pdf_in_storage_to_xml_with_http_info(self, name, **kwargs): + def get_pdf_in_storage_to_svg_with_http_info(self, name, **kwargs): """ - Converts PDF document (located on storage) to XML format and returns resulting file in response content + 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_pdf_in_storage_to_xml_with_http_info(name, 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 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 @@ -11800,7 +12667,7 @@ def get_pdf_in_storage_to_xml_with_http_info(self, name, **kwargs): returns the request thread. """ - all_params = ['name', 'folder', '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') @@ -11811,13 +12678,13 @@ 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_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 `get_pdf_in_storage_to_xml`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_svg`") collection_formats = {} @@ -11827,6 +12694,8 @@ def get_pdf_in_storage_to_xml_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] 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: @@ -11849,7 +12718,7 @@ 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}/convert/svg', 'GET', path_params, query_params, header_params, @@ -11864,20 +12733,35 @@ 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_pdf_in_storage_to_tiff(self, name, **kwargs): """ - Converts PDF document (located on storage) to XPS format and returns resulting file in response content + 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.get_pdf_in_storage_to_xps(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 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 @@ -11886,25 +12770,40 @@ def get_pdf_in_storage_to_xps(self, name, **kwargs): """ 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_pdf_in_storage_to_tiff_with_http_info(name, **kwargs) else: - (data) = self.get_pdf_in_storage_to_xps_with_http_info(name, **kwargs) + (data) = self.get_pdf_in_storage_to_tiff_with_http_info(name, **kwargs) return data - def get_pdf_in_storage_to_xps_with_http_info(self, name, **kwargs): + def get_pdf_in_storage_to_tiff_with_http_info(self, name, **kwargs): """ - Converts PDF document (located on storage) to XPS format and returns resulting file in response content + 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.get_pdf_in_storage_to_xps_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 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 @@ -11912,7 +12811,7 @@ def get_pdf_in_storage_to_xps_with_http_info(self, name, **kwargs): returns the request thread. """ - all_params = ['name', 'folder', 'storage'] + 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') @@ -11923,13 +12822,13 @@ 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_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 `get_pdf_in_storage_to_xps`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_tiff`") collection_formats = {} @@ -11939,6 +12838,36 @@ def get_pdf_in_storage_to_xps_with_http_info(self, name, **kwargs): path_params['name'] = params['name'] 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: @@ -11961,7 +12890,7 @@ 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}/convert/tiff', 'GET', path_params, query_params, header_params, @@ -11976,57 +12905,63 @@ 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_pdf_in_storage_to_xls(self, name, **kwargs): """ - Read document page polyline annotation by ID. + 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.get_poly_line_annotation(name, annotation_id, 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 str annotation_id: The annotation ID. (required) - :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: PolyLineAnnotationResponse + :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_poly_line_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_pdf_in_storage_to_xls_with_http_info(name, **kwargs) else: - (data) = self.get_poly_line_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_pdf_in_storage_to_xls_with_http_info(name, **kwargs) return data - def get_poly_line_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_pdf_in_storage_to_xls_with_http_info(self, name, **kwargs): """ - Read document page polyline annotation by ID. + 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.get_poly_line_annotation_with_http_info(name, annotation_id, 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 str annotation_id: The annotation ID. (required) - :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: PolyLineAnnotationResponse + :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', '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') @@ -12037,16 +12972,13 @@ 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_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 `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_pdf_in_storage_to_xls`") collection_formats = {} @@ -12054,14 +12986,20 @@ 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'] query_params = [] - 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 = {} @@ -12071,7 +13009,7 @@ def get_poly_line_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.\ @@ -12080,14 +13018,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}/convert/xls', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PolyLineAnnotationResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12095,57 +13033,55 @@ 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_pdf_in_storage_to_xml(self, name, **kwargs): """ - Read document page polygon annotation by ID. + 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.get_polygon_annotation(name, annotation_id, 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: 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: PolygonAnnotationResponse + :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_polygon_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_pdf_in_storage_to_xml_with_http_info(name, **kwargs) else: - (data) = self.get_polygon_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_pdf_in_storage_to_xml_with_http_info(name, **kwargs) return data - def get_polygon_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_pdf_in_storage_to_xml_with_http_info(self, name, **kwargs): """ - Read document page polygon annotation by ID. + 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.get_polygon_annotation_with_http_info(name, annotation_id, 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: 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: PolygonAnnotationResponse + :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', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12156,16 +13092,13 @@ 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_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 `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_pdf_in_storage_to_xml`") collection_formats = {} @@ -12173,14 +13106,12 @@ 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'] 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 = {} @@ -12190,7 +13121,7 @@ def get_polygon_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.\ @@ -12199,14 +13130,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}/convert/xml', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PolygonAnnotationResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12214,57 +13145,55 @@ def get_polygon_annotation_with_http_info(self, name, annotation_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_popup_annotation(self, name, annotation_id, **kwargs): + def get_pdf_in_storage_to_xps(self, name, **kwargs): """ - Read document page popup annotation by ID. + 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.get_popup_annotation(name, annotation_id, 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 str annotation_id: The annotation ID. (required) - :param str storage: The document storage. :param str folder: The document folder. - :return: PopupAnnotationResponse + :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_popup_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_pdf_in_storage_to_xps_with_http_info(name, **kwargs) else: - (data) = self.get_popup_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_pdf_in_storage_to_xps_with_http_info(name, **kwargs) return data - def get_popup_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_pdf_in_storage_to_xps_with_http_info(self, name, **kwargs): """ - Read document page popup annotation by ID. + 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.get_popup_annotation_with_http_info(name, annotation_id, 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 str annotation_id: The annotation ID. (required) - :param str storage: The document storage. :param str folder: The document folder. - :return: PopupAnnotationResponse + :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', 'folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12275,16 +13204,13 @@ def get_popup_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_popup_annotation" % 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 `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`") + raise ValueError("Missing the required parameter `name` when calling `get_pdf_in_storage_to_xps`") collection_formats = {} @@ -12292,14 +13218,12 @@ def get_popup_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 'folder' in params: query_params.append(('folder', params['folder'])) + if 'storage' in params: + query_params.append(('storage', params['storage'])) header_params = {} @@ -12309,7 +13233,7 @@ def get_popup_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.\ @@ -12318,14 +13242,14 @@ def get_popup_annotation_with_http_info(self, name, annotation_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/popup/{annotationId}', 'GET', + 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='PopupAnnotationResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12333,53 +13257,57 @@ def get_popup_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_poly_line_annotation(self, name, annotation_id, **kwargs): """ - Convert PS file (located on storage) to PDF format and return resulting file in response. + 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.get_ps_in_storage_to_pdf(src_path, 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 src_path: Full source filename (ex. /folder1/folder2/template.ps) (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: PolyLineAnnotationResponse 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_poly_line_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_ps_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_poly_line_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_ps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_poly_line_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Convert PS file (located on storage) to PDF format and return resulting file in response. + 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.get_ps_in_storage_to_pdf_with_http_info(src_path, 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 src_path: Full source filename (ex. /folder1/folder2/template.ps) (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: PolyLineAnnotationResponse 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') @@ -12390,24 +13318,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_poly_line_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_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_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 = {} 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 = {} @@ -12417,7 +13352,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.\ @@ -12426,14 +13361,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}/annotations/polyline/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='PolyLineAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12441,16 +13376,16 @@ 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_polygon_annotation(self, name, annotation_id, **kwargs): """ - Read document page square annotation by ID. + 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.get_square_annotation(name, annotation_id, callback=callback_function) + >>> thread = api.get_polygon_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -12458,27 +13393,27 @@ def get_square_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: SquareAnnotationResponse + :return: PolygonAnnotationResponse 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_polygon_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_square_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_polygon_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_square_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_polygon_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Read document page square annotation by ID. + 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.get_square_annotation_with_http_info(name, annotation_id, 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) @@ -12486,7 +13421,7 @@ def get_square_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: SquareAnnotationResponse + :return: PolygonAnnotationResponse If the method is called asynchronously, returns the request thread. """ @@ -12502,16 +13437,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_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 `get_square_annotation`") + 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_square_annotation`") + raise ValueError("Missing the required parameter `annotation_id` when calling `get_polygon_annotation`") collection_formats = {} @@ -12545,14 +13480,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}/annotations/polygon/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SquareAnnotationResponse', + response_type='PolygonAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12560,16 +13495,16 @@ def get_square_annotation_with_http_info(self, name, annotation_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_squiggly_annotation(self, name, annotation_id, **kwargs): + def get_popup_annotation(self, name, annotation_id, **kwargs): """ - Read document page squiggly annotation by ID. + 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.get_squiggly_annotation(name, annotation_id, callback=callback_function) + >>> thread = api.get_popup_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -12577,27 +13512,27 @@ def get_squiggly_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: SquigglyAnnotationResponse + :return: PopupAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_squiggly_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_popup_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_squiggly_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_popup_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_squiggly_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_popup_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Read document page squiggly annotation by ID. + 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.get_squiggly_annotation_with_http_info(name, annotation_id, 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) @@ -12605,7 +13540,7 @@ def get_squiggly_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: SquigglyAnnotationResponse + :return: PopupAnnotationResponse If the method is called asynchronously, returns the request thread. """ @@ -12621,16 +13556,16 @@ def get_squiggly_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_squiggly_annotation" % 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 `get_squiggly_annotation`") + 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_squiggly_annotation`") + raise ValueError("Missing the required parameter `annotation_id` when calling `get_popup_annotation`") collection_formats = {} @@ -12664,14 +13599,14 @@ def get_squiggly_annotation_with_http_info(self, name, annotation_id, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/squiggly/{annotationId}', 'GET', + 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='SquigglyAnnotationResponse', + response_type='PopupAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12679,57 +13614,53 @@ def get_squiggly_annotation_with_http_info(self, name, annotation_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_strike_out_annotation(self, name, annotation_id, **kwargs): + def get_ps_in_storage_to_pdf(self, src_path, **kwargs): """ - Read document page StrikeOut annotation by ID. + 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.get_strike_out_annotation(name, annotation_id, 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 str annotation_id: The annotation ID. (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: StrikeOutAnnotationResponse + :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_strike_out_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_ps_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.get_strike_out_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_ps_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def get_strike_out_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_ps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Read document page StrikeOut annotation by ID. + 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.get_strike_out_annotation_with_http_info(name, annotation_id, 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 str annotation_id: The annotation ID. (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: StrikeOutAnnotationResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'storage', 'folder'] + all_params = ['src_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12740,31 +13671,24 @@ def get_strike_out_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_strike_out_annotation" % 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 `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`") - + # 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 '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 = {} @@ -12774,7 +13698,7 @@ def get_strike_out_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.\ @@ -12783,14 +13707,14 @@ def get_strike_out_annotation_with_http_info(self, name, annotation_id, **kwargs # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/strikeout/{annotationId}', 'GET', + 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='StrikeOutAnnotationResponse', + response_type='file', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12798,69 +13722,57 @@ def get_strike_out_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_redaction_annotation(self, name, annotation_id, **kwargs): """ - Convert SVG file (located on storage) to PDF format and return resulting file in response. + Read document page redaction 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_svg_in_storage_to_pdf(src_path, callback=callback_function) + >>> thread = api.get_redaction_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.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 annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: RedactionAnnotationResponse 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_redaction_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_svg_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_redaction_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_svg_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_redaction_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Convert SVG file (located on storage) to PDF format and return resulting file in response. + Read document page redaction 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_svg_in_storage_to_pdf_with_http_info(src_path, callback=callback_function) + >>> thread = api.get_redaction_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.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 annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: RedactionAnnotationResponse 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', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -12871,40 +13783,31 @@ 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_redaction_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_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_redaction_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_redaction_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 '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 = {} @@ -12914,7 +13817,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.\ @@ -12923,14 +13826,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}/annotations/redaction/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='RedactionAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -12938,69 +13841,57 @@ 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_sound_annotation(self, name, annotation_id, **kwargs): """ - Read document text. + Read document page sound 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_text(name, llx, lly, urx, ury, callback=callback_function) + >>> thread = api.get_sound_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 float llx: X-coordinate of lower - left corner. (required) - :param float lly: Y - coordinate of lower-left corner. (required) - :param float urx: X - coordinate of upper-right corner. (required) - :param float ury: Y - coordinate of upper-right corner. (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 annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: TextRectsResponse + :param str folder: The document folder. + :return: SoundAnnotationResponse 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_sound_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_text_with_http_info(name, llx, lly, urx, ury, **kwargs) + (data) = self.get_sound_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_text_with_http_info(self, name, llx, lly, urx, ury, **kwargs): + def get_sound_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Read document text. + Read document page sound 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_text_with_http_info(name, llx, lly, urx, ury, callback=callback_function) + >>> thread = api.get_sound_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 float llx: X-coordinate of lower - left corner. (required) - :param float lly: Y - coordinate of lower-left corner. (required) - :param float urx: X - coordinate of upper-right corner. (required) - :param float ury: Y - coordinate of upper-right corner. (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 annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: TextRectsResponse + :param str folder: The document folder. + :return: SoundAnnotationResponse 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 = ['name', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13011,25 +13902,16 @@ 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_sound_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_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`") + raise ValueError("Missing the required parameter `name` when calling `get_sound_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_sound_annotation`") collection_formats = {} @@ -13037,27 +13919,14 @@ def get_text_with_http_info(self, name, llx, lly, urx, ury, **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 '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'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -13076,14 +13945,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/{name}/annotations/sound/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TextRectsResponse', + response_type='SoundAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13091,16 +13960,16 @@ 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_sound_annotation_data(self, name, annotation_id, **kwargs): """ - Read document page text annotation by ID. + Read document page sound 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_text_annotation(name, annotation_id, callback=callback_function) + >>> thread = api.get_sound_annotation_data(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -13108,27 +13977,27 @@ def get_text_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: TextAnnotationResponse + :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_sound_annotation_data_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_text_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_sound_annotation_data_with_http_info(name, annotation_id, **kwargs) return data - def get_text_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_sound_annotation_data_with_http_info(self, name, annotation_id, **kwargs): """ - Read document page text annotation by ID. + Read document page sound 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_text_annotation_with_http_info(name, annotation_id, callback=callback_function) + >>> thread = api.get_sound_annotation_data_with_http_info(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -13136,7 +14005,7 @@ def get_text_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: TextAnnotationResponse + :return: file If the method is called asynchronously, returns the request thread. """ @@ -13152,16 +14021,16 @@ 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_sound_annotation_data" % 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`") + raise ValueError("Missing the required parameter `name` when calling `get_sound_annotation_data`") # 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 `annotation_id` when calling `get_sound_annotation_data`") collection_formats = {} @@ -13195,14 +14064,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}/annotations/sound/{annotationId}/data', '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'), @@ -13210,16 +14079,16 @@ def get_text_annotation_with_http_info(self, name, annotation_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_underline_annotation(self, name, annotation_id, **kwargs): + def get_square_annotation(self, name, annotation_id, **kwargs): """ - Read document page underline annotation by ID. + 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.get_underline_annotation(name, annotation_id, callback=callback_function) + >>> thread = api.get_square_annotation(name, annotation_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) @@ -13227,27 +14096,27 @@ def get_underline_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: UnderlineAnnotationResponse + :return: SquareAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_underline_annotation_with_http_info(name, annotation_id, **kwargs) + return self.get_square_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_underline_annotation_with_http_info(name, annotation_id, **kwargs) + (data) = self.get_square_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_underline_annotation_with_http_info(self, name, annotation_id, **kwargs): + def get_square_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Read document page underline annotation by ID. + 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.get_underline_annotation_with_http_info(name, annotation_id, 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) @@ -13255,7 +14124,7 @@ def get_underline_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: UnderlineAnnotationResponse + :return: SquareAnnotationResponse If the method is called asynchronously, returns the request thread. """ @@ -13271,16 +14140,16 @@ def get_underline_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_underline_annotation" % 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 `get_underline_annotation`") + 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_underline_annotation`") + raise ValueError("Missing the required parameter `annotation_id` when calling `get_square_annotation`") collection_formats = {} @@ -13314,14 +14183,14 @@ def get_underline_annotation_with_http_info(self, name, annotation_id, **kwargs) # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/underline/{annotationId}', 'GET', + 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='UnderlineAnnotationResponse', + response_type='SquareAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13329,57 +14198,57 @@ def get_underline_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_squiggly_annotation(self, name, annotation_id, **kwargs): """ - Verify signature document. + 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.get_verify_signature(name, sign_name, 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 str sign_name: Sign name. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SignatureVerifyResponse + :return: SquigglyAnnotationResponse 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_squiggly_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_verify_signature_with_http_info(name, sign_name, **kwargs) + (data) = self.get_squiggly_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_verify_signature_with_http_info(self, name, sign_name, **kwargs): + def get_squiggly_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Verify signature document. + 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.get_verify_signature_with_http_info(name, sign_name, 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 str sign_name: Sign name. (required) + :param str annotation_id: The annotation ID. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SignatureVerifyResponse + :return: SquigglyAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'sign_name', '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') @@ -13390,16 +14259,16 @@ 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_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 `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_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 = {} @@ -13407,10 +14276,10 @@ def get_verify_signature_with_http_info(self, name, sign_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 '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: @@ -13433,14 +14302,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}/annotations/squiggly/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SignatureVerifyResponse', + response_type='SquigglyAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13448,67 +14317,57 @@ 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_strike_out_annotation(self, name, annotation_id, **kwargs): """ - Convert web page to PDF format and return resulting file in response. + 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.get_web_in_storage_to_pdf(url, 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 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 str annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: StrikeOutAnnotationResponse If the method is called asynchronously, returns the request thread. """ 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_strike_out_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_web_in_storage_to_pdf_with_http_info(url, **kwargs) + (data) = self.get_strike_out_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_web_in_storage_to_pdf_with_http_info(self, url, **kwargs): + def get_strike_out_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Convert web page to PDF format and return resulting file in response. + 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.get_web_in_storage_to_pdf_with_http_info(url, 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 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 str annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: StrikeOutAnnotationResponse 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', 'annotation_id', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -13519,38 +14378,31 @@ 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_strike_out_annotation" % 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_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 = {} 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 '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 = {} @@ -13560,7 +14412,7 @@ def get_web_in_storage_to_pdf_with_http_info(self, url, **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.\ @@ -13569,14 +14421,14 @@ 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}/annotations/strikeout/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='StrikeOutAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13584,55 +14436,69 @@ 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_svg_in_storage_to_pdf(self, src_path, **kwargs): """ - Get number of words per document page. + 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.get_words_per_page(name, 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 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: WordCountResponse + :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_svg_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.get_words_per_page_with_http_info(name, **kwargs) + (data) = self.get_svg_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def get_words_per_page_with_http_info(self, name, **kwargs): + def get_svg_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Get number of words per document page. + 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.get_words_per_page_with_http_info(name, 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 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: WordCountResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', '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') @@ -13643,26 +14509,40 @@ 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_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 `get_words_per_page`") + # 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'] 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 = {} @@ -13672,7 +14552,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.\ @@ -13681,14 +14561,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/create/svg', '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'), @@ -13696,55 +14576,69 @@ 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_text(self, name, llx, lly, urx, ury, **kwargs): """ - Converts PDF document which contatins XFA form (located on storage) to PDF with AcroForm and returns resulting file response content + 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.get_xfa_pdf_in_storage_to_acro_form(name, 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 float llx: X-coordinate of lower - left corner. (required) + :param float lly: Y - coordinate of lower-left corner. (required) + :param float urx: X - coordinate of upper-right corner. (required) + :param float ury: Y - coordinate of upper-right corner. (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 storage: The document storage. - :return: file + :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_xfa_pdf_in_storage_to_acro_form_with_http_info(name, **kwargs) + return self.get_text_with_http_info(name, llx, lly, urx, ury, **kwargs) else: - (data) = self.get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, **kwargs) + (data) = self.get_text_with_http_info(name, llx, lly, urx, ury, **kwargs) return data - def get_xfa_pdf_in_storage_to_acro_form_with_http_info(self, name, **kwargs): + def get_text_with_http_info(self, name, llx, lly, urx, ury, **kwargs): """ - Converts PDF document which contatins XFA form (located on storage) to PDF with AcroForm and returns resulting file response content + 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.get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, 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 float llx: X-coordinate of lower - left corner. (required) + :param float lly: Y - coordinate of lower-left corner. (required) + :param float urx: X - coordinate of upper-right corner. (required) + :param float ury: Y - coordinate of upper-right corner. (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 storage: The document storage. - :return: file + :return: TextRectsResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'folder', 'storage'] + 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') @@ -13755,13 +14649,25 @@ 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_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_xfa_pdf_in_storage_to_acro_form`") + 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 = {} @@ -13771,8 +14677,23 @@ def get_xfa_pdf_in_storage_to_acro_form_with_http_info(self, name, **kwargs): 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 'storage' in params: query_params.append(('storage', params['storage'])) @@ -13784,7 +14705,7 @@ def get_xfa_pdf_in_storage_to_acro_form_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.\ @@ -13793,14 +14714,14 @@ 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}/text', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='TextRectsResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13808,55 +14729,57 @@ 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_text_annotation(self, name, annotation_id, **kwargs): """ - Convert XML file (located on storage) to PDF format and return resulting file in response. + 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.get_xml_in_storage_to_pdf(src_path, 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 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 annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: TextAnnotationResponse If the method is called asynchronously, returns the request thread. """ 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_text_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_xml_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_text_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_xml_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_text_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Convert XML file (located on storage) to PDF format and return resulting file in response. + 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.get_xml_in_storage_to_pdf_with_http_info(src_path, 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 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 annotation_id: The annotation ID. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: TextAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['src_path', 'xsl_file_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') @@ -13867,26 +14790,31 @@ 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_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_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_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 = {} 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 'xsl_file_path' in params: - query_params.append(('xslFilePath', params['xsl_file_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -13896,7 +14824,7 @@ def get_xml_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.\ @@ -13905,14 +14833,14 @@ 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}/annotations/text/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='TextAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -13920,53 +14848,57 @@ 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_underline_annotation(self, name, annotation_id, **kwargs): """ - Convert XPS file (located on storage) to PDF format and return resulting file in response. + 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.get_xps_in_storage_to_pdf(src_path, 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 src_path: Full source filename (ex. /folder1/folder2/template.xps) (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: UnderlineAnnotationResponse If the method is called asynchronously, returns the request thread. """ 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_underline_annotation_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.get_xps_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_underline_annotation_with_http_info(name, annotation_id, **kwargs) return data - def get_xps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_underline_annotation_with_http_info(self, name, annotation_id, **kwargs): """ - Convert XPS file (located on storage) to PDF format and return resulting file in response. + 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.get_xps_in_storage_to_pdf_with_http_info(src_path, 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 src_path: Full source filename (ex. /folder1/folder2/template.xps) (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: UnderlineAnnotationResponse 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') @@ -13977,24 +14909,31 @@ 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_underline_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_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_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 = {} 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 = {} @@ -14004,7 +14943,7 @@ def get_xps_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.\ @@ -14013,14 +14952,14 @@ 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}/annotations/underline/{annotationId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='UnderlineAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -14028,53 +14967,57 @@ 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_verify_signature(self, name, sign_name, **kwargs): """ - Convert XslFo file (located on storage) to PDF format and return resulting file in response. + 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.get_xsl_fo_in_storage_to_pdf(src_path, 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 src_path: Full source filename (ex. /folder1/folder2/template.xslfo) (required) + :param str name: The document name. (required) + :param str sign_name: Sign name. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: SignatureVerifyResponse If the method is called asynchronously, returns the request thread. """ 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_verify_signature_with_http_info(name, sign_name, **kwargs) else: - (data) = self.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, **kwargs) + (data) = self.get_verify_signature_with_http_info(name, sign_name, **kwargs) return data - def get_xsl_fo_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): + def get_verify_signature_with_http_info(self, name, sign_name, **kwargs): """ - Convert XslFo file (located on storage) to PDF format and return resulting file in response. + 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.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, 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 src_path: Full source filename (ex. /folder1/folder2/template.xslfo) (required) + :param str name: The document name. (required) + :param str sign_name: Sign name. (required) :param str storage: The document storage. - :return: file + :param str folder: The document folder. + :return: SignatureVerifyResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['src_path', 'storage'] + all_params = ['name', 'sign_name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14085,24 +15028,31 @@ 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_verify_signature" % 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_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 = {} 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 '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: + query_params.append(('folder', params['folder'])) header_params = {} @@ -14112,7 +15062,7 @@ def get_xsl_fo_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.\ @@ -14121,14 +15071,14 @@ 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}/verifySignature', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='file', + response_type='SignatureVerifyResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -14136,63 +15086,67 @@ 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_web_in_storage_to_pdf(self, url, **kwargs): """ - Append document to existing one. + 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_append_document(name, 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 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 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. + :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_web_in_storage_to_pdf_with_http_info(url, **kwargs) else: - (data) = self.post_append_document_with_http_info(name, **kwargs) + (data) = self.get_web_in_storage_to_pdf_with_http_info(url, **kwargs) return data - def post_append_document_with_http_info(self, name, **kwargs): + def get_web_in_storage_to_pdf_with_http_info(self, url, **kwargs): """ - Append document to existing one. + 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_append_document_with_http_info(name, 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 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 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. + :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 = ['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') @@ -14203,32 +15157,38 @@ 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_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_append_document`") + # 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'] 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 '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 = {} @@ -14236,11 +15196,9 @@ def post_append_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']) + select_header_accept(['multipart/form-data']) # HTTP header `Content-Type` header_params['Content-Type'] = self.api_client.\ @@ -14249,14 +15207,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/create/web', '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'), @@ -14264,59 +15222,55 @@ 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_words_per_page(self, name, **kwargs): """ - Create field. + 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_create_field(name, page, 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: 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 str folder: The document folder. - :return: AsposeResponse + :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_create_field_with_http_info(name, page, **kwargs) + return self.get_words_per_page_with_http_info(name, **kwargs) else: - (data) = self.post_create_field_with_http_info(name, page, **kwargs) + (data) = self.get_words_per_page_with_http_info(name, **kwargs) return data - def post_create_field_with_http_info(self, name, page, **kwargs): + def get_words_per_page_with_http_info(self, name, **kwargs): """ - Create field. + 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_create_field_with_http_info(name, page, 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: 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 str folder: The document folder. - :return: AsposeResponse + :return: WordCountResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page', 'field', 'storage', 'folder'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14327,16 +15281,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_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_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_words_per_page`") collection_formats = {} @@ -14346,8 +15297,6 @@ 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 'folder' in params: @@ -14359,8 +15308,6 @@ 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']) @@ -14372,14 +15319,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}/pages/wordCount', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='WordCountResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -14387,57 +15334,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_xfa_pdf_in_storage_to_acro_form(self, name, **kwargs): """ - Document's replace text method. + 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.post_document_text_replace(name, text_replace, 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: (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_xfa_pdf_in_storage_to_acro_form_with_http_info(name, **kwargs) else: - (data) = self.post_document_text_replace_with_http_info(name, text_replace, **kwargs) + (data) = self.get_xfa_pdf_in_storage_to_acro_form_with_http_info(name, **kwargs) return data - def post_document_text_replace_with_http_info(self, name, text_replace, **kwargs): + def get_xfa_pdf_in_storage_to_acro_form_with_http_info(self, name, **kwargs): """ - Document's replace text method. + 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.post_document_text_replace_with_http_info(name, text_replace, 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: (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') @@ -14448,16 +15393,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_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 `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_xfa_pdf_in_storage_to_acro_form`") collection_formats = {} @@ -14467,10 +15409,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 = {} @@ -14478,11 +15420,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.\ @@ -14491,14 +15431,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/xfatoacroform', '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'), @@ -14506,61 +15446,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_flatten_document(self, name, **kwargs): + def get_xml_in_storage_to_pdf(self, src_path, **kwargs): """ - Removes all fields from the document and place their values instead. + 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.post_flatten_document(name, 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 bool update_appearances: If set, all field appearances will be regenerated before flattening. This option may help if field is incorrectly flattened. This option may decrease performance.. - :param bool call_events: If set, formatting and other JavaScript events will be called. - :param bool hide_buttons: If set, buttons will be removed from flattened document. + :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. - :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_flatten_document_with_http_info(name, **kwargs) + return self.get_xml_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.post_flatten_document_with_http_info(name, **kwargs) + (data) = self.get_xml_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def post_flatten_document_with_http_info(self, name, **kwargs): + def get_xml_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Removes all fields from the document and place their values instead. + 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.post_flatten_document_with_http_info(name, 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 bool update_appearances: If set, all field appearances will be regenerated before flattening. This option may help if field is incorrectly flattened. This option may decrease performance.. - :param bool call_events: If set, formatting and other JavaScript events will be called. - :param bool hide_buttons: If set, buttons will be removed from flattened document. + :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. - :param str folder: The document folder. - :return: AsposeResponse + :return: file If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'update_appearances', 'call_events', 'hide_buttons', 'storage', 'folder'] + all_params = ['src_path', 'xsl_file_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14571,32 +15505,26 @@ def post_flatten_document_with_http_info(self, name, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_flatten_document" % 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 `post_flatten_document`") + # 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'] query_params = [] - if 'update_appearances' in params: - query_params.append(('updateAppearances', params['update_appearances'])) - if 'call_events' in params: - query_params.append(('callEvents', params['call_events'])) - if 'hide_buttons' in params: - query_params.append(('hideButtons', params['hide_buttons'])) + 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'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) header_params = {} @@ -14606,7 +15534,7 @@ def post_flatten_document_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.\ @@ -14615,14 +15543,14 @@ def post_flatten_document_with_http_info(self, name, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/flatten', 'POST', + 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'), @@ -14630,69 +15558,53 @@ def post_flatten_document_with_http_info(self, name, **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_xps_in_storage_to_pdf(self, src_path, **kwargs): """ - Insert image to document page. + 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.post_insert_image(name, page_number, llx, lly, urx, ury, 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 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 src_path: Full source filename (ex. /folder1/folder2/template.xps) (required) :param str storage: The document storage. - :param str folder: The document folder. - :param file image: Image file. - :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_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) + return self.get_xps_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) + (data) = self.get_xps_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury, **kwargs): + def get_xps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Insert image to document page. + 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.post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, 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 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 src_path: Full source filename (ex. /folder1/folder2/template.xps) (required) :param str storage: The document storage. - :param str folder: The document folder. - :param file image: Image file. - :return: AsposeResponse + :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 = ['src_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14703,81 +15615,50 @@ 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_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 `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`") + # 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 '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 '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 = {} 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/create/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'), @@ -14785,59 +15666,53 @@ 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_file(self, src, dest, **kwargs): + def get_xsl_fo_in_storage_to_pdf(self, src_path, **kwargs): """ - Move 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.post_move_file(src, dest, 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 src: Source file path e.g. /fileSource.ext (required) - :param str dest: Destination file path e.g. /fileDestination.ext (required) - :param str version_id: Source file's version, - :param str storage: User's source storage name - :param str dest_storage: User's destination 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.post_move_file_with_http_info(src, dest, **kwargs) + return self.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, **kwargs) else: - (data) = self.post_move_file_with_http_info(src, dest, **kwargs) + (data) = self.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, **kwargs) return data - def post_move_file_with_http_info(self, src, dest, **kwargs): + def get_xsl_fo_in_storage_to_pdf_with_http_info(self, src_path, **kwargs): """ - Move 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.post_move_file_with_http_info(src, dest, 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 src: Source file path e.g. /fileSource.ext (required) - :param str dest: Destination file path e.g. /fileDestination.ext (required) - :param str version_id: Source file's version, - :param str storage: User's source storage name - :param str dest_storage: User's destination 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 = ['src', 'dest', 'version_id', 'storage', 'dest_storage'] + all_params = ['src_path', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -14848,16 +15723,13 @@ def post_move_file_with_http_info(self, src, dest, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_move_file" % key + " to method get_xsl_fo_in_storage_to_pdf" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'src' is set - if ('src' not in params) or (params['src'] is None): - raise ValueError("Missing the required parameter `src` when calling `post_move_file`") - # verify the required parameter 'dest' is set - if ('dest' not in params) or (params['dest'] is None): - raise ValueError("Missing the required parameter `dest` when calling `post_move_file`") + # 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 = {} @@ -14865,16 +15737,10 @@ def post_move_file_with_http_info(self, src, dest, **kwargs): path_params = {} query_params = [] - if 'src' in params: - query_params.append(('src', params['src'])) - if 'dest' in params: - query_params.append(('dest', params['dest'])) - 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'])) - if 'dest_storage' in params: - query_params.append(('destStorage', params['dest_storage'])) header_params = {} @@ -14884,23 +15750,23 @@ def post_move_file_with_http_info(self, src, dest, **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.\ - 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', 'POST', + 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'), @@ -14908,57 +15774,63 @@ def post_move_file_with_http_info(self, src, dest, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_move_folder(self, src, dest, **kwargs): + def post_append_document(self, name, **kwargs): """ - Move a specific folder + 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.post_move_folder(src, dest, callback=callback_function) + >>> thread = api.post_append_document(name, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) - :param str src: Source folder path e.g. /Folder1 (required) - :param str dest: Destination folder path e.g. /Folder2 (required) - :param str storage: User's source storage name - :param str dest_storage: User's destination storage name - :return: AsposeResponse + :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.post_move_folder_with_http_info(src, dest, **kwargs) + return self.post_append_document_with_http_info(name, **kwargs) else: - (data) = self.post_move_folder_with_http_info(src, dest, **kwargs) + (data) = self.post_append_document_with_http_info(name, **kwargs) return data - def post_move_folder_with_http_info(self, src, dest, **kwargs): + def post_append_document_with_http_info(self, name, **kwargs): """ - Move a specific folder + 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.post_move_folder_with_http_info(src, dest, 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 src: Source folder path e.g. /Folder1 (required) - :param str dest: Destination folder path e.g. /Folder2 (required) - :param str storage: User's source storage name - :param str dest_storage: User's destination storage name - :return: AsposeResponse + :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 = ['src', 'dest', 'storage', 'dest_storage'] + 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') @@ -14969,31 +15841,32 @@ def post_move_folder_with_http_info(self, src, dest, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_move_folder" % key + " to method post_append_document" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'src' is set - if ('src' not in params) or (params['src'] is None): - raise ValueError("Missing the required parameter `src` when calling `post_move_folder`") - # verify the required parameter 'dest' is set - if ('dest' not in params) or (params['dest'] is None): - raise ValueError("Missing the required parameter `dest` when calling `post_move_folder`") + # 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`") collection_formats = {} path_params = {} + if 'name' in params: + path_params['name'] = params['name'] query_params = [] - if 'src' in params: - query_params.append(('src', params['src'])) - if 'dest' in params: - query_params.append(('dest', params['dest'])) + 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 'dest_storage' in params: - query_params.append(('destStorage', params['dest_storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -15001,6 +15874,8 @@ def post_move_folder_with_http_info(self, src, dest, **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']) @@ -15012,14 +15887,14 @@ def post_move_folder_with_http_info(self, src, dest, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/storage/folder', 'POST', + return self.api_client.call_api('/pdf/{name}/appendDocument', 'POST', 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'), @@ -15027,22 +15902,22 @@ def post_move_folder_with_http_info(self, src, dest, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_move_page(self, name, page_number, new_index, **kwargs): + def post_create_field(self, name, page, **kwargs): """ - Move page to new position. + 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.post_move_page(name, page_number, new_index, 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 int page_number: The page number. (required) - :param int new_index: The new page position/index. (required) + :param int page: Document page number. (required) + :param Field field: with the field data. :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -15051,27 +15926,27 @@ def post_move_page(self, name, page_number, new_index, **kwargs): """ 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.post_create_field_with_http_info(name, page, **kwargs) else: - (data) = self.post_move_page_with_http_info(name, page_number, new_index, **kwargs) + (data) = self.post_create_field_with_http_info(name, page, **kwargs) return data - def post_move_page_with_http_info(self, name, page_number, new_index, **kwargs): + def post_create_field_with_http_info(self, name, page, **kwargs): """ - Move page to new position. + 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.post_move_page_with_http_info(name, page_number, new_index, 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 int page_number: The page number. (required) - :param int new_index: The new page position/index. (required) + :param int page: Document page number. (required) + :param Field field: with the field data. :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -15079,7 +15954,7 @@ def post_move_page_with_http_info(self, name, page_number, new_index, **kwargs): returns the request thread. """ - all_params = ['name', 'page_number', 'new_index', 'storage', 'folder'] + all_params = ['name', 'page', 'field', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15090,19 +15965,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 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 `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 `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 = {} @@ -15110,12 +15982,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'] query_params = [] - if 'new_index' in params: - query_params.append(('newIndex', params['new_index'])) + if 'page' in params: + query_params.append(('page', params['page'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -15127,6 +15997,8 @@ def post_move_page_with_http_info(self, name, page_number, new_index, **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']) @@ -15138,7 +16010,7 @@ 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}/fields', 'POST', path_params, query_params, header_params, @@ -15153,57 +16025,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 post_document_text_replace(self, name, text_replace, **kwargs): """ - Optimize 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.post_optimize_document(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 OptimizeOptions options: The optimization options. - :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.post_optimize_document_with_http_info(name, **kwargs) + return self.post_document_text_replace_with_http_info(name, text_replace, **kwargs) else: - (data) = self.post_optimize_document_with_http_info(name, **kwargs) + (data) = self.post_document_text_replace_with_http_info(name, text_replace, **kwargs) return data - def post_optimize_document_with_http_info(self, name, **kwargs): + def post_document_text_replace_with_http_info(self, name, text_replace, **kwargs): """ - Optimize 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.post_optimize_document_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 OptimizeOptions options: The optimization options. - :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', 'options', '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') @@ -15214,13 +16086,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 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 `post_optimize_document`") + 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 = {} @@ -15241,8 +16116,8 @@ def post_optimize_document_with_http_info(self, name, **kwargs): local_var_files = {} body_params = None - if 'options' in params: - body_params = params['options'] + if 'text_replace' in params: + body_params = params['text_replace'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -15254,14 +16129,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}/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'), @@ -15269,22 +16144,23 @@ def post_optimize_document_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_caret_annotations(self, name, page_number, annotations, **kwargs): + def post_flatten_document(self, name, **kwargs): """ - Add document page caret annotations. + Flatten 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.post_page_caret_annotations(name, page_number, annotations, callback=callback_function) + >>> thread = api.post_flatten_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 list[CaretAnnotation] annotations: The array of annotation. (required) + :param bool update_appearances: If set, all field appearances will be regenerated before flattening. This option may help if field is incorrectly flattened. This option may decrease performance.. + :param bool call_events: If set, formatting and other JavaScript events will be called. + :param bool hide_buttons: If set, buttons will be removed from flattened document. :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -15293,27 +16169,28 @@ def post_page_caret_annotations(self, name, page_number, annotations, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_caret_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.post_flatten_document_with_http_info(name, **kwargs) else: - (data) = self.post_page_caret_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_flatten_document_with_http_info(name, **kwargs) return data - def post_page_caret_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_flatten_document_with_http_info(self, name, **kwargs): """ - Add document page caret annotations. + Flatten 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.post_page_caret_annotations_with_http_info(name, page_number, annotations, callback=callback_function) + >>> thread = api.post_flatten_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 list[CaretAnnotation] annotations: The array of annotation. (required) + :param bool update_appearances: If set, all field appearances will be regenerated before flattening. This option may help if field is incorrectly flattened. This option may decrease performance.. + :param bool call_events: If set, formatting and other JavaScript events will be called. + :param bool hide_buttons: If set, buttons will be removed from flattened document. :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -15321,7 +16198,7 @@ def post_page_caret_annotations_with_http_info(self, name, page_number, annotati returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] + all_params = ['name', 'update_appearances', 'call_events', 'hide_buttons', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15332,19 +16209,13 @@ def post_page_caret_annotations_with_http_info(self, name, page_number, annotati if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_caret_annotations" % key + " to method post_flatten_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 `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`") + raise ValueError("Missing the required parameter `name` when calling `post_flatten_document`") collection_formats = {} @@ -15352,10 +16223,14 @@ def post_page_caret_annotations_with_http_info(self, name, page_number, annotati 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 'update_appearances' in params: + query_params.append(('updateAppearances', params['update_appearances'])) + if 'call_events' in params: + query_params.append(('callEvents', params['call_events'])) + if 'hide_buttons' in params: + query_params.append(('hideButtons', params['hide_buttons'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -15367,8 +16242,6 @@ def post_page_caret_annotations_with_http_info(self, name, page_number, annotati 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']) @@ -15380,7 +16253,7 @@ def post_page_caret_annotations_with_http_info(self, name, page_number, annotati # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/caret', 'POST', + return self.api_client.call_api('/pdf/{name}/flatten', 'POST', path_params, query_params, header_params, @@ -15395,59 +16268,69 @@ def post_page_caret_annotations_with_http_info(self, name, page_number, annotati _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_circle_annotations(self, name, page_number, annotations, **kwargs): + def post_insert_image(self, name, page_number, llx, lly, urx, ury, **kwargs): """ - Add document page circle annotations. + 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.post_page_circle_annotations(name, page_number, annotations, 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 int page_number: The page number. (required) - :param list[CircleAnnotation] annotations: The array of annotation. (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 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.post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) else: - (data) = self.post_page_circle_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs) return data - def post_page_circle_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury, **kwargs): """ - Add document page circle annotations. + 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.post_page_circle_annotations_with_http_info(name, page_number, annotations, 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 int page_number: The page number. (required) - :param list[CircleAnnotation] annotations: The array of annotation. (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 If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', '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') @@ -15458,19 +16341,28 @@ 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 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 `post_page_circle_annotations`") + 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_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 `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 = {} @@ -15482,6 +16374,16 @@ def post_page_circle_annotations_with_http_info(self, name, page_number, annotat 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: @@ -15491,22 +16393,22 @@ def post_page_circle_annotations_with_http_info(self, name, page_number, annotat form_params = [] local_var_files = {} + if 'image' in params: + local_var_files['image'] = params['image'] 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']) # 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}/pages/{pageNumber}/annotations/circle', 'POST', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images', 'POST', path_params, query_params, header_params, @@ -15521,59 +16423,59 @@ 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 post_move_file(self, src, dest, **kwargs): """ - Add document page free text annotations. + Move 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.post_page_free_text_annotations(name, page_number, annotations, callback=callback_function) + >>> thread = api.post_move_file(src, dest, 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 storage: The document storage. - :param str folder: The document folder. + :param str src: Source file path e.g. /fileSource.ext (required) + :param str dest: Destination file path e.g. /fileDestination.ext (required) + :param str version_id: Source file's version, + :param str storage: User's source storage name + :param str dest_storage: User's destination 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.post_page_free_text_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.post_move_file_with_http_info(src, dest, **kwargs) else: - (data) = self.post_page_free_text_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_move_file_with_http_info(src, dest, **kwargs) return data - def post_page_free_text_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_move_file_with_http_info(self, src, dest, **kwargs): """ - Add document page free text annotations. + Move 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.post_page_free_text_annotations_with_http_info(name, page_number, annotations, callback=callback_function) + >>> thread = api.post_move_file_with_http_info(src, dest, 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 storage: The document storage. - :param str folder: The document folder. + :param str src: Source file path e.g. /fileSource.ext (required) + :param str dest: Destination file path e.g. /fileDestination.ext (required) + :param str version_id: Source file's version, + :param str storage: User's source storage name + :param str dest_storage: User's destination storage name :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] + all_params = ['src', 'dest', 'version_id', 'storage', 'dest_storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15584,34 +16486,33 @@ 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 post_move_file" % 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' is set + if ('src' not in params) or (params['src'] is None): + raise ValueError("Missing the required parameter `src` when calling `post_move_file`") + # verify the required parameter 'dest' is set + if ('dest' not in params) or (params['dest'] is None): + raise ValueError("Missing the required parameter `dest` when calling `post_move_file`") 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' in params: + query_params.append(('src', params['src'])) + if 'dest' in params: + query_params.append(('dest', params['dest'])) + 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'])) + if 'dest_storage' in params: + query_params.append(('destStorage', params['dest_storage'])) header_params = {} @@ -15619,20 +16520,18 @@ 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']) # 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}/pages/{pageNumber}/annotations/freetext', 'POST', + return self.api_client.call_api('/storage/file', 'POST', path_params, query_params, header_params, @@ -15647,59 +16546,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_highlight_annotations(self, name, page_number, annotations, **kwargs): + def post_move_folder(self, src, dest, **kwargs): """ - Add document page highlight annotations. + Move 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.post_page_highlight_annotations(name, page_number, annotations, callback=callback_function) + >>> thread = api.post_move_folder(src, dest, 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[HighlightAnnotation] annotations: The array of annotation. (required) - :param str storage: The document storage. - :param str folder: The document folder. + :param str src: Source folder path e.g. /Folder1 (required) + :param str dest: Destination folder path e.g. /Folder2 (required) + :param str storage: User's source storage name + :param str dest_storage: User's destination 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.post_page_highlight_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.post_move_folder_with_http_info(src, dest, **kwargs) else: - (data) = self.post_page_highlight_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_move_folder_with_http_info(src, dest, **kwargs) return data - def post_page_highlight_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_move_folder_with_http_info(self, src, dest, **kwargs): """ - Add document page highlight annotations. + Move 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.post_page_highlight_annotations_with_http_info(name, page_number, annotations, callback=callback_function) + >>> thread = api.post_move_folder_with_http_info(src, dest, 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[HighlightAnnotation] annotations: The array of annotation. (required) - :param str storage: The document storage. - :param str folder: The document folder. + :param str src: Source folder path e.g. /Folder1 (required) + :param str dest: Destination folder path e.g. /Folder2 (required) + :param str storage: User's source storage name + :param str dest_storage: User's destination storage name :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] + all_params = ['src', 'dest', 'storage', 'dest_storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15710,34 +16607,31 @@ def post_page_highlight_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_highlight_annotations" % key + " to method post_move_folder" % 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_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`") + # verify the required parameter 'src' is set + if ('src' not in params) or (params['src'] is None): + raise ValueError("Missing the required parameter `src` when calling `post_move_folder`") + # verify the required parameter 'dest' is set + if ('dest' not in params) or (params['dest'] is None): + raise ValueError("Missing the required parameter `dest` when calling `post_move_folder`") 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' in params: + query_params.append(('src', params['src'])) + if 'dest' in params: + query_params.append(('dest', params['dest'])) if 'storage' in params: query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) + if 'dest_storage' in params: + query_params.append(('destStorage', params['dest_storage'])) header_params = {} @@ -15745,8 +16639,6 @@ def post_page_highlight_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']) @@ -15758,7 +16650,7 @@ def post_page_highlight_annotations_with_http_info(self, name, page_number, anno # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/highlight', 'POST', + return self.api_client.call_api('/storage/folder', 'POST', path_params, query_params, header_params, @@ -15773,22 +16665,22 @@ def post_page_highlight_annotations_with_http_info(self, name, page_number, anno _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_ink_annotations(self, name, page_number, annotations, **kwargs): + def post_move_page(self, name, page_number, new_index, **kwargs): """ - Add document page ink annotations. + 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.post_page_ink_annotations(name, page_number, annotations, 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 int page_number: The page number. (required) - :param list[InkAnnotation] annotations: The array of annotation. (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 @@ -15797,27 +16689,27 @@ def post_page_ink_annotations(self, name, page_number, annotations, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_ink_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.post_move_page_with_http_info(name, page_number, new_index, **kwargs) else: - (data) = self.post_page_ink_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_move_page_with_http_info(name, page_number, new_index, **kwargs) return data - def post_page_ink_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_move_page_with_http_info(self, name, page_number, new_index, **kwargs): """ - Add document page ink annotations. + 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.post_page_ink_annotations_with_http_info(name, page_number, annotations, 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 int page_number: The page number. (required) - :param list[InkAnnotation] annotations: The array of annotation. (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 @@ -15825,7 +16717,7 @@ def post_page_ink_annotations_with_http_info(self, name, page_number, annotation returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] + 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') @@ -15836,19 +16728,19 @@ def post_page_ink_annotations_with_http_info(self, name, page_number, annotation if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_ink_annotations" % 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 `post_page_ink_annotations`") + 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_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`") + 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 = {} @@ -15860,6 +16752,8 @@ def post_page_ink_annotations_with_http_info(self, name, page_number, annotation path_params['pageNumber'] = params['page_number'] 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: @@ -15871,8 +16765,6 @@ def post_page_ink_annotations_with_http_info(self, name, page_number, annotation 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']) @@ -15884,7 +16776,7 @@ def post_page_ink_annotations_with_http_info(self, name, page_number, annotation # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/ink', 'POST', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/movePage', 'POST', path_params, query_params, header_params, @@ -15899,22 +16791,21 @@ def post_page_ink_annotations_with_http_info(self, name, page_number, annotation _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_line_annotations(self, name, page_number, annotations, **kwargs): + def post_optimize_document(self, name, **kwargs): """ - Add document page line annotations. + 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.post_page_line_annotations(name, page_number, annotations, 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 int page_number: The page number. (required) - :param list[LineAnnotation] annotations: The array of annotation. (required) + :param OptimizeOptions options: The optimization options. :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -15923,27 +16814,26 @@ def post_page_line_annotations(self, name, page_number, annotations, **kwargs): """ 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.post_optimize_document_with_http_info(name, **kwargs) else: - (data) = self.post_page_line_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_optimize_document_with_http_info(name, **kwargs) return data - def post_page_line_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_optimize_document_with_http_info(self, name, **kwargs): """ - Add document page line annotations. + 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.post_page_line_annotations_with_http_info(name, page_number, annotations, 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 int page_number: The page number. (required) - :param list[LineAnnotation] annotations: The array of annotation. (required) + :param OptimizeOptions options: The optimization options. :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -15951,7 +16841,7 @@ def post_page_line_annotations_with_http_info(self, name, page_number, annotatio returns the request thread. """ - all_params = ['name', 'page_number', 'annotations', 'storage', 'folder'] + all_params = ['name', 'options', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -15962,19 +16852,13 @@ 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 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 `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 `post_optimize_document`") collection_formats = {} @@ -15982,8 +16866,6 @@ 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'] query_params = [] if 'storage' in params: @@ -15997,8 +16879,8 @@ 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'] + if 'options' in params: + body_params = params['options'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -16010,7 +16892,7 @@ 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}/optimize', 'POST', path_params, query_params, header_params, @@ -16025,22 +16907,22 @@ 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 post_page_caret_annotations(self, name, page_number, annotations, **kwargs): """ - Add document page link annotations. + 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.post_page_link_annotations(name, page_number, links, 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 int page_number: The page number. (required) - :param list[LinkAnnotation] links: Array of link anotation. (required) + :param list[CaretAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16049,27 +16931,27 @@ def post_page_link_annotations(self, name, page_number, links, **kwargs): """ 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.post_page_caret_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.post_page_link_annotations_with_http_info(name, page_number, links, **kwargs) + (data) = self.post_page_caret_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def post_page_link_annotations_with_http_info(self, name, page_number, links, **kwargs): + def post_page_caret_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Add document page link annotations. + 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.post_page_link_annotations_with_http_info(name, page_number, links, 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 int page_number: The page number. (required) - :param list[LinkAnnotation] links: Array of link anotation. (required) + :param list[CaretAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16077,7 +16959,7 @@ def post_page_link_annotations_with_http_info(self, name, page_number, links, ** returns the request thread. """ - all_params = ['name', 'page_number', 'links', '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') @@ -16088,19 +16970,19 @@ 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 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 `post_page_link_annotations`") + 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_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 `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 = {} @@ -16123,8 +17005,8 @@ 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'] + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -16136,7 +17018,7 @@ 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}/pages/{pageNumber}/annotations/caret', 'POST', path_params, query_params, header_params, @@ -16151,22 +17033,22 @@ 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 post_page_circle_annotations(self, name, page_number, annotations, **kwargs): """ - Add document page polyline annotations. + 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.post_page_poly_line_annotations(name, page_number, annotations, 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 int page_number: The page number. (required) - :param list[PolyLineAnnotation] annotations: The array of annotation. (required) + :param list[CircleAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16175,27 +17057,27 @@ def post_page_poly_line_annotations(self, name, page_number, annotations, **kwar """ 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.post_page_circle_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.post_page_poly_line_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_page_circle_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def post_page_poly_line_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_page_circle_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Add document page polyline annotations. + 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.post_page_poly_line_annotations_with_http_info(name, page_number, annotations, 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 int page_number: The page number. (required) - :param list[PolyLineAnnotation] annotations: The array of annotation. (required) + :param list[CircleAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16214,19 +17096,19 @@ 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 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 `post_page_poly_line_annotations`") + 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_poly_line_annotations`") + 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_poly_line_annotations`") + raise ValueError("Missing the required parameter `annotations` when calling `post_page_circle_annotations`") collection_formats = {} @@ -16262,7 +17144,7 @@ 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}/pages/{pageNumber}/annotations/circle', 'POST', path_params, query_params, header_params, @@ -16277,22 +17159,22 @@ 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 post_page_file_attachment_annotations(self, name, page_number, annotations, **kwargs): """ - Add document page polygon annotations. + Add document page FileAttachment 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.post_page_polygon_annotations(name, page_number, annotations, callback=callback_function) + >>> thread = api.post_page_file_attachment_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 list[PolygonAnnotation] annotations: The array of annotation. (required) + :param list[FileAttachmentAnnotation] annotations: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16301,27 +17183,27 @@ def post_page_polygon_annotations(self, name, page_number, annotations, **kwargs """ 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.post_page_file_attachment_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.post_page_polygon_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_page_file_attachment_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def post_page_polygon_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_page_file_attachment_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Add document page polygon annotations. + Add document page FileAttachment 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.post_page_polygon_annotations_with_http_info(name, page_number, annotations, callback=callback_function) + >>> thread = api.post_page_file_attachment_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 list[PolygonAnnotation] annotations: The array of annotation. (required) + :param list[FileAttachmentAnnotation] annotations: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16340,19 +17222,19 @@ 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 post_page_file_attachment_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 `post_page_polygon_annotations`") + raise ValueError("Missing the required parameter `name` when calling `post_page_file_attachment_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`") + raise ValueError("Missing the required parameter `page_number` when calling `post_page_file_attachment_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`") + raise ValueError("Missing the required parameter `annotations` when calling `post_page_file_attachment_annotations`") collection_formats = {} @@ -16388,7 +17270,7 @@ 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/{name}/pages/{pageNumber}/annotations/fileattachment', 'POST', path_params, query_params, header_params, @@ -16403,22 +17285,22 @@ 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 post_page_free_text_annotations(self, name, page_number, annotations, **kwargs): """ - Add document page square annotations. + 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.post_page_square_annotations(name, page_number, annotations, 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 int page_number: The page number. (required) - :param list[SquareAnnotation] annotations: The array of annotation. (required) + :param list[FreeTextAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16427,27 +17309,27 @@ def post_page_square_annotations(self, name, page_number, annotations, **kwargs) """ 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.post_page_free_text_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.post_page_square_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_page_free_text_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def post_page_square_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_page_free_text_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Add document page square annotations. + 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.post_page_square_annotations_with_http_info(name, page_number, annotations, 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 int page_number: The page number. (required) - :param list[SquareAnnotation] annotations: The array of annotation. (required) + :param list[FreeTextAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16466,19 +17348,19 @@ 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 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 `post_page_square_annotations`") + 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_square_annotations`") + 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_square_annotations`") + raise ValueError("Missing the required parameter `annotations` when calling `post_page_free_text_annotations`") collection_formats = {} @@ -16514,7 +17396,7 @@ 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}/pages/{pageNumber}/annotations/freetext', 'POST', path_params, query_params, header_params, @@ -16529,22 +17411,22 @@ 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_squiggly_annotations(self, name, page_number, annotations, **kwargs): + def post_page_highlight_annotations(self, name, page_number, annotations, **kwargs): """ - Add document page squiggly annotations. + 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.post_page_squiggly_annotations(name, page_number, annotations, 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 int page_number: The page number. (required) - :param list[SquigglyAnnotation] annotations: The array of annotation. (required) + :param list[HighlightAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16553,27 +17435,27 @@ def post_page_squiggly_annotations(self, name, page_number, annotations, **kwarg """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_squiggly_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.post_page_highlight_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.post_page_squiggly_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_page_highlight_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def post_page_squiggly_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_page_highlight_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Add document page squiggly annotations. + 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.post_page_squiggly_annotations_with_http_info(name, page_number, annotations, 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 int page_number: The page number. (required) - :param list[SquigglyAnnotation] annotations: The array of annotation. (required) + :param list[HighlightAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16592,19 +17474,19 @@ def post_page_squiggly_annotations_with_http_info(self, name, page_number, annot if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_squiggly_annotations" % 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 `post_page_squiggly_annotations`") + 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_squiggly_annotations`") + 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_squiggly_annotations`") + raise ValueError("Missing the required parameter `annotations` when calling `post_page_highlight_annotations`") collection_formats = {} @@ -16640,7 +17522,7 @@ def post_page_squiggly_annotations_with_http_info(self, name, page_number, annot # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/squiggly', 'POST', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/highlight', 'POST', path_params, query_params, header_params, @@ -16655,22 +17537,22 @@ def post_page_squiggly_annotations_with_http_info(self, name, page_number, annot _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_strike_out_annotations(self, name, page_number, annotations, **kwargs): + def post_page_ink_annotations(self, name, page_number, annotations, **kwargs): """ - Add document page StrikeOut annotations. + 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.post_page_strike_out_annotations(name, page_number, annotations, 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 list[StrikeOutAnnotation] annotations: The array of annotation. (required) + :param list[InkAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16679,27 +17561,27 @@ def post_page_strike_out_annotations(self, name, page_number, annotations, **kwa """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_strike_out_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.post_page_ink_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.post_page_strike_out_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_page_ink_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def post_page_strike_out_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_page_ink_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Add document page StrikeOut annotations. + 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.post_page_strike_out_annotations_with_http_info(name, page_number, annotations, 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 list[StrikeOutAnnotation] annotations: The array of annotation. (required) + :param list[InkAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16718,19 +17600,19 @@ def post_page_strike_out_annotations_with_http_info(self, name, page_number, ann if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method post_page_strike_out_annotations" % 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 `post_page_strike_out_annotations`") + 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 `post_page_strike_out_annotations`") + 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_strike_out_annotations`") + raise ValueError("Missing the required parameter `annotations` when calling `post_page_ink_annotations`") collection_formats = {} @@ -16766,7 +17648,7 @@ def post_page_strike_out_annotations_with_http_info(self, name, page_number, ann # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/strikeout', 'POST', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/ink', 'POST', path_params, query_params, header_params, @@ -16781,22 +17663,22 @@ def post_page_strike_out_annotations_with_http_info(self, name, page_number, ann _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_page_text_annotations(self, name, page_number, annotations, **kwargs): + def post_page_line_annotations(self, name, page_number, annotations, **kwargs): """ - Add document page text annotations. + 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.post_page_text_annotations(name, page_number, annotations, 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 list[TextAnnotation] annotations: The array of annotation. (required) + :param list[LineAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16805,27 +17687,27 @@ def post_page_text_annotations(self, name, page_number, annotations, **kwargs): """ 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.post_page_line_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.post_page_text_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_page_line_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def post_page_text_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_page_line_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Add document page text annotations. + 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.post_page_text_annotations_with_http_info(name, page_number, annotations, 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 list[TextAnnotation] annotations: The array of annotation. (required) + :param list[LineAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -16844,19 +17726,19 @@ 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 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 `post_page_text_annotations`") + 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_text_annotations`") + 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_text_annotations`") + raise ValueError("Missing the required parameter `annotations` when calling `post_page_line_annotations`") collection_formats = {} @@ -16892,7 +17774,7 @@ 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}/pages/{pageNumber}/annotations/line', 'POST', path_params, query_params, header_params, @@ -16907,59 +17789,59 @@ 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 post_page_link_annotations(self, name, page_number, links, **kwargs): """ - Page's replace text method. + 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.post_page_text_replace(name, page_number, text_replace_list_request, 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: (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 int page_number: The page number. (required) + :param list[LinkAnnotation] links: Array of link anotation. (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.post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, **kwargs) + return self.post_page_link_annotations_with_http_info(name, page_number, links, **kwargs) else: - (data) = self.post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, **kwargs) + (data) = self.post_page_link_annotations_with_http_info(name, page_number, links, **kwargs) return data - def post_page_text_replace_with_http_info(self, name, page_number, text_replace_list_request, **kwargs): + def post_page_link_annotations_with_http_info(self, name, page_number, links, **kwargs): """ - Page's replace text method. + 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.post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, 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: (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 int page_number: The page number. (required) + :param list[LinkAnnotation] links: Array of link anotation. (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', 'text_replace_list_request', 'storage', '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') @@ -16970,19 +17852,19 @@ 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 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 `post_page_text_replace`") + 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_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 `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 = {} @@ -17005,8 +17887,8 @@ 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'] + if 'links' in params: + body_params = params['links'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -17018,14 +17900,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}/pages/{pageNumber}/links', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TextReplaceResponse', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -17033,22 +17915,22 @@ 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_page_underline_annotations(self, name, page_number, annotations, **kwargs): + def post_page_movie_annotations(self, name, page_number, annotations, **kwargs): """ - Add document page underline annotations. + Add document page movie 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.post_page_underline_annotations(name, page_number, annotations, callback=callback_function) + >>> thread = api.post_page_movie_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 list[UnderlineAnnotation] annotations: The array of annotation. (required) + :param list[MovieAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -17057,27 +17939,27 @@ def post_page_underline_annotations(self, name, page_number, annotations, **kwar """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_page_underline_annotations_with_http_info(name, page_number, annotations, **kwargs) + return self.post_page_movie_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.post_page_underline_annotations_with_http_info(name, page_number, annotations, **kwargs) + (data) = self.post_page_movie_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def post_page_underline_annotations_with_http_info(self, name, page_number, annotations, **kwargs): + def post_page_movie_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Add document page underline annotations. + Add document page movie 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.post_page_underline_annotations_with_http_info(name, page_number, annotations, callback=callback_function) + >>> thread = api.post_page_movie_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 list[UnderlineAnnotation] annotations: The array of annotation. (required) + :param list[MovieAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -17096,19 +17978,19 @@ def post_page_underline_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_underline_annotations" % key + " to method post_page_movie_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 `post_page_underline_annotations`") + raise ValueError("Missing the required parameter `name` when calling `post_page_movie_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_underline_annotations`") + raise ValueError("Missing the required parameter `page_number` when calling `post_page_movie_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`") + raise ValueError("Missing the required parameter `annotations` when calling `post_page_movie_annotations`") collection_formats = {} @@ -17144,7 +18026,7 @@ def post_page_underline_annotations_with_http_info(self, name, page_number, anno # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/underline', 'POST', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/movie', 'POST', path_params, query_params, header_params, @@ -17159,22 +18041,22 @@ def post_page_underline_annotations_with_http_info(self, name, page_number, anno _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_popup_annotation(self, name, annotation_id, annotation, **kwargs): + def post_page_poly_line_annotations(self, name, page_number, annotations, **kwargs): """ - Add document popup annotations. + 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.post_popup_annotation(name, annotation_id, annotation, 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 str annotation_id: The parent annotation ID. (required) - :param PopupAnnotation annotation: The annotation. (required) + :param int page_number: The page number. (required) + :param list[PolyLineAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -17183,27 +18065,27 @@ def post_popup_annotation(self, name, annotation_id, annotation, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_popup_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.post_page_poly_line_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.post_popup_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.post_page_poly_line_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def post_popup_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def post_page_poly_line_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Add document popup annotations. + 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.post_popup_annotation_with_http_info(name, annotation_id, annotation, 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 str annotation_id: The parent annotation ID. (required) - :param PopupAnnotation annotation: The annotation. (required) + :param int page_number: The page number. (required) + :param list[PolyLineAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -17211,7 +18093,7 @@ def post_popup_annotation_with_http_info(self, name, annotation_id, annotation, 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') @@ -17222,19 +18104,19 @@ def post_popup_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 post_popup_annotation" % 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 `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`") + 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`") collection_formats = {} @@ -17242,8 +18124,8 @@ def post_popup_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: @@ -17257,8 +18139,8 @@ def post_popup_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']) @@ -17270,7 +18152,7 @@ def post_popup_annotation_with_http_info(self, name, annotation_id, annotation, # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/{annotationId}/popup', 'POST', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polyline', 'POST', path_params, query_params, header_params, @@ -17285,21 +18167,22 @@ def post_popup_annotation_with_http_info(self, name, annotation_id, annotation, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def post_sign_document(self, name, **kwargs): + def post_page_polygon_annotations(self, name, page_number, annotations, **kwargs): """ - Sign document. + 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.post_sign_document(name, 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 Signature signature: Signature object containing signature data. + :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 @@ -17308,26 +18191,27 @@ def post_sign_document(self, name, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_sign_document_with_http_info(name, **kwargs) + return self.post_page_polygon_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.post_sign_document_with_http_info(name, **kwargs) + (data) = self.post_page_polygon_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def post_sign_document_with_http_info(self, name, **kwargs): + def post_page_polygon_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Sign document. + 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.post_sign_document_with_http_info(name, 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 Signature signature: Signature object containing signature data. + :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 @@ -17335,7 +18219,7 @@ def post_sign_document_with_http_info(self, name, **kwargs): returns the request thread. """ - all_params = ['name', 'signature', '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') @@ -17346,13 +18230,19 @@ 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 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 `post_sign_document`") + 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 = {} @@ -17360,6 +18250,8 @@ def post_sign_document_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: @@ -17373,8 +18265,8 @@ def post_sign_document_with_http_info(self, name, **kwargs): local_var_files = {} body_params = None - if 'signature' in params: - body_params = params['signature'] + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -17386,7 +18278,7 @@ 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}/pages/{pageNumber}/annotations/polygon', 'POST', path_params, query_params, header_params, @@ -17401,22 +18293,22 @@ 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 post_page_redaction_annotations(self, name, page_number, annotations, **kwargs): """ - Sign page. + Add document page redaction 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.post_sign_page(name, page_number, callback=callback_function) + >>> thread = api.post_page_redaction_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 Signature signature: Signature object containing signature data. + :param list[RedactionAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -17425,27 +18317,27 @@ def post_sign_page(self, name, page_number, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.post_sign_page_with_http_info(name, page_number, **kwargs) + return self.post_page_redaction_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.post_sign_page_with_http_info(name, page_number, **kwargs) + (data) = self.post_page_redaction_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def post_sign_page_with_http_info(self, name, page_number, **kwargs): + def post_page_redaction_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Sign page. + Add document page redaction 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.post_sign_page_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.post_page_redaction_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 Signature signature: Signature object containing signature data. + :param list[RedactionAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -17453,7 +18345,7 @@ def post_sign_page_with_http_info(self, name, page_number, **kwargs): returns the request thread. """ - all_params = ['name', 'page_number', 'signature', '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') @@ -17464,16 +18356,19 @@ 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 post_page_redaction_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 `post_sign_page`") + raise ValueError("Missing the required parameter `name` when calling `post_page_redaction_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_sign_page`") + raise ValueError("Missing the required parameter `page_number` when calling `post_page_redaction_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_redaction_annotations`") collection_formats = {} @@ -17496,8 +18391,8 @@ 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'] + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -17509,7 +18404,7 @@ 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/{name}/pages/{pageNumber}/annotations/redaction', 'POST', path_params, query_params, header_params, @@ -17524,61 +18419,59 @@ 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 post_page_sound_annotations(self, name, page_number, annotations, **kwargs): """ - Split document to parts. + Add document page sound 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.post_split_document(name, callback=callback_function) + >>> thread = api.post_page_sound_annotations(name, page_number, annotations, 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 int page_number: The page number. (required) + :param list[SoundAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SplitResultResponse + :return: AsposeResponse 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.post_page_sound_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.post_split_document_with_http_info(name, **kwargs) + (data) = self.post_page_sound_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def post_split_document_with_http_info(self, name, **kwargs): + def post_page_sound_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Split document to parts. + Add document page sound 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.post_split_document_with_http_info(name, callback=callback_function) + >>> thread = api.post_page_sound_annotations_with_http_info(name, page_number, annotations, 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 int page_number: The page number. (required) + :param list[SoundAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: SplitResultResponse + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'format', '_from', 'to', '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') @@ -17589,13 +18482,19 @@ 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 post_page_sound_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 `post_split_document`") + raise ValueError("Missing the required parameter `name` when calling `post_page_sound_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_sound_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_sound_annotations`") collection_formats = {} @@ -17603,14 +18502,10 @@ def post_split_document_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 '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: @@ -17622,6 +18517,8 @@ def post_split_document_with_http_info(self, name, **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']) @@ -17633,14 +18530,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/{pageNumber}/annotations/sound', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='SplitResultResponse', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -17648,55 +18545,59 @@ 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 post_page_square_annotations(self, name, page_number, annotations, **kwargs): """ - Add new page to end of the document. + 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_add_new_page(name, 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 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: DocumentPagesResponse + :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_add_new_page_with_http_info(name, **kwargs) + return self.post_page_square_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_add_new_page_with_http_info(name, **kwargs) + (data) = self.post_page_square_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_add_new_page_with_http_info(self, name, **kwargs): + def post_page_square_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Add new page to end of the document. + 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_add_new_page_with_http_info(name, 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 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: DocumentPagesResponse + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', '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') @@ -17707,13 +18608,19 @@ 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 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_add_new_page`") + 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 = {} @@ -17721,6 +18628,8 @@ def put_add_new_page_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: @@ -17734,6 +18643,8 @@ def put_add_new_page_with_http_info(self, name, **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']) @@ -17745,14 +18656,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}/pages/{pageNumber}/annotations/square', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentPagesResponse', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -17760,59 +18671,59 @@ 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 post_page_squiggly_annotations(self, name, page_number, annotations, **kwargs): """ - Add text to PDF document page. + 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_add_text(name, page_number, 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 int page_number: Number of page (starting from 1). (required) - :param Paragraph paragraph: Paragraph data. - :param str folder: Document folder. + :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: AsposeResponse 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.post_page_squiggly_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_add_text_with_http_info(name, page_number, **kwargs) + (data) = self.post_page_squiggly_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_add_text_with_http_info(self, name, page_number, **kwargs): + def post_page_squiggly_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Add text to PDF document page. + 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_add_text_with_http_info(name, page_number, 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 int page_number: Number of page (starting from 1). (required) - :param Paragraph paragraph: Paragraph data. - :param str folder: Document folder. + :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: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'paragraph', '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') @@ -17823,16 +18734,19 @@ 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 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_add_text`") + 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 `put_add_text`") + 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 = {} @@ -17844,10 +18758,10 @@ def put_add_text_with_http_info(self, name, page_number, **kwargs): 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 = {} @@ -17855,8 +18769,8 @@ 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'] + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -17868,7 +18782,7 @@ 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/{name}/pages/{pageNumber}/annotations/squiggly', 'POST', path_params, query_params, header_params, @@ -17883,59 +18797,59 @@ def put_add_text_with_http_info(self, name, page_number, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_caret_annotation(self, name, annotation_id, annotation, **kwargs): + def post_page_strike_out_annotations(self, name, page_number, annotations, **kwargs): """ - Replace document caret annotation + 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_caret_annotation(name, annotation_id, annotation, 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: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param CaretAnnotation annotation: Annotation. (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: CaretAnnotationResponse + :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_caret_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.post_page_strike_out_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_caret_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.post_page_strike_out_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_caret_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def post_page_strike_out_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Replace document caret annotation + 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_caret_annotation_with_http_info(name, annotation_id, annotation, 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: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param CaretAnnotation annotation: Annotation. (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: CaretAnnotationResponse + :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') @@ -17946,19 +18860,19 @@ def put_caret_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_caret_annotation" % 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_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`") + 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 = {} @@ -17966,8 +18880,8 @@ def put_caret_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: @@ -17981,8 +18895,8 @@ def put_caret_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']) @@ -17994,14 +18908,14 @@ def put_caret_annotation_with_http_info(self, name, annotation_id, annotation, * # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/caret/{annotationId}', '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='CaretAnnotationResponse', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -18009,59 +18923,59 @@ def put_caret_annotation_with_http_info(self, name, annotation_id, annotation, * _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_circle_annotation(self, name, annotation_id, annotation, **kwargs): + def post_page_text_annotations(self, name, page_number, annotations, **kwargs): """ - Replace document circle annotation + 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_circle_annotation(name, annotation_id, annotation, 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 annotation_id: The annotation ID. (required) - :param CircleAnnotation annotation: Annotation. (required) + :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: CircleAnnotationResponse + :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_circle_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.post_page_text_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_circle_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.post_page_text_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_circle_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def post_page_text_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Replace document circle annotation + 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_circle_annotation_with_http_info(name, annotation_id, annotation, 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 annotation_id: The annotation ID. (required) - :param CircleAnnotation annotation: Annotation. (required) + :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: CircleAnnotationResponse + :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') @@ -18072,19 +18986,19 @@ 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 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_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`") + 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 = {} @@ -18092,8 +19006,8 @@ def put_circle_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: @@ -18107,8 +19021,8 @@ 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'] + if 'annotations' in params: + body_params = params['annotations'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -18120,14 +19034,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/{name}/pages/{pageNumber}/annotations/text', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='CircleAnnotationResponse', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -18135,57 +19049,59 @@ 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 post_page_text_replace(self, name, page_number, text_replace_list_request, **kwargs): """ - Upload a specific file + 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_create(path, file, 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 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 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_create_with_http_info(path, file, **kwargs) + return self.post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, **kwargs) else: - (data) = self.put_create_with_http_info(path, file, **kwargs) + (data) = self.post_page_text_replace_with_http_info(name, page_number, text_replace_list_request, **kwargs) return data - def put_create_with_http_info(self, path, file, **kwargs): + def post_page_text_replace_with_http_info(self, name, page_number, text_replace_list_request, **kwargs): """ - Upload a specific file + 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_create_with_http_info(path, file, 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 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 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 = ['path', 'file', 'version_id', 'storage'] + 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') @@ -18196,57 +19112,62 @@ 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 post_page_text_replace" % 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 '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`") 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 '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 = {} form_params = [] local_var_files = {} - if 'file' in params: - local_var_files['File'] = params['file'] 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']) # 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/{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'), @@ -18254,55 +19175,59 @@ 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_page_underline_annotations(self, name, page_number, annotations, **kwargs): """ - Create empty document. + 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_create_document(name, 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 new document name. (required) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param list[UnderlineAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. - :param str folder: The new document folder. - :return: DocumentResponse + :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_create_document_with_http_info(name, **kwargs) + return self.post_page_underline_annotations_with_http_info(name, page_number, annotations, **kwargs) else: - (data) = self.put_create_document_with_http_info(name, **kwargs) + (data) = self.post_page_underline_annotations_with_http_info(name, page_number, annotations, **kwargs) return data - def put_create_document_with_http_info(self, name, **kwargs): + def post_page_underline_annotations_with_http_info(self, name, page_number, annotations, **kwargs): """ - Create empty document. + 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_create_document_with_http_info(name, 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 new document name. (required) + :param str name: The document name. (required) + :param int page_number: The page number. (required) + :param list[UnderlineAnnotation] annotations: The array of annotation. (required) :param str storage: The document storage. - :param str folder: The new document folder. - :return: DocumentResponse + :param str folder: The document folder. + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', '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') @@ -18313,13 +19238,19 @@ 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_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_create_document`") + 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 `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 = {} @@ -18327,6 +19258,8 @@ def put_create_document_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: @@ -18340,6 +19273,8 @@ def put_create_document_with_http_info(self, name, **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']) @@ -18351,14 +19286,14 @@ 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}/pages/{pageNumber}/annotations/underline', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentResponse', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -18366,55 +19301,59 @@ def put_create_document_with_http_info(self, name, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_create_folder(self, path, **kwargs): + def post_popup_annotation(self, name, annotation_id, annotation, **kwargs): """ - Create the folder + 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_create_folder(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 path: Target folder's path e.g. Folder1/Folder2/. The folders will be created recursively (required) - :param str storage: User's source storage name - :param str dest_storage: User's destination storage name + :param str name: The document name. (required) + :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_create_folder_with_http_info(path, **kwargs) + return self.post_popup_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_create_folder_with_http_info(path, **kwargs) + (data) = self.post_popup_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_create_folder_with_http_info(self, path, **kwargs): + def post_popup_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Create the folder + 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_create_folder_with_http_info(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 path: Target folder's path e.g. Folder1/Folder2/. The folders will be created recursively (required) - :param str storage: User's source storage name - :param str dest_storage: User's destination storage name + :param str name: The document name. (required) + :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 = ['path', 'storage', 'dest_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') @@ -18425,26 +19364,34 @@ def put_create_folder_with_http_info(self, path, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_create_folder" % key + " to method post_popup_annotation" % 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_folder`") + # 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_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 = {} 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 'storage' in params: query_params.append(('storage', params['storage'])) - if 'dest_storage' in params: - query_params.append(('destStorage', params['dest_storage'])) + if 'folder' in params: + query_params.append(('folder', params['folder'])) header_params = {} @@ -18452,6 +19399,8 @@ def put_create_folder_with_http_info(self, 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']) @@ -18463,7 +19412,7 @@ def put_create_folder_with_http_info(self, path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/storage/folder', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/{annotationId}/popup', 'POST', path_params, query_params, header_params, @@ -18478,57 +19427,57 @@ def put_create_folder_with_http_info(self, path, **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_sign_document(self, name, **kwargs): """ - Convert EPUB file (located on storage) to PDF format 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_epub_in_storage_to_pdf(name, src_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 str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required) + :param Signature signature: Signature object containing signature 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_sign_document_with_http_info(name, **kwargs) else: - (data) = self.put_epub_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + (data) = self.post_sign_document_with_http_info(name, **kwargs) return data - def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): + def post_sign_document_with_http_info(self, name, **kwargs): """ - Convert EPUB file (located on storage) to PDF format 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_epub_in_storage_to_pdf_with_http_info(name, src_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 str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required) + :param Signature signature: Signature object containing signature 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', 'signature', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -18539,16 +19488,13 @@ 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_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_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_sign_document`") collection_formats = {} @@ -18558,12 +19504,10 @@ 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 '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 = {} @@ -18571,6 +19515,8 @@ def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **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']) @@ -18582,7 +19528,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}/sign', 'POST', path_params, query_params, header_params, @@ -18597,20 +19543,22 @@ 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_sign_page(self, name, page_number, **kwargs): """ - Flatten form fields in document. + 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_fields_flatten(name, 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 Signature signature: Signature object containing signature data. :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -18619,25 +19567,27 @@ def put_fields_flatten(self, name, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_fields_flatten_with_http_info(name, **kwargs) + return self.post_sign_page_with_http_info(name, page_number, **kwargs) else: - (data) = self.put_fields_flatten_with_http_info(name, **kwargs) + (data) = self.post_sign_page_with_http_info(name, page_number, **kwargs) return data - def put_fields_flatten_with_http_info(self, name, **kwargs): + def post_sign_page_with_http_info(self, name, page_number, **kwargs): """ - Flatten form fields in document. + 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_fields_flatten_with_http_info(name, 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 Signature signature: Signature object containing signature data. :param str storage: The document storage. :param str folder: The document folder. :return: AsposeResponse @@ -18645,7 +19595,7 @@ def put_fields_flatten_with_http_info(self, name, **kwargs): returns the request thread. """ - all_params = ['name', 'storage', 'folder'] + all_params = ['name', 'page_number', 'signature', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -18656,13 +19606,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_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_fields_flatten`") + 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`") collection_formats = {} @@ -18670,6 +19623,8 @@ def put_fields_flatten_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: @@ -18683,6 +19638,8 @@ def put_fields_flatten_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']) @@ -18694,7 +19651,7 @@ 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}/pages/{pageNumber}/sign', 'POST', path_params, query_params, header_params, @@ -18709,59 +19666,61 @@ 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_split_document(self, name, **kwargs): """ - Replace document free text annotation + 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_free_text_annotation(name, annotation_id, annotation, 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 str annotation_id: The annotation ID. (required) - :param FreeTextAnnotation annotation: Annotation. (required) + :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. :param str folder: The document folder. - :return: FreeTextAnnotationResponse + :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_free_text_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.post_split_document_with_http_info(name, **kwargs) else: - (data) = self.put_free_text_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.post_split_document_with_http_info(name, **kwargs) return data - def put_free_text_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def post_split_document_with_http_info(self, name, **kwargs): """ - Replace document free text annotation + 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_free_text_annotation_with_http_info(name, annotation_id, annotation, 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 str annotation_id: The annotation ID. (required) - :param FreeTextAnnotation annotation: Annotation. (required) + :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. :param str folder: The document folder. - :return: FreeTextAnnotationResponse + :return: SplitResultResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] + all_params = ['name', 'format', '_from', 'to', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -18772,19 +19731,13 @@ 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_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_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_split_document`") collection_formats = {} @@ -18792,10 +19745,14 @@ 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'] 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: @@ -18807,8 +19764,6 @@ def put_free_text_annotation_with_http_info(self, name, annotation_id, annotatio 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']) @@ -18820,14 +19775,14 @@ def put_free_text_annotation_with_http_info(self, name, annotation_id, annotatio # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/freetext/{annotationId}', '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='FreeTextAnnotationResponse', + response_type='SplitResultResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -18835,59 +19790,55 @@ 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_highlight_annotation(self, name, annotation_id, annotation, **kwargs): + def put_add_new_page(self, name, **kwargs): """ - Replace document highlight annotation + 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_highlight_annotation(name, annotation_id, annotation, 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 str annotation_id: The annotation ID. (required) - :param HighlightAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: HighlightAnnotationResponse + :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_highlight_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.put_add_new_page_with_http_info(name, **kwargs) else: - (data) = self.put_highlight_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.put_add_new_page_with_http_info(name, **kwargs) return data - def put_highlight_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def put_add_new_page_with_http_info(self, name, **kwargs): """ - Replace document highlight annotation + 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_highlight_annotation_with_http_info(name, annotation_id, annotation, 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 str annotation_id: The annotation ID. (required) - :param HighlightAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: HighlightAnnotationResponse + :return: DocumentPagesResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'annotation_id', 'annotation', 'storage', 'folder'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -18898,19 +19849,13 @@ def put_highlight_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_highlight_annotation" % 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_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`") + raise ValueError("Missing the required parameter `name` when calling `put_add_new_page`") collection_formats = {} @@ -18918,8 +19863,6 @@ def put_highlight_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: @@ -18933,8 +19876,6 @@ def put_highlight_annotation_with_http_info(self, name, annotation_id, annotatio 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']) @@ -18946,14 +19887,14 @@ def put_highlight_annotation_with_http_info(self, name, annotation_id, annotatio # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/highlight/{annotationId}', '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='HighlightAnnotationResponse', + response_type='DocumentPagesResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -18961,30 +19902,23 @@ def put_highlight_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, **kwargs): + def put_add_text(self, name, page_number, **kwargs): """ - Convert HTML 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_html_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.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 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, @@ -18992,42 +19926,35 @@ def put_html_in_storage_to_pdf(self, name, src_path, **kwargs): """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_html_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_html_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_html_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 HTML 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_html_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.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 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', 'html_file_name', 'height', 'width', 'is_landscape', 'margin_left', 'margin_bottom', 'margin_right', 'margin_top', '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') @@ -19038,16 +19965,16 @@ def put_html_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_html_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_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`") + 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 = {} @@ -19055,28 +19982,12 @@ def put_html_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 '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 'folder' in params: + query_params.append(('folder', params['folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -19086,6 +19997,8 @@ def put_html_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']) @@ -19097,7 +20010,7 @@ def put_html_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/html', 'PUT', + return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/text', 'PUT', path_params, query_params, header_params, @@ -19112,63 +20025,59 @@ def put_html_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_image_extract_as_gif(self, name, image_id, **kwargs): + def put_caret_annotation(self, name, annotation_id, annotation, **kwargs): """ - Extract document image in GIF format to folder + 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_image_extract_as_gif(name, image_id, 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 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 annotation_id: The annotation ID. (required) + :param CaretAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. - :return: AsposeResponse + :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_image_extract_as_gif_with_http_info(name, image_id, **kwargs) + return self.put_caret_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_image_extract_as_gif_with_http_info(name, image_id, **kwargs) + (data) = self.put_caret_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): + def put_caret_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Extract document image in GIF format to folder + 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_image_extract_as_gif_with_http_info(name, image_id, 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 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 annotation_id: The annotation ID. (required) + :param CaretAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. - :return: AsposeResponse + :return: CaretAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_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') @@ -19179,16 +20088,19 @@ 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 put_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 `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 `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 = {} @@ -19196,20 +20108,14 @@ 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'] + 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 '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 = {} @@ -19217,6 +20123,8 @@ def put_image_extract_as_gif_with_http_info(self, name, image_id, **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']) @@ -19228,14 +20136,14 @@ 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}/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'), @@ -19243,63 +20151,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 put_circle_annotation(self, name, annotation_id, annotation, **kwargs): """ - Extract document image in JPEG format to folder + 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_image_extract_as_jpeg(name, image_id, 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 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 annotation_id: The annotation ID. (required) + :param CircleAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. - :return: AsposeResponse + :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_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs) + return self.put_circle_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs) + (data) = self.put_circle_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): + def put_circle_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Extract document image in JPEG format to folder + 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_image_extract_as_jpeg_with_http_info(name, image_id, 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 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 annotation_id: The annotation ID. (required) + :param CircleAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. - :return: AsposeResponse + :return: CircleAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_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') @@ -19310,16 +20214,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 put_circle_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_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 `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 = {} @@ -19327,20 +20234,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 '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 '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 = {} @@ -19348,6 +20249,8 @@ def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **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']) @@ -19359,14 +20262,14 @@ 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}/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'), @@ -19374,63 +20277,57 @@ 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 put_create(self, path, file, **kwargs): """ - Extract document image in PNG format to folder + 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_image_extract_as_png(name, image_id, callback=callback_function) + >>> thread = api.put_create(path, file, 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. + :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_image_extract_as_png_with_http_info(name, image_id, **kwargs) + return self.put_create_with_http_info(path, file, **kwargs) else: - (data) = self.put_image_extract_as_png_with_http_info(name, image_id, **kwargs) + (data) = self.put_create_with_http_info(path, file, **kwargs) return data - def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): + def put_create_with_http_info(self, path, file, **kwargs): """ - Extract document image in PNG format to folder + 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_image_extract_as_png_with_http_info(name, image_id, 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 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. + :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 = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params = ['path', 'file', 'version_id', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -19441,42 +20338,36 @@ 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 put_create" % 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`") + # 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 = {} 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'])) - 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` @@ -19485,12 +20376,12 @@ def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): # 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}/images/{imageId}/extract/png', 'PUT', + return self.api_client.call_api('/storage/file', 'PUT', path_params, query_params, header_params, @@ -19505,63 +20396,55 @@ 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 put_create_document(self, name, **kwargs): """ - Extract document image in TIFF format to folder + 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_image_extract_as_tiff(name, image_id, callback=callback_function) + >>> thread = api.put_create_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 str name: The new document name. (required) :param str storage: The document storage. - :param str folder: The document folder. - :param str dest_folder: The document folder. - :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_image_extract_as_tiff_with_http_info(name, image_id, **kwargs) + return self.put_create_document_with_http_info(name, **kwargs) else: - (data) = self.put_image_extract_as_tiff_with_http_info(name, image_id, **kwargs) + (data) = self.put_create_document_with_http_info(name, **kwargs) return data - def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): + def put_create_document_with_http_info(self, name, **kwargs): """ - Extract document image in TIFF format to folder + 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_image_extract_as_tiff_with_http_info(name, image_id, 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 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 name: The new document name. (required) :param str storage: The document storage. - :param str folder: The document folder. - :param str dest_folder: The document folder. - :return: AsposeResponse + :param str folder: The new document folder. + :return: DocumentResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder'] + all_params = ['name', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -19572,16 +20455,13 @@ 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 put_create_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_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 `put_create_document`") collection_formats = {} @@ -19589,20 +20469,12 @@ 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'] 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 = {} @@ -19621,14 +20493,14 @@ 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}', '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'), @@ -19636,57 +20508,55 @@ 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 put_create_folder(self, path, **kwargs): """ - Convert image file (located on storage) to PDF format and upload resulting file to storage. + Create the 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_in_storage_to_pdf(name, image_templates, callback=callback_function) + >>> thread = api.put_create_folder(path, 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. + :param str path: Target folder's path e.g. Folder1/Folder2/. The folders will be created recursively (required) + :param str storage: User's source storage name + :param str dest_storage: User's destination 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_image_in_storage_to_pdf_with_http_info(name, image_templates, **kwargs) + return self.put_create_folder_with_http_info(path, **kwargs) else: - (data) = self.put_image_in_storage_to_pdf_with_http_info(name, image_templates, **kwargs) + (data) = self.put_create_folder_with_http_info(path, **kwargs) return data - def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kwargs): + def put_create_folder_with_http_info(self, path, **kwargs): """ - Convert image file (located on storage) to PDF format and upload resulting file to storage. + Create the 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_in_storage_to_pdf_with_http_info(name, image_templates, callback=callback_function) + >>> thread = api.put_create_folder_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 ImageTemplatesRequest image_templates: Image templates (required) - :param str dst_folder: The destination document folder. - :param str storage: The document storage. + :param str path: Target folder's path e.g. Folder1/Folder2/. The folders will be created recursively (required) + :param str storage: User's source storage name + :param str dest_storage: User's destination storage name :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'image_templates', 'dst_folder', 'storage'] + all_params = ['path', 'storage', 'dest_storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -19697,29 +20567,26 @@ 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 put_create_folder" % 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`") + # 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_folder`") 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 'path' in params: + query_params.append(('path', params['path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) + if 'dest_storage' in params: + query_params.append(('destStorage', params['dest_storage'])) header_params = {} @@ -19727,8 +20594,6 @@ 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'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -19740,7 +20605,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('/storage/folder', 'PUT', path_params, query_params, header_params, @@ -19755,63 +20620,57 @@ 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 put_epub_in_storage_to_pdf(self, name, src_path, **kwargs): """ - Extract document images in GIF format to folder. + 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_images_extract_as_gif(name, page_number, 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 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 src_path: Full source filename (ex. /folder1/folder2/template.epub) (required) :param str storage: The document storage. - :param str folder: The document folder. - :param str dest_folder: The document folder. + :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_images_extract_as_gif_with_http_info(name, page_number, **kwargs) + return self.put_epub_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) else: - (data) = self.put_images_extract_as_gif_with_http_info(name, page_number, **kwargs) + (data) = self.put_epub_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) return data - def put_images_extract_as_gif_with_http_info(self, name, page_number, **kwargs): + def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): """ - Extract document images in GIF format to folder. + 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_images_extract_as_gif_with_http_info(name, page_number, 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 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 src_path: Full source filename (ex. /folder1/folder2/template.epub) (required) :param str storage: The document storage. - :param str folder: The document folder. - :param str dest_folder: The document folder. + :param str dst_folder: The destination 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', 'src_path', 'storage', 'dst_folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -19822,16 +20681,16 @@ 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 put_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 `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`") + 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 = {} @@ -19839,20 +20698,14 @@ def put_images_extract_as_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'] 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'])) - if 'dest_folder' in params: - query_params.append(('destFolder', params['dest_folder'])) + if 'dst_folder' in params: + query_params.append(('dstFolder', params['dst_folder'])) header_params = {} @@ -19871,7 +20724,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}/create/epub', 'PUT', path_params, query_params, header_params, @@ -19886,63 +20739,55 @@ 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 put_fields_flatten(self, name, **kwargs): """ - Extract document images in JPEG format to folder. + 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_images_extract_as_jpeg(name, page_number, callback=callback_function) + >>> thread = api.put_fields_flatten(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 int width: The converted image width. - :param int height: The converted image height. - :param str storage: + :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.put_fields_flatten_with_http_info(name, **kwargs) else: - (data) = self.put_images_extract_as_jpeg_with_http_info(name, page_number, **kwargs) + (data) = self.put_fields_flatten_with_http_info(name, **kwargs) return data - def put_images_extract_as_jpeg_with_http_info(self, name, page_number, **kwargs): + def put_fields_flatten_with_http_info(self, name, **kwargs): """ - Extract document images in JPEG format to folder. + 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_images_extract_as_jpeg_with_http_info(name, page_number, 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 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 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', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -19953,16 +20798,13 @@ 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 put_fields_flatten" % 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`") + raise ValueError("Missing the required parameter `name` when calling `put_fields_flatten`") collection_formats = {} @@ -19970,20 +20812,12 @@ def put_images_extract_as_jpeg_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 '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 = {} @@ -20002,7 +20836,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}/fields/flatten', 'PUT', path_params, query_params, header_params, @@ -20017,63 +20851,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 put_file_attachment_annotation(self, name, annotation_id, annotation, **kwargs): """ - Extract document images in PNG format to folder. + Replace document FileAttachment 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_images_extract_as_png(name, page_number, callback=callback_function) + >>> thread = api.put_file_attachment_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 int width: The converted image width. - :param int height: The converted image height. + :param str annotation_id: The annotation ID. (required) + :param FileAttachmentAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. - :return: AsposeResponse + :return: FileAttachmentAnnotationResponse 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.put_file_attachment_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_images_extract_as_png_with_http_info(name, page_number, **kwargs) + (data) = self.put_file_attachment_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_images_extract_as_png_with_http_info(self, name, page_number, **kwargs): + def put_file_attachment_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Extract document images in PNG format to folder. + Replace document FileAttachment 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_images_extract_as_png_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.put_file_attachment_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 int width: The converted image width. - :param int height: The converted image height. + :param str annotation_id: The annotation ID. (required) + :param FileAttachmentAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :param str dest_folder: The document folder. - :return: AsposeResponse + :return: FileAttachmentAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'page_number', 'width', 'height', 'storage', 'folder', 'dest_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') @@ -20084,16 +20914,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 put_file_attachment_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_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`") + raise ValueError("Missing the required parameter `name` when calling `put_file_attachment_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_file_attachment_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_file_attachment_annotation`") collection_formats = {} @@ -20101,20 +20934,14 @@ def put_images_extract_as_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 '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 = {} @@ -20122,6 +20949,8 @@ def put_images_extract_as_png_with_http_info(self, name, page_number, **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']) @@ -20133,14 +20962,14 @@ 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}/annotations/fileattachment/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='FileAttachmentAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -20148,63 +20977,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 put_file_attachment_annotation_data_extract(self, name, annotation_id, **kwargs): """ - Extract document images in TIFF format to folder. + Extract document FileAttachment annotation content 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_images_extract_as_tiff(name, page_number, callback=callback_function) + >>> thread = api.put_file_attachment_annotation_data_extract(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 annotation_id: The annotation ID. (required) + :param str out_folder: The output folder. :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.put_file_attachment_annotation_data_extract_with_http_info(name, annotation_id, **kwargs) else: - (data) = self.put_images_extract_as_tiff_with_http_info(name, page_number, **kwargs) + (data) = self.put_file_attachment_annotation_data_extract_with_http_info(name, annotation_id, **kwargs) return data - def put_images_extract_as_tiff_with_http_info(self, name, page_number, **kwargs): + def put_file_attachment_annotation_data_extract_with_http_info(self, name, annotation_id, **kwargs): """ - Extract document images in TIFF format to folder. + Extract document FileAttachment annotation content 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_images_extract_as_tiff_with_http_info(name, page_number, callback=callback_function) + >>> thread = api.put_file_attachment_annotation_data_extract_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 annotation_id: The annotation ID. (required) + :param str out_folder: The output folder. :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', 'annotation_id', 'out_folder', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -20215,16 +21040,16 @@ 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 put_file_attachment_annotation_data_extract" % 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`") + raise ValueError("Missing the required parameter `name` when calling `put_file_attachment_annotation_data_extract`") + # 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_file_attachment_annotation_data_extract`") collection_formats = {} @@ -20232,20 +21057,16 @@ def put_images_extract_as_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 '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 'out_folder' in params: + query_params.append(('outFolder', params['out_folder'])) 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 = {} @@ -20264,7 +21085,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}/annotations/fileattachment/{annotationId}/data/extract', 'PUT', path_params, query_params, header_params, @@ -20279,54 +21100,54 @@ 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_ink_annotation(self, name, annotation_id, annotation, **kwargs): + def put_free_text_annotation(self, name, annotation_id, annotation, **kwargs): """ - Replace document ink annotation + 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_ink_annotation(name, annotation_id, annotation, 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 name: The document name. (required) :param str annotation_id: The annotation ID. (required) - :param InkAnnotation annotation: Annotation. (required) + :param FreeTextAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: InkAnnotationResponse + :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_ink_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.put_free_text_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_ink_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.put_free_text_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_ink_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def put_free_text_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Replace document ink annotation + 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_ink_annotation_with_http_info(name, annotation_id, annotation, 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 name: The document name. (required) :param str annotation_id: The annotation ID. (required) - :param InkAnnotation annotation: Annotation. (required) + :param FreeTextAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: InkAnnotationResponse + :return: FreeTextAnnotationResponse If the method is called asynchronously, returns the request thread. """ @@ -20342,19 +21163,19 @@ def put_ink_annotation_with_http_info(self, name, annotation_id, annotation, **k if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method put_ink_annotation" % key + " to method put_free_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 `put_ink_annotation`") + 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_ink_annotation`") + 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_ink_annotation`") + raise ValueError("Missing the required parameter `annotation` when calling `put_free_text_annotation`") collection_formats = {} @@ -20390,14 +21211,14 @@ def put_ink_annotation_with_http_info(self, name, annotation_id, annotation, **k # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/ink/{annotationId}', '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='InkAnnotationResponse', + response_type='FreeTextAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -20405,57 +21226,59 @@ def put_ink_annotation_with_http_info(self, name, annotation_id, annotation, **k _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 put_highlight_annotation(self, name, annotation_id, annotation, **kwargs): """ - Convert LaTeX file (located on storage) to PDF format and upload 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_la_te_x_in_storage_to_pdf(name, src_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 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 annotation_id: The annotation ID. (required) + :param HighlightAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :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_la_te_x_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + return self.put_highlight_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_la_te_x_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + (data) = self.put_highlight_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_la_te_x_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): + def put_highlight_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Convert LaTeX file (located on storage) to PDF format and upload 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_la_te_x_in_storage_to_pdf_with_http_info(name, src_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 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 annotation_id: The annotation ID. (required) + :param HighlightAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :return: AsposeResponse + :param str folder: The document folder. + :return: HighlightAnnotationResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'src_path', 'dst_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') @@ -20466,16 +21289,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 put_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 `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 `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 = {} @@ -20483,14 +21309,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 '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 = {} @@ -20498,6 +21324,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 'annotation' in params: + body_params = params['annotation'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -20509,14 +21337,14 @@ 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}/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'), @@ -20524,59 +21352,73 @@ 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 put_html_in_storage_to_pdf(self, name, src_path, **kwargs): """ - Replace document line annotation + 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_line_annotation(name, annotation_id, annotation, 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 name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param LineAnnotation annotation: Annotation. (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 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.put_html_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) else: - (data) = self.put_line_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.put_html_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) return data - def put_line_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def put_html_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): """ - Replace document line annotation + 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_line_annotation_with_http_info(name, annotation_id, annotation, 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 name: The document name. (required) - :param str annotation_id: The annotation ID. (required) - :param LineAnnotation annotation: Annotation. (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 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', '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') @@ -20587,19 +21429,16 @@ 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 put_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 `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 `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 = {} @@ -20607,14 +21446,30 @@ 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'] 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 'storage' in params: query_params.append(('storage', params['storage'])) - if 'folder' in params: - query_params.append(('folder', params['folder'])) header_params = {} @@ -20622,8 +21477,6 @@ 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'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -20635,14 +21488,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}/create/html', 'PUT', 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'), @@ -20650,59 +21503,63 @@ 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 put_image_extract_as_gif(self, name, image_id, **kwargs): """ - Replace document page link annotations + 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_link_annotation(name, link_id, link, 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 name: The document name. (required) - :param str link_id: The link ID. (required) - :param LinkAnnotation link: Link anotation. (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: LinkAnnotationResponse + :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_link_annotation_with_http_info(name, link_id, link, **kwargs) + return self.put_image_extract_as_gif_with_http_info(name, image_id, **kwargs) else: - (data) = self.put_link_annotation_with_http_info(name, link_id, link, **kwargs) + (data) = self.put_image_extract_as_gif_with_http_info(name, image_id, **kwargs) return data - def put_link_annotation_with_http_info(self, name, link_id, link, **kwargs): + def put_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs): """ - Replace document page link annotations + 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_link_annotation_with_http_info(name, link_id, link, 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 name: The document name. (required) - :param str link_id: The link ID. (required) - :param LinkAnnotation link: Link anotation. (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: LinkAnnotationResponse + :param str dest_folder: The document folder. + :return: AsposeResponse If the method is called asynchronously, returns the request thread. """ - all_params = ['name', 'link_id', 'link', 'storage', 'folder'] + 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') @@ -20713,19 +21570,16 @@ 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 put_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 `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 `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 = {} @@ -20733,14 +21587,20 @@ 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 '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 = {} @@ -20748,8 +21608,6 @@ 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'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -20761,14 +21619,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}/images/{imageId}/extract/gif', 'PUT', 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'), @@ -20776,57 +21634,63 @@ 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 put_image_extract_as_jpeg(self, name, image_id, **kwargs): """ - Merge a list of documents. + 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_merge_documents(name, 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 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 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_merge_documents_with_http_info(name, **kwargs) + return self.put_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs) else: - (data) = self.put_merge_documents_with_http_info(name, **kwargs) + (data) = self.put_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs) return data - def put_merge_documents_with_http_info(self, name, **kwargs): + def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs): """ - Merge a list of documents. + 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_merge_documents_with_http_info(name, 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 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 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', 'merge_documents', 'storage', 'folder'] + 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') @@ -20837,13 +21701,16 @@ 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 put_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 `put_merge_documents`") + 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 = {} @@ -20851,12 +21718,20 @@ def put_merge_documents_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 '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 = {} @@ -20864,8 +21739,6 @@ 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'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -20877,14 +21750,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}/images/{imageId}/extract/jpeg', 'PUT', 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'), @@ -20892,57 +21765,63 @@ 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 put_image_extract_as_png(self, name, image_id, **kwargs): """ - Convert MHT file (located on storage) to PDF format and upload 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_mht_in_storage_to_pdf(name, src_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 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 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_mht_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + return self.put_image_extract_as_png_with_http_info(name, image_id, **kwargs) else: - (data) = self.put_mht_in_storage_to_pdf_with_http_info(name, src_path, **kwargs) + (data) = self.put_image_extract_as_png_with_http_info(name, image_id, **kwargs) return data - def put_mht_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs): + def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs): """ - Convert MHT file (located on storage) to PDF format and upload 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_mht_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) + >>> 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 src_path: Full source filename (ex. /folder1/folder2/template.mht) (required) - :param str dst_folder: The destination document folder. + :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', 'src_path', 'dst_folder', 'storage'] + 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') @@ -20953,16 +21832,16 @@ 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 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_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 `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 = {} @@ -20970,14 +21849,20 @@ 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 '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 'dst_folder' in params: - query_params.append(('dstFolder', params['dst_folder'])) + 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 = {} @@ -20996,7 +21881,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}/images/{imageId}/extract/png', 'PUT', path_params, query_params, header_params, @@ -21011,59 +21896,63 @@ 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 put_image_extract_as_tiff(self, name, image_id, **kwargs): """ - Add page stamp. + 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_page_add_stamp(name, page_number, stamp, callback=callback_function) + >>> 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 int page_number: The page number. (required) - :param Stamp stamp: with data. (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_page_add_stamp_with_http_info(name, page_number, stamp, **kwargs) + return self.put_image_extract_as_tiff_with_http_info(name, image_id, **kwargs) else: - (data) = self.put_page_add_stamp_with_http_info(name, page_number, stamp, **kwargs) + (data) = self.put_image_extract_as_tiff_with_http_info(name, image_id, **kwargs) return data - def put_page_add_stamp_with_http_info(self, name, page_number, stamp, **kwargs): + def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs): """ - Add page stamp. + 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_page_add_stamp_with_http_info(name, page_number, stamp, callback=callback_function) + >>> 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 int page_number: The page number. (required) - :param Stamp stamp: with data. (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', 'page_number', 'stamp', 'storage', 'folder'] + 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') @@ -21074,19 +21963,16 @@ 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 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_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`") + 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 = {} @@ -21094,14 +21980,20 @@ def put_page_add_stamp_with_http_info(self, name, page_number, stamp, **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: query_params.append(('folder', params['folder'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -21109,8 +22001,6 @@ 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'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -21122,7 +22012,7 @@ 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}/images/{imageId}/extract/tiff', 'PUT', path_params, query_params, header_params, @@ -21137,25 +22027,22 @@ 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 put_image_in_storage_to_pdf(self, name, image_templates, **kwargs): """ - Convert document page to bmp image and upload resulting file to storage. + 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_page_convert_to_bmp(name, page_number, out_path, callback=callback_function) + >>> 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 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 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, @@ -21163,37 +22050,34 @@ def put_page_convert_to_bmp(self, name, page_number, out_path, **kwargs): """ 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.put_image_in_storage_to_pdf_with_http_info(name, image_templates, **kwargs) else: - (data) = self.put_page_convert_to_bmp_with_http_info(name, page_number, out_path, **kwargs) + (data) = self.put_image_in_storage_to_pdf_with_http_info(name, image_templates, **kwargs) return data - def put_page_convert_to_bmp_with_http_info(self, name, page_number, out_path, **kwargs): + def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kwargs): """ - Convert document page to bmp image and upload resulting file to storage. + 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_page_convert_to_bmp_with_http_info(name, page_number, out_path, callback=callback_function) + >>> 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 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 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', 'page_number', 'out_path', 'width', 'height', 'folder', 'storage'] + all_params = ['name', 'image_templates', 'dst_folder', 'storage'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -21204,19 +22088,16 @@ 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 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_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`") + 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 = {} @@ -21224,18 +22105,10 @@ def put_page_convert_to_bmp_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 'dst_folder' in params: + query_params.append(('dstFolder', params['dst_folder'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -21245,6 +22118,8 @@ def put_page_convert_to_bmp_with_http_info(self, name, page_number, out_path, ** 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']) @@ -21256,7 +22131,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}/create/images', 'PUT', path_params, query_params, header_params, @@ -21271,63 +22146,63 @@ 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 put_images_extract_as_gif(self, name, page_number, **kwargs): """ - Convert document page to emf image and upload resulting file to storage. + 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_page_convert_to_emf(name, page_number, out_path, callback=callback_function) + >>> 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 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. + :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_page_convert_to_emf_with_http_info(name, page_number, out_path, **kwargs) + return self.put_images_extract_as_gif_with_http_info(name, page_number, **kwargs) else: - (data) = self.put_page_convert_to_emf_with_http_info(name, page_number, out_path, **kwargs) + (data) = self.put_images_extract_as_gif_with_http_info(name, page_number, **kwargs) return data - def put_page_convert_to_emf_with_http_info(self, name, page_number, out_path, **kwargs): + def put_images_extract_as_gif_with_http_info(self, name, page_number, **kwargs): """ - Convert document page to emf image and upload resulting file to storage. + 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_page_convert_to_emf_with_http_info(name, page_number, out_path, callback=callback_function) + >>> 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 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. + :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', 'out_path', 'width', 'height', 'folder', 'storage'] + 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') @@ -21338,19 +22213,16 @@ 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 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_page_convert_to_emf`") + 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_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 `page_number` when calling `put_images_extract_as_gif`") collection_formats = {} @@ -21362,16 +22234,16 @@ def put_page_convert_to_emf_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'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -21390,7 +22262,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}/pages/{pageNumber}/images/extract/gif', 'PUT', path_params, query_params, header_params, @@ -21405,63 +22277,63 @@ 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 put_images_extract_as_jpeg(self, name, page_number, **kwargs): """ - Convert document page to gif image and upload resulting file to storage. + 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_page_convert_to_gif(name, page_number, out_path, callback=callback_function) + >>> 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 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 storage: :param str folder: The document folder. - :param str storage: The document storage. + :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_page_convert_to_gif_with_http_info(name, page_number, out_path, **kwargs) + return self.put_images_extract_as_jpeg_with_http_info(name, page_number, **kwargs) else: - (data) = self.put_page_convert_to_gif_with_http_info(name, page_number, out_path, **kwargs) + (data) = self.put_images_extract_as_jpeg_with_http_info(name, page_number, **kwargs) return data - def put_page_convert_to_gif_with_http_info(self, name, page_number, out_path, **kwargs): + def put_images_extract_as_jpeg_with_http_info(self, name, page_number, **kwargs): """ - Convert document page to gif image and upload resulting file to storage. + 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_page_convert_to_gif_with_http_info(name, page_number, out_path, callback=callback_function) + >>> 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 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 storage: :param str folder: The document folder. - :param str storage: The document storage. + :param str dest_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', 'width', 'height', 'storage', 'folder', 'dest_folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -21472,19 +22344,16 @@ 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 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_page_convert_to_gif`") + 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_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 `page_number` when calling `put_images_extract_as_jpeg`") collection_formats = {} @@ -21496,16 +22365,16 @@ def put_page_convert_to_gif_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'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -21524,7 +22393,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}/pages/{pageNumber}/images/extract/jpeg', 'PUT', path_params, query_params, header_params, @@ -21539,63 +22408,63 @@ 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 put_images_extract_as_png(self, name, page_number, **kwargs): """ - Convert document page to Jpeg image and upload resulting file to storage. + 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_page_convert_to_jpeg(name, page_number, out_path, callback=callback_function) + >>> 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 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. + :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_page_convert_to_jpeg_with_http_info(name, page_number, out_path, **kwargs) + return self.put_images_extract_as_png_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.put_images_extract_as_png_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 put_images_extract_as_png_with_http_info(self, name, page_number, **kwargs): """ - Convert document page to Jpeg image and upload resulting file to storage. + 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_page_convert_to_jpeg_with_http_info(name, page_number, out_path, callback=callback_function) + >>> 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 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. + :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', 'out_path', 'width', 'height', 'folder', 'storage'] + 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') @@ -21606,19 +22475,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 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_page_convert_to_jpeg`") + 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_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 `put_images_extract_as_png`") collection_formats = {} @@ -21630,16 +22496,16 @@ 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'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -21658,7 +22524,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}/images/extract/png', 'PUT', path_params, query_params, header_params, @@ -21673,63 +22539,63 @@ 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 put_images_extract_as_tiff(self, name, page_number, **kwargs): """ - Convert document page to png image and upload resulting file to storage. + 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_page_convert_to_png(name, page_number, out_path, callback=callback_function) + >>> 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 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. + :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_page_convert_to_png_with_http_info(name, page_number, out_path, **kwargs) + return self.put_images_extract_as_tiff_with_http_info(name, page_number, **kwargs) else: - (data) = self.put_page_convert_to_png_with_http_info(name, page_number, out_path, **kwargs) + (data) = self.put_images_extract_as_tiff_with_http_info(name, page_number, **kwargs) return data - def put_page_convert_to_png_with_http_info(self, name, page_number, out_path, **kwargs): + def put_images_extract_as_tiff_with_http_info(self, name, page_number, **kwargs): """ - Convert document page to png image and upload resulting file to storage. + 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_page_convert_to_png_with_http_info(name, page_number, out_path, callback=callback_function) + >>> 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 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. + :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', 'out_path', 'width', 'height', 'folder', 'storage'] + 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') @@ -21740,19 +22606,16 @@ 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 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_page_convert_to_png`") + 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_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 `page_number` when calling `put_images_extract_as_tiff`") collection_formats = {} @@ -21764,16 +22627,16 @@ def put_page_convert_to_png_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'])) + if 'dest_folder' in params: + query_params.append(('destFolder', params['dest_folder'])) header_params = {} @@ -21792,7 +22655,7 @@ 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}/pages/{pageNumber}/images/extract/tiff', 'PUT', path_params, query_params, header_params, @@ -21807,63 +22670,59 @@ 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_ink_annotation(self, name, annotation_id, annotation, **kwargs): """ - Convert document page to Tiff image and upload resulting file to storage. + 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_page_convert_to_tiff(name, page_number, out_path, callback=callback_function) + >>> 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 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 annotation ID. (required) + :param InkAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :return: AsposeResponse + :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_page_convert_to_tiff_with_http_info(name, page_number, out_path, **kwargs) + return self.put_ink_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_page_convert_to_tiff_with_http_info(name, page_number, out_path, **kwargs) + (data) = self.put_ink_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_page_convert_to_tiff_with_http_info(self, name, page_number, out_path, **kwargs): + def put_ink_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Convert document page to Tiff image and upload resulting file to storage. + 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_page_convert_to_tiff_with_http_info(name, page_number, out_path, callback=callback_function) + >>> 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 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 annotation ID. (required) + :param InkAnnotation annotation: Annotation. (required) :param str storage: The document storage. - :return: AsposeResponse + :param str folder: The document folder. + :return: InkAnnotationResponse 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') @@ -21874,19 +22733,19 @@ 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_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_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_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 = {} @@ -21894,20 +22753,14 @@ 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'] + 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 = {} @@ -21915,6 +22768,8 @@ def put_page_convert_to_tiff_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']) @@ -21926,14 +22781,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}/annotations/ink/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='InkAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -21941,21 +22796,21 @@ 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_la_te_x_in_storage_to_pdf(self, name, src_path, **kwargs): """ - Convert PCL file (located on storage) to PDF format and upload resulting file to storage. + 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_pcl_in_storage_to_pdf(name, src_path, callback=callback_function) + >>> 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.pcl) (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 @@ -21964,26 +22819,26 @@ 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_la_te_x_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) + (data) = self.put_la_te_x_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): + def put_la_te_x_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. + 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_pcl_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function) + >>> 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.pcl) (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 @@ -22002,16 +22857,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_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_pcl_in_storage_to_pdf`") + 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_pcl_in_storage_to_pdf`") + raise ValueError("Missing the required parameter `src_path` when calling `put_la_te_x_in_storage_to_pdf`") collection_formats = {} @@ -22045,7 +22900,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}/create/latex', 'PUT', path_params, query_params, header_params, @@ -22060,71 +22915,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_line_annotation(self, name, annotation_id, annotation, **kwargs): """ - Converts PDF document (in request content) to DOC format and uploads resulting file to storage. + 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_pdf_in_request_to_doc(out_path, callback=callback_function) + >>> thread = api.put_line_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 LineAnnotation 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: LineAnnotationResponse 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_line_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_line_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_line_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 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_pdf_in_request_to_doc_with_http_info(out_path, callback=callback_function) + >>> 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 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 LineAnnotation 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: LineAnnotationResponse 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') @@ -22135,68 +22978,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_line_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_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 '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/line/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='LineAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -22204,49 +23041,2184 @@ 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_link_annotation(self, name, link_id, link, **kwargs): """ - Converts PDF document (in request content) to EPUB format and uploads resulting file to storage. + 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_pdf_in_request_to_epub(out_path, callback=callback_function) + >>> thread = api.put_link_annotation(name, link_id, link, 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: Property tunes conversion for this or that desirable method of recognition of content. + :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 file file: A file to be converted. - :return: AsposeResponse + :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_pdf_in_request_to_epub_with_http_info(out_path, **kwargs) + return self.put_link_annotation_with_http_info(name, link_id, link, **kwargs) else: - (data) = self.put_pdf_in_request_to_epub_with_http_info(out_path, **kwargs) + (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_movie_annotation(self, name, annotation_id, annotation, **kwargs): + """ + Replace document movie 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_movie_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 MovieAnnotation annotation: Annotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: MovieAnnotationResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.put_movie_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + else: + (data) = self.put_movie_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return data + + def put_movie_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + """ + Replace document movie 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_movie_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 MovieAnnotation annotation: Annotation. (required) + :param str storage: The document storage. + :param str folder: The document folder. + :return: MovieAnnotationResponse + 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_movie_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_movie_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_movie_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_movie_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/movie/{annotationId}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='MovieAnnotationResponse', + 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: Property 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: Property 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_epub_with_http_info(self, out_path, **kwargs): + def put_pdf_in_request_to_mobi_xml_with_http_info(self, out_path, **kwargs): """ - Converts PDF document (in request content) to EPUB format and uploads resulting file to storage. + 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_epub_with_http_info(out_path, callback=callback_function) + >>> 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.epub) (required) - :param str content_recognition_mode: Property 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 storage: The document storage. :param file file: A file to be converted. :return: AsposeResponse @@ -22254,7 +25226,7 @@ def put_pdf_in_request_to_epub_with_http_info(self, out_path, **kwargs): returns the request thread. """ - all_params = ['out_path', 'content_recognition_mode', 'storage', 'file'] + all_params = ['out_path', 'storage', 'file'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -22265,13 +25237,13 @@ 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_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_epub`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_mobi_xml`") collection_formats = {} @@ -22281,8 +25253,6 @@ def put_pdf_in_request_to_epub_with_http_info(self, 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 'storage' in params: query_params.append(('storage', params['storage'])) @@ -22305,7 +25275,7 @@ def put_pdf_in_request_to_epub_with_http_info(self, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/epub', 'PUT', + return self.api_client.call_api('/pdf/convert/mobixml', 'PUT', path_params, query_params, header_params, @@ -22320,48 +25290,21 @@ 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_pdf_in_request_to_pdf_a(self, out_path, type, **kwargs): """ - Converts PDF document (in request content) to Html format and uploads resulting file to storage. + 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_html(out_path, callback=callback_function) + >>> 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.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 storage: The document storage. :param file file: A file to be converted. :return: AsposeResponse @@ -22370,53 +25313,26 @@ def put_pdf_in_request_to_html(self, out_path, **kwargs): """ 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_pdf_in_request_to_pdf_a_with_http_info(out_path, type, **kwargs) else: - (data) = self.put_pdf_in_request_to_html_with_http_info(out_path, **kwargs) + (data) = self.put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, **kwargs) return data - def put_pdf_in_request_to_html_with_http_info(self, out_path, **kwargs): + def put_pdf_in_request_to_pdf_a_with_http_info(self, out_path, type, **kwargs): """ - Converts PDF document (in request content) to Html format and uploads resulting file to storage. + 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_html_with_http_info(out_path, callback=callback_function) + >>> 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.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 storage: The document storage. :param file file: A file to be converted. :return: AsposeResponse @@ -22424,7 +25340,7 @@ def put_pdf_in_request_to_html_with_http_info(self, out_path, **kwargs): 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 = ['out_path', 'type', 'storage', 'file'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -22435,13 +25351,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_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_html`") + 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 = {} @@ -22451,63 +25370,8 @@ def put_pdf_in_request_to_html_with_http_info(self, out_path, **kwargs): 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 'type' in params: + query_params.append(('type', params['type'])) if 'storage' in params: query_params.append(('storage', params['storage'])) @@ -22530,7 +25394,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('/pdf/convert/pdfa', 'PUT', path_params, query_params, header_params, @@ -22545,21 +25409,22 @@ 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_pdf_in_request_to_pptx(self, out_path, **kwargs): """ - Converts PDF document (in request content) to LaTeX format and uploads resulting file to storage. + 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_la_te_x(out_path, callback=callback_function) + >>> 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.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 storage: The document storage. :param file file: A file to be converted. :return: AsposeResponse @@ -22568,26 +25433,27 @@ def put_pdf_in_request_to_la_te_x(self, out_path, **kwargs): """ 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_pdf_in_request_to_pptx_with_http_info(out_path, **kwargs) else: - (data) = self.put_pdf_in_request_to_la_te_x_with_http_info(out_path, **kwargs) + (data) = self.put_pdf_in_request_to_pptx_with_http_info(out_path, **kwargs) return data - def put_pdf_in_request_to_la_te_x_with_http_info(self, out_path, **kwargs): + def put_pdf_in_request_to_pptx_with_http_info(self, out_path, **kwargs): """ - Converts PDF document (in request content) to LaTeX format and uploads resulting file to storage. + 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_la_te_x_with_http_info(out_path, callback=callback_function) + >>> 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.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 storage: The document storage. :param file file: A file to be converted. :return: AsposeResponse @@ -22595,7 +25461,7 @@ def put_pdf_in_request_to_la_te_x_with_http_info(self, out_path, **kwargs): returns the request thread. """ - all_params = ['out_path', 'pages_count', 'storage', 'file'] + 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') @@ -22606,13 +25472,13 @@ 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_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_la_te_x`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_pptx`") collection_formats = {} @@ -22622,8 +25488,10 @@ def put_pdf_in_request_to_la_te_x_with_http_info(self, 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 'storage' in params: query_params.append(('storage', params['storage'])) @@ -22646,7 +25514,7 @@ def put_pdf_in_request_to_la_te_x_with_http_info(self, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/latex', 'PUT', + return self.api_client.call_api('/pdf/convert/pptx', 'PUT', path_params, query_params, header_params, @@ -22661,20 +25529,20 @@ 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_pdf_in_request_to_svg(self, out_path, **kwargs): """ - Converts PDF document (in request content) to MOBIXML format and uploads resulting file to storage. + 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_mobi_xml(out_path, callback=callback_function) + >>> 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.mobixml) (required) + :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 @@ -22683,25 +25551,25 @@ def put_pdf_in_request_to_mobi_xml(self, out_path, **kwargs): """ 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_pdf_in_request_to_svg_with_http_info(out_path, **kwargs) else: - (data) = self.put_pdf_in_request_to_mobi_xml_with_http_info(out_path, **kwargs) + (data) = self.put_pdf_in_request_to_svg_with_http_info(out_path, **kwargs) return data - def put_pdf_in_request_to_mobi_xml_with_http_info(self, out_path, **kwargs): + def put_pdf_in_request_to_svg_with_http_info(self, out_path, **kwargs): """ - Converts PDF document (in request content) to MOBIXML format and uploads resulting file to storage. + 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_mobi_xml_with_http_info(out_path, callback=callback_function) + >>> 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.mobixml) (required) + :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 @@ -22720,13 +25588,13 @@ 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_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_mobi_xml`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_svg`") collection_formats = {} @@ -22758,7 +25626,7 @@ def put_pdf_in_request_to_mobi_xml_with_http_info(self, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/mobixml', 'PUT', + return self.api_client.call_api('/pdf/convert/svg', 'PUT', path_params, query_params, header_params, @@ -22773,21 +25641,35 @@ 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_pdf_in_request_to_tiff(self, out_path, **kwargs): """ - Converts PDF document (in request content) to PdfA format and uploads resulting file to storage. + 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_pdf_a(out_path, type, callback=callback_function) + >>> 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.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 storage: The document storage. :param file file: A file to be converted. :return: AsposeResponse @@ -22796,26 +25678,40 @@ def put_pdf_in_request_to_pdf_a(self, out_path, type, **kwargs): """ 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_pdf_in_request_to_tiff_with_http_info(out_path, **kwargs) else: - (data) = self.put_pdf_in_request_to_pdf_a_with_http_info(out_path, type, **kwargs) + (data) = self.put_pdf_in_request_to_tiff_with_http_info(out_path, **kwargs) return data - def put_pdf_in_request_to_pdf_a_with_http_info(self, out_path, type, **kwargs): + def put_pdf_in_request_to_tiff_with_http_info(self, out_path, **kwargs): """ - Converts PDF document (in request content) to PdfA format and uploads resulting file to storage. + 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_pdf_a_with_http_info(out_path, type, callback=callback_function) + >>> 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.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 storage: The document storage. :param file file: A file to be converted. :return: AsposeResponse @@ -22823,7 +25719,7 @@ def put_pdf_in_request_to_pdf_a_with_http_info(self, out_path, type, **kwargs): returns the request thread. """ - all_params = ['out_path', 'type', 'storage', 'file'] + 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') @@ -22834,16 +25730,13 @@ 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_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_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`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_tiff`") collection_formats = {} @@ -22853,8 +25746,36 @@ def put_pdf_in_request_to_pdf_a_with_http_info(self, out_path, type, **kwargs): 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 'storage' in params: query_params.append(('storage', params['storage'])) @@ -22877,7 +25798,7 @@ def put_pdf_in_request_to_pdf_a_with_http_info(self, out_path, type, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/pdfa', 'PUT', + return self.api_client.call_api('/pdf/convert/tiff', 'PUT', path_params, query_params, header_params, @@ -22892,22 +25813,24 @@ 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_pdf_in_request_to_xls(self, out_path, **kwargs): """ - Converts PDF document (in request content) to PPTX format and uploads resulting file to storage. + 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_pptx(out_path, callback=callback_function) + >>> 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.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 storage: The document storage. :param file file: A file to be converted. :return: AsposeResponse @@ -22916,27 +25839,29 @@ def put_pdf_in_request_to_pptx(self, out_path, **kwargs): """ 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_pdf_in_request_to_xls_with_http_info(out_path, **kwargs) else: - (data) = self.put_pdf_in_request_to_pptx_with_http_info(out_path, **kwargs) + (data) = self.put_pdf_in_request_to_xls_with_http_info(out_path, **kwargs) return data - def put_pdf_in_request_to_pptx_with_http_info(self, out_path, **kwargs): + def put_pdf_in_request_to_xls_with_http_info(self, out_path, **kwargs): """ - Converts PDF document (in request content) to PPTX format and uploads resulting file to storage. + 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_pptx_with_http_info(out_path, callback=callback_function) + >>> 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.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 storage: The document storage. :param file file: A file to be converted. :return: AsposeResponse @@ -22944,7 +25869,7 @@ def put_pdf_in_request_to_pptx_with_http_info(self, out_path, **kwargs): returns the request thread. """ - all_params = ['out_path', 'separate_images', 'slides_as_images', 'storage', 'file'] + 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') @@ -22955,13 +25880,13 @@ 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_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_pptx`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_xls`") collection_formats = {} @@ -22971,10 +25896,14 @@ def put_pdf_in_request_to_pptx_with_http_info(self, 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 'storage' in params: query_params.append(('storage', params['storage'])) @@ -22997,7 +25926,7 @@ def put_pdf_in_request_to_pptx_with_http_info(self, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/pptx', 'PUT', + return self.api_client.call_api('/pdf/convert/xls', 'PUT', path_params, query_params, header_params, @@ -23012,20 +25941,20 @@ 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_pdf_in_request_to_xml(self, out_path, **kwargs): """ - Converts PDF document (in request content) to SVG format and uploads resulting file to storage. + 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_svg(out_path, callback=callback_function) + >>> 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.svg) (required) + :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 @@ -23034,25 +25963,25 @@ def put_pdf_in_request_to_svg(self, out_path, **kwargs): """ 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_pdf_in_request_to_xml_with_http_info(out_path, **kwargs) else: - (data) = self.put_pdf_in_request_to_svg_with_http_info(out_path, **kwargs) + (data) = self.put_pdf_in_request_to_xml_with_http_info(out_path, **kwargs) return data - def put_pdf_in_request_to_svg_with_http_info(self, out_path, **kwargs): + def put_pdf_in_request_to_xml_with_http_info(self, out_path, **kwargs): """ - Converts PDF document (in request content) to SVG format and uploads resulting file to storage. + 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_svg_with_http_info(out_path, callback=callback_function) + >>> 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.svg) (required) + :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 @@ -23071,13 +26000,13 @@ 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_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_svg`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_xml`") collection_formats = {} @@ -23109,7 +26038,7 @@ def put_pdf_in_request_to_svg_with_http_info(self, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/svg', 'PUT', + return self.api_client.call_api('/pdf/convert/xml', 'PUT', path_params, query_params, header_params, @@ -23124,35 +26053,20 @@ 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_pdf_in_request_to_xps(self, out_path, **kwargs): """ - Converts PDF document (in request content) to TIFF 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_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. + 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 @@ -23161,40 +26075,25 @@ def put_pdf_in_request_to_tiff(self, out_path, **kwargs): """ 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_pdf_in_request_to_xps_with_http_info(out_path, **kwargs) else: - (data) = self.put_pdf_in_request_to_tiff_with_http_info(out_path, **kwargs) + (data) = self.put_pdf_in_request_to_xps_with_http_info(out_path, **kwargs) return data - def put_pdf_in_request_to_tiff_with_http_info(self, out_path, **kwargs): + def put_pdf_in_request_to_xps_with_http_info(self, out_path, **kwargs): """ - Converts PDF document (in request content) to TIFF 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_tiff_with_http_info(out_path, callback=callback_function) + >>> 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.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 storage: The document storage. :param file file: A file to be converted. :return: AsposeResponse @@ -23202,7 +26101,7 @@ def put_pdf_in_request_to_tiff_with_http_info(self, out_path, **kwargs): 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 = ['out_path', 'storage', 'file'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -23213,13 +26112,13 @@ 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_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_tiff`") + raise ValueError("Missing the required parameter `out_path` when calling `put_pdf_in_request_to_xps`") collection_formats = {} @@ -23229,36 +26128,6 @@ def put_pdf_in_request_to_tiff_with_http_info(self, 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 'storage' in params: query_params.append(('storage', params['storage'])) @@ -23281,7 +26150,7 @@ def put_pdf_in_request_to_tiff_with_http_info(self, out_path, **kwargs): # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/convert/tiff', 'PUT', + return self.api_client.call_api('/pdf/convert/xps', 'PUT', path_params, query_params, header_params, @@ -23296,63 +26165,73 @@ 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_pdf_in_storage_to_doc(self, name, out_path, **kwargs): """ - Converts PDF document (in request content) to XLS format and uploads resulting file to storage. + 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_request_to_xls(out_path, callback=callback_function) + >>> 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 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 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. - :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) + return self.put_pdf_in_storage_to_doc_with_http_info(name, out_path, **kwargs) else: - (data) = self.put_pdf_in_request_to_xls_with_http_info(out_path, **kwargs) + (data) = self.put_pdf_in_storage_to_doc_with_http_info(name, out_path, **kwargs) return data - def put_pdf_in_request_to_xls_with_http_info(self, out_path, **kwargs): + def put_pdf_in_storage_to_doc_with_http_info(self, name, out_path, **kwargs): """ - Converts PDF document (in request content) to XLS format and uploads resulting file to storage. + 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_request_to_xls_with_http_info(out_path, callback=callback_function) + >>> 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 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 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. - :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 = ['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') @@ -23363,30 +26242,45 @@ 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_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_request_to_xls`") + 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 '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 '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'])) @@ -23394,8 +26288,6 @@ def put_pdf_in_request_to_xls_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` @@ -23404,12 +26296,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}/convert/doc', 'PUT', path_params, query_params, header_params, @@ -23424,55 +26316,59 @@ 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_pdf_in_storage_to_epub(self, name, out_path, **kwargs): """ - Converts PDF document (in request content) to XML format and uploads resulting file to storage. + 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_request_to_xml(out_path, callback=callback_function) + >>> 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 out_path: Full resulting filename (ex. /folder1/folder2/result.xml) (required) + :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: Property tunes conversion for this or that desirable method of recognition of content. + :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_request_to_xml_with_http_info(out_path, **kwargs) + return self.put_pdf_in_storage_to_epub_with_http_info(name, out_path, **kwargs) else: - (data) = self.put_pdf_in_request_to_xml_with_http_info(out_path, **kwargs) + (data) = self.put_pdf_in_storage_to_epub_with_http_info(name, out_path, **kwargs) return data - def put_pdf_in_request_to_xml_with_http_info(self, out_path, **kwargs): + def put_pdf_in_storage_to_epub_with_http_info(self, name, out_path, **kwargs): """ - Converts PDF document (in request content) to XML format and uploads resulting file to storage. + 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_request_to_xml_with_http_info(out_path, callback=callback_function) + >>> 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 out_path: Full resulting filename (ex. /folder1/folder2/result.xml) (required) + :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: Property tunes conversion for this or that desirable method of recognition of content. + :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. """ - all_params = ['out_path', 'storage', 'file'] + 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') @@ -23483,22 +26379,31 @@ 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_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_request_to_xml`") + 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'])) @@ -23506,8 +26411,6 @@ def put_pdf_in_request_to_xml_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` @@ -23516,12 +26419,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}/convert/epub', 'PUT', path_params, query_params, header_params, @@ -23536,55 +26439,113 @@ 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_pdf_in_storage_to_html(self, name, out_path, **kwargs): """ - Converts PDF document (in request content) to XPS format and uploads resulting file to storage. + 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(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_request_to_xps_with_http_info(out_path, **kwargs) + return self.put_pdf_in_storage_to_html_with_http_info(name, out_path, **kwargs) else: - (data) = self.put_pdf_in_request_to_xps_with_http_info(out_path, **kwargs) + (data) = self.put_pdf_in_storage_to_html_with_http_info(name, out_path, **kwargs) return data - def put_pdf_in_request_to_xps_with_http_info(self, out_path, **kwargs): + def put_pdf_in_storage_to_html_with_http_info(self, name, out_path, **kwargs): """ - Converts PDF document (in request content) to XPS format and uploads resulting file to storage. + 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_with_http_info(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. """ - all_params = ['out_path', 'storage', 'file'] + 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') @@ -23595,22 +26556,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'])) @@ -23618,8 +26643,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` @@ -23628,12 +26651,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, @@ -23648,29 +26671,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 @@ -23679,34 +26695,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 @@ -23714,7 +26723,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') @@ -23725,16 +26734,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 = {} @@ -23746,22 +26755,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: @@ -23784,7 +26779,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, @@ -23799,22 +26794,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: Property 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 @@ -23823,27 +26817,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: Property 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 @@ -23851,7 +26844,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') @@ -23862,16 +26855,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 = {} @@ -23883,8 +26876,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: @@ -23907,7 +26898,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, @@ -23922,49 +26913,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) - - :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. + >>> 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.pdf) (required) + :param str type: Type of PdfA format. (required) :param str folder: The document folder. :param str storage: The document storage. :return: AsposeResponse @@ -23973,54 +26937,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 @@ -24028,7 +26965,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') @@ -24039,16 +26976,19 @@ 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 = {} @@ -24060,63 +27000,8 @@ def put_pdf_in_storage_to_html_with_http_info(self, name, out_path, **kwargs): 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 'type' in params: + query_params.append(('type', params['type'])) if 'folder' in params: query_params.append(('folder', params['folder'])) if 'storage' in params: @@ -24139,7 +27024,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, @@ -24154,22 +27039,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 @@ -24178,27 +27064,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 @@ -24206,7 +27093,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') @@ -24217,16 +27104,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 = {} @@ -24238,8 +27125,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: @@ -24262,7 +27151,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, @@ -24277,21 +27166,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 @@ -24300,26 +27189,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 @@ -24338,16 +27227,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 = {} @@ -24381,7 +27270,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, @@ -24396,22 +27285,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 @@ -24420,27 +27323,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 @@ -24448,7 +27365,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') @@ -24459,19 +27376,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 = {} @@ -24483,8 +27397,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: @@ -24507,7 +27449,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, @@ -24522,23 +27464,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 @@ -24547,28 +27491,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 @@ -24576,7 +27522,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') @@ -24587,16 +27533,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 = {} @@ -24608,10 +27554,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: @@ -24634,7 +27584,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, @@ -24649,21 +27599,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 @@ -24672,26 +27622,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 @@ -24710,16 +27660,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 = {} @@ -24753,7 +27703,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, @@ -24768,36 +27718,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 @@ -24806,41 +27741,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 @@ -24848,7 +27768,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') @@ -24859,16 +27779,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 = {} @@ -24880,36 +27800,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: @@ -24932,7 +27822,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, @@ -24947,65 +27837,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') @@ -25016,16 +27900,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 = {} @@ -25033,22 +27920,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 = {} @@ -25056,6 +27935,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']) @@ -25067,14 +27948,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'), @@ -25082,57 +27963,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') @@ -25143,16 +28026,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 = {} @@ -25160,14 +28046,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 = {} @@ -25175,6 +28061,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']) @@ -25186,14 +28074,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'), @@ -25201,57 +28089,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') @@ -25262,16 +28152,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 = {} @@ -25279,14 +28172,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 = {} @@ -25294,6 +28187,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']) @@ -25305,14 +28200,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'), @@ -25320,59 +28215,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') @@ -25383,19 +28276,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 = {} @@ -25403,8 +28290,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: @@ -25418,8 +28303,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']) @@ -25431,14 +28316,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'), @@ -25446,59 +28331,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') @@ -25509,19 +28392,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 = {} @@ -25529,14 +28409,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 = {} @@ -25544,8 +28424,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']) @@ -25557,14 +28435,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'), @@ -25572,54 +28450,54 @@ def put_polygon_annotation_with_http_info(self, name, annotation_id, annotation, _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def put_popup_annotation(self, name, annotation_id, annotation, **kwargs): + def put_redaction_annotation(self, name, annotation_id, annotation, **kwargs): """ - Replace document popup annotation + Replace document redaction 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_popup_annotation(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.put_redaction_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 PopupAnnotation annotation: Annotation. (required) + :param RedactionAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: PopupAnnotationResponse + :return: RedactionAnnotationResponse If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.put_popup_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + return self.put_redaction_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_popup_annotation_with_http_info(name, annotation_id, annotation, **kwargs) + (data) = self.put_redaction_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_popup_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): + def put_redaction_annotation_with_http_info(self, name, annotation_id, annotation, **kwargs): """ - Replace document popup annotation + Replace document redaction 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_popup_annotation_with_http_info(name, annotation_id, annotation, callback=callback_function) + >>> thread = api.put_redaction_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 PopupAnnotation annotation: Annotation. (required) + :param RedactionAnnotation annotation: Annotation. (required) :param str storage: The document storage. :param str folder: The document folder. - :return: PopupAnnotationResponse + :return: RedactionAnnotationResponse If the method is called asynchronously, returns the request thread. """ @@ -25635,19 +28513,19 @@ def put_popup_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_popup_annotation" % key + " to method put_redaction_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_popup_annotation`") + raise ValueError("Missing the required parameter `name` when calling `put_redaction_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`") + raise ValueError("Missing the required parameter `annotation_id` when calling `put_redaction_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`") + raise ValueError("Missing the required parameter `annotation` when calling `put_redaction_annotation`") collection_formats = {} @@ -25683,14 +28561,14 @@ def put_popup_annotation_with_http_info(self, name, annotation_id, annotation, * # Authentication setting auth_settings = [] - return self.api_client.call_api('/pdf/{name}/annotations/popup/{annotationId}', 'PUT', + return self.api_client.call_api('/pdf/{name}/annotations/redaction/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='PopupAnnotationResponse', + response_type='RedactionAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -25698,57 +28576,61 @@ def put_popup_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') @@ -25759,13 +28641,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 = {} @@ -25773,8 +28658,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: @@ -25784,29 +28673,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'), @@ -25814,57 +28703,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') @@ -25875,16 +28764,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 = {} @@ -25894,12 +28780,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 = {} @@ -25918,7 +28804,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, @@ -25933,61 +28819,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') @@ -25998,16 +28882,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 = {} @@ -26015,12 +28902,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: @@ -26030,8 +28917,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` @@ -26040,19 +28925,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'), @@ -26060,57 +28945,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_sound_annotation(self, name, annotation_id, annotation, **kwargs): """ - Create searchable PDF document. Generate OCR layer for images in input PDF document. + Replace document sound 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_sound_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 SoundAnnotation 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: SoundAnnotationResponse 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_sound_annotation_with_http_info(name, annotation_id, annotation, **kwargs) else: - (data) = self.put_searchable_document_with_http_info(name, **kwargs) + (data) = self.put_sound_annotation_with_http_info(name, annotation_id, annotation, **kwargs) return data - def put_searchable_document_with_http_info(self, name, **kwargs): + def put_sound_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 sound 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_sound_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 SoundAnnotation 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: SoundAnnotationResponse 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') @@ -26121,13 +29008,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_sound_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_sound_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_sound_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_sound_annotation`") collection_formats = {} @@ -26135,14 +29028,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 = {} @@ -26150,6 +29043,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']) @@ -26161,14 +29056,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/sound/{annotationId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='AsposeResponse', + response_type='SoundAnnotationResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -26176,59 +29071,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_sound_annotation_data_extract(self, name, annotation_id, out_file_path, **kwargs): """ - Add/update document property. + Extract document sound annotation content 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_set_property(name, property_name, value, callback=callback_function) + >>> thread = api.put_sound_annotation_data_extract(name, annotation_id, out_file_path, 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 str out_file_path: The output file path. (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_set_property_with_http_info(name, property_name, value, **kwargs) + return self.put_sound_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, **kwargs) else: - (data) = self.put_set_property_with_http_info(name, property_name, value, **kwargs) + (data) = self.put_sound_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, **kwargs) return data - def put_set_property_with_http_info(self, name, property_name, value, **kwargs): + def put_sound_annotation_data_extract_with_http_info(self, name, annotation_id, out_file_path, **kwargs): """ - Add/update document property. + Extract document sound annotation content 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_set_property_with_http_info(name, property_name, value, callback=callback_function) + >>> thread = api.put_sound_annotation_data_extract_with_http_info(name, annotation_id, out_file_path, 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 str out_file_path: The output file path. (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', 'property_name', 'value', 'storage', 'folder'] + all_params = ['name', 'annotation_id', 'out_file_path', 'storage', 'folder'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -26239,19 +29134,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_sound_annotation_data_extract" % 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_sound_annotation_data_extract`") + # 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_sound_annotation_data_extract`") + # verify the required parameter 'out_file_path' is set + if ('out_file_path' not in params) or (params['out_file_path'] is None): + raise ValueError("Missing the required parameter `out_file_path` when calling `put_sound_annotation_data_extract`") collection_formats = {} @@ -26259,12 +29154,12 @@ 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 'out_file_path' in params: + query_params.append(('outFilePath', params['out_file_path'])) if 'storage' in params: query_params.append(('storage', params['storage'])) if 'folder' in params: @@ -26287,14 +29182,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/sound/{annotationId}/data/extract', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='DocumentPropertyResponse', + response_type='AsposeResponse', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/asposepdfcloud/configuration.py b/asposepdfcloud/configuration.py index a2b11cf..35657fc 100644 --- a/asposepdfcloud/configuration.py +++ b/asposepdfcloud/configuration.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 @@ -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.12.0".\ + "SDK Package Version: 19.1.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/asposepdfcloud/models/__init__.py b/asposepdfcloud/models/__init__.py index 8776d04..b73cc54 100644 --- a/asposepdfcloud/models/__init__.py +++ b/asposepdfcloud/models/__init__.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 @@ -51,6 +51,7 @@ from .field_type import FieldType from .file import File from .file_exist import FileExist +from .file_icon import FileIcon from .font_encoding_rules import FontEncodingRules from .font_saving_modes import FontSavingModes from .font_styles import FontStyles @@ -86,6 +87,8 @@ from .shape_type import ShapeType from .signature import Signature from .signature_type import SignatureType +from .sound_encoding import SoundEncoding +from .sound_icon import SoundIcon from .split_result import SplitResult from .stamp import Stamp from .stamp_type import StampType @@ -127,6 +130,9 @@ from .field_response import FieldResponse from .fields import Fields from .fields_response import FieldsResponse +from .file_attachment_annotation_response import FileAttachmentAnnotationResponse +from .file_attachment_annotations import FileAttachmentAnnotations +from .file_attachment_annotations_response import FileAttachmentAnnotationsResponse from .file_exist_response import FileExistResponse from .file_version import FileVersion from .file_versions_response import FileVersionsResponse @@ -151,6 +157,9 @@ from .link_annotation_response import LinkAnnotationResponse from .link_annotations import LinkAnnotations from .link_annotations_response import LinkAnnotationsResponse +from .movie_annotation_response import MovieAnnotationResponse +from .movie_annotations import MovieAnnotations +from .movie_annotations_response import MovieAnnotationsResponse from .page import Page from .pages import Pages from .poly_line_annotation_response import PolyLineAnnotationResponse @@ -162,7 +171,13 @@ from .popup_annotation_response import PopupAnnotationResponse from .popup_annotations import PopupAnnotations from .popup_annotations_response import PopupAnnotationsResponse +from .redaction_annotation_response import RedactionAnnotationResponse +from .redaction_annotations import RedactionAnnotations +from .redaction_annotations_response import RedactionAnnotationsResponse from .signature_verify_response import SignatureVerifyResponse +from .sound_annotation_response import SoundAnnotationResponse +from .sound_annotations import SoundAnnotations +from .sound_annotations_response import SoundAnnotationsResponse from .split_result_document import SplitResultDocument from .split_result_response import SplitResultResponse from .square_annotation_response import SquareAnnotationResponse @@ -186,15 +201,19 @@ from .word_count_response import WordCountResponse from .annotation_info import AnnotationInfo from .markup_annotation import MarkupAnnotation +from .movie_annotation import MovieAnnotation from .popup_annotation import PopupAnnotation +from .redaction_annotation import RedactionAnnotation from .caret_annotation import CaretAnnotation from .common_figure_annotation import CommonFigureAnnotation +from .file_attachment_annotation import FileAttachmentAnnotation 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 .sound_annotation import SoundAnnotation from .squiggly_annotation import SquigglyAnnotation from .strike_out_annotation import StrikeOutAnnotation from .text_annotation import TextAnnotation diff --git a/asposepdfcloud/models/annotation.py b/asposepdfcloud/models/annotation.py index b946b99..639f4bc 100644 --- a/asposepdfcloud/models/annotation.py +++ b/asposepdfcloud/models/annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/annotation_flags.py b/asposepdfcloud/models/annotation_flags.py index 22d83ee..71e37b6 100644 --- a/asposepdfcloud/models/annotation_flags.py +++ b/asposepdfcloud/models/annotation_flags.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/annotation_info.py b/asposepdfcloud/models/annotation_info.py index 9b88a86..58a2166 100644 --- a/asposepdfcloud/models/annotation_info.py +++ b/asposepdfcloud/models/annotation_info.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/annotation_state.py b/asposepdfcloud/models/annotation_state.py index 0e2a817..d2bf95c 100644 --- a/asposepdfcloud/models/annotation_state.py +++ b/asposepdfcloud/models/annotation_state.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/annotation_type.py b/asposepdfcloud/models/annotation_type.py index 77b69e7..898c4b5 100644 --- a/asposepdfcloud/models/annotation_type.py +++ b/asposepdfcloud/models/annotation_type.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/annotations_info.py b/asposepdfcloud/models/annotations_info.py index 253467f..3ffc8ff 100644 --- a/asposepdfcloud/models/annotations_info.py +++ b/asposepdfcloud/models/annotations_info.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/annotations_info_response.py b/asposepdfcloud/models/annotations_info_response.py index 6aa486c..47b11af 100644 --- a/asposepdfcloud/models/annotations_info_response.py +++ b/asposepdfcloud/models/annotations_info_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/antialiasing_processing_type.py b/asposepdfcloud/models/antialiasing_processing_type.py index 6c0fe8a..9881999 100644 --- a/asposepdfcloud/models/antialiasing_processing_type.py +++ b/asposepdfcloud/models/antialiasing_processing_type.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/append_document.py b/asposepdfcloud/models/append_document.py index 9b2457f..8b7638f 100644 --- a/asposepdfcloud/models/append_document.py +++ b/asposepdfcloud/models/append_document.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/aspose_response.py b/asposepdfcloud/models/aspose_response.py index fd0192e..eb4ac81 100644 --- a/asposepdfcloud/models/aspose_response.py +++ b/asposepdfcloud/models/aspose_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/attachment.py b/asposepdfcloud/models/attachment.py index f136ce1..1cc44a5 100644 --- a/asposepdfcloud/models/attachment.py +++ b/asposepdfcloud/models/attachment.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/attachment_response.py b/asposepdfcloud/models/attachment_response.py index 8d88001..f5e5432 100644 --- a/asposepdfcloud/models/attachment_response.py +++ b/asposepdfcloud/models/attachment_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/attachments.py b/asposepdfcloud/models/attachments.py index 9647c85..2bf18af 100644 --- a/asposepdfcloud/models/attachments.py +++ b/asposepdfcloud/models/attachments.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/attachments_response.py b/asposepdfcloud/models/attachments_response.py index 0f43cd6..c6d794d 100644 --- a/asposepdfcloud/models/attachments_response.py +++ b/asposepdfcloud/models/attachments_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/cap_style.py b/asposepdfcloud/models/cap_style.py index d7861c1..3b6ac78 100644 --- a/asposepdfcloud/models/cap_style.py +++ b/asposepdfcloud/models/cap_style.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/caption_position.py b/asposepdfcloud/models/caption_position.py index 6c9fa41..c73f4eb 100644 --- a/asposepdfcloud/models/caption_position.py +++ b/asposepdfcloud/models/caption_position.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/caret_annotation.py b/asposepdfcloud/models/caret_annotation.py index 5741a1d..47757e8 100644 --- a/asposepdfcloud/models/caret_annotation.py +++ b/asposepdfcloud/models/caret_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/caret_annotation_response.py b/asposepdfcloud/models/caret_annotation_response.py index 028a6b7..1ef611a 100644 --- a/asposepdfcloud/models/caret_annotation_response.py +++ b/asposepdfcloud/models/caret_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/caret_annotations.py b/asposepdfcloud/models/caret_annotations.py index 0526c17..f5c7ef6 100644 --- a/asposepdfcloud/models/caret_annotations.py +++ b/asposepdfcloud/models/caret_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/caret_annotations_response.py b/asposepdfcloud/models/caret_annotations_response.py index 9901864..4c6cede 100644 --- a/asposepdfcloud/models/caret_annotations_response.py +++ b/asposepdfcloud/models/caret_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/caret_symbol.py b/asposepdfcloud/models/caret_symbol.py index 9123f10..fa5191e 100644 --- a/asposepdfcloud/models/caret_symbol.py +++ b/asposepdfcloud/models/caret_symbol.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/circle_annotation.py b/asposepdfcloud/models/circle_annotation.py index 39fb704..9de3e23 100644 --- a/asposepdfcloud/models/circle_annotation.py +++ b/asposepdfcloud/models/circle_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/circle_annotation_response.py b/asposepdfcloud/models/circle_annotation_response.py index dff1ee0..576f4c2 100644 --- a/asposepdfcloud/models/circle_annotation_response.py +++ b/asposepdfcloud/models/circle_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/circle_annotations.py b/asposepdfcloud/models/circle_annotations.py index 565bc2e..4414e3f 100644 --- a/asposepdfcloud/models/circle_annotations.py +++ b/asposepdfcloud/models/circle_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/circle_annotations_response.py b/asposepdfcloud/models/circle_annotations_response.py index 1eb0bea..deaeefb 100644 --- a/asposepdfcloud/models/circle_annotations_response.py +++ b/asposepdfcloud/models/circle_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/color.py b/asposepdfcloud/models/color.py index 2ce278e..2bfd539 100644 --- a/asposepdfcloud/models/color.py +++ b/asposepdfcloud/models/color.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/color_depth.py b/asposepdfcloud/models/color_depth.py index 8aab7f6..e927b41 100644 --- a/asposepdfcloud/models/color_depth.py +++ b/asposepdfcloud/models/color_depth.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/common_figure_annotation.py b/asposepdfcloud/models/common_figure_annotation.py index ef27afb..fc705a1 100644 --- a/asposepdfcloud/models/common_figure_annotation.py +++ b/asposepdfcloud/models/common_figure_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/compression_type.py b/asposepdfcloud/models/compression_type.py index 0be20cb..c776c71 100644 --- a/asposepdfcloud/models/compression_type.py +++ b/asposepdfcloud/models/compression_type.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/disc_usage.py b/asposepdfcloud/models/disc_usage.py index 0364b22..cd0172e 100644 --- a/asposepdfcloud/models/disc_usage.py +++ b/asposepdfcloud/models/disc_usage.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/disc_usage_response.py b/asposepdfcloud/models/disc_usage_response.py index f23b2e9..d3c4672 100644 --- a/asposepdfcloud/models/disc_usage_response.py +++ b/asposepdfcloud/models/disc_usage_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/doc_format.py b/asposepdfcloud/models/doc_format.py index 8a9f297..2819f4f 100644 --- a/asposepdfcloud/models/doc_format.py +++ b/asposepdfcloud/models/doc_format.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/doc_recognition_mode.py b/asposepdfcloud/models/doc_recognition_mode.py index 2d6a207..214a59b 100644 --- a/asposepdfcloud/models/doc_recognition_mode.py +++ b/asposepdfcloud/models/doc_recognition_mode.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/document.py b/asposepdfcloud/models/document.py index ddaf510..49529dc 100644 --- a/asposepdfcloud/models/document.py +++ b/asposepdfcloud/models/document.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/document_page_response.py b/asposepdfcloud/models/document_page_response.py index 3c1243c..cb70970 100644 --- a/asposepdfcloud/models/document_page_response.py +++ b/asposepdfcloud/models/document_page_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/document_pages_response.py b/asposepdfcloud/models/document_pages_response.py index 4d844e9..909d49e 100644 --- a/asposepdfcloud/models/document_pages_response.py +++ b/asposepdfcloud/models/document_pages_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/document_privilege.py b/asposepdfcloud/models/document_privilege.py index 05baa2e..b8ee2b3 100644 --- a/asposepdfcloud/models/document_privilege.py +++ b/asposepdfcloud/models/document_privilege.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/document_properties.py b/asposepdfcloud/models/document_properties.py index 15a27cb..a4f5314 100644 --- a/asposepdfcloud/models/document_properties.py +++ b/asposepdfcloud/models/document_properties.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/document_properties_response.py b/asposepdfcloud/models/document_properties_response.py index b2b06b4..f0f1495 100644 --- a/asposepdfcloud/models/document_properties_response.py +++ b/asposepdfcloud/models/document_properties_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/document_property.py b/asposepdfcloud/models/document_property.py index b981960..bf21e1e 100644 --- a/asposepdfcloud/models/document_property.py +++ b/asposepdfcloud/models/document_property.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/document_property_response.py b/asposepdfcloud/models/document_property_response.py index a9767cd..86ffd25 100644 --- a/asposepdfcloud/models/document_property_response.py +++ b/asposepdfcloud/models/document_property_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/document_response.py b/asposepdfcloud/models/document_response.py index 208b10b..6281ad9 100644 --- a/asposepdfcloud/models/document_response.py +++ b/asposepdfcloud/models/document_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/epub_recognition_mode.py b/asposepdfcloud/models/epub_recognition_mode.py index 0597c6b..4f128e6 100644 --- a/asposepdfcloud/models/epub_recognition_mode.py +++ b/asposepdfcloud/models/epub_recognition_mode.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/field.py b/asposepdfcloud/models/field.py index 7f25015..474033a 100644 --- a/asposepdfcloud/models/field.py +++ b/asposepdfcloud/models/field.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/field_response.py b/asposepdfcloud/models/field_response.py index ef162fc..8756487 100644 --- a/asposepdfcloud/models/field_response.py +++ b/asposepdfcloud/models/field_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/field_type.py b/asposepdfcloud/models/field_type.py index eaf1cc2..851c474 100644 --- a/asposepdfcloud/models/field_type.py +++ b/asposepdfcloud/models/field_type.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/fields.py b/asposepdfcloud/models/fields.py index d903fec..0eab389 100644 --- a/asposepdfcloud/models/fields.py +++ b/asposepdfcloud/models/fields.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/fields_response.py b/asposepdfcloud/models/fields_response.py index 93fd18d..759cac7 100644 --- a/asposepdfcloud/models/fields_response.py +++ b/asposepdfcloud/models/fields_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/file.py b/asposepdfcloud/models/file.py index 6862b44..8190c78 100644 --- a/asposepdfcloud/models/file.py +++ b/asposepdfcloud/models/file.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/file_attachment_annotation.py b/asposepdfcloud/models/file_attachment_annotation.py new file mode 100644 index 0000000..177efcc --- /dev/null +++ b/asposepdfcloud/models/file_attachment_annotation.py @@ -0,0 +1,702 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 FileAttachmentAnnotation(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]', + 'color': 'Color', + 'contents': 'str', + 'modified': 'str', + 'id': 'str', + 'flags': 'list[AnnotationFlags]', + 'name': 'str', + 'rect': 'Rectangle', + 'page_index': 'int', + 'z_index': 'int', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', + 'rich_text': 'str', + 'icon': 'FileIcon', + 'opacity': 'float', + 'file_description': 'str', + 'file_name': 'str', + 'file_path': 'str' + } + + attribute_map = { + 'links': 'Links', + 'color': 'Color', + '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', + 'icon': 'Icon', + 'opacity': 'Opacity', + 'file_description': 'FileDescription', + 'file_name': 'FileName', + 'file_path': 'FilePath' + } + + def __init__(self, links=None, color=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, icon=None, opacity=None, file_description=None, file_name=None, file_path=None): + """ + FileAttachmentAnnotation - a model defined in Swagger + """ + + self._links = None + self._color = 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._icon = None + self._opacity = None + self._file_description = None + self._file_name = None + self._file_path = None + + if links is not None: + self.links = links + if color is not None: + self.color = color + 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 icon is not None: + self.icon = icon + if opacity is not None: + self.opacity = opacity + if file_description is not None: + self.file_description = file_description + if file_name is not None: + self.file_name = file_name + if file_path is not None: + self.file_path = file_path + + @property + def links(self): + """ + Gets the links of this FileAttachmentAnnotation. + Link to the document. + + :return: The links of this FileAttachmentAnnotation. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this FileAttachmentAnnotation. + Link to the document. + + :param links: The links of this FileAttachmentAnnotation. + :type: list[Link] + """ + + self._links = links + + @property + def color(self): + """ + Gets the color of this FileAttachmentAnnotation. + Color of the annotation. + + :return: The color of this FileAttachmentAnnotation. + :rtype: Color + """ + return self._color + + @color.setter + def color(self, color): + """ + Sets the color of this FileAttachmentAnnotation. + Color of the annotation. + + :param color: The color of this FileAttachmentAnnotation. + :type: Color + """ + + self._color = color + + @property + def contents(self): + """ + Gets the contents of this FileAttachmentAnnotation. + Get the annotation content. + + :return: The contents of this FileAttachmentAnnotation. + :rtype: str + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this FileAttachmentAnnotation. + Get the annotation content. + + :param contents: The contents of this FileAttachmentAnnotation. + :type: str + """ + + self._contents = contents + + @property + def modified(self): + """ + Gets the modified of this FileAttachmentAnnotation. + The date and time when the annotation was last modified. + + :return: The modified of this FileAttachmentAnnotation. + :rtype: str + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this FileAttachmentAnnotation. + The date and time when the annotation was last modified. + + :param modified: The modified of this FileAttachmentAnnotation. + :type: str + """ + + self._modified = modified + + @property + def id(self): + """ + Gets the id of this FileAttachmentAnnotation. + Gets ID of the annotation. + + :return: The id of this FileAttachmentAnnotation. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this FileAttachmentAnnotation. + Gets ID of the annotation. + + :param id: The id of this FileAttachmentAnnotation. + :type: str + """ + + self._id = id + + @property + def flags(self): + """ + Gets the flags of this FileAttachmentAnnotation. + Gets Flags of the annotation. + + :return: The flags of this FileAttachmentAnnotation. + :rtype: list[AnnotationFlags] + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this FileAttachmentAnnotation. + Gets Flags of the annotation. + + :param flags: The flags of this FileAttachmentAnnotation. + :type: list[AnnotationFlags] + """ + + self._flags = flags + + @property + def name(self): + """ + Gets the name of this FileAttachmentAnnotation. + Gets Name of the annotation. + + :return: The name of this FileAttachmentAnnotation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this FileAttachmentAnnotation. + Gets Name of the annotation. + + :param name: The name of this FileAttachmentAnnotation. + :type: str + """ + + self._name = name + + @property + def rect(self): + """ + Gets the rect of this FileAttachmentAnnotation. + Gets Rect of the annotation. + + :return: The rect of this FileAttachmentAnnotation. + :rtype: Rectangle + """ + return self._rect + + @rect.setter + def rect(self, rect): + """ + Sets the rect of this FileAttachmentAnnotation. + Gets Rect of the annotation. + + :param rect: The rect of this FileAttachmentAnnotation. + :type: Rectangle + """ + + self._rect = rect + + @property + def page_index(self): + """ + Gets the page_index of this FileAttachmentAnnotation. + Gets PageIndex of the annotation. + + :return: The page_index of this FileAttachmentAnnotation. + :rtype: int + """ + return self._page_index + + @page_index.setter + def page_index(self, page_index): + """ + Sets the page_index of this FileAttachmentAnnotation. + Gets PageIndex of the annotation. + + :param page_index: The page_index of this FileAttachmentAnnotation. + :type: int + """ + + self._page_index = page_index + + @property + def z_index(self): + """ + Gets the z_index of this FileAttachmentAnnotation. + Gets ZIndex of the annotation. + + :return: The z_index of this FileAttachmentAnnotation. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this FileAttachmentAnnotation. + Gets ZIndex of the annotation. + + :param z_index: The z_index of this FileAttachmentAnnotation. + :type: int + """ + + self._z_index = z_index + + @property + def horizontal_alignment(self): + """ + Gets the horizontal_alignment of this FileAttachmentAnnotation. + Gets HorizontalAlignment of the annotation. + + :return: The horizontal_alignment of this FileAttachmentAnnotation. + :rtype: HorizontalAlignment + """ + return self._horizontal_alignment + + @horizontal_alignment.setter + def horizontal_alignment(self, horizontal_alignment): + """ + Sets the horizontal_alignment of this FileAttachmentAnnotation. + Gets HorizontalAlignment of the annotation. + + :param horizontal_alignment: The horizontal_alignment of this FileAttachmentAnnotation. + :type: HorizontalAlignment + """ + + self._horizontal_alignment = horizontal_alignment + + @property + def vertical_alignment(self): + """ + Gets the vertical_alignment of this FileAttachmentAnnotation. + Gets VerticalAlignment of the annotation. + + :return: The vertical_alignment of this FileAttachmentAnnotation. + :rtype: VerticalAlignment + """ + return self._vertical_alignment + + @vertical_alignment.setter + def vertical_alignment(self, vertical_alignment): + """ + Sets the vertical_alignment of this FileAttachmentAnnotation. + Gets VerticalAlignment of the annotation. + + :param vertical_alignment: The vertical_alignment of this FileAttachmentAnnotation. + :type: VerticalAlignment + """ + + self._vertical_alignment = vertical_alignment + + @property + def creation_date(self): + """ + Gets the creation_date of this FileAttachmentAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this FileAttachmentAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this FileAttachmentAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this FileAttachmentAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this FileAttachmentAnnotation. + Get the annotation subject. + + :return: The subject of this FileAttachmentAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this FileAttachmentAnnotation. + Get the annotation subject. + + :param subject: The subject of this FileAttachmentAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this FileAttachmentAnnotation. + Get the annotation title. + + :return: The title of this FileAttachmentAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this FileAttachmentAnnotation. + Get the annotation title. + + :param title: The title of this FileAttachmentAnnotation. + :type: str + """ + + self._title = title + + @property + def rich_text(self): + """ + Gets the rich_text of this FileAttachmentAnnotation. + Get the annotation RichText. + + :return: The rich_text of this FileAttachmentAnnotation. + :rtype: str + """ + return self._rich_text + + @rich_text.setter + def rich_text(self, rich_text): + """ + Sets the rich_text of this FileAttachmentAnnotation. + Get the annotation RichText. + + :param rich_text: The rich_text of this FileAttachmentAnnotation. + :type: str + """ + + self._rich_text = rich_text + + @property + def icon(self): + """ + Gets the icon of this FileAttachmentAnnotation. + Gets or sets icon that shall be used in displaying annotation. + + :return: The icon of this FileAttachmentAnnotation. + :rtype: FileIcon + """ + return self._icon + + @icon.setter + def icon(self, icon): + """ + Sets the icon of this FileAttachmentAnnotation. + Gets or sets icon that shall be used in displaying annotation. + + :param icon: The icon of this FileAttachmentAnnotation. + :type: FileIcon + """ + + self._icon = icon + + @property + def opacity(self): + """ + Gets the opacity of this FileAttachmentAnnotation. + Gets or sets icon's opacity from 0 to 1: 0 - completely transparant, 1 - completely opaque. + + :return: The opacity of this FileAttachmentAnnotation. + :rtype: float + """ + return self._opacity + + @opacity.setter + def opacity(self, opacity): + """ + Sets the opacity of this FileAttachmentAnnotation. + Gets or sets icon's opacity from 0 to 1: 0 - completely transparant, 1 - completely opaque. + + :param opacity: The opacity of this FileAttachmentAnnotation. + :type: float + """ + + self._opacity = opacity + + @property + def file_description(self): + """ + Gets the file_description of this FileAttachmentAnnotation. + Gets or sets text associated with the file specification. + + :return: The file_description of this FileAttachmentAnnotation. + :rtype: str + """ + return self._file_description + + @file_description.setter + def file_description(self, file_description): + """ + Sets the file_description of this FileAttachmentAnnotation. + Gets or sets text associated with the file specification. + + :param file_description: The file_description of this FileAttachmentAnnotation. + :type: str + """ + + self._file_description = file_description + + @property + def file_name(self): + """ + Gets the file_name of this FileAttachmentAnnotation. + Gets or sets file specification name. + + :return: The file_name of this FileAttachmentAnnotation. + :rtype: str + """ + return self._file_name + + @file_name.setter + def file_name(self, file_name): + """ + Sets the file_name of this FileAttachmentAnnotation. + Gets or sets file specification name. + + :param file_name: The file_name of this FileAttachmentAnnotation. + :type: str + """ + + self._file_name = file_name + + @property + def file_path(self): + """ + Gets the file_path of this FileAttachmentAnnotation. + Sets content file path. + + :return: The file_path of this FileAttachmentAnnotation. + :rtype: str + """ + return self._file_path + + @file_path.setter + def file_path(self, file_path): + """ + Sets the file_path of this FileAttachmentAnnotation. + Sets content file path. + + :param file_path: The file_path of this FileAttachmentAnnotation. + :type: str + """ + + self._file_path = file_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, FileAttachmentAnnotation): + 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/file_attachment_annotation_response.py b/asposepdfcloud/models/file_attachment_annotation_response.py new file mode 100644 index 0000000..25a306c --- /dev/null +++ b/asposepdfcloud/models/file_attachment_annotation_response.py @@ -0,0 +1,199 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 FileAttachmentAnnotationResponse(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': 'FileAttachmentAnnotation' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotation': 'Annotation' + } + + def __init__(self, code=None, status=None, annotation=None): + """ + FileAttachmentAnnotationResponse - 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 FileAttachmentAnnotationResponse. + Response status code. + + :return: The code of this FileAttachmentAnnotationResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this FileAttachmentAnnotationResponse. + Response status code. + + :param code: The code of this FileAttachmentAnnotationResponse. + :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 FileAttachmentAnnotationResponse. + Response status. + + :return: The status of this FileAttachmentAnnotationResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this FileAttachmentAnnotationResponse. + Response status. + + :param status: The status of this FileAttachmentAnnotationResponse. + :type: str + """ + + self._status = status + + @property + def annotation(self): + """ + Gets the annotation of this FileAttachmentAnnotationResponse. + FileAttachment annotation object + + :return: The annotation of this FileAttachmentAnnotationResponse. + :rtype: FileAttachmentAnnotation + """ + return self._annotation + + @annotation.setter + def annotation(self, annotation): + """ + Sets the annotation of this FileAttachmentAnnotationResponse. + FileAttachment annotation object + + :param annotation: The annotation of this FileAttachmentAnnotationResponse. + :type: FileAttachmentAnnotation + """ + + 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, FileAttachmentAnnotationResponse): + 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/file_attachment_annotations.py b/asposepdfcloud/models/file_attachment_annotations.py new file mode 100644 index 0000000..a57d2d8 --- /dev/null +++ b/asposepdfcloud/models/file_attachment_annotations.py @@ -0,0 +1,170 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 FileAttachmentAnnotations(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[FileAttachmentAnnotation]' + } + + attribute_map = { + 'links': 'Links', + 'list': 'List' + } + + def __init__(self, links=None, list=None): + """ + FileAttachmentAnnotations - 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 FileAttachmentAnnotations. + Link to the document. + + :return: The links of this FileAttachmentAnnotations. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this FileAttachmentAnnotations. + Link to the document. + + :param links: The links of this FileAttachmentAnnotations. + :type: list[Link] + """ + + self._links = links + + @property + def list(self): + """ + Gets the list of this FileAttachmentAnnotations. + List of FileAttachment annotations. + + :return: The list of this FileAttachmentAnnotations. + :rtype: list[FileAttachmentAnnotation] + """ + return self._list + + @list.setter + def list(self, list): + """ + Sets the list of this FileAttachmentAnnotations. + List of FileAttachment annotations. + + :param list: The list of this FileAttachmentAnnotations. + :type: list[FileAttachmentAnnotation] + """ + + 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, FileAttachmentAnnotations): + 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/file_attachment_annotations_response.py b/asposepdfcloud/models/file_attachment_annotations_response.py new file mode 100644 index 0000000..201a56a --- /dev/null +++ b/asposepdfcloud/models/file_attachment_annotations_response.py @@ -0,0 +1,199 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 FileAttachmentAnnotationsResponse(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': 'FileAttachmentAnnotations' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotations': 'Annotations' + } + + def __init__(self, code=None, status=None, annotations=None): + """ + FileAttachmentAnnotationsResponse - 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 FileAttachmentAnnotationsResponse. + Response status code. + + :return: The code of this FileAttachmentAnnotationsResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this FileAttachmentAnnotationsResponse. + Response status code. + + :param code: The code of this FileAttachmentAnnotationsResponse. + :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 FileAttachmentAnnotationsResponse. + Response status. + + :return: The status of this FileAttachmentAnnotationsResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this FileAttachmentAnnotationsResponse. + Response status. + + :param status: The status of this FileAttachmentAnnotationsResponse. + :type: str + """ + + self._status = status + + @property + def annotations(self): + """ + Gets the annotations of this FileAttachmentAnnotationsResponse. + Free text annotations object + + :return: The annotations of this FileAttachmentAnnotationsResponse. + :rtype: FileAttachmentAnnotations + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this FileAttachmentAnnotationsResponse. + Free text annotations object + + :param annotations: The annotations of this FileAttachmentAnnotationsResponse. + :type: FileAttachmentAnnotations + """ + + 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, FileAttachmentAnnotationsResponse): + 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/file_exist.py b/asposepdfcloud/models/file_exist.py index f85544b..12671eb 100644 --- a/asposepdfcloud/models/file_exist.py +++ b/asposepdfcloud/models/file_exist.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/file_exist_response.py b/asposepdfcloud/models/file_exist_response.py index 245235b..5282e78 100644 --- a/asposepdfcloud/models/file_exist_response.py +++ b/asposepdfcloud/models/file_exist_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/file_icon.py b/asposepdfcloud/models/file_icon.py new file mode 100644 index 0000000..139b6e9 --- /dev/null +++ b/asposepdfcloud/models/file_icon.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 FileIcon(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + """ + allowed enum values + """ + PUSHPIN = "PushPin" + GRAPH = "Graph" + PAPERCLIP = "Paperclip" + TAG = "Tag" + + """ + 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): + """ + FileIcon - 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, FileIcon): + 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/file_version.py b/asposepdfcloud/models/file_version.py index 03d36d4..ff23a10 100644 --- a/asposepdfcloud/models/file_version.py +++ b/asposepdfcloud/models/file_version.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/file_versions_response.py b/asposepdfcloud/models/file_versions_response.py index a69f8fa..10a13c9 100644 --- a/asposepdfcloud/models/file_versions_response.py +++ b/asposepdfcloud/models/file_versions_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/files_response.py b/asposepdfcloud/models/files_response.py index 1758100..c7f8365 100644 --- a/asposepdfcloud/models/files_response.py +++ b/asposepdfcloud/models/files_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/font_encoding_rules.py b/asposepdfcloud/models/font_encoding_rules.py index c6f2699..e25c81f 100644 --- a/asposepdfcloud/models/font_encoding_rules.py +++ b/asposepdfcloud/models/font_encoding_rules.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/font_saving_modes.py b/asposepdfcloud/models/font_saving_modes.py index 059add9..106fa0d 100644 --- a/asposepdfcloud/models/font_saving_modes.py +++ b/asposepdfcloud/models/font_saving_modes.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/font_styles.py b/asposepdfcloud/models/font_styles.py index 5752ae9..1f388b2 100644 --- a/asposepdfcloud/models/font_styles.py +++ b/asposepdfcloud/models/font_styles.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/free_text_annotation.py b/asposepdfcloud/models/free_text_annotation.py index 65cf1ae..7c4313e 100644 --- a/asposepdfcloud/models/free_text_annotation.py +++ b/asposepdfcloud/models/free_text_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/free_text_annotation_response.py b/asposepdfcloud/models/free_text_annotation_response.py index 431110e..0ee29d5 100644 --- a/asposepdfcloud/models/free_text_annotation_response.py +++ b/asposepdfcloud/models/free_text_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/free_text_annotations.py b/asposepdfcloud/models/free_text_annotations.py index 5a87543..8357a08 100644 --- a/asposepdfcloud/models/free_text_annotations.py +++ b/asposepdfcloud/models/free_text_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/free_text_annotations_response.py b/asposepdfcloud/models/free_text_annotations_response.py index 851138e..cfba305 100644 --- a/asposepdfcloud/models/free_text_annotations_response.py +++ b/asposepdfcloud/models/free_text_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/free_text_intent.py b/asposepdfcloud/models/free_text_intent.py index 4ed721e..c667738 100644 --- a/asposepdfcloud/models/free_text_intent.py +++ b/asposepdfcloud/models/free_text_intent.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/highlight_annotation.py b/asposepdfcloud/models/highlight_annotation.py index bab3635..37d8e6f 100644 --- a/asposepdfcloud/models/highlight_annotation.py +++ b/asposepdfcloud/models/highlight_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/highlight_annotation_response.py b/asposepdfcloud/models/highlight_annotation_response.py index 1657fe6..106da65 100644 --- a/asposepdfcloud/models/highlight_annotation_response.py +++ b/asposepdfcloud/models/highlight_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/highlight_annotations.py b/asposepdfcloud/models/highlight_annotations.py index 8fc02b1..2c040d0 100644 --- a/asposepdfcloud/models/highlight_annotations.py +++ b/asposepdfcloud/models/highlight_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/highlight_annotations_response.py b/asposepdfcloud/models/highlight_annotations_response.py index f5ce268..fb4890b 100644 --- a/asposepdfcloud/models/highlight_annotations_response.py +++ b/asposepdfcloud/models/highlight_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/horizontal_alignment.py b/asposepdfcloud/models/horizontal_alignment.py index cfb7e30..79aa0aa 100644 --- a/asposepdfcloud/models/horizontal_alignment.py +++ b/asposepdfcloud/models/horizontal_alignment.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/html_document_type.py b/asposepdfcloud/models/html_document_type.py index fdc648d..b4c949a 100644 --- a/asposepdfcloud/models/html_document_type.py +++ b/asposepdfcloud/models/html_document_type.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/html_markup_generation_modes.py b/asposepdfcloud/models/html_markup_generation_modes.py index eb6ebb9..50b0201 100644 --- a/asposepdfcloud/models/html_markup_generation_modes.py +++ b/asposepdfcloud/models/html_markup_generation_modes.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/image.py b/asposepdfcloud/models/image.py index 4f49fb7..6f4f96b 100644 --- a/asposepdfcloud/models/image.py +++ b/asposepdfcloud/models/image.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/image_response.py b/asposepdfcloud/models/image_response.py index dabb7e8..6f556a0 100644 --- a/asposepdfcloud/models/image_response.py +++ b/asposepdfcloud/models/image_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/image_src_type.py b/asposepdfcloud/models/image_src_type.py index 89cdf30..1896c91 100644 --- a/asposepdfcloud/models/image_src_type.py +++ b/asposepdfcloud/models/image_src_type.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/image_template.py b/asposepdfcloud/models/image_template.py index dd77486..8155d90 100644 --- a/asposepdfcloud/models/image_template.py +++ b/asposepdfcloud/models/image_template.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/image_templates_request.py b/asposepdfcloud/models/image_templates_request.py index be100e8..2d3c201 100644 --- a/asposepdfcloud/models/image_templates_request.py +++ b/asposepdfcloud/models/image_templates_request.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/images.py b/asposepdfcloud/models/images.py index 77d1678..af30625 100644 --- a/asposepdfcloud/models/images.py +++ b/asposepdfcloud/models/images.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/images_response.py b/asposepdfcloud/models/images_response.py index f19ca10..0b9acf8 100644 --- a/asposepdfcloud/models/images_response.py +++ b/asposepdfcloud/models/images_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/ink_annotation.py b/asposepdfcloud/models/ink_annotation.py index c87a9e6..97fa73b 100644 --- a/asposepdfcloud/models/ink_annotation.py +++ b/asposepdfcloud/models/ink_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/ink_annotation_response.py b/asposepdfcloud/models/ink_annotation_response.py index ba80ddd..2cb6623 100644 --- a/asposepdfcloud/models/ink_annotation_response.py +++ b/asposepdfcloud/models/ink_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/ink_annotations.py b/asposepdfcloud/models/ink_annotations.py index a8ad672..a8015f7 100644 --- a/asposepdfcloud/models/ink_annotations.py +++ b/asposepdfcloud/models/ink_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/ink_annotations_response.py b/asposepdfcloud/models/ink_annotations_response.py index 158d9cb..12ab1f3 100644 --- a/asposepdfcloud/models/ink_annotations_response.py +++ b/asposepdfcloud/models/ink_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/justification.py b/asposepdfcloud/models/justification.py index 2719c4a..d0b1917 100644 --- a/asposepdfcloud/models/justification.py +++ b/asposepdfcloud/models/justification.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/letters_positioning_methods.py b/asposepdfcloud/models/letters_positioning_methods.py index 4a7eb44..5b4f0f1 100644 --- a/asposepdfcloud/models/letters_positioning_methods.py +++ b/asposepdfcloud/models/letters_positioning_methods.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/line_annotation.py b/asposepdfcloud/models/line_annotation.py index ee7595a..91c2a5e 100644 --- a/asposepdfcloud/models/line_annotation.py +++ b/asposepdfcloud/models/line_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/line_annotation_response.py b/asposepdfcloud/models/line_annotation_response.py index be6e6a9..a6caacb 100644 --- a/asposepdfcloud/models/line_annotation_response.py +++ b/asposepdfcloud/models/line_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/line_annotations.py b/asposepdfcloud/models/line_annotations.py index 5570954..a3f1dfb 100644 --- a/asposepdfcloud/models/line_annotations.py +++ b/asposepdfcloud/models/line_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/line_annotations_response.py b/asposepdfcloud/models/line_annotations_response.py index 762d39a..b1281ca 100644 --- a/asposepdfcloud/models/line_annotations_response.py +++ b/asposepdfcloud/models/line_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/line_ending.py b/asposepdfcloud/models/line_ending.py index 9c21a84..7a73f0b 100644 --- a/asposepdfcloud/models/line_ending.py +++ b/asposepdfcloud/models/line_ending.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/line_intent.py b/asposepdfcloud/models/line_intent.py index c3360bd..8df9fc0 100644 --- a/asposepdfcloud/models/line_intent.py +++ b/asposepdfcloud/models/line_intent.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/line_spacing.py b/asposepdfcloud/models/line_spacing.py index c5aa168..25e4001 100644 --- a/asposepdfcloud/models/line_spacing.py +++ b/asposepdfcloud/models/line_spacing.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/link.py b/asposepdfcloud/models/link.py index 4740549..498e235 100644 --- a/asposepdfcloud/models/link.py +++ b/asposepdfcloud/models/link.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/link_action_type.py b/asposepdfcloud/models/link_action_type.py index e4dbe09..408ff36 100644 --- a/asposepdfcloud/models/link_action_type.py +++ b/asposepdfcloud/models/link_action_type.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/link_annotation.py b/asposepdfcloud/models/link_annotation.py index cabc2b3..5158dfa 100644 --- a/asposepdfcloud/models/link_annotation.py +++ b/asposepdfcloud/models/link_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/link_annotation_response.py b/asposepdfcloud/models/link_annotation_response.py index db3a818..1eb5803 100644 --- a/asposepdfcloud/models/link_annotation_response.py +++ b/asposepdfcloud/models/link_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/link_annotations.py b/asposepdfcloud/models/link_annotations.py index 03400b4..fa7c2da 100644 --- a/asposepdfcloud/models/link_annotations.py +++ b/asposepdfcloud/models/link_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/link_annotations_response.py b/asposepdfcloud/models/link_annotations_response.py index e4c1177..83703e7 100644 --- a/asposepdfcloud/models/link_annotations_response.py +++ b/asposepdfcloud/models/link_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/link_element.py b/asposepdfcloud/models/link_element.py index f44e79c..c858df0 100644 --- a/asposepdfcloud/models/link_element.py +++ b/asposepdfcloud/models/link_element.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/link_highlighting_mode.py b/asposepdfcloud/models/link_highlighting_mode.py index 8025765..929d6d7 100644 --- a/asposepdfcloud/models/link_highlighting_mode.py +++ b/asposepdfcloud/models/link_highlighting_mode.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/margin_info.py b/asposepdfcloud/models/margin_info.py index 4c285ed..bbc772c 100644 --- a/asposepdfcloud/models/margin_info.py +++ b/asposepdfcloud/models/margin_info.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/markup_annotation.py b/asposepdfcloud/models/markup_annotation.py index 4a213f3..e463065 100644 --- a/asposepdfcloud/models/markup_annotation.py +++ b/asposepdfcloud/models/markup_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/merge_documents.py b/asposepdfcloud/models/merge_documents.py index 19b7479..c3ecaaf 100644 --- a/asposepdfcloud/models/merge_documents.py +++ b/asposepdfcloud/models/merge_documents.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/movie_annotation.py b/asposepdfcloud/models/movie_annotation.py new file mode 100644 index 0000000..15bbf06 --- /dev/null +++ b/asposepdfcloud/models/movie_annotation.py @@ -0,0 +1,534 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 MovieAnnotation(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]', + 'color': 'Color', + 'contents': 'str', + 'modified': 'str', + 'id': 'str', + 'flags': 'list[AnnotationFlags]', + 'name': 'str', + 'rect': 'Rectangle', + 'page_index': 'int', + 'z_index': 'int', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'title': 'str', + 'file_name': 'str', + 'file_path': 'str' + } + + attribute_map = { + 'links': 'Links', + 'color': 'Color', + 'contents': 'Contents', + 'modified': 'Modified', + 'id': 'Id', + 'flags': 'Flags', + 'name': 'Name', + 'rect': 'Rect', + 'page_index': 'PageIndex', + 'z_index': 'ZIndex', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'title': 'Title', + 'file_name': 'FileName', + 'file_path': 'FilePath' + } + + def __init__(self, links=None, color=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, title=None, file_name=None, file_path=None): + """ + MovieAnnotation - a model defined in Swagger + """ + + self._links = None + self._color = 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._title = None + self._file_name = None + self._file_path = None + + if links is not None: + self.links = links + if color is not None: + self.color = color + 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 title is not None: + self.title = title + if file_name is not None: + self.file_name = file_name + if file_path is not None: + self.file_path = file_path + + @property + def links(self): + """ + Gets the links of this MovieAnnotation. + Link to the document. + + :return: The links of this MovieAnnotation. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this MovieAnnotation. + Link to the document. + + :param links: The links of this MovieAnnotation. + :type: list[Link] + """ + + self._links = links + + @property + def color(self): + """ + Gets the color of this MovieAnnotation. + Color of the annotation. + + :return: The color of this MovieAnnotation. + :rtype: Color + """ + return self._color + + @color.setter + def color(self, color): + """ + Sets the color of this MovieAnnotation. + Color of the annotation. + + :param color: The color of this MovieAnnotation. + :type: Color + """ + + self._color = color + + @property + def contents(self): + """ + Gets the contents of this MovieAnnotation. + Get the annotation content. + + :return: The contents of this MovieAnnotation. + :rtype: str + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this MovieAnnotation. + Get the annotation content. + + :param contents: The contents of this MovieAnnotation. + :type: str + """ + + self._contents = contents + + @property + def modified(self): + """ + Gets the modified of this MovieAnnotation. + The date and time when the annotation was last modified. + + :return: The modified of this MovieAnnotation. + :rtype: str + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this MovieAnnotation. + The date and time when the annotation was last modified. + + :param modified: The modified of this MovieAnnotation. + :type: str + """ + + self._modified = modified + + @property + def id(self): + """ + Gets the id of this MovieAnnotation. + Gets ID of the annotation. + + :return: The id of this MovieAnnotation. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this MovieAnnotation. + Gets ID of the annotation. + + :param id: The id of this MovieAnnotation. + :type: str + """ + + self._id = id + + @property + def flags(self): + """ + Gets the flags of this MovieAnnotation. + Gets Flags of the annotation. + + :return: The flags of this MovieAnnotation. + :rtype: list[AnnotationFlags] + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this MovieAnnotation. + Gets Flags of the annotation. + + :param flags: The flags of this MovieAnnotation. + :type: list[AnnotationFlags] + """ + + self._flags = flags + + @property + def name(self): + """ + Gets the name of this MovieAnnotation. + Gets Name of the annotation. + + :return: The name of this MovieAnnotation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this MovieAnnotation. + Gets Name of the annotation. + + :param name: The name of this MovieAnnotation. + :type: str + """ + + self._name = name + + @property + def rect(self): + """ + Gets the rect of this MovieAnnotation. + Gets Rect of the annotation. + + :return: The rect of this MovieAnnotation. + :rtype: Rectangle + """ + return self._rect + + @rect.setter + def rect(self, rect): + """ + Sets the rect of this MovieAnnotation. + Gets Rect of the annotation. + + :param rect: The rect of this MovieAnnotation. + :type: Rectangle + """ + + self._rect = rect + + @property + def page_index(self): + """ + Gets the page_index of this MovieAnnotation. + Gets PageIndex of the annotation. + + :return: The page_index of this MovieAnnotation. + :rtype: int + """ + return self._page_index + + @page_index.setter + def page_index(self, page_index): + """ + Sets the page_index of this MovieAnnotation. + Gets PageIndex of the annotation. + + :param page_index: The page_index of this MovieAnnotation. + :type: int + """ + + self._page_index = page_index + + @property + def z_index(self): + """ + Gets the z_index of this MovieAnnotation. + Gets ZIndex of the annotation. + + :return: The z_index of this MovieAnnotation. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this MovieAnnotation. + Gets ZIndex of the annotation. + + :param z_index: The z_index of this MovieAnnotation. + :type: int + """ + + self._z_index = z_index + + @property + def horizontal_alignment(self): + """ + Gets the horizontal_alignment of this MovieAnnotation. + Gets HorizontalAlignment of the annotation. + + :return: The horizontal_alignment of this MovieAnnotation. + :rtype: HorizontalAlignment + """ + return self._horizontal_alignment + + @horizontal_alignment.setter + def horizontal_alignment(self, horizontal_alignment): + """ + Sets the horizontal_alignment of this MovieAnnotation. + Gets HorizontalAlignment of the annotation. + + :param horizontal_alignment: The horizontal_alignment of this MovieAnnotation. + :type: HorizontalAlignment + """ + + self._horizontal_alignment = horizontal_alignment + + @property + def vertical_alignment(self): + """ + Gets the vertical_alignment of this MovieAnnotation. + Gets VerticalAlignment of the annotation. + + :return: The vertical_alignment of this MovieAnnotation. + :rtype: VerticalAlignment + """ + return self._vertical_alignment + + @vertical_alignment.setter + def vertical_alignment(self, vertical_alignment): + """ + Sets the vertical_alignment of this MovieAnnotation. + Gets VerticalAlignment of the annotation. + + :param vertical_alignment: The vertical_alignment of this MovieAnnotation. + :type: VerticalAlignment + """ + + self._vertical_alignment = vertical_alignment + + @property + def title(self): + """ + Gets the title of this MovieAnnotation. + Get the annotation title. + + :return: The title of this MovieAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this MovieAnnotation. + Get the annotation title. + + :param title: The title of this MovieAnnotation. + :type: str + """ + + self._title = title + + @property + def file_name(self): + """ + Gets the file_name of this MovieAnnotation. + Gets or sets file specification name. + + :return: The file_name of this MovieAnnotation. + :rtype: str + """ + return self._file_name + + @file_name.setter + def file_name(self, file_name): + """ + Sets the file_name of this MovieAnnotation. + Gets or sets file specification name. + + :param file_name: The file_name of this MovieAnnotation. + :type: str + """ + + self._file_name = file_name + + @property + def file_path(self): + """ + Gets the file_path of this MovieAnnotation. + Sets content file path. + + :return: The file_path of this MovieAnnotation. + :rtype: str + """ + return self._file_path + + @file_path.setter + def file_path(self, file_path): + """ + Sets the file_path of this MovieAnnotation. + Sets content file path. + + :param file_path: The file_path of this MovieAnnotation. + :type: str + """ + + self._file_path = file_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, MovieAnnotation): + 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/movie_annotation_response.py b/asposepdfcloud/models/movie_annotation_response.py new file mode 100644 index 0000000..f964991 --- /dev/null +++ b/asposepdfcloud/models/movie_annotation_response.py @@ -0,0 +1,199 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 MovieAnnotationResponse(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': 'MovieAnnotation' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotation': 'Annotation' + } + + def __init__(self, code=None, status=None, annotation=None): + """ + MovieAnnotationResponse - 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 MovieAnnotationResponse. + Response status code. + + :return: The code of this MovieAnnotationResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this MovieAnnotationResponse. + Response status code. + + :param code: The code of this MovieAnnotationResponse. + :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 MovieAnnotationResponse. + Response status. + + :return: The status of this MovieAnnotationResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this MovieAnnotationResponse. + Response status. + + :param status: The status of this MovieAnnotationResponse. + :type: str + """ + + self._status = status + + @property + def annotation(self): + """ + Gets the annotation of this MovieAnnotationResponse. + Movie annotation object + + :return: The annotation of this MovieAnnotationResponse. + :rtype: MovieAnnotation + """ + return self._annotation + + @annotation.setter + def annotation(self, annotation): + """ + Sets the annotation of this MovieAnnotationResponse. + Movie annotation object + + :param annotation: The annotation of this MovieAnnotationResponse. + :type: MovieAnnotation + """ + + 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, MovieAnnotationResponse): + 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/movie_annotations.py b/asposepdfcloud/models/movie_annotations.py new file mode 100644 index 0000000..3254e74 --- /dev/null +++ b/asposepdfcloud/models/movie_annotations.py @@ -0,0 +1,170 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 MovieAnnotations(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[MovieAnnotation]' + } + + attribute_map = { + 'links': 'Links', + 'list': 'List' + } + + def __init__(self, links=None, list=None): + """ + MovieAnnotations - 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 MovieAnnotations. + Link to the document. + + :return: The links of this MovieAnnotations. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this MovieAnnotations. + Link to the document. + + :param links: The links of this MovieAnnotations. + :type: list[Link] + """ + + self._links = links + + @property + def list(self): + """ + Gets the list of this MovieAnnotations. + List of movie annotations. + + :return: The list of this MovieAnnotations. + :rtype: list[MovieAnnotation] + """ + return self._list + + @list.setter + def list(self, list): + """ + Sets the list of this MovieAnnotations. + List of movie annotations. + + :param list: The list of this MovieAnnotations. + :type: list[MovieAnnotation] + """ + + 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, MovieAnnotations): + 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/movie_annotations_response.py b/asposepdfcloud/models/movie_annotations_response.py new file mode 100644 index 0000000..6cb5464 --- /dev/null +++ b/asposepdfcloud/models/movie_annotations_response.py @@ -0,0 +1,199 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 MovieAnnotationsResponse(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': 'MovieAnnotations' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotations': 'Annotations' + } + + def __init__(self, code=None, status=None, annotations=None): + """ + MovieAnnotationsResponse - 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 MovieAnnotationsResponse. + Response status code. + + :return: The code of this MovieAnnotationsResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this MovieAnnotationsResponse. + Response status code. + + :param code: The code of this MovieAnnotationsResponse. + :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 MovieAnnotationsResponse. + Response status. + + :return: The status of this MovieAnnotationsResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this MovieAnnotationsResponse. + Response status. + + :param status: The status of this MovieAnnotationsResponse. + :type: str + """ + + self._status = status + + @property + def annotations(self): + """ + Gets the annotations of this MovieAnnotationsResponse. + Movie annotations object + + :return: The annotations of this MovieAnnotationsResponse. + :rtype: MovieAnnotations + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this MovieAnnotationsResponse. + Movie annotations object + + :param annotations: The annotations of this MovieAnnotationsResponse. + :type: MovieAnnotations + """ + + 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, MovieAnnotationsResponse): + 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/optimize_options.py b/asposepdfcloud/models/optimize_options.py index 0b3efb3..cf8305a 100644 --- a/asposepdfcloud/models/optimize_options.py +++ b/asposepdfcloud/models/optimize_options.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/page.py b/asposepdfcloud/models/page.py index a38c43b..6cda571 100644 --- a/asposepdfcloud/models/page.py +++ b/asposepdfcloud/models/page.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/page_word_count.py b/asposepdfcloud/models/page_word_count.py index 2941f38..4419230 100644 --- a/asposepdfcloud/models/page_word_count.py +++ b/asposepdfcloud/models/page_word_count.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/pages.py b/asposepdfcloud/models/pages.py index 33380d2..b572260 100644 --- a/asposepdfcloud/models/pages.py +++ b/asposepdfcloud/models/pages.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/paragraph.py b/asposepdfcloud/models/paragraph.py index 9aca9eb..6b8d8bf 100644 --- a/asposepdfcloud/models/paragraph.py +++ b/asposepdfcloud/models/paragraph.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/parts_embedding_modes.py b/asposepdfcloud/models/parts_embedding_modes.py index f138397..05875a1 100644 --- a/asposepdfcloud/models/parts_embedding_modes.py +++ b/asposepdfcloud/models/parts_embedding_modes.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/pdf_a_type.py b/asposepdfcloud/models/pdf_a_type.py index d122990..4932868 100644 --- a/asposepdfcloud/models/pdf_a_type.py +++ b/asposepdfcloud/models/pdf_a_type.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/point.py b/asposepdfcloud/models/point.py index 9ebe951..a0105e6 100644 --- a/asposepdfcloud/models/point.py +++ b/asposepdfcloud/models/point.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/poly_annotation.py b/asposepdfcloud/models/poly_annotation.py index 23add53..ba87ce8 100644 --- a/asposepdfcloud/models/poly_annotation.py +++ b/asposepdfcloud/models/poly_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/poly_intent.py b/asposepdfcloud/models/poly_intent.py index 378f01b..5fcbf08 100644 --- a/asposepdfcloud/models/poly_intent.py +++ b/asposepdfcloud/models/poly_intent.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/poly_line_annotation.py b/asposepdfcloud/models/poly_line_annotation.py index 610bc9f..91cb8fd 100644 --- a/asposepdfcloud/models/poly_line_annotation.py +++ b/asposepdfcloud/models/poly_line_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/poly_line_annotation_response.py b/asposepdfcloud/models/poly_line_annotation_response.py index 346e24a..221d396 100644 --- a/asposepdfcloud/models/poly_line_annotation_response.py +++ b/asposepdfcloud/models/poly_line_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/poly_line_annotations.py b/asposepdfcloud/models/poly_line_annotations.py index f5da436..63fa719 100644 --- a/asposepdfcloud/models/poly_line_annotations.py +++ b/asposepdfcloud/models/poly_line_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/poly_line_annotations_response.py b/asposepdfcloud/models/poly_line_annotations_response.py index a4f8a78..bf44f68 100644 --- a/asposepdfcloud/models/poly_line_annotations_response.py +++ b/asposepdfcloud/models/poly_line_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/polygon_annotation.py b/asposepdfcloud/models/polygon_annotation.py index e009f67..57486b1 100644 --- a/asposepdfcloud/models/polygon_annotation.py +++ b/asposepdfcloud/models/polygon_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/polygon_annotation_response.py b/asposepdfcloud/models/polygon_annotation_response.py index 9acda19..735ec24 100644 --- a/asposepdfcloud/models/polygon_annotation_response.py +++ b/asposepdfcloud/models/polygon_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/polygon_annotations.py b/asposepdfcloud/models/polygon_annotations.py index ae295f9..d53e7ba 100644 --- a/asposepdfcloud/models/polygon_annotations.py +++ b/asposepdfcloud/models/polygon_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/polygon_annotations_response.py b/asposepdfcloud/models/polygon_annotations_response.py index 870c711..4404af5 100644 --- a/asposepdfcloud/models/polygon_annotations_response.py +++ b/asposepdfcloud/models/polygon_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/popup_annotation.py b/asposepdfcloud/models/popup_annotation.py index 7a09f0c..c4a297b 100644 --- a/asposepdfcloud/models/popup_annotation.py +++ b/asposepdfcloud/models/popup_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/popup_annotation_response.py b/asposepdfcloud/models/popup_annotation_response.py index 3e1bea0..ed5fc69 100644 --- a/asposepdfcloud/models/popup_annotation_response.py +++ b/asposepdfcloud/models/popup_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/popup_annotation_with_parent.py b/asposepdfcloud/models/popup_annotation_with_parent.py index 8e00891..30538da 100644 --- a/asposepdfcloud/models/popup_annotation_with_parent.py +++ b/asposepdfcloud/models/popup_annotation_with_parent.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/popup_annotations.py b/asposepdfcloud/models/popup_annotations.py index 17faf10..0498dce 100644 --- a/asposepdfcloud/models/popup_annotations.py +++ b/asposepdfcloud/models/popup_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/popup_annotations_response.py b/asposepdfcloud/models/popup_annotations_response.py index 500f2a3..06fa2d6 100644 --- a/asposepdfcloud/models/popup_annotations_response.py +++ b/asposepdfcloud/models/popup_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/raster_images_saving_modes.py b/asposepdfcloud/models/raster_images_saving_modes.py index 8c4fe57..758a7dc 100644 --- a/asposepdfcloud/models/raster_images_saving_modes.py +++ b/asposepdfcloud/models/raster_images_saving_modes.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/rectangle.py b/asposepdfcloud/models/rectangle.py index 6bcf6aa..ab6ea01 100644 --- a/asposepdfcloud/models/rectangle.py +++ b/asposepdfcloud/models/rectangle.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/redaction_annotation.py b/asposepdfcloud/models/redaction_annotation.py new file mode 100644 index 0000000..862208d --- /dev/null +++ b/asposepdfcloud/models/redaction_annotation.py @@ -0,0 +1,618 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 RedactionAnnotation(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]', + 'color': 'Color', + 'contents': 'str', + 'modified': 'str', + 'id': 'str', + 'flags': 'list[AnnotationFlags]', + 'name': 'str', + 'rect': 'Rectangle', + 'page_index': 'int', + 'z_index': 'int', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'quad_point': 'list[Point]', + 'fill_color': 'Color', + 'border_color': 'Color', + 'overlay_text': 'str', + 'repeat': 'bool', + 'text_alignment': 'HorizontalAlignment' + } + + attribute_map = { + 'links': 'Links', + 'color': 'Color', + 'contents': 'Contents', + 'modified': 'Modified', + 'id': 'Id', + 'flags': 'Flags', + 'name': 'Name', + 'rect': 'Rect', + 'page_index': 'PageIndex', + 'z_index': 'ZIndex', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'quad_point': 'QuadPoint', + 'fill_color': 'FillColor', + 'border_color': 'BorderColor', + 'overlay_text': 'OverlayText', + 'repeat': 'Repeat', + 'text_alignment': 'TextAlignment' + } + + def __init__(self, links=None, color=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, quad_point=None, fill_color=None, border_color=None, overlay_text=None, repeat=None, text_alignment=None): + """ + RedactionAnnotation - a model defined in Swagger + """ + + self._links = None + self._color = 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._quad_point = None + self._fill_color = None + self._border_color = None + self._overlay_text = None + self._repeat = None + self._text_alignment = None + + if links is not None: + self.links = links + if color is not None: + self.color = color + 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 quad_point is not None: + self.quad_point = quad_point + if fill_color is not None: + self.fill_color = fill_color + if border_color is not None: + self.border_color = border_color + if overlay_text is not None: + self.overlay_text = overlay_text + if repeat is not None: + self.repeat = repeat + if text_alignment is not None: + self.text_alignment = text_alignment + + @property + def links(self): + """ + Gets the links of this RedactionAnnotation. + Link to the document. + + :return: The links of this RedactionAnnotation. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this RedactionAnnotation. + Link to the document. + + :param links: The links of this RedactionAnnotation. + :type: list[Link] + """ + + self._links = links + + @property + def color(self): + """ + Gets the color of this RedactionAnnotation. + Color of the annotation. + + :return: The color of this RedactionAnnotation. + :rtype: Color + """ + return self._color + + @color.setter + def color(self, color): + """ + Sets the color of this RedactionAnnotation. + Color of the annotation. + + :param color: The color of this RedactionAnnotation. + :type: Color + """ + + self._color = color + + @property + def contents(self): + """ + Gets the contents of this RedactionAnnotation. + Get the annotation content. + + :return: The contents of this RedactionAnnotation. + :rtype: str + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this RedactionAnnotation. + Get the annotation content. + + :param contents: The contents of this RedactionAnnotation. + :type: str + """ + + self._contents = contents + + @property + def modified(self): + """ + Gets the modified of this RedactionAnnotation. + The date and time when the annotation was last modified. + + :return: The modified of this RedactionAnnotation. + :rtype: str + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this RedactionAnnotation. + The date and time when the annotation was last modified. + + :param modified: The modified of this RedactionAnnotation. + :type: str + """ + + self._modified = modified + + @property + def id(self): + """ + Gets the id of this RedactionAnnotation. + Gets ID of the annotation. + + :return: The id of this RedactionAnnotation. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this RedactionAnnotation. + Gets ID of the annotation. + + :param id: The id of this RedactionAnnotation. + :type: str + """ + + self._id = id + + @property + def flags(self): + """ + Gets the flags of this RedactionAnnotation. + Gets Flags of the annotation. + + :return: The flags of this RedactionAnnotation. + :rtype: list[AnnotationFlags] + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this RedactionAnnotation. + Gets Flags of the annotation. + + :param flags: The flags of this RedactionAnnotation. + :type: list[AnnotationFlags] + """ + + self._flags = flags + + @property + def name(self): + """ + Gets the name of this RedactionAnnotation. + Gets Name of the annotation. + + :return: The name of this RedactionAnnotation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this RedactionAnnotation. + Gets Name of the annotation. + + :param name: The name of this RedactionAnnotation. + :type: str + """ + + self._name = name + + @property + def rect(self): + """ + Gets the rect of this RedactionAnnotation. + Gets Rect of the annotation. + + :return: The rect of this RedactionAnnotation. + :rtype: Rectangle + """ + return self._rect + + @rect.setter + def rect(self, rect): + """ + Sets the rect of this RedactionAnnotation. + Gets Rect of the annotation. + + :param rect: The rect of this RedactionAnnotation. + :type: Rectangle + """ + + self._rect = rect + + @property + def page_index(self): + """ + Gets the page_index of this RedactionAnnotation. + Gets PageIndex of the annotation. + + :return: The page_index of this RedactionAnnotation. + :rtype: int + """ + return self._page_index + + @page_index.setter + def page_index(self, page_index): + """ + Sets the page_index of this RedactionAnnotation. + Gets PageIndex of the annotation. + + :param page_index: The page_index of this RedactionAnnotation. + :type: int + """ + + self._page_index = page_index + + @property + def z_index(self): + """ + Gets the z_index of this RedactionAnnotation. + Gets ZIndex of the annotation. + + :return: The z_index of this RedactionAnnotation. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this RedactionAnnotation. + Gets ZIndex of the annotation. + + :param z_index: The z_index of this RedactionAnnotation. + :type: int + """ + + self._z_index = z_index + + @property + def horizontal_alignment(self): + """ + Gets the horizontal_alignment of this RedactionAnnotation. + Gets HorizontalAlignment of the annotation. + + :return: The horizontal_alignment of this RedactionAnnotation. + :rtype: HorizontalAlignment + """ + return self._horizontal_alignment + + @horizontal_alignment.setter + def horizontal_alignment(self, horizontal_alignment): + """ + Sets the horizontal_alignment of this RedactionAnnotation. + Gets HorizontalAlignment of the annotation. + + :param horizontal_alignment: The horizontal_alignment of this RedactionAnnotation. + :type: HorizontalAlignment + """ + + self._horizontal_alignment = horizontal_alignment + + @property + def vertical_alignment(self): + """ + Gets the vertical_alignment of this RedactionAnnotation. + Gets VerticalAlignment of the annotation. + + :return: The vertical_alignment of this RedactionAnnotation. + :rtype: VerticalAlignment + """ + return self._vertical_alignment + + @vertical_alignment.setter + def vertical_alignment(self, vertical_alignment): + """ + Sets the vertical_alignment of this RedactionAnnotation. + Gets VerticalAlignment of the annotation. + + :param vertical_alignment: The vertical_alignment of this RedactionAnnotation. + :type: VerticalAlignment + """ + + self._vertical_alignment = vertical_alignment + + @property + def quad_point(self): + """ + Gets the quad_point of this RedactionAnnotation. + An array of 8xN numbers specifying the coordinates of content region that is intended to be removed. + + :return: The quad_point of this RedactionAnnotation. + :rtype: list[Point] + """ + return self._quad_point + + @quad_point.setter + def quad_point(self, quad_point): + """ + Sets the quad_point of this RedactionAnnotation. + An array of 8xN numbers specifying the coordinates of content region that is intended to be removed. + + :param quad_point: The quad_point of this RedactionAnnotation. + :type: list[Point] + """ + + self._quad_point = quad_point + + @property + def fill_color(self): + """ + Gets the fill_color of this RedactionAnnotation. + Gets or sets color to fill annotation. + + :return: The fill_color of this RedactionAnnotation. + :rtype: Color + """ + return self._fill_color + + @fill_color.setter + def fill_color(self, fill_color): + """ + Sets the fill_color of this RedactionAnnotation. + Gets or sets color to fill annotation. + + :param fill_color: The fill_color of this RedactionAnnotation. + :type: Color + """ + + self._fill_color = fill_color + + @property + def border_color(self): + """ + Gets the border_color of this RedactionAnnotation. + Gets or sets color of border which is drawn when redaction is not active. + + :return: The border_color of this RedactionAnnotation. + :rtype: Color + """ + return self._border_color + + @border_color.setter + def border_color(self, border_color): + """ + Sets the border_color of this RedactionAnnotation. + Gets or sets color of border which is drawn when redaction is not active. + + :param border_color: The border_color of this RedactionAnnotation. + :type: Color + """ + + self._border_color = border_color + + @property + def overlay_text(self): + """ + Gets the overlay_text of this RedactionAnnotation. + Text to print on redact annotation. + + :return: The overlay_text of this RedactionAnnotation. + :rtype: str + """ + return self._overlay_text + + @overlay_text.setter + def overlay_text(self, overlay_text): + """ + Sets the overlay_text of this RedactionAnnotation. + Text to print on redact annotation. + + :param overlay_text: The overlay_text of this RedactionAnnotation. + :type: str + """ + + self._overlay_text = overlay_text + + @property + def repeat(self): + """ + Gets the repeat of this RedactionAnnotation. + If true overlay text will be repated on the annotation. + + :return: The repeat of this RedactionAnnotation. + :rtype: bool + """ + return self._repeat + + @repeat.setter + def repeat(self, repeat): + """ + Sets the repeat of this RedactionAnnotation. + If true overlay text will be repated on the annotation. + + :param repeat: The repeat of this RedactionAnnotation. + :type: bool + """ + + self._repeat = repeat + + @property + def text_alignment(self): + """ + Gets the text_alignment of this RedactionAnnotation. + Gets or sets. Alignment of Overlay Text. + + :return: The text_alignment of this RedactionAnnotation. + :rtype: HorizontalAlignment + """ + return self._text_alignment + + @text_alignment.setter + def text_alignment(self, text_alignment): + """ + Sets the text_alignment of this RedactionAnnotation. + Gets or sets. Alignment of Overlay Text. + + :param text_alignment: The text_alignment of this RedactionAnnotation. + :type: HorizontalAlignment + """ + + self._text_alignment = text_alignment + + 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, RedactionAnnotation): + 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/redaction_annotation_response.py b/asposepdfcloud/models/redaction_annotation_response.py new file mode 100644 index 0000000..0c759f7 --- /dev/null +++ b/asposepdfcloud/models/redaction_annotation_response.py @@ -0,0 +1,199 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 RedactionAnnotationResponse(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': 'RedactionAnnotation' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotation': 'Annotation' + } + + def __init__(self, code=None, status=None, annotation=None): + """ + RedactionAnnotationResponse - 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 RedactionAnnotationResponse. + Response status code. + + :return: The code of this RedactionAnnotationResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this RedactionAnnotationResponse. + Response status code. + + :param code: The code of this RedactionAnnotationResponse. + :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 RedactionAnnotationResponse. + Response status. + + :return: The status of this RedactionAnnotationResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this RedactionAnnotationResponse. + Response status. + + :param status: The status of this RedactionAnnotationResponse. + :type: str + """ + + self._status = status + + @property + def annotation(self): + """ + Gets the annotation of this RedactionAnnotationResponse. + Redaction annotation object + + :return: The annotation of this RedactionAnnotationResponse. + :rtype: RedactionAnnotation + """ + return self._annotation + + @annotation.setter + def annotation(self, annotation): + """ + Sets the annotation of this RedactionAnnotationResponse. + Redaction annotation object + + :param annotation: The annotation of this RedactionAnnotationResponse. + :type: RedactionAnnotation + """ + + 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, RedactionAnnotationResponse): + 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/redaction_annotations.py b/asposepdfcloud/models/redaction_annotations.py new file mode 100644 index 0000000..0e6dcee --- /dev/null +++ b/asposepdfcloud/models/redaction_annotations.py @@ -0,0 +1,170 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 RedactionAnnotations(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[RedactionAnnotation]' + } + + attribute_map = { + 'links': 'Links', + 'list': 'List' + } + + def __init__(self, links=None, list=None): + """ + RedactionAnnotations - 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 RedactionAnnotations. + Link to the document. + + :return: The links of this RedactionAnnotations. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this RedactionAnnotations. + Link to the document. + + :param links: The links of this RedactionAnnotations. + :type: list[Link] + """ + + self._links = links + + @property + def list(self): + """ + Gets the list of this RedactionAnnotations. + List of redaction annotations. + + :return: The list of this RedactionAnnotations. + :rtype: list[RedactionAnnotation] + """ + return self._list + + @list.setter + def list(self, list): + """ + Sets the list of this RedactionAnnotations. + List of redaction annotations. + + :param list: The list of this RedactionAnnotations. + :type: list[RedactionAnnotation] + """ + + 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, RedactionAnnotations): + 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/redaction_annotations_response.py b/asposepdfcloud/models/redaction_annotations_response.py new file mode 100644 index 0000000..ac7166a --- /dev/null +++ b/asposepdfcloud/models/redaction_annotations_response.py @@ -0,0 +1,199 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 RedactionAnnotationsResponse(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': 'RedactionAnnotations' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotations': 'Annotations' + } + + def __init__(self, code=None, status=None, annotations=None): + """ + RedactionAnnotationsResponse - 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 RedactionAnnotationsResponse. + Response status code. + + :return: The code of this RedactionAnnotationsResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this RedactionAnnotationsResponse. + Response status code. + + :param code: The code of this RedactionAnnotationsResponse. + :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 RedactionAnnotationsResponse. + Response status. + + :return: The status of this RedactionAnnotationsResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this RedactionAnnotationsResponse. + Response status. + + :param status: The status of this RedactionAnnotationsResponse. + :type: str + """ + + self._status = status + + @property + def annotations(self): + """ + Gets the annotations of this RedactionAnnotationsResponse. + Ink annotations object + + :return: The annotations of this RedactionAnnotationsResponse. + :rtype: RedactionAnnotations + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this RedactionAnnotationsResponse. + Ink annotations object + + :param annotations: The annotations of this RedactionAnnotationsResponse. + :type: RedactionAnnotations + """ + + 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, RedactionAnnotationsResponse): + 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/rotation.py b/asposepdfcloud/models/rotation.py index 500f25e..a0e258f 100644 --- a/asposepdfcloud/models/rotation.py +++ b/asposepdfcloud/models/rotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/segment.py b/asposepdfcloud/models/segment.py index 3f3008b..3ff76f7 100644 --- a/asposepdfcloud/models/segment.py +++ b/asposepdfcloud/models/segment.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/shape_type.py b/asposepdfcloud/models/shape_type.py index 4089c08..524e6b1 100644 --- a/asposepdfcloud/models/shape_type.py +++ b/asposepdfcloud/models/shape_type.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/signature.py b/asposepdfcloud/models/signature.py index 9097f1e..cd17ed7 100644 --- a/asposepdfcloud/models/signature.py +++ b/asposepdfcloud/models/signature.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/signature_type.py b/asposepdfcloud/models/signature_type.py index 9091a6b..80f8c7b 100644 --- a/asposepdfcloud/models/signature_type.py +++ b/asposepdfcloud/models/signature_type.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/signature_verify_response.py b/asposepdfcloud/models/signature_verify_response.py index 6af4723..21b58bf 100644 --- a/asposepdfcloud/models/signature_verify_response.py +++ b/asposepdfcloud/models/signature_verify_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/sound_annotation.py b/asposepdfcloud/models/sound_annotation.py new file mode 100644 index 0000000..1af51a1 --- /dev/null +++ b/asposepdfcloud/models/sound_annotation.py @@ -0,0 +1,730 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 SoundAnnotation(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]', + 'color': 'Color', + 'contents': 'str', + 'modified': 'str', + 'id': 'str', + 'flags': 'list[AnnotationFlags]', + 'name': 'str', + 'rect': 'Rectangle', + 'page_index': 'int', + 'z_index': 'int', + 'horizontal_alignment': 'HorizontalAlignment', + 'vertical_alignment': 'VerticalAlignment', + 'creation_date': 'str', + 'subject': 'str', + 'title': 'str', + 'rich_text': 'str', + 'file_path': 'str', + 'icon': 'SoundIcon', + 'rate': 'int', + 'channels': 'int', + 'bits': 'int', + 'encoding': 'SoundEncoding' + } + + attribute_map = { + 'links': 'Links', + 'color': 'Color', + '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', + 'file_path': 'FilePath', + 'icon': 'Icon', + 'rate': 'Rate', + 'channels': 'Channels', + 'bits': 'Bits', + 'encoding': 'Encoding' + } + + def __init__(self, links=None, color=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, file_path=None, icon=None, rate=None, channels=None, bits=None, encoding=None): + """ + SoundAnnotation - a model defined in Swagger + """ + + self._links = None + self._color = 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._file_path = None + self._icon = None + self._rate = None + self._channels = None + self._bits = None + self._encoding = None + + if links is not None: + self.links = links + if color is not None: + self.color = color + 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 file_path is not None: + self.file_path = file_path + if icon is not None: + self.icon = icon + if rate is not None: + self.rate = rate + if channels is not None: + self.channels = channels + if bits is not None: + self.bits = bits + if encoding is not None: + self.encoding = encoding + + @property + def links(self): + """ + Gets the links of this SoundAnnotation. + Link to the document. + + :return: The links of this SoundAnnotation. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this SoundAnnotation. + Link to the document. + + :param links: The links of this SoundAnnotation. + :type: list[Link] + """ + + self._links = links + + @property + def color(self): + """ + Gets the color of this SoundAnnotation. + Color of the annotation. + + :return: The color of this SoundAnnotation. + :rtype: Color + """ + return self._color + + @color.setter + def color(self, color): + """ + Sets the color of this SoundAnnotation. + Color of the annotation. + + :param color: The color of this SoundAnnotation. + :type: Color + """ + + self._color = color + + @property + def contents(self): + """ + Gets the contents of this SoundAnnotation. + Get the annotation content. + + :return: The contents of this SoundAnnotation. + :rtype: str + """ + return self._contents + + @contents.setter + def contents(self, contents): + """ + Sets the contents of this SoundAnnotation. + Get the annotation content. + + :param contents: The contents of this SoundAnnotation. + :type: str + """ + + self._contents = contents + + @property + def modified(self): + """ + Gets the modified of this SoundAnnotation. + The date and time when the annotation was last modified. + + :return: The modified of this SoundAnnotation. + :rtype: str + """ + return self._modified + + @modified.setter + def modified(self, modified): + """ + Sets the modified of this SoundAnnotation. + The date and time when the annotation was last modified. + + :param modified: The modified of this SoundAnnotation. + :type: str + """ + + self._modified = modified + + @property + def id(self): + """ + Gets the id of this SoundAnnotation. + Gets ID of the annotation. + + :return: The id of this SoundAnnotation. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this SoundAnnotation. + Gets ID of the annotation. + + :param id: The id of this SoundAnnotation. + :type: str + """ + + self._id = id + + @property + def flags(self): + """ + Gets the flags of this SoundAnnotation. + Gets Flags of the annotation. + + :return: The flags of this SoundAnnotation. + :rtype: list[AnnotationFlags] + """ + return self._flags + + @flags.setter + def flags(self, flags): + """ + Sets the flags of this SoundAnnotation. + Gets Flags of the annotation. + + :param flags: The flags of this SoundAnnotation. + :type: list[AnnotationFlags] + """ + + self._flags = flags + + @property + def name(self): + """ + Gets the name of this SoundAnnotation. + Gets Name of the annotation. + + :return: The name of this SoundAnnotation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this SoundAnnotation. + Gets Name of the annotation. + + :param name: The name of this SoundAnnotation. + :type: str + """ + + self._name = name + + @property + def rect(self): + """ + Gets the rect of this SoundAnnotation. + Gets Rect of the annotation. + + :return: The rect of this SoundAnnotation. + :rtype: Rectangle + """ + return self._rect + + @rect.setter + def rect(self, rect): + """ + Sets the rect of this SoundAnnotation. + Gets Rect of the annotation. + + :param rect: The rect of this SoundAnnotation. + :type: Rectangle + """ + + self._rect = rect + + @property + def page_index(self): + """ + Gets the page_index of this SoundAnnotation. + Gets PageIndex of the annotation. + + :return: The page_index of this SoundAnnotation. + :rtype: int + """ + return self._page_index + + @page_index.setter + def page_index(self, page_index): + """ + Sets the page_index of this SoundAnnotation. + Gets PageIndex of the annotation. + + :param page_index: The page_index of this SoundAnnotation. + :type: int + """ + + self._page_index = page_index + + @property + def z_index(self): + """ + Gets the z_index of this SoundAnnotation. + Gets ZIndex of the annotation. + + :return: The z_index of this SoundAnnotation. + :rtype: int + """ + return self._z_index + + @z_index.setter + def z_index(self, z_index): + """ + Sets the z_index of this SoundAnnotation. + Gets ZIndex of the annotation. + + :param z_index: The z_index of this SoundAnnotation. + :type: int + """ + + self._z_index = z_index + + @property + def horizontal_alignment(self): + """ + Gets the horizontal_alignment of this SoundAnnotation. + Gets HorizontalAlignment of the annotation. + + :return: The horizontal_alignment of this SoundAnnotation. + :rtype: HorizontalAlignment + """ + return self._horizontal_alignment + + @horizontal_alignment.setter + def horizontal_alignment(self, horizontal_alignment): + """ + Sets the horizontal_alignment of this SoundAnnotation. + Gets HorizontalAlignment of the annotation. + + :param horizontal_alignment: The horizontal_alignment of this SoundAnnotation. + :type: HorizontalAlignment + """ + + self._horizontal_alignment = horizontal_alignment + + @property + def vertical_alignment(self): + """ + Gets the vertical_alignment of this SoundAnnotation. + Gets VerticalAlignment of the annotation. + + :return: The vertical_alignment of this SoundAnnotation. + :rtype: VerticalAlignment + """ + return self._vertical_alignment + + @vertical_alignment.setter + def vertical_alignment(self, vertical_alignment): + """ + Sets the vertical_alignment of this SoundAnnotation. + Gets VerticalAlignment of the annotation. + + :param vertical_alignment: The vertical_alignment of this SoundAnnotation. + :type: VerticalAlignment + """ + + self._vertical_alignment = vertical_alignment + + @property + def creation_date(self): + """ + Gets the creation_date of this SoundAnnotation. + The date and time when the annotation was created. + + :return: The creation_date of this SoundAnnotation. + :rtype: str + """ + return self._creation_date + + @creation_date.setter + def creation_date(self, creation_date): + """ + Sets the creation_date of this SoundAnnotation. + The date and time when the annotation was created. + + :param creation_date: The creation_date of this SoundAnnotation. + :type: str + """ + + self._creation_date = creation_date + + @property + def subject(self): + """ + Gets the subject of this SoundAnnotation. + Get the annotation subject. + + :return: The subject of this SoundAnnotation. + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """ + Sets the subject of this SoundAnnotation. + Get the annotation subject. + + :param subject: The subject of this SoundAnnotation. + :type: str + """ + + self._subject = subject + + @property + def title(self): + """ + Gets the title of this SoundAnnotation. + Get the annotation title. + + :return: The title of this SoundAnnotation. + :rtype: str + """ + return self._title + + @title.setter + def title(self, title): + """ + Sets the title of this SoundAnnotation. + Get the annotation title. + + :param title: The title of this SoundAnnotation. + :type: str + """ + + self._title = title + + @property + def rich_text(self): + """ + Gets the rich_text of this SoundAnnotation. + Get the annotation RichText. + + :return: The rich_text of this SoundAnnotation. + :rtype: str + """ + return self._rich_text + + @rich_text.setter + def rich_text(self, rich_text): + """ + Sets the rich_text of this SoundAnnotation. + Get the annotation RichText. + + :param rich_text: The rich_text of this SoundAnnotation. + :type: str + """ + + self._rich_text = rich_text + + @property + def file_path(self): + """ + Gets the file_path of this SoundAnnotation. + A sound file path defining the sound to be played when the annotation is activated. + + :return: The file_path of this SoundAnnotation. + :rtype: str + """ + return self._file_path + + @file_path.setter + def file_path(self, file_path): + """ + Sets the file_path of this SoundAnnotation. + A sound file path defining the sound to be played when the annotation is activated. + + :param file_path: The file_path of this SoundAnnotation. + :type: str + """ + + self._file_path = file_path + + @property + def icon(self): + """ + Gets the icon of this SoundAnnotation. + Gets or sets an icon to be used in displaying the annotation. + + :return: The icon of this SoundAnnotation. + :rtype: SoundIcon + """ + return self._icon + + @icon.setter + def icon(self, icon): + """ + Sets the icon of this SoundAnnotation. + Gets or sets an icon to be used in displaying the annotation. + + :param icon: The icon of this SoundAnnotation. + :type: SoundIcon + """ + + self._icon = icon + + @property + def rate(self): + """ + Gets the rate of this SoundAnnotation. + Gets or sets the sampling rate, in samples per second. + + :return: The rate of this SoundAnnotation. + :rtype: int + """ + return self._rate + + @rate.setter + def rate(self, rate): + """ + Sets the rate of this SoundAnnotation. + Gets or sets the sampling rate, in samples per second. + + :param rate: The rate of this SoundAnnotation. + :type: int + """ + + self._rate = rate + + @property + def channels(self): + """ + Gets the channels of this SoundAnnotation. + Gets or sets the number of sound channels. + + :return: The channels of this SoundAnnotation. + :rtype: int + """ + return self._channels + + @channels.setter + def channels(self, channels): + """ + Sets the channels of this SoundAnnotation. + Gets or sets the number of sound channels. + + :param channels: The channels of this SoundAnnotation. + :type: int + """ + + self._channels = channels + + @property + def bits(self): + """ + Gets the bits of this SoundAnnotation. + Gets or sets the number of bits per sample value per channel. + + :return: The bits of this SoundAnnotation. + :rtype: int + """ + return self._bits + + @bits.setter + def bits(self, bits): + """ + Sets the bits of this SoundAnnotation. + Gets or sets the number of bits per sample value per channel. + + :param bits: The bits of this SoundAnnotation. + :type: int + """ + + self._bits = bits + + @property + def encoding(self): + """ + Gets the encoding of this SoundAnnotation. + Gets or sets the encoding format for the sample data. + + :return: The encoding of this SoundAnnotation. + :rtype: SoundEncoding + """ + return self._encoding + + @encoding.setter + def encoding(self, encoding): + """ + Sets the encoding of this SoundAnnotation. + Gets or sets the encoding format for the sample data. + + :param encoding: The encoding of this SoundAnnotation. + :type: SoundEncoding + """ + + self._encoding = encoding + + 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, SoundAnnotation): + 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/sound_annotation_response.py b/asposepdfcloud/models/sound_annotation_response.py new file mode 100644 index 0000000..08688da --- /dev/null +++ b/asposepdfcloud/models/sound_annotation_response.py @@ -0,0 +1,199 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 SoundAnnotationResponse(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': 'SoundAnnotation' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotation': 'Annotation' + } + + def __init__(self, code=None, status=None, annotation=None): + """ + SoundAnnotationResponse - 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 SoundAnnotationResponse. + Response status code. + + :return: The code of this SoundAnnotationResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this SoundAnnotationResponse. + Response status code. + + :param code: The code of this SoundAnnotationResponse. + :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 SoundAnnotationResponse. + Response status. + + :return: The status of this SoundAnnotationResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this SoundAnnotationResponse. + Response status. + + :param status: The status of this SoundAnnotationResponse. + :type: str + """ + + self._status = status + + @property + def annotation(self): + """ + Gets the annotation of this SoundAnnotationResponse. + Sound annotation object + + :return: The annotation of this SoundAnnotationResponse. + :rtype: SoundAnnotation + """ + return self._annotation + + @annotation.setter + def annotation(self, annotation): + """ + Sets the annotation of this SoundAnnotationResponse. + Sound annotation object + + :param annotation: The annotation of this SoundAnnotationResponse. + :type: SoundAnnotation + """ + + 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, SoundAnnotationResponse): + 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/sound_annotations.py b/asposepdfcloud/models/sound_annotations.py new file mode 100644 index 0000000..e0a252d --- /dev/null +++ b/asposepdfcloud/models/sound_annotations.py @@ -0,0 +1,170 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 SoundAnnotations(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[SoundAnnotation]' + } + + attribute_map = { + 'links': 'Links', + 'list': 'List' + } + + def __init__(self, links=None, list=None): + """ + SoundAnnotations - 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 SoundAnnotations. + Link to the document. + + :return: The links of this SoundAnnotations. + :rtype: list[Link] + """ + return self._links + + @links.setter + def links(self, links): + """ + Sets the links of this SoundAnnotations. + Link to the document. + + :param links: The links of this SoundAnnotations. + :type: list[Link] + """ + + self._links = links + + @property + def list(self): + """ + Gets the list of this SoundAnnotations. + List of Sound annotations. + + :return: The list of this SoundAnnotations. + :rtype: list[SoundAnnotation] + """ + return self._list + + @list.setter + def list(self, list): + """ + Sets the list of this SoundAnnotations. + List of Sound annotations. + + :param list: The list of this SoundAnnotations. + :type: list[SoundAnnotation] + """ + + 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, SoundAnnotations): + 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/sound_annotations_response.py b/asposepdfcloud/models/sound_annotations_response.py new file mode 100644 index 0000000..748a9e1 --- /dev/null +++ b/asposepdfcloud/models/sound_annotations_response.py @@ -0,0 +1,199 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 SoundAnnotationsResponse(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': 'SoundAnnotations' + } + + attribute_map = { + 'code': 'Code', + 'status': 'Status', + 'annotations': 'Annotations' + } + + def __init__(self, code=None, status=None, annotations=None): + """ + SoundAnnotationsResponse - 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 SoundAnnotationsResponse. + Response status code. + + :return: The code of this SoundAnnotationsResponse. + :rtype: int + """ + return self._code + + @code.setter + def code(self, code): + """ + Sets the code of this SoundAnnotationsResponse. + Response status code. + + :param code: The code of this SoundAnnotationsResponse. + :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 SoundAnnotationsResponse. + Response status. + + :return: The status of this SoundAnnotationsResponse. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this SoundAnnotationsResponse. + Response status. + + :param status: The status of this SoundAnnotationsResponse. + :type: str + """ + + self._status = status + + @property + def annotations(self): + """ + Gets the annotations of this SoundAnnotationsResponse. + Sound annotations object + + :return: The annotations of this SoundAnnotationsResponse. + :rtype: SoundAnnotations + """ + return self._annotations + + @annotations.setter + def annotations(self, annotations): + """ + Sets the annotations of this SoundAnnotationsResponse. + Sound annotations object + + :param annotations: The annotations of this SoundAnnotationsResponse. + :type: SoundAnnotations + """ + + 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, SoundAnnotationsResponse): + 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/sound_encoding.py b/asposepdfcloud/models/sound_encoding.py new file mode 100644 index 0000000..8aba806 --- /dev/null +++ b/asposepdfcloud/models/sound_encoding.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 SoundEncoding(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + """ + allowed enum values + """ + RAW = "Raw" + SIGNED = "Signed" + MULAW = "MuLaw" + ALAW = "ALaw" + + """ + 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): + """ + SoundEncoding - 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, SoundEncoding): + 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/sound_icon.py b/asposepdfcloud/models/sound_icon.py new file mode 100644 index 0000000..be4195d --- /dev/null +++ b/asposepdfcloud/models/sound_icon.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Aspose.PDF Cloud API Reference + + + Copyright (c) 2019 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 SoundIcon(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + """ + allowed enum values + """ + SPEAKER = "Speaker" + MIC = "Mic" + + """ + 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): + """ + SoundIcon - 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, SoundIcon): + 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/split_result.py b/asposepdfcloud/models/split_result.py index d5d8bf0..32eaf23 100644 --- a/asposepdfcloud/models/split_result.py +++ b/asposepdfcloud/models/split_result.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/split_result_document.py b/asposepdfcloud/models/split_result_document.py index fb8bd7c..931a53f 100644 --- a/asposepdfcloud/models/split_result_document.py +++ b/asposepdfcloud/models/split_result_document.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/split_result_response.py b/asposepdfcloud/models/split_result_response.py index 477f8a6..8302755 100644 --- a/asposepdfcloud/models/split_result_response.py +++ b/asposepdfcloud/models/split_result_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/square_annotation.py b/asposepdfcloud/models/square_annotation.py index ea3e8eb..901589b 100644 --- a/asposepdfcloud/models/square_annotation.py +++ b/asposepdfcloud/models/square_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/square_annotation_response.py b/asposepdfcloud/models/square_annotation_response.py index 3f1c27b..b96957c 100644 --- a/asposepdfcloud/models/square_annotation_response.py +++ b/asposepdfcloud/models/square_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/square_annotations.py b/asposepdfcloud/models/square_annotations.py index 6e08a01..d5be719 100644 --- a/asposepdfcloud/models/square_annotations.py +++ b/asposepdfcloud/models/square_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/square_annotations_response.py b/asposepdfcloud/models/square_annotations_response.py index d510d51..063a508 100644 --- a/asposepdfcloud/models/square_annotations_response.py +++ b/asposepdfcloud/models/square_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/squiggly_annotation.py b/asposepdfcloud/models/squiggly_annotation.py index ad99998..28ddbb5 100644 --- a/asposepdfcloud/models/squiggly_annotation.py +++ b/asposepdfcloud/models/squiggly_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/squiggly_annotation_response.py b/asposepdfcloud/models/squiggly_annotation_response.py index b525967..3b3cdc5 100644 --- a/asposepdfcloud/models/squiggly_annotation_response.py +++ b/asposepdfcloud/models/squiggly_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/squiggly_annotations.py b/asposepdfcloud/models/squiggly_annotations.py index 5eb9e6f..a14df9a 100644 --- a/asposepdfcloud/models/squiggly_annotations.py +++ b/asposepdfcloud/models/squiggly_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/squiggly_annotations_response.py b/asposepdfcloud/models/squiggly_annotations_response.py index db1cb07..165e253 100644 --- a/asposepdfcloud/models/squiggly_annotations_response.py +++ b/asposepdfcloud/models/squiggly_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/stamp.py b/asposepdfcloud/models/stamp.py index ead6e6c..f3038ff 100644 --- a/asposepdfcloud/models/stamp.py +++ b/asposepdfcloud/models/stamp.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/stamp_type.py b/asposepdfcloud/models/stamp_type.py index 4f1d237..e672d97 100644 --- a/asposepdfcloud/models/stamp_type.py +++ b/asposepdfcloud/models/stamp_type.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/storage_exist_response.py b/asposepdfcloud/models/storage_exist_response.py index 881c080..66b91de 100644 --- a/asposepdfcloud/models/storage_exist_response.py +++ b/asposepdfcloud/models/storage_exist_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/strike_out_annotation.py b/asposepdfcloud/models/strike_out_annotation.py index e217fee..ce7b698 100644 --- a/asposepdfcloud/models/strike_out_annotation.py +++ b/asposepdfcloud/models/strike_out_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/strike_out_annotation_response.py b/asposepdfcloud/models/strike_out_annotation_response.py index 8d71fcc..70f6c1c 100644 --- a/asposepdfcloud/models/strike_out_annotation_response.py +++ b/asposepdfcloud/models/strike_out_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/strike_out_annotations.py b/asposepdfcloud/models/strike_out_annotations.py index 9aff7f1..9050107 100644 --- a/asposepdfcloud/models/strike_out_annotations.py +++ b/asposepdfcloud/models/strike_out_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/strike_out_annotations_response.py b/asposepdfcloud/models/strike_out_annotations_response.py index 9af2260..eae4da6 100644 --- a/asposepdfcloud/models/strike_out_annotations_response.py +++ b/asposepdfcloud/models/strike_out_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_annotation.py b/asposepdfcloud/models/text_annotation.py index dd89ed6..c3762f3 100644 --- a/asposepdfcloud/models/text_annotation.py +++ b/asposepdfcloud/models/text_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_annotation_response.py b/asposepdfcloud/models/text_annotation_response.py index 9b03cb4..33da35f 100644 --- a/asposepdfcloud/models/text_annotation_response.py +++ b/asposepdfcloud/models/text_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_annotations.py b/asposepdfcloud/models/text_annotations.py index ddbf218..65c5898 100644 --- a/asposepdfcloud/models/text_annotations.py +++ b/asposepdfcloud/models/text_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_annotations_response.py b/asposepdfcloud/models/text_annotations_response.py index d390656..f0a44ee 100644 --- a/asposepdfcloud/models/text_annotations_response.py +++ b/asposepdfcloud/models/text_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_horizontal_alignment.py b/asposepdfcloud/models/text_horizontal_alignment.py index d9f5d7b..077ce08 100644 --- a/asposepdfcloud/models/text_horizontal_alignment.py +++ b/asposepdfcloud/models/text_horizontal_alignment.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_icon.py b/asposepdfcloud/models/text_icon.py index 270fe02..ae671fc 100644 --- a/asposepdfcloud/models/text_icon.py +++ b/asposepdfcloud/models/text_icon.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_line.py b/asposepdfcloud/models/text_line.py index cb292f7..90b23a7 100644 --- a/asposepdfcloud/models/text_line.py +++ b/asposepdfcloud/models/text_line.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_rect.py b/asposepdfcloud/models/text_rect.py index e24b2b3..782bad7 100644 --- a/asposepdfcloud/models/text_rect.py +++ b/asposepdfcloud/models/text_rect.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_rects.py b/asposepdfcloud/models/text_rects.py index 75f3448..2c72738 100644 --- a/asposepdfcloud/models/text_rects.py +++ b/asposepdfcloud/models/text_rects.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_rects_response.py b/asposepdfcloud/models/text_rects_response.py index f036427..5855be5 100644 --- a/asposepdfcloud/models/text_rects_response.py +++ b/asposepdfcloud/models/text_rects_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_replace.py b/asposepdfcloud/models/text_replace.py index 205ae24..8ad0953 100644 --- a/asposepdfcloud/models/text_replace.py +++ b/asposepdfcloud/models/text_replace.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_replace_list_request.py b/asposepdfcloud/models/text_replace_list_request.py index 9f727b6..ecb5e67 100644 --- a/asposepdfcloud/models/text_replace_list_request.py +++ b/asposepdfcloud/models/text_replace_list_request.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_replace_response.py b/asposepdfcloud/models/text_replace_response.py index d7b0e55..62eff10 100644 --- a/asposepdfcloud/models/text_replace_response.py +++ b/asposepdfcloud/models/text_replace_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_state.py b/asposepdfcloud/models/text_state.py index d0eb819..1dca125 100644 --- a/asposepdfcloud/models/text_state.py +++ b/asposepdfcloud/models/text_state.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/text_style.py b/asposepdfcloud/models/text_style.py index 8127ca5..08cc143 100644 --- a/asposepdfcloud/models/text_style.py +++ b/asposepdfcloud/models/text_style.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/underline_annotation.py b/asposepdfcloud/models/underline_annotation.py index c1e7e1f..275caf0 100644 --- a/asposepdfcloud/models/underline_annotation.py +++ b/asposepdfcloud/models/underline_annotation.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/underline_annotation_response.py b/asposepdfcloud/models/underline_annotation_response.py index 5847eb2..d03a3b3 100644 --- a/asposepdfcloud/models/underline_annotation_response.py +++ b/asposepdfcloud/models/underline_annotation_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/underline_annotations.py b/asposepdfcloud/models/underline_annotations.py index c8e8907..2f14086 100644 --- a/asposepdfcloud/models/underline_annotations.py +++ b/asposepdfcloud/models/underline_annotations.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/underline_annotations_response.py b/asposepdfcloud/models/underline_annotations_response.py index fa26b0d..bedf4d7 100644 --- a/asposepdfcloud/models/underline_annotations_response.py +++ b/asposepdfcloud/models/underline_annotations_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/vertical_alignment.py b/asposepdfcloud/models/vertical_alignment.py index bb8706c..0936320 100644 --- a/asposepdfcloud/models/vertical_alignment.py +++ b/asposepdfcloud/models/vertical_alignment.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/word_count.py b/asposepdfcloud/models/word_count.py index 89886a7..9b9a440 100644 --- a/asposepdfcloud/models/word_count.py +++ b/asposepdfcloud/models/word_count.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/word_count_response.py b/asposepdfcloud/models/word_count_response.py index f0b590c..28a0274 100644 --- a/asposepdfcloud/models/word_count_response.py +++ b/asposepdfcloud/models/word_count_response.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/models/wrap_mode.py b/asposepdfcloud/models/wrap_mode.py index 61b3d36..a4b690f 100644 --- a/asposepdfcloud/models/wrap_mode.py +++ b/asposepdfcloud/models/wrap_mode.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/asposepdfcloud/rest.py b/asposepdfcloud/rest.py index bccabdd..1c9d431 100644 --- a/asposepdfcloud/rest.py +++ b/asposepdfcloud/rest.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 diff --git a/docs/FileAttachmentAnnotation.md b/docs/FileAttachmentAnnotation.md new file mode 100644 index 0000000..f888074 --- /dev/null +++ b/docs/FileAttachmentAnnotation.md @@ -0,0 +1,31 @@ +# FileAttachmentAnnotation +Provides FileAttachmentAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**color** | [**Color**](Color.md) | Color of the annotation. | [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** | [**Rectangle**](Rectangle.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] +**icon** | [**FileIcon**](FileIcon.md) | Gets or sets icon that shall be used in displaying annotation. | [optional] +**opacity** | **float** | Gets or sets icon's opacity from 0 to 1: 0 - completely transparant, 1 - completely opaque. | [optional] +**file_description** | **str** | Gets or sets text associated with the file specification. | [optional] +**file_name** | **str** | Gets or sets file specification name. | [optional] +**file_path** | **str** | Sets content file path. | [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/FileAttachmentAnnotationResponse.md b/docs/FileAttachmentAnnotationResponse.md new file mode 100644 index 0000000..bbf72aa --- /dev/null +++ b/docs/FileAttachmentAnnotationResponse.md @@ -0,0 +1,13 @@ +# FileAttachmentAnnotationResponse +Represents response containing single FileAttachment annotation object + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotation** | [**FileAttachmentAnnotation**](FileAttachmentAnnotation.md) | FileAttachment annotation object | [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/FileAttachmentAnnotations.md b/docs/FileAttachmentAnnotations.md new file mode 100644 index 0000000..52836cc --- /dev/null +++ b/docs/FileAttachmentAnnotations.md @@ -0,0 +1,12 @@ +# FileAttachmentAnnotations +Object representing a list of FileAttachment annotations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**list** | [**list[FileAttachmentAnnotation]**](FileAttachmentAnnotation.md) | List of FileAttachment annotations. | [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/FileAttachmentAnnotationsResponse.md b/docs/FileAttachmentAnnotationsResponse.md new file mode 100644 index 0000000..4cedd01 --- /dev/null +++ b/docs/FileAttachmentAnnotationsResponse.md @@ -0,0 +1,13 @@ +# FileAttachmentAnnotationsResponse +Represents response containing multiple FileAttachment annotation objects + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotations** | [**FileAttachmentAnnotations**](FileAttachmentAnnotations.md) | Free text annotations object | [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/FileIcon.md b/docs/FileIcon.md new file mode 100644 index 0000000..f31422a --- /dev/null +++ b/docs/FileIcon.md @@ -0,0 +1,15 @@ +# FileIcon +An icon to be used in displaying the annotation. + +## Enum +Name | Type | Value | Description +------------ | ------------- | ------------- | ------------- +**PUSHPIN** | **str** | "PushPin" | PushPin icon (default value). +**GRAPH** | **str** | "Graph" | Graph icon. +**PAPERCLIP** | **str** | "Paperclip" | Paperclip icon. +**TAG** | **str** | "Tag" | This is tag icon. + + +[[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/MovieAnnotation.md b/docs/MovieAnnotation.md new file mode 100644 index 0000000..e3558d8 --- /dev/null +++ b/docs/MovieAnnotation.md @@ -0,0 +1,25 @@ +# MovieAnnotation +Provides MovieAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**color** | [**Color**](Color.md) | Color of the annotation. | [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** | [**Rectangle**](Rectangle.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] +**title** | **str** | Get the annotation title. | [optional] +**file_name** | **str** | Gets or sets file specification name. | [optional] +**file_path** | **str** | Sets content file path. | [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/MovieAnnotationResponse.md b/docs/MovieAnnotationResponse.md new file mode 100644 index 0000000..552c54f --- /dev/null +++ b/docs/MovieAnnotationResponse.md @@ -0,0 +1,13 @@ +# MovieAnnotationResponse +Represents response containing single movie annotation object + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotation** | [**MovieAnnotation**](MovieAnnotation.md) | Movie annotation object | [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/MovieAnnotations.md b/docs/MovieAnnotations.md new file mode 100644 index 0000000..f6d628f --- /dev/null +++ b/docs/MovieAnnotations.md @@ -0,0 +1,12 @@ +# MovieAnnotations +Object representing a list of movie annotations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**list** | [**list[MovieAnnotation]**](MovieAnnotation.md) | List of movie annotations. | [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/MovieAnnotationsResponse.md b/docs/MovieAnnotationsResponse.md new file mode 100644 index 0000000..3eceebf --- /dev/null +++ b/docs/MovieAnnotationsResponse.md @@ -0,0 +1,13 @@ +# MovieAnnotationsResponse +Represents response containing multiple movie annotation objects + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotations** | [**MovieAnnotations**](MovieAnnotations.md) | Movie annotations object | [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 1d01bfa..89776fc 100644 --- a/docs/PdfApi.md +++ b/docs/PdfApi.md @@ -27,16 +27,20 @@ Method | HTTP request | Description [**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_file_attachment_annotations**](PdfApi.md#get_document_file_attachment_annotations) | **GET** /pdf/\{name}/annotations/fileattachment | Read document FileAttachment 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_movie_annotations**](PdfApi.md#get_document_movie_annotations) | **GET** /pdf/\{name}/annotations/movie | Read document movie 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_redaction_annotations**](PdfApi.md#get_document_redaction_annotations) | **GET** /pdf/\{name}/annotations/redaction | Read document redaction annotations. +[**get_document_sound_annotations**](PdfApi.md#get_document_sound_annotations) | **GET** /pdf/\{name}/annotations/sound | Read document sound annotations. [**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. @@ -47,6 +51,8 @@ Method | HTTP request | Description [**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_file_attachment_annotation**](PdfApi.md#get_file_attachment_annotation) | **GET** /pdf/\{name}/annotations/fileattachment/\{annotationId} | Read document page FileAttachment annotation by ID. +[**get_file_attachment_annotation_data**](PdfApi.md#get_file_attachment_annotation_data) | **GET** /pdf/\{name}/annotations/fileattachment/\{annotationId}/data | Read document page FileAttachment annotation by ID. [**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. @@ -65,6 +71,7 @@ Method | HTTP request | Description [**get_list_file_versions**](PdfApi.md#get_list_file_versions) | **GET** /storage/version | Get the file's versions list [**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_movie_annotation**](PdfApi.md#get_movie_annotation) | **GET** /pdf/\{name}/annotations/movie/\{annotationId} | Read document page movie annotation by ID. [**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. @@ -75,15 +82,19 @@ Method | HTTP request | Description [**get_page_convert_to_jpeg**](PdfApi.md#get_page_convert_to_jpeg) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/jpeg | Convert document page to Jpeg image and return resulting file in response. [**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_file_attachment_annotations**](PdfApi.md#get_page_file_attachment_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/fileattachment | Read document page FileAttachment annotations. [**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_movie_annotations**](PdfApi.md#get_page_movie_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/movie | Read document page movie 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_redaction_annotations**](PdfApi.md#get_page_redaction_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/redaction | Read document page redaction annotations. +[**get_page_sound_annotations**](PdfApi.md#get_page_sound_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/sound | Read document page sound 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. @@ -108,6 +119,9 @@ Method | HTTP request | Description [**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_redaction_annotation**](PdfApi.md#get_redaction_annotation) | **GET** /pdf/\{name}/annotations/redaction/\{annotationId} | Read document page redaction annotation by ID. +[**get_sound_annotation**](PdfApi.md#get_sound_annotation) | **GET** /pdf/\{name}/annotations/sound/\{annotationId} | Read document page sound annotation by ID. +[**get_sound_annotation_data**](PdfApi.md#get_sound_annotation_data) | **GET** /pdf/\{name}/annotations/sound/\{annotationId}/data | Read document page sound annotation by ID. [**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. @@ -125,7 +139,7 @@ Method | HTTP request | Description [**post_append_document**](PdfApi.md#post_append_document) | **POST** /pdf/\{name}/appendDocument | Append document to existing one. [**post_create_field**](PdfApi.md#post_create_field) | **POST** /pdf/\{name}/fields | Create field. [**post_document_text_replace**](PdfApi.md#post_document_text_replace) | **POST** /pdf/\{name}/text/replace | Document's replace text method. -[**post_flatten_document**](PdfApi.md#post_flatten_document) | **POST** /pdf/\{name}/flatten | Removes all fields from the document and place their values instead. +[**post_flatten_document**](PdfApi.md#post_flatten_document) | **POST** /pdf/\{name}/flatten | Flatten the document. [**post_insert_image**](PdfApi.md#post_insert_image) | **POST** /pdf/\{name}/pages/\{pageNumber}/images | Insert image to document page. [**post_move_file**](PdfApi.md#post_move_file) | **POST** /storage/file | Move a specific file [**post_move_folder**](PdfApi.md#post_move_folder) | **POST** /storage/folder | Move a specific folder @@ -133,13 +147,17 @@ Method | HTTP request | Description [**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_file_attachment_annotations**](PdfApi.md#post_page_file_attachment_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/fileattachment | Add document page FileAttachment 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_movie_annotations**](PdfApi.md#post_page_movie_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/movie | Add document page movie 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_redaction_annotations**](PdfApi.md#post_page_redaction_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/redaction | Add document page redaction annotations. +[**post_page_sound_annotations**](PdfApi.md#post_page_sound_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/sound | Add document page sound 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. @@ -159,6 +177,8 @@ Method | HTTP request | Description [**put_create_folder**](PdfApi.md#put_create_folder) | **PUT** /storage/folder | Create the folder [**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_file_attachment_annotation**](PdfApi.md#put_file_attachment_annotation) | **PUT** /pdf/\{name}/annotations/fileattachment/\{annotationId} | Replace document FileAttachment annotation +[**put_file_attachment_annotation_data_extract**](PdfApi.md#put_file_attachment_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/fileattachment/\{annotationId}/data/extract | Extract document FileAttachment annotation content to storage [**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. @@ -177,6 +197,7 @@ Method | HTTP request | Description [**put_link_annotation**](PdfApi.md#put_link_annotation) | **PUT** /pdf/\{name}/links/\{linkId} | Replace document page link annotations [**put_merge_documents**](PdfApi.md#put_merge_documents) | **PUT** /pdf/\{name}/merge | Merge a list of documents. [**put_mht_in_storage_to_pdf**](PdfApi.md#put_mht_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/mht | Convert MHT file (located on storage) to PDF format and upload resulting file to storage. +[**put_movie_annotation**](PdfApi.md#put_movie_annotation) | **PUT** /pdf/\{name}/annotations/movie/\{annotationId} | Replace document movie annotation [**put_page_add_stamp**](PdfApi.md#put_page_add_stamp) | **PUT** /pdf/\{name}/pages/\{pageNumber}/stamp | Add page stamp. [**put_page_convert_to_bmp**](PdfApi.md#put_page_convert_to_bmp) | **PUT** /pdf/\{name}/pages/\{pageNumber}/convert/bmp | Convert document page to bmp image and upload resulting file to storage. [**put_page_convert_to_emf**](PdfApi.md#put_page_convert_to_emf) | **PUT** /pdf/\{name}/pages/\{pageNumber}/convert/emf | Convert document page to emf image and upload resulting file to storage. @@ -214,9 +235,12 @@ Method | HTTP request | Description [**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_redaction_annotation**](PdfApi.md#put_redaction_annotation) | **PUT** /pdf/\{name}/annotations/redaction/\{annotationId} | Replace document redaction annotation [**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_sound_annotation**](PdfApi.md#put_sound_annotation) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId} | Replace document sound annotation +[**put_sound_annotation_data_extract**](PdfApi.md#put_sound_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId}/data/extract | Extract document sound annotation content to storage [**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 @@ -795,6 +819,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_file_attachment_annotations** +> FileAttachmentAnnotationsResponse get_document_file_attachment_annotations(name, storage=storage, folder=folder) + +Read document FileAttachment 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 + +[**FileAttachmentAnnotationsResponse**](FileAttachmentAnnotationsResponse.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_free_text_annotations** > FreeTextAnnotationsResponse get_document_free_text_annotations(name, storage=storage, folder=folder) @@ -891,6 +939,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_movie_annotations** +> MovieAnnotationsResponse get_document_movie_annotations(name, storage=storage, folder=folder) + +Read document movie 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 + +[**MovieAnnotationsResponse**](MovieAnnotationsResponse.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_poly_line_annotations** > PolyLineAnnotationsResponse get_document_poly_line_annotations(name, storage=storage, folder=folder) @@ -1037,6 +1109,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_redaction_annotations** +> RedactionAnnotationsResponse get_document_redaction_annotations(name, storage=storage, folder=folder) + +Read document redaction 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 + +[**RedactionAnnotationsResponse**](RedactionAnnotationsResponse.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_sound_annotations** +> SoundAnnotationsResponse get_document_sound_annotations(name, storage=storage, folder=folder) + +Read document sound 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 + +[**SoundAnnotationsResponse**](SoundAnnotationsResponse.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_square_annotations** > SquareAnnotationsResponse get_document_square_annotations(name, storage=storage, folder=folder) @@ -1278,6 +1398,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_file_attachment_annotation** +> FileAttachmentAnnotationResponse get_file_attachment_annotation(name, annotation_id, storage=storage, folder=folder) + +Read document page FileAttachment 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 + +[**FileAttachmentAnnotationResponse**](FileAttachmentAnnotationResponse.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_file_attachment_annotation_data** +> file get_file_attachment_annotation_data(name, annotation_id, storage=storage, folder=folder) + +Read document page FileAttachment 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 + +**file** + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: multipart/form-data + +[[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_free_text_annotation** > FreeTextAnnotationResponse get_free_text_annotation(name, annotation_id, storage=storage, folder=folder) @@ -1730,6 +1900,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_movie_annotation** +> MovieAnnotationResponse get_movie_annotation(name, annotation_id, storage=storage, folder=folder) + +Read document page movie 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 + +[**MovieAnnotationResponse**](MovieAnnotationResponse.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** > DocumentPageResponse get_page(name, page_number, storage=storage, folder=folder) @@ -1992,6 +2187,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_file_attachment_annotations** +> FileAttachmentAnnotationsResponse get_page_file_attachment_annotations(name, page_number, storage=storage, folder=folder) + +Read document page FileAttachment 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 + +[**FileAttachmentAnnotationsResponse**](FileAttachmentAnnotationsResponse.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_free_text_annotations** > FreeTextAnnotationsResponse get_page_free_text_annotations(name, page_number, storage=storage, folder=folder) @@ -2143,6 +2363,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_movie_annotations** +> MovieAnnotationsResponse get_page_movie_annotations(name, page_number, storage=storage, folder=folder) + +Read document page movie 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 + +[**MovieAnnotationsResponse**](MovieAnnotationsResponse.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_poly_line_annotations** > PolyLineAnnotationsResponse get_page_poly_line_annotations(name, page_number, storage=storage, folder=folder) @@ -2218,6 +2463,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_page_redaction_annotations** +> RedactionAnnotationsResponse get_page_redaction_annotations(name, page_number, storage=storage, folder=folder) + +Read document page redaction 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 + +[**RedactionAnnotationsResponse**](RedactionAnnotationsResponse.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_sound_annotations** +> SoundAnnotationsResponse get_page_sound_annotations(name, page_number, storage=storage, folder=folder) + +Read document page sound 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 + +[**SoundAnnotationsResponse**](SoundAnnotationsResponse.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_square_annotations** > SquareAnnotationsResponse get_page_square_annotations(name, page_number, storage=storage, folder=folder) @@ -2869,6 +3164,81 @@ 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_redaction_annotation** +> RedactionAnnotationResponse get_redaction_annotation(name, annotation_id, storage=storage, folder=folder) + +Read document page redaction 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 + +[**RedactionAnnotationResponse**](RedactionAnnotationResponse.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_sound_annotation** +> SoundAnnotationResponse get_sound_annotation(name, annotation_id, storage=storage, folder=folder) + +Read document page sound 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 + +[**SoundAnnotationResponse**](SoundAnnotationResponse.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_sound_annotation_data** +> file get_sound_annotation_data(name, annotation_id, storage=storage, folder=folder) + +Read document page sound 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 + +**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_square_annotation** > SquareAnnotationResponse get_square_annotation(name, annotation_id, storage=storage, folder=folder) @@ -3311,7 +3681,7 @@ Name | Type | Description | Notes # **post_flatten_document** > AsposeResponse post_flatten_document(name, update_appearances=update_appearances, call_events=call_events, hide_buttons=hide_buttons, storage=storage, folder=folder) -Removes all fields from the document and place their values instead. +Flatten the document. ### Parameters @@ -3520,6 +3890,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) +# **post_page_file_attachment_annotations** +> AsposeResponse post_page_file_attachment_annotations(name, page_number, annotations, storage=storage, folder=folder) + +Add document page FileAttachment annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **annotations** | [**list[FileAttachmentAnnotation]**](FileAttachmentAnnotation.md)| 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_free_text_annotations** > AsposeResponse post_page_free_text_annotations(name, page_number, annotations, storage=storage, folder=folder) @@ -3650,6 +4046,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) +# **post_page_movie_annotations** +> AsposeResponse post_page_movie_annotations(name, page_number, annotations, storage=storage, folder=folder) + +Add document page movie annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **annotations** | [**list[MovieAnnotation]**](MovieAnnotation.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_poly_line_annotations** > AsposeResponse post_page_poly_line_annotations(name, page_number, annotations, storage=storage, folder=folder) @@ -3702,6 +4124,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_redaction_annotations** +> AsposeResponse post_page_redaction_annotations(name, page_number, annotations, storage=storage, folder=folder) + +Add document page redaction annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **annotations** | [**list[RedactionAnnotation]**](RedactionAnnotation.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_sound_annotations** +> AsposeResponse post_page_sound_annotations(name, page_number, annotations, storage=storage, folder=folder) + +Add document page sound annotations. + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **page_number** | **int**| The page number. | + **annotations** | [**list[SoundAnnotation]**](SoundAnnotation.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_square_annotations** > AsposeResponse post_page_square_annotations(name, page_number, annotations, storage=storage, folder=folder) @@ -4186,6 +4660,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_file_attachment_annotation** +> FileAttachmentAnnotationResponse put_file_attachment_annotation(name, annotation_id, annotation, storage=storage, folder=folder) + +Replace document FileAttachment annotation + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **annotation** | [**FileAttachmentAnnotation**](FileAttachmentAnnotation.md)| Annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**FileAttachmentAnnotationResponse**](FileAttachmentAnnotationResponse.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_file_attachment_annotation_data_extract** +> AsposeResponse put_file_attachment_annotation_data_extract(name, annotation_id, out_folder=out_folder, storage=storage, folder=folder) + +Extract document FileAttachment annotation content to storage + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **out_folder** | **str**| The output folder. | [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) + # **put_free_text_annotation** > FreeTextAnnotationResponse put_free_text_annotation(name, annotation_id, annotation, storage=storage, folder=folder) @@ -4673,6 +5199,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_movie_annotation** +> MovieAnnotationResponse put_movie_annotation(name, annotation_id, annotation, storage=storage, folder=folder) + +Replace document movie annotation + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **annotation** | [**MovieAnnotation**](MovieAnnotation.md)| Annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**MovieAnnotationResponse**](MovieAnnotationResponse.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_page_add_stamp** > AsposeResponse put_page_add_stamp(name, page_number, stamp, storage=storage, folder=folder) @@ -5728,6 +6280,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_redaction_annotation** +> RedactionAnnotationResponse put_redaction_annotation(name, annotation_id, annotation, storage=storage, folder=folder) + +Replace document redaction annotation + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **annotation** | [**RedactionAnnotation**](RedactionAnnotation.md)| Annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**RedactionAnnotationResponse**](RedactionAnnotationResponse.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_replace_image** > ImageResponse put_replace_image(name, image_id, image_file_path=image_file_path, storage=storage, folder=folder, image=image) @@ -5806,6 +6384,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_sound_annotation** +> SoundAnnotationResponse put_sound_annotation(name, annotation_id, annotation, storage=storage, folder=folder) + +Replace document sound annotation + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **annotation** | [**SoundAnnotation**](SoundAnnotation.md)| Annotation. | + **storage** | **str**| The document storage. | [optional] + **folder** | **str**| The document folder. | [optional] + +### Return type + +[**SoundAnnotationResponse**](SoundAnnotationResponse.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_sound_annotation_data_extract** +> AsposeResponse put_sound_annotation_data_extract(name, annotation_id, out_file_path, storage=storage, folder=folder) + +Extract document sound annotation content to storage + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **str**| The document name. | + **annotation_id** | **str**| The annotation ID. | + **out_file_path** | **str**| The output file path. | + **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) + # **put_square_annotation** > SquareAnnotationResponse put_square_annotation(name, annotation_id, annotation, storage=storage, folder=folder) diff --git a/docs/RedactionAnnotation.md b/docs/RedactionAnnotation.md new file mode 100644 index 0000000..2530cff --- /dev/null +++ b/docs/RedactionAnnotation.md @@ -0,0 +1,28 @@ +# RedactionAnnotation +Provides RedactionAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**color** | [**Color**](Color.md) | Color of the annotation. | [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** | [**Rectangle**](Rectangle.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] +**quad_point** | [**list[Point]**](Point.md) | An array of 8xN numbers specifying the coordinates of content region that is intended to be removed. | [optional] +**fill_color** | [**Color**](Color.md) | Gets or sets color to fill annotation. | [optional] +**border_color** | [**Color**](Color.md) | Gets or sets color of border which is drawn when redaction is not active. | [optional] +**overlay_text** | **str** | Text to print on redact annotation. | [optional] +**repeat** | **bool** | If true overlay text will be repated on the annotation. | [optional] +**text_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets. Alignment of Overlay Text. | [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/RedactionAnnotationResponse.md b/docs/RedactionAnnotationResponse.md new file mode 100644 index 0000000..9a8e1cd --- /dev/null +++ b/docs/RedactionAnnotationResponse.md @@ -0,0 +1,13 @@ +# RedactionAnnotationResponse +Represents response containing single redaction annotation object + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotation** | [**RedactionAnnotation**](RedactionAnnotation.md) | Redaction annotation object | [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/RedactionAnnotations.md b/docs/RedactionAnnotations.md new file mode 100644 index 0000000..555ce8c --- /dev/null +++ b/docs/RedactionAnnotations.md @@ -0,0 +1,12 @@ +# RedactionAnnotations +Object representing a list of redaction annotations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**list** | [**list[RedactionAnnotation]**](RedactionAnnotation.md) | List of redaction annotations. | [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/RedactionAnnotationsResponse.md b/docs/RedactionAnnotationsResponse.md new file mode 100644 index 0000000..63e9b79 --- /dev/null +++ b/docs/RedactionAnnotationsResponse.md @@ -0,0 +1,13 @@ +# RedactionAnnotationsResponse +Represents response containing multiple redaction annotation objects + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotations** | [**RedactionAnnotations**](RedactionAnnotations.md) | Ink annotations object | [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/SoundAnnotation.md b/docs/SoundAnnotation.md new file mode 100644 index 0000000..9d55a3d --- /dev/null +++ b/docs/SoundAnnotation.md @@ -0,0 +1,32 @@ +# SoundAnnotation +Provides SoundAnnotation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**color** | [**Color**](Color.md) | Color of the annotation. | [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** | [**Rectangle**](Rectangle.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] +**file_path** | **str** | A sound file path defining the sound to be played when the annotation is activated. | [optional] +**icon** | [**SoundIcon**](SoundIcon.md) | Gets or sets an icon to be used in displaying the annotation. | [optional] +**rate** | **int** | Gets or sets the sampling rate, in samples per second. | [optional] +**channels** | **int** | Gets or sets the number of sound channels. | [optional] +**bits** | **int** | Gets or sets the number of bits per sample value per channel. | [optional] +**encoding** | [**SoundEncoding**](SoundEncoding.md) | Gets or sets the encoding format for the sample data. | [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/SoundAnnotationResponse.md b/docs/SoundAnnotationResponse.md new file mode 100644 index 0000000..42fbd4e --- /dev/null +++ b/docs/SoundAnnotationResponse.md @@ -0,0 +1,13 @@ +# SoundAnnotationResponse +Represents response containing single Sound annotation object + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotation** | [**SoundAnnotation**](SoundAnnotation.md) | Sound annotation object | [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/SoundAnnotations.md b/docs/SoundAnnotations.md new file mode 100644 index 0000000..b3cd219 --- /dev/null +++ b/docs/SoundAnnotations.md @@ -0,0 +1,12 @@ +# SoundAnnotations +Object representing a list of Sound annotations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**list[Link]**](Link.md) | Link to the document. | [optional] +**list** | [**list[SoundAnnotation]**](SoundAnnotation.md) | List of Sound annotations. | [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/SoundAnnotationsResponse.md b/docs/SoundAnnotationsResponse.md new file mode 100644 index 0000000..1cb0364 --- /dev/null +++ b/docs/SoundAnnotationsResponse.md @@ -0,0 +1,13 @@ +# SoundAnnotationsResponse +Represents response containing multiple sound annotation objects + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | Response status code. | +**status** | **str** | Response status. | [optional] +**annotations** | [**SoundAnnotations**](SoundAnnotations.md) | Sound annotations object | [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/SoundEncoding.md b/docs/SoundEncoding.md new file mode 100644 index 0000000..7423002 --- /dev/null +++ b/docs/SoundEncoding.md @@ -0,0 +1,15 @@ +# SoundEncoding +The encoding format for the sample data. + +## Enum +Name | Type | Value | Description +------------ | ------------- | ------------- | ------------- +**RAW** | **str** | "Raw" | Unspecified or unsigned values in the range 0 to 2^bits − 1. +**SIGNED** | **str** | "Signed" | Twos-complement values. +**MULAW** | **str** | "MuLaw" | μ-law–encoded samples. +**ALAW** | **str** | "ALaw" | A-law–encoded samples. + + +[[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/SoundIcon.md b/docs/SoundIcon.md new file mode 100644 index 0000000..da1b7a2 --- /dev/null +++ b/docs/SoundIcon.md @@ -0,0 +1,13 @@ +# SoundIcon +An icon to be used in displaying the annotation. + +## Enum +Name | Type | Value | Description +------------ | ------------- | ------------- | ------------- +**SPEAKER** | **str** | "Speaker" | Speaker icon. +**MIC** | **str** | "Mic" | Microphone icon. + + +[[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 8fcd6e3..44b8d02 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 @@ -32,7 +32,7 @@ from setuptools import setup, find_packages NAME = "asposepdfcloud" -VERSION = "18.12.0" +VERSION = "19.1.0" # To install the library, run the following # # python setup.py install diff --git a/test-requirements.txt b/test-requirements.txt index 6cb0a5d..ffc54ac 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,4 +1,3 @@ -asposestoragecloud == 1.0.1 requests >= 2.18.4 coverage >= 4.0.3 nose >= 1.3.7 diff --git a/test/pdf_tests.py b/test/pdf_tests.py index 759b1e4..2822ca2 100644 --- a/test/pdf_tests.py +++ b/test/pdf_tests.py @@ -4,7 +4,7 @@ Aspose.PDF Cloud API Reference - Copyright (c) 2018 Aspose.PDF Cloud + Copyright (c) 2019 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 @@ -66,7 +66,6 @@ def uploadFile(self, name): def tearDown(self): pass - # Annotations Tests @@ -117,6 +116,367 @@ def testDeleteAnnotation(self): response = self.pdf_api.delete_annotation(file_name, annotation_id, folder=self.temp_folder) self.assertEqual(response.code, 200) + # FileAttachment Annotations Tests + + def testGetDocumentFileAttachmentAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response = self.pdf_api.get_document_file_attachment_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetPageFileAttachmentAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 2 + + response = self.pdf_api.get_page_file_attachment_annotations(file_name, page_number, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetFileAttachmentAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_file_attachment_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_file_attachment_annotation(file_name, annotation_id, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testPostPageFileAttachmentAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + attachment_file = '4pages.pdf' + self.uploadFile(attachment_file) + + page_number = 1 + + annotation = asposepdfcloud.models.FileAttachmentAnnotation() + annotation.name = 'Test Name' + annotation.rect = asposepdfcloud.models.Rectangle(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.modified = '01/01/2018 12:00:00.000 AM' + annotation.file_path = self.temp_folder + '/' + attachment_file + annotation.file_name = attachment_file + + response = self.pdf_api.post_page_file_attachment_annotations(file_name, page_number, [annotation], folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + def testPutFileAttachmentAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + attachment_file = '4pages.pdf' + self.uploadFile(attachment_file) + + annotation = asposepdfcloud.models.FileAttachmentAnnotation() + annotation.name = 'Test Name' + annotation.rect = asposepdfcloud.models.Rectangle(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.modified = '01/01/2018 12:00:00.000 AM' + annotation.file_path = self.temp_folder + '/' + attachment_file + annotation.file_name = attachment_file + + response_annotations = self.pdf_api.get_document_file_attachment_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_file_attachment_annotation(file_name, annotation_id, annotation, folder=self.temp_folder) + self.assertEqual(response.code, 201) + + def testGetFileAttachmentAnnotationData(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_file_attachment_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_file_attachment_annotation_data(file_name, annotation_id, folder=self.temp_folder) + self.assertIsInstance(response, str) + + def testPutFileAttachmentAnnotationDataExtract(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_file_attachment_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_file_attachment_annotation_data_extract(file_name, annotation_id, folder=self.temp_folder) + self.assertEqual(response.code, 201) + + # Sound Annotations Tests + + def testGetDocumentSoundAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response = self.pdf_api.get_document_sound_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetPageSoundAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 2 + + response = self.pdf_api.get_page_sound_annotations(file_name, page_number, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetSoundAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_sound_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_sound_annotation(file_name, annotation_id, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testPostPageSoundAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + attachment_file = '4pages.pdf' + self.uploadFile(attachment_file) + + page_number = 1 + + annotation = asposepdfcloud.models.SoundAnnotation() + annotation.name = 'Test Name' + annotation.rect = asposepdfcloud.models.Rectangle(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.modified = '01/01/2018 12:00:00.000 AM' + annotation.file_path = self.temp_folder + '/' + attachment_file + + response = self.pdf_api.post_page_sound_annotations(file_name, page_number, [annotation], folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + def testPutSoundAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + attachment_file = '4pages.pdf' + self.uploadFile(attachment_file) + + annotation = asposepdfcloud.models.SoundAnnotation() + annotation.name = 'Test Name' + annotation.rect = asposepdfcloud.models.Rectangle(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.modified = '01/01/2018 12:00:00.000 AM' + annotation.file_path = self.temp_folder + '/' + attachment_file + + response_annotations = self.pdf_api.get_document_sound_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_sound_annotation(file_name, annotation_id, annotation, folder=self.temp_folder) + self.assertEqual(response.code, 201) + + def testGetSoundAnnotationData(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_sound_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_sound_annotation_data(file_name, annotation_id, folder=self.temp_folder) + self.assertIsInstance(response, str) + + def testPutSoundAnnotationDataExtract(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_sound_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_sound_annotation_data_extract(file_name, annotation_id, out_file_path="outFile.dat", folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + # Redaction Annotations Tests + + def testGetDocumentRedactionAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response = self.pdf_api.get_document_redaction_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetPageRedactionAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 2 + + response = self.pdf_api.get_page_redaction_annotations(file_name, page_number, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetRedactionAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_redaction_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_redaction_annotation(file_name, annotation_id, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testPostPageRedactionAnnotations(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 1 + + annotation = asposepdfcloud.models.RedactionAnnotation() + annotation.name = 'Test Name' + annotation.rect = asposepdfcloud.models.Rectangle(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.quad_point = [ + asposepdfcloud.models.Point(10, 40), + asposepdfcloud.models.Point(30, 40) + ] + annotation.modified = '01/01/2018 12:00:00.000 AM' + + response = self.pdf_api.post_page_redaction_annotations(file_name, page_number, [annotation], folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + def testPutRedactionAnnotation(self): + file_name = 'PdfWithAnnotations.pdf' + self.uploadFile(file_name) + + page_number = 1 + + annotation = asposepdfcloud.models.RedactionAnnotation() + annotation.name = 'Test Name Updated' + annotation.rect = asposepdfcloud.models.Rectangle(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.quad_point = [ + asposepdfcloud.models.Point(10, 40), + asposepdfcloud.models.Point(30, 40) + ] + annotation.modified = '01/01/2018 12:01:02.000 AM' + + response = self.pdf_api.post_page_redaction_annotations(file_name, page_number, [annotation], folder=self.temp_folder) + self.assertEqual(response.code, 201) + + response_annotations = self.pdf_api.get_document_redaction_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_redaction_annotation(file_name, annotation_id, annotation, folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + # Movie Annotations Tests + + def testGetDocumentMovieAnnotations(self): + file_name = 'PdfWithAnnotations1.pdf' + self.uploadFile(file_name) + + response = self.pdf_api.get_document_movie_annotations(file_name, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetPageMovieAnnotations(self): + file_name = 'PdfWithAnnotations1.pdf' + self.uploadFile(file_name) + + page_number = 2 + + response = self.pdf_api.get_page_movie_annotations(file_name, page_number, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testGetMovieAnnotation(self): + file_name = 'PdfWithAnnotations1.pdf' + self.uploadFile(file_name) + + response_annotations = self.pdf_api.get_document_movie_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_movie_annotation(file_name, annotation_id, folder=self.temp_folder) + self.assertEqual(response.code, 200) + + def testPostPageMovieAnnotations(self): + file_name = 'PdfWithAnnotations1.pdf' + self.uploadFile(file_name) + + attachment_file = '4pages.pdf' + self.uploadFile(attachment_file) + + page_number = 1 + + annotation = asposepdfcloud.models.MovieAnnotation() + annotation.name = 'Test Name' + annotation.rect = asposepdfcloud.models.Rectangle(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 = '01/01/2018 12:00:00.000 AM' + annotation.file_path = self.temp_folder + '/' + attachment_file + + response = self.pdf_api.post_page_movie_annotations(file_name, page_number, [annotation], folder=self.temp_folder) + self.assertEqual(response.code, 201) + + + def testPutMovieAnnotation(self): + file_name = 'PdfWithAnnotations1.pdf' + self.uploadFile(file_name) + + attachment_file = '4pages.pdf' + self.uploadFile(attachment_file) + + annotation = asposepdfcloud.models.MovieAnnotation() + annotation.name = 'Test Name' + annotation.rect = asposepdfcloud.models.Rectangle(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 = '01/01/2018 12:00:00.000 AM' + annotation.file_path = self.temp_folder + '/' + attachment_file + + response_annotations = self.pdf_api.get_document_movie_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_movie_annotation(file_name, annotation_id, annotation, folder=self.temp_folder) + self.assertEqual(response.code, 201) + # PolyLine Annotations Tests def testGetDocumentPolyLineAnnotations(self): @@ -1325,7 +1685,7 @@ def testGetDownloadDocumentAttachmentByIndex(self): } response = self.pdf_api.get_download_document_attachment_by_index(file_name, attachment_index, **opts) - self.assertIsInstance(response, str); + self.assertIsInstance(response, str) # Bookmarks Tests @@ -2705,7 +3065,6 @@ def testDeleteDocumentLinkAnnotations(self): file_name = 'PdfWithLinks.pdf' self.uploadFile(file_name) - page_number = 1 opts = { "folder" : self.temp_folder } @@ -3259,7 +3618,7 @@ def testGetVerifySignature(self): } response = self.pdf_api.get_verify_signature(file_name, signature.form_field_name, **opts) - self.assertEqual(response_sign.code, 200) + self.assertEqual(response.code, 200) # Text Replace Tests @@ -3371,7 +3730,7 @@ def testPutAddText(self): background_color=background_color, font_style=asposepdfcloud.models.FontStyles.BOLD) - segment = asposepdfcloud.models.Segment(value='segment 1', text_state=text_state); + segment = asposepdfcloud.models.Segment(value='segment 1', text_state=text_state) text_line = asposepdfcloud.models.TextLine(horizontal_alignment=asposepdfcloud.models.TextHorizontalAlignment.RIGHT, segments=[segment]) @@ -3479,7 +3838,7 @@ def testGetDiscUsage(self): response = self.pdf_api.get_disc_usage() self.assertEqual(response.code, 200) - def testGetListFileVersions(self): + def testGetListFileVersion(self): file_name = '4pages.pdf' self.uploadFile(file_name) path = self.temp_folder + '/' + file_name diff --git a/test_data/PdfWithAnnotations.pdf b/test_data/PdfWithAnnotations.pdf index 44f9e7d..98970c2 100644 Binary files a/test_data/PdfWithAnnotations.pdf and b/test_data/PdfWithAnnotations.pdf differ diff --git a/test_data/PdfWithAnnotations1.pdf b/test_data/PdfWithAnnotations1.pdf new file mode 100644 index 0000000..504c821 Binary files /dev/null and b/test_data/PdfWithAnnotations1.pdf differ