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
@@ -78,6 +78,7 @@ module CloudmersiveConvertApiClient
78
78
  # Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.
79
79
  # @param input_file Input file to perform the operation on.
80
80
  # @param [Hash] opts the optional parameters
81
+ # @option opts [BOOLEAN] :autorepair Optional; automatically repair input documents that have errors (default is true)
81
82
  # @return [String]
82
83
  def edit_document_docx_accept_all_track_changes(input_file, opts = {})
83
84
  data, _status_code, _headers = edit_document_docx_accept_all_track_changes_with_http_info(input_file, opts)
@@ -88,6 +89,7 @@ module CloudmersiveConvertApiClient
88
89
  # Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.
89
90
  # @param input_file Input file to perform the operation on.
90
91
  # @param [Hash] opts the optional parameters
92
+ # @option opts [BOOLEAN] :autorepair Optional; automatically repair input documents that have errors (default is true)
91
93
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
92
94
  def edit_document_docx_accept_all_track_changes_with_http_info(input_file, opts = {})
93
95
  if @api_client.config.debugging
@@ -109,6 +111,7 @@ module CloudmersiveConvertApiClient
109
111
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
110
112
  # HTTP header 'Content-Type'
111
113
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
114
+ header_params[:'autorepair'] = opts[:'autorepair'] if !opts[:'autorepair'].nil?
112
115
 
113
116
  # form parameters
114
117
  form_params = {}
@@ -2458,6 +2461,70 @@ module CloudmersiveConvertApiClient
2458
2461
  end
2459
2462
  return data, status_code, headers
2460
2463
  end
2464
+ # Set the size and/or orientation of a PowerPoint PPTX presentation document
2465
+ # Edits the input PowerPoint PPTX presentation document to be a different orientation and/or size
2466
+ # @param input_file Input file to perform the operation on.
2467
+ # @param [Hash] opts the optional parameters
2468
+ # @option opts [String] :orientation Optional: The desired slide orientation; can be landscape or portrait.
2469
+ # @option opts [Integer] :width Optional: The desired slide width in Emu, where 1 inch equals 914400 emu.
2470
+ # @option opts [Integer] :height Optional: The desired slide height in Emu, where 1 inch equals 914400 emu
2471
+ # @return [String]
2472
+ def edit_document_pptx_edit_size_and_orientation(input_file, opts = {})
2473
+ data, _status_code, _headers = edit_document_pptx_edit_size_and_orientation_with_http_info(input_file, opts)
2474
+ data
2475
+ end
2476
+
2477
+ # Set the size and/or orientation of a PowerPoint PPTX presentation document
2478
+ # Edits the input PowerPoint PPTX presentation document to be a different orientation and/or size
2479
+ # @param input_file Input file to perform the operation on.
2480
+ # @param [Hash] opts the optional parameters
2481
+ # @option opts [String] :orientation Optional: The desired slide orientation; can be landscape or portrait.
2482
+ # @option opts [Integer] :width Optional: The desired slide width in Emu, where 1 inch equals 914400 emu.
2483
+ # @option opts [Integer] :height Optional: The desired slide height in Emu, where 1 inch equals 914400 emu
2484
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
2485
+ def edit_document_pptx_edit_size_and_orientation_with_http_info(input_file, opts = {})
2486
+ if @api_client.config.debugging
2487
+ @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_pptx_edit_size_and_orientation ...'
2488
+ end
2489
+ # verify the required parameter 'input_file' is set
2490
+ if @api_client.config.client_side_validation && input_file.nil?
2491
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_pptx_edit_size_and_orientation"
2492
+ end
2493
+ # resource path
2494
+ local_var_path = '/convert/edit/pptx/set-size-and-orientation'
2495
+
2496
+ # query parameters
2497
+ query_params = {}
2498
+
2499
+ # header parameters
2500
+ header_params = {}
2501
+ # HTTP header 'Accept' (if needed)
2502
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
2503
+ # HTTP header 'Content-Type'
2504
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
2505
+ header_params[:'orientation'] = opts[:'orientation'] if !opts[:'orientation'].nil?
2506
+ header_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
2507
+ header_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
2508
+
2509
+ # form parameters
2510
+ form_params = {}
2511
+ form_params['inputFile'] = input_file
2512
+
2513
+ # http body (model)
2514
+ post_body = nil
2515
+ auth_names = ['Apikey']
2516
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2517
+ :header_params => header_params,
2518
+ :query_params => query_params,
2519
+ :form_params => form_params,
2520
+ :body => post_body,
2521
+ :auth_names => auth_names,
2522
+ :return_type => 'String')
2523
+ if @api_client.config.debugging
2524
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_pptx_edit_size_and_orientation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2525
+ end
2526
+ return data, status_code, headers
2527
+ end
2461
2528
  # Get macro information from a PowerPoint PPTX/PPTM presentation document
