aspose_pdf_cloud 19.7.0 → 19.8.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 +18 -4
- data/docs/DocMDPAccessPermissionType.md +16 -0
- data/docs/FormField.md +26 -0
- data/docs/PdfApi.md +155 -0
- data/docs/Signature.md +3 -0
- data/docs/SignatureCustomAppearance.md +20 -0
- data/docs/SignatureField.md +27 -0
- data/docs/SignatureFieldResponse.md +11 -0
- data/docs/SignatureFields.md +10 -0
- data/docs/SignatureFieldsResponse.md +11 -0
- data/docs/TimestampSettings.md +10 -0
- data/lib/aspose_pdf_cloud.rb +8 -0
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +479 -8
- data/lib/aspose_pdf_cloud/models/doc_mdp_access_permission_type.rb +45 -0
- data/lib/aspose_pdf_cloud/models/form_field.rb +383 -0
- data/lib/aspose_pdf_cloud/models/signature.rb +34 -4
- data/lib/aspose_pdf_cloud/models/signature_custom_appearance.rb +329 -0
- data/lib/aspose_pdf_cloud/models/signature_field.rb +393 -0
- data/lib/aspose_pdf_cloud/models/signature_field_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/signature_fields.rb +213 -0
- data/lib/aspose_pdf_cloud/models/signature_fields_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/timestamp_settings.rb +209 -0
- data/lib/aspose_pdf_cloud/version.rb +1 -1
- data/test/pdf_tests.rb +96 -0
- data/test_data/33226.p12 +0 -0
- data/test_data/adbe.x509.rsa_sha1.valid.pdf +0 -0
- data/test_data/mixed.md +14 -0
- metadata +21 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 37a570ea03a80e0e0d6a513bf07f9e36d4dd66115eb3955dfd8676e48876fc26
|
4
|
+
data.tar.gz: 96ba1ceeb7bc7f299a0d73d40f82b32a232ebbc341bb902e26596fb598816bf2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c25ef3bd5dfddc7622c679e1b46e78e0cf9c8f0c66012d55d37363bf599629afa4803b93d2e80f534929f2f0cee67811a785653a31ceb0824d5e39d5967ebf4b
|
7
|
+
data.tar.gz: 415db71629009a2fdc8848aa02d0f976e6cf3d184a3e1fa5bdcd35a3f06478e92a3d1d51416c8f6c10095266e3bed3e5f44b335926d38cb8ce1dc947ed1b8e38
|
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.8.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.8.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.8.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.8.0'
|
34
34
|
|
35
35
|
### Install from Git
|
36
36
|
|
@@ -140,6 +140,7 @@ Class | Method | HTTP request | Description
|
|
140
140
|
*AsposePdfCloud::PdfApi* | [**get_document_property**](docs/PdfApi.md#get_document_property) | **GET** /pdf/\{name}/documentproperties/\{propertyName} | Read document property by name.
|
141
141
|
*AsposePdfCloud::PdfApi* | [**get_document_redaction_annotations**](docs/PdfApi.md#get_document_redaction_annotations) | **GET** /pdf/\{name}/annotations/redaction | Read document redaction annotations.
|
142
142
|
*AsposePdfCloud::PdfApi* | [**get_document_screen_annotations**](docs/PdfApi.md#get_document_screen_annotations) | **GET** /pdf/\{name}/annotations/screen | Read document screen annotations.
|
143
|
+
*AsposePdfCloud::PdfApi* | [**get_document_signature_fields**](docs/PdfApi.md#get_document_signature_fields) | **GET** /pdf/\{name}/fields/signature | Read document signature fields.
|
143
144
|
*AsposePdfCloud::PdfApi* | [**get_document_sound_annotations**](docs/PdfApi.md#get_document_sound_annotations) | **GET** /pdf/\{name}/annotations/sound | Read document sound annotations.
|
144
145
|
*AsposePdfCloud::PdfApi* | [**get_document_square_annotations**](docs/PdfApi.md#get_document_square_annotations) | **GET** /pdf/\{name}/annotations/square | Read document square annotations.
|
145
146
|
*AsposePdfCloud::PdfApi* | [**get_document_squiggly_annotations**](docs/PdfApi.md#get_document_squiggly_annotations) | **GET** /pdf/\{name}/annotations/squiggly | Read document squiggly annotations.
|
@@ -176,6 +177,7 @@ Class | Method | HTTP request | Description
|
|
176
177
|
*AsposePdfCloud::PdfApi* | [**get_la_te_x_in_storage_to_pdf**](docs/PdfApi.md#get_la_te_x_in_storage_to_pdf) | **GET** /pdf/create/latex | Convert LaTeX file (located on storage) to PDF format and return resulting file in response.
|
177
178
|
*AsposePdfCloud::PdfApi* | [**get_line_annotation**](docs/PdfApi.md#get_line_annotation) | **GET** /pdf/\{name}/annotations/line/\{annotationId} | Read document page line annotation by ID.
|
178
179
|
*AsposePdfCloud::PdfApi* | [**get_link_annotation**](docs/PdfApi.md#get_link_annotation) | **GET** /pdf/\{name}/links/\{linkId} | Read document link annotation by ID.
|
180
|
+
*AsposePdfCloud::PdfApi* | [**get_markdown_in_storage_to_pdf**](docs/PdfApi.md#get_markdown_in_storage_to_pdf) | **GET** /pdf/create/markdown | Convert MD file (located on storage) to PDF format and return resulting file in response.
|
179
181
|
*AsposePdfCloud::PdfApi* | [**get_mht_in_storage_to_pdf**](docs/PdfApi.md#get_mht_in_storage_to_pdf) | **GET** /pdf/create/mht | Convert MHT file (located on storage) to PDF format and return resulting file in response.
|
180
182
|
*AsposePdfCloud::PdfApi* | [**get_movie_annotation**](docs/PdfApi.md#get_movie_annotation) | **GET** /pdf/\{name}/annotations/movie/\{annotationId} | Read document page movie annotation by ID.
|
181
183
|
*AsposePdfCloud::PdfApi* | [**get_page**](docs/PdfApi.md#get_page) | **GET** /pdf/\{name}/pages/\{pageNumber} | Read document page info.
|
@@ -201,6 +203,7 @@ Class | Method | HTTP request | Description
|
|
201
203
|
*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.
|
202
204
|
*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.
|
203
205
|
*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.
|
206
|
+
*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.
|
204
207
|
*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.
|
205
208
|
*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.
|
206
209
|
*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.
|
@@ -233,6 +236,7 @@ Class | Method | HTTP request | Description
|
|
233
236
|
*AsposePdfCloud::PdfApi* | [**get_redaction_annotation**](docs/PdfApi.md#get_redaction_annotation) | **GET** /pdf/\{name}/annotations/redaction/\{annotationId} | Read document page redaction annotation by ID.
|
234
237
|
*AsposePdfCloud::PdfApi* | [**get_screen_annotation**](docs/PdfApi.md#get_screen_annotation) | **GET** /pdf/\{name}/annotations/screen/\{annotationId} | Read document page screen annotation by ID.
|
235
238
|
*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.
|
239
|
+
*AsposePdfCloud::PdfApi* | [**get_signature_field**](docs/PdfApi.md#get_signature_field) | **GET** /pdf/\{name}/fields/signature/\{fieldName} | Read document signature field by name.
|
236
240
|
*AsposePdfCloud::PdfApi* | [**get_sound_annotation**](docs/PdfApi.md#get_sound_annotation) | **GET** /pdf/\{name}/annotations/sound/\{annotationId} | Read document page sound annotation by ID.
|
237
241
|
*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.
|
238
242
|
*AsposePdfCloud::PdfApi* | [**get_square_annotation**](docs/PdfApi.md#get_square_annotation) | **GET** /pdf/\{name}/annotations/square/\{annotationId} | Read document page square annotation by ID.
|
@@ -275,6 +279,7 @@ Class | Method | HTTP request | Description
|
|
275
279
|
*AsposePdfCloud::PdfApi* | [**post_move_page**](docs/PdfApi.md#post_move_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/movePage | Move page to new position.
|
276
280
|
*AsposePdfCloud::PdfApi* | [**post_optimize_document**](docs/PdfApi.md#post_optimize_document) | **POST** /pdf/\{name}/optimize | Optimize document.
|
277
281
|
*AsposePdfCloud::PdfApi* | [**post_page_caret_annotations**](docs/PdfApi.md#post_page_caret_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Add document page caret annotations.
|
282
|
+
*AsposePdfCloud::PdfApi* | [**post_page_certify**](docs/PdfApi.md#post_page_certify) | **POST** /pdf/\{name}/pages/\{pageNumber}/certify | Certify document page.
|
278
283
|
*AsposePdfCloud::PdfApi* | [**post_page_circle_annotations**](docs/PdfApi.md#post_page_circle_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Add document page circle annotations.
|
279
284
|
*AsposePdfCloud::PdfApi* | [**post_page_file_attachment_annotations**](docs/PdfApi.md#post_page_file_attachment_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/fileattachment | Add document page FileAttachment annotations.
|
280
285
|
*AsposePdfCloud::PdfApi* | [**post_page_free_text_annotations**](docs/PdfApi.md#post_page_free_text_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/freetext | Add document page free text annotations.
|
@@ -339,6 +344,7 @@ Class | Method | HTTP request | Description
|
|
339
344
|
*AsposePdfCloud::PdfApi* | [**put_la_te_x_in_storage_to_pdf**](docs/PdfApi.md#put_la_te_x_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/latex | Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage.
|
340
345
|
*AsposePdfCloud::PdfApi* | [**put_line_annotation**](docs/PdfApi.md#put_line_annotation) | **PUT** /pdf/\{name}/annotations/line/\{annotationId} | Replace document line annotation
|
341
346
|
*AsposePdfCloud::PdfApi* | [**put_link_annotation**](docs/PdfApi.md#put_link_annotation) | **PUT** /pdf/\{name}/links/\{linkId} | Replace document page link annotations
|
347
|
+
*AsposePdfCloud::PdfApi* | [**put_markdown_in_storage_to_pdf**](docs/PdfApi.md#put_markdown_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/markdown | Convert MD file (located on storage) to PDF format and upload resulting file to storage.
|
342
348
|
*AsposePdfCloud::PdfApi* | [**put_merge_documents**](docs/PdfApi.md#put_merge_documents) | **PUT** /pdf/\{name}/merge | Merge a list of documents.
|
343
349
|
*AsposePdfCloud::PdfApi* | [**put_mht_in_storage_to_pdf**](docs/PdfApi.md#put_mht_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/mht | Convert MHT file (located on storage) to PDF format and upload resulting file to storage.
|
344
350
|
*AsposePdfCloud::PdfApi* | [**put_movie_annotation**](docs/PdfApi.md#put_movie_annotation) | **PUT** /pdf/\{name}/annotations/movie/\{annotationId} | Replace document movie annotation
|
@@ -431,6 +437,7 @@ Class | Method | HTTP request | Description
|
|
431
437
|
- [AsposePdfCloud::CryptoAlgorithm](docs/CryptoAlgorithm.md)
|
432
438
|
- [AsposePdfCloud::DiscUsage](docs/DiscUsage.md)
|
433
439
|
- [AsposePdfCloud::DocFormat](docs/DocFormat.md)
|
440
|
+
- [AsposePdfCloud::DocMDPAccessPermissionType](docs/DocMDPAccessPermissionType.md)
|
434
441
|
- [AsposePdfCloud::DocRecognitionMode](docs/DocRecognitionMode.md)
|
435
442
|
- [AsposePdfCloud::DocumentPrivilege](docs/DocumentPrivilege.md)
|
436
443
|
- [AsposePdfCloud::EpubRecognitionMode](docs/EpubRecognitionMode.md)
|
@@ -481,6 +488,7 @@ Class | Method | HTTP request | Description
|
|
481
488
|
- [AsposePdfCloud::Segment](docs/Segment.md)
|
482
489
|
- [AsposePdfCloud::ShapeType](docs/ShapeType.md)
|
483
490
|
- [AsposePdfCloud::Signature](docs/Signature.md)
|
491
|
+
- [AsposePdfCloud::SignatureCustomAppearance](docs/SignatureCustomAppearance.md)
|
484
492
|
- [AsposePdfCloud::SignatureType](docs/SignatureType.md)
|
485
493
|
- [AsposePdfCloud::SoundEncoding](docs/SoundEncoding.md)
|
486
494
|
- [AsposePdfCloud::SoundIcon](docs/SoundIcon.md)
|
@@ -500,6 +508,7 @@ Class | Method | HTTP request | Description
|
|
500
508
|
- [AsposePdfCloud::TextReplaceListRequest](docs/TextReplaceListRequest.md)
|
501
509
|
- [AsposePdfCloud::TextState](docs/TextState.md)
|
502
510
|
- [AsposePdfCloud::TextStyle](docs/TextStyle.md)
|
511
|
+
- [AsposePdfCloud::TimestampSettings](docs/TimestampSettings.md)
|
503
512
|
- [AsposePdfCloud::VerticalAlignment](docs/VerticalAlignment.md)
|
504
513
|
- [AsposePdfCloud::WordCount](docs/WordCount.md)
|
505
514
|
- [AsposePdfCloud::WrapMode](docs/WrapMode.md)
|
@@ -536,6 +545,7 @@ Class | Method | HTTP request | Description
|
|
536
545
|
- [AsposePdfCloud::FileAttachmentAnnotations](docs/FileAttachmentAnnotations.md)
|
537
546
|
- [AsposePdfCloud::FileAttachmentAnnotationsResponse](docs/FileAttachmentAnnotationsResponse.md)
|
538
547
|
- [AsposePdfCloud::FileVersion](docs/FileVersion.md)
|
548
|
+
- [AsposePdfCloud::FormField](docs/FormField.md)
|
539
549
|
- [AsposePdfCloud::FreeTextAnnotationResponse](docs/FreeTextAnnotationResponse.md)
|
540
550
|
- [AsposePdfCloud::FreeTextAnnotations](docs/FreeTextAnnotations.md)
|
541
551
|
- [AsposePdfCloud::FreeTextAnnotationsResponse](docs/FreeTextAnnotationsResponse.md)
|
@@ -576,6 +586,9 @@ Class | Method | HTTP request | Description
|
|
576
586
|
- [AsposePdfCloud::ScreenAnnotationResponse](docs/ScreenAnnotationResponse.md)
|
577
587
|
- [AsposePdfCloud::ScreenAnnotations](docs/ScreenAnnotations.md)
|
578
588
|
- [AsposePdfCloud::ScreenAnnotationsResponse](docs/ScreenAnnotationsResponse.md)
|
589
|
+
- [AsposePdfCloud::SignatureFieldResponse](docs/SignatureFieldResponse.md)
|
590
|
+
- [AsposePdfCloud::SignatureFields](docs/SignatureFields.md)
|
591
|
+
- [AsposePdfCloud::SignatureFieldsResponse](docs/SignatureFieldsResponse.md)
|
579
592
|
- [AsposePdfCloud::SignatureVerifyResponse](docs/SignatureVerifyResponse.md)
|
580
593
|
- [AsposePdfCloud::SoundAnnotationResponse](docs/SoundAnnotationResponse.md)
|
581
594
|
- [AsposePdfCloud::SoundAnnotations](docs/SoundAnnotations.md)
|
@@ -623,6 +636,7 @@ Class | Method | HTTP request | Description
|
|
623
636
|
- [AsposePdfCloud::PopupAnnotation](docs/PopupAnnotation.md)
|
624
637
|
- [AsposePdfCloud::RedactionAnnotation](docs/RedactionAnnotation.md)
|
625
638
|
- [AsposePdfCloud::ScreenAnnotation](docs/ScreenAnnotation.md)
|
639
|
+
- [AsposePdfCloud::SignatureField](docs/SignatureField.md)
|
626
640
|
- [AsposePdfCloud::TextFooter](docs/TextFooter.md)
|
627
641
|
- [AsposePdfCloud::TextHeader](docs/TextHeader.md)
|
628
642
|
- [AsposePdfCloud::TextStamp](docs/TextStamp.md)
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# AsposePdfCloud::DocMDPAccessPermissionType
|
2
|
+
The access permissions granted for this document.
|
3
|
+
Valid values are:
|
4
|
+
1 - No changes to the document are permitted; any change to the document invalidates the signature.
|
5
|
+
2 - Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature.
|
6
|
+
3 - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature.
|
7
|
+
|
8
|
+
## Enum
|
9
|
+
Name | Type | Value | Description
|
10
|
+
------------ | ------------- | ------------- | -------------
|
11
|
+
**NO_CHANGES** | **String** | 'NoChanges' | No changes to the document are permitted; any change to the document invalidates the signature.
|
12
|
+
**FILLING_IN_FORMS** | **String** | 'FillingInForms' | Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature.
|
13
|
+
**ANNOTATION_MODIFICATION** | **String** | 'AnnotationModification' | Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature.
|
14
|
+
|
15
|
+
|
16
|
+
|
data/docs/FormField.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# AsposePdfCloud::FormField
|
2
|
+
Provides form 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
|
+
|
26
|
+
|
data/docs/PdfApi.md
CHANGED
@@ -55,6 +55,7 @@ Method | HTTP request | Description
|
|
55
55
|
[**get_document_property**](PdfApi.md#get_document_property) | **GET** /pdf/\{name}/documentproperties/\{propertyName} | Read document property by name.
|
56
56
|
[**get_document_redaction_annotations**](PdfApi.md#get_document_redaction_annotations) | **GET** /pdf/\{name}/annotations/redaction | Read document redaction annotations.
|
57
57
|
[**get_document_screen_annotations**](PdfApi.md#get_document_screen_annotations) | **GET** /pdf/\{name}/annotations/screen | Read document screen annotations.
|
58
|
+
[**get_document_signature_fields**](PdfApi.md#get_document_signature_fields) | **GET** /pdf/\{name}/fields/signature | Read document signature fields.
|
58
59
|
[**get_document_sound_annotations**](PdfApi.md#get_document_sound_annotations) | **GET** /pdf/\{name}/annotations/sound | Read document sound annotations.
|
59
60
|
[**get_document_square_annotations**](PdfApi.md#get_document_square_annotations) | **GET** /pdf/\{name}/annotations/square | Read document square annotations.
|
60
61
|
[**get_document_squiggly_annotations**](PdfApi.md#get_document_squiggly_annotations) | **GET** /pdf/\{name}/annotations/squiggly | Read document squiggly annotations.
|
@@ -91,6 +92,7 @@ Method | HTTP request | Description
|
|
91
92
|
[**get_la_te_x_in_storage_to_pdf**](PdfApi.md#get_la_te_x_in_storage_to_pdf) | **GET** /pdf/create/latex | Convert LaTeX file (located on storage) to PDF format and return resulting file in response.
|
92
93
|
[**get_line_annotation**](PdfApi.md#get_line_annotation) | **GET** /pdf/\{name}/annotations/line/\{annotationId} | Read document page line annotation by ID.
|
93
94
|
[**get_link_annotation**](PdfApi.md#get_link_annotation) | **GET** /pdf/\{name}/links/\{linkId} | Read document link annotation by ID.
|
95
|
+
[**get_markdown_in_storage_to_pdf**](PdfApi.md#get_markdown_in_storage_to_pdf) | **GET** /pdf/create/markdown | Convert MD file (located on storage) to PDF format and return resulting file in response.
|
94
96
|
[**get_mht_in_storage_to_pdf**](PdfApi.md#get_mht_in_storage_to_pdf) | **GET** /pdf/create/mht | Convert MHT file (located on storage) to PDF format and return resulting file in response.
|
95
97
|
[**get_movie_annotation**](PdfApi.md#get_movie_annotation) | **GET** /pdf/\{name}/annotations/movie/\{annotationId} | Read document page movie annotation by ID.
|
96
98
|
[**get_page**](PdfApi.md#get_page) | **GET** /pdf/\{name}/pages/\{pageNumber} | Read document page info.
|
@@ -116,6 +118,7 @@ Method | HTTP request | Description
|
|
116
118
|
[**get_page_popup_annotations**](PdfApi.md#get_page_popup_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/popup | Read document page popup annotations.
|
117
119
|
[**get_page_redaction_annotations**](PdfApi.md#get_page_redaction_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/redaction | Read document page redaction annotations.
|
118
120
|
[**get_page_screen_annotations**](PdfApi.md#get_page_screen_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/screen | Read document page screen annotations.
|
121
|
+
[**get_page_signature_fields**](PdfApi.md#get_page_signature_fields) | **GET** /pdf/\{name}/page/\{pageNumber}/fields/signature | Read document page signature fields.
|
119
122
|
[**get_page_sound_annotations**](PdfApi.md#get_page_sound_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/sound | Read document page sound annotations.
|
120
123
|
[**get_page_square_annotations**](PdfApi.md#get_page_square_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/square | Read document page square annotations.
|
121
124
|
[**get_page_squiggly_annotations**](PdfApi.md#get_page_squiggly_annotations) | **GET** /pdf/\{name}/pages/\{pageNumber}/annotations/squiggly | Read document page squiggly annotations.
|
@@ -148,6 +151,7 @@ Method | HTTP request | Description
|
|
148
151
|
[**get_redaction_annotation**](PdfApi.md#get_redaction_annotation) | **GET** /pdf/\{name}/annotations/redaction/\{annotationId} | Read document page redaction annotation by ID.
|
149
152
|
[**get_screen_annotation**](PdfApi.md#get_screen_annotation) | **GET** /pdf/\{name}/annotations/screen/\{annotationId} | Read document page screen annotation by ID.
|
150
153
|
[**get_screen_annotation_data**](PdfApi.md#get_screen_annotation_data) | **GET** /pdf/\{name}/annotations/screen/\{annotationId}/data | Read document page screen annotation by ID.
|
154
|
+
[**get_signature_field**](PdfApi.md#get_signature_field) | **GET** /pdf/\{name}/fields/signature/\{fieldName} | Read document signature field by name.
|
151
155
|
[**get_sound_annotation**](PdfApi.md#get_sound_annotation) | **GET** /pdf/\{name}/annotations/sound/\{annotationId} | Read document page sound annotation by ID.
|
152
156
|
[**get_sound_annotation_data**](PdfApi.md#get_sound_annotation_data) | **GET** /pdf/\{name}/annotations/sound/\{annotationId}/data | Read document page sound annotation by ID.
|
153
157
|
[**get_square_annotation**](PdfApi.md#get_square_annotation) | **GET** /pdf/\{name}/annotations/square/\{annotationId} | Read document page square annotation by ID.
|
@@ -190,6 +194,7 @@ Method | HTTP request | Description
|
|
190
194
|
[**post_move_page**](PdfApi.md#post_move_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/movePage | Move page to new position.
|
191
195
|
[**post_optimize_document**](PdfApi.md#post_optimize_document) | **POST** /pdf/\{name}/optimize | Optimize document.
|
192
196
|
[**post_page_caret_annotations**](PdfApi.md#post_page_caret_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Add document page caret annotations.
|
197
|
+
[**post_page_certify**](PdfApi.md#post_page_certify) | **POST** /pdf/\{name}/pages/\{pageNumber}/certify | Certify document page.
|
193
198
|
[**post_page_circle_annotations**](PdfApi.md#post_page_circle_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Add document page circle annotations.
|
194
199
|
[**post_page_file_attachment_annotations**](PdfApi.md#post_page_file_attachment_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/fileattachment | Add document page FileAttachment annotations.
|
195
200
|
[**post_page_free_text_annotations**](PdfApi.md#post_page_free_text_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/freetext | Add document page free text annotations.
|
@@ -254,6 +259,7 @@ Method | HTTP request | Description
|
|
254
259
|
[**put_la_te_x_in_storage_to_pdf**](PdfApi.md#put_la_te_x_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/latex | Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage.
|
255
260
|
[**put_line_annotation**](PdfApi.md#put_line_annotation) | **PUT** /pdf/\{name}/annotations/line/\{annotationId} | Replace document line annotation
|
256
261
|
[**put_link_annotation**](PdfApi.md#put_link_annotation) | **PUT** /pdf/\{name}/links/\{linkId} | Replace document page link annotations
|
262
|
+
[**put_markdown_in_storage_to_pdf**](PdfApi.md#put_markdown_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/markdown | Convert MD file (located on storage) to PDF format and upload resulting file to storage.
|
257
263
|
[**put_merge_documents**](PdfApi.md#put_merge_documents) | **PUT** /pdf/\{name}/merge | Merge a list of documents.
|
258
264
|
[**put_mht_in_storage_to_pdf**](PdfApi.md#put_mht_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/mht | Convert MHT file (located on storage) to PDF format and upload resulting file to storage.
|
259
265
|
[**put_movie_annotation**](PdfApi.md#put_movie_annotation) | **PUT** /pdf/\{name}/annotations/movie/\{annotationId} | Replace document movie annotation
|
@@ -1569,6 +1575,30 @@ Name | Type | Description | Notes
|
|
1569
1575
|
|
1570
1576
|
|
1571
1577
|
|
1578
|
+
# **get_document_signature_fields**
|
1579
|
+
> SignatureFieldsResponse get_document_signature_fields(name, opts)
|
1580
|
+
|
1581
|
+
Read document signature fields.
|
1582
|
+
|
1583
|
+
### Parameters
|
1584
|
+
|
1585
|
+
Name | Type | Description | Notes
|
1586
|
+
------------- | ------------- | ------------- | -------------
|
1587
|
+
**name** | **String**| The document name. |
|
1588
|
+
**storage** | **String**| The document storage. | [optional]
|
1589
|
+
**folder** | **String**| The document folder. | [optional]
|
1590
|
+
|
1591
|
+
### Return type
|
1592
|
+
|
1593
|
+
[**SignatureFieldsResponse**](SignatureFieldsResponse.md)
|
1594
|
+
|
1595
|
+
### HTTP request headers
|
1596
|
+
|
1597
|
+
- **Content-Type**: application/json
|
1598
|
+
- **Accept**: application/json
|
1599
|
+
|
1600
|
+
|
1601
|
+
|
1572
1602
|
# **get_document_sound_annotations**
|
1573
1603
|
> SoundAnnotationsResponse get_document_sound_annotations(name, opts)
|
1574
1604
|
|
@@ -2462,6 +2492,29 @@ Name | Type | Description | Notes
|
|
2462
2492
|
|
2463
2493
|
|
2464
2494
|
|
2495
|
+
# **get_markdown_in_storage_to_pdf**
|
2496
|
+
> File get_markdown_in_storage_to_pdf(src_path, opts)
|
2497
|
+
|
2498
|
+
Convert MD file (located on storage) to PDF format and return resulting file in response.
|
2499
|
+
|
2500
|
+
### Parameters
|
2501
|
+
|
2502
|
+
Name | Type | Description | Notes
|
2503
|
+
------------- | ------------- | ------------- | -------------
|
2504
|
+
**src_path** | **String**| Full source filename (ex. /folder1/folder2/template.md) |
|
2505
|
+
**storage** | **String**| The document storage. | [optional]
|
2506
|
+
|
2507
|
+
### Return type
|
2508
|
+
|
2509
|
+
**File**
|
2510
|
+
|
2511
|
+
### HTTP request headers
|
2512
|
+
|
2513
|
+
- **Content-Type**: application/json
|
2514
|
+
- **Accept**: multipart/form-data
|
2515
|
+
|
2516
|
+
|
2517
|
+
|
2465
2518
|
# **get_mht_in_storage_to_pdf**
|
2466
2519
|
> File get_mht_in_storage_to_pdf(src_path, opts)
|
2467
2520
|
|
@@ -3098,6 +3151,31 @@ Name | Type | Description | Notes
|
|
3098
3151
|
|
3099
3152
|
|
3100
3153
|
|
3154
|
+
# **get_page_signature_fields**
|
3155
|
+
> SignatureFieldsResponse get_page_signature_fields(name, page_number, opts)
|
3156
|
+
|
3157
|
+
Read document page signature fields.
|
3158
|
+
|
3159
|
+
### Parameters
|
3160
|
+
|
3161
|
+
Name | Type | Description | Notes
|
3162
|
+
------------- | ------------- | ------------- | -------------
|
3163
|
+
**name** | **String**| The document name. |
|
3164
|
+
**page_number** | **Integer**| The page number. |
|
3165
|
+
**storage** | **String**| The document storage. | [optional]
|
3166
|
+
**folder** | **String**| The document folder. | [optional]
|
3167
|
+
|
3168
|
+
### Return type
|
3169
|
+
|
3170
|
+
[**SignatureFieldsResponse**](SignatureFieldsResponse.md)
|
3171
|
+
|
3172
|
+
### HTTP request headers
|
3173
|
+
|
3174
|
+
- **Content-Type**: application/json
|
3175
|
+
- **Accept**: application/json
|
3176
|
+
|
3177
|
+
|
3178
|
+
|
3101
3179
|
# **get_page_sound_annotations**
|
3102
3180
|
> SoundAnnotationsResponse get_page_sound_annotations(name, page_number, opts)
|
3103
3181
|
|
@@ -3952,6 +4030,31 @@ Name | Type | Description | Notes
|
|
3952
4030
|
|
3953
4031
|
|
3954
4032
|
|
4033
|
+
# **get_signature_field**
|
4034
|
+
> SignatureFieldResponse get_signature_field(name, field_name, opts)
|
4035
|
+
|
4036
|
+
Read document signature field by name.
|
4037
|
+
|
4038
|
+
### Parameters
|
4039
|
+
|
4040
|
+
Name | Type | Description | Notes
|
4041
|
+
------------- | ------------- | ------------- | -------------
|
4042
|
+
**name** | **String**| The document name. |
|
4043
|
+
**field_name** | **String**| The field name. |
|
4044
|
+
**storage** | **String**| The document storage. | [optional]
|
4045
|
+
**folder** | **String**| The document folder. | [optional]
|
4046
|
+
|
4047
|
+
### Return type
|
4048
|
+
|
4049
|
+
[**SignatureFieldResponse**](SignatureFieldResponse.md)
|
4050
|
+
|
4051
|
+
### HTTP request headers
|
4052
|
+
|
4053
|
+
- **Content-Type**: application/json
|
4054
|
+
- **Accept**: application/json
|
4055
|
+
|
4056
|
+
|
4057
|
+
|
3955
4058
|
# **get_sound_annotation**
|
3956
4059
|
> SoundAnnotationResponse get_sound_annotation(name, annotation_id, opts)
|
3957
4060
|
|
@@ -5042,6 +5145,33 @@ Name | Type | Description | Notes
|
|
5042
5145
|
|
5043
5146
|
|
5044
5147
|
|
5148
|
+
# **post_page_certify**
|
5149
|
+
> AsposeResponse post_page_certify(name, page_number, sign, doc_mdp_access_permission_type, opts)
|
5150
|
+
|
5151
|
+
Certify document page.
|
5152
|
+
|
5153
|
+
### Parameters
|
5154
|
+
|
5155
|
+
Name | Type | Description | Notes
|
5156
|
+
------------- | ------------- | ------------- | -------------
|
5157
|
+
**name** | **String**| The document name. |
|
5158
|
+
**page_number** | **Integer**| The page number. |
|
5159
|
+
**sign** | [**Signature**](Signature.md)| Signature object containing signature data. |
|
5160
|
+
**doc_mdp_access_permission_type** | **String**| The access permissions granted for this document. |
|
5161
|
+
**storage** | **String**| The document storage. | [optional]
|
5162
|
+
**folder** | **String**| The document folder. | [optional]
|
5163
|
+
|
5164
|
+
### Return type
|
5165
|
+
|
5166
|
+
[**AsposeResponse**](AsposeResponse.md)
|
5167
|
+
|
5168
|
+
### HTTP request headers
|
5169
|
+
|
5170
|
+
- **Content-Type**: application/json
|
5171
|
+
- **Accept**: application/json
|
5172
|
+
|
5173
|
+
|
5174
|
+
|
5045
5175
|
# **post_page_circle_annotations**
|
5046
5176
|
> AsposeResponse post_page_circle_annotations(name, page_number, annotations, opts)
|
5047
5177
|
|
@@ -6718,6 +6848,31 @@ Name | Type | Description | Notes
|
|
6718
6848
|
|
6719
6849
|
|
6720
6850
|
|
6851
|
+
# **put_markdown_in_storage_to_pdf**
|
6852
|
+
> AsposeResponse put_markdown_in_storage_to_pdf(name, src_path, opts)
|
6853
|
+
|
6854
|
+
Convert MD file (located on storage) to PDF format and upload resulting file to storage.
|
6855
|
+
|
6856
|
+
### Parameters
|
6857
|
+
|
6858
|
+
Name | Type | Description | Notes
|
6859
|
+
------------- | ------------- | ------------- | -------------
|
6860
|
+
**name** | **String**| The document name. |
|
6861
|
+
**src_path** | **String**| Full source filename (ex. /folder1/folder2/template.md) |
|
6862
|
+
**storage** | **String**| The document storage. | [optional]
|
6863
|
+
**dst_folder** | **String**| The destination document folder. | [optional]
|
6864
|
+
|
6865
|
+
### Return type
|
6866
|
+
|
6867
|
+
[**AsposeResponse**](AsposeResponse.md)
|
6868
|
+
|
6869
|
+
### HTTP request headers
|
6870
|
+
|
6871
|
+
- **Content-Type**: application/json
|
6872
|
+
- **Accept**: application/json
|
6873
|
+
|
6874
|
+
|
6875
|
+
|
6721
6876
|
# **put_merge_documents**
|
6722
6877
|
> DocumentResponse put_merge_documents(name, merge_documents, opts)
|
6723
6878
|
|
data/docs/Signature.md
CHANGED
@@ -17,5 +17,8 @@ Name | Type | Description | Notes
|
|
17
17
|
**authority** | **String** | Gets or sets the name of the person or authority signing the document.. | [optional]
|
18
18
|
**date** | **String** | Gets or sets the time of signing. | [optional]
|
19
19
|
**show_properties** | **BOOLEAN** | Gets or sets the showproperties in signature field |
|
20
|
+
**timestamp_settings** | [**TimestampSettings**](TimestampSettings.md) | Gets/sets timestamp settings. | [optional]
|
21
|
+
**is_valid** | **BOOLEAN** | Verify the document regarding this signature and return true if document is valid or otherwise false. | [optional]
|
22
|
+
**custom_appearance** | [**SignatureCustomAppearance**](SignatureCustomAppearance.md) | Gets/sets the custom appearance. | [optional]
|
20
23
|
|
21
24
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# AsposePdfCloud::SignatureCustomAppearance
|
2
|
+
An abstract class which represents signature custon appearance object.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**font_family_name** | **String** | Gets/sets font family name. It should be existed in the document. Default value: Arial. | [optional]
|
8
|
+
**font_size** | **Float** | Gets/sets font size. Default value: 10. |
|
9
|
+
**show_contact_info** | **BOOLEAN** | Gets/sets contact info visibility. Default value: true. |
|
10
|
+
**show_reason** | **BOOLEAN** | Gets/sets reason visibility. Default value: true. |
|
11
|
+
**show_location** | **BOOLEAN** | Gets/sets location visibility. Default value: true. |
|
12
|
+
**contact_info_label** | **String** | Gets/sets contact info label. Default value: "Contact". | [optional]
|
13
|
+
**reason_label** | **String** | Gets/sets reason label. Default value: "Reason". | [optional]
|
14
|
+
**location_label** | **String** | Gets/sets location label. Default value: "Location". | [optional]
|
15
|
+
**digital_signed_label** | **String** | Gets/sets digital signed label. Default value: "Digitally signed by". | [optional]
|
16
|
+
**date_signed_at_label** | **String** | Gets/sets date signed label. Default value: "Date". | [optional]
|
17
|
+
**date_time_local_format** | **String** | Gets/sets datetime local format. Default value: "yyyy.MM.dd HH:mm:ss zzz". | [optional]
|
18
|
+
**date_time_format** | **String** | Gets/sets datetime format. Default value: "yyyy.MM.dd HH:mm:ss". | [optional]
|
19
|
+
|
20
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# AsposePdfCloud::SignatureField
|
2
|
+
Provides SignatureField.
|
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
|
+
**signature** | [**Signature**](Signature.md) | Gets signature object. This object contains signature data regarding public-key cryptographic standards. Classes PKCS1, PKCS7 and PKCS7Detached represent all supported types of signature objects. | [optional]
|
26
|
+
|
27
|
+
|