diff --git a/README.md b/README.md
index a50e78d..ea6bd1a 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Aspose.PDF Cloud
-- API version: 2.0
-- Package version: 19.5.0
+- API version: 3.0
+- Package version: 19.7.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.
@@ -91,18 +91,23 @@ All Aspose.PDF Cloud SDKs are licensed under [MIT License](LICENSE).
## Documentation for API Endpoints
-All URIs are relative to *https://api.aspose.cloud/v2.0/*
+All URIs are relative to *https://api.aspose.cloud/v3.0/*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
+*PdfApi* | [**copy_file**](docs/PdfApi.md#copy_file) | **PUT** /pdf/storage/file/copy/\{srcPath} | Copy file
+*PdfApi* | [**copy_folder**](docs/PdfApi.md#copy_folder) | **PUT** /pdf/storage/folder/copy/\{srcPath} | Copy folder
+*PdfApi* | [**create_folder**](docs/PdfApi.md#create_folder) | **PUT** /pdf/storage/folder/\{path} | Create the folder
*PdfApi* | [**delete_annotation**](docs/PdfApi.md#delete_annotation) | **DELETE** /pdf/\{name}/annotations/\{annotationId} | Delete document annotation by ID
+*PdfApi* | [**delete_bookmark**](docs/PdfApi.md#delete_bookmark) | **DELETE** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Delete document bookmark by ID.
*PdfApi* | [**delete_document_annotations**](docs/PdfApi.md#delete_document_annotations) | **DELETE** /pdf/\{name}/annotations | Delete all annotations from the document
+*PdfApi* | [**delete_document_bookmarks**](docs/PdfApi.md#delete_document_bookmarks) | **DELETE** /pdf/\{name}/bookmarks/tree | Delete all document bookmarks.
*PdfApi* | [**delete_document_link_annotations**](docs/PdfApi.md#delete_document_link_annotations) | **DELETE** /pdf/\{name}/links | Delete all link annotations from the document
*PdfApi* | [**delete_document_stamps**](docs/PdfApi.md#delete_document_stamps) | **DELETE** /pdf/\{name}/stamps | Delete all stamps from the document
*PdfApi* | [**delete_document_tables**](docs/PdfApi.md#delete_document_tables) | **DELETE** /pdf/\{name}/tables | Delete all tables from the document
*PdfApi* | [**delete_field**](docs/PdfApi.md#delete_field) | **DELETE** /pdf/\{name}/fields/\{fieldName} | Delete document field by name.
-*PdfApi* | [**delete_file**](docs/PdfApi.md#delete_file) | **DELETE** /storage/file | Remove a specific file
-*PdfApi* | [**delete_folder**](docs/PdfApi.md#delete_folder) | **DELETE** /storage/folder | Remove a specific folder
+*PdfApi* | [**delete_file**](docs/PdfApi.md#delete_file) | **DELETE** /pdf/storage/file/\{path} | Delete file
+*PdfApi* | [**delete_folder**](docs/PdfApi.md#delete_folder) | **DELETE** /pdf/storage/folder/\{path} | Delete folder
*PdfApi* | [**delete_image**](docs/PdfApi.md#delete_image) | **DELETE** /pdf/\{name}/images/\{imageId} | Delete image from document page.
*PdfApi* | [**delete_link_annotation**](docs/PdfApi.md#delete_link_annotation) | **DELETE** /pdf/\{name}/links/\{linkId} | Delete document page link annotation by ID
*PdfApi* | [**delete_page**](docs/PdfApi.md#delete_page) | **DELETE** /pdf/\{name}/pages/\{pageNumber} | Delete document page by its number.
@@ -114,13 +119,17 @@ Class | Method | HTTP request | Description
*PdfApi* | [**delete_property**](docs/PdfApi.md#delete_property) | **DELETE** /pdf/\{name}/documentproperties/\{propertyName} | Delete document property.
*PdfApi* | [**delete_stamp**](docs/PdfApi.md#delete_stamp) | **DELETE** /pdf/\{name}/stamps/\{stampId} | Delete document stamp by ID
*PdfApi* | [**delete_table**](docs/PdfApi.md#delete_table) | **DELETE** /pdf/\{name}/tables/\{tableId} | Delete document table by ID
+*PdfApi* | [**download_file**](docs/PdfApi.md#download_file) | **GET** /pdf/storage/file/\{path} | Download file
+*PdfApi* | [**get_bookmark**](docs/PdfApi.md#get_bookmark) | **GET** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Read document bookmark.
+*PdfApi* | [**get_bookmarks**](docs/PdfApi.md#get_bookmarks) | **GET** /pdf/\{name}/bookmarks/list/\{bookmarkPath} | Read document bookmarks node list.
*PdfApi* | [**get_caret_annotation**](docs/PdfApi.md#get_caret_annotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID.
*PdfApi* | [**get_circle_annotation**](docs/PdfApi.md#get_circle_annotation) | **GET** /pdf/\{name}/annotations/circle/\{annotationId} | Read document page circle annotation by ID.
-*PdfApi* | [**get_disc_usage**](docs/PdfApi.md#get_disc_usage) | **GET** /storage/disc | Check the disk usage of the current account
+*PdfApi* | [**get_disc_usage**](docs/PdfApi.md#get_disc_usage) | **GET** /pdf/storage/disc | Get disc usage
*PdfApi* | [**get_document**](docs/PdfApi.md#get_document) | **GET** /pdf/\{name} | Read common document info.
*PdfApi* | [**get_document_annotations**](docs/PdfApi.md#get_document_annotations) | **GET** /pdf/\{name}/annotations | Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
*PdfApi* | [**get_document_attachment_by_index**](docs/PdfApi.md#get_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex} | Read document attachment info by its index.
*PdfApi* | [**get_document_attachments**](docs/PdfApi.md#get_document_attachments) | **GET** /pdf/\{name}/attachments | Read document attachments info.
+*PdfApi* | [**get_document_bookmarks**](docs/PdfApi.md#get_document_bookmarks) | **GET** /pdf/\{name}/bookmarks/tree | Read document bookmarks tree.
*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.
@@ -146,13 +155,17 @@ Class | Method | HTTP request | Description
*PdfApi* | [**get_document_tables**](docs/PdfApi.md#get_document_tables) | **GET** /pdf/\{name}/tables | Read document tables.
*PdfApi* | [**get_document_text_annotations**](docs/PdfApi.md#get_document_text_annotations) | **GET** /pdf/\{name}/annotations/text | Read document text annotations.
*PdfApi* | [**get_document_underline_annotations**](docs/PdfApi.md#get_document_underline_annotations) | **GET** /pdf/\{name}/annotations/underline | Read document underline annotations.
-*PdfApi* | [**get_download**](docs/PdfApi.md#get_download) | **GET** /storage/file | Download a specific file
*PdfApi* | [**get_download_document_attachment_by_index**](docs/PdfApi.md#get_download_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex}/download | Download document attachment content by its index.
*PdfApi* | [**get_epub_in_storage_to_pdf**](docs/PdfApi.md#get_epub_in_storage_to_pdf) | **GET** /pdf/create/epub | Convert EPUB file (located on storage) to PDF format and return resulting file in response.
+*PdfApi* | [**get_export_fields_from_pdf_to_fdf_in_storage**](docs/PdfApi.md#get_export_fields_from_pdf_to_fdf_in_storage) | **GET** /pdf/\{name}/export/fdf | Export fields from from PDF in storage to FDF file.
+*PdfApi* | [**get_export_fields_from_pdf_to_xfdf_in_storage**](docs/PdfApi.md#get_export_fields_from_pdf_to_xfdf_in_storage) | **GET** /pdf/\{name}/export/xfdf | Export fields from from PDF in storage to XFDF file.
+*PdfApi* | [**get_export_fields_from_pdf_to_xml_in_storage**](docs/PdfApi.md#get_export_fields_from_pdf_to_xml_in_storage) | **GET** /pdf/\{name}/export/xml | Export fields from from PDF in storage to XML file.
*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_file_versions**](docs/PdfApi.md#get_file_versions) | **GET** /pdf/storage/version/\{path} | Get file versions
+*PdfApi* | [**get_files_list**](docs/PdfApi.md#get_files_list) | **GET** /pdf/storage/folder/\{path} | Get all files and folders within a folder
*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.
@@ -162,14 +175,13 @@ Class | Method | HTTP request | Description
*PdfApi* | [**get_image_extract_as_png**](docs/PdfApi.md#get_image_extract_as_png) | **GET** /pdf/\{name}/images/\{imageId}/extract/png | Extract document image in PNG format
*PdfApi* | [**get_image_extract_as_tiff**](docs/PdfApi.md#get_image_extract_as_tiff) | **GET** /pdf/\{name}/images/\{imageId}/extract/tiff | Extract document image in TIFF format
*PdfApi* | [**get_images**](docs/PdfApi.md#get_images) | **GET** /pdf/\{name}/pages/\{pageNumber}/images | Read document images.
+*PdfApi* | [**get_import_fields_from_fdf_in_storage**](docs/PdfApi.md#get_import_fields_from_fdf_in_storage) | **GET** /pdf/\{name}/import/fdf | Update fields from FDF file in storage.
+*PdfApi* | [**get_import_fields_from_xfdf_in_storage**](docs/PdfApi.md#get_import_fields_from_xfdf_in_storage) | **GET** /pdf/\{name}/import/xfdf | Update fields from XFDF file in storage.
+*PdfApi* | [**get_import_fields_from_xml_in_storage**](docs/PdfApi.md#get_import_fields_from_xml_in_storage) | **GET** /pdf/\{name}/import/xml | Import from XML file (located on storage) to PDF format and return resulting file in response.
*PdfApi* | [**get_ink_annotation**](docs/PdfApi.md#get_ink_annotation) | **GET** /pdf/\{name}/annotations/ink/\{annotationId} | Read document page ink annotation by ID.
-*PdfApi* | [**get_is_exist**](docs/PdfApi.md#get_is_exist) | **GET** /storage/exist | Check if a specific file or folder exists
-*PdfApi* | [**get_is_storage_exist**](docs/PdfApi.md#get_is_storage_exist) | **GET** /storage/\{name}/exist | Check if storage exists
*PdfApi* | [**get_la_te_x_in_storage_to_pdf**](docs/PdfApi.md#get_la_te_x_in_storage_to_pdf) | **GET** /pdf/create/latex | Convert LaTeX file (located on storage) to PDF format and return resulting file in response.
*PdfApi* | [**get_line_annotation**](docs/PdfApi.md#get_line_annotation) | **GET** /pdf/\{name}/annotations/line/\{annotationId} | Read document page line annotation by ID.
*PdfApi* | [**get_link_annotation**](docs/PdfApi.md#get_link_annotation) | **GET** /pdf/\{name}/links/\{linkId} | Read document link annotation by ID.
-*PdfApi* | [**get_list_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.
@@ -246,7 +258,11 @@ Class | Method | HTTP request | Description
*PdfApi* | [**get_xml_in_storage_to_pdf**](docs/PdfApi.md#get_xml_in_storage_to_pdf) | **GET** /pdf/create/xml | Convert XML file (located on storage) to PDF format and return resulting file in response.
*PdfApi* | [**get_xps_in_storage_to_pdf**](docs/PdfApi.md#get_xps_in_storage_to_pdf) | **GET** /pdf/create/xps | Convert XPS file (located on storage) to PDF format and return resulting file in response.
*PdfApi* | [**get_xsl_fo_in_storage_to_pdf**](docs/PdfApi.md#get_xsl_fo_in_storage_to_pdf) | **GET** /pdf/create/xslfo | Convert XslFo file (located on storage) to PDF format and return resulting file in response.
+*PdfApi* | [**move_file**](docs/PdfApi.md#move_file) | **PUT** /pdf/storage/file/move/\{srcPath} | Move file
+*PdfApi* | [**move_folder**](docs/PdfApi.md#move_folder) | **PUT** /pdf/storage/folder/move/\{srcPath} | Move folder
+*PdfApi* | [**object_exists**](docs/PdfApi.md#object_exists) | **GET** /pdf/storage/exist/\{path} | Check if file or folder exists
*PdfApi* | [**post_append_document**](docs/PdfApi.md#post_append_document) | **POST** /pdf/\{name}/appendDocument | Append document to existing one.
+*PdfApi* | [**post_bookmark**](docs/PdfApi.md#post_bookmark) | **POST** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Add document bookmarks.
*PdfApi* | [**post_change_password_document_in_storage**](docs/PdfApi.md#post_change_password_document_in_storage) | **POST** /pdf/\{name}/changepassword | Change document password in storage.
*PdfApi* | [**post_create_field**](docs/PdfApi.md#post_create_field) | **POST** /pdf/\{name}/fields | Create field.
*PdfApi* | [**post_decrypt_document_in_storage**](docs/PdfApi.md#post_decrypt_document_in_storage) | **POST** /pdf/\{name}/decrypt | Decrypt document in storage.
@@ -258,9 +274,10 @@ Class | Method | HTTP request | Description
*PdfApi* | [**post_document_text_replace**](docs/PdfApi.md#post_document_text_replace) | **POST** /pdf/\{name}/text/replace | Document's replace text method.
*PdfApi* | [**post_encrypt_document_in_storage**](docs/PdfApi.md#post_encrypt_document_in_storage) | **POST** /pdf/\{name}/encrypt | Encrypt document in storage.
*PdfApi* | [**post_flatten_document**](docs/PdfApi.md#post_flatten_document) | **POST** /pdf/\{name}/flatten | Flatten the document.
+*PdfApi* | [**post_import_fields_from_fdf**](docs/PdfApi.md#post_import_fields_from_fdf) | **POST** /pdf/\{name}/import/fdf | Update fields from FDF file in request.
+*PdfApi* | [**post_import_fields_from_xfdf**](docs/PdfApi.md#post_import_fields_from_xfdf) | **POST** /pdf/\{name}/import/xfdf | Update fields from XFDF file in request.
+*PdfApi* | [**post_import_fields_from_xml**](docs/PdfApi.md#post_import_fields_from_xml) | **POST** /pdf/\{name}/import/xml | Update fields from XML file in request.
*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
*PdfApi* | [**post_move_page**](docs/PdfApi.md#post_move_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/movePage | Move page to new position.
*PdfApi* | [**post_optimize_document**](docs/PdfApi.md#post_optimize_document) | **POST** /pdf/\{name}/optimize | Optimize document.
*PdfApi* | [**post_page_caret_annotations**](docs/PdfApi.md#post_page_caret_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Add document page caret annotations.
@@ -295,15 +312,17 @@ Class | Method | HTTP request | Description
*PdfApi* | [**put_add_new_page**](docs/PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
*PdfApi* | [**put_add_text**](docs/PdfApi.md#put_add_text) | **PUT** /pdf/\{name}/pages/\{pageNumber}/text | Add text to PDF document page.
*PdfApi* | [**put_annotations_flatten**](docs/PdfApi.md#put_annotations_flatten) | **PUT** /pdf/\{name}/annotations/flatten | Flattens the annotations of the specified types
+*PdfApi* | [**put_bookmark**](docs/PdfApi.md#put_bookmark) | **PUT** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Update document bookmark.
*PdfApi* | [**put_caret_annotation**](docs/PdfApi.md#put_caret_annotation) | **PUT** /pdf/\{name}/annotations/caret/\{annotationId} | Replace document caret annotation
*PdfApi* | [**put_change_password_document**](docs/PdfApi.md#put_change_password_document) | **PUT** /pdf/changepassword | Change document password from content.
*PdfApi* | [**put_circle_annotation**](docs/PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation
-*PdfApi* | [**put_create**](docs/PdfApi.md#put_create) | **PUT** /storage/file | Upload a specific file
*PdfApi* | [**put_create_document**](docs/PdfApi.md#put_create_document) | **PUT** /pdf/\{name} | Create empty document.
-*PdfApi* | [**put_create_folder**](docs/PdfApi.md#put_create_folder) | **PUT** /storage/folder | Create the folder
*PdfApi* | [**put_decrypt_document**](docs/PdfApi.md#put_decrypt_document) | **PUT** /pdf/decrypt | Decrypt document from content.
*PdfApi* | [**put_encrypt_document**](docs/PdfApi.md#put_encrypt_document) | **PUT** /pdf/encrypt | Encrypt document from content.
*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_export_fields_from_pdf_to_fdf_in_storage**](docs/PdfApi.md#put_export_fields_from_pdf_to_fdf_in_storage) | **PUT** /pdf/\{name}/export/fdf | Export fields from from PDF in storage to FDF file in storage.
+*PdfApi* | [**put_export_fields_from_pdf_to_xfdf_in_storage**](docs/PdfApi.md#put_export_fields_from_pdf_to_xfdf_in_storage) | **PUT** /pdf/\{name}/export/xfdf | Export fields from from PDF in storage to XFDF file in storage.
+*PdfApi* | [**put_export_fields_from_pdf_to_xml_in_storage**](docs/PdfApi.md#put_export_fields_from_pdf_to_xml_in_storage) | **PUT** /pdf/\{name}/export/xml | Export fields from from PDF in storage to XML file in 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
@@ -319,6 +338,9 @@ Class | Method | HTTP request | Description
*PdfApi* | [**put_images_extract_as_jpeg**](docs/PdfApi.md#put_images_extract_as_jpeg) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/jpeg | Extract document images in JPEG format to folder.
*PdfApi* | [**put_images_extract_as_png**](docs/PdfApi.md#put_images_extract_as_png) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/png | Extract document images in PNG format to folder.
*PdfApi* | [**put_images_extract_as_tiff**](docs/PdfApi.md#put_images_extract_as_tiff) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/tiff | Extract document images in TIFF format to folder.
+*PdfApi* | [**put_import_fields_from_fdf_in_storage**](docs/PdfApi.md#put_import_fields_from_fdf_in_storage) | **PUT** /pdf/\{name}/import/fdf | Update fields from FDF file in storage.
+*PdfApi* | [**put_import_fields_from_xfdf_in_storage**](docs/PdfApi.md#put_import_fields_from_xfdf_in_storage) | **PUT** /pdf/\{name}/import/xfdf | Update fields from XFDF file in storage.
+*PdfApi* | [**put_import_fields_from_xml_in_storage**](docs/PdfApi.md#put_import_fields_from_xml_in_storage) | **PUT** /pdf/\{name}/import/xml | Update fields from XML file in storage.
*PdfApi* | [**put_ink_annotation**](docs/PdfApi.md#put_ink_annotation) | **PUT** /pdf/\{name}/annotations/ink/\{annotationId} | Replace document ink annotation
*PdfApi* | [**put_la_te_x_in_storage_to_pdf**](docs/PdfApi.md#put_la_te_x_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/latex | Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage.
*PdfApi* | [**put_line_annotation**](docs/PdfApi.md#put_line_annotation) | **PUT** /pdf/\{name}/annotations/line/\{annotationId} | Replace document line annotation
@@ -390,6 +412,8 @@ Class | Method | HTTP request | Description
*PdfApi* | [**put_xml_in_storage_to_pdf**](docs/PdfApi.md#put_xml_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/xml | Convert XML file (located on storage) to PDF format and upload resulting file to storage.
*PdfApi* | [**put_xps_in_storage_to_pdf**](docs/PdfApi.md#put_xps_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/xps | Convert XPS file (located on storage) to PDF format and upload resulting file to storage.
*PdfApi* | [**put_xsl_fo_in_storage_to_pdf**](docs/PdfApi.md#put_xsl_fo_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/xslfo | Convert XslFo file (located on storage) to PDF format and upload resulting file to storage.
+*PdfApi* | [**storage_exists**](docs/PdfApi.md#storage_exists) | **GET** /pdf/storage/\{storageName}/exist | Check if storage exists
+*PdfApi* | [**upload_file**](docs/PdfApi.md#upload_file) | **PUT** /pdf/storage/file/\{path} | Upload file
## Documentation For Models
@@ -398,7 +422,6 @@ Class | Method | HTTP request | Description
- [AnnotationState](docs/AnnotationState.md)
- [AnnotationType](docs/AnnotationType.md)
- [AntialiasingProcessingType](docs/AntialiasingProcessingType.md)
- - [AppendDocument](docs/AppendDocument.md)
- [AsposeResponse](docs/AsposeResponse.md)
- [BorderCornerStyle](docs/BorderCornerStyle.md)
- [BorderInfo](docs/BorderInfo.md)
@@ -417,10 +440,13 @@ Class | Method | HTTP request | Description
- [DocRecognitionMode](docs/DocRecognitionMode.md)
- [DocumentPrivilege](docs/DocumentPrivilege.md)
- [EpubRecognitionMode](docs/EpubRecognitionMode.md)
+ - [Error](docs/Error.md)
+ - [ErrorDetails](docs/ErrorDetails.md)
- [FieldType](docs/FieldType.md)
- - [File](docs/File.md)
- - [FileExist](docs/FileExist.md)
- [FileIcon](docs/FileIcon.md)
+ - [FileVersions](docs/FileVersions.md)
+ - [FilesList](docs/FilesList.md)
+ - [FilesUploadResult](docs/FilesUploadResult.md)
- [FontEncodingRules](docs/FontEncodingRules.md)
- [FontSavingModes](docs/FontSavingModes.md)
- [FontStyles](docs/FontStyles.md)
@@ -443,6 +469,7 @@ Class | Method | HTTP request | Description
- [LinkHighlightingMode](docs/LinkHighlightingMode.md)
- [MarginInfo](docs/MarginInfo.md)
- [MergeDocuments](docs/MergeDocuments.md)
+ - [ObjectExist](docs/ObjectExist.md)
- [OptimizeOptions](docs/OptimizeOptions.md)
- [PageWordCount](docs/PageWordCount.md)
- [Paragraph](docs/Paragraph.md)
@@ -467,6 +494,8 @@ Class | Method | HTTP request | Description
- [Stamp](docs/Stamp.md)
- [StampIcon](docs/StampIcon.md)
- [StampType](docs/StampType.md)
+ - [StorageExist](docs/StorageExist.md)
+ - [StorageFile](docs/StorageFile.md)
- [TableBroken](docs/TableBroken.md)
- [TextHorizontalAlignment](docs/TextHorizontalAlignment.md)
- [TextIcon](docs/TextIcon.md)
@@ -487,13 +516,16 @@ Class | Method | HTTP request | Description
- [AttachmentResponse](docs/AttachmentResponse.md)
- [Attachments](docs/Attachments.md)
- [AttachmentsResponse](docs/AttachmentsResponse.md)
+ - [Bookmark](docs/Bookmark.md)
+ - [BookmarkResponse](docs/BookmarkResponse.md)
+ - [Bookmarks](docs/Bookmarks.md)
+ - [BookmarksResponse](docs/BookmarksResponse.md)
- [CaretAnnotationResponse](docs/CaretAnnotationResponse.md)
- [CaretAnnotations](docs/CaretAnnotations.md)
- [CaretAnnotationsResponse](docs/CaretAnnotationsResponse.md)
- [CircleAnnotationResponse](docs/CircleAnnotationResponse.md)
- [CircleAnnotations](docs/CircleAnnotations.md)
- [CircleAnnotationsResponse](docs/CircleAnnotationsResponse.md)
- - [DiscUsageResponse](docs/DiscUsageResponse.md)
- [Document](docs/Document.md)
- [DocumentPageResponse](docs/DocumentPageResponse.md)
- [DocumentPagesResponse](docs/DocumentPagesResponse.md)
@@ -509,10 +541,7 @@ Class | Method | HTTP request | Description
- [FileAttachmentAnnotationResponse](docs/FileAttachmentAnnotationResponse.md)
- [FileAttachmentAnnotations](docs/FileAttachmentAnnotations.md)
- [FileAttachmentAnnotationsResponse](docs/FileAttachmentAnnotationsResponse.md)
- - [FileExistResponse](docs/FileExistResponse.md)
- [FileVersion](docs/FileVersion.md)
- - [FileVersionsResponse](docs/FileVersionsResponse.md)
- - [FilesResponse](docs/FilesResponse.md)
- [FreeTextAnnotationResponse](docs/FreeTextAnnotationResponse.md)
- [FreeTextAnnotations](docs/FreeTextAnnotations.md)
- [FreeTextAnnotationsResponse](docs/FreeTextAnnotationsResponse.md)
@@ -572,7 +601,6 @@ Class | Method | HTTP request | Description
- [StampInfo](docs/StampInfo.md)
- [StampsInfo](docs/StampsInfo.md)
- [StampsInfoResponse](docs/StampsInfoResponse.md)
- - [StorageExistResponse](docs/StorageExistResponse.md)
- [StrikeOutAnnotationResponse](docs/StrikeOutAnnotationResponse.md)
- [StrikeOutAnnotations](docs/StrikeOutAnnotations.md)
- [StrikeOutAnnotationsResponse](docs/StrikeOutAnnotationsResponse.md)
diff --git a/asposepdfcloud/__init__.py b/asposepdfcloud/__init__.py
index 0dbdec7..9d0689b 100644
--- a/asposepdfcloud/__init__.py
+++ b/asposepdfcloud/__init__.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -35,7 +35,6 @@
from .models.annotation_state import AnnotationState
from .models.annotation_type import AnnotationType
from .models.antialiasing_processing_type import AntialiasingProcessingType
-from .models.append_document import AppendDocument
from .models.aspose_response import AsposeResponse
from .models.border_corner_style import BorderCornerStyle
from .models.border_info import BorderInfo
@@ -54,10 +53,13 @@
from .models.doc_recognition_mode import DocRecognitionMode
from .models.document_privilege import DocumentPrivilege
from .models.epub_recognition_mode import EpubRecognitionMode
+from .models.error import Error
+from .models.error_details import ErrorDetails
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.file_versions import FileVersions
+from .models.files_list import FilesList
+from .models.files_upload_result import FilesUploadResult
from .models.font_encoding_rules import FontEncodingRules
from .models.font_saving_modes import FontSavingModes
from .models.font_styles import FontStyles
@@ -80,6 +82,7 @@
from .models.link_highlighting_mode import LinkHighlightingMode
from .models.margin_info import MarginInfo
from .models.merge_documents import MergeDocuments
+from .models.object_exist import ObjectExist
from .models.optimize_options import OptimizeOptions
from .models.page_word_count import PageWordCount
from .models.paragraph import Paragraph
@@ -104,6 +107,8 @@
from .models.stamp import Stamp
from .models.stamp_icon import StampIcon
from .models.stamp_type import StampType
+from .models.storage_exist import StorageExist
+from .models.storage_file import StorageFile
from .models.table_broken import TableBroken
from .models.text_horizontal_alignment import TextHorizontalAlignment
from .models.text_icon import TextIcon
@@ -124,13 +129,16 @@
from .models.attachment_response import AttachmentResponse
from .models.attachments import Attachments
from .models.attachments_response import AttachmentsResponse
+from .models.bookmark import Bookmark
+from .models.bookmark_response import BookmarkResponse
+from .models.bookmarks import Bookmarks
+from .models.bookmarks_response import BookmarksResponse
from .models.caret_annotation_response import CaretAnnotationResponse
from .models.caret_annotations import CaretAnnotations
from .models.caret_annotations_response import CaretAnnotationsResponse
from .models.circle_annotation_response import CircleAnnotationResponse
from .models.circle_annotations import CircleAnnotations
from .models.circle_annotations_response import CircleAnnotationsResponse
-from .models.disc_usage_response import DiscUsageResponse
from .models.document import Document
from .models.document_page_response import DocumentPageResponse
from .models.document_pages_response import DocumentPagesResponse
@@ -146,10 +154,7 @@
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
-from .models.files_response import FilesResponse
from .models.free_text_annotation_response import FreeTextAnnotationResponse
from .models.free_text_annotations import FreeTextAnnotations
from .models.free_text_annotations_response import FreeTextAnnotationsResponse
@@ -209,7 +214,6 @@
from .models.stamp_info import StampInfo
from .models.stamps_info import StampsInfo
from .models.stamps_info_response import StampsInfoResponse
-from .models.storage_exist_response import StorageExistResponse
from .models.strike_out_annotation_response import StrikeOutAnnotationResponse
from .models.strike_out_annotations import StrikeOutAnnotations
from .models.strike_out_annotations_response import StrikeOutAnnotationsResponse
diff --git a/asposepdfcloud/api_client.py b/asposepdfcloud/api_client.py
index 486e380..0329f01 100644
--- a/asposepdfcloud/api_client.py
+++ b/asposepdfcloud/api_client.py
@@ -22,7 +22,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -192,7 +192,7 @@ def __call_api(self, resource_path, method,
_request_timeout=_request_timeout)
except ApiException as error:
if error.status == 401:
- self.__refresh_token()
+ self.__request_token()
self.__add_o_auth_token(header_params)
response_data = self.request(method, url,
query_params=query_params,
@@ -240,10 +240,10 @@ def __request_token(self):
}
# resource path
- resource_path = "/oauth2/token"
+ resource_path = "/connect/token"
# request url
- url = self.host.replace("/v2.0", "") + resource_path
+ url = self.host.replace("/v3.0", "") + resource_path
# perform request and return response
response_data = self.request(method, url,
@@ -252,36 +252,7 @@ def __request_token(self):
data = json.loads(str(response_data.data))
config.access_token = data['access_token']
- config.refresh_token = data['refresh_token']
- def __refresh_token(self):
- config = Configuration()
-
- # header parameters
- header_params = {"Content-Type" : "application/x-www-form-urlencoded"}
-
- method = 'POST'
-
- # post params
- post_params = {
- "grant_type" : "refresh_token",
- "refresh_token" : config.refresh_token
- }
-
- # resource path
- resource_path = "/oauth2/token"
-
- # request url
- url = self.host.replace("/v2.0", "") + resource_path
-
- # perform request and return response
- response_data = self.request(method, url,
- headers=header_params,
- post_params=post_params)
-
- data = json.loads(str(response_data.data))
- config.access_token = data['access_token']
- config.refresh_token = data['refresh_token']
def __add_o_auth_token(self, header_params):
config = Configuration()
diff --git a/asposepdfcloud/apis/__init__.py b/asposepdfcloud/apis/__init__.py
index 439a651..dcca3ae 100644
--- a/asposepdfcloud/apis/__init__.py
+++ b/asposepdfcloud/apis/__init__.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/apis/pdf_api.py b/asposepdfcloud/apis/pdf_api.py
index ed21b60..dc0172e 100644
--- a/asposepdfcloud/apis/pdf_api.py
+++ b/asposepdfcloud/apis/pdf_api.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -57,57 +57,59 @@ def __init__(self, api_client=None):
config.api_client = ApiClient(None, None)
self.api_client = config.api_client
- def delete_annotation(self, name, annotation_id, **kwargs):
+ def copy_file(self, src_path, dest_path, **kwargs):
"""
- Delete document annotation by ID
+ Copy 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.delete_annotation(name, annotation_id, callback=callback_function)
+ >>> thread = api.copy_file(src_path, dest_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 storage: The document storage.
- :param str folder: The document folder.
- :return: AsposeResponse
+ :param str src_path: Source file path e.g. '/folder/file.ext' (required)
+ :param str dest_path: Destination file path (required)
+ :param str src_storage_name: Source storage name
+ :param str dest_storage_name: Destination storage name
+ :param str version_id: File version ID to copy
+ :return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_annotation_with_http_info(name, annotation_id, **kwargs)
+ return self.copy_file_with_http_info(src_path, dest_path, **kwargs)
else:
- (data) = self.delete_annotation_with_http_info(name, annotation_id, **kwargs)
+ (data) = self.copy_file_with_http_info(src_path, dest_path, **kwargs)
return data
- def delete_annotation_with_http_info(self, name, annotation_id, **kwargs):
+ def copy_file_with_http_info(self, src_path, dest_path, **kwargs):
"""
- Delete document annotation by ID
+ Copy 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.delete_annotation_with_http_info(name, annotation_id, callback=callback_function)
+ >>> thread = api.copy_file_with_http_info(src_path, dest_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 storage: The document storage.
- :param str folder: The document folder.
- :return: AsposeResponse
+ :param str src_path: Source file path e.g. '/folder/file.ext' (required)
+ :param str dest_path: Destination file path (required)
+ :param str src_storage_name: Source storage name
+ :param str dest_storage_name: Destination storage name
+ :param str version_id: File version ID to copy
+ :return: None
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'annotation_id', 'storage', 'folder']
+ all_params = ['src_path', 'dest_path', 'src_storage_name', 'dest_storage_name', 'version_id']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -118,31 +120,33 @@ def delete_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 delete_annotation" % key
+ " to method copy_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 `delete_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 `delete_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 `copy_file`")
+ # verify the required parameter 'dest_path' is set
+ if ('dest_path' not in params) or (params['dest_path'] is None):
+ raise ValueError("Missing the required parameter `dest_path` when calling `copy_file`")
collection_formats = {}
path_params = {}
- if 'name' in params:
- path_params['name'] = params['name']
- if 'annotation_id' in params:
- path_params['annotationId'] = params['annotation_id']
+ if 'src_path' in params:
+ path_params['srcPath'] = params['src_path']
query_params = []
- if 'storage' in params:
- query_params.append(('storage', params['storage']))
- if 'folder' in params:
- query_params.append(('folder', params['folder']))
+ if 'dest_path' in params:
+ query_params.append(('destPath', params['dest_path']))
+ if 'src_storage_name' in params:
+ query_params.append(('srcStorageName', params['src_storage_name']))
+ if 'dest_storage_name' in params:
+ query_params.append(('destStorageName', params['dest_storage_name']))
+ if 'version_id' in params:
+ query_params.append(('versionId', params['version_id']))
header_params = {}
@@ -159,16 +163,16 @@ def delete_annotation_with_http_info(self, name, annotation_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/{annotationId}', 'DELETE',
+ return self.api_client.call_api('/pdf/storage/file/copy/{srcPath}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='AsposeResponse',
+ response_type=None,
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -176,55 +180,57 @@ def delete_annotation_with_http_info(self, name, annotation_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_document_annotations(self, name, **kwargs):
+ def copy_folder(self, src_path, dest_path, **kwargs):
"""
- Delete all annotations from the document
+ Copy 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.delete_document_annotations(name, callback=callback_function)
+ >>> thread = api.copy_folder(src_path, dest_path, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: The document name. (required)
- :param str storage: The document storage.
- :param str folder: The document folder.
- :return: AsposeResponse
+ :param str src_path: Source folder path e.g. '/src' (required)
+ :param str dest_path: Destination folder path e.g. '/dst' (required)
+ :param str src_storage_name: Source storage name
+ :param str dest_storage_name: Destination storage name
+ :return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_document_annotations_with_http_info(name, **kwargs)
+ return self.copy_folder_with_http_info(src_path, dest_path, **kwargs)
else:
- (data) = self.delete_document_annotations_with_http_info(name, **kwargs)
+ (data) = self.copy_folder_with_http_info(src_path, dest_path, **kwargs)
return data
- def delete_document_annotations_with_http_info(self, name, **kwargs):
+ def copy_folder_with_http_info(self, src_path, dest_path, **kwargs):
"""
- Delete all annotations from the document
+ Copy 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.delete_document_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.copy_folder_with_http_info(src_path, dest_path, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: The document name. (required)
- :param str storage: The document storage.
- :param str folder: The document folder.
- :return: AsposeResponse
+ :param str src_path: Source folder path e.g. '/src' (required)
+ :param str dest_path: Destination folder path e.g. '/dst' (required)
+ :param str src_storage_name: Source storage name
+ :param str dest_storage_name: Destination storage name
+ :return: None
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'storage', 'folder']
+ all_params = ['src_path', 'dest_path', 'src_storage_name', 'dest_storage_name']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -235,26 +241,31 @@ def delete_document_annotations_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_document_annotations" % key
+ " to method copy_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 `delete_document_annotations`")
+ # verify the required parameter 'src_path' is set
+ if ('src_path' not in params) or (params['src_path'] is None):
+ raise ValueError("Missing the required parameter `src_path` when calling `copy_folder`")
+ # verify the required parameter 'dest_path' is set
+ if ('dest_path' not in params) or (params['dest_path'] is None):
+ raise ValueError("Missing the required parameter `dest_path` when calling `copy_folder`")
collection_formats = {}
path_params = {}
- if 'name' in params:
- path_params['name'] = params['name']
+ if 'src_path' in params:
+ path_params['srcPath'] = params['src_path']
query_params = []
- if 'storage' in params:
- query_params.append(('storage', params['storage']))
- if 'folder' in params:
- query_params.append(('folder', params['folder']))
+ if 'dest_path' in params:
+ query_params.append(('destPath', params['dest_path']))
+ if 'src_storage_name' in params:
+ query_params.append(('srcStorageName', params['src_storage_name']))
+ if 'dest_storage_name' in params:
+ query_params.append(('destStorageName', params['dest_storage_name']))
header_params = {}
@@ -271,16 +282,16 @@ def delete_document_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations', 'DELETE',
+ return self.api_client.call_api('/pdf/storage/folder/copy/{srcPath}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='AsposeResponse',
+ response_type=None,
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -288,55 +299,53 @@ def delete_document_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_document_link_annotations(self, name, **kwargs):
+ def create_folder(self, path, **kwargs):
"""
- Delete all link annotations from the document
+ 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.delete_document_link_annotations(name, callback=callback_function)
+ >>> thread = api.create_folder(path, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: The document name. (required)
- :param str storage: The document storage.
- :param str folder: The document folder.
- :return: AsposeResponse
+ :param str path: Folder path to create e.g. 'folder_1/folder_2/' (required)
+ :param str storage_name: Storage name
+ :return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_document_link_annotations_with_http_info(name, **kwargs)
+ return self.create_folder_with_http_info(path, **kwargs)
else:
- (data) = self.delete_document_link_annotations_with_http_info(name, **kwargs)
+ (data) = self.create_folder_with_http_info(path, **kwargs)
return data
- def delete_document_link_annotations_with_http_info(self, name, **kwargs):
+ def create_folder_with_http_info(self, path, **kwargs):
"""
- Delete all link annotations from the document
+ 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.delete_document_link_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.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 str storage: The document storage.
- :param str folder: The document folder.
- :return: AsposeResponse
+ :param str path: Folder path to create e.g. 'folder_1/folder_2/' (required)
+ :param str storage_name: Storage name
+ :return: None
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'storage', 'folder']
+ all_params = ['path', 'storage_name']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -347,26 +356,24 @@ def delete_document_link_annotations_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_document_link_annotations" % key
+ " to method 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 `delete_document_link_annotations`")
+ # 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 `create_folder`")
collection_formats = {}
path_params = {}
- if 'name' in params:
- path_params['name'] = params['name']
+ if 'path' in params:
+ path_params['path'] = params['path']
query_params = []
- if 'storage' in params:
- query_params.append(('storage', params['storage']))
- if 'folder' in params:
- query_params.append(('folder', params['folder']))
+ if 'storage_name' in params:
+ query_params.append(('storageName', params['storage_name']))
header_params = {}
@@ -383,16 +390,16 @@ def delete_document_link_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/links', 'DELETE',
+ return self.api_client.call_api('/pdf/storage/folder/{path}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='AsposeResponse',
+ response_type=None,
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -400,20 +407,21 @@ def delete_document_link_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_document_stamps(self, name, **kwargs):
+ def delete_annotation(self, name, annotation_id, **kwargs):
"""
- Delete all stamps from the document
+ Delete document 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.delete_document_stamps(name, callback=callback_function)
+ >>> thread = api.delete_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: AsposeResponse
@@ -422,25 +430,26 @@ def delete_document_stamps(self, name, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_document_stamps_with_http_info(name, **kwargs)
+ return self.delete_annotation_with_http_info(name, annotation_id, **kwargs)
else:
- (data) = self.delete_document_stamps_with_http_info(name, **kwargs)
+ (data) = self.delete_annotation_with_http_info(name, annotation_id, **kwargs)
return data
- def delete_document_stamps_with_http_info(self, name, **kwargs):
+ def delete_annotation_with_http_info(self, name, annotation_id, **kwargs):
"""
- Delete all stamps from the document
+ Delete document 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.delete_document_stamps_with_http_info(name, callback=callback_function)
+ >>> thread = api.delete_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: AsposeResponse
@@ -448,7 +457,7 @@ def delete_document_stamps_with_http_info(self, name, **kwargs):
returns the request thread.
"""
- all_params = ['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')
@@ -459,13 +468,16 @@ def delete_document_stamps_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_document_stamps" % key
+ " to method delete_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 `delete_document_stamps`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_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 `delete_annotation`")
collection_formats = {}
@@ -473,6 +485,8 @@ def delete_document_stamps_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:
@@ -495,9 +509,9 @@ def delete_document_stamps_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/stamps', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/annotations/{annotationId}', 'DELETE',
path_params,
query_params,
header_params,
@@ -512,55 +526,57 @@ def delete_document_stamps_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_document_tables(self, name, **kwargs):
+ def delete_bookmark(self, name, bookmark_path, **kwargs):
"""
- Delete all tables from the document
+ Delete document bookmark 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.delete_document_tables(name, callback=callback_function)
+ >>> thread = api.delete_bookmark(name, bookmark_path, 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 bookmark_path: The bookmark path. (required)
: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.delete_document_tables_with_http_info(name, **kwargs)
+ return self.delete_bookmark_with_http_info(name, bookmark_path, **kwargs)
else:
- (data) = self.delete_document_tables_with_http_info(name, **kwargs)
+ (data) = self.delete_bookmark_with_http_info(name, bookmark_path, **kwargs)
return data
- def delete_document_tables_with_http_info(self, name, **kwargs):
+ def delete_bookmark_with_http_info(self, name, bookmark_path, **kwargs):
"""
- Delete all tables from the document
+ Delete document bookmark 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.delete_document_tables_with_http_info(name, callback=callback_function)
+ >>> thread = api.delete_bookmark_with_http_info(name, bookmark_path, 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 bookmark_path: The bookmark path. (required)
: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', 'storage', 'folder']
+ all_params = ['name', 'bookmark_path', 'folder', 'storage']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -571,13 +587,16 @@ def delete_document_tables_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_document_tables" % key
+ " to method delete_bookmark" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `delete_document_tables`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_bookmark`")
+ # verify the required parameter 'bookmark_path' is set
+ if ('bookmark_path' not in params) or (params['bookmark_path'] is None):
+ raise ValueError("Missing the required parameter `bookmark_path` when calling `delete_bookmark`")
collection_formats = {}
@@ -585,12 +604,14 @@ def delete_document_tables_with_http_info(self, name, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
+ if 'bookmark_path' in params:
+ path_params['bookmarkPath'] = params['bookmark_path']
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 = {}
@@ -607,9 +628,9 @@ def delete_document_tables_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/tables', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/bookmarks/bookmark/{bookmarkPath}', 'DELETE',
path_params,
query_params,
header_params,
@@ -624,21 +645,20 @@ def delete_document_tables_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_field(self, name, field_name, **kwargs):
+ def delete_document_annotations(self, name, **kwargs):
"""
- Delete document field by name.
+ Delete all annotations from 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.delete_field(name, field_name, callback=callback_function)
+ >>> thread = api.delete_document_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str field_name: The field name/ (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -647,26 +667,25 @@ def delete_field(self, name, field_name, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_field_with_http_info(name, field_name, **kwargs)
+ return self.delete_document_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.delete_field_with_http_info(name, field_name, **kwargs)
+ (data) = self.delete_document_annotations_with_http_info(name, **kwargs)
return data
- def delete_field_with_http_info(self, name, field_name, **kwargs):
+ def delete_document_annotations_with_http_info(self, name, **kwargs):
"""
- Delete document field by name.
+ Delete all annotations from 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.delete_field_with_http_info(name, field_name, callback=callback_function)
+ >>> thread = api.delete_document_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str field_name: The field name/ (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -674,7 +693,7 @@ def delete_field_with_http_info(self, name, field_name, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'field_name', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -685,16 +704,13 @@ def delete_field_with_http_info(self, name, field_name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_field" % key
+ " to method delete_document_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 `delete_field`")
- # verify the required parameter 'field_name' is set
- if ('field_name' not in params) or (params['field_name'] is None):
- raise ValueError("Missing the required parameter `field_name` when calling `delete_field`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_document_annotations`")
collection_formats = {}
@@ -702,8 +718,6 @@ def delete_field_with_http_info(self, name, field_name, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'field_name' in params:
- path_params['fieldName'] = params['field_name']
query_params = []
if 'storage' in params:
@@ -726,9 +740,9 @@ def delete_field_with_http_info(self, name, field_name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/fields/{fieldName}', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/annotations', 'DELETE',
path_params,
query_params,
header_params,
@@ -743,55 +757,55 @@ def delete_field_with_http_info(self, name, field_name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_file(self, path, **kwargs):
+ def delete_document_bookmarks(self, name, **kwargs):
"""
- Remove a specific file
+ Delete all document bookmarks.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.delete_file(path, callback=callback_function)
+ >>> thread = api.delete_document_bookmarks(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str path: Path of the file including file name and extension e.g. /Folder1/file.ext (required)
- :param str version_id: File's version
- :param str storage: User's storage name
+ :param str name: The document name. (required)
+ :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.delete_file_with_http_info(path, **kwargs)
+ return self.delete_document_bookmarks_with_http_info(name, **kwargs)
else:
- (data) = self.delete_file_with_http_info(path, **kwargs)
+ (data) = self.delete_document_bookmarks_with_http_info(name, **kwargs)
return data
- def delete_file_with_http_info(self, path, **kwargs):
+ def delete_document_bookmarks_with_http_info(self, name, **kwargs):
"""
- Remove a specific file
+ Delete all document bookmarks.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.delete_file_with_http_info(path, callback=callback_function)
+ >>> thread = api.delete_document_bookmarks_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str path: Path of the file including file name and extension e.g. /Folder1/file.ext (required)
- :param str version_id: File's version
- :param str storage: User's storage name
+ :param str name: The document name. (required)
+ :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 = ['path', 'version_id', 'storage']
+ all_params = ['name', 'folder', 'storage']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -802,24 +816,24 @@ def delete_file_with_http_info(self, path, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_file" % key
+ " to method delete_document_bookmarks" % 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 `delete_file`")
+ # verify the required parameter 'name' is set
+ if ('name' not in params) or (params['name'] is None):
+ raise ValueError("Missing the required parameter `name` when calling `delete_document_bookmarks`")
collection_formats = {}
path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
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 'folder' in params:
+ query_params.append(('folder', params['folder']))
if 'storage' in params:
query_params.append(('storage', params['storage']))
@@ -838,9 +852,9 @@ def delete_file_with_http_info(self, path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/storage/file', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/bookmarks/tree', 'DELETE',
path_params,
query_params,
header_params,
@@ -855,55 +869,55 @@ def delete_file_with_http_info(self, path, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_folder(self, path, **kwargs):
+ def delete_document_link_annotations(self, name, **kwargs):
"""
- Remove a specific folder
+ Delete all link annotations from 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.delete_folder(path, callback=callback_function)
+ >>> thread = api.delete_document_link_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str path: Folder path e.g. /Folder1 (required)
- :param str storage: User's storage name
- :param bool recursive: Remove recursivelly inner folder/files. If false and folder contains data than exception is raised.
+ :param str name: The document name. (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.delete_folder_with_http_info(path, **kwargs)
+ return self.delete_document_link_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.delete_folder_with_http_info(path, **kwargs)
+ (data) = self.delete_document_link_annotations_with_http_info(name, **kwargs)
return data
- def delete_folder_with_http_info(self, path, **kwargs):
+ def delete_document_link_annotations_with_http_info(self, name, **kwargs):
"""
- Remove a specific folder
+ Delete all link annotations from 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.delete_folder_with_http_info(path, callback=callback_function)
+ >>> thread = api.delete_document_link_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str path: Folder path e.g. /Folder1 (required)
- :param str storage: User's storage name
- :param bool recursive: Remove recursivelly inner folder/files. If false and folder contains data than exception is raised.
+ :param str name: The document name. (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', 'recursive']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -914,26 +928,26 @@ def delete_folder_with_http_info(self, path, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_folder" % key
+ " to method delete_document_link_annotations" % 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 `delete_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 `delete_document_link_annotations`")
collection_formats = {}
path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
query_params = []
- if 'path' in params:
- query_params.append(('path', params['path']))
if 'storage' in params:
query_params.append(('storage', params['storage']))
- if 'recursive' in params:
- query_params.append(('recursive', params['recursive']))
+ if 'folder' in params:
+ query_params.append(('folder', params['folder']))
header_params = {}
@@ -950,9 +964,9 @@ def delete_folder_with_http_info(self, path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/storage/folder', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/links', 'DELETE',
path_params,
query_params,
header_params,
@@ -967,21 +981,20 @@ def delete_folder_with_http_info(self, path, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_image(self, name, image_id, **kwargs):
+ def delete_document_stamps(self, name, **kwargs):
"""
- Delete image from document page.
+ Delete all stamps from 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.delete_image(name, image_id, callback=callback_function)
+ >>> thread = api.delete_document_stamps(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str image_id: Image ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -990,26 +1003,25 @@ def delete_image(self, name, image_id, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_image_with_http_info(name, image_id, **kwargs)
+ return self.delete_document_stamps_with_http_info(name, **kwargs)
else:
- (data) = self.delete_image_with_http_info(name, image_id, **kwargs)
+ (data) = self.delete_document_stamps_with_http_info(name, **kwargs)
return data
- def delete_image_with_http_info(self, name, image_id, **kwargs):
+ def delete_document_stamps_with_http_info(self, name, **kwargs):
"""
- Delete image from document page.
+ Delete all stamps from 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.delete_image_with_http_info(name, image_id, callback=callback_function)
+ >>> thread = api.delete_document_stamps_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str image_id: Image ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -1017,7 +1029,7 @@ def delete_image_with_http_info(self, name, image_id, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'image_id', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -1028,16 +1040,13 @@ def delete_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 delete_image" % key
+ " to method delete_document_stamps" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `delete_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 `delete_image`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_document_stamps`")
collection_formats = {}
@@ -1045,8 +1054,6 @@ def delete_image_with_http_info(self, name, image_id, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'image_id' in params:
- path_params['imageId'] = params['image_id']
query_params = []
if 'storage' in params:
@@ -1069,9 +1076,9 @@ def delete_image_with_http_info(self, name, image_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/images/{imageId}', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/stamps', 'DELETE',
path_params,
query_params,
header_params,
@@ -1086,21 +1093,20 @@ def delete_image_with_http_info(self, name, image_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_link_annotation(self, name, link_id, **kwargs):
+ def delete_document_tables(self, name, **kwargs):
"""
- Delete document page link annotation by ID
+ Delete all tables from 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.delete_link_annotation(name, link_id, callback=callback_function)
+ >>> thread = api.delete_document_tables(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str link_id: The link ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -1109,26 +1115,25 @@ def delete_link_annotation(self, name, link_id, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_link_annotation_with_http_info(name, link_id, **kwargs)
+ return self.delete_document_tables_with_http_info(name, **kwargs)
else:
- (data) = self.delete_link_annotation_with_http_info(name, link_id, **kwargs)
+ (data) = self.delete_document_tables_with_http_info(name, **kwargs)
return data
- def delete_link_annotation_with_http_info(self, name, link_id, **kwargs):
+ def delete_document_tables_with_http_info(self, name, **kwargs):
"""
- Delete document page link annotation by ID
+ Delete all tables from 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.delete_link_annotation_with_http_info(name, link_id, callback=callback_function)
+ >>> thread = api.delete_document_tables_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 link_id: The link ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -1136,7 +1141,7 @@ def delete_link_annotation_with_http_info(self, name, link_id, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'link_id', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -1147,16 +1152,13 @@ def delete_link_annotation_with_http_info(self, name, link_id, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_link_annotation" % key
+ " to method delete_document_tables" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `delete_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 `delete_link_annotation`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_document_tables`")
collection_formats = {}
@@ -1164,8 +1166,6 @@ def delete_link_annotation_with_http_info(self, name, link_id, **kwargs):
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:
@@ -1188,9 +1188,9 @@ def delete_link_annotation_with_http_info(self, name, link_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/links/{linkId}', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/tables', 'DELETE',
path_params,
query_params,
header_params,
@@ -1205,21 +1205,21 @@ def delete_link_annotation_with_http_info(self, name, link_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_page(self, name, page_number, **kwargs):
+ def delete_field(self, name, field_name, **kwargs):
"""
- Delete document page by its number.
+ Delete document field by name.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.delete_page(name, page_number, callback=callback_function)
+ >>> thread = api.delete_field(name, field_name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param int page_number: The page number. (required)
+ :param str field_name: The field name/ (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -1228,26 +1228,26 @@ def delete_page(self, name, page_number, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_page_with_http_info(name, page_number, **kwargs)
+ return self.delete_field_with_http_info(name, field_name, **kwargs)
else:
- (data) = self.delete_page_with_http_info(name, page_number, **kwargs)
+ (data) = self.delete_field_with_http_info(name, field_name, **kwargs)
return data
- def delete_page_with_http_info(self, name, page_number, **kwargs):
+ def delete_field_with_http_info(self, name, field_name, **kwargs):
"""
- Delete document page by its number.
+ Delete document field by name.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.delete_page_with_http_info(name, page_number, callback=callback_function)
+ >>> thread = api.delete_field_with_http_info(name, field_name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param int page_number: The page number. (required)
+ :param str field_name: The field name/ (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -1255,7 +1255,7 @@ def delete_page_with_http_info(self, name, page_number, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'page_number', 'storage', 'folder']
+ all_params = ['name', 'field_name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -1266,16 +1266,16 @@ def delete_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 delete_page" % key
+ " to method delete_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 `delete_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 `delete_page`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_field`")
+ # verify the required parameter 'field_name' is set
+ if ('field_name' not in params) or (params['field_name'] is None):
+ raise ValueError("Missing the required parameter `field_name` when calling `delete_field`")
collection_formats = {}
@@ -1283,8 +1283,8 @@ def delete_page_with_http_info(self, name, page_number, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'page_number' in params:
- path_params['pageNumber'] = params['page_number']
+ if 'field_name' in params:
+ path_params['fieldName'] = params['field_name']
query_params = []
if 'storage' in params:
@@ -1307,9 +1307,9 @@ def delete_page_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/fields/{fieldName}', 'DELETE',
path_params,
query_params,
header_params,
@@ -1324,57 +1324,55 @@ def delete_page_with_http_info(self, name, page_number, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_page_annotations(self, name, page_number, **kwargs):
+ def delete_file(self, path, **kwargs):
"""
- Delete all annotations from the page
+ Delete 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.delete_page_annotations(name, page_number, callback=callback_function)
+ >>> thread = api.delete_file(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 storage: The document storage.
- :param str folder: The document folder.
- :return: AsposeResponse
+ :param str path: File path e.g. '/folder/file.ext' (required)
+ :param str storage_name: Storage name
+ :param str version_id: File version ID to delete
+ :return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_page_annotations_with_http_info(name, page_number, **kwargs)
+ return self.delete_file_with_http_info(path, **kwargs)
else:
- (data) = self.delete_page_annotations_with_http_info(name, page_number, **kwargs)
+ (data) = self.delete_file_with_http_info(path, **kwargs)
return data
- def delete_page_annotations_with_http_info(self, name, page_number, **kwargs):
+ def delete_file_with_http_info(self, path, **kwargs):
"""
- Delete all annotations from the page
+ Delete 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.delete_page_annotations_with_http_info(name, page_number, callback=callback_function)
+ >>> thread = api.delete_file_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 int page_number: The page number. (required)
- :param str storage: The document storage.
- :param str folder: The document folder.
- :return: AsposeResponse
+ :param str path: File path e.g. '/folder/file.ext' (required)
+ :param str storage_name: Storage name
+ :param str version_id: File version ID to delete
+ :return: None
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'page_number', 'storage', 'folder']
+ all_params = ['path', 'storage_name', 'version_id']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -1385,31 +1383,26 @@ def delete_page_annotations_with_http_info(self, name, page_number, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_page_annotations" % key
+ " to method delete_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 `delete_page_annotations`")
- # verify the required parameter 'page_number' is set
- if ('page_number' not in params) or (params['page_number'] is None):
- raise ValueError("Missing the required parameter `page_number` when calling `delete_page_annotations`")
+ # 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 `delete_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']
+ if 'path' in params:
+ path_params['path'] = params['path']
query_params = []
- if 'storage' in params:
- query_params.append(('storage', params['storage']))
- if 'folder' in params:
- query_params.append(('folder', params['folder']))
+ if 'storage_name' in params:
+ query_params.append(('storageName', params['storage_name']))
+ if 'version_id' in params:
+ query_params.append(('versionId', params['version_id']))
header_params = {}
@@ -1426,16 +1419,16 @@ def delete_page_annotations_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations', 'DELETE',
+ return self.api_client.call_api('/pdf/storage/file/{path}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='AsposeResponse',
+ response_type=None,
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -1443,57 +1436,55 @@ def delete_page_annotations_with_http_info(self, name, page_number, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_page_link_annotations(self, name, page_number, **kwargs):
+ def delete_folder(self, path, **kwargs):
"""
- Delete all link annotations from the page
+ Delete 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.delete_page_link_annotations(name, page_number, callback=callback_function)
+ >>> thread = api.delete_folder(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 storage: The document storage.
- :param str folder: The document folder.
- :return: AsposeResponse
+ :param str path: Folder path e.g. '/folder' (required)
+ :param str storage_name: Storage name
+ :param bool recursive: Enable to delete folders, subfolders and files
+ :return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_page_link_annotations_with_http_info(name, page_number, **kwargs)
+ return self.delete_folder_with_http_info(path, **kwargs)
else:
- (data) = self.delete_page_link_annotations_with_http_info(name, page_number, **kwargs)
+ (data) = self.delete_folder_with_http_info(path, **kwargs)
return data
- def delete_page_link_annotations_with_http_info(self, name, page_number, **kwargs):
+ def delete_folder_with_http_info(self, path, **kwargs):
"""
- Delete all link annotations from the page
+ Delete 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.delete_page_link_annotations_with_http_info(name, page_number, callback=callback_function)
+ >>> thread = api.delete_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 int page_number: The page number. (required)
- :param str storage: The document storage.
- :param str folder: The document folder.
- :return: AsposeResponse
+ :param str path: Folder path e.g. '/folder' (required)
+ :param str storage_name: Storage name
+ :param bool recursive: Enable to delete folders, subfolders and files
+ :return: None
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'page_number', 'storage', 'folder']
+ all_params = ['path', 'storage_name', 'recursive']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -1504,31 +1495,26 @@ def delete_page_link_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 delete_page_link_annotations" % key
+ " to method delete_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 `delete_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 `delete_page_link_annotations`")
+ # 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 `delete_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']
+ if 'path' in params:
+ path_params['path'] = params['path']
query_params = []
- if 'storage' in params:
- query_params.append(('storage', params['storage']))
- if 'folder' in params:
- query_params.append(('folder', params['folder']))
+ if 'storage_name' in params:
+ query_params.append(('storageName', params['storage_name']))
+ if 'recursive' in params:
+ query_params.append(('recursive', params['recursive']))
header_params = {}
@@ -1545,16 +1531,16 @@ def delete_page_link_annotations_with_http_info(self, name, page_number, **kwarg
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/links', 'DELETE',
+ return self.api_client.call_api('/pdf/storage/folder/{path}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='AsposeResponse',
+ response_type=None,
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -1562,21 +1548,21 @@ def delete_page_link_annotations_with_http_info(self, name, page_number, **kwarg
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_page_stamps(self, name, page_number, **kwargs):
+ def delete_image(self, name, image_id, **kwargs):
"""
- Delete all stamps from the page
+ Delete image from 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.delete_page_stamps(name, page_number, callback=callback_function)
+ >>> thread = api.delete_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 int page_number: The page number. (required)
+ :param str image_id: Image ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -1585,26 +1571,26 @@ def delete_page_stamps(self, name, page_number, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_page_stamps_with_http_info(name, page_number, **kwargs)
+ return self.delete_image_with_http_info(name, image_id, **kwargs)
else:
- (data) = self.delete_page_stamps_with_http_info(name, page_number, **kwargs)
+ (data) = self.delete_image_with_http_info(name, image_id, **kwargs)
return data
- def delete_page_stamps_with_http_info(self, name, page_number, **kwargs):
+ def delete_image_with_http_info(self, name, image_id, **kwargs):
"""
- Delete all stamps from the page
+ Delete image from 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.delete_page_stamps_with_http_info(name, page_number, callback=callback_function)
+ >>> thread = api.delete_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 int page_number: The page number. (required)
+ :param str image_id: Image ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -1612,7 +1598,7 @@ def delete_page_stamps_with_http_info(self, name, page_number, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'page_number', 'storage', 'folder']
+ all_params = ['name', 'image_id', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -1623,16 +1609,16 @@ def delete_page_stamps_with_http_info(self, name, page_number, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_page_stamps" % key
+ " to method delete_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 `delete_page_stamps`")
- # 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 `delete_page_stamps`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_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 `delete_image`")
collection_formats = {}
@@ -1640,8 +1626,8 @@ def delete_page_stamps_with_http_info(self, name, page_number, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'page_number' in params:
- path_params['pageNumber'] = params['page_number']
+ if 'image_id' in params:
+ path_params['imageId'] = params['image_id']
query_params = []
if 'storage' in params:
@@ -1664,9 +1650,9 @@ def delete_page_stamps_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/stamps', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/images/{imageId}', 'DELETE',
path_params,
query_params,
header_params,
@@ -1681,21 +1667,21 @@ def delete_page_stamps_with_http_info(self, name, page_number, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_page_tables(self, name, page_number, **kwargs):
+ def delete_link_annotation(self, name, link_id, **kwargs):
"""
- Delete all tables from the page
+ Delete document page link annotation by ID
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.delete_page_tables(name, page_number, callback=callback_function)
+ >>> thread = api.delete_link_annotation(name, link_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param int page_number: The page number. (required)
+ :param str link_id: The link ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -1704,26 +1690,26 @@ def delete_page_tables(self, name, page_number, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_page_tables_with_http_info(name, page_number, **kwargs)
+ return self.delete_link_annotation_with_http_info(name, link_id, **kwargs)
else:
- (data) = self.delete_page_tables_with_http_info(name, page_number, **kwargs)
+ (data) = self.delete_link_annotation_with_http_info(name, link_id, **kwargs)
return data
- def delete_page_tables_with_http_info(self, name, page_number, **kwargs):
+ def delete_link_annotation_with_http_info(self, name, link_id, **kwargs):
"""
- Delete all tables from the page
+ Delete document page link annotation by ID
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.delete_page_tables_with_http_info(name, page_number, callback=callback_function)
+ >>> thread = api.delete_link_annotation_with_http_info(name, link_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param int page_number: The page number. (required)
+ :param str link_id: The link ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -1731,7 +1717,7 @@ def delete_page_tables_with_http_info(self, name, page_number, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'page_number', 'storage', 'folder']
+ all_params = ['name', 'link_id', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -1742,16 +1728,16 @@ def delete_page_tables_with_http_info(self, name, page_number, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_page_tables" % key
+ " to method delete_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 `delete_page_tables`")
- # 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 `delete_page_tables`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_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 `delete_link_annotation`")
collection_formats = {}
@@ -1759,8 +1745,8 @@ def delete_page_tables_with_http_info(self, name, page_number, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'page_number' in params:
- path_params['pageNumber'] = params['page_number']
+ if 'link_id' in params:
+ path_params['linkId'] = params['link_id']
query_params = []
if 'storage' in params:
@@ -1783,9 +1769,9 @@ def delete_page_tables_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/tables', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/links/{linkId}', 'DELETE',
path_params,
query_params,
header_params,
@@ -1800,55 +1786,57 @@ def delete_page_tables_with_http_info(self, name, page_number, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_properties(self, name, **kwargs):
+ def delete_page(self, name, page_number, **kwargs):
"""
- Delete custom document properties.
+ Delete document page by its number.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.delete_properties(name, callback=callback_function)
+ >>> thread = api.delete_page(name, page_number, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: (required)
- :param str storage:
- :param str folder:
+ :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: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_properties_with_http_info(name, **kwargs)
+ return self.delete_page_with_http_info(name, page_number, **kwargs)
else:
- (data) = self.delete_properties_with_http_info(name, **kwargs)
+ (data) = self.delete_page_with_http_info(name, page_number, **kwargs)
return data
- def delete_properties_with_http_info(self, name, **kwargs):
+ def delete_page_with_http_info(self, name, page_number, **kwargs):
"""
- Delete custom document properties.
+ Delete document page by its number.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.delete_properties_with_http_info(name, callback=callback_function)
+ >>> thread = api.delete_page_with_http_info(name, page_number, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: (required)
- :param str storage:
- :param str folder:
+ :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: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'storage', 'folder']
+ all_params = ['name', 'page_number', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -1859,13 +1847,16 @@ def delete_properties_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_properties" % key
+ " to method delete_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 `delete_properties`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_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 `delete_page`")
collection_formats = {}
@@ -1873,6 +1864,8 @@ def delete_properties_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:
@@ -1895,9 +1888,9 @@ def delete_properties_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/documentproperties', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}', 'DELETE',
path_params,
query_params,
header_params,
@@ -1912,57 +1905,57 @@ def delete_properties_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_property(self, name, property_name, **kwargs):
+ def delete_page_annotations(self, name, page_number, **kwargs):
"""
- Delete document property.
+ Delete all annotations from the 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.delete_property(name, property_name, callback=callback_function)
+ >>> thread = api.delete_page_annotations(name, page_number, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: (required)
- :param str property_name: (required)
- :param str storage:
- :param str folder:
+ :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: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_property_with_http_info(name, property_name, **kwargs)
+ return self.delete_page_annotations_with_http_info(name, page_number, **kwargs)
else:
- (data) = self.delete_property_with_http_info(name, property_name, **kwargs)
+ (data) = self.delete_page_annotations_with_http_info(name, page_number, **kwargs)
return data
- def delete_property_with_http_info(self, name, property_name, **kwargs):
+ def delete_page_annotations_with_http_info(self, name, page_number, **kwargs):
"""
- Delete document property.
+ Delete all annotations from the 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.delete_property_with_http_info(name, property_name, callback=callback_function)
+ >>> thread = api.delete_page_annotations_with_http_info(name, page_number, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: (required)
- :param str property_name: (required)
- :param str storage:
- :param str folder:
+ :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: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'property_name', 'storage', 'folder']
+ all_params = ['name', 'page_number', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -1973,16 +1966,16 @@ def delete_property_with_http_info(self, name, property_name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_property" % key
+ " to method delete_page_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `delete_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 `delete_property`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_page_annotations`")
+ # verify the required parameter 'page_number' is set
+ if ('page_number' not in params) or (params['page_number'] is None):
+ raise ValueError("Missing the required parameter `page_number` when calling `delete_page_annotations`")
collection_formats = {}
@@ -1990,8 +1983,8 @@ def delete_property_with_http_info(self, name, property_name, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'property_name' in params:
- path_params['propertyName'] = params['property_name']
+ if 'page_number' in params:
+ path_params['pageNumber'] = params['page_number']
query_params = []
if 'storage' in params:
@@ -2014,9 +2007,9 @@ def delete_property_with_http_info(self, name, property_name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/documentproperties/{propertyName}', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations', 'DELETE',
path_params,
query_params,
header_params,
@@ -2031,21 +2024,21 @@ def delete_property_with_http_info(self, name, property_name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_stamp(self, name, stamp_id, **kwargs):
+ def delete_page_link_annotations(self, name, page_number, **kwargs):
"""
- Delete document stamp by ID
+ Delete all link annotations from the 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.delete_stamp(name, stamp_id, callback=callback_function)
+ >>> thread = api.delete_page_link_annotations(name, page_number, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str stamp_id: The stamp ID. (required)
+ :param int page_number: The page number. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -2054,26 +2047,26 @@ def delete_stamp(self, name, stamp_id, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_stamp_with_http_info(name, stamp_id, **kwargs)
+ return self.delete_page_link_annotations_with_http_info(name, page_number, **kwargs)
else:
- (data) = self.delete_stamp_with_http_info(name, stamp_id, **kwargs)
+ (data) = self.delete_page_link_annotations_with_http_info(name, page_number, **kwargs)
return data
- def delete_stamp_with_http_info(self, name, stamp_id, **kwargs):
+ def delete_page_link_annotations_with_http_info(self, name, page_number, **kwargs):
"""
- Delete document stamp by ID
+ Delete all link annotations from the 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.delete_stamp_with_http_info(name, stamp_id, callback=callback_function)
+ >>> thread = api.delete_page_link_annotations_with_http_info(name, page_number, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str stamp_id: The stamp ID. (required)
+ :param int page_number: The page number. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -2081,7 +2074,7 @@ def delete_stamp_with_http_info(self, name, stamp_id, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'stamp_id', 'storage', 'folder']
+ all_params = ['name', 'page_number', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2092,16 +2085,16 @@ def delete_stamp_with_http_info(self, name, stamp_id, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_stamp" % key
+ " to method delete_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 `delete_stamp`")
- # verify the required parameter 'stamp_id' is set
- if ('stamp_id' not in params) or (params['stamp_id'] is None):
- raise ValueError("Missing the required parameter `stamp_id` when calling `delete_stamp`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_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 `delete_page_link_annotations`")
collection_formats = {}
@@ -2109,8 +2102,8 @@ def delete_stamp_with_http_info(self, name, stamp_id, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'stamp_id' in params:
- path_params['stampId'] = params['stamp_id']
+ if 'page_number' in params:
+ path_params['pageNumber'] = params['page_number']
query_params = []
if 'storage' in params:
@@ -2133,9 +2126,9 @@ def delete_stamp_with_http_info(self, name, stamp_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/stamps/{stampId}', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/links', 'DELETE',
path_params,
query_params,
header_params,
@@ -2150,21 +2143,21 @@ def delete_stamp_with_http_info(self, name, stamp_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def delete_table(self, name, table_id, **kwargs):
+ def delete_page_stamps(self, name, page_number, **kwargs):
"""
- Delete document table by ID
+ Delete all stamps from the 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.delete_table(name, table_id, callback=callback_function)
+ >>> thread = api.delete_page_stamps(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 table_id: The table ID. (required)
+ :param int page_number: The page number. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -2173,26 +2166,26 @@ def delete_table(self, name, table_id, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.delete_table_with_http_info(name, table_id, **kwargs)
+ return self.delete_page_stamps_with_http_info(name, page_number, **kwargs)
else:
- (data) = self.delete_table_with_http_info(name, table_id, **kwargs)
+ (data) = self.delete_page_stamps_with_http_info(name, page_number, **kwargs)
return data
- def delete_table_with_http_info(self, name, table_id, **kwargs):
+ def delete_page_stamps_with_http_info(self, name, page_number, **kwargs):
"""
- Delete document table by ID
+ Delete all stamps from the 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.delete_table_with_http_info(name, table_id, callback=callback_function)
+ >>> thread = api.delete_page_stamps_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 table_id: The table ID. (required)
+ :param int page_number: The page number. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -2200,7 +2193,7 @@ def delete_table_with_http_info(self, name, table_id, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'table_id', 'storage', 'folder']
+ all_params = ['name', 'page_number', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2211,16 +2204,16 @@ def delete_table_with_http_info(self, name, table_id, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method delete_table" % key
+ " to method delete_page_stamps" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `delete_table`")
- # verify the required parameter 'table_id' is set
- if ('table_id' not in params) or (params['table_id'] is None):
- raise ValueError("Missing the required parameter `table_id` when calling `delete_table`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_page_stamps`")
+ # 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 `delete_page_stamps`")
collection_formats = {}
@@ -2228,8 +2221,8 @@ def delete_table_with_http_info(self, name, table_id, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'table_id' in params:
- path_params['tableId'] = params['table_id']
+ if 'page_number' in params:
+ path_params['pageNumber'] = params['page_number']
query_params = []
if 'storage' in params:
@@ -2252,9 +2245,9 @@ def delete_table_with_http_info(self, name, table_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/tables/{tableId}', 'DELETE',
+ return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/stamps', 'DELETE',
path_params,
query_params,
header_params,
@@ -2269,57 +2262,57 @@ def delete_table_with_http_info(self, name, table_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_caret_annotation(self, name, annotation_id, **kwargs):
+ def delete_page_tables(self, name, page_number, **kwargs):
"""
- Read document page caret annotation by ID.
+ Delete all tables from the 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.get_caret_annotation(name, annotation_id, callback=callback_function)
+ >>> thread = api.delete_page_tables(name, page_number, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str annotation_id: The annotation ID. (required)
+ :param int page_number: The page number. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: 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.get_caret_annotation_with_http_info(name, annotation_id, **kwargs)
+ return self.delete_page_tables_with_http_info(name, page_number, **kwargs)
else:
- (data) = self.get_caret_annotation_with_http_info(name, annotation_id, **kwargs)
+ (data) = self.delete_page_tables_with_http_info(name, page_number, **kwargs)
return data
- def get_caret_annotation_with_http_info(self, name, annotation_id, **kwargs):
+ def delete_page_tables_with_http_info(self, name, page_number, **kwargs):
"""
- Read document page caret annotation by ID.
+ Delete all tables from the 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.get_caret_annotation_with_http_info(name, annotation_id, callback=callback_function)
+ >>> thread = api.delete_page_tables_with_http_info(name, page_number, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str annotation_id: The annotation ID. (required)
+ :param int page_number: The page number. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: CaretAnnotationResponse
+ :return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'annotation_id', 'storage', 'folder']
+ all_params = ['name', 'page_number', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2330,16 +2323,16 @@ def get_caret_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_caret_annotation" % key
+ " to method delete_page_tables" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_caret_annotation`")
- # verify the required parameter 'annotation_id' is set
- if ('annotation_id' not in params) or (params['annotation_id'] is None):
- raise ValueError("Missing the required parameter `annotation_id` when calling `get_caret_annotation`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_page_tables`")
+ # 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 `delete_page_tables`")
collection_formats = {}
@@ -2347,8 +2340,8 @@ def get_caret_annotation_with_http_info(self, name, annotation_id, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'annotation_id' in params:
- path_params['annotationId'] = params['annotation_id']
+ if 'page_number' in params:
+ path_params['pageNumber'] = params['page_number']
query_params = []
if 'storage' in params:
@@ -2371,16 +2364,16 @@ def get_caret_annotation_with_http_info(self, name, annotation_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/caret/{annotationId}', 'GET',
+ return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/tables', 'DELETE',
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'),
@@ -2388,57 +2381,55 @@ def get_caret_annotation_with_http_info(self, name, annotation_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_circle_annotation(self, name, annotation_id, **kwargs):
+ def delete_properties(self, name, **kwargs):
"""
- Read document page circle annotation by ID.
+ Delete custom document properties.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_circle_annotation(name, annotation_id, callback=callback_function)
+ >>> thread = api.delete_properties(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: CircleAnnotationResponse
+ :param str name: (required)
+ :param str storage:
+ :param str 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.get_circle_annotation_with_http_info(name, annotation_id, **kwargs)
+ return self.delete_properties_with_http_info(name, **kwargs)
else:
- (data) = self.get_circle_annotation_with_http_info(name, annotation_id, **kwargs)
+ (data) = self.delete_properties_with_http_info(name, **kwargs)
return data
- def get_circle_annotation_with_http_info(self, name, annotation_id, **kwargs):
+ def delete_properties_with_http_info(self, name, **kwargs):
"""
- Read document page circle annotation by ID.
+ Delete custom document properties.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_circle_annotation_with_http_info(name, annotation_id, callback=callback_function)
+ >>> thread = api.delete_properties_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: The document name. (required)
- :param str annotation_id: The annotation ID. (required)
- :param str storage: The document storage.
- :param str folder: The document folder.
- :return: CircleAnnotationResponse
+ :param str name: (required)
+ :param str storage:
+ :param str folder:
+ :return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'annotation_id', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2449,16 +2440,13 @@ def get_circle_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_circle_annotation" % key
+ " to method delete_properties" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_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 `get_circle_annotation`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_properties`")
collection_formats = {}
@@ -2466,8 +2454,6 @@ def get_circle_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:
@@ -2490,16 +2476,16 @@ def get_circle_annotation_with_http_info(self, name, annotation_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/circle/{annotationId}', 'GET',
+ return self.api_client.call_api('/pdf/{name}/documentproperties', 'DELETE',
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'),
@@ -2507,51 +2493,57 @@ def get_circle_annotation_with_http_info(self, name, annotation_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_disc_usage(self, **kwargs):
+ def delete_property(self, name, property_name, **kwargs):
"""
- Check the disk usage of the current account
+ Delete 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.get_disc_usage(callback=callback_function)
+ >>> thread = api.delete_property(name, property_name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str storage: User's storage name
- :return: DiscUsageResponse
+ :param str name: (required)
+ :param str property_name: (required)
+ :param str storage:
+ :param str 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.get_disc_usage_with_http_info(**kwargs)
+ return self.delete_property_with_http_info(name, property_name, **kwargs)
else:
- (data) = self.get_disc_usage_with_http_info(**kwargs)
+ (data) = self.delete_property_with_http_info(name, property_name, **kwargs)
return data
- def get_disc_usage_with_http_info(self, **kwargs):
+ def delete_property_with_http_info(self, name, property_name, **kwargs):
"""
- Check the disk usage of the current account
+ Delete 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.get_disc_usage_with_http_info(callback=callback_function)
+ >>> thread = api.delete_property_with_http_info(name, property_name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str storage: User's storage name
- :return: DiscUsageResponse
+ :param str name: (required)
+ :param str property_name: (required)
+ :param str storage:
+ :param str folder:
+ :return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['storage']
+ all_params = ['name', 'property_name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2562,19 +2554,31 @@ def get_disc_usage_with_http_info(self, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_disc_usage" % key
+ " to method delete_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 `delete_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 `delete_property`")
collection_formats = {}
path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
+ if 'property_name' in params:
+ path_params['propertyName'] = params['property_name']
query_params = []
if 'storage' in params:
query_params.append(('storage', params['storage']))
+ if 'folder' in params:
+ query_params.append(('folder', params['folder']))
header_params = {}
@@ -2591,16 +2595,16 @@ def get_disc_usage_with_http_info(self, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/storage/disc', 'GET',
+ return self.api_client.call_api('/pdf/{name}/documentproperties/{propertyName}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='DiscUsageResponse',
+ response_type='AsposeResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -2608,55 +2612,57 @@ def get_disc_usage_with_http_info(self, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document(self, name, **kwargs):
+ def delete_stamp(self, name, stamp_id, **kwargs):
"""
- Read common document info.
+ Delete document stamp 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_document(name, callback=callback_function)
+ >>> thread = api.delete_stamp(name, stamp_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
+ :param str stamp_id: The stamp ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: DocumentResponse
+ :return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_with_http_info(name, **kwargs)
+ return self.delete_stamp_with_http_info(name, stamp_id, **kwargs)
else:
- (data) = self.get_document_with_http_info(name, **kwargs)
+ (data) = self.delete_stamp_with_http_info(name, stamp_id, **kwargs)
return data
- def get_document_with_http_info(self, name, **kwargs):
+ def delete_stamp_with_http_info(self, name, stamp_id, **kwargs):
"""
- Read common document info.
+ Delete document stamp 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_document_with_http_info(name, callback=callback_function)
+ >>> thread = api.delete_stamp_with_http_info(name, stamp_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
+ :param str stamp_id: The stamp ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: DocumentResponse
+ :return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'storage', 'folder']
+ all_params = ['name', 'stamp_id', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2667,13 +2673,16 @@ def get_document_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document" % key
+ " to method delete_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 `get_document`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_stamp`")
+ # verify the required parameter 'stamp_id' is set
+ if ('stamp_id' not in params) or (params['stamp_id'] is None):
+ raise ValueError("Missing the required parameter `stamp_id` when calling `delete_stamp`")
collection_formats = {}
@@ -2681,6 +2690,8 @@ def get_document_with_http_info(self, name, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
+ if 'stamp_id' in params:
+ path_params['stampId'] = params['stamp_id']
query_params = []
if 'storage' in params:
@@ -2703,16 +2714,16 @@ def get_document_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}', 'GET',
+ return self.api_client.call_api('/pdf/{name}/stamps/{stampId}', 'DELETE',
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'),
@@ -2720,55 +2731,57 @@ def get_document_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_annotations(self, name, **kwargs):
+ def delete_table(self, name, table_id, **kwargs):
"""
- Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
+ Delete document table 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_document_annotations(name, callback=callback_function)
+ >>> thread = api.delete_table(name, table_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
+ :param str table_id: The table ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: AnnotationsInfoResponse
+ :return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_annotations_with_http_info(name, **kwargs)
+ return self.delete_table_with_http_info(name, table_id, **kwargs)
else:
- (data) = self.get_document_annotations_with_http_info(name, **kwargs)
+ (data) = self.delete_table_with_http_info(name, table_id, **kwargs)
return data
- def get_document_annotations_with_http_info(self, name, **kwargs):
+ def delete_table_with_http_info(self, name, table_id, **kwargs):
"""
- Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
+ Delete document table 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_document_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.delete_table_with_http_info(name, table_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
+ :param str table_id: The table ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: AnnotationsInfoResponse
+ :return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'storage', 'folder']
+ all_params = ['name', 'table_id', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2779,13 +2792,16 @@ def get_document_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_annotations" % key
+ " to method delete_table" % key
)
params[key] = val
del params['kwargs']
# verify the 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_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `delete_table`")
+ # verify the required parameter 'table_id' is set
+ if ('table_id' not in params) or (params['table_id'] is None):
+ raise ValueError("Missing the required parameter `table_id` when calling `delete_table`")
collection_formats = {}
@@ -2793,6 +2809,8 @@ def get_document_annotations_with_http_info(self, name, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
+ if 'table_id' in params:
+ path_params['tableId'] = params['table_id']
query_params = []
if 'storage' in params:
@@ -2815,16 +2833,16 @@ def get_document_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations', 'GET',
+ return self.api_client.call_api('/pdf/{name}/tables/{tableId}', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='AnnotationsInfoResponse',
+ response_type='AsposeResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -2832,57 +2850,55 @@ def get_document_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_attachment_by_index(self, name, attachment_index, **kwargs):
+ def download_file(self, path, **kwargs):
"""
- Read document attachment info by its index.
+ Download file
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_attachment_by_index(name, attachment_index, callback=callback_function)
+ >>> thread = api.download_file(path, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: The document name. (required)
- :param int attachment_index: The attachment index. (required)
- :param str storage: The document storage.
- :param str folder: The document folder.
- :return: AttachmentResponse
+ :param str path: File path e.g. '/folder/file.ext' (required)
+ :param str storage_name: Storage name
+ :param str version_id: File version ID to download
+ :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_document_attachment_by_index_with_http_info(name, attachment_index, **kwargs)
+ return self.download_file_with_http_info(path, **kwargs)
else:
- (data) = self.get_document_attachment_by_index_with_http_info(name, attachment_index, **kwargs)
+ (data) = self.download_file_with_http_info(path, **kwargs)
return data
- def get_document_attachment_by_index_with_http_info(self, name, attachment_index, **kwargs):
+ def download_file_with_http_info(self, path, **kwargs):
"""
- Read document attachment info by its index.
+ Download file
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_attachment_by_index_with_http_info(name, attachment_index, callback=callback_function)
+ >>> thread = api.download_file_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 int attachment_index: The attachment index. (required)
- :param str storage: The document storage.
- :param str folder: The document folder.
- :return: AttachmentResponse
+ :param str path: File path e.g. '/folder/file.ext' (required)
+ :param str storage_name: Storage name
+ :param str version_id: File version ID to download
+ :return: file
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'attachment_index', 'storage', 'folder']
+ all_params = ['path', 'storage_name', 'version_id']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2893,31 +2909,26 @@ def get_document_attachment_by_index_with_http_info(self, name, attachment_index
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_attachment_by_index" % key
+ " to method download_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 `get_document_attachment_by_index`")
- # verify the required parameter 'attachment_index' is set
- if ('attachment_index' not in params) or (params['attachment_index'] is None):
- raise ValueError("Missing the required parameter `attachment_index` when calling `get_document_attachment_by_index`")
+ # 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 `download_file`")
collection_formats = {}
path_params = {}
- if 'name' in params:
- path_params['name'] = params['name']
- if 'attachment_index' in params:
- path_params['attachmentIndex'] = params['attachment_index']
+ if 'path' in params:
+ path_params['path'] = params['path']
query_params = []
- if 'storage' in params:
- query_params.append(('storage', params['storage']))
- if 'folder' in params:
- query_params.append(('folder', params['folder']))
+ if 'storage_name' in params:
+ query_params.append(('storageName', params['storage_name']))
+ if 'version_id' in params:
+ query_params.append(('versionId', params['version_id']))
header_params = {}
@@ -2927,23 +2938,23 @@ def get_document_attachment_by_index_with_http_info(self, name, attachment_index
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 = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/attachments/{attachmentIndex}', 'GET',
+ return self.api_client.call_api('/pdf/storage/file/{path}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='AttachmentResponse',
+ response_type='file',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -2951,55 +2962,57 @@ def get_document_attachment_by_index_with_http_info(self, name, attachment_index
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_attachments(self, name, **kwargs):
+ def get_bookmark(self, name, bookmark_path, **kwargs):
"""
- Read document attachments info.
+ Read document bookmark.
This method makes a synchronous HTTP request by default. To make 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_attachments(name, callback=callback_function)
+ >>> thread = api.get_bookmark(name, bookmark_path, 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 bookmark_path: The bookmark path. (required)
:param str folder: The document folder.
- :return: AttachmentsResponse
+ :param str storage: The document storage.
+ :return: BookmarkResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_attachments_with_http_info(name, **kwargs)
+ return self.get_bookmark_with_http_info(name, bookmark_path, **kwargs)
else:
- (data) = self.get_document_attachments_with_http_info(name, **kwargs)
+ (data) = self.get_bookmark_with_http_info(name, bookmark_path, **kwargs)
return data
- def get_document_attachments_with_http_info(self, name, **kwargs):
+ def get_bookmark_with_http_info(self, name, bookmark_path, **kwargs):
"""
- Read document attachments info.
+ Read document bookmark.
This method makes a synchronous HTTP request by default. To make 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_attachments_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_bookmark_with_http_info(name, bookmark_path, 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 bookmark_path: The bookmark path. (required)
:param str folder: The document folder.
- :return: AttachmentsResponse
+ :param str storage: The document storage.
+ :return: BookmarkResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'storage', 'folder']
+ all_params = ['name', 'bookmark_path', 'folder', 'storage']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -3010,13 +3023,16 @@ def get_document_attachments_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_attachments" % key
+ " to method get_bookmark" % key
)
params[key] = val
del params['kwargs']
# verify the 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_attachments`")
+ raise ValueError("Missing the required parameter `name` when calling `get_bookmark`")
+ # verify the required parameter 'bookmark_path' is set
+ if ('bookmark_path' not in params) or (params['bookmark_path'] is None):
+ raise ValueError("Missing the required parameter `bookmark_path` when calling `get_bookmark`")
collection_formats = {}
@@ -3024,12 +3040,14 @@ def get_document_attachments_with_http_info(self, name, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
+ if 'bookmark_path' in params:
+ path_params['bookmarkPath'] = params['bookmark_path']
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 = {}
@@ -3046,16 +3064,16 @@ def get_document_attachments_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/attachments', 'GET',
+ return self.api_client.call_api('/pdf/{name}/bookmarks/bookmark/{bookmarkPath}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='AttachmentsResponse',
+ response_type='BookmarkResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -3063,55 +3081,57 @@ def get_document_attachments_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_caret_annotations(self, name, **kwargs):
+ def get_bookmarks(self, name, bookmark_path, **kwargs):
"""
- Read document caret annotations.
+ Read document bookmarks node list.
This method makes a synchronous HTTP request by default. To make 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_caret_annotations(name, callback=callback_function)
+ >>> thread = api.get_bookmarks(name, bookmark_path, 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 bookmark_path: The bookmark path. (required)
:param str folder: The document folder.
- :return: CaretAnnotationsResponse
+ :param str storage: The document storage.
+ :return: BookmarksResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_caret_annotations_with_http_info(name, **kwargs)
+ return self.get_bookmarks_with_http_info(name, bookmark_path, **kwargs)
else:
- (data) = self.get_document_caret_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_bookmarks_with_http_info(name, bookmark_path, **kwargs)
return data
- def get_document_caret_annotations_with_http_info(self, name, **kwargs):
+ def get_bookmarks_with_http_info(self, name, bookmark_path, **kwargs):
"""
- Read document caret annotations.
+ Read document bookmarks node list.
This method makes a synchronous HTTP request by default. To make 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_caret_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_bookmarks_with_http_info(name, bookmark_path, 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 bookmark_path: The bookmark path. (required)
:param str folder: The document folder.
- :return: CaretAnnotationsResponse
+ :param str storage: The document storage.
+ :return: BookmarksResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'storage', 'folder']
+ all_params = ['name', 'bookmark_path', 'folder', 'storage']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -3122,13 +3142,16 @@ def get_document_caret_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_caret_annotations" % key
+ " to method get_bookmarks" % key
)
params[key] = val
del params['kwargs']
# verify the 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_caret_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_bookmarks`")
+ # verify the required parameter 'bookmark_path' is set
+ if ('bookmark_path' not in params) or (params['bookmark_path'] is None):
+ raise ValueError("Missing the required parameter `bookmark_path` when calling `get_bookmarks`")
collection_formats = {}
@@ -3136,12 +3159,14 @@ def get_document_caret_annotations_with_http_info(self, name, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
+ if 'bookmark_path' in params:
+ path_params['bookmarkPath'] = params['bookmark_path']
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 = {}
@@ -3158,16 +3183,16 @@ def get_document_caret_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/caret', 'GET',
+ return self.api_client.call_api('/pdf/{name}/bookmarks/list/{bookmarkPath}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='CaretAnnotationsResponse',
+ response_type='BookmarksResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -3175,55 +3200,57 @@ def get_document_caret_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_circle_annotations(self, name, **kwargs):
+ def get_caret_annotation(self, name, annotation_id, **kwargs):
"""
- Read document circle annotations.
+ Read document page caret annotation by ID.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_circle_annotations(name, callback=callback_function)
+ >>> thread = api.get_caret_annotation(name, annotation_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
+ :param str annotation_id: The annotation ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: CircleAnnotationsResponse
+ :return: CaretAnnotationResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_circle_annotations_with_http_info(name, **kwargs)
+ return self.get_caret_annotation_with_http_info(name, annotation_id, **kwargs)
else:
- (data) = self.get_document_circle_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_caret_annotation_with_http_info(name, annotation_id, **kwargs)
return data
- def get_document_circle_annotations_with_http_info(self, name, **kwargs):
+ def get_caret_annotation_with_http_info(self, name, annotation_id, **kwargs):
"""
- Read document circle annotations.
+ Read document page caret annotation by ID.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_circle_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_caret_annotation_with_http_info(name, annotation_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
+ :param str annotation_id: The annotation ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: CircleAnnotationsResponse
+ :return: CaretAnnotationResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['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')
@@ -3234,13 +3261,16 @@ def get_document_circle_annotations_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_circle_annotations" % key
+ " to method get_caret_annotation" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_circle_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_caret_annotation`")
+ # verify the required parameter 'annotation_id' is set
+ if ('annotation_id' not in params) or (params['annotation_id'] is None):
+ raise ValueError("Missing the required parameter `annotation_id` when calling `get_caret_annotation`")
collection_formats = {}
@@ -3248,6 +3278,8 @@ def get_document_circle_annotations_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:
@@ -3270,16 +3302,16 @@ def get_document_circle_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/circle', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/caret/{annotationId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='CircleAnnotationsResponse',
+ response_type='CaretAnnotationResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -3287,55 +3319,57 @@ 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):
+ def get_circle_annotation(self, name, annotation_id, **kwargs):
"""
- Read document FileAttachment annotations.
+ Read document page circle 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_document_file_attachment_annotations(name, callback=callback_function)
+ >>> thread = api.get_circle_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: FileAttachmentAnnotationsResponse
+ :return: CircleAnnotationResponse
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)
+ return self.get_circle_annotation_with_http_info(name, annotation_id, **kwargs)
else:
- (data) = self.get_document_file_attachment_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_circle_annotation_with_http_info(name, annotation_id, **kwargs)
return data
- def get_document_file_attachment_annotations_with_http_info(self, name, **kwargs):
+ def get_circle_annotation_with_http_info(self, name, annotation_id, **kwargs):
"""
- Read document FileAttachment annotations.
+ Read document page circle 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_document_file_attachment_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_circle_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: FileAttachmentAnnotationsResponse
+ :return: CircleAnnotationResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['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')
@@ -3346,13 +3380,16 @@ def get_document_file_attachment_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_file_attachment_annotations" % key
+ " to method get_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 `get_document_file_attachment_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_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 `get_circle_annotation`")
collection_formats = {}
@@ -3360,6 +3397,8 @@ def get_document_file_attachment_annotations_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:
@@ -3382,16 +3421,16 @@ def get_document_file_attachment_annotations_with_http_info(self, name, **kwargs
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/fileattachment', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/circle/{annotationId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='FileAttachmentAnnotationsResponse',
+ response_type='CircleAnnotationResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -3399,55 +3438,51 @@ def get_document_file_attachment_annotations_with_http_info(self, name, **kwargs
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_free_text_annotations(self, name, **kwargs):
+ def get_disc_usage(self, **kwargs):
"""
- Read document free text annotations.
+ Get disc usage
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_free_text_annotations(name, callback=callback_function)
+ >>> thread = api.get_disc_usage(callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: The document name. (required)
- :param str storage: The document storage.
- :param str folder: The document folder.
- :return: FreeTextAnnotationsResponse
+ :param str storage_name: Storage name
+ :return: DiscUsage
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_free_text_annotations_with_http_info(name, **kwargs)
+ return self.get_disc_usage_with_http_info(**kwargs)
else:
- (data) = self.get_document_free_text_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_disc_usage_with_http_info(**kwargs)
return data
- def get_document_free_text_annotations_with_http_info(self, name, **kwargs):
+ def get_disc_usage_with_http_info(self, **kwargs):
"""
- Read document free text annotations.
+ Get disc usage
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_free_text_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_disc_usage_with_http_info(callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: The document name. (required)
- :param str storage: The document storage.
- :param str folder: The document folder.
- :return: FreeTextAnnotationsResponse
+ :param str storage_name: Storage name
+ :return: DiscUsage
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'storage', 'folder']
+ all_params = ['storage_name']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -3458,26 +3493,19 @@ def get_document_free_text_annotations_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_free_text_annotations" % key
+ " to method get_disc_usage" % key
)
params[key] = val
del params['kwargs']
- # verify the required parameter 'name' is set
- if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_free_text_annotations`")
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']))
+ if 'storage_name' in params:
+ query_params.append(('storageName', params['storage_name']))
header_params = {}
@@ -3494,16 +3522,16 @@ def get_document_free_text_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/freetext', 'GET',
+ return self.api_client.call_api('/pdf/storage/disc', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='FreeTextAnnotationsResponse',
+ response_type='DiscUsage',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -3511,50 +3539,50 @@ def get_document_free_text_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_highlight_annotations(self, name, **kwargs):
+ def get_document(self, name, **kwargs):
"""
- Read document highlight annotations.
+ Read common document 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_document_highlight_annotations(name, callback=callback_function)
+ >>> thread = api.get_document(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: HighlightAnnotationsResponse
+ :return: DocumentResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_highlight_annotations_with_http_info(name, **kwargs)
+ return self.get_document_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_highlight_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_with_http_info(name, **kwargs)
return data
- def get_document_highlight_annotations_with_http_info(self, name, **kwargs):
+ def get_document_with_http_info(self, name, **kwargs):
"""
- Read document highlight annotations.
+ Read common document 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_document_highlight_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_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 storage: The document storage.
:param str folder: The document folder.
- :return: HighlightAnnotationsResponse
+ :return: DocumentResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -3570,13 +3598,13 @@ def get_document_highlight_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_highlight_annotations" % key
+ " to method get_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 `get_document_highlight_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document`")
collection_formats = {}
@@ -3606,16 +3634,16 @@ def get_document_highlight_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/highlight', 'GET',
+ return self.api_client.call_api('/pdf/{name}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='HighlightAnnotationsResponse',
+ response_type='DocumentResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -3623,50 +3651,50 @@ def get_document_highlight_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_ink_annotations(self, name, **kwargs):
+ def get_document_annotations(self, name, **kwargs):
"""
- Read document ink annotations.
+ Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_ink_annotations(name, callback=callback_function)
+ >>> thread = api.get_document_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: InkAnnotationsResponse
+ :return: AnnotationsInfoResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_ink_annotations_with_http_info(name, **kwargs)
+ return self.get_document_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_ink_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_annotations_with_http_info(name, **kwargs)
return data
- def get_document_ink_annotations_with_http_info(self, name, **kwargs):
+ def get_document_annotations_with_http_info(self, name, **kwargs):
"""
- Read document ink annotations.
+ Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_ink_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_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: InkAnnotationsResponse
+ :return: AnnotationsInfoResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -3682,13 +3710,13 @@ def get_document_ink_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_ink_annotations" % key
+ " to method get_document_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_ink_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_annotations`")
collection_formats = {}
@@ -3718,16 +3746,16 @@ def get_document_ink_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/ink', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='InkAnnotationsResponse',
+ response_type='AnnotationsInfoResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -3735,55 +3763,57 @@ def get_document_ink_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_line_annotations(self, name, **kwargs):
+ def get_document_attachment_by_index(self, name, attachment_index, **kwargs):
"""
- Read document line annotations.
+ Read document attachment info by its index.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_line_annotations(name, callback=callback_function)
+ >>> thread = api.get_document_attachment_by_index(name, attachment_index, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
+ :param int attachment_index: The attachment index. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: LineAnnotationsResponse
+ :return: AttachmentResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_line_annotations_with_http_info(name, **kwargs)
+ return self.get_document_attachment_by_index_with_http_info(name, attachment_index, **kwargs)
else:
- (data) = self.get_document_line_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_attachment_by_index_with_http_info(name, attachment_index, **kwargs)
return data
- def get_document_line_annotations_with_http_info(self, name, **kwargs):
+ def get_document_attachment_by_index_with_http_info(self, name, attachment_index, **kwargs):
"""
- Read document line annotations.
+ Read document attachment info by its index.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_line_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_attachment_by_index_with_http_info(name, attachment_index, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
+ :param int attachment_index: The attachment index. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: LineAnnotationsResponse
+ :return: AttachmentResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'storage', 'folder']
+ all_params = ['name', 'attachment_index', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -3794,13 +3824,16 @@ def get_document_line_annotations_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_line_annotations" % key
+ " to method get_document_attachment_by_index" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_line_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_attachment_by_index`")
+ # verify the required parameter 'attachment_index' is set
+ if ('attachment_index' not in params) or (params['attachment_index'] is None):
+ raise ValueError("Missing the required parameter `attachment_index` when calling `get_document_attachment_by_index`")
collection_formats = {}
@@ -3808,6 +3841,8 @@ def get_document_line_annotations_with_http_info(self, name, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
+ if 'attachment_index' in params:
+ path_params['attachmentIndex'] = params['attachment_index']
query_params = []
if 'storage' in params:
@@ -3830,16 +3865,16 @@ def get_document_line_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/line', 'GET',
+ return self.api_client.call_api('/pdf/{name}/attachments/{attachmentIndex}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='LineAnnotationsResponse',
+ response_type='AttachmentResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -3847,50 +3882,50 @@ def get_document_line_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_movie_annotations(self, name, **kwargs):
+ def get_document_attachments(self, name, **kwargs):
"""
- Read document movie annotations.
+ Read document attachments 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_document_movie_annotations(name, callback=callback_function)
+ >>> thread = api.get_document_attachments(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
+ :return: AttachmentsResponse
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)
+ return self.get_document_attachments_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_movie_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_attachments_with_http_info(name, **kwargs)
return data
- def get_document_movie_annotations_with_http_info(self, name, **kwargs):
+ def get_document_attachments_with_http_info(self, name, **kwargs):
"""
- Read document movie annotations.
+ Read document attachments 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_document_movie_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_attachments_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
+ :return: AttachmentsResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -3906,13 +3941,13 @@ def get_document_movie_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_movie_annotations" % key
+ " to method get_document_attachments" % key
)
params[key] = val
del params['kwargs']
# verify the 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`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_attachments`")
collection_formats = {}
@@ -3942,16 +3977,16 @@ def get_document_movie_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/movie', 'GET',
+ return self.api_client.call_api('/pdf/{name}/attachments', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='MovieAnnotationsResponse',
+ response_type='AttachmentsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -3959,50 +3994,162 @@ def get_document_movie_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_poly_line_annotations(self, name, **kwargs):
+ def get_document_bookmarks(self, name, **kwargs):
"""
- Read document polyline annotations.
+ Read document bookmarks tree.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_poly_line_annotations(name, callback=callback_function)
+ >>> thread = api.get_document_bookmarks(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
+ :param str folder: The document folder.
:param str storage: The document storage.
+ :return: BookmarksResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_document_bookmarks_with_http_info(name, **kwargs)
+ else:
+ (data) = self.get_document_bookmarks_with_http_info(name, **kwargs)
+ return data
+
+ def get_document_bookmarks_with_http_info(self, name, **kwargs):
+ """
+ Read document bookmarks tree.
+ This method makes a synchronous HTTP request by default. To make 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_bookmarks_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 folder: The document folder.
- :return: PolyLineAnnotationsResponse
+ :param str storage: The document storage.
+ :return: BookmarksResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', '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 get_document_bookmarks" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the 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_bookmarks`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
+
+ query_params = []
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/bookmarks/tree', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='BookmarksResponse',
+ 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_caret_annotations(self, name, **kwargs):
+ """
+ Read document caret annotations.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_document_caret_annotations(name, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: CaretAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_poly_line_annotations_with_http_info(name, **kwargs)
+ return self.get_document_caret_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_poly_line_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_caret_annotations_with_http_info(name, **kwargs)
return data
- def get_document_poly_line_annotations_with_http_info(self, name, **kwargs):
+ def get_document_caret_annotations_with_http_info(self, name, **kwargs):
"""
- Read document polyline annotations.
+ Read document caret annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_poly_line_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_caret_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: PolyLineAnnotationsResponse
+ :return: CaretAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -4018,13 +4165,13 @@ def get_document_poly_line_annotations_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_poly_line_annotations" % key
+ " to method get_document_caret_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_poly_line_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_caret_annotations`")
collection_formats = {}
@@ -4054,16 +4201,16 @@ def get_document_poly_line_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/polyline', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/caret', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='PolyLineAnnotationsResponse',
+ response_type='CaretAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -4071,50 +4218,50 @@ def get_document_poly_line_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_polygon_annotations(self, name, **kwargs):
+ def get_document_circle_annotations(self, name, **kwargs):
"""
- Read document polygon annotations.
+ Read document circle annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_polygon_annotations(name, callback=callback_function)
+ >>> thread = api.get_document_circle_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: PolygonAnnotationsResponse
+ :return: CircleAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_polygon_annotations_with_http_info(name, **kwargs)
+ return self.get_document_circle_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_polygon_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_circle_annotations_with_http_info(name, **kwargs)
return data
- def get_document_polygon_annotations_with_http_info(self, name, **kwargs):
+ def get_document_circle_annotations_with_http_info(self, name, **kwargs):
"""
- Read document polygon annotations.
+ Read document circle annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_polygon_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_circle_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: PolygonAnnotationsResponse
+ :return: CircleAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -4130,13 +4277,13 @@ def get_document_polygon_annotations_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_polygon_annotations" % key
+ " to method get_document_circle_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_polygon_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_circle_annotations`")
collection_formats = {}
@@ -4166,16 +4313,16 @@ def get_document_polygon_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/polygon', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/circle', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='PolygonAnnotationsResponse',
+ response_type='CircleAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -4183,50 +4330,50 @@ def get_document_polygon_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_popup_annotations(self, name, **kwargs):
+ def get_document_file_attachment_annotations(self, name, **kwargs):
"""
- Read document popup annotations.
+ 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_popup_annotations(name, callback=callback_function)
+ >>> 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: PopupAnnotationsResponse
+ :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_popup_annotations_with_http_info(name, **kwargs)
+ return self.get_document_file_attachment_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_popup_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_file_attachment_annotations_with_http_info(name, **kwargs)
return data
- def get_document_popup_annotations_with_http_info(self, name, **kwargs):
+ def get_document_file_attachment_annotations_with_http_info(self, name, **kwargs):
"""
- Read document popup annotations.
+ 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_popup_annotations_with_http_info(name, callback=callback_function)
+ >>> 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: PopupAnnotationsResponse
+ :return: FileAttachmentAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -4242,13 +4389,13 @@ def get_document_popup_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_popup_annotations" % key
+ " 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_popup_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_file_attachment_annotations`")
collection_formats = {}
@@ -4278,16 +4425,16 @@ def get_document_popup_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/popup', 'GET',
+ 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='PopupAnnotationsResponse',
+ response_type='FileAttachmentAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -4295,57 +4442,55 @@ def get_document_popup_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_popup_annotations_by_parent(self, name, annotation_id, **kwargs):
+ def get_document_free_text_annotations(self, name, **kwargs):
"""
- Read document popup annotations by parent id.
+ Read document free text annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_popup_annotations_by_parent(name, annotation_id, callback=callback_function)
+ >>> thread = api.get_document_free_text_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str annotation_id: The parent annotation ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: PopupAnnotationsResponse
+ :return: FreeTextAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, **kwargs)
+ return self.get_document_free_text_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, **kwargs)
+ (data) = self.get_document_free_text_annotations_with_http_info(name, **kwargs)
return data
- def get_document_popup_annotations_by_parent_with_http_info(self, name, annotation_id, **kwargs):
+ def get_document_free_text_annotations_with_http_info(self, name, **kwargs):
"""
- Read document popup annotations by parent id.
+ Read document free text annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, callback=callback_function)
+ >>> thread = api.get_document_free_text_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str annotation_id: The parent annotation ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: PopupAnnotationsResponse
+ :return: FreeTextAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'annotation_id', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -4356,16 +4501,13 @@ def get_document_popup_annotations_by_parent_with_http_info(self, name, annotati
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_popup_annotations_by_parent" % key
+ " to method get_document_free_text_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_popup_annotations_by_parent`")
- # verify the required parameter 'annotation_id' is set
- if ('annotation_id' not in params) or (params['annotation_id'] is None):
- raise ValueError("Missing the required parameter `annotation_id` when calling `get_document_popup_annotations_by_parent`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_free_text_annotations`")
collection_formats = {}
@@ -4373,8 +4515,6 @@ def get_document_popup_annotations_by_parent_with_http_info(self, name, annotati
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:
@@ -4397,16 +4537,16 @@ def get_document_popup_annotations_by_parent_with_http_info(self, name, annotati
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/{annotationId}/popup', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/freetext', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='PopupAnnotationsResponse',
+ response_type='FreeTextAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -4414,50 +4554,50 @@ def get_document_popup_annotations_by_parent_with_http_info(self, name, annotati
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_properties(self, name, **kwargs):
+ def get_document_highlight_annotations(self, name, **kwargs):
"""
- Read document properties.
+ Read document highlight annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_properties(name, callback=callback_function)
+ >>> thread = api.get_document_highlight_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: (required)
- :param str storage:
- :param str folder:
- :return: DocumentPropertiesResponse
+ :param str name: The document name. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: HighlightAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_properties_with_http_info(name, **kwargs)
+ return self.get_document_highlight_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_properties_with_http_info(name, **kwargs)
+ (data) = self.get_document_highlight_annotations_with_http_info(name, **kwargs)
return data
- def get_document_properties_with_http_info(self, name, **kwargs):
+ def get_document_highlight_annotations_with_http_info(self, name, **kwargs):
"""
- Read document properties.
+ Read document highlight annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_properties_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_highlight_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: (required)
- :param str storage:
- :param str folder:
- :return: DocumentPropertiesResponse
+ :param str name: The document name. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: HighlightAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -4473,13 +4613,13 @@ def get_document_properties_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_properties" % key
+ " to method get_document_highlight_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_properties`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_highlight_annotations`")
collection_formats = {}
@@ -4509,16 +4649,16 @@ def get_document_properties_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/documentproperties', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/highlight', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='DocumentPropertiesResponse',
+ response_type='HighlightAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -4526,57 +4666,55 @@ def get_document_properties_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_property(self, name, property_name, **kwargs):
+ def get_document_ink_annotations(self, name, **kwargs):
"""
- Read document property by name.
+ Read document ink annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_property(name, property_name, callback=callback_function)
+ >>> thread = api.get_document_ink_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: (required)
- :param str property_name: (required)
- :param str storage:
- :param str folder:
- :return: DocumentPropertyResponse
+ :param str name: The document name. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: InkAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_property_with_http_info(name, property_name, **kwargs)
+ return self.get_document_ink_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_property_with_http_info(name, property_name, **kwargs)
+ (data) = self.get_document_ink_annotations_with_http_info(name, **kwargs)
return data
- def get_document_property_with_http_info(self, name, property_name, **kwargs):
+ def get_document_ink_annotations_with_http_info(self, name, **kwargs):
"""
- Read document property by name.
+ Read document ink annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_property_with_http_info(name, property_name, callback=callback_function)
+ >>> thread = api.get_document_ink_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: (required)
- :param str property_name: (required)
- :param str storage:
- :param str folder:
- :return: DocumentPropertyResponse
+ :param str name: The document name. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: InkAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'property_name', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -4587,16 +4725,13 @@ def get_document_property_with_http_info(self, name, property_name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_property" % key
+ " to method get_document_ink_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_property`")
- # verify the required parameter 'property_name' is set
- if ('property_name' not in params) or (params['property_name'] is None):
- raise ValueError("Missing the required parameter `property_name` when calling `get_document_property`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_ink_annotations`")
collection_formats = {}
@@ -4604,8 +4739,6 @@ def get_document_property_with_http_info(self, name, property_name, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'property_name' in params:
- path_params['propertyName'] = params['property_name']
query_params = []
if 'storage' in params:
@@ -4628,16 +4761,16 @@ def get_document_property_with_http_info(self, name, property_name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/documentproperties/{propertyName}', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/ink', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='DocumentPropertyResponse',
+ response_type='InkAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -4645,50 +4778,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_redaction_annotations(self, name, **kwargs):
+ def get_document_line_annotations(self, name, **kwargs):
"""
- Read document redaction annotations.
+ Read document line annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_redaction_annotations(name, callback=callback_function)
+ >>> thread = api.get_document_line_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: RedactionAnnotationsResponse
+ :return: LineAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_redaction_annotations_with_http_info(name, **kwargs)
+ return self.get_document_line_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_redaction_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_line_annotations_with_http_info(name, **kwargs)
return data
- def get_document_redaction_annotations_with_http_info(self, name, **kwargs):
+ def get_document_line_annotations_with_http_info(self, name, **kwargs):
"""
- Read document redaction annotations.
+ Read document line annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_redaction_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_line_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: RedactionAnnotationsResponse
+ :return: LineAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -4704,13 +4837,13 @@ def get_document_redaction_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_redaction_annotations" % key
+ " to method get_document_line_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_redaction_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_line_annotations`")
collection_formats = {}
@@ -4740,16 +4873,16 @@ def get_document_redaction_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/redaction', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/line', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='RedactionAnnotationsResponse',
+ response_type='LineAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -4757,50 +4890,50 @@ def get_document_redaction_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_screen_annotations(self, name, **kwargs):
+ def get_document_movie_annotations(self, name, **kwargs):
"""
- Read document screen annotations.
+ 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_screen_annotations(name, callback=callback_function)
+ >>> 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: ScreenAnnotationsResponse
+ :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_screen_annotations_with_http_info(name, **kwargs)
+ return self.get_document_movie_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_screen_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_movie_annotations_with_http_info(name, **kwargs)
return data
- def get_document_screen_annotations_with_http_info(self, name, **kwargs):
+ def get_document_movie_annotations_with_http_info(self, name, **kwargs):
"""
- Read document screen annotations.
+ 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_screen_annotations_with_http_info(name, callback=callback_function)
+ >>> 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: ScreenAnnotationsResponse
+ :return: MovieAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -4816,13 +4949,13 @@ def get_document_screen_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_screen_annotations" % key
+ " 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_screen_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_movie_annotations`")
collection_formats = {}
@@ -4852,16 +4985,16 @@ def get_document_screen_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/screen', 'GET',
+ 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='ScreenAnnotationsResponse',
+ response_type='MovieAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -4869,50 +5002,50 @@ def get_document_screen_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_sound_annotations(self, name, **kwargs):
+ def get_document_poly_line_annotations(self, name, **kwargs):
"""
- Read document sound annotations.
+ Read document polyline annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_sound_annotations(name, callback=callback_function)
+ >>> thread = api.get_document_poly_line_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: SoundAnnotationsResponse
+ :return: PolyLineAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_sound_annotations_with_http_info(name, **kwargs)
+ return self.get_document_poly_line_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_sound_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_poly_line_annotations_with_http_info(name, **kwargs)
return data
- def get_document_sound_annotations_with_http_info(self, name, **kwargs):
+ def get_document_poly_line_annotations_with_http_info(self, name, **kwargs):
"""
- Read document sound annotations.
+ Read document polyline annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_sound_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_poly_line_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: SoundAnnotationsResponse
+ :return: PolyLineAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -4928,13 +5061,13 @@ def get_document_sound_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_sound_annotations" % key
+ " to method get_document_poly_line_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_sound_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_poly_line_annotations`")
collection_formats = {}
@@ -4964,16 +5097,16 @@ def get_document_sound_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/sound', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/polyline', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='SoundAnnotationsResponse',
+ response_type='PolyLineAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -4981,50 +5114,50 @@ def get_document_sound_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_square_annotations(self, name, **kwargs):
+ def get_document_polygon_annotations(self, name, **kwargs):
"""
- Read document square annotations.
+ Read document polygon annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_square_annotations(name, callback=callback_function)
+ >>> thread = api.get_document_polygon_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: SquareAnnotationsResponse
+ :return: PolygonAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_square_annotations_with_http_info(name, **kwargs)
+ return self.get_document_polygon_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_square_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_polygon_annotations_with_http_info(name, **kwargs)
return data
- def get_document_square_annotations_with_http_info(self, name, **kwargs):
+ def get_document_polygon_annotations_with_http_info(self, name, **kwargs):
"""
- Read document square annotations.
+ Read document polygon annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_square_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_polygon_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: SquareAnnotationsResponse
+ :return: PolygonAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -5040,13 +5173,13 @@ def get_document_square_annotations_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_square_annotations" % key
+ " to method get_document_polygon_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_square_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_polygon_annotations`")
collection_formats = {}
@@ -5076,16 +5209,16 @@ def get_document_square_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/square', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/polygon', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='SquareAnnotationsResponse',
+ response_type='PolygonAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -5093,50 +5226,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_popup_annotations(self, name, **kwargs):
"""
- Read document squiggly annotations.
+ Read document popup annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_squiggly_annotations(name, callback=callback_function)
+ >>> thread = api.get_document_popup_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: SquigglyAnnotationsResponse
+ :return: PopupAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_squiggly_annotations_with_http_info(name, **kwargs)
+ return self.get_document_popup_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_squiggly_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_popup_annotations_with_http_info(name, **kwargs)
return data
- def get_document_squiggly_annotations_with_http_info(self, name, **kwargs):
+ def get_document_popup_annotations_with_http_info(self, name, **kwargs):
"""
- Read document squiggly annotations.
+ Read document popup annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_squiggly_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_popup_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: SquigglyAnnotationsResponse
+ :return: PopupAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -5152,13 +5285,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_popup_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_squiggly_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_popup_annotations`")
collection_formats = {}
@@ -5188,128 +5321,16 @@ def get_document_squiggly_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- 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_stamp_annotations(self, name, **kwargs):
- """
- Read document stamp 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_stamp_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: StampAnnotationsResponse
- If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- if kwargs.get('callback'):
- return self.get_document_stamp_annotations_with_http_info(name, **kwargs)
- else:
- (data) = self.get_document_stamp_annotations_with_http_info(name, **kwargs)
- return data
-
- def get_document_stamp_annotations_with_http_info(self, name, **kwargs):
- """
- Read document stamp 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_stamp_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: StampAnnotationsResponse
- 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_stamp_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_stamp_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/stamp', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/popup', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='StampAnnotationsResponse',
+ response_type='PopupAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -5317,55 +5338,57 @@ def get_document_stamp_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_stamps(self, name, **kwargs):
+ def get_document_popup_annotations_by_parent(self, name, annotation_id, **kwargs):
"""
- Read document stamps.
+ Read document popup annotations by parent id.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_stamps(name, callback=callback_function)
+ >>> thread = api.get_document_popup_annotations_by_parent(name, annotation_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
+ :param str annotation_id: The parent annotation ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: StampsInfoResponse
+ :return: PopupAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_stamps_with_http_info(name, **kwargs)
+ return self.get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, **kwargs)
else:
- (data) = self.get_document_stamps_with_http_info(name, **kwargs)
+ (data) = self.get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, **kwargs)
return data
- def get_document_stamps_with_http_info(self, name, **kwargs):
+ def get_document_popup_annotations_by_parent_with_http_info(self, name, annotation_id, **kwargs):
"""
- Read document stamps.
+ Read document popup annotations by parent id.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_stamps_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_popup_annotations_by_parent_with_http_info(name, annotation_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
+ :param str annotation_id: The parent annotation ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: StampsInfoResponse
+ :return: PopupAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['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')
@@ -5376,13 +5399,16 @@ def get_document_stamps_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_stamps" % key
+ " to method get_document_popup_annotations_by_parent" % key
)
params[key] = val
del params['kwargs']
# verify the 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_stamps`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_popup_annotations_by_parent`")
+ # verify the required parameter 'annotation_id' is set
+ if ('annotation_id' not in params) or (params['annotation_id'] is None):
+ raise ValueError("Missing the required parameter `annotation_id` when calling `get_document_popup_annotations_by_parent`")
collection_formats = {}
@@ -5390,6 +5416,8 @@ def get_document_stamps_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:
@@ -5412,16 +5440,16 @@ def get_document_stamps_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/stamps', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/{annotationId}/popup', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='StampsInfoResponse',
+ response_type='PopupAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -5429,50 +5457,50 @@ def get_document_stamps_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_properties(self, name, **kwargs):
"""
- Read document StrikeOut annotations.
+ Read document properties.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_strike_out_annotations(name, callback=callback_function)
+ >>> thread = api.get_document_properties(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: The document name. (required)
- :param str storage: The document storage.
- :param str folder: The document folder.
- :return: StrikeOutAnnotationsResponse
+ :param str name: (required)
+ :param str storage:
+ :param str folder:
+ :return: DocumentPropertiesResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_strike_out_annotations_with_http_info(name, **kwargs)
+ return self.get_document_properties_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_strike_out_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_properties_with_http_info(name, **kwargs)
return data
- def get_document_strike_out_annotations_with_http_info(self, name, **kwargs):
+ def get_document_properties_with_http_info(self, name, **kwargs):
"""
- Read document StrikeOut annotations.
+ Read document properties.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_strike_out_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_properties_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: The document name. (required)
- :param str storage: The document storage.
- :param str folder: The document folder.
- :return: StrikeOutAnnotationsResponse
+ :param str name: (required)
+ :param str storage:
+ :param str folder:
+ :return: DocumentPropertiesResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -5488,13 +5516,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_properties" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_document_strike_out_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_properties`")
collection_formats = {}
@@ -5524,16 +5552,16 @@ def get_document_strike_out_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/strikeout', 'GET',
+ return self.api_client.call_api('/pdf/{name}/documentproperties', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='StrikeOutAnnotationsResponse',
+ response_type='DocumentPropertiesResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -5541,55 +5569,57 @@ 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_tables(self, name, **kwargs):
+ def get_document_property(self, name, property_name, **kwargs):
"""
- Read document tables.
+ Read document property by name.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_tables(name, callback=callback_function)
+ >>> thread = api.get_document_property(name, property_name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: (required)
+ :param str property_name: (required)
:param str storage:
:param str folder:
- :return: TablesRecognizedResponse
+ :return: DocumentPropertyResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_tables_with_http_info(name, **kwargs)
+ return self.get_document_property_with_http_info(name, property_name, **kwargs)
else:
- (data) = self.get_document_tables_with_http_info(name, **kwargs)
+ (data) = self.get_document_property_with_http_info(name, property_name, **kwargs)
return data
- def get_document_tables_with_http_info(self, name, **kwargs):
+ def get_document_property_with_http_info(self, name, property_name, **kwargs):
"""
- Read document tables.
+ Read document property by name.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_document_tables_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_property_with_http_info(name, property_name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: (required)
+ :param str property_name: (required)
:param str storage:
:param str folder:
- :return: TablesRecognizedResponse
+ :return: DocumentPropertyResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'storage', 'folder']
+ all_params = ['name', 'property_name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -5600,13 +5630,16 @@ def get_document_tables_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_tables" % key
+ " to method get_document_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 `get_document_tables`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_property`")
+ # verify the required parameter 'property_name' is set
+ if ('property_name' not in params) or (params['property_name'] is None):
+ raise ValueError("Missing the required parameter `property_name` when calling `get_document_property`")
collection_formats = {}
@@ -5614,6 +5647,8 @@ def get_document_tables_with_http_info(self, name, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
+ if 'property_name' in params:
+ path_params['propertyName'] = params['property_name']
query_params = []
if 'storage' in params:
@@ -5636,16 +5671,16 @@ def get_document_tables_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/tables', 'GET',
+ return self.api_client.call_api('/pdf/{name}/documentproperties/{propertyName}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='TablesRecognizedResponse',
+ response_type='DocumentPropertyResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -5653,50 +5688,50 @@ def get_document_tables_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_redaction_annotations(self, name, **kwargs):
"""
- Read document text 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_text_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: TextAnnotationsResponse
+ :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_text_annotations_with_http_info(name, **kwargs)
+ return self.get_document_redaction_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_text_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_redaction_annotations_with_http_info(name, **kwargs)
return data
- def get_document_text_annotations_with_http_info(self, name, **kwargs):
+ def get_document_redaction_annotations_with_http_info(self, name, **kwargs):
"""
- Read document text 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_text_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: TextAnnotationsResponse
+ :return: RedactionAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -5712,13 +5747,13 @@ def get_document_text_annotations_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_document_text_annotations" % key
+ " to method get_document_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_text_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_redaction_annotations`")
collection_formats = {}
@@ -5748,16 +5783,16 @@ def get_document_text_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/text', '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='TextAnnotationsResponse',
+ response_type='RedactionAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -5765,50 +5800,50 @@ def get_document_text_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_document_underline_annotations(self, name, **kwargs):
+ def get_document_screen_annotations(self, name, **kwargs):
"""
- Read document underline annotations.
+ Read document screen 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_underline_annotations(name, callback=callback_function)
+ >>> thread = api.get_document_screen_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: UnderlineAnnotationsResponse
+ :return: ScreenAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_document_underline_annotations_with_http_info(name, **kwargs)
+ return self.get_document_screen_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_document_underline_annotations_with_http_info(name, **kwargs)
+ (data) = self.get_document_screen_annotations_with_http_info(name, **kwargs)
return data
- def get_document_underline_annotations_with_http_info(self, name, **kwargs):
+ def get_document_screen_annotations_with_http_info(self, name, **kwargs):
"""
- Read document underline annotations.
+ Read document screen 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_underline_annotations_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_screen_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: UnderlineAnnotationsResponse
+ :return: ScreenAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -5824,13 +5859,13 @@ def get_document_underline_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_underline_annotations" % key
+ " to method get_document_screen_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_underline_annotations`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_screen_annotations`")
collection_formats = {}
@@ -5860,16 +5895,16 @@ def get_document_underline_annotations_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/underline', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/screen', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='UnderlineAnnotationsResponse',
+ response_type='ScreenAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -5877,55 +5912,55 @@ def get_document_underline_annotations_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_download(self, path, **kwargs):
+ def get_document_sound_annotations(self, name, **kwargs):
"""
- Download a specific file
+ 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_download(path, 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 path: Path of the file including the file name and extension e.g. /file.ext (required)
- :param str version_id: File's version
- :param str storage: User's storage name
- :return: file
+ :param str name: The document name. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :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_download_with_http_info(path, **kwargs)
+ return self.get_document_sound_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_download_with_http_info(path, **kwargs)
+ (data) = self.get_document_sound_annotations_with_http_info(name, **kwargs)
return data
- def get_download_with_http_info(self, path, **kwargs):
+ def get_document_sound_annotations_with_http_info(self, name, **kwargs):
"""
- Download a specific file
+ 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_download_with_http_info(path, 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 path: Path of the file including the file name and extension e.g. /file.ext (required)
- :param str version_id: File's version
- :param str storage: User's storage name
- :return: file
+ :param str name: The document name. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: SoundAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['path', 'version_id', 'storage']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -5936,26 +5971,26 @@ def get_download_with_http_info(self, path, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_download" % key
+ " to method get_document_sound_annotations" % key
)
params[key] = val
del params['kwargs']
- # verify the required parameter 'path' is set
- if ('path' not in params) or (params['path'] is None):
- raise ValueError("Missing the required parameter `path` when calling `get_download`")
+ # verify the required parameter 'name' is set
+ if ('name' not in params) or (params['name'] is None):
+ raise ValueError("Missing the required parameter `name` when calling `get_document_sound_annotations`")
collection_formats = {}
path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
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 = {}
@@ -5965,23 +6000,23 @@ def get_download_with_http_info(self, path, **kwargs):
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
- select_header_accept(['multipart/form-data'])
+ select_header_accept(['application/json'])
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.\
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/storage/file', '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='file',
+ response_type='SoundAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -5989,57 +6024,55 @@ def get_download_with_http_info(self, path, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_download_document_attachment_by_index(self, name, attachment_index, **kwargs):
+ def get_document_square_annotations(self, name, **kwargs):
"""
- Download document attachment content by its index.
+ 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_download_document_attachment_by_index(name, attachment_index, 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 int attachment_index: The attachment index. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: file
+ :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_download_document_attachment_by_index_with_http_info(name, attachment_index, **kwargs)
+ return self.get_document_square_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_download_document_attachment_by_index_with_http_info(name, attachment_index, **kwargs)
+ (data) = self.get_document_square_annotations_with_http_info(name, **kwargs)
return data
- def get_download_document_attachment_by_index_with_http_info(self, name, attachment_index, **kwargs):
+ def get_document_square_annotations_with_http_info(self, name, **kwargs):
"""
- Download document attachment content by its index.
+ 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_download_document_attachment_by_index_with_http_info(name, attachment_index, 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 int attachment_index: The attachment index. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: file
+ :return: SquareAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'attachment_index', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -6050,16 +6083,13 @@ def get_download_document_attachment_by_index_with_http_info(self, name, attachm
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_download_document_attachment_by_index" % key
+ " to method get_document_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_download_document_attachment_by_index`")
- # verify the required parameter 'attachment_index' is set
- if ('attachment_index' not in params) or (params['attachment_index'] is None):
- raise ValueError("Missing the required parameter `attachment_index` when calling `get_download_document_attachment_by_index`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_square_annotations`")
collection_formats = {}
@@ -6067,8 +6097,6 @@ def get_download_document_attachment_by_index_with_http_info(self, name, attachm
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'attachment_index' in params:
- path_params['attachmentIndex'] = params['attachment_index']
query_params = []
if 'storage' in params:
@@ -6084,23 +6112,23 @@ def get_download_document_attachment_by_index_with_http_info(self, name, attachm
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
- select_header_accept(['multipart/form-data'])
+ select_header_accept(['application/json'])
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.\
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/attachments/{attachmentIndex}/download', '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='file',
+ response_type='SquareAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -6108,53 +6136,55 @@ def get_download_document_attachment_by_index_with_http_info(self, name, attachm
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_epub_in_storage_to_pdf(self, src_path, **kwargs):
+ def get_document_squiggly_annotations(self, name, **kwargs):
"""
- Convert EPUB file (located on storage) to PDF format and return resulting file in response.
+ 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_epub_in_storage_to_pdf(src_path, callback=callback_function)
+ >>> thread = api.get_document_squiggly_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required)
+ :param str name: The document name. (required)
:param str storage: The document storage.
- :return: file
+ :param str folder: The document folder.
+ :return: SquigglyAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_epub_in_storage_to_pdf_with_http_info(src_path, **kwargs)
+ return self.get_document_squiggly_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_epub_in_storage_to_pdf_with_http_info(src_path, **kwargs)
+ (data) = self.get_document_squiggly_annotations_with_http_info(name, **kwargs)
return data
- def get_epub_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
+ def get_document_squiggly_annotations_with_http_info(self, name, **kwargs):
"""
- Convert EPUB file (located on storage) to PDF format and return resulting file in response.
+ 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_epub_in_storage_to_pdf_with_http_info(src_path, callback=callback_function)
+ >>> thread = api.get_document_squiggly_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required)
+ :param str name: The document name. (required)
:param str storage: The document storage.
- :return: file
+ :param str folder: The document folder.
+ :return: SquigglyAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['src_path', 'storage']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -6165,24 +6195,26 @@ def get_epub_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_epub_in_storage_to_pdf" % key
+ " to method get_document_squiggly_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_epub_in_storage_to_pdf`")
+ # verify the required parameter 'name' is set
+ if ('name' not in params) or (params['name'] is None):
+ raise ValueError("Missing the required parameter `name` when calling `get_document_squiggly_annotations`")
collection_formats = {}
path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
query_params = []
- if 'src_path' in params:
- query_params.append(('srcPath', params['src_path']))
if 'storage' in params:
query_params.append(('storage', params['storage']))
+ if 'folder' in params:
+ query_params.append(('folder', params['folder']))
header_params = {}
@@ -6192,23 +6224,23 @@ def get_epub_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
- select_header_accept(['multipart/form-data'])
+ select_header_accept(['application/json'])
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.\
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/create/epub', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/squiggly', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='file',
+ response_type='SquigglyAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -6216,57 +6248,55 @@ def get_epub_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_field(self, name, field_name, **kwargs):
+ def get_document_stamp_annotations(self, name, **kwargs):
"""
- Get document field by name.
+ Read document stamp annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_field(name, field_name, callback=callback_function)
+ >>> thread = api.get_document_stamp_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str field_name: The field name/ (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: FieldResponse
+ :return: StampAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_field_with_http_info(name, field_name, **kwargs)
+ return self.get_document_stamp_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_field_with_http_info(name, field_name, **kwargs)
+ (data) = self.get_document_stamp_annotations_with_http_info(name, **kwargs)
return data
- def get_field_with_http_info(self, name, field_name, **kwargs):
+ def get_document_stamp_annotations_with_http_info(self, name, **kwargs):
"""
- Get document field by name.
+ Read document stamp annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_field_with_http_info(name, field_name, callback=callback_function)
+ >>> thread = api.get_document_stamp_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str field_name: The field name/ (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: FieldResponse
+ :return: StampAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'field_name', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -6277,16 +6307,13 @@ def get_field_with_http_info(self, name, field_name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_field" % key
+ " to method get_document_stamp_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_field`")
- # verify the required parameter 'field_name' is set
- if ('field_name' not in params) or (params['field_name'] is None):
- raise ValueError("Missing the required parameter `field_name` when calling `get_field`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_stamp_annotations`")
collection_formats = {}
@@ -6294,8 +6321,6 @@ def get_field_with_http_info(self, name, field_name, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'field_name' in params:
- path_params['fieldName'] = params['field_name']
query_params = []
if 'storage' in params:
@@ -6318,16 +6343,16 @@ def get_field_with_http_info(self, name, field_name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/fields/{fieldName}', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/stamp', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='FieldResponse',
+ response_type='StampAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -6335,50 +6360,50 @@ def get_field_with_http_info(self, name, field_name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_fields(self, name, **kwargs):
+ def get_document_stamps(self, name, **kwargs):
"""
- Get document fields.
+ Read document stamps.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_fields(name, callback=callback_function)
+ >>> thread = api.get_document_stamps(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: FieldsResponse
+ :return: StampsInfoResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_fields_with_http_info(name, **kwargs)
+ return self.get_document_stamps_with_http_info(name, **kwargs)
else:
- (data) = self.get_fields_with_http_info(name, **kwargs)
+ (data) = self.get_document_stamps_with_http_info(name, **kwargs)
return data
- def get_fields_with_http_info(self, name, **kwargs):
+ def get_document_stamps_with_http_info(self, name, **kwargs):
"""
- Get document fields.
+ Read document stamps.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_fields_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_document_stamps_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: FieldsResponse
+ :return: StampsInfoResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -6394,13 +6419,13 @@ def get_fields_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_fields" % key
+ " to method get_document_stamps" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_fields`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_stamps`")
collection_formats = {}
@@ -6430,16 +6455,16 @@ def get_fields_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/fields', 'GET',
+ return self.api_client.call_api('/pdf/{name}/stamps', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='FieldsResponse',
+ response_type='StampsInfoResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -6447,57 +6472,55 @@ def get_fields_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_file_attachment_annotation(self, name, annotation_id, **kwargs):
+ def get_document_strike_out_annotations(self, name, **kwargs):
"""
- Read document page FileAttachment annotation by ID.
+ Read document StrikeOut annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_file_attachment_annotation(name, annotation_id, callback=callback_function)
+ >>> thread = api.get_document_strike_out_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str annotation_id: The annotation ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: FileAttachmentAnnotationResponse
+ :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_file_attachment_annotation_with_http_info(name, annotation_id, **kwargs)
+ return self.get_document_strike_out_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_file_attachment_annotation_with_http_info(name, annotation_id, **kwargs)
+ (data) = self.get_document_strike_out_annotations_with_http_info(name, **kwargs)
return data
- def get_file_attachment_annotation_with_http_info(self, name, annotation_id, **kwargs):
+ def get_document_strike_out_annotations_with_http_info(self, name, **kwargs):
"""
- Read document page FileAttachment annotation by ID.
+ Read document StrikeOut annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_file_attachment_annotation_with_http_info(name, annotation_id, callback=callback_function)
+ >>> thread = api.get_document_strike_out_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str annotation_id: The annotation ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: FileAttachmentAnnotationResponse
+ :return: StrikeOutAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'annotation_id', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -6508,16 +6531,13 @@ def get_file_attachment_annotation_with_http_info(self, name, annotation_id, **k
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_file_attachment_annotation" % key
+ " to method get_document_strike_out_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_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_file_attachment_annotation`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_strike_out_annotations`")
collection_formats = {}
@@ -6525,8 +6545,6 @@ def get_file_attachment_annotation_with_http_info(self, name, annotation_id, **k
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:
@@ -6542,23 +6560,23 @@ def get_file_attachment_annotation_with_http_info(self, name, annotation_id, **k
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.\
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/fileattachment/{annotationId}', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/strikeout', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='FileAttachmentAnnotationResponse',
+ response_type='StrikeOutAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -6566,57 +6584,55 @@ def get_file_attachment_annotation_with_http_info(self, name, annotation_id, **k
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_file_attachment_annotation_data(self, name, annotation_id, **kwargs):
+ def get_document_tables(self, name, **kwargs):
"""
- Read document page FileAttachment annotation by ID.
+ Read document tables.
This method makes a synchronous HTTP request by default. To make 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_file_attachment_annotation_data(name, annotation_id, callback=callback_function)
+ >>> thread = api.get_document_tables(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: file
+ :param str name: (required)
+ :param str storage:
+ :param str folder:
+ :return: TablesRecognizedResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_file_attachment_annotation_data_with_http_info(name, annotation_id, **kwargs)
+ return self.get_document_tables_with_http_info(name, **kwargs)
else:
- (data) = self.get_file_attachment_annotation_data_with_http_info(name, annotation_id, **kwargs)
+ (data) = self.get_document_tables_with_http_info(name, **kwargs)
return data
- def get_file_attachment_annotation_data_with_http_info(self, name, annotation_id, **kwargs):
+ def get_document_tables_with_http_info(self, name, **kwargs):
"""
- Read document page FileAttachment annotation by ID.
+ Read document tables.
This method makes a synchronous HTTP request by default. To make 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_file_attachment_annotation_data_with_http_info(name, annotation_id, callback=callback_function)
+ >>> thread = api.get_document_tables_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: file
+ :param str name: (required)
+ :param str storage:
+ :param str folder:
+ :return: TablesRecognizedResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'annotation_id', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -6627,16 +6643,13 @@ def get_file_attachment_annotation_data_with_http_info(self, name, annotation_id
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_file_attachment_annotation_data" % key
+ " to method get_document_tables" % key
)
params[key] = val
del params['kwargs']
# verify the 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_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_file_attachment_annotation_data`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_tables`")
collection_formats = {}
@@ -6644,8 +6657,6 @@ def get_file_attachment_annotation_data_with_http_info(self, name, annotation_id
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:
@@ -6661,23 +6672,23 @@ def get_file_attachment_annotation_data_with_http_info(self, name, annotation_id
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.\
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/fileattachment/{annotationId}/data', 'GET',
+ return self.api_client.call_api('/pdf/{name}/tables', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='file',
+ response_type='TablesRecognizedResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -6685,57 +6696,55 @@ def get_file_attachment_annotation_data_with_http_info(self, name, annotation_id
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_free_text_annotation(self, name, annotation_id, **kwargs):
+ def get_document_text_annotations(self, name, **kwargs):
"""
- Read document page free text annotation by ID.
+ Read document text annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_free_text_annotation(name, annotation_id, callback=callback_function)
+ >>> thread = api.get_document_text_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str annotation_id: The annotation ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: FreeTextAnnotationResponse
+ :return: TextAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_free_text_annotation_with_http_info(name, annotation_id, **kwargs)
+ return self.get_document_text_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_free_text_annotation_with_http_info(name, annotation_id, **kwargs)
+ (data) = self.get_document_text_annotations_with_http_info(name, **kwargs)
return data
- def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs):
+ def get_document_text_annotations_with_http_info(self, name, **kwargs):
"""
- Read document page free text annotation by ID.
+ Read document text annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_free_text_annotation_with_http_info(name, annotation_id, callback=callback_function)
+ >>> thread = api.get_document_text_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str annotation_id: The annotation ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: FreeTextAnnotationResponse
+ :return: TextAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'annotation_id', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -6746,16 +6755,13 @@ def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs)
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_free_text_annotation" % key
+ " to method get_document_text_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_free_text_annotation`")
- # verify the required parameter 'annotation_id' is set
- if ('annotation_id' not in params) or (params['annotation_id'] is None):
- raise ValueError("Missing the required parameter `annotation_id` when calling `get_free_text_annotation`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_text_annotations`")
collection_formats = {}
@@ -6763,8 +6769,6 @@ def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs)
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'annotation_id' in params:
- path_params['annotationId'] = params['annotation_id']
query_params = []
if 'storage' in params:
@@ -6787,16 +6791,16 @@ def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/freetext/{annotationId}', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/text', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='FreeTextAnnotationResponse',
+ response_type='TextAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -6804,57 +6808,55 @@ def get_free_text_annotation_with_http_info(self, name, annotation_id, **kwargs)
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_highlight_annotation(self, name, annotation_id, **kwargs):
+ def get_document_underline_annotations(self, name, **kwargs):
"""
- Read document page highlight annotation by ID.
+ Read document underline annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_highlight_annotation(name, annotation_id, callback=callback_function)
+ >>> thread = api.get_document_underline_annotations(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str annotation_id: The annotation ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: HighlightAnnotationResponse
+ :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_highlight_annotation_with_http_info(name, annotation_id, **kwargs)
+ return self.get_document_underline_annotations_with_http_info(name, **kwargs)
else:
- (data) = self.get_highlight_annotation_with_http_info(name, annotation_id, **kwargs)
+ (data) = self.get_document_underline_annotations_with_http_info(name, **kwargs)
return data
- def get_highlight_annotation_with_http_info(self, name, annotation_id, **kwargs):
+ def get_document_underline_annotations_with_http_info(self, name, **kwargs):
"""
- Read document page highlight annotation by ID.
+ Read document underline annotations.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_highlight_annotation_with_http_info(name, annotation_id, callback=callback_function)
+ >>> thread = api.get_document_underline_annotations_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str annotation_id: The annotation ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: HighlightAnnotationResponse
+ :return: UnderlineAnnotationsResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'annotation_id', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -6865,16 +6867,13 @@ 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_document_underline_annotations" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_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`")
+ raise ValueError("Missing the required parameter `name` when calling `get_document_underline_annotations`")
collection_formats = {}
@@ -6882,8 +6881,6 @@ def get_highlight_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:
@@ -6906,16 +6903,16 @@ def get_highlight_annotation_with_http_info(self, name, annotation_id, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/highlight/{annotationId}', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/underline', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='HighlightAnnotationResponse',
+ response_type='UnderlineAnnotationsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -6923,69 +6920,57 @@ def get_highlight_annotation_with_http_info(self, name, annotation_id, **kwargs)
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_html_in_storage_to_pdf(self, src_path, **kwargs):
+ def get_download_document_attachment_by_index(self, name, attachment_index, **kwargs):
"""
- Convert HTML file (located on storage) to PDF format and return resulting file in response.
+ Download document attachment content by its index.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_html_in_storage_to_pdf(src_path, callback=callback_function)
+ >>> thread = api.get_download_document_attachment_by_index(name, attachment_index, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str 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 name: The document name. (required)
+ :param int attachment_index: The attachment index. (required)
:param str storage: The document storage.
+ :param str folder: The document folder.
:return: file
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_html_in_storage_to_pdf_with_http_info(src_path, **kwargs)
+ return self.get_download_document_attachment_by_index_with_http_info(name, attachment_index, **kwargs)
else:
- (data) = self.get_html_in_storage_to_pdf_with_http_info(src_path, **kwargs)
+ (data) = self.get_download_document_attachment_by_index_with_http_info(name, attachment_index, **kwargs)
return data
- def get_html_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
+ def get_download_document_attachment_by_index_with_http_info(self, name, attachment_index, **kwargs):
"""
- Convert HTML file (located on storage) to PDF format and return resulting file in response.
+ Download document attachment content by its index.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_html_in_storage_to_pdf_with_http_info(src_path, callback=callback_function)
+ >>> thread = api.get_download_document_attachment_by_index_with_http_info(name, attachment_index, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str 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 name: The document name. (required)
+ :param int attachment_index: The attachment index. (required)
:param str storage: The document storage.
+ :param str folder: The document folder.
:return: file
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['src_path', 'html_file_name', 'height', 'width', 'is_landscape', 'margin_left', 'margin_bottom', 'margin_right', 'margin_top', 'storage']
+ all_params = ['name', 'attachment_index', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -6996,13 +6981,128 @@ def get_html_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_html_in_storage_to_pdf" % key
+ " to method get_download_document_attachment_by_index" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'name' is set
+ if ('name' not in params) or (params['name'] is None):
+ raise ValueError("Missing the required parameter `name` when calling `get_download_document_attachment_by_index`")
+ # verify the required parameter 'attachment_index' is set
+ if ('attachment_index' not in params) or (params['attachment_index'] is None):
+ raise ValueError("Missing the required parameter `attachment_index` when calling `get_download_document_attachment_by_index`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
+ if 'attachment_index' in params:
+ path_params['attachmentIndex'] = params['attachment_index']
+
+ query_params = []
+ if 'storage' in params:
+ 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(['multipart/form-data'])
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/attachments/{attachmentIndex}/download', '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_epub_in_storage_to_pdf(self, src_path, **kwargs):
+ """
+ Convert EPUB file (located on storage) to PDF format and return resulting file in response.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_epub_in_storage_to_pdf(src_path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required)
+ :param str storage: The document storage.
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_epub_in_storage_to_pdf_with_http_info(src_path, **kwargs)
+ else:
+ (data) = self.get_epub_in_storage_to_pdf_with_http_info(src_path, **kwargs)
+ return data
+
+ def get_epub_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
+ """
+ Convert EPUB file (located on storage) to PDF format and return resulting file in response.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_epub_in_storage_to_pdf_with_http_info(src_path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str src_path: Full source filename (ex. /folder1/folder2/template.epub) (required)
+ :param str storage: The document storage.
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['src_path', 'storage']
+ all_params.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_epub_in_storage_to_pdf" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'src_path' is set
if ('src_path' not in params) or (params['src_path'] is None):
- raise ValueError("Missing the required parameter `src_path` when calling `get_html_in_storage_to_pdf`")
+ raise ValueError("Missing the required parameter `src_path` when calling `get_epub_in_storage_to_pdf`")
collection_formats = {}
@@ -7012,22 +7112,6 @@ def get_html_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
query_params = []
if 'src_path' in params:
query_params.append(('srcPath', params['src_path']))
- if 'html_file_name' in params:
- query_params.append(('htmlFileName', params['html_file_name']))
- if 'height' in params:
- query_params.append(('height', params['height']))
- if 'width' in params:
- query_params.append(('width', params['width']))
- if 'is_landscape' in params:
- query_params.append(('isLandscape', params['is_landscape']))
- if 'margin_left' in params:
- query_params.append(('marginLeft', params['margin_left']))
- if 'margin_bottom' in params:
- query_params.append(('marginBottom', params['margin_bottom']))
- if 'margin_right' in params:
- query_params.append(('marginRight', params['margin_right']))
- if 'margin_top' in params:
- query_params.append(('marginTop', params['margin_top']))
if 'storage' in params:
query_params.append(('storage', params['storage']))
@@ -7046,9 +7130,9 @@ def get_html_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/create/html', 'GET',
+ return self.api_client.call_api('/pdf/create/epub', 'GET',
path_params,
query_params,
header_params,
@@ -7063,57 +7147,55 @@ def get_html_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_image(self, name, image_id, **kwargs):
+ def get_export_fields_from_pdf_to_fdf_in_storage(self, name, **kwargs):
"""
- Read document image by ID.
+ Export fields from from PDF in storage to FDF file.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_image(name, image_id, callback=callback_function)
+ >>> thread = api.get_export_fields_from_pdf_to_fdf_in_storage(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str image_id: Image ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: ImageResponse
+ :return: file
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_image_with_http_info(name, image_id, **kwargs)
+ return self.get_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, **kwargs)
else:
- (data) = self.get_image_with_http_info(name, image_id, **kwargs)
+ (data) = self.get_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, **kwargs)
return data
- def get_image_with_http_info(self, name, image_id, **kwargs):
+ def get_export_fields_from_pdf_to_fdf_in_storage_with_http_info(self, name, **kwargs):
"""
- Read document image by ID.
+ Export fields from from PDF in storage to FDF file.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_image_with_http_info(name, image_id, callback=callback_function)
+ >>> thread = api.get_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str image_id: Image ID. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: ImageResponse
+ :return: file
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'image_id', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -7124,16 +7206,13 @@ def get_image_with_http_info(self, name, image_id, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_image" % key
+ " to method get_export_fields_from_pdf_to_fdf_in_storage" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_image`")
- # verify the required parameter 'image_id' is set
- if ('image_id' not in params) or (params['image_id'] is None):
- raise ValueError("Missing the required parameter `image_id` when calling `get_image`")
+ raise ValueError("Missing the required parameter `name` when calling `get_export_fields_from_pdf_to_fdf_in_storage`")
collection_formats = {}
@@ -7141,8 +7220,6 @@ def get_image_with_http_info(self, name, image_id, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'image_id' in params:
- path_params['imageId'] = params['image_id']
query_params = []
if 'storage' in params:
@@ -7165,16 +7242,16 @@ def get_image_with_http_info(self, name, image_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/images/{imageId}', 'GET',
+ return self.api_client.call_api('/pdf/{name}/export/fdf', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='ImageResponse',
+ response_type='file',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -7182,23 +7259,20 @@ def get_image_with_http_info(self, name, image_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_image_extract_as_gif(self, name, image_id, **kwargs):
+ def get_export_fields_from_pdf_to_xfdf_in_storage(self, name, **kwargs):
"""
- Extract document image in GIF format
+ Export fields from from PDF in storage to XFDF file.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_image_extract_as_gif(name, image_id, callback=callback_function)
+ >>> thread = api.get_export_fields_from_pdf_to_xfdf_in_storage(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 storage: The document storage.
:param str folder: The document folder.
:return: file
@@ -7207,28 +7281,25 @@ def get_image_extract_as_gif(self, name, image_id, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_image_extract_as_gif_with_http_info(name, image_id, **kwargs)
+ return self.get_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, **kwargs)
else:
- (data) = self.get_image_extract_as_gif_with_http_info(name, image_id, **kwargs)
+ (data) = self.get_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, **kwargs)
return data
- def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs):
+ def get_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(self, name, **kwargs):
"""
- Extract document image in GIF format
+ Export fields from from PDF in storage to XFDF file.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_image_extract_as_gif_with_http_info(name, image_id, callback=callback_function)
+ >>> thread = api.get_export_fields_from_pdf_to_xfdf_in_storage_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 storage: The document storage.
:param str folder: The document folder.
:return: file
@@ -7236,7 +7307,7 @@ def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -7247,16 +7318,13 @@ def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_image_extract_as_gif" % key
+ " to method get_export_fields_from_pdf_to_xfdf_in_storage" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_gif`")
- # verify the required parameter 'image_id' is set
- if ('image_id' not in params) or (params['image_id'] is None):
- raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_gif`")
+ raise ValueError("Missing the required parameter `name` when calling `get_export_fields_from_pdf_to_xfdf_in_storage`")
collection_formats = {}
@@ -7264,14 +7332,8 @@ def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'image_id' in params:
- path_params['imageId'] = params['image_id']
query_params = []
- if 'width' in params:
- query_params.append(('width', params['width']))
- if 'height' in params:
- query_params.append(('height', params['height']))
if 'storage' in params:
query_params.append(('storage', params['storage']))
if 'folder' in params:
@@ -7292,9 +7354,9 @@ def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/gif', 'GET',
+ return self.api_client.call_api('/pdf/{name}/export/xfdf', 'GET',
path_params,
query_params,
header_params,
@@ -7309,23 +7371,20 @@ def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_image_extract_as_jpeg(self, name, image_id, **kwargs):
+ def get_export_fields_from_pdf_to_xml_in_storage(self, name, **kwargs):
"""
- Extract document image in JPEG format
+ Export fields from from PDF in storage to XML file.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_image_extract_as_jpeg(name, image_id, callback=callback_function)
+ >>> thread = api.get_export_fields_from_pdf_to_xml_in_storage(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 storage: The document storage.
:param str folder: The document folder.
:return: file
@@ -7334,28 +7393,25 @@ def get_image_extract_as_jpeg(self, name, image_id, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs)
+ return self.get_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, **kwargs)
else:
- (data) = self.get_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs)
+ (data) = self.get_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, **kwargs)
return data
- def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs):
+ def get_export_fields_from_pdf_to_xml_in_storage_with_http_info(self, name, **kwargs):
"""
- Extract document image in JPEG format
+ Export fields from from PDF in storage to XML file.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_image_extract_as_jpeg_with_http_info(name, image_id, callback=callback_function)
+ >>> thread = api.get_export_fields_from_pdf_to_xml_in_storage_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 storage: The document storage.
:param str folder: The document folder.
:return: file
@@ -7363,7 +7419,7 @@ def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -7374,16 +7430,13 @@ def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_image_extract_as_jpeg" % key
+ " to method get_export_fields_from_pdf_to_xml_in_storage" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_jpeg`")
- # verify the required parameter 'image_id' is set
- if ('image_id' not in params) or (params['image_id'] is None):
- raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_jpeg`")
+ raise ValueError("Missing the required parameter `name` when calling `get_export_fields_from_pdf_to_xml_in_storage`")
collection_formats = {}
@@ -7391,14 +7444,8 @@ def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'image_id' in params:
- path_params['imageId'] = params['image_id']
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:
@@ -7419,9 +7466,9 @@ def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/jpeg', 'GET',
+ return self.api_client.call_api('/pdf/{name}/export/xml', 'GET',
path_params,
query_params,
header_params,
@@ -7436,61 +7483,57 @@ def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_image_extract_as_png(self, name, image_id, **kwargs):
+ def get_field(self, name, field_name, **kwargs):
"""
- Extract document image in PNG format
+ Get document field by name.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_image_extract_as_png(name, image_id, callback=callback_function)
+ >>> thread = api.get_field(name, field_name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str image_id: Image ID. (required)
- :param int width: The converted image width.
- :param int height: The converted image height.
+ :param str field_name: The field name (name should be encoded). (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: file
+ :return: FieldResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_image_extract_as_png_with_http_info(name, image_id, **kwargs)
+ return self.get_field_with_http_info(name, field_name, **kwargs)
else:
- (data) = self.get_image_extract_as_png_with_http_info(name, image_id, **kwargs)
+ (data) = self.get_field_with_http_info(name, field_name, **kwargs)
return data
- def get_image_extract_as_png_with_http_info(self, name, image_id, **kwargs):
+ def get_field_with_http_info(self, name, field_name, **kwargs):
"""
- Extract document image in PNG format
+ Get document field by name.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_image_extract_as_png_with_http_info(name, image_id, callback=callback_function)
+ >>> thread = api.get_field_with_http_info(name, field_name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param str image_id: Image ID. (required)
- :param int width: The converted image width.
- :param int height: The converted image height.
+ :param str field_name: The field name (name should be encoded). (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :return: file
+ :return: FieldResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder']
+ all_params = ['name', 'field_name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -7501,16 +7544,16 @@ def get_image_extract_as_png_with_http_info(self, name, image_id, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_image_extract_as_png" % key
+ " to method get_field" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_png`")
- # verify the required parameter 'image_id' is set
- if ('image_id' not in params) or (params['image_id'] is None):
- raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_png`")
+ raise ValueError("Missing the required parameter `name` when calling `get_field`")
+ # verify the required parameter 'field_name' is set
+ if ('field_name' not in params) or (params['field_name'] is None):
+ raise ValueError("Missing the required parameter `field_name` when calling `get_field`")
collection_formats = {}
@@ -7518,14 +7561,10 @@ def get_image_extract_as_png_with_http_info(self, name, image_id, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'image_id' in params:
- path_params['imageId'] = params['image_id']
+ if 'field_name' in params:
+ path_params['fieldName'] = params['field_name']
query_params = []
- if 'width' in params:
- query_params.append(('width', params['width']))
- if 'height' in params:
- query_params.append(('height', params['height']))
if 'storage' in params:
query_params.append(('storage', params['storage']))
if 'folder' in params:
@@ -7539,23 +7578,23 @@ def get_image_extract_as_png_with_http_info(self, name, image_id, **kwargs):
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
- select_header_accept(['multipart/form-data'])
+ 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 = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/png', 'GET',
+ return self.api_client.call_api('/pdf/{name}/fields/{fieldName}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='file',
+ response_type='FieldResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -7563,61 +7602,55 @@ def get_image_extract_as_png_with_http_info(self, name, image_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_image_extract_as_tiff(self, name, image_id, **kwargs):
+ def get_fields(self, name, **kwargs):
"""
- Extract document image in TIFF format
+ Get document fields.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_image_extract_as_tiff(name, image_id, callback=callback_function)
+ >>> thread = api.get_fields(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param 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: file
+ :return: FieldsResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_image_extract_as_tiff_with_http_info(name, image_id, **kwargs)
+ return self.get_fields_with_http_info(name, **kwargs)
else:
- (data) = self.get_image_extract_as_tiff_with_http_info(name, image_id, **kwargs)
+ (data) = self.get_fields_with_http_info(name, **kwargs)
return data
- def get_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs):
+ def get_fields_with_http_info(self, name, **kwargs):
"""
- Extract document image in TIFF format
+ Get document fields.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_image_extract_as_tiff_with_http_info(name, image_id, callback=callback_function)
+ >>> thread = api.get_fields_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param 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: file
+ :return: FieldsResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -7628,16 +7661,13 @@ def get_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_image_extract_as_tiff" % key
+ " to method get_fields" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_tiff`")
- # verify the required parameter 'image_id' is set
- if ('image_id' not in params) or (params['image_id'] is None):
- raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_tiff`")
+ raise ValueError("Missing the required parameter `name` when calling `get_fields`")
collection_formats = {}
@@ -7645,14 +7675,8 @@ def get_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'image_id' in params:
- path_params['imageId'] = params['image_id']
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:
@@ -7666,23 +7690,23 @@ def get_image_extract_as_tiff_with_http_info(self, name, image_id, **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.\
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/tiff', 'GET',
+ return self.api_client.call_api('/pdf/{name}/fields', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='file',
+ response_type='FieldsResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -7690,57 +7714,57 @@ def get_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_images(self, name, page_number, **kwargs):
+ def get_file_attachment_annotation(self, name, annotation_id, **kwargs):
"""
- Read document images.
+ 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_images(name, page_number, 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)
: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: ImagesResponse
+ :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_images_with_http_info(name, page_number, **kwargs)
+ return self.get_file_attachment_annotation_with_http_info(name, annotation_id, **kwargs)
else:
- (data) = self.get_images_with_http_info(name, page_number, **kwargs)
+ (data) = self.get_file_attachment_annotation_with_http_info(name, annotation_id, **kwargs)
return data
- def get_images_with_http_info(self, name, page_number, **kwargs):
+ def get_file_attachment_annotation_with_http_info(self, name, annotation_id, **kwargs):
"""
- Read document images.
+ 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_images_with_http_info(name, page_number, 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)
: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: ImagesResponse
+ :return: FileAttachmentAnnotationResponse
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')
@@ -7751,16 +7775,16 @@ def get_images_with_http_info(self, name, page_number, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_images" % key
+ " to method get_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_images`")
- # verify the required parameter 'page_number' is set
- if ('page_number' not in params) or (params['page_number'] is None):
- raise ValueError("Missing the required parameter `page_number` when calling `get_images`")
+ raise ValueError("Missing the required parameter `name` when calling `get_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_file_attachment_annotation`")
collection_formats = {}
@@ -7768,8 +7792,8 @@ def get_images_with_http_info(self, name, page_number, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'page_number' in params:
- path_params['pageNumber'] = params['page_number']
+ if 'annotation_id' in params:
+ path_params['annotationId'] = params['annotation_id']
query_params = []
if 'storage' in params:
@@ -7792,16 +7816,16 @@ def get_images_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images', '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='ImagesResponse',
+ response_type='FileAttachmentAnnotationResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -7809,16 +7833,16 @@ def get_images_with_http_info(self, name, page_number, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_ink_annotation(self, name, annotation_id, **kwargs):
+ def get_file_attachment_annotation_data(self, name, annotation_id, **kwargs):
"""
- Read document page ink 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_ink_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)
@@ -7826,27 +7850,27 @@ def get_ink_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: InkAnnotationResponse
+ :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_ink_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_ink_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_ink_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 ink 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_ink_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)
@@ -7854,7 +7878,7 @@ def get_ink_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: InkAnnotationResponse
+ :return: file
If the method is called asynchronously,
returns the request thread.
"""
@@ -7870,16 +7894,16 @@ def get_ink_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_ink_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_ink_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_ink_annotation`")
+ raise ValueError("Missing the required parameter `annotation_id` when calling `get_file_attachment_annotation_data`")
collection_formats = {}
@@ -7901,6 +7925,114 @@ def get_ink_annotation_with_http_info(self, name, annotation_id, **kwargs):
form_params = []
local_var_files = {}
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ 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 = ['JWT']
+
+ 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_file_versions(self, path, **kwargs):
+ """
+ Get file versions
+ This method makes a synchronous HTTP request by default. To make 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_file_versions(path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str path: File path e.g. '/file.ext' (required)
+ :param str storage_name: Storage name
+ :return: FileVersions
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_file_versions_with_http_info(path, **kwargs)
+ else:
+ (data) = self.get_file_versions_with_http_info(path, **kwargs)
+ return data
+
+ def get_file_versions_with_http_info(self, path, **kwargs):
+ """
+ Get file versions
+ This method makes a synchronous HTTP request by default. To make 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_file_versions_with_http_info(path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str path: File path e.g. '/file.ext' (required)
+ :param str storage_name: Storage name
+ :return: FileVersions
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['path', 'storage_name']
+ 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_file_versions" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'path' is set
+ if ('path' not in params) or (params['path'] is None):
+ raise ValueError("Missing the required parameter `path` when calling `get_file_versions`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'path' in params:
+ path_params['path'] = params['path']
+
+ query_params = []
+ if 'storage_name' in params:
+ query_params.append(('storageName', params['storage_name']))
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
@@ -7911,16 +8043,16 @@ def get_ink_annotation_with_http_info(self, name, annotation_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/annotations/ink/{annotationId}', 'GET',
+ return self.api_client.call_api('/pdf/storage/version/{path}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='InkAnnotationResponse',
+ response_type='FileVersions',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -7928,55 +8060,53 @@ def get_ink_annotation_with_http_info(self, name, annotation_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_is_exist(self, path, **kwargs):
+ def get_files_list(self, path, **kwargs):
"""
- Check if a specific file or folder exists
+ Get all files and folders within a folder
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_is_exist(path, callback=callback_function)
+ >>> thread = api.get_files_list(path, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str path: File or folder path e.g. /file.ext or /Folder1 (required)
- :param str version_id: File's version
- :param str storage: User's storage name
- :return: FileExistResponse
+ :param str path: Folder path e.g. '/folder' (required)
+ :param str storage_name: Storage name
+ :return: FilesList
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_is_exist_with_http_info(path, **kwargs)
+ return self.get_files_list_with_http_info(path, **kwargs)
else:
- (data) = self.get_is_exist_with_http_info(path, **kwargs)
+ (data) = self.get_files_list_with_http_info(path, **kwargs)
return data
- def get_is_exist_with_http_info(self, path, **kwargs):
+ def get_files_list_with_http_info(self, path, **kwargs):
"""
- Check if a specific file or folder exists
+ Get all files and folders within a folder
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_is_exist_with_http_info(path, callback=callback_function)
+ >>> thread = api.get_files_list_with_http_info(path, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str path: File or folder path e.g. /file.ext or /Folder1 (required)
- :param str version_id: File's version
- :param str storage: User's storage name
- :return: FileExistResponse
+ :param str path: Folder path e.g. '/folder' (required)
+ :param str storage_name: Storage name
+ :return: FilesList
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['path', 'version_id', 'storage']
+ all_params = ['path', 'storage_name']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -7987,26 +8117,1148 @@ def get_is_exist_with_http_info(self, path, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_is_exist" % key
+ " to method get_files_list" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'path' is set
if ('path' not in params) or (params['path'] is None):
- raise ValueError("Missing the required parameter `path` when calling `get_is_exist`")
+ raise ValueError("Missing the required parameter `path` when calling `get_files_list`")
collection_formats = {}
path_params = {}
+ if 'path' in params:
+ path_params['path'] = params['path']
+
+ query_params = []
+ if 'storage_name' in params:
+ query_params.append(('storageName', params['storage_name']))
+
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/storage/folder/{path}', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='FilesList',
+ 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 = ['JWT']
+
+ 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.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/annotations/highlight/{annotationId}', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='HighlightAnnotationResponse',
+ 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_html_in_storage_to_pdf(self, src_path, **kwargs):
+ """
+ Convert HTML file (located on storage) to PDF format and return resulting file in response.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_html_in_storage_to_pdf(src_path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str src_path: Full source filename (ex. /folder1/folder2/template.zip) (required)
+ :param str html_file_name: Name of HTML file in ZIP.
+ :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.get_html_in_storage_to_pdf_with_http_info(src_path, **kwargs)
+ else:
+ (data) = self.get_html_in_storage_to_pdf_with_http_info(src_path, **kwargs)
+ return data
+
+ def get_html_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
+ """
+ Convert HTML file (located on storage) to PDF format and return resulting file in response.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_html_in_storage_to_pdf_with_http_info(src_path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str src_path: Full source filename (ex. /folder1/folder2/template.zip) (required)
+ :param str html_file_name: Name of HTML file in ZIP.
+ :param float height: Page height
+ :param float width: Page width
+ :param bool is_landscape: Is page landscaped
+ :param float margin_left: Page margin left
+ :param float margin_bottom: Page margin bottom
+ :param float margin_right: Page margin right
+ :param float margin_top: Page margin top
+ :param str storage: The document storage.
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['src_path', 'html_file_name', 'height', 'width', 'is_landscape', 'margin_left', 'margin_bottom', 'margin_right', 'margin_top', 'storage']
+ all_params.append('callback')
+ all_params.append('_return_http_data_only')
+ all_params.append('_preload_content')
+ 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_html_in_storage_to_pdf" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'src_path' is set
+ if ('src_path' not in params) or (params['src_path'] is None):
+ raise ValueError("Missing the required parameter `src_path` when calling `get_html_in_storage_to_pdf`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+ if 'src_path' in params:
+ query_params.append(('srcPath', params['src_path']))
+ if 'html_file_name' in params:
+ query_params.append(('htmlFileName', params['html_file_name']))
+ if 'height' in params:
+ query_params.append(('height', params['height']))
+ if 'width' in params:
+ query_params.append(('width', params['width']))
+ if 'is_landscape' in params:
+ query_params.append(('isLandscape', params['is_landscape']))
+ if 'margin_left' in params:
+ query_params.append(('marginLeft', params['margin_left']))
+ if 'margin_bottom' in params:
+ query_params.append(('marginBottom', params['margin_bottom']))
+ if 'margin_right' in params:
+ query_params.append(('marginRight', params['margin_right']))
+ if 'margin_top' in params:
+ query_params.append(('marginTop', params['margin_top']))
+ if 'storage' in params:
+ query_params.append(('storage', params['storage']))
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/create/html', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='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_image(self, name, image_id, **kwargs):
+ """
+ Read document image by ID.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_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 str image_id: Image ID. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: ImageResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_image_with_http_info(name, image_id, **kwargs)
+ else:
+ (data) = self.get_image_with_http_info(name, image_id, **kwargs)
+ return data
+
+ def get_image_with_http_info(self, name, image_id, **kwargs):
+ """
+ Read document image by ID.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_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 str image_id: Image ID. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: ImageResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'image_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_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 `get_image`")
+ # verify the required parameter 'image_id' is set
+ if ('image_id' not in params) or (params['image_id'] is None):
+ raise ValueError("Missing the required parameter `image_id` when calling `get_image`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
+ if 'image_id' in params:
+ path_params['imageId'] = params['image_id']
+
+ query_params = []
+ if '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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/images/{imageId}', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='ImageResponse',
+ 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_image_extract_as_gif(self, name, image_id, **kwargs):
+ """
+ Extract document image in GIF format
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_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 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: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_image_extract_as_gif_with_http_info(name, image_id, **kwargs)
+ else:
+ (data) = self.get_image_extract_as_gif_with_http_info(name, image_id, **kwargs)
+ return data
+
+ def get_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs):
+ """
+ Extract document image in GIF format
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_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 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: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder']
+ all_params.append('callback')
+ all_params.append('_return_http_data_only')
+ all_params.append('_preload_content')
+ 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_image_extract_as_gif" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'name' is set
+ if ('name' not in params) or (params['name'] is None):
+ raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_gif`")
+ # verify the required parameter 'image_id' is set
+ if ('image_id' not in params) or (params['image_id'] is None):
+ raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_gif`")
+
+
+ collection_formats = {}
+
+ 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']))
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/gif', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='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_image_extract_as_jpeg(self, name, image_id, **kwargs):
+ """
+ Extract document image in JPEG format
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_image_extract_as_jpeg(name, image_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param 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: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs)
+ else:
+ (data) = self.get_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs)
+ return data
+
+ def get_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs):
+ """
+ Extract document image in JPEG format
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_image_extract_as_jpeg_with_http_info(name, image_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param 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: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder']
+ all_params.append('callback')
+ all_params.append('_return_http_data_only')
+ all_params.append('_preload_content')
+ 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_image_extract_as_jpeg" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'name' is set
+ if ('name' not in params) or (params['name'] is None):
+ raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_jpeg`")
+ # verify the required parameter 'image_id' is set
+ if ('image_id' not in params) or (params['image_id'] is None):
+ raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_jpeg`")
+
+
+ collection_formats = {}
+
+ 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']))
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/jpeg', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='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_image_extract_as_png(self, name, image_id, **kwargs):
+ """
+ Extract document image in PNG format
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_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 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: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_image_extract_as_png_with_http_info(name, image_id, **kwargs)
+ else:
+ (data) = self.get_image_extract_as_png_with_http_info(name, image_id, **kwargs)
+ return data
+
+ def get_image_extract_as_png_with_http_info(self, name, image_id, **kwargs):
+ """
+ Extract document image in PNG format
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_image_extract_as_png_with_http_info(name, image_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str image_id: Image ID. (required)
+ :param int width: The converted image width.
+ :param int height: The converted image height.
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder']
+ all_params.append('callback')
+ all_params.append('_return_http_data_only')
+ all_params.append('_preload_content')
+ 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_image_extract_as_png" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'name' is set
+ if ('name' not in params) or (params['name'] is None):
+ raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_png`")
+ # verify the required parameter 'image_id' is set
+ if ('image_id' not in params) or (params['image_id'] is None):
+ raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_png`")
+
+
+ collection_formats = {}
+
+ 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']))
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/png', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='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_image_extract_as_tiff(self, name, image_id, **kwargs):
+ """
+ Extract document image in TIFF format
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_image_extract_as_tiff(name, image_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str image_id: Image ID. (required)
+ :param int width: The converted image width.
+ :param int height: The converted image height.
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_image_extract_as_tiff_with_http_info(name, image_id, **kwargs)
+ else:
+ (data) = self.get_image_extract_as_tiff_with_http_info(name, image_id, **kwargs)
+ return data
+
+ def get_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs):
+ """
+ Extract document image in TIFF format
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_image_extract_as_tiff_with_http_info(name, image_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str image_id: Image ID. (required)
+ :param int width: The converted image width.
+ :param int height: The converted image height.
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder']
+ all_params.append('callback')
+ all_params.append('_return_http_data_only')
+ all_params.append('_preload_content')
+ 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_image_extract_as_tiff" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'name' is set
+ if ('name' not in params) or (params['name'] is None):
+ raise ValueError("Missing the required parameter `name` when calling `get_image_extract_as_tiff`")
+ # verify the required parameter 'image_id' is set
+ if ('image_id' not in params) or (params['image_id'] is None):
+ raise ValueError("Missing the required parameter `image_id` when calling `get_image_extract_as_tiff`")
+
+
+ collection_formats = {}
+
+ 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']))
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/tiff', '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_images(self, name, page_number, **kwargs):
+ """
+ Read document images.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_images(name, page_number, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param int page_number: The page number. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: ImagesResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_images_with_http_info(name, page_number, **kwargs)
+ else:
+ (data) = self.get_images_with_http_info(name, page_number, **kwargs)
+ return data
+
+ def get_images_with_http_info(self, name, page_number, **kwargs):
+ """
+ Read document images.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.get_images_with_http_info(name, page_number, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param int page_number: The page number. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: ImagesResponse
+ 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_images" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'name' is set
+ if ('name' not in params) or (params['name'] is None):
+ raise ValueError("Missing the required parameter `name` when calling `get_images`")
+ # verify the required parameter 'page_number' is set
+ if ('page_number' not in params) or (params['page_number'] is None):
+ raise ValueError("Missing the required parameter `page_number` when calling `get_images`")
+
+
+ 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 = {}
@@ -8023,16 +9275,373 @@ def get_is_exist_with_http_info(self, path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='ImagesResponse',
+ 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_import_fields_from_fdf_in_storage(self, name, fdf_file_path, **kwargs):
+ """
+ Update fields from FDF file in 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.get_import_fields_from_fdf_in_storage(name, fdf_file_path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str fdf_file_path: The Fdf file path. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, **kwargs)
+ else:
+ (data) = self.get_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, **kwargs)
+ return data
+
+ def get_import_fields_from_fdf_in_storage_with_http_info(self, name, fdf_file_path, **kwargs):
+ """
+ Update fields from FDF file in 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.get_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str fdf_file_path: The Fdf file path. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'fdf_file_path', '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_import_fields_from_fdf_in_storage" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the 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_import_fields_from_fdf_in_storage`")
+ # verify the required parameter 'fdf_file_path' is set
+ if ('fdf_file_path' not in params) or (params['fdf_file_path'] is None):
+ raise ValueError("Missing the required parameter `fdf_file_path` when calling `get_import_fields_from_fdf_in_storage`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
+
+ query_params = []
+ if 'fdf_file_path' in params:
+ query_params.append(('fdfFilePath', params['fdf_file_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 = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/import/fdf', '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_import_fields_from_xfdf_in_storage(self, name, xfdf_file_path, **kwargs):
+ """
+ Update fields from XFDF file in 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.get_import_fields_from_xfdf_in_storage(name, xfdf_file_path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str xfdf_file_path: The XFDF file path. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, **kwargs)
+ else:
+ (data) = self.get_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, **kwargs)
+ return data
+
+ def get_import_fields_from_xfdf_in_storage_with_http_info(self, name, xfdf_file_path, **kwargs):
+ """
+ Update fields from XFDF file in 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.get_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str xfdf_file_path: The XFDF file path. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'xfdf_file_path', '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_import_fields_from_xfdf_in_storage" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the 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_import_fields_from_xfdf_in_storage`")
+ # verify the required parameter 'xfdf_file_path' is set
+ if ('xfdf_file_path' not in params) or (params['xfdf_file_path'] is None):
+ raise ValueError("Missing the required parameter `xfdf_file_path` when calling `get_import_fields_from_xfdf_in_storage`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
+
+ query_params = []
+ if 'xfdf_file_path' in params:
+ query_params.append(('xfdfFilePath', params['xfdf_file_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 = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/import/xfdf', '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_import_fields_from_xml_in_storage(self, name, xml_file_path, **kwargs):
+ """
+ Import from 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.get_import_fields_from_xml_in_storage(name, xml_file_path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str xml_file_path: Full source filename (ex. /folder1/folder2/template.xml) (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, **kwargs)
+ else:
+ (data) = self.get_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, **kwargs)
+ return data
+
+ def get_import_fields_from_xml_in_storage_with_http_info(self, name, xml_file_path, **kwargs):
+ """
+ Import from 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.get_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str xml_file_path: Full source filename (ex. /folder1/folder2/template.xml) (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'xml_file_path', '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_import_fields_from_xml_in_storage" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the 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_import_fields_from_xml_in_storage`")
+ # verify the required parameter 'xml_file_path' is set
+ if ('xml_file_path' not in params) or (params['xml_file_path'] is None):
+ raise ValueError("Missing the required parameter `xml_file_path` when calling `get_import_fields_from_xml_in_storage`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
+
+ query_params = []
+ if 'xml_file_path' in params:
+ query_params.append(('xmlFilePath', params['xml_file_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 = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ 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 = ['JWT']
- return self.api_client.call_api('/storage/exist', 'GET',
+ return self.api_client.call_api('/pdf/{name}/import/xml', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='FileExistResponse',
+ response_type='file',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -8040,51 +9649,57 @@ def get_is_exist_with_http_info(self, path, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_is_storage_exist(self, name, **kwargs):
+ def get_ink_annotation(self, name, annotation_id, **kwargs):
"""
- Check if storage exists
+ Read document page ink annotation by ID.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_is_storage_exist(name, callback=callback_function)
+ >>> thread = api.get_ink_annotation(name, annotation_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: Storage name (required)
- :return: StorageExistResponse
+ :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: InkAnnotationResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_is_storage_exist_with_http_info(name, **kwargs)
+ return self.get_ink_annotation_with_http_info(name, annotation_id, **kwargs)
else:
- (data) = self.get_is_storage_exist_with_http_info(name, **kwargs)
+ (data) = self.get_ink_annotation_with_http_info(name, annotation_id, **kwargs)
return data
- def get_is_storage_exist_with_http_info(self, name, **kwargs):
+ def get_ink_annotation_with_http_info(self, name, annotation_id, **kwargs):
"""
- Check if storage exists
+ Read document page ink annotation by ID.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_is_storage_exist_with_http_info(name, callback=callback_function)
+ >>> thread = api.get_ink_annotation_with_http_info(name, annotation_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: Storage name (required)
- :return: StorageExistResponse
+ :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: InkAnnotationResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name']
+ all_params = ['name', 'annotation_id', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -8095,13 +9710,16 @@ def get_is_storage_exist_with_http_info(self, name, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_is_storage_exist" % key
+ " to method get_ink_annotation" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `get_is_storage_exist`")
+ raise ValueError("Missing the required parameter `name` when calling `get_ink_annotation`")
+ # verify the required parameter 'annotation_id' is set
+ if ('annotation_id' not in params) or (params['annotation_id'] is None):
+ raise ValueError("Missing the required parameter `annotation_id` when calling `get_ink_annotation`")
collection_formats = {}
@@ -8109,8 +9727,14 @@ def get_is_storage_exist_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']))
header_params = {}
@@ -8127,16 +9751,16 @@ def get_is_storage_exist_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/storage/{name}/exist', 'GET',
+ return self.api_client.call_api('/pdf/{name}/annotations/ink/{annotationId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='StorageExistResponse',
+ response_type='InkAnnotationResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -8235,7 +9859,7 @@ def get_la_te_x_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/create/latex', 'GET',
path_params,
@@ -8354,7 +9978,7 @@ def get_line_annotation_with_http_info(self, name, annotation_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/line/{annotationId}', 'GET',
path_params,
@@ -8473,7 +10097,7 @@ def get_link_annotation_with_http_info(self, name, link_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/links/{linkId}', 'GET',
path_params,
@@ -8490,219 +10114,6 @@ def get_link_annotation_with_http_info(self, name, link_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_list_file_versions(self, path, **kwargs):
- """
- Get the file's versions list
- This method makes a synchronous HTTP request by default. To make 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_list_file_versions(path, callback=callback_function)
-
- :param callback function: The callback function
- for asynchronous request. (optional)
- :param str path: File path e.g. /file.ext or /Folder1/file.ext (required)
- :param str storage: User's storage name
- :return: FileVersionsResponse
- If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- if kwargs.get('callback'):
- return self.get_list_file_versions_with_http_info(path, **kwargs)
- else:
- (data) = self.get_list_file_versions_with_http_info(path, **kwargs)
- return data
-
- def get_list_file_versions_with_http_info(self, path, **kwargs):
- """
- Get the file's versions list
- This method makes a synchronous HTTP request by default. To make 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_list_file_versions_with_http_info(path, callback=callback_function)
-
- :param callback function: The callback function
- for asynchronous request. (optional)
- :param str path: File path e.g. /file.ext or /Folder1/file.ext (required)
- :param str storage: User's storage name
- :return: FileVersionsResponse
- If the method is called asynchronously,
- returns the request thread.
- """
-
- all_params = ['path', '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 get_list_file_versions" % key
- )
- params[key] = val
- del params['kwargs']
- # verify the required parameter 'path' is set
- if ('path' not in params) or (params['path'] is None):
- raise ValueError("Missing the required parameter `path` when calling `get_list_file_versions`")
-
-
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
- if 'path' in params:
- query_params.append(('path', params['path']))
- 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('/storage/version', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='FileVersionsResponse',
- 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_list_files(self, **kwargs):
- """
- Get the file listing of a specific folder
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please define a `callback` function
- to be invoked when receiving the response.
- >>> def callback_function(response):
- >>> pprint(response)
- >>>
- >>> thread = api.get_list_files(callback=callback_function)
-
- :param callback function: The callback function
- for asynchronous request. (optional)
- :param str path: Start with name of storage e.g. root folder '/'or some folder '/folder1/..'
- :param str storage: User's storage name
- :return: FilesResponse
- If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- if kwargs.get('callback'):
- return self.get_list_files_with_http_info(**kwargs)
- else:
- (data) = self.get_list_files_with_http_info(**kwargs)
- return data
-
- def get_list_files_with_http_info(self, **kwargs):
- """
- Get the file listing of a specific folder
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please define a `callback` function
- to be invoked when receiving the response.
- >>> def callback_function(response):
- >>> pprint(response)
- >>>
- >>> thread = api.get_list_files_with_http_info(callback=callback_function)
-
- :param callback function: The callback function
- for asynchronous request. (optional)
- :param str path: Start with name of storage e.g. root folder '/'or some folder '/folder1/..'
- :param str storage: User's storage name
- :return: FilesResponse
- If the method is called asynchronously,
- returns the request thread.
- """
-
- all_params = ['path', '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 get_list_files" % key
- )
- params[key] = val
- del params['kwargs']
-
-
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
- if 'path' in params:
- query_params.append(('path', params['path']))
- 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('/storage/folder', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='FilesResponse',
- 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_mht_in_storage_to_pdf(self, src_path, **kwargs):
"""
Convert MHT file (located on storage) to PDF format and return resulting file in response.
@@ -8794,7 +10205,7 @@ def get_mht_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/create/mht', 'GET',
path_params,
@@ -8913,7 +10324,7 @@ def get_movie_annotation_with_http_info(self, name, annotation_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/movie/{annotationId}', 'GET',
path_params,
@@ -9025,14 +10436,14 @@ def get_page_with_http_info(self, name, page_number, **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.\
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}', 'GET',
path_params,
@@ -9151,7 +10562,7 @@ def get_page_annotations_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations', 'GET',
path_params,
@@ -9270,7 +10681,7 @@ def get_page_caret_annotations_with_http_info(self, name, page_number, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/caret', 'GET',
path_params,
@@ -9389,7 +10800,7 @@ def get_page_circle_annotations_with_http_info(self, name, page_number, **kwargs
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/circle', 'GET',
path_params,
@@ -9516,7 +10927,7 @@ def get_page_convert_to_bmp_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/bmp', 'GET',
path_params,
@@ -9643,7 +11054,7 @@ def get_page_convert_to_emf_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/emf', 'GET',
path_params,
@@ -9770,7 +11181,7 @@ def get_page_convert_to_gif_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/gif', 'GET',
path_params,
@@ -9897,7 +11308,7 @@ def get_page_convert_to_jpeg_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/jpeg', 'GET',
path_params,
@@ -10024,7 +11435,7 @@ def get_page_convert_to_png_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/png', 'GET',
path_params,
@@ -10151,7 +11562,7 @@ def get_page_convert_to_tiff_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/tiff', 'GET',
path_params,
@@ -10270,7 +11681,7 @@ def get_page_file_attachment_annotations_with_http_info(self, name, page_number,
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/fileattachment', 'GET',
path_params,
@@ -10389,7 +11800,7 @@ def get_page_free_text_annotations_with_http_info(self, name, page_number, **kwa
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/freetext', 'GET',
path_params,
@@ -10508,7 +11919,7 @@ def get_page_highlight_annotations_with_http_info(self, name, page_number, **kwa
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/highlight', 'GET',
path_params,
@@ -10627,7 +12038,7 @@ def get_page_ink_annotations_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/ink', 'GET',
path_params,
@@ -10746,7 +12157,7 @@ def get_page_line_annotations_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/line', 'GET',
path_params,
@@ -10872,7 +12283,7 @@ def get_page_link_annotation_with_http_info(self, name, page_number, link_id, **
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/links/{linkId}', 'GET',
path_params,
@@ -10991,7 +12402,7 @@ def get_page_link_annotations_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/links', 'GET',
path_params,
@@ -11110,7 +12521,7 @@ def get_page_movie_annotations_with_http_info(self, name, page_number, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/movie', 'GET',
path_params,
@@ -11229,7 +12640,7 @@ def get_page_poly_line_annotations_with_http_info(self, name, page_number, **kwa
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polyline', 'GET',
path_params,
@@ -11348,7 +12759,7 @@ def get_page_polygon_annotations_with_http_info(self, name, page_number, **kwarg
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polygon', 'GET',
path_params,
@@ -11467,7 +12878,7 @@ def get_page_popup_annotations_with_http_info(self, name, page_number, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/popup', 'GET',
path_params,
@@ -11586,7 +12997,7 @@ def get_page_redaction_annotations_with_http_info(self, name, page_number, **kwa
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/redaction', 'GET',
path_params,
@@ -11705,7 +13116,7 @@ def get_page_screen_annotations_with_http_info(self, name, page_number, **kwargs
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/screen', 'GET',
path_params,
@@ -11824,7 +13235,7 @@ def get_page_sound_annotations_with_http_info(self, name, page_number, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/sound', 'GET',
path_params,
@@ -11943,7 +13354,7 @@ def get_page_square_annotations_with_http_info(self, name, page_number, **kwargs
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/square', 'GET',
path_params,
@@ -12062,7 +13473,7 @@ def get_page_squiggly_annotations_with_http_info(self, name, page_number, **kwar
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/squiggly', 'GET',
path_params,
@@ -12181,7 +13592,7 @@ def get_page_stamp_annotations_with_http_info(self, name, page_number, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/stamp', 'GET',
path_params,
@@ -12300,7 +13711,7 @@ def get_page_stamps_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/stamps', 'GET',
path_params,
@@ -12419,7 +13830,7 @@ def get_page_strike_out_annotations_with_http_info(self, name, page_number, **kw
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/strikeout', 'GET',
path_params,
@@ -12538,7 +13949,7 @@ def get_page_tables_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/tables', 'GET',
path_params,
@@ -12665,7 +14076,7 @@ def get_page_text_with_http_info(self, name, page_number, llx, lly, urx, ury, **
query_params = []
if 'format' in params:
query_params.append(('format', params['format']))
- collection_formats['format'] = 'multi'
+ collection_formats['format'] = 'csv'
if 'regex' in params:
query_params.append(('regex', params['regex']))
if 'split_rects' in params:
@@ -12698,7 +14109,7 @@ def get_page_text_with_http_info(self, name, page_number, llx, lly, urx, ury, **
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/text', 'GET',
path_params,
@@ -12817,7 +14228,7 @@ def get_page_text_annotations_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/text', 'GET',
path_params,
@@ -12936,7 +14347,7 @@ def get_page_underline_annotations_with_http_info(self, name, page_number, **kwa
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/underline', 'GET',
path_params,
@@ -13048,7 +14459,7 @@ def get_pages_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages', 'GET',
path_params,
@@ -13156,7 +14567,7 @@ def get_pcl_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/create/pcl', 'GET',
path_params,
@@ -13300,7 +14711,7 @@ def get_pdf_in_storage_to_doc_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/doc', 'GET',
path_params,
@@ -13416,7 +14827,7 @@ def get_pdf_in_storage_to_epub_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/epub', 'GET',
path_params,
@@ -13594,7 +15005,7 @@ def get_pdf_in_storage_to_html_with_http_info(self, name, **kwargs):
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'
+ collection_formats['explicitListOfSavedPages'] = 'csv'
if 'font_encoding_strategy' in params:
query_params.append(('fontEncodingStrategy', params['font_encoding_strategy']))
if 'font_saving_mode' in params:
@@ -13641,7 +15052,7 @@ def get_pdf_in_storage_to_html_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/html', 'GET',
path_params,
@@ -13757,7 +15168,7 @@ def get_pdf_in_storage_to_la_te_x_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/latex', 'GET',
path_params,
@@ -13869,7 +15280,7 @@ def get_pdf_in_storage_to_mobi_xml_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/mobixml', 'GET',
path_params,
@@ -13988,7 +15399,7 @@ def get_pdf_in_storage_to_pdf_a_with_http_info(self, name, type, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/pdfa', 'GET',
path_params,
@@ -14108,7 +15519,7 @@ def get_pdf_in_storage_to_pptx_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/pptx', 'GET',
path_params,
@@ -14224,7 +15635,7 @@ def get_pdf_in_storage_to_svg_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/svg', 'GET',
path_params,
@@ -14396,7 +15807,7 @@ def get_pdf_in_storage_to_tiff_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/tiff', 'GET',
path_params,
@@ -14524,7 +15935,7 @@ def get_pdf_in_storage_to_xls_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/xls', 'GET',
path_params,
@@ -14652,7 +16063,7 @@ def get_pdf_in_storage_to_xlsx_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/xlsx', 'GET',
path_params,
@@ -14764,7 +16175,7 @@ def get_pdf_in_storage_to_xml_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/xml', 'GET',
path_params,
@@ -14876,7 +16287,7 @@ def get_pdf_in_storage_to_xps_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/xps', 'GET',
path_params,
@@ -14995,7 +16406,7 @@ def get_poly_line_annotation_with_http_info(self, name, annotation_id, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/polyline/{annotationId}', 'GET',
path_params,
@@ -15114,7 +16525,7 @@ def get_polygon_annotation_with_http_info(self, name, annotation_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/polygon/{annotationId}', 'GET',
path_params,
@@ -15233,7 +16644,7 @@ def get_popup_annotation_with_http_info(self, name, annotation_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/popup/{annotationId}', 'GET',
path_params,
@@ -15341,7 +16752,7 @@ def get_ps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/create/ps', 'GET',
path_params,
@@ -15460,7 +16871,7 @@ def get_redaction_annotation_with_http_info(self, name, annotation_id, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/redaction/{annotationId}', 'GET',
path_params,
@@ -15572,14 +16983,14 @@ def get_screen_annotation_with_http_info(self, name, annotation_id, **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.\
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/screen/{annotationId}', 'GET',
path_params,
@@ -15698,7 +17109,7 @@ def get_screen_annotation_data_with_http_info(self, name, annotation_id, **kwarg
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/screen/{annotationId}/data', 'GET',
path_params,
@@ -15810,14 +17221,14 @@ def get_sound_annotation_with_http_info(self, name, annotation_id, **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.\
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/sound/{annotationId}', 'GET',
path_params,
@@ -15936,7 +17347,7 @@ def get_sound_annotation_data_with_http_info(self, name, annotation_id, **kwargs
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/sound/{annotationId}/data', 'GET',
path_params,
@@ -16055,7 +17466,7 @@ def get_square_annotation_with_http_info(self, name, annotation_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/square/{annotationId}', 'GET',
path_params,
@@ -16174,7 +17585,7 @@ def get_squiggly_annotation_with_http_info(self, name, annotation_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/squiggly/{annotationId}', 'GET',
path_params,
@@ -16293,7 +17704,7 @@ def get_stamp_annotation_with_http_info(self, name, annotation_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/stamp/{annotationId}', 'GET',
path_params,
@@ -16412,7 +17823,7 @@ def get_stamp_annotation_data_with_http_info(self, name, annotation_id, **kwargs
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/stamp/{annotationId}/data', 'GET',
path_params,
@@ -16531,7 +17942,7 @@ def get_strike_out_annotation_with_http_info(self, name, annotation_id, **kwargs
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/strikeout/{annotationId}', 'GET',
path_params,
@@ -16671,7 +18082,7 @@ def get_svg_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/create/svg', 'GET',
path_params,
@@ -16790,7 +18201,7 @@ def get_table_with_http_info(self, name, table_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/tables/{tableId}', 'GET',
path_params,
@@ -16910,7 +18321,7 @@ def get_text_with_http_info(self, name, llx, lly, urx, ury, **kwargs):
query_params = []
if 'format' in params:
query_params.append(('format', params['format']))
- collection_formats['format'] = 'multi'
+ collection_formats['format'] = 'csv'
if 'regex' in params:
query_params.append(('regex', params['regex']))
if 'split_rects' in params:
@@ -16943,7 +18354,7 @@ def get_text_with_http_info(self, name, llx, lly, urx, ury, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/text', 'GET',
path_params,
@@ -17062,7 +18473,7 @@ def get_text_annotation_with_http_info(self, name, annotation_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/text/{annotationId}', 'GET',
path_params,
@@ -17181,7 +18592,7 @@ def get_underline_annotation_with_http_info(self, name, annotation_id, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/underline/{annotationId}', 'GET',
path_params,
@@ -17300,7 +18711,7 @@ def get_verify_signature_with_http_info(self, name, sign_name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/verifySignature', 'GET',
path_params,
@@ -17436,7 +18847,7 @@ def get_web_in_storage_to_pdf_with_http_info(self, url, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/create/web', 'GET',
path_params,
@@ -17548,7 +18959,7 @@ def get_words_per_page_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/wordCount', 'GET',
path_params,
@@ -17660,7 +19071,7 @@ def get_xfa_pdf_in_storage_to_acro_form_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/xfatoacroform', 'GET',
path_params,
@@ -17772,7 +19183,7 @@ def get_xml_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/create/xml', 'GET',
path_params,
@@ -17880,9 +19291,117 @@ def get_xps_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
+
+ 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='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_xsl_fo_in_storage_to_pdf(self, src_path, **kwargs):
+ """
+ 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.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_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.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, **kwargs)
+ else:
+ (data) = self.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, **kwargs)
+ return data
+
+ def get_xsl_fo_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
+ """
+ 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.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_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_path', '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 get_xsl_fo_in_storage_to_pdf" % 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`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+ if 'src_path' in params:
+ query_params.append(('srcPath', params['src_path']))
+ 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(['multipart/form-data'])
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/create/xps', 'GET',
+ return self.api_client.call_api('/pdf/create/xslfo', 'GET',
path_params,
query_params,
header_params,
@@ -17897,53 +19416,59 @@ 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 move_file(self, src_path, dest_path, **kwargs):
"""
- Convert XslFo file (located on storage) to PDF format and return resulting file in response.
+ Move file
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_xsl_fo_in_storage_to_pdf(src_path, callback=callback_function)
+ >>> thread = api.move_file(src_path, dest_path, 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 storage: The document storage.
- :return: file
+ :param str src_path: Source file path e.g. '/src.ext' (required)
+ :param str dest_path: Destination file path e.g. '/dest.ext' (required)
+ :param str src_storage_name: Source storage name
+ :param str dest_storage_name: Destination storage name
+ :param str version_id: File version ID to move
+ :return: None
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.move_file_with_http_info(src_path, dest_path, **kwargs)
else:
- (data) = self.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, **kwargs)
+ (data) = self.move_file_with_http_info(src_path, dest_path, **kwargs)
return data
- def get_xsl_fo_in_storage_to_pdf_with_http_info(self, src_path, **kwargs):
+ def move_file_with_http_info(self, src_path, dest_path, **kwargs):
"""
- Convert XslFo file (located on storage) to PDF format and return resulting file in response.
+ Move file
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_xsl_fo_in_storage_to_pdf_with_http_info(src_path, callback=callback_function)
+ >>> thread = api.move_file_with_http_info(src_path, dest_path, 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 storage: The document storage.
- :return: file
+ :param str src_path: Source file path e.g. '/src.ext' (required)
+ :param str dest_path: Destination file path e.g. '/dest.ext' (required)
+ :param str src_storage_name: Source storage name
+ :param str dest_storage_name: Destination storage name
+ :param str version_id: File version ID to move
+ :return: None
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['src_path', 'storage']
+ all_params = ['src_path', 'dest_path', 'src_storage_name', 'dest_storage_name', 'version_id']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -17954,24 +19479,152 @@ 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 move_file" % 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`")
+ raise ValueError("Missing the required parameter `src_path` when calling `move_file`")
+ # verify the required parameter 'dest_path' is set
+ if ('dest_path' not in params) or (params['dest_path'] is None):
+ raise ValueError("Missing the required parameter `dest_path` when calling `move_file`")
collection_formats = {}
path_params = {}
+ if 'src_path' in params:
+ path_params['srcPath'] = params['src_path']
query_params = []
+ if 'dest_path' in params:
+ query_params.append(('destPath', params['dest_path']))
+ if 'src_storage_name' in params:
+ query_params.append(('srcStorageName', params['src_storage_name']))
+ if 'dest_storage_name' in params:
+ query_params.append(('destStorageName', params['dest_storage_name']))
+ if 'version_id' in params:
+ query_params.append(('versionId', params['version_id']))
+
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/storage/file/move/{srcPath}', 'PUT',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type=None,
+ 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 move_folder(self, src_path, dest_path, **kwargs):
+ """
+ Move 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.move_folder(src_path, dest_path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str src_path: Folder path to move e.g. '/folder' (required)
+ :param str dest_path: Destination folder path to move to e.g '/dst' (required)
+ :param str src_storage_name: Source storage name
+ :param str dest_storage_name: Destination storage name
+ :return: None
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.move_folder_with_http_info(src_path, dest_path, **kwargs)
+ else:
+ (data) = self.move_folder_with_http_info(src_path, dest_path, **kwargs)
+ return data
+
+ def move_folder_with_http_info(self, src_path, dest_path, **kwargs):
+ """
+ Move 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.move_folder_with_http_info(src_path, dest_path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str src_path: Folder path to move e.g. '/folder' (required)
+ :param str dest_path: Destination folder path to move to e.g '/dst' (required)
+ :param str src_storage_name: Source storage name
+ :param str dest_storage_name: Destination storage name
+ :return: None
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['src_path', 'dest_path', 'src_storage_name', 'dest_storage_name']
+ 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 move_folder" % 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 `move_folder`")
+ # verify the required parameter 'dest_path' is set
+ if ('dest_path' not in params) or (params['dest_path'] is None):
+ raise ValueError("Missing the required parameter `dest_path` when calling `move_folder`")
+
+
+ collection_formats = {}
+
+ path_params = {}
if 'src_path' in params:
- query_params.append(('srcPath', params['src_path']))
- if 'storage' in params:
- query_params.append(('storage', params['storage']))
+ path_params['srcPath'] = params['src_path']
+
+ query_params = []
+ if 'dest_path' in params:
+ query_params.append(('destPath', params['dest_path']))
+ if 'src_storage_name' in params:
+ query_params.append(('srcStorageName', params['src_storage_name']))
+ if 'dest_storage_name' in params:
+ query_params.append(('destStorageName', params['dest_storage_name']))
header_params = {}
@@ -17981,23 +19634,23 @@ 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.\
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/create/xslfo', 'GET',
+ return self.api_client.call_api('/pdf/storage/folder/move/{srcPath}', 'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='file',
+ response_type=None,
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -18005,7 +19658,119 @@ 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 object_exists(self, path, **kwargs):
+ """
+ Check if file or folder exists
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.object_exists(path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str path: File or folder path e.g. '/file.ext' or '/folder' (required)
+ :param str storage_name: Storage name
+ :param str version_id: File version ID
+ :return: ObjectExist
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.object_exists_with_http_info(path, **kwargs)
+ else:
+ (data) = self.object_exists_with_http_info(path, **kwargs)
+ return data
+
+ def object_exists_with_http_info(self, path, **kwargs):
+ """
+ Check if file or folder exists
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.object_exists_with_http_info(path, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str path: File or folder path e.g. '/file.ext' or '/folder' (required)
+ :param str storage_name: Storage name
+ :param str version_id: File version ID
+ :return: ObjectExist
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['path', 'storage_name', 'version_id']
+ 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 object_exists" % 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 `object_exists`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'path' in params:
+ path_params['path'] = params['path']
+
+ query_params = []
+ if 'storage_name' in params:
+ query_params.append(('storageName', params['storage_name']))
+ if 'version_id' in params:
+ query_params.append(('versionId', params['version_id']))
+
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/storage/exist/{path}', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='ObjectExist',
+ 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 post_append_document(self, name, append_file, **kwargs):
"""
Append document to existing one.
This method makes a synchronous HTTP request by default. To make an
@@ -18014,13 +19779,12 @@ def post_append_document(self, name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.post_append_document(name, callback=callback_function)
+ >>> thread = api.post_append_document(name, append_file, 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 str append_file: Append file server path. (required)
:param int start_page: Appending start page.
:param int end_page: Appending end page.
:param str storage: The documents storage.
@@ -18031,12 +19795,12 @@ def post_append_document(self, name, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.post_append_document_with_http_info(name, **kwargs)
+ return self.post_append_document_with_http_info(name, append_file, **kwargs)
else:
- (data) = self.post_append_document_with_http_info(name, **kwargs)
+ (data) = self.post_append_document_with_http_info(name, append_file, **kwargs)
return data
- def post_append_document_with_http_info(self, name, **kwargs):
+ def post_append_document_with_http_info(self, name, append_file, **kwargs):
"""
Append document to existing one.
This method makes a synchronous HTTP request by default. To make an
@@ -18045,13 +19809,12 @@ def post_append_document_with_http_info(self, name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.post_append_document_with_http_info(name, callback=callback_function)
+ >>> thread = api.post_append_document_with_http_info(name, append_file, 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 str append_file: Append file server path. (required)
:param int start_page: Appending start page.
:param int end_page: Appending end page.
:param str storage: The documents storage.
@@ -18061,7 +19824,7 @@ def post_append_document_with_http_info(self, name, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'append_document', 'append_file', 'start_page', 'end_page', 'storage', 'folder']
+ all_params = ['name', 'append_file', 'start_page', 'end_page', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -18079,6 +19842,9 @@ def post_append_document_with_http_info(self, name, **kwargs):
# verify the 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 'append_file' is set
+ if ('append_file' not in params) or (params['append_file'] is None):
+ raise ValueError("Missing the required parameter `append_file` when calling `post_append_document`")
collection_formats = {}
@@ -18105,8 +19871,6 @@ 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'])
@@ -18116,7 +19880,7 @@ def post_append_document_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/appendDocument', 'POST',
path_params,
@@ -18133,6 +19897,132 @@ def post_append_document_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
+ def post_bookmark(self, name, bookmark_path, bookmarks, **kwargs):
+ """
+ Add document bookmarks.
+ This method makes a synchronous HTTP request by default. To make 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_bookmark(name, bookmark_path, bookmarks, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str bookmark_path: The bookmark path. (required)
+ :param list[Bookmark] bookmarks: The array of bookmark. (required)
+ :param str folder: The document folder.
+ :param str storage: The document storage.
+ :return: BookmarksResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.post_bookmark_with_http_info(name, bookmark_path, bookmarks, **kwargs)
+ else:
+ (data) = self.post_bookmark_with_http_info(name, bookmark_path, bookmarks, **kwargs)
+ return data
+
+ def post_bookmark_with_http_info(self, name, bookmark_path, bookmarks, **kwargs):
+ """
+ Add document bookmarks.
+ This method makes a synchronous HTTP request by default. To make 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_bookmark_with_http_info(name, bookmark_path, bookmarks, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str bookmark_path: The bookmark path. (required)
+ :param list[Bookmark] bookmarks: The array of bookmark. (required)
+ :param str folder: The document folder.
+ :param str storage: The document storage.
+ :return: BookmarksResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'bookmark_path', 'bookmarks', '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 post_bookmark" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the 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_bookmark`")
+ # verify the required parameter 'bookmark_path' is set
+ if ('bookmark_path' not in params) or (params['bookmark_path'] is None):
+ raise ValueError("Missing the required parameter `bookmark_path` when calling `post_bookmark`")
+ # verify the required parameter 'bookmarks' is set
+ if ('bookmarks' not in params) or (params['bookmarks'] is None):
+ raise ValueError("Missing the required parameter `bookmarks` when calling `post_bookmark`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
+ if 'bookmark_path' in params:
+ path_params['bookmarkPath'] = params['bookmark_path']
+
+ query_params = []
+ if 'folder' in params:
+ query_params.append(('folder', params['folder']))
+ if 'storage' in params:
+ query_params.append(('storage', params['storage']))
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'bookmarks' in params:
+ body_params = params['bookmarks']
+ # 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/bookmarks/bookmark/{bookmarkPath}', 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='BookmarksResponse',
+ 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 post_change_password_document_in_storage(self, name, owner_password, new_user_password, new_owner_password, **kwargs):
"""
Change document password in storage.
@@ -18249,7 +20139,7 @@ def post_change_password_document_in_storage_with_http_info(self, name, owner_pa
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/changepassword', 'POST',
path_params,
@@ -18266,7 +20156,7 @@ def post_change_password_document_in_storage_with_http_info(self, name, owner_pa
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def post_create_field(self, name, page, **kwargs):
+ def post_create_field(self, name, page, field, **kwargs):
"""
Create field.
This method makes a synchronous HTTP request by default. To make an
@@ -18275,13 +20165,13 @@ def post_create_field(self, name, page, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.post_create_field(name, page, callback=callback_function)
+ >>> thread = api.post_create_field(name, page, field, 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 Field field: Field with the field data. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -18290,12 +20180,12 @@ def post_create_field(self, name, page, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.post_create_field_with_http_info(name, page, **kwargs)
+ return self.post_create_field_with_http_info(name, page, field, **kwargs)
else:
- (data) = self.post_create_field_with_http_info(name, page, **kwargs)
+ (data) = self.post_create_field_with_http_info(name, page, field, **kwargs)
return data
- def post_create_field_with_http_info(self, name, page, **kwargs):
+ def post_create_field_with_http_info(self, name, page, field, **kwargs):
"""
Create field.
This method makes a synchronous HTTP request by default. To make an
@@ -18304,13 +20194,13 @@ def post_create_field_with_http_info(self, name, page, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.post_create_field_with_http_info(name, page, callback=callback_function)
+ >>> thread = api.post_create_field_with_http_info(name, page, field, 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 Field field: Field with the field data. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -18339,6 +20229,9 @@ def post_create_field_with_http_info(self, name, page, **kwargs):
# 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`")
+ # verify the required parameter 'field' is set
+ if ('field' not in params) or (params['field'] is None):
+ raise ValueError("Missing the required parameter `field` when calling `post_create_field`")
collection_formats = {}
@@ -18372,7 +20265,7 @@ def post_create_field_with_http_info(self, name, page, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/fields', 'POST',
path_params,
@@ -18491,7 +20384,7 @@ def post_decrypt_document_in_storage_with_http_info(self, name, password, **kwar
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/decrypt', 'POST',
path_params,
@@ -18618,7 +20511,7 @@ def post_document_image_footer_with_http_info(self, name, image_footer, **kwargs
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/footer/image', 'POST',
path_params,
@@ -18745,7 +20638,7 @@ def post_document_image_header_with_http_info(self, name, image_header, **kwargs
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/header/image', 'POST',
path_params,
@@ -18872,7 +20765,7 @@ def post_document_page_number_stamps_with_http_info(self, name, stamp, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/stamps/pagenumber', 'POST',
path_params,
@@ -18999,7 +20892,7 @@ def post_document_text_footer_with_http_info(self, name, text_footer, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/footer/text', 'POST',
path_params,
@@ -19126,7 +21019,7 @@ def post_document_text_header_with_http_info(self, name, text_header, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/header/text', 'POST',
path_params,
@@ -19245,7 +21138,7 @@ def post_document_text_replace_with_http_info(self, name, text_replace, **kwargs
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/text/replace', 'POST',
path_params,
@@ -19278,8 +21171,8 @@ def post_encrypt_document_in_storage(self, name, user_password, owner_password,
:param str name: Document name. (required)
:param str user_password: User password (encrypted Base64). (required)
:param str owner_password: Owner password (encrypted Base64). (required)
- :param str crypto_algorithm: Cryptographic algorithm, see for details. (required)
- :param list[PermissionsFlags] permissions_flags: Array of document permissions, see for details.
+ :param str crypto_algorithm: Cryptographic algorithm, see CryptoAlgorithm for details. (required)
+ :param list[PermissionsFlags] permissions_flags: Array of document permissions, see PermissionsFlags for details.
:param bool use_pdf20: Support for revision 6 (Extension 8).
:param str storage: The document storage.
:param str folder: The document folder.
@@ -19310,8 +21203,8 @@ def post_encrypt_document_in_storage_with_http_info(self, name, user_password, o
:param str name: Document name. (required)
:param str user_password: User password (encrypted Base64). (required)
:param str owner_password: Owner password (encrypted Base64). (required)
- :param str crypto_algorithm: Cryptographic algorithm, see for details. (required)
- :param list[PermissionsFlags] permissions_flags: Array of document permissions, see for details.
+ :param str crypto_algorithm: Cryptographic algorithm, see CryptoAlgorithm for details. (required)
+ :param list[PermissionsFlags] permissions_flags: Array of document permissions, see PermissionsFlags for details.
:param bool use_pdf20: Support for revision 6 (Extension 8).
:param str storage: The document storage.
:param str folder: The document folder.
@@ -19364,7 +21257,7 @@ def post_encrypt_document_in_storage_with_http_info(self, name, user_password, o
query_params.append(('cryptoAlgorithm', params['crypto_algorithm']))
if 'permissions_flags' in params:
query_params.append(('permissionsFlags', params['permissions_flags']))
- collection_formats['permissionsFlags'] = 'multi'
+ collection_formats['permissionsFlags'] = 'csv'
if 'use_pdf20' in params:
query_params.append(('usePdf20', params['use_pdf20']))
if 'storage' in params:
@@ -19387,9 +21280,133 @@ def post_encrypt_document_in_storage_with_http_info(self, name, user_password, o
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/encrypt', 'POST',
+ 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 post_flatten_document(self, name, **kwargs):
+ """
+ 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_flatten_document(name, 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 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_flatten_document_with_http_info(name, **kwargs)
+ else:
+ (data) = self.post_flatten_document_with_http_info(name, **kwargs)
+ return data
+
+ def post_flatten_document_with_http_info(self, name, **kwargs):
+ """
+ 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_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 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
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ 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')
+ 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 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_flatten_document`")
+
+
+ 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 '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 = ['JWT']
- return self.api_client.call_api('/pdf/{name}/encrypt', 'POST',
+ return self.api_client.call_api('/pdf/{name}/flatten', 'POST',
path_params,
query_params,
header_params,
@@ -19404,61 +21421,57 @@ def post_encrypt_document_in_storage_with_http_info(self, name, user_password, o
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def post_flatten_document(self, name, **kwargs):
+ def post_import_fields_from_fdf(self, name, **kwargs):
"""
- Flatten the document.
+ Update fields from FDF file in request.
This method makes a synchronous HTTP request by default. To make 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.post_import_fields_from_fdf(name, 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 storage: The document storage.
:param str folder: The document folder.
+ :param file fdf_data: Fdf 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_flatten_document_with_http_info(name, **kwargs)
+ return self.post_import_fields_from_fdf_with_http_info(name, **kwargs)
else:
- (data) = self.post_flatten_document_with_http_info(name, **kwargs)
+ (data) = self.post_import_fields_from_fdf_with_http_info(name, **kwargs)
return data
- def post_flatten_document_with_http_info(self, name, **kwargs):
+ def post_import_fields_from_fdf_with_http_info(self, name, **kwargs):
"""
- Flatten the document.
+ Update fields from FDF file in request.
This method makes a synchronous HTTP request by default. To make 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.post_import_fields_from_fdf_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 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.
+ :param file fdf_data: Fdf file.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'update_appearances', 'call_events', 'hide_buttons', 'storage', 'folder']
+ all_params = ['name', 'storage', 'folder', 'fdf_data']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -19469,13 +21482,13 @@ 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 post_import_fields_from_fdf" % key
)
params[key] = val
del params['kwargs']
# verify the 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`")
+ raise ValueError("Missing the required parameter `name` when calling `post_import_fields_from_fdf`")
collection_formats = {}
@@ -19485,12 +21498,6 @@ def post_flatten_document_with_http_info(self, name, **kwargs):
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 'storage' in params:
query_params.append(('storage', params['storage']))
if 'folder' in params:
@@ -19500,6 +21507,8 @@ def post_flatten_document_with_http_info(self, name, **kwargs):
form_params = []
local_var_files = {}
+ if 'fdf_data' in params:
+ local_var_files['fdfData'] = params['fdf_data']
body_params = None
# HTTP header `Accept`
@@ -19508,12 +21517,12 @@ def post_flatten_document_with_http_info(self, name, **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 = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/flatten', 'POST',
+ return self.api_client.call_api('/pdf/{name}/import/fdf', 'POST',
path_params,
query_params,
header_params,
@@ -19528,69 +21537,57 @@ 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 post_import_fields_from_xfdf(self, name, **kwargs):
"""
- Insert image to document page.
+ Update fields from XFDF file in request.
This method makes a synchronous HTTP request by default. To make 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.post_import_fields_from_xfdf(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param int page_number: The page number. (required)
- :param float llx: Coordinate lower left X. (required)
- :param float lly: Coordinate lower left Y. (required)
- :param float urx: Coordinate upper right X. (required)
- :param float ury: Coordinate upper right Y. (required)
- :param str image_file_path: Path to image file if specified. Request content is used otherwise.
:param str storage: The document storage.
:param str folder: The document folder.
- :param file image: Image file.
+ :param file xfdf_data: Xfdf 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_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs)
+ return self.post_import_fields_from_xfdf_with_http_info(name, **kwargs)
else:
- (data) = self.post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs)
+ (data) = self.post_import_fields_from_xfdf_with_http_info(name, **kwargs)
return data
- def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury, **kwargs):
+ def post_import_fields_from_xfdf_with_http_info(self, name, **kwargs):
"""
- Insert image to document page.
+ Update fields from XFDF file in request.
This method makes a synchronous HTTP request by default. To make 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.post_import_fields_from_xfdf_with_http_info(name, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param int page_number: The page number. (required)
- :param float llx: Coordinate lower left X. (required)
- :param float lly: Coordinate lower left Y. (required)
- :param float urx: Coordinate upper right X. (required)
- :param float ury: Coordinate upper right Y. (required)
- :param str image_file_path: Path to image file if specified. Request content is used otherwise.
:param str storage: The document storage.
:param str folder: The document folder.
- :param file image: Image file.
+ :param file xfdf_data: Xfdf file.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'page_number', 'llx', 'lly', 'urx', 'ury', 'image_file_path', 'storage', 'folder', 'image']
+ all_params = ['name', 'storage', 'folder', 'xfdf_data']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -19601,28 +21598,13 @@ def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method post_insert_image" % key
+ " to method post_import_fields_from_xfdf" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `post_insert_image`")
- # verify the required parameter 'page_number' is set
- if ('page_number' not in params) or (params['page_number'] is None):
- raise ValueError("Missing the required parameter `page_number` when calling `post_insert_image`")
- # verify the required parameter 'llx' is set
- if ('llx' not in params) or (params['llx'] is None):
- raise ValueError("Missing the required parameter `llx` when calling `post_insert_image`")
- # verify the required parameter 'lly' is set
- if ('lly' not in params) or (params['lly'] is None):
- raise ValueError("Missing the required parameter `lly` when calling `post_insert_image`")
- # verify the required parameter 'urx' is set
- if ('urx' not in params) or (params['urx'] is None):
- raise ValueError("Missing the required parameter `urx` when calling `post_insert_image`")
- # verify the required parameter 'ury' is set
- if ('ury' not in params) or (params['ury'] is None):
- raise ValueError("Missing the required parameter `ury` when calling `post_insert_image`")
+ raise ValueError("Missing the required parameter `name` when calling `post_import_fields_from_xfdf`")
collection_formats = {}
@@ -19630,20 +21612,8 @@ def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'page_number' in params:
- path_params['pageNumber'] = params['page_number']
query_params = []
- if 'llx' in params:
- query_params.append(('llx', params['llx']))
- if 'lly' in params:
- query_params.append(('lly', params['lly']))
- if 'urx' in params:
- query_params.append(('urx', params['urx']))
- if 'ury' in params:
- query_params.append(('ury', params['ury']))
- if 'image_file_path' in params:
- query_params.append(('imageFilePath', params['image_file_path']))
if 'storage' in params:
query_params.append(('storage', params['storage']))
if 'folder' in params:
@@ -19653,8 +21623,8 @@ def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury
form_params = []
local_var_files = {}
- if 'image' in params:
- local_var_files['image'] = params['image']
+ if 'xfdf_data' in params:
+ local_var_files['xfdfData'] = params['xfdf_data']
body_params = None
# HTTP header `Accept`
@@ -19666,9 +21636,9 @@ def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images', 'POST',
+ return self.api_client.call_api('/pdf/{name}/import/xfdf', 'POST',
path_params,
query_params,
header_params,
@@ -19683,59 +21653,57 @@ def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def post_move_file(self, src, dest, **kwargs):
+ def post_import_fields_from_xml(self, name, **kwargs):
"""
- Move a specific file
+ Update fields from XML file in request.
This method makes a synchronous HTTP request by default. To make 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.post_import_fields_from_xml(name, 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
+ :param str name: The document name. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :param file xml_data: Xml 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_move_file_with_http_info(src, dest, **kwargs)
+ return self.post_import_fields_from_xml_with_http_info(name, **kwargs)
else:
- (data) = self.post_move_file_with_http_info(src, dest, **kwargs)
+ (data) = self.post_import_fields_from_xml_with_http_info(name, **kwargs)
return data
- def post_move_file_with_http_info(self, src, dest, **kwargs):
+ def post_import_fields_from_xml_with_http_info(self, name, **kwargs):
"""
- Move a specific file
+ Update fields from XML file in request.
This method makes a synchronous HTTP request by default. To make 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.post_import_fields_from_xml_with_http_info(name, 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
+ :param str name: The document name. (required)
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :param file xml_data: Xml file.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['src', 'dest', 'version_id', 'storage', 'dest_storage']
+ all_params = ['name', 'storage', 'folder', 'xml_data']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -19746,38 +21714,33 @@ 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 post_import_fields_from_xml" % 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 'name' is set
+ if ('name' not in params) or (params['name'] is None):
+ raise ValueError("Missing the required parameter `name` when calling `post_import_fields_from_xml`")
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 'version_id' in params:
- query_params.append(('versionId', params['version_id']))
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 = {}
form_params = []
local_var_files = {}
+ if 'xml_data' in params:
+ local_var_files['xmlData'] = params['xml_data']
body_params = None
# HTTP header `Accept`
@@ -19789,9 +21752,9 @@ def post_move_file_with_http_info(self, src, dest, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/storage/file', 'POST',
+ return self.api_client.call_api('/pdf/{name}/import/xml', 'POST',
path_params,
query_params,
header_params,
@@ -19806,57 +21769,69 @@ 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_insert_image(self, name, page_number, llx, lly, urx, ury, **kwargs):
"""
- Move a specific folder
+ 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_move_folder(src, dest, 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 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
+ :param str name: The document name. (required)
+ :param int page_number: The page number. (required)
+ :param float llx: Coordinate lower left X. (required)
+ :param float lly: Coordinate lower left Y. (required)
+ :param float urx: Coordinate upper right X. (required)
+ :param float ury: Coordinate upper right Y. (required)
+ :param str image_file_path: Path to image file if specified. Request content is used otherwise.
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :param file image: Image file.
:return: AsposeResponse
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_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs)
else:
- (data) = self.post_move_folder_with_http_info(src, dest, **kwargs)
+ (data) = self.post_insert_image_with_http_info(name, page_number, llx, lly, urx, ury, **kwargs)
return data
- def post_move_folder_with_http_info(self, src, dest, **kwargs):
+ def post_insert_image_with_http_info(self, name, page_number, llx, lly, urx, ury, **kwargs):
"""
- Move a specific folder
+ 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_move_folder_with_http_info(src, dest, 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 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
+ :param str name: The document name. (required)
+ :param int page_number: The page number. (required)
+ :param float llx: Coordinate lower left X. (required)
+ :param float lly: Coordinate lower left Y. (required)
+ :param float urx: Coordinate upper right X. (required)
+ :param float ury: Coordinate upper right Y. (required)
+ :param str image_file_path: Path to image file if specified. Request content is used otherwise.
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :param file image: Image file.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['src', 'dest', 'storage', 'dest_storage']
+ 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')
@@ -19867,36 +21842,60 @@ 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_insert_image" % 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_insert_image`")
+ # verify the required parameter 'page_number' is set
+ if ('page_number' not in params) or (params['page_number'] is None):
+ raise ValueError("Missing the required parameter `page_number` when calling `post_insert_image`")
+ # verify the required parameter 'llx' is set
+ if ('llx' not in params) or (params['llx'] is None):
+ raise ValueError("Missing the required parameter `llx` when calling `post_insert_image`")
+ # verify the required parameter 'lly' is set
+ if ('lly' not in params) or (params['lly'] is None):
+ raise ValueError("Missing the required parameter `lly` when calling `post_insert_image`")
+ # verify the required parameter 'urx' is set
+ if ('urx' not in params) or (params['urx'] is None):
+ raise ValueError("Missing the required parameter `urx` when calling `post_insert_image`")
+ # verify the required parameter 'ury' is set
+ if ('ury' not in params) or (params['ury'] is None):
+ raise ValueError("Missing the required parameter `ury` when calling `post_insert_image`")
collection_formats = {}
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 '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 'dest_storage' in params:
- query_params.append(('destStorage', params['dest_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`
@@ -19905,12 +21904,12 @@ def post_move_folder_with_http_info(self, src, dest, **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 = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/storage/folder', 'POST',
+ return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images', 'POST',
path_params,
query_params,
header_params,
@@ -20034,7 +22033,7 @@ def post_move_page_with_http_info(self, name, page_number, new_index, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/movePage', 'POST',
path_params,
@@ -20051,7 +22050,7 @@ 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_optimize_document(self, name, options, **kwargs):
"""
Optimize document.
This method makes a synchronous HTTP request by default. To make an
@@ -20060,12 +22059,12 @@ def post_optimize_document(self, name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.post_optimize_document(name, callback=callback_function)
+ >>> thread = api.post_optimize_document(name, options, 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 OptimizeOptions options: The optimization options. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -20074,12 +22073,12 @@ def post_optimize_document(self, name, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.post_optimize_document_with_http_info(name, **kwargs)
+ return self.post_optimize_document_with_http_info(name, options, **kwargs)
else:
- (data) = self.post_optimize_document_with_http_info(name, **kwargs)
+ (data) = self.post_optimize_document_with_http_info(name, options, **kwargs)
return data
- def post_optimize_document_with_http_info(self, name, **kwargs):
+ def post_optimize_document_with_http_info(self, name, options, **kwargs):
"""
Optimize document.
This method makes a synchronous HTTP request by default. To make an
@@ -20088,12 +22087,12 @@ def post_optimize_document_with_http_info(self, name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.post_optimize_document_with_http_info(name, callback=callback_function)
+ >>> thread = api.post_optimize_document_with_http_info(name, options, 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 OptimizeOptions options: The optimization options. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -20119,6 +22118,9 @@ def post_optimize_document_with_http_info(self, name, **kwargs):
# verify the 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`")
+ # verify the required parameter 'options' is set
+ if ('options' not in params) or (params['options'] is None):
+ raise ValueError("Missing the required parameter `options` when calling `post_optimize_document`")
collection_formats = {}
@@ -20150,7 +22152,7 @@ def post_optimize_document_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/optimize', 'POST',
path_params,
@@ -20276,7 +22278,7 @@ def post_page_caret_annotations_with_http_info(self, name, page_number, annotati
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/caret', 'POST',
path_params,
@@ -20402,7 +22404,7 @@ def post_page_circle_annotations_with_http_info(self, name, page_number, annotat
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/circle', 'POST',
path_params,
@@ -20528,7 +22530,7 @@ def post_page_file_attachment_annotations_with_http_info(self, name, page_number
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/fileattachment', 'POST',
path_params,
@@ -20654,7 +22656,7 @@ def post_page_free_text_annotations_with_http_info(self, name, page_number, anno
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/freetext', 'POST',
path_params,
@@ -20780,7 +22782,7 @@ def post_page_highlight_annotations_with_http_info(self, name, page_number, anno
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/highlight', 'POST',
path_params,
@@ -20906,7 +22908,7 @@ def post_page_image_stamps_with_http_info(self, name, page_number, stamps, **kwa
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/stamps/image', 'POST',
path_params,
@@ -21032,7 +23034,7 @@ def post_page_ink_annotations_with_http_info(self, name, page_number, annotation
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/ink', 'POST',
path_params,
@@ -21158,7 +23160,7 @@ def post_page_line_annotations_with_http_info(self, name, page_number, annotatio
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/line', 'POST',
path_params,
@@ -21284,7 +23286,7 @@ def post_page_link_annotations_with_http_info(self, name, page_number, links, **
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/links', 'POST',
path_params,
@@ -21410,7 +23412,7 @@ def post_page_movie_annotations_with_http_info(self, name, page_number, annotati
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/movie', 'POST',
path_params,
@@ -21536,7 +23538,7 @@ def post_page_pdf_page_stamps_with_http_info(self, name, page_number, stamps, **
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/stamps/pdfpage', 'POST',
path_params,
@@ -21662,7 +23664,7 @@ def post_page_poly_line_annotations_with_http_info(self, name, page_number, anno
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polyline', 'POST',
path_params,
@@ -21788,7 +23790,7 @@ def post_page_polygon_annotations_with_http_info(self, name, page_number, annota
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/polygon', 'POST',
path_params,
@@ -21914,7 +23916,7 @@ def post_page_redaction_annotations_with_http_info(self, name, page_number, anno
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/redaction', 'POST',
path_params,
@@ -22040,7 +24042,7 @@ def post_page_screen_annotations_with_http_info(self, name, page_number, annotat
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/screen', 'POST',
path_params,
@@ -22166,7 +24168,7 @@ def post_page_sound_annotations_with_http_info(self, name, page_number, annotati
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/sound', 'POST',
path_params,
@@ -22292,7 +24294,7 @@ def post_page_square_annotations_with_http_info(self, name, page_number, annotat
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/square', 'POST',
path_params,
@@ -22418,7 +24420,7 @@ def post_page_squiggly_annotations_with_http_info(self, name, page_number, annot
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/squiggly', 'POST',
path_params,
@@ -22544,7 +24546,7 @@ def post_page_stamp_annotations_with_http_info(self, name, page_number, annotati
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/stamp', 'POST',
path_params,
@@ -22670,7 +24672,7 @@ def post_page_strike_out_annotations_with_http_info(self, name, page_number, ann
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/strikeout', 'POST',
path_params,
@@ -22796,7 +24798,7 @@ def post_page_tables_with_http_info(self, name, page_number, tables, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/tables', 'POST',
path_params,
@@ -22922,7 +24924,7 @@ def post_page_text_annotations_with_http_info(self, name, page_number, annotatio
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/text', 'POST',
path_params,
@@ -23048,7 +25050,7 @@ def post_page_text_replace_with_http_info(self, name, page_number, text_replace_
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/text/replace', 'POST',
path_params,
@@ -23174,7 +25176,7 @@ def post_page_text_stamps_with_http_info(self, name, page_number, stamps, **kwar
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/stamps/text', 'POST',
path_params,
@@ -23300,7 +25302,7 @@ def post_page_underline_annotations_with_http_info(self, name, page_number, anno
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/annotations/underline', 'POST',
path_params,
@@ -23426,7 +25428,7 @@ def post_popup_annotation_with_http_info(self, name, annotation_id, annotation,
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/{annotationId}/popup', 'POST',
path_params,
@@ -23443,7 +25445,7 @@ 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_sign_document(self, name, sign, **kwargs):
"""
Sign document.
This method makes a synchronous HTTP request by default. To make an
@@ -23452,12 +25454,12 @@ def post_sign_document(self, name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.post_sign_document(name, callback=callback_function)
+ >>> thread = api.post_sign_document(name, sign, 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 Signature sign: Signature object containing signature data. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -23466,12 +25468,12 @@ 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_sign_document_with_http_info(name, sign, **kwargs)
else:
- (data) = self.post_sign_document_with_http_info(name, **kwargs)
+ (data) = self.post_sign_document_with_http_info(name, sign, **kwargs)
return data
- def post_sign_document_with_http_info(self, name, **kwargs):
+ def post_sign_document_with_http_info(self, name, sign, **kwargs):
"""
Sign document.
This method makes a synchronous HTTP request by default. To make an
@@ -23480,12 +25482,12 @@ def post_sign_document_with_http_info(self, name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.post_sign_document_with_http_info(name, callback=callback_function)
+ >>> thread = api.post_sign_document_with_http_info(name, sign, 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 Signature sign: Signature object containing signature data. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -23493,7 +25495,7 @@ def post_sign_document_with_http_info(self, name, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'signature', 'storage', 'folder']
+ all_params = ['name', 'sign', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -23511,6 +25513,9 @@ def post_sign_document_with_http_info(self, name, **kwargs):
# verify the 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`")
+ # verify the required parameter 'sign' is set
+ if ('sign' not in params) or (params['sign'] is None):
+ raise ValueError("Missing the required parameter `sign` when calling `post_sign_document`")
collection_formats = {}
@@ -23531,8 +25536,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 'sign' in params:
+ body_params = params['sign']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
select_header_accept(['application/json'])
@@ -23542,7 +25547,7 @@ def post_sign_document_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/sign', 'POST',
path_params,
@@ -23559,7 +25564,7 @@ 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_sign_page(self, name, page_number, sign, **kwargs):
"""
Sign page.
This method makes a synchronous HTTP request by default. To make an
@@ -23568,13 +25573,13 @@ def post_sign_page(self, name, page_number, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.post_sign_page(name, page_number, callback=callback_function)
+ >>> thread = api.post_sign_page(name, page_number, sign, 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 Signature sign: Signature object containing signature data. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -23583,12 +25588,12 @@ 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_sign_page_with_http_info(name, page_number, sign, **kwargs)
else:
- (data) = self.post_sign_page_with_http_info(name, page_number, **kwargs)
+ (data) = self.post_sign_page_with_http_info(name, page_number, sign, **kwargs)
return data
- def post_sign_page_with_http_info(self, name, page_number, **kwargs):
+ def post_sign_page_with_http_info(self, name, page_number, sign, **kwargs):
"""
Sign page.
This method makes a synchronous HTTP request by default. To make an
@@ -23597,13 +25602,13 @@ def post_sign_page_with_http_info(self, name, page_number, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.post_sign_page_with_http_info(name, page_number, callback=callback_function)
+ >>> thread = api.post_sign_page_with_http_info(name, page_number, sign, 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 Signature sign: Signature object containing signature data. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -23611,7 +25616,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', 'sign', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -23632,6 +25637,9 @@ def post_sign_page_with_http_info(self, name, page_number, **kwargs):
# verify the required parameter 'page_number' is set
if ('page_number' not in params) or (params['page_number'] is None):
raise ValueError("Missing the required parameter `page_number` when calling `post_sign_page`")
+ # verify the required parameter 'sign' is set
+ if ('sign' not in params) or (params['sign'] is None):
+ raise ValueError("Missing the required parameter `sign` when calling `post_sign_page`")
collection_formats = {}
@@ -23654,8 +25662,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 'sign' in params:
+ body_params = params['sign']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
select_header_accept(['application/json'])
@@ -23665,7 +25673,7 @@ def post_sign_page_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/sign', 'POST',
path_params,
@@ -23789,7 +25797,7 @@ def post_split_document_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/split', 'POST',
path_params,
@@ -23901,7 +25909,7 @@ def put_add_new_page_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages', 'PUT',
path_params,
@@ -23918,7 +25926,7 @@ 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 put_add_text(self, name, page_number, paragraph, **kwargs):
"""
Add text to PDF document page.
This method makes a synchronous HTTP request by default. To make an
@@ -23927,13 +25935,13 @@ def put_add_text(self, name, page_number, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_add_text(name, page_number, callback=callback_function)
+ >>> thread = api.put_add_text(name, page_number, paragraph, 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 Paragraph paragraph: Paragraph data. (required)
:param str folder: Document folder.
:param str storage: The document storage.
:return: AsposeResponse
@@ -23942,12 +25950,12 @@ def put_add_text(self, name, page_number, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.put_add_text_with_http_info(name, page_number, **kwargs)
+ return self.put_add_text_with_http_info(name, page_number, paragraph, **kwargs)
else:
- (data) = self.put_add_text_with_http_info(name, page_number, **kwargs)
+ (data) = self.put_add_text_with_http_info(name, page_number, paragraph, **kwargs)
return data
- def put_add_text_with_http_info(self, name, page_number, **kwargs):
+ def put_add_text_with_http_info(self, name, page_number, paragraph, **kwargs):
"""
Add text to PDF document page.
This method makes a synchronous HTTP request by default. To make an
@@ -23956,13 +25964,13 @@ def put_add_text_with_http_info(self, name, page_number, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_add_text_with_http_info(name, page_number, callback=callback_function)
+ >>> thread = api.put_add_text_with_http_info(name, page_number, paragraph, 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 Paragraph paragraph: Paragraph data. (required)
:param str folder: Document folder.
:param str storage: The document storage.
:return: AsposeResponse
@@ -23991,6 +25999,9 @@ def put_add_text_with_http_info(self, name, page_number, **kwargs):
# verify the required parameter 'page_number' is set
if ('page_number' not in params) or (params['page_number'] is None):
raise ValueError("Missing the required parameter `page_number` when calling `put_add_text`")
+ # verify the required parameter 'paragraph' is set
+ if ('paragraph' not in params) or (params['paragraph'] is None):
+ raise ValueError("Missing the required parameter `paragraph` when calling `put_add_text`")
collection_formats = {}
@@ -24024,7 +26035,7 @@ def put_add_text_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/text', 'PUT',
path_params,
@@ -24128,7 +26139,7 @@ def put_annotations_flatten_with_http_info(self, name, **kwargs):
query_params.append(('endPage', params['end_page']))
if 'annotation_types' in params:
query_params.append(('annotationTypes', params['annotation_types']))
- collection_formats['annotationTypes'] = 'multi'
+ collection_formats['annotationTypes'] = 'csv'
if 'storage' in params:
query_params.append(('storage', params['storage']))
if 'folder' in params:
@@ -24149,7 +26160,7 @@ def put_annotations_flatten_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/flatten', 'PUT',
path_params,
@@ -24166,6 +26177,132 @@ def put_annotations_flatten_with_http_info(self, name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
+ def put_bookmark(self, name, bookmark_path, bookmark, **kwargs):
+ """
+ Update document bookmark.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.put_bookmark(name, bookmark_path, bookmark, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str bookmark_path: The bookmark path. (required)
+ :param Bookmark bookmark: The bookmark. (required)
+ :param str folder: The document folder.
+ :param str storage: The document storage.
+ :return: BookmarkResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.put_bookmark_with_http_info(name, bookmark_path, bookmark, **kwargs)
+ else:
+ (data) = self.put_bookmark_with_http_info(name, bookmark_path, bookmark, **kwargs)
+ return data
+
+ def put_bookmark_with_http_info(self, name, bookmark_path, bookmark, **kwargs):
+ """
+ Update document bookmark.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.put_bookmark_with_http_info(name, bookmark_path, bookmark, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str bookmark_path: The bookmark path. (required)
+ :param Bookmark bookmark: The bookmark. (required)
+ :param str folder: The document folder.
+ :param str storage: The document storage.
+ :return: BookmarkResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'bookmark_path', 'bookmark', '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_bookmark" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the 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_bookmark`")
+ # verify the required parameter 'bookmark_path' is set
+ if ('bookmark_path' not in params) or (params['bookmark_path'] is None):
+ raise ValueError("Missing the required parameter `bookmark_path` when calling `put_bookmark`")
+ # verify the required parameter 'bookmark' is set
+ if ('bookmark' not in params) or (params['bookmark'] is None):
+ raise ValueError("Missing the required parameter `bookmark` when calling `put_bookmark`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
+ if 'bookmark_path' in params:
+ path_params['bookmarkPath'] = params['bookmark_path']
+
+ query_params = []
+ if 'folder' in params:
+ query_params.append(('folder', params['folder']))
+ if 'storage' in params:
+ query_params.append(('storage', params['storage']))
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'bookmark' in params:
+ body_params = params['bookmark']
+ # 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/bookmarks/bookmark/{bookmarkPath}', 'PUT',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='BookmarkResponse',
+ 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_caret_annotation(self, name, annotation_id, annotation, **kwargs):
"""
Replace document caret annotation
@@ -24275,7 +26412,7 @@ def put_caret_annotation_with_http_info(self, name, annotation_id, annotation, *
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/caret/{annotationId}', 'PUT',
path_params,
@@ -24408,7 +26545,7 @@ def put_change_password_document_with_http_info(self, out_path, owner_password,
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/changepassword', 'PUT',
path_params,
@@ -24534,7 +26671,7 @@ def put_circle_annotation_with_http_info(self, name, annotation_id, annotation,
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/circle/{annotationId}', 'PUT',
path_params,
@@ -24551,57 +26688,169 @@ 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 put_create_document(self, name, **kwargs):
"""
- Upload a specific file
+ 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_create(path, file, callback=callback_function)
+ >>> thread = api.put_create_document(name, 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
+ :param str name: The new document name. (required)
+ :param str storage: The document storage.
+ :param str folder: The new document folder.
+ :return: DocumentResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.put_create_document_with_http_info(name, **kwargs)
+ else:
+ (data) = self.put_create_document_with_http_info(name, **kwargs)
+ return data
+
+ def put_create_document_with_http_info(self, name, **kwargs):
+ """
+ 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_create_document_with_http_info(name, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The new document name. (required)
+ :param str storage: The document storage.
+ :param str folder: The new document folder.
+ :return: DocumentResponse
+ If the method is called asynchronously,
+ 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 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_create_document`")
+
+
+ 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 = ['JWT']
+
+ 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='DocumentResponse',
+ 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_decrypt_document(self, out_path, password, **kwargs):
+ """
+ Decrypt document from content.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.put_decrypt_document(out_path, password, 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 str password: The password (encrypted Base64). (required)
+ :param str storage: The document storage.
+ :param file file: A file to be derypted.
: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_with_http_info(path, file, **kwargs)
+ return self.put_decrypt_document_with_http_info(out_path, password, **kwargs)
else:
- (data) = self.put_create_with_http_info(path, file, **kwargs)
+ (data) = self.put_decrypt_document_with_http_info(out_path, password, **kwargs)
return data
- def put_create_with_http_info(self, path, file, **kwargs):
+ def put_decrypt_document_with_http_info(self, out_path, password, **kwargs):
"""
- Upload a specific file
+ Decrypt document from content.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_create_with_http_info(path, file, callback=callback_function)
+ >>> thread = api.put_decrypt_document_with_http_info(out_path, password, 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
+ :param str out_path: Full resulting filename (ex. /folder1/folder2/result.doc) (required)
+ :param str password: The password (encrypted Base64). (required)
+ :param str storage: The document storage.
+ :param file file: A file to be derypted.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['path', 'file', 'version_id', 'storage']
+ all_params = ['out_path', 'password', 'storage', 'file']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -24612,16 +26861,16 @@ 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 put_decrypt_document" % 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 '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_decrypt_document`")
+ # verify the required parameter 'password' is set
+ if ('password' not in params) or (params['password'] is None):
+ raise ValueError("Missing the required parameter `password` when calling `put_decrypt_document`")
collection_formats = {}
@@ -24629,10 +26878,10 @@ def put_create_with_http_info(self, path, file, **kwargs):
path_params = {}
query_params = []
- if 'path' in params:
- query_params.append(('path', params['path']))
- if 'version_id' in params:
- query_params.append(('versionId', params['version_id']))
+ if 'out_path' in params:
+ query_params.append(('outPath', params['out_path']))
+ if 'password' in params:
+ query_params.append(('password', params['password']))
if 'storage' in params:
query_params.append(('storage', params['storage']))
@@ -24641,7 +26890,7 @@ def put_create_with_http_info(self, path, file, **kwargs):
form_params = []
local_var_files = {}
if 'file' in params:
- local_var_files['File'] = params['file']
+ local_var_files['file'] = params['file']
body_params = None
# HTTP header `Accept`
@@ -24653,9 +26902,9 @@ def put_create_with_http_info(self, path, file, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/storage/file', 'PUT',
+ return self.api_client.call_api('/pdf/decrypt', 'PUT',
path_params,
query_params,
header_params,
@@ -24670,55 +26919,65 @@ 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 put_encrypt_document(self, out_path, user_password, owner_password, crypto_algorithm, **kwargs):
"""
- Create empty document.
+ Encrypt document from content.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_create_document(name, callback=callback_function)
+ >>> thread = api.put_encrypt_document(out_path, user_password, owner_password, crypto_algorithm, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: The new document name. (required)
+ :param str out_path: Full resulting filename (ex. /folder1/folder2/result.doc) (required)
+ :param str user_password: User password (encrypted Base64). (required)
+ :param str owner_password: Owner password (encrypted Base64). (required)
+ :param str crypto_algorithm: Cryptographic algorithm, see CryptoAlgorithm for details. (required)
+ :param list[PermissionsFlags] permissions_flags: Array of document permissions, see PermissionsFlags for details.
+ :param bool use_pdf20: Support for revision 6 (Extension 8).
:param str storage: The document storage.
- :param str folder: The new document folder.
- :return: DocumentResponse
+ :param file file: A file to be encrypted.
+ :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.put_encrypt_document_with_http_info(out_path, user_password, owner_password, crypto_algorithm, **kwargs)
else:
- (data) = self.put_create_document_with_http_info(name, **kwargs)
+ (data) = self.put_encrypt_document_with_http_info(out_path, user_password, owner_password, crypto_algorithm, **kwargs)
return data
- def put_create_document_with_http_info(self, name, **kwargs):
+ def put_encrypt_document_with_http_info(self, out_path, user_password, owner_password, crypto_algorithm, **kwargs):
"""
- Create empty document.
+ Encrypt document from content.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_create_document_with_http_info(name, callback=callback_function)
+ >>> thread = api.put_encrypt_document_with_http_info(out_path, user_password, owner_password, crypto_algorithm, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str name: The new document name. (required)
+ :param str out_path: Full resulting filename (ex. /folder1/folder2/result.doc) (required)
+ :param str user_password: User password (encrypted Base64). (required)
+ :param str owner_password: Owner password (encrypted Base64). (required)
+ :param str crypto_algorithm: Cryptographic algorithm, see CryptoAlgorithm for details. (required)
+ :param list[PermissionsFlags] permissions_flags: Array of document permissions, see PermissionsFlags for details.
+ :param bool use_pdf20: Support for revision 6 (Extension 8).
:param str storage: The document storage.
- :param str folder: The new document folder.
- :return: DocumentResponse
+ :param file file: A file to be encrypted.
+ :return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'storage', 'folder']
+ all_params = ['out_path', 'user_password', 'owner_password', 'crypto_algorithm', 'permissions_flags', 'use_pdf20', 'storage', 'file']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -24729,31 +26988,51 @@ 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 put_encrypt_document" % key
)
params[key] = val
del params['kwargs']
- # verify the required parameter 'name' is set
- if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `put_create_document`")
+ # 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_encrypt_document`")
+ # verify the required parameter 'user_password' is set
+ if ('user_password' not in params) or (params['user_password'] is None):
+ raise ValueError("Missing the required parameter `user_password` when calling `put_encrypt_document`")
+ # verify the required parameter 'owner_password' is set
+ if ('owner_password' not in params) or (params['owner_password'] is None):
+ raise ValueError("Missing the required parameter `owner_password` when calling `put_encrypt_document`")
+ # verify the required parameter 'crypto_algorithm' is set
+ if ('crypto_algorithm' not in params) or (params['crypto_algorithm'] is None):
+ raise ValueError("Missing the required parameter `crypto_algorithm` when calling `put_encrypt_document`")
collection_formats = {}
path_params = {}
- if 'name' in params:
- path_params['name'] = params['name']
query_params = []
+ if 'out_path' in params:
+ query_params.append(('outPath', params['out_path']))
+ if 'user_password' in params:
+ query_params.append(('userPassword', params['user_password']))
+ if 'owner_password' in params:
+ query_params.append(('ownerPassword', params['owner_password']))
+ if 'crypto_algorithm' in params:
+ query_params.append(('cryptoAlgorithm', params['crypto_algorithm']))
+ if 'permissions_flags' in params:
+ query_params.append(('permissionsFlags', params['permissions_flags']))
+ collection_formats['permissionsFlags'] = 'csv'
+ if 'use_pdf20' in params:
+ query_params.append(('usePdf20', params['use_pdf20']))
if 'storage' in params:
query_params.append(('storage', params['storage']))
- if 'folder' in params:
- query_params.append(('folder', params['folder']))
header_params = {}
form_params = []
local_var_files = {}
+ if 'file' in params:
+ local_var_files['file'] = params['file']
body_params = None
# HTTP header `Accept`
@@ -24762,19 +27041,19 @@ def put_create_document_with_http_info(self, name, **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 = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}', 'PUT',
+ return self.api_client.call_api('/pdf/encrypt', 'PUT',
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'),
@@ -24782,55 +27061,57 @@ 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 put_epub_in_storage_to_pdf(self, name, src_path, **kwargs):
"""
- Create the 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_create_folder(path, callback=callback_function)
+ >>> thread = api.put_epub_in_storage_to_pdf(name, src_path, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str 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 src_path: Full source filename (ex. /folder1/folder2/template.epub) (required)
+ :param str storage: The document storage.
+ :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_create_folder_with_http_info(path, **kwargs)
+ return self.put_epub_in_storage_to_pdf_with_http_info(name, src_path, **kwargs)
else:
- (data) = self.put_create_folder_with_http_info(path, **kwargs)
+ (data) = self.put_epub_in_storage_to_pdf_with_http_info(name, src_path, **kwargs)
return data
- def put_create_folder_with_http_info(self, path, **kwargs):
+ def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
"""
- Create the 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_create_folder_with_http_info(path, callback=callback_function)
+ >>> thread = api.put_epub_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
- :param str 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 src_path: Full source filename (ex. /folder1/folder2/template.epub) (required)
+ :param str storage: The document storage.
+ :param str dst_folder: The destination document folder.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['path', 'storage', 'dest_storage']
+ all_params = ['name', 'src_path', 'storage', 'dst_folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -24841,26 +27122,31 @@ 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 put_epub_in_storage_to_pdf" % key
)
params[key] = val
del params['kwargs']
- # verify the required parameter 'path' is set
- if ('path' not in params) or (params['path'] is None):
- raise ValueError("Missing the required parameter `path` when calling `put_create_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 `put_epub_in_storage_to_pdf`")
+ # verify the required parameter 'src_path' is set
+ if ('src_path' not in params) or (params['src_path'] is None):
+ raise ValueError("Missing the required parameter `src_path` when calling `put_epub_in_storage_to_pdf`")
collection_formats = {}
path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
query_params = []
- if 'path' in params:
- query_params.append(('path', params['path']))
+ 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']))
+ if 'dst_folder' in params:
+ query_params.append(('dstFolder', params['dst_folder']))
header_params = {}
@@ -24877,9 +27163,9 @@ def put_create_folder_with_http_info(self, path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/storage/folder', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/create/epub', 'PUT',
path_params,
query_params,
header_params,
@@ -24894,57 +27180,57 @@ def put_create_folder_with_http_info(self, path, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def put_decrypt_document(self, out_path, password, **kwargs):
+ def put_export_fields_from_pdf_to_fdf_in_storage(self, name, fdf_output_file_path, **kwargs):
"""
- Decrypt document from content.
+ Export fields from from PDF in storage to FDF file in 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_decrypt_document(out_path, password, callback=callback_function)
+ >>> thread = api.put_export_fields_from_pdf_to_fdf_in_storage(name, fdf_output_file_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 str password: The password (encrypted Base64). (required)
+ :param str name: The document name. (required)
+ :param str fdf_output_file_path: The output Fdf file path. (required)
:param str storage: The document storage.
- :param file file: A file to be derypted.
+ :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_decrypt_document_with_http_info(out_path, password, **kwargs)
+ return self.put_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, fdf_output_file_path, **kwargs)
else:
- (data) = self.put_decrypt_document_with_http_info(out_path, password, **kwargs)
+ (data) = self.put_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, fdf_output_file_path, **kwargs)
return data
- def put_decrypt_document_with_http_info(self, out_path, password, **kwargs):
+ def put_export_fields_from_pdf_to_fdf_in_storage_with_http_info(self, name, fdf_output_file_path, **kwargs):
"""
- Decrypt document from content.
+ Export fields from from PDF in storage to FDF file in 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_decrypt_document_with_http_info(out_path, password, callback=callback_function)
+ >>> thread = api.put_export_fields_from_pdf_to_fdf_in_storage_with_http_info(name, fdf_output_file_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 str password: The password (encrypted Base64). (required)
+ :param str name: The document name. (required)
+ :param str fdf_output_file_path: The output Fdf file path. (required)
:param str storage: The document storage.
- :param file file: A file to be derypted.
+ :param str folder: The document folder.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['out_path', 'password', 'storage', 'file']
+ all_params = ['name', 'fdf_output_file_path', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -24955,36 +27241,36 @@ def put_decrypt_document_with_http_info(self, out_path, password, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method put_decrypt_document" % key
+ " to method put_export_fields_from_pdf_to_fdf_in_storage" % 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_decrypt_document`")
- # verify the required parameter 'password' is set
- if ('password' not in params) or (params['password'] is None):
- raise ValueError("Missing the required parameter `password` when calling `put_decrypt_document`")
+ # verify the 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_export_fields_from_pdf_to_fdf_in_storage`")
+ # verify the required parameter 'fdf_output_file_path' is set
+ if ('fdf_output_file_path' not in params) or (params['fdf_output_file_path'] is None):
+ raise ValueError("Missing the required parameter `fdf_output_file_path` when calling `put_export_fields_from_pdf_to_fdf_in_storage`")
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 'password' in params:
- query_params.append(('password', params['password']))
+ if 'fdf_output_file_path' in params:
+ query_params.append(('fdfOutputFilePath', params['fdf_output_file_path']))
if 'storage' in params:
query_params.append(('storage', params['storage']))
+ if 'folder' in params:
+ query_params.append(('folder', params['folder']))
header_params = {}
form_params = []
local_var_files = {}
- if 'file' in params:
- local_var_files['file'] = params['file']
body_params = None
# HTTP header `Accept`
@@ -24993,12 +27279,12 @@ def put_decrypt_document_with_http_info(self, out_path, password, **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 = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/decrypt', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/export/fdf', 'PUT',
path_params,
query_params,
header_params,
@@ -25013,65 +27299,57 @@ def put_decrypt_document_with_http_info(self, out_path, password, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def put_encrypt_document(self, out_path, user_password, owner_password, crypto_algorithm, **kwargs):
+ def put_export_fields_from_pdf_to_xfdf_in_storage(self, name, xfdf_output_file_path, **kwargs):
"""
- Encrypt document from content.
+ Export fields from from PDF in storage to XFDF file in 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_encrypt_document(out_path, user_password, owner_password, crypto_algorithm, callback=callback_function)
+ >>> thread = api.put_export_fields_from_pdf_to_xfdf_in_storage(name, xfdf_output_file_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 str user_password: User password (encrypted Base64). (required)
- :param str owner_password: Owner password (encrypted Base64). (required)
- :param str crypto_algorithm: Cryptographic algorithm, see for details. (required)
- :param list[PermissionsFlags] permissions_flags: Array of document permissions, see for details.
- :param bool use_pdf20: Support for revision 6 (Extension 8).
+ :param str name: The document name. (required)
+ :param str xfdf_output_file_path: The output xfdf file path. (required)
:param str storage: The document storage.
- :param file file: A file to be encrypted.
+ :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_encrypt_document_with_http_info(out_path, user_password, owner_password, crypto_algorithm, **kwargs)
+ return self.put_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, xfdf_output_file_path, **kwargs)
else:
- (data) = self.put_encrypt_document_with_http_info(out_path, user_password, owner_password, crypto_algorithm, **kwargs)
+ (data) = self.put_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, xfdf_output_file_path, **kwargs)
return data
- def put_encrypt_document_with_http_info(self, out_path, user_password, owner_password, crypto_algorithm, **kwargs):
+ def put_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(self, name, xfdf_output_file_path, **kwargs):
"""
- Encrypt document from content.
+ Export fields from from PDF in storage to XFDF file in 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_encrypt_document_with_http_info(out_path, user_password, owner_password, crypto_algorithm, callback=callback_function)
+ >>> thread = api.put_export_fields_from_pdf_to_xfdf_in_storage_with_http_info(name, xfdf_output_file_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 str user_password: User password (encrypted Base64). (required)
- :param str owner_password: Owner password (encrypted Base64). (required)
- :param str crypto_algorithm: Cryptographic algorithm, see for details. (required)
- :param list[PermissionsFlags] permissions_flags: Array of document permissions, see for details.
- :param bool use_pdf20: Support for revision 6 (Extension 8).
+ :param str name: The document name. (required)
+ :param str xfdf_output_file_path: The output xfdf file path. (required)
:param str storage: The document storage.
- :param file file: A file to be encrypted.
+ :param str folder: The document folder.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['out_path', 'user_password', 'owner_password', 'crypto_algorithm', 'permissions_flags', 'use_pdf20', 'storage', 'file']
+ all_params = ['name', 'xfdf_output_file_path', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -25082,51 +27360,36 @@ def put_encrypt_document_with_http_info(self, out_path, user_password, owner_pas
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method put_encrypt_document" % key
+ " to method put_export_fields_from_pdf_to_xfdf_in_storage" % 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_encrypt_document`")
- # verify the required parameter 'user_password' is set
- if ('user_password' not in params) or (params['user_password'] is None):
- raise ValueError("Missing the required parameter `user_password` when calling `put_encrypt_document`")
- # verify the required parameter 'owner_password' is set
- if ('owner_password' not in params) or (params['owner_password'] is None):
- raise ValueError("Missing the required parameter `owner_password` when calling `put_encrypt_document`")
- # verify the required parameter 'crypto_algorithm' is set
- if ('crypto_algorithm' not in params) or (params['crypto_algorithm'] is None):
- raise ValueError("Missing the required parameter `crypto_algorithm` when calling `put_encrypt_document`")
+ # verify the 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_export_fields_from_pdf_to_xfdf_in_storage`")
+ # verify the required parameter 'xfdf_output_file_path' is set
+ if ('xfdf_output_file_path' not in params) or (params['xfdf_output_file_path'] is None):
+ raise ValueError("Missing the required parameter `xfdf_output_file_path` when calling `put_export_fields_from_pdf_to_xfdf_in_storage`")
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 'user_password' in params:
- query_params.append(('userPassword', params['user_password']))
- if 'owner_password' in params:
- query_params.append(('ownerPassword', params['owner_password']))
- if 'crypto_algorithm' in params:
- query_params.append(('cryptoAlgorithm', params['crypto_algorithm']))
- if 'permissions_flags' in params:
- query_params.append(('permissionsFlags', params['permissions_flags']))
- collection_formats['permissionsFlags'] = 'multi'
- if 'use_pdf20' in params:
- query_params.append(('usePdf20', params['use_pdf20']))
+ if 'xfdf_output_file_path' in params:
+ query_params.append(('xfdfOutputFilePath', params['xfdf_output_file_path']))
if 'storage' in params:
query_params.append(('storage', params['storage']))
+ if 'folder' in params:
+ query_params.append(('folder', params['folder']))
header_params = {}
form_params = []
local_var_files = {}
- if 'file' in params:
- local_var_files['file'] = params['file']
body_params = None
# HTTP header `Accept`
@@ -25135,12 +27398,12 @@ def put_encrypt_document_with_http_info(self, out_path, user_password, owner_pas
# 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 = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/encrypt', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/export/xfdf', 'PUT',
path_params,
query_params,
header_params,
@@ -25155,57 +27418,57 @@ def put_encrypt_document_with_http_info(self, out_path, user_password, owner_pas
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def put_epub_in_storage_to_pdf(self, name, src_path, **kwargs):
+ def put_export_fields_from_pdf_to_xml_in_storage(self, name, xml_output_file_path, **kwargs):
"""
- Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.
+ Export fields from from PDF in storage to XML file in 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_epub_in_storage_to_pdf(name, src_path, callback=callback_function)
+ >>> thread = api.put_export_fields_from_pdf_to_xml_in_storage(name, xml_output_file_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.epub) (required)
+ :param str xml_output_file_path: The output xml file path. (required)
: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.put_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, xml_output_file_path, **kwargs)
else:
- (data) = self.put_epub_in_storage_to_pdf_with_http_info(name, src_path, **kwargs)
+ (data) = self.put_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, xml_output_file_path, **kwargs)
return data
- def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
+ def put_export_fields_from_pdf_to_xml_in_storage_with_http_info(self, name, xml_output_file_path, **kwargs):
"""
- Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.
+ Export fields from from PDF in storage to XML file in 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_epub_in_storage_to_pdf_with_http_info(name, src_path, callback=callback_function)
+ >>> thread = api.put_export_fields_from_pdf_to_xml_in_storage_with_http_info(name, xml_output_file_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.epub) (required)
+ :param str xml_output_file_path: The output xml file path. (required)
: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', 'xml_output_file_path', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -25216,16 +27479,16 @@ def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method put_epub_in_storage_to_pdf" % key
+ " to method put_export_fields_from_pdf_to_xml_in_storage" % key
)
params[key] = val
del params['kwargs']
# verify the 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 `put_export_fields_from_pdf_to_xml_in_storage`")
+ # verify the required parameter 'xml_output_file_path' is set
+ if ('xml_output_file_path' not in params) or (params['xml_output_file_path'] is None):
+ raise ValueError("Missing the required parameter `xml_output_file_path` when calling `put_export_fields_from_pdf_to_xml_in_storage`")
collection_formats = {}
@@ -25235,12 +27498,12 @@ def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
path_params['name'] = params['name']
query_params = []
- if 'src_path' in params:
- query_params.append(('srcPath', params['src_path']))
+ if 'xml_output_file_path' in params:
+ query_params.append(('xmlOutputFilePath', params['xml_output_file_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 = {}
@@ -25257,9 +27520,9 @@ def put_epub_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/create/epub', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/export/xml', 'PUT',
path_params,
query_params,
header_params,
@@ -25369,7 +27632,7 @@ def put_fields_flatten_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/fields/flatten', 'PUT',
path_params,
@@ -25495,7 +27758,7 @@ def put_file_attachment_annotation_with_http_info(self, name, annotation_id, ann
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/fileattachment/{annotationId}', 'PUT',
path_params,
@@ -25618,7 +27881,7 @@ def put_file_attachment_annotation_data_extract_with_http_info(self, name, annot
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/fileattachment/{annotationId}/data/extract', 'PUT',
path_params,
@@ -25744,7 +28007,7 @@ def put_free_text_annotation_with_http_info(self, name, annotation_id, annotatio
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/freetext/{annotationId}', 'PUT',
path_params,
@@ -25870,7 +28133,7 @@ def put_highlight_annotation_with_http_info(self, name, annotation_id, annotatio
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/highlight/{annotationId}', 'PUT',
path_params,
@@ -26021,7 +28284,7 @@ def put_html_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/create/html', 'PUT',
path_params,
@@ -26152,9 +28415,271 @@ def put_image_extract_as_gif_with_http_info(self, name, image_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
+
+ 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='AsposeResponse',
+ auth_settings=auth_settings,
+ callback=params.get('callback'),
+ _return_http_data_only=params.get('_return_http_data_only'),
+ _preload_content=params.get('_preload_content', True),
+ _request_timeout=params.get('_request_timeout'),
+ collection_formats=collection_formats)
+
+ def put_image_extract_as_jpeg(self, name, image_id, **kwargs):
+ """
+ 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_image_extract_as_jpeg(name, image_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str image_id: Image ID. (required)
+ :param int width: The converted image width.
+ :param int height: The converted image height.
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :param str dest_folder: The document folder.
+ :return: AsposeResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.put_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs)
+ else:
+ (data) = self.put_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs)
+ return data
+
+ def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs):
+ """
+ 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_image_extract_as_jpeg_with_http_info(name, image_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str image_id: Image ID. (required)
+ :param int width: The converted image width.
+ :param int height: The converted image height.
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :param str dest_folder: The document folder.
+ :return: AsposeResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder']
+ all_params.append('callback')
+ all_params.append('_return_http_data_only')
+ all_params.append('_preload_content')
+ all_params.append('_request_timeout')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method put_image_extract_as_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_image_extract_as_jpeg`")
+ # verify the required parameter 'image_id' is set
+ if ('image_id' not in params) or (params['image_id'] is None):
+ raise ValueError("Missing the required parameter `image_id` when calling `put_image_extract_as_jpeg`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
+ if 'image_id' in params:
+ path_params['imageId'] = params['image_id']
+
+ query_params = []
+ if 'width' in params:
+ query_params.append(('width', params['width']))
+ if 'height' in params:
+ query_params.append(('height', params['height']))
+ if 'storage' in params:
+ query_params.append(('storage', params['storage']))
+ if 'folder' in params:
+ query_params.append(('folder', params['folder']))
+ if 'dest_folder' in params:
+ query_params.append(('destFolder', params['dest_folder']))
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['JWT']
+
+ 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='AsposeResponse',
+ auth_settings=auth_settings,
+ callback=params.get('callback'),
+ _return_http_data_only=params.get('_return_http_data_only'),
+ _preload_content=params.get('_preload_content', True),
+ _request_timeout=params.get('_request_timeout'),
+ collection_formats=collection_formats)
+
+ def put_image_extract_as_png(self, name, image_id, **kwargs):
+ """
+ Extract document image in PNG format to folder
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.put_image_extract_as_png(name, image_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str image_id: Image ID. (required)
+ :param int width: The converted image width.
+ :param int height: The converted image height.
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :param str dest_folder: The document folder.
+ :return: AsposeResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.put_image_extract_as_png_with_http_info(name, image_id, **kwargs)
+ else:
+ (data) = self.put_image_extract_as_png_with_http_info(name, image_id, **kwargs)
+ return data
+
+ def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs):
+ """
+ Extract document image in PNG format to folder
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.put_image_extract_as_png_with_http_info(name, image_id, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param str image_id: Image ID. (required)
+ :param int width: The converted image width.
+ :param int height: The converted image height.
+ :param str storage: The document storage.
+ :param str folder: The document folder.
+ :param str dest_folder: The document folder.
+ :return: AsposeResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder']
+ all_params.append('callback')
+ all_params.append('_return_http_data_only')
+ all_params.append('_preload_content')
+ all_params.append('_request_timeout')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method put_image_extract_as_png" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'name' is set
+ if ('name' not in params) or (params['name'] is None):
+ raise ValueError("Missing the required parameter `name` when calling `put_image_extract_as_png`")
+ # verify the required parameter 'image_id' is set
+ if ('image_id' not in params) or (params['image_id'] is None):
+ raise ValueError("Missing the required parameter `image_id` when calling `put_image_extract_as_png`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
+ if 'image_id' in params:
+ path_params['imageId'] = params['image_id']
+
+ query_params = []
+ if 'width' in params:
+ query_params.append(('width', params['width']))
+ if 'height' in params:
+ query_params.append(('height', params['height']))
+ if 'storage' in params:
+ query_params.append(('storage', params['storage']))
+ if 'folder' in params:
+ query_params.append(('folder', params['folder']))
+ if 'dest_folder' in params:
+ query_params.append(('destFolder', params['dest_folder']))
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/gif', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/png', 'PUT',
path_params,
query_params,
header_params,
@@ -26169,16 +28694,16 @@ 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_image_extract_as_tiff(self, name, image_id, **kwargs):
"""
- Extract document image in JPEG format to folder
+ Extract document image in TIFF format to folder
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_image_extract_as_jpeg(name, image_id, 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)
@@ -26195,21 +28720,21 @@ def put_image_extract_as_jpeg(self, name, image_id, **kwargs):
"""
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_image_extract_as_tiff_with_http_info(name, image_id, **kwargs)
else:
- (data) = self.put_image_extract_as_jpeg_with_http_info(name, image_id, **kwargs)
+ (data) = self.put_image_extract_as_tiff_with_http_info(name, image_id, **kwargs)
return data
- def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs):
+ def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs):
"""
- Extract document image in JPEG format to folder
+ Extract document image in TIFF format to folder
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_image_extract_as_jpeg_with_http_info(name, image_id, 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)
@@ -26236,16 +28761,16 @@ 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_image_extract_as_tiff" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `put_image_extract_as_jpeg`")
+ 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_jpeg`")
+ raise ValueError("Missing the required parameter `image_id` when calling `put_image_extract_as_tiff`")
collection_formats = {}
@@ -26283,9 +28808,9 @@ def put_image_extract_as_jpeg_with_http_info(self, name, image_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/jpeg', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/tiff', 'PUT',
path_params,
query_params,
header_params,
@@ -26300,21 +28825,140 @@ 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_image_in_storage_to_pdf(self, name, image_templates, **kwargs):
"""
- Extract document image in PNG format to folder
+ Convert image file (located on storage) to PDF format and upload resulting file to storage.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_image_extract_as_png(name, image_id, 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 str image_id: Image ID. (required)
+ :param ImageTemplatesRequest image_templates: ImageTemplatesRequestImage templates (required)
+ :param str dst_folder: The destination document folder.
+ :param str storage: The document storage.
+ :return: AsposeResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.put_image_in_storage_to_pdf_with_http_info(name, image_templates, **kwargs)
+ else:
+ (data) = self.put_image_in_storage_to_pdf_with_http_info(name, image_templates, **kwargs)
+ return data
+
+ def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kwargs):
+ """
+ Convert image file (located on storage) to PDF format and upload resulting file to storage.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.put_image_in_storage_to_pdf_with_http_info(name, image_templates, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param ImageTemplatesRequest image_templates: ImageTemplatesRequestImage templates (required)
+ :param str dst_folder: The destination document folder.
+ :param str storage: The document storage.
+ :return: AsposeResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['name', 'image_templates', 'dst_folder', 'storage']
+ all_params.append('callback')
+ all_params.append('_return_http_data_only')
+ all_params.append('_preload_content')
+ all_params.append('_request_timeout')
+
+ params = locals()
+ for key, val in iteritems(params['kwargs']):
+ if key not in all_params:
+ raise TypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method put_image_in_storage_to_pdf" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'name' is set
+ if ('name' not in params) or (params['name'] is None):
+ raise ValueError("Missing the required parameter `name` when calling `put_image_in_storage_to_pdf`")
+ # verify the required parameter 'image_templates' is set
+ if ('image_templates' not in params) or (params['image_templates'] is None):
+ raise ValueError("Missing the required parameter `image_templates` when calling `put_image_in_storage_to_pdf`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'name' in params:
+ path_params['name'] = params['name']
+
+ query_params = []
+ if 'dst_folder' in params:
+ query_params.append(('dstFolder', params['dst_folder']))
+ if 'storage' in params:
+ query_params.append(('storage', params['storage']))
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'image_templates' in params:
+ body_params = params['image_templates']
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['application/json'])
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.\
+ select_header_content_type(['application/json'])
+
+ # Authentication setting
+ auth_settings = ['JWT']
+
+ return self.api_client.call_api('/pdf/{name}/create/images', 'PUT',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='AsposeResponse',
+ auth_settings=auth_settings,
+ callback=params.get('callback'),
+ _return_http_data_only=params.get('_return_http_data_only'),
+ _preload_content=params.get('_preload_content', True),
+ _request_timeout=params.get('_request_timeout'),
+ collection_formats=collection_formats)
+
+ def put_images_extract_as_gif(self, name, page_number, **kwargs):
+ """
+ Extract document images in GIF format to folder.
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.put_images_extract_as_gif(name, page_number, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str name: The document name. (required)
+ :param int page_number: The page number. (required)
:param int width: The converted image width.
:param int height: The converted image height.
:param str storage: The document storage.
@@ -26326,26 +28970,26 @@ def put_image_extract_as_png(self, name, image_id, **kwargs):
"""
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_images_extract_as_gif_with_http_info(name, page_number, **kwargs)
else:
- (data) = self.put_image_extract_as_png_with_http_info(name, image_id, **kwargs)
+ (data) = self.put_images_extract_as_gif_with_http_info(name, page_number, **kwargs)
return data
- def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs):
+ def put_images_extract_as_gif_with_http_info(self, name, page_number, **kwargs):
"""
- Extract document image in PNG format to folder
+ 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_image_extract_as_png_with_http_info(name, image_id, 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 str image_id: Image ID. (required)
+ :param int page_number: The page number. (required)
:param int width: The converted image width.
:param int height: The converted image height.
:param str storage: The document storage.
@@ -26356,7 +29000,7 @@ def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder']
+ 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')
@@ -26367,16 +29011,16 @@ 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_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_image_extract_as_png`")
- # verify the required parameter 'image_id' is set
- if ('image_id' not in params) or (params['image_id'] is None):
- raise ValueError("Missing the required parameter `image_id` when calling `put_image_extract_as_png`")
+ raise ValueError("Missing the required parameter `name` when calling `put_images_extract_as_gif`")
+ # verify the required parameter 'page_number' is set
+ if ('page_number' not in params) or (params['page_number'] is None):
+ raise ValueError("Missing the required parameter `page_number` when calling `put_images_extract_as_gif`")
collection_formats = {}
@@ -26384,8 +29028,8 @@ def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'image_id' in params:
- path_params['imageId'] = params['image_id']
+ if 'page_number' in params:
+ path_params['pageNumber'] = params['page_number']
query_params = []
if 'width' in params:
@@ -26414,9 +29058,9 @@ def put_image_extract_as_png_with_http_info(self, name, image_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/png', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/gif', 'PUT',
path_params,
query_params,
header_params,
@@ -26431,21 +29075,21 @@ 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_images_extract_as_jpeg(self, name, page_number, **kwargs):
"""
- Extract document image in TIFF format to folder
+ 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_image_extract_as_tiff(name, image_id, 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 str image_id: Image ID. (required)
+ :param int page_number: The page number. (required)
:param int width: The converted image width.
:param int height: The converted image height.
:param str storage: The document storage.
@@ -26457,26 +29101,26 @@ def put_image_extract_as_tiff(self, name, image_id, **kwargs):
"""
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_images_extract_as_jpeg_with_http_info(name, page_number, **kwargs)
else:
- (data) = self.put_image_extract_as_tiff_with_http_info(name, image_id, **kwargs)
+ (data) = self.put_images_extract_as_jpeg_with_http_info(name, page_number, **kwargs)
return data
- def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs):
+ def put_images_extract_as_jpeg_with_http_info(self, name, page_number, **kwargs):
"""
- Extract document image in TIFF format to folder
+ 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_image_extract_as_tiff_with_http_info(name, image_id, 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 str image_id: Image ID. (required)
+ :param int page_number: The page number. (required)
:param int width: The converted image width.
:param int height: The converted image height.
:param str storage: The document storage.
@@ -26487,7 +29131,7 @@ def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs):
returns the request thread.
"""
- all_params = ['name', 'image_id', 'width', 'height', 'storage', 'folder', 'dest_folder']
+ 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')
@@ -26498,16 +29142,16 @@ 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_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_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_images_extract_as_jpeg`")
+ # verify the required parameter 'page_number' is set
+ if ('page_number' not in params) or (params['page_number'] is None):
+ raise ValueError("Missing the required parameter `page_number` when calling `put_images_extract_as_jpeg`")
collection_formats = {}
@@ -26515,8 +29159,8 @@ def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs):
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
- if 'image_id' in params:
- path_params['imageId'] = params['image_id']
+ if 'page_number' in params:
+ path_params['pageNumber'] = params['page_number']
query_params = []
if 'width' in params:
@@ -26545,9 +29189,9 @@ def put_image_extract_as_tiff_with_http_info(self, name, image_id, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/images/{imageId}/extract/tiff', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/jpeg', 'PUT',
path_params,
query_params,
header_params,
@@ -26562,57 +29206,63 @@ 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_images_extract_as_png(self, name, page_number, **kwargs):
"""
- Convert image file (located on storage) to PDF format 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_image_in_storage_to_pdf(name, image_templates, 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 ImageTemplatesRequest image_templates: Image templates (required)
- :param str dst_folder: The destination document folder.
+ :param int page_number: The page number. (required)
+ :param int width: The converted image width.
+ :param int height: The converted image height.
:param str storage: The document storage.
+ :param str folder: The document folder.
+ :param str dest_folder: The document folder.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.put_image_in_storage_to_pdf_with_http_info(name, image_templates, **kwargs)
+ return self.put_images_extract_as_png_with_http_info(name, page_number, **kwargs)
else:
- (data) = self.put_image_in_storage_to_pdf_with_http_info(name, image_templates, **kwargs)
+ (data) = self.put_images_extract_as_png_with_http_info(name, page_number, **kwargs)
return data
- def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kwargs):
+ def put_images_extract_as_png_with_http_info(self, name, page_number, **kwargs):
"""
- Convert image file (located on storage) to PDF format 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_image_in_storage_to_pdf_with_http_info(name, image_templates, 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 ImageTemplatesRequest image_templates: Image templates (required)
- :param str dst_folder: The destination document folder.
+ :param int page_number: The page number. (required)
+ :param int width: The converted image width.
+ :param int height: The converted image height.
:param str storage: The document storage.
+ :param str folder: The document folder.
+ :param str dest_folder: The document folder.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'image_templates', 'dst_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')
@@ -26623,16 +29273,16 @@ 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_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_image_in_storage_to_pdf`")
- # verify the required parameter 'image_templates' is set
- if ('image_templates' not in params) or (params['image_templates'] is None):
- raise ValueError("Missing the required parameter `image_templates` when calling `put_image_in_storage_to_pdf`")
+ raise ValueError("Missing the required parameter `name` when calling `put_images_extract_as_png`")
+ # verify the required parameter 'page_number' is set
+ if ('page_number' not in params) or (params['page_number'] is None):
+ raise ValueError("Missing the required parameter `page_number` when calling `put_images_extract_as_png`")
collection_formats = {}
@@ -26640,12 +29290,20 @@ def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kw
path_params = {}
if 'name' in params:
path_params['name'] = params['name']
+ if 'page_number' in params:
+ path_params['pageNumber'] = params['page_number']
query_params = []
- if 'dst_folder' in params:
- query_params.append(('dstFolder', params['dst_folder']))
+ if '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 = {}
@@ -26653,8 +29311,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'])
@@ -26664,9 +29320,9 @@ def put_image_in_storage_to_pdf_with_http_info(self, name, image_templates, **kw
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/create/images', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/png', 'PUT',
path_params,
query_params,
header_params,
@@ -26681,16 +29337,16 @@ 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_images_extract_as_tiff(self, name, page_number, **kwargs):
"""
- Extract document images in GIF format to folder.
+ Extract document images in TIFF format to folder.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_images_extract_as_gif(name, page_number, 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)
@@ -26707,21 +29363,21 @@ def put_images_extract_as_gif(self, name, page_number, **kwargs):
"""
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_images_extract_as_tiff_with_http_info(name, page_number, **kwargs)
else:
- (data) = self.put_images_extract_as_gif_with_http_info(name, page_number, **kwargs)
+ (data) = self.put_images_extract_as_tiff_with_http_info(name, page_number, **kwargs)
return data
- def put_images_extract_as_gif_with_http_info(self, name, page_number, **kwargs):
+ def put_images_extract_as_tiff_with_http_info(self, name, page_number, **kwargs):
"""
- Extract document images in GIF format to folder.
+ Extract document images in TIFF format to folder.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_images_extract_as_gif_with_http_info(name, page_number, 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)
@@ -26748,16 +29404,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_images_extract_as_tiff" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'name' is set
if ('name' not in params) or (params['name'] is None):
- raise ValueError("Missing the required parameter `name` when calling `put_images_extract_as_gif`")
+ 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_gif`")
+ raise ValueError("Missing the required parameter `page_number` when calling `put_images_extract_as_tiff`")
collection_formats = {}
@@ -26795,9 +29451,9 @@ def put_images_extract_as_gif_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/gif', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/tiff', 'PUT',
path_params,
query_params,
header_params,
@@ -26812,63 +29468,57 @@ 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_import_fields_from_fdf_in_storage(self, name, fdf_file_path, **kwargs):
"""
- Extract document images in JPEG format to folder.
+ Update fields from FDF file in 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_jpeg(name, page_number, callback=callback_function)
+ >>> thread = api.put_import_fields_from_fdf_in_storage(name, fdf_file_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 storage:
+ :param str fdf_file_path: The Fdf file path. (required)
+ :param str storage: The document storage.
:param str folder: The document folder.
- :param str dest_folder: The document folder.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.put_images_extract_as_jpeg_with_http_info(name, page_number, **kwargs)
+ return self.put_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, **kwargs)
else:
- (data) = self.put_images_extract_as_jpeg_with_http_info(name, page_number, **kwargs)
+ (data) = self.put_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_path, **kwargs)
return data
- def put_images_extract_as_jpeg_with_http_info(self, name, page_number, **kwargs):
+ def put_import_fields_from_fdf_in_storage_with_http_info(self, name, fdf_file_path, **kwargs):
"""
- Extract document images in JPEG format to folder.
+ Update fields from FDF file in 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_jpeg_with_http_info(name, page_number, callback=callback_function)
+ >>> thread = api.put_import_fields_from_fdf_in_storage_with_http_info(name, fdf_file_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 storage:
+ :param str fdf_file_path: The Fdf file path. (required)
+ :param str storage: The document storage.
:param str folder: The document folder.
- :param str dest_folder: The document folder.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'page_number', 'width', 'height', 'storage', 'folder', 'dest_folder']
+ all_params = ['name', 'fdf_file_path', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -26879,16 +29529,16 @@ 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_import_fields_from_fdf_in_storage" % key
)
params[key] = val
del params['kwargs']
# verify the 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_import_fields_from_fdf_in_storage`")
+ # verify the required parameter 'fdf_file_path' is set
+ if ('fdf_file_path' not in params) or (params['fdf_file_path'] is None):
+ raise ValueError("Missing the required parameter `fdf_file_path` when calling `put_import_fields_from_fdf_in_storage`")
collection_formats = {}
@@ -26896,20 +29546,14 @@ 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 'fdf_file_path' in params:
+ query_params.append(('fdfFilePath', params['fdf_file_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']))
header_params = {}
@@ -26926,9 +29570,9 @@ def put_images_extract_as_jpeg_with_http_info(self, name, page_number, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/jpeg', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/import/fdf', 'PUT',
path_params,
query_params,
header_params,
@@ -26943,63 +29587,57 @@ 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_import_fields_from_xfdf_in_storage(self, name, xfdf_file_path, **kwargs):
"""
- Extract document images in PNG format to folder.
+ Update fields from XFDF file in 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_png(name, page_number, callback=callback_function)
+ >>> thread = api.put_import_fields_from_xfdf_in_storage(name, xfdf_file_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 xfdf_file_path: The XFDF file path. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :param str dest_folder: The document folder.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.put_images_extract_as_png_with_http_info(name, page_number, **kwargs)
+ return self.put_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, **kwargs)
else:
- (data) = self.put_images_extract_as_png_with_http_info(name, page_number, **kwargs)
+ (data) = self.put_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_path, **kwargs)
return data
- def put_images_extract_as_png_with_http_info(self, name, page_number, **kwargs):
+ def put_import_fields_from_xfdf_in_storage_with_http_info(self, name, xfdf_file_path, **kwargs):
"""
- Extract document images in PNG format to folder.
+ Update fields from XFDF file in 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_png_with_http_info(name, page_number, callback=callback_function)
+ >>> thread = api.put_import_fields_from_xfdf_in_storage_with_http_info(name, xfdf_file_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 xfdf_file_path: The XFDF file path. (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :param str dest_folder: The document folder.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'page_number', 'width', 'height', 'storage', 'folder', 'dest_folder']
+ all_params = ['name', 'xfdf_file_path', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -27010,16 +29648,16 @@ 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_import_fields_from_xfdf_in_storage" % key
)
params[key] = val
del params['kwargs']
# verify the 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_import_fields_from_xfdf_in_storage`")
+ # verify the required parameter 'xfdf_file_path' is set
+ if ('xfdf_file_path' not in params) or (params['xfdf_file_path'] is None):
+ raise ValueError("Missing the required parameter `xfdf_file_path` when calling `put_import_fields_from_xfdf_in_storage`")
collection_formats = {}
@@ -27027,20 +29665,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']
query_params = []
- if 'width' in params:
- query_params.append(('width', params['width']))
- if 'height' in params:
- query_params.append(('height', params['height']))
+ if 'xfdf_file_path' in params:
+ query_params.append(('xfdfFilePath', params['xfdf_file_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']))
header_params = {}
@@ -27057,9 +29689,9 @@ def put_images_extract_as_png_with_http_info(self, name, page_number, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/png', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/import/xfdf', 'PUT',
path_params,
query_params,
header_params,
@@ -27074,63 +29706,57 @@ 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_import_fields_from_xml_in_storage(self, name, xml_file_path, **kwargs):
"""
- Extract document images in TIFF format to folder.
+ Update fields from XML file in 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_import_fields_from_xml_in_storage(name, xml_file_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 xml_file_path: Full source filename (ex. /folder1/folder2/template.xml) (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :param str dest_folder: The document folder.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.put_images_extract_as_tiff_with_http_info(name, page_number, **kwargs)
+ return self.put_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, **kwargs)
else:
- (data) = self.put_images_extract_as_tiff_with_http_info(name, page_number, **kwargs)
+ (data) = self.put_import_fields_from_xml_in_storage_with_http_info(name, xml_file_path, **kwargs)
return data
- def put_images_extract_as_tiff_with_http_info(self, name, page_number, **kwargs):
+ def put_import_fields_from_xml_in_storage_with_http_info(self, name, xml_file_path, **kwargs):
"""
- Extract document images in TIFF format to folder.
+ Update fields from XML file in 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_import_fields_from_xml_in_storage_with_http_info(name, xml_file_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 xml_file_path: Full source filename (ex. /folder1/folder2/template.xml) (required)
:param str storage: The document storage.
:param str folder: The document folder.
- :param str dest_folder: The document folder.
:return: AsposeResponse
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['name', 'page_number', 'width', 'height', 'storage', 'folder', 'dest_folder']
+ all_params = ['name', 'xml_file_path', 'storage', 'folder']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -27141,16 +29767,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_import_fields_from_xml_in_storage" % key
)
params[key] = val
del params['kwargs']
# verify the 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_import_fields_from_xml_in_storage`")
+ # verify the required parameter 'xml_file_path' is set
+ if ('xml_file_path' not in params) or (params['xml_file_path'] is None):
+ raise ValueError("Missing the required parameter `xml_file_path` when calling `put_import_fields_from_xml_in_storage`")
collection_formats = {}
@@ -27158,20 +29784,14 @@ 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']
query_params = []
- if 'width' in params:
- query_params.append(('width', params['width']))
- if 'height' in params:
- query_params.append(('height', params['height']))
+ if 'xml_file_path' in params:
+ query_params.append(('xmlFilePath', params['xml_file_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']))
header_params = {}
@@ -27188,9 +29808,9 @@ def put_images_extract_as_tiff_with_http_info(self, name, page_number, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
- return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/images/extract/tiff', 'PUT',
+ return self.api_client.call_api('/pdf/{name}/import/xml', 'PUT',
path_params,
query_params,
header_params,
@@ -27314,7 +29934,7 @@ def put_ink_annotation_with_http_info(self, name, annotation_id, annotation, **k
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/ink/{annotationId}', 'PUT',
path_params,
@@ -27433,7 +30053,7 @@ def put_la_te_x_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/create/latex', 'PUT',
path_params,
@@ -27559,7 +30179,7 @@ def put_line_annotation_with_http_info(self, name, annotation_id, annotation, **
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/line/{annotationId}', 'PUT',
path_params,
@@ -27685,7 +30305,7 @@ def put_link_annotation_with_http_info(self, name, link_id, link, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/links/{linkId}', 'PUT',
path_params,
@@ -27702,7 +30322,7 @@ 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_merge_documents(self, name, merge_documents, **kwargs):
"""
Merge a list of documents.
This method makes a synchronous HTTP request by default. To make an
@@ -27711,12 +30331,12 @@ def put_merge_documents(self, name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_merge_documents(name, callback=callback_function)
+ >>> thread = api.put_merge_documents(name, merge_documents, 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 MergeDocuments merge_documents: MergeDocuments with a list of documents. (required)
:param str storage: Resulting document storage.
:param str folder: Resulting document folder.
:return: DocumentResponse
@@ -27725,12 +30345,12 @@ def put_merge_documents(self, name, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.put_merge_documents_with_http_info(name, **kwargs)
+ return self.put_merge_documents_with_http_info(name, merge_documents, **kwargs)
else:
- (data) = self.put_merge_documents_with_http_info(name, **kwargs)
+ (data) = self.put_merge_documents_with_http_info(name, merge_documents, **kwargs)
return data
- def put_merge_documents_with_http_info(self, name, **kwargs):
+ def put_merge_documents_with_http_info(self, name, merge_documents, **kwargs):
"""
Merge a list of documents.
This method makes a synchronous HTTP request by default. To make an
@@ -27739,12 +30359,12 @@ def put_merge_documents_with_http_info(self, name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_merge_documents_with_http_info(name, callback=callback_function)
+ >>> thread = api.put_merge_documents_with_http_info(name, merge_documents, 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 MergeDocuments merge_documents: MergeDocuments with a list of documents. (required)
:param str storage: Resulting document storage.
:param str folder: Resulting document folder.
:return: DocumentResponse
@@ -27770,6 +30390,9 @@ def put_merge_documents_with_http_info(self, name, **kwargs):
# verify the 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`")
+ # verify the required parameter 'merge_documents' is set
+ if ('merge_documents' not in params) or (params['merge_documents'] is None):
+ raise ValueError("Missing the required parameter `merge_documents` when calling `put_merge_documents`")
collection_formats = {}
@@ -27801,7 +30424,7 @@ def put_merge_documents_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/merge', 'PUT',
path_params,
@@ -27920,7 +30543,7 @@ def put_mht_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/create/mht', 'PUT',
path_params,
@@ -28046,7 +30669,7 @@ def put_movie_annotation_with_http_info(self, name, annotation_id, annotation, *
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/movie/{annotationId}', 'PUT',
path_params,
@@ -28078,7 +30701,7 @@ def put_page_add_stamp(self, name, page_number, stamp, **kwargs):
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 Stamp stamp: Stamp with data. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -28107,7 +30730,7 @@ def put_page_add_stamp_with_http_info(self, name, page_number, stamp, **kwargs):
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 Stamp stamp: Stamp with data. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -28172,7 +30795,7 @@ def put_page_add_stamp_with_http_info(self, name, page_number, stamp, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/stamp', 'PUT',
path_params,
@@ -28306,7 +30929,7 @@ def put_page_convert_to_bmp_with_http_info(self, name, page_number, out_path, **
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/bmp', 'PUT',
path_params,
@@ -28440,7 +31063,7 @@ def put_page_convert_to_emf_with_http_info(self, name, page_number, out_path, **
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/emf', 'PUT',
path_params,
@@ -28574,7 +31197,7 @@ def put_page_convert_to_gif_with_http_info(self, name, page_number, out_path, **
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/gif', 'PUT',
path_params,
@@ -28708,7 +31331,7 @@ def put_page_convert_to_jpeg_with_http_info(self, name, page_number, out_path, *
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/jpeg', 'PUT',
path_params,
@@ -28842,7 +31465,7 @@ def put_page_convert_to_png_with_http_info(self, name, page_number, out_path, **
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/png', 'PUT',
path_params,
@@ -28976,7 +31599,7 @@ def put_page_convert_to_tiff_with_http_info(self, name, page_number, out_path, *
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/pages/{pageNumber}/convert/tiff', 'PUT',
path_params,
@@ -29095,7 +31718,7 @@ def put_pcl_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/create/pcl', 'PUT',
path_params,
@@ -29239,7 +31862,7 @@ def put_pdf_in_request_to_doc_with_http_info(self, out_path, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/doc', 'PUT',
path_params,
@@ -29355,7 +31978,7 @@ def put_pdf_in_request_to_epub_with_http_info(self, out_path, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/epub', 'PUT',
path_params,
@@ -29533,7 +32156,7 @@ def put_pdf_in_request_to_html_with_http_info(self, out_path, **kwargs):
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'
+ collection_formats['explicitListOfSavedPages'] = 'csv'
if 'font_encoding_strategy' in params:
query_params.append(('fontEncodingStrategy', params['font_encoding_strategy']))
if 'font_saving_mode' in params:
@@ -29580,7 +32203,7 @@ def put_pdf_in_request_to_html_with_http_info(self, out_path, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/html', 'PUT',
path_params,
@@ -29696,7 +32319,7 @@ def put_pdf_in_request_to_la_te_x_with_http_info(self, out_path, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/latex', 'PUT',
path_params,
@@ -29808,7 +32431,7 @@ def put_pdf_in_request_to_mobi_xml_with_http_info(self, out_path, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/mobixml', 'PUT',
path_params,
@@ -29927,7 +32550,7 @@ def put_pdf_in_request_to_pdf_a_with_http_info(self, out_path, type, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/pdfa', 'PUT',
path_params,
@@ -30047,7 +32670,7 @@ def put_pdf_in_request_to_pptx_with_http_info(self, out_path, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/pptx', 'PUT',
path_params,
@@ -30159,7 +32782,7 @@ def put_pdf_in_request_to_svg_with_http_info(self, out_path, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/svg', 'PUT',
path_params,
@@ -30331,7 +32954,7 @@ def put_pdf_in_request_to_tiff_with_http_info(self, out_path, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/tiff', 'PUT',
path_params,
@@ -30459,7 +33082,7 @@ def put_pdf_in_request_to_xls_with_http_info(self, out_path, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/xls', 'PUT',
path_params,
@@ -30587,7 +33210,7 @@ def put_pdf_in_request_to_xlsx_with_http_info(self, out_path, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/xlsx', 'PUT',
path_params,
@@ -30699,7 +33322,7 @@ def put_pdf_in_request_to_xml_with_http_info(self, out_path, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/xml', 'PUT',
path_params,
@@ -30811,7 +33434,7 @@ def put_pdf_in_request_to_xps_with_http_info(self, out_path, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/xps', 'PUT',
path_params,
@@ -30962,7 +33585,7 @@ def put_pdf_in_storage_to_doc_with_http_info(self, name, out_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/doc', 'PUT',
path_params,
@@ -31085,7 +33708,7 @@ def put_pdf_in_storage_to_epub_with_http_info(self, name, out_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/epub', 'PUT',
path_params,
@@ -31270,7 +33893,7 @@ def put_pdf_in_storage_to_html_with_http_info(self, name, out_path, **kwargs):
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'
+ collection_formats['explicitListOfSavedPages'] = 'csv'
if 'font_encoding_strategy' in params:
query_params.append(('fontEncodingStrategy', params['font_encoding_strategy']))
if 'font_saving_mode' in params:
@@ -31317,7 +33940,7 @@ def put_pdf_in_storage_to_html_with_http_info(self, name, out_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/html', 'PUT',
path_params,
@@ -31440,7 +34063,7 @@ def put_pdf_in_storage_to_la_te_x_with_http_info(self, name, out_path, **kwargs)
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/latex', 'PUT',
path_params,
@@ -31559,7 +34182,7 @@ def put_pdf_in_storage_to_mobi_xml_with_http_info(self, name, out_path, **kwargs
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/mobixml', 'PUT',
path_params,
@@ -31685,7 +34308,7 @@ def put_pdf_in_storage_to_pdf_a_with_http_info(self, name, out_path, type, **kwa
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/pdfa', 'PUT',
path_params,
@@ -31812,7 +34435,7 @@ def put_pdf_in_storage_to_pptx_with_http_info(self, name, out_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/pptx', 'PUT',
path_params,
@@ -31931,7 +34554,7 @@ def put_pdf_in_storage_to_svg_with_http_info(self, name, out_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/svg', 'PUT',
path_params,
@@ -32110,7 +34733,7 @@ def put_pdf_in_storage_to_tiff_with_http_info(self, name, out_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/tiff', 'PUT',
path_params,
@@ -32245,7 +34868,7 @@ def put_pdf_in_storage_to_xls_with_http_info(self, name, out_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/xls', 'PUT',
path_params,
@@ -32380,7 +35003,7 @@ def put_pdf_in_storage_to_xlsx_with_http_info(self, name, out_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/xlsx', 'PUT',
path_params,
@@ -32499,7 +35122,7 @@ def put_pdf_in_storage_to_xml_with_http_info(self, name, out_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/xml', 'PUT',
path_params,
@@ -32618,7 +35241,7 @@ def put_pdf_in_storage_to_xps_with_http_info(self, name, out_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/xps', 'PUT',
path_params,
@@ -32744,7 +35367,7 @@ def put_poly_line_annotation_with_http_info(self, name, annotation_id, annotatio
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/polyline/{annotationId}', 'PUT',
path_params,
@@ -32870,7 +35493,7 @@ def put_polygon_annotation_with_http_info(self, name, annotation_id, annotation,
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/polygon/{annotationId}', 'PUT',
path_params,
@@ -32996,7 +35619,7 @@ def put_popup_annotation_with_http_info(self, name, annotation_id, annotation, *
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/popup/{annotationId}', 'PUT',
path_params,
@@ -33013,7 +35636,7 @@ 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_privileges(self, name, privileges, **kwargs):
"""
Update privilege document.
This method makes a synchronous HTTP request by default. To make an
@@ -33022,12 +35645,12 @@ def put_privileges(self, name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_privileges(name, callback=callback_function)
+ >>> thread = api.put_privileges(name, privileges, 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 DocumentPrivilege privileges: Document privileges. DocumentPrivilege (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -33036,12 +35659,12 @@ def put_privileges(self, name, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.put_privileges_with_http_info(name, **kwargs)
+ return self.put_privileges_with_http_info(name, privileges, **kwargs)
else:
- (data) = self.put_privileges_with_http_info(name, **kwargs)
+ (data) = self.put_privileges_with_http_info(name, privileges, **kwargs)
return data
- def put_privileges_with_http_info(self, name, **kwargs):
+ def put_privileges_with_http_info(self, name, privileges, **kwargs):
"""
Update privilege document.
This method makes a synchronous HTTP request by default. To make an
@@ -33050,12 +35673,12 @@ def put_privileges_with_http_info(self, name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_privileges_with_http_info(name, callback=callback_function)
+ >>> thread = api.put_privileges_with_http_info(name, privileges, 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 DocumentPrivilege privileges: Document privileges. DocumentPrivilege (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: AsposeResponse
@@ -33081,6 +35704,9 @@ def put_privileges_with_http_info(self, name, **kwargs):
# verify the 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`")
+ # verify the required parameter 'privileges' is set
+ if ('privileges' not in params) or (params['privileges'] is None):
+ raise ValueError("Missing the required parameter `privileges` when calling `put_privileges`")
collection_formats = {}
@@ -33112,7 +35738,7 @@ def put_privileges_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/privileges', 'PUT',
path_params,
@@ -33231,7 +35857,7 @@ def put_ps_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/create/ps', 'PUT',
path_params,
@@ -33357,7 +35983,7 @@ def put_redaction_annotation_with_http_info(self, name, annotation_id, annotatio
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/redaction/{annotationId}', 'PUT',
path_params,
@@ -33484,7 +36110,7 @@ def put_replace_image_with_http_info(self, name, image_id, **kwargs):
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/images/{imageId}', 'PUT',
path_params,
@@ -33610,7 +36236,7 @@ def put_screen_annotation_with_http_info(self, name, annotation_id, annotation,
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/screen/{annotationId}', 'PUT',
path_params,
@@ -33736,7 +36362,7 @@ def put_screen_annotation_data_extract_with_http_info(self, name, annotation_id,
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/screen/{annotationId}/data/extract', 'PUT',
path_params,
@@ -33852,7 +36478,7 @@ def put_searchable_document_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/ocr', 'PUT',
path_params,
@@ -33978,7 +36604,7 @@ def put_set_property_with_http_info(self, name, property_name, value, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/documentproperties/{propertyName}', 'PUT',
path_params,
@@ -34104,7 +36730,7 @@ def put_sound_annotation_with_http_info(self, name, annotation_id, annotation, *
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/sound/{annotationId}', 'PUT',
path_params,
@@ -34230,7 +36856,7 @@ def put_sound_annotation_data_extract_with_http_info(self, name, annotation_id,
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/sound/{annotationId}/data/extract', 'PUT',
path_params,
@@ -34356,7 +36982,7 @@ def put_square_annotation_with_http_info(self, name, annotation_id, annotation,
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/square/{annotationId}', 'PUT',
path_params,
@@ -34482,7 +37108,7 @@ def put_squiggly_annotation_with_http_info(self, name, annotation_id, annotation
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/squiggly/{annotationId}', 'PUT',
path_params,
@@ -34608,7 +37234,7 @@ def put_stamp_annotation_with_http_info(self, name, annotation_id, annotation, *
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/stamp/{annotationId}', 'PUT',
path_params,
@@ -34734,7 +37360,7 @@ def put_stamp_annotation_data_extract_with_http_info(self, name, annotation_id,
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/stamp/{annotationId}/data/extract', 'PUT',
path_params,
@@ -34860,7 +37486,7 @@ def put_strike_out_annotation_with_http_info(self, name, annotation_id, annotati
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/strikeout/{annotationId}', 'PUT',
path_params,
@@ -35011,7 +37637,7 @@ def put_svg_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/create/svg', 'PUT',
path_params,
@@ -35137,7 +37763,7 @@ def put_table_with_http_info(self, name, table_id, table, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/tables/{tableId}', 'PUT',
path_params,
@@ -35263,7 +37889,7 @@ def put_text_annotation_with_http_info(self, name, annotation_id, annotation, **
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/text/{annotationId}', 'PUT',
path_params,
@@ -35389,7 +38015,7 @@ def put_underline_annotation_with_http_info(self, name, annotation_id, annotatio
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/annotations/underline/{annotationId}', 'PUT',
path_params,
@@ -35406,7 +38032,7 @@ def put_underline_annotation_with_http_info(self, name, annotation_id, annotatio
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def put_update_field(self, name, field_name, **kwargs):
+ def put_update_field(self, name, field_name, field, **kwargs):
"""
Update field.
This method makes a synchronous HTTP request by default. To make an
@@ -35415,13 +38041,13 @@ def put_update_field(self, name, field_name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_update_field(name, field_name, callback=callback_function)
+ >>> thread = api.put_update_field(name, field_name, field, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str field_name: The name of a field to be updated. (required)
- :param Field field: with the field data.
+ :param Field field: Field with the field data. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: FieldResponse
@@ -35430,12 +38056,12 @@ def put_update_field(self, name, field_name, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.put_update_field_with_http_info(name, field_name, **kwargs)
+ return self.put_update_field_with_http_info(name, field_name, field, **kwargs)
else:
- (data) = self.put_update_field_with_http_info(name, field_name, **kwargs)
+ (data) = self.put_update_field_with_http_info(name, field_name, field, **kwargs)
return data
- def put_update_field_with_http_info(self, name, field_name, **kwargs):
+ def put_update_field_with_http_info(self, name, field_name, field, **kwargs):
"""
Update field.
This method makes a synchronous HTTP request by default. To make an
@@ -35444,13 +38070,13 @@ def put_update_field_with_http_info(self, name, field_name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_update_field_with_http_info(name, field_name, callback=callback_function)
+ >>> thread = api.put_update_field_with_http_info(name, field_name, field, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
:param str field_name: The name of a field to be updated. (required)
- :param Field field: with the field data.
+ :param Field field: Field with the field data. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: FieldResponse
@@ -35479,6 +38105,9 @@ def put_update_field_with_http_info(self, name, field_name, **kwargs):
# verify the required parameter 'field_name' is set
if ('field_name' not in params) or (params['field_name'] is None):
raise ValueError("Missing the required parameter `field_name` when calling `put_update_field`")
+ # verify the required parameter 'field' is set
+ if ('field' not in params) or (params['field'] is None):
+ raise ValueError("Missing the required parameter `field` when calling `put_update_field`")
collection_formats = {}
@@ -35512,7 +38141,7 @@ def put_update_field_with_http_info(self, name, field_name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/fields/{fieldName}', 'PUT',
path_params,
@@ -35529,7 +38158,7 @@ def put_update_field_with_http_info(self, name, field_name, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def put_update_fields(self, name, **kwargs):
+ def put_update_fields(self, name, fields, **kwargs):
"""
Update fields.
This method makes a synchronous HTTP request by default. To make an
@@ -35538,12 +38167,12 @@ def put_update_fields(self, name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_update_fields(name, callback=callback_function)
+ >>> thread = api.put_update_fields(name, fields, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param Fields fields: with the fields data.
+ :param Fields fields: Fields with the fields data. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: FieldsResponse
@@ -35552,12 +38181,12 @@ def put_update_fields(self, name, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.put_update_fields_with_http_info(name, **kwargs)
+ return self.put_update_fields_with_http_info(name, fields, **kwargs)
else:
- (data) = self.put_update_fields_with_http_info(name, **kwargs)
+ (data) = self.put_update_fields_with_http_info(name, fields, **kwargs)
return data
- def put_update_fields_with_http_info(self, name, **kwargs):
+ def put_update_fields_with_http_info(self, name, fields, **kwargs):
"""
Update fields.
This method makes a synchronous HTTP request by default. To make an
@@ -35566,12 +38195,12 @@ def put_update_fields_with_http_info(self, name, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.put_update_fields_with_http_info(name, callback=callback_function)
+ >>> thread = api.put_update_fields_with_http_info(name, fields, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
:param str name: The document name. (required)
- :param Fields fields: with the fields data.
+ :param Fields fields: Fields with the fields data. (required)
:param str storage: The document storage.
:param str folder: The document folder.
:return: FieldsResponse
@@ -35597,6 +38226,9 @@ def put_update_fields_with_http_info(self, name, **kwargs):
# verify the 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_update_fields`")
+ # verify the required parameter 'fields' is set
+ if ('fields' not in params) or (params['fields'] is None):
+ raise ValueError("Missing the required parameter `fields` when calling `put_update_fields`")
collection_formats = {}
@@ -35628,7 +38260,7 @@ def put_update_fields_with_http_info(self, name, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/fields', 'PUT',
path_params,
@@ -35775,7 +38407,7 @@ def put_web_in_storage_to_pdf_with_http_info(self, name, url, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/create/web', 'PUT',
path_params,
@@ -35887,7 +38519,7 @@ def put_xfa_pdf_in_request_to_acro_form_with_http_info(self, out_path, **kwargs)
select_header_content_type(['multipart/form-data'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/convert/xfatoacroform', 'PUT',
path_params,
@@ -36006,7 +38638,7 @@ def put_xfa_pdf_in_storage_to_acro_form_with_http_info(self, name, out_path, **k
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/convert/xfatoacroform', 'PUT',
path_params,
@@ -36129,7 +38761,7 @@ def put_xml_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/create/xml', 'PUT',
path_params,
@@ -36248,7 +38880,7 @@ def put_xps_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/create/xps', 'PUT',
path_params,
@@ -36367,7 +38999,7 @@ def put_xsl_fo_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
select_header_content_type(['application/json'])
# Authentication setting
- auth_settings = []
+ auth_settings = ['JWT']
return self.api_client.call_api('/pdf/{name}/create/xslfo', 'PUT',
path_params,
@@ -36383,3 +39015,222 @@ def put_xsl_fo_in_storage_to_pdf_with_http_info(self, name, src_path, **kwargs):
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
+
+ def storage_exists(self, storage_name, **kwargs):
+ """
+ Check if storage exists
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.storage_exists(storage_name, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str storage_name: Storage name (required)
+ :return: StorageExist
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.storage_exists_with_http_info(storage_name, **kwargs)
+ else:
+ (data) = self.storage_exists_with_http_info(storage_name, **kwargs)
+ return data
+
+ def storage_exists_with_http_info(self, storage_name, **kwargs):
+ """
+ Check if storage exists
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please define a `callback` function
+ to be invoked when receiving the response.
+ >>> def callback_function(response):
+ >>> pprint(response)
+ >>>
+ >>> thread = api.storage_exists_with_http_info(storage_name, callback=callback_function)
+
+ :param callback function: The callback function
+ for asynchronous request. (optional)
+ :param str storage_name: Storage name (required)
+ :return: StorageExist
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['storage_name']
+ 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 storage_exists" % key
+ )
+ params[key] = val
+ del params['kwargs']
+ # verify the required parameter 'storage_name' is set
+ if ('storage_name' not in params) or (params['storage_name'] is None):
+ raise ValueError("Missing the required parameter `storage_name` when calling `storage_exists`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'storage_name' in params:
+ path_params['storageName'] = params['storage_name']
+
+ query_params = []
+
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/storage/{storageName}/exist', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='StorageExist',
+ 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 upload_file(self, path, file, **kwargs):
+ """
+ Upload 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.upload_file(path, file, 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 If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. (required)
+ :param file file: File to upload (required)
+ :param str storage_name: Storage name
+ :return: FilesUploadResult
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.upload_file_with_http_info(path, file, **kwargs)
+ else:
+ (data) = self.upload_file_with_http_info(path, file, **kwargs)
+ return data
+
+ def upload_file_with_http_info(self, path, file, **kwargs):
+ """
+ Upload 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.upload_file_with_http_info(path, file, 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 If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. (required)
+ :param file file: File to upload (required)
+ :param str storage_name: Storage name
+ :return: FilesUploadResult
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['path', 'file', 'storage_name']
+ 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 upload_file" % 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 `upload_file`")
+ # 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 `upload_file`")
+
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'path' in params:
+ path_params['path'] = params['path']
+
+ query_params = []
+ if 'storage_name' in params:
+ query_params.append(('storageName', params['storage_name']))
+
+ 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 = ['JWT']
+
+ return self.api_client.call_api('/pdf/storage/file/{path}', 'PUT',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='FilesUploadResult',
+ 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)
diff --git a/asposepdfcloud/configuration.py b/asposepdfcloud/configuration.py
index 097b65a..0974dc9 100644
--- a/asposepdfcloud/configuration.py
+++ b/asposepdfcloud/configuration.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -62,7 +62,7 @@ def __init__(self):
Constructor
"""
# Default Base url
- self.host = "https://api.aspose.cloud/v2.0"
+ self.host = "https://api.aspose.cloud/v3.0"
# Default api client
self.api_client = None
# Temp file folder for downloading files
@@ -71,9 +71,6 @@ def __init__(self):
# access token for OAuth
self.access_token = ""
- # refresh token for OAuth
- self.refresh_token = ""
-
# Logging Settings
self.logger = {}
self.logger["package_logger"] = logging.getLogger("swagger_client")
@@ -201,6 +198,6 @@ def to_debug_report(self):
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
- "Version of the API: 2.0\n"\
- "SDK Package Version: 19.5.0".\
+ "Version of the API: 3.0\n"\
+ "SDK Package Version: 19.7.0".\
format(env=sys.platform, pyversion=sys.version)
diff --git a/asposepdfcloud/models/__init__.py b/asposepdfcloud/models/__init__.py
index 5c89ff3..5844bc7 100644
--- a/asposepdfcloud/models/__init__.py
+++ b/asposepdfcloud/models/__init__.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -35,7 +35,6 @@
from .annotation_state import AnnotationState
from .annotation_type import AnnotationType
from .antialiasing_processing_type import AntialiasingProcessingType
-from .append_document import AppendDocument
from .aspose_response import AsposeResponse
from .border_corner_style import BorderCornerStyle
from .border_info import BorderInfo
@@ -54,10 +53,13 @@
from .doc_recognition_mode import DocRecognitionMode
from .document_privilege import DocumentPrivilege
from .epub_recognition_mode import EpubRecognitionMode
+from .error import Error
+from .error_details import ErrorDetails
from .field_type import FieldType
-from .file import File
-from .file_exist import FileExist
from .file_icon import FileIcon
+from .file_versions import FileVersions
+from .files_list import FilesList
+from .files_upload_result import FilesUploadResult
from .font_encoding_rules import FontEncodingRules
from .font_saving_modes import FontSavingModes
from .font_styles import FontStyles
@@ -80,6 +82,7 @@
from .link_highlighting_mode import LinkHighlightingMode
from .margin_info import MarginInfo
from .merge_documents import MergeDocuments
+from .object_exist import ObjectExist
from .optimize_options import OptimizeOptions
from .page_word_count import PageWordCount
from .paragraph import Paragraph
@@ -104,6 +107,8 @@
from .stamp import Stamp
from .stamp_icon import StampIcon
from .stamp_type import StampType
+from .storage_exist import StorageExist
+from .storage_file import StorageFile
from .table_broken import TableBroken
from .text_horizontal_alignment import TextHorizontalAlignment
from .text_icon import TextIcon
@@ -124,13 +129,16 @@
from .attachment_response import AttachmentResponse
from .attachments import Attachments
from .attachments_response import AttachmentsResponse
+from .bookmark import Bookmark
+from .bookmark_response import BookmarkResponse
+from .bookmarks import Bookmarks
+from .bookmarks_response import BookmarksResponse
from .caret_annotation_response import CaretAnnotationResponse
from .caret_annotations import CaretAnnotations
from .caret_annotations_response import CaretAnnotationsResponse
from .circle_annotation_response import CircleAnnotationResponse
from .circle_annotations import CircleAnnotations
from .circle_annotations_response import CircleAnnotationsResponse
-from .disc_usage_response import DiscUsageResponse
from .document import Document
from .document_page_response import DocumentPageResponse
from .document_pages_response import DocumentPagesResponse
@@ -146,10 +154,7 @@
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
-from .files_response import FilesResponse
from .free_text_annotation_response import FreeTextAnnotationResponse
from .free_text_annotations import FreeTextAnnotations
from .free_text_annotations_response import FreeTextAnnotationsResponse
@@ -209,7 +214,6 @@
from .stamp_info import StampInfo
from .stamps_info import StampsInfo
from .stamps_info_response import StampsInfoResponse
-from .storage_exist_response import StorageExistResponse
from .strike_out_annotation_response import StrikeOutAnnotationResponse
from .strike_out_annotations import StrikeOutAnnotations
from .strike_out_annotations_response import StrikeOutAnnotationsResponse
diff --git a/asposepdfcloud/models/annotation.py b/asposepdfcloud/models/annotation.py
index 639f4bc..b8b714a 100644
--- a/asposepdfcloud/models/annotation.py
+++ b/asposepdfcloud/models/annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -109,8 +109,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -301,6 +300,8 @@ def rect(self, rect):
:param rect: The rect of this Annotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/annotation_flags.py b/asposepdfcloud/models/annotation_flags.py
index 71e37b6..7071006 100644
--- a/asposepdfcloud/models/annotation_flags.py
+++ b/asposepdfcloud/models/annotation_flags.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/annotation_info.py b/asposepdfcloud/models/annotation_info.py
index 58a2166..387b8c3 100644
--- a/asposepdfcloud/models/annotation_info.py
+++ b/asposepdfcloud/models/annotation_info.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -112,8 +112,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -122,8 +121,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.horizontal_alignment = horizontal_alignment
if vertical_alignment is not None:
self.vertical_alignment = vertical_alignment
- if annotation_type is not None:
- self.annotation_type = annotation_type
+ self.annotation_type = annotation_type
@property
def links(self):
@@ -306,6 +304,8 @@ def rect(self, rect):
:param rect: The rect of this AnnotationInfo.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
@@ -421,6 +421,8 @@ def annotation_type(self, annotation_type):
:param annotation_type: The annotation_type of this AnnotationInfo.
:type: AnnotationType
"""
+ if annotation_type is None:
+ raise ValueError("Invalid value for `annotation_type`, must not be `None`")
self._annotation_type = annotation_type
diff --git a/asposepdfcloud/models/annotation_state.py b/asposepdfcloud/models/annotation_state.py
index d2bf95c..56d180e 100644
--- a/asposepdfcloud/models/annotation_state.py
+++ b/asposepdfcloud/models/annotation_state.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/annotation_type.py b/asposepdfcloud/models/annotation_type.py
index 898c4b5..a844dcb 100644
--- a/asposepdfcloud/models/annotation_type.py
+++ b/asposepdfcloud/models/annotation_type.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/annotations_info.py b/asposepdfcloud/models/annotations_info.py
index 3ffc8ff..c87654f 100644
--- a/asposepdfcloud/models/annotations_info.py
+++ b/asposepdfcloud/models/annotations_info.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/annotations_info_response.py b/asposepdfcloud/models/annotations_info_response.py
index 47b11af..789fa38 100644
--- a/asposepdfcloud/models/annotations_info_response.py
+++ b/asposepdfcloud/models/annotations_info_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/antialiasing_processing_type.py b/asposepdfcloud/models/antialiasing_processing_type.py
index 9881999..80d43fb 100644
--- a/asposepdfcloud/models/antialiasing_processing_type.py
+++ b/asposepdfcloud/models/antialiasing_processing_type.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/aspose_response.py b/asposepdfcloud/models/aspose_response.py
index eb4ac81..ad7b503 100644
--- a/asposepdfcloud/models/aspose_response.py
+++ b/asposepdfcloud/models/aspose_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/attachment.py b/asposepdfcloud/models/attachment.py
index 1cc44a5..8eb8cad 100644
--- a/asposepdfcloud/models/attachment.py
+++ b/asposepdfcloud/models/attachment.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -95,8 +95,7 @@ def __init__(self, links=None, description=None, mime_type=None, name=None, crea
self.creation_date = creation_date
if modification_date is not None:
self.modification_date = modification_date
- if size is not None:
- self.size = size
+ self.size = size
if check_sum is not None:
self.check_sum = check_sum
@@ -258,6 +257,8 @@ def size(self, size):
:param size: The size of this Attachment.
:type: int
"""
+ if size is None:
+ raise ValueError("Invalid value for `size`, must not be `None`")
self._size = size
diff --git a/asposepdfcloud/models/attachment_response.py b/asposepdfcloud/models/attachment_response.py
index f5e5432..e9324b2 100644
--- a/asposepdfcloud/models/attachment_response.py
+++ b/asposepdfcloud/models/attachment_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/attachments.py b/asposepdfcloud/models/attachments.py
index 2bf18af..eb03ae8 100644
--- a/asposepdfcloud/models/attachments.py
+++ b/asposepdfcloud/models/attachments.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/attachments_response.py b/asposepdfcloud/models/attachments_response.py
index c6d794d..52521d9 100644
--- a/asposepdfcloud/models/attachments_response.py
+++ b/asposepdfcloud/models/attachments_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/bookmark.py b/asposepdfcloud/models/bookmark.py
new file mode 100644
index 0000000..306ed1f
--- /dev/null
+++ b/asposepdfcloud/models/bookmark.py
@@ -0,0 +1,590 @@
+# 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: 3.0
+
+"""
+
+
+from pprint import pformat
+from six import iteritems
+import re
+
+
+class Bookmark(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]',
+ 'title': 'str',
+ 'italic': 'bool',
+ 'bold': 'bool',
+ 'color': 'Color',
+ 'action': 'str',
+ 'level': 'int',
+ 'destination': 'str',
+ 'page_display': 'str',
+ 'page_display_bottom': 'int',
+ 'page_display_left': 'int',
+ 'page_display_right': 'int',
+ 'page_display_top': 'int',
+ 'page_display_zoom': 'int',
+ 'page_number': 'int',
+ 'remote_file': 'str',
+ 'bookmarks': 'Bookmarks'
+ }
+
+ attribute_map = {
+ 'links': 'Links',
+ 'title': 'Title',
+ 'italic': 'Italic',
+ 'bold': 'Bold',
+ 'color': 'Color',
+ 'action': 'Action',
+ 'level': 'Level',
+ 'destination': 'Destination',
+ 'page_display': 'PageDisplay',
+ 'page_display_bottom': 'PageDisplay_Bottom',
+ 'page_display_left': 'PageDisplay_Left',
+ 'page_display_right': 'PageDisplay_Right',
+ 'page_display_top': 'PageDisplay_Top',
+ 'page_display_zoom': 'PageDisplay_Zoom',
+ 'page_number': 'PageNumber',
+ 'remote_file': 'RemoteFile',
+ 'bookmarks': 'Bookmarks'
+ }
+
+ def __init__(self, links=None, title=None, italic=None, bold=None, color=None, action=None, level=None, destination=None, page_display=None, page_display_bottom=None, page_display_left=None, page_display_right=None, page_display_top=None, page_display_zoom=None, page_number=None, remote_file=None, bookmarks=None):
+ """
+ Bookmark - a model defined in Swagger
+ """
+
+ self._links = None
+ self._title = None
+ self._italic = None
+ self._bold = None
+ self._color = None
+ self._action = None
+ self._level = None
+ self._destination = None
+ self._page_display = None
+ self._page_display_bottom = None
+ self._page_display_left = None
+ self._page_display_right = None
+ self._page_display_top = None
+ self._page_display_zoom = None
+ self._page_number = None
+ self._remote_file = None
+ self._bookmarks = None
+
+ if links is not None:
+ self.links = links
+ if title is not None:
+ self.title = title
+ if italic is not None:
+ self.italic = italic
+ if bold is not None:
+ self.bold = bold
+ if color is not None:
+ self.color = color
+ if action is not None:
+ self.action = action
+ if level is not None:
+ self.level = level
+ if destination is not None:
+ self.destination = destination
+ if page_display is not None:
+ self.page_display = page_display
+ if page_display_bottom is not None:
+ self.page_display_bottom = page_display_bottom
+ if page_display_left is not None:
+ self.page_display_left = page_display_left
+ if page_display_right is not None:
+ self.page_display_right = page_display_right
+ if page_display_top is not None:
+ self.page_display_top = page_display_top
+ if page_display_zoom is not None:
+ self.page_display_zoom = page_display_zoom
+ if page_number is not None:
+ self.page_number = page_number
+ if remote_file is not None:
+ self.remote_file = remote_file
+ if bookmarks is not None:
+ self.bookmarks = bookmarks
+
+ @property
+ def links(self):
+ """
+ Gets the links of this Bookmark.
+ Link to the document.
+
+ :return: The links of this Bookmark.
+ :rtype: list[Link]
+ """
+ return self._links
+
+ @links.setter
+ def links(self, links):
+ """
+ Sets the links of this Bookmark.
+ Link to the document.
+
+ :param links: The links of this Bookmark.
+ :type: list[Link]
+ """
+
+ self._links = links
+
+ @property
+ def title(self):
+ """
+ Gets the title of this Bookmark.
+ Get the Title;
+
+ :return: The title of this Bookmark.
+ :rtype: str
+ """
+ return self._title
+
+ @title.setter
+ def title(self, title):
+ """
+ Sets the title of this Bookmark.
+ Get the Title;
+
+ :param title: The title of this Bookmark.
+ :type: str
+ """
+
+ self._title = title
+
+ @property
+ def italic(self):
+ """
+ Gets the italic of this Bookmark.
+ Is bookmark italic.
+
+ :return: The italic of this Bookmark.
+ :rtype: bool
+ """
+ return self._italic
+
+ @italic.setter
+ def italic(self, italic):
+ """
+ Sets the italic of this Bookmark.
+ Is bookmark italic.
+
+ :param italic: The italic of this Bookmark.
+ :type: bool
+ """
+
+ self._italic = italic
+
+ @property
+ def bold(self):
+ """
+ Gets the bold of this Bookmark.
+ Is bookmark bold.
+
+ :return: The bold of this Bookmark.
+ :rtype: bool
+ """
+ return self._bold
+
+ @bold.setter
+ def bold(self, bold):
+ """
+ Sets the bold of this Bookmark.
+ Is bookmark bold.
+
+ :param bold: The bold of this Bookmark.
+ :type: bool
+ """
+
+ self._bold = bold
+
+ @property
+ def color(self):
+ """
+ Gets the color of this Bookmark.
+ Get the color
+
+ :return: The color of this Bookmark.
+ :rtype: Color
+ """
+ return self._color
+
+ @color.setter
+ def color(self, color):
+ """
+ Sets the color of this Bookmark.
+ Get the color
+
+ :param color: The color of this Bookmark.
+ :type: Color
+ """
+
+ self._color = color
+
+ @property
+ def action(self):
+ """
+ Gets the action of this Bookmark.
+ Gets or sets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: \"GoTo\", \"GoToR\", \"Launch\", \"Named\".
+
+ :return: The action of this Bookmark.
+ :rtype: str
+ """
+ return self._action
+
+ @action.setter
+ def action(self, action):
+ """
+ Sets the action of this Bookmark.
+ Gets or sets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: \"GoTo\", \"GoToR\", \"Launch\", \"Named\".
+
+ :param action: The action of this Bookmark.
+ :type: str
+ """
+
+ self._action = action
+
+ @property
+ def level(self):
+ """
+ Gets the level of this Bookmark.
+ Gets or sets bookmark's hierarchy level.
+
+ :return: The level of this Bookmark.
+ :rtype: int
+ """
+ return self._level
+
+ @level.setter
+ def level(self, level):
+ """
+ Sets the level of this Bookmark.
+ Gets or sets bookmark's hierarchy level.
+
+ :param level: The level of this Bookmark.
+ :type: int
+ """
+
+ self._level = level
+
+ @property
+ def destination(self):
+ """
+ Gets the destination of this Bookmark.
+ Gets or sets bookmark's destination page. Required if action is set as string.Empty.
+
+ :return: The destination of this Bookmark.
+ :rtype: str
+ """
+ return self._destination
+
+ @destination.setter
+ def destination(self, destination):
+ """
+ Sets the destination of this Bookmark.
+ Gets or sets bookmark's destination page. Required if action is set as string.Empty.
+
+ :param destination: The destination of this Bookmark.
+ :type: str
+ """
+
+ self._destination = destination
+
+ @property
+ def page_display(self):
+ """
+ Gets the page_display of this Bookmark.
+ Gets or sets the type of display bookmark's destination page.
+
+ :return: The page_display of this Bookmark.
+ :rtype: str
+ """
+ return self._page_display
+
+ @page_display.setter
+ def page_display(self, page_display):
+ """
+ Sets the page_display of this Bookmark.
+ Gets or sets the type of display bookmark's destination page.
+
+ :param page_display: The page_display of this Bookmark.
+ :type: str
+ """
+
+ self._page_display = page_display
+
+ @property
+ def page_display_bottom(self):
+ """
+ Gets the page_display_bottom of this Bookmark.
+ Gets or sets the bottom coordinate of page display.
+
+ :return: The page_display_bottom of this Bookmark.
+ :rtype: int
+ """
+ return self._page_display_bottom
+
+ @page_display_bottom.setter
+ def page_display_bottom(self, page_display_bottom):
+ """
+ Sets the page_display_bottom of this Bookmark.
+ Gets or sets the bottom coordinate of page display.
+
+ :param page_display_bottom: The page_display_bottom of this Bookmark.
+ :type: int
+ """
+
+ self._page_display_bottom = page_display_bottom
+
+ @property
+ def page_display_left(self):
+ """
+ Gets the page_display_left of this Bookmark.
+ Gets or sets the left coordinate of page display.
+
+ :return: The page_display_left of this Bookmark.
+ :rtype: int
+ """
+ return self._page_display_left
+
+ @page_display_left.setter
+ def page_display_left(self, page_display_left):
+ """
+ Sets the page_display_left of this Bookmark.
+ Gets or sets the left coordinate of page display.
+
+ :param page_display_left: The page_display_left of this Bookmark.
+ :type: int
+ """
+
+ self._page_display_left = page_display_left
+
+ @property
+ def page_display_right(self):
+ """
+ Gets the page_display_right of this Bookmark.
+ Gets or sets the right coordinate of page display.
+
+ :return: The page_display_right of this Bookmark.
+ :rtype: int
+ """
+ return self._page_display_right
+
+ @page_display_right.setter
+ def page_display_right(self, page_display_right):
+ """
+ Sets the page_display_right of this Bookmark.
+ Gets or sets the right coordinate of page display.
+
+ :param page_display_right: The page_display_right of this Bookmark.
+ :type: int
+ """
+
+ self._page_display_right = page_display_right
+
+ @property
+ def page_display_top(self):
+ """
+ Gets the page_display_top of this Bookmark.
+ Gets or sets the top coordinate of page display.
+
+ :return: The page_display_top of this Bookmark.
+ :rtype: int
+ """
+ return self._page_display_top
+
+ @page_display_top.setter
+ def page_display_top(self, page_display_top):
+ """
+ Sets the page_display_top of this Bookmark.
+ Gets or sets the top coordinate of page display.
+
+ :param page_display_top: The page_display_top of this Bookmark.
+ :type: int
+ """
+
+ self._page_display_top = page_display_top
+
+ @property
+ def page_display_zoom(self):
+ """
+ Gets the page_display_zoom of this Bookmark.
+ Gets or sets the zoom factor of page display.
+
+ :return: The page_display_zoom of this Bookmark.
+ :rtype: int
+ """
+ return self._page_display_zoom
+
+ @page_display_zoom.setter
+ def page_display_zoom(self, page_display_zoom):
+ """
+ Sets the page_display_zoom of this Bookmark.
+ Gets or sets the zoom factor of page display.
+
+ :param page_display_zoom: The page_display_zoom of this Bookmark.
+ :type: int
+ """
+
+ self._page_display_zoom = page_display_zoom
+
+ @property
+ def page_number(self):
+ """
+ Gets the page_number of this Bookmark.
+ Gets or sets the number of bookmark's destination page.
+
+ :return: The page_number of this Bookmark.
+ :rtype: int
+ """
+ return self._page_number
+
+ @page_number.setter
+ def page_number(self, page_number):
+ """
+ Sets the page_number of this Bookmark.
+ Gets or sets the number of bookmark's destination page.
+
+ :param page_number: The page_number of this Bookmark.
+ :type: int
+ """
+
+ self._page_number = page_number
+
+ @property
+ def remote_file(self):
+ """
+ Gets the remote_file of this Bookmark.
+ Gets or sets the file (path) which is required for \"GoToR\" action of bookmark.
+
+ :return: The remote_file of this Bookmark.
+ :rtype: str
+ """
+ return self._remote_file
+
+ @remote_file.setter
+ def remote_file(self, remote_file):
+ """
+ Sets the remote_file of this Bookmark.
+ Gets or sets the file (path) which is required for \"GoToR\" action of bookmark.
+
+ :param remote_file: The remote_file of this Bookmark.
+ :type: str
+ """
+
+ self._remote_file = remote_file
+
+ @property
+ def bookmarks(self):
+ """
+ Gets the bookmarks of this Bookmark.
+ The children bookmarks.
+
+ :return: The bookmarks of this Bookmark.
+ :rtype: Bookmarks
+ """
+ return self._bookmarks
+
+ @bookmarks.setter
+ def bookmarks(self, bookmarks):
+ """
+ Sets the bookmarks of this Bookmark.
+ The children bookmarks.
+
+ :param bookmarks: The bookmarks of this Bookmark.
+ :type: Bookmarks
+ """
+
+ self._bookmarks = bookmarks
+
+ 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, Bookmark):
+ 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/bookmark_response.py b/asposepdfcloud/models/bookmark_response.py
new file mode 100644
index 0000000..cfbcb66
--- /dev/null
+++ b/asposepdfcloud/models/bookmark_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: 3.0
+
+"""
+
+
+from pprint import pformat
+from six import iteritems
+import re
+
+
+class BookmarkResponse(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',
+ 'bookmark': 'Bookmark'
+ }
+
+ attribute_map = {
+ 'code': 'Code',
+ 'status': 'Status',
+ 'bookmark': 'Bookmark'
+ }
+
+ def __init__(self, code=None, status=None, bookmark=None):
+ """
+ BookmarkResponse - a model defined in Swagger
+ """
+
+ self._code = None
+ self._status = None
+ self._bookmark = None
+
+ self.code = code
+ if status is not None:
+ self.status = status
+ if bookmark is not None:
+ self.bookmark = bookmark
+
+ @property
+ def code(self):
+ """
+ Gets the code of this BookmarkResponse.
+ Response status code.
+
+ :return: The code of this BookmarkResponse.
+ :rtype: int
+ """
+ return self._code
+
+ @code.setter
+ def code(self, code):
+ """
+ Sets the code of this BookmarkResponse.
+ Response status code.
+
+ :param code: The code of this BookmarkResponse.
+ :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 BookmarkResponse.
+ Response status.
+
+ :return: The status of this BookmarkResponse.
+ :rtype: str
+ """
+ return self._status
+
+ @status.setter
+ def status(self, status):
+ """
+ Sets the status of this BookmarkResponse.
+ Response status.
+
+ :param status: The status of this BookmarkResponse.
+ :type: str
+ """
+
+ self._status = status
+
+ @property
+ def bookmark(self):
+ """
+ Gets the bookmark of this BookmarkResponse.
+ Bookmark object
+
+ :return: The bookmark of this BookmarkResponse.
+ :rtype: Bookmark
+ """
+ return self._bookmark
+
+ @bookmark.setter
+ def bookmark(self, bookmark):
+ """
+ Sets the bookmark of this BookmarkResponse.
+ Bookmark object
+
+ :param bookmark: The bookmark of this BookmarkResponse.
+ :type: Bookmark
+ """
+
+ self._bookmark = bookmark
+
+ 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, BookmarkResponse):
+ 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/bookmarks.py b/asposepdfcloud/models/bookmarks.py
new file mode 100644
index 0000000..c10382f
--- /dev/null
+++ b/asposepdfcloud/models/bookmarks.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: 3.0
+
+"""
+
+
+from pprint import pformat
+from six import iteritems
+import re
+
+
+class Bookmarks(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[Bookmark]'
+ }
+
+ attribute_map = {
+ 'links': 'Links',
+ 'list': 'List'
+ }
+
+ def __init__(self, links=None, list=None):
+ """
+ Bookmarks - 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 Bookmarks.
+ Link to the document.
+
+ :return: The links of this Bookmarks.
+ :rtype: list[Link]
+ """
+ return self._links
+
+ @links.setter
+ def links(self, links):
+ """
+ Sets the links of this Bookmarks.
+ Link to the document.
+
+ :param links: The links of this Bookmarks.
+ :type: list[Link]
+ """
+
+ self._links = links
+
+ @property
+ def list(self):
+ """
+ Gets the list of this Bookmarks.
+ List of bookmarks.
+
+ :return: The list of this Bookmarks.
+ :rtype: list[Bookmark]
+ """
+ return self._list
+
+ @list.setter
+ def list(self, list):
+ """
+ Sets the list of this Bookmarks.
+ List of bookmarks.
+
+ :param list: The list of this Bookmarks.
+ :type: list[Bookmark]
+ """
+
+ 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, Bookmarks):
+ 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/bookmarks_response.py b/asposepdfcloud/models/bookmarks_response.py
new file mode 100644
index 0000000..2b0c68d
--- /dev/null
+++ b/asposepdfcloud/models/bookmarks_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: 3.0
+
+"""
+
+
+from pprint import pformat
+from six import iteritems
+import re
+
+
+class BookmarksResponse(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',
+ 'bookmarks': 'Bookmarks'
+ }
+
+ attribute_map = {
+ 'code': 'Code',
+ 'status': 'Status',
+ 'bookmarks': 'Bookmarks'
+ }
+
+ def __init__(self, code=None, status=None, bookmarks=None):
+ """
+ BookmarksResponse - a model defined in Swagger
+ """
+
+ self._code = None
+ self._status = None
+ self._bookmarks = None
+
+ self.code = code
+ if status is not None:
+ self.status = status
+ if bookmarks is not None:
+ self.bookmarks = bookmarks
+
+ @property
+ def code(self):
+ """
+ Gets the code of this BookmarksResponse.
+ Response status code.
+
+ :return: The code of this BookmarksResponse.
+ :rtype: int
+ """
+ return self._code
+
+ @code.setter
+ def code(self, code):
+ """
+ Sets the code of this BookmarksResponse.
+ Response status code.
+
+ :param code: The code of this BookmarksResponse.
+ :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 BookmarksResponse.
+ Response status.
+
+ :return: The status of this BookmarksResponse.
+ :rtype: str
+ """
+ return self._status
+
+ @status.setter
+ def status(self, status):
+ """
+ Sets the status of this BookmarksResponse.
+ Response status.
+
+ :param status: The status of this BookmarksResponse.
+ :type: str
+ """
+
+ self._status = status
+
+ @property
+ def bookmarks(self):
+ """
+ Gets the bookmarks of this BookmarksResponse.
+ Bookmarks object
+
+ :return: The bookmarks of this BookmarksResponse.
+ :rtype: Bookmarks
+ """
+ return self._bookmarks
+
+ @bookmarks.setter
+ def bookmarks(self, bookmarks):
+ """
+ Sets the bookmarks of this BookmarksResponse.
+ Bookmarks object
+
+ :param bookmarks: The bookmarks of this BookmarksResponse.
+ :type: Bookmarks
+ """
+
+ self._bookmarks = bookmarks
+
+ 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, BookmarksResponse):
+ 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/border_corner_style.py b/asposepdfcloud/models/border_corner_style.py
index 22c0b5b..042b91e 100644
--- a/asposepdfcloud/models/border_corner_style.py
+++ b/asposepdfcloud/models/border_corner_style.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/border_info.py b/asposepdfcloud/models/border_info.py
index f45128a..8428e22 100644
--- a/asposepdfcloud/models/border_info.py
+++ b/asposepdfcloud/models/border_info.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/cap_style.py b/asposepdfcloud/models/cap_style.py
index 3b6ac78..ab54c54 100644
--- a/asposepdfcloud/models/cap_style.py
+++ b/asposepdfcloud/models/cap_style.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/caption_position.py b/asposepdfcloud/models/caption_position.py
index c73f4eb..c58ccc3 100644
--- a/asposepdfcloud/models/caption_position.py
+++ b/asposepdfcloud/models/caption_position.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/caret_annotation.py b/asposepdfcloud/models/caret_annotation.py
index 47757e8..ae2290b 100644
--- a/asposepdfcloud/models/caret_annotation.py
+++ b/asposepdfcloud/models/caret_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -127,8 +127,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -331,6 +330,8 @@ def rect(self, rect):
:param rect: The rect of this CaretAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/caret_annotation_response.py b/asposepdfcloud/models/caret_annotation_response.py
index 1ef611a..e355040 100644
--- a/asposepdfcloud/models/caret_annotation_response.py
+++ b/asposepdfcloud/models/caret_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/caret_annotations.py b/asposepdfcloud/models/caret_annotations.py
index f5c7ef6..d8ad128 100644
--- a/asposepdfcloud/models/caret_annotations.py
+++ b/asposepdfcloud/models/caret_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/caret_annotations_response.py b/asposepdfcloud/models/caret_annotations_response.py
index 4c6cede..9e7844e 100644
--- a/asposepdfcloud/models/caret_annotations_response.py
+++ b/asposepdfcloud/models/caret_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/caret_symbol.py b/asposepdfcloud/models/caret_symbol.py
index fa5191e..23541d6 100644
--- a/asposepdfcloud/models/caret_symbol.py
+++ b/asposepdfcloud/models/caret_symbol.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/cell.py b/asposepdfcloud/models/cell.py
index f5399cc..ac70009 100644
--- a/asposepdfcloud/models/cell.py
+++ b/asposepdfcloud/models/cell.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/cell_recognized.py b/asposepdfcloud/models/cell_recognized.py
index 8c9494a..825c072 100644
--- a/asposepdfcloud/models/cell_recognized.py
+++ b/asposepdfcloud/models/cell_recognized.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -74,7 +74,7 @@ def __init__(self, text_rects=None, rectangle=None):
def text_rects(self):
"""
Gets the text_rects of this CellRecognized.
- Gets collection of objects that describes text containing in the cell
+ Gets collection of TextRect objects that describes text containing in the cell
:return: The text_rects of this CellRecognized.
:rtype: TextRects
@@ -85,7 +85,7 @@ def text_rects(self):
def text_rects(self, text_rects):
"""
Sets the text_rects of this CellRecognized.
- Gets collection of objects that describes text containing in the cell
+ Gets collection of TextRect objects that describes text containing in the cell
:param text_rects: The text_rects of this CellRecognized.
:type: TextRects
diff --git a/asposepdfcloud/models/circle_annotation.py b/asposepdfcloud/models/circle_annotation.py
index 9de3e23..ed29456 100644
--- a/asposepdfcloud/models/circle_annotation.py
+++ b/asposepdfcloud/models/circle_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -127,8 +127,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -331,6 +330,8 @@ def rect(self, rect):
:param rect: The rect of this CircleAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/circle_annotation_response.py b/asposepdfcloud/models/circle_annotation_response.py
index 576f4c2..9e8461e 100644
--- a/asposepdfcloud/models/circle_annotation_response.py
+++ b/asposepdfcloud/models/circle_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/circle_annotations.py b/asposepdfcloud/models/circle_annotations.py
index 4414e3f..b3b2cd7 100644
--- a/asposepdfcloud/models/circle_annotations.py
+++ b/asposepdfcloud/models/circle_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/circle_annotations_response.py b/asposepdfcloud/models/circle_annotations_response.py
index deaeefb..8172fed 100644
--- a/asposepdfcloud/models/circle_annotations_response.py
+++ b/asposepdfcloud/models/circle_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/color.py b/asposepdfcloud/models/color.py
index 2bfd539..545ddb8 100644
--- a/asposepdfcloud/models/color.py
+++ b/asposepdfcloud/models/color.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/color_depth.py b/asposepdfcloud/models/color_depth.py
index e927b41..921352a 100644
--- a/asposepdfcloud/models/color_depth.py
+++ b/asposepdfcloud/models/color_depth.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/column_adjustment.py b/asposepdfcloud/models/column_adjustment.py
index 6040281..e4470fb 100644
--- a/asposepdfcloud/models/column_adjustment.py
+++ b/asposepdfcloud/models/column_adjustment.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/common_figure_annotation.py b/asposepdfcloud/models/common_figure_annotation.py
index fc705a1..6011fc5 100644
--- a/asposepdfcloud/models/common_figure_annotation.py
+++ b/asposepdfcloud/models/common_figure_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -127,8 +127,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -331,6 +330,8 @@ def rect(self, rect):
:param rect: The rect of this CommonFigureAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/compression_type.py b/asposepdfcloud/models/compression_type.py
index c776c71..e891b76 100644
--- a/asposepdfcloud/models/compression_type.py
+++ b/asposepdfcloud/models/compression_type.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/crypto_algorithm.py b/asposepdfcloud/models/crypto_algorithm.py
index f12f940..a686efa 100644
--- a/asposepdfcloud/models/crypto_algorithm.py
+++ b/asposepdfcloud/models/crypto_algorithm.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/disc_usage.py b/asposepdfcloud/models/disc_usage.py
index cd0172e..c446057 100644
--- a/asposepdfcloud/models/disc_usage.py
+++ b/asposepdfcloud/models/disc_usage.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -72,6 +72,7 @@ def __init__(self, used_size=None, total_size=None):
def used_size(self):
"""
Gets the used_size of this DiscUsage.
+ Application used disc space.
:return: The used_size of this DiscUsage.
:rtype: int
@@ -82,6 +83,7 @@ def used_size(self):
def used_size(self, used_size):
"""
Sets the used_size of this DiscUsage.
+ Application used disc space.
:param used_size: The used_size of this DiscUsage.
:type: int
@@ -95,6 +97,7 @@ def used_size(self, used_size):
def total_size(self):
"""
Gets the total_size of this DiscUsage.
+ Total disc space.
:return: The total_size of this DiscUsage.
:rtype: int
@@ -105,6 +108,7 @@ def total_size(self):
def total_size(self, total_size):
"""
Sets the total_size of this DiscUsage.
+ Total disc space.
:param total_size: The total_size of this DiscUsage.
:type: int
diff --git a/asposepdfcloud/models/doc_format.py b/asposepdfcloud/models/doc_format.py
index 2819f4f..3055a12 100644
--- a/asposepdfcloud/models/doc_format.py
+++ b/asposepdfcloud/models/doc_format.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/doc_recognition_mode.py b/asposepdfcloud/models/doc_recognition_mode.py
index 214a59b..e295a21 100644
--- a/asposepdfcloud/models/doc_recognition_mode.py
+++ b/asposepdfcloud/models/doc_recognition_mode.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/document.py b/asposepdfcloud/models/document.py
index 49529dc..ee67d37 100644
--- a/asposepdfcloud/models/document.py
+++ b/asposepdfcloud/models/document.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/document_page_response.py b/asposepdfcloud/models/document_page_response.py
index cb70970..997e045 100644
--- a/asposepdfcloud/models/document_page_response.py
+++ b/asposepdfcloud/models/document_page_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/document_pages_response.py b/asposepdfcloud/models/document_pages_response.py
index 909d49e..35856bf 100644
--- a/asposepdfcloud/models/document_pages_response.py
+++ b/asposepdfcloud/models/document_pages_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/document_privilege.py b/asposepdfcloud/models/document_privilege.py
index b8ee2b3..0e81ea7 100644
--- a/asposepdfcloud/models/document_privilege.py
+++ b/asposepdfcloud/models/document_privilege.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/document_properties.py b/asposepdfcloud/models/document_properties.py
index a4f5314..af1e80c 100644
--- a/asposepdfcloud/models/document_properties.py
+++ b/asposepdfcloud/models/document_properties.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/document_properties_response.py b/asposepdfcloud/models/document_properties_response.py
index f0f1495..eaf431b 100644
--- a/asposepdfcloud/models/document_properties_response.py
+++ b/asposepdfcloud/models/document_properties_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/document_property.py b/asposepdfcloud/models/document_property.py
index bf21e1e..8734167 100644
--- a/asposepdfcloud/models/document_property.py
+++ b/asposepdfcloud/models/document_property.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -77,8 +77,7 @@ def __init__(self, links=None, name=None, value=None, built_in=None):
self.name = name
if value is not None:
self.value = value
- if built_in is not None:
- self.built_in = built_in
+ self.built_in = built_in
@property
def links(self):
@@ -169,6 +168,8 @@ def built_in(self, built_in):
:param built_in: The built_in of this DocumentProperty.
:type: bool
"""
+ if built_in is None:
+ raise ValueError("Invalid value for `built_in`, must not be `None`")
self._built_in = built_in
diff --git a/asposepdfcloud/models/document_property_response.py b/asposepdfcloud/models/document_property_response.py
index 86ffd25..43ed81c 100644
--- a/asposepdfcloud/models/document_property_response.py
+++ b/asposepdfcloud/models/document_property_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/document_response.py b/asposepdfcloud/models/document_response.py
index 6281ad9..59fccc5 100644
--- a/asposepdfcloud/models/document_response.py
+++ b/asposepdfcloud/models/document_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/epub_recognition_mode.py b/asposepdfcloud/models/epub_recognition_mode.py
index 4f128e6..d029c3e 100644
--- a/asposepdfcloud/models/epub_recognition_mode.py
+++ b/asposepdfcloud/models/epub_recognition_mode.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/error.py b/asposepdfcloud/models/error.py
new file mode 100644
index 0000000..60756f6
--- /dev/null
+++ b/asposepdfcloud/models/error.py
@@ -0,0 +1,226 @@
+# 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: 3.0
+
+"""
+
+
+from pprint import pformat
+from six import iteritems
+import re
+
+
+class Error(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': 'str',
+ 'message': 'str',
+ 'description': 'str',
+ 'inner_error': 'ErrorDetails'
+ }
+
+ attribute_map = {
+ 'code': 'Code',
+ 'message': 'Message',
+ 'description': 'Description',
+ 'inner_error': 'InnerError'
+ }
+
+ def __init__(self, code=None, message=None, description=None, inner_error=None):
+ """
+ Error - a model defined in Swagger
+ """
+
+ self._code = None
+ self._message = None
+ self._description = None
+ self._inner_error = None
+
+ if code is not None:
+ self.code = code
+ if message is not None:
+ self.message = message
+ if description is not None:
+ self.description = description
+ if inner_error is not None:
+ self.inner_error = inner_error
+
+ @property
+ def code(self):
+ """
+ Gets the code of this Error.
+ Code
+
+ :return: The code of this Error.
+ :rtype: str
+ """
+ return self._code
+
+ @code.setter
+ def code(self, code):
+ """
+ Sets the code of this Error.
+ Code
+
+ :param code: The code of this Error.
+ :type: str
+ """
+
+ self._code = code
+
+ @property
+ def message(self):
+ """
+ Gets the message of this Error.
+ Message
+
+ :return: The message of this Error.
+ :rtype: str
+ """
+ return self._message
+
+ @message.setter
+ def message(self, message):
+ """
+ Sets the message of this Error.
+ Message
+
+ :param message: The message of this Error.
+ :type: str
+ """
+
+ self._message = message
+
+ @property
+ def description(self):
+ """
+ Gets the description of this Error.
+ Description
+
+ :return: The description of this Error.
+ :rtype: str
+ """
+ return self._description
+
+ @description.setter
+ def description(self, description):
+ """
+ Sets the description of this Error.
+ Description
+
+ :param description: The description of this Error.
+ :type: str
+ """
+
+ self._description = description
+
+ @property
+ def inner_error(self):
+ """
+ Gets the inner_error of this Error.
+ Inner Error
+
+ :return: The inner_error of this Error.
+ :rtype: ErrorDetails
+ """
+ return self._inner_error
+
+ @inner_error.setter
+ def inner_error(self, inner_error):
+ """
+ Sets the inner_error of this Error.
+ Inner Error
+
+ :param inner_error: The inner_error of this Error.
+ :type: ErrorDetails
+ """
+
+ self._inner_error = inner_error
+
+ 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, Error):
+ 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/error_details.py b/asposepdfcloud/models/error_details.py
new file mode 100644
index 0000000..c59e14e
--- /dev/null
+++ b/asposepdfcloud/models/error_details.py
@@ -0,0 +1,171 @@
+# 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: 3.0
+
+"""
+
+
+from pprint import pformat
+from six import iteritems
+import re
+
+
+class ErrorDetails(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 = {
+ 'request_id': 'str',
+ 'date': 'datetime'
+ }
+
+ attribute_map = {
+ 'request_id': 'RequestId',
+ 'date': 'Date'
+ }
+
+ def __init__(self, request_id=None, date=None):
+ """
+ ErrorDetails - a model defined in Swagger
+ """
+
+ self._request_id = None
+ self._date = None
+
+ if request_id is not None:
+ self.request_id = request_id
+ self.date = date
+
+ @property
+ def request_id(self):
+ """
+ Gets the request_id of this ErrorDetails.
+ The request id
+
+ :return: The request_id of this ErrorDetails.
+ :rtype: str
+ """
+ return self._request_id
+
+ @request_id.setter
+ def request_id(self, request_id):
+ """
+ Sets the request_id of this ErrorDetails.
+ The request id
+
+ :param request_id: The request_id of this ErrorDetails.
+ :type: str
+ """
+
+ self._request_id = request_id
+
+ @property
+ def date(self):
+ """
+ Gets the date of this ErrorDetails.
+ Date
+
+ :return: The date of this ErrorDetails.
+ :rtype: datetime
+ """
+ return self._date
+
+ @date.setter
+ def date(self, date):
+ """
+ Sets the date of this ErrorDetails.
+ Date
+
+ :param date: The date of this ErrorDetails.
+ :type: datetime
+ """
+ if date is None:
+ raise ValueError("Invalid value for `date`, must not be `None`")
+
+ self._date = date
+
+ 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, ErrorDetails):
+ 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/field.py b/asposepdfcloud/models/field.py
index 474033a..95d1ec6 100644
--- a/asposepdfcloud/models/field.py
+++ b/asposepdfcloud/models/field.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -87,8 +87,7 @@ def __init__(self, links=None, name=None, selected_items=None, type=None, rect=N
self.type = type
if rect is not None:
self.rect = rect
- if values is not None:
- self.values = values
+ self.values = values
@property
def links(self):
@@ -225,6 +224,8 @@ def values(self, values):
:param values: The values of this Field.
:type: list[str]
"""
+ if values is None:
+ raise ValueError("Invalid value for `values`, must not be `None`")
self._values = values
diff --git a/asposepdfcloud/models/field_response.py b/asposepdfcloud/models/field_response.py
index 8756487..2616200 100644
--- a/asposepdfcloud/models/field_response.py
+++ b/asposepdfcloud/models/field_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/field_type.py b/asposepdfcloud/models/field_type.py
index 851c474..8bdf319 100644
--- a/asposepdfcloud/models/field_type.py
+++ b/asposepdfcloud/models/field_type.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/fields.py b/asposepdfcloud/models/fields.py
index 0eab389..53efa8d 100644
--- a/asposepdfcloud/models/fields.py
+++ b/asposepdfcloud/models/fields.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -67,8 +67,7 @@ def __init__(self, links=None, list=None):
if links is not None:
self.links = links
- if list is not None:
- self.list = list
+ self.list = list
@property
def links(self):
@@ -113,6 +112,8 @@ def list(self, list):
:param list: The list of this Fields.
:type: list[Field]
"""
+ if list is None:
+ raise ValueError("Invalid value for `list`, must not be `None`")
self._list = list
diff --git a/asposepdfcloud/models/fields_response.py b/asposepdfcloud/models/fields_response.py
index 759cac7..9555027 100644
--- a/asposepdfcloud/models/fields_response.py
+++ b/asposepdfcloud/models/fields_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/file_attachment_annotation.py b/asposepdfcloud/models/file_attachment_annotation.py
index 177efcc..cf08dea 100644
--- a/asposepdfcloud/models/file_attachment_annotation.py
+++ b/asposepdfcloud/models/file_attachment_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -136,8 +136,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -346,6 +345,8 @@ def rect(self, rect):
:param rect: The rect of this FileAttachmentAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/file_attachment_annotation_response.py b/asposepdfcloud/models/file_attachment_annotation_response.py
index 25a306c..d9943c8 100644
--- a/asposepdfcloud/models/file_attachment_annotation_response.py
+++ b/asposepdfcloud/models/file_attachment_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/file_attachment_annotations.py b/asposepdfcloud/models/file_attachment_annotations.py
index a57d2d8..498e8e7 100644
--- a/asposepdfcloud/models/file_attachment_annotations.py
+++ b/asposepdfcloud/models/file_attachment_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/file_attachment_annotations_response.py b/asposepdfcloud/models/file_attachment_annotations_response.py
index 201a56a..40f9342 100644
--- a/asposepdfcloud/models/file_attachment_annotations_response.py
+++ b/asposepdfcloud/models/file_attachment_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/file_icon.py b/asposepdfcloud/models/file_icon.py
index 139b6e9..d3a32ef 100644
--- a/asposepdfcloud/models/file_icon.py
+++ b/asposepdfcloud/models/file_icon.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/file_version.py b/asposepdfcloud/models/file_version.py
index ff23a10..f886bd8 100644
--- a/asposepdfcloud/models/file_version.py
+++ b/asposepdfcloud/models/file_version.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -90,13 +90,13 @@ def __init__(self, name=None, is_folder=None, modified_date=None, size=None, pat
self.path = path
if version_id is not None:
self.version_id = version_id
- if is_latest is not None:
- self.is_latest = is_latest
+ self.is_latest = is_latest
@property
def name(self):
"""
Gets the name of this FileVersion.
+ File or folder name.
:return: The name of this FileVersion.
:rtype: str
@@ -107,6 +107,7 @@ def name(self):
def name(self, name):
"""
Sets the name of this FileVersion.
+ File or folder name.
:param name: The name of this FileVersion.
:type: str
@@ -118,6 +119,7 @@ def name(self, name):
def is_folder(self):
"""
Gets the is_folder of this FileVersion.
+ True if it is a folder.
:return: The is_folder of this FileVersion.
:rtype: bool
@@ -128,6 +130,7 @@ def is_folder(self):
def is_folder(self, is_folder):
"""
Sets the is_folder of this FileVersion.
+ True if it is a folder.
:param is_folder: The is_folder of this FileVersion.
:type: bool
@@ -141,6 +144,7 @@ def is_folder(self, is_folder):
def modified_date(self):
"""
Gets the modified_date of this FileVersion.
+ File or folder last modified DateTime.
:return: The modified_date of this FileVersion.
:rtype: datetime
@@ -151,6 +155,7 @@ def modified_date(self):
def modified_date(self, modified_date):
"""
Sets the modified_date of this FileVersion.
+ File or folder last modified DateTime.
:param modified_date: The modified_date of this FileVersion.
:type: datetime
@@ -162,6 +167,7 @@ def modified_date(self, modified_date):
def size(self):
"""
Gets the size of this FileVersion.
+ File or folder size.
:return: The size of this FileVersion.
:rtype: int
@@ -172,6 +178,7 @@ def size(self):
def size(self, size):
"""
Sets the size of this FileVersion.
+ File or folder size.
:param size: The size of this FileVersion.
:type: int
@@ -185,6 +192,7 @@ def size(self, size):
def path(self):
"""
Gets the path of this FileVersion.
+ File or folder path.
:return: The path of this FileVersion.
:rtype: str
@@ -195,6 +203,7 @@ def path(self):
def path(self, path):
"""
Sets the path of this FileVersion.
+ File or folder path.
:param path: The path of this FileVersion.
:type: str
@@ -206,6 +215,7 @@ def path(self, path):
def version_id(self):
"""
Gets the version_id of this FileVersion.
+ File Version ID.
:return: The version_id of this FileVersion.
:rtype: str
@@ -216,6 +226,7 @@ def version_id(self):
def version_id(self, version_id):
"""
Sets the version_id of this FileVersion.
+ File Version ID.
:param version_id: The version_id of this FileVersion.
:type: str
@@ -227,6 +238,7 @@ def version_id(self, version_id):
def is_latest(self):
"""
Gets the is_latest of this FileVersion.
+ Specifies whether the file is (true) or is not (false) the latest version of an file.
:return: The is_latest of this FileVersion.
:rtype: bool
@@ -237,10 +249,13 @@ def is_latest(self):
def is_latest(self, is_latest):
"""
Sets the is_latest of this FileVersion.
+ Specifies whether the file is (true) or is not (false) the latest version of an file.
:param is_latest: The is_latest of this FileVersion.
:type: bool
"""
+ if is_latest is None:
+ raise ValueError("Invalid value for `is_latest`, must not be `None`")
self._is_latest = is_latest
diff --git a/asposepdfcloud/models/file_versions.py b/asposepdfcloud/models/file_versions.py
new file mode 100644
index 0000000..f95e7e7
--- /dev/null
+++ b/asposepdfcloud/models/file_versions.py
@@ -0,0 +1,142 @@
+# 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: 3.0
+
+"""
+
+
+from pprint import pformat
+from six import iteritems
+import re
+
+
+class FileVersions(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 = {
+ 'value': 'list[FileVersion]'
+ }
+
+ attribute_map = {
+ 'value': 'Value'
+ }
+
+ def __init__(self, value=None):
+ """
+ FileVersions - a model defined in Swagger
+ """
+
+ self._value = None
+
+ if value is not None:
+ self.value = value
+
+ @property
+ def value(self):
+ """
+ Gets the value of this FileVersions.
+ File versions FileVersion.
+
+ :return: The value of this FileVersions.
+ :rtype: list[FileVersion]
+ """
+ return self._value
+
+ @value.setter
+ def value(self, value):
+ """
+ Sets the value of this FileVersions.
+ File versions FileVersion.
+
+ :param value: The value of this FileVersions.
+ :type: list[FileVersion]
+ """
+
+ self._value = value
+
+ 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, FileVersions):
+ return False
+
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
diff --git a/asposepdfcloud/models/files_list.py b/asposepdfcloud/models/files_list.py
new file mode 100644
index 0000000..2f053b4
--- /dev/null
+++ b/asposepdfcloud/models/files_list.py
@@ -0,0 +1,142 @@
+# 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: 3.0
+
+"""
+
+
+from pprint import pformat
+from six import iteritems
+import re
+
+
+class FilesList(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 = {
+ 'value': 'list[StorageFile]'
+ }
+
+ attribute_map = {
+ 'value': 'Value'
+ }
+
+ def __init__(self, value=None):
+ """
+ FilesList - a model defined in Swagger
+ """
+
+ self._value = None
+
+ if value is not None:
+ self.value = value
+
+ @property
+ def value(self):
+ """
+ Gets the value of this FilesList.
+ Files and folders contained by folder StorageFile.
+
+ :return: The value of this FilesList.
+ :rtype: list[StorageFile]
+ """
+ return self._value
+
+ @value.setter
+ def value(self, value):
+ """
+ Sets the value of this FilesList.
+ Files and folders contained by folder StorageFile.
+
+ :param value: The value of this FilesList.
+ :type: list[StorageFile]
+ """
+
+ self._value = value
+
+ 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, FilesList):
+ return False
+
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
diff --git a/asposepdfcloud/models/files_upload_result.py b/asposepdfcloud/models/files_upload_result.py
new file mode 100644
index 0000000..a6a37f6
--- /dev/null
+++ b/asposepdfcloud/models/files_upload_result.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: 3.0
+
+"""
+
+
+from pprint import pformat
+from six import iteritems
+import re
+
+
+class FilesUploadResult(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 = {
+ 'uploaded': 'list[str]',
+ 'errors': 'list[Error]'
+ }
+
+ attribute_map = {
+ 'uploaded': 'Uploaded',
+ 'errors': 'Errors'
+ }
+
+ def __init__(self, uploaded=None, errors=None):
+ """
+ FilesUploadResult - a model defined in Swagger
+ """
+
+ self._uploaded = None
+ self._errors = None
+
+ if uploaded is not None:
+ self.uploaded = uploaded
+ if errors is not None:
+ self.errors = errors
+
+ @property
+ def uploaded(self):
+ """
+ Gets the uploaded of this FilesUploadResult.
+ List of uploaded file names
+
+ :return: The uploaded of this FilesUploadResult.
+ :rtype: list[str]
+ """
+ return self._uploaded
+
+ @uploaded.setter
+ def uploaded(self, uploaded):
+ """
+ Sets the uploaded of this FilesUploadResult.
+ List of uploaded file names
+
+ :param uploaded: The uploaded of this FilesUploadResult.
+ :type: list[str]
+ """
+
+ self._uploaded = uploaded
+
+ @property
+ def errors(self):
+ """
+ Gets the errors of this FilesUploadResult.
+ List of errors.
+
+ :return: The errors of this FilesUploadResult.
+ :rtype: list[Error]
+ """
+ return self._errors
+
+ @errors.setter
+ def errors(self, errors):
+ """
+ Sets the errors of this FilesUploadResult.
+ List of errors.
+
+ :param errors: The errors of this FilesUploadResult.
+ :type: list[Error]
+ """
+
+ self._errors = errors
+
+ 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, FilesUploadResult):
+ 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/font_encoding_rules.py b/asposepdfcloud/models/font_encoding_rules.py
index e25c81f..96c2984 100644
--- a/asposepdfcloud/models/font_encoding_rules.py
+++ b/asposepdfcloud/models/font_encoding_rules.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/font_saving_modes.py b/asposepdfcloud/models/font_saving_modes.py
index 106fa0d..18bf56b 100644
--- a/asposepdfcloud/models/font_saving_modes.py
+++ b/asposepdfcloud/models/font_saving_modes.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/font_styles.py b/asposepdfcloud/models/font_styles.py
index 1f388b2..f400d30 100644
--- a/asposepdfcloud/models/font_styles.py
+++ b/asposepdfcloud/models/font_styles.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/free_text_annotation.py b/asposepdfcloud/models/free_text_annotation.py
index 7c4313e..c250d74 100644
--- a/asposepdfcloud/models/free_text_annotation.py
+++ b/asposepdfcloud/models/free_text_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -133,8 +133,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -157,8 +156,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.intent = intent
if rotate is not None:
self.rotate = rotate
- if text_style is not None:
- self.text_style = text_style
+ self.text_style = text_style
@property
def links(self):
@@ -341,6 +339,8 @@ def rect(self, rect):
:param rect: The rect of this FreeTextAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
@@ -617,6 +617,8 @@ def text_style(self, text_style):
:param text_style: The text_style of this FreeTextAnnotation.
:type: TextStyle
"""
+ if text_style is None:
+ raise ValueError("Invalid value for `text_style`, must not be `None`")
self._text_style = text_style
diff --git a/asposepdfcloud/models/free_text_annotation_response.py b/asposepdfcloud/models/free_text_annotation_response.py
index 0ee29d5..938fb5d 100644
--- a/asposepdfcloud/models/free_text_annotation_response.py
+++ b/asposepdfcloud/models/free_text_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/free_text_annotations.py b/asposepdfcloud/models/free_text_annotations.py
index 8357a08..5fc9acb 100644
--- a/asposepdfcloud/models/free_text_annotations.py
+++ b/asposepdfcloud/models/free_text_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/free_text_annotations_response.py b/asposepdfcloud/models/free_text_annotations_response.py
index cfba305..7a5fa4a 100644
--- a/asposepdfcloud/models/free_text_annotations_response.py
+++ b/asposepdfcloud/models/free_text_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/free_text_intent.py b/asposepdfcloud/models/free_text_intent.py
index c667738..3d305e8 100644
--- a/asposepdfcloud/models/free_text_intent.py
+++ b/asposepdfcloud/models/free_text_intent.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/graph_info.py b/asposepdfcloud/models/graph_info.py
index fa9ecdc..e131f6f 100644
--- a/asposepdfcloud/models/graph_info.py
+++ b/asposepdfcloud/models/graph_info.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -142,7 +142,7 @@ def line_width(self, line_width):
def color(self):
"""
Gets the color of this GraphInfo.
- Gets or sets a object that indicates the color of the graph.
+ Gets or sets a Color object that indicates the color of the graph.
:return: The color of this GraphInfo.
:rtype: Color
@@ -153,7 +153,7 @@ def color(self):
def color(self, color):
"""
Sets the color of this GraphInfo.
- Gets or sets a object that indicates the color of the graph.
+ Gets or sets a Color object that indicates the color of the graph.
:param color: The color of this GraphInfo.
:type: Color
@@ -211,7 +211,7 @@ def dash_phase(self, dash_phase):
def fill_color(self):
"""
Gets the fill_color of this GraphInfo.
- Gets or sets a object that indicates the fill color of the graph.
+ Gets or sets a Color object that indicates the fill color of the graph.
:return: The fill_color of this GraphInfo.
:rtype: Color
@@ -222,7 +222,7 @@ def fill_color(self):
def fill_color(self, fill_color):
"""
Sets the fill_color of this GraphInfo.
- Gets or sets a object that indicates the fill color of the graph.
+ Gets or sets a Color object that indicates the fill color of the graph.
:param fill_color: The fill_color of this GraphInfo.
:type: Color
diff --git a/asposepdfcloud/models/highlight_annotation.py b/asposepdfcloud/models/highlight_annotation.py
index 37d8e6f..c0b2601 100644
--- a/asposepdfcloud/models/highlight_annotation.py
+++ b/asposepdfcloud/models/highlight_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -124,8 +124,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -326,6 +325,8 @@ def rect(self, rect):
:param rect: The rect of this HighlightAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/highlight_annotation_response.py b/asposepdfcloud/models/highlight_annotation_response.py
index 106da65..6ca6f57 100644
--- a/asposepdfcloud/models/highlight_annotation_response.py
+++ b/asposepdfcloud/models/highlight_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/highlight_annotations.py b/asposepdfcloud/models/highlight_annotations.py
index 2c040d0..0a50313 100644
--- a/asposepdfcloud/models/highlight_annotations.py
+++ b/asposepdfcloud/models/highlight_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/highlight_annotations_response.py b/asposepdfcloud/models/highlight_annotations_response.py
index fb4890b..f6c6d3d 100644
--- a/asposepdfcloud/models/highlight_annotations_response.py
+++ b/asposepdfcloud/models/highlight_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/horizontal_alignment.py b/asposepdfcloud/models/horizontal_alignment.py
index 79aa0aa..70d6dbc 100644
--- a/asposepdfcloud/models/horizontal_alignment.py
+++ b/asposepdfcloud/models/horizontal_alignment.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/html_document_type.py b/asposepdfcloud/models/html_document_type.py
index b4c949a..3107254 100644
--- a/asposepdfcloud/models/html_document_type.py
+++ b/asposepdfcloud/models/html_document_type.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/html_markup_generation_modes.py b/asposepdfcloud/models/html_markup_generation_modes.py
index 50b0201..ed8baa5 100644
--- a/asposepdfcloud/models/html_markup_generation_modes.py
+++ b/asposepdfcloud/models/html_markup_generation_modes.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/image.py b/asposepdfcloud/models/image.py
index 6f4f96b..03f9bf1 100644
--- a/asposepdfcloud/models/image.py
+++ b/asposepdfcloud/models/image.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -79,16 +79,13 @@ def __init__(self, links=None, width=None, height=None, id=None, rectangle=None,
if links is not None:
self.links = links
- if width is not None:
- self.width = width
- if height is not None:
- self.height = height
+ self.width = width
+ self.height = height
if id is not None:
self.id = id
if rectangle is not None:
self.rectangle = rectangle
- if page_number is not None:
- self.page_number = page_number
+ self.page_number = page_number
@property
def links(self):
@@ -133,6 +130,8 @@ def width(self, width):
:param width: The width of this Image.
:type: int
"""
+ if width is None:
+ raise ValueError("Invalid value for `width`, must not be `None`")
self._width = width
@@ -156,6 +155,8 @@ def height(self, height):
:param height: The height of this Image.
:type: int
"""
+ if height is None:
+ raise ValueError("Invalid value for `height`, must not be `None`")
self._height = height
@@ -225,6 +226,8 @@ def page_number(self, page_number):
:param page_number: The page_number of this Image.
:type: int
"""
+ if page_number is None:
+ raise ValueError("Invalid value for `page_number`, must not be `None`")
self._page_number = page_number
diff --git a/asposepdfcloud/models/image_footer.py b/asposepdfcloud/models/image_footer.py
index 1023677..3dd1197 100644
--- a/asposepdfcloud/models/image_footer.py
+++ b/asposepdfcloud/models/image_footer.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -231,7 +231,7 @@ def opacity(self, opacity):
def rotate(self):
"""
Gets the rotate of this ImageFooter.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:return: The rotate of this ImageFooter.
:rtype: Rotation
@@ -242,7 +242,7 @@ def rotate(self):
def rotate(self, rotate):
"""
Sets the rotate of this ImageFooter.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:param rotate: The rotate of this ImageFooter.
:type: Rotation
diff --git a/asposepdfcloud/models/image_header.py b/asposepdfcloud/models/image_header.py
index 1045ec7..3d635a4 100644
--- a/asposepdfcloud/models/image_header.py
+++ b/asposepdfcloud/models/image_header.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -231,7 +231,7 @@ def opacity(self, opacity):
def rotate(self):
"""
Gets the rotate of this ImageHeader.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:return: The rotate of this ImageHeader.
:rtype: Rotation
@@ -242,7 +242,7 @@ def rotate(self):
def rotate(self, rotate):
"""
Sets the rotate of this ImageHeader.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:param rotate: The rotate of this ImageHeader.
:type: Rotation
diff --git a/asposepdfcloud/models/image_response.py b/asposepdfcloud/models/image_response.py
index 6f556a0..1ab49a1 100644
--- a/asposepdfcloud/models/image_response.py
+++ b/asposepdfcloud/models/image_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/image_src_type.py b/asposepdfcloud/models/image_src_type.py
index 1896c91..427d551 100644
--- a/asposepdfcloud/models/image_src_type.py
+++ b/asposepdfcloud/models/image_src_type.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/image_stamp.py b/asposepdfcloud/models/image_stamp.py
index 157a24b..a1feb6e 100644
--- a/asposepdfcloud/models/image_stamp.py
+++ b/asposepdfcloud/models/image_stamp.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -241,7 +241,7 @@ def opacity(self, opacity):
def rotate(self):
"""
Gets the rotate of this ImageStamp.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:return: The rotate of this ImageStamp.
:rtype: Rotation
@@ -252,7 +252,7 @@ def rotate(self):
def rotate(self, rotate):
"""
Sets the rotate of this ImageStamp.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:param rotate: The rotate of this ImageStamp.
:type: Rotation
diff --git a/asposepdfcloud/models/image_template.py b/asposepdfcloud/models/image_template.py
index 8155d90..866fa82 100644
--- a/asposepdfcloud/models/image_template.py
+++ b/asposepdfcloud/models/image_template.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -125,6 +125,8 @@ def image_path(self, image_path):
"""
if image_path is None:
raise ValueError("Invalid value for `image_path`, must not be `None`")
+ if image_path is not None and len(image_path) < 1:
+ raise ValueError("Invalid value for `image_path`, length must be greater than or equal to `1`")
self._image_path = image_path
diff --git a/asposepdfcloud/models/image_templates_request.py b/asposepdfcloud/models/image_templates_request.py
index 2d3c201..0ccdf47 100644
--- a/asposepdfcloud/models/image_templates_request.py
+++ b/asposepdfcloud/models/image_templates_request.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/images.py b/asposepdfcloud/models/images.py
index af30625..b6fc450 100644
--- a/asposepdfcloud/models/images.py
+++ b/asposepdfcloud/models/images.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/images_response.py b/asposepdfcloud/models/images_response.py
index 0b9acf8..8c0e4f2 100644
--- a/asposepdfcloud/models/images_response.py
+++ b/asposepdfcloud/models/images_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/ink_annotation.py b/asposepdfcloud/models/ink_annotation.py
index 97fa73b..2c06c68 100644
--- a/asposepdfcloud/models/ink_annotation.py
+++ b/asposepdfcloud/models/ink_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -127,8 +127,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -331,6 +330,8 @@ def rect(self, rect):
:param rect: The rect of this InkAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/ink_annotation_response.py b/asposepdfcloud/models/ink_annotation_response.py
index 2cb6623..6aea017 100644
--- a/asposepdfcloud/models/ink_annotation_response.py
+++ b/asposepdfcloud/models/ink_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/ink_annotations.py b/asposepdfcloud/models/ink_annotations.py
index a8015f7..a6f3b9e 100644
--- a/asposepdfcloud/models/ink_annotations.py
+++ b/asposepdfcloud/models/ink_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/ink_annotations_response.py b/asposepdfcloud/models/ink_annotations_response.py
index 12ab1f3..8703013 100644
--- a/asposepdfcloud/models/ink_annotations_response.py
+++ b/asposepdfcloud/models/ink_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/justification.py b/asposepdfcloud/models/justification.py
index d0b1917..edd5413 100644
--- a/asposepdfcloud/models/justification.py
+++ b/asposepdfcloud/models/justification.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/letters_positioning_methods.py b/asposepdfcloud/models/letters_positioning_methods.py
index 5b4f0f1..e8da4d5 100644
--- a/asposepdfcloud/models/letters_positioning_methods.py
+++ b/asposepdfcloud/models/letters_positioning_methods.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/line_annotation.py b/asposepdfcloud/models/line_annotation.py
index 91c2a5e..89a42f7 100644
--- a/asposepdfcloud/models/line_annotation.py
+++ b/asposepdfcloud/models/line_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -157,8 +157,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -175,12 +174,10 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.title = title
if rich_text is not None:
self.rich_text = rich_text
- if starting is not None:
- self.starting = starting
+ self.starting = starting
if starting_style is not None:
self.starting_style = starting_style
- if ending is not None:
- self.ending = ending
+ self.ending = ending
if ending_style is not None:
self.ending_style = ending_style
if interior_color is not None:
@@ -381,6 +378,8 @@ def rect(self, rect):
:param rect: The rect of this LineAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
@@ -588,6 +587,8 @@ def starting(self, starting):
:param starting: The starting of this LineAnnotation.
:type: Point
"""
+ if starting is None:
+ raise ValueError("Invalid value for `starting`, must not be `None`")
self._starting = starting
@@ -634,6 +635,8 @@ def ending(self, ending):
:param ending: The ending of this LineAnnotation.
:type: Point
"""
+ if ending is None:
+ raise ValueError("Invalid value for `ending`, must not be `None`")
self._ending = ending
diff --git a/asposepdfcloud/models/line_annotation_response.py b/asposepdfcloud/models/line_annotation_response.py
index a6caacb..ce477db 100644
--- a/asposepdfcloud/models/line_annotation_response.py
+++ b/asposepdfcloud/models/line_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/line_annotations.py b/asposepdfcloud/models/line_annotations.py
index a3f1dfb..a600b6b 100644
--- a/asposepdfcloud/models/line_annotations.py
+++ b/asposepdfcloud/models/line_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/line_annotations_response.py b/asposepdfcloud/models/line_annotations_response.py
index b1281ca..e01dac0 100644
--- a/asposepdfcloud/models/line_annotations_response.py
+++ b/asposepdfcloud/models/line_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/line_ending.py b/asposepdfcloud/models/line_ending.py
index 7a73f0b..d42e164 100644
--- a/asposepdfcloud/models/line_ending.py
+++ b/asposepdfcloud/models/line_ending.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/line_intent.py b/asposepdfcloud/models/line_intent.py
index 8df9fc0..b65d5b7 100644
--- a/asposepdfcloud/models/line_intent.py
+++ b/asposepdfcloud/models/line_intent.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/line_spacing.py b/asposepdfcloud/models/line_spacing.py
index 25e4001..33c66bd 100644
--- a/asposepdfcloud/models/line_spacing.py
+++ b/asposepdfcloud/models/line_spacing.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/link.py b/asposepdfcloud/models/link.py
index 498e235..8cd4780 100644
--- a/asposepdfcloud/models/link.py
+++ b/asposepdfcloud/models/link.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/link_action_type.py b/asposepdfcloud/models/link_action_type.py
index 408ff36..e6b2db6 100644
--- a/asposepdfcloud/models/link_action_type.py
+++ b/asposepdfcloud/models/link_action_type.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/link_annotation.py b/asposepdfcloud/models/link_annotation.py
index 5158dfa..9fb422b 100644
--- a/asposepdfcloud/models/link_annotation.py
+++ b/asposepdfcloud/models/link_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -82,16 +82,12 @@ def __init__(self, links=None, action_type=None, action=None, highlighting=None,
if links is not None:
self.links = links
- if action_type is not None:
- self.action_type = action_type
- if action is not None:
- self.action = action
- if highlighting is not None:
- self.highlighting = highlighting
+ self.action_type = action_type
+ self.action = action
+ self.highlighting = highlighting
if color is not None:
self.color = color
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if id is not None:
self.id = id
@@ -136,6 +132,8 @@ def action_type(self, action_type):
:param action_type: The action_type of this LinkAnnotation.
:type: LinkActionType
"""
+ if action_type is None:
+ raise ValueError("Invalid value for `action_type`, must not be `None`")
self._action_type = action_type
@@ -157,6 +155,10 @@ def action(self, action):
:param action: The action of this LinkAnnotation.
:type: str
"""
+ if action is None:
+ raise ValueError("Invalid value for `action`, must not be `None`")
+ if action is not None and len(action) < 1:
+ raise ValueError("Invalid value for `action`, length must be greater than or equal to `1`")
self._action = action
@@ -178,6 +180,8 @@ def highlighting(self, highlighting):
:param highlighting: The highlighting of this LinkAnnotation.
:type: LinkHighlightingMode
"""
+ if highlighting is None:
+ raise ValueError("Invalid value for `highlighting`, must not be `None`")
self._highlighting = highlighting
@@ -220,6 +224,8 @@ def rect(self, rect):
:param rect: The rect of this LinkAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/link_annotation_response.py b/asposepdfcloud/models/link_annotation_response.py
index 1eb5803..a75ce40 100644
--- a/asposepdfcloud/models/link_annotation_response.py
+++ b/asposepdfcloud/models/link_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/link_annotations.py b/asposepdfcloud/models/link_annotations.py
index fa7c2da..f95dde8 100644
--- a/asposepdfcloud/models/link_annotations.py
+++ b/asposepdfcloud/models/link_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/link_annotations_response.py b/asposepdfcloud/models/link_annotations_response.py
index 83703e7..bc6292f 100644
--- a/asposepdfcloud/models/link_annotations_response.py
+++ b/asposepdfcloud/models/link_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/link_element.py b/asposepdfcloud/models/link_element.py
index c858df0..067e16a 100644
--- a/asposepdfcloud/models/link_element.py
+++ b/asposepdfcloud/models/link_element.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/link_highlighting_mode.py b/asposepdfcloud/models/link_highlighting_mode.py
index 929d6d7..fe7b326 100644
--- a/asposepdfcloud/models/link_highlighting_mode.py
+++ b/asposepdfcloud/models/link_highlighting_mode.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/margin_info.py b/asposepdfcloud/models/margin_info.py
index 3245d01..6d18e84 100644
--- a/asposepdfcloud/models/margin_info.py
+++ b/asposepdfcloud/models/margin_info.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/markup_annotation.py b/asposepdfcloud/models/markup_annotation.py
index e463065..951da6e 100644
--- a/asposepdfcloud/models/markup_annotation.py
+++ b/asposepdfcloud/models/markup_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -121,8 +121,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -321,6 +320,8 @@ def rect(self, rect):
:param rect: The rect of this MarkupAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/merge_documents.py b/asposepdfcloud/models/merge_documents.py
index c3ecaaf..41331bf 100644
--- a/asposepdfcloud/models/merge_documents.py
+++ b/asposepdfcloud/models/merge_documents.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/movie_annotation.py b/asposepdfcloud/models/movie_annotation.py
index 15bbf06..3012718 100644
--- a/asposepdfcloud/models/movie_annotation.py
+++ b/asposepdfcloud/models/movie_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -118,8 +118,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -316,6 +315,8 @@ def rect(self, rect):
:param rect: The rect of this MovieAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/movie_annotation_response.py b/asposepdfcloud/models/movie_annotation_response.py
index f964991..5f07e8d 100644
--- a/asposepdfcloud/models/movie_annotation_response.py
+++ b/asposepdfcloud/models/movie_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/movie_annotations.py b/asposepdfcloud/models/movie_annotations.py
index 3254e74..853820f 100644
--- a/asposepdfcloud/models/movie_annotations.py
+++ b/asposepdfcloud/models/movie_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/movie_annotations_response.py b/asposepdfcloud/models/movie_annotations_response.py
index 6cb5464..a3796ed 100644
--- a/asposepdfcloud/models/movie_annotations_response.py
+++ b/asposepdfcloud/models/movie_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/object_exist.py b/asposepdfcloud/models/object_exist.py
new file mode 100644
index 0000000..d2ca4a0
--- /dev/null
+++ b/asposepdfcloud/models/object_exist.py
@@ -0,0 +1,172 @@
+# 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: 3.0
+
+"""
+
+
+from pprint import pformat
+from six import iteritems
+import re
+
+
+class ObjectExist(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 = {
+ 'exists': 'bool',
+ 'is_folder': 'bool'
+ }
+
+ attribute_map = {
+ 'exists': 'Exists',
+ 'is_folder': 'IsFolder'
+ }
+
+ def __init__(self, exists=None, is_folder=None):
+ """
+ ObjectExist - a model defined in Swagger
+ """
+
+ self._exists = None
+ self._is_folder = None
+
+ self.exists = exists
+ self.is_folder = is_folder
+
+ @property
+ def exists(self):
+ """
+ Gets the exists of this ObjectExist.
+ Indicates that the file or folder exists.
+
+ :return: The exists of this ObjectExist.
+ :rtype: bool
+ """
+ return self._exists
+
+ @exists.setter
+ def exists(self, exists):
+ """
+ Sets the exists of this ObjectExist.
+ Indicates that the file or folder exists.
+
+ :param exists: The exists of this ObjectExist.
+ :type: bool
+ """
+ if exists is None:
+ raise ValueError("Invalid value for `exists`, must not be `None`")
+
+ self._exists = exists
+
+ @property
+ def is_folder(self):
+ """
+ Gets the is_folder of this ObjectExist.
+ True if it is a folder, false if it is a file.
+
+ :return: The is_folder of this ObjectExist.
+ :rtype: bool
+ """
+ return self._is_folder
+
+ @is_folder.setter
+ def is_folder(self, is_folder):
+ """
+ Sets the is_folder of this ObjectExist.
+ True if it is a folder, false if it is a file.
+
+ :param is_folder: The is_folder of this ObjectExist.
+ :type: bool
+ """
+ if is_folder is None:
+ raise ValueError("Invalid value for `is_folder`, must not be `None`")
+
+ self._is_folder = is_folder
+
+ 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, ObjectExist):
+ 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 cf8305a..ea35f61 100644
--- a/asposepdfcloud/models/optimize_options.py
+++ b/asposepdfcloud/models/optimize_options.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/page.py b/asposepdfcloud/models/page.py
index 6cda571..b1383f0 100644
--- a/asposepdfcloud/models/page.py
+++ b/asposepdfcloud/models/page.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -73,8 +73,7 @@ def __init__(self, links=None, id=None, images=None, rectangle=None):
if links is not None:
self.links = links
- if id is not None:
- self.id = id
+ self.id = id
if images is not None:
self.images = images
if rectangle is not None:
@@ -123,6 +122,8 @@ def id(self, id):
:param id: The id of this Page.
:type: int
"""
+ if id is None:
+ raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
diff --git a/asposepdfcloud/models/page_number_stamp.py b/asposepdfcloud/models/page_number_stamp.py
index 4aaf1b0..872a531 100644
--- a/asposepdfcloud/models/page_number_stamp.py
+++ b/asposepdfcloud/models/page_number_stamp.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -236,7 +236,7 @@ def opacity(self, opacity):
def rotate(self):
"""
Gets the rotate of this PageNumberStamp.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:return: The rotate of this PageNumberStamp.
:rtype: Rotation
@@ -247,7 +247,7 @@ def rotate(self):
def rotate(self, rotate):
"""
Sets the rotate of this PageNumberStamp.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:param rotate: The rotate of this PageNumberStamp.
:type: Rotation
diff --git a/asposepdfcloud/models/page_word_count.py b/asposepdfcloud/models/page_word_count.py
index 4419230..9e3662d 100644
--- a/asposepdfcloud/models/page_word_count.py
+++ b/asposepdfcloud/models/page_word_count.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/pages.py b/asposepdfcloud/models/pages.py
index b572260..7e3647d 100644
--- a/asposepdfcloud/models/pages.py
+++ b/asposepdfcloud/models/pages.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/paragraph.py b/asposepdfcloud/models/paragraph.py
index 6b8d8bf..bc9eb52 100644
--- a/asposepdfcloud/models/paragraph.py
+++ b/asposepdfcloud/models/paragraph.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/parts_embedding_modes.py b/asposepdfcloud/models/parts_embedding_modes.py
index 05875a1..f406517 100644
--- a/asposepdfcloud/models/parts_embedding_modes.py
+++ b/asposepdfcloud/models/parts_embedding_modes.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/pdf_a_type.py b/asposepdfcloud/models/pdf_a_type.py
index 4932868..6978f8e 100644
--- a/asposepdfcloud/models/pdf_a_type.py
+++ b/asposepdfcloud/models/pdf_a_type.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/pdf_page_stamp.py b/asposepdfcloud/models/pdf_page_stamp.py
index c58f6b4..14efdab 100644
--- a/asposepdfcloud/models/pdf_page_stamp.py
+++ b/asposepdfcloud/models/pdf_page_stamp.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -236,7 +236,7 @@ def opacity(self, opacity):
def rotate(self):
"""
Gets the rotate of this PdfPageStamp.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:return: The rotate of this PdfPageStamp.
:rtype: Rotation
@@ -247,7 +247,7 @@ def rotate(self):
def rotate(self, rotate):
"""
Sets the rotate of this PdfPageStamp.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:param rotate: The rotate of this PdfPageStamp.
:type: Rotation
diff --git a/asposepdfcloud/models/permissions_flags.py b/asposepdfcloud/models/permissions_flags.py
index 099c2c4..30137aa 100644
--- a/asposepdfcloud/models/permissions_flags.py
+++ b/asposepdfcloud/models/permissions_flags.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/point.py b/asposepdfcloud/models/point.py
index a0105e6..4bc39b3 100644
--- a/asposepdfcloud/models/point.py
+++ b/asposepdfcloud/models/point.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/poly_annotation.py b/asposepdfcloud/models/poly_annotation.py
index ba87ce8..57e04f9 100644
--- a/asposepdfcloud/models/poly_annotation.py
+++ b/asposepdfcloud/models/poly_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -136,8 +136,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -162,8 +161,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.ending_style = ending_style
if intent is not None:
self.intent = intent
- if vertices is not None:
- self.vertices = vertices
+ self.vertices = vertices
@property
def links(self):
@@ -346,6 +344,8 @@ def rect(self, rect):
:param rect: The rect of this PolyAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
@@ -645,6 +645,8 @@ def vertices(self, vertices):
:param vertices: The vertices of this PolyAnnotation.
:type: list[Point]
"""
+ if vertices is None:
+ raise ValueError("Invalid value for `vertices`, must not be `None`")
self._vertices = vertices
diff --git a/asposepdfcloud/models/poly_intent.py b/asposepdfcloud/models/poly_intent.py
index 5fcbf08..5f14462 100644
--- a/asposepdfcloud/models/poly_intent.py
+++ b/asposepdfcloud/models/poly_intent.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/poly_line_annotation.py b/asposepdfcloud/models/poly_line_annotation.py
index 91cb8fd..11bbc6b 100644
--- a/asposepdfcloud/models/poly_line_annotation.py
+++ b/asposepdfcloud/models/poly_line_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -136,8 +136,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -162,8 +161,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.ending_style = ending_style
if intent is not None:
self.intent = intent
- if vertices is not None:
- self.vertices = vertices
+ self.vertices = vertices
@property
def links(self):
@@ -346,6 +344,8 @@ def rect(self, rect):
:param rect: The rect of this PolyLineAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
@@ -645,6 +645,8 @@ def vertices(self, vertices):
:param vertices: The vertices of this PolyLineAnnotation.
:type: list[Point]
"""
+ if vertices is None:
+ raise ValueError("Invalid value for `vertices`, must not be `None`")
self._vertices = vertices
diff --git a/asposepdfcloud/models/poly_line_annotation_response.py b/asposepdfcloud/models/poly_line_annotation_response.py
index 221d396..420cc8a 100644
--- a/asposepdfcloud/models/poly_line_annotation_response.py
+++ b/asposepdfcloud/models/poly_line_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/poly_line_annotations.py b/asposepdfcloud/models/poly_line_annotations.py
index 63fa719..28f3705 100644
--- a/asposepdfcloud/models/poly_line_annotations.py
+++ b/asposepdfcloud/models/poly_line_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/poly_line_annotations_response.py b/asposepdfcloud/models/poly_line_annotations_response.py
index bf44f68..9906024 100644
--- a/asposepdfcloud/models/poly_line_annotations_response.py
+++ b/asposepdfcloud/models/poly_line_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/polygon_annotation.py b/asposepdfcloud/models/polygon_annotation.py
index 57486b1..aa176e6 100644
--- a/asposepdfcloud/models/polygon_annotation.py
+++ b/asposepdfcloud/models/polygon_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -136,8 +136,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -162,8 +161,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.ending_style = ending_style
if intent is not None:
self.intent = intent
- if vertices is not None:
- self.vertices = vertices
+ self.vertices = vertices
@property
def links(self):
@@ -346,6 +344,8 @@ def rect(self, rect):
:param rect: The rect of this PolygonAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
@@ -645,6 +645,8 @@ def vertices(self, vertices):
:param vertices: The vertices of this PolygonAnnotation.
:type: list[Point]
"""
+ if vertices is None:
+ raise ValueError("Invalid value for `vertices`, must not be `None`")
self._vertices = vertices
diff --git a/asposepdfcloud/models/polygon_annotation_response.py b/asposepdfcloud/models/polygon_annotation_response.py
index 735ec24..5e179bf 100644
--- a/asposepdfcloud/models/polygon_annotation_response.py
+++ b/asposepdfcloud/models/polygon_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/polygon_annotations.py b/asposepdfcloud/models/polygon_annotations.py
index d53e7ba..da55e71 100644
--- a/asposepdfcloud/models/polygon_annotations.py
+++ b/asposepdfcloud/models/polygon_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/polygon_annotations_response.py b/asposepdfcloud/models/polygon_annotations_response.py
index 4404af5..c361967 100644
--- a/asposepdfcloud/models/polygon_annotations_response.py
+++ b/asposepdfcloud/models/polygon_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/popup_annotation.py b/asposepdfcloud/models/popup_annotation.py
index c4a297b..5e87436 100644
--- a/asposepdfcloud/models/popup_annotation.py
+++ b/asposepdfcloud/models/popup_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -112,8 +112,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -306,6 +305,8 @@ def rect(self, rect):
:param rect: The rect of this PopupAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/popup_annotation_response.py b/asposepdfcloud/models/popup_annotation_response.py
index ed5fc69..22bc944 100644
--- a/asposepdfcloud/models/popup_annotation_response.py
+++ b/asposepdfcloud/models/popup_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/popup_annotation_with_parent.py b/asposepdfcloud/models/popup_annotation_with_parent.py
index 30538da..a5c6f5f 100644
--- a/asposepdfcloud/models/popup_annotation_with_parent.py
+++ b/asposepdfcloud/models/popup_annotation_with_parent.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -115,8 +115,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -311,6 +310,8 @@ def rect(self, rect):
:param rect: The rect of this PopupAnnotationWithParent.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/popup_annotations.py b/asposepdfcloud/models/popup_annotations.py
index 0498dce..ce67d37 100644
--- a/asposepdfcloud/models/popup_annotations.py
+++ b/asposepdfcloud/models/popup_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/popup_annotations_response.py b/asposepdfcloud/models/popup_annotations_response.py
index 06fa2d6..fae735f 100644
--- a/asposepdfcloud/models/popup_annotations_response.py
+++ b/asposepdfcloud/models/popup_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/position.py b/asposepdfcloud/models/position.py
index cdc80c2..4c19ad6 100644
--- a/asposepdfcloud/models/position.py
+++ b/asposepdfcloud/models/position.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/raster_images_saving_modes.py b/asposepdfcloud/models/raster_images_saving_modes.py
index 758a7dc..958bc37 100644
--- a/asposepdfcloud/models/raster_images_saving_modes.py
+++ b/asposepdfcloud/models/raster_images_saving_modes.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/rectangle.py b/asposepdfcloud/models/rectangle.py
index ab6ea01..95f9a09 100644
--- a/asposepdfcloud/models/rectangle.py
+++ b/asposepdfcloud/models/rectangle.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/redaction_annotation.py b/asposepdfcloud/models/redaction_annotation.py
index 862208d..5f3e34e 100644
--- a/asposepdfcloud/models/redaction_annotation.py
+++ b/asposepdfcloud/models/redaction_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -127,8 +127,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -331,6 +330,8 @@ def rect(self, rect):
:param rect: The rect of this RedactionAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/redaction_annotation_response.py b/asposepdfcloud/models/redaction_annotation_response.py
index 0c759f7..1ed020d 100644
--- a/asposepdfcloud/models/redaction_annotation_response.py
+++ b/asposepdfcloud/models/redaction_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/redaction_annotations.py b/asposepdfcloud/models/redaction_annotations.py
index 0e6dcee..1ca9a7b 100644
--- a/asposepdfcloud/models/redaction_annotations.py
+++ b/asposepdfcloud/models/redaction_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/redaction_annotations_response.py b/asposepdfcloud/models/redaction_annotations_response.py
index 34101b6..26956c2 100644
--- a/asposepdfcloud/models/redaction_annotations_response.py
+++ b/asposepdfcloud/models/redaction_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/rotation.py b/asposepdfcloud/models/rotation.py
index a0e258f..4b30e4a 100644
--- a/asposepdfcloud/models/rotation.py
+++ b/asposepdfcloud/models/rotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/row.py b/asposepdfcloud/models/row.py
index 5a04dc8..3c02a31 100644
--- a/asposepdfcloud/models/row.py
+++ b/asposepdfcloud/models/row.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/row_recognized.py b/asposepdfcloud/models/row_recognized.py
index fabacf0..2e92ef7 100644
--- a/asposepdfcloud/models/row_recognized.py
+++ b/asposepdfcloud/models/row_recognized.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/screen_annotation.py b/asposepdfcloud/models/screen_annotation.py
index 42f788e..154a674 100644
--- a/asposepdfcloud/models/screen_annotation.py
+++ b/asposepdfcloud/models/screen_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -115,8 +115,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -311,6 +310,8 @@ def rect(self, rect):
:param rect: The rect of this ScreenAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/screen_annotation_response.py b/asposepdfcloud/models/screen_annotation_response.py
index 1fd24c3..903f78c 100644
--- a/asposepdfcloud/models/screen_annotation_response.py
+++ b/asposepdfcloud/models/screen_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/screen_annotations.py b/asposepdfcloud/models/screen_annotations.py
index b48f28e..6bf67bc 100644
--- a/asposepdfcloud/models/screen_annotations.py
+++ b/asposepdfcloud/models/screen_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/screen_annotations_response.py b/asposepdfcloud/models/screen_annotations_response.py
index c25524c..62fedb2 100644
--- a/asposepdfcloud/models/screen_annotations_response.py
+++ b/asposepdfcloud/models/screen_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/segment.py b/asposepdfcloud/models/segment.py
index 3ff76f7..bcde398 100644
--- a/asposepdfcloud/models/segment.py
+++ b/asposepdfcloud/models/segment.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -91,6 +91,8 @@ def value(self, value):
"""
if value is None:
raise ValueError("Invalid value for `value`, must not be `None`")
+ if value is not None and len(value) < 1:
+ raise ValueError("Invalid value for `value`, length must be greater than or equal to `1`")
self._value = value
diff --git a/asposepdfcloud/models/shape_type.py b/asposepdfcloud/models/shape_type.py
index 524e6b1..bdfe415 100644
--- a/asposepdfcloud/models/shape_type.py
+++ b/asposepdfcloud/models/shape_type.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/signature.py b/asposepdfcloud/models/signature.py
index cd17ed7..2ce630e 100644
--- a/asposepdfcloud/models/signature.py
+++ b/asposepdfcloud/models/signature.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -143,6 +143,8 @@ def signature_path(self, signature_path):
"""
if signature_path is None:
raise ValueError("Invalid value for `signature_path`, must not be `None`")
+ if signature_path is not None and len(signature_path) < 1:
+ raise ValueError("Invalid value for `signature_path`, length must be greater than or equal to `1`")
self._signature_path = signature_path
@@ -290,7 +292,7 @@ def location(self, location):
def visible(self):
"""
Gets the visible of this Signature.
- Gets or sets a value indicating whether this is visible. Supports only when signing particular page.
+ Gets or sets a value indicating whether this Signature is visible. Supports only when signing particular page.
:return: The visible of this Signature.
:rtype: bool
@@ -301,7 +303,7 @@ def visible(self):
def visible(self, visible):
"""
Sets the visible of this Signature.
- Gets or sets a value indicating whether this is visible. Supports only when signing particular page.
+ Gets or sets a value indicating whether this Signature is visible. Supports only when signing particular page.
:param visible: The visible of this Signature.
:type: bool
diff --git a/asposepdfcloud/models/signature_type.py b/asposepdfcloud/models/signature_type.py
index 80f8c7b..9f46003 100644
--- a/asposepdfcloud/models/signature_type.py
+++ b/asposepdfcloud/models/signature_type.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/signature_verify_response.py b/asposepdfcloud/models/signature_verify_response.py
index 21b58bf..61ea36c 100644
--- a/asposepdfcloud/models/signature_verify_response.py
+++ b/asposepdfcloud/models/signature_verify_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -71,8 +71,7 @@ def __init__(self, code=None, status=None, valid=None):
self.code = code
if status is not None:
self.status = status
- if valid is not None:
- self.valid = valid
+ self.valid = valid
@property
def code(self):
@@ -142,6 +141,8 @@ def valid(self, valid):
:param valid: The valid of this SignatureVerifyResponse.
:type: bool
"""
+ if valid is None:
+ raise ValueError("Invalid value for `valid`, must not be `None`")
self._valid = valid
diff --git a/asposepdfcloud/models/sound_annotation.py b/asposepdfcloud/models/sound_annotation.py
index 1af51a1..6ebda20 100644
--- a/asposepdfcloud/models/sound_annotation.py
+++ b/asposepdfcloud/models/sound_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -139,8 +139,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -157,8 +156,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=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
+ self.file_path = file_path
if icon is not None:
self.icon = icon
if rate is not None:
@@ -351,6 +349,8 @@ def rect(self, rect):
:param rect: The rect of this SoundAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
@@ -558,7 +558,6 @@ def file_path(self, file_path):
:param file_path: The file_path of this SoundAnnotation.
:type: str
"""
-
self._file_path = file_path
@property
diff --git a/asposepdfcloud/models/sound_annotation_response.py b/asposepdfcloud/models/sound_annotation_response.py
index 08688da..75df22b 100644
--- a/asposepdfcloud/models/sound_annotation_response.py
+++ b/asposepdfcloud/models/sound_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/sound_annotations.py b/asposepdfcloud/models/sound_annotations.py
index e0a252d..aa23682 100644
--- a/asposepdfcloud/models/sound_annotations.py
+++ b/asposepdfcloud/models/sound_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/sound_annotations_response.py b/asposepdfcloud/models/sound_annotations_response.py
index 748a9e1..f3268bc 100644
--- a/asposepdfcloud/models/sound_annotations_response.py
+++ b/asposepdfcloud/models/sound_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/sound_encoding.py b/asposepdfcloud/models/sound_encoding.py
index 8aba806..792945e 100644
--- a/asposepdfcloud/models/sound_encoding.py
+++ b/asposepdfcloud/models/sound_encoding.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/sound_icon.py b/asposepdfcloud/models/sound_icon.py
index be4195d..cc95e74 100644
--- a/asposepdfcloud/models/sound_icon.py
+++ b/asposepdfcloud/models/sound_icon.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/split_result.py b/asposepdfcloud/models/split_result.py
index 32eaf23..d5d057f 100644
--- a/asposepdfcloud/models/split_result.py
+++ b/asposepdfcloud/models/split_result.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/split_result_document.py b/asposepdfcloud/models/split_result_document.py
index 931a53f..a1c423f 100644
--- a/asposepdfcloud/models/split_result_document.py
+++ b/asposepdfcloud/models/split_result_document.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -82,8 +82,7 @@ def __init__(self, href=None, rel=None, type=None, title=None, id=None):
self.type = type
if title is not None:
self.title = title
- if id is not None:
- self.id = id
+ self.id = id
@property
def href(self):
@@ -197,6 +196,8 @@ def id(self, id):
:param id: The id of this SplitResultDocument.
:type: int
"""
+ if id is None:
+ raise ValueError("Invalid value for `id`, must not be `None`")
self._id = id
diff --git a/asposepdfcloud/models/split_result_response.py b/asposepdfcloud/models/split_result_response.py
index 8302755..da3f8e3 100644
--- a/asposepdfcloud/models/split_result_response.py
+++ b/asposepdfcloud/models/split_result_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/square_annotation.py b/asposepdfcloud/models/square_annotation.py
index 901589b..a4f3eb2 100644
--- a/asposepdfcloud/models/square_annotation.py
+++ b/asposepdfcloud/models/square_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -127,8 +127,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -331,6 +330,8 @@ def rect(self, rect):
:param rect: The rect of this SquareAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/square_annotation_response.py b/asposepdfcloud/models/square_annotation_response.py
index b96957c..04821e9 100644
--- a/asposepdfcloud/models/square_annotation_response.py
+++ b/asposepdfcloud/models/square_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/square_annotations.py b/asposepdfcloud/models/square_annotations.py
index d5be719..7967092 100644
--- a/asposepdfcloud/models/square_annotations.py
+++ b/asposepdfcloud/models/square_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/square_annotations_response.py b/asposepdfcloud/models/square_annotations_response.py
index 063a508..15dbd2c 100644
--- a/asposepdfcloud/models/square_annotations_response.py
+++ b/asposepdfcloud/models/square_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/squiggly_annotation.py b/asposepdfcloud/models/squiggly_annotation.py
index 28ddbb5..5c9ca17 100644
--- a/asposepdfcloud/models/squiggly_annotation.py
+++ b/asposepdfcloud/models/squiggly_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -124,8 +124,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -326,6 +325,8 @@ def rect(self, rect):
:param rect: The rect of this SquigglyAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/squiggly_annotation_response.py b/asposepdfcloud/models/squiggly_annotation_response.py
index 3b3cdc5..6a6f742 100644
--- a/asposepdfcloud/models/squiggly_annotation_response.py
+++ b/asposepdfcloud/models/squiggly_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/squiggly_annotations.py b/asposepdfcloud/models/squiggly_annotations.py
index a14df9a..02d3795 100644
--- a/asposepdfcloud/models/squiggly_annotations.py
+++ b/asposepdfcloud/models/squiggly_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/squiggly_annotations_response.py b/asposepdfcloud/models/squiggly_annotations_response.py
index 165e253..5204064 100644
--- a/asposepdfcloud/models/squiggly_annotations_response.py
+++ b/asposepdfcloud/models/squiggly_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/stamp.py b/asposepdfcloud/models/stamp.py
index f3038ff..a99f279 100644
--- a/asposepdfcloud/models/stamp.py
+++ b/asposepdfcloud/models/stamp.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -336,7 +336,7 @@ def right_margin(self, right_margin):
def rotate(self):
"""
Gets the rotate of this Stamp.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:return: The rotate of this Stamp.
:rtype: Rotation
@@ -347,7 +347,7 @@ def rotate(self):
def rotate(self, rotate):
"""
Sets the rotate of this Stamp.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:param rotate: The rotate of this Stamp.
:type: Rotation
@@ -543,7 +543,7 @@ def value(self, value):
def text_state(self):
"""
Gets the text_state of this Stamp.
- Gets text properties of the stamp. See for details.
+ Gets text properties of the stamp. See TextState for details.
:return: The text_state of this Stamp.
:rtype: TextState
@@ -554,7 +554,7 @@ def text_state(self):
def text_state(self, text_state):
"""
Sets the text_state of this Stamp.
- Gets text properties of the stamp. See for details.
+ Gets text properties of the stamp. See TextState for details.
:param text_state: The text_state of this Stamp.
:type: TextState
diff --git a/asposepdfcloud/models/stamp_annotation.py b/asposepdfcloud/models/stamp_annotation.py
index ad5101e..c62e1bd 100644
--- a/asposepdfcloud/models/stamp_annotation.py
+++ b/asposepdfcloud/models/stamp_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -130,8 +130,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -336,6 +335,8 @@ def rect(self, rect):
:param rect: The rect of this StampAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/stamp_annotation_response.py b/asposepdfcloud/models/stamp_annotation_response.py
index 894edad..626a22b 100644
--- a/asposepdfcloud/models/stamp_annotation_response.py
+++ b/asposepdfcloud/models/stamp_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/stamp_annotations.py b/asposepdfcloud/models/stamp_annotations.py
index 745d490..905bb28 100644
--- a/asposepdfcloud/models/stamp_annotations.py
+++ b/asposepdfcloud/models/stamp_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/stamp_annotations_response.py b/asposepdfcloud/models/stamp_annotations_response.py
index 1589bbb..5a6b486 100644
--- a/asposepdfcloud/models/stamp_annotations_response.py
+++ b/asposepdfcloud/models/stamp_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/stamp_base.py b/asposepdfcloud/models/stamp_base.py
index b641f9d..43fd449 100644
--- a/asposepdfcloud/models/stamp_base.py
+++ b/asposepdfcloud/models/stamp_base.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -201,7 +201,7 @@ def opacity(self, opacity):
def rotate(self):
"""
Gets the rotate of this StampBase.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:return: The rotate of this StampBase.
:rtype: Rotation
@@ -212,7 +212,7 @@ def rotate(self):
def rotate(self, rotate):
"""
Sets the rotate of this StampBase.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:param rotate: The rotate of this StampBase.
:type: Rotation
diff --git a/asposepdfcloud/models/stamp_icon.py b/asposepdfcloud/models/stamp_icon.py
index 03cac0e..4567a4c 100644
--- a/asposepdfcloud/models/stamp_icon.py
+++ b/asposepdfcloud/models/stamp_icon.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/stamp_info.py b/asposepdfcloud/models/stamp_info.py
index 5fd3bcf..7fe777d 100644
--- a/asposepdfcloud/models/stamp_info.py
+++ b/asposepdfcloud/models/stamp_info.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -97,8 +97,7 @@ def __init__(self, links=None, id=None, index_on_page=None, page_index=None, rec
self.text = text
if visible is not None:
self.visible = visible
- if stamp_type is not None:
- self.stamp_type = stamp_type
+ self.stamp_type = stamp_type
@property
def links(self):
@@ -281,6 +280,8 @@ def stamp_type(self, stamp_type):
:param stamp_type: The stamp_type of this StampInfo.
:type: StampType
"""
+ if stamp_type is None:
+ raise ValueError("Invalid value for `stamp_type`, must not be `None`")
self._stamp_type = stamp_type
diff --git a/asposepdfcloud/models/stamp_type.py b/asposepdfcloud/models/stamp_type.py
index e672d97..cf67b8b 100644
--- a/asposepdfcloud/models/stamp_type.py
+++ b/asposepdfcloud/models/stamp_type.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/stamps_info.py b/asposepdfcloud/models/stamps_info.py
index 69523e7..61372ab 100644
--- a/asposepdfcloud/models/stamps_info.py
+++ b/asposepdfcloud/models/stamps_info.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/stamps_info_response.py b/asposepdfcloud/models/stamps_info_response.py
index 6b2744f..7370ccf 100644
--- a/asposepdfcloud/models/stamps_info_response.py
+++ b/asposepdfcloud/models/stamps_info_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/storage_exist.py b/asposepdfcloud/models/storage_exist.py
new file mode 100644
index 0000000..d89aeb3
--- /dev/null
+++ b/asposepdfcloud/models/storage_exist.py
@@ -0,0 +1,143 @@
+# 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: 3.0
+
+"""
+
+
+from pprint import pformat
+from six import iteritems
+import re
+
+
+class StorageExist(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 = {
+ 'exists': 'bool'
+ }
+
+ attribute_map = {
+ 'exists': 'Exists'
+ }
+
+ def __init__(self, exists=None):
+ """
+ StorageExist - a model defined in Swagger
+ """
+
+ self._exists = None
+
+ self.exists = exists
+
+ @property
+ def exists(self):
+ """
+ Gets the exists of this StorageExist.
+ Shows that the storage exists.
+
+ :return: The exists of this StorageExist.
+ :rtype: bool
+ """
+ return self._exists
+
+ @exists.setter
+ def exists(self, exists):
+ """
+ Sets the exists of this StorageExist.
+ Shows that the storage exists.
+
+ :param exists: The exists of this StorageExist.
+ :type: bool
+ """
+ if exists is None:
+ raise ValueError("Invalid value for `exists`, must not be `None`")
+
+ self._exists = exists
+
+ 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, StorageExist):
+ 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/storage_file.py b/asposepdfcloud/models/storage_file.py
new file mode 100644
index 0000000..4574a4a
--- /dev/null
+++ b/asposepdfcloud/models/storage_file.py
@@ -0,0 +1,256 @@
+# 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: 3.0
+
+"""
+
+
+from pprint import pformat
+from six import iteritems
+import re
+
+
+class StorageFile(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ """
+
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'name': 'str',
+ 'is_folder': 'bool',
+ 'modified_date': 'datetime',
+ 'size': 'int',
+ 'path': 'str'
+ }
+
+ attribute_map = {
+ 'name': 'Name',
+ 'is_folder': 'IsFolder',
+ 'modified_date': 'ModifiedDate',
+ 'size': 'Size',
+ 'path': 'Path'
+ }
+
+ def __init__(self, name=None, is_folder=None, modified_date=None, size=None, path=None):
+ """
+ StorageFile - a model defined in Swagger
+ """
+
+ self._name = None
+ self._is_folder = None
+ self._modified_date = None
+ self._size = None
+ self._path = None
+
+ if name is not None:
+ self.name = name
+ self.is_folder = is_folder
+ if modified_date is not None:
+ self.modified_date = modified_date
+ self.size = size
+ if path is not None:
+ self.path = path
+
+ @property
+ def name(self):
+ """
+ Gets the name of this StorageFile.
+ File or folder name.
+
+ :return: The name of this StorageFile.
+ :rtype: str
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name):
+ """
+ Sets the name of this StorageFile.
+ File or folder name.
+
+ :param name: The name of this StorageFile.
+ :type: str
+ """
+
+ self._name = name
+
+ @property
+ def is_folder(self):
+ """
+ Gets the is_folder of this StorageFile.
+ True if it is a folder.
+
+ :return: The is_folder of this StorageFile.
+ :rtype: bool
+ """
+ return self._is_folder
+
+ @is_folder.setter
+ def is_folder(self, is_folder):
+ """
+ Sets the is_folder of this StorageFile.
+ True if it is a folder.
+
+ :param is_folder: The is_folder of this StorageFile.
+ :type: bool
+ """
+ if is_folder is None:
+ raise ValueError("Invalid value for `is_folder`, must not be `None`")
+
+ self._is_folder = is_folder
+
+ @property
+ def modified_date(self):
+ """
+ Gets the modified_date of this StorageFile.
+ File or folder last modified DateTime.
+
+ :return: The modified_date of this StorageFile.
+ :rtype: datetime
+ """
+ return self._modified_date
+
+ @modified_date.setter
+ def modified_date(self, modified_date):
+ """
+ Sets the modified_date of this StorageFile.
+ File or folder last modified DateTime.
+
+ :param modified_date: The modified_date of this StorageFile.
+ :type: datetime
+ """
+
+ self._modified_date = modified_date
+
+ @property
+ def size(self):
+ """
+ Gets the size of this StorageFile.
+ File or folder size.
+
+ :return: The size of this StorageFile.
+ :rtype: int
+ """
+ return self._size
+
+ @size.setter
+ def size(self, size):
+ """
+ Sets the size of this StorageFile.
+ File or folder size.
+
+ :param size: The size of this StorageFile.
+ :type: int
+ """
+ if size is None:
+ raise ValueError("Invalid value for `size`, must not be `None`")
+
+ self._size = size
+
+ @property
+ def path(self):
+ """
+ Gets the path of this StorageFile.
+ File or folder path.
+
+ :return: The path of this StorageFile.
+ :rtype: str
+ """
+ return self._path
+
+ @path.setter
+ def path(self, path):
+ """
+ Sets the path of this StorageFile.
+ File or folder path.
+
+ :param path: The path of this StorageFile.
+ :type: str
+ """
+
+ self._path = path
+
+ def to_dict(self):
+ """
+ Returns the model properties as a dict
+ """
+ result = {}
+
+ for attr, _ in iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """
+ Returns the string representation of the model
+ """
+ return pformat(self.to_dict())
+
+ def __repr__(self):
+ """
+ For `print` and `pprint`
+ """
+ return self.to_str()
+
+ def __eq__(self, other):
+ """
+ Returns true if both objects are equal
+ """
+ if not isinstance(other, StorageFile):
+ return False
+
+ return self.__dict__ == other.__dict__
+
+ def __ne__(self, other):
+ """
+ Returns true if both objects are not equal
+ """
+ return not self == other
diff --git a/asposepdfcloud/models/strike_out_annotation.py b/asposepdfcloud/models/strike_out_annotation.py
index ce7b698..3a1607a 100644
--- a/asposepdfcloud/models/strike_out_annotation.py
+++ b/asposepdfcloud/models/strike_out_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -124,8 +124,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -326,6 +325,8 @@ def rect(self, rect):
:param rect: The rect of this StrikeOutAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/strike_out_annotation_response.py b/asposepdfcloud/models/strike_out_annotation_response.py
index 70f6c1c..2bd7592 100644
--- a/asposepdfcloud/models/strike_out_annotation_response.py
+++ b/asposepdfcloud/models/strike_out_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/strike_out_annotations.py b/asposepdfcloud/models/strike_out_annotations.py
index 9050107..8ebb82c 100644
--- a/asposepdfcloud/models/strike_out_annotations.py
+++ b/asposepdfcloud/models/strike_out_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/strike_out_annotations_response.py b/asposepdfcloud/models/strike_out_annotations_response.py
index eae4da6..806cca0 100644
--- a/asposepdfcloud/models/strike_out_annotations_response.py
+++ b/asposepdfcloud/models/strike_out_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/table.py b/asposepdfcloud/models/table.py
index d33183e..77cf5fc 100644
--- a/asposepdfcloud/models/table.py
+++ b/asposepdfcloud/models/table.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -146,8 +146,7 @@ def __init__(self, links=None, alignment=None, horizontal_alignment=None, vertic
self.default_cell_padding = default_cell_padding
if border is not None:
self.border = border
- if rows is not None:
- self.rows = rows
+ self.rows = rows
if default_column_width is not None:
self.default_column_width = default_column_width
if default_cell_border is not None:
@@ -402,6 +401,8 @@ def rows(self, rows):
:param rows: The rows of this Table.
:type: list[Row]
"""
+ if rows is None:
+ raise ValueError("Invalid value for `rows`, must not be `None`")
self._rows = rows
diff --git a/asposepdfcloud/models/table_broken.py b/asposepdfcloud/models/table_broken.py
index f0e1473..236e8e0 100644
--- a/asposepdfcloud/models/table_broken.py
+++ b/asposepdfcloud/models/table_broken.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/table_recognized.py b/asposepdfcloud/models/table_recognized.py
index 553804d..b8c8795 100644
--- a/asposepdfcloud/models/table_recognized.py
+++ b/asposepdfcloud/models/table_recognized.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/table_recognized_response.py b/asposepdfcloud/models/table_recognized_response.py
index 98cbcb9..ea086f0 100644
--- a/asposepdfcloud/models/table_recognized_response.py
+++ b/asposepdfcloud/models/table_recognized_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/tables_recognized.py b/asposepdfcloud/models/tables_recognized.py
index 999cccb..0968c62 100644
--- a/asposepdfcloud/models/tables_recognized.py
+++ b/asposepdfcloud/models/tables_recognized.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/tables_recognized_response.py b/asposepdfcloud/models/tables_recognized_response.py
index 890ad8c..a1dfa0c 100644
--- a/asposepdfcloud/models/tables_recognized_response.py
+++ b/asposepdfcloud/models/tables_recognized_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/text_annotation.py b/asposepdfcloud/models/text_annotation.py
index c3762f3..d992962 100644
--- a/asposepdfcloud/models/text_annotation.py
+++ b/asposepdfcloud/models/text_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -130,8 +130,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -336,6 +335,8 @@ def rect(self, rect):
:param rect: The rect of this TextAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/text_annotation_response.py b/asposepdfcloud/models/text_annotation_response.py
index 33da35f..966e3cb 100644
--- a/asposepdfcloud/models/text_annotation_response.py
+++ b/asposepdfcloud/models/text_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/text_annotations.py b/asposepdfcloud/models/text_annotations.py
index 65c5898..0421828 100644
--- a/asposepdfcloud/models/text_annotations.py
+++ b/asposepdfcloud/models/text_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/text_annotations_response.py b/asposepdfcloud/models/text_annotations_response.py
index f0a44ee..becb198 100644
--- a/asposepdfcloud/models/text_annotations_response.py
+++ b/asposepdfcloud/models/text_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/text_footer.py b/asposepdfcloud/models/text_footer.py
index c56d414..e1e8e5a 100644
--- a/asposepdfcloud/models/text_footer.py
+++ b/asposepdfcloud/models/text_footer.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -231,7 +231,7 @@ def opacity(self, opacity):
def rotate(self):
"""
Gets the rotate of this TextFooter.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:return: The rotate of this TextFooter.
:rtype: Rotation
@@ -242,7 +242,7 @@ def rotate(self):
def rotate(self, rotate):
"""
Sets the rotate of this TextFooter.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:param rotate: The rotate of this TextFooter.
:type: Rotation
@@ -392,7 +392,7 @@ def value(self, value):
def text_state(self):
"""
Gets the text_state of this TextFooter.
- Gets text properties of the stamp. See for details.
+ Gets text properties of the stamp. See TextState for details.
:return: The text_state of this TextFooter.
:rtype: TextState
@@ -403,7 +403,7 @@ def text_state(self):
def text_state(self, text_state):
"""
Sets the text_state of this TextFooter.
- Gets text properties of the stamp. See for details.
+ Gets text properties of the stamp. See TextState for details.
:param text_state: The text_state of this TextFooter.
:type: TextState
diff --git a/asposepdfcloud/models/text_header.py b/asposepdfcloud/models/text_header.py
index 1759d4f..6142955 100644
--- a/asposepdfcloud/models/text_header.py
+++ b/asposepdfcloud/models/text_header.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -231,7 +231,7 @@ def opacity(self, opacity):
def rotate(self):
"""
Gets the rotate of this TextHeader.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:return: The rotate of this TextHeader.
:rtype: Rotation
@@ -242,7 +242,7 @@ def rotate(self):
def rotate(self, rotate):
"""
Sets the rotate of this TextHeader.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:param rotate: The rotate of this TextHeader.
:type: Rotation
@@ -392,7 +392,7 @@ def value(self, value):
def text_state(self):
"""
Gets the text_state of this TextHeader.
- Gets text properties of the stamp. See for details.
+ Gets text properties of the stamp. See TextState for details.
:return: The text_state of this TextHeader.
:rtype: TextState
@@ -403,7 +403,7 @@ def text_state(self):
def text_state(self, text_state):
"""
Sets the text_state of this TextHeader.
- Gets text properties of the stamp. See for details.
+ Gets text properties of the stamp. See TextState for details.
:param text_state: The text_state of this TextHeader.
:type: TextState
diff --git a/asposepdfcloud/models/text_horizontal_alignment.py b/asposepdfcloud/models/text_horizontal_alignment.py
index 077ce08..8bf25ac 100644
--- a/asposepdfcloud/models/text_horizontal_alignment.py
+++ b/asposepdfcloud/models/text_horizontal_alignment.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/text_icon.py b/asposepdfcloud/models/text_icon.py
index ae671fc..bc13558 100644
--- a/asposepdfcloud/models/text_icon.py
+++ b/asposepdfcloud/models/text_icon.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/text_line.py b/asposepdfcloud/models/text_line.py
index 90b23a7..1ba0dc7 100644
--- a/asposepdfcloud/models/text_line.py
+++ b/asposepdfcloud/models/text_line.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/text_rect.py b/asposepdfcloud/models/text_rect.py
index e6d4030..1c152de 100644
--- a/asposepdfcloud/models/text_rect.py
+++ b/asposepdfcloud/models/text_rect.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -219,7 +219,7 @@ def vertical_alignment(self, vertical_alignment):
def position(self):
"""
Gets the position of this TextRect.
- Gets or sets text position for text, represented with object.
+ Gets or sets text position for text, represented with TextRect object.
:return: The position of this TextRect.
:rtype: Position
@@ -230,7 +230,7 @@ def position(self):
def position(self, position):
"""
Sets the position of this TextRect.
- Gets or sets text position for text, represented with object.
+ Gets or sets text position for text, represented with TextRect object.
:param position: The position of this TextRect.
:type: Position
@@ -242,7 +242,7 @@ def position(self, position):
def baseline_position(self):
"""
Gets the baseline_position of this TextRect.
- Gets text position for text, represented with object. The YIndent of the Position structure represents baseline coordinate of the text fragment.
+ Gets text position for text, represented with TextRect object. The YIndent of the Position structure represents baseline coordinate of the text fragment.
:return: The baseline_position of this TextRect.
:rtype: Position
@@ -253,7 +253,7 @@ def baseline_position(self):
def baseline_position(self, baseline_position):
"""
Sets the baseline_position of this TextRect.
- Gets text position for text, represented with object. The YIndent of the Position structure represents baseline coordinate of the text fragment.
+ Gets text position for text, represented with TextRect object. The YIndent of the Position structure represents baseline coordinate of the text fragment.
:param baseline_position: The baseline_position of this TextRect.
:type: Position
@@ -265,7 +265,7 @@ def baseline_position(self, baseline_position):
def text_state(self):
"""
Gets the text_state of this TextRect.
- Gets or sets text state for the text that object represents.
+ Gets or sets text state for the text that TextRect object represents.
:return: The text_state of this TextRect.
:rtype: TextState
@@ -276,7 +276,7 @@ def text_state(self):
def text_state(self, text_state):
"""
Sets the text_state of this TextRect.
- Gets or sets text state for the text that object represents.
+ Gets or sets text state for the text that TextRect object represents.
:param text_state: The text_state of this TextRect.
:type: TextState
diff --git a/asposepdfcloud/models/text_rects.py b/asposepdfcloud/models/text_rects.py
index 2c72738..ad903ea 100644
--- a/asposepdfcloud/models/text_rects.py
+++ b/asposepdfcloud/models/text_rects.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/text_rects_response.py b/asposepdfcloud/models/text_rects_response.py
index 5855be5..e87eb29 100644
--- a/asposepdfcloud/models/text_rects_response.py
+++ b/asposepdfcloud/models/text_rects_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/text_replace.py b/asposepdfcloud/models/text_replace.py
index 8ad0953..f659cf2 100644
--- a/asposepdfcloud/models/text_replace.py
+++ b/asposepdfcloud/models/text_replace.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -104,6 +104,8 @@ def old_value(self, old_value):
"""
if old_value is None:
raise ValueError("Invalid value for `old_value`, must not be `None`")
+ if old_value is not None and len(old_value) < 1:
+ raise ValueError("Invalid value for `old_value`, length must be greater than or equal to `1`")
self._old_value = old_value
@@ -129,6 +131,8 @@ def new_value(self, new_value):
"""
if new_value is None:
raise ValueError("Invalid value for `new_value`, must not be `None`")
+ if new_value is not None and len(new_value) < 1:
+ raise ValueError("Invalid value for `new_value`, length must be greater than or equal to `1`")
self._new_value = new_value
diff --git a/asposepdfcloud/models/text_replace_list_request.py b/asposepdfcloud/models/text_replace_list_request.py
index ecb5e67..4870345 100644
--- a/asposepdfcloud/models/text_replace_list_request.py
+++ b/asposepdfcloud/models/text_replace_list_request.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -108,6 +108,7 @@ def text_replaces(self, text_replaces):
def default_font(self):
"""
Gets the default_font of this TextReplaceListRequest.
+ Name of font to use if requested font is not embedded into document.
:return: The default_font of this TextReplaceListRequest.
:rtype: str
@@ -118,6 +119,7 @@ def default_font(self):
def default_font(self, default_font):
"""
Sets the default_font of this TextReplaceListRequest.
+ Name of font to use if requested font is not embedded into document.
:param default_font: The default_font of this TextReplaceListRequest.
:type: str
diff --git a/asposepdfcloud/models/text_replace_response.py b/asposepdfcloud/models/text_replace_response.py
index 62eff10..8a83838 100644
--- a/asposepdfcloud/models/text_replace_response.py
+++ b/asposepdfcloud/models/text_replace_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -71,8 +71,7 @@ def __init__(self, code=None, status=None, matches=None):
self.code = code
if status is not None:
self.status = status
- if matches is not None:
- self.matches = matches
+ self.matches = matches
@property
def code(self):
@@ -142,6 +141,8 @@ def matches(self, matches):
:param matches: The matches of this TextReplaceResponse.
:type: int
"""
+ if matches is None:
+ raise ValueError("Invalid value for `matches`, must not be `None`")
self._matches = matches
diff --git a/asposepdfcloud/models/text_stamp.py b/asposepdfcloud/models/text_stamp.py
index 422a118..10e3e86 100644
--- a/asposepdfcloud/models/text_stamp.py
+++ b/asposepdfcloud/models/text_stamp.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -241,7 +241,7 @@ def opacity(self, opacity):
def rotate(self):
"""
Gets the rotate of this TextStamp.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:return: The rotate of this TextStamp.
:rtype: Rotation
@@ -252,7 +252,7 @@ def rotate(self):
def rotate(self, rotate):
"""
Sets the rotate of this TextStamp.
- Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
+ Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
:param rotate: The rotate of this TextStamp.
:type: Rotation
@@ -402,7 +402,7 @@ def value(self, value):
def text_state(self):
"""
Gets the text_state of this TextStamp.
- Gets text properties of the stamp. See for details.
+ Gets text properties of the stamp. See TextState for details.
:return: The text_state of this TextStamp.
:rtype: TextState
@@ -413,7 +413,7 @@ def text_state(self):
def text_state(self, text_state):
"""
Sets the text_state of this TextStamp.
- Gets text properties of the stamp. See for details.
+ Gets text properties of the stamp. See TextState for details.
:param text_state: The text_state of this TextStamp.
:type: TextState
diff --git a/asposepdfcloud/models/text_state.py b/asposepdfcloud/models/text_state.py
index 1dca125..c7481fb 100644
--- a/asposepdfcloud/models/text_state.py
+++ b/asposepdfcloud/models/text_state.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/text_style.py b/asposepdfcloud/models/text_style.py
index 08cc143..f053e14 100644
--- a/asposepdfcloud/models/text_style.py
+++ b/asposepdfcloud/models/text_style.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/underline_annotation.py b/asposepdfcloud/models/underline_annotation.py
index 275caf0..7ca2519 100644
--- a/asposepdfcloud/models/underline_annotation.py
+++ b/asposepdfcloud/models/underline_annotation.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -124,8 +124,7 @@ def __init__(self, links=None, color=None, contents=None, modified=None, id=None
self.flags = flags
if name is not None:
self.name = name
- if rect is not None:
- self.rect = rect
+ self.rect = rect
if page_index is not None:
self.page_index = page_index
if z_index is not None:
@@ -326,6 +325,8 @@ def rect(self, rect):
:param rect: The rect of this UnderlineAnnotation.
:type: Rectangle
"""
+ if rect is None:
+ raise ValueError("Invalid value for `rect`, must not be `None`")
self._rect = rect
diff --git a/asposepdfcloud/models/underline_annotation_response.py b/asposepdfcloud/models/underline_annotation_response.py
index d03a3b3..2f9c51c 100644
--- a/asposepdfcloud/models/underline_annotation_response.py
+++ b/asposepdfcloud/models/underline_annotation_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/underline_annotations.py b/asposepdfcloud/models/underline_annotations.py
index 2f14086..9087bbe 100644
--- a/asposepdfcloud/models/underline_annotations.py
+++ b/asposepdfcloud/models/underline_annotations.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/underline_annotations_response.py b/asposepdfcloud/models/underline_annotations_response.py
index bedf4d7..d7bc881 100644
--- a/asposepdfcloud/models/underline_annotations_response.py
+++ b/asposepdfcloud/models/underline_annotations_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/vertical_alignment.py b/asposepdfcloud/models/vertical_alignment.py
index 0936320..c493034 100644
--- a/asposepdfcloud/models/vertical_alignment.py
+++ b/asposepdfcloud/models/vertical_alignment.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/word_count.py b/asposepdfcloud/models/word_count.py
index 9b9a440..5151298 100644
--- a/asposepdfcloud/models/word_count.py
+++ b/asposepdfcloud/models/word_count.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/models/word_count_response.py b/asposepdfcloud/models/word_count_response.py
index 28a0274..20502ea 100644
--- a/asposepdfcloud/models/word_count_response.py
+++ b/asposepdfcloud/models/word_count_response.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -126,7 +126,7 @@ def status(self, status):
def words_per_page(self):
"""
Gets the words_per_page of this WordCountResponse.
- with words per page info.
+ WordCount with words per page info.
:return: The words_per_page of this WordCountResponse.
:rtype: WordCount
@@ -137,7 +137,7 @@ def words_per_page(self):
def words_per_page(self, words_per_page):
"""
Sets the words_per_page of this WordCountResponse.
- with words per page info.
+ WordCount with words per page info.
:param words_per_page: The words_per_page of this WordCountResponse.
:type: WordCount
diff --git a/asposepdfcloud/models/wrap_mode.py b/asposepdfcloud/models/wrap_mode.py
index a4b690f..dc17e11 100644
--- a/asposepdfcloud/models/wrap_mode.py
+++ b/asposepdfcloud/models/wrap_mode.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/asposepdfcloud/rest.py b/asposepdfcloud/rest.py
index 1c9d431..cf7716c 100644
--- a/asposepdfcloud/rest.py
+++ b/asposepdfcloud/rest.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
diff --git a/docs/Annotation.md b/docs/Annotation.md
index 9c678a2..dd93f6c 100644
--- a/docs/Annotation.md
+++ b/docs/Annotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/AnnotationInfo.md b/docs/AnnotationInfo.md
index bc70355..1181c86 100644
--- a/docs/AnnotationInfo.md
+++ b/docs/AnnotationInfo.md
@@ -11,12 +11,12 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
-**annotation_type** | [**AnnotationType**](AnnotationType.md) | Gets annotation type. | [optional]
+**annotation_type** | [**AnnotationType**](AnnotationType.md) | Gets annotation type. |
[[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/Attachment.md b/docs/Attachment.md
index d458c26..d5934d3 100644
--- a/docs/Attachment.md
+++ b/docs/Attachment.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
**name** | **str** | Gets the name of the attachment. | [optional]
**creation_date** | **str** | The date and time when the embedded file was created. | [optional]
**modification_date** | **str** | The date and time when the embedded file was last modified. | [optional]
-**size** | **int** | The size of the uncompressed embedded file, in bytes. | [optional]
+**size** | **int** | The size of the uncompressed embedded file, in bytes. |
**check_sum** | **str** | A 16-byte string that is the checksum of the bytes of the uncompressed embedded file. The checksum is calculated by applying the standard MD5 message-digest algorithm to the bytes of the embedded file stream. | [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/Bookmark.md b/docs/Bookmark.md
new file mode 100644
index 0000000..9cd8049
--- /dev/null
+++ b/docs/Bookmark.md
@@ -0,0 +1,27 @@
+# Bookmark
+Provides link to bookmark.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**list[Link]**](Link.md) | Link to the document. | [optional]
+**title** | **str** | Get the Title; | [optional]
+**italic** | **bool** | Is bookmark italic. | [optional]
+**bold** | **bool** | Is bookmark bold. | [optional]
+**color** | [**Color**](Color.md) | Get the color | [optional]
+**action** | **str** | Gets or sets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: "GoTo", "GoToR", "Launch", "Named". | [optional]
+**level** | **int** | Gets or sets bookmark's hierarchy level. | [optional]
+**destination** | **str** | Gets or sets bookmark's destination page. Required if action is set as string.Empty. | [optional]
+**page_display** | **str** | Gets or sets the type of display bookmark's destination page. | [optional]
+**page_display_bottom** | **int** | Gets or sets the bottom coordinate of page display. | [optional]
+**page_display_left** | **int** | Gets or sets the left coordinate of page display. | [optional]
+**page_display_right** | **int** | Gets or sets the right coordinate of page display. | [optional]
+**page_display_top** | **int** | Gets or sets the top coordinate of page display. | [optional]
+**page_display_zoom** | **int** | Gets or sets the zoom factor of page display. | [optional]
+**page_number** | **int** | Gets or sets the number of bookmark's destination page. | [optional]
+**remote_file** | **str** | Gets or sets the file (path) which is required for "GoToR" action of bookmark. | [optional]
+**bookmarks** | [**Bookmarks**](Bookmarks.md) | The children bookmarks. | [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/BookmarkResponse.md b/docs/BookmarkResponse.md
new file mode 100644
index 0000000..e57f434
--- /dev/null
+++ b/docs/BookmarkResponse.md
@@ -0,0 +1,13 @@
+# BookmarkResponse
+Represents response containing single bookmark info
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **int** | Response status code. |
+**status** | **str** | Response status. | [optional]
+**bookmark** | [**Bookmark**](Bookmark.md) | Bookmark 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/Bookmarks.md b/docs/Bookmarks.md
new file mode 100644
index 0000000..a0df6bf
--- /dev/null
+++ b/docs/Bookmarks.md
@@ -0,0 +1,12 @@
+# Bookmarks
+Represents list of bookmark.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**list[Link]**](Link.md) | Link to the document. | [optional]
+**list** | [**list[Bookmark]**](Bookmark.md) | List of bookmarks. | [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/BookmarksResponse.md b/docs/BookmarksResponse.md
new file mode 100644
index 0000000..3ac2ff5
--- /dev/null
+++ b/docs/BookmarksResponse.md
@@ -0,0 +1,13 @@
+# BookmarksResponse
+Represents response containing multiple bookmarks info
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **int** | Response status code. |
+**status** | **str** | Response status. | [optional]
+**bookmarks** | [**Bookmarks**](Bookmarks.md) | Bookmarks 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/CaretAnnotation.md b/docs/CaretAnnotation.md
index e4458e0..caac888 100644
--- a/docs/CaretAnnotation.md
+++ b/docs/CaretAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/CellRecognized.md b/docs/CellRecognized.md
index c0c3f66..4e029a5 100644
--- a/docs/CellRecognized.md
+++ b/docs/CellRecognized.md
@@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**text_rects** | [**TextRects**](TextRects.md) | Gets collection of objects that describes text containing in the cell | [optional]
+**text_rects** | [**TextRects**](TextRects.md) | Gets collection of TextRect objects that describes text containing in the cell | [optional]
**rectangle** | [**Rectangle**](Rectangle.md) | Gets rectangle that describes position of the cell on page | [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/CircleAnnotation.md b/docs/CircleAnnotation.md
index cae2c1e..a45d70b 100644
--- a/docs/CircleAnnotation.md
+++ b/docs/CircleAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/CommonFigureAnnotation.md b/docs/CommonFigureAnnotation.md
index c029f6a..301ea72 100644
--- a/docs/CommonFigureAnnotation.md
+++ b/docs/CommonFigureAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/DiscUsage.md b/docs/DiscUsage.md
index cff4f4b..47aed23 100644
--- a/docs/DiscUsage.md
+++ b/docs/DiscUsage.md
@@ -1,11 +1,11 @@
# DiscUsage
-
+Class for disc space information.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**used_size** | **int** | |
-**total_size** | **int** | |
+**used_size** | **int** | Application used disc space. |
+**total_size** | **int** | Total disc space. |
[[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/DocumentPrivilege.md b/docs/DocumentPrivilege.md
index 01f34c2..d938009 100644
--- a/docs/DocumentPrivilege.md
+++ b/docs/DocumentPrivilege.md
@@ -1,5 +1,5 @@
# DocumentPrivilege
-Represents the privileges for accessing Pdf file./>.
+Represents the privileges for accessing Pdf file.
## Properties
Name | Type | Description | Notes
diff --git a/docs/DocumentProperty.md b/docs/DocumentProperty.md
index 9e205ec..e3b2a37 100644
--- a/docs/DocumentProperty.md
+++ b/docs/DocumentProperty.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
**links** | [**list[Link]**](Link.md) | Link to the document. | [optional]
**name** | **str** | Pame of the property. | [optional]
**value** | **str** | Property value. | [optional]
-**built_in** | **bool** | Value indicating whether it is a built-in property. | [optional]
+**built_in** | **bool** | Value indicating whether it is a built-in property. |
[[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/Error.md b/docs/Error.md
new file mode 100644
index 0000000..042526c
--- /dev/null
+++ b/docs/Error.md
@@ -0,0 +1,14 @@
+# Error
+Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **str** | Code | [optional]
+**message** | **str** | Message | [optional]
+**description** | **str** | Description | [optional]
+**inner_error** | [**ErrorDetails**](ErrorDetails.md) | Inner Error | [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/ErrorDetails.md b/docs/ErrorDetails.md
new file mode 100644
index 0000000..887e490
--- /dev/null
+++ b/docs/ErrorDetails.md
@@ -0,0 +1,12 @@
+# ErrorDetails
+The error details
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_id** | **str** | The request id | [optional]
+**date** | **datetime** | Date |
+
+[[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/Field.md b/docs/Field.md
index a5649fa..08d1d6b 100644
--- a/docs/Field.md
+++ b/docs/Field.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**selected_items** | **list[int]** | Selected items. | [optional]
**type** | [**FieldType**](FieldType.md) | Field type. | [optional]
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
-**values** | **list[str]** | Field values. | [optional]
+**values** | **list[str]** | Field values. |
[[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/Fields.md b/docs/Fields.md
index 5936e20..91fe3d3 100644
--- a/docs/Fields.md
+++ b/docs/Fields.md
@@ -5,7 +5,7 @@ Represents list of form fields.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**list[Link]**](Link.md) | Link to the document. | [optional]
-**list** | [**list[Field]**](Field.md) | List of form fields. | [optional]
+**list** | [**list[Field]**](Field.md) | List of form fields. |
[[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/FileAttachmentAnnotation.md b/docs/FileAttachmentAnnotation.md
index f888074..d00b939 100644
--- a/docs/FileAttachmentAnnotation.md
+++ b/docs/FileAttachmentAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/FileVersion.md b/docs/FileVersion.md
index 05e13b1..dc551a1 100644
--- a/docs/FileVersion.md
+++ b/docs/FileVersion.md
@@ -1,16 +1,16 @@
# FileVersion
-
+File Version
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**name** | **str** | | [optional]
-**is_folder** | **bool** | |
-**modified_date** | **datetime** | | [optional]
-**size** | **int** | |
-**path** | **str** | | [optional]
-**version_id** | **str** | | [optional]
-**is_latest** | **bool** | | [optional]
+**name** | **str** | File or folder name. | [optional]
+**is_folder** | **bool** | True if it is a folder. |
+**modified_date** | **datetime** | File or folder last modified DateTime. | [optional]
+**size** | **int** | File or folder size. |
+**path** | **str** | File or folder path. | [optional]
+**version_id** | **str** | File Version ID. | [optional]
+**is_latest** | **bool** | Specifies whether the file is (true) or is not (false) the latest version of an file. |
[[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/FileVersions.md b/docs/FileVersions.md
new file mode 100644
index 0000000..c8af2e1
--- /dev/null
+++ b/docs/FileVersions.md
@@ -0,0 +1,11 @@
+# FileVersions
+File versions FileVersion.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**list[FileVersion]**](FileVersion.md) | File versions FileVersion. | [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/FilesList.md b/docs/FilesList.md
new file mode 100644
index 0000000..3a84c0a
--- /dev/null
+++ b/docs/FilesList.md
@@ -0,0 +1,11 @@
+# FilesList
+Files list
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**list[StorageFile]**](StorageFile.md) | Files and folders contained by folder StorageFile. | [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/FilesUploadResult.md b/docs/FilesUploadResult.md
new file mode 100644
index 0000000..31064b9
--- /dev/null
+++ b/docs/FilesUploadResult.md
@@ -0,0 +1,12 @@
+# FilesUploadResult
+File upload result
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uploaded** | **list[str]** | List of uploaded file names | [optional]
+**errors** | [**list[Error]**](Error.md) | List of errors. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/FreeTextAnnotation.md b/docs/FreeTextAnnotation.md
index f8d61df..e962b25 100644
--- a/docs/FreeTextAnnotation.md
+++ b/docs/FreeTextAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
**justification** | [**Justification**](Justification.md) | Gets Justification of the annotation. | [optional]
**intent** | [**FreeTextIntent**](FreeTextIntent.md) | Gets or sets the intent of the free text annotation. | [optional]
**rotate** | [**Rotation**](Rotation.md) | Angle of annotation rotation. | [optional]
-**text_style** | [**TextStyle**](TextStyle.md) | Text style of the annotation. | [optional]
+**text_style** | [**TextStyle**](TextStyle.md) | Text style of the annotation. |
[[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/GraphInfo.md b/docs/GraphInfo.md
index e53d43d..be9f757 100644
--- a/docs/GraphInfo.md
+++ b/docs/GraphInfo.md
@@ -5,10 +5,10 @@ Represents graphics info.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**line_width** | **float** | Gets or sets a float value that indicates the line width of the graph. | [optional]
-**color** | [**Color**](Color.md) | Gets or sets a object that indicates the color of the graph. | [optional]
+**color** | [**Color**](Color.md) | Gets or sets a Color object that indicates the color of the graph. | [optional]
**dash_array** | **list[int]** | Gets or sets a dash array. | [optional]
**dash_phase** | **int** | Gets or sets a dash phase. | [optional]
-**fill_color** | [**Color**](Color.md) | Gets or sets a object that indicates the fill color of the graph. | [optional]
+**fill_color** | [**Color**](Color.md) | Gets or sets a Color object that indicates the fill color of the graph. | [optional]
**is_doubled** | **bool** | Gets or sets is border doubled. | [optional]
**skew_angle_x** | **float** | Gets or sets a float value that indicates the skew angle of the x-coordinate when transforming a coordinate system. | [optional]
**skew_angle_y** | **float** | Gets or sets a float value that indicates the skew angle of the y-coordinate when transforming a coordinate system. | [optional]
diff --git a/docs/HighlightAnnotation.md b/docs/HighlightAnnotation.md
index 8dab148..6973594 100644
--- a/docs/HighlightAnnotation.md
+++ b/docs/HighlightAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/Image.md b/docs/Image.md
index ad1034b..015cef3 100644
--- a/docs/Image.md
+++ b/docs/Image.md
@@ -5,11 +5,11 @@ Represents image DTO.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**list[Link]**](Link.md) | Link to the document. | [optional]
-**width** | **int** | Gets width of the image. | [optional]
-**height** | **int** | Gets height of the image. | [optional]
+**width** | **int** | Gets width of the image. |
+**height** | **int** | Gets height of the image. |
**id** | **str** | Gets ID of the image. | [optional]
**rectangle** | [**Rectangle**](Rectangle.md) | Gets rectangle of the image. | [optional]
-**page_number** | **int** | Gets page number. | [optional]
+**page_number** | **int** | Gets page number. |
[[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/ImageFooter.md b/docs/ImageFooter.md
index dec12ff..dcd0ea7 100644
--- a/docs/ImageFooter.md
+++ b/docs/ImageFooter.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**background** | **bool** | Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. | [optional]
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
**opacity** | **float** | Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. | [optional]
-**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
+**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
**rotate_angle** | **float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
**x_indent** | **float** | Horizontal stamp coordinate, starting from the left. | [optional]
**y_indent** | **float** | Vertical stamp coordinate, starting from the bottom. | [optional]
diff --git a/docs/ImageHeader.md b/docs/ImageHeader.md
index ac6af74..abb5b0c 100644
--- a/docs/ImageHeader.md
+++ b/docs/ImageHeader.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**background** | **bool** | Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. | [optional]
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
**opacity** | **float** | Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. | [optional]
-**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
+**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
**rotate_angle** | **float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
**x_indent** | **float** | Horizontal stamp coordinate, starting from the left. | [optional]
**y_indent** | **float** | Vertical stamp coordinate, starting from the bottom. | [optional]
diff --git a/docs/ImageStamp.md b/docs/ImageStamp.md
index 2226594..bb654cc 100644
--- a/docs/ImageStamp.md
+++ b/docs/ImageStamp.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**background** | **bool** | Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. | [optional]
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
**opacity** | **float** | Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. | [optional]
-**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
+**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
**rotate_angle** | **float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
**x_indent** | **float** | Horizontal stamp coordinate, starting from the left. | [optional]
**y_indent** | **float** | Vertical stamp coordinate, starting from the bottom. | [optional]
diff --git a/docs/InkAnnotation.md b/docs/InkAnnotation.md
index 838a123..32782ed 100644
--- a/docs/InkAnnotation.md
+++ b/docs/InkAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/LineAnnotation.md b/docs/LineAnnotation.md
index 5c91e0a..efc6fa6 100644
--- a/docs/LineAnnotation.md
+++ b/docs/LineAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
**subject** | **str** | Get the annotation subject. | [optional]
**title** | **str** | Get the annotation title. | [optional]
**rich_text** | **str** | Get the annotation RichText. | [optional]
-**starting** | [**Point**](Point.md) | Gets or sets starting point of line. | [optional]
+**starting** | [**Point**](Point.md) | Gets or sets starting point of line. |
**starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets line ending style for line starting point. | [optional]
-**ending** | [**Point**](Point.md) | Gets or sets ending point of line. | [optional]
+**ending** | [**Point**](Point.md) | Gets or sets ending point of line. |
**ending_style** | [**LineEnding**](LineEnding.md) | Gets or sets ending style for end point of line. | [optional]
**interior_color** | [**Color**](Color.md) | Gets or sets interior color of the annotation. | [optional]
**leader_line** | **float** | Gets or sets leader line length. | [optional]
diff --git a/docs/LinkAnnotation.md b/docs/LinkAnnotation.md
index 3c5daf9..ab63ef3 100644
--- a/docs/LinkAnnotation.md
+++ b/docs/LinkAnnotation.md
@@ -5,11 +5,11 @@ Provides link to linkAnnotation.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**list[Link]**](Link.md) | Link to the document. | [optional]
-**action_type** | [**LinkActionType**](LinkActionType.md) | | [optional]
-**action** | **str** | | [optional]
-**highlighting** | [**LinkHighlightingMode**](LinkHighlightingMode.md) | | [optional]
+**action_type** | [**LinkActionType**](LinkActionType.md) | |
+**action** | **str** | |
+**highlighting** | [**LinkHighlightingMode**](LinkHighlightingMode.md) | |
**color** | [**Color**](Color.md) | | [optional]
-**rect** | [**Rectangle**](Rectangle.md) | | [optional]
+**rect** | [**Rectangle**](Rectangle.md) | |
**id** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/MarkupAnnotation.md b/docs/MarkupAnnotation.md
index 42ded46..cecb65e 100644
--- a/docs/MarkupAnnotation.md
+++ b/docs/MarkupAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/MovieAnnotation.md b/docs/MovieAnnotation.md
index e3558d8..9ecde1e 100644
--- a/docs/MovieAnnotation.md
+++ b/docs/MovieAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/ObjectExist.md b/docs/ObjectExist.md
new file mode 100644
index 0000000..1c3cb56
--- /dev/null
+++ b/docs/ObjectExist.md
@@ -0,0 +1,12 @@
+# ObjectExist
+Object exists
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exists** | **bool** | Indicates that the file or folder exists. |
+**is_folder** | **bool** | True if it is a folder, false if it is a file. |
+
+[[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/Page.md b/docs/Page.md
index a46638d..1203313 100644
--- a/docs/Page.md
+++ b/docs/Page.md
@@ -5,7 +5,7 @@ Provides link to page.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**list[Link]**](Link.md) | Link to the document. | [optional]
-**id** | **int** | Page's id. | [optional]
+**id** | **int** | Page's id. |
**images** | [**Images**](Images.md) | Page's images | [optional]
**rectangle** | [**Rectangle**](Rectangle.md) | Page's rectangle | [optional]
diff --git a/docs/PageNumberStamp.md b/docs/PageNumberStamp.md
index 0af6ec5..84ca471 100644
--- a/docs/PageNumberStamp.md
+++ b/docs/PageNumberStamp.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**background** | **bool** | Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. | [optional]
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
**opacity** | **float** | Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. | [optional]
-**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
+**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
**rotate_angle** | **float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
**x_indent** | **float** | Horizontal stamp coordinate, starting from the left. | [optional]
**y_indent** | **float** | Vertical stamp coordinate, starting from the bottom. | [optional]
diff --git a/docs/PdfApi.md b/docs/PdfApi.md
index adf90af..c27e4d6 100644
--- a/docs/PdfApi.md
+++ b/docs/PdfApi.md
@@ -1,17 +1,22 @@
# swagger_client.PdfApi
-All URIs are relative to *https://api.aspose.cloud/v2.0*
+All URIs are relative to *https://api.aspose.cloud/v3.0*
Method | HTTP request | Description
------------- | ------------- | -------------
+[**copy_file**](PdfApi.md#copy_file) | **PUT** /pdf/storage/file/copy/\{srcPath} | Copy file
+[**copy_folder**](PdfApi.md#copy_folder) | **PUT** /pdf/storage/folder/copy/\{srcPath} | Copy folder
+[**create_folder**](PdfApi.md#create_folder) | **PUT** /pdf/storage/folder/\{path} | Create the folder
[**delete_annotation**](PdfApi.md#delete_annotation) | **DELETE** /pdf/\{name}/annotations/\{annotationId} | Delete document annotation by ID
+[**delete_bookmark**](PdfApi.md#delete_bookmark) | **DELETE** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Delete document bookmark by ID.
[**delete_document_annotations**](PdfApi.md#delete_document_annotations) | **DELETE** /pdf/\{name}/annotations | Delete all annotations from the document
+[**delete_document_bookmarks**](PdfApi.md#delete_document_bookmarks) | **DELETE** /pdf/\{name}/bookmarks/tree | Delete all document bookmarks.
[**delete_document_link_annotations**](PdfApi.md#delete_document_link_annotations) | **DELETE** /pdf/\{name}/links | Delete all link annotations from the document
[**delete_document_stamps**](PdfApi.md#delete_document_stamps) | **DELETE** /pdf/\{name}/stamps | Delete all stamps from the document
[**delete_document_tables**](PdfApi.md#delete_document_tables) | **DELETE** /pdf/\{name}/tables | Delete all tables from the document
[**delete_field**](PdfApi.md#delete_field) | **DELETE** /pdf/\{name}/fields/\{fieldName} | Delete document field by name.
-[**delete_file**](PdfApi.md#delete_file) | **DELETE** /storage/file | Remove a specific file
-[**delete_folder**](PdfApi.md#delete_folder) | **DELETE** /storage/folder | Remove a specific folder
+[**delete_file**](PdfApi.md#delete_file) | **DELETE** /pdf/storage/file/\{path} | Delete file
+[**delete_folder**](PdfApi.md#delete_folder) | **DELETE** /pdf/storage/folder/\{path} | Delete folder
[**delete_image**](PdfApi.md#delete_image) | **DELETE** /pdf/\{name}/images/\{imageId} | Delete image from document page.
[**delete_link_annotation**](PdfApi.md#delete_link_annotation) | **DELETE** /pdf/\{name}/links/\{linkId} | Delete document page link annotation by ID
[**delete_page**](PdfApi.md#delete_page) | **DELETE** /pdf/\{name}/pages/\{pageNumber} | Delete document page by its number.
@@ -23,13 +28,17 @@ Method | HTTP request | Description
[**delete_property**](PdfApi.md#delete_property) | **DELETE** /pdf/\{name}/documentproperties/\{propertyName} | Delete document property.
[**delete_stamp**](PdfApi.md#delete_stamp) | **DELETE** /pdf/\{name}/stamps/\{stampId} | Delete document stamp by ID
[**delete_table**](PdfApi.md#delete_table) | **DELETE** /pdf/\{name}/tables/\{tableId} | Delete document table by ID
+[**download_file**](PdfApi.md#download_file) | **GET** /pdf/storage/file/\{path} | Download file
+[**get_bookmark**](PdfApi.md#get_bookmark) | **GET** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Read document bookmark.
+[**get_bookmarks**](PdfApi.md#get_bookmarks) | **GET** /pdf/\{name}/bookmarks/list/\{bookmarkPath} | Read document bookmarks node list.
[**get_caret_annotation**](PdfApi.md#get_caret_annotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID.
[**get_circle_annotation**](PdfApi.md#get_circle_annotation) | **GET** /pdf/\{name}/annotations/circle/\{annotationId} | Read document page circle annotation by ID.
-[**get_disc_usage**](PdfApi.md#get_disc_usage) | **GET** /storage/disc | Check the disk usage of the current account
+[**get_disc_usage**](PdfApi.md#get_disc_usage) | **GET** /pdf/storage/disc | Get disc usage
[**get_document**](PdfApi.md#get_document) | **GET** /pdf/\{name} | Read common document info.
[**get_document_annotations**](PdfApi.md#get_document_annotations) | **GET** /pdf/\{name}/annotations | Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
[**get_document_attachment_by_index**](PdfApi.md#get_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex} | Read document attachment info by its index.
[**get_document_attachments**](PdfApi.md#get_document_attachments) | **GET** /pdf/\{name}/attachments | Read document attachments info.
+[**get_document_bookmarks**](PdfApi.md#get_document_bookmarks) | **GET** /pdf/\{name}/bookmarks/tree | Read document bookmarks tree.
[**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.
@@ -55,13 +64,17 @@ Method | HTTP request | Description
[**get_document_tables**](PdfApi.md#get_document_tables) | **GET** /pdf/\{name}/tables | Read document tables.
[**get_document_text_annotations**](PdfApi.md#get_document_text_annotations) | **GET** /pdf/\{name}/annotations/text | Read document text annotations.
[**get_document_underline_annotations**](PdfApi.md#get_document_underline_annotations) | **GET** /pdf/\{name}/annotations/underline | Read document underline annotations.
-[**get_download**](PdfApi.md#get_download) | **GET** /storage/file | Download a specific file
[**get_download_document_attachment_by_index**](PdfApi.md#get_download_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex}/download | Download document attachment content by its index.
[**get_epub_in_storage_to_pdf**](PdfApi.md#get_epub_in_storage_to_pdf) | **GET** /pdf/create/epub | Convert EPUB file (located on storage) to PDF format and return resulting file in response.
+[**get_export_fields_from_pdf_to_fdf_in_storage**](PdfApi.md#get_export_fields_from_pdf_to_fdf_in_storage) | **GET** /pdf/\{name}/export/fdf | Export fields from from PDF in storage to FDF file.
+[**get_export_fields_from_pdf_to_xfdf_in_storage**](PdfApi.md#get_export_fields_from_pdf_to_xfdf_in_storage) | **GET** /pdf/\{name}/export/xfdf | Export fields from from PDF in storage to XFDF file.
+[**get_export_fields_from_pdf_to_xml_in_storage**](PdfApi.md#get_export_fields_from_pdf_to_xml_in_storage) | **GET** /pdf/\{name}/export/xml | Export fields from from PDF in storage to XML file.
[**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_file_versions**](PdfApi.md#get_file_versions) | **GET** /pdf/storage/version/\{path} | Get file versions
+[**get_files_list**](PdfApi.md#get_files_list) | **GET** /pdf/storage/folder/\{path} | Get all files and folders within a folder
[**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.
@@ -71,14 +84,13 @@ Method | HTTP request | Description
[**get_image_extract_as_png**](PdfApi.md#get_image_extract_as_png) | **GET** /pdf/\{name}/images/\{imageId}/extract/png | Extract document image in PNG format
[**get_image_extract_as_tiff**](PdfApi.md#get_image_extract_as_tiff) | **GET** /pdf/\{name}/images/\{imageId}/extract/tiff | Extract document image in TIFF format
[**get_images**](PdfApi.md#get_images) | **GET** /pdf/\{name}/pages/\{pageNumber}/images | Read document images.
+[**get_import_fields_from_fdf_in_storage**](PdfApi.md#get_import_fields_from_fdf_in_storage) | **GET** /pdf/\{name}/import/fdf | Update fields from FDF file in storage.
+[**get_import_fields_from_xfdf_in_storage**](PdfApi.md#get_import_fields_from_xfdf_in_storage) | **GET** /pdf/\{name}/import/xfdf | Update fields from XFDF file in storage.
+[**get_import_fields_from_xml_in_storage**](PdfApi.md#get_import_fields_from_xml_in_storage) | **GET** /pdf/\{name}/import/xml | Import from XML file (located on storage) to PDF format and return resulting file in response.
[**get_ink_annotation**](PdfApi.md#get_ink_annotation) | **GET** /pdf/\{name}/annotations/ink/\{annotationId} | Read document page ink annotation by ID.
-[**get_is_exist**](PdfApi.md#get_is_exist) | **GET** /storage/exist | Check if a specific file or folder exists
-[**get_is_storage_exist**](PdfApi.md#get_is_storage_exist) | **GET** /storage/\{name}/exist | Check if storage exists
[**get_la_te_x_in_storage_to_pdf**](PdfApi.md#get_la_te_x_in_storage_to_pdf) | **GET** /pdf/create/latex | Convert LaTeX file (located on storage) to PDF format and return resulting file in response.
[**get_line_annotation**](PdfApi.md#get_line_annotation) | **GET** /pdf/\{name}/annotations/line/\{annotationId} | Read document page line annotation by ID.
[**get_link_annotation**](PdfApi.md#get_link_annotation) | **GET** /pdf/\{name}/links/\{linkId} | Read document link annotation by ID.
-[**get_list_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.
@@ -155,7 +167,11 @@ Method | HTTP request | Description
[**get_xml_in_storage_to_pdf**](PdfApi.md#get_xml_in_storage_to_pdf) | **GET** /pdf/create/xml | Convert XML file (located on storage) to PDF format and return resulting file in response.
[**get_xps_in_storage_to_pdf**](PdfApi.md#get_xps_in_storage_to_pdf) | **GET** /pdf/create/xps | Convert XPS file (located on storage) to PDF format and return resulting file in response.
[**get_xsl_fo_in_storage_to_pdf**](PdfApi.md#get_xsl_fo_in_storage_to_pdf) | **GET** /pdf/create/xslfo | Convert XslFo file (located on storage) to PDF format and return resulting file in response.
+[**move_file**](PdfApi.md#move_file) | **PUT** /pdf/storage/file/move/\{srcPath} | Move file
+[**move_folder**](PdfApi.md#move_folder) | **PUT** /pdf/storage/folder/move/\{srcPath} | Move folder
+[**object_exists**](PdfApi.md#object_exists) | **GET** /pdf/storage/exist/\{path} | Check if file or folder exists
[**post_append_document**](PdfApi.md#post_append_document) | **POST** /pdf/\{name}/appendDocument | Append document to existing one.
+[**post_bookmark**](PdfApi.md#post_bookmark) | **POST** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Add document bookmarks.
[**post_change_password_document_in_storage**](PdfApi.md#post_change_password_document_in_storage) | **POST** /pdf/\{name}/changepassword | Change document password in storage.
[**post_create_field**](PdfApi.md#post_create_field) | **POST** /pdf/\{name}/fields | Create field.
[**post_decrypt_document_in_storage**](PdfApi.md#post_decrypt_document_in_storage) | **POST** /pdf/\{name}/decrypt | Decrypt document in storage.
@@ -167,9 +183,10 @@ Method | HTTP request | Description
[**post_document_text_replace**](PdfApi.md#post_document_text_replace) | **POST** /pdf/\{name}/text/replace | Document's replace text method.
[**post_encrypt_document_in_storage**](PdfApi.md#post_encrypt_document_in_storage) | **POST** /pdf/\{name}/encrypt | Encrypt document in storage.
[**post_flatten_document**](PdfApi.md#post_flatten_document) | **POST** /pdf/\{name}/flatten | Flatten the document.
+[**post_import_fields_from_fdf**](PdfApi.md#post_import_fields_from_fdf) | **POST** /pdf/\{name}/import/fdf | Update fields from FDF file in request.
+[**post_import_fields_from_xfdf**](PdfApi.md#post_import_fields_from_xfdf) | **POST** /pdf/\{name}/import/xfdf | Update fields from XFDF file in request.
+[**post_import_fields_from_xml**](PdfApi.md#post_import_fields_from_xml) | **POST** /pdf/\{name}/import/xml | Update fields from XML file in request.
[**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
[**post_move_page**](PdfApi.md#post_move_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/movePage | Move page to new position.
[**post_optimize_document**](PdfApi.md#post_optimize_document) | **POST** /pdf/\{name}/optimize | Optimize document.
[**post_page_caret_annotations**](PdfApi.md#post_page_caret_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Add document page caret annotations.
@@ -204,15 +221,17 @@ Method | HTTP request | Description
[**put_add_new_page**](PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
[**put_add_text**](PdfApi.md#put_add_text) | **PUT** /pdf/\{name}/pages/\{pageNumber}/text | Add text to PDF document page.
[**put_annotations_flatten**](PdfApi.md#put_annotations_flatten) | **PUT** /pdf/\{name}/annotations/flatten | Flattens the annotations of the specified types
+[**put_bookmark**](PdfApi.md#put_bookmark) | **PUT** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Update document bookmark.
[**put_caret_annotation**](PdfApi.md#put_caret_annotation) | **PUT** /pdf/\{name}/annotations/caret/\{annotationId} | Replace document caret annotation
[**put_change_password_document**](PdfApi.md#put_change_password_document) | **PUT** /pdf/changepassword | Change document password from content.
[**put_circle_annotation**](PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation
-[**put_create**](PdfApi.md#put_create) | **PUT** /storage/file | Upload a specific file
[**put_create_document**](PdfApi.md#put_create_document) | **PUT** /pdf/\{name} | Create empty document.
-[**put_create_folder**](PdfApi.md#put_create_folder) | **PUT** /storage/folder | Create the folder
[**put_decrypt_document**](PdfApi.md#put_decrypt_document) | **PUT** /pdf/decrypt | Decrypt document from content.
[**put_encrypt_document**](PdfApi.md#put_encrypt_document) | **PUT** /pdf/encrypt | Encrypt document from content.
[**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_export_fields_from_pdf_to_fdf_in_storage**](PdfApi.md#put_export_fields_from_pdf_to_fdf_in_storage) | **PUT** /pdf/\{name}/export/fdf | Export fields from from PDF in storage to FDF file in storage.
+[**put_export_fields_from_pdf_to_xfdf_in_storage**](PdfApi.md#put_export_fields_from_pdf_to_xfdf_in_storage) | **PUT** /pdf/\{name}/export/xfdf | Export fields from from PDF in storage to XFDF file in storage.
+[**put_export_fields_from_pdf_to_xml_in_storage**](PdfApi.md#put_export_fields_from_pdf_to_xml_in_storage) | **PUT** /pdf/\{name}/export/xml | Export fields from from PDF in storage to XML file in 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
@@ -228,6 +247,9 @@ Method | HTTP request | Description
[**put_images_extract_as_jpeg**](PdfApi.md#put_images_extract_as_jpeg) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/jpeg | Extract document images in JPEG format to folder.
[**put_images_extract_as_png**](PdfApi.md#put_images_extract_as_png) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/png | Extract document images in PNG format to folder.
[**put_images_extract_as_tiff**](PdfApi.md#put_images_extract_as_tiff) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/tiff | Extract document images in TIFF format to folder.
+[**put_import_fields_from_fdf_in_storage**](PdfApi.md#put_import_fields_from_fdf_in_storage) | **PUT** /pdf/\{name}/import/fdf | Update fields from FDF file in storage.
+[**put_import_fields_from_xfdf_in_storage**](PdfApi.md#put_import_fields_from_xfdf_in_storage) | **PUT** /pdf/\{name}/import/xfdf | Update fields from XFDF file in storage.
+[**put_import_fields_from_xml_in_storage**](PdfApi.md#put_import_fields_from_xml_in_storage) | **PUT** /pdf/\{name}/import/xml | Update fields from XML file in storage.
[**put_ink_annotation**](PdfApi.md#put_ink_annotation) | **PUT** /pdf/\{name}/annotations/ink/\{annotationId} | Replace document ink annotation
[**put_la_te_x_in_storage_to_pdf**](PdfApi.md#put_la_te_x_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/latex | Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage.
[**put_line_annotation**](PdfApi.md#put_line_annotation) | **PUT** /pdf/\{name}/annotations/line/\{annotationId} | Replace document line annotation
@@ -299,8 +321,84 @@ Method | HTTP request | Description
[**put_xml_in_storage_to_pdf**](PdfApi.md#put_xml_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/xml | Convert XML file (located on storage) to PDF format and upload resulting file to storage.
[**put_xps_in_storage_to_pdf**](PdfApi.md#put_xps_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/xps | Convert XPS file (located on storage) to PDF format and upload resulting file to storage.
[**put_xsl_fo_in_storage_to_pdf**](PdfApi.md#put_xsl_fo_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/xslfo | Convert XslFo file (located on storage) to PDF format and upload resulting file to storage.
+[**storage_exists**](PdfApi.md#storage_exists) | **GET** /pdf/storage/\{storageName}/exist | Check if storage exists
+[**upload_file**](PdfApi.md#upload_file) | **PUT** /pdf/storage/file/\{path} | Upload file
+# **copy_file**
+> copy_file(src_path, dest_path, src_storage_name=src_storage_name, dest_storage_name=dest_storage_name, version_id=version_id)
+
+Copy file
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **src_path** | **str**| Source file path e.g. '/folder/file.ext' |
+ **dest_path** | **str**| Destination file path |
+ **src_storage_name** | **str**| Source storage name | [optional]
+ **dest_storage_name** | **str**| Destination storage name | [optional]
+ **version_id** | **str**| File version ID to copy | [optional]
+
+### Return type
+
+void (empty response body)
+
+### 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)
+
+# **copy_folder**
+> copy_folder(src_path, dest_path, src_storage_name=src_storage_name, dest_storage_name=dest_storage_name)
+
+Copy folder
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **src_path** | **str**| Source folder path e.g. '/src' |
+ **dest_path** | **str**| Destination folder path e.g. '/dst' |
+ **src_storage_name** | **str**| Source storage name | [optional]
+ **dest_storage_name** | **str**| Destination storage name | [optional]
+
+### Return type
+
+void (empty response body)
+
+### 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)
+
+# **create_folder**
+> create_folder(path, storage_name=storage_name)
+
+Create the folder
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **str**| Folder path to create e.g. 'folder_1/folder_2/' |
+ **storage_name** | **str**| Storage name | [optional]
+
+### Return type
+
+void (empty response body)
+
+### 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)
+
# **delete_annotation**
> AsposeResponse delete_annotation(name, annotation_id, storage=storage, folder=folder)
@@ -326,6 +424,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)
+# **delete_bookmark**
+> AsposeResponse delete_bookmark(name, bookmark_path, folder=folder, storage=storage)
+
+Delete document bookmark by ID.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. |
+ **bookmark_path** | **str**| The bookmark path. |
+ **folder** | **str**| The document folder. | [optional]
+ **storage** | **str**| The document storage. | [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)
+
# **delete_document_annotations**
> AsposeResponse delete_document_annotations(name, storage=storage, folder=folder)
@@ -350,6 +473,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)
+# **delete_document_bookmarks**
+> AsposeResponse delete_document_bookmarks(name, folder=folder, storage=storage)
+
+Delete all document bookmarks.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. |
+ **folder** | **str**| The document folder. | [optional]
+ **storage** | **str**| The document storage. | [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)
+
# **delete_document_link_annotations**
> AsposeResponse delete_document_link_annotations(name, storage=storage, folder=folder)
@@ -448,21 +595,21 @@ 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)
# **delete_file**
-> AsposeResponse delete_file(path, version_id=version_id, storage=storage)
+> delete_file(path, storage_name=storage_name, version_id=version_id)
-Remove a specific file
+Delete file
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **path** | **str**| Path of the file including file name and extension e.g. /Folder1/file.ext |
- **version_id** | **str**| File's version | [optional]
- **storage** | **str**| User's storage name | [optional]
+ **path** | **str**| File path e.g. '/folder/file.ext' |
+ **storage_name** | **str**| Storage name | [optional]
+ **version_id** | **str**| File version ID to delete | [optional]
### Return type
-[**AsposeResponse**](AsposeResponse.md)
+void (empty response body)
### HTTP request headers
@@ -472,21 +619,21 @@ 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)
# **delete_folder**
-> AsposeResponse delete_folder(path, storage=storage, recursive=recursive)
+> delete_folder(path, storage_name=storage_name, recursive=recursive)
-Remove a specific folder
+Delete folder
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **path** | **str**| Folder path e.g. /Folder1 |
- **storage** | **str**| User's storage name | [optional]
- **recursive** | **bool**| Remove recursivelly inner folder/files. If false and folder contains data than exception is raised. | [optional] [default to false]
+ **path** | **str**| Folder path e.g. '/folder' |
+ **storage_name** | **str**| Storage name | [optional]
+ **recursive** | **bool**| Enable to delete folders, subfolders and files | [optional] [default to false]
### Return type
-[**AsposeResponse**](AsposeResponse.md)
+void (empty response body)
### HTTP request headers
@@ -769,6 +916,80 @@ 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)
+# **download_file**
+> file download_file(path, storage_name=storage_name, version_id=version_id)
+
+Download file
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **str**| File path e.g. '/folder/file.ext' |
+ **storage_name** | **str**| Storage name | [optional]
+ **version_id** | **str**| File version ID to download | [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_bookmark**
+> BookmarkResponse get_bookmark(name, bookmark_path, folder=folder, storage=storage)
+
+Read document bookmark.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. |
+ **bookmark_path** | **str**| The bookmark path. |
+ **folder** | **str**| The document folder. | [optional]
+ **storage** | **str**| The document storage. | [optional]
+
+### Return type
+
+[**BookmarkResponse**](BookmarkResponse.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_bookmarks**
+> BookmarksResponse get_bookmarks(name, bookmark_path, folder=folder, storage=storage)
+
+Read document bookmarks node list.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. |
+ **bookmark_path** | **str**| The bookmark path. |
+ **folder** | **str**| The document folder. | [optional]
+ **storage** | **str**| The document storage. | [optional]
+
+### Return type
+
+[**BookmarksResponse**](BookmarksResponse.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_caret_annotation**
> CaretAnnotationResponse get_caret_annotation(name, annotation_id, storage=storage, folder=folder)
@@ -820,19 +1041,19 @@ 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_disc_usage**
-> DiscUsageResponse get_disc_usage(storage=storage)
+> DiscUsage get_disc_usage(storage_name=storage_name)
-Check the disk usage of the current account
+Get disc usage
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **storage** | **str**| User's storage name | [optional]
+ **storage_name** | **str**| Storage name | [optional]
### Return type
-[**DiscUsageResponse**](DiscUsageResponse.md)
+[**DiscUsage**](DiscUsage.md)
### HTTP request headers
@@ -938,6 +1159,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_bookmarks**
+> BookmarksResponse get_document_bookmarks(name, folder=folder, storage=storage)
+
+Read document bookmarks tree.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. |
+ **folder** | **str**| The document folder. | [optional]
+ **storage** | **str**| The document storage. | [optional]
+
+### Return type
+
+[**BookmarksResponse**](BookmarksResponse.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_caret_annotations**
> CaretAnnotationsResponse get_document_caret_annotations(name, storage=storage, folder=folder)
@@ -1540,18 +1785,19 @@ 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_download**
-> file get_download(path, version_id=version_id, storage=storage)
+# **get_download_document_attachment_by_index**
+> file get_download_document_attachment_by_index(name, attachment_index, storage=storage, folder=folder)
-Download a specific file
+Download document attachment content by its index.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **path** | **str**| Path of the file including the file name and extension e.g. /file.ext |
- **version_id** | **str**| File's version | [optional]
- **storage** | **str**| User's storage name | [optional]
+ **name** | **str**| The document name. |
+ **attachment_index** | **int**| The attachment index. |
+ **storage** | **str**| The document storage. | [optional]
+ **folder** | **str**| The document folder. | [optional]
### Return type
@@ -1564,17 +1810,39 @@ 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_download_document_attachment_by_index**
-> file get_download_document_attachment_by_index(name, attachment_index, storage=storage, folder=folder)
+# **get_epub_in_storage_to_pdf**
+> file get_epub_in_storage_to_pdf(src_path, storage=storage)
-Download document attachment content by its index.
+Convert EPUB file (located on storage) to PDF format and return resulting file in response.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **src_path** | **str**| Full source filename (ex. /folder1/folder2/template.epub) |
+ **storage** | **str**| The document storage. | [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_export_fields_from_pdf_to_fdf_in_storage**
+> file get_export_fields_from_pdf_to_fdf_in_storage(name, storage=storage, folder=folder)
+
+Export fields from from PDF in storage to FDF file.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
- **attachment_index** | **int**| The attachment index. |
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -1589,17 +1857,42 @@ 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_epub_in_storage_to_pdf**
-> file get_epub_in_storage_to_pdf(src_path, storage=storage)
+# **get_export_fields_from_pdf_to_xfdf_in_storage**
+> file get_export_fields_from_pdf_to_xfdf_in_storage(name, storage=storage, folder=folder)
-Convert EPUB file (located on storage) to PDF format and return resulting file in response.
+Export fields from from PDF in storage to XFDF file.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **src_path** | **str**| Full source filename (ex. /folder1/folder2/template.epub) |
+ **name** | **str**| The document name. |
**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_export_fields_from_pdf_to_xml_in_storage**
+> file get_export_fields_from_pdf_to_xml_in_storage(name, storage=storage, folder=folder)
+
+Export fields from from PDF in storage to XML file.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. |
+ **storage** | **str**| The document storage. | [optional]
+ **folder** | **str**| The document folder. | [optional]
### Return type
@@ -1622,7 +1915,7 @@ Get document field by name.
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
- **field_name** | **str**| The field name/ |
+ **field_name** | **str**| The field name (name should be encoded). |
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -1682,7 +1975,7 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: application/json
- - **Accept**: multipart/form-data
+ - **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)
@@ -1711,6 +2004,52 @@ 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_versions**
+> FileVersions get_file_versions(path, storage_name=storage_name)
+
+Get file versions
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **str**| File path e.g. '/file.ext' |
+ **storage_name** | **str**| Storage name | [optional]
+
+### Return type
+
+[**FileVersions**](FileVersions.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_files_list**
+> FilesList get_files_list(path, storage_name=storage_name)
+
+Get all files and folders within a folder
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **str**| Folder path e.g. '/folder' |
+ **storage_name** | **str**| Storage name | [optional]
+
+### Return type
+
+[**FilesList**](FilesList.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_free_text_annotation**
> FreeTextAnnotationResponse get_free_text_annotation(name, annotation_id, storage=storage, folder=folder)
@@ -1813,7 +2152,7 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: application/json
- - **Accept**: multipart/form-data
+ - **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)
@@ -1828,8 +2167,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**image_id** | **str**| Image ID. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -1855,8 +2194,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**image_id** | **str**| Image ID. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -1882,8 +2221,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**image_id** | **str**| Image ID. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -1909,8 +2248,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**image_id** | **str**| Image ID. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -1950,88 +2289,69 @@ Name | Type | Description | Notes
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-# **get_ink_annotation**
-> InkAnnotationResponse get_ink_annotation(name, annotation_id, storage=storage, folder=folder)
+# **get_import_fields_from_fdf_in_storage**
+> file get_import_fields_from_fdf_in_storage(name, fdf_file_path, storage=storage, folder=folder)
-Read document page ink annotation by ID.
+Update fields from FDF file in storage.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
- **annotation_id** | **str**| The annotation ID. |
+ **fdf_file_path** | **str**| The Fdf file path. |
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
### Return type
-[**InkAnnotationResponse**](InkAnnotationResponse.md)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **get_is_exist**
-> FileExistResponse get_is_exist(path, version_id=version_id, storage=storage)
-
-Check if a specific file or folder exists
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **path** | **str**| File or folder path e.g. /file.ext or /Folder1 |
- **version_id** | **str**| File's version | [optional]
- **storage** | **str**| User's storage name | [optional]
-
-### Return type
-
-[**FileExistResponse**](FileExistResponse.md)
+**file**
### HTTP request headers
- **Content-Type**: application/json
- - **Accept**: 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_is_storage_exist**
-> StorageExistResponse get_is_storage_exist(name)
+# **get_import_fields_from_xfdf_in_storage**
+> file get_import_fields_from_xfdf_in_storage(name, xfdf_file_path, storage=storage, folder=folder)
-Check if storage exists
+Update fields from XFDF file in storage.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **name** | **str**| Storage name |
+ **name** | **str**| The document name. |
+ **xfdf_file_path** | **str**| The XFDF file path. |
+ **storage** | **str**| The document storage. | [optional]
+ **folder** | **str**| The document folder. | [optional]
### Return type
-[**StorageExistResponse**](StorageExistResponse.md)
+**file**
### HTTP request headers
- **Content-Type**: application/json
- - **Accept**: 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_la_te_x_in_storage_to_pdf**
-> file get_la_te_x_in_storage_to_pdf(src_path, storage=storage)
+# **get_import_fields_from_xml_in_storage**
+> file get_import_fields_from_xml_in_storage(name, xml_file_path, storage=storage, folder=folder)
-Convert LaTeX file (located on storage) to PDF format and return resulting file in response.
+Import from XML file (located on storage) to PDF format and return resulting file in response.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **src_path** | **str**| Full source filename (ex. /folder1/folder2/template.tex) |
+ **name** | **str**| The document name. |
+ **xml_file_path** | **str**| Full source filename (ex. /folder1/folder2/template.xml) |
**storage** | **str**| The document storage. | [optional]
+ **folder** | **str**| The document folder. | [optional]
### Return type
@@ -2044,10 +2364,10 @@ Name | Type | Description | Notes
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-# **get_line_annotation**
-> LineAnnotationResponse get_line_annotation(name, annotation_id, storage=storage, folder=folder)
+# **get_ink_annotation**
+> InkAnnotationResponse get_ink_annotation(name, annotation_id, storage=storage, folder=folder)
-Read document page line annotation by ID.
+Read document page ink annotation by ID.
### Parameters
@@ -2060,7 +2380,7 @@ Name | Type | Description | Notes
### Return type
-[**LineAnnotationResponse**](LineAnnotationResponse.md)
+[**InkAnnotationResponse**](InkAnnotationResponse.md)
### HTTP request headers
@@ -2069,46 +2389,46 @@ 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_link_annotation**
-> LinkAnnotationResponse get_link_annotation(name, link_id, storage=storage, folder=folder)
+# **get_la_te_x_in_storage_to_pdf**
+> file get_la_te_x_in_storage_to_pdf(src_path, storage=storage)
-Read document link annotation by ID.
+Convert LaTeX file (located on storage) to PDF format and return resulting file in response.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **name** | **str**| The document name. |
- **link_id** | **str**| The link ID. |
+ **src_path** | **str**| Full source filename (ex. /folder1/folder2/template.tex) |
**storage** | **str**| The document storage. | [optional]
- **folder** | **str**| The document folder. | [optional]
### Return type
-[**LinkAnnotationResponse**](LinkAnnotationResponse.md)
+**file**
### HTTP request headers
- **Content-Type**: application/json
- - **Accept**: 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_list_file_versions**
-> FileVersionsResponse get_list_file_versions(path, storage=storage)
+# **get_line_annotation**
+> LineAnnotationResponse get_line_annotation(name, annotation_id, storage=storage, folder=folder)
-Get the file's versions list
+Read document page line annotation by ID.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **path** | **str**| File path e.g. /file.ext or /Folder1/file.ext |
- **storage** | **str**| User's storage name | [optional]
+ **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
-[**FileVersionsResponse**](FileVersionsResponse.md)
+[**LineAnnotationResponse**](LineAnnotationResponse.md)
### HTTP request headers
@@ -2117,21 +2437,23 @@ Name | Type | Description | Notes
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-# **get_list_files**
-> FilesResponse get_list_files(path=path, storage=storage)
+# **get_link_annotation**
+> LinkAnnotationResponse get_link_annotation(name, link_id, storage=storage, folder=folder)
-Get the file listing of a specific folder
+Read document link annotation by ID.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **path** | **str**| Start with name of storage e.g. root folder '/'or some folder '/folder1/..' | [optional] [default to /]
- **storage** | **str**| User's storage name | [optional]
+ **name** | **str**| The document name. |
+ **link_id** | **str**| The link ID. |
+ **storage** | **str**| The document storage. | [optional]
+ **folder** | **str**| The document folder. | [optional]
### Return type
-[**FilesResponse**](FilesResponse.md)
+[**LinkAnnotationResponse**](LinkAnnotationResponse.md)
### HTTP request headers
@@ -2209,7 +2531,7 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: application/json
- - **Accept**: multipart/form-data
+ - **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)
@@ -2299,8 +2621,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -2326,8 +2648,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -2353,8 +2675,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -2380,8 +2702,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -2407,8 +2729,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -2434,8 +2756,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -2968,7 +3290,7 @@ Name | Type | Description | Notes
**ury** | **float**| Y - coordinate of upper-right corner. |
**format** | **list[str]**| List of formats for search. | [optional]
**regex** | **str**| Formats are specified as a regular expression. | [optional]
- **split_rects** | **bool**| Split result fragments (default is true). | [optional]
+ **split_rects** | **bool**| Split result fragments (default is true). | [optional] [default to true]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -3601,7 +3923,7 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: application/json
- - **Accept**: multipart/form-data
+ - **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)
@@ -3651,7 +3973,7 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: application/json
- - **Accept**: multipart/form-data
+ - **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)
@@ -3877,7 +4199,7 @@ Name | Type | Description | Notes
**ury** | **float**| Y - coordinate of upper-right corner. |
**format** | **list[str]**| List of formats for search. | [optional]
**regex** | **str**| Formats are specified as a regular expression. | [optional]
- **split_rects** | **bool**| Split result fragments (default is true). | [optional]
+ **split_rects** | **bool**| Split result fragments (default is true). | [optional] [default to true]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -4115,8 +4437,83 @@ 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)
+# **move_file**
+> move_file(src_path, dest_path, src_storage_name=src_storage_name, dest_storage_name=dest_storage_name, version_id=version_id)
+
+Move file
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **src_path** | **str**| Source file path e.g. '/src.ext' |
+ **dest_path** | **str**| Destination file path e.g. '/dest.ext' |
+ **src_storage_name** | **str**| Source storage name | [optional]
+ **dest_storage_name** | **str**| Destination storage name | [optional]
+ **version_id** | **str**| File version ID to move | [optional]
+
+### Return type
+
+void (empty response body)
+
+### 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)
+
+# **move_folder**
+> move_folder(src_path, dest_path, src_storage_name=src_storage_name, dest_storage_name=dest_storage_name)
+
+Move folder
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **src_path** | **str**| Folder path to move e.g. '/folder' |
+ **dest_path** | **str**| Destination folder path to move to e.g '/dst' |
+ **src_storage_name** | **str**| Source storage name | [optional]
+ **dest_storage_name** | **str**| Destination storage name | [optional]
+
+### Return type
+
+void (empty response body)
+
+### 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)
+
+# **object_exists**
+> ObjectExist object_exists(path, storage_name=storage_name, version_id=version_id)
+
+Check if file or folder exists
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **str**| File or folder path e.g. '/file.ext' or '/folder' |
+ **storage_name** | **str**| Storage name | [optional]
+ **version_id** | **str**| File version ID | [optional]
+
+### Return type
+
+[**ObjectExist**](ObjectExist.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_append_document**
-> DocumentResponse post_append_document(name, append_document=append_document, append_file=append_file, start_page=start_page, end_page=end_page, storage=storage, folder=folder)
+> DocumentResponse post_append_document(name, append_file, start_page=start_page, end_page=end_page, storage=storage, folder=folder)
Append document to existing one.
@@ -4125,8 +4522,7 @@ Append document to existing one.
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The original document name. |
- **append_document** | [**AppendDocument**](AppendDocument.md)| with the append document data. | [optional]
- **append_file** | **str**| Append file server path. | [optional]
+ **append_file** | **str**| Append file server path. |
**start_page** | **int**| Appending start page. | [optional] [default to 0]
**end_page** | **int**| Appending end page. | [optional] [default to 0]
**storage** | **str**| The documents storage. | [optional]
@@ -4134,7 +4530,33 @@ Name | Type | Description | Notes
### Return type
-[**DocumentResponse**](DocumentResponse.md)
+[**DocumentResponse**](DocumentResponse.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_bookmark**
+> BookmarksResponse post_bookmark(name, bookmark_path, bookmarks, folder=folder, storage=storage)
+
+Add document bookmarks.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. |
+ **bookmark_path** | **str**| The bookmark path. |
+ **bookmarks** | [**list[Bookmark]**](Bookmark.md)| The array of bookmark. |
+ **folder** | **str**| The document folder. | [optional]
+ **storage** | **str**| The document storage. | [optional]
+
+### Return type
+
+[**BookmarksResponse**](BookmarksResponse.md)
### HTTP request headers
@@ -4171,7 +4593,7 @@ 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_create_field**
-> AsposeResponse post_create_field(name, page, field=field, storage=storage, folder=folder)
+> AsposeResponse post_create_field(name, page, field, storage=storage, folder=folder)
Create field.
@@ -4181,7 +4603,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page** | **int**| Document page number. |
- **field** | [**Field**](Field.md)| with the field data. | [optional]
+ **field** | [**Field**](Field.md)| Field with the field data. |
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -4393,8 +4815,8 @@ Name | Type | Description | Notes
**name** | **str**| Document name. |
**user_password** | **str**| User password (encrypted Base64). |
**owner_password** | **str**| Owner password (encrypted Base64). |
- **crypto_algorithm** | **str**| Cryptographic algorithm, see for details. |
- **permissions_flags** | [**list[PermissionsFlags]**](PermissionsFlags.md)| Array of document permissions, see for details. | [optional]
+ **crypto_algorithm** | **str**| Cryptographic algorithm, see CryptoAlgorithm for details. |
+ **permissions_flags** | [**list[PermissionsFlags]**](PermissionsFlags.md)| Array of document permissions, see PermissionsFlags for details. | [optional]
**use_pdf20** | **bool**| Support for revision 6 (Extension 8). | [optional]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -4437,25 +4859,19 @@ 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_insert_image**
-> AsposeResponse post_insert_image(name, page_number, llx, lly, urx, ury, image_file_path=image_file_path, storage=storage, folder=folder, image=image)
+# **post_import_fields_from_fdf**
+> AsposeResponse post_import_fields_from_fdf(name, storage=storage, folder=folder, fdf_data=fdf_data)
-Insert image to document page.
+Update fields from FDF file in request.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
- **page_number** | **int**| The page number. |
- **llx** | **float**| Coordinate lower left X. |
- **lly** | **float**| Coordinate lower left Y. |
- **urx** | **float**| Coordinate upper right X. |
- **ury** | **float**| Coordinate upper right Y. |
- **image_file_path** | **str**| Path to image file if specified. Request content is used otherwise. | [optional]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
- **image** | **file**| Image file. | [optional]
+ **fdf_data** | **file**| Fdf file. | [optional]
### Return type
@@ -4468,20 +4884,19 @@ 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_move_file**
-> AsposeResponse post_move_file(src, dest, version_id=version_id, storage=storage, dest_storage=dest_storage)
+# **post_import_fields_from_xfdf**
+> AsposeResponse post_import_fields_from_xfdf(name, storage=storage, folder=folder, xfdf_data=xfdf_data)
-Move a specific file
+Update fields from XFDF file in request.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **src** | **str**| Source file path e.g. /fileSource.ext |
- **dest** | **str**| Destination file path e.g. /fileDestination.ext |
- **version_id** | **str**| Source file's version, | [optional]
- **storage** | **str**| User's source storage name | [optional]
- **dest_storage** | **str**| User's destination storage name | [optional]
+ **name** | **str**| The document name. |
+ **storage** | **str**| The document storage. | [optional]
+ **folder** | **str**| The document folder. | [optional]
+ **xfdf_data** | **file**| Xfdf file. | [optional]
### Return type
@@ -4494,19 +4909,19 @@ 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_move_folder**
-> AsposeResponse post_move_folder(src, dest, storage=storage, dest_storage=dest_storage)
+# **post_import_fields_from_xml**
+> AsposeResponse post_import_fields_from_xml(name, storage=storage, folder=folder, xml_data=xml_data)
-Move a specific folder
+Update fields from XML file in request.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **src** | **str**| Source folder path e.g. /Folder1 |
- **dest** | **str**| Destination folder path e.g. /Folder2 |
- **storage** | **str**| User's source storage name | [optional]
- **dest_storage** | **str**| User's destination storage name | [optional]
+ **name** | **str**| The document name. |
+ **storage** | **str**| The document storage. | [optional]
+ **folder** | **str**| The document folder. | [optional]
+ **xml_data** | **file**| Xml file. | [optional]
### Return type
@@ -4514,7 +4929,38 @@ Name | Type | Description | Notes
### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: multipart/form-data
+ - **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_insert_image**
+> AsposeResponse post_insert_image(name, page_number, llx, lly, urx, ury, image_file_path=image_file_path, storage=storage, folder=folder, image=image)
+
+Insert image to document page.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. |
+ **page_number** | **int**| The page number. |
+ **llx** | **float**| Coordinate lower left X. |
+ **lly** | **float**| Coordinate lower left Y. |
+ **urx** | **float**| Coordinate upper right X. |
+ **ury** | **float**| Coordinate upper right Y. |
+ **image_file_path** | **str**| Path to image file if specified. Request content is used otherwise. | [optional]
+ **storage** | **str**| The document storage. | [optional]
+ **folder** | **str**| The document folder. | [optional]
+ **image** | **file**| Image file. | [optional]
+
+### Return type
+
+[**AsposeResponse**](AsposeResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
- **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)
@@ -4546,7 +4992,7 @@ Name | Type | Description | Notes
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **post_optimize_document**
-> AsposeResponse post_optimize_document(name, options=options, storage=storage, folder=folder)
+> AsposeResponse post_optimize_document(name, options, storage=storage, folder=folder)
Optimize document.
@@ -4555,7 +5001,7 @@ Optimize document.
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
- **options** | [**OptimizeOptions**](OptimizeOptions.md)| The optimization options. | [optional]
+ **options** | [**OptimizeOptions**](OptimizeOptions.md)| The optimization options. |
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -5247,7 +5693,7 @@ 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_sign_document**
-> AsposeResponse post_sign_document(name, signature=signature, storage=storage, folder=folder)
+> AsposeResponse post_sign_document(name, sign, storage=storage, folder=folder)
Sign document.
@@ -5256,7 +5702,7 @@ Sign document.
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
- **signature** | [**Signature**](Signature.md)| Signature object containing signature data. | [optional]
+ **sign** | [**Signature**](Signature.md)| Signature object containing signature data. |
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -5272,7 +5718,7 @@ 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_sign_page**
-> AsposeResponse post_sign_page(name, page_number, signature=signature, storage=storage, folder=folder)
+> AsposeResponse post_sign_page(name, page_number, sign, storage=storage, folder=folder)
Sign page.
@@ -5282,7 +5728,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
- **signature** | [**Signature**](Signature.md)| Signature object containing signature data. | [optional]
+ **sign** | [**Signature**](Signature.md)| Signature object containing signature data. |
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -5349,7 +5795,7 @@ 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_add_text**
-> AsposeResponse put_add_text(name, page_number, paragraph=paragraph, folder=folder, storage=storage)
+> AsposeResponse put_add_text(name, page_number, paragraph, folder=folder, storage=storage)
Add text to PDF document page.
@@ -5359,7 +5805,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| Number of page (starting from 1). |
- **paragraph** | [**Paragraph**](Paragraph.md)| Paragraph data. | [optional]
+ **paragraph** | [**Paragraph**](Paragraph.md)| Paragraph data. |
**folder** | **str**| Document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -5401,6 +5847,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_bookmark**
+> BookmarkResponse put_bookmark(name, bookmark_path, bookmark, folder=folder, storage=storage)
+
+Update document bookmark.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. |
+ **bookmark_path** | **str**| The bookmark path. |
+ **bookmark** | [**Bookmark**](Bookmark.md)| The bookmark. |
+ **folder** | **str**| The document folder. | [optional]
+ **storage** | **str**| The document storage. | [optional]
+
+### Return type
+
+[**BookmarkResponse**](BookmarkResponse.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_caret_annotation**
> CaretAnnotationResponse put_caret_annotation(name, annotation_id, annotation, storage=storage, folder=folder)
@@ -5480,19 +5952,43 @@ 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_create**
-> AsposeResponse put_create(path, file, version_id=version_id, storage=storage)
+# **put_create_document**
+> DocumentResponse put_create_document(name, storage=storage, folder=folder)
-Upload a specific file
+Create empty document.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **path** | **str**| Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext |
- **file** | **file**| File to upload |
- **version_id** | **str**| Source file's version | [optional]
- **storage** | **str**| User's storage name | [optional]
+ **name** | **str**| The new document name. |
+ **storage** | **str**| The document storage. | [optional]
+ **folder** | **str**| The new document folder. | [optional]
+
+### Return type
+
+[**DocumentResponse**](DocumentResponse.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_decrypt_document**
+> AsposeResponse put_decrypt_document(out_path, password, storage=storage, file=file)
+
+Decrypt document from content.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **out_path** | **str**| Full resulting filename (ex. /folder1/folder2/result.doc) |
+ **password** | **str**| The password (encrypted Base64). |
+ **storage** | **str**| The document storage. | [optional]
+ **file** | **file**| A file to be derypted. | [optional]
### Return type
@@ -5505,42 +6001,48 @@ 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_create_document**
-> DocumentResponse put_create_document(name, storage=storage, folder=folder)
+# **put_encrypt_document**
+> AsposeResponse put_encrypt_document(out_path, user_password, owner_password, crypto_algorithm, permissions_flags=permissions_flags, use_pdf20=use_pdf20, storage=storage, file=file)
-Create empty document.
+Encrypt document from content.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **name** | **str**| The new document name. |
+ **out_path** | **str**| Full resulting filename (ex. /folder1/folder2/result.doc) |
+ **user_password** | **str**| User password (encrypted Base64). |
+ **owner_password** | **str**| Owner password (encrypted Base64). |
+ **crypto_algorithm** | **str**| Cryptographic algorithm, see CryptoAlgorithm for details. |
+ **permissions_flags** | [**list[PermissionsFlags]**](PermissionsFlags.md)| Array of document permissions, see PermissionsFlags for details. | [optional]
+ **use_pdf20** | **bool**| Support for revision 6 (Extension 8). | [optional]
**storage** | **str**| The document storage. | [optional]
- **folder** | **str**| The new document folder. | [optional]
+ **file** | **file**| A file to be encrypted. | [optional]
### Return type
-[**DocumentResponse**](DocumentResponse.md)
+[**AsposeResponse**](AsposeResponse.md)
### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: multipart/form-data
- **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_create_folder**
-> AsposeResponse put_create_folder(path, storage=storage, dest_storage=dest_storage)
+# **put_epub_in_storage_to_pdf**
+> AsposeResponse put_epub_in_storage_to_pdf(name, src_path, storage=storage, dst_folder=dst_folder)
-Create the folder
+Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **path** | **str**| Target folder's path e.g. Folder1/Folder2/. The folders will be created recursively |
- **storage** | **str**| User's source storage name | [optional]
- **dest_storage** | **str**| User's destination storage name | [optional]
+ **name** | **str**| The document name. |
+ **src_path** | **str**| Full source filename (ex. /folder1/folder2/template.epub) |
+ **storage** | **str**| The document storage. | [optional]
+ **dst_folder** | **str**| The destination document folder. | [optional]
### Return type
@@ -5553,19 +6055,19 @@ 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_decrypt_document**
-> AsposeResponse put_decrypt_document(out_path, password, storage=storage, file=file)
+# **put_export_fields_from_pdf_to_fdf_in_storage**
+> AsposeResponse put_export_fields_from_pdf_to_fdf_in_storage(name, fdf_output_file_path, storage=storage, folder=folder)
-Decrypt document from content.
+Export fields from from PDF in storage to FDF file in storage.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **out_path** | **str**| Full resulting filename (ex. /folder1/folder2/result.doc) |
- **password** | **str**| The password (encrypted Base64). |
+ **name** | **str**| The document name. |
+ **fdf_output_file_path** | **str**| The output Fdf file path. |
**storage** | **str**| The document storage. | [optional]
- **file** | **file**| A file to be derypted. | [optional]
+ **folder** | **str**| The document folder. | [optional]
### Return type
@@ -5573,28 +6075,24 @@ Name | Type | Description | Notes
### HTTP request headers
- - **Content-Type**: multipart/form-data
+ - **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_encrypt_document**
-> AsposeResponse put_encrypt_document(out_path, user_password, owner_password, crypto_algorithm, permissions_flags=permissions_flags, use_pdf20=use_pdf20, storage=storage, file=file)
+# **put_export_fields_from_pdf_to_xfdf_in_storage**
+> AsposeResponse put_export_fields_from_pdf_to_xfdf_in_storage(name, xfdf_output_file_path, storage=storage, folder=folder)
-Encrypt document from content.
+Export fields from from PDF in storage to XFDF file in storage.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **out_path** | **str**| Full resulting filename (ex. /folder1/folder2/result.doc) |
- **user_password** | **str**| User password (encrypted Base64). |
- **owner_password** | **str**| Owner password (encrypted Base64). |
- **crypto_algorithm** | **str**| Cryptographic algorithm, see for details. |
- **permissions_flags** | [**list[PermissionsFlags]**](PermissionsFlags.md)| Array of document permissions, see for details. | [optional]
- **use_pdf20** | **bool**| Support for revision 6 (Extension 8). | [optional]
+ **name** | **str**| The document name. |
+ **xfdf_output_file_path** | **str**| The output xfdf file path. |
**storage** | **str**| The document storage. | [optional]
- **file** | **file**| A file to be encrypted. | [optional]
+ **folder** | **str**| The document folder. | [optional]
### Return type
@@ -5602,24 +6100,24 @@ Name | Type | Description | Notes
### HTTP request headers
- - **Content-Type**: multipart/form-data
+ - **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_epub_in_storage_to_pdf**
-> AsposeResponse put_epub_in_storage_to_pdf(name, src_path, storage=storage, dst_folder=dst_folder)
+# **put_export_fields_from_pdf_to_xml_in_storage**
+> AsposeResponse put_export_fields_from_pdf_to_xml_in_storage(name, xml_output_file_path, storage=storage, folder=folder)
-Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.
+Export fields from from PDF in storage to XML file in storage.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
- **src_path** | **str**| Full source filename (ex. /folder1/folder2/template.epub) |
+ **xml_output_file_path** | **str**| The output xml file path. |
**storage** | **str**| The document storage. | [optional]
- **dst_folder** | **str**| The destination document folder. | [optional]
+ **folder** | **str**| The document folder. | [optional]
### Return type
@@ -5804,8 +6302,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**image_id** | **str**| Image ID. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
**dest_folder** | **str**| The document folder. | [optional]
@@ -5832,8 +6330,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**image_id** | **str**| Image ID. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
**dest_folder** | **str**| The document folder. | [optional]
@@ -5860,8 +6358,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**image_id** | **str**| Image ID. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
**dest_folder** | **str**| The document folder. | [optional]
@@ -5888,8 +6386,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**image_id** | **str**| Image ID. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
**dest_folder** | **str**| The document folder. | [optional]
@@ -5915,7 +6413,7 @@ Convert image file (located on storage) to PDF format and upload resulting file
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
- **image_templates** | [**ImageTemplatesRequest**](ImageTemplatesRequest.md)| Image templates |
+ **image_templates** | [**ImageTemplatesRequest**](ImageTemplatesRequest.md)| ImageTemplatesRequestImage templates |
**dst_folder** | **str**| The destination document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -5941,8 +6439,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
**dest_folder** | **str**| The document folder. | [optional]
@@ -5969,9 +6467,9 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
- **storage** | **str**| | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
+ **storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
**dest_folder** | **str**| The document folder. | [optional]
@@ -5997,8 +6495,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
**dest_folder** | **str**| The document folder. | [optional]
@@ -6025,8 +6523,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
**dest_folder** | **str**| The document folder. | [optional]
@@ -6042,6 +6540,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)
+# **put_import_fields_from_fdf_in_storage**
+> AsposeResponse put_import_fields_from_fdf_in_storage(name, fdf_file_path, storage=storage, folder=folder)
+
+Update fields from FDF file in storage.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. |
+ **fdf_file_path** | **str**| The Fdf 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_import_fields_from_xfdf_in_storage**
+> AsposeResponse put_import_fields_from_xfdf_in_storage(name, xfdf_file_path, storage=storage, folder=folder)
+
+Update fields from XFDF file in storage.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. |
+ **xfdf_file_path** | **str**| The XFDF 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_import_fields_from_xml_in_storage**
+> AsposeResponse put_import_fields_from_xml_in_storage(name, xml_file_path, storage=storage, folder=folder)
+
+Update fields from XML file in storage.
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **str**| The document name. |
+ **xml_file_path** | **str**| Full source filename (ex. /folder1/folder2/template.xml) |
+ **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_ink_annotation**
> InkAnnotationResponse put_ink_annotation(name, annotation_id, annotation, storage=storage, folder=folder)
@@ -6146,7 +6719,7 @@ 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_merge_documents**
-> DocumentResponse put_merge_documents(name, merge_documents=merge_documents, storage=storage, folder=folder)
+> DocumentResponse put_merge_documents(name, merge_documents, storage=storage, folder=folder)
Merge a list of documents.
@@ -6155,7 +6728,7 @@ Merge a list of documents.
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| Resulting documen name. |
- **merge_documents** | [**MergeDocuments**](MergeDocuments.md)| with a list of documents. | [optional]
+ **merge_documents** | [**MergeDocuments**](MergeDocuments.md)| MergeDocuments with a list of documents. |
**storage** | **str**| Resulting document storage. | [optional]
**folder** | **str**| Resulting document folder. | [optional]
@@ -6232,7 +6805,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
- **stamp** | [**Stamp**](Stamp.md)| with data. |
+ **stamp** | [**Stamp**](Stamp.md)| Stamp with data. |
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -6259,8 +6832,8 @@ Name | Type | Description | Notes
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
**out_path** | **str**| The out path of result image. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -6287,8 +6860,8 @@ Name | Type | Description | Notes
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
**out_path** | **str**| The out path of result image. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -6315,8 +6888,8 @@ Name | Type | Description | Notes
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
**out_path** | **str**| The out path of result image. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -6343,8 +6916,8 @@ Name | Type | Description | Notes
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
**out_path** | **str**| The out path of result image. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -6371,8 +6944,8 @@ Name | Type | Description | Notes
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
**out_path** | **str**| The out path of result image. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -6399,8 +6972,8 @@ Name | Type | Description | Notes
**name** | **str**| The document name. |
**page_number** | **int**| The page number. |
**out_path** | **str**| The out path of result image. |
- **width** | **int**| The converted image width. | [optional]
- **height** | **int**| The converted image height. | [optional]
+ **width** | **int**| The converted image width. | [optional] [default to 0]
+ **height** | **int**| The converted image height. | [optional] [default to 0]
**folder** | **str**| The document folder. | [optional]
**storage** | **str**| The document storage. | [optional]
@@ -7284,7 +7857,7 @@ 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_privileges**
-> AsposeResponse put_privileges(name, privileges=privileges, storage=storage, folder=folder)
+> AsposeResponse put_privileges(name, privileges, storage=storage, folder=folder)
Update privilege document.
@@ -7293,7 +7866,7 @@ Update privilege document.
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
- **privileges** | [**DocumentPrivilege**](DocumentPrivilege.md)| Document privileges. | [optional]
+ **privileges** | [**DocumentPrivilege**](DocumentPrivilege.md)| Document privileges. DocumentPrivilege |
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -7783,7 +8356,7 @@ 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_update_field**
-> FieldResponse put_update_field(name, field_name, field=field, storage=storage, folder=folder)
+> FieldResponse put_update_field(name, field_name, field, storage=storage, folder=folder)
Update field.
@@ -7793,7 +8366,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
**field_name** | **str**| The name of a field to be updated. |
- **field** | [**Field**](Field.md)| with the field data. | [optional]
+ **field** | [**Field**](Field.md)| Field with the field data. |
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -7809,7 +8382,7 @@ 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_update_fields**
-> FieldsResponse put_update_fields(name, fields=fields, storage=storage, folder=folder)
+> FieldsResponse put_update_fields(name, fields, storage=storage, folder=folder)
Update fields.
@@ -7818,7 +8391,7 @@ Update fields.
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **str**| The document name. |
- **fields** | [**Fields**](Fields.md)| with the fields data. | [optional]
+ **fields** | [**Fields**](Fields.md)| Fields with the fields data. |
**storage** | **str**| The document storage. | [optional]
**folder** | **str**| The document folder. | [optional]
@@ -7990,3 +8563,49 @@ 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)
+# **storage_exists**
+> StorageExist storage_exists(storage_name)
+
+Check if storage exists
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **storage_name** | **str**| Storage name |
+
+### Return type
+
+[**StorageExist**](StorageExist.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)
+
+# **upload_file**
+> FilesUploadResult upload_file(path, file, storage_name=storage_name)
+
+Upload file
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **str**| Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. |
+ **file** | **file**| File to upload |
+ **storage_name** | **str**| Storage name | [optional]
+
+### Return type
+
+[**FilesUploadResult**](FilesUploadResult.md)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **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)
+
diff --git a/docs/PdfPageStamp.md b/docs/PdfPageStamp.md
index 2523c5d..0cbb887 100644
--- a/docs/PdfPageStamp.md
+++ b/docs/PdfPageStamp.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**background** | **bool** | Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. | [optional]
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
**opacity** | **float** | Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. | [optional]
-**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
+**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
**rotate_angle** | **float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
**x_indent** | **float** | Horizontal stamp coordinate, starting from the left. | [optional]
**y_indent** | **float** | Vertical stamp coordinate, starting from the bottom. | [optional]
diff --git a/docs/PolyAnnotation.md b/docs/PolyAnnotation.md
index 35d4dbc..09d2764 100644
--- a/docs/PolyAnnotation.md
+++ b/docs/PolyAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
**starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of first line ending. | [optional]
**ending_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of second line ending. | [optional]
**intent** | [**PolyIntent**](PolyIntent.md) | Gets or sets the intent of the polygon or polyline annotation. | [optional]
-**vertices** | [**list[Point]**](Point.md) | Gets or sets an array of points representing the horizontal and vertical coordinates of each vertex. | [optional]
+**vertices** | [**list[Point]**](Point.md) | Gets or sets an array of points representing the horizontal and vertical coordinates of each vertex. |
[[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/PolyLineAnnotation.md b/docs/PolyLineAnnotation.md
index 1652090..9a0caed 100644
--- a/docs/PolyLineAnnotation.md
+++ b/docs/PolyLineAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
**starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of first line ending. | [optional]
**ending_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of second line ending. | [optional]
**intent** | [**PolyIntent**](PolyIntent.md) | Gets or sets the intent of the polygon or polyline annotation. | [optional]
-**vertices** | [**list[Point]**](Point.md) | Gets or sets an array of points representing the horizontal and vertical coordinates of each vertex. | [optional]
+**vertices** | [**list[Point]**](Point.md) | Gets or sets an array of points representing the horizontal and vertical coordinates of each vertex. |
[[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/PolygonAnnotation.md b/docs/PolygonAnnotation.md
index 72b53be..56d3576 100644
--- a/docs/PolygonAnnotation.md
+++ b/docs/PolygonAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
**starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of first line ending. | [optional]
**ending_style** | [**LineEnding**](LineEnding.md) | Gets or sets the style of second line ending. | [optional]
**intent** | [**PolyIntent**](PolyIntent.md) | Gets or sets the intent of the polygon or polyline annotation. | [optional]
-**vertices** | [**list[Point]**](Point.md) | Gets or sets an array of points representing the horizontal and vertical coordinates of each vertex. | [optional]
+**vertices** | [**list[Point]**](Point.md) | Gets or sets an array of points representing the horizontal and vertical coordinates of each vertex. |
[[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/PopupAnnotation.md b/docs/PopupAnnotation.md
index 03b0b27..c2c1c18 100644
--- a/docs/PopupAnnotation.md
+++ b/docs/PopupAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/PopupAnnotationWithParent.md b/docs/PopupAnnotationWithParent.md
index cc65fe4..6ca3dd9 100644
--- a/docs/PopupAnnotationWithParent.md
+++ b/docs/PopupAnnotationWithParent.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/RedactionAnnotation.md b/docs/RedactionAnnotation.md
index 2530cff..15fd1e6 100644
--- a/docs/RedactionAnnotation.md
+++ b/docs/RedactionAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/ScreenAnnotation.md b/docs/ScreenAnnotation.md
index 8a4b99b..e7d895d 100644
--- a/docs/ScreenAnnotation.md
+++ b/docs/ScreenAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/Signature.md b/docs/Signature.md
index d03a550..bed8176 100644
--- a/docs/Signature.md
+++ b/docs/Signature.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**reason** | **str** | Gets or sets the reason of the signature. | [optional]
**contact** | **str** | Gets or sets the contact of the signature. | [optional]
**location** | **str** | Gets or sets the location of the signature. | [optional]
-**visible** | **bool** | Gets or sets a value indicating whether this is visible. Supports only when signing particular page. |
+**visible** | **bool** | Gets or sets a value indicating whether this Signature is visible. Supports only when signing particular page. |
**rectangle** | [**Rectangle**](Rectangle.md) | Gets or sets the visible rectangle of the signature. Supports only when signing particular page. | [optional]
**form_field_name** | **str** | Gets or sets the name of the signature field. Supports only when signing document with particular form field. | [optional]
**authority** | **str** | Gets or sets the name of the person or authority signing the document.. | [optional]
diff --git a/docs/SignatureVerifyResponse.md b/docs/SignatureVerifyResponse.md
index 2014743..9a3cb4c 100644
--- a/docs/SignatureVerifyResponse.md
+++ b/docs/SignatureVerifyResponse.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | Response status code. |
**status** | **str** | Response status. | [optional]
-**valid** | **bool** | True if signature is valid and false if not | [optional]
+**valid** | **bool** | True if signature is valid and false if not |
[[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
index 9d55a3d..384a8e5 100644
--- a/docs/SoundAnnotation.md
+++ b/docs/SoundAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**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]
+**file_path** | **str** | A sound file path defining the sound to be played when the annotation is activated. |
**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]
diff --git a/docs/SplitResultDocument.md b/docs/SplitResultDocument.md
index 8a4815b..5143533 100644
--- a/docs/SplitResultDocument.md
+++ b/docs/SplitResultDocument.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**rel** | **str** | atom:link elements MAY have a "rel" attribute that indicates the link relation type. If the "rel" attribute is not present, the link element MUST be interpreted as if the link relation type is "alternate". | [optional]
**type** | **str** | On the link element, the "type" attribute's value is an advisory media type: it is a hint about the type of the representation that is expected to be returned when the value of the href attribute is dereferenced. Note that the type attribute does not override the actual media type returned with the representation. | [optional]
**title** | **str** | The "title" attribute conveys human-readable information about the link. The content of the "title" attribute is Language-Sensitive. | [optional]
-**id** | **int** | Gets or sets the page number. | [optional]
+**id** | **int** | Gets or sets the page number. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SquareAnnotation.md b/docs/SquareAnnotation.md
index c54de2b..e39dbaf 100644
--- a/docs/SquareAnnotation.md
+++ b/docs/SquareAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/SquigglyAnnotation.md b/docs/SquigglyAnnotation.md
index 9be8e90..2167085 100644
--- a/docs/SquigglyAnnotation.md
+++ b/docs/SquigglyAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/Stamp.md b/docs/Stamp.md
index 8f9e718..d8d733f 100644
--- a/docs/Stamp.md
+++ b/docs/Stamp.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**left_margin** | **float** | Gets or sets left margin of stamp. | [optional]
**opacity** | **float** | Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. | [optional]
**right_margin** | **float** | Gets or sets right margin of stamp. | [optional]
-**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
+**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
**rotate_angle** | **float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
**top_margin** | **float** | Gets or sets top margin of stamp. | [optional]
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets or sets vertical alignment of stamp on page. | [optional]
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**zoom** | **float** | Zooming factor of the stamp. Allows to scale stamp. | [optional]
**text_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Alignment of the text inside the stamp. | [optional]
**value** | **str** | Gets or sets string value which is used as stamp on the page. | [optional]
-**text_state** | [**TextState**](TextState.md) | Gets text properties of the stamp. See for details. | [optional]
+**text_state** | [**TextState**](TextState.md) | Gets text properties of the stamp. See TextState for details. | [optional]
**file_name** | **str** | Gets or sets the file name. | [optional]
**width** | **float** | Gets or sets image width. Setting this property allos to scal image horizontally. | [optional]
**height** | **float** | Gets or sets image height. Setting this image allows to scale image vertically. | [optional]
diff --git a/docs/StampAnnotation.md b/docs/StampAnnotation.md
index b225138..433a983 100644
--- a/docs/StampAnnotation.md
+++ b/docs/StampAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/StampBase.md b/docs/StampBase.md
index 72e5a25..fe8fbde 100644
--- a/docs/StampBase.md
+++ b/docs/StampBase.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**background** | **bool** | Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. | [optional]
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
**opacity** | **float** | Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. | [optional]
-**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
+**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
**rotate_angle** | **float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
**x_indent** | **float** | Horizontal stamp coordinate, starting from the left. | [optional]
**y_indent** | **float** | Vertical stamp coordinate, starting from the bottom. | [optional]
diff --git a/docs/StampInfo.md b/docs/StampInfo.md
index 7683376..1afebce 100644
--- a/docs/StampInfo.md
+++ b/docs/StampInfo.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. | [optional]
**text** | **str** | Get the text content. | [optional]
**visible** | **bool** | Gets the stamp is visible. | [optional]
-**stamp_type** | [**StampType**](StampType.md) | Gets stamp type. | [optional]
+**stamp_type** | [**StampType**](StampType.md) | Gets stamp type. |
[[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/StorageExist.md b/docs/StorageExist.md
new file mode 100644
index 0000000..226b5b3
--- /dev/null
+++ b/docs/StorageExist.md
@@ -0,0 +1,11 @@
+# StorageExist
+Storage exists
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exists** | **bool** | Shows that the storage exists. |
+
+[[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/StorageFile.md b/docs/StorageFile.md
new file mode 100644
index 0000000..cb944a1
--- /dev/null
+++ b/docs/StorageFile.md
@@ -0,0 +1,15 @@
+# StorageFile
+File or folder information
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | File or folder name. | [optional]
+**is_folder** | **bool** | True if it is a folder. |
+**modified_date** | **datetime** | File or folder last modified DateTime. | [optional]
+**size** | **int** | File or folder size. |
+**path** | **str** | File or folder 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/StrikeOutAnnotation.md b/docs/StrikeOutAnnotation.md
index 5e24798..4b41f18 100644
--- a/docs/StrikeOutAnnotation.md
+++ b/docs/StrikeOutAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/Table.md b/docs/Table.md
index 15d96e2..b64526f 100644
--- a/docs/Table.md
+++ b/docs/Table.md
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
**default_cell_text_state** | [**TextState**](TextState.md) | Gets or sets the default cell text state. | [optional]
**default_cell_padding** | [**MarginInfo**](MarginInfo.md) | Gets or sets the default cell padding. | [optional]
**border** | [**BorderInfo**](BorderInfo.md) | Gets or sets the border. | [optional]
-**rows** | [**list[Row]**](Row.md) | Sets the rows of the table. | [optional]
+**rows** | [**list[Row]**](Row.md) | Sets the rows of the table. |
**default_column_width** | **str** | Gets default cell border; | [optional]
**default_cell_border** | [**BorderInfo**](BorderInfo.md) | Gets default cell border; | [optional]
**broken** | [**TableBroken**](TableBroken.md) | Gets or sets table vertial broken; | [optional]
diff --git a/docs/TextAnnotation.md b/docs/TextAnnotation.md
index e31a62c..af19c2b 100644
--- a/docs/TextAnnotation.md
+++ b/docs/TextAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/TextFooter.md b/docs/TextFooter.md
index 67518a5..6db8152 100644
--- a/docs/TextFooter.md
+++ b/docs/TextFooter.md
@@ -8,14 +8,14 @@ Name | Type | Description | Notes
**background** | **bool** | Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. | [optional]
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
**opacity** | **float** | Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. | [optional]
-**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
+**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
**rotate_angle** | **float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
**x_indent** | **float** | Horizontal stamp coordinate, starting from the left. | [optional]
**y_indent** | **float** | Vertical stamp coordinate, starting from the bottom. | [optional]
**zoom** | **float** | Zooming factor of the stamp. Allows to scale stamp. | [optional]
**text_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Alignment of the text inside the stamp. | [optional]
**value** | **str** | Gets or sets string value which is used as stamp on the page. | [optional]
-**text_state** | [**TextState**](TextState.md) | Gets text properties of the stamp. See for details. | [optional]
+**text_state** | [**TextState**](TextState.md) | Gets text properties of the stamp. See TextState for details. | [optional]
**bottom_margin** | **float** | Gets or sets bottom margin of stamp. | [optional]
**left_margin** | **float** | Gets or sets left margin of stamp. | [optional]
**right_margin** | **float** | Gets or sets right margin of stamp. | [optional]
diff --git a/docs/TextHeader.md b/docs/TextHeader.md
index fa05f7d..df70f3f 100644
--- a/docs/TextHeader.md
+++ b/docs/TextHeader.md
@@ -8,14 +8,14 @@ Name | Type | Description | Notes
**background** | **bool** | Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. | [optional]
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
**opacity** | **float** | Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. | [optional]
-**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
+**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
**rotate_angle** | **float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
**x_indent** | **float** | Horizontal stamp coordinate, starting from the left. | [optional]
**y_indent** | **float** | Vertical stamp coordinate, starting from the bottom. | [optional]
**zoom** | **float** | Zooming factor of the stamp. Allows to scale stamp. | [optional]
**text_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Alignment of the text inside the stamp. | [optional]
**value** | **str** | Gets or sets string value which is used as stamp on the page. | [optional]
-**text_state** | [**TextState**](TextState.md) | Gets text properties of the stamp. See for details. | [optional]
+**text_state** | [**TextState**](TextState.md) | Gets text properties of the stamp. See TextState for details. | [optional]
**left_margin** | **float** | Gets or sets left margin of stamp. | [optional]
**top_margin** | **float** | Gets or sets top margin of stamp. | [optional]
**right_margin** | **float** | Gets or sets right margin of stamp. | [optional]
diff --git a/docs/TextRect.md b/docs/TextRect.md
index 354617a..693e305 100644
--- a/docs/TextRect.md
+++ b/docs/TextRect.md
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
**rect** | [**Rectangle**](Rectangle.md) | Rectangle of the occurrence. | [optional]
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets a horizontal alignment of text fragment. | [optional]
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets or sets a vertical alignment of text fragment. | [optional]
-**position** | [**Position**](Position.md) | Gets or sets text position for text, represented with object. | [optional]
-**baseline_position** | [**Position**](Position.md) | Gets text position for text, represented with object. The YIndent of the Position structure represents baseline coordinate of the text fragment. | [optional]
-**text_state** | [**TextState**](TextState.md) | Gets or sets text state for the text that object represents. | [optional]
+**position** | [**Position**](Position.md) | Gets or sets text position for text, represented with TextRect object. | [optional]
+**baseline_position** | [**Position**](Position.md) | Gets text position for text, represented with TextRect object. The YIndent of the Position structure represents baseline coordinate of the text fragment. | [optional]
+**text_state** | [**TextState**](TextState.md) | Gets or sets text state for the text that TextRect object represents. | [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/TextReplaceListRequest.md b/docs/TextReplaceListRequest.md
index 2054a34..9b66687 100644
--- a/docs/TextReplaceListRequest.md
+++ b/docs/TextReplaceListRequest.md
@@ -5,7 +5,7 @@ Multiple text replacements request.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**text_replaces** | [**list[TextReplace]**](TextReplace.md) | A list of text replacement settings. |
-**default_font** | **str** | | [optional]
+**default_font** | **str** | Name of font to use if requested font is not embedded into document. | [optional]
**start_index** | **int** | The index of first match to be replaced. | [optional]
**count_replace** | **int** | The number of matches to be replaced. | [optional]
diff --git a/docs/TextReplaceResponse.md b/docs/TextReplaceResponse.md
index 6677021..322e3e9 100644
--- a/docs/TextReplaceResponse.md
+++ b/docs/TextReplaceResponse.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | Response status code. |
**status** | **str** | Response status. | [optional]
-**matches** | **int** | Number of matches | [optional]
+**matches** | **int** | Number of matches |
[[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/TextStamp.md b/docs/TextStamp.md
index 6ad7809..7f90977 100644
--- a/docs/TextStamp.md
+++ b/docs/TextStamp.md
@@ -8,14 +8,14 @@ Name | Type | Description | Notes
**background** | **bool** | Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. | [optional]
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
**opacity** | **float** | Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. | [optional]
-**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
+**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. | [optional]
**rotate_angle** | **float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
**x_indent** | **float** | Horizontal stamp coordinate, starting from the left. | [optional]
**y_indent** | **float** | Vertical stamp coordinate, starting from the bottom. | [optional]
**zoom** | **float** | Zooming factor of the stamp. Allows to scale stamp. | [optional]
**text_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Alignment of the text inside the stamp. | [optional]
**value** | **str** | Gets or sets string value which is used as stamp on the page. | [optional]
-**text_state** | [**TextState**](TextState.md) | Gets text properties of the stamp. See for details. | [optional]
+**text_state** | [**TextState**](TextState.md) | Gets text properties of the stamp. See TextState for details. | [optional]
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets or sets vertical alignment of stamp on page. | [optional]
**bottom_margin** | **float** | Gets or sets bottom margin of stamp. | [optional]
**left_margin** | **float** | Gets or sets left margin of stamp. | [optional]
diff --git a/docs/UnderlineAnnotation.md b/docs/UnderlineAnnotation.md
index db802ac..ab5d827 100644
--- a/docs/UnderlineAnnotation.md
+++ b/docs/UnderlineAnnotation.md
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
+**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
**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]
diff --git a/docs/WordCountResponse.md b/docs/WordCountResponse.md
index 6aefc75..abf1959 100644
--- a/docs/WordCountResponse.md
+++ b/docs/WordCountResponse.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | Response status code. |
**status** | **str** | Response status. | [optional]
-**words_per_page** | [**WordCount**](WordCount.md) | with words per page info. | [optional]
+**words_per_page** | [**WordCount**](WordCount.md) | WordCount with words per page info. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/setup.py b/setup.py
index 46887bf..7ab8ce3 100644
--- a/setup.py
+++ b/setup.py
@@ -23,7 +23,7 @@
- OpenAPI spec version: 2.0
+ OpenAPI spec version: 3.0
"""
@@ -32,7 +32,7 @@
from setuptools import setup, find_packages
NAME = "asposepdfcloud"
-VERSION = "19.5.0"
+VERSION = "19.7.0"
# To install the library, run the following
#
# python setup.py install
diff --git a/test/pdf_tests.py b/test/pdf_tests.py
index 9e90062..e1589d9 100644
--- a/test/pdf_tests.py
+++ b/test/pdf_tests.py
@@ -63,7 +63,7 @@ def setUp(self):
def uploadFile(self, name):
- self.pdf_api.put_create(self.temp_folder + '/' + name, self.test_data_path + name)
+ self.pdf_api.upload_file(self.temp_folder + '/' + name, self.test_data_path + name)
def tearDown(self):
pass
@@ -165,9 +165,8 @@ def testPostPageFileAttachmentAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.FileAttachmentAnnotation()
+ annotation = asposepdfcloud.models.FileAttachmentAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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'
@@ -179,7 +178,7 @@ def testPostPageFileAttachmentAnnotations(self):
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)
+ self.assertEqual(response.code, 200)
def testPutFileAttachmentAnnotation(self):
@@ -189,9 +188,8 @@ def testPutFileAttachmentAnnotation(self):
attachment_file = '4pages.pdf'
self.uploadFile(attachment_file)
- annotation = asposepdfcloud.models.FileAttachmentAnnotation()
+ annotation = asposepdfcloud.models.FileAttachmentAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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'
@@ -207,7 +205,7 @@ def testPutFileAttachmentAnnotation(self):
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)
+ self.assertEqual(response.code, 200)
def testGetFileAttachmentAnnotationData(self):
file_name = 'PdfWithAnnotations.pdf'
@@ -229,7 +227,7 @@ def testPutFileAttachmentAnnotationDataExtract(self):
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)
+ self.assertEqual(response.code, 200)
# Stamp Tests
@@ -290,7 +288,7 @@ def testPostPageTextStamps(self):
stamp.text_state = text_state
response = self.pdf_api.post_page_text_stamps(file_name, page_number, [stamp], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPostPageImageStamps(self):
file_name = 'PageNumberStamp.pdf'
@@ -318,7 +316,7 @@ def testPostPageImageStamps(self):
stamp.file_name = self.temp_folder + '/' + image
response = self.pdf_api.post_page_image_stamps(file_name, page_number, [stamp], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPostPagePdfPageStamps(self):
file_name = 'PageNumberStamp.pdf'
@@ -347,7 +345,7 @@ def testPostPagePdfPageStamps(self):
stamp.page_index = 2
response = self.pdf_api.post_page_pdf_page_stamps(file_name, page_number, [stamp], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testDeleteStamp(self):
file_name = 'PageNumberStamp.pdf'
@@ -382,7 +380,7 @@ def testPostDocumentPageNumberStamps(self):
stamp.value = 'Page #'
response = self.pdf_api.post_document_page_number_stamps(name, stamp, start_page_number=2, end_page_number=3, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Header Footer Tests
@@ -420,7 +418,7 @@ def testPostDocumentTextHeader(self):
end_page_number = 3
response = self.pdf_api.post_document_text_header(file_name, header, start_page_number=start_page_number, end_page_number=end_page_number, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPostDocumentTextFooter(self):
file_name = '4pages.pdf'
@@ -456,7 +454,7 @@ def testPostDocumentTextFooter(self):
end_page_number = 3
response = self.pdf_api.post_document_text_footer(file_name, footer, start_page_number=start_page_number, end_page_number=end_page_number, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPostDocumentImageHeader(self):
file_name = '4pages.pdf'
@@ -483,7 +481,7 @@ def testPostDocumentImageHeader(self):
end_page_number = 3
response = self.pdf_api.post_document_image_header(file_name, header, start_page_number=start_page_number, end_page_number=end_page_number, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPostDocumentImageFooter(self):
file_name = '4pages.pdf'
@@ -510,7 +508,7 @@ def testPostDocumentImageFooter(self):
end_page_number = 3
response = self.pdf_api.post_document_image_footer(file_name, footer, start_page_number=start_page_number, end_page_number=end_page_number, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Tables Tests
@@ -576,7 +574,7 @@ def testPostPageTables(self):
table = self.__drawTable()
response = self.pdf_api.post_page_tables(file_name, page_number, [table], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutTable(self):
file_name = 'PdfWithTable.pdf'
@@ -589,7 +587,7 @@ def testPutTable(self):
table = self.__drawTable()
response = self.pdf_api.put_table(file_name, table_id, table, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def __drawTable(self):
@@ -604,8 +602,7 @@ def __drawTable(self):
num_of_cols = 5
num_of_rows = 5
- table = asposepdfcloud.models.Table()
- table.rows = []
+ table = asposepdfcloud.models.Table(rows = [])
col_widths = ''
for _ in range(num_of_cols):
@@ -704,9 +701,8 @@ def testPostPageStampAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.StampAnnotation()
+ annotation = asposepdfcloud.models.StampAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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'
@@ -717,7 +713,7 @@ def testPostPageStampAnnotations(self):
annotation.file_path = self.temp_folder + '/' + attachment_file
response = self.pdf_api.post_page_stamp_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutStampAnnotation(self):
@@ -727,9 +723,8 @@ def testPutStampAnnotation(self):
attachment_file = '4pages.pdf'
self.uploadFile(attachment_file)
- annotation = asposepdfcloud.models.StampAnnotation()
+ annotation = asposepdfcloud.models.StampAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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'
@@ -744,7 +739,7 @@ def testPutStampAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_stamp_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testGetStampAnnotationData(self):
file_name = 'PdfWithAnnotations.pdf'
@@ -766,7 +761,7 @@ def testPutStampAnnotationDataExtract(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_stamp_annotation_data_extract(file_name, annotation_id, out_file_path='stamp.dat', folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Screen Annotations Tests
@@ -807,9 +802,8 @@ def testPostPageScreenAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.ScreenAnnotation()
+ annotation = asposepdfcloud.models.ScreenAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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
@@ -818,7 +812,7 @@ def testPostPageScreenAnnotations(self):
annotation.file_path = self.temp_folder + '/' + attachment_file
response = self.pdf_api.post_page_screen_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutScreenAnnotation(self):
@@ -828,9 +822,8 @@ def testPutScreenAnnotation(self):
attachment_file = 'ScreenMovie.swf'
self.uploadFile(attachment_file)
- annotation = asposepdfcloud.models.ScreenAnnotation()
+ annotation = asposepdfcloud.models.ScreenAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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
@@ -843,7 +836,7 @@ def testPutScreenAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_screen_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testGetScreenAnnotationData(self):
file_name = 'PdfWithScreenAnnotations.pdf'
@@ -866,7 +859,7 @@ def testPutScreenAnnotationDataExtract(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_screen_annotation_data_extract(file_name, annotation_id, out_file_path, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Sound Annotations Tests
@@ -907,9 +900,8 @@ def testPostPageSoundAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.SoundAnnotation()
+ annotation = asposepdfcloud.models.SoundAnnotation(rect=asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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'
@@ -920,7 +912,7 @@ def testPostPageSoundAnnotations(self):
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)
+ self.assertEqual(response.code, 200)
def testPutSoundAnnotation(self):
@@ -930,9 +922,8 @@ def testPutSoundAnnotation(self):
attachment_file = '4pages.pdf'
self.uploadFile(attachment_file)
- annotation = asposepdfcloud.models.SoundAnnotation()
+ annotation = asposepdfcloud.models.SoundAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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'
@@ -947,7 +938,7 @@ def testPutSoundAnnotation(self):
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)
+ self.assertEqual(response.code, 200)
def testGetSoundAnnotationData(self):
file_name = 'PdfWithAnnotations.pdf'
@@ -969,7 +960,7 @@ def testPutSoundAnnotationDataExtract(self):
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)
+ self.assertEqual(response.code, 200)
# Redaction Annotations Tests
@@ -1007,9 +998,8 @@ def testPostPageRedactionAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.RedactionAnnotation()
+ annotation = asposepdfcloud.models.RedactionAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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
@@ -1020,7 +1010,7 @@ def testPostPageRedactionAnnotations(self):
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)
+ self.assertEqual(response.code, 200)
def testPutRedactionAnnotation(self):
@@ -1029,9 +1019,8 @@ def testPutRedactionAnnotation(self):
page_number = 1
- annotation = asposepdfcloud.models.RedactionAnnotation()
+ annotation = asposepdfcloud.models.RedactionAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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
@@ -1042,14 +1031,14 @@ def testPutRedactionAnnotation(self):
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)
+ self.assertEqual(response.code, 200)
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)
+ self.assertEqual(response.code, 200)
# Movie Annotations Tests
@@ -1090,9 +1079,8 @@ def testPostPageMovieAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.MovieAnnotation()
+ annotation = asposepdfcloud.models.MovieAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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
@@ -1100,7 +1088,7 @@ def testPostPageMovieAnnotations(self):
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)
+ self.assertEqual(response.code, 200)
def testPutMovieAnnotation(self):
@@ -1110,9 +1098,8 @@ def testPutMovieAnnotation(self):
attachment_file = '4pages.pdf'
self.uploadFile(attachment_file)
- annotation = asposepdfcloud.models.MovieAnnotation()
+ annotation = asposepdfcloud.models.MovieAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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
@@ -1124,7 +1111,7 @@ def testPutMovieAnnotation(self):
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)
+ self.assertEqual(response.code, 200)
# PolyLine Annotations Tests
@@ -1160,53 +1147,50 @@ def testPostPagePolyLineAnnotations(self):
self.uploadFile(file_name)
page_number = 1
-
- annotation = asposepdfcloud.models.PolyLineAnnotation()
+ vertices = [
+ asposepdfcloud.models.Point(10, 10),
+ asposepdfcloud.models.Point(20, 10),
+ asposepdfcloud.models.Point(10, 20),
+ asposepdfcloud.models.Point(10, 10)
+ ]
+ annotation = asposepdfcloud.models.PolyLineAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200), vertices = vertices)
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.vertices = [
- asposepdfcloud.models.Point(10, 10),
- asposepdfcloud.models.Point(20, 10),
- asposepdfcloud.models.Point(10, 20),
- asposepdfcloud.models.Point(10, 10)
- ]
+
response = self.pdf_api.post_page_poly_line_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPolyLineAnnotation(self):
file_name = 'PdfWithAnnotations.pdf'
self.uploadFile(file_name)
+ vertices = [
+ asposepdfcloud.models.Point(10, 10),
+ asposepdfcloud.models.Point(20, 10),
+ asposepdfcloud.models.Point(10, 20),
+ asposepdfcloud.models.Point(10, 10)
+ ]
-
- annotation = asposepdfcloud.models.PolyLineAnnotation()
+ annotation = asposepdfcloud.models.PolyLineAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200), vertices = vertices)
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.rich_text = 'Rich Text Updated'
annotation.subject = 'Subj Updated'
annotation.z_index = 1
annotation.title = 'Title Updated'
- annotation.vertices = [
- asposepdfcloud.models.Point(10, 10),
- asposepdfcloud.models.Point(20, 10),
- asposepdfcloud.models.Point(10, 20),
- asposepdfcloud.models.Point(10, 10)
- ]
response_annotations = self.pdf_api.get_document_poly_line_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_poly_line_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Polygon Annotations Tests
@@ -1242,10 +1226,14 @@ def testPostPagePolygonAnnotations(self):
self.uploadFile(file_name)
page_number = 1
-
- annotation = asposepdfcloud.models.PolygonAnnotation()
+ vertices = [
+ asposepdfcloud.models.Point(10, 10),
+ asposepdfcloud.models.Point(20, 10),
+ asposepdfcloud.models.Point(10, 20),
+ asposepdfcloud.models.Point(10, 10)
+ ]
+ annotation = asposepdfcloud.models.PolygonAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200), vertices = vertices)
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'
@@ -1260,35 +1248,34 @@ def testPostPagePolygonAnnotations(self):
]
response = self.pdf_api.post_page_polygon_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPolygonAnnotation(self):
file_name = 'PdfWithAnnotations.pdf'
self.uploadFile(file_name)
+
+ vertices = [
+ asposepdfcloud.models.Point(10, 10),
+ asposepdfcloud.models.Point(20, 10),
+ asposepdfcloud.models.Point(10, 20),
+ asposepdfcloud.models.Point(10, 10)
+ ]
-
- annotation = asposepdfcloud.models.PolygonAnnotation()
+ annotation = asposepdfcloud.models.PolygonAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200), vertices = vertices)
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.rich_text = 'Rich Text Updated'
annotation.subject = 'Subj Updated'
annotation.z_index = 1
annotation.title = 'Title Updated'
- annotation.vertices = [
- asposepdfcloud.models.Point(10, 10),
- asposepdfcloud.models.Point(20, 10),
- asposepdfcloud.models.Point(10, 20),
- asposepdfcloud.models.Point(10, 10)
- ]
response_annotations = self.pdf_api.get_document_polygon_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_polygon_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Circle Annotations Tests
@@ -1325,9 +1312,8 @@ def testPostPageCircleAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.CircleAnnotation()
+ annotation = asposepdfcloud.models.CircleAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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'
@@ -1336,7 +1322,7 @@ def testPostPageCircleAnnotations(self):
annotation.title = 'Title'
response = self.pdf_api.post_page_circle_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutCircleAnnotation(self):
@@ -1344,9 +1330,8 @@ def testPutCircleAnnotation(self):
self.uploadFile(file_name)
- annotation = asposepdfcloud.models.CircleAnnotation()
+ annotation = asposepdfcloud.models.CircleAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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.rich_text = 'Rich Text Updated'
@@ -1359,7 +1344,7 @@ def testPutCircleAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_circle_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Square Annotations Tests
@@ -1396,9 +1381,8 @@ def testPostPageSquareAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.SquareAnnotation()
+ annotation = asposepdfcloud.models.SquareAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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'
@@ -1407,7 +1391,7 @@ def testPostPageSquareAnnotations(self):
annotation.title = 'Title'
response = self.pdf_api.post_page_square_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutSquareAnnotation(self):
@@ -1415,9 +1399,8 @@ def testPutSquareAnnotation(self):
self.uploadFile(file_name)
- annotation = asposepdfcloud.models.SquareAnnotation()
+ annotation = asposepdfcloud.models.SquareAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
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.rich_text = 'Rich Text Updated'
@@ -1430,7 +1413,7 @@ def testPutSquareAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_square_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Line Annotations Tests
@@ -1468,19 +1451,18 @@ def testPostPageLineAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.LineAnnotation()
+ annotation = asposepdfcloud.models.LineAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200),
+ starting = asposepdfcloud.models.Point(10, 10),
+ ending = asposepdfcloud.models.Point(100, 100))
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.starting = asposepdfcloud.models.Point(10, 10)
- annotation.ending = asposepdfcloud.models.Point(100, 100)
response = self.pdf_api.post_page_line_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutLineAnnotation(self):
@@ -1488,23 +1470,22 @@ def testPutLineAnnotation(self):
self.uploadFile(file_name)
- annotation = asposepdfcloud.models.LineAnnotation()
+ annotation = asposepdfcloud.models.LineAnnotation(rect=asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200),
+ starting=asposepdfcloud.models.Point(10, 10),
+ ending=asposepdfcloud.models.Point(100, 100))
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.rich_text = 'Rich Text Updated'
annotation.subject = 'Subj Updated'
annotation.z_index = 1
- annotation.starting = asposepdfcloud.models.Point(10, 10)
- annotation.ending = asposepdfcloud.models.Point(100, 100)
response_annotations = self.pdf_api.get_document_line_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_line_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Free Text Annotations Tests
@@ -1545,10 +1526,8 @@ def testPostPageFreeTextAnnotations(self):
foreground_color=asposepdfcloud.models.Color(a=0xFF, r=0, g=0xFF, b=0),
background_color=asposepdfcloud.models.Color(a=0xFF, r=0xFF, g=0, b=0))
- annotation = asposepdfcloud.models.FreeTextAnnotation()
+ annotation = asposepdfcloud.models.FreeTextAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200), text_style = text_style)
annotation.name = 'Test Free Text'
- annotation.text_style = text_style
- 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.intent = asposepdfcloud.models.FreeTextIntent.FREETEXTTYPEWRITER
@@ -1559,7 +1538,7 @@ def testPostPageFreeTextAnnotations(self):
annotation.title = 'Title'
response = self.pdf_api.post_page_free_text_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutFreeTextAnnotation(self):
@@ -1571,10 +1550,8 @@ def testPutFreeTextAnnotation(self):
foreground_color=asposepdfcloud.models.Color(a=0xFF, r=0, g=0xFF, b=0),
background_color=asposepdfcloud.models.Color(a=0xFF, r=0xFF, g=0, b=0))
- annotation = asposepdfcloud.models.FreeTextAnnotation()
+ annotation = asposepdfcloud.models.FreeTextAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200), text_style = text_style)
annotation.name = 'Test Free Text'
- annotation.text_style = text_style
- 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.intent = asposepdfcloud.models.FreeTextIntent.FREETEXTTYPEWRITER
@@ -1589,7 +1566,7 @@ def testPutFreeTextAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_free_text_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Text Annotations Tests
@@ -1626,9 +1603,8 @@ def testPostPageTextAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.TextAnnotation()
+ annotation = asposepdfcloud.models.TextAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = 'Test Free Text'
- 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'
@@ -1638,7 +1614,7 @@ def testPostPageTextAnnotations(self):
annotation.state = asposepdfcloud.models.AnnotationState.UNDEFINED
response = self.pdf_api.post_page_text_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutTextAnnotation(self):
@@ -1646,9 +1622,8 @@ def testPutTextAnnotation(self):
self.uploadFile(file_name)
- annotation = asposepdfcloud.models.TextAnnotation()
+ annotation = asposepdfcloud.models.TextAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = 'Test Free Text'
- 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'
@@ -1662,7 +1637,7 @@ def testPutTextAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_text_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Highlight Annotations Tests
@@ -1700,9 +1675,8 @@ def testPostPageHighlightAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.HighlightAnnotation()
+ annotation = asposepdfcloud.models.HighlightAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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'
@@ -1718,7 +1692,7 @@ def testPostPageHighlightAnnotations(self):
annotation.modified = '02/02/2018 00:00:00.000 AM'
response = self.pdf_api.post_page_highlight_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutHighlightAnnotation(self):
@@ -1726,9 +1700,8 @@ def testPutHighlightAnnotation(self):
self.uploadFile(file_name)
- annotation = asposepdfcloud.models.HighlightAnnotation()
+ annotation = asposepdfcloud.models.HighlightAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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.rich_text = 'Text Updated'
@@ -1748,7 +1721,7 @@ def testPutHighlightAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_highlight_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Underline Annotations Tests
@@ -1786,9 +1759,8 @@ def testPostPageUnderlineAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.UnderlineAnnotation()
+ annotation = asposepdfcloud.models.UnderlineAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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'
@@ -1804,7 +1776,7 @@ def testPostPageUnderlineAnnotations(self):
annotation.modified = '02/02/2018 00:00:00.000 AM'
response = self.pdf_api.post_page_underline_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutUnderlineAnnotation(self):
@@ -1812,9 +1784,8 @@ def testPutUnderlineAnnotation(self):
self.uploadFile(file_name)
- annotation = asposepdfcloud.models.UnderlineAnnotation()
+ annotation = asposepdfcloud.models.UnderlineAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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.rich_text = 'Text Updated'
@@ -1834,7 +1805,7 @@ def testPutUnderlineAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_underline_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Squiggly Annotations Tests
@@ -1871,9 +1842,8 @@ def testPostPageSquigglyAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.SquigglyAnnotation()
+ annotation = asposepdfcloud.models.SquigglyAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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'
@@ -1889,7 +1859,7 @@ def testPostPageSquigglyAnnotations(self):
annotation.modified = '02/02/2018 00:00:00.000 AM'
response = self.pdf_api.post_page_squiggly_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutSquigglyAnnotation(self):
@@ -1897,9 +1867,8 @@ def testPutSquigglyAnnotation(self):
self.uploadFile(file_name)
- annotation = asposepdfcloud.models.SquigglyAnnotation()
+ annotation = asposepdfcloud.models.SquigglyAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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.rich_text = 'Text Updated'
@@ -1919,7 +1888,7 @@ def testPutSquigglyAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_squiggly_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# StrikeOut Annotations Tests
@@ -1957,9 +1926,8 @@ def testPostPageStrikeOutAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.StrikeOutAnnotation()
+ annotation = asposepdfcloud.models.StrikeOutAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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'
@@ -1975,7 +1943,7 @@ def testPostPageStrikeOutAnnotations(self):
annotation.modified = '02/02/2018 00:00:00.000 AM'
response = self.pdf_api.post_page_strike_out_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutStrikeOutAnnotation(self):
@@ -1983,9 +1951,8 @@ def testPutStrikeOutAnnotation(self):
self.uploadFile(file_name)
- annotation = asposepdfcloud.models.StrikeOutAnnotation()
+ annotation = asposepdfcloud.models.StrikeOutAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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.rich_text = 'Text Updated'
@@ -2005,7 +1972,7 @@ def testPutStrikeOutAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_strike_out_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Caret Annotations Tests
@@ -2042,9 +2009,8 @@ def testPostPageCaretAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.CaretAnnotation()
+ annotation = asposepdfcloud.models.CaretAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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'
@@ -2055,7 +2021,7 @@ def testPostPageCaretAnnotations(self):
annotation.modified = '02/02/2018 00:00:00.000 AM'
response = self.pdf_api.post_page_caret_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutCaretAnnotation(self):
@@ -2063,9 +2029,8 @@ def testPutCaretAnnotation(self):
self.uploadFile(file_name)
- annotation = asposepdfcloud.models.CaretAnnotation()
+ annotation = asposepdfcloud.models.CaretAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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.rich_text = 'Text Updated'
@@ -2080,7 +2045,7 @@ def testPutCaretAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_caret_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Ink Annotations Tests
@@ -2118,9 +2083,8 @@ def testPostPageInkAnnotations(self):
page_number = 1
- annotation = asposepdfcloud.models.InkAnnotation()
+ annotation = asposepdfcloud.models.InkAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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'
@@ -2142,7 +2106,7 @@ def testPostPageInkAnnotations(self):
annotation.modified = '02/02/2018 00:00:00.000 AM'
response = self.pdf_api.post_page_ink_annotations(file_name, page_number, [annotation], folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutInkAnnotation(self):
@@ -2150,9 +2114,8 @@ def testPutInkAnnotation(self):
self.uploadFile(file_name)
- annotation = asposepdfcloud.models.InkAnnotation()
+ annotation = asposepdfcloud.models.InkAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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.rich_text = 'Text Updated'
@@ -2178,7 +2141,7 @@ def testPutInkAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_ink_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Popup Annotations Tests
@@ -2224,16 +2187,15 @@ def testPostPopupAnnotation(self):
parent_id = 'GI5TCMR3GE2TQLBSGM3CYMJYGUWDENRV'
- annotation = asposepdfcloud.models.PopupAnnotation()
+ annotation = asposepdfcloud.models.PopupAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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 = '02/02/2018 00:00:00.000 AM'
response = self.pdf_api.post_popup_annotation(file_name, parent_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPopupAnnotation(self):
@@ -2241,9 +2203,8 @@ def testPutPopupAnnotation(self):
self.uploadFile(file_name)
- annotation = asposepdfcloud.models.PopupAnnotation()
+ annotation = asposepdfcloud.models.PopupAnnotation(rect = asposepdfcloud.models.Rectangle(llx=100, lly=100, urx=200, ury=200))
annotation.name = '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
@@ -2254,11 +2215,11 @@ def testPutPopupAnnotation(self):
annotation_id = response_annotations.annotations.list[0].id
response = self.pdf_api.put_popup_annotation(file_name, annotation_id, annotation, folder=self.temp_folder)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Append Tests
- def testPostAppendDocumentUsingQueryParams(self):
+ def testPostAppendDocument(self):
file_name = 'PdfWithImages2.pdf'
append_file_name = '4pages.pdf'
@@ -2276,25 +2237,6 @@ def testPostAppendDocumentUsingQueryParams(self):
self.assertEqual(response.code, 200)
- def testPostAppendDocumentUsingBodyParams(self):
- file_name = 'PdfWithImages2.pdf'
- append_file_name = '4pages.pdf'
-
- self.uploadFile(file_name)
- self.uploadFile(append_file_name)
-
- append_document = asposepdfcloud.models.AppendDocument(self.temp_folder + '/' + append_file_name, start_page=2, end_page=4)
-
-
- opts = {
- "append_document" : append_document,
- "folder" : self.temp_folder
- }
-
- response = self.pdf_api.post_append_document(file_name, **opts)
- self.assertEqual(response.code, 200)
-
-
# Attachments Tests
def testGetDocumentAttachmentByIndex(self):
@@ -2361,7 +2303,7 @@ def testPutPdfInStorageToDoc(self):
}
response = self.pdf_api.put_pdf_in_storage_to_doc(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToDoc(self):
@@ -2373,7 +2315,7 @@ def testPutPdfInRequestToDoc(self):
}
response = self.pdf_api.put_pdf_in_request_to_doc(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# To PDFA
@@ -2404,7 +2346,7 @@ def testPutPdfInStorageToPdfA(self):
self.temp_folder + '/' + result_file_name,
asposepdfcloud.models.PdfAType.PDFA1A,
**opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToPdfA(self):
@@ -2419,7 +2361,7 @@ def testPutPdfInRequestToPdfA(self):
self.temp_folder + '/' + result_file_name,
asposepdfcloud.models.PdfAType.PDFA1A,
**opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# To Tiff
def testGetPdfInStorageToTiff(self):
@@ -2444,7 +2386,7 @@ def testPutPdfInStorageToTiff(self):
}
response = self.pdf_api.put_pdf_in_storage_to_tiff(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToTiff(self):
@@ -2456,7 +2398,7 @@ def testPutPdfInRequestToTiff(self):
}
response = self.pdf_api.put_pdf_in_request_to_tiff(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# To SVG
@@ -2483,7 +2425,7 @@ def testPutPdfInStorageToSvg(self):
}
response = self.pdf_api.put_pdf_in_storage_to_svg(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToSvg(self):
@@ -2495,7 +2437,7 @@ def testPutPdfInRequestToSvg(self):
}
response = self.pdf_api.put_pdf_in_request_to_svg(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# To XPS
@@ -2521,7 +2463,7 @@ def testPutPdfInStorageToXps(self):
}
response = self.pdf_api.put_pdf_in_storage_to_xps(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToXps(self):
@@ -2533,7 +2475,7 @@ def testPutPdfInRequestToXps(self):
}
response = self.pdf_api.put_pdf_in_request_to_xps(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# To XLS
def testGetPdfInStorageToXls(self):
@@ -2558,7 +2500,7 @@ def testPutPdfInStorageToXls(self):
}
response = self.pdf_api.put_pdf_in_storage_to_xls(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToXls(self):
@@ -2570,7 +2512,7 @@ def testPutPdfInRequestToXls(self):
}
response = self.pdf_api.put_pdf_in_request_to_xls(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# To XLSX
def testGetPdfInStorageToXlsx(self):
@@ -2595,7 +2537,7 @@ def testPutPdfInStorageToXlsx(self):
}
response = self.pdf_api.put_pdf_in_storage_to_xlsx(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToXlsx(self):
@@ -2607,7 +2549,7 @@ def testPutPdfInRequestToXlsx(self):
}
response = self.pdf_api.put_pdf_in_request_to_xlsx(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# To HTML
def testGetPdfInStorageToHtml(self):
@@ -2632,7 +2574,7 @@ def testPutPdfInStorageToHtml(self):
}
response = self.pdf_api.put_pdf_in_storage_to_html(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToHtml(self):
@@ -2644,7 +2586,7 @@ def testPutPdfInRequestToHtml(self):
}
response = self.pdf_api.put_pdf_in_request_to_html(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# To EPUB
@@ -2670,7 +2612,7 @@ def testPutPdfInStorageToEpub(self):
}
response = self.pdf_api.put_pdf_in_storage_to_epub(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToEpub(self):
@@ -2682,7 +2624,7 @@ def testPutPdfInRequestToEpub(self):
}
response = self.pdf_api.put_pdf_in_request_to_epub(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# To PPTX
@@ -2708,7 +2650,7 @@ def testPutPdfInStorageToPptx(self):
}
response = self.pdf_api.put_pdf_in_storage_to_pptx(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToPptx(self):
@@ -2720,7 +2662,7 @@ def testPutPdfInRequestToPptx(self):
}
response = self.pdf_api.put_pdf_in_request_to_pptx(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# To LaTeX
@@ -2746,7 +2688,7 @@ def testPutPdfInStorageToLaTeX(self):
}
response = self.pdf_api.put_pdf_in_storage_to_la_te_x(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToLaTeX(self):
@@ -2758,7 +2700,7 @@ def testPutPdfInRequestToLaTeX(self):
}
response = self.pdf_api.put_pdf_in_request_to_la_te_x(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# To Mobi Xml
@@ -2784,7 +2726,7 @@ def testPutPdfInStorageToMobiXml(self):
}
response = self.pdf_api.put_pdf_in_storage_to_mobi_xml(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToMobiXml(self):
@@ -2796,7 +2738,7 @@ def testPutPdfInRequestToMobiXml(self):
}
response = self.pdf_api.put_pdf_in_request_to_mobi_xml(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# PDF Xfa To Acro Form
@@ -2822,7 +2764,7 @@ def testPutXfaPdfInStorageToAcroForm(self):
}
response = self.pdf_api.put_xfa_pdf_in_storage_to_acro_form(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutXfaPdfInRequestToAcroForm(self):
@@ -2834,7 +2776,7 @@ def testPutXfaPdfInRequestToAcroForm(self):
}
response = self.pdf_api.put_xfa_pdf_in_request_to_acro_form(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# To Xml
@@ -2860,7 +2802,7 @@ def testPutPdfInStorageToXml(self):
}
response = self.pdf_api.put_pdf_in_storage_to_xml(file_name, self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutPdfInRequestToXml(self):
@@ -2872,7 +2814,7 @@ def testPutPdfInRequestToXml(self):
}
response = self.pdf_api.put_pdf_in_request_to_xml(self.temp_folder + '/' + result_file_name, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Convert to PDF Tests
@@ -2896,7 +2838,7 @@ def testPutEpubInStorageToPdf(self):
"dst_folder" : self.temp_folder
}
response = self.pdf_api.put_epub_in_storage_to_pdf(result_name, src_path, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testGetWebInStorageToPdf(self):
@@ -2914,12 +2856,12 @@ def testPutWebInStorageToPdf(self):
"dst_folder" : self.temp_folder
}
response = self.pdf_api.put_web_in_storage_to_pdf(result_name, url, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testGetLaTeXInStorageToPdf(self):
- file_name = 'TexExample.tex'
+ file_name = 'sample.tex'
self.uploadFile(file_name)
src_path = self.temp_folder + '/' + file_name
@@ -2928,7 +2870,7 @@ def testGetLaTeXInStorageToPdf(self):
def testPutLaTeXInStorageToPdf(self):
- file_name = 'TexExample.tex'
+ file_name = 'sample.tex'
self.uploadFile(file_name)
result_name = 'fromTex.pdf'
@@ -2937,7 +2879,7 @@ def testPutLaTeXInStorageToPdf(self):
"dst_folder" : self.temp_folder
}
response = self.pdf_api.put_la_te_x_in_storage_to_pdf(result_name, src_path, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testGetMhtInStorageToPdf(self):
@@ -2959,7 +2901,7 @@ def testPutMhtInStorageToPdf(self):
"dst_folder" : self.temp_folder
}
response = self.pdf_api.put_mht_in_storage_to_pdf(result_name, src_path, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
@@ -2993,7 +2935,7 @@ def testPutHtmlInStorageToPdf(self):
"html_file_name": html_file_name
}
response = self.pdf_api.put_html_in_storage_to_pdf(result_name, src_path, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testGetXslFoInStorageToPdf(self):
@@ -3015,7 +2957,7 @@ def testPutXslFoInStorageToPdf(self):
"dst_folder" : self.temp_folder
}
response = self.pdf_api.put_xsl_fo_in_storage_to_pdf(result_name, src_path, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
@@ -3038,7 +2980,7 @@ def testPutXpsInStorageToPdf(self):
"dst_folder" : self.temp_folder
}
response = self.pdf_api.put_xps_in_storage_to_pdf(result_name, src_path, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
@@ -3061,7 +3003,7 @@ def testPutSvgInStorageToPdf(self):
"dst_folder" : self.temp_folder
}
response = self.pdf_api.put_svg_in_storage_to_pdf(result_name, src_path, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testGetPclInStorageToPdf(self):
@@ -3083,7 +3025,7 @@ def testPutPclInStorageToPdf(self):
"dst_folder" : self.temp_folder
}
response = self.pdf_api.put_pcl_in_storage_to_pdf(result_name, src_path, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
@@ -3106,7 +3048,7 @@ def testPutXmlInStorageToPdf(self):
"dst_folder" : self.temp_folder
}
response = self.pdf_api.put_xml_in_storage_to_pdf(result_name, src_path, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testGetPsInStorageToPdf(self):
file_name = 'Typography.PS'
@@ -3127,7 +3069,7 @@ def testPutPsInStorageToPdf(self):
"dst_folder" : self.temp_folder
}
response = self.pdf_api.put_ps_in_storage_to_pdf(result_name, src_path, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutImageInStorageToPdf(self):
data_file_1 = "33539.jpg"
@@ -3152,7 +3094,7 @@ def testPutImageInStorageToPdf(self):
}
response = self.pdf_api.put_image_in_storage_to_pdf(result_name, image_templates_request, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
# Document Tests
@@ -3247,9 +3189,8 @@ def testPostCreateField(self):
rect = asposepdfcloud.models.Rectangle(50, 200, 200, 400)
- field = asposepdfcloud.models.Field()
+ field = asposepdfcloud.models.Field(values = ['1'])
field.name = 'checkboxfield'
- field.values = ['1']
field.type = 'Boolean'
field.rect = rect
@@ -3270,9 +3211,8 @@ def testPutUpdateField(self):
field_name = 'textField'
- field = asposepdfcloud.models.Field()
+ field = asposepdfcloud.models.Field(values = ['Text field updated value.'])
field.name = field_name
- field.values = ['Text field updated value.']
field.type = asposepdfcloud.models.FieldType.TEXT
opts = {
@@ -3290,13 +3230,11 @@ def testPutUpdateFields(self):
field_name = 'textField'
- field = asposepdfcloud.models.Field()
+ field = asposepdfcloud.models.Field(values = ['Text field updated value.'])
field.name = field_name
- field.values = ['Text field updated value.']
field.type = asposepdfcloud.models.FieldType.TEXT
- fields = asposepdfcloud.models.Fields()
- fields.list = [field]
+ fields = asposepdfcloud.models.Fields(list = [field])
opts = {
"fields" : fields,
@@ -3436,7 +3374,7 @@ def testPostInsertImage(self):
}
response = self.pdf_api.post_insert_image(file_name, page_number, llx, lly, urx, ury, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutImagesExtractAsJpeg(self):
name = "PdfWithImages2.pdf"
@@ -3690,13 +3628,13 @@ def testPostPageLinkAnnotations(self):
rect = asposepdfcloud.models.Rectangle(100, 100, 500, 500)
- linkAnnotation = asposepdfcloud.models.LinkAnnotation()
- linkAnnotation.action_type = asposepdfcloud.models.LinkActionType.GOTOURIACTION
- linkAnnotation.action = "https://products.aspose.cloud/pdf"
- linkAnnotation.rect = rect
+ linkAnnotation = asposepdfcloud.models.LinkAnnotation(action_type=asposepdfcloud.models.LinkActionType.GOTOURIACTION,
+ action="https://products.aspose.cloud/pdf",
+ highlighting=asposepdfcloud.models.LinkHighlightingMode.NONE,
+ rect = rect)
response = self.pdf_api.post_page_link_annotations(file_name, page_number, [linkAnnotation], **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testPutLinkAnnotation(self):
file_name = 'PdfWithLinks.pdf'
@@ -3713,13 +3651,13 @@ def testPutLinkAnnotation(self):
rect = asposepdfcloud.models.Rectangle(100, 100, 500, 500)
- linkAnnotation = asposepdfcloud.models.LinkAnnotation()
- linkAnnotation.action_type = asposepdfcloud.models.LinkActionType.GOTOURIACTION
- linkAnnotation.action = "https://products.aspose.cloud/pdf"
- linkAnnotation.rect = rect
+ linkAnnotation = asposepdfcloud.models.LinkAnnotation(action_type=asposepdfcloud.models.LinkActionType.GOTOURIACTION,
+ action="https://products.aspose.cloud/pdf",
+ highlighting=asposepdfcloud.models.LinkHighlightingMode.NONE,
+ rect = rect)
response = self.pdf_api.put_link_annotation(file_name, link_id, linkAnnotation, **opts)
- self.assertEqual(response.code, 201)
+ self.assertEqual(response.code, 200)
def testDeletePageLinkAnnotations(self):
file_name = 'PdfWithLinks.pdf'
@@ -4096,20 +4034,18 @@ def testDeleteProperties(self):
file_name = 'PdfWithAcroForm.pdf'
self.uploadFile(file_name)
- property_1 = asposepdfcloud.models.DocumentProperty()
- property_1.name = 'prop1'
- property_1.value = 'val1'
+ property_1_name = 'prop1'
+ property_1_value = 'val1'
opts = {
"folder" : self.temp_folder
}
- property_2 = asposepdfcloud.models.DocumentProperty()
- property_2.name = 'prop2'
- property_2.value = 'val2'
+ property_2_name = 'prop2'
+ property_2_value = 'val2'
- self.pdf_api.put_set_property(file_name, property_1.name, property_1.value, **opts)
- self.pdf_api.put_set_property(file_name, property_2.name, property_2.value, **opts)
+ self.pdf_api.put_set_property(file_name, property_1_name, property_1_value, **opts)
+ self.pdf_api.put_set_property(file_name, property_2_name, property_2_value, **opts)
response = self.pdf_api.delete_properties(file_name, **opts)
self.assertEqual(response.code, 200)
@@ -4119,17 +4055,16 @@ def testDeleteProperty(self):
file_name = 'PdfWithAcroForm.pdf'
self.uploadFile(file_name)
- property_1 = asposepdfcloud.models.DocumentProperty()
- property_1.name = 'prop1'
- property_1.value = 'val1'
+ property_1_name = 'prop1'
+ property_1_value = 'val1'
opts = {
"folder" : self.temp_folder
}
- self.pdf_api.put_set_property(file_name, property_1.name, property_1.value, **opts)
+ self.pdf_api.put_set_property(file_name, property_1_name, property_1_value, **opts)
- response = self.pdf_api.delete_property(file_name, property_1.name, **opts)
+ response = self.pdf_api.delete_property(file_name, property_1_name, **opts)
self.assertEqual(response.code, 200)
@@ -4137,20 +4072,18 @@ def testGetDocumentProperties(self):
file_name = 'PdfWithAcroForm.pdf'
self.uploadFile(file_name)
- property_1 = asposepdfcloud.models.DocumentProperty()
- property_1.name = 'prop1'
- property_1.value = 'val1'
+ property_1_name = 'prop1'
+ property_1_value = 'val1'
opts = {
"folder" : self.temp_folder
}
- property_2 = asposepdfcloud.models.DocumentProperty()
- property_2.name = 'prop2'
- property_2.value = 'val2'
+ property_2_name = 'prop2'
+ property_2_value = 'val2'
- self.pdf_api.put_set_property(file_name, property_1.name, property_1.value, **opts)
- self.pdf_api.put_set_property(file_name, property_2.name, property_2.value, **opts)
+ self.pdf_api.put_set_property(file_name, property_1_name, property_1_value, **opts)
+ self.pdf_api.put_set_property(file_name, property_2_name, property_2_value, **opts)
response = self.pdf_api.get_document_properties(file_name, **opts)
self.assertEqual(response.code, 200)
@@ -4160,17 +4093,16 @@ def testGetDocumentProperty(self):
file_name = 'PdfWithAcroForm.pdf'
self.uploadFile(file_name)
- property_1 = asposepdfcloud.models.DocumentProperty()
- property_1.name = 'prop1'
- property_1.value = 'val1'
+ property_1_name = 'prop1'
+ property_1_value = 'val1'
opts = {
"folder" : self.temp_folder
}
- self.pdf_api.put_set_property(file_name, property_1.name, property_1.value, **opts)
+ self.pdf_api.put_set_property(file_name, property_1_name, property_1_value, **opts)
- response = self.pdf_api.get_document_property(file_name, property_1.name, **opts)
+ response = self.pdf_api.get_document_property(file_name, property_1_name, **opts)
self.assertEqual(response.code, 200)
@@ -4178,15 +4110,14 @@ def testPutSetProperty(self):
file_name = 'PdfWithAcroForm.pdf'
self.uploadFile(file_name)
- property_1 = asposepdfcloud.models.DocumentProperty()
- property_1.name = 'prop1'
- property_1.value = 'val1'
+ property_1_name = 'prop1'
+ property_1_value = 'val1'
opts = {
"folder" : self.temp_folder
}
- response = self.pdf_api.put_set_property(file_name, property_1.name, property_1.value, **opts)
+ response = self.pdf_api.put_set_property(file_name, property_1_name, property_1_value, **opts)
self.assertEqual(response.code, 200)
@@ -4215,7 +4146,7 @@ def testPostSignDocument(self):
show_properties=False)
opts = {
- "signature" : signature,
+ "sign" : signature,
"folder" : self.temp_folder
}
@@ -4248,7 +4179,7 @@ def testPostSignPage(self):
show_properties=False)
opts = {
- "signature" : signature,
+ "sign" : signature,
"folder" : self.temp_folder
}
@@ -4278,7 +4209,7 @@ def testGetVerifySignature(self):
show_properties=False)
opts = {
- "signature" : signature,
+ "sign" : signature,
"folder" : self.temp_folder
}
@@ -4524,30 +4455,28 @@ def testPutAddText(self):
# Storage Tests
-
- def testPutCreate(self):
+ def testUploadFile(self):
file_name = '4pages.pdf'
- response = self.pdf_api.put_create(self.temp_folder + '/' + file_name, self.test_data_path + file_name)
- self.assertEqual(response.code, 200)
+ response = self.pdf_api.upload_file(self.temp_folder + '/' + file_name, self.test_data_path + file_name)
+ self.assertEqual(len(response.uploaded), 1)
- def testGetDownload(self):
+ def testDownloadFile(self):
file_name = '4pages.pdf'
self.uploadFile(file_name)
- response = self.pdf_api.get_download(self.temp_folder + '/' + file_name)
+ response = self.pdf_api.download_file(self.temp_folder + '/' + file_name)
self.assertIsInstance(response, str)
- def testGetListFiles(self):
- response = self.pdf_api.get_list_files(path=self.temp_folder)
- self.assertEqual(response.code, 200)
+ def testGetFilesList(self):
+ response = self.pdf_api.get_files_list(path=self.temp_folder)
+ self.assertGreater(len(response.value), 0)
- def testPostMoveFile(self):
+ def testMoveFile(self):
file_name = '4pages.pdf'
self.uploadFile(file_name)
src = self.temp_folder + '/' + file_name
dest = self.temp_folder + '/4pages_renamed.pdf'
- response = self.pdf_api.post_move_file(src, dest)
- self.assertEqual(response.code, 200)
+ response = self.pdf_api.move_file(src, dest)
def testDeleteFile(self):
file_name = '4pages.pdf'
@@ -4555,60 +4484,381 @@ def testDeleteFile(self):
path = self.temp_folder + '/' + file_name
response = self.pdf_api.delete_file(path)
- self.assertEqual(response.code, 200)
- def testPutCreateFolder(self):
+ def testCreateFolder(self):
path = self.temp_folder + '/testFolder'
- response = self.pdf_api.put_create_folder(path)
- self.assertEqual(response.code, 200)
+ response = self.pdf_api.create_folder(path)
- def testPostMoveFolder(self):
+ def testMoveFolder(self):
src = self.temp_folder + '/testFolder'
- response_create_folder = self.pdf_api.put_create_folder(src)
- self.assertEqual(response_create_folder.code, 200)
-
+ response_create_folder = self.pdf_api.create_folder(src)
dest = self.temp_folder + '/testFolderRednamed'
-
- response = self.pdf_api.post_move_folder(src, dest)
- self.assertEqual(response.code, 200)
-
+ response = self.pdf_api.move_folder(src, dest)
+
def testDeleteFolder(self):
path = self.temp_folder + '/testFolder'
- response_create_folder = self.pdf_api.put_create_folder(path)
- self.assertEqual(response_create_folder.code, 200)
-
+ response_create_folder = self.pdf_api.create_folder(path)
response = self.pdf_api.delete_folder(path)
- self.assertEqual(response.code, 200)
- def testGetIsStorageExist(self):
+ def testStorageExists(self):
name = 'PDF-CI'
- response = self.pdf_api.get_is_storage_exist(name)
- self.assertEqual(response.code, 200)
+ response = self.pdf_api.storage_exists(name)
+ self.assertEqual(response.exists, True)
- def testGetIsExist(self):
+ def testObjectExists(self):
file_name = '4pages.pdf'
self.uploadFile(file_name)
path = self.temp_folder + '/' + file_name
- response = self.pdf_api.get_is_exist(path)
- self.assertEqual(response.code, 200)
+ response = self.pdf_api.object_exists(path)
+ self.assertEqual(response.exists, True)
def testGetDiscUsage(self):
response = self.pdf_api.get_disc_usage()
- self.assertEqual(response.code, 200)
+ self.assertGreater(response.total_size, 0)
- def testGetListFileVersion(self):
+ def testGetFileVersions(self):
file_name = '4pages.pdf'
self.uploadFile(file_name)
path = self.temp_folder + '/' + file_name
- response = self.pdf_api.get_list_file_versions(path)
+ response = self.pdf_api.get_file_versions(path)
+ self.assertGreater(len(response.value), 0)
+
+ # Bookmark Tests
+ def testGetDocumentBookmarks(self):
+ file_name = 'PdfWithBookmarks.pdf'
+ self.uploadFile(file_name)
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.get_document_bookmarks(file_name, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testGetBookmarks(self):
+ file_name = 'PdfWithBookmarks.pdf'
+ self.uploadFile(file_name)
+
+ bookmark_path = '1/1'
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.get_bookmarks(file_name, bookmark_path, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testGetBookmark(self):
+ file_name = 'PdfWithBookmarks.pdf'
+ self.uploadFile(file_name)
+
+ bookmark_path = '1/1'
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.get_bookmark(file_name, bookmark_path, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testDeleteDocumentBookmarks(self):
+ file_name = 'PdfWithBookmarks.pdf'
+ self.uploadFile(file_name)
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.delete_document_bookmarks(file_name, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testDeleteBookmark(self):
+ file_name = 'PdfWithBookmarks.pdf'
+ self.uploadFile(file_name)
+
+ bookmark_path = '1/1'
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.delete_bookmark(file_name, bookmark_path, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testPostBookmark(self):
+ file_name = 'PdfWithBookmarks.pdf'
+ self.uploadFile(file_name)
+
+ bookmark_path = '2'
+
+ bookmark = asposepdfcloud.models.Bookmark()
+ bookmark .action = 'GoTo'
+ bookmark.bold = True
+ bookmark.italic = False
+ bookmark.title = 'New Bookmark XYZ'
+ bookmark.page_display = 'XYZ'
+ bookmark.page_display_bottom = 10
+ bookmark.page_display_left = 10
+ bookmark.page_display_right = 10
+ bookmark.page_display_top = 10
+ bookmark.page_display_zoom = 2
+ bookmark.page_number = 2
+ bookmark.color = asposepdfcloud.models.Color(a=0xFF, r=0, g=0xFF, b=0)
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.post_bookmark(file_name, bookmark_path, [bookmark], **opts)
+ self.assertEqual(response.code, 200)
+
+ def testPutBookmark(self):
+ file_name = 'PdfWithBookmarks.pdf'
+ self.uploadFile(file_name)
+
+ bookmark_path = '2'
+
+ bookmark = asposepdfcloud.models.Bookmark()
+ bookmark .action = 'GoTo'
+ bookmark.bold = True
+ bookmark.italic = False
+ bookmark.title = 'New Bookmark XYZ'
+ bookmark.page_display = 'XYZ'
+ bookmark.page_display_bottom = 10
+ bookmark.page_display_left = 10
+ bookmark.page_display_right = 10
+ bookmark.page_display_top = 10
+ bookmark.page_display_zoom = 2
+ bookmark.page_number = 2
+ bookmark.color = asposepdfcloud.models.Color(a=0xFF, r=0, g=0xFF, b=0)
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.put_bookmark(file_name, bookmark_path, bookmark, **opts)
+ self.assertEqual(response.code, 200)
+
+ # Import Export Tests
+ def testGetExportFieldsFromPdfToXmlInStorage(self):
+ file_name = 'FormData.pdf'
+ self.uploadFile(file_name)
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.get_export_fields_from_pdf_to_xml_in_storage(file_name, **opts)
+ self.assertIsInstance(response, str)
+
+ def testGetExportFieldsFromPdfToFdfInStorage(self):
+ file_name = 'FormData.pdf'
+ self.uploadFile(file_name)
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.get_export_fields_from_pdf_to_fdf_in_storage(file_name, **opts)
+ self.assertIsInstance(response, str)
+
+ def testGetExportFieldsFromPdfToXfdfInStorage(self):
+ file_name = 'FormData.pdf'
+ self.uploadFile(file_name)
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.get_export_fields_from_pdf_to_xfdf_in_storage(file_name, **opts)
+ self.assertIsInstance(response, str)
+
+ def testPutExportFieldsFromPdfToXmlInStorage(self):
+ file_name = 'FormData.pdf'
+ self.uploadFile(file_name)
+
+ out_path = self.temp_folder + '/exportData.xml'
+
+ opts = {
+
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.put_export_fields_from_pdf_to_xml_in_storage(file_name, out_path, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testPutExportFieldsFromPdfToFdfInStorage(self):
+ file_name = 'FormData.pdf'
+ self.uploadFile(file_name)
+
+ out_path = self.temp_folder + '/exportData.fdf'
+
+ opts = {
+
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.put_export_fields_from_pdf_to_fdf_in_storage(file_name, out_path, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testPutExportFieldsFromPdfToXfdfInStorage(self):
+ file_name = 'FormData.pdf'
+ self.uploadFile(file_name)
+
+ out_path = self.temp_folder + '/exportData.xfdf'
+
+ opts = {
+
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.put_export_fields_from_pdf_to_xfdf_in_storage(file_name, out_path, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testGetImportFieldsFromFdfInStorage(self):
+ file_name = 'FormData.pdf'
+ self.uploadFile(file_name)
+
+ data_file = 'FormData.fdf'
+ self.uploadFile(data_file)
+
+ data_path = self.temp_folder + '/' + data_file
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.get_import_fields_from_fdf_in_storage(file_name, data_path, **opts)
+ self.assertIsInstance(response, str)
+
+ def testGetImportFieldsFromXfdfInStorage(self):
+ file_name = 'FormDataXfdf_in.pdf'
+ self.uploadFile(file_name)
+
+ data_file = 'FormDataXfdf_in.xfdf'
+ self.uploadFile(data_file)
+
+ data_path = self.temp_folder + '/' + data_file
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.get_import_fields_from_xfdf_in_storage(file_name, data_path, **opts)
+ self.assertIsInstance(response, str)
+
+ def testGetImportFieldsFromXmlInStorage(self):
+ file_name = 'FormDataXfa_in.pdf'
+ self.uploadFile(file_name)
+
+ data_file = 'FormDataXfa_in.xml'
+ self.uploadFile(data_file)
+
+ data_path = self.temp_folder + '/' + data_file
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.get_import_fields_from_xml_in_storage(file_name, data_path, **opts)
+ self.assertIsInstance(response, str)
+
+ def testPutImportFieldsFromFdfInStorage(self):
+ file_name = 'FormData.pdf'
+ self.uploadFile(file_name)
+
+ data_file = 'FormData.fdf'
+ self.uploadFile(data_file)
+
+ data_path = self.temp_folder + '/' + data_file
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.put_import_fields_from_fdf_in_storage(file_name, data_path, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testPutImportFieldsFromXfdfInStorage(self):
+ file_name = 'FormDataXfdf_in.pdf'
+ self.uploadFile(file_name)
+
+ data_file = 'FormDataXfdf_in.xfdf'
+ self.uploadFile(data_file)
+
+ data_path = self.temp_folder + '/' + data_file
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.put_import_fields_from_xfdf_in_storage(file_name, data_path, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testPutImportFieldsFromXmlInStorage(self):
+ file_name = 'FormDataXfa_in.pdf'
+ self.uploadFile(file_name)
+
+ data_file = 'FormDataXfa_in.xml'
+ self.uploadFile(data_file)
+
+ data_path = self.temp_folder + '/' + data_file
+
+ opts = {
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.put_import_fields_from_xml_in_storage(file_name, data_path, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testPostImportFieldsFromFdf(self):
+ file_name = 'FormData.pdf'
+ self.uploadFile(file_name)
+
+ data_file = 'FormData.fdf'
+
+ opts = {
+ "fdf_data": self.test_data_path + data_file,
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.post_import_fields_from_fdf(file_name, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testPostImportFieldsFromXfdf(self):
+ file_name = 'FormDataXfdf_in.pdf'
+ self.uploadFile(file_name)
+
+ data_file = 'FormDataXfdf_in.xfdf'
+
+ opts = {
+ "xfdf_data": self.test_data_path + data_file,
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.post_import_fields_from_xfdf(file_name, **opts)
+ self.assertEqual(response.code, 200)
+
+ def testPosttImportFieldsFromXml(self):
+ file_name = 'FormDataXfa_in.pdf'
+ self.uploadFile(file_name)
+
+ data_file = 'FormDataXfa_in.xml'
+
+ opts = {
+ "xml_data": self.test_data_path + data_file,
+ "folder" : self.temp_folder
+ }
+
+ response = self.pdf_api.post_import_fields_from_xml(file_name, **opts)
self.assertEqual(response.code, 200)
if __name__ == '__main__':
diff --git a/test/setup.json b/test/setup.json
index 675dcea..7484098 100644
--- a/test/setup.json
+++ b/test/setup.json
@@ -2,5 +2,5 @@
"app_key" : "",
"app_sid" : "",
"output_location": "./output/",
- "product_uri": "https://billing.cloud.saltov.dynabic.com/v2.0"
+ "product_uri": "https://api-qa.aspose.cloud/v3.0"
}
\ No newline at end of file
diff --git a/test_data/FormData.fdf b/test_data/FormData.fdf
new file mode 100644
index 0000000..dbf2680
Binary files /dev/null and b/test_data/FormData.fdf differ
diff --git a/test_data/FormData.pdf b/test_data/FormData.pdf
new file mode 100644
index 0000000..5dec572
Binary files /dev/null and b/test_data/FormData.pdf differ
diff --git a/test_data/FormDataXfa_in.pdf b/test_data/FormDataXfa_in.pdf
new file mode 100644
index 0000000..743dbaa
Binary files /dev/null and b/test_data/FormDataXfa_in.pdf differ
diff --git a/test_data/FormDataXfa_in.xml b/test_data/FormDataXfa_in.xml
new file mode 100644
index 0000000..a48467e
--- /dev/null
+++ b/test_data/FormDataXfa_in.xml
@@ -0,0 +1,8 @@
+
+
+
+ Dou
+ Jon
+ 999]]>
+
+
\ No newline at end of file
diff --git a/test_data/FormDataXfdf_in.pdf b/test_data/FormDataXfdf_in.pdf
new file mode 100644
index 0000000..0a879ae
Binary files /dev/null and b/test_data/FormDataXfdf_in.pdf differ
diff --git a/test_data/FormDataXfdf_in.xfdf b/test_data/FormDataXfdf_in.xfdf
new file mode 100644
index 0000000..3ca2678
--- /dev/null
+++ b/test_data/FormDataXfdf_in.xfdf
@@ -0,0 +1,21 @@
+
+
+
+
+
+ Deutschland
+
+
+ Freie & Hansestadt Hamburg
+
+
+ Hamburger
+
+
+ dirk.pass@bs-card-service.com
+
+
+ Dirk Pass
+
+
+
diff --git a/test_data/sample.tex b/test_data/sample.tex
new file mode 100644
index 0000000..637c532
--- /dev/null
+++ b/test_data/sample.tex
@@ -0,0 +1,105 @@
+\documentclass{article}
+\usepackage{epsfig}
+\renewcommand{\baselinestretch}{1}
+\setlength{\textheight}{9in}
+\setlength{\textwidth}{6.5in}
+\setlength{\headheight}{0in}
+\setlength{\headsep}{0in}
+\setlength{\topmargin}{0in}
+\setlength{\oddsidemargin}{0in}
+\setlength{\evensidemargin}{0in}
+\setlength{\parindent}{.3in}
+\begin{document}
+
+\leftline{Pat Q.~Student}
+\leftline{AME 20231}
+\leftline{18 January 2013}
+
+\medskip
+This is a sample file in the text formatter \LaTeX.
+I require you to use it for the following reasons:
+
+\begin{itemize}
+
+\item{It produces the best output of text, figures,
+ and equations of any
+ program I've seen.}
+
+\item{It is machine-independent. It runs on Linux, Macintosh (see {\tt TeXShop}), and Windows (see {\tt MiKTeX}) machines.
+ You can e-mail {\tt ASCII} text versions of most relevant files.}
+
+\item{It is the tool of choice for many research
+ scientists and engineers.
+ Many journals accept
+ \LaTeX~ submissions, and many books
+ are written in \LaTeX.}
+
+\end{itemize}
+\medskip
+Some basic instructions are given next.
+Put your text in here. You can be a little sloppy about
+spacing. It adjusts the text to look good.
+{\small You can make the text smaller.}
+{\tiny You can make the text tiny.}
+
+Skip a line for a new paragraph.
+You can use italics ({\em e.g.} {\em Thermodynamics is everywhere}) or {\bf bold}.
+Greek letters are a snap: $\Psi$, $\psi$,
+$\Phi$, $\phi$. Equations within text are easy---
+A well known Maxwell thermodynamic relation is
+$\left.{\partial T \over \partial p}\right|_{s} =
+\left.{\partial v \over \partial s}\right|_{p}$.
+You can also set aside equations like so:
+\begin{eqnarray}
+du &=& Tds -p dv, \qquad \mbox{first law}\\
+ds &\ge& {dq \over T}.\qquad \qquad \mbox{second law} \label{ee}
+\end{eqnarray}
+Eq.~(\ref{ee}) is the second law.
+References\footnote{Lamport, L., 1986, {\em \LaTeX: User's Guide \& Reference Manual},
+ Addison-Wesley: Reading, Massachusetts.}
+are available.
+If you have an postscript file, say {\tt sample.figure.eps}, in the same local directory,
+you can insert the file as a figure. Figure \ref{sample}, below, plots an isotherm for air modeled as an ideal gas.
+\begin{figure}[ht]
+\epsfxsize=2.5in
+\centerline{\epsffile{sample.figure.eps}}
+\caption{Sample figure plotting $T=300~K$ isotherm for air when modeled as an ideal gas.}
+\label{sample}
+\end{figure}
+
+\medskip
+\leftline{\em Running \LaTeX}
+\medskip
+
+You can create a \LaTeX~ file with any text editor ({\tt vi}, {\tt emacs}, {\tt gedit},
+etc.).
+To get a document, you need to run the \LaTeX~ application
+on the text file. The text file must have the suffix ``{\tt .tex}''
+On a Linux cluster machine, this is done via the command
+
+\medskip
+{\tt latex file.tex}
+
+\medskip
+\noindent
+This generates three files: {\tt file.dvi}, {\tt file.aux},
+and {\tt file.log}. The most important is {\tt file.dvi}.
+
+\medskip
+\noindent
+The finished product can be previewed in the following way.
+Execute the commands:
+
+\medskip
+
+{\tt dvipdf file.dvi}\hspace{1.9in}{\em Linux System}
+
+\medskip
+\noindent
+This command generates {\tt file.pdf}.
+Alternatively, you can use {\tt TeXShop} on a Macintosh or {\tt MiKTeX} on a Windows-based machine.
+The {\tt .tex} file must have a closing statement as
+below.
+
+
+\end{document}