cloudmersive-convert-api-client 1.5.8 → 1.5.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +18 -4
- data/docs/AddPdfAnnotationRequest.md +9 -0
- data/docs/EditDocumentApi.md +56 -1
- data/docs/EditPdfApi.md +345 -0
- data/docs/GetPdfAnnotationsResult.md +9 -0
- data/docs/PdfAnnotation.md +19 -0
- data/docs/PresentationResult.md +10 -0
- data/docs/RemovePptxSlidesRequest.md +11 -0
- data/docs/SetPdfMetadataRequest.md +2 -2
- data/docs/SplitDocumentApi.md +65 -2
- data/docs/SplitPptxPresentationResult.md +9 -0
- data/docs/WorksheetResult.md +1 -0
- data/lib/cloudmersive-convert-api-client.rb +6 -0
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +57 -2
- data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +370 -0
- data/lib/cloudmersive-convert-api-client/api/split_document_api.rb +62 -0
- data/lib/cloudmersive-convert-api-client/models/add_pdf_annotation_request.rb +217 -0
- data/lib/cloudmersive-convert-api-client/models/get_pdf_annotations_result.rb +201 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_annotation.rb +299 -0
- data/lib/cloudmersive-convert-api-client/models/presentation_result.rb +225 -0
- data/lib/cloudmersive-convert-api-client/models/remove_pptx_slides_request.rb +235 -0
- data/lib/cloudmersive-convert-api-client/models/set_pdf_metadata_request.rb +3 -1
- data/lib/cloudmersive-convert-api-client/models/split_pptx_presentation_result.rb +200 -0
- data/lib/cloudmersive-convert-api-client/models/worksheet_result.rb +30 -4
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/edit_document_api_spec.rb +13 -1
- data/spec/api/edit_pdf_api_spec.rb +77 -0
- data/spec/api/split_document_api_spec.rb +14 -0
- data/spec/models/add_pdf_annotation_request_spec.rb +48 -0
- data/spec/models/get_pdf_annotations_result_spec.rb +48 -0
- data/spec/models/pdf_annotation_spec.rb +108 -0
- data/spec/models/presentation_result_spec.rb +54 -0
- data/spec/models/remove_pptx_slides_request_spec.rb +60 -0
- data/spec/models/split_pptx_presentation_result_spec.rb +48 -0
- data/spec/models/worksheet_result_spec.rb +6 -0
- metadata +20 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f61dd567ad35613ad0aa341f97cd2815c36a739778c1b29e28f883d23dc0aea6
|
4
|
+
data.tar.gz: 9a444ff028b884768d6438a7db38f800e73bf2f6c775351122c16a6e2cbe1a12
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6a71aab3822ae00814d0a1b2989c4d73616a398a7a988c063eb70c997ca838d02dee6fc0a7a8cbf926ff0b046b896d7759d6a91c15bfa8550a58d1283a48d6d0
|
7
|
+
data.tar.gz: a878fafc82c85e0b5301e0ac63e847dcca73ab785d6306b907f967223c9b66046879853dc3de44e2b2314f450a5ac783f33c39e6db1a80da16d9930157418c45
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 1.5.
|
10
|
+
- Package version: 1.5.9
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-convert-api-client-1.5.
|
26
|
+
gem install ./cloudmersive-convert-api-client-1.5.9.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.5.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.5.9.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'cloudmersive-convert-api-client', '~> 1.5.
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 1.5.9'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -170,6 +170,7 @@ Class | Method | HTTP request | Description
|
|
170
170
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_update_table_cell**](docs/EditDocumentApi.md#edit_document_docx_update_table_cell) | **POST** /convert/edit/docx/update-table-cell | Update, set contents of a table cell in an existing table in a Word DOCX document
|
171
171
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_update_table_row**](docs/EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
|
172
172
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_finish_editing**](docs/EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Download result from document editing
|
173
|
+
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_pptx_delete_slides**](docs/EditDocumentApi.md#edit_document_pptx_delete_slides) | **POST** /convert/edit/pptx/delete-slides | Delete, remove slides from a PowerPoint PPTX presentation document
|
173
174
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_pptx_replace**](docs/EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
174
175
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_create_blank_spreadsheet**](docs/EditDocumentApi.md#edit_document_xlsx_create_blank_spreadsheet) | **POST** /convert/edit/xlsx/create/blank | Create a blank Excel XLSX spreadsheet
|
175
176
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_cell_by_index**](docs/EditDocumentApi.md#edit_document_xlsx_get_cell_by_index) | **POST** /convert/edit/xlsx/get-cell/by-index | Get cell from an Excel XLSX spreadsheet, worksheet by index
|
@@ -179,14 +180,20 @@ Class | Method | HTTP request | Description
|
|
179
180
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_styles**](docs/EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
|
180
181
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_worksheets**](docs/EditDocumentApi.md#edit_document_xlsx_get_worksheets) | **POST** /convert/edit/xlsx/get-worksheets | Get worksheets from a Excel XLSX spreadsheet
|
181
182
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_insert_worksheet**](docs/EditDocumentApi.md#edit_document_xlsx_insert_worksheet) | **POST** /convert/edit/xlsx/insert-worksheet | Insert a new worksheet into an Excel XLSX spreadsheet
|
183
|
+
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_add_annotations**](docs/EditPdfApi.md#edit_pdf_add_annotations) | **POST** /convert/edit/pdf/annotations/add-item | Add one or more PDF annotations, comments in the PDF document
|
182
184
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_decrypt**](docs/EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
|
183
185
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_delete_pages**](docs/EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove / delete pages from a PDF document
|
184
186
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_encrypt**](docs/EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
|
187
|
+
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_annotations**](docs/EditPdfApi.md#edit_pdf_get_annotations) | **POST** /convert/edit/pdf/annotations/list | Get PDF annotations, including comments in the document
|
185
188
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_form_fields**](docs/EditPdfApi.md#edit_pdf_get_form_fields) | **POST** /convert/edit/pdf/form/get-fields | Gets PDF Form fields and values
|
186
189
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_metadata**](docs/EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
|
187
190
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_pdf_text_by_pages**](docs/EditPdfApi.md#edit_pdf_get_pdf_text_by_pages) | **POST** /convert/edit/pdf/pages/get-text | Get text in a PDF document by page
|
188
191
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_insert_pages**](docs/EditPdfApi.md#edit_pdf_insert_pages) | **POST** /convert/edit/pdf/pages/insert | Insert / copy pages from one PDF document into another
|
189
192
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_rasterize**](docs/EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
|
193
|
+
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_remove_all_annotations**](docs/EditPdfApi.md#edit_pdf_remove_all_annotations) | **POST** /convert/edit/pdf/annotations/remove-all | Remove all PDF annotations, including comments in the document
|
194
|
+
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_remove_annotation_item**](docs/EditPdfApi.md#edit_pdf_remove_annotation_item) | **POST** /convert/edit/pdf/annotations/remove-item | Remove a specific PDF annotation, comment in the document
|
195
|
+
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_rotate_all_pages**](docs/EditPdfApi.md#edit_pdf_rotate_all_pages) | **POST** /convert/edit/pdf/pages/rotate/all | Rotate all pages in a PDF document
|
196
|
+
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_rotate_page_range**](docs/EditPdfApi.md#edit_pdf_rotate_page_range) | **POST** /convert/edit/pdf/pages/rotate/page-range | Rotate a range, subset of pages in a PDF document
|
190
197
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_set_form_fields**](docs/EditPdfApi.md#edit_pdf_set_form_fields) | **POST** /convert/edit/pdf/form/set-fields | Sets ands fills PDF Form field values
|
191
198
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_set_metadata**](docs/EditPdfApi.md#edit_pdf_set_metadata) | **POST** /convert/edit/pdf/set-metadata | Sets PDF document metadata
|
192
199
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_set_permissions**](docs/EditPdfApi.md#edit_pdf_set_permissions) | **POST** /convert/edit/pdf/encrypt/set-permissions | Encrypt, password-protect and set restricted permissions on a PDF
|
@@ -201,6 +208,7 @@ Class | Method | HTTP request | Description
|
|
201
208
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_xlsx**](docs/MergeDocumentApi.md#merge_document_xlsx) | **POST** /convert/merge/xlsx | Merge Two Excel XLSX Together
|
202
209
|
*CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_xlsx_multi**](docs/MergeDocumentApi.md#merge_document_xlsx_multi) | **POST** /convert/merge/xlsx/multi | Merge Multple Excel XLSX Together
|
203
210
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_pdf_by_page**](docs/SplitDocumentApi.md#split_document_pdf_by_page) | **POST** /convert/split/pdf | Split a PDF file into separate PDF files, one per page
|
211
|
+
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_pptx**](docs/SplitDocumentApi.md#split_document_pptx) | **POST** /convert/split/pptx | Split a single PowerPoint Presentation PPTX into Separate Slides
|
204
212
|
*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_xlsx**](docs/SplitDocumentApi.md#split_document_xlsx) | **POST** /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets
|
205
213
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_autodetect_validation**](docs/ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
|
206
214
|
*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_docx_validation**](docs/ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
|
@@ -215,6 +223,7 @@ Class | Method | HTTP request | Description
|
|
215
223
|
|
216
224
|
## Documentation for Models
|
217
225
|
|
226
|
+
- [CloudmersiveConvertApiClient::AddPdfAnnotationRequest](docs/AddPdfAnnotationRequest.md)
|
218
227
|
- [CloudmersiveConvertApiClient::AlternateFileFormatCandidate](docs/AlternateFileFormatCandidate.md)
|
219
228
|
- [CloudmersiveConvertApiClient::AutodetectDocumentValidationResult](docs/AutodetectDocumentValidationResult.md)
|
220
229
|
- [CloudmersiveConvertApiClient::AutodetectGetInfoResult](docs/AutodetectGetInfoResult.md)
|
@@ -274,6 +283,7 @@ Class | Method | HTTP request | Description
|
|
274
283
|
- [CloudmersiveConvertApiClient::GetDocxTablesRequest](docs/GetDocxTablesRequest.md)
|
275
284
|
- [CloudmersiveConvertApiClient::GetDocxTablesResponse](docs/GetDocxTablesResponse.md)
|
276
285
|
- [CloudmersiveConvertApiClient::GetImageInfoResult](docs/GetImageInfoResult.md)
|
286
|
+
- [CloudmersiveConvertApiClient::GetPdfAnnotationsResult](docs/GetPdfAnnotationsResult.md)
|
277
287
|
- [CloudmersiveConvertApiClient::GetXlsxCellRequest](docs/GetXlsxCellRequest.md)
|
278
288
|
- [CloudmersiveConvertApiClient::GetXlsxCellResponse](docs/GetXlsxCellResponse.md)
|
279
289
|
- [CloudmersiveConvertApiClient::GetXlsxColumnsRequest](docs/GetXlsxColumnsRequest.md)
|
@@ -305,6 +315,7 @@ Class | Method | HTTP request | Description
|
|
305
315
|
- [CloudmersiveConvertApiClient::InsertXlsxWorksheetResponse](docs/InsertXlsxWorksheetResponse.md)
|
306
316
|
- [CloudmersiveConvertApiClient::MultipageImageFormatConversionResult](docs/MultipageImageFormatConversionResult.md)
|
307
317
|
- [CloudmersiveConvertApiClient::PageConversionResult](docs/PageConversionResult.md)
|
318
|
+
- [CloudmersiveConvertApiClient::PdfAnnotation](docs/PdfAnnotation.md)
|
308
319
|
- [CloudmersiveConvertApiClient::PdfDocument](docs/PdfDocument.md)
|
309
320
|
- [CloudmersiveConvertApiClient::PdfFormField](docs/PdfFormField.md)
|
310
321
|
- [CloudmersiveConvertApiClient::PdfFormFields](docs/PdfFormFields.md)
|
@@ -312,15 +323,18 @@ Class | Method | HTTP request | Description
|
|
312
323
|
- [CloudmersiveConvertApiClient::PdfPageText](docs/PdfPageText.md)
|
313
324
|
- [CloudmersiveConvertApiClient::PdfTextByPageResult](docs/PdfTextByPageResult.md)
|
314
325
|
- [CloudmersiveConvertApiClient::PdfToPngResult](docs/PdfToPngResult.md)
|
326
|
+
- [CloudmersiveConvertApiClient::PresentationResult](docs/PresentationResult.md)
|
315
327
|
- [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest](docs/RemoveDocxHeadersAndFootersRequest.md)
|
316
328
|
- [CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersResponse](docs/RemoveDocxHeadersAndFootersResponse.md)
|
317
329
|
- [CloudmersiveConvertApiClient::RemoveDocxPagesRequest](docs/RemoveDocxPagesRequest.md)
|
330
|
+
- [CloudmersiveConvertApiClient::RemovePptxSlidesRequest](docs/RemovePptxSlidesRequest.md)
|
318
331
|
- [CloudmersiveConvertApiClient::ReplaceStringRequest](docs/ReplaceStringRequest.md)
|
319
332
|
- [CloudmersiveConvertApiClient::ScreenshotRequest](docs/ScreenshotRequest.md)
|
320
333
|
- [CloudmersiveConvertApiClient::SetFormFieldValue](docs/SetFormFieldValue.md)
|
321
334
|
- [CloudmersiveConvertApiClient::SetPdfFormFieldsRequest](docs/SetPdfFormFieldsRequest.md)
|
322
335
|
- [CloudmersiveConvertApiClient::SetPdfMetadataRequest](docs/SetPdfMetadataRequest.md)
|
323
336
|
- [CloudmersiveConvertApiClient::SplitPdfResult](docs/SplitPdfResult.md)
|
337
|
+
- [CloudmersiveConvertApiClient::SplitPptxPresentationResult](docs/SplitPptxPresentationResult.md)
|
324
338
|
- [CloudmersiveConvertApiClient::SplitXlsxWorksheetResult](docs/SplitXlsxWorksheetResult.md)
|
325
339
|
- [CloudmersiveConvertApiClient::TextConversionResult](docs/TextConversionResult.md)
|
326
340
|
- [CloudmersiveConvertApiClient::UpdateDocxTableCellRequest](docs/UpdateDocxTableCellRequest.md)
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::AddPdfAnnotationRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**input_file_bytes** | **String** | Input file contents bytes for the file to modify | [optional]
|
7
|
+
**annotations_to_add** | [**Array<PdfAnnotation>**](PdfAnnotation.md) | Annotations to add to the PDF file | [optional]
|
8
|
+
|
9
|
+
|
data/docs/EditDocumentApi.md
CHANGED
@@ -30,6 +30,7 @@ Method | HTTP request | Description
|
|
30
30
|
[**edit_document_docx_update_table_cell**](EditDocumentApi.md#edit_document_docx_update_table_cell) | **POST** /convert/edit/docx/update-table-cell | Update, set contents of a table cell in an existing table in a Word DOCX document
|
31
31
|
[**edit_document_docx_update_table_row**](EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
|
32
32
|
[**edit_document_finish_editing**](EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Download result from document editing
|
33
|
+
[**edit_document_pptx_delete_slides**](EditDocumentApi.md#edit_document_pptx_delete_slides) | **POST** /convert/edit/pptx/delete-slides | Delete, remove slides from a PowerPoint PPTX presentation document
|
33
34
|
[**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
34
35
|
[**edit_document_xlsx_create_blank_spreadsheet**](EditDocumentApi.md#edit_document_xlsx_create_blank_spreadsheet) | **POST** /convert/edit/xlsx/create/blank | Create a blank Excel XLSX spreadsheet
|
35
36
|
[**edit_document_xlsx_get_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_get_cell_by_index) | **POST** /convert/edit/xlsx/get-cell/by-index | Get cell from an Excel XLSX spreadsheet, worksheet by index
|
@@ -208,7 +209,7 @@ Name | Type | Description | Notes
|
|
208
209
|
|
209
210
|
Delete, remove pages from a Word DOCX document
|
210
211
|
|
211
|
-
Returns the
|
212
|
+
Returns the edited Word Document in the Word Document (DOCX) format file with the specified pages removed
|
212
213
|
|
213
214
|
### Example
|
214
215
|
```ruby
|
@@ -1445,6 +1446,60 @@ Name | Type | Description | Notes
|
|
1445
1446
|
|
1446
1447
|
|
1447
1448
|
|
1449
|
+
# **edit_document_pptx_delete_slides**
|
1450
|
+
> String edit_document_pptx_delete_slides(req_config)
|
1451
|
+
|
1452
|
+
Delete, remove slides from a PowerPoint PPTX presentation document
|
1453
|
+
|
1454
|
+
Edits the input PowerPoint PPTX presentation document to remove the specified slides
|
1455
|
+
|
1456
|
+
### Example
|
1457
|
+
```ruby
|
1458
|
+
# load the gem
|
1459
|
+
require 'cloudmersive-convert-api-client'
|
1460
|
+
# setup authorization
|
1461
|
+
CloudmersiveConvertApiClient.configure do |config|
|
1462
|
+
# Configure API key authorization: Apikey
|
1463
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
1464
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1465
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
1466
|
+
end
|
1467
|
+
|
1468
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
1469
|
+
|
1470
|
+
req_config = CloudmersiveConvertApiClient::RemovePptxSlidesRequest.new # RemovePptxSlidesRequest | Presentation input request
|
1471
|
+
|
1472
|
+
|
1473
|
+
begin
|
1474
|
+
#Delete, remove slides from a PowerPoint PPTX presentation document
|
1475
|
+
result = api_instance.edit_document_pptx_delete_slides(req_config)
|
1476
|
+
p result
|
1477
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
1478
|
+
puts "Exception when calling EditDocumentApi->edit_document_pptx_delete_slides: #{e}"
|
1479
|
+
end
|
1480
|
+
```
|
1481
|
+
|
1482
|
+
### Parameters
|
1483
|
+
|
1484
|
+
Name | Type | Description | Notes
|
1485
|
+
------------- | ------------- | ------------- | -------------
|
1486
|
+
**req_config** | [**RemovePptxSlidesRequest**](RemovePptxSlidesRequest.md)| Presentation input request |
|
1487
|
+
|
1488
|
+
### Return type
|
1489
|
+
|
1490
|
+
**String**
|
1491
|
+
|
1492
|
+
### Authorization
|
1493
|
+
|
1494
|
+
[Apikey](../README.md#Apikey)
|
1495
|
+
|
1496
|
+
### HTTP request headers
|
1497
|
+
|
1498
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
1499
|
+
- **Accept**: application/octet-stream
|
1500
|
+
|
1501
|
+
|
1502
|
+
|
1448
1503
|
# **edit_document_pptx_replace**
|
1449
1504
|
> String edit_document_pptx_replace(req_config)
|
1450
1505
|
|
data/docs/EditPdfApi.md
CHANGED
@@ -4,20 +4,80 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**edit_pdf_add_annotations**](EditPdfApi.md#edit_pdf_add_annotations) | **POST** /convert/edit/pdf/annotations/add-item | Add one or more PDF annotations, comments in the PDF document
|
7
8
|
[**edit_pdf_decrypt**](EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
|
8
9
|
[**edit_pdf_delete_pages**](EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove / delete pages from a PDF document
|
9
10
|
[**edit_pdf_encrypt**](EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
|
11
|
+
[**edit_pdf_get_annotations**](EditPdfApi.md#edit_pdf_get_annotations) | **POST** /convert/edit/pdf/annotations/list | Get PDF annotations, including comments in the document
|
10
12
|
[**edit_pdf_get_form_fields**](EditPdfApi.md#edit_pdf_get_form_fields) | **POST** /convert/edit/pdf/form/get-fields | Gets PDF Form fields and values
|
11
13
|
[**edit_pdf_get_metadata**](EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
|
12
14
|
[**edit_pdf_get_pdf_text_by_pages**](EditPdfApi.md#edit_pdf_get_pdf_text_by_pages) | **POST** /convert/edit/pdf/pages/get-text | Get text in a PDF document by page
|
13
15
|
[**edit_pdf_insert_pages**](EditPdfApi.md#edit_pdf_insert_pages) | **POST** /convert/edit/pdf/pages/insert | Insert / copy pages from one PDF document into another
|
14
16
|
[**edit_pdf_rasterize**](EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
|
17
|
+
[**edit_pdf_remove_all_annotations**](EditPdfApi.md#edit_pdf_remove_all_annotations) | **POST** /convert/edit/pdf/annotations/remove-all | Remove all PDF annotations, including comments in the document
|
18
|
+
[**edit_pdf_remove_annotation_item**](EditPdfApi.md#edit_pdf_remove_annotation_item) | **POST** /convert/edit/pdf/annotations/remove-item | Remove a specific PDF annotation, comment in the document
|
19
|
+
[**edit_pdf_rotate_all_pages**](EditPdfApi.md#edit_pdf_rotate_all_pages) | **POST** /convert/edit/pdf/pages/rotate/all | Rotate all pages in a PDF document
|
20
|
+
[**edit_pdf_rotate_page_range**](EditPdfApi.md#edit_pdf_rotate_page_range) | **POST** /convert/edit/pdf/pages/rotate/page-range | Rotate a range, subset of pages in a PDF document
|
15
21
|
[**edit_pdf_set_form_fields**](EditPdfApi.md#edit_pdf_set_form_fields) | **POST** /convert/edit/pdf/form/set-fields | Sets ands fills PDF Form field values
|
16
22
|
[**edit_pdf_set_metadata**](EditPdfApi.md#edit_pdf_set_metadata) | **POST** /convert/edit/pdf/set-metadata | Sets PDF document metadata
|
17
23
|
[**edit_pdf_set_permissions**](EditPdfApi.md#edit_pdf_set_permissions) | **POST** /convert/edit/pdf/encrypt/set-permissions | Encrypt, password-protect and set restricted permissions on a PDF
|
18
24
|
[**edit_pdf_watermark_text**](EditPdfApi.md#edit_pdf_watermark_text) | **POST** /convert/edit/pdf/watermark/text | Add a text watermark to a PDF
|
19
25
|
|
20
26
|
|
27
|
+
# **edit_pdf_add_annotations**
|
28
|
+
> String edit_pdf_add_annotations(request)
|
29
|
+
|
30
|
+
Add one or more PDF annotations, comments in the PDF document
|
31
|
+
|
32
|
+
Adds one or more annotations, comments to a PDF document.
|
33
|
+
|
34
|
+
### Example
|
35
|
+
```ruby
|
36
|
+
# load the gem
|
37
|
+
require 'cloudmersive-convert-api-client'
|
38
|
+
# setup authorization
|
39
|
+
CloudmersiveConvertApiClient.configure do |config|
|
40
|
+
# Configure API key authorization: Apikey
|
41
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
42
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
43
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
44
|
+
end
|
45
|
+
|
46
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
47
|
+
|
48
|
+
request = CloudmersiveConvertApiClient::AddPdfAnnotationRequest.new # AddPdfAnnotationRequest |
|
49
|
+
|
50
|
+
|
51
|
+
begin
|
52
|
+
#Add one or more PDF annotations, comments in the PDF document
|
53
|
+
result = api_instance.edit_pdf_add_annotations(request)
|
54
|
+
p result
|
55
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
56
|
+
puts "Exception when calling EditPdfApi->edit_pdf_add_annotations: #{e}"
|
57
|
+
end
|
58
|
+
```
|
59
|
+
|
60
|
+
### Parameters
|
61
|
+
|
62
|
+
Name | Type | Description | Notes
|
63
|
+
------------- | ------------- | ------------- | -------------
|
64
|
+
**request** | [**AddPdfAnnotationRequest**](AddPdfAnnotationRequest.md)| |
|
65
|
+
|
66
|
+
### Return type
|
67
|
+
|
68
|
+
**String**
|
69
|
+
|
70
|
+
### Authorization
|
71
|
+
|
72
|
+
[Apikey](../README.md#Apikey)
|
73
|
+
|
74
|
+
### HTTP request headers
|
75
|
+
|
76
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
77
|
+
- **Accept**: application/octet-stream
|
78
|
+
|
79
|
+
|
80
|
+
|
21
81
|
# **edit_pdf_decrypt**
|
22
82
|
> String edit_pdf_decrypt(password, input_file)
|
23
83
|
|
@@ -197,6 +257,60 @@ Name | Type | Description | Notes
|
|
197
257
|
|
198
258
|
|
199
259
|
|
260
|
+
# **edit_pdf_get_annotations**
|
261
|
+
> GetPdfAnnotationsResult edit_pdf_get_annotations(input_file)
|
262
|
+
|
263
|
+
Get PDF annotations, including comments in the document
|
264
|
+
|
265
|
+
Enumerates the annotations, including comments and notes, in a PDF document.
|
266
|
+
|
267
|
+
### Example
|
268
|
+
```ruby
|
269
|
+
# load the gem
|
270
|
+
require 'cloudmersive-convert-api-client'
|
271
|
+
# setup authorization
|
272
|
+
CloudmersiveConvertApiClient.configure do |config|
|
273
|
+
# Configure API key authorization: Apikey
|
274
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
275
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
276
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
277
|
+
end
|
278
|
+
|
279
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
280
|
+
|
281
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
282
|
+
|
283
|
+
|
284
|
+
begin
|
285
|
+
#Get PDF annotations, including comments in the document
|
286
|
+
result = api_instance.edit_pdf_get_annotations(input_file)
|
287
|
+
p result
|
288
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
289
|
+
puts "Exception when calling EditPdfApi->edit_pdf_get_annotations: #{e}"
|
290
|
+
end
|
291
|
+
```
|
292
|
+
|
293
|
+
### Parameters
|
294
|
+
|
295
|
+
Name | Type | Description | Notes
|
296
|
+
------------- | ------------- | ------------- | -------------
|
297
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
298
|
+
|
299
|
+
### Return type
|
300
|
+
|
301
|
+
[**GetPdfAnnotationsResult**](GetPdfAnnotationsResult.md)
|
302
|
+
|
303
|
+
### Authorization
|
304
|
+
|
305
|
+
[Apikey](../README.md#Apikey)
|
306
|
+
|
307
|
+
### HTTP request headers
|
308
|
+
|
309
|
+
- **Content-Type**: multipart/form-data
|
310
|
+
- **Accept**: application/octet-stream
|
311
|
+
|
312
|
+
|
313
|
+
|
200
314
|
# **edit_pdf_get_form_fields**
|
201
315
|
> PdfFormFields edit_pdf_get_form_fields(input_file)
|
202
316
|
|
@@ -479,6 +593,237 @@ Name | Type | Description | Notes
|
|
479
593
|
|
480
594
|
|
481
595
|
|
596
|
+
# **edit_pdf_remove_all_annotations**
|
597
|
+
> String edit_pdf_remove_all_annotations(input_file)
|
598
|
+
|
599
|
+
Remove all PDF annotations, including comments in the document
|
600
|
+
|
601
|
+
Removes all of the annotations, including comments and notes, in a PDF document.
|
602
|
+
|
603
|
+
### Example
|
604
|
+
```ruby
|
605
|
+
# load the gem
|
606
|
+
require 'cloudmersive-convert-api-client'
|
607
|
+
# setup authorization
|
608
|
+
CloudmersiveConvertApiClient.configure do |config|
|
609
|
+
# Configure API key authorization: Apikey
|
610
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
611
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
612
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
613
|
+
end
|
614
|
+
|
615
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
616
|
+
|
617
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
618
|
+
|
619
|
+
|
620
|
+
begin
|
621
|
+
#Remove all PDF annotations, including comments in the document
|
622
|
+
result = api_instance.edit_pdf_remove_all_annotations(input_file)
|
623
|
+
p result
|
624
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
625
|
+
puts "Exception when calling EditPdfApi->edit_pdf_remove_all_annotations: #{e}"
|
626
|
+
end
|
627
|
+
```
|
628
|
+
|
629
|
+
### Parameters
|
630
|
+
|
631
|
+
Name | Type | Description | Notes
|
632
|
+
------------- | ------------- | ------------- | -------------
|
633
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
634
|
+
|
635
|
+
### Return type
|
636
|
+
|
637
|
+
**String**
|
638
|
+
|
639
|
+
### Authorization
|
640
|
+
|
641
|
+
[Apikey](../README.md#Apikey)
|
642
|
+
|
643
|
+
### HTTP request headers
|
644
|
+
|
645
|
+
- **Content-Type**: multipart/form-data
|
646
|
+
- **Accept**: application/octet-stream
|
647
|
+
|
648
|
+
|
649
|
+
|
650
|
+
# **edit_pdf_remove_annotation_item**
|
651
|
+
> String edit_pdf_remove_annotation_item(input_file, annotation_index)
|
652
|
+
|
653
|
+
Remove a specific PDF annotation, comment in the document
|
654
|
+
|
655
|
+
Removes a specific annotation in a PDF document, using the AnnotationIndex. To enumerate AnnotationIndex for all of the annotations in the PDF document, use the /edit/pdf/annotations/list API.
|
656
|
+
|
657
|
+
### Example
|
658
|
+
```ruby
|
659
|
+
# load the gem
|
660
|
+
require 'cloudmersive-convert-api-client'
|
661
|
+
# setup authorization
|
662
|
+
CloudmersiveConvertApiClient.configure do |config|
|
663
|
+
# Configure API key authorization: Apikey
|
664
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
665
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
666
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
667
|
+
end
|
668
|
+
|
669
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
670
|
+
|
671
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
672
|
+
|
673
|
+
annotation_index = 56 # Integer | The 0-based index of the annotation in the document
|
674
|
+
|
675
|
+
|
676
|
+
begin
|
677
|
+
#Remove a specific PDF annotation, comment in the document
|
678
|
+
result = api_instance.edit_pdf_remove_annotation_item(input_file, annotation_index)
|
679
|
+
p result
|
680
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
681
|
+
puts "Exception when calling EditPdfApi->edit_pdf_remove_annotation_item: #{e}"
|
682
|
+
end
|
683
|
+
```
|
684
|
+
|
685
|
+
### Parameters
|
686
|
+
|
687
|
+
Name | Type | Description | Notes
|
688
|
+
------------- | ------------- | ------------- | -------------
|
689
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
690
|
+
**annotation_index** | **Integer**| The 0-based index of the annotation in the document |
|
691
|
+
|
692
|
+
### Return type
|
693
|
+
|
694
|
+
**String**
|
695
|
+
|
696
|
+
### Authorization
|
697
|
+
|
698
|
+
[Apikey](../README.md#Apikey)
|
699
|
+
|
700
|
+
### HTTP request headers
|
701
|
+
|
702
|
+
- **Content-Type**: multipart/form-data
|
703
|
+
- **Accept**: application/octet-stream
|
704
|
+
|
705
|
+
|
706
|
+
|
707
|
+
# **edit_pdf_rotate_all_pages**
|
708
|
+
> String edit_pdf_rotate_all_pages(input_file, rotation_angle)
|
709
|
+
|
710
|
+
Rotate all pages in a PDF document
|
711
|
+
|
712
|
+
Rotate all of the pages in a PDF document by a multiple of 90 degrees
|
713
|
+
|
714
|
+
### Example
|
715
|
+
```ruby
|
716
|
+
# load the gem
|
717
|
+
require 'cloudmersive-convert-api-client'
|
718
|
+
# setup authorization
|
719
|
+
CloudmersiveConvertApiClient.configure do |config|
|
720
|
+
# Configure API key authorization: Apikey
|
721
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
722
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
723
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
724
|
+
end
|
725
|
+
|
726
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
727
|
+
|
728
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
729
|
+
|
730
|
+
rotation_angle = 56 # Integer | The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc.
|
731
|
+
|
732
|
+
|
733
|
+
begin
|
734
|
+
#Rotate all pages in a PDF document
|
735
|
+
result = api_instance.edit_pdf_rotate_all_pages(input_file, rotation_angle)
|
736
|
+
p result
|
737
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
738
|
+
puts "Exception when calling EditPdfApi->edit_pdf_rotate_all_pages: #{e}"
|
739
|
+
end
|
740
|
+
```
|
741
|
+
|
742
|
+
### Parameters
|
743
|
+
|
744
|
+
Name | Type | Description | Notes
|
745
|
+
------------- | ------------- | ------------- | -------------
|
746
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
747
|
+
**rotation_angle** | **Integer**| The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc. |
|
748
|
+
|
749
|
+
### Return type
|
750
|
+
|
751
|
+
**String**
|
752
|
+
|
753
|
+
### Authorization
|
754
|
+
|
755
|
+
[Apikey](../README.md#Apikey)
|
756
|
+
|
757
|
+
### HTTP request headers
|
758
|
+
|
759
|
+
- **Content-Type**: multipart/form-data
|
760
|
+
- **Accept**: application/octet-stream
|
761
|
+
|
762
|
+
|
763
|
+
|
764
|
+
# **edit_pdf_rotate_page_range**
|
765
|
+
> String edit_pdf_rotate_page_range(input_file, rotation_angle, page_start, page_end)
|
766
|
+
|
767
|
+
Rotate a range, subset of pages in a PDF document
|
768
|
+
|
769
|
+
Rotate a range of specific pages in a PDF document by a multiple of 90 degrees
|
770
|
+
|
771
|
+
### Example
|
772
|
+
```ruby
|
773
|
+
# load the gem
|
774
|
+
require 'cloudmersive-convert-api-client'
|
775
|
+
# setup authorization
|
776
|
+
CloudmersiveConvertApiClient.configure do |config|
|
777
|
+
# Configure API key authorization: Apikey
|
778
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
779
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
780
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
781
|
+
end
|
782
|
+
|
783
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
784
|
+
|
785
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
786
|
+
|
787
|
+
rotation_angle = 56 # Integer | The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc.
|
788
|
+
|
789
|
+
page_start = 56 # Integer | Page number (1 based) to start rotating pages from (inclusive).
|
790
|
+
|
791
|
+
page_end = 56 # Integer | Page number (1 based) to stop rotating pages from (inclusive).
|
792
|
+
|
793
|
+
|
794
|
+
begin
|
795
|
+
#Rotate a range, subset of pages in a PDF document
|
796
|
+
result = api_instance.edit_pdf_rotate_page_range(input_file, rotation_angle, page_start, page_end)
|
797
|
+
p result
|
798
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
799
|
+
puts "Exception when calling EditPdfApi->edit_pdf_rotate_page_range: #{e}"
|
800
|
+
end
|
801
|
+
```
|
802
|
+
|
803
|
+
### Parameters
|
804
|
+
|
805
|
+
Name | Type | Description | Notes
|
806
|
+
------------- | ------------- | ------------- | -------------
|
807
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
808
|
+
**rotation_angle** | **Integer**| The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc. |
|
809
|
+
**page_start** | **Integer**| Page number (1 based) to start rotating pages from (inclusive). |
|
810
|
+
**page_end** | **Integer**| Page number (1 based) to stop rotating pages from (inclusive). |
|
811
|
+
|
812
|
+
### Return type
|
813
|
+
|
814
|
+
**String**
|
815
|
+
|
816
|
+
### Authorization
|
817
|
+
|
818
|
+
[Apikey](../README.md#Apikey)
|
819
|
+
|
820
|
+
### HTTP request headers
|
821
|
+
|
822
|
+
- **Content-Type**: multipart/form-data
|
823
|
+
- **Accept**: application/octet-stream
|
824
|
+
|
825
|
+
|
826
|
+
|
482
827
|
# **edit_pdf_set_form_fields**
|
483
828
|
> String edit_pdf_set_form_fields(field_values)
|
484
829
|
|