aspose_pdf_cloud 24.7.0 → 24.9.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 +4 -8
- data/docs/DocumentLayers.md +9 -0
- data/docs/LayerInfo.md +12 -0
- data/docs/OptimizeOptions.md +3 -3
- data/docs/PdfApi.md +137 -0
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +420 -0
- data/lib/aspose_pdf_cloud/api_client.rb +9 -1
- data/lib/aspose_pdf_cloud/models/document_layers.rb +201 -0
- data/lib/aspose_pdf_cloud/models/layer_info.rb +239 -0
- data/lib/aspose_pdf_cloud/models/optimize_options.rb +3 -3
- data/lib/aspose_pdf_cloud/version.rb +1 -1
- data/lib/aspose_pdf_cloud.rb +2 -0
- data/test/pdf_tests.rb +106 -0
- data/test_data/PdfWithLayers.pdf +0 -0
- metadata +7 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 28f24d744fc7c852333e5ffe4d013b99b1ce12577cb91e727b7bd399824f7bd5
|
4
|
+
data.tar.gz: '035608878d88906b3095a096696b6dcd4fe62fe9329c9ee745050c3bdfba9dc4'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 79a888d3171d173a2f1254f0b9cfbd8a5a52a840c86edd67b473b7da7fd58aa717d2968ac2141dbe731be6e13dce4ccc1ab058478659975c6faa932aa8a298cd
|
7
|
+
data.tar.gz: 19f75b669468f764865488a7163cac576175fa7d5d6fc61f6fe38897ead797d70a98afdbdef5f8825769fe5c54ec60ab86d2775e2b4aa3603ab2062370493055
|
data/README.md
CHANGED
@@ -29,13 +29,9 @@ XLS, XLSX, PPTX, DOC, DOCX, MobiXML, JPEG, EMF, PNG, BMP, GIF, TIFF, Text
|
|
29
29
|
## Read PDF Formats
|
30
30
|
MHT, PCL, PS, XSLFO, MD
|
31
31
|
|
32
|
-
## Enhancements in Version 24.
|
32
|
+
## Enhancements in Version 24.9
|
33
33
|
- A new version of Aspose.PDF Cloud was prepared using the latest version of Aspose.PDF for .NET.
|
34
34
|
|
35
|
-
## Bugs fixed in Version 24.7
|
36
|
-
- PutPsInStorageToPdf throws: Cannot find resource ‘Aspose.PDF.dependencies.ZapfDingbats.ttf.
|
37
|
-
- Ocr method is not working.
|
38
|
-
|
39
35
|
## Installation
|
40
36
|
|
41
37
|
### Build a gem
|
@@ -49,15 +45,15 @@ gem build aspose_pdf_cloud.gemspec
|
|
49
45
|
Then either install the gem locally:
|
50
46
|
|
51
47
|
```shell
|
52
|
-
gem install ./aspose_pdf_cloud-24.
|
48
|
+
gem install ./aspose_pdf_cloud-24.9.0.gem
|
53
49
|
```
|
54
|
-
(for development, run `gem install --dev ./aspose_pdf_cloud-24.
|
50
|
+
(for development, run `gem install --dev ./aspose_pdf_cloud-24.9.0.gem` to install the development dependencies)
|
55
51
|
|
56
52
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
57
53
|
|
58
54
|
Finally add this to the Gemfile:
|
59
55
|
|
60
|
-
gem 'aspose_pdf_cloud', '~> 24.
|
56
|
+
gem 'aspose_pdf_cloud', '~> 24.9.0'
|
61
57
|
|
62
58
|
### Install from Git
|
63
59
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# AsposePdfCloud::DocumentLayers
|
2
|
+
DocumentLayers response class.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**layers** | [**Array<LayerInfo>**](LayerInfo.md) | List of document Layers. | [optional]
|
8
|
+
|
9
|
+
|
data/docs/LayerInfo.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
# AsposePdfCloud::LayerInfo
|
2
|
+
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**page_number** | **Integer** | Layer Page Number. |
|
8
|
+
**id** | **String** | Layer Id. | [optional]
|
9
|
+
**name** | **String** | Layer Name. | [optional]
|
10
|
+
**locked** | **BOOLEAN** | Gets a value indicating whether the layer is locked. |
|
11
|
+
|
12
|
+
|
data/docs/OptimizeOptions.md
CHANGED
@@ -5,16 +5,16 @@ Represents Pdf optimize options.
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**password** | **String** | Specifies document password (if any) encoded with base-64. | [optional]
|
8
|
-
**allow_reuse_page_content** | **BOOLEAN** | If true page contents will be reused when document is optimized for equal pages. | [optional]
|
8
|
+
**allow_reuse_page_content** | **BOOLEAN** | If true page contents will be reused when document is optimized for equal pages. LinkDuplcateStreams option must be set to true. | [optional]
|
9
9
|
**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]
|
10
10
|
**image_quality** | **Integer** | Specifies level of image compression when CompressImages flag is used. | [optional]
|
11
11
|
**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]
|
12
12
|
**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]
|
13
13
|
**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]
|
14
|
-
**unembed_fonts** | **BOOLEAN** | Make fonts not embedded if set to true.
|
14
|
+
**unembed_fonts** | **BOOLEAN** | Make fonts not embedded if set to true. Unembedding a font means removing the embedded byte stream data of the font included in a PDF document. | [optional]
|
15
15
|
**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]
|
16
16
|
**max_resolution** | **Integer** | Specifies maximum resolution of images. If image has higher resolution it will be scaled. | [optional]
|
17
|
-
**subset_fonts** | **BOOLEAN** | Fonts will be converted into subsets if set to true. | [optional]
|
17
|
+
**subset_fonts** | **BOOLEAN** | Fonts will be converted into subsets if set to true. Only those characters that are actually used in the layout are stored in the PDF. | [optional]
|
18
18
|
**remove_private_info** | **BOOLEAN** | Remove private information (page piece info). | [optional]
|
19
19
|
**image_encoding** | [**ImageEncoding**](ImageEncoding.md) | Image encode which will be used. | [optional]
|
20
20
|
**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]
|
data/docs/PdfApi.md
CHANGED
@@ -11,6 +11,7 @@ Method | HTTP request | Description
|
|
11
11
|
[**delete_bookmark**](PdfApi.md#delete_bookmark) | **DELETE** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Delete document bookmark by ID.
|
12
12
|
[**delete_document_annotations**](PdfApi.md#delete_document_annotations) | **DELETE** /pdf/\{name}/annotations | Delete all annotations from the document
|
13
13
|
[**delete_document_bookmarks**](PdfApi.md#delete_document_bookmarks) | **DELETE** /pdf/\{name}/bookmarks/tree | Delete all document bookmarks.
|
14
|
+
[**delete_document_layer**](PdfApi.md#delete_document_layer) | **DELETE** /pdf/\{name}/layers | Remove document layer.
|
14
15
|
[**delete_document_link_annotations**](PdfApi.md#delete_document_link_annotations) | **DELETE** /pdf/\{name}/links | Delete all link annotations from the document
|
15
16
|
[**delete_document_stamps**](PdfApi.md#delete_document_stamps) | **DELETE** /pdf/\{name}/stamps | Delete all stamps from the document
|
16
17
|
[**delete_document_tables**](PdfApi.md#delete_document_tables) | **DELETE** /pdf/\{name}/tables | Delete all tables from the document
|
@@ -50,6 +51,7 @@ Method | HTTP request | Description
|
|
50
51
|
[**get_document_free_text_annotations**](PdfApi.md#get_document_free_text_annotations) | **GET** /pdf/\{name}/annotations/freetext | Read document free text annotations.
|
51
52
|
[**get_document_highlight_annotations**](PdfApi.md#get_document_highlight_annotations) | **GET** /pdf/\{name}/annotations/highlight | Read document highlight annotations.
|
52
53
|
[**get_document_ink_annotations**](PdfApi.md#get_document_ink_annotations) | **GET** /pdf/\{name}/annotations/ink | Read document ink annotations.
|
54
|
+
[**get_document_layers**](PdfApi.md#get_document_layers) | **GET** /pdf/\{name}/layers | Gets document layers.
|
53
55
|
[**get_document_line_annotations**](PdfApi.md#get_document_line_annotations) | **GET** /pdf/\{name}/annotations/line | Read document line annotations.
|
54
56
|
[**get_document_list_box_fields**](PdfApi.md#get_document_list_box_fields) | **GET** /pdf/\{name}/fields/listbox | Read document listbox fields.
|
55
57
|
[**get_document_movie_annotations**](PdfApi.md#get_document_movie_annotations) | **GET** /pdf/\{name}/annotations/movie | Read document movie annotations.
|
@@ -203,10 +205,12 @@ Method | HTTP request | Description
|
|
203
205
|
[**post_decrypt_document_in_storage**](PdfApi.md#post_decrypt_document_in_storage) | **POST** /pdf/\{name}/decrypt | Decrypt document in storage.
|
204
206
|
[**post_document_image_footer**](PdfApi.md#post_document_image_footer) | **POST** /pdf/\{name}/footer/image | Add document image footer.
|
205
207
|
[**post_document_image_header**](PdfApi.md#post_document_image_header) | **POST** /pdf/\{name}/header/image | Add document image header.
|
208
|
+
[**post_document_image_stamps**](PdfApi.md#post_document_image_stamps) | **POST** /pdf/\{name}/stamps/image | Add document pages image stamps.
|
206
209
|
[**post_document_page_number_stamps**](PdfApi.md#post_document_page_number_stamps) | **POST** /pdf/\{name}/stamps/pagenumber | Add document page number stamps.
|
207
210
|
[**post_document_text_footer**](PdfApi.md#post_document_text_footer) | **POST** /pdf/\{name}/footer/text | Add document text footer.
|
208
211
|
[**post_document_text_header**](PdfApi.md#post_document_text_header) | **POST** /pdf/\{name}/header/text | Add document text header.
|
209
212
|
[**post_document_text_replace**](PdfApi.md#post_document_text_replace) | **POST** /pdf/\{name}/text/replace | Document's replace text method.
|
213
|
+
[**post_document_text_stamps**](PdfApi.md#post_document_text_stamps) | **POST** /pdf/\{name}/stamps/text | Add document pages text stamps.
|
210
214
|
[**post_encrypt_document_in_storage**](PdfApi.md#post_encrypt_document_in_storage) | **POST** /pdf/\{name}/encrypt | Encrypt document in storage.
|
211
215
|
[**post_flatten_document**](PdfApi.md#post_flatten_document) | **POST** /pdf/\{name}/flatten | Flatten the document.
|
212
216
|
[**post_html_to_pdf**](PdfApi.md#post_html_to_pdf) | **POST** /pdf/create/html | Convert HTML file (zip archive in request content) to PDF format and return resulting file in response.
|
@@ -264,6 +268,7 @@ Method | HTTP request | Description
|
|
264
268
|
[**put_circle_annotation**](PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation
|
265
269
|
[**put_combo_box_field**](PdfApi.md#put_combo_box_field) | **PUT** /pdf/\{name}/fields/combobox/\{fieldName} | Replace document combobox field
|
266
270
|
[**put_create_document**](PdfApi.md#put_create_document) | **PUT** /pdf/\{name} | Create empty document.
|
271
|
+
[**put_create_pdf_from_layer**](PdfApi.md#put_create_pdf_from_layer) | **PUT** /pdf/\{name}/layers | Create a separate PDF from a PDF Layer and upload resulting file to storage.
|
267
272
|
[**put_decrypt_document**](PdfApi.md#put_decrypt_document) | **PUT** /pdf/decrypt | Decrypt document from content.
|
268
273
|
[**put_document_display_properties**](PdfApi.md#put_document_display_properties) | **PUT** /pdf/\{name}/displayproperties | Update document display properties.
|
269
274
|
[**put_encrypt_document**](PdfApi.md#put_encrypt_document) | **PUT** /pdf/encrypt | Encrypt document from content.
|
@@ -545,6 +550,33 @@ Name | Type | Description | Notes
|
|
545
550
|
|
546
551
|
|
547
552
|
|
553
|
+
# **delete_document_layer**
|
554
|
+
> AsposeResponse delete_document_layer(name, page_number, layer_id, opts)
|
555
|
+
|
556
|
+
Remove document layer.
|
557
|
+
|
558
|
+
### Parameters
|
559
|
+
|
560
|
+
Name | Type | Description | Notes
|
561
|
+
------------- | ------------- | ------------- | -------------
|
562
|
+
**name** | **String**| The document name. |
|
563
|
+
**page_number** | **Integer**| Layer page. |
|
564
|
+
**layer_id** | **String**| Layer Id. |
|
565
|
+
**folder** | **String**| The document folder. | [optional]
|
566
|
+
**storage** | **String**| The document storage. | [optional]
|
567
|
+
**pass_base64** | **String**| The password (Base64). | [optional]
|
568
|
+
|
569
|
+
### Return type
|
570
|
+
|
571
|
+
[**AsposeResponse**](AsposeResponse.md)
|
572
|
+
|
573
|
+
### HTTP request headers
|
574
|
+
|
575
|
+
- **Content-Type**: application/json
|
576
|
+
- **Accept**: application/json
|
577
|
+
|
578
|
+
|
579
|
+
|
548
580
|
# **delete_document_link_annotations**
|
549
581
|
> AsposeResponse delete_document_link_annotations(name, opts)
|
550
582
|
|
@@ -1506,6 +1538,31 @@ Name | Type | Description | Notes
|
|
1506
1538
|
|
1507
1539
|
|
1508
1540
|
|
1541
|
+
# **get_document_layers**
|
1542
|
+
> DocumentLayers get_document_layers(name, opts)
|
1543
|
+
|
1544
|
+
Gets document layers.
|
1545
|
+
|
1546
|
+
### Parameters
|
1547
|
+
|
1548
|
+
Name | Type | Description | Notes
|
1549
|
+
------------- | ------------- | ------------- | -------------
|
1550
|
+
**name** | **String**| The document name. |
|
1551
|
+
**folder** | **String**| The document folder. | [optional]
|
1552
|
+
**storage** | **String**| The document storage. | [optional]
|
1553
|
+
**pass_base64** | **String**| The password (Base64). | [optional]
|
1554
|
+
|
1555
|
+
### Return type
|
1556
|
+
|
1557
|
+
[**DocumentLayers**](DocumentLayers.md)
|
1558
|
+
|
1559
|
+
### HTTP request headers
|
1560
|
+
|
1561
|
+
- **Content-Type**: application/json
|
1562
|
+
- **Accept**: application/json
|
1563
|
+
|
1564
|
+
|
1565
|
+
|
1509
1566
|
# **get_document_line_annotations**
|
1510
1567
|
> LineAnnotationsResponse get_document_line_annotations(name, opts)
|
1511
1568
|
|
@@ -5409,6 +5466,32 @@ Name | Type | Description | Notes
|
|
5409
5466
|
|
5410
5467
|
|
5411
5468
|
|
5469
|
+
# **post_document_image_stamps**
|
5470
|
+
> AsposeResponse post_document_image_stamps(name, stamps, opts)
|
5471
|
+
|
5472
|
+
Add document pages image stamps.
|
5473
|
+
|
5474
|
+
### Parameters
|
5475
|
+
|
5476
|
+
Name | Type | Description | Notes
|
5477
|
+
------------- | ------------- | ------------- | -------------
|
5478
|
+
**name** | **String**| The document name. |
|
5479
|
+
**stamps** | [**Array<ImageStamp>**](ImageStamp.md)| The array of stamp. |
|
5480
|
+
**storage** | **String**| The document storage. | [optional]
|
5481
|
+
**folder** | **String**| The document folder. | [optional]
|
5482
|
+
**password** | **String**| Base64 encoded password. | [optional]
|
5483
|
+
|
5484
|
+
### Return type
|
5485
|
+
|
5486
|
+
[**AsposeResponse**](AsposeResponse.md)
|
5487
|
+
|
5488
|
+
### HTTP request headers
|
5489
|
+
|
5490
|
+
- **Content-Type**: application/json
|
5491
|
+
- **Accept**: application/json
|
5492
|
+
|
5493
|
+
|
5494
|
+
|
5412
5495
|
# **post_document_page_number_stamps**
|
5413
5496
|
> AsposeResponse post_document_page_number_stamps(name, stamp, opts)
|
5414
5497
|
|
@@ -5516,6 +5599,32 @@ Name | Type | Description | Notes
|
|
5516
5599
|
|
5517
5600
|
|
5518
5601
|
|
5602
|
+
# **post_document_text_stamps**
|
5603
|
+
> AsposeResponse post_document_text_stamps(name, stamps, opts)
|
5604
|
+
|
5605
|
+
Add document pages text stamps.
|
5606
|
+
|
5607
|
+
### Parameters
|
5608
|
+
|
5609
|
+
Name | Type | Description | Notes
|
5610
|
+
------------- | ------------- | ------------- | -------------
|
5611
|
+
**name** | **String**| The document name. |
|
5612
|
+
**stamps** | [**Array<TextStamp>**](TextStamp.md)| The array of stamp. |
|
5613
|
+
**storage** | **String**| The document storage. | [optional]
|
5614
|
+
**folder** | **String**| The document folder. | [optional]
|
5615
|
+
**password** | **String**| Base64 encoded password. | [optional]
|
5616
|
+
|
5617
|
+
### Return type
|
5618
|
+
|
5619
|
+
[**AsposeResponse**](AsposeResponse.md)
|
5620
|
+
|
5621
|
+
### HTTP request headers
|
5622
|
+
|
5623
|
+
- **Content-Type**: application/json
|
5624
|
+
- **Accept**: application/json
|
5625
|
+
|
5626
|
+
|
5627
|
+
|
5519
5628
|
# **post_encrypt_document_in_storage**
|
5520
5629
|
> AsposeResponse post_encrypt_document_in_storage(name, user_password, owner_password, crypto_algorithm, opts)
|
5521
5630
|
|
@@ -7005,6 +7114,34 @@ Name | Type | Description | Notes
|
|
7005
7114
|
|
7006
7115
|
|
7007
7116
|
|
7117
|
+
# **put_create_pdf_from_layer**
|
7118
|
+
> AsposeResponse put_create_pdf_from_layer(name, page_number, out_path, layer_id, opts)
|
7119
|
+
|
7120
|
+
Create a separate PDF from a PDF Layer and upload resulting file to storage.
|
7121
|
+
|
7122
|
+
### Parameters
|
7123
|
+
|
7124
|
+
Name | Type | Description | Notes
|
7125
|
+
------------- | ------------- | ------------- | -------------
|
7126
|
+
**name** | **String**| The document name. |
|
7127
|
+
**page_number** | **Integer**| The page number. |
|
7128
|
+
**out_path** | **String**| The out path of result image. |
|
7129
|
+
**layer_id** | **String**| Layer Id. |
|
7130
|
+
**folder** | **String**| The document folder. | [optional]
|
7131
|
+
**storage** | **String**| The document storage. | [optional]
|
7132
|
+
**pass_base64** | **String**| The password (Base64). | [optional]
|
7133
|
+
|
7134
|
+
### Return type
|
7135
|
+
|
7136
|
+
[**AsposeResponse**](AsposeResponse.md)
|
7137
|
+
|
7138
|
+
### HTTP request headers
|
7139
|
+
|
7140
|
+
- **Content-Type**: application/json
|
7141
|
+
- **Accept**: application/json
|
7142
|
+
|
7143
|
+
|
7144
|
+
|
7008
7145
|
# **put_decrypt_document**
|
7009
7146
|
> AsposeResponse put_decrypt_document(out_path, password, opts)
|
7010
7147
|
|