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
@@ -58,10 +58,22 @@ describe 'ConvertDataApi' do
58
58
  end
59
59
  end
60
60
 
61
+ # unit tests for convert_data_json_string_to_xml
62
+ # Convert JSON String to XML conversion
63
+ # Convert a JSON object into XML
64
+ # @param json_string Input JSON String to convert to XML
65
+ # @param [Hash] opts the optional parameters
66
+ # @return [Object]
67
+ describe 'convert_data_json_string_to_xml test' do
68
+ it 'should work' do
69
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
70
+ end
71
+ end
72
+
61
73
  # unit tests for convert_data_json_to_xml
62
- # Convert JSON to XML conversion
74
+ # Convert JSON Object to XML conversion
63
75
  # Convert a JSON object into XML
64
- # @param json_object Input JSON to convert to XML
76
+ # @param json_object Input JSON Object to convert to XML
65
77
  # @param [Hash] opts the optional parameters
66
78
  # @return [String]
67
79
  describe 'convert_data_json_to_xml test' do
@@ -59,7 +59,7 @@ describe 'ConvertDocumentApi' do
59
59
 
60
60
  # unit tests for convert_document_autodetect_to_pdf
61
61
  # Convert Document to PDF
62
- # Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, and even multi-page TIFF files.
62
+ # Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, text files, and even multi-page TIFF files.
63
63
  # @param input_file Input file to perform the operation on.
64
64
  # @param [Hash] opts the optional parameters
65
65
  # @return [String]
@@ -69,6 +69,18 @@ describe 'ConvertDocumentApi' do
69
69
  end
70
70
  end
71
71
 
72
+ # unit tests for convert_document_autodetect_to_pdf_batch_job
73
+ # Convert Document to PDF as Batch Job
74
+ # Automatically detect file type and convert it to PDF. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT), over 100 image formats, HTML files, text files, and even multi-page TIFF files. 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 is only available for Cloudmersive Managed Instance and Private Cloud deployments.
75
+ # @param input_file Input file to perform the operation on.
76
+ # @param [Hash] opts the optional parameters
77
+ # @return [ConvertDocumentBatchJobCreateResult]
78
+ describe 'convert_document_autodetect_to_pdf_batch_job test' do
79
+ it 'should work' do
80
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
81
+ end
82
+ end
83
+
72
84
  # unit tests for convert_document_autodetect_to_png_array
73
85
  # Convert Document to PNG array
74
86
  # Automatically detect file type and convert it to an array of PNG images. Supports all of the major Office document file formats, over 100 image formats, and even multi-page TIFF files.
@@ -357,6 +369,18 @@ describe 'ConvertDocumentApi' do
357
369
  end
358
370
  end
359
371
 
372
+ # unit tests for convert_document_get_async_job_status
373
+ # Get the status and result of a Convert Document Batch Job
374
+ # 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.
375
+ # @param async_job_id
376
+ # @param [Hash] opts the optional parameters
377
+ # @return [ConvertDocumentJobStatusResult]
378
+ describe 'convert_document_get_async_job_status test' do
379
+ it 'should work' do
380
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
381
+ end
382
+ end
383
+
360
384
  # unit tests for convert_document_get_file_type_icon
361
385
  # Get PNG icon file for the file extension
362
386
  # Returns a PNG icon for the given file format extension as a file for download. User may specify the icon size. Supports over 100 file formats, with a generic icon for unsupported formats.
@@ -708,9 +732,10 @@ describe 'ConvertDocumentApi' do
708
732
 
709
733
  # unit tests for convert_document_pdf_to_png_array
710
734
  # Convert PDF to PNG Image Array
711
- # Convert PDF document to PNG array, one image per page.
735
+ # Convert PDF document to PNG array, one image per page. Returns PNG images as temporary expiring URLs.
712
736
  # @param input_file Input file to perform the operation on.
713
737
  # @param [Hash] opts the optional parameters