2462
2529
  # Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
2463
2530
  # @param input_file Input file to perform the operation on.
@@ -2513,6 +2580,61 @@ module CloudmersiveConvertApiClient
2513
2580
  end
2514
2581
  return data, status_code, headers
2515
2582
  end
2583
+ # Get the page layout information, including size and orientation of a PowerPoint PPTX presentation document
2584
+ # Gets size and orientation of an input PowerPoint PPTX presentation
2585
+ # @param input_file Input file to perform the operation on.
2586
+ # @param [Hash] opts the optional parameters
2587
+ # @return [PptxPageLayoutInformation]
2588
+ def edit_document_pptx_get_size_and_orientation(input_file, opts = {})
2589
+ data, _status_code, _headers = edit_document_pptx_get_size_and_orientation_with_http_info(input_file, opts)
2590
+ data
2591
+ end
2592
+
2593
+ # Get the page layout information, including size and orientation of a PowerPoint PPTX presentation document
2594
+ # Gets size and orientation of an input PowerPoint PPTX presentation
2595
+ # @param input_file Input file to perform the operation on.
2596
+ # @param [Hash] opts the optional parameters
2597
+ # @return [Array<(PptxPageLayoutInformation, Fixnum, Hash)>] PptxPageLayoutInformation data, response status code and response headers
2598
+ def edit_document_pptx_get_size_and_orientation_with_http_info(input_file, opts = {})
2599
+ if @api_client.config.debugging
2600
+ @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_pptx_get_size_and_orientation ...'
2601
+ end
2602
+ # verify the required parameter 'input_file' is set
2603
+ if @api_client.config.client_side_validation && input_file.nil?
2604
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling EditDocumentApi.edit_document_pptx_get_size_and_orientation"
2605
+ end
2606
+ # resource path
2607
+ local_var_path = '/convert/edit/pptx/get-size-and-orientation'
2608
+
2609
+ # query parameters
2610
+ query_params = {}
2611
+
2612
+ # header parameters
2613
+ header_params = {}
2614
+ # HTTP header 'Accept' (if needed)
2615
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
2616
+ # HTTP header 'Content-Type'
2617
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
2618
+
2619
+ # form parameters
2620
+ form_params = {}
2621
+ form_params['inputFile'] = input_file
2622
+
2623
+ # http body (model)
2624
+ post_body = nil
2625
+ auth_names = ['Apikey']
2626
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2627
+ :header_params => header_params,
2628
+ :query_params => query_params,
2629
+ :form_params => form_params,
2630
+ :body => post_body,
2631
+ :auth_names => auth_names,
2632
+ :return_type => 'PptxPageLayoutInformation')
2633
+ if @api_client.config.debugging
2634
+ @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_pptx_get_size_and_orientation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2635
+ end
2636
+ return data, status_code, headers
2637
+ end
2516
2638
  # Replace string in PowerPoint PPTX presentation
2517
2639
  # Replace all instances of a string in an Office PowerPoint Document (pptx)
