aspose_pdf_cloud 20.5.0 → 20.12.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 +13 -8
- data/docs/ApiInfo.md +10 -0
- data/docs/CheckBoxField.md +1 -0
- data/docs/ChoiceField.md +1 -0
- data/docs/ComboBoxField.md +1 -0
- data/docs/FormField.md +1 -0
- data/docs/ImageCompressionVersion.md +12 -0
- data/docs/ImageEncoding.md +13 -0
- data/docs/ListBoxField.md +1 -0
- data/docs/OptimizeOptions.md +13 -7
- data/docs/OutputFormat.md +11 -0
- data/docs/Paragraph.md +2 -2
- data/docs/PdfAType.md +3 -2
- data/docs/PdfApi.md +36 -12
- data/docs/RadioButtonField.md +1 -0
- data/docs/RadioButtonOptionField.md +1 -0
- data/docs/RedactionAnnotation.md +1 -1
- data/docs/SignatureCustomAppearance.md +1 -1
- data/docs/SignatureField.md +1 -0
- data/docs/TextBoxField.md +1 -0
- data/docs/TextState.md +2 -1
- data/docs/TextStyle.md +1 -0
- data/lib/aspose_pdf_cloud.rb +4 -0
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +100 -22
- data/lib/aspose_pdf_cloud/models/api_info.rb +209 -0
- data/lib/aspose_pdf_cloud/models/check_box_field.rb +11 -1
- data/lib/aspose_pdf_cloud/models/choice_field.rb +11 -1
- data/lib/aspose_pdf_cloud/models/combo_box_field.rb +11 -1
- data/lib/aspose_pdf_cloud/models/form_field.rb +11 -1
- data/lib/aspose_pdf_cloud/models/image_compression_version.rb +45 -0
- data/lib/aspose_pdf_cloud/models/image_encoding.rb +46 -0
- data/lib/aspose_pdf_cloud/models/list_box_field.rb +11 -1
- data/lib/aspose_pdf_cloud/models/optimize_options.rb +60 -35
- data/lib/aspose_pdf_cloud/models/output_format.rb +44 -0
- data/lib/aspose_pdf_cloud/models/paragraph.rb +2 -2
- data/lib/aspose_pdf_cloud/models/pdf_a_type.rb +1 -0
- data/lib/aspose_pdf_cloud/models/radio_button_field.rb +11 -1
- data/lib/aspose_pdf_cloud/models/radio_button_option_field.rb +11 -1
- data/lib/aspose_pdf_cloud/models/redaction_annotation.rb +1 -1
- data/lib/aspose_pdf_cloud/models/signature_custom_appearance.rb +1 -1
- data/lib/aspose_pdf_cloud/models/signature_field.rb +11 -1
- data/lib/aspose_pdf_cloud/models/text_box_field.rb +11 -1
- data/lib/aspose_pdf_cloud/models/text_state.rb +15 -5
- data/lib/aspose_pdf_cloud/models/text_style.rb +14 -4
- data/lib/aspose_pdf_cloud/version.rb +1 -1
- data/test/pdf_tests.rb +8 -4
- data/test_data/Righteous-Regular.ttf +0 -0
- metadata +11 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fa48dbd06e45019672a85fe4170d4e491aeafdacd0750ceb37ab7ed95c33a8de
|
4
|
+
data.tar.gz: 82d35366668d0a3afe54180db68da1d78b16f1db68c1cf10bb634a7213c390e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8086f4e1921c40deca70afba0b959ee924b6a322c6e032eeff8123124443163305545c3b8c8bace33f72f5c6957bf3b5183d470e89b1056ef92c08485839b487
|
7
|
+
data.tar.gz: c3c0049f8573eaec68942935541a03ee752fbc9740411b40acb09e42db091709974192d49ae46dd520e5454382d999cc04ee3a5c989852b3fffcbad06352f500
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# Aspose.PDF Cloud
|
2
2
|
|
3
3
|
- API version: 3.0
|
4
|
-
- Package version: 20.
|
4
|
+
- Package version: 20.12.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
|
|
@@ -24,15 +24,15 @@ gem build aspose_pdf_cloud.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./aspose_pdf_cloud-20.
|
27
|
+
gem install ./aspose_pdf_cloud-20.12.0.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./aspose_pdf_cloud-20.
|
29
|
+
(for development, run `gem install --dev ./aspose_pdf_cloud-20.12.0.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'aspose_pdf_cloud', '~> 20.
|
35
|
+
gem 'aspose_pdf_cloud', '~> 20.12.0'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -116,6 +116,7 @@ Class | Method | HTTP request | Description
|
|
116
116
|
*AsposePdfCloud::PdfApi* | [**delete_stamp**](docs/PdfApi.md#delete_stamp) | **DELETE** /pdf/\{name}/stamps/\{stampId} | Delete document stamp by ID
|
117
117
|
*AsposePdfCloud::PdfApi* | [**delete_table**](docs/PdfApi.md#delete_table) | **DELETE** /pdf/\{name}/tables/\{tableId} | Delete document table by ID
|
118
118
|
*AsposePdfCloud::PdfApi* | [**download_file**](docs/PdfApi.md#download_file) | **GET** /pdf/storage/file/\{path} | Download file
|
119
|
+
*AsposePdfCloud::PdfApi* | [**get_api_info**](docs/PdfApi.md#get_api_info) | **GET** /pdf/info |
|
119
120
|
*AsposePdfCloud::PdfApi* | [**get_bookmark**](docs/PdfApi.md#get_bookmark) | **GET** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Read document bookmark.
|
120
121
|
*AsposePdfCloud::PdfApi* | [**get_bookmarks**](docs/PdfApi.md#get_bookmarks) | **GET** /pdf/\{name}/bookmarks/list/\{bookmarkPath} | Read document bookmarks node list.
|
121
122
|
*AsposePdfCloud::PdfApi* | [**get_caret_annotation**](docs/PdfApi.md#get_caret_annotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID.
|
@@ -124,7 +125,7 @@ Class | Method | HTTP request | Description
|
|
124
125
|
*AsposePdfCloud::PdfApi* | [**get_combo_box_field**](docs/PdfApi.md#get_combo_box_field) | **GET** /pdf/\{name}/fields/combobox/\{fieldName} | Read document combobox field by name.
|
125
126
|
*AsposePdfCloud::PdfApi* | [**get_disc_usage**](docs/PdfApi.md#get_disc_usage) | **GET** /pdf/storage/disc | Get disc usage
|
126
127
|
*AsposePdfCloud::PdfApi* | [**get_document**](docs/PdfApi.md#get_document) | **GET** /pdf/\{name} | Read common document info.
|
127
|
-
*AsposePdfCloud::PdfApi* | [**get_document_annotations**](docs/PdfApi.md#get_document_annotations) | **GET** /pdf/\{name}/annotations | Read
|
128
|
+
*AsposePdfCloud::PdfApi* | [**get_document_annotations**](docs/PdfApi.md#get_document_annotations) | **GET** /pdf/\{name}/annotations | Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
|
128
129
|
*AsposePdfCloud::PdfApi* | [**get_document_attachment_by_index**](docs/PdfApi.md#get_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex} | Read document attachment info by its index.
|
129
130
|
*AsposePdfCloud::PdfApi* | [**get_document_attachments**](docs/PdfApi.md#get_document_attachments) | **GET** /pdf/\{name}/attachments | Read document attachments info.
|
130
131
|
*AsposePdfCloud::PdfApi* | [**get_document_bookmarks**](docs/PdfApi.md#get_document_bookmarks) | **GET** /pdf/\{name}/bookmarks/tree | Read document bookmarks tree.
|
@@ -273,7 +274,7 @@ Class | Method | HTTP request | Description
|
|
273
274
|
*AsposePdfCloud::PdfApi* | [**get_verify_signature**](docs/PdfApi.md#get_verify_signature) | **GET** /pdf/\{name}/verifySignature | Verify signature document.
|
274
275
|
*AsposePdfCloud::PdfApi* | [**get_web_in_storage_to_pdf**](docs/PdfApi.md#get_web_in_storage_to_pdf) | **GET** /pdf/create/web | Convert web page to PDF format and return resulting file in response.
|
275
276
|
*AsposePdfCloud::PdfApi* | [**get_words_per_page**](docs/PdfApi.md#get_words_per_page) | **GET** /pdf/\{name}/pages/wordCount | Get number of words per document page.
|
276
|
-
*AsposePdfCloud::PdfApi* | [**get_xfa_pdf_in_storage_to_acro_form**](docs/PdfApi.md#get_xfa_pdf_in_storage_to_acro_form) | **GET** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which
|
277
|
+
*AsposePdfCloud::PdfApi* | [**get_xfa_pdf_in_storage_to_acro_form**](docs/PdfApi.md#get_xfa_pdf_in_storage_to_acro_form) | **GET** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and returns resulting file response content
|
277
278
|
*AsposePdfCloud::PdfApi* | [**get_xml_in_storage_to_pdf**](docs/PdfApi.md#get_xml_in_storage_to_pdf) | **GET** /pdf/create/xml | Convert XML file (located on storage) to PDF format and return resulting file in response.
|
278
279
|
*AsposePdfCloud::PdfApi* | [**get_xps_in_storage_to_pdf**](docs/PdfApi.md#get_xps_in_storage_to_pdf) | **GET** /pdf/create/xps | Convert XPS file (located on storage) to PDF format and return resulting file in response.
|
279
280
|
*AsposePdfCloud::PdfApi* | [**get_xsl_fo_in_storage_to_pdf**](docs/PdfApi.md#get_xsl_fo_in_storage_to_pdf) | **GET** /pdf/create/xslfo | Convert XslFo file (located on storage) to PDF format and return resulting file in response.
|
@@ -446,8 +447,8 @@ Class | Method | HTTP request | Description
|
|
446
447
|
*AsposePdfCloud::PdfApi* | [**put_update_field**](docs/PdfApi.md#put_update_field) | **PUT** /pdf/\{name}/fields/\{fieldName} | Update field.
|
447
448
|
*AsposePdfCloud::PdfApi* | [**put_update_fields**](docs/PdfApi.md#put_update_fields) | **PUT** /pdf/\{name}/fields | Update fields.
|
448
449
|
*AsposePdfCloud::PdfApi* | [**put_web_in_storage_to_pdf**](docs/PdfApi.md#put_web_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/web | Convert web page to PDF format and upload resulting file to storage.
|
449
|
-
*AsposePdfCloud::PdfApi* | [**put_xfa_pdf_in_request_to_acro_form**](docs/PdfApi.md#put_xfa_pdf_in_request_to_acro_form) | **PUT** /pdf/convert/xfatoacroform | Converts PDF document which
|
450
|
-
*AsposePdfCloud::PdfApi* | [**put_xfa_pdf_in_storage_to_acro_form**](docs/PdfApi.md#put_xfa_pdf_in_storage_to_acro_form) | **PUT** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which
|
450
|
+
*AsposePdfCloud::PdfApi* | [**put_xfa_pdf_in_request_to_acro_form**](docs/PdfApi.md#put_xfa_pdf_in_request_to_acro_form) | **PUT** /pdf/convert/xfatoacroform | Converts PDF document which contains XFA form (in request content) to PDF with AcroForm and uploads resulting file to storage.
|
451
|
+
*AsposePdfCloud::PdfApi* | [**put_xfa_pdf_in_storage_to_acro_form**](docs/PdfApi.md#put_xfa_pdf_in_storage_to_acro_form) | **PUT** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and uploads resulting file to storage
|
451
452
|
*AsposePdfCloud::PdfApi* | [**put_xml_in_storage_to_pdf**](docs/PdfApi.md#put_xml_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/xml | Convert XML file (located on storage) to PDF format and upload resulting file to storage.
|
452
453
|
*AsposePdfCloud::PdfApi* | [**put_xps_in_storage_to_pdf**](docs/PdfApi.md#put_xps_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/xps | Convert XPS file (located on storage) to PDF format and upload resulting file to storage.
|
453
454
|
*AsposePdfCloud::PdfApi* | [**put_xsl_fo_in_storage_to_pdf**](docs/PdfApi.md#put_xsl_fo_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/xslfo | Convert XslFo file (located on storage) to PDF format and upload resulting file to storage.
|
@@ -461,6 +462,7 @@ Class | Method | HTTP request | Description
|
|
461
462
|
- [AsposePdfCloud::AnnotationState](docs/AnnotationState.md)
|
462
463
|
- [AsposePdfCloud::AnnotationType](docs/AnnotationType.md)
|
463
464
|
- [AsposePdfCloud::AntialiasingProcessingType](docs/AntialiasingProcessingType.md)
|
465
|
+
- [AsposePdfCloud::ApiInfo](docs/ApiInfo.md)
|
464
466
|
- [AsposePdfCloud::AsposeResponse](docs/AsposeResponse.md)
|
465
467
|
- [AsposePdfCloud::Border](docs/Border.md)
|
466
468
|
- [AsposePdfCloud::BorderCornerStyle](docs/BorderCornerStyle.md)
|
@@ -503,6 +505,8 @@ Class | Method | HTTP request | Description
|
|
503
505
|
- [AsposePdfCloud::HorizontalAlignment](docs/HorizontalAlignment.md)
|
504
506
|
- [AsposePdfCloud::HtmlDocumentType](docs/HtmlDocumentType.md)
|
505
507
|
- [AsposePdfCloud::HtmlMarkupGenerationModes](docs/HtmlMarkupGenerationModes.md)
|
508
|
+
- [AsposePdfCloud::ImageCompressionVersion](docs/ImageCompressionVersion.md)
|
509
|
+
- [AsposePdfCloud::ImageEncoding](docs/ImageEncoding.md)
|
506
510
|
- [AsposePdfCloud::ImageFragment](docs/ImageFragment.md)
|
507
511
|
- [AsposePdfCloud::ImageSrcType](docs/ImageSrcType.md)
|
508
512
|
- [AsposePdfCloud::ImageTemplate](docs/ImageTemplate.md)
|
@@ -521,6 +525,7 @@ Class | Method | HTTP request | Description
|
|
521
525
|
- [AsposePdfCloud::ObjectExist](docs/ObjectExist.md)
|
522
526
|
- [AsposePdfCloud::OptimizeOptions](docs/OptimizeOptions.md)
|
523
527
|
- [AsposePdfCloud::Option](docs/Option.md)
|
528
|
+
- [AsposePdfCloud::OutputFormat](docs/OutputFormat.md)
|
524
529
|
- [AsposePdfCloud::PageLayout](docs/PageLayout.md)
|
525
530
|
- [AsposePdfCloud::PageMode](docs/PageMode.md)
|
526
531
|
- [AsposePdfCloud::PageWordCount](docs/PageWordCount.md)
|
data/docs/ApiInfo.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposePdfCloud::ApiInfo
|
2
|
+
Represents response for ApiInfo DTO
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | Product name. | [optional]
|
8
|
+
**version** | **String** | API version. | [optional]
|
9
|
+
|
10
|
+
|
data/docs/CheckBoxField.md
CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
8
|
**partial_name** | **String** | Field name. | [optional]
|
9
|
+
**full_name** | **String** | Full Field name. | [optional]
|
9
10
|
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
|
10
11
|
**value** | **String** | Field value. | [optional]
|
11
12
|
**page_index** | **Integer** | Page index. |
|
data/docs/ChoiceField.md
CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
8
|
**partial_name** | **String** | Field name. | [optional]
|
9
|
+
**full_name** | **String** | Full Field name. | [optional]
|
9
10
|
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
|
10
11
|
**value** | **String** | Field value. | [optional]
|
11
12
|
**page_index** | **Integer** | Page index. |
|
data/docs/ComboBoxField.md
CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
8
|
**partial_name** | **String** | Field name. | [optional]
|
9
|
+
**full_name** | **String** | Full Field name. | [optional]
|
9
10
|
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
|
10
11
|
**value** | **String** | Field value. | [optional]
|
11
12
|
**page_index** | **Integer** | Page index. |
|
data/docs/FormField.md
CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
8
|
**partial_name** | **String** | Field name. | [optional]
|
9
|
+
**full_name** | **String** | Full Field name. | [optional]
|
9
10
|
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
|
10
11
|
**value** | **String** | Field value. | [optional]
|
11
12
|
**page_index** | **Integer** | Page index. |
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# AsposePdfCloud::ImageCompressionVersion
|
2
|
+
Describes versions of image compression algorithm.
|
3
|
+
|
4
|
+
## Enum
|
5
|
+
Name | Type | Value | Description
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**STANDARD** | **String** | 'Standard' | Standard algorithm. Default value.
|
8
|
+
**FAST** | **String** | 'Fast' | Improved algorithm faster then standard but applicable not for all cases.
|
9
|
+
**MIXED** | **String** | 'Mixed' | Use fast algorithm when possible and standard for other cases. May be slower then "Fast" but may produce better compression.
|
10
|
+
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# AsposePdfCloud::ImageEncoding
|
2
|
+
Image encoding type.
|
3
|
+
|
4
|
+
## Enum
|
5
|
+
Name | Type | Value | Description
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**UNCHANGED** | **String** | 'Unchanged' | Don't change encoding.
|
8
|
+
**JPEG** | **String** | 'Jpeg' | JPEG (DCT) encoding.
|
9
|
+
**FLATE** | **String** | 'Flate' | Flate encoding.
|
10
|
+
**JPEG2000** | **String** | 'Jpeg2000' | JPEG2000 (JPX) encoding.
|
11
|
+
|
12
|
+
|
13
|
+
|
data/docs/ListBoxField.md
CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
8
|
**partial_name** | **String** | Field name. | [optional]
|
9
|
+
**full_name** | **String** | Full Field name. | [optional]
|
9
10
|
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
|
10
11
|
**value** | **String** | Field value. | [optional]
|
11
12
|
**page_index** | **Integer** | Page index. |
|
data/docs/OptimizeOptions.md
CHANGED
@@ -4,12 +4,18 @@ Represents Pdf optimize options.
|
|
4
4
|
## Properties
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**allow_reuse_page_content** | **BOOLEAN** | If true page contents will be reused when document is optimized for equal pages. |
|
8
|
-
**compress_images** | **BOOLEAN** | If this flag is set to true images will be compressed in the document.
|
9
|
-
**image_quality** | **Integer** |
|
10
|
-
**link_duplcate_streams** | **BOOLEAN** | If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then
|
11
|
-
**remove_unused_objects** | **BOOLEAN** | If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document. |
|
12
|
-
**remove_unused_streams** | **BOOLEAN** | If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document. |
|
13
|
-
**unembed_fonts** | **BOOLEAN** | Make fonts not embedded if set to true. |
|
7
|
+
**allow_reuse_page_content** | **BOOLEAN** | If true page contents will be reused when document is optimized for equal pages. | [optional]
|
8
|
+
**compress_images** | **BOOLEAN** | If this flag is set to true images will be compressed in the document. Compression level is specified with ImageQuality property. | [optional]
|
9
|
+
**image_quality** | **Integer** | Specifies level of image compression when CompressImages flag is used. | [optional]
|
10
|
+
**link_duplcate_streams** | **BOOLEAN** | If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then thees streams will be stored as one object. This allows to decrease document size in some cases (for example, when same document was concatenated multiple times). | [optional]
|
11
|
+
**remove_unused_objects** | **BOOLEAN** | If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document. | [optional]
|
12
|
+
**remove_unused_streams** | **BOOLEAN** | If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document. | [optional]
|
13
|
+
**unembed_fonts** | **BOOLEAN** | Make fonts not embedded if set to true. | [optional]
|
14
|
+
**resize_images** | **BOOLEAN** | If this flag set to true and CompressImages is true images will be resized if image resolution is greater then specified MaxResolution parameter. | [optional]
|
15
|
+
**max_resolution** | **Integer** | Specifies maximum resolution of images. If image has higher resolution it will be scaled. | [optional]
|
16
|
+
**subset_fonts** | **BOOLEAN** | Fonts will be converted into subsets if set to true. | [optional]
|
17
|
+
**remove_private_info** | **BOOLEAN** | Remove private information (page piece info). | [optional]
|
18
|
+
**image_encoding** | [**ImageEncoding**](ImageEncoding.md) | Image encode which will be used. | [optional]
|
19
|
+
**image_compression_version** | [**ImageCompressionVersion**](ImageCompressionVersion.md) | Version of compression algorithm. Possible values are: "Standard" - standard compression, "Fast" - fast (improved compression which is faster then standard but may be applicable not for all images), "Mixed" - mixed (standard compression is applied to images which can not be compressed by faster algorithm, this may give best compression but more slow then "Fast" algorithm. Version "Fast" is not applicable for resizing images (standard method will be used). Default is "Standard". | [optional]
|
14
20
|
|
15
21
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::OutputFormat
|
2
|
+
Enumeration for output type format.
|
3
|
+
|
4
|
+
## Enum
|
5
|
+
Name | Type | Value | Description
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**ZIP** | **String** | 'Zip' | Zip archive.
|
8
|
+
**FOLDER** | **String** | 'Folder' | Folder.
|
9
|
+
|
10
|
+
|
11
|
+
|
data/docs/Paragraph.md
CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**line_spacing** | [**LineSpacing**](LineSpacing.md) | Line spacing mode. | [optional]
|
8
8
|
**wrap_mode** | [**WrapMode**](WrapMode.md) | Word wrap mode. | [optional]
|
9
|
-
**horizontal_alignment** | [**TextHorizontalAlignment**](TextHorizontalAlignment.md) | Horizontal alignment for the text inside
|
9
|
+
**horizontal_alignment** | [**TextHorizontalAlignment**](TextHorizontalAlignment.md) | Horizontal alignment for the text inside paragraph's rectangle. | [optional]
|
10
10
|
**left_margin** | **Float** | Left margin. | [optional]
|
11
11
|
**right_margin** | **Float** | Right margin. | [optional]
|
12
12
|
**top_margin** | **Float** | Top margin. | [optional]
|
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
|
|
14
14
|
**rectangle** | [**Rectangle**](Rectangle.md) | Rectangle of the paragraph. | [optional]
|
15
15
|
**rotation** | **Float** | Rotation angle in degrees. | [optional]
|
16
16
|
**subsequent_lines_indent** | **Float** | Subsequent lines indent value. | [optional]
|
17
|
-
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Vertical alignment for the text inside
|
17
|
+
**vertical_alignment** | [**VerticalAlignment**](VerticalAlignment.md) | Vertical alignment for the text inside paragraph's rectangle | [optional]
|
18
18
|
**lines** | [**Array<TextLine>**](TextLine.md) | An array of text lines. |
|
19
19
|
|
20
20
|
|
data/docs/PdfAType.md
CHANGED
@@ -4,8 +4,9 @@ Allows to specify PdfA file format.
|
|
4
4
|
## Enum
|
5
5
|
Name | Type | Value | Description
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**PDFA1_A** | **String** | 'PDFA1A' |
|
8
|
-
**PDFA1_B** | **String** | 'PDFA1B' |
|
7
|
+
**PDFA1_A** | **String** | 'PDFA1A' | Pdf/A-1a format
|
8
|
+
**PDFA1_B** | **String** | 'PDFA1B' | Pdf/A-1b format
|
9
|
+
**PDFA3_A** | **String** | 'PDFA3A' | Pdf/A-3a format
|
9
10
|
|
10
11
|
|
11
12
|
|
data/docs/PdfApi.md
CHANGED
@@ -29,6 +29,7 @@ Method | HTTP request | Description
|
|
29
29
|
[**delete_stamp**](PdfApi.md#delete_stamp) | **DELETE** /pdf/\{name}/stamps/\{stampId} | Delete document stamp by ID
|
30
30
|
[**delete_table**](PdfApi.md#delete_table) | **DELETE** /pdf/\{name}/tables/\{tableId} | Delete document table by ID
|
31
31
|
[**download_file**](PdfApi.md#download_file) | **GET** /pdf/storage/file/\{path} | Download file
|
32
|
+
[**get_api_info**](PdfApi.md#get_api_info) | **GET** /pdf/info |
|
32
33
|
[**get_bookmark**](PdfApi.md#get_bookmark) | **GET** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Read document bookmark.
|
33
34
|
[**get_bookmarks**](PdfApi.md#get_bookmarks) | **GET** /pdf/\{name}/bookmarks/list/\{bookmarkPath} | Read document bookmarks node list.
|
34
35
|
[**get_caret_annotation**](PdfApi.md#get_caret_annotation) | **GET** /pdf/\{name}/annotations/caret/\{annotationId} | Read document page caret annotation by ID.
|
@@ -37,7 +38,7 @@ Method | HTTP request | Description
|
|
37
38
|
[**get_combo_box_field**](PdfApi.md#get_combo_box_field) | **GET** /pdf/\{name}/fields/combobox/\{fieldName} | Read document combobox field by name.
|
38
39
|
[**get_disc_usage**](PdfApi.md#get_disc_usage) | **GET** /pdf/storage/disc | Get disc usage
|
39
40
|
[**get_document**](PdfApi.md#get_document) | **GET** /pdf/\{name} | Read common document info.
|
40
|
-
[**get_document_annotations**](PdfApi.md#get_document_annotations) | **GET** /pdf/\{name}/annotations | Read
|
41
|
+
[**get_document_annotations**](PdfApi.md#get_document_annotations) | **GET** /pdf/\{name}/annotations | Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
|
41
42
|
[**get_document_attachment_by_index**](PdfApi.md#get_document_attachment_by_index) | **GET** /pdf/\{name}/attachments/\{attachmentIndex} | Read document attachment info by its index.
|
42
43
|
[**get_document_attachments**](PdfApi.md#get_document_attachments) | **GET** /pdf/\{name}/attachments | Read document attachments info.
|
43
44
|
[**get_document_bookmarks**](PdfApi.md#get_document_bookmarks) | **GET** /pdf/\{name}/bookmarks/tree | Read document bookmarks tree.
|
@@ -186,7 +187,7 @@ Method | HTTP request | Description
|
|
186
187
|
[**get_verify_signature**](PdfApi.md#get_verify_signature) | **GET** /pdf/\{name}/verifySignature | Verify signature document.
|
187
188
|
[**get_web_in_storage_to_pdf**](PdfApi.md#get_web_in_storage_to_pdf) | **GET** /pdf/create/web | Convert web page to PDF format and return resulting file in response.
|
188
189
|
[**get_words_per_page**](PdfApi.md#get_words_per_page) | **GET** /pdf/\{name}/pages/wordCount | Get number of words per document page.
|
189
|
-
[**get_xfa_pdf_in_storage_to_acro_form**](PdfApi.md#get_xfa_pdf_in_storage_to_acro_form) | **GET** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which
|
190
|
+
[**get_xfa_pdf_in_storage_to_acro_form**](PdfApi.md#get_xfa_pdf_in_storage_to_acro_form) | **GET** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and returns resulting file response content
|
190
191
|
[**get_xml_in_storage_to_pdf**](PdfApi.md#get_xml_in_storage_to_pdf) | **GET** /pdf/create/xml | Convert XML file (located on storage) to PDF format and return resulting file in response.
|
191
192
|
[**get_xps_in_storage_to_pdf**](PdfApi.md#get_xps_in_storage_to_pdf) | **GET** /pdf/create/xps | Convert XPS file (located on storage) to PDF format and return resulting file in response.
|
192
193
|
[**get_xsl_fo_in_storage_to_pdf**](PdfApi.md#get_xsl_fo_in_storage_to_pdf) | **GET** /pdf/create/xslfo | Convert XslFo file (located on storage) to PDF format and return resulting file in response.
|
@@ -359,8 +360,8 @@ Method | HTTP request | Description
|
|
359
360
|
[**put_update_field**](PdfApi.md#put_update_field) | **PUT** /pdf/\{name}/fields/\{fieldName} | Update field.
|
360
361
|
[**put_update_fields**](PdfApi.md#put_update_fields) | **PUT** /pdf/\{name}/fields | Update fields.
|
361
362
|
[**put_web_in_storage_to_pdf**](PdfApi.md#put_web_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/web | Convert web page to PDF format and upload resulting file to storage.
|
362
|
-
[**put_xfa_pdf_in_request_to_acro_form**](PdfApi.md#put_xfa_pdf_in_request_to_acro_form) | **PUT** /pdf/convert/xfatoacroform | Converts PDF document which
|
363
|
-
[**put_xfa_pdf_in_storage_to_acro_form**](PdfApi.md#put_xfa_pdf_in_storage_to_acro_form) | **PUT** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which
|
363
|
+
[**put_xfa_pdf_in_request_to_acro_form**](PdfApi.md#put_xfa_pdf_in_request_to_acro_form) | **PUT** /pdf/convert/xfatoacroform | Converts PDF document which contains XFA form (in request content) to PDF with AcroForm and uploads resulting file to storage.
|
364
|
+
[**put_xfa_pdf_in_storage_to_acro_form**](PdfApi.md#put_xfa_pdf_in_storage_to_acro_form) | **PUT** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and uploads resulting file to storage
|
364
365
|
[**put_xml_in_storage_to_pdf**](PdfApi.md#put_xml_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/xml | Convert XML file (located on storage) to PDF format and upload resulting file to storage.
|
365
366
|
[**put_xps_in_storage_to_pdf**](PdfApi.md#put_xps_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/xps | Convert XPS file (located on storage) to PDF format and upload resulting file to storage.
|
366
367
|
[**put_xsl_fo_in_storage_to_pdf**](PdfApi.md#put_xsl_fo_in_storage_to_pdf) | **PUT** /pdf/\{name}/create/xslfo | Convert XslFo file (located on storage) to PDF format and upload resulting file to storage.
|
@@ -983,6 +984,25 @@ Name | Type | Description | Notes
|
|
983
984
|
|
984
985
|
|
985
986
|
|
987
|
+
# **get_api_info**
|
988
|
+
> ApiInfo get_api_info
|
989
|
+
|
990
|
+
|
991
|
+
|
992
|
+
### Parameters
|
993
|
+
This endpoint does not need any parameter.
|
994
|
+
|
995
|
+
### Return type
|
996
|
+
|
997
|
+
[**ApiInfo**](ApiInfo.md)
|
998
|
+
|
999
|
+
### HTTP request headers
|
1000
|
+
|
1001
|
+
- **Content-Type**: application/json
|
1002
|
+
- **Accept**: application/json
|
1003
|
+
|
1004
|
+
|
1005
|
+
|
986
1006
|
# **get_bookmark**
|
987
1007
|
> BookmarkResponse get_bookmark(name, bookmark_path, opts)
|
988
1008
|
|
@@ -1182,7 +1202,7 @@ Name | Type | Description | Notes
|
|
1182
1202
|
# **get_document_annotations**
|
1183
1203
|
> AnnotationsInfoResponse get_document_annotations(name, opts)
|
1184
1204
|
|
1185
|
-
Read
|
1205
|
+
Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
|
1186
1206
|
|
1187
1207
|
### Parameters
|
1188
1208
|
|
@@ -4951,7 +4971,7 @@ Name | Type | Description | Notes
|
|
4951
4971
|
# **get_xfa_pdf_in_storage_to_acro_form**
|
4952
4972
|
> File get_xfa_pdf_in_storage_to_acro_form(name, opts)
|
4953
4973
|
|
4954
|
-
Converts PDF document which
|
4974
|
+
Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and returns resulting file response content
|
4955
4975
|
|
4956
4976
|
### Parameters
|
4957
4977
|
|
@@ -5967,7 +5987,7 @@ Name | Type | Description | Notes
|
|
5967
5987
|
------------- | ------------- | ------------- | -------------
|
5968
5988
|
**name** | **String**| The document name. |
|
5969
5989
|
**page_number** | **Integer**| The page number. |
|
5970
|
-
**links** | [**Array<LinkAnnotation>**](LinkAnnotation.md)| Array of link
|
5990
|
+
**links** | [**Array<LinkAnnotation>**](LinkAnnotation.md)| Array of link annotation. |
|
5971
5991
|
**storage** | **String**| The document storage. | [optional]
|
5972
5992
|
**folder** | **String**| The document folder. | [optional]
|
5973
5993
|
|
@@ -6100,6 +6120,7 @@ Name | Type | Description | Notes
|
|
6100
6120
|
**annotations** | [**Array<RedactionAnnotation>**](RedactionAnnotation.md)| The array of annotation. |
|
6101
6121
|
**storage** | **String**| The document storage. | [optional]
|
6102
6122
|
**folder** | **String**| The document folder. | [optional]
|
6123
|
+
**apply** | **BOOLEAN**| Apply redaction immediately after adding. | [optional] [default to false]
|
6103
6124
|
|
6104
6125
|
### Return type
|
6105
6126
|
|
@@ -6847,7 +6868,7 @@ Name | Type | Description | Notes
|
|
6847
6868
|
**out_path** | **String**| Full resulting filename (ex. /folder1/folder2/result.doc) |
|
6848
6869
|
**password** | **String**| The password (encrypted Base64). |
|
6849
6870
|
**storage** | **String**| The document storage. | [optional]
|
6850
|
-
**file** | **File**| A file to be
|
6871
|
+
**file** | **File**| A file to be decrypted. | [optional]
|
6851
6872
|
|
6852
6873
|
### Return type
|
6853
6874
|
|
@@ -7587,7 +7608,7 @@ Name | Type | Description | Notes
|
|
7587
7608
|
------------- | ------------- | ------------- | -------------
|
7588
7609
|
**name** | **String**| The document name. |
|
7589
7610
|
**link_id** | **String**| The link ID. |
|
7590
|
-
**link** | [**LinkAnnotation**](LinkAnnotation.md)| Link
|
7611
|
+
**link** | [**LinkAnnotation**](LinkAnnotation.md)| Link annotation. |
|
7591
7612
|
**storage** | **String**| The document storage. | [optional]
|
7592
7613
|
**folder** | **String**| The document folder. | [optional]
|
7593
7614
|
|
@@ -7662,7 +7683,7 @@ Merge a list of documents.
|
|
7662
7683
|
|
7663
7684
|
Name | Type | Description | Notes
|
7664
7685
|
------------- | ------------- | ------------- | -------------
|
7665
|
-
**name** | **String**| Resulting
|
7686
|
+
**name** | **String**| Resulting document name. |
|
7666
7687
|
**merge_documents** | [**MergeDocuments**](MergeDocuments.md)| MergeDocuments with a list of documents. |
|
7667
7688
|
**storage** | **String**| Resulting document storage. | [optional]
|
7668
7689
|
**folder** | **String**| Resulting document folder. | [optional]
|
@@ -8071,6 +8092,7 @@ Name | Type | Description | Notes
|
|
8071
8092
|
**try_save_text_underlining_and_strikeouting_in_css** | **BOOLEAN**| PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text's underlining and put this info into CSS instead of drawing of underlining graphically. | [optional]
|
8072
8093
|
**storage** | **String**| The document storage. | [optional]
|
8073
8094
|
**flow_layout_paragraph_full_width** | **BOOLEAN**| This attribute specifies full width paragraph text for Flow mode, FixedLayout = false. | [optional]
|
8095
|
+
**output_format** | **String**| This parameter determines the type of result. The zip archive will be uploaded into the storage if the parameter is "Zip" or missed (default). In case of the "Folder", all resulting files and directories will be uploaded to the folder of the resulting HTML file. | [optional] [default to Zip]
|
8074
8096
|
**file** | **File**| A file to be converted. | [optional]
|
8075
8097
|
|
8076
8098
|
### Return type
|
@@ -8475,6 +8497,7 @@ Name | Type | Description | Notes
|
|
8475
8497
|
**folder** | **String**| The document folder. | [optional]
|
8476
8498
|
**storage** | **String**| The document storage. | [optional]
|
8477
8499
|
**flow_layout_paragraph_full_width** | **BOOLEAN**| This attribute specifies full width paragraph text for Flow mode, FixedLayout = false. | [optional]
|
8500
|
+
**output_format** | **String**| This parameter determines the type of result. The zip archive will be uploaded into the storage if the parameter is "Zip" or missed (default). In case of the "Folder", all resulting files and directories will be uploaded to the folder of the resulting HTML file. | [optional] [default to Zip]
|
8478
8501
|
|
8479
8502
|
### Return type
|
8480
8503
|
|
@@ -8956,6 +8979,7 @@ Name | Type | Description | Notes
|
|
8956
8979
|
**annotation** | [**RedactionAnnotation**](RedactionAnnotation.md)| Annotation. |
|
8957
8980
|
**storage** | **String**| The document storage. | [optional]
|
8958
8981
|
**folder** | **String**| The document folder. | [optional]
|
8982
|
+
**apply** | **BOOLEAN**| Apply redaction immediately after adding. | [optional] [default to false]
|
8959
8983
|
|
8960
8984
|
### Return type
|
8961
8985
|
|
@@ -9554,7 +9578,7 @@ Name | Type | Description | Notes
|
|
9554
9578
|
# **put_xfa_pdf_in_request_to_acro_form**
|
9555
9579
|
> AsposeResponse put_xfa_pdf_in_request_to_acro_form(out_path, opts)
|
9556
9580
|
|
9557
|
-
Converts PDF document which
|
9581
|
+
Converts PDF document which contains XFA form (in request content) to PDF with AcroForm and uploads resulting file to storage.
|
9558
9582
|
|
9559
9583
|
### Parameters
|
9560
9584
|
|
@@ -9578,7 +9602,7 @@ Name | Type | Description | Notes
|
|
9578
9602
|
# **put_xfa_pdf_in_storage_to_acro_form**
|
9579
9603
|
> AsposeResponse put_xfa_pdf_in_storage_to_acro_form(name, out_path, opts)
|
9580
9604
|
|
9581
|
-
Converts PDF document which
|
9605
|
+
Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and uploads resulting file to storage
|
9582
9606
|
|
9583
9607
|
### Parameters
|
9584
9608
|
|
data/docs/RadioButtonField.md
CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
8
|
**partial_name** | **String** | Field name. | [optional]
|
9
|
+
**full_name** | **String** | Full Field name. | [optional]
|
9
10
|
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
|
10
11
|
**value** | **String** | Field value. | [optional]
|
11
12
|
**page_index** | **Integer** | Page index. |
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
8
|
**partial_name** | **String** | Field name. | [optional]
|
9
|
+
**full_name** | **String** | Full Field name. | [optional]
|
9
10
|
**rect** | [**Rectangle**](Rectangle.md) | Field rectangle. | [optional]
|
10
11
|
**value** | **String** | Field value. | [optional]
|
11
12
|
**page_index** | **Integer** | Page index. |
|
data/docs/RedactionAnnotation.md
CHANGED
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
|
|
20
20
|
**fill_color** | [**Color**](Color.md) | Gets or sets color to fill annotation. | [optional]
|
21
21
|
**border_color** | [**Color**](Color.md) | Gets or sets color of border which is drawn when redaction is not active. | [optional]
|
22
22
|
**overlay_text** | **String** | Text to print on redact annotation. | [optional]
|
23
|
-
**repeat** | **BOOLEAN** | If true overlay text will be
|
23
|
+
**repeat** | **BOOLEAN** | If true overlay text will be repeated on the annotation. | [optional]
|
24
24
|
**text_alignment** | [**HorizontalAlignment**](HorizontalAlignment.md) | Gets or sets. Alignment of Overlay Text. | [optional]
|
25
25
|
|
26
26
|
|