738
+ # @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.
714
739
  # @return [PdfToPngResult]
715
740
  describe 'convert_document_pdf_to_png_array test' do
716
741
  it 'should work' do
@@ -718,6 +743,19 @@ describe 'ConvertDocumentApi' do
718
743
  end
719
744
  end
720
745
 
746
+ # unit tests for convert_document_pdf_to_png_array_direct
747
+ # Convert PDF to PNG Image Array (Direct)
748
+ # Convert PDF document to PNG array, one image per page. Returns PNG images directly in the response objects.
749
+ # @param input_file Input file to perform the operation on.
750
+ # @param [Hash] opts the optional parameters
751
+ # @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.
752
+ # @return [PdfToPngDirectResult]
753
+ describe 'convert_document_pdf_to_png_array_direct test' do
754
+ it 'should work' do
755
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
756
+ end
757
+ end
758
+
721
759
  # unit tests for convert_document_pdf_to_png_single
722
760
  # Convert PDF to Single PNG image
723
761
  # Convert PDF document to a single tall PNG image, by stacking/concatenating the images vertically into a single \"tall\" image
@@ -742,6 +780,20 @@ describe 'ConvertDocumentApi' do
742
780
  end
743
781
  end
744
782
 
783
+ # unit tests for convert_document_pdf_to_tiff
784
+ # Convert PDF to TIFF image
785
+ # Converts a PDF Document to a TIFF image. If the PDF contains multiple pages, these pages will be represented as separate pages within the output TIFF image.
786
+ # @param input_file Input file to perform the operation on.
787
+ # @param [Hash] opts the optional parameters
788
+ # @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.
789
+ # @option opts [BOOLEAN] :lzw_compression Optional; Enables LZW compression to reduce the size of the output image.
790
+ # @return [String]
791
+ describe 'convert_document_pdf_to_tiff test' do
792
+ it 'should work' do
793
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
794
+ end
795
+ end
796
+
745
797
  # unit tests for convert_document_pdf_to_txt
746
798
  # Convert PDF Document to Text (txt)
747
799
  # PDF document to text
@@ -776,6 +828,17 @@ describe 'ConvertDocumentApi' do
776
828
  end
777
829
  end
778
830
 
831
+ # unit tests for convert_document_png_array_to_pdf_flatten_transparency
832
+ # Convert PNG Array to PDF and remove transparency
833
+ # Convert an array of PNG images, remove transparency in source images, one image per page, into a newly-created PDF. Supports images of different sizes as input.
834
+ # @param [Hash] opts the optional parameters
835
+ # @return [Object]
836
+ describe 'convert_document_png_array_to_pdf_flatten_transparency test' do
837
+ it 'should work' do
838
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
839
+ end
840
+ end
841
+
779
842
  # unit tests for convert_document_ppt_to_pdf
780
843
  # Convert PowerPoint PPT (97-03) Presentation to PDF
781
844
  # Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF
@@ -827,8 +890,9 @@ describe 'ConvertDocumentApi' do
827
890
  # unit tests for convert_document_pptx_to_ppt
828
891
  # Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
829
892
  # Convert/downgrade modern Office PowerPoint PPTX Presentation to the legacy PowerPoint PPT (97-2003 Format) format
893
+ # @param input_file Input file to perform the operation on.
830
894
  # @param [Hash] opts the optional parameters
831
- # @return [Object]
895
+ # @return [String]
832
896
  describe 'convert_document_pptx_to_ppt test' do
833
897
  it 'should work' do
834
898
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -908,6 +972,19 @@ describe 'ConvertDocumentApi' do
908
972
  end
909
973
  end
910
974
 
