aspose_pdf_cloud 19.5.0 → 19.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +39 -26
- data/docs/Annotation.md +1 -1
- data/docs/AnnotationInfo.md +2 -2
- data/docs/Attachment.md +1 -1
- data/docs/Bookmark.md +25 -0
- data/docs/{FileExistResponse.md → BookmarkResponse.md} +3 -3
- data/docs/Bookmarks.md +10 -0
- data/docs/{DiscUsageResponse.md → BookmarksResponse.md} +3 -3
- data/docs/CaretAnnotation.md +1 -1
- data/docs/CellRecognized.md +1 -1
- data/docs/CircleAnnotation.md +1 -1
- data/docs/CommonFigureAnnotation.md +1 -1
- data/docs/DiscUsage.md +3 -3
- data/docs/DocumentPrivilege.md +1 -1
- data/docs/DocumentProperty.md +1 -1
- data/docs/Error.md +12 -0
- data/docs/ErrorDetails.md +10 -0
- data/docs/Field.md +1 -1
- data/docs/Fields.md +1 -1
- data/docs/FileAttachmentAnnotation.md +1 -1
- data/docs/FileVersion.md +8 -8
- data/docs/FileVersions.md +9 -0
- data/docs/FilesList.md +9 -0
- data/docs/FilesUploadResult.md +10 -0
- data/docs/FreeTextAnnotation.md +2 -2
- data/docs/GraphInfo.md +2 -2
- data/docs/HighlightAnnotation.md +1 -1
- data/docs/Image.md +3 -3
- data/docs/ImageFooter.md +1 -1
- data/docs/ImageHeader.md +1 -1
- data/docs/ImageStamp.md +1 -1
- data/docs/InkAnnotation.md +1 -1
- data/docs/LineAnnotation.md +3 -3
- data/docs/LinkAnnotation.md +4 -4
- data/docs/MarkupAnnotation.md +1 -1
- data/docs/MovieAnnotation.md +1 -1
- data/docs/ObjectExist.md +10 -0
- data/docs/Page.md +1 -1
- data/docs/PageNumberStamp.md +1 -1
- data/docs/PdfApi.md +560 -328
- data/docs/PdfPageStamp.md +1 -1
- data/docs/PolyAnnotation.md +2 -2
- data/docs/PolyLineAnnotation.md +2 -2
- data/docs/PolygonAnnotation.md +2 -2
- data/docs/PopupAnnotation.md +1 -1
- data/docs/PopupAnnotationWithParent.md +1 -1
- data/docs/RedactionAnnotation.md +1 -1
- data/docs/ScreenAnnotation.md +1 -1
- data/docs/Signature.md +1 -1
- data/docs/SignatureVerifyResponse.md +1 -1
- data/docs/SoundAnnotation.md +2 -2
- data/docs/SplitResultDocument.md +1 -1
- data/docs/SquareAnnotation.md +1 -1
- data/docs/SquigglyAnnotation.md +1 -1
- data/docs/Stamp.md +2 -2
- data/docs/StampAnnotation.md +1 -1
- data/docs/StampBase.md +1 -1
- data/docs/StampInfo.md +1 -1
- data/docs/StorageExist.md +9 -0
- data/docs/StorageFile.md +13 -0
- data/docs/StrikeOutAnnotation.md +1 -1
- data/docs/Table.md +1 -1
- data/docs/TextAnnotation.md +1 -1
- data/docs/TextFooter.md +2 -2
- data/docs/TextHeader.md +2 -2
- data/docs/TextRect.md +3 -3
- data/docs/TextReplaceListRequest.md +1 -1
- data/docs/TextReplaceResponse.md +1 -1
- data/docs/TextStamp.md +2 -2
- data/docs/UnderlineAnnotation.md +1 -1
- data/docs/WordCountResponse.md +1 -1
- data/lib/aspose_pdf_cloud.rb +12 -8
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +2521 -1650
- data/lib/aspose_pdf_cloud/api_client.rb +2 -54
- data/lib/aspose_pdf_cloud/configuration.rb +2 -5
- data/lib/aspose_pdf_cloud/models/annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/annotation_info.rb +12 -4
- data/lib/aspose_pdf_cloud/models/annotations_info.rb +2 -4
- data/lib/aspose_pdf_cloud/models/annotations_info_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/aspose_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/attachment.rb +7 -4
- data/lib/aspose_pdf_cloud/models/attachment_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/attachments.rb +2 -4
- data/lib/aspose_pdf_cloud/models/attachments_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/{append_document.rb → bookmark.rb} +167 -42
- data/lib/aspose_pdf_cloud/models/{storage_exist_response.rb → bookmark_response.rb} +12 -13
- data/lib/aspose_pdf_cloud/models/{files_response.rb → bookmarks.rb} +22 -36
- data/lib/aspose_pdf_cloud/models/{disc_usage_response.rb → bookmarks_response.rb} +12 -13
- data/lib/aspose_pdf_cloud/models/border_info.rb +2 -4
- data/lib/aspose_pdf_cloud/models/caret_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/caret_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/caret_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/caret_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/cell.rb +2 -4
- data/lib/aspose_pdf_cloud/models/cell_recognized.rb +3 -5
- data/lib/aspose_pdf_cloud/models/circle_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/circle_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/circle_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/circle_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/color.rb +2 -4
- data/lib/aspose_pdf_cloud/models/common_figure_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/disc_usage.rb +5 -5
- data/lib/aspose_pdf_cloud/models/document.rb +2 -4
- data/lib/aspose_pdf_cloud/models/document_page_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/document_pages_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/document_privilege.rb +3 -5
- data/lib/aspose_pdf_cloud/models/document_properties.rb +2 -4
- data/lib/aspose_pdf_cloud/models/document_properties_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/document_property.rb +7 -4
- data/lib/aspose_pdf_cloud/models/document_property_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/document_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/{file_exist_response.rb → error.rb} +31 -27
- data/lib/aspose_pdf_cloud/models/error_details.rb +214 -0
- data/lib/aspose_pdf_cloud/models/field.rb +7 -4
- data/lib/aspose_pdf_cloud/models/field_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/fields.rb +7 -4
- data/lib/aspose_pdf_cloud/models/fields_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/file_attachment_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/file_attachment_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/file_attachment_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/file_attachment_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/file_version.rb +15 -5
- data/lib/aspose_pdf_cloud/models/file_versions.rb +201 -0
- data/lib/aspose_pdf_cloud/models/files_list.rb +201 -0
- data/lib/aspose_pdf_cloud/models/files_upload_result.rb +213 -0
- data/lib/aspose_pdf_cloud/models/free_text_annotation.rb +12 -4
- data/lib/aspose_pdf_cloud/models/free_text_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/free_text_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/free_text_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/graph_info.rb +4 -6
- data/lib/aspose_pdf_cloud/models/highlight_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/highlight_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/highlight_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/highlight_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/image.rb +17 -4
- data/lib/aspose_pdf_cloud/models/image_footer.rb +3 -5
- data/lib/aspose_pdf_cloud/models/image_header.rb +3 -5
- data/lib/aspose_pdf_cloud/models/image_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/image_stamp.rb +3 -5
- data/lib/aspose_pdf_cloud/models/image_template.rb +21 -4
- data/lib/aspose_pdf_cloud/models/image_templates_request.rb +2 -4
- data/lib/aspose_pdf_cloud/models/images.rb +2 -4
- data/lib/aspose_pdf_cloud/models/images_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/ink_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/ink_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/ink_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/ink_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/line_annotation.rb +17 -4
- data/lib/aspose_pdf_cloud/models/line_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/line_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/line_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/link.rb +2 -4
- data/lib/aspose_pdf_cloud/models/link_annotation.rb +41 -4
- data/lib/aspose_pdf_cloud/models/link_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/link_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/link_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/link_element.rb +2 -4
- data/lib/aspose_pdf_cloud/models/margin_info.rb +2 -4
- data/lib/aspose_pdf_cloud/models/markup_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/merge_documents.rb +2 -4
- data/lib/aspose_pdf_cloud/models/movie_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/movie_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/movie_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/movie_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/{file_exist.rb → object_exist.rb} +16 -16
- data/lib/aspose_pdf_cloud/models/optimize_options.rb +2 -4
- data/lib/aspose_pdf_cloud/models/page.rb +7 -4
- data/lib/aspose_pdf_cloud/models/page_number_stamp.rb +3 -5
- data/lib/aspose_pdf_cloud/models/page_word_count.rb +2 -4
- data/lib/aspose_pdf_cloud/models/pages.rb +2 -4
- data/lib/aspose_pdf_cloud/models/paragraph.rb +2 -4
- data/lib/aspose_pdf_cloud/models/pdf_page_stamp.rb +3 -5
- data/lib/aspose_pdf_cloud/models/point.rb +2 -4
- data/lib/aspose_pdf_cloud/models/poly_annotation.rb +12 -4
- data/lib/aspose_pdf_cloud/models/poly_line_annotation.rb +12 -4
- data/lib/aspose_pdf_cloud/models/poly_line_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/poly_line_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/poly_line_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/polygon_annotation.rb +12 -4
- data/lib/aspose_pdf_cloud/models/polygon_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/polygon_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/polygon_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/popup_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/popup_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/popup_annotation_with_parent.rb +7 -4
- data/lib/aspose_pdf_cloud/models/popup_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/popup_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/position.rb +2 -4
- data/lib/aspose_pdf_cloud/models/rectangle.rb +2 -4
- data/lib/aspose_pdf_cloud/models/redaction_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/redaction_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/redaction_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/redaction_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/row.rb +2 -4
- data/lib/aspose_pdf_cloud/models/row_recognized.rb +2 -4
- data/lib/aspose_pdf_cloud/models/screen_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/screen_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/screen_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/screen_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/segment.rb +21 -4
- data/lib/aspose_pdf_cloud/models/signature.rb +22 -5
- data/lib/aspose_pdf_cloud/models/signature_verify_response.rb +7 -4
- data/lib/aspose_pdf_cloud/models/sound_annotation.rb +31 -4
- data/lib/aspose_pdf_cloud/models/sound_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/sound_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/sound_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/split_result.rb +2 -4
- data/lib/aspose_pdf_cloud/models/split_result_document.rb +7 -4
- data/lib/aspose_pdf_cloud/models/split_result_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/square_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/square_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/square_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/square_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/squiggly_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/squiggly_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/squiggly_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/squiggly_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/stamp.rb +4 -6
- data/lib/aspose_pdf_cloud/models/stamp_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/stamp_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/stamp_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/stamp_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/stamp_base.rb +3 -5
- data/lib/aspose_pdf_cloud/models/stamp_info.rb +7 -4
- data/lib/aspose_pdf_cloud/models/stamps_info.rb +2 -4
- data/lib/aspose_pdf_cloud/models/stamps_info_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/storage_exist.rb +204 -0
- data/lib/aspose_pdf_cloud/models/{file.rb → storage_file.rb} +9 -6
- data/lib/aspose_pdf_cloud/models/strike_out_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/strike_out_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/strike_out_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/strike_out_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/table.rb +7 -4
- data/lib/aspose_pdf_cloud/models/table_recognized.rb +2 -4
- data/lib/aspose_pdf_cloud/models/table_recognized_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/tables_recognized.rb +2 -4
- data/lib/aspose_pdf_cloud/models/tables_recognized_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/text_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/text_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/text_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/text_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/text_footer.rb +4 -6
- data/lib/aspose_pdf_cloud/models/text_header.rb +4 -6
- data/lib/aspose_pdf_cloud/models/text_line.rb +2 -4
- data/lib/aspose_pdf_cloud/models/text_rect.rb +5 -7
- data/lib/aspose_pdf_cloud/models/text_rects.rb +2 -4
- data/lib/aspose_pdf_cloud/models/text_rects_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/text_replace.rb +40 -4
- data/lib/aspose_pdf_cloud/models/text_replace_list_request.rb +3 -4
- data/lib/aspose_pdf_cloud/models/text_replace_response.rb +7 -4
- data/lib/aspose_pdf_cloud/models/text_stamp.rb +4 -6
- data/lib/aspose_pdf_cloud/models/text_state.rb +2 -4
- data/lib/aspose_pdf_cloud/models/text_style.rb +2 -4
- data/lib/aspose_pdf_cloud/models/underline_annotation.rb +7 -4
- data/lib/aspose_pdf_cloud/models/underline_annotation_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/underline_annotations.rb +2 -4
- data/lib/aspose_pdf_cloud/models/underline_annotations_response.rb +2 -4
- data/lib/aspose_pdf_cloud/models/word_count.rb +2 -4
- data/lib/aspose_pdf_cloud/models/word_count_response.rb +3 -5
- data/lib/aspose_pdf_cloud/version.rb +1 -1
- data/test/pdf_tests.rb +175 -71
- data/test_data/sample.tex +105 -0
- metadata +27 -18
- data/docs/AppendDocument.md +0 -11
- data/docs/File.md +0 -13
- data/docs/FileExist.md +0 -10
- data/docs/FileVersionsResponse.md +0 -11
- data/docs/FilesResponse.md +0 -11
- data/docs/StorageExistResponse.md +0 -11
- data/lib/aspose_pdf_cloud/models/file_versions_response.rb +0 -227
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**id** | **String** | Gets ID of the annotation. | [optional]
|
12
12
|
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
|
13
13
|
**name** | **String** | Gets Name of the annotation. | [optional]
|
14
|
-
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
14
|
+
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
15
15
|
**page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
|
16
16
|
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
|
17
17
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
|
data/docs/FileVersion.md
CHANGED
@@ -1,15 +1,15 @@
|
|
1
1
|
# AsposePdfCloud::FileVersion
|
2
|
-
|
2
|
+
File Version
|
3
3
|
|
4
4
|
## Properties
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**name** | **String** |
|
8
|
-
**is_folder** | **BOOLEAN** |
|
9
|
-
**modified_date** | **DateTime** |
|
10
|
-
**size** | **Integer** |
|
11
|
-
**path** | **String** |
|
12
|
-
**version_id** | **String** |
|
13
|
-
**is_latest** | **BOOLEAN** |
|
7
|
+
**name** | **String** | File or folder name. | [optional]
|
8
|
+
**is_folder** | **BOOLEAN** | True if it is a folder. |
|
9
|
+
**modified_date** | **DateTime** | File or folder last modified DateTime. | [optional]
|
10
|
+
**size** | **Integer** | File or folder size. |
|
11
|
+
**path** | **String** | File or folder path. | [optional]
|
12
|
+
**version_id** | **String** | File Version ID. | [optional]
|
13
|
+
**is_latest** | **BOOLEAN** | Specifies whether the file is (true) or is not (false) the latest version of an file. |
|
14
14
|
|
15
15
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# AsposePdfCloud::FileVersions
|
2
|
+
File versions FileVersion.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**value** | [**Array<FileVersion>**](FileVersion.md) | File versions FileVersion. | [optional]
|
8
|
+
|
9
|
+
|
data/docs/FilesList.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# AsposePdfCloud::FilesList
|
2
|
+
Files list
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**value** | [**Array<StorageFile>**](StorageFile.md) | Files and folders contained by folder StorageFile. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposePdfCloud::FilesUploadResult
|
2
|
+
File upload result
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**uploaded** | **Array<String>** | List of uploaded file names | [optional]
|
8
|
+
**errors** | [**Array<Error>**](Error.md) | List of errors. | [optional]
|
9
|
+
|
10
|
+
|
data/docs/FreeTextAnnotation.md
CHANGED
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**id** | **String** | Gets ID of the annotation. | [optional]
|
12
12
|
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
|
13
13
|
**name** | **String** | Gets Name of the annotation. | [optional]
|
14
|
-
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
14
|
+
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
15
15
|
**page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
|
16
16
|
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
|
17
17
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
|
@@ -23,6 +23,6 @@ Name | Type | Description | Notes
|
|
23
23
|
**justification** | [**Justification**](Justification.md) | Gets Justification of the annotation. | [optional]
|
24
24
|
**intent** | [**FreeTextIntent**](FreeTextIntent.md) | Gets or sets the intent of the free text annotation. | [optional]
|
25
25
|
**rotate** | [**Rotation**](Rotation.md) | Angle of annotation rotation. | [optional]
|
26
|
-
**text_style** | [**TextStyle**](TextStyle.md) | Text style of the annotation. |
|
26
|
+
**text_style** | [**TextStyle**](TextStyle.md) | Text style of the annotation. |
|
27
27
|
|
28
28
|
|
data/docs/GraphInfo.md
CHANGED
@@ -5,10 +5,10 @@ Represents graphics info.
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**line_width** | **Float** | Gets or sets a float value that indicates the line width of the graph. | [optional]
|
8
|
-
**color** | [**Color**](Color.md) | Gets or sets a
|
8
|
+
**color** | [**Color**](Color.md) | Gets or sets a Color object that indicates the color of the graph. | [optional]
|
9
9
|
**dash_array** | **Array<Integer>** | Gets or sets a dash array. | [optional]
|
10
10
|
**dash_phase** | **Integer** | Gets or sets a dash phase. | [optional]
|
11
|
-
**fill_color** | [**Color**](Color.md) | Gets or sets a
|
11
|
+
**fill_color** | [**Color**](Color.md) | Gets or sets a Color object that indicates the fill color of the graph. | [optional]
|
12
12
|
**is_doubled** | **BOOLEAN** | Gets or sets is border doubled. | [optional]
|
13
13
|
**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]
|
14
14
|
**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]
|
data/docs/HighlightAnnotation.md
CHANGED
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**id** | **String** | Gets ID of the annotation. | [optional]
|
12
12
|
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
|
13
13
|
**name** | **String** | Gets Name of the annotation. | [optional]
|
14
|
-
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
14
|
+
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
15
15
|
**page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
|
16
16
|
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
|
17
17
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
|
data/docs/Image.md
CHANGED
@@ -5,10 +5,10 @@ Represents image DTO.
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
-
**width** | **Integer** | Gets width of the image. |
|
9
|
-
**height** | **Integer** | Gets height of the image. |
|
8
|
+
**width** | **Integer** | Gets width of the image. |
|
9
|
+
**height** | **Integer** | Gets height of the image. |
|
10
10
|
**id** | **String** | Gets ID of the image. | [optional]
|
11
11
|
**rectangle** | [**Rectangle**](Rectangle.md) | Gets rectangle of the image. | [optional]
|
12
|
-
**page_number** | **Integer** | Gets page number. |
|
12
|
+
**page_number** | **Integer** | Gets page number. |
|
13
13
|
|
14
14
|
|
data/docs/ImageFooter.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**background** | **BOOLEAN** | 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]
|
9
9
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
|
10
10
|
**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]
|
11
|
-
**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according
|
11
|
+
**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]
|
12
12
|
**rotate_angle** | **Float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
|
13
13
|
**x_indent** | **Float** | Horizontal stamp coordinate, starting from the left. | [optional]
|
14
14
|
**y_indent** | **Float** | Vertical stamp coordinate, starting from the bottom. | [optional]
|
data/docs/ImageHeader.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**background** | **BOOLEAN** | 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]
|
9
9
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
|
10
10
|
**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]
|
11
|
-
**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according
|
11
|
+
**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]
|
12
12
|
**rotate_angle** | **Float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
|
13
13
|
**x_indent** | **Float** | Horizontal stamp coordinate, starting from the left. | [optional]
|
14
14
|
**y_indent** | **Float** | Vertical stamp coordinate, starting from the bottom. | [optional]
|
data/docs/ImageStamp.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**background** | **BOOLEAN** | 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]
|
9
9
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
|
10
10
|
**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]
|
11
|
-
**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according
|
11
|
+
**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]
|
12
12
|
**rotate_angle** | **Float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
|
13
13
|
**x_indent** | **Float** | Horizontal stamp coordinate, starting from the left. | [optional]
|
14
14
|
**y_indent** | **Float** | Vertical stamp coordinate, starting from the bottom. | [optional]
|
data/docs/InkAnnotation.md
CHANGED
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**id** | **String** | Gets ID of the annotation. | [optional]
|
12
12
|
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
|
13
13
|
**name** | **String** | Gets Name of the annotation. | [optional]
|
14
|
-
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
14
|
+
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
15
15
|
**page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
|
16
16
|
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
|
17
17
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
|
data/docs/LineAnnotation.md
CHANGED
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**id** | **String** | Gets ID of the annotation. | [optional]
|
12
12
|
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
|
13
13
|
**name** | **String** | Gets Name of the annotation. | [optional]
|
14
|
-
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
14
|
+
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
15
15
|
**page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
|
16
16
|
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
|
17
17
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
|
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
|
|
20
20
|
**subject** | **String** | Get the annotation subject. | [optional]
|
21
21
|
**title** | **String** | Get the annotation title. | [optional]
|
22
22
|
**rich_text** | **String** | Get the annotation RichText. | [optional]
|
23
|
-
**starting** | [**Point**](Point.md) | Gets or sets starting point of line. |
|
23
|
+
**starting** | [**Point**](Point.md) | Gets or sets starting point of line. |
|
24
24
|
**starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets line ending style for line starting point. | [optional]
|
25
|
-
**ending** | [**Point**](Point.md) | Gets or sets ending point of line. |
|
25
|
+
**ending** | [**Point**](Point.md) | Gets or sets ending point of line. |
|
26
26
|
**ending_style** | [**LineEnding**](LineEnding.md) | Gets or sets ending style for end point of line. | [optional]
|
27
27
|
**interior_color** | [**Color**](Color.md) | Gets or sets interior color of the annotation. | [optional]
|
28
28
|
**leader_line** | **Float** | Gets or sets leader line length. | [optional]
|
data/docs/LinkAnnotation.md
CHANGED
@@ -5,11 +5,11 @@ Provides link to linkAnnotation.
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
-
**action_type** | [**LinkActionType**](LinkActionType.md) | |
|
9
|
-
**action** | **String** | |
|
10
|
-
**highlighting** | [**LinkHighlightingMode**](LinkHighlightingMode.md) | |
|
8
|
+
**action_type** | [**LinkActionType**](LinkActionType.md) | |
|
9
|
+
**action** | **String** | |
|
10
|
+
**highlighting** | [**LinkHighlightingMode**](LinkHighlightingMode.md) | |
|
11
11
|
**color** | [**Color**](Color.md) | | [optional]
|
12
|
-
**rect** | [**Rectangle**](Rectangle.md) | |
|
12
|
+
**rect** | [**Rectangle**](Rectangle.md) | |
|
13
13
|
**id** | **String** | | [optional]
|
14
14
|
|
15
15
|
|
data/docs/MarkupAnnotation.md
CHANGED
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**id** | **String** | Gets ID of the annotation. | [optional]
|
12
12
|
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
|
13
13
|
**name** | **String** | Gets Name of the annotation. | [optional]
|
14
|
-
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
14
|
+
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
15
15
|
**page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
|
16
16
|
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
|
17
17
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
|
data/docs/MovieAnnotation.md
CHANGED
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**id** | **String** | Gets ID of the annotation. | [optional]
|
12
12
|
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
|
13
13
|
**name** | **String** | Gets Name of the annotation. | [optional]
|
14
|
-
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
14
|
+
**rect** | [**Rectangle**](Rectangle.md) | Gets Rect of the annotation. |
|
15
15
|
**page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
|
16
16
|
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
|
17
17
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
|
data/docs/ObjectExist.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposePdfCloud::ObjectExist
|
2
|
+
Object exists
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**exists** | **BOOLEAN** | Indicates that the file or folder exists. |
|
8
|
+
**is_folder** | **BOOLEAN** | True if it is a folder, false if it is a file. |
|
9
|
+
|
10
|
+
|
data/docs/Page.md
CHANGED
@@ -5,7 +5,7 @@ Provides link to page.
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
-
**id** | **Integer** | Page's id. |
|
8
|
+
**id** | **Integer** | Page's id. |
|
9
9
|
**images** | [**Images**](Images.md) | Page's images | [optional]
|
10
10
|
**rectangle** | [**Rectangle**](Rectangle.md) | Page's rectangle | [optional]
|
11
11
|
|
data/docs/PageNumberStamp.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**background** | **BOOLEAN** | 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]
|
9
9
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets Horizontal alignment of stamp on the page. | [optional]
|
10
10
|
**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]
|
11
|
-
**rotate** | [**Rotation**](Rotation.md) | Sets or gets the rotation of stamp content according
|
11
|
+
**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]
|
12
12
|
**rotate_angle** | **Float** | Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. | [optional]
|
13
13
|
**x_indent** | **Float** | Horizontal stamp coordinate, starting from the left. | [optional]
|
14
14
|
**y_indent** | **Float** | Vertical stamp coordinate, starting from the bottom. | [optional]
|
data/docs/PdfApi.md
CHANGED
@@ -1,17 +1,22 @@
|
|
1
1
|
# AsposePdfCloud::PdfApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://api.aspose.cloud/
|
3
|
+
All URIs are relative to *https://api.aspose.cloud/v3.0*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**copy_file**](PdfApi.md#copy_file) | **PUT** /pdf/storage/file/copy/\{srcPath} | Copy file
|
8
|
+
[**copy_folder**](PdfApi.md#copy_folder) | **PUT** /pdf/storage/folder/copy/\{srcPath} | Copy folder
|
9
|
+
[**create_folder**](PdfApi.md#create_folder) | **PUT** /pdf/storage/folder/\{path} | Create the folder
|
7
10
|
[**delete_annotation**](PdfApi.md#delete_annotation) | **DELETE** /pdf/\{name}/annotations/\{annotationId} | Delete document annotation by ID
|
11
|
+
[**delete_bookmark**](PdfApi.md#delete_bookmark) | **DELETE** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Delete document bookmark by ID.
|
8
12
|
[**delete_document_annotations**](PdfApi.md#delete_document_annotations) | **DELETE** /pdf/\{name}/annotations | Delete all annotations from the document
|
13
|
+
[**delete_document_bookmarks**](PdfApi.md#delete_document_bookmarks) | **DELETE** /pdf/\{name}/bookmarks/tree | Delete all document bookmarks.
|
9
14
|
[**delete_document_link_annotations**](PdfApi.md#delete_document_link_annotations) | **DELETE** /pdf/\{name}/links | Delete all link annotations from the document
|
10
15
|
[**delete_document_stamps**](PdfApi.md#delete_document_stamps) | **DELETE** /pdf/\{name}/stamps | Delete all stamps from the document
|
11
16
|
[**delete_document_tables**](PdfApi.md#delete_document_tables) | **DELETE** /pdf/\{name}/tables | Delete all tables from the document
|
12
17
|
[**delete_field**](PdfApi.md#delete_field) | **DELETE** /pdf/\{name}/fields/\{fieldName} | Delete document field by name.
|
13
|
-
[**delete_file**](PdfApi.md#delete_file) | **DELETE** /storage/file |
|
14
|
-
[**delete_folder**](PdfApi.md#delete_folder) | **DELETE** /storage/folder |
|
18
|
+
[**delete_file**](PdfApi.md#delete_file) | **DELETE** /pdf/storage/file/\{path} | Delete file
|
19
|
+
[**delete_folder**](PdfApi.md#delete_folder) | **DELETE** /pdf/storage/folder/\{path} | Delete folder
|
15
20
|
[**delete_image**](PdfApi.md#delete_image) | **DELETE** /pdf/\{name}/images/\{imageId} | Delete image from document page.
|
16
21
|
[**delete_link_annotation**](PdfApi.md#delete_link_annotation) | **DELETE** /pdf/\{name}/links/\{linkId} | Delete document page link annotation by ID
|
17
22
|
[**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
|
|
23
28
|
[**delete_property**](PdfApi.md#delete_property) | **DELETE** /pdf/\{name}/documentproperties/\{propertyName} | Delete document property.
|
24
29
|
[**delete_stamp**](PdfApi.md#delete_stamp) | **DELETE** /pdf/\{name}/stamps/\{stampId} | Delete document stamp by ID
|
25
30
|
[**delete_table**](PdfApi.md#delete_table) | **DELETE** /pdf/\{name}/tables/\{tableId} | Delete document table by ID
|
31
|
+
[**download_file**](PdfApi.md#download_file) | **GET** /pdf/storage/file/\{path} | Download file
|
32
|
+
[**get_bookmark**](PdfApi.md#get_bookmark) | **GET** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Read document bookmark.
|
33
|
+
[**get_bookmarks**](PdfApi.md#get_bookmarks) | **GET** /pdf/\{name}/bookmarks/list/\{bookmarkPath} | Read document bookmarks node list.
|
26
34
|
[**get_caret_annotation**](PdfApi.md#get_caret_annotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID.
|
27
35
|
[**get_circle_annotation**](PdfApi.md#get_circle_annotation) | **GET** /pdf/\{name}/annotations/circle/\{annotationId} | Read document page circle annotation by ID.
|
28
|
-
[**get_disc_usage**](PdfApi.md#get_disc_usage) | **GET** /storage/disc |
|
36
|
+
[**get_disc_usage**](PdfApi.md#get_disc_usage) | **GET** /pdf/storage/disc | Get disc usage
|
29
37
|
[**get_document**](PdfApi.md#get_document) | **GET** /pdf/\{name} | Read common document info.
|
30
38
|
[**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.
|
31
39
|
[**get_document_attachment_by_index**](PdfApi.md#get_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex} | Read document attachment info by its index.
|
32
40
|
[**get_document_attachments**](PdfApi.md#get_document_attachments) | **GET** /pdf/\{name}/attachments | Read document attachments info.
|
41
|
+
[**get_document_bookmarks**](PdfApi.md#get_document_bookmarks) | **GET** /pdf/\{name}/bookmarks/tree | Read document bookmarks tree.
|
33
42
|
[**get_document_caret_annotations**](PdfApi.md#get_document_caret_annotations) | **GET** /pdf/\{name}/annotations/caret | Read document caret annotations.
|
34
43
|
[**get_document_circle_annotations**](PdfApi.md#get_document_circle_annotations) | **GET** /pdf/\{name}/annotations/circle | Read document circle annotations.
|
35
44
|
[**get_document_file_attachment_annotations**](PdfApi.md#get_document_file_attachment_annotations) | **GET** /pdf/\{name}/annotations/fileattachment | Read document FileAttachment annotations.
|
@@ -55,13 +64,14 @@ Method | HTTP request | Description
|
|
55
64
|
[**get_document_tables**](PdfApi.md#get_document_tables) | **GET** /pdf/\{name}/tables | Read document tables.
|
56
65
|
[**get_document_text_annotations**](PdfApi.md#get_document_text_annotations) | **GET** /pdf/\{name}/annotations/text | Read document text annotations.
|
57
66
|
[**get_document_underline_annotations**](PdfApi.md#get_document_underline_annotations) | **GET** /pdf/\{name}/annotations/underline | Read document underline annotations.
|
58
|
-
[**get_download**](PdfApi.md#get_download) | **GET** /storage/file | Download a specific file
|
59
67
|
[**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.
|
60
68
|
[**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.
|
61
69
|
[**get_field**](PdfApi.md#get_field) | **GET** /pdf/\{name}/fields/\{fieldName} | Get document field by name.
|
62
70
|
[**get_fields**](PdfApi.md#get_fields) | **GET** /pdf/\{name}/fields | Get document fields.
|
63
71
|
[**get_file_attachment_annotation**](PdfApi.md#get_file_attachment_annotation) | **GET** /pdf/\{name}/annotations/fileattachment/\{annotationId} | Read document page FileAttachment annotation by ID.
|
64
72
|
[**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.
|
73
|
+
[**get_file_versions**](PdfApi.md#get_file_versions) | **GET** /pdf/storage/version/\{path} | Get file versions
|
74
|
+
[**get_files_list**](PdfApi.md#get_files_list) | **GET** /pdf/storage/folder/\{path} | Get all files and folders within a folder
|
65
75
|
[**get_free_text_annotation**](PdfApi.md#get_free_text_annotation) | **GET** /pdf/\{name}/annotations/freetext/\{annotationId} | Read document page free text annotation by ID.
|
66
76
|
[**get_highlight_annotation**](PdfApi.md#get_highlight_annotation) | **GET** /pdf/\{name}/annotations/highlight/\{annotationId} | Read document page highlight annotation by ID.
|
67
77
|
[**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.
|
@@ -72,13 +82,9 @@ Method | HTTP request | Description
|
|
72
82
|
[**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
|
73
83
|
[**get_images**](PdfApi.md#get_images) | **GET** /pdf/\{name}/pages/\{pageNumber}/images | Read document images.
|
74
84
|
[**get_ink_annotation**](PdfApi.md#get_ink_annotation) | **GET** /pdf/\{name}/annotations/ink/\{annotationId} | Read document page ink annotation by ID.
|
75
|
-
[**get_is_exist**](PdfApi.md#get_is_exist) | **GET** /storage/exist | Check if a specific file or folder exists
|
76
|
-
[**get_is_storage_exist**](PdfApi.md#get_is_storage_exist) | **GET** /storage/\{name}/exist | Check if storage exists
|
77
85
|
[**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.
|
78
86
|
[**get_line_annotation**](PdfApi.md#get_line_annotation) | **GET** /pdf/\{name}/annotations/line/\{annotationId} | Read document page line annotation by ID.
|
79
87
|
[**get_link_annotation**](PdfApi.md#get_link_annotation) | **GET** /pdf/\{name}/links/\{linkId} | Read document link annotation by ID.
|
80
|
-
[**get_list_file_versions**](PdfApi.md#get_list_file_versions) | **GET** /storage/version | Get the file's versions list
|
81
|
-
[**get_list_files**](PdfApi.md#get_list_files) | **GET** /storage/folder | Get the file listing of a specific folder
|
82
88
|
[**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.
|
83
89
|
[**get_movie_annotation**](PdfApi.md#get_movie_annotation) | **GET** /pdf/\{name}/annotations/movie/\{annotationId} | Read document page movie annotation by ID.
|
84
90
|
[**get_page**](PdfApi.md#get_page) | **GET** /pdf/\{name}/pages/\{pageNumber} | Read document page info.
|
@@ -155,7 +161,11 @@ Method | HTTP request | Description
|
|
155
161
|
[**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.
|
156
162
|
[**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.
|
157
163
|
[**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.
|
164
|
+
[**move_file**](PdfApi.md#move_file) | **PUT** /pdf/storage/file/move/\{srcPath} | Move file
|
165
|
+
[**move_folder**](PdfApi.md#move_folder) | **PUT** /pdf/storage/folder/move/\{srcPath} | Move folder
|
166
|
+
[**object_exists**](PdfApi.md#object_exists) | **GET** /pdf/storage/exist/\{path} | Check if file or folder exists
|
158
167
|
[**post_append_document**](PdfApi.md#post_append_document) | **POST** /pdf/\{name}/appendDocument | Append document to existing one.
|
168
|
+
[**post_bookmark**](PdfApi.md#post_bookmark) | **POST** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Add document bookmarks.
|
159
169
|
[**post_change_password_document_in_storage**](PdfApi.md#post_change_password_document_in_storage) | **POST** /pdf/\{name}/changepassword | Change document password in storage.
|
160
170
|
[**post_create_field**](PdfApi.md#post_create_field) | **POST** /pdf/\{name}/fields | Create field.
|
161
171
|
[**post_decrypt_document_in_storage**](PdfApi.md#post_decrypt_document_in_storage) | **POST** /pdf/\{name}/decrypt | Decrypt document in storage.
|
@@ -168,8 +178,6 @@ Method | HTTP request | Description
|
|
168
178
|
[**post_encrypt_document_in_storage**](PdfApi.md#post_encrypt_document_in_storage) | **POST** /pdf/\{name}/encrypt | Encrypt document in storage.
|
169
179
|
[**post_flatten_document**](PdfApi.md#post_flatten_document) | **POST** /pdf/\{name}/flatten | Flatten the document.
|
170
180
|
[**post_insert_image**](PdfApi.md#post_insert_image) | **POST** /pdf/\{name}/pages/\{pageNumber}/images | Insert image to document page.
|
171
|
-
[**post_move_file**](PdfApi.md#post_move_file) | **POST** /storage/file | Move a specific file
|
172
|
-
[**post_move_folder**](PdfApi.md#post_move_folder) | **POST** /storage/folder | Move a specific folder
|
173
181
|
[**post_move_page**](PdfApi.md#post_move_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/movePage | Move page to new position.
|
174
182
|
[**post_optimize_document**](PdfApi.md#post_optimize_document) | **POST** /pdf/\{name}/optimize | Optimize document.
|
175
183
|
[**post_page_caret_annotations**](PdfApi.md#post_page_caret_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Add document page caret annotations.
|
@@ -204,12 +212,11 @@ Method | HTTP request | Description
|
|
204
212
|
[**put_add_new_page**](PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
|
205
213
|
[**put_add_text**](PdfApi.md#put_add_text) | **PUT** /pdf/\{name}/pages/\{pageNumber}/text | Add text to PDF document page.
|
206
214
|
[**put_annotations_flatten**](PdfApi.md#put_annotations_flatten) | **PUT** /pdf/\{name}/annotations/flatten | Flattens the annotations of the specified types
|
215
|
+
[**put_bookmark**](PdfApi.md#put_bookmark) | **PUT** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Update document bookmark.
|
207
216
|
[**put_caret_annotation**](PdfApi.md#put_caret_annotation) | **PUT** /pdf/\{name}/annotations/caret/\{annotationId} | Replace document caret annotation
|
208
217
|
[**put_change_password_document**](PdfApi.md#put_change_password_document) | **PUT** /pdf/changepassword | Change document password from content.
|
209
218
|
[**put_circle_annotation**](PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation
|
210
|
-
[**put_create**](PdfApi.md#put_create) | **PUT** /storage/file | Upload a specific file
|
211
219
|
[**put_create_document**](PdfApi.md#put_create_document) | **PUT** /pdf/\{name} | Create empty document.
|
212
|
-
[**put_create_folder**](PdfApi.md#put_create_folder) | **PUT** /storage/folder | Create the folder
|
213
220
|
[**put_decrypt_document**](PdfApi.md#put_decrypt_document) | **PUT** /pdf/decrypt | Decrypt document from content.
|
214
221
|
[**put_encrypt_document**](PdfApi.md#put_encrypt_document) | **PUT** /pdf/encrypt | Encrypt document from content.
|
215
222
|
[**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.
|
@@ -299,6 +306,82 @@ Method | HTTP request | Description
|
|
299
306
|
[**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.
|
300
307
|
[**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.
|
301
308
|
[**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.
|
309
|
+
[**storage_exists**](PdfApi.md#storage_exists) | **GET** /pdf/storage/\{storageName}/exist | Check if storage exists
|
310
|
+
[**upload_file**](PdfApi.md#upload_file) | **PUT** /pdf/storage/file/\{path} | Upload file
|
311
|
+
|
312
|
+
|
313
|
+
# **copy_file**
|
314
|
+
> copy_file(src_path, dest_path, opts)
|
315
|
+
|
316
|
+
Copy file
|
317
|
+
|
318
|
+
### Parameters
|
319
|
+
|
320
|
+
Name | Type | Description | Notes
|
321
|
+
------------- | ------------- | ------------- | -------------
|
322
|
+
**src_path** | **String**| Source file path e.g. '/folder/file.ext' |
|
323
|
+
**dest_path** | **String**| Destination file path |
|
324
|
+
**src_storage_name** | **String**| Source storage name | [optional]
|
325
|
+
**dest_storage_name** | **String**| Destination storage name | [optional]
|
326
|
+
**version_id** | **String**| File version ID to copy | [optional]
|
327
|
+
|
328
|
+
### Return type
|
329
|
+
|
330
|
+
nil (empty response body)
|
331
|
+
|
332
|
+
### HTTP request headers
|
333
|
+
|
334
|
+
- **Content-Type**: application/json
|
335
|
+
- **Accept**: application/json
|
336
|
+
|
337
|
+
|
338
|
+
|
339
|
+
# **copy_folder**
|
340
|
+
> copy_folder(src_path, dest_path, opts)
|
341
|
+
|
342
|
+
Copy folder
|
343
|
+
|
344
|
+
### Parameters
|
345
|
+
|
346
|
+
Name | Type | Description | Notes
|
347
|
+
------------- | ------------- | ------------- | -------------
|
348
|
+
**src_path** | **String**| Source folder path e.g. '/src' |
|
349
|
+
**dest_path** | **String**| Destination folder path e.g. '/dst' |
|
350
|
+
**src_storage_name** | **String**| Source storage name | [optional]
|
351
|
+
**dest_storage_name** | **String**| Destination storage name | [optional]
|
352
|
+
|
353
|
+
### Return type
|
354
|
+
|
355
|
+
nil (empty response body)
|
356
|
+
|
357
|
+
### HTTP request headers
|
358
|
+
|
359
|
+
- **Content-Type**: application/json
|
360
|
+
- **Accept**: application/json
|
361
|
+
|
362
|
+
|
363
|
+
|
364
|
+
# **create_folder**
|
365
|
+
> create_folder(path, opts)
|
366
|
+
|
367
|
+
Create the folder
|
368
|
+
|
369
|
+
### Parameters
|
370
|
+
|
371
|
+
Name | Type | Description | Notes
|
372
|
+
------------- | ------------- | ------------- | -------------
|
373
|
+
**path** | **String**| Folder path to create e.g. 'folder_1/folder_2/' |
|
374
|
+
**storage_name** | **String**| Storage name | [optional]
|
375
|
+
|
376
|
+
### Return type
|
377
|
+
|
378
|
+
nil (empty response body)
|
379
|
+
|
380
|
+
### HTTP request headers
|
381
|
+
|
382
|
+
- **Content-Type**: application/json
|
383
|
+
- **Accept**: application/json
|
384
|
+
|
302
385
|
|
303
386
|
|
304
387
|
# **delete_annotation**
|
@@ -326,6 +409,31 @@ Name | Type | Description | Notes
|
|
326
409
|
|
327
410
|
|
328
411
|
|
412
|
+
# **delete_bookmark**
|
413
|
+
> AsposeResponse delete_bookmark(name, bookmark_path, opts)
|
414
|
+
|
415
|
+
Delete document bookmark by ID.
|
416
|
+
|
417
|
+
### Parameters
|
418
|
+
|
419
|
+
Name | Type | Description | Notes
|
420
|
+
------------- | ------------- | ------------- | -------------
|
421
|
+
**name** | **String**| The document name. |
|
422
|
+
**bookmark_path** | **String**| The bookmark path. |
|
423
|
+
**folder** | **String**| The document folder. | [optional]
|
424
|
+
**storage** | **String**| The document storage. | [optional]
|
425
|
+
|
426
|
+
### Return type
|
427
|
+
|
428
|
+
[**AsposeResponse**](AsposeResponse.md)
|
429
|
+
|
430
|
+
### HTTP request headers
|
431
|
+
|
432
|
+
- **Content-Type**: application/json
|
433
|
+
- **Accept**: application/json
|
434
|
+
|
435
|
+
|
436
|
+
|
329
437
|
# **delete_document_annotations**
|
330
438
|
> AsposeResponse delete_document_annotations(name, opts)
|
331
439
|
|
@@ -350,6 +458,30 @@ Name | Type | Description | Notes
|
|
350
458
|
|
351
459
|
|
352
460
|
|
461
|
+
# **delete_document_bookmarks**
|
462
|
+
> AsposeResponse delete_document_bookmarks(name, opts)
|
463
|
+
|
464
|
+
Delete all document bookmarks.
|
465
|
+
|
466
|
+
### Parameters
|
467
|
+
|
468
|
+
Name | Type | Description | Notes
|
469
|
+
------------- | ------------- | ------------- | -------------
|
470
|
+
**name** | **String**| The document name. |
|
471
|
+
**folder** | **String**| The document folder. | [optional]
|
472
|
+
**storage** | **String**| The document storage. | [optional]
|
473
|
+
|
474
|
+
### Return type
|
475
|
+
|
476
|
+
[**AsposeResponse**](AsposeResponse.md)
|
477
|
+
|
478
|
+
### HTTP request headers
|
479
|
+
|
480
|
+
- **Content-Type**: application/json
|
481
|
+
- **Accept**: application/json
|
482
|
+
|
483
|
+
|
484
|
+
|
353
485
|
# **delete_document_link_annotations**
|
354
486
|
> AsposeResponse delete_document_link_annotations(name, opts)
|
355
487
|
|
@@ -448,21 +580,21 @@ Name | Type | Description | Notes
|
|
448
580
|
|
449
581
|
|
450
582
|
# **delete_file**
|
451
|
-
>
|
583
|
+
> delete_file(path, opts)
|
452
584
|
|
453
|
-
|
585
|
+
Delete file
|
454
586
|
|
455
587
|
### Parameters
|
456
588
|
|
457
589
|
Name | Type | Description | Notes
|
458
590
|
------------- | ------------- | ------------- | -------------
|
459
|
-
**path** | **String**|
|
460
|
-
**
|
461
|
-
**
|
591
|
+
**path** | **String**| File path e.g. '/folder/file.ext' |
|
592
|
+
**storage_name** | **String**| Storage name | [optional]
|
593
|
+
**version_id** | **String**| File version ID to delete | [optional]
|
462
594
|
|
463
595
|
### Return type
|
464
596
|
|
465
|
-
|
597
|
+
nil (empty response body)
|
466
598
|
|
467
599
|
### HTTP request headers
|
468
600
|
|
@@ -472,21 +604,21 @@ Name | Type | Description | Notes
|
|
472
604
|
|
473
605
|
|
474
606
|
# **delete_folder**
|
475
|
-
>
|
607
|
+
> delete_folder(path, opts)
|
476
608
|
|
477
|
-
|
609
|
+
Delete folder
|
478
610
|
|
479
611
|
### Parameters
|
480
612
|
|
481
613
|
Name | Type | Description | Notes
|
482
614
|
------------- | ------------- | ------------- | -------------
|
483
|
-
**path** | **String**| Folder path e.g.
|
484
|
-
**
|
485
|
-
**recursive** | **BOOLEAN**|
|
615
|
+
**path** | **String**| Folder path e.g. '/folder' |
|
616
|
+
**storage_name** | **String**| Storage name | [optional]
|
617
|
+
**recursive** | **BOOLEAN**| Enable to delete folders, subfolders and files | [optional] [default to false]
|
486
618
|
|
487
619
|
### Return type
|
488
620
|
|
489
|
-
|
621
|
+
nil (empty response body)
|
490
622
|
|
491
623
|
### HTTP request headers
|
492
624
|
|
@@ -769,6 +901,80 @@ Name | Type | Description | Notes
|
|
769
901
|
|
770
902
|
|
771
903
|
|
904
|
+
# **download_file**
|
905
|
+
> File download_file(path, opts)
|
906
|
+
|
907
|
+
Download file
|
908
|
+
|
909
|
+
### Parameters
|
910
|
+
|
911
|
+
Name | Type | Description | Notes
|
912
|
+
------------- | ------------- | ------------- | -------------
|
913
|
+
**path** | **String**| File path e.g. '/folder/file.ext' |
|
914
|
+
**storage_name** | **String**| Storage name | [optional]
|
915
|
+
**version_id** | **String**| File version ID to download | [optional]
|
916
|
+
|
917
|
+
### Return type
|
918
|
+
|
919
|
+
**File**
|
920
|
+
|
921
|
+
### HTTP request headers
|
922
|
+
|
923
|
+
- **Content-Type**: application/json
|
924
|
+
- **Accept**: multipart/form-data
|
925
|
+
|
926
|
+
|
927
|
+
|
928
|
+
# **get_bookmark**
|
929
|
+
> BookmarkResponse get_bookmark(name, bookmark_path, opts)
|
930
|
+
|
931
|
+
Read document bookmark.
|
932
|
+
|
933
|
+
### Parameters
|
934
|
+
|
935
|
+
Name | Type | Description | Notes
|
936
|
+
------------- | ------------- | ------------- | -------------
|
937
|
+
**name** | **String**| The document name. |
|
938
|
+
**bookmark_path** | **String**| The bookmark path. |
|
939
|
+
**folder** | **String**| The document folder. | [optional]
|
940
|
+
**storage** | **String**| The document storage. | [optional]
|
941
|
+
|
942
|
+
### Return type
|
943
|
+
|
944
|
+
[**BookmarkResponse**](BookmarkResponse.md)
|
945
|
+
|
946
|
+
### HTTP request headers
|
947
|
+
|
948
|
+
- **Content-Type**: application/json
|
949
|
+
- **Accept**: application/json
|
950
|
+
|
951
|
+
|
952
|
+
|
953
|
+
# **get_bookmarks**
|
954
|
+
> BookmarksResponse get_bookmarks(name, bookmark_path, opts)
|
955
|
+
|
956
|
+
Read document bookmarks node list.
|
957
|
+
|
958
|
+
### Parameters
|
959
|
+
|
960
|
+
Name | Type | Description | Notes
|
961
|
+
------------- | ------------- | ------------- | -------------
|
962
|
+
**name** | **String**| The document name. |
|
963
|
+
**bookmark_path** | **String**| The bookmark path. |
|
964
|
+
**folder** | **String**| The document folder. | [optional]
|
965
|
+
**storage** | **String**| The document storage. | [optional]
|
966
|
+
|
967
|
+
### Return type
|
968
|
+
|
969
|
+
[**BookmarksResponse**](BookmarksResponse.md)
|
970
|
+
|
971
|
+
### HTTP request headers
|
972
|
+
|
973
|
+
- **Content-Type**: application/json
|
974
|
+
- **Accept**: application/json
|
975
|
+
|
976
|
+
|
977
|
+
|
772
978
|
# **get_caret_annotation**
|
773
979
|
> CaretAnnotationResponse get_caret_annotation(name, annotation_id, opts)
|
774
980
|
|
@@ -820,19 +1026,19 @@ Name | Type | Description | Notes
|
|
820
1026
|
|
821
1027
|
|
822
1028
|
# **get_disc_usage**
|
823
|
-
>
|
1029
|
+
> DiscUsage get_disc_usage(opts)
|
824
1030
|
|
825
|
-
|
1031
|
+
Get disc usage
|
826
1032
|
|
827
1033
|
### Parameters
|
828
1034
|
|
829
1035
|
Name | Type | Description | Notes
|
830
1036
|
------------- | ------------- | ------------- | -------------
|
831
|
-
**
|
1037
|
+
**storage_name** | **String**| Storage name | [optional]
|
832
1038
|
|
833
1039
|
### Return type
|
834
1040
|
|
835
|
-
[**
|
1041
|
+
[**DiscUsage**](DiscUsage.md)
|
836
1042
|
|
837
1043
|
### HTTP request headers
|
838
1044
|
|
@@ -938,6 +1144,30 @@ Name | Type | Description | Notes
|
|
938
1144
|
|
939
1145
|
|
940
1146
|
|
1147
|
+
# **get_document_bookmarks**
|
1148
|
+
> BookmarksResponse get_document_bookmarks(name, opts)
|
1149
|
+
|
1150
|
+
Read document bookmarks tree.
|
1151
|
+
|
1152
|
+
### Parameters
|
1153
|
+
|
1154
|
+
Name | Type | Description | Notes
|
1155
|
+
------------- | ------------- | ------------- | -------------
|
1156
|
+
**name** | **String**| The document name. |
|
1157
|
+
**folder** | **String**| The document folder. | [optional]
|
1158
|
+
**storage** | **String**| The document storage. | [optional]
|
1159
|
+
|
1160
|
+
### Return type
|
1161
|
+
|
1162
|
+
[**BookmarksResponse**](BookmarksResponse.md)
|
1163
|
+
|
1164
|
+
### HTTP request headers
|
1165
|
+
|
1166
|
+
- **Content-Type**: application/json
|
1167
|
+
- **Accept**: application/json
|
1168
|
+
|
1169
|
+
|
1170
|
+
|
941
1171
|
# **get_document_caret_annotations**
|
942
1172
|
> CaretAnnotationsResponse get_document_caret_annotations(name, opts)
|
943
1173
|
|
@@ -1540,30 +1770,6 @@ Name | Type | Description | Notes
|
|
1540
1770
|
|
1541
1771
|
|
1542
1772
|
|
1543
|
-
# **get_download**
|
1544
|
-
> File get_download(path, opts)
|
1545
|
-
|
1546
|
-
Download a specific file
|
1547
|
-
|
1548
|
-
### Parameters
|
1549
|
-
|
1550
|
-
Name | Type | Description | Notes
|
1551
|
-
------------- | ------------- | ------------- | -------------
|
1552
|
-
**path** | **String**| Path of the file including the file name and extension e.g. /file.ext |
|
1553
|
-
**version_id** | **String**| File's version | [optional]
|
1554
|
-
**storage** | **String**| User's storage name | [optional]
|
1555
|
-
|
1556
|
-
### Return type
|
1557
|
-
|
1558
|
-
**File**
|
1559
|
-
|
1560
|
-
### HTTP request headers
|
1561
|
-
|
1562
|
-
- **Content-Type**: application/json
|
1563
|
-
- **Accept**: multipart/form-data
|
1564
|
-
|
1565
|
-
|
1566
|
-
|
1567
1773
|
# **get_download_document_attachment_by_index**
|
1568
1774
|
> File get_download_document_attachment_by_index(name, attachment_index, opts)
|
1569
1775
|
|
@@ -1682,7 +1888,7 @@ Name | Type | Description | Notes
|
|
1682
1888
|
### HTTP request headers
|
1683
1889
|
|
1684
1890
|
- **Content-Type**: application/json
|
1685
|
-
- **Accept**:
|
1891
|
+
- **Accept**: application/json
|
1686
1892
|
|
1687
1893
|
|
1688
1894
|
|
@@ -1711,6 +1917,52 @@ Name | Type | Description | Notes
|
|
1711
1917
|
|
1712
1918
|
|
1713
1919
|
|
1920
|
+
# **get_file_versions**
|
1921
|
+
> FileVersions get_file_versions(path, opts)
|
1922
|
+
|
1923
|
+
Get file versions
|
1924
|
+
|
1925
|
+
### Parameters
|
1926
|
+
|
1927
|
+
Name | Type | Description | Notes
|
1928
|
+
------------- | ------------- | ------------- | -------------
|
1929
|
+
**path** | **String**| File path e.g. '/file.ext' |
|
1930
|
+
**storage_name** | **String**| Storage name | [optional]
|
1931
|
+
|
1932
|
+
### Return type
|
1933
|
+
|
1934
|
+
[**FileVersions**](FileVersions.md)
|
1935
|
+
|
1936
|
+
### HTTP request headers
|
1937
|
+
|
1938
|
+
- **Content-Type**: application/json
|
1939
|
+
- **Accept**: application/json
|
1940
|
+
|
1941
|
+
|
1942
|
+
|
1943
|
+
# **get_files_list**
|
1944
|
+
> FilesList get_files_list(path, opts)
|
1945
|
+
|
1946
|
+
Get all files and folders within a folder
|
1947
|
+
|
1948
|
+
### Parameters
|
1949
|
+
|
1950
|
+
Name | Type | Description | Notes
|
1951
|
+
------------- | ------------- | ------------- | -------------
|
1952
|
+
**path** | **String**| Folder path e.g. '/folder' |
|
1953
|
+
**storage_name** | **String**| Storage name | [optional]
|
1954
|
+
|
1955
|
+
### Return type
|
1956
|
+
|
1957
|
+
[**FilesList**](FilesList.md)
|
1958
|
+
|
1959
|
+
### HTTP request headers
|
1960
|
+
|
1961
|
+
- **Content-Type**: application/json
|
1962
|
+
- **Accept**: application/json
|
1963
|
+
|
1964
|
+
|
1965
|
+
|
1714
1966
|
# **get_free_text_annotation**
|
1715
1967
|
> FreeTextAnnotationResponse get_free_text_annotation(name, annotation_id, opts)
|
1716
1968
|
|
@@ -1813,7 +2065,7 @@ Name | Type | Description | Notes
|
|
1813
2065
|
### HTTP request headers
|
1814
2066
|
|
1815
2067
|
- **Content-Type**: application/json
|
1816
|
-
- **Accept**:
|
2068
|
+
- **Accept**: application/json
|
1817
2069
|
|
1818
2070
|
|
1819
2071
|
|
@@ -1828,8 +2080,8 @@ Name | Type | Description | Notes
|
|
1828
2080
|
------------- | ------------- | ------------- | -------------
|
1829
2081
|
**name** | **String**| The document name. |
|
1830
2082
|
**image_id** | **String**| Image ID. |
|
1831
|
-
**width** | **Integer**| The converted image width. | [optional]
|
1832
|
-
**height** | **Integer**| The converted image height. | [optional]
|
2083
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
2084
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
1833
2085
|
**storage** | **String**| The document storage. | [optional]
|
1834
2086
|
**folder** | **String**| The document folder. | [optional]
|
1835
2087
|
|
@@ -1855,8 +2107,8 @@ Name | Type | Description | Notes
|
|
1855
2107
|
------------- | ------------- | ------------- | -------------
|
1856
2108
|
**name** | **String**| The document name. |
|
1857
2109
|
**image_id** | **String**| Image ID. |
|
1858
|
-
**width** | **Integer**| The converted image width. | [optional]
|
1859
|
-
**height** | **Integer**| The converted image height. | [optional]
|
2110
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
2111
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
1860
2112
|
**storage** | **String**| The document storage. | [optional]
|
1861
2113
|
**folder** | **String**| The document folder. | [optional]
|
1862
2114
|
|
@@ -1882,8 +2134,8 @@ Name | Type | Description | Notes
|
|
1882
2134
|
------------- | ------------- | ------------- | -------------
|
1883
2135
|
**name** | **String**| The document name. |
|
1884
2136
|
**image_id** | **String**| Image ID. |
|
1885
|
-
**width** | **Integer**| The converted image width. | [optional]
|
1886
|
-
**height** | **Integer**| The converted image height. | [optional]
|
2137
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
2138
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
1887
2139
|
**storage** | **String**| The document storage. | [optional]
|
1888
2140
|
**folder** | **String**| The document folder. | [optional]
|
1889
2141
|
|
@@ -1909,8 +2161,8 @@ Name | Type | Description | Notes
|
|
1909
2161
|
------------- | ------------- | ------------- | -------------
|
1910
2162
|
**name** | **String**| The document name. |
|
1911
2163
|
**image_id** | **String**| Image ID. |
|
1912
|
-
**width** | **Integer**| The converted image width. | [optional]
|
1913
|
-
**height** | **Integer**| The converted image height. | [optional]
|
2164
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
2165
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
1914
2166
|
**storage** | **String**| The document storage. | [optional]
|
1915
2167
|
**folder** | **String**| The document folder. | [optional]
|
1916
2168
|
|
@@ -1975,52 +2227,6 @@ Name | Type | Description | Notes
|
|
1975
2227
|
|
1976
2228
|
|
1977
2229
|
|
1978
|
-
# **get_is_exist**
|
1979
|
-
> FileExistResponse get_is_exist(path, opts)
|
1980
|
-
|
1981
|
-
Check if a specific file or folder exists
|
1982
|
-
|
1983
|
-
### Parameters
|
1984
|
-
|
1985
|
-
Name | Type | Description | Notes
|
1986
|
-
------------- | ------------- | ------------- | -------------
|
1987
|
-
**path** | **String**| File or folder path e.g. /file.ext or /Folder1 |
|
1988
|
-
**version_id** | **String**| File's version | [optional]
|
1989
|
-
**storage** | **String**| User's storage name | [optional]
|
1990
|
-
|
1991
|
-
### Return type
|
1992
|
-
|
1993
|
-
[**FileExistResponse**](FileExistResponse.md)
|
1994
|
-
|
1995
|
-
### HTTP request headers
|
1996
|
-
|
1997
|
-
- **Content-Type**: application/json
|
1998
|
-
- **Accept**: application/json
|
1999
|
-
|
2000
|
-
|
2001
|
-
|
2002
|
-
# **get_is_storage_exist**
|
2003
|
-
> StorageExistResponse get_is_storage_exist(name)
|
2004
|
-
|
2005
|
-
Check if storage exists
|
2006
|
-
|
2007
|
-
### Parameters
|
2008
|
-
|
2009
|
-
Name | Type | Description | Notes
|
2010
|
-
------------- | ------------- | ------------- | -------------
|
2011
|
-
**name** | **String**| Storage name |
|
2012
|
-
|
2013
|
-
### Return type
|
2014
|
-
|
2015
|
-
[**StorageExistResponse**](StorageExistResponse.md)
|
2016
|
-
|
2017
|
-
### HTTP request headers
|
2018
|
-
|
2019
|
-
- **Content-Type**: application/json
|
2020
|
-
- **Accept**: application/json
|
2021
|
-
|
2022
|
-
|
2023
|
-
|
2024
2230
|
# **get_la_te_x_in_storage_to_pdf**
|
2025
2231
|
> File get_la_te_x_in_storage_to_pdf(src_path, opts)
|
2026
2232
|
|
@@ -2094,52 +2300,6 @@ Name | Type | Description | Notes
|
|
2094
2300
|
|
2095
2301
|
|
2096
2302
|
|
2097
|
-
# **get_list_file_versions**
|
2098
|
-
> FileVersionsResponse get_list_file_versions(path, opts)
|
2099
|
-
|
2100
|
-
Get the file's versions list
|
2101
|
-
|
2102
|
-
### Parameters
|
2103
|
-
|
2104
|
-
Name | Type | Description | Notes
|
2105
|
-
------------- | ------------- | ------------- | -------------
|
2106
|
-
**path** | **String**| File path e.g. /file.ext or /Folder1/file.ext |
|
2107
|
-
**storage** | **String**| User's storage name | [optional]
|
2108
|
-
|
2109
|
-
### Return type
|
2110
|
-
|
2111
|
-
[**FileVersionsResponse**](FileVersionsResponse.md)
|
2112
|
-
|
2113
|
-
### HTTP request headers
|
2114
|
-
|
2115
|
-
- **Content-Type**: application/json
|
2116
|
-
- **Accept**: application/json
|
2117
|
-
|
2118
|
-
|
2119
|
-
|
2120
|
-
# **get_list_files**
|
2121
|
-
> FilesResponse get_list_files(opts)
|
2122
|
-
|
2123
|
-
Get the file listing of a specific folder
|
2124
|
-
|
2125
|
-
### Parameters
|
2126
|
-
|
2127
|
-
Name | Type | Description | Notes
|
2128
|
-
------------- | ------------- | ------------- | -------------
|
2129
|
-
**path** | **String**| Start with name of storage e.g. root folder '/'or some folder '/folder1/..' | [optional] [default to /]
|
2130
|
-
**storage** | **String**| User's storage name | [optional]
|
2131
|
-
|
2132
|
-
### Return type
|
2133
|
-
|
2134
|
-
[**FilesResponse**](FilesResponse.md)
|
2135
|
-
|
2136
|
-
### HTTP request headers
|
2137
|
-
|
2138
|
-
- **Content-Type**: application/json
|
2139
|
-
- **Accept**: application/json
|
2140
|
-
|
2141
|
-
|
2142
|
-
|
2143
2303
|
# **get_mht_in_storage_to_pdf**
|
2144
2304
|
> File get_mht_in_storage_to_pdf(src_path, opts)
|
2145
2305
|
|
@@ -2209,7 +2369,7 @@ Name | Type | Description | Notes
|
|
2209
2369
|
### HTTP request headers
|
2210
2370
|
|
2211
2371
|
- **Content-Type**: application/json
|
2212
|
-
- **Accept**:
|
2372
|
+
- **Accept**: application/json
|
2213
2373
|
|
2214
2374
|
|
2215
2375
|
|
@@ -2299,8 +2459,8 @@ Name | Type | Description | Notes
|
|
2299
2459
|
------------- | ------------- | ------------- | -------------
|
2300
2460
|
**name** | **String**| The document name. |
|
2301
2461
|
**page_number** | **Integer**| The page number. |
|
2302
|
-
**width** | **Integer**| The converted image width. | [optional]
|
2303
|
-
**height** | **Integer**| The converted image height. | [optional]
|
2462
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
2463
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
2304
2464
|
**folder** | **String**| The document folder. | [optional]
|
2305
2465
|
**storage** | **String**| The document storage. | [optional]
|
2306
2466
|
|
@@ -2326,8 +2486,8 @@ Name | Type | Description | Notes
|
|
2326
2486
|
------------- | ------------- | ------------- | -------------
|
2327
2487
|
**name** | **String**| The document name. |
|
2328
2488
|
**page_number** | **Integer**| The page number. |
|
2329
|
-
**width** | **Integer**| The converted image width. | [optional]
|
2330
|
-
**height** | **Integer**| The converted image height. | [optional]
|
2489
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
2490
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
2331
2491
|
**folder** | **String**| The document folder. | [optional]
|
2332
2492
|
**storage** | **String**| The document storage. | [optional]
|
2333
2493
|
|
@@ -2353,8 +2513,8 @@ Name | Type | Description | Notes
|
|
2353
2513
|
------------- | ------------- | ------------- | -------------
|
2354
2514
|
**name** | **String**| The document name. |
|
2355
2515
|
**page_number** | **Integer**| The page number. |
|
2356
|
-
**width** | **Integer**| The converted image width. | [optional]
|
2357
|
-
**height** | **Integer**| The converted image height. | [optional]
|
2516
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
2517
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
2358
2518
|
**folder** | **String**| The document folder. | [optional]
|
2359
2519
|
**storage** | **String**| The document storage. | [optional]
|
2360
2520
|
|
@@ -2380,8 +2540,8 @@ Name | Type | Description | Notes
|
|
2380
2540
|
------------- | ------------- | ------------- | -------------
|
2381
2541
|
**name** | **String**| The document name. |
|
2382
2542
|
**page_number** | **Integer**| The page number. |
|
2383
|
-
**width** | **Integer**| The converted image width. | [optional]
|
2384
|
-
**height** | **Integer**| The converted image height. | [optional]
|
2543
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
2544
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
2385
2545
|
**folder** | **String**| The document folder. | [optional]
|
2386
2546
|
**storage** | **String**| The document storage. | [optional]
|
2387
2547
|
|
@@ -2407,8 +2567,8 @@ Name | Type | Description | Notes
|
|
2407
2567
|
------------- | ------------- | ------------- | -------------
|
2408
2568
|
**name** | **String**| The document name. |
|
2409
2569
|
**page_number** | **Integer**| The page number. |
|
2410
|
-
**width** | **Integer**| The converted image width. | [optional]
|
2411
|
-
**height** | **Integer**| The converted image height. | [optional]
|
2570
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
2571
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
2412
2572
|
**folder** | **String**| The document folder. | [optional]
|
2413
2573
|
**storage** | **String**| The document storage. | [optional]
|
2414
2574
|
|
@@ -2434,8 +2594,8 @@ Name | Type | Description | Notes
|
|
2434
2594
|
------------- | ------------- | ------------- | -------------
|
2435
2595
|
**name** | **String**| The document name. |
|
2436
2596
|
**page_number** | **Integer**| The page number. |
|
2437
|
-
**width** | **Integer**| The converted image width. | [optional]
|
2438
|
-
**height** | **Integer**| The converted image height. | [optional]
|
2597
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
2598
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
2439
2599
|
**folder** | **String**| The document folder. | [optional]
|
2440
2600
|
**storage** | **String**| The document storage. | [optional]
|
2441
2601
|
|
@@ -2968,7 +3128,7 @@ Name | Type | Description | Notes
|
|
2968
3128
|
**ury** | **Float**| Y - coordinate of upper-right corner. |
|
2969
3129
|
**format** | **Array<String>**| List of formats for search. | [optional]
|
2970
3130
|
**regex** | **String**| Formats are specified as a regular expression. | [optional]
|
2971
|
-
**split_rects** | **BOOLEAN**| Split result fragments (default is true). | [optional]
|
3131
|
+
**split_rects** | **BOOLEAN**| Split result fragments (default is true). | [optional] [default to true]
|
2972
3132
|
**folder** | **String**| The document folder. | [optional]
|
2973
3133
|
**storage** | **String**| The document storage. | [optional]
|
2974
3134
|
|
@@ -3601,7 +3761,7 @@ Name | Type | Description | Notes
|
|
3601
3761
|
### HTTP request headers
|
3602
3762
|
|
3603
3763
|
- **Content-Type**: application/json
|
3604
|
-
- **Accept**:
|
3764
|
+
- **Accept**: application/json
|
3605
3765
|
|
3606
3766
|
|
3607
3767
|
|
@@ -3651,7 +3811,7 @@ Name | Type | Description | Notes
|
|
3651
3811
|
### HTTP request headers
|
3652
3812
|
|
3653
3813
|
- **Content-Type**: application/json
|
3654
|
-
- **Accept**:
|
3814
|
+
- **Accept**: application/json
|
3655
3815
|
|
3656
3816
|
|
3657
3817
|
|
@@ -3877,7 +4037,7 @@ Name | Type | Description | Notes
|
|
3877
4037
|
**ury** | **Float**| Y - coordinate of upper-right corner. |
|
3878
4038
|
**format** | **Array<String>**| List of formats for search. | [optional]
|
3879
4039
|
**regex** | **String**| Formats are specified as a regular expression. | [optional]
|
3880
|
-
**split_rects** | **BOOLEAN**| Split result fragments (default is true). | [optional]
|
4040
|
+
**split_rects** | **BOOLEAN**| Split result fragments (default is true). | [optional] [default to true]
|
3881
4041
|
**folder** | **String**| The document folder. | [optional]
|
3882
4042
|
**storage** | **String**| The document storage. | [optional]
|
3883
4043
|
|
@@ -4115,8 +4275,83 @@ Name | Type | Description | Notes
|
|
4115
4275
|
|
4116
4276
|
|
4117
4277
|
|
4278
|
+
# **move_file**
|
4279
|
+
> move_file(src_path, dest_path, opts)
|
4280
|
+
|
4281
|
+
Move file
|
4282
|
+
|
4283
|
+
### Parameters
|
4284
|
+
|
4285
|
+
Name | Type | Description | Notes
|
4286
|
+
------------- | ------------- | ------------- | -------------
|
4287
|
+
**src_path** | **String**| Source file path e.g. '/src.ext' |
|
4288
|
+
**dest_path** | **String**| Destination file path e.g. '/dest.ext' |
|
4289
|
+
**src_storage_name** | **String**| Source storage name | [optional]
|
4290
|
+
**dest_storage_name** | **String**| Destination storage name | [optional]
|
4291
|
+
**version_id** | **String**| File version ID to move | [optional]
|
4292
|
+
|
4293
|
+
### Return type
|
4294
|
+
|
4295
|
+
nil (empty response body)
|
4296
|
+
|
4297
|
+
### HTTP request headers
|
4298
|
+
|
4299
|
+
- **Content-Type**: application/json
|
4300
|
+
- **Accept**: application/json
|
4301
|
+
|
4302
|
+
|
4303
|
+
|
4304
|
+
# **move_folder**
|
4305
|
+
> move_folder(src_path, dest_path, opts)
|
4306
|
+
|
4307
|
+
Move folder
|
4308
|
+
|
4309
|
+
### Parameters
|
4310
|
+
|
4311
|
+
Name | Type | Description | Notes
|
4312
|
+
------------- | ------------- | ------------- | -------------
|
4313
|
+
**src_path** | **String**| Folder path to move e.g. '/folder' |
|
4314
|
+
**dest_path** | **String**| Destination folder path to move to e.g '/dst' |
|
4315
|
+
**src_storage_name** | **String**| Source storage name | [optional]
|
4316
|
+
**dest_storage_name** | **String**| Destination storage name | [optional]
|
4317
|
+
|
4318
|
+
### Return type
|
4319
|
+
|
4320
|
+
nil (empty response body)
|
4321
|
+
|
4322
|
+
### HTTP request headers
|
4323
|
+
|
4324
|
+
- **Content-Type**: application/json
|
4325
|
+
- **Accept**: application/json
|
4326
|
+
|
4327
|
+
|
4328
|
+
|
4329
|
+
# **object_exists**
|
4330
|
+
> ObjectExist object_exists(path, opts)
|
4331
|
+
|
4332
|
+
Check if file or folder exists
|
4333
|
+
|
4334
|
+
### Parameters
|
4335
|
+
|
4336
|
+
Name | Type | Description | Notes
|
4337
|
+
------------- | ------------- | ------------- | -------------
|
4338
|
+
**path** | **String**| File or folder path e.g. '/file.ext' or '/folder' |
|
4339
|
+
**storage_name** | **String**| Storage name | [optional]
|
4340
|
+
**version_id** | **String**| File version ID | [optional]
|
4341
|
+
|
4342
|
+
### Return type
|
4343
|
+
|
4344
|
+
[**ObjectExist**](ObjectExist.md)
|
4345
|
+
|
4346
|
+
### HTTP request headers
|
4347
|
+
|
4348
|
+
- **Content-Type**: application/json
|
4349
|
+
- **Accept**: application/json
|
4350
|
+
|
4351
|
+
|
4352
|
+
|
4118
4353
|
# **post_append_document**
|
4119
|
-
> DocumentResponse post_append_document(name, opts)
|
4354
|
+
> DocumentResponse post_append_document(name, append_file, opts)
|
4120
4355
|
|
4121
4356
|
Append document to existing one.
|
4122
4357
|
|
@@ -4125,8 +4360,7 @@ Append document to existing one.
|
|
4125
4360
|
Name | Type | Description | Notes
|
4126
4361
|
------------- | ------------- | ------------- | -------------
|
4127
4362
|
**name** | **String**| The original document name. |
|
4128
|
-
**
|
4129
|
-
**append_file** | **String**| Append file server path. | [optional]
|
4363
|
+
**append_file** | **String**| Append file server path. |
|
4130
4364
|
**start_page** | **Integer**| Appending start page. | [optional] [default to 0]
|
4131
4365
|
**end_page** | **Integer**| Appending end page. | [optional] [default to 0]
|
4132
4366
|
**storage** | **String**| The documents storage. | [optional]
|
@@ -4143,6 +4377,32 @@ Name | Type | Description | Notes
|
|
4143
4377
|
|
4144
4378
|
|
4145
4379
|
|
4380
|
+
# **post_bookmark**
|
4381
|
+
> BookmarksResponse post_bookmark(name, bookmark_path, bookmarks, opts)
|
4382
|
+
|
4383
|
+
Add document bookmarks.
|
4384
|
+
|
4385
|
+
### Parameters
|
4386
|
+
|
4387
|
+
Name | Type | Description | Notes
|
4388
|
+
------------- | ------------- | ------------- | -------------
|
4389
|
+
**name** | **String**| The document name. |
|
4390
|
+
**bookmark_path** | **String**| The bookmark path. |
|
4391
|
+
**bookmarks** | [**Array<Bookmark>**](Bookmark.md)| The array of bookmark. |
|
4392
|
+
**folder** | **String**| The document folder. | [optional]
|
4393
|
+
**storage** | **String**| The document storage. | [optional]
|
4394
|
+
|
4395
|
+
### Return type
|
4396
|
+
|
4397
|
+
[**BookmarksResponse**](BookmarksResponse.md)
|
4398
|
+
|
4399
|
+
### HTTP request headers
|
4400
|
+
|
4401
|
+
- **Content-Type**: application/json
|
4402
|
+
- **Accept**: application/json
|
4403
|
+
|
4404
|
+
|
4405
|
+
|
4146
4406
|
# **post_change_password_document_in_storage**
|
4147
4407
|
> AsposeResponse post_change_password_document_in_storage(name, owner_password, new_user_password, new_owner_password, opts)
|
4148
4408
|
|
@@ -4171,7 +4431,7 @@ Name | Type | Description | Notes
|
|
4171
4431
|
|
4172
4432
|
|
4173
4433
|
# **post_create_field**
|
4174
|
-
> AsposeResponse post_create_field(name, page, opts)
|
4434
|
+
> AsposeResponse post_create_field(name, page, field, opts)
|
4175
4435
|
|
4176
4436
|
Create field.
|
4177
4437
|
|
@@ -4181,7 +4441,7 @@ Name | Type | Description | Notes
|
|
4181
4441
|
------------- | ------------- | ------------- | -------------
|
4182
4442
|
**name** | **String**| The document name. |
|
4183
4443
|
**page** | **Integer**| Document page number. |
|
4184
|
-
**field** | [**Field**](Field.md)| with the field data. |
|
4444
|
+
**field** | [**Field**](Field.md)| Field with the field data. |
|
4185
4445
|
**storage** | **String**| The document storage. | [optional]
|
4186
4446
|
**folder** | **String**| The document folder. | [optional]
|
4187
4447
|
|
@@ -4393,8 +4653,8 @@ Name | Type | Description | Notes
|
|
4393
4653
|
**name** | **String**| Document name. |
|
4394
4654
|
**user_password** | **String**| User password (encrypted Base64). |
|
4395
4655
|
**owner_password** | **String**| Owner password (encrypted Base64). |
|
4396
|
-
**crypto_algorithm** | **String**| Cryptographic algorithm, see
|
4397
|
-
**permissions_flags** | [**Array<PermissionsFlags>**](PermissionsFlags.md)| Array of document permissions, see
|
4656
|
+
**crypto_algorithm** | **String**| Cryptographic algorithm, see CryptoAlgorithm for details. |
|
4657
|
+
**permissions_flags** | [**Array<PermissionsFlags>**](PermissionsFlags.md)| Array of document permissions, see PermissionsFlags for details. | [optional]
|
4398
4658
|
**use_pdf20** | **BOOLEAN**| Support for revision 6 (Extension 8). | [optional]
|
4399
4659
|
**storage** | **String**| The document storage. | [optional]
|
4400
4660
|
**folder** | **String**| The document folder. | [optional]
|
@@ -4468,57 +4728,6 @@ Name | Type | Description | Notes
|
|
4468
4728
|
|
4469
4729
|
|
4470
4730
|
|
4471
|
-
# **post_move_file**
|
4472
|
-
> AsposeResponse post_move_file(src, dest, opts)
|
4473
|
-
|
4474
|
-
Move a specific file
|
4475
|
-
|
4476
|
-
### Parameters
|
4477
|
-
|
4478
|
-
Name | Type | Description | Notes
|
4479
|
-
------------- | ------------- | ------------- | -------------
|
4480
|
-
**src** | **String**| Source file path e.g. /fileSource.ext |
|
4481
|
-
**dest** | **String**| Destination file path e.g. /fileDestination.ext |
|
4482
|
-
**version_id** | **String**| Source file's version, | [optional]
|
4483
|
-
**storage** | **String**| User's source storage name | [optional]
|
4484
|
-
**dest_storage** | **String**| User's destination storage name | [optional]
|
4485
|
-
|
4486
|
-
### Return type
|
4487
|
-
|
4488
|
-
[**AsposeResponse**](AsposeResponse.md)
|
4489
|
-
|
4490
|
-
### HTTP request headers
|
4491
|
-
|
4492
|
-
- **Content-Type**: multipart/form-data
|
4493
|
-
- **Accept**: application/json
|
4494
|
-
|
4495
|
-
|
4496
|
-
|
4497
|
-
# **post_move_folder**
|
4498
|
-
> AsposeResponse post_move_folder(src, dest, opts)
|
4499
|
-
|
4500
|
-
Move a specific folder
|
4501
|
-
|
4502
|
-
### Parameters
|
4503
|
-
|
4504
|
-
Name | Type | Description | Notes
|
4505
|
-
------------- | ------------- | ------------- | -------------
|
4506
|
-
**src** | **String**| Source folder path e.g. /Folder1 |
|
4507
|
-
**dest** | **String**| Destination folder path e.g. /Folder2 |
|
4508
|
-
**storage** | **String**| User's source storage name | [optional]
|
4509
|
-
**dest_storage** | **String**| User's destination storage name | [optional]
|
4510
|
-
|
4511
|
-
### Return type
|
4512
|
-
|
4513
|
-
[**AsposeResponse**](AsposeResponse.md)
|
4514
|
-
|
4515
|
-
### HTTP request headers
|
4516
|
-
|
4517
|
-
- **Content-Type**: application/json
|
4518
|
-
- **Accept**: application/json
|
4519
|
-
|
4520
|
-
|
4521
|
-
|
4522
4731
|
# **post_move_page**
|
4523
4732
|
> AsposeResponse post_move_page(name, page_number, new_index, opts)
|
4524
4733
|
|
@@ -4546,7 +4755,7 @@ Name | Type | Description | Notes
|
|
4546
4755
|
|
4547
4756
|
|
4548
4757
|
# **post_optimize_document**
|
4549
|
-
> AsposeResponse post_optimize_document(name, opts)
|
4758
|
+
> AsposeResponse post_optimize_document(name, options, opts)
|
4550
4759
|
|
4551
4760
|
Optimize document.
|
4552
4761
|
|
@@ -4555,7 +4764,7 @@ Optimize document.
|
|
4555
4764
|
Name | Type | Description | Notes
|
4556
4765
|
------------- | ------------- | ------------- | -------------
|
4557
4766
|
**name** | **String**| The document name. |
|
4558
|
-
**options** | [**OptimizeOptions**](OptimizeOptions.md)| The optimization options. |
|
4767
|
+
**options** | [**OptimizeOptions**](OptimizeOptions.md)| The optimization options. |
|
4559
4768
|
**storage** | **String**| The document storage. | [optional]
|
4560
4769
|
**folder** | **String**| The document folder. | [optional]
|
4561
4770
|
|
@@ -5247,7 +5456,7 @@ Name | Type | Description | Notes
|
|
5247
5456
|
|
5248
5457
|
|
5249
5458
|
# **post_sign_document**
|
5250
|
-
> AsposeResponse post_sign_document(name, opts)
|
5459
|
+
> AsposeResponse post_sign_document(name, sign, opts)
|
5251
5460
|
|
5252
5461
|
Sign document.
|
5253
5462
|
|
@@ -5256,7 +5465,7 @@ Sign document.
|
|
5256
5465
|
Name | Type | Description | Notes
|
5257
5466
|
------------- | ------------- | ------------- | -------------
|
5258
5467
|
**name** | **String**| The document name. |
|
5259
|
-
**
|
5468
|
+
**sign** | [**Signature**](Signature.md)| Signature object containing signature data. |
|
5260
5469
|
**storage** | **String**| The document storage. | [optional]
|
5261
5470
|
**folder** | **String**| The document folder. | [optional]
|
5262
5471
|
|
@@ -5272,7 +5481,7 @@ Name | Type | Description | Notes
|
|
5272
5481
|
|
5273
5482
|
|
5274
5483
|
# **post_sign_page**
|
5275
|
-
> AsposeResponse post_sign_page(name, page_number, opts)
|
5484
|
+
> AsposeResponse post_sign_page(name, page_number, sign, opts)
|
5276
5485
|
|
5277
5486
|
Sign page.
|
5278
5487
|
|
@@ -5282,7 +5491,7 @@ Name | Type | Description | Notes
|
|
5282
5491
|
------------- | ------------- | ------------- | -------------
|
5283
5492
|
**name** | **String**| The document name. |
|
5284
5493
|
**page_number** | **Integer**| The page number. |
|
5285
|
-
**
|
5494
|
+
**sign** | [**Signature**](Signature.md)| Signature object containing signature data. |
|
5286
5495
|
**storage** | **String**| The document storage. | [optional]
|
5287
5496
|
**folder** | **String**| The document folder. | [optional]
|
5288
5497
|
|
@@ -5349,7 +5558,7 @@ Name | Type | Description | Notes
|
|
5349
5558
|
|
5350
5559
|
|
5351
5560
|
# **put_add_text**
|
5352
|
-
> AsposeResponse put_add_text(name, page_number, opts)
|
5561
|
+
> AsposeResponse put_add_text(name, page_number, paragraph, opts)
|
5353
5562
|
|
5354
5563
|
Add text to PDF document page.
|
5355
5564
|
|
@@ -5359,7 +5568,7 @@ Name | Type | Description | Notes
|
|
5359
5568
|
------------- | ------------- | ------------- | -------------
|
5360
5569
|
**name** | **String**| The document name. |
|
5361
5570
|
**page_number** | **Integer**| Number of page (starting from 1). |
|
5362
|
-
**paragraph** | [**Paragraph**](Paragraph.md)| Paragraph data. |
|
5571
|
+
**paragraph** | [**Paragraph**](Paragraph.md)| Paragraph data. |
|
5363
5572
|
**folder** | **String**| Document folder. | [optional]
|
5364
5573
|
**storage** | **String**| The document storage. | [optional]
|
5365
5574
|
|
@@ -5401,6 +5610,32 @@ Name | Type | Description | Notes
|
|
5401
5610
|
|
5402
5611
|
|
5403
5612
|
|
5613
|
+
# **put_bookmark**
|
5614
|
+
> BookmarkResponse put_bookmark(name, bookmark_path, bookmark, opts)
|
5615
|
+
|
5616
|
+
Update document bookmark.
|
5617
|
+
|
5618
|
+
### Parameters
|
5619
|
+
|
5620
|
+
Name | Type | Description | Notes
|
5621
|
+
------------- | ------------- | ------------- | -------------
|
5622
|
+
**name** | **String**| The document name. |
|
5623
|
+
**bookmark_path** | **String**| The bookmark path. |
|
5624
|
+
**bookmark** | [**Bookmark**](Bookmark.md)| The bookmark. |
|
5625
|
+
**folder** | **String**| The document folder. | [optional]
|
5626
|
+
**storage** | **String**| The document storage. | [optional]
|
5627
|
+
|
5628
|
+
### Return type
|
5629
|
+
|
5630
|
+
[**BookmarkResponse**](BookmarkResponse.md)
|
5631
|
+
|
5632
|
+
### HTTP request headers
|
5633
|
+
|
5634
|
+
- **Content-Type**: application/json
|
5635
|
+
- **Accept**: application/json
|
5636
|
+
|
5637
|
+
|
5638
|
+
|
5404
5639
|
# **put_caret_annotation**
|
5405
5640
|
> CaretAnnotationResponse put_caret_annotation(name, annotation_id, annotation, opts)
|
5406
5641
|
|
@@ -5480,31 +5715,6 @@ Name | Type | Description | Notes
|
|
5480
5715
|
|
5481
5716
|
|
5482
5717
|
|
5483
|
-
# **put_create**
|
5484
|
-
> AsposeResponse put_create(path, file, opts)
|
5485
|
-
|
5486
|
-
Upload a specific file
|
5487
|
-
|
5488
|
-
### Parameters
|
5489
|
-
|
5490
|
-
Name | Type | Description | Notes
|
5491
|
-
------------- | ------------- | ------------- | -------------
|
5492
|
-
**path** | **String**| Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext |
|
5493
|
-
**file** | **File**| File to upload |
|
5494
|
-
**version_id** | **String**| Source file's version | [optional]
|
5495
|
-
**storage** | **String**| User's storage name | [optional]
|
5496
|
-
|
5497
|
-
### Return type
|
5498
|
-
|
5499
|
-
[**AsposeResponse**](AsposeResponse.md)
|
5500
|
-
|
5501
|
-
### HTTP request headers
|
5502
|
-
|
5503
|
-
- **Content-Type**: multipart/form-data
|
5504
|
-
- **Accept**: application/json
|
5505
|
-
|
5506
|
-
|
5507
|
-
|
5508
5718
|
# **put_create_document**
|
5509
5719
|
> DocumentResponse put_create_document(name, opts)
|
5510
5720
|
|
@@ -5529,30 +5739,6 @@ Name | Type | Description | Notes
|
|
5529
5739
|
|
5530
5740
|
|
5531
5741
|
|
5532
|
-
# **put_create_folder**
|
5533
|
-
> AsposeResponse put_create_folder(path, opts)
|
5534
|
-
|
5535
|
-
Create the folder
|
5536
|
-
|
5537
|
-
### Parameters
|
5538
|
-
|
5539
|
-
Name | Type | Description | Notes
|
5540
|
-
------------- | ------------- | ------------- | -------------
|
5541
|
-
**path** | **String**| Target folder's path e.g. Folder1/Folder2/. The folders will be created recursively |
|
5542
|
-
**storage** | **String**| User's source storage name | [optional]
|
5543
|
-
**dest_storage** | **String**| User's destination storage name | [optional]
|
5544
|
-
|
5545
|
-
### Return type
|
5546
|
-
|
5547
|
-
[**AsposeResponse**](AsposeResponse.md)
|
5548
|
-
|
5549
|
-
### HTTP request headers
|
5550
|
-
|
5551
|
-
- **Content-Type**: application/json
|
5552
|
-
- **Accept**: application/json
|
5553
|
-
|
5554
|
-
|
5555
|
-
|
5556
5742
|
# **put_decrypt_document**
|
5557
5743
|
> AsposeResponse put_decrypt_document(out_path, password, opts)
|
5558
5744
|
|
@@ -5590,8 +5776,8 @@ Name | Type | Description | Notes
|
|
5590
5776
|
**out_path** | **String**| Full resulting filename (ex. /folder1/folder2/result.doc) |
|
5591
5777
|
**user_password** | **String**| User password (encrypted Base64). |
|
5592
5778
|
**owner_password** | **String**| Owner password (encrypted Base64). |
|
5593
|
-
**crypto_algorithm** | **String**| Cryptographic algorithm, see
|
5594
|
-
**permissions_flags** | [**Array<PermissionsFlags>**](PermissionsFlags.md)| Array of document permissions, see
|
5779
|
+
**crypto_algorithm** | **String**| Cryptographic algorithm, see CryptoAlgorithm for details. |
|
5780
|
+
**permissions_flags** | [**Array<PermissionsFlags>**](PermissionsFlags.md)| Array of document permissions, see PermissionsFlags for details. | [optional]
|
5595
5781
|
**use_pdf20** | **BOOLEAN**| Support for revision 6 (Extension 8). | [optional]
|
5596
5782
|
**storage** | **String**| The document storage. | [optional]
|
5597
5783
|
**file** | **File**| A file to be encrypted. | [optional]
|
@@ -5804,8 +5990,8 @@ Name | Type | Description | Notes
|
|
5804
5990
|
------------- | ------------- | ------------- | -------------
|
5805
5991
|
**name** | **String**| The document name. |
|
5806
5992
|
**image_id** | **String**| Image ID. |
|
5807
|
-
**width** | **Integer**| The converted image width. | [optional]
|
5808
|
-
**height** | **Integer**| The converted image height. | [optional]
|
5993
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
5994
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
5809
5995
|
**storage** | **String**| The document storage. | [optional]
|
5810
5996
|
**folder** | **String**| The document folder. | [optional]
|
5811
5997
|
**dest_folder** | **String**| The document folder. | [optional]
|
@@ -5832,8 +6018,8 @@ Name | Type | Description | Notes
|
|
5832
6018
|
------------- | ------------- | ------------- | -------------
|
5833
6019
|
**name** | **String**| The document name. |
|
5834
6020
|
**image_id** | **String**| Image ID. |
|
5835
|
-
**width** | **Integer**| The converted image width. | [optional]
|
5836
|
-
**height** | **Integer**| The converted image height. | [optional]
|
6021
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6022
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
5837
6023
|
**storage** | **String**| The document storage. | [optional]
|
5838
6024
|
**folder** | **String**| The document folder. | [optional]
|
5839
6025
|
**dest_folder** | **String**| The document folder. | [optional]
|
@@ -5860,8 +6046,8 @@ Name | Type | Description | Notes
|
|
5860
6046
|
------------- | ------------- | ------------- | -------------
|
5861
6047
|
**name** | **String**| The document name. |
|
5862
6048
|
**image_id** | **String**| Image ID. |
|
5863
|
-
**width** | **Integer**| The converted image width. | [optional]
|
5864
|
-
**height** | **Integer**| The converted image height. | [optional]
|
6049
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6050
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
5865
6051
|
**storage** | **String**| The document storage. | [optional]
|
5866
6052
|
**folder** | **String**| The document folder. | [optional]
|
5867
6053
|
**dest_folder** | **String**| The document folder. | [optional]
|
@@ -5888,8 +6074,8 @@ Name | Type | Description | Notes
|
|
5888
6074
|
------------- | ------------- | ------------- | -------------
|
5889
6075
|
**name** | **String**| The document name. |
|
5890
6076
|
**image_id** | **String**| Image ID. |
|
5891
|
-
**width** | **Integer**| The converted image width. | [optional]
|
5892
|
-
**height** | **Integer**| The converted image height. | [optional]
|
6077
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6078
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
5893
6079
|
**storage** | **String**| The document storage. | [optional]
|
5894
6080
|
**folder** | **String**| The document folder. | [optional]
|
5895
6081
|
**dest_folder** | **String**| The document folder. | [optional]
|
@@ -5915,7 +6101,7 @@ Convert image file (located on storage) to PDF format and upload resulting file
|
|
5915
6101
|
Name | Type | Description | Notes
|
5916
6102
|
------------- | ------------- | ------------- | -------------
|
5917
6103
|
**name** | **String**| The document name. |
|
5918
|
-
**image_templates** | [**ImageTemplatesRequest**](ImageTemplatesRequest.md)|
|
6104
|
+
**image_templates** | [**ImageTemplatesRequest**](ImageTemplatesRequest.md)| ImageTemplatesRequestImage templates |
|
5919
6105
|
**dst_folder** | **String**| The destination document folder. | [optional]
|
5920
6106
|
**storage** | **String**| The document storage. | [optional]
|
5921
6107
|
|
@@ -5941,8 +6127,8 @@ Name | Type | Description | Notes
|
|
5941
6127
|
------------- | ------------- | ------------- | -------------
|
5942
6128
|
**name** | **String**| The document name. |
|
5943
6129
|
**page_number** | **Integer**| The page number. |
|
5944
|
-
**width** | **Integer**| The converted image width. | [optional]
|
5945
|
-
**height** | **Integer**| The converted image height. | [optional]
|
6130
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6131
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
5946
6132
|
**storage** | **String**| The document storage. | [optional]
|
5947
6133
|
**folder** | **String**| The document folder. | [optional]
|
5948
6134
|
**dest_folder** | **String**| The document folder. | [optional]
|
@@ -5969,9 +6155,9 @@ Name | Type | Description | Notes
|
|
5969
6155
|
------------- | ------------- | ------------- | -------------
|
5970
6156
|
**name** | **String**| The document name. |
|
5971
6157
|
**page_number** | **Integer**| The page number. |
|
5972
|
-
**width** | **Integer**| The converted image width. | [optional]
|
5973
|
-
**height** | **Integer**| The converted image height. | [optional]
|
5974
|
-
**storage** | **String**|
|
6158
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6159
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
6160
|
+
**storage** | **String**| The document storage. | [optional]
|
5975
6161
|
**folder** | **String**| The document folder. | [optional]
|
5976
6162
|
**dest_folder** | **String**| The document folder. | [optional]
|
5977
6163
|
|
@@ -5997,8 +6183,8 @@ Name | Type | Description | Notes
|
|
5997
6183
|
------------- | ------------- | ------------- | -------------
|
5998
6184
|
**name** | **String**| The document name. |
|
5999
6185
|
**page_number** | **Integer**| The page number. |
|
6000
|
-
**width** | **Integer**| The converted image width. | [optional]
|
6001
|
-
**height** | **Integer**| The converted image height. | [optional]
|
6186
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6187
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
6002
6188
|
**storage** | **String**| The document storage. | [optional]
|
6003
6189
|
**folder** | **String**| The document folder. | [optional]
|
6004
6190
|
**dest_folder** | **String**| The document folder. | [optional]
|
@@ -6025,8 +6211,8 @@ Name | Type | Description | Notes
|
|
6025
6211
|
------------- | ------------- | ------------- | -------------
|
6026
6212
|
**name** | **String**| The document name. |
|
6027
6213
|
**page_number** | **Integer**| The page number. |
|
6028
|
-
**width** | **Integer**| The converted image width. | [optional]
|
6029
|
-
**height** | **Integer**| The converted image height. | [optional]
|
6214
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6215
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
6030
6216
|
**storage** | **String**| The document storage. | [optional]
|
6031
6217
|
**folder** | **String**| The document folder. | [optional]
|
6032
6218
|
**dest_folder** | **String**| The document folder. | [optional]
|
@@ -6146,7 +6332,7 @@ Name | Type | Description | Notes
|
|
6146
6332
|
|
6147
6333
|
|
6148
6334
|
# **put_merge_documents**
|
6149
|
-
> DocumentResponse put_merge_documents(name, opts)
|
6335
|
+
> DocumentResponse put_merge_documents(name, merge_documents, opts)
|
6150
6336
|
|
6151
6337
|
Merge a list of documents.
|
6152
6338
|
|
@@ -6155,7 +6341,7 @@ Merge a list of documents.
|
|
6155
6341
|
Name | Type | Description | Notes
|
6156
6342
|
------------- | ------------- | ------------- | -------------
|
6157
6343
|
**name** | **String**| Resulting documen name. |
|
6158
|
-
**merge_documents** | [**MergeDocuments**](MergeDocuments.md)| with a list of documents. |
|
6344
|
+
**merge_documents** | [**MergeDocuments**](MergeDocuments.md)| MergeDocuments with a list of documents. |
|
6159
6345
|
**storage** | **String**| Resulting document storage. | [optional]
|
6160
6346
|
**folder** | **String**| Resulting document folder. | [optional]
|
6161
6347
|
|
@@ -6232,7 +6418,7 @@ Name | Type | Description | Notes
|
|
6232
6418
|
------------- | ------------- | ------------- | -------------
|
6233
6419
|
**name** | **String**| The document name. |
|
6234
6420
|
**page_number** | **Integer**| The page number. |
|
6235
|
-
**stamp** | [**Stamp**](Stamp.md)| with data. |
|
6421
|
+
**stamp** | [**Stamp**](Stamp.md)| Stamp with data. |
|
6236
6422
|
**storage** | **String**| The document storage. | [optional]
|
6237
6423
|
**folder** | **String**| The document folder. | [optional]
|
6238
6424
|
|
@@ -6259,8 +6445,8 @@ Name | Type | Description | Notes
|
|
6259
6445
|
**name** | **String**| The document name. |
|
6260
6446
|
**page_number** | **Integer**| The page number. |
|
6261
6447
|
**out_path** | **String**| The out path of result image. |
|
6262
|
-
**width** | **Integer**| The converted image width. | [optional]
|
6263
|
-
**height** | **Integer**| The converted image height. | [optional]
|
6448
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6449
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
6264
6450
|
**folder** | **String**| The document folder. | [optional]
|
6265
6451
|
**storage** | **String**| The document storage. | [optional]
|
6266
6452
|
|
@@ -6287,8 +6473,8 @@ Name | Type | Description | Notes
|
|
6287
6473
|
**name** | **String**| The document name. |
|
6288
6474
|
**page_number** | **Integer**| The page number. |
|
6289
6475
|
**out_path** | **String**| The out path of result image. |
|
6290
|
-
**width** | **Integer**| The converted image width. | [optional]
|
6291
|
-
**height** | **Integer**| The converted image height. | [optional]
|
6476
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6477
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
6292
6478
|
**folder** | **String**| The document folder. | [optional]
|
6293
6479
|
**storage** | **String**| The document storage. | [optional]
|
6294
6480
|
|
@@ -6315,8 +6501,8 @@ Name | Type | Description | Notes
|
|
6315
6501
|
**name** | **String**| The document name. |
|
6316
6502
|
**page_number** | **Integer**| The page number. |
|
6317
6503
|
**out_path** | **String**| The out path of result image. |
|
6318
|
-
**width** | **Integer**| The converted image width. | [optional]
|
6319
|
-
**height** | **Integer**| The converted image height. | [optional]
|
6504
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6505
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
6320
6506
|
**folder** | **String**| The document folder. | [optional]
|
6321
6507
|
**storage** | **String**| The document storage. | [optional]
|
6322
6508
|
|
@@ -6343,8 +6529,8 @@ Name | Type | Description | Notes
|
|
6343
6529
|
**name** | **String**| The document name. |
|
6344
6530
|
**page_number** | **Integer**| The page number. |
|
6345
6531
|
**out_path** | **String**| The out path of result image. |
|
6346
|
-
**width** | **Integer**| The converted image width. | [optional]
|
6347
|
-
**height** | **Integer**| The converted image height. | [optional]
|
6532
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6533
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
6348
6534
|
**folder** | **String**| The document folder. | [optional]
|
6349
6535
|
**storage** | **String**| The document storage. | [optional]
|
6350
6536
|
|
@@ -6371,8 +6557,8 @@ Name | Type | Description | Notes
|
|
6371
6557
|
**name** | **String**| The document name. |
|
6372
6558
|
**page_number** | **Integer**| The page number. |
|
6373
6559
|
**out_path** | **String**| The out path of result image. |
|
6374
|
-
**width** | **Integer**| The converted image width. | [optional]
|
6375
|
-
**height** | **Integer**| The converted image height. | [optional]
|
6560
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6561
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
6376
6562
|
**folder** | **String**| The document folder. | [optional]
|
6377
6563
|
**storage** | **String**| The document storage. | [optional]
|
6378
6564
|
|
@@ -6399,8 +6585,8 @@ Name | Type | Description | Notes
|
|
6399
6585
|
**name** | **String**| The document name. |
|
6400
6586
|
**page_number** | **Integer**| The page number. |
|
6401
6587
|
**out_path** | **String**| The out path of result image. |
|
6402
|
-
**width** | **Integer**| The converted image width. | [optional]
|
6403
|
-
**height** | **Integer**| The converted image height. | [optional]
|
6588
|
+
**width** | **Integer**| The converted image width. | [optional] [default to 0]
|
6589
|
+
**height** | **Integer**| The converted image height. | [optional] [default to 0]
|
6404
6590
|
**folder** | **String**| The document folder. | [optional]
|
6405
6591
|
**storage** | **String**| The document storage. | [optional]
|
6406
6592
|
|
@@ -7284,7 +7470,7 @@ Name | Type | Description | Notes
|
|
7284
7470
|
|
7285
7471
|
|
7286
7472
|
# **put_privileges**
|
7287
|
-
> AsposeResponse put_privileges(name, opts)
|
7473
|
+
> AsposeResponse put_privileges(name, privileges, opts)
|
7288
7474
|
|
7289
7475
|
Update privilege document.
|
7290
7476
|
|
@@ -7293,7 +7479,7 @@ Update privilege document.
|
|
7293
7479
|
Name | Type | Description | Notes
|
7294
7480
|
------------- | ------------- | ------------- | -------------
|
7295
7481
|
**name** | **String**| The document name. |
|
7296
|
-
**privileges** | [**DocumentPrivilege**](DocumentPrivilege.md)| Document privileges.
|
7482
|
+
**privileges** | [**DocumentPrivilege**](DocumentPrivilege.md)| Document privileges. DocumentPrivilege |
|
7297
7483
|
**storage** | **String**| The document storage. | [optional]
|
7298
7484
|
**folder** | **String**| The document folder. | [optional]
|
7299
7485
|
|
@@ -7783,7 +7969,7 @@ Name | Type | Description | Notes
|
|
7783
7969
|
|
7784
7970
|
|
7785
7971
|
# **put_update_field**
|
7786
|
-
> FieldResponse put_update_field(name, field_name, opts)
|
7972
|
+
> FieldResponse put_update_field(name, field_name, field, opts)
|
7787
7973
|
|
7788
7974
|
Update field.
|
7789
7975
|
|
@@ -7793,7 +7979,7 @@ Name | Type | Description | Notes
|
|
7793
7979
|
------------- | ------------- | ------------- | -------------
|
7794
7980
|
**name** | **String**| The document name. |
|
7795
7981
|
**field_name** | **String**| The name of a field to be updated. |
|
7796
|
-
**field** | [**Field**](Field.md)| with the field data. |
|
7982
|
+
**field** | [**Field**](Field.md)| Field with the field data. |
|
7797
7983
|
**storage** | **String**| The document storage. | [optional]
|
7798
7984
|
**folder** | **String**| The document folder. | [optional]
|
7799
7985
|
|
@@ -7809,7 +7995,7 @@ Name | Type | Description | Notes
|
|
7809
7995
|
|
7810
7996
|
|
7811
7997
|
# **put_update_fields**
|
7812
|
-
> FieldsResponse put_update_fields(name, opts)
|
7998
|
+
> FieldsResponse put_update_fields(name, fields, opts)
|
7813
7999
|
|
7814
8000
|
Update fields.
|
7815
8001
|
|
@@ -7818,7 +8004,7 @@ Update fields.
|
|
7818
8004
|
Name | Type | Description | Notes
|
7819
8005
|
------------- | ------------- | ------------- | -------------
|
7820
8006
|
**name** | **String**| The document name. |
|
7821
|
-
**fields** | [**Fields**](Fields.md)| with the fields data. |
|
8007
|
+
**fields** | [**Fields**](Fields.md)| Fields with the fields data. |
|
7822
8008
|
**storage** | **String**| The document storage. | [optional]
|
7823
8009
|
**folder** | **String**| The document folder. | [optional]
|
7824
8010
|
|
@@ -7990,3 +8176,49 @@ Name | Type | Description | Notes
|
|
7990
8176
|
|
7991
8177
|
|
7992
8178
|
|
8179
|
+
# **storage_exists**
|
8180
|
+
> StorageExist storage_exists(storage_name)
|
8181
|
+
|
8182
|
+
Check if storage exists
|
8183
|
+
|
8184
|
+
### Parameters
|
8185
|
+
|
8186
|
+
Name | Type | Description | Notes
|
8187
|
+
------------- | ------------- | ------------- | -------------
|
8188
|
+
**storage_name** | **String**| Storage name |
|
8189
|
+
|
8190
|
+
### Return type
|
8191
|
+
|
8192
|
+
[**StorageExist**](StorageExist.md)
|
8193
|
+
|
8194
|
+
### HTTP request headers
|
8195
|
+
|
8196
|
+
- **Content-Type**: application/json
|
8197
|
+
- **Accept**: application/json
|
8198
|
+
|
8199
|
+
|
8200
|
+
|
8201
|
+
# **upload_file**
|
8202
|
+
> FilesUploadResult upload_file(path, file, opts)
|
8203
|
+
|
8204
|
+
Upload file
|
8205
|
+
|
8206
|
+
### Parameters
|
8207
|
+
|
8208
|
+
Name | Type | Description | Notes
|
8209
|
+
------------- | ------------- | ------------- | -------------
|
8210
|
+
**path** | **String**| 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. |
|
8211
|
+
**file** | **File**| File to upload |
|
8212
|
+
**storage_name** | **String**| Storage name | [optional]
|
8213
|
+
|
8214
|
+
### Return type
|
8215
|
+
|
8216
|
+
[**FilesUploadResult**](FilesUploadResult.md)
|
8217
|
+
|
8218
|
+
### HTTP request headers
|
8219
|
+
|
8220
|
+
- **Content-Type**: multipart/form-data
|
8221
|
+
- **Accept**: application/json
|
8222
|
+
|
8223
|
+
|
8224
|
+
|