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.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +54 -8
  3. data/docs/CompareDocumentApi.md +6 -2
  4. data/docs/ConvertDataApi.md +60 -5
  5. data/docs/ConvertDocumentApi.md +358 -10
  6. data/docs/ConvertDocumentBatchJobCreateResult.md +9 -0
  7. data/docs/ConvertDocumentJobStatusResult.md +12 -0
  8. data/docs/ConvertImageApi.md +6 -2
  9. data/docs/ConvertWebApi.md +8 -8
  10. data/docs/ConvertedPngDirectPage.md +9 -0
  11. data/docs/DocumentArrayInput.md +8 -0
  12. data/docs/DocumentItem.md +9 -0
  13. data/docs/EditDocumentApi.md +124 -2
  14. data/docs/EditPdfApi.md +244 -2
  15. data/docs/EditPdfBatchJobCreateResult.md +9 -0
  16. data/docs/EditPdfJobStatusResult.md +12 -0
  17. data/docs/JobStatusResult.md +12 -0
  18. data/docs/MergeBatchJobCreateResult.md +9 -0
  19. data/docs/MergeDocumentApi.md +440 -0
  20. data/docs/MergeJobStatusResult.md +12 -0
  21. data/docs/PdfMetadata.md +2 -0
  22. data/docs/PdfToPngDirectResult.md +9 -0
  23. data/docs/PptxPageLayoutInformation.md +11 -0
  24. data/docs/PptxSplitAdvancedRequest.md +9 -0
  25. data/docs/PptxSplitAdvancedResponse.md +9 -0
  26. data/docs/PresentationAdvancedResult.md +9 -0
  27. data/docs/SplitBatchJobCreateResult.md +9 -0
  28. data/docs/SplitDocumentApi.md +169 -0
  29. data/docs/ValidateDocumentApi.md +175 -6
  30. data/lib/cloudmersive-convert-api-client/api/compare_document_api.rb +3 -0
  31. data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +57 -4
  32. data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +354 -11
  33. data/lib/cloudmersive-convert-api-client/api/convert_image_api.rb +3 -0
  34. data/lib/cloudmersive-convert-api-client/api/convert_web_api.rb +8 -8
  35. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +122 -0
  36. data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +263 -0
  37. data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +431 -0
  38. data/lib/cloudmersive-convert-api-client/api/split_document_api.rb +165 -0
  39. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +172 -4
  40. data/lib/cloudmersive-convert-api-client/models/convert_document_batch_job_create_result.rb +196 -0
  41. data/lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb +241 -0
  42. data/lib/cloudmersive-convert-api-client/models/converted_png_direct_page.rb +211 -0
  43. data/lib/cloudmersive-convert-api-client/models/document_array_input.rb +188 -0
  44. data/lib/cloudmersive-convert-api-client/models/document_item.rb +211 -0
  45. data/lib/cloudmersive-convert-api-client/models/edit_pdf_batch_job_create_result.rb +196 -0
  46. data/lib/cloudmersive-convert-api-client/models/edit_pdf_job_status_result.rb +241 -0
  47. data/lib/cloudmersive-convert-api-client/models/job_status_result.rb +226 -0
  48. data/lib/cloudmersive-convert-api-client/models/merge_batch_job_create_result.rb +196 -0
  49. data/lib/cloudmersive-convert-api-client/models/merge_job_status_result.rb +241 -0
  50. data/lib/cloudmersive-convert-api-client/models/pdf_metadata.rb +24 -4
  51. data/lib/cloudmersive-convert-api-client/models/pdf_to_png_direct_result.rb +198 -0
  52. data/lib/cloudmersive-convert-api-client/models/pptx_page_layout_information.rb +216 -0
  53. data/lib/cloudmersive-convert-api-client/models/pptx_split_advanced_request.rb +211 -0
  54. data/lib/cloudmersive-convert-api-client/models/pptx_split_advanced_response.rb +197 -0
  55. data/lib/cloudmersive-convert-api-client/models/presentation_advanced_result.rb +211 -0
  56. data/lib/cloudmersive-convert-api-client/models/presentation_result.rb +1 -1
  57. data/lib/cloudmersive-convert-api-client/models/split_batch_job_create_result.rb +196 -0
  58. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  59. data/lib/cloudmersive-convert-api-client.rb +16 -0
  60. data/spec/api/compare_document_api_spec.rb +1 -0
  61. data/spec/api/convert_data_api_spec.rb +14 -2
  62. data/spec/api/convert_document_api_spec.rb +80 -3
  63. data/spec/api/convert_image_api_spec.rb +1 -0
  64. data/spec/api/edit_document_api_spec.rb +28 -0
  65. data/spec/api/edit_pdf_api_spec.rb +55 -0
  66. data/spec/api/merge_document_api_spec.rb +96 -0
  67. data/spec/api/split_document_api_spec.rb +37 -0
  68. data/spec/api/validate_document_api_spec.rb +39 -2
  69. data/spec/models/convert_document_batch_job_create_result_spec.rb +47 -0
  70. data/spec/models/convert_document_job_status_result_spec.rb +65 -0
  71. data/spec/models/converted_png_direct_page_spec.rb +47 -0
  72. data/spec/models/document_array_input_spec.rb +41 -0
  73. data/spec/models/document_item_spec.rb +47 -0
  74. data/spec/models/edit_pdf_batch_job_create_result_spec.rb +47 -0
  75. data/spec/models/edit_pdf_job_status_result_spec.rb +65 -0
  76. data/spec/models/job_status_result_spec.rb +65 -0
  77. data/spec/models/merge_batch_job_create_result_spec.rb +47 -0
  78. data/spec/models/merge_job_status_result_spec.rb +65 -0
  79. data/spec/models/pdf_metadata_spec.rb +12 -0
  80. data/spec/models/pdf_to_png_direct_result_spec.rb +47 -0
  81. data/spec/models/pptx_page_layout_information_spec.rb +59 -0
  82. data/spec/models/pptx_split_advanced_request_spec.rb +47 -0
  83. data/spec/models/pptx_split_advanced_response_spec.rb +47 -0
  84. data/spec/models/presentation_advanced_result_spec.rb +47 -0
  85. data/spec/models/split_batch_job_create_result_spec.rb +47 -0
  86. metadata +50 -2
