cloudmersive-convert-api-client 2.2.6 → 2.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +54 -8
  3. data/docs/CompareDocumentApi.md +6 -2
  4. data/docs/ConvertDataApi.md +60 -5
  5. data/docs/ConvertDocumentApi.md +358 -10
  6. data/docs/ConvertDocumentBatchJobCreateResult.md +9 -0
  7. data/docs/ConvertDocumentJobStatusResult.md +12 -0
  8. data/docs/ConvertImageApi.md +6 -2
  9. data/docs/ConvertWebApi.md +8 -8
  10. data/docs/ConvertedPngDirectPage.md +9 -0
  11. data/docs/DocumentArrayInput.md +8 -0
  12. data/docs/DocumentItem.md +9 -0
  13. data/docs/EditDocumentApi.md +124 -2
  14. data/docs/EditPdfApi.md +244 -2
  15. data/docs/EditPdfBatchJobCreateResult.md +9 -0
  16. data/docs/EditPdfJobStatusResult.md +12 -0
  17. data/docs/JobStatusResult.md +12 -0
  18. data/docs/MergeBatchJobCreateResult.md +9 -0
  19. data/docs/MergeDocumentApi.md +440 -0
  20. data/docs/MergeJobStatusResult.md +12 -0
  21. data/docs/PdfMetadata.md +2 -0
  22. data/docs/PdfToPngDirectResult.md +9 -0
  23. data/docs/PptxPageLayoutInformation.md +11 -0
  24. data/docs/PptxSplitAdvancedRequest.md +9 -0
  25. data/docs/PptxSplitAdvancedResponse.md +9 -0
  26. data/docs/PresentationAdvancedResult.md +9 -0
  27. data/docs/SplitBatchJobCreateResult.md +9 -0
  28. data/docs/SplitDocumentApi.md +169 -0
  29. data/docs/ValidateDocumentApi.md +175 -6
  30. data/lib/cloudmersive-convert-api-client/api/compare_document_api.rb +3 -0
  31. data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +57 -4
  32. data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +354 -11
  33. data/lib/cloudmersive-convert-api-client/api/convert_image_api.rb +3 -0
  34. data/lib/cloudmersive-convert-api-client/api/convert_web_api.rb +8 -8
  35. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +122 -0
  36. data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +263 -0
  37. data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +431 -0
  38. data/lib/cloudmersive-convert-api-client/api/split_document_api.rb +165 -0
  39. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +172 -4
  40. data/lib/cloudmersive-convert-api-client/models/convert_document_batch_job_create_result.rb +196 -0
  41. data/lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb +241 -0
  42. data/lib/cloudmersive-convert-api-client/models/converted_png_direct_page.rb +211 -0
  43. data/lib/cloudmersive-convert-api-client/models/document_array_input.rb +188 -0
  44. data/lib/cloudmersive-convert-api-client/models/document_item.rb +211 -0
  45. data/lib/cloudmersive-convert-api-client/models/edit_pdf_batch_job_create_result.rb +196 -0
  46. data/lib/cloudmersive-convert-api-client/models/edit_pdf_job_status_result.rb +241 -0
  47. data/lib/cloudmersive-convert-api-client/models/job_status_result.rb +226 -0
  48. data/lib/cloudmersive-convert-api-client/models/merge_batch_job_create_result.rb +196 -0
  49. data/lib/cloudmersive-convert-api-client/models/merge_job_status_result.rb +241 -0
  50. data/lib/cloudmersive-convert-api-client/models/pdf_metadata.rb +24 -4
  51. data/lib/cloudmersive-convert-api-client/models/pdf_to_png_direct_result.rb +198 -0
  52. data/lib/cloudmersive-convert-api-client/models/pptx_page_layout_information.rb +216 -0
  53. data/lib/cloudmersive-convert-api-client/models/pptx_split_advanced_request.rb +211 -0
  54. data/lib/cloudmersive-convert-api-client/models/pptx_split_advanced_response.rb +197 -0
  55. data/lib/cloudmersive-convert-api-client/models/presentation_advanced_result.rb +211 -0
  56. data/lib/cloudmersive-convert-api-client/models/presentation_result.rb +1 -1
  57. data/lib/cloudmersive-convert-api-client/models/split_batch_job_create_result.rb +196 -0
  58. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  59. data/lib/cloudmersive-convert-api-client.rb +16 -0
  60. data/spec/api/compare_document_api_spec.rb +1 -0
  61. data/spec/api/convert_data_api_spec.rb +14 -2
  62. data/spec/api/convert_document_api_spec.rb +80 -3
  63. data/spec/api/convert_image_api_spec.rb +1 -0
  64. data/spec/api/edit_document_api_spec.rb +28 -0
  65. data/spec/api/edit_pdf_api_spec.rb +55 -0
  66. data/spec/api/merge_document_api_spec.rb +96 -0
  67. data/spec/api/split_document_api_spec.rb +37 -0
  68. data/spec/api/validate_document_api_spec.rb +39 -2
  69. data/spec/models/convert_document_batch_job_create_result_spec.rb +47 -0
  70. data/spec/models/convert_document_job_status_result_spec.rb +65 -0
  71. data/spec/models/converted_png_direct_page_spec.rb +47 -0
  72. data/spec/models/document_array_input_spec.rb +41 -0
  73. data/spec/models/document_item_spec.rb +47 -0
  74. data/spec/models/edit_pdf_batch_job_create_result_spec.rb +47 -0
  75. data/spec/models/edit_pdf_job_status_result_spec.rb +65 -0
  76. data/spec/models/job_status_result_spec.rb +65 -0
  77. data/spec/models/merge_batch_job_create_result_spec.rb +47 -0
  78. data/spec/models/merge_job_status_result_spec.rb +65 -0
  79. data/spec/models/pdf_metadata_spec.rb +12 -0
  80. data/spec/models/pdf_to_png_direct_result_spec.rb +47 -0
  81. data/spec/models/pptx_page_layout_information_spec.rb +59 -0
  82. data/spec/models/pptx_split_advanced_request_spec.rb +47 -0
  83. data/spec/models/pptx_split_advanced_response_spec.rb +47 -0
  84. data/spec/models/presentation_advanced_result_spec.rb +47 -0
  85. data/spec/models/split_batch_job_create_result_spec.rb +47 -0
  86. metadata +50 -2