975
+ # unit tests for convert_document_txt_to_pdf
976
+ # Convert TXT text file to PDF Document
977
+ # Convert simple text files to PDF.
978
+ # @param input_file Input file to perform the operation on.
979
+ # @param [Hash] opts the optional parameters
980
+ # @option opts [Integer] :scale_factor Optional: Set to 100 to scale at 100%, set to 50% to scale down to 50% scale, set to 200% to scale up to 200% scale, etc. Default is 100%. Maximum is 1000%.
981
+ # @return [String]
982
+ describe 'convert_document_txt_to_pdf test' do
983
+ it 'should work' do
984
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
985
+ end
986
+ end
987
+
911
988
  # unit tests for convert_document_xls_to_csv
912
989
  # Convert Excel XLS (97-03) Spreadsheet to CSV
913
990
  # Convert/upgrade Office Excel (97-2003) Workbooks (xls) to standard CSV format.
@@ -78,6 +78,7 @@ describe 'ConvertImageApi' do
78
78
  # @param format2 Output (convert to this format) file format as a 3+ letter file extension. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
79
79
  # @param input_file Input file to perform the operation on.
80
80
  # @param [Hash] opts the optional parameters
81
+ # @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.
81
82
  # @return [MultipageImageFormatConversionResult]
82
83
  describe 'convert_image_multipage_image_format_convert test' do
83
84
  it 'should work' do
@@ -49,6 +49,7 @@ describe 'EditDocumentApi' do
49
49
  # 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.
50
50
  # @param input_file Input file to perform the operation on.
51
51
  # @param [Hash] opts the optional parameters
52
+ # @option opts [BOOLEAN] :autorepair Optional; automatically repair input documents that have errors (default is true)
52
53
  # @return [String]
53
54
  describe 'edit_document_docx_accept_all_track_changes test' do
54
55
  it 'should work' do
@@ -572,6 +573,21 @@ describe 'EditDocumentApi' do
572
573
  end
573
574
  end
574
575
 
576
+ # unit tests for edit_document_pptx_edit_size_and_orientation
577
+ # Set the size and/or orientation of a PowerPoint PPTX presentation document
578
+ # Edits the input PowerPoint PPTX presentation document to be a different orientation and/or size
579
+ # @param input_file Input file to perform the operation on.
580
+ # @param [Hash] opts the optional parameters
581
+ # @option opts [String] :orientation Optional: The desired slide orientation; can be landscape or portrait.
582
+ # @option opts [Integer] :width Optional: The desired slide width in Emu, where 1 inch equals 914400 emu.
583
+ # @option opts [Integer] :height Optional: The desired slide height in Emu, where 1 inch equals 914400 emu
584
+ # @return [String]
585
+ describe 'edit_document_pptx_edit_size_and_orientation test' do
586
+ it 'should work' do
587
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
588
+ end
589
+ end
590
+
575
591
  # unit tests for edit_document_pptx_get_macro_information
576
592
  # Get macro information from a PowerPoint PPTX/PPTM presentation document
577
593
  # Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
@@ -584,6 +600,18 @@ describe 'EditDocumentApi' do
584
600
  end
585
601
  end
586
602
 
603
+ # unit tests for edit_document_pptx_get_size_and_orientation
604
+ # Get the page layout information, including size and orientation of a PowerPoint PPTX presentation document
605
+ # Gets size and orientation of an input PowerPoint PPTX presentation
606
+ # @param input_file Input file to perform the operation on.
607
+ # @param [Hash] opts the optional parameters
608
+ # @return [PptxPageLayoutInformation]
609
+ describe 'edit_document_pptx_get_size_and_orientation test' do
610
+ it 'should work' do
611
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
612
+ end
613
+ end
614
+
587
615
  # unit tests for edit_document_pptx_replace
588
616
  # Replace string in PowerPoint PPTX presentation
589
617
  # Replace all instances of a string in an Office PowerPoint Document (pptx)
@@ -84,6 +84,20 @@ describe 'EditPdfApi' do
84
84
  end
85
85
  end
86
86
 
