aspose_pdf_cloud 18.10.0 → 18.11.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 +75 -6
- data/docs/Annotation.md +0 -3
- data/docs/AnnotationInfo.md +0 -3
- data/docs/CapStyle.md +11 -0
- data/docs/CaretAnnotation.md +26 -0
- data/docs/CaretAnnotationResponse.md +11 -0
- data/docs/CaretAnnotations.md +10 -0
- data/docs/CaretAnnotationsResponse.md +11 -0
- data/docs/CaretSymbol.md +11 -0
- data/docs/CircleAnnotation.md +3 -3
- data/docs/CommonFigureAnnotation.md +3 -3
- data/docs/File.md +13 -0
- data/docs/FilesResponse.md +11 -0
- data/docs/FreeTextAnnotation.md +3 -3
- data/docs/HighlightAnnotation.md +25 -0
- data/docs/HighlightAnnotationResponse.md +11 -0
- data/docs/HighlightAnnotations.md +10 -0
- data/docs/HighlightAnnotationsResponse.md +11 -0
- data/docs/InkAnnotation.md +26 -0
- data/docs/InkAnnotationResponse.md +11 -0
- data/docs/InkAnnotations.md +10 -0
- data/docs/InkAnnotationsResponse.md +11 -0
- data/docs/LineAnnotation.md +3 -3
- data/docs/MarkupAnnotation.md +3 -3
- data/docs/PdfApi.md +1036 -69
- data/docs/PolyAnnotation.md +3 -3
- data/docs/PolyLineAnnotation.md +3 -3
- data/docs/PolygonAnnotation.md +3 -3
- data/docs/PopupAnnotation.md +21 -0
- data/docs/PopupAnnotationResponse.md +11 -0
- data/docs/PopupAnnotationWithParent.md +22 -0
- data/docs/PopupAnnotations.md +10 -0
- data/docs/PopupAnnotationsResponse.md +11 -0
- data/docs/SquareAnnotation.md +3 -3
- data/docs/SquigglyAnnotation.md +25 -0
- data/docs/SquigglyAnnotationResponse.md +11 -0
- data/docs/SquigglyAnnotations.md +10 -0
- data/docs/SquigglyAnnotationsResponse.md +11 -0
- data/docs/StrikeOutAnnotation.md +25 -0
- data/docs/StrikeOutAnnotationResponse.md +11 -0
- data/docs/StrikeOutAnnotations.md +10 -0
- data/docs/StrikeOutAnnotationsResponse.md +11 -0
- data/docs/TextAnnotation.md +3 -3
- data/docs/UnderlineAnnotation.md +25 -0
- data/docs/UnderlineAnnotationResponse.md +11 -0
- data/docs/UnderlineAnnotations.md +10 -0
- data/docs/UnderlineAnnotationsResponse.md +11 -0
- data/lib/aspose_pdf_cloud.rb +33 -0
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +4978 -2084
- data/lib/aspose_pdf_cloud/models/annotation.rb +6 -33
- data/lib/aspose_pdf_cloud/models/annotation_flags.rb +1 -0
- data/lib/aspose_pdf_cloud/models/annotation_info.rb +6 -33
- data/lib/aspose_pdf_cloud/models/annotation_state.rb +1 -0
- data/lib/aspose_pdf_cloud/models/annotation_type.rb +1 -0
- data/lib/aspose_pdf_cloud/models/annotations_info.rb +5 -2
- data/lib/aspose_pdf_cloud/models/annotations_info_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/antialiasing_processing_type.rb +1 -0
- data/lib/aspose_pdf_cloud/models/append_document.rb +5 -2
- data/lib/aspose_pdf_cloud/models/aspose_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/attachment.rb +5 -2
- data/lib/aspose_pdf_cloud/models/attachment_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/attachments.rb +5 -2
- data/lib/aspose_pdf_cloud/models/attachments_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/cap_style.rb +44 -0
- data/lib/aspose_pdf_cloud/models/caption_position.rb +1 -0
- data/lib/aspose_pdf_cloud/models/caret_annotation.rb +375 -0
- data/lib/aspose_pdf_cloud/models/caret_annotation_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/caret_annotations.rb +214 -0
- data/lib/aspose_pdf_cloud/models/caret_annotations_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/caret_symbol.rb +44 -0
- data/lib/aspose_pdf_cloud/models/circle_annotation.rb +36 -33
- data/lib/aspose_pdf_cloud/models/circle_annotation_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/circle_annotations.rb +5 -2
- data/lib/aspose_pdf_cloud/models/circle_annotations_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/color.rb +5 -2
- data/lib/aspose_pdf_cloud/models/color_depth.rb +1 -0
- data/lib/aspose_pdf_cloud/models/common_figure_annotation.rb +36 -33
- data/lib/aspose_pdf_cloud/models/compression_type.rb +1 -0
- data/lib/aspose_pdf_cloud/models/doc_format.rb +1 -0
- data/lib/aspose_pdf_cloud/models/doc_recognition_mode.rb +1 -0
- data/lib/aspose_pdf_cloud/models/document.rb +5 -2
- data/lib/aspose_pdf_cloud/models/document_page_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/document_pages_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/document_privilege.rb +5 -2
- data/lib/aspose_pdf_cloud/models/document_properties.rb +5 -2
- data/lib/aspose_pdf_cloud/models/document_properties_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/document_property.rb +5 -2
- data/lib/aspose_pdf_cloud/models/document_property_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/document_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/epub_recognition_mode.rb +1 -0
- data/lib/aspose_pdf_cloud/models/field.rb +5 -2
- data/lib/aspose_pdf_cloud/models/field_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/field_type.rb +1 -0
- data/lib/aspose_pdf_cloud/models/fields.rb +5 -2
- data/lib/aspose_pdf_cloud/models/fields_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/file.rb +246 -0
- data/lib/aspose_pdf_cloud/models/files_response.rb +227 -0
- data/lib/aspose_pdf_cloud/models/font_encoding_rules.rb +1 -0
- data/lib/aspose_pdf_cloud/models/font_saving_modes.rb +1 -0
- data/lib/aspose_pdf_cloud/models/font_styles.rb +1 -0
- data/lib/aspose_pdf_cloud/models/free_text_annotation.rb +36 -33
- data/lib/aspose_pdf_cloud/models/free_text_annotation_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/free_text_annotations.rb +5 -2
- data/lib/aspose_pdf_cloud/models/free_text_annotations_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/free_text_intent.rb +1 -0
- data/lib/aspose_pdf_cloud/models/highlight_annotation.rb +367 -0
- data/lib/aspose_pdf_cloud/models/highlight_annotation_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/highlight_annotations.rb +214 -0
- data/lib/aspose_pdf_cloud/models/highlight_annotations_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/horizontal_alignment.rb +1 -0
- data/lib/aspose_pdf_cloud/models/html_document_type.rb +1 -0
- data/lib/aspose_pdf_cloud/models/html_markup_generation_modes.rb +1 -0
- data/lib/aspose_pdf_cloud/models/image.rb +5 -2
- data/lib/aspose_pdf_cloud/models/image_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/image_src_type.rb +1 -0
- data/lib/aspose_pdf_cloud/models/image_template.rb +5 -2
- data/lib/aspose_pdf_cloud/models/image_templates_request.rb +5 -2
- data/lib/aspose_pdf_cloud/models/images.rb +5 -2
- data/lib/aspose_pdf_cloud/models/images_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/ink_annotation.rb +377 -0
- data/lib/aspose_pdf_cloud/models/ink_annotation_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/ink_annotations.rb +214 -0
- data/lib/aspose_pdf_cloud/models/ink_annotations_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/justification.rb +1 -0
- data/lib/aspose_pdf_cloud/models/letters_positioning_methods.rb +1 -0
- data/lib/aspose_pdf_cloud/models/line_annotation.rb +36 -33
- data/lib/aspose_pdf_cloud/models/line_annotation_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/line_annotations.rb +5 -2
- data/lib/aspose_pdf_cloud/models/line_annotations_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/line_ending.rb +1 -0
- data/lib/aspose_pdf_cloud/models/line_intent.rb +1 -0
- data/lib/aspose_pdf_cloud/models/line_spacing.rb +1 -0
- data/lib/aspose_pdf_cloud/models/link.rb +5 -2
- data/lib/aspose_pdf_cloud/models/link_action_type.rb +1 -0
- data/lib/aspose_pdf_cloud/models/link_annotation.rb +5 -2
- data/lib/aspose_pdf_cloud/models/link_annotation_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/link_annotations.rb +5 -2
- data/lib/aspose_pdf_cloud/models/link_annotations_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/link_element.rb +5 -2
- data/lib/aspose_pdf_cloud/models/link_highlighting_mode.rb +1 -0
- data/lib/aspose_pdf_cloud/models/margin_info.rb +5 -2
- data/lib/aspose_pdf_cloud/models/markup_annotation.rb +36 -33
- data/lib/aspose_pdf_cloud/models/merge_documents.rb +5 -2
- data/lib/aspose_pdf_cloud/models/optimize_options.rb +5 -2
- data/lib/aspose_pdf_cloud/models/page.rb +5 -2
- data/lib/aspose_pdf_cloud/models/page_word_count.rb +5 -2
- data/lib/aspose_pdf_cloud/models/pages.rb +5 -2
- data/lib/aspose_pdf_cloud/models/paragraph.rb +5 -2
- data/lib/aspose_pdf_cloud/models/parts_embedding_modes.rb +1 -0
- data/lib/aspose_pdf_cloud/models/pdf_a_type.rb +1 -0
- data/lib/aspose_pdf_cloud/models/point.rb +5 -2
- data/lib/aspose_pdf_cloud/models/poly_annotation.rb +36 -33
- data/lib/aspose_pdf_cloud/models/poly_intent.rb +1 -0
- data/lib/aspose_pdf_cloud/models/poly_line_annotation.rb +36 -33
- data/lib/aspose_pdf_cloud/models/poly_line_annotation_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/poly_line_annotations.rb +5 -2
- data/lib/aspose_pdf_cloud/models/poly_line_annotations_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/polygon_annotation.rb +36 -33
- data/lib/aspose_pdf_cloud/models/polygon_annotation_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/polygon_annotations.rb +5 -2
- data/lib/aspose_pdf_cloud/models/polygon_annotations_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/popup_annotation.rb +325 -0
- data/lib/aspose_pdf_cloud/models/popup_annotation_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/popup_annotation_with_parent.rb +335 -0
- data/lib/aspose_pdf_cloud/models/popup_annotations.rb +214 -0
- data/lib/aspose_pdf_cloud/models/popup_annotations_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/raster_images_saving_modes.rb +1 -0
- data/lib/aspose_pdf_cloud/models/rectangle_pdf.rb +5 -2
- data/lib/aspose_pdf_cloud/models/rotation.rb +1 -0
- data/lib/aspose_pdf_cloud/models/segment.rb +5 -2
- data/lib/aspose_pdf_cloud/models/shape_type.rb +1 -0
- data/lib/aspose_pdf_cloud/models/signature.rb +5 -2
- data/lib/aspose_pdf_cloud/models/signature_type.rb +1 -0
- data/lib/aspose_pdf_cloud/models/signature_verify_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/split_result.rb +5 -2
- data/lib/aspose_pdf_cloud/models/split_result_document.rb +5 -2
- data/lib/aspose_pdf_cloud/models/split_result_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/square_annotation.rb +36 -33
- data/lib/aspose_pdf_cloud/models/square_annotation_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/square_annotations.rb +5 -2
- data/lib/aspose_pdf_cloud/models/square_annotations_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/squiggly_annotation.rb +367 -0
- data/lib/aspose_pdf_cloud/models/squiggly_annotation_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/squiggly_annotations.rb +214 -0
- data/lib/aspose_pdf_cloud/models/squiggly_annotations_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/stamp.rb +5 -2
- data/lib/aspose_pdf_cloud/models/stamp_type.rb +1 -0
- data/lib/aspose_pdf_cloud/models/strike_out_annotation.rb +367 -0
- data/lib/aspose_pdf_cloud/models/strike_out_annotation_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/strike_out_annotations.rb +214 -0
- data/lib/aspose_pdf_cloud/models/strike_out_annotations_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/text_annotation.rb +36 -33
- data/lib/aspose_pdf_cloud/models/text_annotation_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/text_annotations.rb +5 -2
- data/lib/aspose_pdf_cloud/models/text_annotations_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/text_horizontal_alignment.rb +1 -0
- data/lib/aspose_pdf_cloud/models/text_icon.rb +1 -0
- data/lib/aspose_pdf_cloud/models/text_line.rb +5 -2
- data/lib/aspose_pdf_cloud/models/text_rect.rb +5 -2
- data/lib/aspose_pdf_cloud/models/text_rects.rb +5 -2
- data/lib/aspose_pdf_cloud/models/text_rects_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/text_replace.rb +5 -2
- data/lib/aspose_pdf_cloud/models/text_replace_list_request.rb +5 -2
- data/lib/aspose_pdf_cloud/models/text_replace_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/text_state.rb +5 -2
- data/lib/aspose_pdf_cloud/models/text_style.rb +5 -2
- data/lib/aspose_pdf_cloud/models/underline_annotation.rb +367 -0
- data/lib/aspose_pdf_cloud/models/underline_annotation_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/underline_annotations.rb +214 -0
- data/lib/aspose_pdf_cloud/models/underline_annotations_response.rb +225 -0
- data/lib/aspose_pdf_cloud/models/vertical_alignment.rb +1 -0
- data/lib/aspose_pdf_cloud/models/word_count.rb +5 -2
- data/lib/aspose_pdf_cloud/models/word_count_response.rb +5 -2
- data/lib/aspose_pdf_cloud/models/wrap_mode.rb +1 -0
- data/lib/aspose_pdf_cloud/version.rb +1 -1
- data/test/pdf_tests.rb +757 -21
- metadata +68 -2
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::FilesResponse
|
2
|
+
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**files** | **Array<File>** | | [optional]
|
10
|
+
|
11
|
+
|
data/docs/FreeTextAnnotation.md
CHANGED
@@ -6,9 +6,6 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
8
|
**contents** | **String** | Get the annotation content. | [optional]
|
9
|
-
**creation_date** | **String** | The date and time when the annotation was created. | [optional]
|
10
|
-
**subject** | **String** | Get the annotation subject. | [optional]
|
11
|
-
**title** | **String** | Get the annotation title. | [optional]
|
12
9
|
**modified** | **String** | The date and time when the annotation was last modified. | [optional]
|
13
10
|
**id** | **String** | Gets ID of the annotation. | [optional]
|
14
11
|
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
|
@@ -18,6 +15,9 @@ Name | Type | Description | Notes
|
|
18
15
|
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
|
19
16
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
|
20
17
|
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional]
|
18
|
+
**creation_date** | **String** | The date and time when the annotation was created. | [optional]
|
19
|
+
**subject** | **String** | Get the annotation subject. | [optional]
|
20
|
+
**title** | **String** | Get the annotation title. | [optional]
|
21
21
|
**rich_text** | **String** | Get the annotation RichText. | [optional]
|
22
22
|
**justification** | [**Justification**](Justification.md) | Gets Justification of the annotation. | [optional]
|
23
23
|
**intent** | [**FreeTextIntent**](FreeTextIntent.md) | Gets or sets the intent of the free text annotation. | [optional]
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# AsposePdfCloud::HighlightAnnotation
|
2
|
+
Provides HighlightAnnotation.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**contents** | **String** | Get the annotation content. | [optional]
|
9
|
+
**modified** | **String** | The date and time when the annotation was last modified. | [optional]
|
10
|
+
**id** | **String** | Gets ID of the annotation. | [optional]
|
11
|
+
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
|
12
|
+
**name** | **String** | Gets Name of the annotation. | [optional]
|
13
|
+
**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. | [optional]
|
14
|
+
**page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
|
15
|
+
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
|
16
|
+
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
|
17
|
+
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional]
|
18
|
+
**creation_date** | **String** | The date and time when the annotation was created. | [optional]
|
19
|
+
**subject** | **String** | Get the annotation subject. | [optional]
|
20
|
+
**title** | **String** | Get the annotation title. | [optional]
|
21
|
+
**rich_text** | **String** | Get the annotation RichText. | [optional]
|
22
|
+
**color** | [**Color**](Color.md) | Color of the annotation. | [optional]
|
23
|
+
**quad_points** | [**Array<Point>**](Point.md) | Gets or sets an array of points specifying the coordinates of n quadrilaterals. Each quadrilateral encompasses a word or group of contiguous words in the text underlying the annotation. | [optional]
|
24
|
+
|
25
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::HighlightAnnotationResponse
|
2
|
+
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**annotation** | [**HighlightAnnotation**](HighlightAnnotation.md) | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposePdfCloud::HighlightAnnotations
|
2
|
+
List of annotations.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**list** | [**Array<HighlightAnnotation>**](HighlightAnnotation.md) | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::HighlightAnnotationsResponse
|
2
|
+
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**annotations** | [**HighlightAnnotations**](HighlightAnnotations.md) | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# AsposePdfCloud::InkAnnotation
|
2
|
+
Provides InkAnnotation.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**contents** | **String** | Get the annotation content. | [optional]
|
9
|
+
**modified** | **String** | The date and time when the annotation was last modified. | [optional]
|
10
|
+
**id** | **String** | Gets ID of the annotation. | [optional]
|
11
|
+
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
|
12
|
+
**name** | **String** | Gets Name of the annotation. | [optional]
|
13
|
+
**rect** | [**RectanglePdf**](RectanglePdf.md) | Gets Rect of the annotation. | [optional]
|
14
|
+
**page_index** | **Integer** | Gets PageIndex of the annotation. | [optional]
|
15
|
+
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
|
16
|
+
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
|
17
|
+
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional]
|
18
|
+
**creation_date** | **String** | The date and time when the annotation was created. | [optional]
|
19
|
+
**subject** | **String** | Get the annotation subject. | [optional]
|
20
|
+
**title** | **String** | Get the annotation title. | [optional]
|
21
|
+
**rich_text** | **String** | Get the annotation RichText. | [optional]
|
22
|
+
**color** | [**Color**](Color.md) | Color of the annotation. | [optional]
|
23
|
+
**ink_list** | **Array<Array<Point>>** | Gets or sets list of gestures that are independent lines which are represented by Point[] arrays. | [optional]
|
24
|
+
**cap_style** | [**CapStyle**](CapStyle.md) | Style of ink annotation line endings. | [optional]
|
25
|
+
|
26
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::InkAnnotationResponse
|
2
|
+
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**annotation** | [**InkAnnotation**](InkAnnotation.md) | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposePdfCloud::InkAnnotations
|
2
|
+
List of annotations.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**list** | [**Array<InkAnnotation>**](InkAnnotation.md) | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::InkAnnotationsResponse
|
2
|
+
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**annotations** | [**InkAnnotations**](InkAnnotations.md) | | [optional]
|
10
|
+
|
11
|
+
|
data/docs/LineAnnotation.md
CHANGED
@@ -6,9 +6,6 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
8
|
**contents** | **String** | Get the annotation content. | [optional]
|
9
|
-
**creation_date** | **String** | The date and time when the annotation was created. | [optional]
|
10
|
-
**subject** | **String** | Get the annotation subject. | [optional]
|
11
|
-
**title** | **String** | Get the annotation title. | [optional]
|
12
9
|
**modified** | **String** | The date and time when the annotation was last modified. | [optional]
|
13
10
|
**id** | **String** | Gets ID of the annotation. | [optional]
|
14
11
|
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
|
@@ -18,6 +15,9 @@ Name | Type | Description | Notes
|
|
18
15
|
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
|
19
16
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
|
20
17
|
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional]
|
18
|
+
**creation_date** | **String** | The date and time when the annotation was created. | [optional]
|
19
|
+
**subject** | **String** | Get the annotation subject. | [optional]
|
20
|
+
**title** | **String** | Get the annotation title. | [optional]
|
21
21
|
**rich_text** | **String** | Get the annotation RichText. | [optional]
|
22
22
|
**starting** | [**Point**](Point.md) | Gets or sets starting point of line. | [optional]
|
23
23
|
**starting_style** | [**LineEnding**](LineEnding.md) | Gets or sets line ending style for line starting point. | [optional]
|
data/docs/MarkupAnnotation.md
CHANGED
@@ -6,9 +6,6 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
8
|
**contents** | **String** | Get the annotation content. | [optional]
|
9
|
-
**creation_date** | **String** | The date and time when the annotation was created. | [optional]
|
10
|
-
**subject** | **String** | Get the annotation subject. | [optional]
|
11
|
-
**title** | **String** | Get the annotation title. | [optional]
|
12
9
|
**modified** | **String** | The date and time when the annotation was last modified. | [optional]
|
13
10
|
**id** | **String** | Gets ID of the annotation. | [optional]
|
14
11
|
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the annotation. | [optional]
|
@@ -18,6 +15,9 @@ Name | Type | Description | Notes
|
|
18
15
|
**z_index** | **Integer** | Gets ZIndex of the annotation. | [optional]
|
19
16
|
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the annotation. | [optional]
|
20
17
|
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the annotation. | [optional]
|
18
|
+
**creation_date** | **String** | The date and time when the annotation was created. | [optional]
|
19
|
+
**subject** | **String** | Get the annotation subject. | [optional]
|
20
|
+
**title** | **String** | Get the annotation title. | [optional]
|
21
21
|
**rich_text** | **String** | Get the annotation RichText. | [optional]
|
22
22
|
|
23
23
|
|
data/docs/PdfApi.md
CHANGED
@@ -15,27 +15,37 @@ Method | HTTP request | Description
|
|
15
15
|
[**delete_page_link_annotations**](PdfApi.md#delete_page_link_annotations) | **DELETE** /pdf/\{name}/pages/\{pageNumber}/links | Delete all link annotations from the page
|
16
16
|
[**delete_properties**](PdfApi.md#delete_properties) | **DELETE** /pdf/\{name}/documentproperties | Delete custom document properties.
|
17
17
|
[**delete_property**](PdfApi.md#delete_property) | **DELETE** /pdf/\{name}/documentproperties/\{propertyName} | Delete document property.
|
18
|
+
[**get_caret_annotation**](PdfApi.md#get_caret_annotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID.
|
18
19
|
[**get_circle_annotation**](PdfApi.md#get_circle_annotation) | **GET** /pdf/\{name}/annotations/circle/\{annotationId} | Read document page circle annotation by ID.
|
19
20
|
[**get_document**](PdfApi.md#get_document) | **GET** /pdf/\{name} | Read common document info.
|
20
21
|
[**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.
|
21
22
|
[**get_document_attachment_by_index**](PdfApi.md#get_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex} | Read document attachment info by its index.
|
22
23
|
[**get_document_attachments**](PdfApi.md#get_document_attachments) | **GET** /pdf/\{name}/attachments | Read document attachments info.
|
23
24
|
[**get_document_bookmarks**](PdfApi.md#get_document_bookmarks) | **GET** /pdf/\{name}/bookmarks | Read document bookmark/bookmarks (including children).
|
25
|
+
[**get_document_caret_annotations**](PdfApi.md#get_document_caret_annotations) | **GET** /pdf/\{name}/annotations/caret | Read document caret annotations.
|
24
26
|
[**get_document_circle_annotations**](PdfApi.md#get_document_circle_annotations) | **GET** /pdf/\{name}/annotations/circle | Read document circle annotations.
|
25
27
|
[**get_document_free_text_annotations**](PdfApi.md#get_document_free_text_annotations) | **GET** /pdf/\{name}/annotations/freetext | Read document free text annotations.
|
28
|
+
[**get_document_highlight_annotations**](PdfApi.md#get_document_highlight_annotations) | **GET** /pdf/\{name}/annotations/highlight | Read document highlight annotations.
|
29
|
+
[**get_document_ink_annotations**](PdfApi.md#get_document_ink_annotations) | **GET** /pdf/\{name}/annotations/ink | Read document ink annotations.
|
26
30
|
[**get_document_line_annotations**](PdfApi.md#get_document_line_annotations) | **GET** /pdf/\{name}/annotations/line | Read document line annotations.
|
27
31
|
[**get_document_poly_line_annotations**](PdfApi.md#get_document_poly_line_annotations) | **GET** /pdf/\{name}/annotations/polyline | Read document polyline annotations.
|
28
32
|
[**get_document_polygon_annotations**](PdfApi.md#get_document_polygon_annotations) | **GET** /pdf/\{name}/annotations/polygon | Read document polygon annotations.
|
33
|
+
[**get_document_popup_annotations**](PdfApi.md#get_document_popup_annotations) | **GET** /pdf/\{name}/annotations/popup | Read document popup annotations.
|
34
|
+
[**get_document_popup_annotations_by_parent**](PdfApi.md#get_document_popup_annotations_by_parent) | **GET** /pdf/\{name}/annotations/\{annotationId}/popup | Read document popup annotations by parent id.
|
29
35
|
[**get_document_properties**](PdfApi.md#get_document_properties) | **GET** /pdf/\{name}/documentproperties | Read document properties.
|
30
36
|
[**get_document_property**](PdfApi.md#get_document_property) | **GET** /pdf/\{name}/documentproperties/\{propertyName} | Read document property by name.
|
31
37
|
[**get_document_square_annotations**](PdfApi.md#get_document_square_annotations) | **GET** /pdf/\{name}/annotations/square | Read document square annotations.
|
38
|
+
[**get_document_squiggly_annotations**](PdfApi.md#get_document_squiggly_annotations) | **GET** /pdf/\{name}/annotations/squiggly | Read document squiggly annotations.
|
39
|
+
[**get_document_strike_out_annotations**](PdfApi.md#get_document_strike_out_annotations) | **GET** /pdf/\{name}/annotations/strikeout | Read document StrikeOut annotations.
|
32
40
|
[**get_document_text_annotations**](PdfApi.md#get_document_text_annotations) | **GET** /pdf/\{name}/annotations/text | Read document text annotations.
|
41
|
+
[**get_document_underline_annotations**](PdfApi.md#get_document_underline_annotations) | **GET** /pdf/\{name}/annotations/underline | Read document underline annotations.
|
33
42
|
[**get_download**](PdfApi.md#get_download) | **GET** /storage/file | Download a specific file
|
34
43
|
[**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.
|
35
44
|
[**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.
|
36
45
|
[**get_field**](PdfApi.md#get_field) | **GET** /pdf/\{name}/fields/\{fieldName} | Get document field by name.
|
37
46
|
[**get_fields**](PdfApi.md#get_fields) | **GET** /pdf/\{name}/fields | Get document fields.
|
38
47
|
[**get_free_text_annotation**](PdfApi.md#get_free_text_annotation) | **GET** /pdf/\{name}/annotations/freetext/\{annotationId} | Read document page free text annotation by ID.
|
48
|
+
[**get_highlight_annotation**](PdfApi.md#get_highlight_annotation) | **GET** /pdf/\{name}/annotations/highlight/\{annotationId} | Read document page highlight annotation by ID.
|
39
49
|
[**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.
|
40
50
|
[**get_image**](PdfApi.md#get_image) | **GET** /pdf/\{name}/images/\{imageId} | Read document image by ID.
|
41
51
|
[**get_image_extract_as_gif**](PdfApi.md#get_image_extract_as_gif) | **GET** /pdf/\{name}/images/\{imageId}/extract/gif | Extract document image in GIF format
|
@@ -43,12 +53,15 @@ Method | HTTP request | Description
|
|
43
53
|
[**get_image_extract_as_png**](PdfApi.md#get_image_extract_as_png) | **GET** /pdf/\{name}/images/\{imageId}/extract/png | Extract document image in PNG format
|
44
54
|
[**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
|
45
55
|
[**get_images**](PdfApi.md#get_images) | **GET** /pdf/\{name}/pages/\{pageNumber}/images | Read document images.
|
56
|
+
[**get_ink_annotation**](PdfApi.md#get_ink_annotation) | **GET** /pdf/\{name}/annotations/ink/\{annotationId} | Read document page ink annotation by ID.
|
46
57
|
[**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.
|
47
58
|
[**get_line_annotation**](PdfApi.md#get_line_annotation) | **GET** /pdf/\{name}/annotations/line/\{annotationId} | Read document page line annotation by ID.
|
48
59
|
[**get_link_annotation**](PdfApi.md#get_link_annotation) | **GET** /pdf/\{name}/links/\{linkId} | Read document link annotation by ID.
|
60
|
+
[**get_list_files**](PdfApi.md#get_list_files) | **GET** /storage/folder | Get the file listing of a specific folder
|
49
61
|
[**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.
|
50
62
|
[**get_page**](PdfApi.md#get_page) | **GET** /pdf/\{name}/pages/\{pageNumber} | Read document page info.
|
51
63
|
[**get_page_annotations**](PdfApi.md#get_page_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations | Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
|
64
|
+
[**get_page_caret_annotations**](PdfApi.md#get_page_caret_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Read document page caret annotations.
|
52
65
|
[**get_page_circle_annotations**](PdfApi.md#get_page_circle_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Read document page circle annotations.
|
53
66
|
[**get_page_convert_to_bmp**](PdfApi.md#get_page_convert_to_bmp) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/bmp | Convert document page to Bmp image and return resulting file in response.
|
54
67
|
[**get_page_convert_to_emf**](PdfApi.md#get_page_convert_to_emf) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/emf | Convert document page to Emf image and return resulting file in response.
|
@@ -57,14 +70,20 @@ Method | HTTP request | Description
|
|
57
70
|
[**get_page_convert_to_png**](PdfApi.md#get_page_convert_to_png) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/png | Convert document page to Png image and return resulting file in response.
|
58
71
|
[**get_page_convert_to_tiff**](PdfApi.md#get_page_convert_to_tiff) | **GET** /pdf/\{name}/pages/\{pageNumber}/convert/tiff | Convert document page to Tiff image and return resulting file in response.
|
59
72
|
[**get_page_free_text_annotations**](PdfApi.md#get_page_free_text_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/freetext | Read document page free text annotations.
|
73
|
+
[**get_page_highlight_annotations**](PdfApi.md#get_page_highlight_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/highlight | Read document page highlight annotations.
|
74
|
+
[**get_page_ink_annotations**](PdfApi.md#get_page_ink_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/ink | Read document page ink annotations.
|
60
75
|
[**get_page_line_annotations**](PdfApi.md#get_page_line_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/line | Read document page line annotations.
|
61
76
|
[**get_page_link_annotation**](PdfApi.md#get_page_link_annotation) | **GET** /pdf/\{name}/pages/\{pageNumber}/links/\{linkId} | Read document page link annotation by ID.
|
62
77
|
[**get_page_link_annotations**](PdfApi.md#get_page_link_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/links | Read document page link annotations.
|
63
78
|
[**get_page_poly_line_annotations**](PdfApi.md#get_page_poly_line_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Read document page polyline annotations.
|
64
79
|
[**get_page_polygon_annotations**](PdfApi.md#get_page_polygon_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Read document page polygon annotations.
|
80
|
+
[**get_page_popup_annotations**](PdfApi.md#get_page_popup_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/popup | Read document page popup annotations.
|
65
81
|
[**get_page_square_annotations**](PdfApi.md#get_page_square_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Read document page square annotations.
|
82
|
+
[**get_page_squiggly_annotations**](PdfApi.md#get_page_squiggly_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Read document page squiggly annotations.
|
83
|
+
[**get_page_strike_out_annotations**](PdfApi.md#get_page_strike_out_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/strikeout | Read document page StrikeOut annotations.
|
66
84
|
[**get_page_text**](PdfApi.md#get_page_text) | **GET** /pdf/\{name}/pages/\{pageNumber}/text | Read page text items.
|
67
85
|
[**get_page_text_annotations**](PdfApi.md#get_page_text_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/text | Read document page text annotations.
|
86
|
+
[**get_page_underline_annotations**](PdfApi.md#get_page_underline_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/underline | Read document page underline annotations.
|
68
87
|
[**get_pages**](PdfApi.md#get_pages) | **GET** /pdf/\{name}/pages | Read document pages info.
|
69
88
|
[**get_pcl_in_storage_to_pdf**](PdfApi.md#get_pcl_in_storage_to_pdf) | **GET** /pdf/create/pcl | Convert PCL file (located on storage) to PDF format and return resulting file in response.
|
70
89
|
[**get_pdf_in_storage_to_doc**](PdfApi.md#get_pdf_in_storage_to_doc) | **GET** /pdf/\{name}/convert/doc | Converts PDF document (located on storage) to DOC format and returns resulting file in response content
|
@@ -81,11 +100,15 @@ Method | HTTP request | Description
|
|
81
100
|
[**get_pdf_in_storage_to_xps**](PdfApi.md#get_pdf_in_storage_to_xps) | **GET** /pdf/\{name}/convert/xps | Converts PDF document (located on storage) to XPS format and returns resulting file in response content
|
82
101
|
[**get_poly_line_annotation**](PdfApi.md#get_poly_line_annotation) | **GET** /pdf/\{name}/annotations/polyline/\{annotationId} | Read document page polyline annotation by ID.
|
83
102
|
[**get_polygon_annotation**](PdfApi.md#get_polygon_annotation) | **GET** /pdf/\{name}/annotations/polygon/\{annotationId} | Read document page polygon annotation by ID.
|
103
|
+
[**get_popup_annotation**](PdfApi.md#get_popup_annotation) | **GET** /pdf/\{name}/annotations/popup/\{annotationId} | Read document page popup annotation by ID.
|
84
104
|
[**get_ps_in_storage_to_pdf**](PdfApi.md#get_ps_in_storage_to_pdf) | **GET** /pdf/create/ps | Convert PS file (located on storage) to PDF format and return resulting file in response.
|
85
105
|
[**get_square_annotation**](PdfApi.md#get_square_annotation) | **GET** /pdf/\{name}/annotations/square/\{annotationId} | Read document page square annotation by ID.
|
106
|
+
[**get_squiggly_annotation**](PdfApi.md#get_squiggly_annotation) | **GET** /pdf/\{name}/annotations/squiggly/\{annotationId} | Read document page squiggly annotation by ID.
|
107
|
+
[**get_strike_out_annotation**](PdfApi.md#get_strike_out_annotation) | **GET** /pdf/\{name}/annotations/strikeout/\{annotationId} | Read document page StrikeOut annotation by ID.
|
86
108
|
[**get_svg_in_storage_to_pdf**](PdfApi.md#get_svg_in_storage_to_pdf) | **GET** /pdf/create/svg | Convert SVG file (located on storage) to PDF format and return resulting file in response.
|
87
109
|
[**get_text**](PdfApi.md#get_text) | **GET** /pdf/\{name}/text | Read document text.
|
88
110
|
[**get_text_annotation**](PdfApi.md#get_text_annotation) | **GET** /pdf/\{name}/annotations/text/\{annotationId} | Read document page text annotation by ID.
|
111
|
+
[**get_underline_annotation**](PdfApi.md#get_underline_annotation) | **GET** /pdf/\{name}/annotations/underline/\{annotationId} | Read document page underline annotation by ID.
|
89
112
|
[**get_verify_signature**](PdfApi.md#get_verify_signature) | **GET** /pdf/\{name}/verifySignature | Verify signature document.
|
90
113
|
[**get_web_in_storage_to_pdf**](PdfApi.md#get_web_in_storage_to_pdf) | **GET** /pdf/create/web | Convert web page to PDF format and return resulting file in response.
|
91
114
|
[**get_words_per_page**](PdfApi.md#get_words_per_page) | **GET** /pdf/\{name}/pages/wordCount | Get number of words per document page.
|
@@ -99,26 +122,35 @@ Method | HTTP request | Description
|
|
99
122
|
[**post_insert_image**](PdfApi.md#post_insert_image) | **POST** /pdf/\{name}/pages/\{pageNumber}/images | Insert image to document page.
|
100
123
|
[**post_move_page**](PdfApi.md#post_move_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/movePage | Move page to new position.
|
101
124
|
[**post_optimize_document**](PdfApi.md#post_optimize_document) | **POST** /pdf/\{name}/optimize | Optimize document.
|
125
|
+
[**post_page_caret_annotations**](PdfApi.md#post_page_caret_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Add document page caret annotations.
|
102
126
|
[**post_page_circle_annotations**](PdfApi.md#post_page_circle_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Add document page circle annotations.
|
103
127
|
[**post_page_free_text_annotations**](PdfApi.md#post_page_free_text_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/freetext | Add document page free text annotations.
|
128
|
+
[**post_page_highlight_annotations**](PdfApi.md#post_page_highlight_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/highlight | Add document page highlight annotations.
|
129
|
+
[**post_page_ink_annotations**](PdfApi.md#post_page_ink_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/ink | Add document page ink annotations.
|
104
130
|
[**post_page_line_annotations**](PdfApi.md#post_page_line_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/line | Add document page line annotations.
|
105
131
|
[**post_page_link_annotations**](PdfApi.md#post_page_link_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/links | Add document page link annotations.
|
106
132
|
[**post_page_poly_line_annotations**](PdfApi.md#post_page_poly_line_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Add document page polyline annotations.
|
107
133
|
[**post_page_polygon_annotations**](PdfApi.md#post_page_polygon_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Add document page polygon annotations.
|
108
134
|
[**post_page_square_annotations**](PdfApi.md#post_page_square_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Add document page square annotations.
|
135
|
+
[**post_page_squiggly_annotations**](PdfApi.md#post_page_squiggly_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Add document page squiggly annotations.
|
136
|
+
[**post_page_strike_out_annotations**](PdfApi.md#post_page_strike_out_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/strikeout | Add document page StrikeOut annotations.
|
109
137
|
[**post_page_text_annotations**](PdfApi.md#post_page_text_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/text | Add document page text annotations.
|
110
138
|
[**post_page_text_replace**](PdfApi.md#post_page_text_replace) | **POST** /pdf/\{name}/pages/\{pageNumber}/text/replace | Page's replace text method.
|
139
|
+
[**post_page_underline_annotations**](PdfApi.md#post_page_underline_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/underline | Add document page underline annotations.
|
140
|
+
[**post_popup_annotation**](PdfApi.md#post_popup_annotation) | **POST** /pdf/\{name}/annotations/\{annotationId}/popup | Add document popup annotations.
|
111
141
|
[**post_sign_document**](PdfApi.md#post_sign_document) | **POST** /pdf/\{name}/sign | Sign document.
|
112
142
|
[**post_sign_page**](PdfApi.md#post_sign_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/sign | Sign page.
|
113
143
|
[**post_split_document**](PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts.
|
114
144
|
[**put_add_new_page**](PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
|
115
145
|
[**put_add_text**](PdfApi.md#put_add_text) | **PUT** /pdf/\{name}/pages/\{pageNumber}/text | Add text to PDF document page.
|
146
|
+
[**put_caret_annotation**](PdfApi.md#put_caret_annotation) | **PUT** /pdf/\{name}/annotations/caret/\{annotationId} | Replace document caret annotation
|
116
147
|
[**put_circle_annotation**](PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation
|
117
148
|
[**put_create**](PdfApi.md#put_create) | **PUT** /storage/file | Upload a specific file
|
118
149
|
[**put_create_document**](PdfApi.md#put_create_document) | **PUT** /pdf/\{name} | Create empty document.
|
119
150
|
[**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.
|
120
151
|
[**put_fields_flatten**](PdfApi.md#put_fields_flatten) | **PUT** /pdf/\{name}/fields/flatten | Flatten form fields in document.
|
121
152
|
[**put_free_text_annotation**](PdfApi.md#put_free_text_annotation) | **PUT** /pdf/\{name}/annotations/freetext/\{annotationId} | Replace document free text annotation
|
153
|
+
[**put_highlight_annotation**](PdfApi.md#put_highlight_annotation) | **PUT** /pdf/\{name}/annotations/highlight/\{annotationId} | Replace document highlight annotation
|
122
154
|
[**put_html_in_storage_to_pdf**](PdfApi.md#put_html_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/html | Convert HTML file (located on storage) to PDF format and upload resulting file to storage.
|
123
155
|
[**put_image_extract_as_gif**](PdfApi.md#put_image_extract_as_gif) | **PUT** /pdf/\{name}/images/\{imageId}/extract/gif | Extract document image in GIF format to folder
|
124
156
|
[**put_image_extract_as_jpeg**](PdfApi.md#put_image_extract_as_jpeg) | **PUT** /pdf/\{name}/images/\{imageId}/extract/jpeg | Extract document image in JPEG format to folder
|
@@ -129,6 +161,7 @@ Method | HTTP request | Description
|
|
129
161
|
[**put_images_extract_as_jpeg**](PdfApi.md#put_images_extract_as_jpeg) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/jpeg | Extract document images in JPEG format to folder.
|
130
162
|
[**put_images_extract_as_png**](PdfApi.md#put_images_extract_as_png) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/png | Extract document images in PNG format to folder.
|
131
163
|
[**put_images_extract_as_tiff**](PdfApi.md#put_images_extract_as_tiff) | **PUT** /pdf/\{name}/pages/\{pageNumber}/images/extract/tiff | Extract document images in TIFF format to folder.
|
164
|
+
[**put_ink_annotation**](PdfApi.md#put_ink_annotation) | **PUT** /pdf/\{name}/annotations/ink/\{annotationId} | Replace document ink annotation
|
132
165
|
[**put_la_te_x_in_storage_to_pdf**](PdfApi.md#put_la_te_x_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/latex | Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage.
|
133
166
|
[**put_line_annotation**](PdfApi.md#put_line_annotation) | **PUT** /pdf/\{name}/annotations/line/\{annotationId} | Replace document line annotation
|
134
167
|
[**put_link_annotation**](PdfApi.md#put_link_annotation) | **PUT** /pdf/\{name}/links/\{linkId} | Replace document page link annotations
|
@@ -168,14 +201,18 @@ Method | HTTP request | Description
|
|
168
201
|
[**put_pdf_in_storage_to_xps**](PdfApi.md#put_pdf_in_storage_to_xps) | **PUT** /pdf/\{name}/convert/xps | Converts PDF document (located on storage) to XPS format and uploads resulting file to storage
|
169
202
|
[**put_poly_line_annotation**](PdfApi.md#put_poly_line_annotation) | **PUT** /pdf/\{name}/annotations/polyline/\{annotationId} | Replace document polyline annotation
|
170
203
|
[**put_polygon_annotation**](PdfApi.md#put_polygon_annotation) | **PUT** /pdf/\{name}/annotations/polygon/\{annotationId} | Replace document polygon annotation
|
204
|
+
[**put_popup_annotation**](PdfApi.md#put_popup_annotation) | **PUT** /pdf/\{name}/annotations/popup/\{annotationId} | Replace document popup annotation
|
171
205
|
[**put_privileges**](PdfApi.md#put_privileges) | **PUT** /pdf/\{name}/privileges | Update privilege document.
|
172
206
|
[**put_ps_in_storage_to_pdf**](PdfApi.md#put_ps_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/ps | Convert PS file (located on storage) to PDF format and upload resulting file to storage.
|
173
207
|
[**put_replace_image**](PdfApi.md#put_replace_image) | **PUT** /pdf/\{name}/images/\{imageId} | Replace document image.
|
174
208
|
[**put_searchable_document**](PdfApi.md#put_searchable_document) | **PUT** /pdf/\{name}/ocr | Create searchable PDF document. Generate OCR layer for images in input PDF document.
|
175
209
|
[**put_set_property**](PdfApi.md#put_set_property) | **PUT** /pdf/\{name}/documentproperties/\{propertyName} | Add/update document property.
|
176
210
|
[**put_square_annotation**](PdfApi.md#put_square_annotation) | **PUT** /pdf/\{name}/annotations/square/\{annotationId} | Replace document square annotation
|
211
|
+
[**put_squiggly_annotation**](PdfApi.md#put_squiggly_annotation) | **PUT** /pdf/\{name}/annotations/squiggly/\{annotationId} | Replace document squiggly annotation
|
212
|
+
[**put_strike_out_annotation**](PdfApi.md#put_strike_out_annotation) | **PUT** /pdf/\{name}/annotations/strikeout/\{annotationId} | Replace document StrikeOut annotation
|
177
213
|
[**put_svg_in_storage_to_pdf**](PdfApi.md#put_svg_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/svg | Convert SVG file (located on storage) to PDF format and upload resulting file to storage.
|
178
214
|
[**put_text_annotation**](PdfApi.md#put_text_annotation) | **PUT** /pdf/\{name}/annotations/text/\{annotationId} | Replace document text annotation
|
215
|
+
[**put_underline_annotation**](PdfApi.md#put_underline_annotation) | **PUT** /pdf/\{name}/annotations/underline/\{annotationId} | Replace document underline annotation
|
179
216
|
[**put_update_field**](PdfApi.md#put_update_field) | **PUT** /pdf/\{name}/fields/\{fieldName} | Update field.
|
180
217
|
[**put_update_fields**](PdfApi.md#put_update_fields) | **PUT** /pdf/\{name}/fields | Update fields.
|
181
218
|
[**put_web_in_storage_to_pdf**](PdfApi.md#put_web_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/web | Convert web page to PDF format and upload resulting file to storage.
|
@@ -458,6 +495,31 @@ Name | Type | Description | Notes
|
|
458
495
|
|
459
496
|
|
460
497
|
|
498
|
+
# **get_caret_annotation**
|
499
|
+
> CaretAnnotationResponse get_caret_annotation(name, annotation_id, opts)
|
500
|
+
|
501
|
+
Read document page caret annotation by ID.
|
502
|
+
|
503
|
+
### Parameters
|
504
|
+
|
505
|
+
Name | Type | Description | Notes
|
506
|
+
------------- | ------------- | ------------- | -------------
|
507
|
+
**name** | **String**| The document name. |
|
508
|
+
**annotation_id** | **String**| The annotation ID. |
|
509
|
+
**storage** | **String**| The document storage. | [optional]
|
510
|
+
**folder** | **String**| The document folder. | [optional]
|
511
|
+
|
512
|
+
### Return type
|
513
|
+
|
514
|
+
[**CaretAnnotationResponse**](CaretAnnotationResponse.md)
|
515
|
+
|
516
|
+
### HTTP request headers
|
517
|
+
|
518
|
+
- **Content-Type**: application/json
|
519
|
+
- **Accept**: application/json
|
520
|
+
|
521
|
+
|
522
|
+
|
461
523
|
# **get_circle_annotation**
|
462
524
|
> CircleAnnotationResponse get_circle_annotation(name, annotation_id, opts)
|
463
525
|
|
@@ -605,6 +667,30 @@ Name | Type | Description | Notes
|
|
605
667
|
|
606
668
|
|
607
669
|
|
670
|
+
# **get_document_caret_annotations**
|
671
|
+
> CaretAnnotationsResponse get_document_caret_annotations(name, opts)
|
672
|
+
|
673
|
+
Read document caret annotations.
|
674
|
+
|
675
|
+
### Parameters
|
676
|
+
|
677
|
+
Name | Type | Description | Notes
|
678
|
+
------------- | ------------- | ------------- | -------------
|
679
|
+
**name** | **String**| The document name. |
|
680
|
+
**storage** | **String**| The document storage. | [optional]
|
681
|
+
**folder** | **String**| The document folder. | [optional]
|
682
|
+
|
683
|
+
### Return type
|
684
|
+
|
685
|
+
[**CaretAnnotationsResponse**](CaretAnnotationsResponse.md)
|
686
|
+
|
687
|
+
### HTTP request headers
|
688
|
+
|
689
|
+
- **Content-Type**: application/json
|
690
|
+
- **Accept**: application/json
|
691
|
+
|
692
|
+
|
693
|
+
|
608
694
|
# **get_document_circle_annotations**
|
609
695
|
> CircleAnnotationsResponse get_document_circle_annotations(name, opts)
|
610
696
|
|
@@ -653,6 +739,54 @@ Name | Type | Description | Notes
|
|
653
739
|
|
654
740
|
|
655
741
|
|
742
|
+
# **get_document_highlight_annotations**
|
743
|
+
> HighlightAnnotationsResponse get_document_highlight_annotations(name, opts)
|
744
|
+
|
745
|
+
Read document highlight annotations.
|
746
|
+
|
747
|
+
### Parameters
|
748
|
+
|
749
|
+
Name | Type | Description | Notes
|
750
|
+
------------- | ------------- | ------------- | -------------
|
751
|
+
**name** | **String**| The document name. |
|
752
|
+
**storage** | **String**| The document storage. | [optional]
|
753
|
+
**folder** | **String**| The document folder. | [optional]
|
754
|
+
|
755
|
+
### Return type
|
756
|
+
|
757
|
+
[**HighlightAnnotationsResponse**](HighlightAnnotationsResponse.md)
|
758
|
+
|
759
|
+
### HTTP request headers
|
760
|
+
|
761
|
+
- **Content-Type**: application/json
|
762
|
+
- **Accept**: application/json
|
763
|
+
|
764
|
+
|
765
|
+
|
766
|
+
# **get_document_ink_annotations**
|
767
|
+
> InkAnnotationsResponse get_document_ink_annotations(name, opts)
|
768
|
+
|
769
|
+
Read document ink annotations.
|
770
|
+
|
771
|
+
### Parameters
|
772
|
+
|
773
|
+
Name | Type | Description | Notes
|
774
|
+
------------- | ------------- | ------------- | -------------
|
775
|
+
**name** | **String**| The document name. |
|
776
|
+
**storage** | **String**| The document storage. | [optional]
|
777
|
+
**folder** | **String**| The document folder. | [optional]
|
778
|
+
|
779
|
+
### Return type
|
780
|
+
|
781
|
+
[**InkAnnotationsResponse**](InkAnnotationsResponse.md)
|
782
|
+
|
783
|
+
### HTTP request headers
|
784
|
+
|
785
|
+
- **Content-Type**: application/json
|
786
|
+
- **Accept**: application/json
|
787
|
+
|
788
|
+
|
789
|
+
|
656
790
|
# **get_document_line_annotations**
|
657
791
|
> LineAnnotationsResponse get_document_line_annotations(name, opts)
|
658
792
|
|
@@ -725,6 +859,55 @@ Name | Type | Description | Notes
|
|
725
859
|
|
726
860
|
|
727
861
|
|
862
|
+
# **get_document_popup_annotations**
|
863
|
+
> PopupAnnotationsResponse get_document_popup_annotations(name, opts)
|
864
|
+
|
865
|
+
Read document popup annotations.
|
866
|
+
|
867
|
+
### Parameters
|
868
|
+
|
869
|
+
Name | Type | Description | Notes
|
870
|
+
------------- | ------------- | ------------- | -------------
|
871
|
+
**name** | **String**| The document name. |
|
872
|
+
**storage** | **String**| The document storage. | [optional]
|
873
|
+
**folder** | **String**| The document folder. | [optional]
|
874
|
+
|
875
|
+
### Return type
|
876
|
+
|
877
|
+
[**PopupAnnotationsResponse**](PopupAnnotationsResponse.md)
|
878
|
+
|
879
|
+
### HTTP request headers
|
880
|
+
|
881
|
+
- **Content-Type**: application/json
|
882
|
+
- **Accept**: application/json
|
883
|
+
|
884
|
+
|
885
|
+
|
886
|
+
# **get_document_popup_annotations_by_parent**
|
887
|
+
> PopupAnnotationsResponse get_document_popup_annotations_by_parent(name, annotation_id, opts)
|
888
|
+
|
889
|
+
Read document popup annotations by parent id.
|
890
|
+
|
891
|
+
### Parameters
|
892
|
+
|
893
|
+
Name | Type | Description | Notes
|
894
|
+
------------- | ------------- | ------------- | -------------
|
895
|
+
**name** | **String**| The document name. |
|
896
|
+
**annotation_id** | **String**| The parent annotation ID. |
|
897
|
+
**storage** | **String**| The document storage. | [optional]
|
898
|
+
**folder** | **String**| The document folder. | [optional]
|
899
|
+
|
900
|
+
### Return type
|
901
|
+
|
902
|
+
[**PopupAnnotationsResponse**](PopupAnnotationsResponse.md)
|
903
|
+
|
904
|
+
### HTTP request headers
|
905
|
+
|
906
|
+
- **Content-Type**: application/json
|
907
|
+
- **Accept**: application/json
|
908
|
+
|
909
|
+
|
910
|
+
|
728
911
|
# **get_document_properties**
|
729
912
|
> DocumentPropertiesResponse get_document_properties(name, opts)
|
730
913
|
|
@@ -798,6 +981,54 @@ Name | Type | Description | Notes
|
|
798
981
|
|
799
982
|
|
800
983
|
|
984
|
+
# **get_document_squiggly_annotations**
|
985
|
+
> SquigglyAnnotationsResponse get_document_squiggly_annotations(name, opts)
|
986
|
+
|
987
|
+
Read document squiggly annotations.
|
988
|
+
|
989
|
+
### Parameters
|
990
|
+
|
991
|
+
Name | Type | Description | Notes
|
992
|
+
------------- | ------------- | ------------- | -------------
|
993
|
+
**name** | **String**| The document name. |
|
994
|
+
**storage** | **String**| The document storage. | [optional]
|
995
|
+
**folder** | **String**| The document folder. | [optional]
|
996
|
+
|
997
|
+
### Return type
|
998
|
+
|
999
|
+
[**SquigglyAnnotationsResponse**](SquigglyAnnotationsResponse.md)
|
1000
|
+
|
1001
|
+
### HTTP request headers
|
1002
|
+
|
1003
|
+
- **Content-Type**: application/json
|
1004
|
+
- **Accept**: application/json
|
1005
|
+
|
1006
|
+
|
1007
|
+
|
1008
|
+
# **get_document_strike_out_annotations**
|
1009
|
+
> StrikeOutAnnotationsResponse get_document_strike_out_annotations(name, opts)
|
1010
|
+
|
1011
|
+
Read document StrikeOut annotations.
|
1012
|
+
|
1013
|
+
### Parameters
|
1014
|
+
|
1015
|
+
Name | Type | Description | Notes
|
1016
|
+
------------- | ------------- | ------------- | -------------
|
1017
|
+
**name** | **String**| The document name. |
|
1018
|
+
**storage** | **String**| The document storage. | [optional]
|
1019
|
+
**folder** | **String**| The document folder. | [optional]
|
1020
|
+
|
1021
|
+
### Return type
|
1022
|
+
|
1023
|
+
[**StrikeOutAnnotationsResponse**](StrikeOutAnnotationsResponse.md)
|
1024
|
+
|
1025
|
+
### HTTP request headers
|
1026
|
+
|
1027
|
+
- **Content-Type**: application/json
|
1028
|
+
- **Accept**: application/json
|
1029
|
+
|
1030
|
+
|
1031
|
+
|
801
1032
|
# **get_document_text_annotations**
|
802
1033
|
> TextAnnotationsResponse get_document_text_annotations(name, opts)
|
803
1034
|
|
@@ -822,6 +1053,30 @@ Name | Type | Description | Notes
|
|
822
1053
|
|
823
1054
|
|
824
1055
|
|
1056
|
+
# **get_document_underline_annotations**
|
1057
|
+
> UnderlineAnnotationsResponse get_document_underline_annotations(name, opts)
|
1058
|
+
|
1059
|
+
Read document underline annotations.
|
1060
|
+
|
1061
|
+
### Parameters
|
1062
|
+
|
1063
|
+
Name | Type | Description | Notes
|
1064
|
+
------------- | ------------- | ------------- | -------------
|
1065
|
+
**name** | **String**| The document name. |
|
1066
|
+
**storage** | **String**| The document storage. | [optional]
|
1067
|
+
**folder** | **String**| The document folder. | [optional]
|
1068
|
+
|
1069
|
+
### Return type
|
1070
|
+
|
1071
|
+
[**UnderlineAnnotationsResponse**](UnderlineAnnotationsResponse.md)
|
1072
|
+
|
1073
|
+
### HTTP request headers
|
1074
|
+
|
1075
|
+
- **Content-Type**: application/json
|
1076
|
+
- **Accept**: application/json
|
1077
|
+
|
1078
|
+
|
1079
|
+
|
825
1080
|
# **get_download**
|
826
1081
|
> File get_download(path, opts)
|
827
1082
|
|
@@ -968,8 +1223,33 @@ Name | Type | Description | Notes
|
|
968
1223
|
|
969
1224
|
|
970
1225
|
|
1226
|
+
# **get_highlight_annotation**
|
1227
|
+
> HighlightAnnotationResponse get_highlight_annotation(name, annotation_id, opts)
|
1228
|
+
|
1229
|
+
Read document page highlight annotation by ID.
|
1230
|
+
|
1231
|
+
### Parameters
|
1232
|
+
|
1233
|
+
Name | Type | Description | Notes
|
1234
|
+
------------- | ------------- | ------------- | -------------
|
1235
|
+
**name** | **String**| The document name. |
|
1236
|
+
**annotation_id** | **String**| The annotation ID. |
|
1237
|
+
**storage** | **String**| The document storage. | [optional]
|
1238
|
+
**folder** | **String**| The document folder. | [optional]
|
1239
|
+
|
1240
|
+
### Return type
|
1241
|
+
|
1242
|
+
[**HighlightAnnotationResponse**](HighlightAnnotationResponse.md)
|
1243
|
+
|
1244
|
+
### HTTP request headers
|
1245
|
+
|
1246
|
+
- **Content-Type**: application/json
|
1247
|
+
- **Accept**: application/json
|
1248
|
+
|
1249
|
+
|
1250
|
+
|
971
1251
|
# **get_html_in_storage_to_pdf**
|
972
|
-
> File get_html_in_storage_to_pdf(src_path,
|
1252
|
+
> File get_html_in_storage_to_pdf(src_path, opts)
|
973
1253
|
|
974
1254
|
Convert HTML file (located on storage) to PDF format and return resulting file in response.
|
975
1255
|
|
@@ -978,7 +1258,7 @@ Convert HTML file (located on storage) to PDF format and return resulting file i
|
|
978
1258
|
Name | Type | Description | Notes
|
979
1259
|
------------- | ------------- | ------------- | -------------
|
980
1260
|
**src_path** | **String**| Full source filename (ex. /folder1/folder2/template.zip) |
|
981
|
-
**html_file_name** | **String**| Name of HTML file in ZIP. |
|
1261
|
+
**html_file_name** | **String**| Name of HTML file in ZIP. | [optional]
|
982
1262
|
**height** | **Float**| Page height | [optional]
|
983
1263
|
**width** | **Float**| Page width | [optional]
|
984
1264
|
**is_landscape** | **BOOLEAN**| Is page landscaped | [optional]
|
@@ -1157,6 +1437,31 @@ Name | Type | Description | Notes
|
|
1157
1437
|
|
1158
1438
|
|
1159
1439
|
|
1440
|
+
# **get_ink_annotation**
|
1441
|
+
> InkAnnotationResponse get_ink_annotation(name, annotation_id, opts)
|
1442
|
+
|
1443
|
+
Read document page ink annotation by ID.
|
1444
|
+
|
1445
|
+
### Parameters
|
1446
|
+
|
1447
|
+
Name | Type | Description | Notes
|
1448
|
+
------------- | ------------- | ------------- | -------------
|
1449
|
+
**name** | **String**| The document name. |
|
1450
|
+
**annotation_id** | **String**| The annotation ID. |
|
1451
|
+
**storage** | **String**| The document storage. | [optional]
|
1452
|
+
**folder** | **String**| The document folder. | [optional]
|
1453
|
+
|
1454
|
+
### Return type
|
1455
|
+
|
1456
|
+
[**InkAnnotationResponse**](InkAnnotationResponse.md)
|
1457
|
+
|
1458
|
+
### HTTP request headers
|
1459
|
+
|
1460
|
+
- **Content-Type**: application/json
|
1461
|
+
- **Accept**: application/json
|
1462
|
+
|
1463
|
+
|
1464
|
+
|
1160
1465
|
# **get_la_te_x_in_storage_to_pdf**
|
1161
1466
|
> File get_la_te_x_in_storage_to_pdf(src_path, opts)
|
1162
1467
|
|
@@ -1230,6 +1535,29 @@ Name | Type | Description | Notes
|
|
1230
1535
|
|
1231
1536
|
|
1232
1537
|
|
1538
|
+
# **get_list_files**
|
1539
|
+
> FilesResponse get_list_files(opts)
|
1540
|
+
|
1541
|
+
Get the file listing of a specific folder
|
1542
|
+
|
1543
|
+
### Parameters
|
1544
|
+
|
1545
|
+
Name | Type | Description | Notes
|
1546
|
+
------------- | ------------- | ------------- | -------------
|
1547
|
+
**path** | **String**| Start with name of storage e.g. root folder '/'or some folder '/folder1/..' | [optional] [default to /]
|
1548
|
+
**storage** | **String**| User's storage name | [optional]
|
1549
|
+
|
1550
|
+
### Return type
|
1551
|
+
|
1552
|
+
[**FilesResponse**](FilesResponse.md)
|
1553
|
+
|
1554
|
+
### HTTP request headers
|
1555
|
+
|
1556
|
+
- **Content-Type**: application/json
|
1557
|
+
- **Accept**: application/json
|
1558
|
+
|
1559
|
+
|
1560
|
+
|
1233
1561
|
# **get_mht_in_storage_to_pdf**
|
1234
1562
|
> File get_mht_in_storage_to_pdf(src_path, opts)
|
1235
1563
|
|
@@ -1303,6 +1631,31 @@ Name | Type | Description | Notes
|
|
1303
1631
|
|
1304
1632
|
|
1305
1633
|
|
1634
|
+
# **get_page_caret_annotations**
|
1635
|
+
> CaretAnnotationsResponse get_page_caret_annotations(name, page_number, opts)
|
1636
|
+
|
1637
|
+
Read document page caret annotations.
|
1638
|
+
|
1639
|
+
### Parameters
|
1640
|
+
|
1641
|
+
Name | Type | Description | Notes
|
1642
|
+
------------- | ------------- | ------------- | -------------
|
1643
|
+
**name** | **String**| The document name. |
|
1644
|
+
**page_number** | **Integer**| The page number. |
|
1645
|
+
**storage** | **String**| The document storage. | [optional]
|
1646
|
+
**folder** | **String**| The document folder. | [optional]
|
1647
|
+
|
1648
|
+
### Return type
|
1649
|
+
|
1650
|
+
[**CaretAnnotationsResponse**](CaretAnnotationsResponse.md)
|
1651
|
+
|
1652
|
+
### HTTP request headers
|
1653
|
+
|
1654
|
+
- **Content-Type**: application/json
|
1655
|
+
- **Accept**: application/json
|
1656
|
+
|
1657
|
+
|
1658
|
+
|
1306
1659
|
# **get_page_circle_annotations**
|
1307
1660
|
> CircleAnnotationsResponse get_page_circle_annotations(name, page_number, opts)
|
1308
1661
|
|
@@ -1400,7 +1753,138 @@ Name | Type | Description | Notes
|
|
1400
1753
|
|
1401
1754
|
### Return type
|
1402
1755
|
|
1403
|
-
**File**
|
1756
|
+
**File**
|
1757
|
+
|
1758
|
+
### HTTP request headers
|
1759
|
+
|
1760
|
+
- **Content-Type**: application/json
|
1761
|
+
- **Accept**: application/json
|
1762
|
+
|
1763
|
+
|
1764
|
+
|
1765
|
+
# **get_page_convert_to_jpeg**
|
1766
|
+
> File get_page_convert_to_jpeg(name, page_number, opts)
|
1767
|
+
|
1768
|
+
Convert document page to Jpeg image and return resulting file in response.
|
1769
|
+
|
1770
|
+
### Parameters
|
1771
|
+
|
1772
|
+
Name | Type | Description | Notes
|
1773
|
+
------------- | ------------- | ------------- | -------------
|
1774
|
+
**name** | **String**| The document name. |
|
1775
|
+
**page_number** | **Integer**| The page number. |
|
1776
|
+
**width** | **Integer**| The converted image width. | [optional]
|
1777
|
+
**height** | **Integer**| The converted image height. | [optional]
|
1778
|
+
**folder** | **String**| The document folder. | [optional]
|
1779
|
+
**storage** | **String**| The document storage. | [optional]
|
1780
|
+
|
1781
|
+
### Return type
|
1782
|
+
|
1783
|
+
**File**
|
1784
|
+
|
1785
|
+
### HTTP request headers
|
1786
|
+
|
1787
|
+
- **Content-Type**: application/json
|
1788
|
+
- **Accept**: application/json
|
1789
|
+
|
1790
|
+
|
1791
|
+
|
1792
|
+
# **get_page_convert_to_png**
|
1793
|
+
> File get_page_convert_to_png(name, page_number, opts)
|
1794
|
+
|
1795
|
+
Convert document page to Png image and return resulting file in response.
|
1796
|
+
|
1797
|
+
### Parameters
|
1798
|
+
|
1799
|
+
Name | Type | Description | Notes
|
1800
|
+
------------- | ------------- | ------------- | -------------
|
1801
|
+
**name** | **String**| The document name. |
|
1802
|
+
**page_number** | **Integer**| The page number. |
|
1803
|
+
**width** | **Integer**| The converted image width. | [optional]
|
1804
|
+
**height** | **Integer**| The converted image height. | [optional]
|
1805
|
+
**folder** | **String**| The document folder. | [optional]
|
1806
|
+
**storage** | **String**| The document storage. | [optional]
|
1807
|
+
|
1808
|
+
### Return type
|
1809
|
+
|
1810
|
+
**File**
|
1811
|
+
|
1812
|
+
### HTTP request headers
|
1813
|
+
|
1814
|
+
- **Content-Type**: application/json
|
1815
|
+
- **Accept**: application/json
|
1816
|
+
|
1817
|
+
|
1818
|
+
|
1819
|
+
# **get_page_convert_to_tiff**
|
1820
|
+
> File get_page_convert_to_tiff(name, page_number, opts)
|
1821
|
+
|
1822
|
+
Convert document page to Tiff image and return resulting file in response.
|
1823
|
+
|
1824
|
+
### Parameters
|
1825
|
+
|
1826
|
+
Name | Type | Description | Notes
|
1827
|
+
------------- | ------------- | ------------- | -------------
|
1828
|
+
**name** | **String**| The document name. |
|
1829
|
+
**page_number** | **Integer**| The page number. |
|
1830
|
+
**width** | **Integer**| The converted image width. | [optional]
|
1831
|
+
**height** | **Integer**| The converted image height. | [optional]
|
1832
|
+
**folder** | **String**| The document folder. | [optional]
|
1833
|
+
**storage** | **String**| The document storage. | [optional]
|
1834
|
+
|
1835
|
+
### Return type
|
1836
|
+
|
1837
|
+
**File**
|
1838
|
+
|
1839
|
+
### HTTP request headers
|
1840
|
+
|
1841
|
+
- **Content-Type**: application/json
|
1842
|
+
- **Accept**: application/json
|
1843
|
+
|
1844
|
+
|
1845
|
+
|
1846
|
+
# **get_page_free_text_annotations**
|
1847
|
+
> FreeTextAnnotationsResponse get_page_free_text_annotations(name, page_number, opts)
|
1848
|
+
|
1849
|
+
Read document page free text annotations.
|
1850
|
+
|
1851
|
+
### Parameters
|
1852
|
+
|
1853
|
+
Name | Type | Description | Notes
|
1854
|
+
------------- | ------------- | ------------- | -------------
|
1855
|
+
**name** | **String**| The document name. |
|
1856
|
+
**page_number** | **Integer**| The page number. |
|
1857
|
+
**storage** | **String**| The document storage. | [optional]
|
1858
|
+
**folder** | **String**| The document folder. | [optional]
|
1859
|
+
|
1860
|
+
### Return type
|
1861
|
+
|
1862
|
+
[**FreeTextAnnotationsResponse**](FreeTextAnnotationsResponse.md)
|
1863
|
+
|
1864
|
+
### HTTP request headers
|
1865
|
+
|
1866
|
+
- **Content-Type**: application/json
|
1867
|
+
- **Accept**: application/json
|
1868
|
+
|
1869
|
+
|
1870
|
+
|
1871
|
+
# **get_page_highlight_annotations**
|
1872
|
+
> HighlightAnnotationsResponse get_page_highlight_annotations(name, page_number, opts)
|
1873
|
+
|
1874
|
+
Read document page highlight annotations.
|
1875
|
+
|
1876
|
+
### Parameters
|
1877
|
+
|
1878
|
+
Name | Type | Description | Notes
|
1879
|
+
------------- | ------------- | ------------- | -------------
|
1880
|
+
**name** | **String**| The document name. |
|
1881
|
+
**page_number** | **Integer**| The page number. |
|
1882
|
+
**storage** | **String**| The document storage. | [optional]
|
1883
|
+
**folder** | **String**| The document folder. | [optional]
|
1884
|
+
|
1885
|
+
### Return type
|
1886
|
+
|
1887
|
+
[**HighlightAnnotationsResponse**](HighlightAnnotationsResponse.md)
|
1404
1888
|
|
1405
1889
|
### HTTP request headers
|
1406
1890
|
|
@@ -1409,10 +1893,10 @@ Name | Type | Description | Notes
|
|
1409
1893
|
|
1410
1894
|
|
1411
1895
|
|
1412
|
-
# **
|
1413
|
-
>
|
1896
|
+
# **get_page_ink_annotations**
|
1897
|
+
> InkAnnotationsResponse get_page_ink_annotations(name, page_number, opts)
|
1414
1898
|
|
1415
|
-
|
1899
|
+
Read document page ink annotations.
|
1416
1900
|
|
1417
1901
|
### Parameters
|
1418
1902
|
|
@@ -1420,14 +1904,12 @@ Name | Type | Description | Notes
|
|
1420
1904
|
------------- | ------------- | ------------- | -------------
|
1421
1905
|
**name** | **String**| The document name. |
|
1422
1906
|
**page_number** | **Integer**| The page number. |
|
1423
|
-
**width** | **Integer**| The converted image width. | [optional]
|
1424
|
-
**height** | **Integer**| The converted image height. | [optional]
|
1425
|
-
**folder** | **String**| The document folder. | [optional]
|
1426
1907
|
**storage** | **String**| The document storage. | [optional]
|
1908
|
+
**folder** | **String**| The document folder. | [optional]
|
1427
1909
|
|
1428
1910
|
### Return type
|
1429
1911
|
|
1430
|
-
**
|
1912
|
+
[**InkAnnotationsResponse**](InkAnnotationsResponse.md)
|
1431
1913
|
|
1432
1914
|
### HTTP request headers
|
1433
1915
|
|
@@ -1436,10 +1918,10 @@ Name | Type | Description | Notes
|
|
1436
1918
|
|
1437
1919
|
|
1438
1920
|
|
1439
|
-
# **
|
1440
|
-
>
|
1921
|
+
# **get_page_line_annotations**
|
1922
|
+
> LineAnnotationsResponse get_page_line_annotations(name, page_number, opts)
|
1441
1923
|
|
1442
|
-
|
1924
|
+
Read document page line annotations.
|
1443
1925
|
|
1444
1926
|
### Parameters
|
1445
1927
|
|
@@ -1447,14 +1929,12 @@ Name | Type | Description | Notes
|
|
1447
1929
|
------------- | ------------- | ------------- | -------------
|
1448
1930
|
**name** | **String**| The document name. |
|
1449
1931
|
**page_number** | **Integer**| The page number. |
|
1450
|
-
**width** | **Integer**| The converted image width. | [optional]
|
1451
|
-
**height** | **Integer**| The converted image height. | [optional]
|
1452
|
-
**folder** | **String**| The document folder. | [optional]
|
1453
1932
|
**storage** | **String**| The document storage. | [optional]
|
1933
|
+
**folder** | **String**| The document folder. | [optional]
|
1454
1934
|
|
1455
1935
|
### Return type
|
1456
1936
|
|
1457
|
-
**
|
1937
|
+
[**LineAnnotationsResponse**](LineAnnotationsResponse.md)
|
1458
1938
|
|
1459
1939
|
### HTTP request headers
|
1460
1940
|
|
@@ -1463,10 +1943,10 @@ Name | Type | Description | Notes
|
|
1463
1943
|
|
1464
1944
|
|
1465
1945
|
|
1466
|
-
# **
|
1467
|
-
>
|
1946
|
+
# **get_page_link_annotation**
|
1947
|
+
> LinkAnnotationResponse get_page_link_annotation(name, page_number, link_id, opts)
|
1468
1948
|
|
1469
|
-
|
1949
|
+
Read document page link annotation by ID.
|
1470
1950
|
|
1471
1951
|
### Parameters
|
1472
1952
|
|
@@ -1474,14 +1954,13 @@ Name | Type | Description | Notes
|
|
1474
1954
|
------------- | ------------- | ------------- | -------------
|
1475
1955
|
**name** | **String**| The document name. |
|
1476
1956
|
**page_number** | **Integer**| The page number. |
|
1477
|
-
**
|
1478
|
-
**height** | **Integer**| The converted image height. | [optional]
|
1479
|
-
**folder** | **String**| The document folder. | [optional]
|
1957
|
+
**link_id** | **String**| The link ID. |
|
1480
1958
|
**storage** | **String**| The document storage. | [optional]
|
1959
|
+
**folder** | **String**| The document folder. | [optional]
|
1481
1960
|
|
1482
1961
|
### Return type
|
1483
1962
|
|
1484
|
-
**
|
1963
|
+
[**LinkAnnotationResponse**](LinkAnnotationResponse.md)
|
1485
1964
|
|
1486
1965
|
### HTTP request headers
|
1487
1966
|
|
@@ -1490,10 +1969,10 @@ Name | Type | Description | Notes
|
|
1490
1969
|
|
1491
1970
|
|
1492
1971
|
|
1493
|
-
# **
|
1494
|
-
>
|
1972
|
+
# **get_page_link_annotations**
|
1973
|
+
> LinkAnnotationsResponse get_page_link_annotations(name, page_number, opts)
|
1495
1974
|
|
1496
|
-
Read document page
|
1975
|
+
Read document page link annotations.
|
1497
1976
|
|
1498
1977
|
### Parameters
|
1499
1978
|
|
@@ -1506,7 +1985,7 @@ Name | Type | Description | Notes
|
|
1506
1985
|
|
1507
1986
|
### Return type
|
1508
1987
|
|
1509
|
-
[**
|
1988
|
+
[**LinkAnnotationsResponse**](LinkAnnotationsResponse.md)
|
1510
1989
|
|
1511
1990
|
### HTTP request headers
|
1512
1991
|
|
@@ -1515,10 +1994,10 @@ Name | Type | Description | Notes
|
|
1515
1994
|
|
1516
1995
|
|
1517
1996
|
|
1518
|
-
# **
|
1519
|
-
>
|
1997
|
+
# **get_page_poly_line_annotations**
|
1998
|
+
> PolyLineAnnotationsResponse get_page_poly_line_annotations(name, page_number, opts)
|
1520
1999
|
|
1521
|
-
Read document page
|
2000
|
+
Read document page polyline annotations.
|
1522
2001
|
|
1523
2002
|
### Parameters
|
1524
2003
|
|
@@ -1531,7 +2010,7 @@ Name | Type | Description | Notes
|
|
1531
2010
|
|
1532
2011
|
### Return type
|
1533
2012
|
|
1534
|
-
[**
|
2013
|
+
[**PolyLineAnnotationsResponse**](PolyLineAnnotationsResponse.md)
|
1535
2014
|
|
1536
2015
|
### HTTP request headers
|
1537
2016
|
|
@@ -1540,10 +2019,10 @@ Name | Type | Description | Notes
|
|
1540
2019
|
|
1541
2020
|
|
1542
2021
|
|
1543
|
-
# **
|
1544
|
-
>
|
2022
|
+
# **get_page_polygon_annotations**
|
2023
|
+
> PolygonAnnotationsResponse get_page_polygon_annotations(name, page_number, opts)
|
1545
2024
|
|
1546
|
-
Read document page
|
2025
|
+
Read document page polygon annotations.
|
1547
2026
|
|
1548
2027
|
### Parameters
|
1549
2028
|
|
@@ -1551,13 +2030,12 @@ Name | Type | Description | Notes
|
|
1551
2030
|
------------- | ------------- | ------------- | -------------
|
1552
2031
|
**name** | **String**| The document name. |
|
1553
2032
|
**page_number** | **Integer**| The page number. |
|
1554
|
-
**link_id** | **String**| The link ID. |
|
1555
2033
|
**storage** | **String**| The document storage. | [optional]
|
1556
2034
|
**folder** | **String**| The document folder. | [optional]
|
1557
2035
|
|
1558
2036
|
### Return type
|
1559
2037
|
|
1560
|
-
[**
|
2038
|
+
[**PolygonAnnotationsResponse**](PolygonAnnotationsResponse.md)
|
1561
2039
|
|
1562
2040
|
### HTTP request headers
|
1563
2041
|
|
@@ -1566,10 +2044,10 @@ Name | Type | Description | Notes
|
|
1566
2044
|
|
1567
2045
|
|
1568
2046
|
|
1569
|
-
# **
|
1570
|
-
>
|
2047
|
+
# **get_page_popup_annotations**
|
2048
|
+
> PopupAnnotationsResponse get_page_popup_annotations(name, page_number, opts)
|
1571
2049
|
|
1572
|
-
Read document page
|
2050
|
+
Read document page popup annotations.
|
1573
2051
|
|
1574
2052
|
### Parameters
|
1575
2053
|
|
@@ -1582,7 +2060,7 @@ Name | Type | Description | Notes
|
|
1582
2060
|
|
1583
2061
|
### Return type
|
1584
2062
|
|
1585
|
-
[**
|
2063
|
+
[**PopupAnnotationsResponse**](PopupAnnotationsResponse.md)
|
1586
2064
|
|
1587
2065
|
### HTTP request headers
|
1588
2066
|
|
@@ -1591,10 +2069,10 @@ Name | Type | Description | Notes
|
|
1591
2069
|
|
1592
2070
|
|
1593
2071
|
|
1594
|
-
# **
|
1595
|
-
>
|
2072
|
+
# **get_page_square_annotations**
|
2073
|
+
> SquareAnnotationsResponse get_page_square_annotations(name, page_number, opts)
|
1596
2074
|
|
1597
|
-
Read document page
|
2075
|
+
Read document page square annotations.
|
1598
2076
|
|
1599
2077
|
### Parameters
|
1600
2078
|
|
@@ -1607,7 +2085,7 @@ Name | Type | Description | Notes
|
|
1607
2085
|
|
1608
2086
|
### Return type
|
1609
2087
|
|
1610
|
-
[**
|
2088
|
+
[**SquareAnnotationsResponse**](SquareAnnotationsResponse.md)
|
1611
2089
|
|
1612
2090
|
### HTTP request headers
|
1613
2091
|
|
@@ -1616,10 +2094,10 @@ Name | Type | Description | Notes
|
|
1616
2094
|
|
1617
2095
|
|
1618
2096
|
|
1619
|
-
# **
|
1620
|
-
>
|
2097
|
+
# **get_page_squiggly_annotations**
|
2098
|
+
> SquigglyAnnotationsResponse get_page_squiggly_annotations(name, page_number, opts)
|
1621
2099
|
|
1622
|
-
Read document page
|
2100
|
+
Read document page squiggly annotations.
|
1623
2101
|
|
1624
2102
|
### Parameters
|
1625
2103
|
|
@@ -1632,7 +2110,7 @@ Name | Type | Description | Notes
|
|
1632
2110
|
|
1633
2111
|
### Return type
|
1634
2112
|
|
1635
|
-
[**
|
2113
|
+
[**SquigglyAnnotationsResponse**](SquigglyAnnotationsResponse.md)
|
1636
2114
|
|
1637
2115
|
### HTTP request headers
|
1638
2116
|
|
@@ -1641,10 +2119,10 @@ Name | Type | Description | Notes
|
|
1641
2119
|
|
1642
2120
|
|
1643
2121
|
|
1644
|
-
# **
|
1645
|
-
>
|
2122
|
+
# **get_page_strike_out_annotations**
|
2123
|
+
> StrikeOutAnnotationsResponse get_page_strike_out_annotations(name, page_number, opts)
|
1646
2124
|
|
1647
|
-
Read document page
|
2125
|
+
Read document page StrikeOut annotations.
|
1648
2126
|
|
1649
2127
|
### Parameters
|
1650
2128
|
|
@@ -1657,7 +2135,7 @@ Name | Type | Description | Notes
|
|
1657
2135
|
|
1658
2136
|
### Return type
|
1659
2137
|
|
1660
|
-
[**
|
2138
|
+
[**StrikeOutAnnotationsResponse**](StrikeOutAnnotationsResponse.md)
|
1661
2139
|
|
1662
2140
|
### HTTP request headers
|
1663
2141
|
|
@@ -1723,6 +2201,31 @@ Name | Type | Description | Notes
|
|
1723
2201
|
|
1724
2202
|
|
1725
2203
|
|
2204
|
+
# **get_page_underline_annotations**
|
2205
|
+
> UnderlineAnnotationsResponse get_page_underline_annotations(name, page_number, opts)
|
2206
|
+
|
2207
|
+
Read document page underline annotations.
|
2208
|
+
|
2209
|
+
### Parameters
|
2210
|
+
|
2211
|
+
Name | Type | Description | Notes
|
2212
|
+
------------- | ------------- | ------------- | -------------
|
2213
|
+
**name** | **String**| The document name. |
|
2214
|
+
**page_number** | **Integer**| The page number. |
|
2215
|
+
**storage** | **String**| The document storage. | [optional]
|
2216
|
+
**folder** | **String**| The document folder. | [optional]
|
2217
|
+
|
2218
|
+
### Return type
|
2219
|
+
|
2220
|
+
[**UnderlineAnnotationsResponse**](UnderlineAnnotationsResponse.md)
|
2221
|
+
|
2222
|
+
### HTTP request headers
|
2223
|
+
|
2224
|
+
- **Content-Type**: application/json
|
2225
|
+
- **Accept**: application/json
|
2226
|
+
|
2227
|
+
|
2228
|
+
|
1726
2229
|
# **get_pages**
|
1727
2230
|
> DocumentPagesResponse get_pages(name, opts)
|
1728
2231
|
|
@@ -2169,6 +2672,31 @@ Name | Type | Description | Notes
|
|
2169
2672
|
|
2170
2673
|
|
2171
2674
|
|
2675
|
+
# **get_popup_annotation**
|
2676
|
+
> PopupAnnotationResponse get_popup_annotation(name, annotation_id, opts)
|
2677
|
+
|
2678
|
+
Read document page popup annotation by ID.
|
2679
|
+
|
2680
|
+
### Parameters
|
2681
|
+
|
2682
|
+
Name | Type | Description | Notes
|
2683
|
+
------------- | ------------- | ------------- | -------------
|
2684
|
+
**name** | **String**| The document name. |
|
2685
|
+
**annotation_id** | **String**| The annotation ID. |
|
2686
|
+
**storage** | **String**| The document storage. | [optional]
|
2687
|
+
**folder** | **String**| The document folder. | [optional]
|
2688
|
+
|
2689
|
+
### Return type
|
2690
|
+
|
2691
|
+
[**PopupAnnotationResponse**](PopupAnnotationResponse.md)
|
2692
|
+
|
2693
|
+
### HTTP request headers
|
2694
|
+
|
2695
|
+
- **Content-Type**: application/json
|
2696
|
+
- **Accept**: application/json
|
2697
|
+
|
2698
|
+
|
2699
|
+
|
2172
2700
|
# **get_ps_in_storage_to_pdf**
|
2173
2701
|
> File get_ps_in_storage_to_pdf(src_path, opts)
|
2174
2702
|
|
@@ -2217,6 +2745,56 @@ Name | Type | Description | Notes
|
|
2217
2745
|
|
2218
2746
|
|
2219
2747
|
|
2748
|
+
# **get_squiggly_annotation**
|
2749
|
+
> SquigglyAnnotationResponse get_squiggly_annotation(name, annotation_id, opts)
|
2750
|
+
|
2751
|
+
Read document page squiggly annotation by ID.
|
2752
|
+
|
2753
|
+
### Parameters
|
2754
|
+
|
2755
|
+
Name | Type | Description | Notes
|
2756
|
+
------------- | ------------- | ------------- | -------------
|
2757
|
+
**name** | **String**| The document name. |
|
2758
|
+
**annotation_id** | **String**| The annotation ID. |
|
2759
|
+
**storage** | **String**| The document storage. | [optional]
|
2760
|
+
**folder** | **String**| The document folder. | [optional]
|
2761
|
+
|
2762
|
+
### Return type
|
2763
|
+
|
2764
|
+
[**SquigglyAnnotationResponse**](SquigglyAnnotationResponse.md)
|
2765
|
+
|
2766
|
+
### HTTP request headers
|
2767
|
+
|
2768
|
+
- **Content-Type**: application/json
|
2769
|
+
- **Accept**: application/json
|
2770
|
+
|
2771
|
+
|
2772
|
+
|
2773
|
+
# **get_strike_out_annotation**
|
2774
|
+
> StrikeOutAnnotationResponse get_strike_out_annotation(name, annotation_id, opts)
|
2775
|
+
|
2776
|
+
Read document page StrikeOut annotation by ID.
|
2777
|
+
|
2778
|
+
### Parameters
|
2779
|
+
|
2780
|
+
Name | Type | Description | Notes
|
2781
|
+
------------- | ------------- | ------------- | -------------
|
2782
|
+
**name** | **String**| The document name. |
|
2783
|
+
**annotation_id** | **String**| The annotation ID. |
|
2784
|
+
**storage** | **String**| The document storage. | [optional]
|
2785
|
+
**folder** | **String**| The document folder. | [optional]
|
2786
|
+
|
2787
|
+
### Return type
|
2788
|
+
|
2789
|
+
[**StrikeOutAnnotationResponse**](StrikeOutAnnotationResponse.md)
|
2790
|
+
|
2791
|
+
### HTTP request headers
|
2792
|
+
|
2793
|
+
- **Content-Type**: application/json
|
2794
|
+
- **Accept**: application/json
|
2795
|
+
|
2796
|
+
|
2797
|
+
|
2220
2798
|
# **get_svg_in_storage_to_pdf**
|
2221
2799
|
> File get_svg_in_storage_to_pdf(src_path, opts)
|
2222
2800
|
|
@@ -2304,6 +2882,31 @@ Name | Type | Description | Notes
|
|
2304
2882
|
|
2305
2883
|
|
2306
2884
|
|
2885
|
+
# **get_underline_annotation**
|
2886
|
+
> UnderlineAnnotationResponse get_underline_annotation(name, annotation_id, opts)
|
2887
|
+
|
2888
|
+
Read document page underline annotation by ID.
|
2889
|
+
|
2890
|
+
### Parameters
|
2891
|
+
|
2892
|
+
Name | Type | Description | Notes
|
2893
|
+
------------- | ------------- | ------------- | -------------
|
2894
|
+
**name** | **String**| The document name. |
|
2895
|
+
**annotation_id** | **String**| The annotation ID. |
|
2896
|
+
**storage** | **String**| The document storage. | [optional]
|
2897
|
+
**folder** | **String**| The document folder. | [optional]
|
2898
|
+
|
2899
|
+
### Return type
|
2900
|
+
|
2901
|
+
[**UnderlineAnnotationResponse**](UnderlineAnnotationResponse.md)
|
2902
|
+
|
2903
|
+
### HTTP request headers
|
2904
|
+
|
2905
|
+
- **Content-Type**: application/json
|
2906
|
+
- **Accept**: application/json
|
2907
|
+
|
2908
|
+
|
2909
|
+
|
2307
2910
|
# **get_verify_signature**
|
2308
2911
|
> SignatureVerifyResponse get_verify_signature(name, sign_name, opts)
|
2309
2912
|
|
@@ -2590,7 +3193,84 @@ Name | Type | Description | Notes
|
|
2590
3193
|
# **post_move_page**
|
2591
3194
|
> AsposeResponse post_move_page(name, page_number, new_index, opts)
|
2592
3195
|
|
2593
|
-
Move page to new position.
|
3196
|
+
Move page to new position.
|
3197
|
+
|
3198
|
+
### Parameters
|
3199
|
+
|
3200
|
+
Name | Type | Description | Notes
|
3201
|
+
------------- | ------------- | ------------- | -------------
|
3202
|
+
**name** | **String**| The document name. |
|
3203
|
+
**page_number** | **Integer**| The page number. |
|
3204
|
+
**new_index** | **Integer**| The new page position/index. |
|
3205
|
+
**storage** | **String**| The document storage. | [optional]
|
3206
|
+
**folder** | **String**| The document folder. | [optional]
|
3207
|
+
|
3208
|
+
### Return type
|
3209
|
+
|
3210
|
+
[**AsposeResponse**](AsposeResponse.md)
|
3211
|
+
|
3212
|
+
### HTTP request headers
|
3213
|
+
|
3214
|
+
- **Content-Type**: application/json
|
3215
|
+
- **Accept**: application/json
|
3216
|
+
|
3217
|
+
|
3218
|
+
|
3219
|
+
# **post_optimize_document**
|
3220
|
+
> AsposeResponse post_optimize_document(name, opts)
|
3221
|
+
|
3222
|
+
Optimize document.
|
3223
|
+
|
3224
|
+
### Parameters
|
3225
|
+
|
3226
|
+
Name | Type | Description | Notes
|
3227
|
+
------------- | ------------- | ------------- | -------------
|
3228
|
+
**name** | **String**| The document name. |
|
3229
|
+
**options** | [**OptimizeOptions**](OptimizeOptions.md)| The optimization options. | [optional]
|
3230
|
+
**storage** | **String**| The document storage. | [optional]
|
3231
|
+
**folder** | **String**| The document folder. | [optional]
|
3232
|
+
|
3233
|
+
### Return type
|
3234
|
+
|
3235
|
+
[**AsposeResponse**](AsposeResponse.md)
|
3236
|
+
|
3237
|
+
### HTTP request headers
|
3238
|
+
|
3239
|
+
- **Content-Type**: application/json
|
3240
|
+
- **Accept**: application/json
|
3241
|
+
|
3242
|
+
|
3243
|
+
|
3244
|
+
# **post_page_caret_annotations**
|
3245
|
+
> AsposeResponse post_page_caret_annotations(name, page_number, annotations, opts)
|
3246
|
+
|
3247
|
+
Add document page caret annotations.
|
3248
|
+
|
3249
|
+
### Parameters
|
3250
|
+
|
3251
|
+
Name | Type | Description | Notes
|
3252
|
+
------------- | ------------- | ------------- | -------------
|
3253
|
+
**name** | **String**| The document name. |
|
3254
|
+
**page_number** | **Integer**| The page number. |
|
3255
|
+
**annotations** | [**Array<CaretAnnotation>**](CaretAnnotation.md)| The array of annotation. |
|
3256
|
+
**storage** | **String**| The document storage. | [optional]
|
3257
|
+
**folder** | **String**| The document folder. | [optional]
|
3258
|
+
|
3259
|
+
### Return type
|
3260
|
+
|
3261
|
+
[**AsposeResponse**](AsposeResponse.md)
|
3262
|
+
|
3263
|
+
### HTTP request headers
|
3264
|
+
|
3265
|
+
- **Content-Type**: application/json
|
3266
|
+
- **Accept**: application/json
|
3267
|
+
|
3268
|
+
|
3269
|
+
|
3270
|
+
# **post_page_circle_annotations**
|
3271
|
+
> AsposeResponse post_page_circle_annotations(name, page_number, annotations, opts)
|
3272
|
+
|
3273
|
+
Add document page circle annotations.
|
2594
3274
|
|
2595
3275
|
### Parameters
|
2596
3276
|
|
@@ -2598,7 +3278,7 @@ Name | Type | Description | Notes
|
|
2598
3278
|
------------- | ------------- | ------------- | -------------
|
2599
3279
|
**name** | **String**| The document name. |
|
2600
3280
|
**page_number** | **Integer**| The page number. |
|
2601
|
-
**
|
3281
|
+
**annotations** | [**Array<CircleAnnotation>**](CircleAnnotation.md)| The array of annotation. |
|
2602
3282
|
**storage** | **String**| The document storage. | [optional]
|
2603
3283
|
**folder** | **String**| The document folder. | [optional]
|
2604
3284
|
|
@@ -2613,17 +3293,18 @@ Name | Type | Description | Notes
|
|
2613
3293
|
|
2614
3294
|
|
2615
3295
|
|
2616
|
-
# **
|
2617
|
-
> AsposeResponse
|
3296
|
+
# **post_page_free_text_annotations**
|
3297
|
+
> AsposeResponse post_page_free_text_annotations(name, page_number, annotations, opts)
|
2618
3298
|
|
2619
|
-
|
3299
|
+
Add document page free text annotations.
|
2620
3300
|
|
2621
3301
|
### Parameters
|
2622
3302
|
|
2623
3303
|
Name | Type | Description | Notes
|
2624
3304
|
------------- | ------------- | ------------- | -------------
|
2625
3305
|
**name** | **String**| The document name. |
|
2626
|
-
**
|
3306
|
+
**page_number** | **Integer**| The page number. |
|
3307
|
+
**annotations** | [**Array<FreeTextAnnotation>**](FreeTextAnnotation.md)| The array of annotation. |
|
2627
3308
|
**storage** | **String**| The document storage. | [optional]
|
2628
3309
|
**folder** | **String**| The document folder. | [optional]
|
2629
3310
|
|
@@ -2638,10 +3319,10 @@ Name | Type | Description | Notes
|
|
2638
3319
|
|
2639
3320
|
|
2640
3321
|
|
2641
|
-
# **
|
2642
|
-
> AsposeResponse
|
3322
|
+
# **post_page_highlight_annotations**
|
3323
|
+
> AsposeResponse post_page_highlight_annotations(name, page_number, annotations, opts)
|
2643
3324
|
|
2644
|
-
Add document page
|
3325
|
+
Add document page highlight annotations.
|
2645
3326
|
|
2646
3327
|
### Parameters
|
2647
3328
|
|
@@ -2649,7 +3330,7 @@ Name | Type | Description | Notes
|
|
2649
3330
|
------------- | ------------- | ------------- | -------------
|
2650
3331
|
**name** | **String**| The document name. |
|
2651
3332
|
**page_number** | **Integer**| The page number. |
|
2652
|
-
**annotations** | [**Array<
|
3333
|
+
**annotations** | [**Array<HighlightAnnotation>**](HighlightAnnotation.md)| The array of annotation. |
|
2653
3334
|
**storage** | **String**| The document storage. | [optional]
|
2654
3335
|
**folder** | **String**| The document folder. | [optional]
|
2655
3336
|
|
@@ -2664,10 +3345,10 @@ Name | Type | Description | Notes
|
|
2664
3345
|
|
2665
3346
|
|
2666
3347
|
|
2667
|
-
# **
|
2668
|
-
> AsposeResponse
|
3348
|
+
# **post_page_ink_annotations**
|
3349
|
+
> AsposeResponse post_page_ink_annotations(name, page_number, annotations, opts)
|
2669
3350
|
|
2670
|
-
Add document page
|
3351
|
+
Add document page ink annotations.
|
2671
3352
|
|
2672
3353
|
### Parameters
|
2673
3354
|
|
@@ -2675,7 +3356,7 @@ Name | Type | Description | Notes
|
|
2675
3356
|
------------- | ------------- | ------------- | -------------
|
2676
3357
|
**name** | **String**| The document name. |
|
2677
3358
|
**page_number** | **Integer**| The page number. |
|
2678
|
-
**annotations** | [**Array<
|
3359
|
+
**annotations** | [**Array<InkAnnotation>**](InkAnnotation.md)| The array of annotation. |
|
2679
3360
|
**storage** | **String**| The document storage. | [optional]
|
2680
3361
|
**folder** | **String**| The document folder. | [optional]
|
2681
3362
|
|
@@ -2820,6 +3501,58 @@ Name | Type | Description | Notes
|
|
2820
3501
|
|
2821
3502
|
|
2822
3503
|
|
3504
|
+
# **post_page_squiggly_annotations**
|
3505
|
+
> AsposeResponse post_page_squiggly_annotations(name, page_number, annotations, opts)
|
3506
|
+
|
3507
|
+
Add document page squiggly annotations.
|
3508
|
+
|
3509
|
+
### Parameters
|
3510
|
+
|
3511
|
+
Name | Type | Description | Notes
|
3512
|
+
------------- | ------------- | ------------- | -------------
|
3513
|
+
**name** | **String**| The document name. |
|
3514
|
+
**page_number** | **Integer**| The page number. |
|
3515
|
+
**annotations** | [**Array<SquigglyAnnotation>**](SquigglyAnnotation.md)| The array of annotation. |
|
3516
|
+
**storage** | **String**| The document storage. | [optional]
|
3517
|
+
**folder** | **String**| The document folder. | [optional]
|
3518
|
+
|
3519
|
+
### Return type
|
3520
|
+
|
3521
|
+
[**AsposeResponse**](AsposeResponse.md)
|
3522
|
+
|
3523
|
+
### HTTP request headers
|
3524
|
+
|
3525
|
+
- **Content-Type**: application/json
|
3526
|
+
- **Accept**: application/json
|
3527
|
+
|
3528
|
+
|
3529
|
+
|
3530
|
+
# **post_page_strike_out_annotations**
|
3531
|
+
> AsposeResponse post_page_strike_out_annotations(name, page_number, annotations, opts)
|
3532
|
+
|
3533
|
+
Add document page StrikeOut annotations.
|
3534
|
+
|
3535
|
+
### Parameters
|
3536
|
+
|
3537
|
+
Name | Type | Description | Notes
|
3538
|
+
------------- | ------------- | ------------- | -------------
|
3539
|
+
**name** | **String**| The document name. |
|
3540
|
+
**page_number** | **Integer**| The page number. |
|
3541
|
+
**annotations** | [**Array<StrikeOutAnnotation>**](StrikeOutAnnotation.md)| The array of annotation. |
|
3542
|
+
**storage** | **String**| The document storage. | [optional]
|
3543
|
+
**folder** | **String**| The document folder. | [optional]
|
3544
|
+
|
3545
|
+
### Return type
|
3546
|
+
|
3547
|
+
[**AsposeResponse**](AsposeResponse.md)
|
3548
|
+
|
3549
|
+
### HTTP request headers
|
3550
|
+
|
3551
|
+
- **Content-Type**: application/json
|
3552
|
+
- **Accept**: application/json
|
3553
|
+
|
3554
|
+
|
3555
|
+
|
2823
3556
|
# **post_page_text_annotations**
|
2824
3557
|
> AsposeResponse post_page_text_annotations(name, page_number, annotations, opts)
|
2825
3558
|
|
@@ -2872,6 +3605,58 @@ Name | Type | Description | Notes
|
|
2872
3605
|
|
2873
3606
|
|
2874
3607
|
|
3608
|
+
# **post_page_underline_annotations**
|
3609
|
+
> AsposeResponse post_page_underline_annotations(name, page_number, annotations, opts)
|
3610
|
+
|
3611
|
+
Add document page underline annotations.
|
3612
|
+
|
3613
|
+
### Parameters
|
3614
|
+
|
3615
|
+
Name | Type | Description | Notes
|
3616
|
+
------------- | ------------- | ------------- | -------------
|
3617
|
+
**name** | **String**| The document name. |
|
3618
|
+
**page_number** | **Integer**| The page number. |
|
3619
|
+
**annotations** | [**Array<UnderlineAnnotation>**](UnderlineAnnotation.md)| The array of annotation. |
|
3620
|
+
**storage** | **String**| The document storage. | [optional]
|
3621
|
+
**folder** | **String**| The document folder. | [optional]
|
3622
|
+
|
3623
|
+
### Return type
|
3624
|
+
|
3625
|
+
[**AsposeResponse**](AsposeResponse.md)
|
3626
|
+
|
3627
|
+
### HTTP request headers
|
3628
|
+
|
3629
|
+
- **Content-Type**: application/json
|
3630
|
+
- **Accept**: application/json
|
3631
|
+
|
3632
|
+
|
3633
|
+
|
3634
|
+
# **post_popup_annotation**
|
3635
|
+
> AsposeResponse post_popup_annotation(name, annotation_id, annotation, opts)
|
3636
|
+
|
3637
|
+
Add document popup annotations.
|
3638
|
+
|
3639
|
+
### Parameters
|
3640
|
+
|
3641
|
+
Name | Type | Description | Notes
|
3642
|
+
------------- | ------------- | ------------- | -------------
|
3643
|
+
**name** | **String**| The document name. |
|
3644
|
+
**annotation_id** | **String**| The parent annotation ID. |
|
3645
|
+
**annotation** | [**PopupAnnotation**](PopupAnnotation.md)| The annotation. |
|
3646
|
+
**storage** | **String**| The document storage. | [optional]
|
3647
|
+
**folder** | **String**| The document folder. | [optional]
|
3648
|
+
|
3649
|
+
### Return type
|
3650
|
+
|
3651
|
+
[**AsposeResponse**](AsposeResponse.md)
|
3652
|
+
|
3653
|
+
### HTTP request headers
|
3654
|
+
|
3655
|
+
- **Content-Type**: application/json
|
3656
|
+
- **Accept**: application/json
|
3657
|
+
|
3658
|
+
|
3659
|
+
|
2875
3660
|
# **post_sign_document**
|
2876
3661
|
> AsposeResponse post_sign_document(name, opts)
|
2877
3662
|
|
@@ -3000,6 +3785,32 @@ Name | Type | Description | Notes
|
|
3000
3785
|
|
3001
3786
|
|
3002
3787
|
|
3788
|
+
# **put_caret_annotation**
|
3789
|
+
> CaretAnnotationResponse put_caret_annotation(name, annotation_id, annotation, opts)
|
3790
|
+
|
3791
|
+
Replace document caret annotation
|
3792
|
+
|
3793
|
+
### Parameters
|
3794
|
+
|
3795
|
+
Name | Type | Description | Notes
|
3796
|
+
------------- | ------------- | ------------- | -------------
|
3797
|
+
**name** | **String**| The document name. |
|
3798
|
+
**annotation_id** | **String**| The annotation ID. |
|
3799
|
+
**annotation** | [**CaretAnnotation**](CaretAnnotation.md)| Annotation. |
|
3800
|
+
**storage** | **String**| The document storage. | [optional]
|
3801
|
+
**folder** | **String**| The document folder. | [optional]
|
3802
|
+
|
3803
|
+
### Return type
|
3804
|
+
|
3805
|
+
[**CaretAnnotationResponse**](CaretAnnotationResponse.md)
|
3806
|
+
|
3807
|
+
### HTTP request headers
|
3808
|
+
|
3809
|
+
- **Content-Type**: application/json
|
3810
|
+
- **Accept**: application/json
|
3811
|
+
|
3812
|
+
|
3813
|
+
|
3003
3814
|
# **put_circle_annotation**
|
3004
3815
|
> CircleAnnotationResponse put_circle_annotation(name, annotation_id, annotation, opts)
|
3005
3816
|
|
@@ -3150,8 +3961,34 @@ Name | Type | Description | Notes
|
|
3150
3961
|
|
3151
3962
|
|
3152
3963
|
|
3964
|
+
# **put_highlight_annotation**
|
3965
|
+
> HighlightAnnotationResponse put_highlight_annotation(name, annotation_id, annotation, opts)
|
3966
|
+
|
3967
|
+
Replace document highlight annotation
|
3968
|
+
|
3969
|
+
### Parameters
|
3970
|
+
|
3971
|
+
Name | Type | Description | Notes
|
3972
|
+
------------- | ------------- | ------------- | -------------
|
3973
|
+
**name** | **String**| The document name. |
|
3974
|
+
**annotation_id** | **String**| The annotation ID. |
|
3975
|
+
**annotation** | [**HighlightAnnotation**](HighlightAnnotation.md)| Annotation. |
|
3976
|
+
**storage** | **String**| The document storage. | [optional]
|
3977
|
+
**folder** | **String**| The document folder. | [optional]
|
3978
|
+
|
3979
|
+
### Return type
|
3980
|
+
|
3981
|
+
[**HighlightAnnotationResponse**](HighlightAnnotationResponse.md)
|
3982
|
+
|
3983
|
+
### HTTP request headers
|
3984
|
+
|
3985
|
+
- **Content-Type**: application/json
|
3986
|
+
- **Accept**: application/json
|
3987
|
+
|
3988
|
+
|
3989
|
+
|
3153
3990
|
# **put_html_in_storage_to_pdf**
|
3154
|
-
> AsposeResponse put_html_in_storage_to_pdf(name, src_path,
|
3991
|
+
> AsposeResponse put_html_in_storage_to_pdf(name, src_path, opts)
|
3155
3992
|
|
3156
3993
|
Convert HTML file (located on storage) to PDF format and upload resulting file to storage.
|
3157
3994
|
|
@@ -3161,7 +3998,7 @@ Name | Type | Description | Notes
|
|
3161
3998
|
------------- | ------------- | ------------- | -------------
|
3162
3999
|
**name** | **String**| The document name. |
|
3163
4000
|
**src_path** | **String**| Full source filename (ex. /folder1/folder2/template.zip) |
|
3164
|
-
**html_file_name** | **String**| Name of HTML file in ZIP. |
|
4001
|
+
**html_file_name** | **String**| Name of HTML file in ZIP. | [optional]
|
3165
4002
|
**height** | **Float**| Page height | [optional]
|
3166
4003
|
**width** | **Float**| Page width | [optional]
|
3167
4004
|
**is_landscape** | **BOOLEAN**| Is page landscaped | [optional]
|
@@ -3432,6 +4269,32 @@ Name | Type | Description | Notes
|
|
3432
4269
|
|
3433
4270
|
|
3434
4271
|
|
4272
|
+
# **put_ink_annotation**
|
4273
|
+
> InkAnnotationResponse put_ink_annotation(name, annotation_id, annotation, opts)
|
4274
|
+
|
4275
|
+
Replace document ink annotation
|
4276
|
+
|
4277
|
+
### Parameters
|
4278
|
+
|
4279
|
+
Name | Type | Description | Notes
|
4280
|
+
------------- | ------------- | ------------- | -------------
|
4281
|
+
**name** | **String**| The document name. |
|
4282
|
+
**annotation_id** | **String**| The annotation ID. |
|
4283
|
+
**annotation** | [**InkAnnotation**](InkAnnotation.md)| Annotation. |
|
4284
|
+
**storage** | **String**| The document storage. | [optional]
|
4285
|
+
**folder** | **String**| The document folder. | [optional]
|
4286
|
+
|
4287
|
+
### Return type
|
4288
|
+
|
4289
|
+
[**InkAnnotationResponse**](InkAnnotationResponse.md)
|
4290
|
+
|
4291
|
+
### HTTP request headers
|
4292
|
+
|
4293
|
+
- **Content-Type**: application/json
|
4294
|
+
- **Accept**: application/json
|
4295
|
+
|
4296
|
+
|
4297
|
+
|
3435
4298
|
# **put_la_te_x_in_storage_to_pdf**
|
3436
4299
|
> AsposeResponse put_la_te_x_in_storage_to_pdf(name, src_path, opts)
|
3437
4300
|
|
@@ -4538,6 +5401,32 @@ Name | Type | Description | Notes
|
|
4538
5401
|
|
4539
5402
|
|
4540
5403
|
|
5404
|
+
# **put_popup_annotation**
|
5405
|
+
> PopupAnnotationResponse put_popup_annotation(name, annotation_id, annotation, opts)
|
5406
|
+
|
5407
|
+
Replace document popup annotation
|
5408
|
+
|
5409
|
+
### Parameters
|
5410
|
+
|
5411
|
+
Name | Type | Description | Notes
|
5412
|
+
------------- | ------------- | ------------- | -------------
|
5413
|
+
**name** | **String**| The document name. |
|
5414
|
+
**annotation_id** | **String**| The annotation ID. |
|
5415
|
+
**annotation** | [**PopupAnnotation**](PopupAnnotation.md)| Annotation. |
|
5416
|
+
**storage** | **String**| The document storage. | [optional]
|
5417
|
+
**folder** | **String**| The document folder. | [optional]
|
5418
|
+
|
5419
|
+
### Return type
|
5420
|
+
|
5421
|
+
[**PopupAnnotationResponse**](PopupAnnotationResponse.md)
|
5422
|
+
|
5423
|
+
### HTTP request headers
|
5424
|
+
|
5425
|
+
- **Content-Type**: application/json
|
5426
|
+
- **Accept**: application/json
|
5427
|
+
|
5428
|
+
|
5429
|
+
|
4541
5430
|
# **put_privileges**
|
4542
5431
|
> AsposeResponse put_privileges(name, opts)
|
4543
5432
|
|
@@ -4692,6 +5581,58 @@ Name | Type | Description | Notes
|
|
4692
5581
|
|
4693
5582
|
|
4694
5583
|
|
5584
|
+
# **put_squiggly_annotation**
|
5585
|
+
> SquigglyAnnotationResponse put_squiggly_annotation(name, annotation_id, annotation, opts)
|
5586
|
+
|
5587
|
+
Replace document squiggly annotation
|
5588
|
+
|
5589
|
+
### Parameters
|
5590
|
+
|
5591
|
+
Name | Type | Description | Notes
|
5592
|
+
------------- | ------------- | ------------- | -------------
|
5593
|
+
**name** | **String**| The document name. |
|
5594
|
+
**annotation_id** | **String**| The annotation ID. |
|
5595
|
+
**annotation** | [**SquigglyAnnotation**](SquigglyAnnotation.md)| Annotation. |
|
5596
|
+
**storage** | **String**| The document storage. | [optional]
|
5597
|
+
**folder** | **String**| The document folder. | [optional]
|
5598
|
+
|
5599
|
+
### Return type
|
5600
|
+
|
5601
|
+
[**SquigglyAnnotationResponse**](SquigglyAnnotationResponse.md)
|
5602
|
+
|
5603
|
+
### HTTP request headers
|
5604
|
+
|
5605
|
+
- **Content-Type**: application/json
|
5606
|
+
- **Accept**: application/json
|
5607
|
+
|
5608
|
+
|
5609
|
+
|
5610
|
+
# **put_strike_out_annotation**
|
5611
|
+
> StrikeOutAnnotationResponse put_strike_out_annotation(name, annotation_id, annotation, opts)
|
5612
|
+
|
5613
|
+
Replace document StrikeOut annotation
|
5614
|
+
|
5615
|
+
### Parameters
|
5616
|
+
|
5617
|
+
Name | Type | Description | Notes
|
5618
|
+
------------- | ------------- | ------------- | -------------
|
5619
|
+
**name** | **String**| The document name. |
|
5620
|
+
**annotation_id** | **String**| The annotation ID. |
|
5621
|
+
**annotation** | [**StrikeOutAnnotation**](StrikeOutAnnotation.md)| Annotation. |
|
5622
|
+
**storage** | **String**| The document storage. | [optional]
|
5623
|
+
**folder** | **String**| The document folder. | [optional]
|
5624
|
+
|
5625
|
+
### Return type
|
5626
|
+
|
5627
|
+
[**StrikeOutAnnotationResponse**](StrikeOutAnnotationResponse.md)
|
5628
|
+
|
5629
|
+
### HTTP request headers
|
5630
|
+
|
5631
|
+
- **Content-Type**: application/json
|
5632
|
+
- **Accept**: application/json
|
5633
|
+
|
5634
|
+
|
5635
|
+
|
4695
5636
|
# **put_svg_in_storage_to_pdf**
|
4696
5637
|
> AsposeResponse put_svg_in_storage_to_pdf(name, src_path, opts)
|
4697
5638
|
|
@@ -4751,6 +5692,32 @@ Name | Type | Description | Notes
|
|
4751
5692
|
|
4752
5693
|
|
4753
5694
|
|
5695
|
+
# **put_underline_annotation**
|
5696
|
+
> UnderlineAnnotationResponse put_underline_annotation(name, annotation_id, annotation, opts)
|
5697
|
+
|
5698
|
+
Replace document underline annotation
|
5699
|
+
|
5700
|
+
### Parameters
|
5701
|
+
|
5702
|
+
Name | Type | Description | Notes
|
5703
|
+
------------- | ------------- | ------------- | -------------
|
5704
|
+
**name** | **String**| The document name. |
|
5705
|
+
**annotation_id** | **String**| The annotation ID. |
|
5706
|
+
**annotation** | [**UnderlineAnnotation**](UnderlineAnnotation.md)| Annotation. |
|
5707
|
+
**storage** | **String**| The document storage. | [optional]
|
5708
|
+
**folder** | **String**| The document folder. | [optional]
|
5709
|
+
|
5710
|
+
### Return type
|
5711
|
+
|
5712
|
+
[**UnderlineAnnotationResponse**](UnderlineAnnotationResponse.md)
|
5713
|
+
|
5714
|
+
### HTTP request headers
|
5715
|
+
|
5716
|
+
- **Content-Type**: application/json
|
5717
|
+
- **Accept**: application/json
|
5718
|
+
|
5719
|
+
|
5720
|
+
|
4754
5721
|
# **put_update_field**
|
4755
5722
|
> FieldResponse put_update_field(name, field_name, opts)
|
4756
5723
|
|