cloudmersive-convert-api-client 2.2.6 → 2.3.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 +54 -8
- data/docs/CompareDocumentApi.md +6 -2
- data/docs/ConvertDataApi.md +60 -5
- data/docs/ConvertDocumentApi.md +358 -10
- data/docs/ConvertDocumentBatchJobCreateResult.md +9 -0
- data/docs/ConvertDocumentJobStatusResult.md +12 -0
- data/docs/ConvertImageApi.md +6 -2
- data/docs/ConvertWebApi.md +8 -8
- data/docs/ConvertedPngDirectPage.md +9 -0
- data/docs/DocumentArrayInput.md +8 -0
- data/docs/DocumentItem.md +9 -0
- data/docs/EditDocumentApi.md +124 -2
- data/docs/EditPdfApi.md +244 -2
- data/docs/EditPdfBatchJobCreateResult.md +9 -0
- data/docs/EditPdfJobStatusResult.md +12 -0
- data/docs/JobStatusResult.md +12 -0
- data/docs/MergeBatchJobCreateResult.md +9 -0
- data/docs/MergeDocumentApi.md +440 -0
- data/docs/MergeJobStatusResult.md +12 -0
- data/docs/PdfMetadata.md +2 -0
- data/docs/PdfToPngDirectResult.md +9 -0
- data/docs/PptxPageLayoutInformation.md +11 -0
- data/docs/PptxSplitAdvancedRequest.md +9 -0
- data/docs/PptxSplitAdvancedResponse.md +9 -0
- data/docs/PresentationAdvancedResult.md +9 -0
- data/docs/SplitBatchJobCreateResult.md +9 -0
- data/docs/SplitDocumentApi.md +169 -0
- data/docs/ValidateDocumentApi.md +175 -6
- data/lib/cloudmersive-convert-api-client/api/compare_document_api.rb +3 -0
- data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +57 -4
- data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +354 -11
- data/lib/cloudmersive-convert-api-client/api/convert_image_api.rb +3 -0
- data/lib/cloudmersive-convert-api-client/api/convert_web_api.rb +8 -8
- data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +122 -0
- data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +263 -0
- data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +431 -0
- data/lib/cloudmersive-convert-api-client/api/split_document_api.rb +165 -0
- data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +172 -4
- data/lib/cloudmersive-convert-api-client/models/convert_document_batch_job_create_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/converted_png_direct_page.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/document_array_input.rb +188 -0
- data/lib/cloudmersive-convert-api-client/models/document_item.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/edit_pdf_batch_job_create_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/edit_pdf_job_status_result.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/job_status_result.rb +226 -0
- data/lib/cloudmersive-convert-api-client/models/merge_batch_job_create_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/models/merge_job_status_result.rb +241 -0
- data/lib/cloudmersive-convert-api-client/models/pdf_metadata.rb +24 -4
- data/lib/cloudmersive-convert-api-client/models/pdf_to_png_direct_result.rb +198 -0
- data/lib/cloudmersive-convert-api-client/models/pptx_page_layout_information.rb +216 -0
- data/lib/cloudmersive-convert-api-client/models/pptx_split_advanced_request.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/pptx_split_advanced_response.rb +197 -0
- data/lib/cloudmersive-convert-api-client/models/presentation_advanced_result.rb +211 -0
- data/lib/cloudmersive-convert-api-client/models/presentation_result.rb +1 -1
- data/lib/cloudmersive-convert-api-client/models/split_batch_job_create_result.rb +196 -0
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/lib/cloudmersive-convert-api-client.rb +16 -0
- data/spec/api/compare_document_api_spec.rb +1 -0
- data/spec/api/convert_data_api_spec.rb +14 -2
- data/spec/api/convert_document_api_spec.rb +80 -3
- data/spec/api/convert_image_api_spec.rb +1 -0
- data/spec/api/edit_document_api_spec.rb +28 -0
- data/spec/api/edit_pdf_api_spec.rb +55 -0
- data/spec/api/merge_document_api_spec.rb +96 -0
- data/spec/api/split_document_api_spec.rb +37 -0
- data/spec/api/validate_document_api_spec.rb +39 -2
- data/spec/models/convert_document_batch_job_create_result_spec.rb +47 -0
- data/spec/models/convert_document_job_status_result_spec.rb +65 -0
- data/spec/models/converted_png_direct_page_spec.rb +47 -0
- data/spec/models/document_array_input_spec.rb +41 -0
- data/spec/models/document_item_spec.rb +47 -0
- data/spec/models/edit_pdf_batch_job_create_result_spec.rb +47 -0
- data/spec/models/edit_pdf_job_status_result_spec.rb +65 -0
- data/spec/models/job_status_result_spec.rb +65 -0
- data/spec/models/merge_batch_job_create_result_spec.rb +47 -0
- data/spec/models/merge_job_status_result_spec.rb +65 -0
- data/spec/models/pdf_metadata_spec.rb +12 -0
- data/spec/models/pdf_to_png_direct_result_spec.rb +47 -0
- data/spec/models/pptx_page_layout_information_spec.rb +59 -0
- data/spec/models/pptx_split_advanced_request_spec.rb +47 -0
- data/spec/models/pptx_split_advanced_response_spec.rb +47 -0
- data/spec/models/presentation_advanced_result_spec.rb +47 -0
- data/spec/models/split_batch_job_create_result_spec.rb +47 -0
- metadata +50 -2
data/docs/EditDocumentApi.md
CHANGED
@@ -49,7 +49,9 @@ Method | HTTP request | Description
|
|
49
49
|
[**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
|
50
50
|
[**edit_document_finish_editing**](EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Finish editing document, and download result from document editing
|
51
51
|
[**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
|
52
|
+
[**edit_document_pptx_edit_size_and_orientation**](EditDocumentApi.md#edit_document_pptx_edit_size_and_orientation) | **POST** /convert/edit/pptx/set-size-and-orientation | Set the size and/or orientation of a PowerPoint PPTX presentation document
|
52
53
|
[**edit_document_pptx_get_macro_information**](EditDocumentApi.md#edit_document_pptx_get_macro_information) | **POST** /convert/edit/pptx/get-macros | Get macro information from a PowerPoint PPTX/PPTM presentation document
|
54
|
+
[**edit_document_pptx_get_size_and_orientation**](EditDocumentApi.md#edit_document_pptx_get_size_and_orientation) | **POST** /convert/edit/pptx/get-size-and-orientation | Get the page layout information, including size and orientation of a PowerPoint PPTX presentation document
|
53
55
|
[**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
|
54
56
|
[**edit_document_xlsx_append_row**](EditDocumentApi.md#edit_document_xlsx_append_row) | **POST** /convert/edit/xlsx/append-row | Append row to a Excel XLSX spreadsheet, worksheet
|
55
57
|
[**edit_document_xlsx_clear_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_clear_cell_by_index) | **POST** /convert/edit/xlsx/clear-cell/by-index | Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
|
@@ -129,7 +131,7 @@ Name | Type | Description | Notes
|
|
129
131
|
|
130
132
|
|
131
133
|
# **edit_document_docx_accept_all_track_changes**
|
132
|
-
> String edit_document_docx_accept_all_track_changes(input_file)
|
134
|
+
> String edit_document_docx_accept_all_track_changes(input_file, opts)
|
133
135
|
|
134
136
|
Accept all tracked changes, revisions in a Word DOCX document
|
135
137
|
|
@@ -151,10 +153,13 @@ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
|
151
153
|
|
152
154
|
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
153
155
|
|
156
|
+
opts = {
|
157
|
+
autorepair: true # BOOLEAN | Optional; automatically repair input documents that have errors (default is true)
|
158
|
+
}
|
154
159
|
|
155
160
|
begin
|
156
161
|
#Accept all tracked changes, revisions in a Word DOCX document
|
157
|
-
result = api_instance.edit_document_docx_accept_all_track_changes(input_file)
|
162
|
+
result = api_instance.edit_document_docx_accept_all_track_changes(input_file, opts)
|
158
163
|
p result
|
159
164
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
160
165
|
puts "Exception when calling EditDocumentApi->edit_document_docx_accept_all_track_changes: #{e}"
|
@@ -166,6 +171,7 @@ end
|
|
166
171
|
Name | Type | Description | Notes
|
167
172
|
------------- | ------------- | ------------- | -------------
|
168
173
|
**input_file** | **File**| Input file to perform the operation on. |
|
174
|
+
**autorepair** | **BOOLEAN**| Optional; automatically repair input documents that have errors (default is true) | [optional]
|
169
175
|
|
170
176
|
### Return type
|
171
177
|
|
@@ -2504,6 +2510,68 @@ Name | Type | Description | Notes
|
|
2504
2510
|
|
2505
2511
|
|
2506
2512
|
|
2513
|
+
# **edit_document_pptx_edit_size_and_orientation**
|
2514
|
+
> String edit_document_pptx_edit_size_and_orientation(input_file, opts)
|
2515
|
+
|
2516
|
+
Set the size and/or orientation of a PowerPoint PPTX presentation document
|
2517
|
+
|
2518
|
+
Edits the input PowerPoint PPTX presentation document to be a different orientation and/or size
|
2519
|
+
|
2520
|
+
### Example
|
2521
|
+
```ruby
|
2522
|
+
# load the gem
|
2523
|
+
require 'cloudmersive-convert-api-client'
|
2524
|
+
# setup authorization
|
2525
|
+
CloudmersiveConvertApiClient.configure do |config|
|
2526
|
+
# Configure API key authorization: Apikey
|
2527
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
2528
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2529
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
2530
|
+
end
|
2531
|
+
|
2532
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
2533
|
+
|
2534
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
2535
|
+
|
2536
|
+
opts = {
|
2537
|
+
orientation: 'orientation_example', # String | Optional: The desired slide orientation; can be landscape or portrait.
|
2538
|
+
width: 56, # Integer | Optional: The desired slide width in Emu, where 1 inch equals 914400 emu.
|
2539
|
+
height: 56 # Integer | Optional: The desired slide height in Emu, where 1 inch equals 914400 emu
|
2540
|
+
}
|
2541
|
+
|
2542
|
+
begin
|
2543
|
+
#Set the size and/or orientation of a PowerPoint PPTX presentation document
|
2544
|
+
result = api_instance.edit_document_pptx_edit_size_and_orientation(input_file, opts)
|
2545
|
+
p result
|
2546
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
2547
|
+
puts "Exception when calling EditDocumentApi->edit_document_pptx_edit_size_and_orientation: #{e}"
|
2548
|
+
end
|
2549
|
+
```
|
2550
|
+
|
2551
|
+
### Parameters
|
2552
|
+
|
2553
|
+
Name | Type | Description | Notes
|
2554
|
+
------------- | ------------- | ------------- | -------------
|
2555
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
2556
|
+
**orientation** | **String**| Optional: The desired slide orientation; can be landscape or portrait. | [optional]
|
2557
|
+
**width** | **Integer**| Optional: The desired slide width in Emu, where 1 inch equals 914400 emu. | [optional]
|
2558
|
+
**height** | **Integer**| Optional: The desired slide height in Emu, where 1 inch equals 914400 emu | [optional]
|
2559
|
+
|
2560
|
+
### Return type
|
2561
|
+
|
2562
|
+
**String**
|
2563
|
+
|
2564
|
+
### Authorization
|
2565
|
+
|
2566
|
+
[Apikey](../README.md#Apikey)
|
2567
|
+
|
2568
|
+
### HTTP request headers
|
2569
|
+
|
2570
|
+
- **Content-Type**: multipart/form-data
|
2571
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
2572
|
+
|
2573
|
+
|
2574
|
+
|
2507
2575
|
# **edit_document_pptx_get_macro_information**
|
2508
2576
|
> GetMacrosResponse edit_document_pptx_get_macro_information(input_file)
|
2509
2577
|
|
@@ -2558,6 +2626,60 @@ Name | Type | Description | Notes
|
|
2558
2626
|
|
2559
2627
|
|
2560
2628
|
|
2629
|
+
# **edit_document_pptx_get_size_and_orientation**
|
2630
|
+
> PptxPageLayoutInformation edit_document_pptx_get_size_and_orientation(input_file)
|
2631
|
+
|
2632
|
+
Get the page layout information, including size and orientation of a PowerPoint PPTX presentation document
|
2633
|
+
|
2634
|
+
Gets size and orientation of an input PowerPoint PPTX presentation
|
2635
|
+
|
2636
|
+
### Example
|
2637
|
+
```ruby
|
2638
|
+
# load the gem
|
2639
|
+
require 'cloudmersive-convert-api-client'
|
2640
|
+
# setup authorization
|
2641
|
+
CloudmersiveConvertApiClient.configure do |config|
|
2642
|
+
# Configure API key authorization: Apikey
|
2643
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
2644
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2645
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
2646
|
+
end
|
2647
|
+
|
2648
|
+
api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
|
2649
|
+
|
2650
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
2651
|
+
|
2652
|
+
|
2653
|
+
begin
|
2654
|
+
#Get the page layout information, including size and orientation of a PowerPoint PPTX presentation document
|
2655
|
+
result = api_instance.edit_document_pptx_get_size_and_orientation(input_file)
|
2656
|
+
p result
|
2657
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
2658
|
+
puts "Exception when calling EditDocumentApi->edit_document_pptx_get_size_and_orientation: #{e}"
|
2659
|
+
end
|
2660
|
+
```
|
2661
|
+
|
2662
|
+
### Parameters
|
2663
|
+
|
2664
|
+
Name | Type | Description | Notes
|
2665
|
+
------------- | ------------- | ------------- | -------------
|
2666
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
2667
|
+
|
2668
|
+
### Return type
|
2669
|
+
|
2670
|
+
[**PptxPageLayoutInformation**](PptxPageLayoutInformation.md)
|
2671
|
+
|
2672
|
+
### Authorization
|
2673
|
+
|
2674
|
+
[Apikey](../README.md#Apikey)
|
2675
|
+
|
2676
|
+
### HTTP request headers
|
2677
|
+
|
2678
|
+
- **Content-Type**: multipart/form-data
|
2679
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
2680
|
+
|
2681
|
+
|
2682
|
+
|
2561
2683
|
# **edit_document_pptx_replace**
|
2562
2684
|
> String edit_document_pptx_replace(req_config)
|
2563
2685
|
|
data/docs/EditPdfApi.md
CHANGED
@@ -8,14 +8,18 @@ Method | HTTP request | Description
|
|
8
8
|
[**edit_pdf_convert_to_pdf_a**](EditPdfApi.md#edit_pdf_convert_to_pdf_a) | **POST** /convert/edit/pdf/optimize/pdf-a | Convert a PDF file to PDF/A
|
9
9
|
[**edit_pdf_decrypt**](EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
|
10
10
|
[**edit_pdf_delete_pages**](EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove, delete pages from a PDF document
|
11
|
+
[**edit_pdf_delete_pages_batch_job**](EditPdfApi.md#edit_pdf_delete_pages_batch_job) | **POST** /convert/edit/pdf/pages/delete/batch-job | Remove, delete pages from a PDF document as Batch Job
|
11
12
|
[**edit_pdf_encrypt**](EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
|
12
13
|
[**edit_pdf_get_annotations**](EditPdfApi.md#edit_pdf_get_annotations) | **POST** /convert/edit/pdf/annotations/list | Get PDF annotations, including comments in the document
|
14
|
+
[**edit_pdf_get_async_job_status**](EditPdfApi.md#edit_pdf_get_async_job_status) | **GET** /convert/edit/pdf/batch-job/status | Get the status and result of a PDF Batch Job
|
13
15
|
[**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
|
14
16
|
[**edit_pdf_get_metadata**](EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
|
15
17
|
[**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
|
16
18
|
[**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
|
19
|
+
[**edit_pdf_insert_pages_batch_job**](EditPdfApi.md#edit_pdf_insert_pages_batch_job) | **POST** /convert/edit/pdf/pages/insert/batch-job | Insert, copy pages from one PDF document into another as a batch job
|
17
20
|
[**edit_pdf_linearize**](EditPdfApi.md#edit_pdf_linearize) | **POST** /convert/edit/pdf/optimize/linearize | Linearize and optimize a PDF for streaming download
|
18
21
|
[**edit_pdf_rasterize**](EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
|
22
|
+
[**edit_pdf_rasterize_batch_job**](EditPdfApi.md#edit_pdf_rasterize_batch_job) | **POST** /convert/edit/pdf/rasterize/batch-job | Rasterize a PDF to an image-based PDF as Batch Job
|
19
23
|
[**edit_pdf_reduce_file_size**](EditPdfApi.md#edit_pdf_reduce_file_size) | **POST** /convert/edit/pdf/optimize/reduce-file-size | Reduce the file size and optimize a PDF
|
20
24
|
[**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
|
21
25
|
[**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
|
@@ -257,6 +261,66 @@ Name | Type | Description | Notes
|
|
257
261
|
|
258
262
|
|
259
263
|
|
264
|
+
# **edit_pdf_delete_pages_batch_job**
|
265
|
+
> EditPdfBatchJobCreateResult edit_pdf_delete_pages_batch_job(input_file, page_start, page_end)
|
266
|
+
|
267
|
+
Remove, delete pages from a PDF document as Batch Job
|
268
|
+
|
269
|
+
Remove one or more pages from a PDF document. Runs as a batch job async and returns a batch job ID that you can check the status of to get the result. Requires Cloudmersive Private Cloud or Managed Instance.
|
270
|
+
|
271
|
+
### Example
|
272
|
+
```ruby
|
273
|
+
# load the gem
|
274
|
+
require 'cloudmersive-convert-api-client'
|
275
|
+
# setup authorization
|
276
|
+
CloudmersiveConvertApiClient.configure do |config|
|
277
|
+
# Configure API key authorization: Apikey
|
278
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
279
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
280
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
281
|
+
end
|
282
|
+
|
283
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
284
|
+
|
285
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
286
|
+
|
287
|
+
page_start = 56 # Integer | Page number (1 based) to start deleting pages from (inclusive).
|
288
|
+
|
289
|
+
page_end = 56 # Integer | Page number (1 based) to stop deleting pages from (inclusive).
|
290
|
+
|
291
|
+
|
292
|
+
begin
|
293
|
+
#Remove, delete pages from a PDF document as Batch Job
|
294
|
+
result = api_instance.edit_pdf_delete_pages_batch_job(input_file, page_start, page_end)
|
295
|
+
p result
|
296
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
297
|
+
puts "Exception when calling EditPdfApi->edit_pdf_delete_pages_batch_job: #{e}"
|
298
|
+
end
|
299
|
+
```
|
300
|
+
|
301
|
+
### Parameters
|
302
|
+
|
303
|
+
Name | Type | Description | Notes
|
304
|
+
------------- | ------------- | ------------- | -------------
|
305
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
306
|
+
**page_start** | **Integer**| Page number (1 based) to start deleting pages from (inclusive). |
|
307
|
+
**page_end** | **Integer**| Page number (1 based) to stop deleting pages from (inclusive). |
|
308
|
+
|
309
|
+
### Return type
|
310
|
+
|
311
|
+
[**EditPdfBatchJobCreateResult**](EditPdfBatchJobCreateResult.md)
|
312
|
+
|
313
|
+
### Authorization
|
314
|
+
|
315
|
+
[Apikey](../README.md#Apikey)
|
316
|
+
|
317
|
+
### HTTP request headers
|
318
|
+
|
319
|
+
- **Content-Type**: multipart/form-data
|
320
|
+
- **Accept**: application/octet-stream
|
321
|
+
|
322
|
+
|
323
|
+
|
260
324
|
# **edit_pdf_encrypt**
|
261
325
|
> String edit_pdf_encrypt(input_file, opts)
|
262
326
|
|
@@ -373,6 +437,60 @@ Name | Type | Description | Notes
|
|
373
437
|
|
374
438
|
|
375
439
|
|
440
|
+
# **edit_pdf_get_async_job_status**
|
441
|
+
> EditPdfJobStatusResult edit_pdf_get_async_job_status(async_job_id)
|
442
|
+
|
443
|
+
Get the status and result of a PDF Batch Job
|
444
|
+
|
445
|
+
Returns the result of the Async Job - possible states can be STARTED or COMPLETED. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.
|
446
|
+
|
447
|
+
### Example
|
448
|
+
```ruby
|
449
|
+
# load the gem
|
450
|
+
require 'cloudmersive-convert-api-client'
|
451
|
+
# setup authorization
|
452
|
+
CloudmersiveConvertApiClient.configure do |config|
|
453
|
+
# Configure API key authorization: Apikey
|
454
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
455
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
456
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
457
|
+
end
|
458
|
+
|
459
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
460
|
+
|
461
|
+
async_job_id = 'async_job_id_example' # String |
|
462
|
+
|
463
|
+
|
464
|
+
begin
|
465
|
+
#Get the status and result of a PDF Batch Job
|
466
|
+
result = api_instance.edit_pdf_get_async_job_status(async_job_id)
|
467
|
+
p result
|
468
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
469
|
+
puts "Exception when calling EditPdfApi->edit_pdf_get_async_job_status: #{e}"
|
470
|
+
end
|
471
|
+
```
|
472
|
+
|
473
|
+
### Parameters
|
474
|
+
|
475
|
+
Name | Type | Description | Notes
|
476
|
+
------------- | ------------- | ------------- | -------------
|
477
|
+
**async_job_id** | **String**| |
|
478
|
+
|
479
|
+
### Return type
|
480
|
+
|
481
|
+
[**EditPdfJobStatusResult**](EditPdfJobStatusResult.md)
|
482
|
+
|
483
|
+
### Authorization
|
484
|
+
|
485
|
+
[Apikey](../README.md#Apikey)
|
486
|
+
|
487
|
+
### HTTP request headers
|
488
|
+
|
489
|
+
- **Content-Type**: Not defined
|
490
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
491
|
+
|
492
|
+
|
493
|
+
|
376
494
|
# **edit_pdf_get_form_fields**
|
377
495
|
> PdfFormFields edit_pdf_get_form_fields(input_file)
|
378
496
|
|
@@ -605,6 +723,72 @@ Name | Type | Description | Notes
|
|
605
723
|
|
606
724
|
|
607
725
|
|
726
|
+
# **edit_pdf_insert_pages_batch_job**
|
727
|
+
> EditPdfBatchJobCreateResult edit_pdf_insert_pages_batch_job(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation)
|
728
|
+
|
729
|
+
Insert, copy pages from one PDF document into another as a batch job
|
730
|
+
|
731
|
+
Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document). Runs as a batch job async and returns a batch job ID that you can check the status of to get the result. Requires Cloudmersive Private Cloud or Managed Instance.
|
732
|
+
|
733
|
+
### Example
|
734
|
+
```ruby
|
735
|
+
# load the gem
|
736
|
+
require 'cloudmersive-convert-api-client'
|
737
|
+
# setup authorization
|
738
|
+
CloudmersiveConvertApiClient.configure do |config|
|
739
|
+
# Configure API key authorization: Apikey
|
740
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
741
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
742
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
743
|
+
end
|
744
|
+
|
745
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
746
|
+
|
747
|
+
source_file = File.new('/path/to/file.txt') # File | Source PDF file to copy pages from.
|
748
|
+
|
749
|
+
destination_file = File.new('/path/to/file.txt') # File | Destination PDF file to copy pages into.
|
750
|
+
|
751
|
+
page_start_source = 56 # Integer | Page number (1 based) to start copying pages from (inclusive) in the Source file.
|
752
|
+
|
753
|
+
page_end_source = 56 # Integer | Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
|
754
|
+
|
755
|
+
page_insert_before_desitnation = 56 # Integer | Page number (1 based) to insert the pages before in the Destination file.
|
756
|
+
|
757
|
+
|
758
|
+
begin
|
759
|
+
#Insert, copy pages from one PDF document into another as a batch job
|
760
|
+
result = api_instance.edit_pdf_insert_pages_batch_job(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation)
|
761
|
+
p result
|
762
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
763
|
+
puts "Exception when calling EditPdfApi->edit_pdf_insert_pages_batch_job: #{e}"
|
764
|
+
end
|
765
|
+
```
|
766
|
+
|
767
|
+
### Parameters
|
768
|
+
|
769
|
+
Name | Type | Description | Notes
|
770
|
+
------------- | ------------- | ------------- | -------------
|
771
|
+
**source_file** | **File**| Source PDF file to copy pages from. |
|
772
|
+
**destination_file** | **File**| Destination PDF file to copy pages into. |
|
773
|
+
**page_start_source** | **Integer**| Page number (1 based) to start copying pages from (inclusive) in the Source file. |
|
774
|
+
**page_end_source** | **Integer**| Page number (1 based) to stop copying pages pages from (inclusive) in the Source file. |
|
775
|
+
**page_insert_before_desitnation** | **Integer**| Page number (1 based) to insert the pages before in the Destination file. |
|
776
|
+
|
777
|
+
### Return type
|
778
|
+
|
779
|
+
[**EditPdfBatchJobCreateResult**](EditPdfBatchJobCreateResult.md)
|
780
|
+
|
781
|
+
### Authorization
|
782
|
+
|
783
|
+
[Apikey](../README.md#Apikey)
|
784
|
+
|
785
|
+
### HTTP request headers
|
786
|
+
|
787
|
+
- **Content-Type**: multipart/form-data
|
788
|
+
- **Accept**: application/octet-stream
|
789
|
+
|
790
|
+
|
791
|
+
|
608
792
|
# **edit_pdf_linearize**
|
609
793
|
> String edit_pdf_linearize(input_file)
|
610
794
|
|
@@ -660,7 +844,7 @@ Name | Type | Description | Notes
|
|
660
844
|
|
661
845
|
|
662
846
|
# **edit_pdf_rasterize**
|
663
|
-
> String edit_pdf_rasterize(input_file)
|
847
|
+
> String edit_pdf_rasterize(input_file, opts)
|
664
848
|
|
665
849
|
Rasterize a PDF to an image-based PDF
|
666
850
|
|
@@ -682,10 +866,13 @@ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
|
682
866
|
|
683
867
|
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
684
868
|
|
869
|
+
opts = {
|
870
|
+
dpi: 56 # Integer | Optional; configures the pixel density in Dots per Inch (DPI) (default is 300). This parameter can only be used with Cloudmersive Managed Instance and Private Cloud.
|
871
|
+
}
|
685
872
|
|
686
873
|
begin
|
687
874
|
#Rasterize a PDF to an image-based PDF
|
688
|
-
result = api_instance.edit_pdf_rasterize(input_file)
|
875
|
+
result = api_instance.edit_pdf_rasterize(input_file, opts)
|
689
876
|
p result
|
690
877
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
691
878
|
puts "Exception when calling EditPdfApi->edit_pdf_rasterize: #{e}"
|
@@ -697,6 +884,7 @@ end
|
|
697
884
|
Name | Type | Description | Notes
|
698
885
|
------------- | ------------- | ------------- | -------------
|
699
886
|
**input_file** | **File**| Input file to perform the operation on. |
|
887
|
+
**dpi** | **Integer**| Optional; configures the pixel density in Dots per Inch (DPI) (default is 300). This parameter can only be used with Cloudmersive Managed Instance and Private Cloud. | [optional]
|
700
888
|
|
701
889
|
### Return type
|
702
890
|
|
@@ -713,6 +901,60 @@ Name | Type | Description | Notes
|
|
713
901
|
|
714
902
|
|
715
903
|
|
904
|
+
# **edit_pdf_rasterize_batch_job**
|
905
|
+
> EditPdfBatchJobCreateResult edit_pdf_rasterize_batch_job(input_file)
|
906
|
+
|
907
|
+
Rasterize a PDF to an image-based PDF as Batch Job
|
908
|
+
|
909
|
+
Rasterize a PDF into an image-based PDF. The output is a PDF where each page is comprised of a high-resolution image, with all text, figures and other components removed.
|
910
|
+
|
911
|
+
### Example
|
912
|
+
```ruby
|
913
|
+
# load the gem
|
914
|
+
require 'cloudmersive-convert-api-client'
|
915
|
+
# setup authorization
|
916
|
+
CloudmersiveConvertApiClient.configure do |config|
|
917
|
+
# Configure API key authorization: Apikey
|
918
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
919
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
920
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
921
|
+
end
|
922
|
+
|
923
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
924
|
+
|
925
|
+
input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
|
926
|
+
|
927
|
+
|
928
|
+
begin
|
929
|
+
#Rasterize a PDF to an image-based PDF as Batch Job
|
930
|
+
result = api_instance.edit_pdf_rasterize_batch_job(input_file)
|
931
|
+
p result
|
932
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
933
|
+
puts "Exception when calling EditPdfApi->edit_pdf_rasterize_batch_job: #{e}"
|
934
|
+
end
|
935
|
+
```
|
936
|
+
|
937
|
+
### Parameters
|
938
|
+
|
939
|
+
Name | Type | Description | Notes
|
940
|
+
------------- | ------------- | ------------- | -------------
|
941
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
942
|
+
|
943
|
+
### Return type
|
944
|
+
|
945
|
+
[**EditPdfBatchJobCreateResult**](EditPdfBatchJobCreateResult.md)
|
946
|
+
|
947
|
+
### Authorization
|
948
|
+
|
949
|
+
[Apikey](../README.md#Apikey)
|
950
|
+
|
951
|
+
### HTTP request headers
|
952
|
+
|
953
|
+
- **Content-Type**: multipart/form-data
|
954
|
+
- **Accept**: application/octet-stream
|
955
|
+
|
956
|
+
|
957
|
+
|
716
958
|
# **edit_pdf_reduce_file_size**
|
717
959
|
> String edit_pdf_reduce_file_size(input_file, opts)
|
718
960
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::EditPdfBatchJobCreateResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**async_job_id** | **String** | When creating a job, an Async Job ID is returned. Use the GetAsyncJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::EditPdfJobStatusResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | Tru eif the operation to check the status of the job was successful, false otherwise | [optional]
|
7
|
+
**async_job_status** | **String** | Returns the job status of the Async Job, if applicable. Possible states are STARTED and COMPLETED | [optional]
|
8
|
+
**async_job_id** | **String** | When the job exceeds 25 pages, an Async Job ID is returned. Use the CheckPdfOcrJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes | [optional]
|
9
|
+
**output_file_result** | **String** | Output file result (if applicable) | [optional]
|
10
|
+
**error_message** | **String** | Error message (if any) | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::JobStatusResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation to check the status of the job was successful, false otherwise | [optional]
|
7
|
+
**async_job_status** | **String** | Returns the job status of the Async Job, if applicable. Possible states are STARTED and COMPLETED | [optional]
|
8
|
+
**async_job_id** | **String** | When the job exceeds 25 pages, an Async Job ID is returned. Use the CheckPdfOcrJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes | [optional]
|
9
|
+
**pptx_result** | [**SplitPptxPresentationResult**](SplitPptxPresentationResult.md) | PowerPoint split result (if applicable) | [optional]
|
10
|
+
**error_message** | **String** | Error message (if any) | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveConvertApiClient::MergeBatchJobCreateResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**async_job_id** | **String** | When creating a job, an Async Job ID is returned. Use the GetAsyncJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes | [optional]
|
8
|
+
|
9
|
+
|