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
@@ -7,6 +7,7 @@ Method | HTTP request | Description
7
7
  [**convert_document_autodetect_get_info**](ConvertDocumentApi.md#convert_document_autodetect_get_info) | **POST** /convert/autodetect/get-info | Get document type information
8
8
  [**convert_document_autodetect_to_jpg**](ConvertDocumentApi.md#convert_document_autodetect_to_jpg) | **POST** /convert/autodetect/to/jpg | Convert Document to JPG/JPEG image array
9
9
  [**convert_document_autodetect_to_pdf**](ConvertDocumentApi.md#convert_document_autodetect_to_pdf) | **POST** /convert/autodetect/to/pdf | Convert Document to PDF
10
+ [**convert_document_autodetect_to_pdf_batch_job**](ConvertDocumentApi.md#convert_document_autodetect_to_pdf_batch_job) | **POST** /convert/autodetect/to/pdf/batch-job | Convert Document to PDF as Batch Job
10
11
  [**convert_document_autodetect_to_png_array**](ConvertDocumentApi.md#convert_document_autodetect_to_png_array) | **POST** /convert/autodetect/to/png | Convert Document to PNG array
11
12
  [**convert_document_autodetect_to_thumbnail**](ConvertDocumentApi.md#convert_document_autodetect_to_thumbnail) | **POST** /convert/autodetect/to/thumbnail | Convert File to Thumbnail Image
12
13
  [**convert_document_autodetect_to_thumbnails_advanced**](ConvertDocumentApi.md#convert_document_autodetect_to_thumbnails_advanced) | **POST** /convert/autodetect/to/thumbnail/advanced | Convert File to Thumbnail Image Object
@@ -29,6 +30,7 @@ Method | HTTP request | Description
29
30
  [**convert_document_eml_to_jpg**](ConvertDocumentApi.md#convert_document_eml_to_jpg) | **POST** /convert/eml/to/jpg | Convert Email EML file to JPG/JPEG image array
30
31
  [**convert_document_eml_to_pdf**](ConvertDocumentApi.md#convert_document_eml_to_pdf) | **POST** /convert/eml/to/pdf | Convert Email EML file to PDF document
31
32
  [**convert_document_eml_to_png**](ConvertDocumentApi.md#convert_document_eml_to_png) | **POST** /convert/eml/to/png | Convert Email EML file to PNG image array
33
+ [**convert_document_get_async_job_status**](ConvertDocumentApi.md#convert_document_get_async_job_status) | **GET** /convert/batch-job/status | Get the status and result of a Convert Document Batch Job
32
34
  [**convert_document_get_file_type_icon**](ConvertDocumentApi.md#convert_document_get_file_type_icon) | **POST** /convert/autodetect/get-icon | Get PNG icon file for the file extension
33
35
  [**convert_document_get_file_type_icon_advanced**](ConvertDocumentApi.md#convert_document_get_file_type_icon_advanced) | **POST** /convert/autodetect/get-icon/advanced | Get PNG icon byte array for the file extension
34
36
  [**convert_document_html_to_pdf**](ConvertDocumentApi.md#convert_document_html_to_pdf) | **POST** /convert/html/to/pdf | Convert HTML document file to PDF Document
@@ -58,10 +60,13 @@ Method | HTTP request | Description
58
60
  [**convert_document_pdf_to_docx_rasterize**](ConvertDocumentApi.md#convert_document_pdf_to_docx_rasterize) | **POST** /convert/pdf/to/docx/rasterize | Convert PDF to Word DOCX Document based on rasterized version of the PDF
59
61
  [**convert_document_pdf_to_jpg**](ConvertDocumentApi.md#convert_document_pdf_to_jpg) | **POST** /convert/pdf/to/jpg | Convert PDF to JPG/JPEG image array
60
62
  [**convert_document_pdf_to_png_array**](ConvertDocumentApi.md#convert_document_pdf_to_png_array) | **POST** /convert/pdf/to/png | Convert PDF to PNG Image Array
63
+ [**convert_document_pdf_to_png_array_direct**](ConvertDocumentApi.md#convert_document_pdf_to_png_array_direct) | **POST** /convert/pdf/to/png/direct | Convert PDF to PNG Image Array (Direct)
61
64
  [**convert_document_pdf_to_png_single**](ConvertDocumentApi.md#convert_document_pdf_to_png_single) | **POST** /convert/pdf/to/png/merge-single | Convert PDF to Single PNG image
62
65
  [**convert_document_pdf_to_pptx**](ConvertDocumentApi.md#convert_document_pdf_to_pptx) | **POST** /convert/pdf/to/pptx | Convert PDF to PowerPoint PPTX Presentation
66
+ [**convert_document_pdf_to_tiff**](ConvertDocumentApi.md#convert_document_pdf_to_tiff) | **POST** /convert/pdf/to/tiff | Convert PDF to TIFF image
63
67
  [**convert_document_pdf_to_txt**](ConvertDocumentApi.md#convert_document_pdf_to_txt) | **POST** /convert/pdf/to/txt | Convert PDF Document to Text (txt)
64
68
  [**convert_document_png_array_to_pdf**](ConvertDocumentApi.md#convert_document_png_array_to_pdf) | **POST** /convert/png/to/pdf | Convert PNG Array to PDF
69
+ [**convert_document_png_array_to_pdf_flatten_transparency**](ConvertDocumentApi.md#convert_document_png_array_to_pdf_flatten_transparency) | **POST** /convert/png/to/pdf/remove-transparency | Convert PNG Array to PDF and remove transparency
65
70
  [**convert_document_ppt_to_pdf**](ConvertDocumentApi.md#convert_document_ppt_to_pdf) | **POST** /convert/ppt/to/pdf | Convert PowerPoint PPT (97-03) Presentation to PDF
66
71
  [**convert_document_ppt_to_pptx**](ConvertDocumentApi.md#convert_document_ppt_to_pptx) | **POST** /convert/ppt/to/pptx | Convert PowerPoint PPT (97-03) Presentation to PPTX
67
72
  [**convert_document_pptx_to_pdf**](ConvertDocumentApi.md#convert_document_pptx_to_pdf) | **POST** /convert/pptx/to/pdf | Convert PowerPoint PPTX Presentation to PDF
@@ -73,6 +78,7 @@ Method | HTTP request | Description
73
78
  [**convert_document_rtf_to_jpg**](ConvertDocumentApi.md#convert_document_rtf_to_jpg) | **POST** /convert/rtf/to/jpg | Convert Rich Text Format RTF to JPG/JPEG image array
74
79
  [**convert_document_rtf_to_pdf**](ConvertDocumentApi.md#convert_document_rtf_to_pdf) | **POST** /convert/rtf/to/pdf | Convert Rich Text Format RTF to PDF
75
80
  [**convert_document_rtf_to_png**](ConvertDocumentApi.md#convert_document_rtf_to_png) | **POST** /convert/rtf/to/png | Convert Rich Text Format RTF to PNG image array
81
+ [**convert_document_txt_to_pdf**](ConvertDocumentApi.md#convert_document_txt_to_pdf) | **POST** /convert/txt/to/pdf | Convert TXT text file to PDF Document
76
82
  [**convert_document_xls_to_csv**](ConvertDocumentApi.md#convert_document_xls_to_csv) | **POST** /convert/xls/to/csv | Convert Excel XLS (97-03) Spreadsheet to CSV
77
83
  [**convert_document_xls_to_pdf**](ConvertDocumentApi.md#convert_document_xls_to_pdf) | **POST** /convert/xls/to/pdf | Convert Excel XLS (97-03) Spreadsheet to PDF
78
84
  [**convert_document_xls_to_xlsx**](ConvertDocumentApi.md#convert_document_xls_to_xlsx) | **POST** /convert/xls/to/xlsx | Convert Excel XLS (97-03) Spreadsheet to XLSX
@@ -202,7 +208,7 @@ Name | Type | Description | Notes
202
208
 
203
209
  Convert Document to PDF
204
210
 
205
- 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.
211
+ 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.
206
212
 
207
213
  ### Example
208
214
  ```ruby
@@ -251,6 +257,60 @@ Name | Type | Description | Notes
251
257
 
252
258
 
253
259
 
260
+ # **convert_document_autodetect_to_pdf_batch_job**
261
+ > ConvertDocumentBatchJobCreateResult convert_document_autodetect_to_pdf_batch_job(input_file)
262
+
263
+ Convert Document to PDF as Batch Job
264
+
265
+ 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.
266
+
267
+ ### Example
268
+ ```ruby
269
+ # load the gem
270
+ require 'cloudmersive-convert-api-client'
271
+ # setup authorization
272
+ CloudmersiveConvertApiClient.configure do |config|
273
+ # Configure API key authorization: Apikey
274
+ config.api_key['Apikey'] = 'YOUR API KEY'
275
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
276
+ #config.api_key_prefix['Apikey'] = 'Bearer'
277
+ end
278
+
279
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
280
+
281
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
282
+
283
+
284
+ begin
285
+ #Convert Document to PDF as Batch Job
286
+ result = api_instance.convert_document_autodetect_to_pdf_batch_job(input_file)
287
+ p result
288
+ rescue CloudmersiveConvertApiClient::ApiError => e
289
+ puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_pdf_batch_job: #{e}"
290
+ end
291
+ ```
292
+
293
+ ### Parameters
294
+
295
+ Name | Type | Description | Notes
296
+ ------------- | ------------- | ------------- | -------------
297
+ **input_file** | **File**| Input file to perform the operation on. |
298
+
299
+ ### Return type
300
+
301
+ [**ConvertDocumentBatchJobCreateResult**](ConvertDocumentBatchJobCreateResult.md)
302
+
303
+ ### Authorization
304
+
305
+ [Apikey](../README.md#Apikey)
306
+
307
+ ### HTTP request headers
308
+
309
+ - **Content-Type**: multipart/form-data
310
+ - **Accept**: application/octet-stream
311
+
312
+
313
+
254
314
  # **convert_document_autodetect_to_png_array**
255
315
  > AutodetectToPngResult convert_document_autodetect_to_png_array(input_file)
256
316
 
@@ -1506,6 +1566,60 @@ Name | Type | Description | Notes
1506
1566
 
1507
1567
 
1508
1568
 
1569
+ # **convert_document_get_async_job_status**
1570
+ > ConvertDocumentJobStatusResult convert_document_get_async_job_status(async_job_id)
1571
+
1572
+ Get the status and result of a Convert Document Batch Job
1573
+
1574
+ 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.
1575
+
1576
+ ### Example
1577
+ ```ruby
1578
+ # load the gem
1579
+ require 'cloudmersive-convert-api-client'
1580
+ # setup authorization
1581
+ CloudmersiveConvertApiClient.configure do |config|
1582
+ # Configure API key authorization: Apikey
1583
+ config.api_key['Apikey'] = 'YOUR API KEY'
1584
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1585
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1586
+ end
1587
+
1588
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1589
+
1590
+ async_job_id = 'async_job_id_example' # String |
1591
+
1592
+
1593
+ begin
1594
+ #Get the status and result of a Convert Document Batch Job
1595
+ result = api_instance.convert_document_get_async_job_status(async_job_id)
1596
+ p result
1597
+ rescue CloudmersiveConvertApiClient::ApiError => e
1598
+ puts "Exception when calling ConvertDocumentApi->convert_document_get_async_job_status: #{e}"
1599
+ end
1600
+ ```
1601
+
1602
+ ### Parameters
1603
+
1604
+ Name | Type | Description | Notes
1605
+ ------------- | ------------- | ------------- | -------------
1606
+ **async_job_id** | **String**| |
1607
+
1608
+ ### Return type
1609
+
1610
+ [**ConvertDocumentJobStatusResult**](ConvertDocumentJobStatusResult.md)
1611
+
1612
+ ### Authorization
1613
+
1614
+ [Apikey](../README.md#Apikey)
1615
+
1616
+ ### HTTP request headers
1617
+
1618
+ - **Content-Type**: Not defined
1619
+ - **Accept**: application/json, text/json, application/xml, text/xml
1620
+
1621
+
1622
+
1509
1623
  # **convert_document_get_file_type_icon**
1510
1624
  > String convert_document_get_file_type_icon(file_extension, opts)
1511
1625
 
@@ -3067,11 +3181,11 @@ Name | Type | Description | Notes
3067
3181
 
3068
3182
 
3069
3183
  # **convert_document_pdf_to_png_array**
3070
- > PdfToPngResult convert_document_pdf_to_png_array(input_file)
3184
+ > PdfToPngResult convert_document_pdf_to_png_array(input_file, opts)
3071
3185
 
3072
3186
  Convert PDF to PNG Image Array
3073
3187
 
3074
- Convert PDF document to PNG array, one image per page.
3188
+ Convert PDF document to PNG array, one image per page. Returns PNG images as temporary expiring URLs.
3075
3189
 
3076
3190
  ### Example
3077
3191
  ```ruby
@@ -3089,10 +3203,13 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3089
3203
 
3090
3204
  input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3091
3205
 
3206
+ opts = {
3207
+ dpi: 56 # Integer | 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.
3208
+ }
3092
3209
 
3093
3210
  begin
3094
3211
  #Convert PDF to PNG Image Array
3095
- result = api_instance.convert_document_pdf_to_png_array(input_file)
3212
+ result = api_instance.convert_document_pdf_to_png_array(input_file, opts)
3096
3213
  p result
3097
3214
  rescue CloudmersiveConvertApiClient::ApiError => e
3098
3215
  puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_png_array: #{e}"
@@ -3104,6 +3221,7 @@ end
3104
3221
  Name | Type | Description | Notes
3105
3222
  ------------- | ------------- | ------------- | -------------
3106
3223
  **input_file** | **File**| Input file to perform the operation on. |
3224
+ **dpi** | **Integer**| 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. | [optional]
3107
3225
 
3108
3226
  ### Return type
3109
3227
 
@@ -3120,6 +3238,64 @@ Name | Type | Description | Notes
3120
3238
 
3121
3239
 
3122
3240
 
3241
+ # **convert_document_pdf_to_png_array_direct**
3242
+ > PdfToPngDirectResult convert_document_pdf_to_png_array_direct(input_file, opts)
3243
+
3244
+ Convert PDF to PNG Image Array (Direct)
3245
+
3246
+ Convert PDF document to PNG array, one image per page. Returns PNG images directly in the response objects.
3247
+
3248
+ ### Example
3249
+ ```ruby
3250
+ # load the gem
3251
+ require 'cloudmersive-convert-api-client'
3252
+ # setup authorization
3253
+ CloudmersiveConvertApiClient.configure do |config|
3254
+ # Configure API key authorization: Apikey
3255
+ config.api_key['Apikey'] = 'YOUR API KEY'
3256
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3257
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3258
+ end
3259
+
3260
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3261
+
3262
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3263
+
3264
+ opts = {
3265
+ dpi: 56 # Integer | 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.
3266
+ }
3267
+
3268
+ begin
3269
+ #Convert PDF to PNG Image Array (Direct)
3270
+ result = api_instance.convert_document_pdf_to_png_array_direct(input_file, opts)
3271
+ p result
3272
+ rescue CloudmersiveConvertApiClient::ApiError => e
3273
+ puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_png_array_direct: #{e}"
3274
+ end
3275
+ ```
3276
+
3277
+ ### Parameters
3278
+
3279
+ Name | Type | Description | Notes
3280
+ ------------- | ------------- | ------------- | -------------
3281
+ **input_file** | **File**| Input file to perform the operation on. |
3282
+ **dpi** | **Integer**| 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. | [optional]
3283
+
3284
+ ### Return type
3285
+
3286
+ [**PdfToPngDirectResult**](PdfToPngDirectResult.md)
3287
+
3288
+ ### Authorization
3289
+
3290
+ [Apikey](../README.md#Apikey)
3291
+
3292
+ ### HTTP request headers
3293
+
3294
+ - **Content-Type**: multipart/form-data
3295
+ - **Accept**: application/json, text/json, application/xml, text/xml
3296
+
3297
+
3298
+
3123
3299
  # **convert_document_pdf_to_png_single**
3124
3300
  > String convert_document_pdf_to_png_single(input_file)
3125
3301
 
@@ -3228,6 +3404,66 @@ Name | Type | Description | Notes
3228
3404
 
3229
3405
 
3230
3406
 
3407
+ # **convert_document_pdf_to_tiff**
3408
+ > String convert_document_pdf_to_tiff(input_file, opts)
3409
+
3410
+ Convert PDF to TIFF image
3411
+
3412
+ 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.
3413
+
3414
+ ### Example
3415
+ ```ruby
3416
+ # load the gem
3417
+ require 'cloudmersive-convert-api-client'
3418
+ # setup authorization
3419
+ CloudmersiveConvertApiClient.configure do |config|
3420
+ # Configure API key authorization: Apikey
3421
+ config.api_key['Apikey'] = 'YOUR API KEY'
3422
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3423
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3424
+ end
3425
+
3426
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3427
+
3428
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3429
+
3430
+ opts = {
3431
+ dpi: 56, # Integer | 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.
3432
+ lzw_compression: true # BOOLEAN | Optional; Enables LZW compression to reduce the size of the output image.
3433
+ }
3434
+
3435
+ begin
3436
+ #Convert PDF to TIFF image
3437
+ result = api_instance.convert_document_pdf_to_tiff(input_file, opts)
3438
+ p result
3439
+ rescue CloudmersiveConvertApiClient::ApiError => e
3440
+ puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_tiff: #{e}"
3441
+ end
3442
+ ```
3443
+
3444
+ ### Parameters
3445
+
3446
+ Name | Type | Description | Notes
3447
+ ------------- | ------------- | ------------- | -------------
3448
+ **input_file** | **File**| Input file to perform the operation on. |
3449
+ **dpi** | **Integer**| 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. | [optional]
3450
+ **lzw_compression** | **BOOLEAN**| Optional; Enables LZW compression to reduce the size of the output image. | [optional]
3451
+
3452
+ ### Return type
3453
+
3454
+ **String**
3455
+
3456
+ ### Authorization
3457
+
3458
+ [Apikey](../README.md#Apikey)
3459
+
3460
+ ### HTTP request headers
3461
+
3462
+ - **Content-Type**: multipart/form-data
3463
+ - **Accept**: application/json, text/json, application/xml, text/xml
3464
+
3465
+
3466
+
3231
3467
  # **convert_document_pdf_to_txt**
3232
3468
  > TextConversionResult convert_document_pdf_to_txt(input_file, opts)
3233
3469
 
@@ -3361,6 +3597,54 @@ Name | Type | Description | Notes
3361
3597
 
3362
3598
 
3363
3599
 
3600
+ # **convert_document_png_array_to_pdf_flatten_transparency**
3601
+ > Object convert_document_png_array_to_pdf_flatten_transparency
3602
+
3603
+ Convert PNG Array to PDF and remove transparency
3604
+
3605
+ 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.
3606
+
3607
+ ### Example
3608
+ ```ruby
3609
+ # load the gem
3610
+ require 'cloudmersive-convert-api-client'
3611
+ # setup authorization
3612
+ CloudmersiveConvertApiClient.configure do |config|
3613
+ # Configure API key authorization: Apikey
3614
+ config.api_key['Apikey'] = 'YOUR API KEY'
3615
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3616
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3617
+ end
3618
+
3619
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3620
+
3621
+ begin
3622
+ #Convert PNG Array to PDF and remove transparency
3623
+ result = api_instance.convert_document_png_array_to_pdf_flatten_transparency
3624
+ p result
3625
+ rescue CloudmersiveConvertApiClient::ApiError => e
3626
+ puts "Exception when calling ConvertDocumentApi->convert_document_png_array_to_pdf_flatten_transparency: #{e}"
3627
+ end
3628
+ ```
3629
+
3630
+ ### Parameters
3631
+ This endpoint does not need any parameter.
3632
+
3633
+ ### Return type
3634
+
3635
+ **Object**
3636
+
3637
+ ### Authorization
3638
+
3639
+ [Apikey](../README.md#Apikey)
3640
+
3641
+ ### HTTP request headers
3642
+
3643
+ - **Content-Type**: Not defined
3644
+ - **Accept**: application/octet-stream
3645
+
3646
+
3647
+
3364
3648
  # **convert_document_ppt_to_pdf**
3365
3649
  > String convert_document_ppt_to_pdf(input_file)
3366
3650
 
@@ -3578,7 +3862,7 @@ Name | Type | Description | Notes
3578
3862
 
3579
3863
 
3580
3864
  # **convert_document_pptx_to_ppt**
3581
- > Object convert_document_pptx_to_ppt
3865
+ > String convert_document_pptx_to_ppt(input_file)
3582
3866
 
3583
3867
  Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
3584
3868
 
@@ -3598,9 +3882,12 @@ end
3598
3882
 
3599
3883
  api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3600
3884
 
3885
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3886
+
3887
+
3601
3888
  begin
3602
3889
  #Convert PowerPoint PPTX presentation to Legacy PowerPoint PPT (97-03)
3603
- result = api_instance.convert_document_pptx_to_ppt
3890
+ result = api_instance.convert_document_pptx_to_ppt(input_file)
3604
3891
  p result
3605
3892
  rescue CloudmersiveConvertApiClient::ApiError => e
3606
3893
  puts "Exception when calling ConvertDocumentApi->convert_document_pptx_to_ppt: #{e}"
@@ -3608,11 +3895,14 @@ end
3608
3895
  ```
3609
3896
 
3610
3897
  ### Parameters
3611
- This endpoint does not need any parameter.
3898
+
3899
+ Name | Type | Description | Notes
3900
+ ------------- | ------------- | ------------- | -------------
3901
+ **input_file** | **File**| Input file to perform the operation on. |
3612
3902
 
3613
3903
  ### Return type
3614
3904
 
3615
- **Object**
3905
+ **String**
3616
3906
 
3617
3907
  ### Authorization
3618
3908
 
@@ -3620,7 +3910,7 @@ This endpoint does not need any parameter.
3620
3910
 
3621
3911
  ### HTTP request headers
3622
3912
 
3623
- - **Content-Type**: Not defined
3913
+ - **Content-Type**: multipart/form-data
3624
3914
  - **Accept**: application/octet-stream
3625
3915
 
3626
3916
 
@@ -3953,6 +4243,64 @@ Name | Type | Description | Notes
3953
4243
 
3954
4244
 
3955
4245
 
4246
+ # **convert_document_txt_to_pdf**
4247
+ > String convert_document_txt_to_pdf(input_file, opts)
4248
+
4249
+ Convert TXT text file to PDF Document
4250
+
4251
+ Convert simple text files to PDF.
4252
+
4253
+ ### Example
4254
+ ```ruby
4255
+ # load the gem
4256
+ require 'cloudmersive-convert-api-client'
4257
+ # setup authorization
4258
+ CloudmersiveConvertApiClient.configure do |config|
4259
+ # Configure API key authorization: Apikey
4260
+ config.api_key['Apikey'] = 'YOUR API KEY'
4261
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4262
+ #config.api_key_prefix['Apikey'] = 'Bearer'
4263
+ end
4264
+
4265
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
4266
+
4267
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
4268
+
4269
+ opts = {
4270
+ scale_factor: 56 # Integer | 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%.
4271
+ }
4272
+
4273
+ begin
4274
+ #Convert TXT text file to PDF Document
4275
+ result = api_instance.convert_document_txt_to_pdf(input_file, opts)
4276
+ p result
4277
+ rescue CloudmersiveConvertApiClient::ApiError => e
4278
+ puts "Exception when calling ConvertDocumentApi->convert_document_txt_to_pdf: #{e}"
4279
+ end
4280
+ ```
4281
+
4282
+ ### Parameters
4283
+
4284
+ Name | Type | Description | Notes
4285
+ ------------- | ------------- | ------------- | -------------
4286
+ **input_file** | **File**| Input file to perform the operation on. |
4287
+ **scale_factor** | **Integer**| 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%. | [optional]
4288
+
4289
+ ### Return type
4290
+
4291
+ **String**
4292
+
4293
+ ### Authorization
4294
+
4295
+ [Apikey](../README.md#Apikey)
4296
+
4297
+ ### HTTP request headers
4298
+
4299
+ - **Content-Type**: multipart/form-data
4300
+ - **Accept**: application/octet-stream
4301
+
4302
+
4303
+
3956
4304
  # **convert_document_xls_to_csv**
3957
4305
  > String convert_document_xls_to_csv(input_file)
3958
4306
 
@@ -4169,7 +4517,7 @@ Name | Type | Description | Notes
4169
4517
  ### HTTP request headers
4170
4518
 
4171
4519
  - **Content-Type**: multipart/form-data
4172
- - **Accept**: application/octet-stream
4520
+ - **Accept**: application/json, text/json, application/xml, text/xml
4173
4521
 
4174
4522
 
4175
4523
 
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::ConvertDocumentBatchJobCreateResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
7
+ **async_job_id** | **String** | When creating a job, an Async Job ID is returned. Use the GetAsyncJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes | [optional]
8
+
9
+
@@ -0,0 +1,12 @@
1
+ # CloudmersiveConvertApiClient::ConvertDocumentJobStatusResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | Tru eif the operation to check the status of the job was successful, false otherwise | [optional]
7
+ **async_job_status** | **String** | Returns the job status of the Async Job, if applicable. Possible states are STARTED and COMPLETED | [optional]
8
+ **async_job_id** | **String** | When the job exceeds 25 pages, an Async Job ID is returned. Use the CheckPdfOcrJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes | [optional]
9
+ **output_file_result** | **String** | Output file result (if applicable) | [optional]
10
+ **error_message** | **String** | Error message (if any) | [optional]
11
+
12
+
@@ -182,7 +182,7 @@ Name | Type | Description | Notes
182
182
 
183
183
 
184
184
  # **convert_image_multipage_image_format_convert**
185
- > MultipageImageFormatConversionResult convert_image_multipage_image_format_convert(format1, format2, input_file)
185
+ > MultipageImageFormatConversionResult convert_image_multipage_image_format_convert(format1, format2, input_file, opts)
186
186
 
187
187
  Multi-page image format conversion
188
188
 
@@ -208,10 +208,13 @@ format2 = 'format2_example' # String | Output (convert to this format) file form
208
208
 
209
209
  input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
210
210
 
211
+ opts = {
212
+ dpi: 56 # Integer | 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.
213
+ }
211
214
 
212
215
  begin
213
216
  #Multi-page image format conversion
214
- result = api_instance.convert_image_multipage_image_format_convert(format1, format2, input_file)
217
+ result = api_instance.convert_image_multipage_image_format_convert(format1, format2, input_file, opts)
215
218
  p result
216
219
  rescue CloudmersiveConvertApiClient::ApiError => e
217
220
  puts "Exception when calling ConvertImageApi->convert_image_multipage_image_format_convert: #{e}"
@@ -225,6 +228,7 @@ Name | Type | Description | Notes
225
228
  **format1** | **String**| Input file format as a 3+ letter file extension. You can also provide UNKNOWN for unknown file formats. 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 |
226
229
  **format2** | **String**| 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 |
227
230
  **input_file** | **File**| Input file to perform the operation on. |
231
+ **dpi** | **Integer**| 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. | [optional]
228
232
 
229
233
  ### Return type
230
234
 
@@ -64,7 +64,7 @@ Name | Type | Description | Notes
64
64
  ### HTTP request headers
65
65
 
66
66
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
67
- - **Accept**: application/octet-stream
67
+ - **Accept**: application/json, text/json, application/xml, text/xml
68
68
 
69
69
 
70
70
 
@@ -118,7 +118,7 @@ Name | Type | Description | Notes
118
118
  ### HTTP request headers
119
119
 
120
120
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
121
- - **Accept**: application/octet-stream
121
+ - **Accept**: application/json, text/json, application/xml, text/xml
122
122
 
123
123
 
124
124
 
@@ -172,7 +172,7 @@ Name | Type | Description | Notes
172
172
  ### HTTP request headers
173
173
 
174
174
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
175
- - **Accept**: application/octet-stream
175
+ - **Accept**: application/json, text/json, application/xml, text/xml
176
176
 
177
177
 
178
178
 
@@ -226,7 +226,7 @@ Name | Type | Description | Notes
226
226
  ### HTTP request headers
227
227
 
228
228
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
229
- - **Accept**: application/octet-stream
229
+ - **Accept**: application/json, text/json, application/xml, text/xml
230
230
 
231
231
 
232
232
 
@@ -280,7 +280,7 @@ Name | Type | Description | Notes
280
280
  ### HTTP request headers
281
281
 
282
282
  - **Content-Type**: multipart/form-data
283
- - **Accept**: application/octet-stream
283
+ - **Accept**: application/json, text/json, application/xml, text/xml
284
284
 
285
285
 
286
286
 
@@ -334,7 +334,7 @@ Name | Type | Description | Notes
334
334
  ### HTTP request headers
335
335
 
336
336
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
337
- - **Accept**: application/octet-stream
337
+ - **Accept**: application/json, text/json, application/xml, text/xml
338
338
 
339
339
 
340
340
 
@@ -388,7 +388,7 @@ Name | Type | Description | Notes
388
388
  ### HTTP request headers
389
389
 
390
390
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
391
- - **Accept**: application/octet-stream
391
+ - **Accept**: application/json, text/json, application/xml, text/xml
392
392
 
393
393
 
394
394
 
@@ -442,7 +442,7 @@ Name | Type | Description | Notes
442
442
  ### HTTP request headers
443
443
 
444
444
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
445
- - **Accept**: application/octet-stream
445
+ - **Accept**: application/json, text/json, application/xml, text/xml
446
446
 
447
447
 
448
448
 
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::ConvertedPngDirectPage
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **page_number** | **Integer** | Page number of the converted page, starting with 1 | [optional]
7
+ **image_data** | **String** | PNG binary image file data in bytes | [optional]
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveConvertApiClient::DocumentArrayInput
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **documents** | [**Array<DocumentItem>**](DocumentItem.md) | Array of document objects | [optional]
7
+
8
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::DocumentItem
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **document_file_name** | **String** | File name of the document | [optional]
7
+ **document_content** | **String** | Contents of the document as a binary byte array | [optional]
8
+
9
+