@@ -4,20 +4,82 @@ All URIs are relative to *https://api.cloudmersive.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**merge_document_batch_job_create**](MergeDocumentApi.md#merge_document_batch_job_create) | **POST** /convert/merge/batch-job/create | Merge an array of Documents into a Single Document by Page as a Batch Job
7
8
  [**merge_document_docx**](MergeDocumentApi.md#merge_document_docx) | **POST** /convert/merge/docx | Merge Two Word DOCX Together
8
9
  [**merge_document_docx_multi**](MergeDocumentApi.md#merge_document_docx_multi) | **POST** /convert/merge/docx/multi | Merge Multple Word DOCX Together
10
+ [**merge_document_docx_multi_array**](MergeDocumentApi.md#merge_document_docx_multi_array) | **POST** /convert/merge/docx/multi/array | Merge Multple Word DOCX Together from an array
11
+ [**merge_document_get_async_job_status**](MergeDocumentApi.md#merge_document_get_async_job_status) | **GET** /convert/merge/batch-job/status | Get the status and result of a Merge Document Batch Job
9
12
  [**merge_document_html**](MergeDocumentApi.md#merge_document_html) | **POST** /convert/merge/html | Merge Two HTML (HTM) Files Together
10
13
  [**merge_document_html_multi**](MergeDocumentApi.md#merge_document_html_multi) | **POST** /convert/merge/html/multi | Merge Multple HTML (HTM) Files Together
14
+ [**merge_document_html_multi_array**](MergeDocumentApi.md#merge_document_html_multi_array) | **POST** /convert/merge/html/multi/array | Merge Multple HTML (HTM) Files Together from an array
11
15
  [**merge_document_pdf**](MergeDocumentApi.md#merge_document_pdf) | **POST** /convert/merge/pdf | Merge Two PDF Files Together
12
16
  [**merge_document_pdf_multi**](MergeDocumentApi.md#merge_document_pdf_multi) | **POST** /convert/merge/pdf/multi | Merge Multple PDF Files Together
17
+ [**merge_document_pdf_multi_array**](MergeDocumentApi.md#merge_document_pdf_multi_array) | **POST** /convert/merge/pdf/multi/array | Merge Multple PDF Files Together from an array
13
18
  [**merge_document_png**](MergeDocumentApi.md#merge_document_png) | **POST** /convert/merge/png/vertical | Merge Two PNG Files Together
14
19
  [**merge_document_png_multi**](MergeDocumentApi.md#merge_document_png_multi) | **POST** /convert/merge/png/vertical/multi | Merge Multple PNG Files Together
20
+ [**merge_document_png_multi_array**](MergeDocumentApi.md#merge_document_png_multi_array) | **POST** /convert/merge/png/vertical/multi/array | Merge Multple PNG Files Together from an array
15
21
  [**merge_document_pptx**](MergeDocumentApi.md#merge_document_pptx) | **POST** /convert/merge/pptx | Merge Two PowerPoint PPTX Together
16
22
  [**merge_document_pptx_multi**](MergeDocumentApi.md#merge_document_pptx_multi) | **POST** /convert/merge/pptx/multi | Merge Multple PowerPoint PPTX Together
23
+ [**merge_document_pptx_multi_array**](MergeDocumentApi.md#merge_document_pptx_multi_array) | **POST** /convert/merge/pptx/multi/array | Merge Multple PowerPoint PPTX Together from an array
17
24
  [**merge_document_txt**](MergeDocumentApi.md#merge_document_txt) | **POST** /convert/merge/txt | Merge Two Text (TXT) Files Together
18
25
  [**merge_document_txt_multi**](MergeDocumentApi.md#merge_document_txt_multi) | **POST** /convert/merge/txt/multi | Merge Multple Text (TXT) Files Together
19
26
  [**merge_document_xlsx**](MergeDocumentApi.md#merge_document_xlsx) | **POST** /convert/merge/xlsx | Merge Two Excel XLSX Together
20
27
  [**merge_document_xlsx_multi**](MergeDocumentApi.md#merge_document_xlsx_multi) | **POST** /convert/merge/xlsx/multi | Merge Multple Excel XLSX Together
28
+ [**merge_document_xlsx_multi_array**](MergeDocumentApi.md#merge_document_xlsx_multi_array) | **POST** /convert/merge/xlsx/multi/array | Merge Multple Excel XLSX Together from an Array
29
+
30
+
31
+ # **merge_document_batch_job_create**
32
+ > MergeBatchJobCreateResult merge_document_batch_job_create(input)
33
+
34
+ Merge an array of Documents into a Single Document by Page as a Batch Job
35
+
36
+ Merge an array of Documents (PDF supported), into a single document. This API is designed for large jobs that could take a long time to create and so runs as a batch job that returns a Job ID that you can use with the GetAsyncJobStatus API to check on the status of the Job and ultimately get the output result. This API automatically detects the document type and then performs the split by using the document type-specific API needed to perform the split. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.
37
+
38
+ ### Example
39
+ ```ruby
40
+ # load the gem
41
+ require 'cloudmersive-convert-api-client'
42
+ # setup authorization
43
+ CloudmersiveConvertApiClient.configure do |config|
44
+ # Configure API key authorization: Apikey
45
+ config.api_key['Apikey'] = 'YOUR API KEY'
46
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
47
+ #config.api_key_prefix['Apikey'] = 'Bearer'
48
+ end
49
+
50
+ api_instance = CloudmersiveConvertApiClient::MergeDocumentApi.new
51
+
52
+ input = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput |
53
+
54
+
55
+ begin
56
+ #Merge an array of Documents into a Single Document by Page as a Batch Job
57
+ result = api_instance.merge_document_batch_job_create(input)
58
+ p result
59
+ rescue CloudmersiveConvertApiClient::ApiError => e
60
+ puts "Exception when calling MergeDocumentApi->merge_document_batch_job_create: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ Name | Type | Description | Notes
67
+ ------------- | ------------- | ------------- | -------------
68
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| |
69
+
70
+ ### Return type
71
+
72
+ [**MergeBatchJobCreateResult**](MergeBatchJobCreateResult.md)
73
+
74
+ ### Authorization
75
+
76
+ [Apikey](../README.md#Apikey)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
81
+ - **Accept**: application/json, text/json, application/xml, text/xml
82
+
21
83
 
22
84
 
23
85
  # **merge_document_docx**
@@ -152,6 +214,114 @@ Name | Type | Description | Notes
152
214
 
153
215
 
154
216
 
217
+ # **merge_document_docx_multi_array**
218
+ > Object merge_document_docx_multi_array(input)
219
+
220
+ Merge Multple Word DOCX Together from an array
221
+
222
+ Combine multiple Office Word Documents (docx), stored in an array, into one single Office Word document
223
+
224
+ ### Example
225
+ ```ruby
226
+ # load the gem
227
+ require 'cloudmersive-convert-api-client'
228
+ # setup authorization
229
+ CloudmersiveConvertApiClient.configure do |config|
230
+ # Configure API key authorization: Apikey
231
+ config.api_key['Apikey'] = 'YOUR API KEY'
232
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
233
+ #config.api_key_prefix['Apikey'] = 'Bearer'
234
+ end
235
+
236
+ api_instance = CloudmersiveConvertApiClient::MergeDocumentApi.new
237
+
238
+ input = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | Array of input files
239
+
240
+
241
+ begin
242
+ #Merge Multple Word DOCX Together from an array
243
+ result = api_instance.merge_document_docx_multi_array(input)
244
+ p result
245
+ rescue CloudmersiveConvertApiClient::ApiError => e
246
+ puts "Exception when calling MergeDocumentApi->merge_document_docx_multi_array: #{e}"
247
+ end
248
+ ```
249
+
250
+ ### Parameters
251
+
252
+ Name | Type | Description | Notes
253
+ ------------- | ------------- | ------------- | -------------
254
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| Array of input files |
255
+
256
+ ### Return type
257
+
258
+ **Object**
259
+
260
+ ### Authorization
261
+
262
+ [Apikey](../README.md#Apikey)
263
+
264
+ ### HTTP request headers
265
+
266
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
267
+ - **Accept**: application/octet-stream
268
+
269
+
270
+
271
+ # **merge_document_get_async_job_status**
272
+ > MergeJobStatusResult merge_document_get_async_job_status(async_job_id)
273
+
274
+ Get the status and result of a Merge Document Batch Job
275
+
276
+ 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.
277
+
278
+ ### Example
279
+ ```ruby
280
+ # load the gem
281
+ require 'cloudmersive-convert-api-client'
282
+ # setup authorization
283
+ CloudmersiveConvertApiClient.configure do |config|
284
+ # Configure API key authorization: Apikey
285
+ config.api_key['Apikey'] = 'YOUR API KEY'
286
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
287
+ #config.api_key_prefix['Apikey'] = 'Bearer'
288
+ end
289
+
290
+ api_instance = CloudmersiveConvertApiClient::MergeDocumentApi.new
291
+
292
+ async_job_id = 'async_job_id_example' # String |
293
+
294
+
295
+ begin
296
+ #Get the status and result of a Merge Document Batch Job
297
+ result = api_instance.merge_document_get_async_job_status(async_job_id)
298
+ p result
299
+ rescue CloudmersiveConvertApiClient::ApiError => e
300
+ puts "Exception when calling MergeDocumentApi->merge_document_get_async_job_status: #{e}"
301
+ end
302
+ ```
303
+
304
+ ### Parameters
305
+
306
+ Name | Type | Description | Notes
307
+ ------------- | ------------- | ------------- | -------------
308
+ **async_job_id** | **String**| |
309
+
310
+ ### Return type
311
+
312
+ [**MergeJobStatusResult**](MergeJobStatusResult.md)
313
+
314
+ ### Authorization
315
+
316
+ [Apikey](../README.md#Apikey)
317
+
318
+ ### HTTP request headers
319
+
320
+ - **Content-Type**: Not defined
321
+ - **Accept**: application/json, text/json, application/xml, text/xml
322
+
323
+
324
+
155
325
  # **merge_document_html**
156
326
  > String merge_document_html(input_file1, input_file2)
157
327
 
@@ -284,6 +454,60 @@ Name | Type | Description | Notes
284
454
 
285
455
 
286
456
 
457
+ # **merge_document_html_multi_array**
458
+ > Object merge_document_html_multi_array(input)
459
+
460
+ Merge Multple HTML (HTM) Files Together from an array
461
+
462
+ Combine multiple HTML (.HTM) files, from an array, into a single text document, preserving the order of the input documents in the combined document by stacking them vertically. The title will be taken from the first document.
463
+
464
+ ### Example
465
+ ```ruby
466
+ # load the gem
467
+ require 'cloudmersive-convert-api-client'
468
+ # setup authorization
469
+ CloudmersiveConvertApiClient.configure do |config|
470
+ # Configure API key authorization: Apikey
471
+ config.api_key['Apikey'] = 'YOUR API KEY'
472
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
473
+ #config.api_key_prefix['Apikey'] = 'Bearer'
474
+ end
475
+
476
+ api_instance = CloudmersiveConvertApiClient::MergeDocumentApi.new
477
+
478
+ input = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | Array of input files
479
+
480
+
481
+ begin
482
+ #Merge Multple HTML (HTM) Files Together from an array
483
+ result = api_instance.merge_document_html_multi_array(input)
484
+ p result
485
+ rescue CloudmersiveConvertApiClient::ApiError => e
486
+ puts "Exception when calling MergeDocumentApi->merge_document_html_multi_array: #{e}"
487
+ end
488
+ ```
489
+
490
+ ### Parameters
491
+
492
+ Name | Type | Description | Notes
493
+ ------------- | ------------- | ------------- | -------------
494
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| Array of input files |
495
+
496
+ ### Return type
497
+
498
+ **Object**
499
+
500
+ ### Authorization
501
+
502
+ [Apikey](../README.md#Apikey)
503
+
504
+ ### HTTP request headers
505
+
506
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
507
+ - **Accept**: application/octet-stream
508
+
509
+
510
+
287
511
  # **merge_document_pdf**
288
512
  > String merge_document_pdf(input_file1, input_file2)
289
513
 
@@ -416,6 +640,60 @@ Name | Type | Description | Notes
416
640
 
417
641
 
418
642
 
643
+ # **merge_document_pdf_multi_array**
644
+ > Object merge_document_pdf_multi_array(input)
645
+
646
+ Merge Multple PDF Files Together from an array
647
+
648
+ Combine multiple PDF files (pdf), as an array, into a single PDF document, preserving the order of the input documents in the combined document
649
+
650
+ ### Example
651
+ ```ruby
652
+ # load the gem
653
+ require 'cloudmersive-convert-api-client'
654
+ # setup authorization
655
+ CloudmersiveConvertApiClient.configure do |config|
656
+ # Configure API key authorization: Apikey
657
+ config.api_key['Apikey'] = 'YOUR API KEY'
658
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
659
+ #config.api_key_prefix['Apikey'] = 'Bearer'
660
+ end
661
+
662
+ api_instance = CloudmersiveConvertApiClient::MergeDocumentApi.new
663
+
664
+ input = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | Array of input files
665
+
666
+
667
+ begin
668
+ #Merge Multple PDF Files Together from an array
669
+ result = api_instance.merge_document_pdf_multi_array(input)
670
+ p result
671
+ rescue CloudmersiveConvertApiClient::ApiError => e
672
+ puts "Exception when calling MergeDocumentApi->merge_document_pdf_multi_array: #{e}"
673
+ end
674
+ ```
675
+
676
+ ### Parameters
677
+
678
+ Name | Type | Description | Notes
679
+ ------------- | ------------- | ------------- | -------------
680
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| Array of input files |
681
+
682
+ ### Return type
683
+
684
+ **Object**
685
+
686
+ ### Authorization
687
+
688
+ [Apikey](../README.md#Apikey)
689
+
690
+ ### HTTP request headers
691
+
692
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
693
+ - **Accept**: application/octet-stream
694
+
695
+
696
+
419
697
  # **merge_document_png**
420
698
  > String merge_document_png(input_file1, input_file2)
421
699
 
@@ -548,6 +826,60 @@ Name | Type | Description | Notes
548
826
 
549
827
 
550
828
 
829
+ # **merge_document_png_multi_array**
830
+ > Object merge_document_png_multi_array(input)
831
+
832
+ Merge Multple PNG Files Together from an array
833
+
834
+ Combine multiple PNG files, from an array, into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically
835
+
836
+ ### Example
837
+ ```ruby
838
+ # load the gem
839
+ require 'cloudmersive-convert-api-client'
840
+ # setup authorization
841
+ CloudmersiveConvertApiClient.configure do |config|
842
+ # Configure API key authorization: Apikey
843
+ config.api_key['Apikey'] = 'YOUR API KEY'
844
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
845
+ #config.api_key_prefix['Apikey'] = 'Bearer'
846
+ end
847
+
848
+ api_instance = CloudmersiveConvertApiClient::MergeDocumentApi.new
849
+
850
+ input = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | Array of input files
851
+
852
+
853
+ begin
854
+ #Merge Multple PNG Files Together from an array
855
+ result = api_instance.merge_document_png_multi_array(input)
856
+ p result
857
+ rescue CloudmersiveConvertApiClient::ApiError => e
858
+ puts "Exception when calling MergeDocumentApi->merge_document_png_multi_array: #{e}"
859
+ end
860
+ ```
861
+
862
+ ### Parameters
863
+
864
+ Name | Type | Description | Notes
865
+ ------------- | ------------- | ------------- | -------------
866
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| Array of input files |
867
+
868
+ ### Return type
869
+
870
+ **Object**
871
+
872
+ ### Authorization
873
+
874
+ [Apikey](../README.md#Apikey)
875
+
876
+ ### HTTP request headers
877
+
878
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
879
+ - **Accept**: application/octet-stream
880
+
881
+
882
+
551
883
  # **merge_document_pptx**
552
884
  > String merge_document_pptx(input_file1, input_file2)
553
885
 
@@ -680,6 +1012,60 @@ Name | Type | Description | Notes
680
1012
 
681
1013
 
682
1014
 
1015
+ # **merge_document_pptx_multi_array**
1016
+ > Object merge_document_pptx_multi_array(input)
1017
+
1018
+ Merge Multple PowerPoint PPTX Together from an array
1019
+
1020
+ Combine multiple Office PowerPoint presentations (pptx), from an array, into one single Office PowerPoint presentation
1021
+
1022
+ ### Example
1023
+ ```ruby
1024
+ # load the gem
1025
+ require 'cloudmersive-convert-api-client'
1026
+ # setup authorization
1027
+ CloudmersiveConvertApiClient.configure do |config|
1028
+ # Configure API key authorization: Apikey
1029
+ config.api_key['Apikey'] = 'YOUR API KEY'
1030
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1031
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1032
+ end
1033
+
1034
+ api_instance = CloudmersiveConvertApiClient::MergeDocumentApi.new
1035
+
1036
+ input = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | Array of input files
1037
+
1038
+
1039
+ begin
1040
+ #Merge Multple PowerPoint PPTX Together from an array
1041
+ result = api_instance.merge_document_pptx_multi_array(input)
1042
+ p result
1043
+ rescue CloudmersiveConvertApiClient::ApiError => e
1044
+ puts "Exception when calling MergeDocumentApi->merge_document_pptx_multi_array: #{e}"
1045
+ end
1046
+ ```
1047
+
1048
+ ### Parameters
1049
+
1050
+ Name | Type | Description | Notes
1051
+ ------------- | ------------- | ------------- | -------------
1052
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| Array of input files |
1053
+
1054
+ ### Return type
1055
+
1056
+ **Object**
1057
+
1058
+ ### Authorization
1059
+
1060
+ [Apikey](../README.md#Apikey)
1061
+
1062
+ ### HTTP request headers
1063
+
1064
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1065
+ - **Accept**: application/octet-stream
1066
+
1067
+
1068
+
683
1069
  # **merge_document_txt**
684
1070
  > Object merge_document_txt(input_file1, input_file2)
685
1071
 
@@ -944,3 +1330,57 @@ Name | Type | Description | Notes
944
1330
 
945
1331
 
946
1332
 
1333
+ # **merge_document_xlsx_multi_array**
1334
+ > Object merge_document_xlsx_multi_array(input)
1335
+
1336
+ Merge Multple Excel XLSX Together from an Array
1337
+
1338
+ Combine multiple Office Excel spreadsheets (xlsx), as an array, into a single Office Excel spreadsheet
1339
+
1340
+ ### Example
1341
+ ```ruby
1342
+ # load the gem
1343
+ require 'cloudmersive-convert-api-client'
1344
+ # setup authorization
1345
+ CloudmersiveConvertApiClient.configure do |config|
1346
+ # Configure API key authorization: Apikey
1347
+ config.api_key['Apikey'] = 'YOUR API KEY'
1348
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1349
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1350
+ end
1351
+
1352
+ api_instance = CloudmersiveConvertApiClient::MergeDocumentApi.new
1353
+
1354
+ input = CloudmersiveConvertApiClient::DocumentArrayInput.new # DocumentArrayInput | Array of input files
1355
+
1356
+
1357
+ begin
1358
+ #Merge Multple Excel XLSX Together from an Array
1359
+ result = api_instance.merge_document_xlsx_multi_array(input)
1360
+ p result
1361
+ rescue CloudmersiveConvertApiClient::ApiError => e
1362
+ puts "Exception when calling MergeDocumentApi->merge_document_xlsx_multi_array: #{e}"
1363
+ end
1364
+ ```
1365
+
1366
+ ### Parameters
1367
+
1368
+ Name | Type | Description | Notes
1369
+ ------------- | ------------- | ------------- | -------------
1370
+ **input** | [**DocumentArrayInput**](DocumentArrayInput.md)| Array of input files |
1371
+
1372
+ ### Return type
1373
+
1374
+ **Object**
1375
+
1376
+ ### Authorization
1377
+
1378
+ [Apikey](../README.md#Apikey)
1379
+
1380
+ ### HTTP request headers
1381
+
1382
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1383
+ - **Accept**: application/octet-stream
1384
+
1385
+
1386
+
@@ -0,0 +1,12 @@
1
+ # CloudmersiveConvertApiClient::MergeJobStatusResult
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
+ **file_output_result** | **String** | Resulting file output (if applicable) | [optional]
10
+ **error_message** | **String** | Error message (if any) | [optional]
11
+
12
+
data/docs/PdfMetadata.md CHANGED
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **error_details** | **String** | Details of any errors if the operation was unsucessful | [optional]
7
8
  **title** | **String** | Title of the document | [optional]
8
9
  **keywords** | **String** | Keywords of the document | [optional]
9
10
  **subject** | **String** | Subject of the document | [optional]
@@ -12,5 +13,6 @@ Name | Type | Description | Notes
12
13
  **date_modified** | **DateTime** | The timestamp that the document was last modified, if available, null if not available | [optional]
13
14
  **date_created** | **DateTime** | The timestamp that the document was created, if available, null if not available | [optional]
14
15
  **page_count** | **Integer** | The number of pages in the document | [optional]
16
+ **encrypted** | **BOOLEAN** | True if the PDF document is encrypted, false otherwise | [optional]
15
17
 
16
18
 
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::PdfToPngDirectResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **png_result_pages** | [**Array<ConvertedPngDirectPage>**](ConvertedPngDirectPage.md) | Array of converted pages | [optional]
8
+
9
+
@@ -0,0 +1,11 @@
1
+ # CloudmersiveConvertApiClient::PptxPageLayoutInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
7
+ **orientation** | **String** | Orientation of the presentation, either portrait or landscape | [optional]
8
+ **width** | **Integer** | Width of the presentation in Emu, where 1 inch equals 914400 emu. | [optional]
9
+ **height** | **Integer** | Height of the presentation in Emu, where 1 inch equals 914400 emu. | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::PptxSplitAdvancedRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_file** | **String** | Input file | [optional]
7
+ **slides_per_presentation** | **Integer** | Slides per presentation for result | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::PptxSplitAdvancedResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **result_presentations** | [**Array<PresentationAdvancedResult>**](PresentationAdvancedResult.md) | | [optional]
7
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::PresentationAdvancedResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **slide_number** | **Integer** | Presentation number of the converted page, starting with 1 for the left-most worksheet | [optional]
7
+ **presentation_contents** | **String** | Contents of the presentation in bytes | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::SplitBatchJobCreateResult
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
+