87
+ # unit tests for edit_pdf_delete_pages_batch_job
88
+ # Remove, delete pages from a PDF document as Batch Job
89
+ # 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.
90
+ # @param input_file Input file to perform the operation on.
91
+ # @param page_start Page number (1 based) to start deleting pages from (inclusive).
92
+ # @param page_end Page number (1 based) to stop deleting pages from (inclusive).
93
+ # @param [Hash] opts the optional parameters
94
+ # @return [EditPdfBatchJobCreateResult]
95
+ describe 'edit_pdf_delete_pages_batch_job test' do
96
+ it 'should work' do
97
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
98
+ end
99
+ end
100
+
87
101
  # unit tests for edit_pdf_encrypt
88
102
  # Encrypt and password-protect a PDF
89
103
  # 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.
@@ -111,6 +125,18 @@ describe 'EditPdfApi' do
111
125
  end
112
126
  end
113
127
 
128
+ # unit tests for edit_pdf_get_async_job_status
129
+ # Get the status and result of a PDF Batch Job
130
+ # 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.
131
+ # @param async_job_id
132
+ # @param [Hash] opts the optional parameters
133
+ # @return [EditPdfJobStatusResult]
134
+ describe 'edit_pdf_get_async_job_status test' do
135
+ it 'should work' do
136
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
137
+ end
138
+ end
139
+
114
140
  # unit tests for edit_pdf_get_form_fields
115
141
  # Gets PDF Form fields and values
116
142
  # 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.
@@ -164,6 +190,22 @@ describe 'EditPdfApi' do
164
190
  end
165
191
  end
166
192
 
193
+ # unit tests for edit_pdf_insert_pages_batch_job
194
+ # Insert, copy pages from one PDF document into another as a batch job
195
+ # 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.
196
+ # @param source_file Source PDF file to copy pages from.
197
+ # @param destination_file Destination PDF file to copy pages into.
198
+ # @param page_start_source Page number (1 based) to start copying pages from (inclusive) in the Source file.
199
+ # @param page_end_source Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
200
+ # @param page_insert_before_desitnation Page number (1 based) to insert the pages before in the Destination file.
201
+ # @param [Hash] opts the optional parameters
202
+ # @return [EditPdfBatchJobCreateResult]
203
+ describe 'edit_pdf_insert_pages_batch_job test' do
204
+ it 'should work' do
205
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
206
+ end
207
+ end
208
+
167
209
  # unit tests for edit_pdf_linearize
168
210
  # Linearize and optimize a PDF for streaming download
169
211
  # Linearizes the content of a PDF to optimize it for streaming download, particularly over web streaming.
@@ -181,6 +223,7 @@ describe 'EditPdfApi' do
181
223
  # 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.
182
224
  # @param input_file Input file to perform the operation on.
183
225
  # @param [Hash] opts the optional parameters
226
+ # @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.
184
227
  # @return [String]
185
228
  describe 'edit_pdf_rasterize test' do
186
229
  it 'should work' do
@@ -188,6 +231,18 @@ describe 'EditPdfApi' do
188
231
  end
189
232
  end
190
233
 
234
+ # unit tests for edit_pdf_rasterize_batch_job
235
+ # Rasterize a PDF to an image-based PDF as Batch Job
236
+ # 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.
237
+ # @param input_file Input file to perform the operation on.
238
+ # @param [Hash] opts the optional parameters
239
+ # @return [EditPdfBatchJobCreateResult]
240
+ describe 'edit_pdf_rasterize_batch_job test' do
241
+ it 'should work' do
242
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
243
+ end
244
+ end
245
+
191
246
  # unit tests for edit_pdf_reduce_file_size
192
247
  # Reduce the file size and optimize a PDF
193
248
  # Reduces the file size and optimizes the content of a PDF to minimize its file size.
@@ -32,6 +32,18 @@ describe 'MergeDocumentApi' do
32
32
  end
33
33
  end
34
34
 
35
+ # unit tests for merge_document_batch_job_create
36
+ # Merge an array of Documents into a Single Document by Page as a Batch Job
37
+ # 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.
38
+ # @param input
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [MergeBatchJobCreateResult]
41
+ describe 'merge_document_batch_job_create test' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
35
47
  # unit tests for merge_document_docx
