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
@@ -19,6 +19,60 @@ module CloudmersiveConvertApiClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Merge an array of Documents into a Single Document by Page as a Batch Job
|
23
|
+
# 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.
|
24
|
+
# @param input
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [MergeBatchJobCreateResult]
|
27
|
+
def merge_document_batch_job_create(input, opts = {})
|
28
|
+
data, _status_code, _headers = merge_document_batch_job_create_with_http_info(input, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Merge an array of Documents into a Single Document by Page as a Batch Job
|
33
|
+
# 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.
|
34
|
+
# @param input
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(MergeBatchJobCreateResult, Fixnum, Hash)>] MergeBatchJobCreateResult data, response status code and response headers
|
37
|
+
def merge_document_batch_job_create_with_http_info(input, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_batch_job_create ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'input' is set
|
42
|
+
if @api_client.config.client_side_validation && input.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_batch_job_create"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/convert/merge/batch-job/create'
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
55
|
+
# HTTP header 'Content-Type'
|
56
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
57
|
+
|
58
|
+
# form parameters
|
59
|
+
form_params = {}
|
60
|
+
|
61
|
+
# http body (model)
|
62
|
+
post_body = @api_client.object_to_http_body(input)
|
63
|
+
auth_names = ['Apikey']
|
64
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
65
|
+
:header_params => header_params,
|
66
|
+
:query_params => query_params,
|
67
|
+
:form_params => form_params,
|
68
|
+
:body => post_body,
|
69
|
+
:auth_names => auth_names,
|
70
|
+
:return_type => 'MergeBatchJobCreateResult')
|
71
|
+
if @api_client.config.debugging
|
72
|
+
@api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_batch_job_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
73
|
+
end
|
74
|
+
return data, status_code, headers
|
75
|
+
end
|
22
76
|
# Merge Two Word DOCX Together
|
23
77
|
# Combine two Office Word Documents (docx) into one single Office Word document
|
24
78
|
# @param input_file1 First input file to perform the operation on.
|
@@ -167,6 +221,113 @@ module CloudmersiveConvertApiClient
|
|
167
221
|
end
|
168
222
|
return data, status_code, headers
|
169
223
|
end
|
224
|
+
# Merge Multple Word DOCX Together from an array
|
225
|
+
# Combine multiple Office Word Documents (docx), stored in an array, into one single Office Word document
|
226
|
+
# @param input Array of input files
|
227
|
+
# @param [Hash] opts the optional parameters
|
228
|
+
# @return [Object]
|
229
|
+
def merge_document_docx_multi_array(input, opts = {})
|
230
|
+
data, _status_code, _headers = merge_document_docx_multi_array_with_http_info(input, opts)
|
231
|
+
data
|
232
|
+
end
|
233
|
+
|
234
|
+
# Merge Multple Word DOCX Together from an array
|
235
|
+
# Combine multiple Office Word Documents (docx), stored in an array, into one single Office Word document
|
236
|
+
# @param input Array of input files
|
237
|
+
# @param [Hash] opts the optional parameters
|
238
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
239
|
+
def merge_document_docx_multi_array_with_http_info(input, opts = {})
|
240
|
+
if @api_client.config.debugging
|
241
|
+
@api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_docx_multi_array ...'
|
242
|
+
end
|
243
|
+
# verify the required parameter 'input' is set
|
244
|
+
if @api_client.config.client_side_validation && input.nil?
|
245
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_docx_multi_array"
|
246
|
+
end
|
247
|
+
# resource path
|
248
|
+
local_var_path = '/convert/merge/docx/multi/array'
|
249
|
+
|
250
|
+
# query parameters
|
251
|
+
query_params = {}
|
252
|
+
|
253
|
+
# header parameters
|
254
|
+
header_params = {}
|
255
|
+
# HTTP header 'Accept' (if needed)
|
256
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
257
|
+
# HTTP header 'Content-Type'
|
258
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
259
|
+
|
260
|
+
# form parameters
|
261
|
+
form_params = {}
|
262
|
+
|
263
|
+
# http body (model)
|
264
|
+
post_body = @api_client.object_to_http_body(input)
|
265
|
+
auth_names = ['Apikey']
|
266
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
267
|
+
:header_params => header_params,
|
268
|
+
:query_params => query_params,
|
269
|
+
:form_params => form_params,
|
270
|
+
:body => post_body,
|
271
|
+
:auth_names => auth_names,
|
272
|
+
:return_type => 'Object')
|
273
|
+
if @api_client.config.debugging
|
274
|
+
@api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_docx_multi_array\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
275
|
+
end
|
276
|
+
return data, status_code, headers
|
277
|
+
end
|
278
|
+
# Get the status and result of a Merge Document Batch Job
|
279
|
+
# 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.
|
280
|
+
# @param async_job_id
|
281
|
+
# @param [Hash] opts the optional parameters
|
282
|
+
# @return [MergeJobStatusResult]
|
283
|
+
def merge_document_get_async_job_status(async_job_id, opts = {})
|
284
|
+
data, _status_code, _headers = merge_document_get_async_job_status_with_http_info(async_job_id, opts)
|
285
|
+
data
|
286
|
+
end
|
287
|
+
|
288
|
+
# Get the status and result of a Merge Document Batch Job
|
289
|
+
# 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.
|
290
|
+
# @param async_job_id
|
291
|
+
# @param [Hash] opts the optional parameters
|
292
|
+
# @return [Array<(MergeJobStatusResult, Fixnum, Hash)>] MergeJobStatusResult data, response status code and response headers
|
293
|
+
def merge_document_get_async_job_status_with_http_info(async_job_id, opts = {})
|
294
|
+
if @api_client.config.debugging
|
295
|
+
@api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_get_async_job_status ...'
|
296
|
+
end
|
297
|
+
# verify the required parameter 'async_job_id' is set
|
298
|
+
if @api_client.config.client_side_validation && async_job_id.nil?
|
299
|
+
fail ArgumentError, "Missing the required parameter 'async_job_id' when calling MergeDocumentApi.merge_document_get_async_job_status"
|
300
|
+
end
|
301
|
+
# resource path
|
302
|
+
local_var_path = '/convert/merge/batch-job/status'
|
303
|
+
|
304
|
+
# query parameters
|
305
|
+
query_params = {}
|
306
|
+
query_params[:'AsyncJobID'] = async_job_id
|
307
|
+
|
308
|
+
# header parameters
|
309
|
+
header_params = {}
|
310
|
+
# HTTP header 'Accept' (if needed)
|
311
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
312
|
+
|
313
|
+
# form parameters
|
314
|
+
form_params = {}
|
315
|
+
|
316
|
+
# http body (model)
|
317
|
+
post_body = nil
|
318
|
+
auth_names = ['Apikey']
|
319
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
320
|
+
:header_params => header_params,
|
321
|
+
:query_params => query_params,
|
322
|
+
:form_params => form_params,
|
323
|
+
:body => post_body,
|
324
|
+
:auth_names => auth_names,
|
325
|
+
:return_type => 'MergeJobStatusResult')
|
326
|
+
if @api_client.config.debugging
|
327
|
+
@api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_get_async_job_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
328
|
+
end
|
329
|
+
return data, status_code, headers
|
330
|
+
end
|
170
331
|
# Merge Two HTML (HTM) Files Together
|
171
332
|
# Combine two HTML (.HTM) files 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.
|
172
333
|
# @param input_file1 First input file to perform the operation on.
|
@@ -315,6 +476,60 @@ module CloudmersiveConvertApiClient
|
|
315
476
|
end
|
316
477
|
return data, status_code, headers
|
317
478
|
end
|
479
|
+
# Merge Multple HTML (HTM) Files Together from an array
|
480
|
+
# 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.
|
481
|
+
# @param input Array of input files
|
482
|
+
# @param [Hash] opts the optional parameters
|
483
|
+
# @return [Object]
|
484
|
+
def merge_document_html_multi_array(input, opts = {})
|
485
|
+
data, _status_code, _headers = merge_document_html_multi_array_with_http_info(input, opts)
|
486
|
+
data
|
487
|
+
end
|
488
|
+
|
489
|
+
# Merge Multple HTML (HTM) Files Together from an array
|
490
|
+
# 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.
|
491
|
+
# @param input Array of input files
|
492
|
+
# @param [Hash] opts the optional parameters
|
493
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
494
|
+
def merge_document_html_multi_array_with_http_info(input, opts = {})
|
495
|
+
if @api_client.config.debugging
|
496
|
+
@api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_html_multi_array ...'
|
497
|
+
end
|
498
|
+
# verify the required parameter 'input' is set
|
499
|
+
if @api_client.config.client_side_validation && input.nil?
|
500
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_html_multi_array"
|
501
|
+
end
|
502
|
+
# resource path
|
503
|
+
local_var_path = '/convert/merge/html/multi/array'
|
504
|
+
|
505
|
+
# query parameters
|
506
|
+
query_params = {}
|
507
|
+
|
508
|
+
# header parameters
|
509
|
+
header_params = {}
|
510
|
+
# HTTP header 'Accept' (if needed)
|
511
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
512
|
+
# HTTP header 'Content-Type'
|
513
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
514
|
+
|
515
|
+
# form parameters
|
516
|
+
form_params = {}
|
517
|
+
|
518
|
+
# http body (model)
|
519
|
+
post_body = @api_client.object_to_http_body(input)
|
520
|
+
auth_names = ['Apikey']
|
521
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
522
|
+
:header_params => header_params,
|
523
|
+
:query_params => query_params,
|
524
|
+
:form_params => form_params,
|
525
|
+
:body => post_body,
|
526
|
+
:auth_names => auth_names,
|
527
|
+
:return_type => 'Object')
|
528
|
+
if @api_client.config.debugging
|
529
|
+
@api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_html_multi_array\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
530
|
+
end
|
531
|
+
return data, status_code, headers
|
532
|
+
end
|
318
533
|
# Merge Two PDF Files Together
|
319
534
|
# Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document
|
320
535
|
# @param input_file1 First input file to perform the operation on.
|
@@ -463,6 +678,60 @@ module CloudmersiveConvertApiClient
|
|
463
678
|
end
|
464
679
|
return data, status_code, headers
|
465
680
|
end
|
681
|
+
# Merge Multple PDF Files Together from an array
|
682
|
+
# Combine multiple PDF files (pdf), as an array, into a single PDF document, preserving the order of the input documents in the combined document
|
683
|
+
# @param input Array of input files
|
684
|
+
# @param [Hash] opts the optional parameters
|
685
|
+
# @return [Object]
|
686
|
+
def merge_document_pdf_multi_array(input, opts = {})
|
687
|
+
data, _status_code, _headers = merge_document_pdf_multi_array_with_http_info(input, opts)
|
688
|
+
data
|
689
|
+
end
|
690
|
+
|
691
|
+
# Merge Multple PDF Files Together from an array
|
692
|
+
# Combine multiple PDF files (pdf), as an array, into a single PDF document, preserving the order of the input documents in the combined document
|
693
|
+
# @param input Array of input files
|
694
|
+
# @param [Hash] opts the optional parameters
|
695
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
696
|
+
def merge_document_pdf_multi_array_with_http_info(input, opts = {})
|
697
|
+
if @api_client.config.debugging
|
698
|
+
@api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_pdf_multi_array ...'
|
699
|
+
end
|
700
|
+
# verify the required parameter 'input' is set
|
701
|
+
if @api_client.config.client_side_validation && input.nil?
|
702
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_pdf_multi_array"
|
703
|
+
end
|
704
|
+
# resource path
|
705
|
+
local_var_path = '/convert/merge/pdf/multi/array'
|
706
|
+
|
707
|
+
# query parameters
|
708
|
+
query_params = {}
|
709
|
+
|
710
|
+
# header parameters
|
711
|
+
header_params = {}
|
712
|
+
# HTTP header 'Accept' (if needed)
|
713
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
714
|
+
# HTTP header 'Content-Type'
|
715
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
716
|
+
|
717
|
+
# form parameters
|
718
|
+
form_params = {}
|
719
|
+
|
720
|
+
# http body (model)
|
721
|
+
post_body = @api_client.object_to_http_body(input)
|
722
|
+
auth_names = ['Apikey']
|
723
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
724
|
+
:header_params => header_params,
|
725
|
+
:query_params => query_params,
|
726
|
+
:form_params => form_params,
|
727
|
+
:body => post_body,
|
728
|
+
:auth_names => auth_names,
|
729
|
+
:return_type => 'Object')
|
730
|
+
if @api_client.config.debugging
|
731
|
+
@api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_pdf_multi_array\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
732
|
+
end
|
733
|
+
return data, status_code, headers
|
734
|
+
end
|
466
735
|
# Merge Two PNG Files Together
|
467
736
|
# Combine two PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically
|
468
737
|
# @param input_file1 First input file to perform the operation on.
|
@@ -611,6 +880,60 @@ module CloudmersiveConvertApiClient
|
|
611
880
|
end
|
612
881
|
return data, status_code, headers
|
613
882
|
end
|
883
|
+
# Merge Multple PNG Files Together from an array
|
884
|
+
# 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
|
885
|
+
# @param input Array of input files
|
886
|
+
# @param [Hash] opts the optional parameters
|
887
|
+
# @return [Object]
|
888
|
+
def merge_document_png_multi_array(input, opts = {})
|
889
|
+
data, _status_code, _headers = merge_document_png_multi_array_with_http_info(input, opts)
|
890
|
+
data
|
891
|
+
end
|
892
|
+
|
893
|
+
# Merge Multple PNG Files Together from an array
|
894
|
+
# 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
|
895
|
+
# @param input Array of input files
|
896
|
+
# @param [Hash] opts the optional parameters
|
897
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
898
|
+
def merge_document_png_multi_array_with_http_info(input, opts = {})
|
899
|
+
if @api_client.config.debugging
|
900
|
+
@api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_png_multi_array ...'
|
901
|
+
end
|
902
|
+
# verify the required parameter 'input' is set
|
903
|
+
if @api_client.config.client_side_validation && input.nil?
|
904
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_png_multi_array"
|
905
|
+
end
|
906
|
+
# resource path
|
907
|
+
local_var_path = '/convert/merge/png/vertical/multi/array'
|
908
|
+
|
909
|
+
# query parameters
|
910
|
+
query_params = {}
|
911
|
+
|
912
|
+
# header parameters
|
913
|
+
header_params = {}
|
914
|
+
# HTTP header 'Accept' (if needed)
|
915
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
916
|
+
# HTTP header 'Content-Type'
|
917
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
918
|
+
|
919
|
+
# form parameters
|
920
|
+
form_params = {}
|
921
|
+
|
922
|
+
# http body (model)
|
923
|
+
post_body = @api_client.object_to_http_body(input)
|
924
|
+
auth_names = ['Apikey']
|
925
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
926
|
+
:header_params => header_params,
|
927
|
+
:query_params => query_params,
|
928
|
+
:form_params => form_params,
|
929
|
+
:body => post_body,
|
930
|
+
:auth_names => auth_names,
|
931
|
+
:return_type => 'Object')
|
932
|
+
if @api_client.config.debugging
|
933
|
+
@api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_png_multi_array\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
934
|
+
end
|
935
|
+
return data, status_code, headers
|
936
|
+
end
|
614
937
|
# Merge Two PowerPoint PPTX Together
|
615
938
|
# Combine two Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation
|
616
939
|
# @param input_file1 First input file to perform the operation on.
|
@@ -759,6 +1082,60 @@ module CloudmersiveConvertApiClient
|
|
759
1082
|
end
|
760
1083
|
return data, status_code, headers
|
761
1084
|
end
|
1085
|
+
# Merge Multple PowerPoint PPTX Together from an array
|
1086
|
+
# Combine multiple Office PowerPoint presentations (pptx), from an array, into one single Office PowerPoint presentation
|
1087
|
+
# @param input Array of input files
|
1088
|
+
# @param [Hash] opts the optional parameters
|
1089
|
+
# @return [Object]
|
1090
|
+
def merge_document_pptx_multi_array(input, opts = {})
|
1091
|
+
data, _status_code, _headers = merge_document_pptx_multi_array_with_http_info(input, opts)
|
1092
|
+
data
|
1093
|
+
end
|
1094
|
+
|
1095
|
+
# Merge Multple PowerPoint PPTX Together from an array
|
1096
|
+
# Combine multiple Office PowerPoint presentations (pptx), from an array, into one single Office PowerPoint presentation
|
1097
|
+
# @param input Array of input files
|
1098
|
+
# @param [Hash] opts the optional parameters
|
1099
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
1100
|
+
def merge_document_pptx_multi_array_with_http_info(input, opts = {})
|
1101
|
+
if @api_client.config.debugging
|
1102
|
+
@api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_pptx_multi_array ...'
|
1103
|
+
end
|
1104
|
+
# verify the required parameter 'input' is set
|
1105
|
+
if @api_client.config.client_side_validation && input.nil?
|
1106
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_pptx_multi_array"
|
1107
|
+
end
|
1108
|
+
# resource path
|
1109
|
+
local_var_path = '/convert/merge/pptx/multi/array'
|
1110
|
+
|
1111
|
+
# query parameters
|
1112
|
+
query_params = {}
|
1113
|
+
|
1114
|
+
# header parameters
|
1115
|
+
header_params = {}
|
1116
|
+
# HTTP header 'Accept' (if needed)
|
1117
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
1118
|
+
# HTTP header 'Content-Type'
|
1119
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
1120
|
+
|
1121
|
+
# form parameters
|
1122
|
+
form_params = {}
|
1123
|
+
|
1124
|
+
# http body (model)
|
1125
|
+
post_body = @api_client.object_to_http_body(input)
|
1126
|
+
auth_names = ['Apikey']
|
1127
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1128
|
+
:header_params => header_params,
|
1129
|
+
:query_params => query_params,
|
1130
|
+
:form_params => form_params,
|
1131
|
+
:body => post_body,
|
1132
|
+
:auth_names => auth_names,
|
1133
|
+
:return_type => 'Object')
|
1134
|
+
if @api_client.config.debugging
|
1135
|
+
@api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_pptx_multi_array\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1136
|
+
end
|
1137
|
+
return data, status_code, headers
|
1138
|
+
end
|
762
1139
|
# Merge Two Text (TXT) Files Together
|
763
1140
|
# Combine two Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.
|
764
1141
|
# @param input_file1 First input file to perform the operation on.
|
@@ -1055,5 +1432,59 @@ module CloudmersiveConvertApiClient
|
|
1055
1432
|
end
|
1056
1433
|
return data, status_code, headers
|
1057
1434
|
end
|
1435
|
+
# Merge Multple Excel XLSX Together from an Array
|
1436
|
+
# Combine multiple Office Excel spreadsheets (xlsx), as an array, into a single Office Excel spreadsheet
|
1437
|
+
# @param input Array of input files
|
1438
|
+
# @param [Hash] opts the optional parameters
|
1439
|
+
# @return [Object]
|
1440
|
+
def merge_document_xlsx_multi_array(input, opts = {})
|
1441
|
+
data, _status_code, _headers = merge_document_xlsx_multi_array_with_http_info(input, opts)
|
1442
|
+
data
|
1443
|
+
end
|
1444
|
+
|
1445
|
+
# Merge Multple Excel XLSX Together from an Array
|
1446
|
+
# Combine multiple Office Excel spreadsheets (xlsx), as an array, into a single Office Excel spreadsheet
|
1447
|
+
# @param input Array of input files
|
1448
|
+
# @param [Hash] opts the optional parameters
|
1449
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
1450
|
+
def merge_document_xlsx_multi_array_with_http_info(input, opts = {})
|
1451
|
+
if @api_client.config.debugging
|
1452
|
+
@api_client.config.logger.debug 'Calling API: MergeDocumentApi.merge_document_xlsx_multi_array ...'
|
1453
|
+
end
|
1454
|
+
# verify the required parameter 'input' is set
|
1455
|
+
if @api_client.config.client_side_validation && input.nil?
|
1456
|
+
fail ArgumentError, "Missing the required parameter 'input' when calling MergeDocumentApi.merge_document_xlsx_multi_array"
|
1457
|
+
end
|
1458
|
+
# resource path
|
1459
|
+
local_var_path = '/convert/merge/xlsx/multi/array'
|
1460
|
+
|
1461
|
+
# query parameters
|
1462
|
+
query_params = {}
|
1463
|
+
|
1464
|
+
# header parameters
|
1465
|
+
header_params = {}
|
1466
|
+
# HTTP header 'Accept' (if needed)
|
1467
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
1468
|
+
# HTTP header 'Content-Type'
|
1469
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
1470
|
+
|
1471
|
+
# form parameters
|
1472
|
+
form_params = {}
|
1473
|
+
|
1474
|
+
# http body (model)
|
1475
|
+
post_body = @api_client.object_to_http_body(input)
|
1476
|
+
auth_names = ['Apikey']
|
1477
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1478
|
+
:header_params => header_params,
|
1479
|
+
:query_params => query_params,
|
1480
|
+
:form_params => form_params,
|
1481
|
+
:body => post_body,
|
1482
|
+
:auth_names => auth_names,
|
1483
|
+
:return_type => 'Object')
|
1484
|
+
if @api_client.config.debugging
|
1485
|
+
@api_client.config.logger.debug "API called: MergeDocumentApi#merge_document_xlsx_multi_array\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1486
|
+
end
|
1487
|
+
return data, status_code, headers
|
1488
|
+
end
|
1058
1489
|
end
|
1059
1490
|
end
|
@@ -19,6 +19,64 @@ module CloudmersiveConvertApiClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Split a single Document into Separate Documents by Page as a Batch Job
|
23
|
+
# Split a Document (PPTX supported), comprised of multiple pages into separate files, with each containing exactly one page. 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.
|
24
|
+
# @param input_file Input file to perform the operation on.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [BOOLEAN] :return_document_contents Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation. Default is true.
|
27
|
+
# @return [SplitBatchJobCreateResult]
|
28
|
+
def split_document_batch_job_create(input_file, opts = {})
|
29
|
+
data, _status_code, _headers = split_document_batch_job_create_with_http_info(input_file, opts)
|
30
|
+
data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Split a single Document into Separate Documents by Page as a Batch Job
|
34
|
+
# Split a Document (PPTX supported), comprised of multiple pages into separate files, with each containing exactly one page. 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.
|
35
|
+
# @param input_file Input file to perform the operation on.
|
36
|
+
# @param [Hash] opts the optional parameters
|
37
|
+
# @option opts [BOOLEAN] :return_document_contents Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation. Default is true.
|
38
|
+
# @return [Array<(SplitBatchJobCreateResult, Fixnum, Hash)>] SplitBatchJobCreateResult data, response status code and response headers
|
39
|
+
def split_document_batch_job_create_with_http_info(input_file, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: SplitDocumentApi.split_document_batch_job_create ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'input_file' is set
|
44
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling SplitDocumentApi.split_document_batch_job_create"
|
46
|
+
end
|
47
|
+
# resource path
|
48
|
+
local_var_path = '/convert/split/batch-job/create'
|
49
|
+
|
50
|
+
# query parameters
|
51
|
+
query_params = {}
|
52
|
+
|
53
|
+
# header parameters
|
54
|
+
header_params = {}
|
55
|
+
# HTTP header 'Accept' (if needed)
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
57
|
+
# HTTP header 'Content-Type'
|
58
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
59
|
+
header_params[:'returnDocumentContents'] = opts[:'return_document_contents'] if !opts[:'return_document_contents'].nil?
|
60
|
+
|
61
|
+
# form parameters
|
62
|
+
form_params = {}
|
63
|
+
form_params['inputFile'] = input_file
|
64
|
+
|
65
|
+
# http body (model)
|
66
|
+
post_body = nil
|
67
|
+
auth_names = ['Apikey']
|
68
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
69
|
+
:header_params => header_params,
|
70
|
+
:query_params => query_params,
|
71
|
+
:form_params => form_params,
|
72
|
+
:body => post_body,
|
73
|
+
:auth_names => auth_names,
|
74
|
+
:return_type => 'SplitBatchJobCreateResult')
|
75
|
+
if @api_client.config.debugging
|
76
|
+
@api_client.config.logger.debug "API called: SplitDocumentApi#split_document_batch_job_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
77
|
+
end
|
78
|
+
return data, status_code, headers
|
79
|
+
end
|
22
80
|
# Split a single Word Document DOCX into Separate Documents by Page
|
23
81
|
# Split a Word DOCX Document, comprised of multiple pages into separate Word DOCX document files, with each containing exactly one page.
|
24
82
|
# @param input_file Input file to perform the operation on.
|
@@ -77,6 +135,59 @@ module CloudmersiveConvertApiClient
|
|
77
135
|
end
|
78
136
|
return data, status_code, headers
|
79
137
|
end
|
138
|
+
# Get the status and result of a Split Document Batch Job
|
139
|
+
# 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.
|
140
|
+
# @param async_job_id
|
141
|
+
# @param [Hash] opts the optional parameters
|
142
|
+
# @return [JobStatusResult]
|
143
|
+
def split_document_get_async_job_status(async_job_id, opts = {})
|
144
|
+
data, _status_code, _headers = split_document_get_async_job_status_with_http_info(async_job_id, opts)
|
145
|
+
data
|
146
|
+
end
|
147
|
+
|
148
|
+
# Get the status and result of a Split Document Batch Job
|
149
|
+
# 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.
|
150
|
+
# @param async_job_id
|
151
|
+
# @param [Hash] opts the optional parameters
|
152
|
+
# @return [Array<(JobStatusResult, Fixnum, Hash)>] JobStatusResult data, response status code and response headers
|
153
|
+
def split_document_get_async_job_status_with_http_info(async_job_id, opts = {})
|
154
|
+
if @api_client.config.debugging
|
155
|
+
@api_client.config.logger.debug 'Calling API: SplitDocumentApi.split_document_get_async_job_status ...'
|
156
|
+
end
|
157
|
+
# verify the required parameter 'async_job_id' is set
|
158
|
+
if @api_client.config.client_side_validation && async_job_id.nil?
|
159
|
+
fail ArgumentError, "Missing the required parameter 'async_job_id' when calling SplitDocumentApi.split_document_get_async_job_status"
|
160
|
+
end
|
161
|
+
# resource path
|
162
|
+
local_var_path = '/convert/split/batch-job/status'
|
163
|
+
|
164
|
+
# query parameters
|
165
|
+
query_params = {}
|
166
|
+
query_params[:'AsyncJobID'] = async_job_id
|
167
|
+
|
168
|
+
# header parameters
|
169
|
+
header_params = {}
|
170
|
+
# HTTP header 'Accept' (if needed)
|
171
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
172
|
+
|
173
|
+
# form parameters
|
174
|
+
form_params = {}
|
175
|
+
|
176
|
+
# http body (model)
|
177
|
+
post_body = nil
|
178
|
+
auth_names = ['Apikey']
|
179
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
180
|
+
:header_params => header_params,
|
181
|
+
:query_params => query_params,
|
182
|
+
:form_params => form_params,
|
183
|
+
:body => post_body,
|
184
|
+
:auth_names => auth_names,
|
185
|
+
:return_type => 'JobStatusResult')
|
186
|
+
if @api_client.config.debugging
|
187
|
+
@api_client.config.logger.debug "API called: SplitDocumentApi#split_document_get_async_job_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
188
|
+
end
|
189
|
+
return data, status_code, headers
|
190
|
+
end
|
80
191
|
# Split a PDF file into separate PDF files, one per page
|
81
192
|
# Split an input PDF file into separate pages, comprised of one PDF file per page.
|
82
193
|
# @param input_file Input file to perform the operation on.
|
@@ -193,6 +304,60 @@ module CloudmersiveConvertApiClient
|
|
193
304
|
end
|
194
305
|
return data, status_code, headers
|
195
306
|
end
|
307
|
+
# Split a single PowerPoint Presentation PPTX into Separate Presentations
|
308
|
+
# Split a PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentations of customizeable size.
|
309
|
+
# @param request
|
310
|
+
# @param [Hash] opts the optional parameters
|
311
|
+
# @return [PptxSplitAdvancedResponse]
|
312
|
+
def split_document_pptx_advanced(request, opts = {})
|
313
|
+
data, _status_code, _headers = split_document_pptx_advanced_with_http_info(request, opts)
|
314
|
+
data
|
315
|
+
end
|
316
|
+
|
317
|
+
# Split a single PowerPoint Presentation PPTX into Separate Presentations
|
318
|
+
# Split a PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentations of customizeable size.
|
319
|
+
# @param request
|
320
|
+
# @param [Hash] opts the optional parameters
|
321
|
+
# @return [Array<(PptxSplitAdvancedResponse, Fixnum, Hash)>] PptxSplitAdvancedResponse data, response status code and response headers
|
322
|
+
def split_document_pptx_advanced_with_http_info(request, opts = {})
|
323
|
+
if @api_client.config.debugging
|
324
|
+
@api_client.config.logger.debug 'Calling API: SplitDocumentApi.split_document_pptx_advanced ...'
|
325
|
+
end
|
326
|
+
# verify the required parameter 'request' is set
|
327
|
+
if @api_client.config.client_side_validation && request.nil?
|
328
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling SplitDocumentApi.split_document_pptx_advanced"
|
329
|
+
end
|
330
|
+
# resource path
|
331
|
+
local_var_path = '/convert/split/pptx/advanced'
|
332
|
+
|
333
|
+
# query parameters
|
334
|
+
query_params = {}
|
335
|
+
|
336
|
+
# header parameters
|
337
|
+
header_params = {}
|
338
|
+
# HTTP header 'Accept' (if needed)
|
339
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
340
|
+
# HTTP header 'Content-Type'
|
341
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
342
|
+
|
343
|
+
# form parameters
|
344
|
+
form_params = {}
|
345
|
+
|
346
|
+
# http body (model)
|
347
|
+
post_body = @api_client.object_to_http_body(request)
|
348
|
+
auth_names = ['Apikey']
|
349
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
350
|
+
:header_params => header_params,
|
351
|
+
:query_params => query_params,
|
352
|
+
:form_params => form_params,
|
353
|
+
:body => post_body,
|
354
|
+
:auth_names => auth_names,
|
355
|
+
:return_type => 'PptxSplitAdvancedResponse')
|
356
|
+
if @api_client.config.debugging
|
357
|
+
@api_client.config.logger.debug "API called: SplitDocumentApi#split_document_pptx_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
358
|
+
end
|
359
|
+
return data, status_code, headers
|
360
|
+
end
|
196
361
|
# Split a single Text file (txt) into lines
|
197
362
|
# Split a Text (txt) Document by line, returning each line separately in order. Supports multiple types of newlines.
|
198
363
|
# @param input_file Input file to perform the operation on.
|