2518
2640
  # @param req_config Replacement document configuration input
@@ -262,6 +262,75 @@ module CloudmersiveConvertApiClient
262
262
  end
263
263
  return data, status_code, headers
264
264
  end
265
+ # Remove, delete pages from a PDF document as Batch Job
266
+ # 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.
267
+ # @param input_file Input file to perform the operation on.
268
+ # @param page_start Page number (1 based) to start deleting pages from (inclusive).
269
+ # @param page_end Page number (1 based) to stop deleting pages from (inclusive).
270
+ # @param [Hash] opts the optional parameters
271
+ # @return [EditPdfBatchJobCreateResult]
272
+ def edit_pdf_delete_pages_batch_job(input_file, page_start, page_end, opts = {})
273
+ data, _status_code, _headers = edit_pdf_delete_pages_batch_job_with_http_info(input_file, page_start, page_end, opts)
274
+ data
275
+ end
276
+
277
+ # Remove, delete pages from a PDF document as Batch Job
278
+ # 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.
279
+ # @param input_file Input file to perform the operation on.
280
+ # @param page_start Page number (1 based) to start deleting pages from (inclusive).
281
+ # @param page_end Page number (1 based) to stop deleting pages from (inclusive).
282
+ # @param [Hash] opts the optional parameters
283
+ # @return [Array<(EditPdfBatchJobCreateResult, Fixnum, Hash)>] EditPdfBatchJobCreateResult data, response status code and response headers
284
+ def edit_pdf_delete_pages_batch_job_with_http_info(input_file, page_start, page_end, opts = {})
285
+ if @api_client.config.debugging
286
+ @api_client.config.logger.debug 'Calling API: EditPdfApi.edit_pdf_delete_pages_batch_job ...'
287
+ end
288
+ # verify the required parameter 'input_file' is set
289
+ if @api_client.config.client_side_validation && input_file.nil?
290
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling EditPdfApi.edit_pdf_delete_pages_batch_job"
291
+ end
292
+ # verify the required parameter 'page_start' is set
293
+ if @api_client.config.client_side_validation && page_start.nil?
294
+ fail ArgumentError, "Missing the required parameter 'page_start' when calling EditPdfApi.edit_pdf_delete_pages_batch_job"
295
+ end
296
+ # verify the required parameter 'page_end' is set
297
+ if @api_client.config.client_side_validation && page_end.nil?
298
+ fail ArgumentError, "Missing the required parameter 'page_end' when calling EditPdfApi.edit_pdf_delete_pages_batch_job"
299
+ end
300
+ # resource path
301
+ local_var_path = '/convert/edit/pdf/pages/delete/batch-job'
302
+
303
+ # query parameters
304
+ query_params = {}
305
+
306
+ # header parameters
307
+ header_params = {}
308
+ # HTTP header 'Accept' (if needed)
309
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
310
+ # HTTP header 'Content-Type'
311
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
312
+ header_params[:'pageStart'] = page_start
313
+ header_params[:'pageEnd'] = page_end
314
+
315
+ # form parameters
316
+ form_params = {}
317
+ form_params['inputFile'] = input_file
318
+
319
+ # http body (model)
320
+ post_body = nil
321
+ auth_names = ['Apikey']
322
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
323
+ :header_params => header_params,
324
+ :query_params => query_params,
325
+ :form_params => form_params,
326
+ :body => post_body,
327
+ :auth_names => auth_names,
328
+ :return_type => 'EditPdfBatchJobCreateResult')
329
+ if @api_client.config.debugging
330
+ @api_client.config.logger.debug "API called: EditPdfApi#edit_pdf_delete_pages_batch_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
331
+ end
332
+ return data, status_code, headers
333
+ end
265
334
  # Encrypt and password-protect a PDF
266
335
  # Encrypt a PDF document with a password. Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF. Set the password fields null to omit the given password.
267
336
  # @param input_file Input file to perform the operation on.
