aspose_pdf_cloud 19.1.0 → 19.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +26 -4
- data/docs/PdfApi.md +361 -18
- data/docs/RedactionAnnotationsResponse.md +1 -1
- data/docs/ScreenAnnotation.md +22 -0
- data/docs/ScreenAnnotationResponse.md +11 -0
- data/docs/ScreenAnnotations.md +10 -0
- data/docs/ScreenAnnotationsResponse.md +11 -0
- data/docs/StampAnnotation.md +27 -0
- data/docs/StampAnnotationResponse.md +11 -0
- data/docs/StampAnnotations.md +10 -0
- data/docs/StampAnnotationsResponse.md +11 -0
- data/docs/StampIcon.md +23 -0
- data/lib/aspose_pdf_cloud.rb +9 -0
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +1116 -84
- data/lib/aspose_pdf_cloud/models/redaction_annotations_response.rb +1 -1
- data/lib/aspose_pdf_cloud/models/screen_annotation.rb +335 -0
- data/lib/aspose_pdf_cloud/models/screen_annotation_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/screen_annotations.rb +215 -0
- data/lib/aspose_pdf_cloud/models/screen_annotations_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/stamp_annotation.rb +385 -0
- data/lib/aspose_pdf_cloud/models/stamp_annotation_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/stamp_annotations.rb +215 -0
- data/lib/aspose_pdf_cloud/models/stamp_annotations_response.rb +226 -0
- data/lib/aspose_pdf_cloud/models/stamp_icon.rb +56 -0
- data/lib/aspose_pdf_cloud/version.rb +1 -1
- data/test/pdf_tests.rb +287 -0
- data/test_data/PdfWithScreenAnnotations.pdf +0 -0
- data/test_data/ScreenMovie.swf +0 -0
- metadata +22 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 412ff06d379f1d2072d545c064c6aeb863248b36c9f7aefd5ae7361d1f9f00a0
|
4
|
+
data.tar.gz: 95b147350af5e71ada61070ebdadc13c118aed6dc70e6ae0dec810ad70823f59
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c010260b42c72874691a222bbeac898342d2a1085e72e674ecdd59342f875a21faa64e9ec44b9396afc91a7c5e2c28b260a5c5f21d3bac9fd464d6742e24bbc2
|
7
|
+
data.tar.gz: 83263f1d7ba2930bb9502914c3de10ad6362020f6b79fc3fa5fab72cc64317c4958be9d457ed47e13754ffdc1c0d29d6db2fe3c68775bae53c0de22223cfae7d
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# Aspose.PDF Cloud
|
2
2
|
|
3
3
|
- API version: 2.0
|
4
|
-
- Package version: 19.
|
4
|
+
- Package version: 19.2.0
|
5
5
|
|
6
6
|
[Aspose.PDF Cloud](https://products.aspose.cloud/pdf) is a true REST API that enables you to perform a wide range of document processing operations including creation, manipulation, conversion and rendering of Pdf documents in the cloud.
|
7
7
|
|
@@ -22,15 +22,15 @@ gem build aspose_pdf_cloud.gemspec
|
|
22
22
|
Then either install the gem locally:
|
23
23
|
|
24
24
|
```shell
|
25
|
-
gem install ./aspose_pdf_cloud-19.
|
25
|
+
gem install ./aspose_pdf_cloud-19.2.0.gem
|
26
26
|
```
|
27
|
-
(for development, run `gem install --dev ./aspose_pdf_cloud-19.
|
27
|
+
(for development, run `gem install --dev ./aspose_pdf_cloud-19.2.0.gem` to install the development dependencies)
|
28
28
|
|
29
29
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
30
30
|
|
31
31
|
Finally add this to the Gemfile:
|
32
32
|
|
33
|
-
gem 'aspose_pdf_cloud', '~> 19.
|
33
|
+
gem 'aspose_pdf_cloud', '~> 19.2.0'
|
34
34
|
|
35
35
|
### Install from Git
|
36
36
|
|
@@ -125,9 +125,11 @@ Class | Method | HTTP request | Description
|
|
125
125
|
*AsposePdfCloud::PdfApi* | [**get_document_properties**](docs/PdfApi.md#get_document_properties) | **GET** /pdf/\{name}/documentproperties | Read document properties.
|
126
126
|
*AsposePdfCloud::PdfApi* | [**get_document_property**](docs/PdfApi.md#get_document_property) | **GET** /pdf/\{name}/documentproperties/\{propertyName} | Read document property by name.
|
127
127
|
*AsposePdfCloud::PdfApi* | [**get_document_redaction_annotations**](docs/PdfApi.md#get_document_redaction_annotations) | **GET** /pdf/\{name}/annotations/redaction | Read document redaction annotations.
|
128
|
+
*AsposePdfCloud::PdfApi* | [**get_document_screen_annotations**](docs/PdfApi.md#get_document_screen_annotations) | **GET** /pdf/\{name}/annotations/screen | Read document screen annotations.
|
128
129
|
*AsposePdfCloud::PdfApi* | [**get_document_sound_annotations**](docs/PdfApi.md#get_document_sound_annotations) | **GET** /pdf/\{name}/annotations/sound | Read document sound annotations.
|
129
130
|
*AsposePdfCloud::PdfApi* | [**get_document_square_annotations**](docs/PdfApi.md#get_document_square_annotations) | **GET** /pdf/\{name}/annotations/square | Read document square annotations.
|
130
131
|
*AsposePdfCloud::PdfApi* | [**get_document_squiggly_annotations**](docs/PdfApi.md#get_document_squiggly_annotations) | **GET** /pdf/\{name}/annotations/squiggly | Read document squiggly annotations.
|
132
|
+
*AsposePdfCloud::PdfApi* | [**get_document_stamp_annotations**](docs/PdfApi.md#get_document_stamp_annotations) | **GET** /pdf/\{name}/annotations/stamp | Read document stamp annotations.
|
131
133
|
*AsposePdfCloud::PdfApi* | [**get_document_strike_out_annotations**](docs/PdfApi.md#get_document_strike_out_annotations) | **GET** /pdf/\{name}/annotations/strikeout | Read document StrikeOut annotations.
|
132
134
|
*AsposePdfCloud::PdfApi* | [**get_document_text_annotations**](docs/PdfApi.md#get_document_text_annotations) | **GET** /pdf/\{name}/annotations/text | Read document text annotations.
|
133
135
|
*AsposePdfCloud::PdfApi* | [**get_document_underline_annotations**](docs/PdfApi.md#get_document_underline_annotations) | **GET** /pdf/\{name}/annotations/underline | Read document underline annotations.
|
@@ -179,9 +181,11 @@ Class | Method | HTTP request | Description
|
|
179
181
|
*AsposePdfCloud::PdfApi* | [**get_page_polygon_annotations**](docs/PdfApi.md#get_page_polygon_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Read document page polygon annotations.
|
180
182
|
*AsposePdfCloud::PdfApi* | [**get_page_popup_annotations**](docs/PdfApi.md#get_page_popup_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/popup | Read document page popup annotations.
|
181
183
|
*AsposePdfCloud::PdfApi* | [**get_page_redaction_annotations**](docs/PdfApi.md#get_page_redaction_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/redaction | Read document page redaction annotations.
|
184
|
+
*AsposePdfCloud::PdfApi* | [**get_page_screen_annotations**](docs/PdfApi.md#get_page_screen_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/screen | Read document page screen annotations.
|
182
185
|
*AsposePdfCloud::PdfApi* | [**get_page_sound_annotations**](docs/PdfApi.md#get_page_sound_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/sound | Read document page sound annotations.
|
183
186
|
*AsposePdfCloud::PdfApi* | [**get_page_square_annotations**](docs/PdfApi.md#get_page_square_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Read document page square annotations.
|
184
187
|
*AsposePdfCloud::PdfApi* | [**get_page_squiggly_annotations**](docs/PdfApi.md#get_page_squiggly_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Read document page squiggly annotations.
|
188
|
+
*AsposePdfCloud::PdfApi* | [**get_page_stamp_annotations**](docs/PdfApi.md#get_page_stamp_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/stamp | Read document page stamp annotations.
|
185
189
|
*AsposePdfCloud::PdfApi* | [**get_page_strike_out_annotations**](docs/PdfApi.md#get_page_strike_out_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/strikeout | Read document page StrikeOut annotations.
|
186
190
|
*AsposePdfCloud::PdfApi* | [**get_page_text**](docs/PdfApi.md#get_page_text) | **GET** /pdf/\{name}/pages/\{pageNumber}/text | Read page text items.
|
187
191
|
*AsposePdfCloud::PdfApi* | [**get_page_text_annotations**](docs/PdfApi.md#get_page_text_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/text | Read document page text annotations.
|
@@ -205,10 +209,13 @@ Class | Method | HTTP request | Description
|
|
205
209
|
*AsposePdfCloud::PdfApi* | [**get_popup_annotation**](docs/PdfApi.md#get_popup_annotation) | **GET** /pdf/\{name}/annotations/popup/\{annotationId} | Read document page popup annotation by ID.
|
206
210
|
*AsposePdfCloud::PdfApi* | [**get_ps_in_storage_to_pdf**](docs/PdfApi.md#get_ps_in_storage_to_pdf) | **GET** /pdf/create/ps | Convert PS file (located on storage) to PDF format and return resulting file in response.
|
207
211
|
*AsposePdfCloud::PdfApi* | [**get_redaction_annotation**](docs/PdfApi.md#get_redaction_annotation) | **GET** /pdf/\{name}/annotations/redaction/\{annotationId} | Read document page redaction annotation by ID.
|
212
|
+
*AsposePdfCloud::PdfApi* | [**get_screen_annotation**](docs/PdfApi.md#get_screen_annotation) | **GET** /pdf/\{name}/annotations/screen/\{annotationId} | Read document page screen annotation by ID.
|
208
213
|
*AsposePdfCloud::PdfApi* | [**get_sound_annotation**](docs/PdfApi.md#get_sound_annotation) | **GET** /pdf/\{name}/annotations/sound/\{annotationId} | Read document page sound annotation by ID.
|
209
214
|
*AsposePdfCloud::PdfApi* | [**get_sound_annotation_data**](docs/PdfApi.md#get_sound_annotation_data) | **GET** /pdf/\{name}/annotations/sound/\{annotationId}/data | Read document page sound annotation by ID.
|
210
215
|
*AsposePdfCloud::PdfApi* | [**get_square_annotation**](docs/PdfApi.md#get_square_annotation) | **GET** /pdf/\{name}/annotations/square/\{annotationId} | Read document page square annotation by ID.
|
211
216
|
*AsposePdfCloud::PdfApi* | [**get_squiggly_annotation**](docs/PdfApi.md#get_squiggly_annotation) | **GET** /pdf/\{name}/annotations/squiggly/\{annotationId} | Read document page squiggly annotation by ID.
|
217
|
+
*AsposePdfCloud::PdfApi* | [**get_stamp_annotation**](docs/PdfApi.md#get_stamp_annotation) | **GET** /pdf/\{name}/annotations/stamp/\{annotationId} | Read document page stamp annotation by ID.
|
218
|
+
*AsposePdfCloud::PdfApi* | [**get_stamp_annotation_data**](docs/PdfApi.md#get_stamp_annotation_data) | **GET** /pdf/\{name}/annotations/stamp/\{annotationId}/data | Read document page stamp annotation by ID.
|
212
219
|
*AsposePdfCloud::PdfApi* | [**get_strike_out_annotation**](docs/PdfApi.md#get_strike_out_annotation) | **GET** /pdf/\{name}/annotations/strikeout/\{annotationId} | Read document page StrikeOut annotation by ID.
|
213
220
|
*AsposePdfCloud::PdfApi* | [**get_svg_in_storage_to_pdf**](docs/PdfApi.md#get_svg_in_storage_to_pdf) | **GET** /pdf/create/svg | Convert SVG file (located on storage) to PDF format and return resulting file in response.
|
214
221
|
*AsposePdfCloud::PdfApi* | [**get_text**](docs/PdfApi.md#get_text) | **GET** /pdf/\{name}/text | Read document text.
|
@@ -242,9 +249,11 @@ Class | Method | HTTP request | Description
|
|
242
249
|
*AsposePdfCloud::PdfApi* | [**post_page_poly_line_annotations**](docs/PdfApi.md#post_page_poly_line_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Add document page polyline annotations.
|
243
250
|
*AsposePdfCloud::PdfApi* | [**post_page_polygon_annotations**](docs/PdfApi.md#post_page_polygon_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Add document page polygon annotations.
|
244
251
|
*AsposePdfCloud::PdfApi* | [**post_page_redaction_annotations**](docs/PdfApi.md#post_page_redaction_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/redaction | Add document page redaction annotations.
|
252
|
+
*AsposePdfCloud::PdfApi* | [**post_page_screen_annotations**](docs/PdfApi.md#post_page_screen_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/screen | Add document page screen annotations.
|
245
253
|
*AsposePdfCloud::PdfApi* | [**post_page_sound_annotations**](docs/PdfApi.md#post_page_sound_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/sound | Add document page sound annotations.
|
246
254
|
*AsposePdfCloud::PdfApi* | [**post_page_square_annotations**](docs/PdfApi.md#post_page_square_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Add document page square annotations.
|
247
255
|
*AsposePdfCloud::PdfApi* | [**post_page_squiggly_annotations**](docs/PdfApi.md#post_page_squiggly_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Add document page squiggly annotations.
|
256
|
+
*AsposePdfCloud::PdfApi* | [**post_page_stamp_annotations**](docs/PdfApi.md#post_page_stamp_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/stamp | Add document page stamp annotations.
|
248
257
|
*AsposePdfCloud::PdfApi* | [**post_page_strike_out_annotations**](docs/PdfApi.md#post_page_strike_out_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/strikeout | Add document page StrikeOut annotations.
|
249
258
|
*AsposePdfCloud::PdfApi* | [**post_page_text_annotations**](docs/PdfApi.md#post_page_text_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/text | Add document page text annotations.
|
250
259
|
*AsposePdfCloud::PdfApi* | [**post_page_text_replace**](docs/PdfApi.md#post_page_text_replace) | **POST** /pdf/\{name}/pages/\{pageNumber}/text/replace | Page's replace text method.
|
@@ -255,6 +264,7 @@ Class | Method | HTTP request | Description
|
|
255
264
|
*AsposePdfCloud::PdfApi* | [**post_split_document**](docs/PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts.
|
256
265
|
*AsposePdfCloud::PdfApi* | [**put_add_new_page**](docs/PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
|
257
266
|
*AsposePdfCloud::PdfApi* | [**put_add_text**](docs/PdfApi.md#put_add_text) | **PUT** /pdf/\{name}/pages/\{pageNumber}/text | Add text to PDF document page.
|
267
|
+
*AsposePdfCloud::PdfApi* | [**put_annotations_flatten**](docs/PdfApi.md#put_annotations_flatten) | **PUT** /pdf/\{name}/annotations/flatten | Flattens the annotations of the specified types
|
258
268
|
*AsposePdfCloud::PdfApi* | [**put_caret_annotation**](docs/PdfApi.md#put_caret_annotation) | **PUT** /pdf/\{name}/annotations/caret/\{annotationId} | Replace document caret annotation
|
259
269
|
*AsposePdfCloud::PdfApi* | [**put_circle_annotation**](docs/PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation
|
260
270
|
*AsposePdfCloud::PdfApi* | [**put_create**](docs/PdfApi.md#put_create) | **PUT** /storage/file | Upload a specific file
|
@@ -322,12 +332,15 @@ Class | Method | HTTP request | Description
|
|
322
332
|
*AsposePdfCloud::PdfApi* | [**put_ps_in_storage_to_pdf**](docs/PdfApi.md#put_ps_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/ps | Convert PS file (located on storage) to PDF format and upload resulting file to storage.
|
323
333
|
*AsposePdfCloud::PdfApi* | [**put_redaction_annotation**](docs/PdfApi.md#put_redaction_annotation) | **PUT** /pdf/\{name}/annotations/redaction/\{annotationId} | Replace document redaction annotation
|
324
334
|
*AsposePdfCloud::PdfApi* | [**put_replace_image**](docs/PdfApi.md#put_replace_image) | **PUT** /pdf/\{name}/images/\{imageId} | Replace document image.
|
335
|
+
*AsposePdfCloud::PdfApi* | [**put_screen_annotation**](docs/PdfApi.md#put_screen_annotation) | **PUT** /pdf/\{name}/annotations/screen/\{annotationId} | Replace document screen annotation
|
325
336
|
*AsposePdfCloud::PdfApi* | [**put_searchable_document**](docs/PdfApi.md#put_searchable_document) | **PUT** /pdf/\{name}/ocr | Create searchable PDF document. Generate OCR layer for images in input PDF document.
|
326
337
|
*AsposePdfCloud::PdfApi* | [**put_set_property**](docs/PdfApi.md#put_set_property) | **PUT** /pdf/\{name}/documentproperties/\{propertyName} | Add/update document property.
|
327
338
|
*AsposePdfCloud::PdfApi* | [**put_sound_annotation**](docs/PdfApi.md#put_sound_annotation) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId} | Replace document sound annotation
|
328
339
|
*AsposePdfCloud::PdfApi* | [**put_sound_annotation_data_extract**](docs/PdfApi.md#put_sound_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId}/data/extract | Extract document sound annotation content to storage
|
329
340
|
*AsposePdfCloud::PdfApi* | [**put_square_annotation**](docs/PdfApi.md#put_square_annotation) | **PUT** /pdf/\{name}/annotations/square/\{annotationId} | Replace document square annotation
|
330
341
|
*AsposePdfCloud::PdfApi* | [**put_squiggly_annotation**](docs/PdfApi.md#put_squiggly_annotation) | **PUT** /pdf/\{name}/annotations/squiggly/\{annotationId} | Replace document squiggly annotation
|
342
|
+
*AsposePdfCloud::PdfApi* | [**put_stamp_annotation**](docs/PdfApi.md#put_stamp_annotation) | **PUT** /pdf/\{name}/annotations/stamp/\{annotationId} | Replace document stamp annotation
|
343
|
+
*AsposePdfCloud::PdfApi* | [**put_stamp_annotation_data_extract**](docs/PdfApi.md#put_stamp_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/stamp/\{annotationId}/data/extract | Extract document stamp annotation content to storage
|
331
344
|
*AsposePdfCloud::PdfApi* | [**put_strike_out_annotation**](docs/PdfApi.md#put_strike_out_annotation) | **PUT** /pdf/\{name}/annotations/strikeout/\{annotationId} | Replace document StrikeOut annotation
|
332
345
|
*AsposePdfCloud::PdfApi* | [**put_svg_in_storage_to_pdf**](docs/PdfApi.md#put_svg_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/svg | Convert SVG file (located on storage) to PDF format and upload resulting file to storage.
|
333
346
|
*AsposePdfCloud::PdfApi* | [**put_text_annotation**](docs/PdfApi.md#put_text_annotation) | **PUT** /pdf/\{name}/annotations/text/\{annotationId} | Replace document text annotation
|
@@ -404,6 +417,7 @@ Class | Method | HTTP request | Description
|
|
404
417
|
- [AsposePdfCloud::SoundIcon](docs/SoundIcon.md)
|
405
418
|
- [AsposePdfCloud::SplitResult](docs/SplitResult.md)
|
406
419
|
- [AsposePdfCloud::Stamp](docs/Stamp.md)
|
420
|
+
- [AsposePdfCloud::StampIcon](docs/StampIcon.md)
|
407
421
|
- [AsposePdfCloud::StampType](docs/StampType.md)
|
408
422
|
- [AsposePdfCloud::TextHorizontalAlignment](docs/TextHorizontalAlignment.md)
|
409
423
|
- [AsposePdfCloud::TextIcon](docs/TextIcon.md)
|
@@ -487,6 +501,9 @@ Class | Method | HTTP request | Description
|
|
487
501
|
- [AsposePdfCloud::RedactionAnnotationResponse](docs/RedactionAnnotationResponse.md)
|
488
502
|
- [AsposePdfCloud::RedactionAnnotations](docs/RedactionAnnotations.md)
|
489
503
|
- [AsposePdfCloud::RedactionAnnotationsResponse](docs/RedactionAnnotationsResponse.md)
|
504
|
+
- [AsposePdfCloud::ScreenAnnotationResponse](docs/ScreenAnnotationResponse.md)
|
505
|
+
- [AsposePdfCloud::ScreenAnnotations](docs/ScreenAnnotations.md)
|
506
|
+
- [AsposePdfCloud::ScreenAnnotationsResponse](docs/ScreenAnnotationsResponse.md)
|
490
507
|
- [AsposePdfCloud::SignatureVerifyResponse](docs/SignatureVerifyResponse.md)
|
491
508
|
- [AsposePdfCloud::SoundAnnotationResponse](docs/SoundAnnotationResponse.md)
|
492
509
|
- [AsposePdfCloud::SoundAnnotations](docs/SoundAnnotations.md)
|
@@ -499,6 +516,9 @@ Class | Method | HTTP request | Description
|
|
499
516
|
- [AsposePdfCloud::SquigglyAnnotationResponse](docs/SquigglyAnnotationResponse.md)
|
500
517
|
- [AsposePdfCloud::SquigglyAnnotations](docs/SquigglyAnnotations.md)
|
501
518
|
- [AsposePdfCloud::SquigglyAnnotationsResponse](docs/SquigglyAnnotationsResponse.md)
|
519
|
+
- [AsposePdfCloud::StampAnnotationResponse](docs/StampAnnotationResponse.md)
|
520
|
+
- [AsposePdfCloud::StampAnnotations](docs/StampAnnotations.md)
|
521
|
+
- [AsposePdfCloud::StampAnnotationsResponse](docs/StampAnnotationsResponse.md)
|
502
522
|
- [AsposePdfCloud::StorageExistResponse](docs/StorageExistResponse.md)
|
503
523
|
- [AsposePdfCloud::StrikeOutAnnotationResponse](docs/StrikeOutAnnotationResponse.md)
|
504
524
|
- [AsposePdfCloud::StrikeOutAnnotations](docs/StrikeOutAnnotations.md)
|
@@ -517,6 +537,7 @@ Class | Method | HTTP request | Description
|
|
517
537
|
- [AsposePdfCloud::MovieAnnotation](docs/MovieAnnotation.md)
|
518
538
|
- [AsposePdfCloud::PopupAnnotation](docs/PopupAnnotation.md)
|
519
539
|
- [AsposePdfCloud::RedactionAnnotation](docs/RedactionAnnotation.md)
|
540
|
+
- [AsposePdfCloud::ScreenAnnotation](docs/ScreenAnnotation.md)
|
520
541
|
- [AsposePdfCloud::CaretAnnotation](docs/CaretAnnotation.md)
|
521
542
|
- [AsposePdfCloud::CommonFigureAnnotation](docs/CommonFigureAnnotation.md)
|
522
543
|
- [AsposePdfCloud::FileAttachmentAnnotation](docs/FileAttachmentAnnotation.md)
|
@@ -528,6 +549,7 @@ Class | Method | HTTP request | Description
|
|
528
549
|
- [AsposePdfCloud::PopupAnnotationWithParent](docs/PopupAnnotationWithParent.md)
|
529
550
|
- [AsposePdfCloud::SoundAnnotation](docs/SoundAnnotation.md)
|
530
551
|
- [AsposePdfCloud::SquigglyAnnotation](docs/SquigglyAnnotation.md)
|
552
|
+
- [AsposePdfCloud::StampAnnotation](docs/StampAnnotation.md)
|
531
553
|
- [AsposePdfCloud::StrikeOutAnnotation](docs/StrikeOutAnnotation.md)
|
532
554
|
- [AsposePdfCloud::TextAnnotation](docs/TextAnnotation.md)
|
533
555
|
- [AsposePdfCloud::UnderlineAnnotation](docs/UnderlineAnnotation.md)
|
data/docs/PdfApi.md
CHANGED
@@ -40,9 +40,11 @@ Method | HTTP request | Description
|
|
40
40
|
[**get_document_properties**](PdfApi.md#get_document_properties) | **GET** /pdf/\{name}/documentproperties | Read document properties.
|
41
41
|
[**get_document_property**](PdfApi.md#get_document_property) | **GET** /pdf/\{name}/documentproperties/\{propertyName} | Read document property by name.
|
42
42
|
[**get_document_redaction_annotations**](PdfApi.md#get_document_redaction_annotations) | **GET** /pdf/\{name}/annotations/redaction | Read document redaction annotations.
|
43
|
+
[**get_document_screen_annotations**](PdfApi.md#get_document_screen_annotations) | **GET** /pdf/\{name}/annotations/screen | Read document screen annotations.
|
43
44
|
[**get_document_sound_annotations**](PdfApi.md#get_document_sound_annotations) | **GET** /pdf/\{name}/annotations/sound | Read document sound annotations.
|
44
45
|
[**get_document_square_annotations**](PdfApi.md#get_document_square_annotations) | **GET** /pdf/\{name}/annotations/square | Read document square annotations.
|
45
46
|
[**get_document_squiggly_annotations**](PdfApi.md#get_document_squiggly_annotations) | **GET** /pdf/\{name}/annotations/squiggly | Read document squiggly annotations.
|
47
|
+
[**get_document_stamp_annotations**](PdfApi.md#get_document_stamp_annotations) | **GET** /pdf/\{name}/annotations/stamp | Read document stamp annotations.
|
46
48
|
[**get_document_strike_out_annotations**](PdfApi.md#get_document_strike_out_annotations) | **GET** /pdf/\{name}/annotations/strikeout | Read document StrikeOut annotations.
|
47
49
|
[**get_document_text_annotations**](PdfApi.md#get_document_text_annotations) | **GET** /pdf/\{name}/annotations/text | Read document text annotations.
|
48
50
|
[**get_document_underline_annotations**](PdfApi.md#get_document_underline_annotations) | **GET** /pdf/\{name}/annotations/underline | Read document underline annotations.
|
@@ -94,9 +96,11 @@ Method | HTTP request | Description
|
|
94
96
|
[**get_page_polygon_annotations**](PdfApi.md#get_page_polygon_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Read document page polygon annotations.
|
95
97
|
[**get_page_popup_annotations**](PdfApi.md#get_page_popup_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/popup | Read document page popup annotations.
|
96
98
|
[**get_page_redaction_annotations**](PdfApi.md#get_page_redaction_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/redaction | Read document page redaction annotations.
|
99
|
+
[**get_page_screen_annotations**](PdfApi.md#get_page_screen_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/screen | Read document page screen annotations.
|
97
100
|
[**get_page_sound_annotations**](PdfApi.md#get_page_sound_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/sound | Read document page sound annotations.
|
98
101
|
[**get_page_square_annotations**](PdfApi.md#get_page_square_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Read document page square annotations.
|
99
102
|
[**get_page_squiggly_annotations**](PdfApi.md#get_page_squiggly_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Read document page squiggly annotations.
|
103
|
+
[**get_page_stamp_annotations**](PdfApi.md#get_page_stamp_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/stamp | Read document page stamp annotations.
|
100
104
|
[**get_page_strike_out_annotations**](PdfApi.md#get_page_strike_out_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/strikeout | Read document page StrikeOut annotations.
|
101
105
|
[**get_page_text**](PdfApi.md#get_page_text) | **GET** /pdf/\{name}/pages/\{pageNumber}/text | Read page text items.
|
102
106
|
[**get_page_text_annotations**](PdfApi.md#get_page_text_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/text | Read document page text annotations.
|
@@ -120,10 +124,13 @@ Method | HTTP request | Description
|
|
120
124
|
[**get_popup_annotation**](PdfApi.md#get_popup_annotation) | **GET** /pdf/\{name}/annotations/popup/\{annotationId} | Read document page popup annotation by ID.
|
121
125
|
[**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.
|
122
126
|
[**get_redaction_annotation**](PdfApi.md#get_redaction_annotation) | **GET** /pdf/\{name}/annotations/redaction/\{annotationId} | Read document page redaction annotation by ID.
|
127
|
+
[**get_screen_annotation**](PdfApi.md#get_screen_annotation) | **GET** /pdf/\{name}/annotations/screen/\{annotationId} | Read document page screen annotation by ID.
|
123
128
|
[**get_sound_annotation**](PdfApi.md#get_sound_annotation) | **GET** /pdf/\{name}/annotations/sound/\{annotationId} | Read document page sound annotation by ID.
|
124
129
|
[**get_sound_annotation_data**](PdfApi.md#get_sound_annotation_data) | **GET** /pdf/\{name}/annotations/sound/\{annotationId}/data | Read document page sound annotation by ID.
|
125
130
|
[**get_square_annotation**](PdfApi.md#get_square_annotation) | **GET** /pdf/\{name}/annotations/square/\{annotationId} | Read document page square annotation by ID.
|
126
131
|
[**get_squiggly_annotation**](PdfApi.md#get_squiggly_annotation) | **GET** /pdf/\{name}/annotations/squiggly/\{annotationId} | Read document page squiggly annotation by ID.
|
132
|
+
[**get_stamp_annotation**](PdfApi.md#get_stamp_annotation) | **GET** /pdf/\{name}/annotations/stamp/\{annotationId} | Read document page stamp annotation by ID.
|
133
|
+
[**get_stamp_annotation_data**](PdfApi.md#get_stamp_annotation_data) | **GET** /pdf/\{name}/annotations/stamp/\{annotationId}/data | Read document page stamp annotation by ID.
|
127
134
|
[**get_strike_out_annotation**](PdfApi.md#get_strike_out_annotation) | **GET** /pdf/\{name}/annotations/strikeout/\{annotationId} | Read document page StrikeOut annotation by ID.
|
128
135
|
[**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.
|
129
136
|
[**get_text**](PdfApi.md#get_text) | **GET** /pdf/\{name}/text | Read document text.
|
@@ -157,9 +164,11 @@ Method | HTTP request | Description
|
|
157
164
|
[**post_page_poly_line_annotations**](PdfApi.md#post_page_poly_line_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Add document page polyline annotations.
|
158
165
|
[**post_page_polygon_annotations**](PdfApi.md#post_page_polygon_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Add document page polygon annotations.
|
159
166
|
[**post_page_redaction_annotations**](PdfApi.md#post_page_redaction_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/redaction | Add document page redaction annotations.
|
167
|
+
[**post_page_screen_annotations**](PdfApi.md#post_page_screen_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/screen | Add document page screen annotations.
|
160
168
|
[**post_page_sound_annotations**](PdfApi.md#post_page_sound_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/sound | Add document page sound annotations.
|
161
169
|
[**post_page_square_annotations**](PdfApi.md#post_page_square_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Add document page square annotations.
|
162
170
|
[**post_page_squiggly_annotations**](PdfApi.md#post_page_squiggly_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Add document page squiggly annotations.
|
171
|
+
[**post_page_stamp_annotations**](PdfApi.md#post_page_stamp_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/stamp | Add document page stamp annotations.
|
163
172
|
[**post_page_strike_out_annotations**](PdfApi.md#post_page_strike_out_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/strikeout | Add document page StrikeOut annotations.
|
164
173
|
[**post_page_text_annotations**](PdfApi.md#post_page_text_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/text | Add document page text annotations.
|
165
174
|
[**post_page_text_replace**](PdfApi.md#post_page_text_replace) | **POST** /pdf/\{name}/pages/\{pageNumber}/text/replace | Page's replace text method.
|
@@ -170,6 +179,7 @@ Method | HTTP request | Description
|
|
170
179
|
[**post_split_document**](PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts.
|
171
180
|
[**put_add_new_page**](PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
|
172
181
|
[**put_add_text**](PdfApi.md#put_add_text) | **PUT** /pdf/\{name}/pages/\{pageNumber}/text | Add text to PDF document page.
|
182
|
+
[**put_annotations_flatten**](PdfApi.md#put_annotations_flatten) | **PUT** /pdf/\{name}/annotations/flatten | Flattens the annotations of the specified types
|
173
183
|
[**put_caret_annotation**](PdfApi.md#put_caret_annotation) | **PUT** /pdf/\{name}/annotations/caret/\{annotationId} | Replace document caret annotation
|
174
184
|
[**put_circle_annotation**](PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation
|
175
185
|
[**put_create**](PdfApi.md#put_create) | **PUT** /storage/file | Upload a specific file
|
@@ -237,12 +247,15 @@ Method | HTTP request | Description
|
|
237
247
|
[**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.
|
238
248
|
[**put_redaction_annotation**](PdfApi.md#put_redaction_annotation) | **PUT** /pdf/\{name}/annotations/redaction/\{annotationId} | Replace document redaction annotation
|
239
249
|
[**put_replace_image**](PdfApi.md#put_replace_image) | **PUT** /pdf/\{name}/images/\{imageId} | Replace document image.
|
250
|
+
[**put_screen_annotation**](PdfApi.md#put_screen_annotation) | **PUT** /pdf/\{name}/annotations/screen/\{annotationId} | Replace document screen annotation
|
240
251
|
[**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.
|
241
252
|
[**put_set_property**](PdfApi.md#put_set_property) | **PUT** /pdf/\{name}/documentproperties/\{propertyName} | Add/update document property.
|
242
253
|
[**put_sound_annotation**](PdfApi.md#put_sound_annotation) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId} | Replace document sound annotation
|
243
254
|
[**put_sound_annotation_data_extract**](PdfApi.md#put_sound_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId}/data/extract | Extract document sound annotation content to storage
|
244
255
|
[**put_square_annotation**](PdfApi.md#put_square_annotation) | **PUT** /pdf/\{name}/annotations/square/\{annotationId} | Replace document square annotation
|
245
256
|
[**put_squiggly_annotation**](PdfApi.md#put_squiggly_annotation) | **PUT** /pdf/\{name}/annotations/squiggly/\{annotationId} | Replace document squiggly annotation
|
257
|
+
[**put_stamp_annotation**](PdfApi.md#put_stamp_annotation) | **PUT** /pdf/\{name}/annotations/stamp/\{annotationId} | Replace document stamp annotation
|
258
|
+
[**put_stamp_annotation_data_extract**](PdfApi.md#put_stamp_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/stamp/\{annotationId}/data/extract | Extract document stamp annotation content to storage
|
246
259
|
[**put_strike_out_annotation**](PdfApi.md#put_strike_out_annotation) | **PUT** /pdf/\{name}/annotations/strikeout/\{annotationId} | Replace document StrikeOut annotation
|
247
260
|
[**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.
|
248
261
|
[**put_text_annotation**](PdfApi.md#put_text_annotation) | **PUT** /pdf/\{name}/annotations/text/\{annotationId} | Replace document text annotation
|
@@ -1133,6 +1146,30 @@ Name | Type | Description | Notes
|
|
1133
1146
|
|
1134
1147
|
|
1135
1148
|
|
1149
|
+
# **get_document_screen_annotations**
|
1150
|
+
> ScreenAnnotationsResponse get_document_screen_annotations(name, opts)
|
1151
|
+
|
1152
|
+
Read document screen annotations.
|
1153
|
+
|
1154
|
+
### Parameters
|
1155
|
+
|
1156
|
+
Name | Type | Description | Notes
|
1157
|
+
------------- | ------------- | ------------- | -------------
|
1158
|
+
**name** | **String**| The document name. |
|
1159
|
+
**storage** | **String**| The document storage. | [optional]
|
1160
|
+
**folder** | **String**| The document folder. | [optional]
|
1161
|
+
|
1162
|
+
### Return type
|
1163
|
+
|
1164
|
+
[**ScreenAnnotationsResponse**](ScreenAnnotationsResponse.md)
|
1165
|
+
|
1166
|
+
### HTTP request headers
|
1167
|
+
|
1168
|
+
- **Content-Type**: application/json
|
1169
|
+
- **Accept**: application/json
|
1170
|
+
|
1171
|
+
|
1172
|
+
|
1136
1173
|
# **get_document_sound_annotations**
|
1137
1174
|
> SoundAnnotationsResponse get_document_sound_annotations(name, opts)
|
1138
1175
|
|
@@ -1205,6 +1242,30 @@ Name | Type | Description | Notes
|
|
1205
1242
|
|
1206
1243
|
|
1207
1244
|
|
1245
|
+
# **get_document_stamp_annotations**
|
1246
|
+
> StampAnnotationsResponse get_document_stamp_annotations(name, opts)
|
1247
|
+
|
1248
|
+
Read document stamp annotations.
|
1249
|
+
|
1250
|
+
### Parameters
|
1251
|
+
|
1252
|
+
Name | Type | Description | Notes
|
1253
|
+
------------- | ------------- | ------------- | -------------
|
1254
|
+
**name** | **String**| The document name. |
|
1255
|
+
**storage** | **String**| The document storage. | [optional]
|
1256
|
+
**folder** | **String**| The document folder. | [optional]
|
1257
|
+
|
1258
|
+
### Return type
|
1259
|
+
|
1260
|
+
[**StampAnnotationsResponse**](StampAnnotationsResponse.md)
|
1261
|
+
|
1262
|
+
### HTTP request headers
|
1263
|
+
|
1264
|
+
- **Content-Type**: application/json
|
1265
|
+
- **Accept**: application/json
|
1266
|
+
|
1267
|
+
|
1268
|
+
|
1208
1269
|
# **get_document_strike_out_annotations**
|
1209
1270
|
> StrikeOutAnnotationsResponse get_document_strike_out_annotations(name, opts)
|
1210
1271
|
|
@@ -1419,7 +1480,7 @@ Name | Type | Description | Notes
|
|
1419
1480
|
### HTTP request headers
|
1420
1481
|
|
1421
1482
|
- **Content-Type**: application/json
|
1422
|
-
- **Accept**:
|
1483
|
+
- **Accept**: multipart/form-data
|
1423
1484
|
|
1424
1485
|
|
1425
1486
|
|
@@ -1444,7 +1505,7 @@ Name | Type | Description | Notes
|
|
1444
1505
|
### HTTP request headers
|
1445
1506
|
|
1446
1507
|
- **Content-Type**: application/json
|
1447
|
-
- **Accept**:
|
1508
|
+
- **Accept**: multipart/form-data
|
1448
1509
|
|
1449
1510
|
|
1450
1511
|
|
@@ -1550,7 +1611,7 @@ Name | Type | Description | Notes
|
|
1550
1611
|
### HTTP request headers
|
1551
1612
|
|
1552
1613
|
- **Content-Type**: application/json
|
1553
|
-
- **Accept**:
|
1614
|
+
- **Accept**: multipart/form-data
|
1554
1615
|
|
1555
1616
|
|
1556
1617
|
|
@@ -1577,7 +1638,7 @@ Name | Type | Description | Notes
|
|
1577
1638
|
### HTTP request headers
|
1578
1639
|
|
1579
1640
|
- **Content-Type**: application/json
|
1580
|
-
- **Accept**:
|
1641
|
+
- **Accept**: multipart/form-data
|
1581
1642
|
|
1582
1643
|
|
1583
1644
|
|
@@ -1604,7 +1665,7 @@ Name | Type | Description | Notes
|
|
1604
1665
|
### HTTP request headers
|
1605
1666
|
|
1606
1667
|
- **Content-Type**: application/json
|
1607
|
-
- **Accept**:
|
1668
|
+
- **Accept**: multipart/form-data
|
1608
1669
|
|
1609
1670
|
|
1610
1671
|
|
@@ -1631,7 +1692,7 @@ Name | Type | Description | Notes
|
|
1631
1692
|
### HTTP request headers
|
1632
1693
|
|
1633
1694
|
- **Content-Type**: application/json
|
1634
|
-
- **Accept**:
|
1695
|
+
- **Accept**: multipart/form-data
|
1635
1696
|
|
1636
1697
|
|
1637
1698
|
|
@@ -1658,7 +1719,7 @@ Name | Type | Description | Notes
|
|
1658
1719
|
### HTTP request headers
|
1659
1720
|
|
1660
1721
|
- **Content-Type**: application/json
|
1661
|
-
- **Accept**:
|
1722
|
+
- **Accept**: multipart/form-data
|
1662
1723
|
|
1663
1724
|
|
1664
1725
|
|
@@ -1946,7 +2007,7 @@ Name | Type | Description | Notes
|
|
1946
2007
|
### HTTP request headers
|
1947
2008
|
|
1948
2009
|
- **Content-Type**: application/json
|
1949
|
-
- **Accept**:
|
2010
|
+
- **Accept**: multipart/form-data
|
1950
2011
|
|
1951
2012
|
|
1952
2013
|
|
@@ -2048,7 +2109,7 @@ Name | Type | Description | Notes
|
|
2048
2109
|
### HTTP request headers
|
2049
2110
|
|
2050
2111
|
- **Content-Type**: application/json
|
2051
|
-
- **Accept**:
|
2112
|
+
- **Accept**: multipart/form-data
|
2052
2113
|
|
2053
2114
|
|
2054
2115
|
|
@@ -2075,7 +2136,7 @@ Name | Type | Description | Notes
|
|
2075
2136
|
### HTTP request headers
|
2076
2137
|
|
2077
2138
|
- **Content-Type**: application/json
|
2078
|
-
- **Accept**:
|
2139
|
+
- **Accept**: multipart/form-data
|
2079
2140
|
|
2080
2141
|
|
2081
2142
|
|
@@ -2102,7 +2163,7 @@ Name | Type | Description | Notes
|
|
2102
2163
|
### HTTP request headers
|
2103
2164
|
|
2104
2165
|
- **Content-Type**: application/json
|
2105
|
-
- **Accept**:
|
2166
|
+
- **Accept**: multipart/form-data
|
2106
2167
|
|
2107
2168
|
|
2108
2169
|
|
@@ -2129,7 +2190,7 @@ Name | Type | Description | Notes
|
|
2129
2190
|
### HTTP request headers
|
2130
2191
|
|
2131
2192
|
- **Content-Type**: application/json
|
2132
|
-
- **Accept**:
|
2193
|
+
- **Accept**: multipart/form-data
|
2133
2194
|
|
2134
2195
|
|
2135
2196
|
|
@@ -2156,7 +2217,7 @@ Name | Type | Description | Notes
|
|
2156
2217
|
### HTTP request headers
|
2157
2218
|
|
2158
2219
|
- **Content-Type**: application/json
|
2159
|
-
- **Accept**:
|
2220
|
+
- **Accept**: multipart/form-data
|
2160
2221
|
|
2161
2222
|
|
2162
2223
|
|
@@ -2183,7 +2244,7 @@ Name | Type | Description | Notes
|
|
2183
2244
|
### HTTP request headers
|
2184
2245
|
|
2185
2246
|
- **Content-Type**: application/json
|
2186
|
-
- **Accept**:
|
2247
|
+
- **Accept**: multipart/form-data
|
2187
2248
|
|
2188
2249
|
|
2189
2250
|
|
@@ -2488,6 +2549,31 @@ Name | Type | Description | Notes
|
|
2488
2549
|
|
2489
2550
|
|
2490
2551
|
|
2552
|
+
# **get_page_screen_annotations**
|
2553
|
+
> ScreenAnnotationsResponse get_page_screen_annotations(name, page_number, opts)
|
2554
|
+
|
2555
|
+
Read document page screen annotations.
|
2556
|
+
|
2557
|
+
### Parameters
|
2558
|
+
|
2559
|
+
Name | Type | Description | Notes
|
2560
|
+
------------- | ------------- | ------------- | -------------
|
2561
|
+
**name** | **String**| The document name. |
|
2562
|
+
**page_number** | **Integer**| The page number. |
|
2563
|
+
**storage** | **String**| The document storage. | [optional]
|
2564
|
+
**folder** | **String**| The document folder. | [optional]
|
2565
|
+
|
2566
|
+
### Return type
|
2567
|
+
|
2568
|
+
[**ScreenAnnotationsResponse**](ScreenAnnotationsResponse.md)
|
2569
|
+
|
2570
|
+
### HTTP request headers
|
2571
|
+
|
2572
|
+
- **Content-Type**: application/json
|
2573
|
+
- **Accept**: application/json
|
2574
|
+
|
2575
|
+
|
2576
|
+
|
2491
2577
|
# **get_page_sound_annotations**
|
2492
2578
|
> SoundAnnotationsResponse get_page_sound_annotations(name, page_number, opts)
|
2493
2579
|
|
@@ -2563,6 +2649,31 @@ Name | Type | Description | Notes
|
|
2563
2649
|
|
2564
2650
|
|
2565
2651
|
|
2652
|
+
# **get_page_stamp_annotations**
|
2653
|
+
> StampAnnotationsResponse get_page_stamp_annotations(name, page_number, opts)
|
2654
|
+
|
2655
|
+
Read document page stamp annotations.
|
2656
|
+
|
2657
|
+
### Parameters
|
2658
|
+
|
2659
|
+
Name | Type | Description | Notes
|
2660
|
+
------------- | ------------- | ------------- | -------------
|
2661
|
+
**name** | **String**| The document name. |
|
2662
|
+
**page_number** | **Integer**| The page number. |
|
2663
|
+
**storage** | **String**| The document storage. | [optional]
|
2664
|
+
**folder** | **String**| The document folder. | [optional]
|
2665
|
+
|
2666
|
+
### Return type
|
2667
|
+
|
2668
|
+
[**StampAnnotationsResponse**](StampAnnotationsResponse.md)
|
2669
|
+
|
2670
|
+
### HTTP request headers
|
2671
|
+
|
2672
|
+
- **Content-Type**: application/json
|
2673
|
+
- **Accept**: application/json
|
2674
|
+
|
2675
|
+
|
2676
|
+
|
2566
2677
|
# **get_page_strike_out_annotations**
|
2567
2678
|
> StrikeOutAnnotationsResponse get_page_strike_out_annotations(name, page_number, opts)
|
2568
2679
|
|
@@ -3189,6 +3300,31 @@ Name | Type | Description | Notes
|
|
3189
3300
|
|
3190
3301
|
|
3191
3302
|
|
3303
|
+
# **get_screen_annotation**
|
3304
|
+
> ScreenAnnotationResponse get_screen_annotation(name, annotation_id, opts)
|
3305
|
+
|
3306
|
+
Read document page screen annotation by ID.
|
3307
|
+
|
3308
|
+
### Parameters
|
3309
|
+
|
3310
|
+
Name | Type | Description | Notes
|
3311
|
+
------------- | ------------- | ------------- | -------------
|
3312
|
+
**name** | **String**| The document name. |
|
3313
|
+
**annotation_id** | **String**| The annotation ID. |
|
3314
|
+
**storage** | **String**| The document storage. | [optional]
|
3315
|
+
**folder** | **String**| The document folder. | [optional]
|
3316
|
+
|
3317
|
+
### Return type
|
3318
|
+
|
3319
|
+
[**ScreenAnnotationResponse**](ScreenAnnotationResponse.md)
|
3320
|
+
|
3321
|
+
### HTTP request headers
|
3322
|
+
|
3323
|
+
- **Content-Type**: application/json
|
3324
|
+
- **Accept**: application/json
|
3325
|
+
|
3326
|
+
|
3327
|
+
|
3192
3328
|
# **get_sound_annotation**
|
3193
3329
|
> SoundAnnotationResponse get_sound_annotation(name, annotation_id, opts)
|
3194
3330
|
|
@@ -3210,7 +3346,7 @@ Name | Type | Description | Notes
|
|
3210
3346
|
### HTTP request headers
|
3211
3347
|
|
3212
3348
|
- **Content-Type**: application/json
|
3213
|
-
- **Accept**:
|
3349
|
+
- **Accept**: multipart/form-data
|
3214
3350
|
|
3215
3351
|
|
3216
3352
|
|
@@ -3235,7 +3371,7 @@ Name | Type | Description | Notes
|
|
3235
3371
|
### HTTP request headers
|
3236
3372
|
|
3237
3373
|
- **Content-Type**: application/json
|
3238
|
-
- **Accept**:
|
3374
|
+
- **Accept**: multipart/form-data
|
3239
3375
|
|
3240
3376
|
|
3241
3377
|
|
@@ -3289,6 +3425,56 @@ Name | Type | Description | Notes
|
|
3289
3425
|
|
3290
3426
|
|
3291
3427
|
|
3428
|
+
# **get_stamp_annotation**
|
3429
|
+
> StampAnnotationResponse get_stamp_annotation(name, annotation_id, opts)
|
3430
|
+
|
3431
|
+
Read document page stamp annotation by ID.
|
3432
|
+
|
3433
|
+
### Parameters
|
3434
|
+
|
3435
|
+
Name | Type | Description | Notes
|
3436
|
+
------------- | ------------- | ------------- | -------------
|
3437
|
+
**name** | **String**| The document name. |
|
3438
|
+
**annotation_id** | **String**| The annotation ID. |
|
3439
|
+
**storage** | **String**| The document storage. | [optional]
|
3440
|
+
**folder** | **String**| The document folder. | [optional]
|
3441
|
+
|
3442
|
+
### Return type
|
3443
|
+
|
3444
|
+
[**StampAnnotationResponse**](StampAnnotationResponse.md)
|
3445
|
+
|
3446
|
+
### HTTP request headers
|
3447
|
+
|
3448
|
+
- **Content-Type**: application/json
|
3449
|
+
- **Accept**: application/json
|
3450
|
+
|
3451
|
+
|
3452
|
+
|
3453
|
+
# **get_stamp_annotation_data**
|
3454
|
+
> File get_stamp_annotation_data(name, annotation_id, opts)
|
3455
|
+
|
3456
|
+
Read document page stamp annotation by ID.
|
3457
|
+
|
3458
|
+
### Parameters
|
3459
|
+
|
3460
|
+
Name | Type | Description | Notes
|
3461
|
+
------------- | ------------- | ------------- | -------------
|
3462
|
+
**name** | **String**| The document name. |
|
3463
|
+
**annotation_id** | **String**| The annotation ID. |
|
3464
|
+
**storage** | **String**| The document storage. | [optional]
|
3465
|
+
**folder** | **String**| The document folder. | [optional]
|
3466
|
+
|
3467
|
+
### Return type
|
3468
|
+
|
3469
|
+
**File**
|
3470
|
+
|
3471
|
+
### HTTP request headers
|
3472
|
+
|
3473
|
+
- **Content-Type**: application/json
|
3474
|
+
- **Accept**: application/json
|
3475
|
+
|
3476
|
+
|
3477
|
+
|
3292
3478
|
# **get_strike_out_annotation**
|
3293
3479
|
> StrikeOutAnnotationResponse get_strike_out_annotation(name, annotation_id, opts)
|
3294
3480
|
|
@@ -4150,6 +4336,32 @@ Name | Type | Description | Notes
|
|
4150
4336
|
|
4151
4337
|
|
4152
4338
|
|
4339
|
+
# **post_page_screen_annotations**
|
4340
|
+
> AsposeResponse post_page_screen_annotations(name, page_number, annotations, opts)
|
4341
|
+
|
4342
|
+
Add document page screen annotations.
|
4343
|
+
|
4344
|
+
### Parameters
|
4345
|
+
|
4346
|
+
Name | Type | Description | Notes
|
4347
|
+
------------- | ------------- | ------------- | -------------
|
4348
|
+
**name** | **String**| The document name. |
|
4349
|
+
**page_number** | **Integer**| The page number. |
|
4350
|
+
**annotations** | [**Array<ScreenAnnotation>**](ScreenAnnotation.md)| The array of annotation. |
|
4351
|
+
**storage** | **String**| The document storage. | [optional]
|
4352
|
+
**folder** | **String**| The document folder. | [optional]
|
4353
|
+
|
4354
|
+
### Return type
|
4355
|
+
|
4356
|
+
[**AsposeResponse**](AsposeResponse.md)
|
4357
|
+
|
4358
|
+
### HTTP request headers
|
4359
|
+
|
4360
|
+
- **Content-Type**: application/json
|
4361
|
+
- **Accept**: application/json
|
4362
|
+
|
4363
|
+
|
4364
|
+
|
4153
4365
|
# **post_page_sound_annotations**
|
4154
4366
|
> AsposeResponse post_page_sound_annotations(name, page_number, annotations, opts)
|
4155
4367
|
|
@@ -4228,6 +4440,32 @@ Name | Type | Description | Notes
|
|
4228
4440
|
|
4229
4441
|
|
4230
4442
|
|
4443
|
+
# **post_page_stamp_annotations**
|
4444
|
+
> AsposeResponse post_page_stamp_annotations(name, page_number, annotations, opts)
|
4445
|
+
|
4446
|
+
Add document page stamp annotations.
|
4447
|
+
|
4448
|
+
### Parameters
|
4449
|
+
|
4450
|
+
Name | Type | Description | Notes
|
4451
|
+
------------- | ------------- | ------------- | -------------
|
4452
|
+
**name** | **String**| The document name. |
|
4453
|
+
**page_number** | **Integer**| The page number. |
|
4454
|
+
**annotations** | [**Array<StampAnnotation>**](StampAnnotation.md)| The array of annotation. |
|
4455
|
+
**storage** | **String**| The document storage. | [optional]
|
4456
|
+
**folder** | **String**| The document folder. | [optional]
|
4457
|
+
|
4458
|
+
### Return type
|
4459
|
+
|
4460
|
+
[**AsposeResponse**](AsposeResponse.md)
|
4461
|
+
|
4462
|
+
### HTTP request headers
|
4463
|
+
|
4464
|
+
- **Content-Type**: application/json
|
4465
|
+
- **Accept**: application/json
|
4466
|
+
|
4467
|
+
|
4468
|
+
|
4231
4469
|
# **post_page_strike_out_annotations**
|
4232
4470
|
> AsposeResponse post_page_strike_out_annotations(name, page_number, annotations, opts)
|
4233
4471
|
|
@@ -4486,6 +4724,33 @@ Name | Type | Description | Notes
|
|
4486
4724
|
|
4487
4725
|
|
4488
4726
|
|
4727
|
+
# **put_annotations_flatten**
|
4728
|
+
> AsposeResponse put_annotations_flatten(name, opts)
|
4729
|
+
|
4730
|
+
Flattens the annotations of the specified types
|
4731
|
+
|
4732
|
+
### Parameters
|
4733
|
+
|
4734
|
+
Name | Type | Description | Notes
|
4735
|
+
------------- | ------------- | ------------- | -------------
|
4736
|
+
**name** | **String**| The document name. |
|
4737
|
+
**start_page** | **Integer**| The start page number. | [optional]
|
4738
|
+
**end_page** | **Integer**| The end page number. | [optional]
|
4739
|
+
**annotation_types** | [**Array<AnnotationType>**](AnnotationType.md)| Array of annotation types. | [optional]
|
4740
|
+
**storage** | **String**| The document storage. | [optional]
|
4741
|
+
**folder** | **String**| The document folder. | [optional]
|
4742
|
+
|
4743
|
+
### Return type
|
4744
|
+
|
4745
|
+
[**AsposeResponse**](AsposeResponse.md)
|
4746
|
+
|
4747
|
+
### HTTP request headers
|
4748
|
+
|
4749
|
+
- **Content-Type**: application/json
|
4750
|
+
- **Accept**: application/json
|
4751
|
+
|
4752
|
+
|
4753
|
+
|
4489
4754
|
# **put_caret_annotation**
|
4490
4755
|
> CaretAnnotationResponse put_caret_annotation(name, annotation_id, annotation, opts)
|
4491
4756
|
|
@@ -5150,7 +5415,7 @@ Name | Type | Description | Notes
|
|
5150
5415
|
|
5151
5416
|
|
5152
5417
|
# **put_merge_documents**
|
5153
|
-
>
|
5418
|
+
> DocumentResponse put_merge_documents(name, opts)
|
5154
5419
|
|
5155
5420
|
Merge a list of documents.
|
5156
5421
|
|
@@ -5165,7 +5430,7 @@ Name | Type | Description | Notes
|
|
5165
5430
|
|
5166
5431
|
### Return type
|
5167
5432
|
|
5168
|
-
**
|
5433
|
+
[**DocumentResponse**](DocumentResponse.md)
|
5169
5434
|
|
5170
5435
|
### HTTP request headers
|
5171
5436
|
|
@@ -6333,6 +6598,32 @@ Name | Type | Description | Notes
|
|
6333
6598
|
|
6334
6599
|
|
6335
6600
|
|
6601
|
+
# **put_screen_annotation**
|
6602
|
+
> ScreenAnnotationResponse put_screen_annotation(name, annotation_id, annotation, opts)
|
6603
|
+
|
6604
|
+
Replace document screen annotation
|
6605
|
+
|
6606
|
+
### Parameters
|
6607
|
+
|
6608
|
+
Name | Type | Description | Notes
|
6609
|
+
------------- | ------------- | ------------- | -------------
|
6610
|
+
**name** | **String**| The document name. |
|
6611
|
+
**annotation_id** | **String**| The annotation ID. |
|
6612
|
+
**annotation** | [**ScreenAnnotation**](ScreenAnnotation.md)| Annotation. |
|
6613
|
+
**storage** | **String**| The document storage. | [optional]
|
6614
|
+
**folder** | **String**| The document folder. | [optional]
|
6615
|
+
|
6616
|
+
### Return type
|
6617
|
+
|
6618
|
+
[**ScreenAnnotationResponse**](ScreenAnnotationResponse.md)
|
6619
|
+
|
6620
|
+
### HTTP request headers
|
6621
|
+
|
6622
|
+
- **Content-Type**: application/json
|
6623
|
+
- **Accept**: application/json
|
6624
|
+
|
6625
|
+
|
6626
|
+
|
6336
6627
|
# **put_searchable_document**
|
6337
6628
|
> AsposeResponse put_searchable_document(name, opts)
|
6338
6629
|
|
@@ -6488,6 +6779,58 @@ Name | Type | Description | Notes
|
|
6488
6779
|
|
6489
6780
|
|
6490
6781
|
|
6782
|
+
# **put_stamp_annotation**
|
6783
|
+
> StampAnnotationResponse put_stamp_annotation(name, annotation_id, annotation, opts)
|
6784
|
+
|
6785
|
+
Replace document stamp annotation
|
6786
|
+
|
6787
|
+
### Parameters
|
6788
|
+
|
6789
|
+
Name | Type | Description | Notes
|
6790
|
+
------------- | ------------- | ------------- | -------------
|
6791
|
+
**name** | **String**| The document name. |
|
6792
|
+
**annotation_id** | **String**| The annotation ID. |
|
6793
|
+
**annotation** | [**StampAnnotation**](StampAnnotation.md)| Annotation. |
|
6794
|
+
**storage** | **String**| The document storage. | [optional]
|
6795
|
+
**folder** | **String**| The document folder. | [optional]
|
6796
|
+
|
6797
|
+
### Return type
|
6798
|
+
|
6799
|
+
[**StampAnnotationResponse**](StampAnnotationResponse.md)
|
6800
|
+
|
6801
|
+
### HTTP request headers
|
6802
|
+
|
6803
|
+
- **Content-Type**: application/json
|
6804
|
+
- **Accept**: application/json
|
6805
|
+
|
6806
|
+
|
6807
|
+
|
6808
|
+
# **put_stamp_annotation_data_extract**
|
6809
|
+
> AsposeResponse put_stamp_annotation_data_extract(name, annotation_id, out_file_path, opts)
|
6810
|
+
|
6811
|
+
Extract document stamp annotation content to storage
|
6812
|
+
|
6813
|
+
### Parameters
|
6814
|
+
|
6815
|
+
Name | Type | Description | Notes
|
6816
|
+
------------- | ------------- | ------------- | -------------
|
6817
|
+
**name** | **String**| The document name. |
|
6818
|
+
**annotation_id** | **String**| The annotation ID. |
|
6819
|
+
**out_file_path** | **String**| The output file path. |
|
6820
|
+
**storage** | **String**| The document storage. | [optional]
|
6821
|
+
**folder** | **String**| The document folder. | [optional]
|
6822
|
+
|
6823
|
+
### Return type
|
6824
|
+
|
6825
|
+
[**AsposeResponse**](AsposeResponse.md)
|
6826
|
+
|
6827
|
+
### HTTP request headers
|
6828
|
+
|
6829
|
+
- **Content-Type**: application/json
|
6830
|
+
- **Accept**: application/json
|
6831
|
+
|
6832
|
+
|
6833
|
+
|
6491
6834
|
# **put_strike_out_annotation**
|
6492
6835
|
> StrikeOutAnnotationResponse put_strike_out_annotation(name, annotation_id, annotation, opts)
|
6493
6836
|
|