36
48
  # Merge Two Word DOCX Together
37
49
  # Combine two Office Word Documents (docx) into one single Office Word document
@@ -66,6 +78,30 @@ describe 'MergeDocumentApi' do
66
78
  end
67
79
  end
68
80
 
81
+ # unit tests for merge_document_docx_multi_array
82
+ # Merge Multple Word DOCX Together from an array
83
+ # Combine multiple Office Word Documents (docx), stored in an array, into one single Office Word document
84
+ # @param input Array of input files
85
+ # @param [Hash] opts the optional parameters
86
+ # @return [Object]
87
+ describe 'merge_document_docx_multi_array test' do
88
+ it 'should work' do
89
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
90
+ end
91
+ end
92
+
93
+ # unit tests for merge_document_get_async_job_status
94
+ # Get the status and result of a Merge Document Batch Job
95
+ # 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.
96
+ # @param async_job_id
97
+ # @param [Hash] opts the optional parameters
98
+ # @return [MergeJobStatusResult]
99
+ describe 'merge_document_get_async_job_status test' do
100
+ it 'should work' do
101
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
102
+ end
103
+ end
104
+
69
105
  # unit tests for merge_document_html
70
106
  # Merge Two HTML (HTM) Files Together
71
107
  # 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.
@@ -100,6 +136,18 @@ describe 'MergeDocumentApi' do
100
136
  end
101
137
  end
102
138
 
139
+ # unit tests for merge_document_html_multi_array
140
+ # Merge Multple HTML (HTM) Files Together from an array
141
+ # 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.
142
+ # @param input Array of input files
143
+ # @param [Hash] opts the optional parameters
144
+ # @return [Object]
145
+ describe 'merge_document_html_multi_array test' do
146
+ it 'should work' do
147
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
148
+ end
149
+ end
150
+
103
151
  # unit tests for merge_document_pdf
104
152
  # Merge Two PDF Files Together
105
153
  # Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document
@@ -134,6 +182,18 @@ describe 'MergeDocumentApi' do
134
182
  end
135
183
  end
136
184
 
185
+ # unit tests for merge_document_pdf_multi_array
186
+ # Merge Multple PDF Files Together from an array
187
+ # Combine multiple PDF files (pdf), as an array, into a single PDF document, preserving the order of the input documents in the combined document
188
+ # @param input Array of input files
189
+ # @param [Hash] opts the optional parameters
190
+ # @return [Object]
191
+ describe 'merge_document_pdf_multi_array test' do
192
+ it 'should work' do
193
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
194
+ end
195
+ end
196
+
137
197
  # unit tests for merge_document_png
138
198
  # Merge Two PNG Files Together
139
199
  # Combine two PNG files into a single PNG document, preserving the order of the input documents in the combined document by stacking them vertically
@@ -168,6 +228,18 @@ describe 'MergeDocumentApi' do
168
228
  end
169
229
  end
170
230
 
231
+ # unit tests for merge_document_png_multi_array
232
+ # Merge Multple PNG Files Together from an array
233
+ # 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
234
+ # @param input Array of input files
235
+ # @param [Hash] opts the optional parameters
236
+ # @return [Object]
237
+ describe 'merge_document_png_multi_array test' do
238
+ it 'should work' do
239
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
240
+ end
241
+ end
242
+
171
243
  # unit tests for merge_document_pptx
172
244
  # Merge Two PowerPoint PPTX Together
173
245
  # Combine two Office PowerPoint presentations (pptx) into one single Office PowerPoint presentation
@@ -202,6 +274,18 @@ describe 'MergeDocumentApi' do
202
274
  end
203
275
  end
204
276
 