@@ -4,14 +4,75 @@ All URIs are relative to *https://api.cloudmersive.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**split_document_batch_job_create**](SplitDocumentApi.md#split_document_batch_job_create) | **POST** /convert/split/batch-job/create | Split a single Document into Separate Documents by Page as a Batch Job
7
8
  [**split_document_docx**](SplitDocumentApi.md#split_document_docx) | **POST** /convert/split/docx | Split a single Word Document DOCX into Separate Documents by Page
9
+ [**split_document_get_async_job_status**](SplitDocumentApi.md#split_document_get_async_job_status) | **GET** /convert/split/batch-job/status | Get the status and result of a Split Document Batch Job
8
10
  [**split_document_pdf_by_page**](SplitDocumentApi.md#split_document_pdf_by_page) | **POST** /convert/split/pdf | Split a PDF file into separate PDF files, one per page
9
11
  [**split_document_pptx**](SplitDocumentApi.md#split_document_pptx) | **POST** /convert/split/pptx | Split a single PowerPoint Presentation PPTX into Separate Slides
12
+ [**split_document_pptx_advanced**](SplitDocumentApi.md#split_document_pptx_advanced) | **POST** /convert/split/pptx/advanced | Split a single PowerPoint Presentation PPTX into Separate Presentations
10
13
  [**split_document_txt_by_line**](SplitDocumentApi.md#split_document_txt_by_line) | **POST** /convert/split/txt/by-line | Split a single Text file (txt) into lines
11
14
  [**split_document_txt_by_string**](SplitDocumentApi.md#split_document_txt_by_string) | **POST** /convert/split/txt/by-string | Split a single Text file (txt) by a string delimiter
12
15
  [**split_document_xlsx**](SplitDocumentApi.md#split_document_xlsx) | **POST** /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets
13
16
 
14
17
 
18
+ # **split_document_batch_job_create**
19
+ > SplitBatchJobCreateResult split_document_batch_job_create(input_file, opts)
20
+
21
+ Split a single Document into Separate Documents by Page as a Batch Job
22
+
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
+
25
+ ### Example
26
+ ```ruby
27
+ # load the gem
28
+ require 'cloudmersive-convert-api-client'
29
+ # setup authorization
30
+ CloudmersiveConvertApiClient.configure do |config|
31
+ # Configure API key authorization: Apikey
32
+ config.api_key['Apikey'] = 'YOUR API KEY'
33
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
34
+ #config.api_key_prefix['Apikey'] = 'Bearer'
35
+ end
36
+
37
+ api_instance = CloudmersiveConvertApiClient::SplitDocumentApi.new
38
+
39
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
40
+
41
+ opts = {
42
+ return_document_contents: true # BOOLEAN | 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.
43
+ }
44
+
45
+ begin
46
+ #Split a single Document into Separate Documents by Page as a Batch Job
47
+ result = api_instance.split_document_batch_job_create(input_file, opts)
48
+ p result
49
+ rescue CloudmersiveConvertApiClient::ApiError => e
50
+ puts "Exception when calling SplitDocumentApi->split_document_batch_job_create: #{e}"
51
+ end
52
+ ```
53
+
54
+ ### Parameters
55
+
56
+ Name | Type | Description | Notes
57
+ ------------- | ------------- | ------------- | -------------
58
+ **input_file** | **File**| Input file to perform the operation on. |
59
+ **return_document_contents** | **BOOLEAN**| 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. | [optional]
60
+
61
+ ### Return type
62
+
63
+ [**SplitBatchJobCreateResult**](SplitBatchJobCreateResult.md)
64
+
65
+ ### Authorization
66
+
67
+ [Apikey](../README.md#Apikey)
68
+
69
+ ### HTTP request headers
70
+
71
+ - **Content-Type**: multipart/form-data
72
+ - **Accept**: application/json, text/json, application/xml, text/xml
73
+
74
+
75
+
15
76
  # **split_document_docx**
16
77
  > SplitDocxDocumentResult split_document_docx(input_file, opts)
17
78
 
@@ -70,6 +131,60 @@ Name | Type | Description | Notes
70
131
 
71
132
 
72
133
 
134
+ # **split_document_get_async_job_status**
135
+ > JobStatusResult split_document_get_async_job_status(async_job_id)
136
+
137
+ Get the status and result of a Split Document Batch Job
138
+
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
+
141
+ ### Example
142
+ ```ruby
143
+ # load the gem
144
+ require 'cloudmersive-convert-api-client'
145
+ # setup authorization
146
+ CloudmersiveConvertApiClient.configure do |config|
147
+ # Configure API key authorization: Apikey
148
+ config.api_key['Apikey'] = 'YOUR API KEY'
149
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
150
+ #config.api_key_prefix['Apikey'] = 'Bearer'
151
+ end
152
+
153
+ api_instance = CloudmersiveConvertApiClient::SplitDocumentApi.new
154
+
155
+ async_job_id = 'async_job_id_example' # String |
156
+
157
+
158
+ begin
159
+ #Get the status and result of a Split Document Batch Job
160
+ result = api_instance.split_document_get_async_job_status(async_job_id)
161
+ p result
162
+ rescue CloudmersiveConvertApiClient::ApiError => e
163
+ puts "Exception when calling SplitDocumentApi->split_document_get_async_job_status: #{e}"
164
+ end
165
+ ```
166
+
167
+ ### Parameters
168
+
169
+ Name | Type | Description | Notes
170
+ ------------- | ------------- | ------------- | -------------
171
+ **async_job_id** | **String**| |
172
+
173
+ ### Return type
174
+
175
+ [**JobStatusResult**](JobStatusResult.md)
176
+
177
+ ### Authorization
178
+
179
+ [Apikey](../README.md#Apikey)
180
+
181
+ ### HTTP request headers
182
+
183
+ - **Content-Type**: Not defined
184
+ - **Accept**: application/json, text/json, application/xml, text/xml
185
+
186
+
187
+
73
188
  # **split_document_pdf_by_page**
74
189
  > SplitPdfResult split_document_pdf_by_page(input_file, opts)
75
190
 
@@ -186,6 +301,60 @@ Name | Type | Description | Notes
186
301
 
187
302
 
188
303
 
304
+ # **split_document_pptx_advanced**
305
+ > PptxSplitAdvancedResponse split_document_pptx_advanced(request)
306
+
307
+ Split a single PowerPoint Presentation PPTX into Separate Presentations
308
+
309
+ Split a PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentations of customizeable size.
310
+
311
+ ### Example
312
+ ```ruby
313
+ # load the gem
314
+ require 'cloudmersive-convert-api-client'
315
+ # setup authorization
316
+ CloudmersiveConvertApiClient.configure do |config|
317
+ # Configure API key authorization: Apikey
318
+ config.api_key['Apikey'] = 'YOUR API KEY'
319
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
320
+ #config.api_key_prefix['Apikey'] = 'Bearer'
321
+ end
322
+
323
+ api_instance = CloudmersiveConvertApiClient::SplitDocumentApi.new
324
+
325
+ request = CloudmersiveConvertApiClient::PptxSplitAdvancedRequest.new # PptxSplitAdvancedRequest |
326
+
327
+
328
+ begin
329
+ #Split a single PowerPoint Presentation PPTX into Separate Presentations
330
+ result = api_instance.split_document_pptx_advanced(request)
331
+ p result
332
+ rescue CloudmersiveConvertApiClient::ApiError => e
333
+ puts "Exception when calling SplitDocumentApi->split_document_pptx_advanced: #{e}"
334
+ end
335
+ ```
336
+
337
+ ### Parameters
338
+
339
+ Name | Type | Description | Notes
340
+ ------------- | ------------- | ------------- | -------------
341
+ **request** | [**PptxSplitAdvancedRequest**](PptxSplitAdvancedRequest.md)| |
342
+
343
+ ### Return type
344
+
345
+ [**PptxSplitAdvancedResponse**](PptxSplitAdvancedResponse.md)
346
+
347
+ ### Authorization
348
+
349
+ [Apikey](../README.md#Apikey)
350
+
351
+ ### HTTP request headers
352
+
353
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
354
+ - **Accept**: application/json, text/json, application/xml, text/xml
355
+
356
+
357
+
189
358
  # **split_document_txt_by_line**
190
359
  > SplitTextDocumentByLinesResult split_document_txt_by_line(input_file)
191
360
 
@@ -7,8 +7,9 @@ Method | HTTP request | Description
7
7
  [**validate_document_autodetect_validation**](ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
8
8
  [**validate_document_csv_validation**](ValidateDocumentApi.md#validate_document_csv_validation) | **POST** /convert/validate/csv | Validate a CSV file document (CSV)
9
9
  [**validate_document_doc_validation**](ValidateDocumentApi.md#validate_document_doc_validation) | **POST** /convert/validate/doc | Validate a Word 97-2003 Legacy document (DOC)
10
+ [**validate_document_docx_repair**](ValidateDocumentApi.md#validate_document_docx_repair) | **POST** /convert/validate/docx/repair | Repair a Word document (DOCX) that contains errors
10
11
  [**validate_document_docx_validation**](ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
11
- [**validate_document_eml_validation**](ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if an EML file is executable
12
+ [**validate_document_eml_validation**](ValidateDocumentApi.md#validate_document_eml_validation) | **POST** /convert/validate/eml | Validate if input file is a valid EML file
12
13
  [**validate_document_executable_validation**](ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
13
14
  [**validate_document_g_zip_validation**](ValidateDocumentApi.md#validate_document_g_zip_validation) | **POST** /convert/validate/gzip | Validate a GZip Archive file (gzip or gz)
14
15
  [**validate_document_html_ssrf_validation**](ValidateDocumentApi.md#validate_document_html_ssrf_validation) | **POST** /convert/validate/html/ssrf-threat-check | Validate an HTML file and checks for SSRF threats
@@ -16,16 +17,18 @@ Method | HTTP request | Description
16
17
  [**validate_document_image_validation**](ValidateDocumentApi.md#validate_document_image_validation) | **POST** /convert/validate/image | Validate an Image File
17
18
  [**validate_document_jpg_validation**](ValidateDocumentApi.md#validate_document_jpg_validation) | **POST** /convert/validate/jpg | Validate a JPG File
18
19
  [**validate_document_json_validation**](ValidateDocumentApi.md#validate_document_json_validation) | **POST** /convert/validate/json | Validate a JSON file
19
- [**validate_document_msg_validation**](ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if an MSG file is executable
20
+ [**validate_document_msg_validation**](ValidateDocumentApi.md#validate_document_msg_validation) | **POST** /convert/validate/msg | Validate if input file is a valid MSG file
20
21
  [**validate_document_pdf_validation**](ValidateDocumentApi.md#validate_document_pdf_validation) | **POST** /convert/validate/pdf | Validate a PDF document file
21
22
  [**validate_document_png_validation**](ValidateDocumentApi.md#validate_document_png_validation) | **POST** /convert/validate/png | Validate a PNG File
22
23
  [**validate_document_ppt_validation**](ValidateDocumentApi.md#validate_document_ppt_validation) | **POST** /convert/validate/ppt | Validate a PowerPoint 97-2003 Legacy presentation (PPT)
24
+ [**validate_document_pptx_repair**](ValidateDocumentApi.md#validate_document_pptx_repair) | **POST** /convert/validate/pptx/repair | Repair a PowerPoint presentation (PPTX) that contains errors
23
25
  [**validate_document_pptx_validation**](ValidateDocumentApi.md#validate_document_pptx_validation) | **POST** /convert/validate/pptx | Validate a PowerPoint presentation (PPTX)
24
26
  [**validate_document_rar_validation**](ValidateDocumentApi.md#validate_document_rar_validation) | **POST** /convert/validate/rar | Validate a RAR Archive file (RAR)
25
27
  [**validate_document_rtf_validation**](ValidateDocumentApi.md#validate_document_rtf_validation) | **POST** /convert/validate/rtf | Validate a Rich Text Format document (RTF)
26
28
  [**validate_document_tar_validation**](ValidateDocumentApi.md#validate_document_tar_validation) | **POST** /convert/validate/tar | Validate a TAR Tarball Archive file (TAR)
27
29
  [**validate_document_txt_validation**](ValidateDocumentApi.md#validate_document_txt_validation) | **POST** /convert/validate/txt | Validate an TXT file
28
30
  [**validate_document_xls_validation**](ValidateDocumentApi.md#validate_document_xls_validation) | **POST** /convert/validate/xls | Validate a Excel 97-2003 Legacy spreadsheet (XLS)
31
+ [**validate_document_xlsx_repair**](ValidateDocumentApi.md#validate_document_xlsx_repair) | **POST** /convert/validate/xlsx/repair | Repair an Excel spreadsheet (XLSX) that contains errors
29
32
  [**validate_document_xlsx_validation**](ValidateDocumentApi.md#validate_document_xlsx_validation) | **POST** /convert/validate/xlsx | Validate a Excel document (XLSX)
30
33
  [**validate_document_xml_validation**](ValidateDocumentApi.md#validate_document_xml_validation) | **POST** /convert/validate/xml | Validate an XML file
31
34
  [**validate_document_xml_xxe_threat_validation**](ValidateDocumentApi.md#validate_document_xml_xxe_threat_validation) | **POST** /convert/validate/xml/xxe-threats | Validate an XML file for XML External Entity (XXE) threats
@@ -194,6 +197,64 @@ Name | Type | Description | Notes
194
197
 
195
198
 
196
199
 
200
+ # **validate_document_docx_repair**
201
+ > String validate_document_docx_repair(input_file, opts)
202
+
203
+ Repair a Word document (DOCX) that contains errors
204
+
205
+ Repair a Word document (DOCX) that contains errors or corruption, if possible.
206
+
207
+ ### Example
208
+ ```ruby
209
+ # load the gem
210
+ require 'cloudmersive-convert-api-client'
211
+ # setup authorization
212
+ CloudmersiveConvertApiClient.configure do |config|
213
+ # Configure API key authorization: Apikey
214
+ config.api_key['Apikey'] = 'YOUR API KEY'
215
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
216
+ #config.api_key_prefix['Apikey'] = 'Bearer'
217
+ end
218
+
219
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
220
+
221
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
222
+
223
+ opts = {
224
+ repair_mode: 'repair_mode_example' # String | Optional; Set to advanced to apply the most advanced repair mode, basic for basic repair mode. Default is advanced.
225
+ }
226
+
227
+ begin
228
+ #Repair a Word document (DOCX) that contains errors
229
+ result = api_instance.validate_document_docx_repair(input_file, opts)
230
+ p result
231
+ rescue CloudmersiveConvertApiClient::ApiError => e
232
+ puts "Exception when calling ValidateDocumentApi->validate_document_docx_repair: #{e}"
233
+ end
234
+ ```
235
+
236
+ ### Parameters
237
+
238
+ Name | Type | Description | Notes
239
+ ------------- | ------------- | ------------- | -------------
240
+ **input_file** | **File**| Input file to perform the operation on. |
241
+ **repair_mode** | **String**| Optional; Set to advanced to apply the most advanced repair mode, basic for basic repair mode. Default is advanced. | [optional]
242
+
243
+ ### Return type
244
+
245
+ **String**
246
+
247
+ ### Authorization
248
+
249
+ [Apikey](../README.md#Apikey)
250
+
251
+ ### HTTP request headers
252
+
253
+ - **Content-Type**: multipart/form-data
254
+ - **Accept**: application/json, text/json, application/xml, text/xml
255
+
256
+
257
+
197
258
  # **validate_document_docx_validation**
198
259
  > DocumentValidationResult validate_document_docx_validation(input_file)
199
260
 
@@ -251,7 +312,7 @@ Name | Type | Description | Notes
251
312
  # **validate_document_eml_validation**
252
313
  > DocumentValidationResult validate_document_eml_validation(input_file)
253
314
 
254
- Validate if an EML file is executable
315
+ Validate if input file is a valid EML file
255
316
 
256
317
  Validate if an input file is an EML email file; if the document is not valid
257
318
 
@@ -273,7 +334,7 @@ input_file = File.new('/path/to/file.txt') # File | Input file to perform the op
273
334
 
274
335
 
275
336
  begin
276
- #Validate if an EML file is executable
337
+ #Validate if input file is a valid EML file
277
338
  result = api_instance.validate_document_eml_validation(input_file)
278
339
  p result
279
340
  rescue CloudmersiveConvertApiClient::ApiError => e
@@ -683,7 +744,7 @@ Name | Type | Description | Notes
683
744
  # **validate_document_msg_validation**
684
745
  > DocumentValidationResult validate_document_msg_validation(input_file)
685
746
 
686
- Validate if an MSG file is executable
747
+ Validate if input file is a valid MSG file
687
748
 
688
749
  Validate if an input file is an MSG email file; if the document is not valid
689
750
 
@@ -705,7 +766,7 @@ input_file = File.new('/path/to/file.txt') # File | Input file to perform the op
705
766
 
706
767
 
707
768
  begin
708
- #Validate if an MSG file is executable
769
+ #Validate if input file is a valid MSG file
709
770
  result = api_instance.validate_document_msg_validation(input_file)
710
771
  p result
711
772
  rescue CloudmersiveConvertApiClient::ApiError => e
@@ -896,6 +957,60 @@ Name | Type | Description | Notes
896
957
 
897
958
 
898
959
 
960
+ # **validate_document_pptx_repair**
961
+ > String validate_document_pptx_repair(input_file)
962
+
963
+ Repair a PowerPoint presentation (PPTX) that contains errors
964
+
965
+ Repair a PowerPoint presentation document (PPTX) that contains errors or corruption, if possible.
966
+
967
+ ### Example
968
+ ```ruby
969
+ # load the gem
970
+ require 'cloudmersive-convert-api-client'
971
+ # setup authorization
972
+ CloudmersiveConvertApiClient.configure do |config|
973
+ # Configure API key authorization: Apikey
974
+ config.api_key['Apikey'] = 'YOUR API KEY'
975
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
976
+ #config.api_key_prefix['Apikey'] = 'Bearer'
977
+ end
978
+
979
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
980
+
981
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
982
+
983
+
984
+ begin
985
+ #Repair a PowerPoint presentation (PPTX) that contains errors
986
+ result = api_instance.validate_document_pptx_repair(input_file)
987
+ p result
988
+ rescue CloudmersiveConvertApiClient::ApiError => e
989
+ puts "Exception when calling ValidateDocumentApi->validate_document_pptx_repair: #{e}"
990
+ end
991
+ ```
992
+
993
+ ### Parameters
994
+
995
+ Name | Type | Description | Notes
996
+ ------------- | ------------- | ------------- | -------------
997
+ **input_file** | **File**| Input file to perform the operation on. |
998
+
999
+ ### Return type
1000
+
1001
+ **String**
1002
+
1003
+ ### Authorization
1004
+
1005
+ [Apikey](../README.md#Apikey)
1006
+
1007
+ ### HTTP request headers
1008
+
1009
+ - **Content-Type**: multipart/form-data
1010
+ - **Accept**: application/json, text/json, application/xml, text/xml
1011
+
1012
+
1013
+
899
1014
  # **validate_document_pptx_validation**
900
1015
  > DocumentValidationResult validate_document_pptx_validation(input_file)
901
1016
 
@@ -1220,6 +1335,60 @@ Name | Type | Description | Notes
1220
1335
 
1221
1336
 
1222
1337
 
1338
+ # **validate_document_xlsx_repair**
1339
+ > String validate_document_xlsx_repair(input_file)
1340
+
1341
+ Repair an Excel spreadsheet (XLSX) that contains errors
1342
+
1343
+ Repair an Excel spreadsheet document (XLSX) that contains errors or corruption, if possible.
1344
+
1345
+ ### Example
1346
+ ```ruby
1347
+ # load the gem
1348
+ require 'cloudmersive-convert-api-client'
1349
+ # setup authorization
1350
+ CloudmersiveConvertApiClient.configure do |config|
1351
+ # Configure API key authorization: Apikey
1352
+ config.api_key['Apikey'] = 'YOUR API KEY'
1353
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1354
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1355
+ end
1356
+
1357
+ api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
1358
+
1359
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1360
+
1361
+
1362
+ begin
1363
+ #Repair an Excel spreadsheet (XLSX) that contains errors
1364
+ result = api_instance.validate_document_xlsx_repair(input_file)
1365
+ p result
1366
+ rescue CloudmersiveConvertApiClient::ApiError => e
1367
+ puts "Exception when calling ValidateDocumentApi->validate_document_xlsx_repair: #{e}"
1368
+ end
1369
+ ```
1370
+
1371
+ ### Parameters
1372
+
1373
+ Name | Type | Description | Notes
1374
+ ------------- | ------------- | ------------- | -------------
1375
+ **input_file** | **File**| Input file to perform the operation on. |
1376
+
1377
+ ### Return type
1378
+
1379
+ **String**
1380
+
1381
+ ### Authorization
1382
+
1383
+ [Apikey](../README.md#Apikey)
1384
+
1385
+ ### HTTP request headers
1386
+
1387
+ - **Content-Type**: multipart/form-data
1388
+ - **Accept**: application/json, text/json, application/xml, text/xml
1389
+
1390
+
1391
+
1223
1392
  # **validate_document_xlsx_validation**
1224
1393
  > DocumentValidationResult validate_document_xlsx_validation(input_file)
1225
1394
 
@@ -24,6 +24,7 @@ module CloudmersiveConvertApiClient
24
24
  # @param input_file1 First input file to perform the operation on.
25
25
  # @param input_file2 Second input file to perform the operation on (more than 2 can be supplied).
26
26
  # @param [Hash] opts the optional parameters
27
+ # @option opts [BOOLEAN] :autorepair Optional; automatically repair input documents that have errors (default is true)
27
28
  # @return [String]
28
29
  def compare_document_docx(input_file1, input_file2, opts = {})
29
30
  data, _status_code, _headers = compare_document_docx_with_http_info(input_file1, input_file2, opts)
@@ -35,6 +36,7 @@ module CloudmersiveConvertApiClient
35
36
  # @param input_file1 First input file to perform the operation on.
36
37
  # @param input_file2 Second input file to perform the operation on (more than 2 can be supplied).
37
38
  # @param [Hash] opts the optional parameters
39
+ # @option opts [BOOLEAN] :autorepair Optional; automatically repair input documents that have errors (default is true)
38
40
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
39
41
  def compare_document_docx_with_http_info(input_file1, input_file2, opts = {})
40
42
  if @api_client.config.debugging
@@ -60,6 +62,7 @@ module CloudmersiveConvertApiClient
60
62
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
61
63
  # HTTP header 'Content-Type'
62
64
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
65
+ header_params[:'autorepair'] = opts[:'autorepair'] if !opts[:'autorepair'].nil?
63
66
 
64
67
  # form parameters
65
68
  form_params = {}
@@ -135,9 +135,62 @@ module CloudmersiveConvertApiClient
135
135
  end
136
136
  return data, status_code, headers
137
137
  end
138
- # Convert JSON to XML conversion
138
+ # Convert JSON String to XML conversion
139
139
  # Convert a JSON object into XML
140
- # @param json_object Input JSON to convert to XML
140
+ # @param json_string Input JSON String to convert to XML
141
+ # @param [Hash] opts the optional parameters
142
+ # @return [Object]
143
+ def convert_data_json_string_to_xml(json_string, opts = {})
144
+ data, _status_code, _headers = convert_data_json_string_to_xml_with_http_info(json_string, opts)
145
+ data
146
+ end
147
+
148
+ # Convert JSON String to XML conversion
149
+ # Convert a JSON object into XML
150
+ # @param json_string Input JSON String to convert to XML
151
+ # @param [Hash] opts the optional parameters
152
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
153
+ def convert_data_json_string_to_xml_with_http_info(json_string, opts = {})
154
+ if @api_client.config.debugging
155
+ @api_client.config.logger.debug 'Calling API: ConvertDataApi.convert_data_json_string_to_xml ...'
156
+ end
157
+ # verify the required parameter 'json_string' is set
158
+ if @api_client.config.client_side_validation && json_string.nil?
159
+ fail ArgumentError, "Missing the required parameter 'json_string' when calling ConvertDataApi.convert_data_json_string_to_xml"
160
+ end
161
+ # resource path
162
+ local_var_path = '/convert/json-string/to/xml'
163
+
164
+ # query parameters
165
+ query_params = {}
166
+ query_params[:'JsonString'] = json_string
167
+
168
+ # header parameters
169
+ header_params = {}
170
+ # HTTP header 'Accept' (if needed)
171
+ header_params['Accept'] = @api_client.select_header_accept(['application/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(:POST, 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 => 'Object')
186
+ if @api_client.config.debugging
187
+ @api_client.config.logger.debug "API called: ConvertDataApi#convert_data_json_string_to_xml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
188
+ end
189
+ return data, status_code, headers
190
+ end
191
+ # Convert JSON Object to XML conversion
192
+ # Convert a JSON object into XML
193
+ # @param json_object Input JSON Object to convert to XML
141
194
  # @param [Hash] opts the optional parameters
142
195
  # @return [String]
143
196
  def convert_data_json_to_xml(json_object, opts = {})
@@ -145,9 +198,9 @@ module CloudmersiveConvertApiClient
145
198
  data
146
199
  end
147
200
 
148
- # Convert JSON to XML conversion
201
+ # Convert JSON Object to XML conversion
149
202
  # Convert a JSON object into XML
150
- # @param json_object Input JSON to convert to XML
203
+ # @param json_object Input JSON Object to convert to XML
151
204
  # @param [Hash] opts the optional parameters
152
205
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
153
206
  def convert_data_json_to_xml_with_http_info(json_object, opts = {})