aspose_pdf_cloud 19.9.0 → 19.10.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 +26 -4
- data/docs/BoxStyle.md +15 -0
- data/docs/CheckBoxField.md +31 -0
- data/docs/CheckBoxFieldResponse.md +11 -0
- data/docs/CheckBoxFields.md +10 -0
- data/docs/CheckBoxFieldsResponse.md +11 -0
- data/docs/ChoiceField.md +27 -0
- data/docs/Option.md +12 -0
- data/docs/PdfApi.md +260 -0
- data/docs/RadioButtonField.md +31 -0
- data/docs/RadioButtonFieldResponse.md +11 -0
- data/docs/RadioButtonFields.md +10 -0
- data/docs/RadioButtonFieldsResponse.md +11 -0
- data/docs/RadioButtonOptionField.md +28 -0
- data/lib/aspose_pdf_cloud.rb +12 -0
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +814 -38
- data/lib/aspose_pdf_cloud/models/box_style.rb +48 -0
- data/lib/aspose_pdf_cloud/models/check_box_field.rb +440 -0
- data/lib/aspose_pdf_cloud/models/check_box_field_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/check_box_fields.rb +213 -0
- data/lib/aspose_pdf_cloud/models/check_box_fields_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/choice_field.rb +393 -0
- data/lib/aspose_pdf_cloud/models/option.rb +229 -0
- data/lib/aspose_pdf_cloud/models/radio_button_field.rb +442 -0
- data/lib/aspose_pdf_cloud/models/radio_button_field_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/radio_button_fields.rb +213 -0
- data/lib/aspose_pdf_cloud/models/radio_button_fields_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/radio_button_option_field.rb +403 -0
- data/lib/aspose_pdf_cloud/version.rb +1 -1
- data/test/pdf_tests.rb +200 -0
- metadata +26 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4779921d204b54540c42f31dc1aa31b2ed475b4f4f52104ca1e79b021a56b4f5
|
4
|
+
data.tar.gz: a8dbe59adc5e0089d358e0644d592c2e28ad086ae29a9cb6f9f3af5f95e7a927
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7424215c45d898fb1e86c6b06edfe9d92ba4dac6991f0a74be4b6a1479d3ec5e67a9116f3d2fd15fd079e03415b69ee8853706ecd65ff0c6f257d4f13cff6fc9
|
7
|
+
data.tar.gz: cb8ad8541d16f1413bae259c65045af5a7fe0200a4f740395ab8e72cb6283294071fec262a5af7a9f8196d1f122bb0564d47a1d22763a27f2d945f301ab6f5ba
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# Aspose.PDF Cloud
|
2
2
|
|
3
3
|
- API version: 3.0
|
4
|
-
- Package version: 19.
|
4
|
+
- Package version: 19.10.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.10.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.10.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.10.0'
|
34
34
|
|
35
35
|
### Install from Git
|
36
36
|
|
@@ -117,6 +117,7 @@ Class | Method | HTTP request | Description
|
|
117
117
|
*AsposePdfCloud::PdfApi* | [**get_bookmark**](docs/PdfApi.md#get_bookmark) | **GET** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Read document bookmark.
|
118
118
|
*AsposePdfCloud::PdfApi* | [**get_bookmarks**](docs/PdfApi.md#get_bookmarks) | **GET** /pdf/\{name}/bookmarks/list/\{bookmarkPath} | Read document bookmarks node list.
|
119
119
|
*AsposePdfCloud::PdfApi* | [**get_caret_annotation**](docs/PdfApi.md#get_caret_annotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID.
|
120
|
+
*AsposePdfCloud::PdfApi* | [**get_check_box_field**](docs/PdfApi.md#get_check_box_field) | **GET** /pdf/\{name}/fields/checkbox/\{fieldName} | Read document checkbox field by name.
|
120
121
|
*AsposePdfCloud::PdfApi* | [**get_circle_annotation**](docs/PdfApi.md#get_circle_annotation) | **GET** /pdf/\{name}/annotations/circle/\{annotationId} | Read document page circle annotation by ID.
|
121
122
|
*AsposePdfCloud::PdfApi* | [**get_disc_usage**](docs/PdfApi.md#get_disc_usage) | **GET** /pdf/storage/disc | Get disc usage
|
122
123
|
*AsposePdfCloud::PdfApi* | [**get_document**](docs/PdfApi.md#get_document) | **GET** /pdf/\{name} | Read common document info.
|
@@ -125,6 +126,7 @@ Class | Method | HTTP request | Description
|
|
125
126
|
*AsposePdfCloud::PdfApi* | [**get_document_attachments**](docs/PdfApi.md#get_document_attachments) | **GET** /pdf/\{name}/attachments | Read document attachments info.
|
126
127
|
*AsposePdfCloud::PdfApi* | [**get_document_bookmarks**](docs/PdfApi.md#get_document_bookmarks) | **GET** /pdf/\{name}/bookmarks/tree | Read document bookmarks tree.
|
127
128
|
*AsposePdfCloud::PdfApi* | [**get_document_caret_annotations**](docs/PdfApi.md#get_document_caret_annotations) | **GET** /pdf/\{name}/annotations/caret | Read document caret annotations.
|
129
|
+
*AsposePdfCloud::PdfApi* | [**get_document_check_box_fields**](docs/PdfApi.md#get_document_check_box_fields) | **GET** /pdf/\{name}/fields/checkbox | Read document checkbox fields.
|
128
130
|
*AsposePdfCloud::PdfApi* | [**get_document_circle_annotations**](docs/PdfApi.md#get_document_circle_annotations) | **GET** /pdf/\{name}/annotations/circle | Read document circle annotations.
|
129
131
|
*AsposePdfCloud::PdfApi* | [**get_document_file_attachment_annotations**](docs/PdfApi.md#get_document_file_attachment_annotations) | **GET** /pdf/\{name}/annotations/fileattachment | Read document FileAttachment annotations.
|
130
132
|
*AsposePdfCloud::PdfApi* | [**get_document_free_text_annotations**](docs/PdfApi.md#get_document_free_text_annotations) | **GET** /pdf/\{name}/annotations/freetext | Read document free text annotations.
|
@@ -138,6 +140,7 @@ Class | Method | HTTP request | Description
|
|
138
140
|
*AsposePdfCloud::PdfApi* | [**get_document_popup_annotations_by_parent**](docs/PdfApi.md#get_document_popup_annotations_by_parent) | **GET** /pdf/\{name}/annotations/\{annotationId}/popup | Read document popup annotations by parent id.
|
139
141
|
*AsposePdfCloud::PdfApi* | [**get_document_properties**](docs/PdfApi.md#get_document_properties) | **GET** /pdf/\{name}/documentproperties | Read document properties.
|
140
142
|
*AsposePdfCloud::PdfApi* | [**get_document_property**](docs/PdfApi.md#get_document_property) | **GET** /pdf/\{name}/documentproperties/\{propertyName} | Read document property by name.
|
143
|
+
*AsposePdfCloud::PdfApi* | [**get_document_radio_button_fields**](docs/PdfApi.md#get_document_radio_button_fields) | **GET** /pdf/\{name}/fields/radiobutton | Read document radiobutton fields.
|
141
144
|
*AsposePdfCloud::PdfApi* | [**get_document_redaction_annotations**](docs/PdfApi.md#get_document_redaction_annotations) | **GET** /pdf/\{name}/annotations/redaction | Read document redaction annotations.
|
142
145
|
*AsposePdfCloud::PdfApi* | [**get_document_screen_annotations**](docs/PdfApi.md#get_document_screen_annotations) | **GET** /pdf/\{name}/annotations/screen | Read document screen annotations.
|
143
146
|
*AsposePdfCloud::PdfApi* | [**get_document_signature_fields**](docs/PdfApi.md#get_document_signature_fields) | **GET** /pdf/\{name}/fields/signature | Read document signature fields.
|
@@ -184,6 +187,7 @@ Class | Method | HTTP request | Description
|
|
184
187
|
*AsposePdfCloud::PdfApi* | [**get_page**](docs/PdfApi.md#get_page) | **GET** /pdf/\{name}/pages/\{pageNumber} | Read document page info.
|
185
188
|
*AsposePdfCloud::PdfApi* | [**get_page_annotations**](docs/PdfApi.md#get_page_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations | Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
|
186
189
|
*AsposePdfCloud::PdfApi* | [**get_page_caret_annotations**](docs/PdfApi.md#get_page_caret_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Read document page caret annotations.
|
190
|
+
*AsposePdfCloud::PdfApi* | [**get_page_check_box_fields**](docs/PdfApi.md#get_page_check_box_fields) | **GET** /pdf/\{name}/page/\{pageNumber}/fields/checkbox | Read document page checkbox fields.
|
187
191
|
*AsposePdfCloud::PdfApi* | [**get_page_circle_annotations**](docs/PdfApi.md#get_page_circle_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Read document page circle annotations.
|
188
192
|
*AsposePdfCloud::PdfApi* | [**get_page_convert_to_bmp**](docs/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.
|
189
193
|
*AsposePdfCloud::PdfApi* | [**get_page_convert_to_emf**](docs/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.
|
@@ -202,6 +206,7 @@ Class | Method | HTTP request | Description
|
|
202
206
|
*AsposePdfCloud::PdfApi* | [**get_page_poly_line_annotations**](docs/PdfApi.md#get_page_poly_line_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Read document page polyline annotations.
|
203
207
|
*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.
|
204
208
|
*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.
|
209
|
+
*AsposePdfCloud::PdfApi* | [**get_page_radio_button_fields**](docs/PdfApi.md#get_page_radio_button_fields) | **GET** /pdf/\{name}/page/\{pageNumber}/fields/radiobutton | Read document page radiobutton fields.
|
205
210
|
*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.
|
206
211
|
*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.
|
207
212
|
*AsposePdfCloud::PdfApi* | [**get_page_signature_fields**](docs/PdfApi.md#get_page_signature_fields) | **GET** /pdf/\{name}/page/\{pageNumber}/fields/signature | Read document page signature fields.
|
@@ -235,6 +240,7 @@ Class | Method | HTTP request | Description
|
|
235
240
|
*AsposePdfCloud::PdfApi* | [**get_polygon_annotation**](docs/PdfApi.md#get_polygon_annotation) | **GET** /pdf/\{name}/annotations/polygon/\{annotationId} | Read document page polygon annotation by ID.
|
236
241
|
*AsposePdfCloud::PdfApi* | [**get_popup_annotation**](docs/PdfApi.md#get_popup_annotation) | **GET** /pdf/\{name}/annotations/popup/\{annotationId} | Read document page popup annotation by ID.
|
237
242
|
*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.
|
243
|
+
*AsposePdfCloud::PdfApi* | [**get_radio_button_field**](docs/PdfApi.md#get_radio_button_field) | **GET** /pdf/\{name}/fields/radiobutton/\{fieldName} | Read document RadioButton field by name.
|
238
244
|
*AsposePdfCloud::PdfApi* | [**get_redaction_annotation**](docs/PdfApi.md#get_redaction_annotation) | **GET** /pdf/\{name}/annotations/redaction/\{annotationId} | Read document page redaction annotation by ID.
|
239
245
|
*AsposePdfCloud::PdfApi* | [**get_screen_annotation**](docs/PdfApi.md#get_screen_annotation) | **GET** /pdf/\{name}/annotations/screen/\{annotationId} | Read document page screen annotation by ID.
|
240
246
|
*AsposePdfCloud::PdfApi* | [**get_screen_annotation_data**](docs/PdfApi.md#get_screen_annotation_data) | **GET** /pdf/\{name}/annotations/screen/\{annotationId}/data | Read document page screen annotation by ID.
|
@@ -265,6 +271,7 @@ Class | Method | HTTP request | Description
|
|
265
271
|
*AsposePdfCloud::PdfApi* | [**post_append_document**](docs/PdfApi.md#post_append_document) | **POST** /pdf/\{name}/appendDocument | Append document to existing one.
|
266
272
|
*AsposePdfCloud::PdfApi* | [**post_bookmark**](docs/PdfApi.md#post_bookmark) | **POST** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Add document bookmarks.
|
267
273
|
*AsposePdfCloud::PdfApi* | [**post_change_password_document_in_storage**](docs/PdfApi.md#post_change_password_document_in_storage) | **POST** /pdf/\{name}/changepassword | Change document password in storage.
|
274
|
+
*AsposePdfCloud::PdfApi* | [**post_check_box_fields**](docs/PdfApi.md#post_check_box_fields) | **POST** /pdf/\{name}/fields/checkbox | Add document checkbox fields.
|
268
275
|
*AsposePdfCloud::PdfApi* | [**post_create_field**](docs/PdfApi.md#post_create_field) | **POST** /pdf/\{name}/fields | Create field.
|
269
276
|
*AsposePdfCloud::PdfApi* | [**post_decrypt_document_in_storage**](docs/PdfApi.md#post_decrypt_document_in_storage) | **POST** /pdf/\{name}/decrypt | Decrypt document in storage.
|
270
277
|
*AsposePdfCloud::PdfApi* | [**post_document_image_footer**](docs/PdfApi.md#post_document_image_footer) | **POST** /pdf/\{name}/footer/image | Add document image footer.
|
@@ -308,6 +315,7 @@ Class | Method | HTTP request | Description
|
|
308
315
|
*AsposePdfCloud::PdfApi* | [**post_page_text_stamps**](docs/PdfApi.md#post_page_text_stamps) | **POST** /pdf/\{name}/pages/\{pageNumber}/stamps/text | Add document page text stamps.
|
309
316
|
*AsposePdfCloud::PdfApi* | [**post_page_underline_annotations**](docs/PdfApi.md#post_page_underline_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/underline | Add document page underline annotations.
|
310
317
|
*AsposePdfCloud::PdfApi* | [**post_popup_annotation**](docs/PdfApi.md#post_popup_annotation) | **POST** /pdf/\{name}/annotations/\{annotationId}/popup | Add document popup annotations.
|
318
|
+
*AsposePdfCloud::PdfApi* | [**post_radio_button_fields**](docs/PdfApi.md#post_radio_button_fields) | **POST** /pdf/\{name}/fields/radiobutton | Add document RadioButton fields.
|
311
319
|
*AsposePdfCloud::PdfApi* | [**post_sign_document**](docs/PdfApi.md#post_sign_document) | **POST** /pdf/\{name}/sign | Sign document.
|
312
320
|
*AsposePdfCloud::PdfApi* | [**post_sign_page**](docs/PdfApi.md#post_sign_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/sign | Sign page.
|
313
321
|
*AsposePdfCloud::PdfApi* | [**post_split_document**](docs/PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts.
|
@@ -318,6 +326,7 @@ Class | Method | HTTP request | Description
|
|
318
326
|
*AsposePdfCloud::PdfApi* | [**put_bookmark**](docs/PdfApi.md#put_bookmark) | **PUT** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Update document bookmark.
|
319
327
|
*AsposePdfCloud::PdfApi* | [**put_caret_annotation**](docs/PdfApi.md#put_caret_annotation) | **PUT** /pdf/\{name}/annotations/caret/\{annotationId} | Replace document caret annotation
|
320
328
|
*AsposePdfCloud::PdfApi* | [**put_change_password_document**](docs/PdfApi.md#put_change_password_document) | **PUT** /pdf/changepassword | Change document password from content.
|
329
|
+
*AsposePdfCloud::PdfApi* | [**put_check_box_field**](docs/PdfApi.md#put_check_box_field) | **PUT** /pdf/\{name}/fields/checkbox/\{fieldName} | Replace document checkbox field
|
321
330
|
*AsposePdfCloud::PdfApi* | [**put_circle_annotation**](docs/PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation
|
322
331
|
*AsposePdfCloud::PdfApi* | [**put_create_document**](docs/PdfApi.md#put_create_document) | **PUT** /pdf/\{name} | Create empty document.
|
323
332
|
*AsposePdfCloud::PdfApi* | [**put_decrypt_document**](docs/PdfApi.md#put_decrypt_document) | **PUT** /pdf/decrypt | Decrypt document from content.
|
@@ -391,6 +400,7 @@ Class | Method | HTTP request | Description
|
|
391
400
|
*AsposePdfCloud::PdfApi* | [**put_popup_annotation**](docs/PdfApi.md#put_popup_annotation) | **PUT** /pdf/\{name}/annotations/popup/\{annotationId} | Replace document popup annotation
|
392
401
|
*AsposePdfCloud::PdfApi* | [**put_privileges**](docs/PdfApi.md#put_privileges) | **PUT** /pdf/\{name}/privileges | Update privilege document.
|
393
402
|
*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.
|
403
|
+
*AsposePdfCloud::PdfApi* | [**put_radio_button_field**](docs/PdfApi.md#put_radio_button_field) | **PUT** /pdf/\{name}/fields/radiobutton/\{fieldName} | Replace document RadioButton field
|
394
404
|
*AsposePdfCloud::PdfApi* | [**put_redaction_annotation**](docs/PdfApi.md#put_redaction_annotation) | **PUT** /pdf/\{name}/annotations/redaction/\{annotationId} | Replace document redaction annotation
|
395
405
|
*AsposePdfCloud::PdfApi* | [**put_replace_image**](docs/PdfApi.md#put_replace_image) | **PUT** /pdf/\{name}/images/\{imageId} | Replace document image.
|
396
406
|
*AsposePdfCloud::PdfApi* | [**put_screen_annotation**](docs/PdfApi.md#put_screen_annotation) | **PUT** /pdf/\{name}/annotations/screen/\{annotationId} | Replace document screen annotation
|
@@ -430,6 +440,7 @@ Class | Method | HTTP request | Description
|
|
430
440
|
- [AsposePdfCloud::AsposeResponse](docs/AsposeResponse.md)
|
431
441
|
- [AsposePdfCloud::BorderCornerStyle](docs/BorderCornerStyle.md)
|
432
442
|
- [AsposePdfCloud::BorderInfo](docs/BorderInfo.md)
|
443
|
+
- [AsposePdfCloud::BoxStyle](docs/BoxStyle.md)
|
433
444
|
- [AsposePdfCloud::CapStyle](docs/CapStyle.md)
|
434
445
|
- [AsposePdfCloud::CaptionPosition](docs/CaptionPosition.md)
|
435
446
|
- [AsposePdfCloud::CaretSymbol](docs/CaretSymbol.md)
|
@@ -477,6 +488,7 @@ Class | Method | HTTP request | Description
|
|
477
488
|
- [AsposePdfCloud::MergeDocuments](docs/MergeDocuments.md)
|
478
489
|
- [AsposePdfCloud::ObjectExist](docs/ObjectExist.md)
|
479
490
|
- [AsposePdfCloud::OptimizeOptions](docs/OptimizeOptions.md)
|
491
|
+
- [AsposePdfCloud::Option](docs/Option.md)
|
480
492
|
- [AsposePdfCloud::PageWordCount](docs/PageWordCount.md)
|
481
493
|
- [AsposePdfCloud::Paragraph](docs/Paragraph.md)
|
482
494
|
- [AsposePdfCloud::PartsEmbeddingModes](docs/PartsEmbeddingModes.md)
|
@@ -531,6 +543,9 @@ Class | Method | HTTP request | Description
|
|
531
543
|
- [AsposePdfCloud::CaretAnnotationResponse](docs/CaretAnnotationResponse.md)
|
532
544
|
- [AsposePdfCloud::CaretAnnotations](docs/CaretAnnotations.md)
|
533
545
|
- [AsposePdfCloud::CaretAnnotationsResponse](docs/CaretAnnotationsResponse.md)
|
546
|
+
- [AsposePdfCloud::CheckBoxFieldResponse](docs/CheckBoxFieldResponse.md)
|
547
|
+
- [AsposePdfCloud::CheckBoxFields](docs/CheckBoxFields.md)
|
548
|
+
- [AsposePdfCloud::CheckBoxFieldsResponse](docs/CheckBoxFieldsResponse.md)
|
534
549
|
- [AsposePdfCloud::CircleAnnotationResponse](docs/CircleAnnotationResponse.md)
|
535
550
|
- [AsposePdfCloud::CircleAnnotations](docs/CircleAnnotations.md)
|
536
551
|
- [AsposePdfCloud::CircleAnnotationsResponse](docs/CircleAnnotationsResponse.md)
|
@@ -585,6 +600,9 @@ Class | Method | HTTP request | Description
|
|
585
600
|
- [AsposePdfCloud::PopupAnnotationResponse](docs/PopupAnnotationResponse.md)
|
586
601
|
- [AsposePdfCloud::PopupAnnotations](docs/PopupAnnotations.md)
|
587
602
|
- [AsposePdfCloud::PopupAnnotationsResponse](docs/PopupAnnotationsResponse.md)
|
603
|
+
- [AsposePdfCloud::RadioButtonFieldResponse](docs/RadioButtonFieldResponse.md)
|
604
|
+
- [AsposePdfCloud::RadioButtonFields](docs/RadioButtonFields.md)
|
605
|
+
- [AsposePdfCloud::RadioButtonFieldsResponse](docs/RadioButtonFieldsResponse.md)
|
588
606
|
- [AsposePdfCloud::RedactionAnnotationResponse](docs/RedactionAnnotationResponse.md)
|
589
607
|
- [AsposePdfCloud::RedactionAnnotations](docs/RedactionAnnotations.md)
|
590
608
|
- [AsposePdfCloud::RedactionAnnotationsResponse](docs/RedactionAnnotationsResponse.md)
|
@@ -634,6 +652,8 @@ Class | Method | HTTP request | Description
|
|
634
652
|
- [AsposePdfCloud::UnderlineAnnotationsResponse](docs/UnderlineAnnotationsResponse.md)
|
635
653
|
- [AsposePdfCloud::WordCountResponse](docs/WordCountResponse.md)
|
636
654
|
- [AsposePdfCloud::AnnotationInfo](docs/AnnotationInfo.md)
|
655
|
+
- [AsposePdfCloud::CheckBoxField](docs/CheckBoxField.md)
|
656
|
+
- [AsposePdfCloud::ChoiceField](docs/ChoiceField.md)
|
637
657
|
- [AsposePdfCloud::ImageFooter](docs/ImageFooter.md)
|
638
658
|
- [AsposePdfCloud::ImageHeader](docs/ImageHeader.md)
|
639
659
|
- [AsposePdfCloud::ImageStamp](docs/ImageStamp.md)
|
@@ -642,6 +662,7 @@ Class | Method | HTTP request | Description
|
|
642
662
|
- [AsposePdfCloud::PageNumberStamp](docs/PageNumberStamp.md)
|
643
663
|
- [AsposePdfCloud::PdfPageStamp](docs/PdfPageStamp.md)
|
644
664
|
- [AsposePdfCloud::PopupAnnotation](docs/PopupAnnotation.md)
|
665
|
+
- [AsposePdfCloud::RadioButtonOptionField](docs/RadioButtonOptionField.md)
|
645
666
|
- [AsposePdfCloud::RedactionAnnotation](docs/RedactionAnnotation.md)
|
646
667
|
- [AsposePdfCloud::ScreenAnnotation](docs/ScreenAnnotation.md)
|
647
668
|
- [AsposePdfCloud::SignatureField](docs/SignatureField.md)
|
@@ -658,6 +679,7 @@ Class | Method | HTTP request | Description
|
|
658
679
|
- [AsposePdfCloud::LineAnnotation](docs/LineAnnotation.md)
|
659
680
|
- [AsposePdfCloud::PolyAnnotation](docs/PolyAnnotation.md)
|
660
681
|
- [AsposePdfCloud::PopupAnnotationWithParent](docs/PopupAnnotationWithParent.md)
|
682
|
+
- [AsposePdfCloud::RadioButtonField](docs/RadioButtonField.md)
|
661
683
|
- [AsposePdfCloud::SoundAnnotation](docs/SoundAnnotation.md)
|
662
684
|
- [AsposePdfCloud::SquigglyAnnotation](docs/SquigglyAnnotation.md)
|
663
685
|
- [AsposePdfCloud::StampAnnotation](docs/StampAnnotation.md)
|
data/docs/BoxStyle.md
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
# AsposePdfCloud::BoxStyle
|
2
|
+
Represents an enumeration of available BoxStyle types.
|
3
|
+
|
4
|
+
## Enum
|
5
|
+
Name | Type | Value | Description
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**CIRCLE** | **String** | 'Circle' | Circle style.
|
8
|
+
**CHECK** | **String** | 'Check' | Check style.
|
9
|
+
**CROSS** | **String** | 'Cross' | Cross style.
|
10
|
+
**DIAMOND** | **String** | 'Diamond' | Diamond style.
|
11
|
+
**SQUARE** | **String** | 'Square' | Square style.
|
12
|
+
**STAR** | **String** | 'Star' | Star style.
|
13
|
+
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# AsposePdfCloud::CheckBoxField
|
2
|
+
Provides CheckBoxField.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**partial_name** | **String** | Field name. | [optional]
|
9
|
+
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
|
10
|
+
**value** | **String** | Field value. | [optional]
|
11
|
+
**page_index** | **Integer** | Page index. |
|
12
|
+
**height** | **Float** | Gets or sets height of the field. | [optional]
|
13
|
+
**width** | **Float** | Gets or sets width of the field. | [optional]
|
14
|
+
**z_index** | **Integer** | Z index. | [optional]
|
15
|
+
**is_group** | **BOOLEAN** | Is group. |
|
16
|
+
**parent** | [**FormField**](FormField.md) | Gets field parent. | [optional]
|
17
|
+
**is_shared_field** | **BOOLEAN** | Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page. | [optional]
|
18
|
+
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the field. | [optional]
|
19
|
+
**color** | [**Color**](Color.md) | Color of the annotation. | [optional]
|
20
|
+
**contents** | **String** | Get the field content. | [optional]
|
21
|
+
**margin** | [**MarginInfo**](MarginInfo.md) | Gets or sets a outer margin for paragraph (for pdf generation) | [optional]
|
22
|
+
**highlighting** | [**LinkHighlightingMode**](LinkHighlightingMode.md) | Field highlighting mode. | [optional]
|
23
|
+
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the field. | [optional]
|
24
|
+
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the field. | [optional]
|
25
|
+
**allowed_states** | **Array<String>** | Returns list of allowed states. | [optional]
|
26
|
+
**style** | [**BoxStyle**](BoxStyle.md) | Gets or sets style of check box. | [optional]
|
27
|
+
**active_state** | **String** | Gets or sets current annotation appearance state. | [optional]
|
28
|
+
**checked** | **BOOLEAN** | Gets or sets state of check box. |
|
29
|
+
**export_value** | **String** | Gets or sets export value of CheckBox field. | [optional]
|
30
|
+
|
31
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::CheckBoxFieldResponse
|
2
|
+
Represents response containing single checkbox field object
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**field** | [**CheckBoxField**](CheckBoxField.md) | Checkbox field object | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposePdfCloud::CheckBoxFields
|
2
|
+
Object representing a list of checkbox fields.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**list** | [**Array<CheckBoxField>**](CheckBoxField.md) | List of checkbox fields. | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::CheckBoxFieldsResponse
|
2
|
+
Represents response containing multiple checkbox field objects
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**fields** | [**CheckBoxFields**](CheckBoxFields.md) | Checkbox fields object | [optional]
|
10
|
+
|
11
|
+
|
data/docs/ChoiceField.md
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# AsposePdfCloud::ChoiceField
|
2
|
+
Provides Choice field.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**partial_name** | **String** | Field name. | [optional]
|
9
|
+
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
|
10
|
+
**value** | **String** | Field value. | [optional]
|
11
|
+
**page_index** | **Integer** | Page index. |
|
12
|
+
**height** | **Float** | Gets or sets height of the field. | [optional]
|
13
|
+
**width** | **Float** | Gets or sets width of the field. | [optional]
|
14
|
+
**z_index** | **Integer** | Z index. | [optional]
|
15
|
+
**is_group** | **BOOLEAN** | Is group. |
|
16
|
+
**parent** | [**FormField**](FormField.md) | Gets field parent. | [optional]
|
17
|
+
**is_shared_field** | **BOOLEAN** | Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page. | [optional]
|
18
|
+
**flags** | [**Array<AnnotationFlags>**](AnnotationFlags.md) | Gets Flags of the field. | [optional]
|
19
|
+
**color** | [**Color**](Color.md) | Color of the annotation. | [optional]
|
20
|
+
**contents** | **String** | Get the field content. | [optional]
|
21
|
+
**margin** | [**MarginInfo**](MarginInfo.md) | Gets or sets a outer margin for paragraph (for pdf generation) | [optional]
|
22
|
+
**highlighting** | [**LinkHighlightingMode**](LinkHighlightingMode.md) | Field highlighting mode. | [optional]
|
23
|
+
**horizontal_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets HorizontalAlignment of the field. | [optional]
|
24
|
+
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Gets VerticalAlignment of the field. | [optional]
|
25
|
+
**multi_select** | **BOOLEAN** | Gets or sets multiselection flag. | [optional]
|
26
|
+
|
27
|
+
|
data/docs/Option.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
# AsposePdfCloud::Option
|
2
|
+
Provides form option.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**value** | **String** | Gets or sets option export value. | [optional]
|
8
|
+
**name** | **String** | Gets or sets name of option. | [optional]
|
9
|
+
**selected** | **BOOLEAN** | Gets or sets selected status of option. Returns true if option is selected. | [optional]
|
10
|
+
**index** | **Integer** | Gets index of the option. | [optional]
|
11
|
+
|
12
|
+
|
data/docs/PdfApi.md
CHANGED
@@ -32,6 +32,7 @@ Method | HTTP request | Description
|
|
32
32
|
[**get_bookmark**](PdfApi.md#get_bookmark) | **GET** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Read document bookmark.
|
33
33
|
[**get_bookmarks**](PdfApi.md#get_bookmarks) | **GET** /pdf/\{name}/bookmarks/list/\{bookmarkPath} | Read document bookmarks node list.
|
34
34
|
[**get_caret_annotation**](PdfApi.md#get_caret_annotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID.
|
35
|
+
[**get_check_box_field**](PdfApi.md#get_check_box_field) | **GET** /pdf/\{name}/fields/checkbox/\{fieldName} | Read document checkbox field by name.
|
35
36
|
[**get_circle_annotation**](PdfApi.md#get_circle_annotation) | **GET** /pdf/\{name}/annotations/circle/\{annotationId} | Read document page circle annotation by ID.
|
36
37
|
[**get_disc_usage**](PdfApi.md#get_disc_usage) | **GET** /pdf/storage/disc | Get disc usage
|
37
38
|
[**get_document**](PdfApi.md#get_document) | **GET** /pdf/\{name} | Read common document info.
|
@@ -40,6 +41,7 @@ Method | HTTP request | Description
|
|
40
41
|
[**get_document_attachments**](PdfApi.md#get_document_attachments) | **GET** /pdf/\{name}/attachments | Read document attachments info.
|
41
42
|
[**get_document_bookmarks**](PdfApi.md#get_document_bookmarks) | **GET** /pdf/\{name}/bookmarks/tree | Read document bookmarks tree.
|
42
43
|
[**get_document_caret_annotations**](PdfApi.md#get_document_caret_annotations) | **GET** /pdf/\{name}/annotations/caret | Read document caret annotations.
|
44
|
+
[**get_document_check_box_fields**](PdfApi.md#get_document_check_box_fields) | **GET** /pdf/\{name}/fields/checkbox | Read document checkbox fields.
|
43
45
|
[**get_document_circle_annotations**](PdfApi.md#get_document_circle_annotations) | **GET** /pdf/\{name}/annotations/circle | Read document circle annotations.
|
44
46
|
[**get_document_file_attachment_annotations**](PdfApi.md#get_document_file_attachment_annotations) | **GET** /pdf/\{name}/annotations/fileattachment | Read document FileAttachment annotations.
|
45
47
|
[**get_document_free_text_annotations**](PdfApi.md#get_document_free_text_annotations) | **GET** /pdf/\{name}/annotations/freetext | Read document free text annotations.
|
@@ -53,6 +55,7 @@ Method | HTTP request | Description
|
|
53
55
|
[**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.
|
54
56
|
[**get_document_properties**](PdfApi.md#get_document_properties) | **GET** /pdf/\{name}/documentproperties | Read document properties.
|
55
57
|
[**get_document_property**](PdfApi.md#get_document_property) | **GET** /pdf/\{name}/documentproperties/\{propertyName} | Read document property by name.
|
58
|
+
[**get_document_radio_button_fields**](PdfApi.md#get_document_radio_button_fields) | **GET** /pdf/\{name}/fields/radiobutton | Read document radiobutton fields.
|
56
59
|
[**get_document_redaction_annotations**](PdfApi.md#get_document_redaction_annotations) | **GET** /pdf/\{name}/annotations/redaction | Read document redaction annotations.
|
57
60
|
[**get_document_screen_annotations**](PdfApi.md#get_document_screen_annotations) | **GET** /pdf/\{name}/annotations/screen | Read document screen annotations.
|
58
61
|
[**get_document_signature_fields**](PdfApi.md#get_document_signature_fields) | **GET** /pdf/\{name}/fields/signature | Read document signature fields.
|
@@ -99,6 +102,7 @@ Method | HTTP request | Description
|
|
99
102
|
[**get_page**](PdfApi.md#get_page) | **GET** /pdf/\{name}/pages/\{pageNumber} | Read document page info.
|
100
103
|
[**get_page_annotations**](PdfApi.md#get_page_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations | Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
|
101
104
|
[**get_page_caret_annotations**](PdfApi.md#get_page_caret_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Read document page caret annotations.
|
105
|
+
[**get_page_check_box_fields**](PdfApi.md#get_page_check_box_fields) | **GET** /pdf/\{name}/page/\{pageNumber}/fields/checkbox | Read document page checkbox fields.
|
102
106
|
[**get_page_circle_annotations**](PdfApi.md#get_page_circle_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Read document page circle annotations.
|
103
107
|
[**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.
|
104
108
|
[**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.
|
@@ -117,6 +121,7 @@ Method | HTTP request | Description
|
|
117
121
|
[**get_page_poly_line_annotations**](PdfApi.md#get_page_poly_line_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polyline | Read document page polyline annotations.
|
118
122
|
[**get_page_polygon_annotations**](PdfApi.md#get_page_polygon_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/polygon | Read document page polygon annotations.
|
119
123
|
[**get_page_popup_annotations**](PdfApi.md#get_page_popup_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/popup | Read document page popup annotations.
|
124
|
+
[**get_page_radio_button_fields**](PdfApi.md#get_page_radio_button_fields) | **GET** /pdf/\{name}/page/\{pageNumber}/fields/radiobutton | Read document page radiobutton fields.
|
120
125
|
[**get_page_redaction_annotations**](PdfApi.md#get_page_redaction_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/redaction | Read document page redaction annotations.
|
121
126
|
[**get_page_screen_annotations**](PdfApi.md#get_page_screen_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/screen | Read document page screen annotations.
|
122
127
|
[**get_page_signature_fields**](PdfApi.md#get_page_signature_fields) | **GET** /pdf/\{name}/page/\{pageNumber}/fields/signature | Read document page signature fields.
|
@@ -150,6 +155,7 @@ Method | HTTP request | Description
|
|
150
155
|
[**get_polygon_annotation**](PdfApi.md#get_polygon_annotation) | **GET** /pdf/\{name}/annotations/polygon/\{annotationId} | Read document page polygon annotation by ID.
|
151
156
|
[**get_popup_annotation**](PdfApi.md#get_popup_annotation) | **GET** /pdf/\{name}/annotations/popup/\{annotationId} | Read document page popup annotation by ID.
|
152
157
|
[**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.
|
158
|
+
[**get_radio_button_field**](PdfApi.md#get_radio_button_field) | **GET** /pdf/\{name}/fields/radiobutton/\{fieldName} | Read document RadioButton field by name.
|
153
159
|
[**get_redaction_annotation**](PdfApi.md#get_redaction_annotation) | **GET** /pdf/\{name}/annotations/redaction/\{annotationId} | Read document page redaction annotation by ID.
|
154
160
|
[**get_screen_annotation**](PdfApi.md#get_screen_annotation) | **GET** /pdf/\{name}/annotations/screen/\{annotationId} | Read document page screen annotation by ID.
|
155
161
|
[**get_screen_annotation_data**](PdfApi.md#get_screen_annotation_data) | **GET** /pdf/\{name}/annotations/screen/\{annotationId}/data | Read document page screen annotation by ID.
|
@@ -180,6 +186,7 @@ Method | HTTP request | Description
|
|
180
186
|
[**post_append_document**](PdfApi.md#post_append_document) | **POST** /pdf/\{name}/appendDocument | Append document to existing one.
|
181
187
|
[**post_bookmark**](PdfApi.md#post_bookmark) | **POST** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Add document bookmarks.
|
182
188
|
[**post_change_password_document_in_storage**](PdfApi.md#post_change_password_document_in_storage) | **POST** /pdf/\{name}/changepassword | Change document password in storage.
|
189
|
+
[**post_check_box_fields**](PdfApi.md#post_check_box_fields) | **POST** /pdf/\{name}/fields/checkbox | Add document checkbox fields.
|
183
190
|
[**post_create_field**](PdfApi.md#post_create_field) | **POST** /pdf/\{name}/fields | Create field.
|
184
191
|
[**post_decrypt_document_in_storage**](PdfApi.md#post_decrypt_document_in_storage) | **POST** /pdf/\{name}/decrypt | Decrypt document in storage.
|
185
192
|
[**post_document_image_footer**](PdfApi.md#post_document_image_footer) | **POST** /pdf/\{name}/footer/image | Add document image footer.
|
@@ -223,6 +230,7 @@ Method | HTTP request | Description
|
|
223
230
|
[**post_page_text_stamps**](PdfApi.md#post_page_text_stamps) | **POST** /pdf/\{name}/pages/\{pageNumber}/stamps/text | Add document page text stamps.
|
224
231
|
[**post_page_underline_annotations**](PdfApi.md#post_page_underline_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/underline | Add document page underline annotations.
|
225
232
|
[**post_popup_annotation**](PdfApi.md#post_popup_annotation) | **POST** /pdf/\{name}/annotations/\{annotationId}/popup | Add document popup annotations.
|
233
|
+
[**post_radio_button_fields**](PdfApi.md#post_radio_button_fields) | **POST** /pdf/\{name}/fields/radiobutton | Add document RadioButton fields.
|
226
234
|
[**post_sign_document**](PdfApi.md#post_sign_document) | **POST** /pdf/\{name}/sign | Sign document.
|
227
235
|
[**post_sign_page**](PdfApi.md#post_sign_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/sign | Sign page.
|
228
236
|
[**post_split_document**](PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts.
|
@@ -233,6 +241,7 @@ Method | HTTP request | Description
|
|
233
241
|
[**put_bookmark**](PdfApi.md#put_bookmark) | **PUT** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Update document bookmark.
|
234
242
|
[**put_caret_annotation**](PdfApi.md#put_caret_annotation) | **PUT** /pdf/\{name}/annotations/caret/\{annotationId} | Replace document caret annotation
|
235
243
|
[**put_change_password_document**](PdfApi.md#put_change_password_document) | **PUT** /pdf/changepassword | Change document password from content.
|
244
|
+
[**put_check_box_field**](PdfApi.md#put_check_box_field) | **PUT** /pdf/\{name}/fields/checkbox/\{fieldName} | Replace document checkbox field
|
236
245
|
[**put_circle_annotation**](PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation
|
237
246
|
[**put_create_document**](PdfApi.md#put_create_document) | **PUT** /pdf/\{name} | Create empty document.
|
238
247
|
[**put_decrypt_document**](PdfApi.md#put_decrypt_document) | **PUT** /pdf/decrypt | Decrypt document from content.
|
@@ -306,6 +315,7 @@ Method | HTTP request | Description
|
|
306
315
|
[**put_popup_annotation**](PdfApi.md#put_popup_annotation) | **PUT** /pdf/\{name}/annotations/popup/\{annotationId} | Replace document popup annotation
|
307
316
|
[**put_privileges**](PdfApi.md#put_privileges) | **PUT** /pdf/\{name}/privileges | Update privilege document.
|
308
317
|
[**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.
|
318
|
+
[**put_radio_button_field**](PdfApi.md#put_radio_button_field) | **PUT** /pdf/\{name}/fields/radiobutton/\{fieldName} | Replace document RadioButton field
|
309
319
|
[**put_redaction_annotation**](PdfApi.md#put_redaction_annotation) | **PUT** /pdf/\{name}/annotations/redaction/\{annotationId} | Replace document redaction annotation
|
310
320
|
[**put_replace_image**](PdfApi.md#put_replace_image) | **PUT** /pdf/\{name}/images/\{imageId} | Replace document image.
|
311
321
|
[**put_screen_annotation**](PdfApi.md#put_screen_annotation) | **PUT** /pdf/\{name}/annotations/screen/\{annotationId} | Replace document screen annotation
|
@@ -1026,6 +1036,31 @@ Name | Type | Description | Notes
|
|
1026
1036
|
|
1027
1037
|
|
1028
1038
|
|
1039
|
+
# **get_check_box_field**
|
1040
|
+
> CheckBoxFieldResponse get_check_box_field(name, field_name, opts)
|
1041
|
+
|
1042
|
+
Read document checkbox field by name.
|
1043
|
+
|
1044
|
+
### Parameters
|
1045
|
+
|
1046
|
+
Name | Type | Description | Notes
|
1047
|
+
------------- | ------------- | ------------- | -------------
|
1048
|
+
**name** | **String**| The document name. |
|
1049
|
+
**field_name** | **String**| The field name. |
|
1050
|
+
**storage** | **String**| The document storage. | [optional]
|
1051
|
+
**folder** | **String**| The document folder. | [optional]
|
1052
|
+
|
1053
|
+
### Return type
|
1054
|
+
|
1055
|
+
[**CheckBoxFieldResponse**](CheckBoxFieldResponse.md)
|
1056
|
+
|
1057
|
+
### HTTP request headers
|
1058
|
+
|
1059
|
+
- **Content-Type**: application/json
|
1060
|
+
- **Accept**: application/json
|
1061
|
+
|
1062
|
+
|
1063
|
+
|
1029
1064
|
# **get_circle_annotation**
|
1030
1065
|
> CircleAnnotationResponse get_circle_annotation(name, annotation_id, opts)
|
1031
1066
|
|
@@ -1218,6 +1253,30 @@ Name | Type | Description | Notes
|
|
1218
1253
|
|
1219
1254
|
|
1220
1255
|
|
1256
|
+
# **get_document_check_box_fields**
|
1257
|
+
> CheckBoxFieldsResponse get_document_check_box_fields(name, opts)
|
1258
|
+
|
1259
|
+
Read document checkbox fields.
|
1260
|
+
|
1261
|
+
### Parameters
|
1262
|
+
|
1263
|
+
Name | Type | Description | Notes
|
1264
|
+
------------- | ------------- | ------------- | -------------
|
1265
|
+
**name** | **String**| The document name. |
|
1266
|
+
**storage** | **String**| The document storage. | [optional]
|
1267
|
+
**folder** | **String**| The document folder. | [optional]
|
1268
|
+
|
1269
|
+
### Return type
|
1270
|
+
|
1271
|
+
[**CheckBoxFieldsResponse**](CheckBoxFieldsResponse.md)
|
1272
|
+
|
1273
|
+
### HTTP request headers
|
1274
|
+
|
1275
|
+
- **Content-Type**: application/json
|
1276
|
+
- **Accept**: application/json
|
1277
|
+
|
1278
|
+
|
1279
|
+
|
1221
1280
|
# **get_document_circle_annotations**
|
1222
1281
|
> CircleAnnotationsResponse get_document_circle_annotations(name, opts)
|
1223
1282
|
|
@@ -1532,6 +1591,30 @@ Name | Type | Description | Notes
|
|
1532
1591
|
|
1533
1592
|
|
1534
1593
|
|
1594
|
+
# **get_document_radio_button_fields**
|
1595
|
+
> RadioButtonFieldsResponse get_document_radio_button_fields(name, opts)
|
1596
|
+
|
1597
|
+
Read document radiobutton fields.
|
1598
|
+
|
1599
|
+
### Parameters
|
1600
|
+
|
1601
|
+
Name | Type | Description | Notes
|
1602
|
+
------------- | ------------- | ------------- | -------------
|
1603
|
+
**name** | **String**| The document name. |
|
1604
|
+
**storage** | **String**| The document storage. | [optional]
|
1605
|
+
**folder** | **String**| The document folder. | [optional]
|
1606
|
+
|
1607
|
+
### Return type
|
1608
|
+
|
1609
|
+
[**RadioButtonFieldsResponse**](RadioButtonFieldsResponse.md)
|
1610
|
+
|
1611
|
+
### HTTP request headers
|
1612
|
+
|
1613
|
+
- **Content-Type**: application/json
|
1614
|
+
- **Accept**: application/json
|
1615
|
+
|
1616
|
+
|
1617
|
+
|
1535
1618
|
# **get_document_redaction_annotations**
|
1536
1619
|
> RedactionAnnotationsResponse get_document_redaction_annotations(name, opts)
|
1537
1620
|
|
@@ -2667,6 +2750,31 @@ Name | Type | Description | Notes
|
|
2667
2750
|
|
2668
2751
|
|
2669
2752
|
|
2753
|
+
# **get_page_check_box_fields**
|
2754
|
+
> CheckBoxFieldsResponse get_page_check_box_fields(name, page_number, opts)
|
2755
|
+
|
2756
|
+
Read document page checkbox fields.
|
2757
|
+
|
2758
|
+
### Parameters
|
2759
|
+
|
2760
|
+
Name | Type | Description | Notes
|
2761
|
+
------------- | ------------- | ------------- | -------------
|
2762
|
+
**name** | **String**| The document name. |
|
2763
|
+
**page_number** | **Integer**| The page number. |
|
2764
|
+
**storage** | **String**| The document storage. | [optional]
|
2765
|
+
**folder** | **String**| The document folder. | [optional]
|
2766
|
+
|
2767
|
+
### Return type
|
2768
|
+
|
2769
|
+
[**CheckBoxFieldsResponse**](CheckBoxFieldsResponse.md)
|
2770
|
+
|
2771
|
+
### HTTP request headers
|
2772
|
+
|
2773
|
+
- **Content-Type**: application/json
|
2774
|
+
- **Accept**: application/json
|
2775
|
+
|
2776
|
+
|
2777
|
+
|
2670
2778
|
# **get_page_circle_annotations**
|
2671
2779
|
> CircleAnnotationsResponse get_page_circle_annotations(name, page_number, opts)
|
2672
2780
|
|
@@ -3130,6 +3238,31 @@ Name | Type | Description | Notes
|
|
3130
3238
|
|
3131
3239
|
|
3132
3240
|
|
3241
|
+
# **get_page_radio_button_fields**
|
3242
|
+
> RadioButtonFieldsResponse get_page_radio_button_fields(name, page_number, opts)
|
3243
|
+
|
3244
|
+
Read document page radiobutton fields.
|
3245
|
+
|
3246
|
+
### Parameters
|
3247
|
+
|
3248
|
+
Name | Type | Description | Notes
|
3249
|
+
------------- | ------------- | ------------- | -------------
|
3250
|
+
**name** | **String**| The document name. |
|
3251
|
+
**page_number** | **Integer**| The page number. |
|
3252
|
+
**storage** | **String**| The document storage. | [optional]
|
3253
|
+
**folder** | **String**| The document folder. | [optional]
|
3254
|
+
|
3255
|
+
### Return type
|
3256
|
+
|
3257
|
+
[**RadioButtonFieldsResponse**](RadioButtonFieldsResponse.md)
|
3258
|
+
|
3259
|
+
### HTTP request headers
|
3260
|
+
|
3261
|
+
- **Content-Type**: application/json
|
3262
|
+
- **Accept**: application/json
|
3263
|
+
|
3264
|
+
|
3265
|
+
|
3133
3266
|
# **get_page_redaction_annotations**
|
3134
3267
|
> RedactionAnnotationsResponse get_page_redaction_annotations(name, page_number, opts)
|
3135
3268
|
|
@@ -4009,6 +4142,31 @@ Name | Type | Description | Notes
|
|
4009
4142
|
|
4010
4143
|
|
4011
4144
|
|
4145
|
+
# **get_radio_button_field**
|
4146
|
+
> RadioButtonFieldResponse get_radio_button_field(name, field_name, opts)
|
4147
|
+
|
4148
|
+
Read document RadioButton field by name.
|
4149
|
+
|
4150
|
+
### Parameters
|
4151
|
+
|
4152
|
+
Name | Type | Description | Notes
|
4153
|
+
------------- | ------------- | ------------- | -------------
|
4154
|
+
**name** | **String**| The document name. |
|
4155
|
+
**field_name** | **String**| The field name. |
|
4156
|
+
**storage** | **String**| The document storage. | [optional]
|
4157
|
+
**folder** | **String**| The document folder. | [optional]
|
4158
|
+
|
4159
|
+
### Return type
|
4160
|
+
|
4161
|
+
[**RadioButtonFieldResponse**](RadioButtonFieldResponse.md)
|
4162
|
+
|
4163
|
+
### HTTP request headers
|
4164
|
+
|
4165
|
+
- **Content-Type**: application/json
|
4166
|
+
- **Accept**: application/json
|
4167
|
+
|
4168
|
+
|
4169
|
+
|
4012
4170
|
# **get_redaction_annotation**
|
4013
4171
|
> RedactionAnnotationResponse get_redaction_annotation(name, annotation_id, opts)
|
4014
4172
|
|
@@ -4774,6 +4932,31 @@ Name | Type | Description | Notes
|
|
4774
4932
|
|
4775
4933
|
|
4776
4934
|
|
4935
|
+
# **post_check_box_fields**
|
4936
|
+
> AsposeResponse post_check_box_fields(name, fields, opts)
|
4937
|
+
|
4938
|
+
Add document checkbox fields.
|
4939
|
+
|
4940
|
+
### Parameters
|
4941
|
+
|
4942
|
+
Name | Type | Description | Notes
|
4943
|
+
------------- | ------------- | ------------- | -------------
|
4944
|
+
**name** | **String**| The document name. |
|
4945
|
+
**fields** | [**Array<CheckBoxField>**](CheckBoxField.md)| The array of field. |
|
4946
|
+
**storage** | **String**| The document storage. | [optional]
|
4947
|
+
**folder** | **String**| The document folder. | [optional]
|
4948
|
+
|
4949
|
+
### Return type
|
4950
|
+
|
4951
|
+
[**AsposeResponse**](AsposeResponse.md)
|
4952
|
+
|
4953
|
+
### HTTP request headers
|
4954
|
+
|
4955
|
+
- **Content-Type**: application/json
|
4956
|
+
- **Accept**: application/json
|
4957
|
+
|
4958
|
+
|
4959
|
+
|
4777
4960
|
# **post_create_field**
|
4778
4961
|
> AsposeResponse post_create_field(name, page, field, opts)
|
4779
4962
|
|
@@ -5901,6 +6084,31 @@ Name | Type | Description | Notes
|
|
5901
6084
|
|
5902
6085
|
|
5903
6086
|
|
6087
|
+
# **post_radio_button_fields**
|
6088
|
+
> AsposeResponse post_radio_button_fields(name, fields, opts)
|
6089
|
+
|
6090
|
+
Add document RadioButton fields.
|
6091
|
+
|
6092
|
+
### Parameters
|
6093
|
+
|
6094
|
+
Name | Type | Description | Notes
|
6095
|
+
------------- | ------------- | ------------- | -------------
|
6096
|
+
**name** | **String**| The document name. |
|
6097
|
+
**fields** | [**Array<RadioButtonField>**](RadioButtonField.md)| The array of field. |
|
6098
|
+
**storage** | **String**| The document storage. | [optional]
|
6099
|
+
**folder** | **String**| The document folder. | [optional]
|
6100
|
+
|
6101
|
+
### Return type
|
6102
|
+
|
6103
|
+
[**AsposeResponse**](AsposeResponse.md)
|
6104
|
+
|
6105
|
+
### HTTP request headers
|
6106
|
+
|
6107
|
+
- **Content-Type**: application/json
|
6108
|
+
- **Accept**: application/json
|
6109
|
+
|
6110
|
+
|
6111
|
+
|
5904
6112
|
# **post_sign_document**
|
5905
6113
|
> AsposeResponse post_sign_document(name, sign, opts)
|
5906
6114
|
|
@@ -6160,6 +6368,32 @@ Name | Type | Description | Notes
|
|
6160
6368
|
|
6161
6369
|
|
6162
6370
|
|
6371
|
+
# **put_check_box_field**
|
6372
|
+
> CheckBoxFieldResponse put_check_box_field(name, field_name, field, opts)
|
6373
|
+
|
6374
|
+
Replace document checkbox field
|
6375
|
+
|
6376
|
+
### Parameters
|
6377
|
+
|
6378
|
+
Name | Type | Description | Notes
|
6379
|
+
------------- | ------------- | ------------- | -------------
|
6380
|
+
**name** | **String**| The document name. |
|
6381
|
+
**field_name** | **String**| The field name. |
|
6382
|
+
**field** | [**CheckBoxField**](CheckBoxField.md)| The field. |
|
6383
|
+
**storage** | **String**| The document storage. | [optional]
|
6384
|
+
**folder** | **String**| The document folder. | [optional]
|
6385
|
+
|
6386
|
+
### Return type
|
6387
|
+
|
6388
|
+
[**CheckBoxFieldResponse**](CheckBoxFieldResponse.md)
|
6389
|
+
|
6390
|
+
### HTTP request headers
|
6391
|
+
|
6392
|
+
- **Content-Type**: application/json
|
6393
|
+
- **Accept**: application/json
|
6394
|
+
|
6395
|
+
|
6396
|
+
|
6163
6397
|
# **put_circle_annotation**
|
6164
6398
|
> CircleAnnotationResponse put_circle_annotation(name, annotation_id, annotation, opts)
|
6165
6399
|
|
@@ -8165,6 +8399,32 @@ Name | Type | Description | Notes
|
|
8165
8399
|
|
8166
8400
|
|
8167
8401
|
|
8402
|
+
# **put_radio_button_field**
|
8403
|
+
> RadioButtonFieldResponse put_radio_button_field(name, field_name, field, opts)
|
8404
|
+
|
8405
|
+
Replace document RadioButton field
|
8406
|
+
|
8407
|
+
### Parameters
|
8408
|
+
|
8409
|
+
Name | Type | Description | Notes
|
8410
|
+
------------- | ------------- | ------------- | -------------
|
8411
|
+
**name** | **String**| The document name. |
|
8412
|
+
**field_name** | **String**| The field name. |
|
8413
|
+
**field** | [**RadioButtonField**](RadioButtonField.md)| The field. |
|
8414
|
+
**storage** | **String**| The document storage. | [optional]
|
8415
|
+
**folder** | **String**| The document folder. | [optional]
|
8416
|
+
|
8417
|
+
### Return type
|
8418
|
+
|
8419
|
+
[**RadioButtonFieldResponse**](RadioButtonFieldResponse.md)
|
8420
|
+
|
8421
|
+
### HTTP request headers
|
8422
|
+
|
8423
|
+
- **Content-Type**: application/json
|
8424
|
+
- **Accept**: application/json
|
8425
|
+
|
8426
|
+
|
8427
|
+
|
8168
8428
|
# **put_redaction_annotation**
|
8169
8429
|
> RedactionAnnotationResponse put_redaction_annotation(name, annotation_id, annotation, opts)
|
8170
8430
|
|