@@ -381,6 +450,59 @@ module CloudmersiveConvertApiClient
381
450
  end
382
451
  return data, status_code, headers
383
452
  end
453
+ # Get the status and result of a PDF Batch Job
454
+ # 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.
455
+ # @param async_job_id
456
+ # @param [Hash] opts the optional parameters
457
+ # @return [EditPdfJobStatusResult]
458
+ def edit_pdf_get_async_job_status(async_job_id, opts = {})
459
+ data, _status_code, _headers = edit_pdf_get_async_job_status_with_http_info(async_job_id, opts)
460
+ data
461
+ end
462
+
463
+ # Get the status and result of a PDF Batch Job
464
+ # 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.
465
+ # @param async_job_id
466
+ # @param [Hash] opts the optional parameters
467
+ # @return [Array<(EditPdfJobStatusResult, Fixnum, Hash)>] EditPdfJobStatusResult data, response status code and response headers
468
+ def edit_pdf_get_async_job_status_with_http_info(async_job_id, opts = {})
469
+ if @api_client.config.debugging
470
+ @api_client.config.logger.debug 'Calling API: EditPdfApi.edit_pdf_get_async_job_status ...'
471
+ end
472
+ # verify the required parameter 'async_job_id' is set
473
+ if @api_client.config.client_side_validation && async_job_id.nil?
474
+ fail ArgumentError, "Missing the required parameter 'async_job_id' when calling EditPdfApi.edit_pdf_get_async_job_status"
475
+ end
476
+ # resource path
477
+ local_var_path = '/convert/edit/pdf/batch-job/status'
478
+
479
+ # query parameters
480
+ query_params = {}
481
+ query_params[:'AsyncJobID'] = async_job_id
482
+
483
+ # header parameters
484
+ header_params = {}
485
+ # HTTP header 'Accept' (if needed)
486
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
487
+
488
+ # form parameters
489
+ form_params = {}
490
+
491
+ # http body (model)
492
+ post_body = nil
493
+ auth_names = ['Apikey']
494
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
495
+ :header_params => header_params,
496
+ :query_params => query_params,
497
+ :form_params => form_params,
498
+ :body => post_body,
499
+ :auth_names => auth_names,
500
+ :return_type => 'EditPdfJobStatusResult')
501
+ if @api_client.config.debugging
502
+ @api_client.config.logger.debug "API called: EditPdfApi#edit_pdf_get_async_job_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
503
+ end
504
+ return data, status_code, headers
505
+ end
384
506
  # Gets PDF Form fields and values
385
507
  # Encrypt a PDF document with a password. Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF. Set the password fields null to omit the given password.
386
508
  # @param input_file Input file to perform the operation on.
@@ -632,6 +754,89 @@ module CloudmersiveConvertApiClient
632
754
  end
633
755
  return data, status_code, headers
634
756
  end
757
+ # Insert, copy pages from one PDF document into another as a batch job
758
+ # 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.
759
+ # @param source_file Source PDF file to copy pages from.
760
+ # @param destination_file Destination PDF file to copy pages into.
761
+ # @param page_start_source Page number (1 based) to start copying pages from (inclusive) in the Source file.
762
+ # @param page_end_source Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
763
+ # @param page_insert_before_desitnation Page number (1 based) to insert the pages before in the Destination file.
764
+ # @param [Hash] opts the optional parameters
765
+ # @return [EditPdfBatchJobCreateResult]
766
+ def edit_pdf_insert_pages_batch_job(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation, opts = {})
767
+ data, _status_code, _headers = edit_pdf_insert_pages_batch_job_with_http_info(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation, opts)
768
+ data
769
+ end
770
+
771
+ # Insert, copy pages from one PDF document into another as a batch job
772
+ # 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.
773
+ # @param source_file Source PDF file to copy pages from.
774
+ # @param destination_file Destination PDF file to copy pages into.
775
+ # @param page_start_source Page number (1 based) to start copying pages from (inclusive) in the Source file.
776
+ # @param page_end_source Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
777
+ # @param page_insert_before_desitnation Page number (1 based) to insert the pages before in the Destination file.
778
+ # @param [Hash] opts the optional parameters
779
+ # @return [Array<(EditPdfBatchJobCreateResult, Fixnum, Hash)>] EditPdfBatchJobCreateResult data, response status code and response headers
780
+ def edit_pdf_insert_pages_batch_job_with_http_info(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation, opts = {})
781
+ if @api_client.config.debugging
782
+ @api_client.config.logger.debug 'Calling API: EditPdfApi.edit_pdf_insert_pages_batch_job ...'
783
+ end
784
+ # verify the required parameter 'source_file' is set
785
+ if @api_client.config.client_side_validation && source_file.nil?
786
+ fail ArgumentError, "Missing the required parameter 'source_file' when calling EditPdfApi.edit_pdf_insert_pages_batch_job"
787
+ end
788
+ # verify the required parameter 'destination_file' is set
789
+ if @api_client.config.client_side_validation && destination_file.nil?
790
+ fail ArgumentError, "Missing the required parameter 'destination_file' when calling EditPdfApi.edit_pdf_insert_pages_batch_job"
791
+ end
792
+ # verify the required parameter 'page_start_source' is set
793
+ if @api_client.config.client_side_validation && page_start_source.nil?
794
+ fail ArgumentError, "Missing the required parameter 'page_start_source' when calling EditPdfApi.edit_pdf_insert_pages_batch_job"
795
+ end
796
+ # verify the required parameter 'page_end_source' is set
797
+ if @api_client.config.client_side_validation && page_end_source.nil?
798
+ fail ArgumentError, "Missing the required parameter 'page_end_source' when calling EditPdfApi.edit_pdf_insert_pages_batch_job"
799
+ end
800
+ # verify the required parameter 'page_insert_before_desitnation' is set
801
+ if @api_client.config.client_side_validation && page_insert_before_desitnation.nil?
802
+ fail ArgumentError, "Missing the required parameter 'page_insert_before_desitnation' when calling EditPdfApi.edit_pdf_insert_pages_batch_job"
803
+ end
804
+ # resource path
805
+ local_var_path = '/convert/edit/pdf/pages/insert/batch-job'
806
+
807
+ # query parameters
808
+ query_params = {}
809
+
810
+ # header parameters
811
+ header_params = {}
812
+ # HTTP header 'Accept' (if needed)
813
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
814
+ # HTTP header 'Content-Type'
815
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
816
+ header_params[:'pageStartSource'] = page_start_source
817
+ header_params[:'pageEndSource'] = page_end_source
818
+ header_params[:'pageInsertBeforeDesitnation'] = page_insert_before_desitnation
819
+
820
+ # form parameters
821
+ form_params = {}
822
+ form_params['sourceFile'] = source_file
823
+ form_params['destinationFile'] = destination_file
824
+
825
+ # http body (model)
826
+ post_body = nil
827
+ auth_names = ['Apikey']
828
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
829
+ :header_params => header_params,
830
+ :query_params => query_params,
831
+ :form_params => form_params,
832
+ :body => post_body,
833
+ :auth_names => auth_names,
834
+ :return_type => 'EditPdfBatchJobCreateResult')
835
+ if @api_client.config.debugging
836
+ @api_client.config.logger.debug "API called: EditPdfApi#edit_pdf_insert_pages_batch_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
837
+ end
838
+ return data, status_code, headers
839
+ end
635
840
  # Linearize and optimize a PDF for streaming download
636
841
  # Linearizes the content of a PDF to optimize it for streaming download, particularly over web streaming.
637
842
  # @param input_file Input file to perform the operation on.
@@ -691,6 +896,7 @@ module CloudmersiveConvertApiClient
691
896
  # 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.
692
897
  # @param input_file Input file to perform the operation on.
693
898
  # @param [Hash] opts the optional parameters
899
+ # @option opts [Integer] :dpi 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.
694
900
  # @return [String]
695
901
  def edit_pdf_rasterize(input_file, opts = {})
696
902
  data, _status_code, _headers = edit_pdf_rasterize_with_http_info(input_file, opts)
@@ -701,6 +907,7 @@ module CloudmersiveConvertApiClient
701
907
  # 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.
702
908
  # @param input_file Input file to perform the operation on.
703
909
  # @param [Hash] opts the optional parameters
910
+ # @option opts [Integer] :dpi 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.
704
911
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
705
912
  def edit_pdf_rasterize_with_http_info(input_file, opts = {})
706
913
  if @api_client.config.debugging
@@ -722,6 +929,7 @@ module CloudmersiveConvertApiClient
722
929
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
723
930
  # HTTP header 'Content-Type'
724
931
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
932
+ header_params[:'dpi'] = opts[:'dpi'] if !opts[:'dpi'].nil?
725
933
 
726
934
  # form parameters
727
935
  form_params = {}
@@ -742,6 +950,61 @@ module CloudmersiveConvertApiClient
742
950
  end
743
951
  return data, status_code, headers
744
952
  end
953
+ # Rasterize a PDF to an image-based PDF as Batch Job
954
+ # 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.
955
+ # @param input_file Input file to perform the operation on.
956
+ # @param [Hash] opts the optional parameters
957
+ # @return [EditPdfBatchJobCreateResult]
958
+ def edit_pdf_rasterize_batch_job(input_file, opts = {})
959
+ data, _status_code, _headers = edit_pdf_rasterize_batch_job_with_http_info(input_file, opts)
960
+ data
961
+ end
962
+
963
+ # Rasterize a PDF to an image-based PDF as Batch Job
964
+ # 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.
965
+ # @param input_file Input file to perform the operation on.
966
+ # @param [Hash] opts the optional parameters
967
+ # @return [Array<(EditPdfBatchJobCreateResult, Fixnum, Hash)>] EditPdfBatchJobCreateResult data, response status code and response headers
968
+ def edit_pdf_rasterize_batch_job_with_http_info(input_file, opts = {})
969
+ if @api_client.config.debugging
970
+ @api_client.config.logger.debug 'Calling API: EditPdfApi.edit_pdf_rasterize_batch_job ...'
971
+ end
972
+ # verify the required parameter 'input_file' is set
973
+ if @api_client.config.client_side_validation && input_file.nil?
974
+ fail ArgumentError, "Missing the required parameter 'input_file' when calling EditPdfApi.edit_pdf_rasterize_batch_job"
975
+ end
976
+ # resource path
977
+ local_var_path = '/convert/edit/pdf/rasterize/batch-job'
978
+
979
+ # query parameters
980
+ query_params = {}
981
+
982
+ # header parameters
983
+ header_params = {}
984
+ # HTTP header 'Accept' (if needed)
985
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
986
+ # HTTP header 'Content-Type'
987
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
988
+
989
+ # form parameters
990
+ form_params = {}
991
+ form_params['inputFile'] = input_file
992
+
993
+ # http body (model)
994
+ post_body = nil
995
+ auth_names = ['Apikey']
996
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
997
+ :header_params => header_params,
998
+ :query_params => query_params,
999
+ :form_params => form_params,
1000
+ :body => post_body,
1001
+ :auth_names => auth_names,
1002
+ :return_type => 'EditPdfBatchJobCreateResult')
1003
+ if @api_client.config.debugging
1004
+ @api_client.config.logger.debug "API called: EditPdfApi#edit_pdf_rasterize_batch_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1005
+ end
1006
+ return data, status_code, headers
1007
+ end
745
1008
  # Reduce the file size and optimize a PDF
746
1009
  # Reduces the file size and optimizes the content of a PDF to minimize its file size.
747
1010
  # @param input_file Input file to perform the operation on.