277
+ # unit tests for merge_document_pptx_multi_array
278
+ # Merge Multple PowerPoint PPTX Together from an array
279
+ # Combine multiple Office PowerPoint presentations (pptx), from an array, into one single Office PowerPoint presentation
280
+ # @param input Array of input files
281
+ # @param [Hash] opts the optional parameters
282
+ # @return [Object]
283
+ describe 'merge_document_pptx_multi_array test' do
284
+ it 'should work' do
285
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
286
+ end
287
+ end
288
+
205
289
  # unit tests for merge_document_txt
206
290
  # Merge Two Text (TXT) Files Together
207
291
  # 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.
@@ -270,4 +354,16 @@ describe 'MergeDocumentApi' do
270
354
  end
271
355
  end
272
356
 
357
+ # unit tests for merge_document_xlsx_multi_array
358
+ # Merge Multple Excel XLSX Together from an Array
359
+ # Combine multiple Office Excel spreadsheets (xlsx), as an array, into a single Office Excel spreadsheet
360
+ # @param input Array of input files
361
+ # @param [Hash] opts the optional parameters
362
+ # @return [Object]
363
+ describe 'merge_document_xlsx_multi_array test' do
364
+ it 'should work' do
365
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
366
+ end
367
+ end
368
+
273
369
  end
@@ -32,6 +32,19 @@ describe 'SplitDocumentApi' do
32
32
  end
33
33
  end
34
34
 
35
+ # unit tests for split_document_batch_job_create
36
+ # Split a single Document into Separate Documents by Page as a Batch Job
37
+ # 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.
38
+ # @param input_file Input file to perform the operation on.
39
+ # @param [Hash] opts the optional parameters
40
+ # @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.
41
+ # @return [SplitBatchJobCreateResult]
42
+ describe 'split_document_batch_job_create test' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
45
+ end
46
+ end
47
+
35
48
  # unit tests for split_document_docx
36
49
  # Split a single Word Document DOCX into Separate Documents by Page
37
50
  # Split a Word DOCX Document, comprised of multiple pages into separate Word DOCX document files, with each containing exactly one page.
@@ -45,6 +58,18 @@ describe 'SplitDocumentApi' do
45
58
  end
46
59
  end
47
60
 
61
+ # unit tests for split_document_get_async_job_status
62
+ # Get the status and result of a Split Document Batch Job
63
+ # 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.
64
+ # @param async_job_id
65
+ # @param [Hash] opts the optional parameters
66
+ # @return [JobStatusResult]
67
+ describe 'split_document_get_async_job_status test' do
68
+ it 'should work' do
69
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
70
+ end
71
+ end
72
+
48
73
  # unit tests for split_document_pdf_by_page
49
74
  # Split a PDF file into separate PDF files, one per page
50
75
  # Split an input PDF file into separate pages, comprised of one PDF file per page.
@@ -71,6 +96,18 @@ describe 'SplitDocumentApi' do
71
96
  end
72
97
  end
73
98
 
99
+ # unit tests for split_document_pptx_advanced
100
+ # Split a single PowerPoint Presentation PPTX into Separate Presentations
101
+ # Split a PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentations of customizeable size.
102
+ # @param request
103
+ # @param [Hash] opts the optional parameters
104
+ # @return [PptxSplitAdvancedResponse]
105
+ describe 'split_document_pptx_advanced test' do
106
+ it 'should work' do
107
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
108
+ end
109
+ end
110
+
74
111
  # unit tests for split_document_txt_by_line
75
112
  # Split a single Text file (txt) into lines
76
113
  # Split a Text (txt) Document by line, returning each line separately in order. Supports multiple types of newlines.
@@ -68,6 +68,19 @@ describe 'ValidateDocumentApi' do
68
68
  end
69
69
  end
70
70
 
71
+ # unit tests for validate_document_docx_repair
72
+ # Repair a Word document (DOCX) that contains errors
73
+ # Repair a Word document (DOCX) that contains errors or corruption, if possible.
74
+ # @param input_file Input file to perform the operation on.
75
+ # @param [Hash] opts the optional parameters
76
+ # @option opts [String] :repair_mode Optional; Set to advanced to apply the most advanced repair mode, basic for basic repair mode. Default is advanced.
77
+ # @return [String]
78
+ describe 'validate_document_docx_repair test' do
79
+ it 'should work' do
80
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
81
+ end
82
+ end
83
+
71
84
  # unit tests for validate_document_docx_validation
72
85
  # Validate a Word document (DOCX)
73
86
  # Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document
@@ -81,7 +94,7 @@ describe 'ValidateDocumentApi' do
81
94
  end
82
95
 
83
96
  # unit tests for validate_document_eml_validation
84
- # Validate if an EML file is executable
97
+ # Validate if input file is a valid EML file
85
98
  # Validate if an input file is an EML email file; if the document is not valid
86
99
  # @param input_file Input file to perform the operation on.
87
100
  # @param [Hash] opts the optional parameters
@@ -177,7 +190,7 @@ describe 'ValidateDocumentApi' do
177
190
  end
178
191
 
179
192
  # unit tests for validate_document_msg_validation
180
- # Validate if an MSG file is executable
193
+ # Validate if input file is a valid MSG file
181
194
  # Validate if an input file is an MSG email file; if the document is not valid
182
195
  # @param input_file Input file to perform the operation on.
183
196
  # @param [Hash] opts the optional parameters
@@ -224,6 +237,18 @@ describe 'ValidateDocumentApi' do
224
237
  end
225
238
  end
226
239
 
240
+ # unit tests for validate_document_pptx_repair
241
+ # Repair a PowerPoint presentation (PPTX) that contains errors
242
+ # Repair a PowerPoint presentation document (PPTX) that contains errors or corruption, if possible.
243
+ # @param input_file Input file to perform the operation on.
244
+ # @param [Hash] opts the optional parameters
245
+ # @return [String]
246
+ describe 'validate_document_pptx_repair test' do
247
+ it 'should work' do
248
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
249
+ end
250
+ end
251
+
227
252
  # unit tests for validate_document_pptx_validation
228
253
  # Validate a PowerPoint presentation (PPTX)
229
254
  # Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document
@@ -296,6 +321,18 @@ describe 'ValidateDocumentApi' do
296
321
  end
297
322
  end
298
323
 
324
+ # unit tests for validate_document_xlsx_repair
325
+ # Repair an Excel spreadsheet (XLSX) that contains errors
326
+ # Repair an Excel spreadsheet document (XLSX) that contains errors or corruption, if possible.
327
+ # @param input_file Input file to perform the operation on.
328
+ # @param [Hash] opts the optional parameters
329
+ # @return [String]
330
+ describe 'validate_document_xlsx_repair test' do
331
+ it 'should work' do
332
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
333
+ end
334
+ end
335
+
299
336
  # unit tests for validate_document_xlsx_validation
300
337
  # Validate a Excel document (XLSX)
301
338
  # Validate a Excel document (XLSX); if the document is not valid, identifies the errors in the document
@@ -0,0 +1,47 @@
1
+ =begin
2
+ #convertapi
3
+
4
+ #Convert API lets you effortlessly convert file formats and types.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.14
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for CloudmersiveConvertApiClient::ConvertDocumentBatchJobCreateResult
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'ConvertDocumentBatchJobCreateResult' do
21
+ before do
22
+ # run before each test
23
+ @instance = CloudmersiveConvertApiClient::ConvertDocumentBatchJobCreateResult.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of ConvertDocumentBatchJobCreateResult' do
31
+ it 'should create an instance of ConvertDocumentBatchJobCreateResult' do
32
+ expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::ConvertDocumentBatchJobCreateResult)
33
+ end
34
+ end
35
+ describe 'test attribute "successful"' do
36
+ it 'should work' do
37
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
38
+ end
39
+ end
40
+
41
+ describe 'test attribute "async_job_id"' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ end