cloudmersive-convert-api-client 2.0.6 → 2.0.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (783) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +7 -0
  3. data/README.md +579 -0
  4. data/Rakefile +8 -0
  5. data/cloudmersive-convert-api-client.gemspec +45 -0
  6. data/docs/AddPdfAnnotationRequest.md +9 -0
  7. data/docs/AlternateFileFormatCandidate.md +10 -0
  8. data/docs/AppendXlsxRowRequest.md +11 -0
  9. data/docs/AppendXlsxRowResponse.md +9 -0
  10. data/docs/AutodetectDocumentValidationResult.md +12 -0
  11. data/docs/AutodetectGetInfoResult.md +14 -0
  12. data/docs/AutodetectToJpgResult.md +9 -0
  13. data/docs/AutodetectToPngResult.md +9 -0
  14. data/docs/AutodetectToThumbnailsResult.md +9 -0
  15. data/docs/Base64DecodeRequest.md +8 -0
  16. data/docs/Base64DecodeResponse.md +9 -0
  17. data/docs/Base64DetectRequest.md +8 -0
  18. data/docs/Base64DetectResponse.md +9 -0
  19. data/docs/Base64EncodeRequest.md +8 -0
  20. data/docs/Base64EncodeResponse.md +9 -0
  21. data/docs/ChangeLineEndingResponse.md +9 -0
  22. data/docs/ClearXlsxCellRequest.md +12 -0
  23. data/docs/ClearXlsxCellResponse.md +9 -0
  24. data/docs/ClearXlsxRowRequest.md +11 -0
  25. data/docs/ClearXlsxRowResponse.md +9 -0
  26. data/docs/CompareDocumentApi.md +66 -0
  27. data/docs/ConvertDataApi.md +902 -0
  28. data/docs/ConvertDocumentApi.md +4344 -0
  29. data/docs/ConvertImageApi.md +243 -0
  30. data/docs/ConvertTemplateApi.md +122 -0
  31. data/docs/ConvertWebApi.md +448 -0
  32. data/docs/ConvertedJpgPage.md +9 -0
  33. data/docs/ConvertedPngPage.md +9 -0
  34. data/docs/CreateBlankDocxRequest.md +8 -0
  35. data/docs/CreateBlankDocxResponse.md +9 -0
  36. data/docs/CreateBlankSpreadsheetRequest.md +8 -0
  37. data/docs/CreateBlankSpreadsheetResponse.md +9 -0
  38. data/docs/CreateSpreadsheetFromDataRequest.md +9 -0
  39. data/docs/CreateSpreadsheetFromDataResponse.md +9 -0
  40. data/docs/CreateZipArchiveRequest.md +9 -0
  41. data/docs/CsvCollection.md +10 -0
  42. data/docs/CsvFileResult.md +9 -0
  43. data/docs/DeleteDocxTableRowRangeRequest.md +12 -0
  44. data/docs/DeleteDocxTableRowRangeResponse.md +9 -0
  45. data/docs/DeleteDocxTableRowRequest.md +11 -0
  46. data/docs/DeleteDocxTableRowResponse.md +9 -0
  47. data/docs/DetectLineEndingsResponse.md +11 -0
  48. data/docs/DisableSharedWorkbookRequest.md +9 -0
  49. data/docs/DisableSharedWorkbookResponse.md +9 -0
  50. data/docs/DocumentValidationError.md +11 -0
  51. data/docs/DocumentValidationResult.md +12 -0
  52. data/docs/DocxBody.md +10 -0
  53. data/docs/DocxCellStyle.md +11 -0
  54. data/docs/DocxComment.md +16 -0
  55. data/docs/DocxFooter.md +10 -0
  56. data/docs/DocxHeader.md +10 -0
  57. data/docs/DocxImage.md +20 -0
  58. data/docs/DocxInsertCommentOnParagraphRequest.md +11 -0
  59. data/docs/DocxInsertImageRequest.md +16 -0
  60. data/docs/DocxInsertImageResponse.md +9 -0
  61. data/docs/DocxPage.md +9 -0
  62. data/docs/DocxParagraph.md +11 -0
  63. data/docs/DocxRemoveObjectRequest.md +10 -0
  64. data/docs/DocxRemoveObjectResponse.md +9 -0
  65. data/docs/DocxRun.md +15 -0
  66. data/docs/DocxSection.md +9 -0
  67. data/docs/DocxSetFooterAddPageNumberRequest.md +10 -0
  68. data/docs/DocxSetFooterRequest.md +10 -0
  69. data/docs/DocxSetFooterResponse.md +9 -0
  70. data/docs/DocxSetHeaderRequest.md +10 -0
  71. data/docs/DocxSetHeaderResponse.md +9 -0
  72. data/docs/DocxStyle.md +14 -0
  73. data/docs/DocxTable.md +46 -0
  74. data/docs/DocxTableCell.md +15 -0
  75. data/docs/DocxTableRow.md +10 -0
  76. data/docs/DocxTemplateApplicationRequest.md +8 -0
  77. data/docs/DocxTemplateOperation.md +10 -0
  78. data/docs/DocxText.md +10 -0
  79. data/docs/DocxToJpgResult.md +9 -0
  80. data/docs/DocxToPngResult.md +9 -0
  81. data/docs/DocxTopLevelComment.md +14 -0
  82. data/docs/EditDocumentApi.md +3033 -0
  83. data/docs/EditHtmlApi.md +261 -0
  84. data/docs/EditPdfApi.md +1083 -0
  85. data/docs/EditTextApi.md +726 -0
  86. data/docs/EmlAttachment.md +9 -0
  87. data/docs/EmlToHtmlResult.md +16 -0
  88. data/docs/EmlToJpgResult.md +9 -0
  89. data/docs/EmlToPngResult.md +9 -0
  90. data/docs/EnableSharedWorkbookRequest.md +9 -0
  91. data/docs/EnableSharedWorkbookResponse.md +9 -0
  92. data/docs/ExifValue.md +10 -0
  93. data/docs/FindDocxParagraphRequest.md +11 -0
  94. data/docs/FindDocxParagraphResponse.md +10 -0
  95. data/docs/FindRegexMatch.md +12 -0
  96. data/docs/FindStringMatch.md +10 -0
  97. data/docs/FindStringRegexRequest.md +10 -0
  98. data/docs/FindStringRegexResponse.md +10 -0
  99. data/docs/FindStringSimpleRequest.md +9 -0
  100. data/docs/FindStringSimpleResponse.md +10 -0
  101. data/docs/FinishEditingRequest.md +8 -0
  102. data/docs/GetDocxBodyRequest.md +9 -0
  103. data/docs/GetDocxBodyResponse.md +9 -0
  104. data/docs/GetDocxCommentsHierarchicalResponse.md +10 -0
  105. data/docs/GetDocxCommentsResponse.md +10 -0
  106. data/docs/GetDocxGetCommentsHierarchicalRequest.md +9 -0
  107. data/docs/GetDocxGetCommentsRequest.md +9 -0
  108. data/docs/GetDocxHeadersAndFootersRequest.md +9 -0
  109. data/docs/GetDocxHeadersAndFootersResponse.md +10 -0
  110. data/docs/GetDocxImagesRequest.md +9 -0
  111. data/docs/GetDocxImagesResponse.md +9 -0
  112. data/docs/GetDocxPagesRequest.md +10 -0
  113. data/docs/GetDocxPagesResponse.md +10 -0
  114. data/docs/GetDocxSectionsRequest.md +9 -0
  115. data/docs/GetDocxSectionsResponse.md +9 -0
  116. data/docs/GetDocxStylesRequest.md +9 -0
  117. data/docs/GetDocxStylesResponse.md +9 -0
  118. data/docs/GetDocxTableByIndexRequest.md +10 -0
  119. data/docs/GetDocxTableByIndexResponse.md +9 -0
  120. data/docs/GetDocxTableRowRequest.md +11 -0
  121. data/docs/GetDocxTableRowResponse.md +9 -0
  122. data/docs/GetDocxTablesRequest.md +9 -0
  123. data/docs/GetDocxTablesResponse.md +9 -0
  124. data/docs/GetFileTypeIconResult.md +10 -0
  125. data/docs/GetImageInfoResult.md +24 -0
  126. data/docs/GetPdfAnnotationsResult.md +9 -0
  127. data/docs/GetXlsxCellByIdentifierRequest.md +11 -0
  128. data/docs/GetXlsxCellByIdentifierResponse.md +9 -0
  129. data/docs/GetXlsxCellRequest.md +12 -0
  130. data/docs/GetXlsxCellResponse.md +9 -0
  131. data/docs/GetXlsxColumnsRequest.md +10 -0
  132. data/docs/GetXlsxColumnsResponse.md +9 -0
  133. data/docs/GetXlsxImagesRequest.md +10 -0
  134. data/docs/GetXlsxImagesResponse.md +9 -0
  135. data/docs/GetXlsxRowsAndCellsRequest.md +10 -0
  136. data/docs/GetXlsxRowsAndCellsResponse.md +9 -0
  137. data/docs/GetXlsxSpecificRowRequest.md +11 -0
  138. data/docs/GetXlsxSpecificRowResponse.md +9 -0
  139. data/docs/GetXlsxStylesRequest.md +9 -0
  140. data/docs/GetXlsxStylesResponse.md +9 -0
  141. data/docs/GetXlsxWorksheetsRequest.md +9 -0
  142. data/docs/GetXlsxWorksheetsResponse.md +9 -0
  143. data/docs/HtmlMdResult.md +9 -0
  144. data/docs/HtmlTemplateApplicationRequest.md +10 -0
  145. data/docs/HtmlTemplateApplicationResponse.md +9 -0
  146. data/docs/HtmlTemplateOperation.md +10 -0
  147. data/docs/HtmlToOfficeRequest.md +8 -0
  148. data/docs/HtmlToPdfRequest.md +11 -0
  149. data/docs/HtmlToPngRequest.md +11 -0
  150. data/docs/HtmlToTextRequest.md +8 -0
  151. data/docs/HtmlToTextResponse.md +9 -0
  152. data/docs/InsertDocxCommentOnParagraphResponse.md +9 -0
  153. data/docs/InsertDocxInsertParagraphRequest.md +12 -0
  154. data/docs/InsertDocxInsertParagraphResponse.md +9 -0
  155. data/docs/InsertDocxTableRowRequest.md +12 -0
  156. data/docs/InsertDocxTableRowResponse.md +9 -0
  157. data/docs/InsertDocxTablesRequest.md +12 -0
  158. data/docs/InsertDocxTablesResponse.md +9 -0
  159. data/docs/InsertXlsxWorksheetRequest.md +10 -0
  160. data/docs/InsertXlsxWorksheetResponse.md +9 -0
  161. data/docs/KeynoteToJpgResult.md +9 -0
  162. data/docs/KeynoteToPngResult.md +9 -0
  163. data/docs/MergeDocumentApi.md +812 -0
  164. data/docs/MsgAttachment.md +9 -0
  165. data/docs/MsgToHtmlResult.md +16 -0
  166. data/docs/MsgToJpgResult.md +9 -0
  167. data/docs/MsgToPngResult.md +9 -0
  168. data/docs/MultiReplaceStringRequest.md +10 -0
  169. data/docs/MultipageImageFormatConversionResult.md +10 -0
  170. data/docs/OdpToJpgResult.md +9 -0
  171. data/docs/OdpToPngResult.md +9 -0
  172. data/docs/OdsToJpgResult.md +9 -0
  173. data/docs/OdsToPngResult.md +9 -0
  174. data/docs/OdtToJpgResult.md +9 -0
  175. data/docs/OdtToPngResult.md +9 -0
  176. data/docs/PageConversionResult.md +9 -0
  177. data/docs/PdfAnnotation.md +19 -0
  178. data/docs/PdfDocument.md +10 -0
  179. data/docs/PdfFormField.md +11 -0
  180. data/docs/PdfFormFields.md +9 -0
  181. data/docs/PdfMetadata.md +16 -0
  182. data/docs/PdfPageText.md +9 -0
  183. data/docs/PdfTextByPageResult.md +9 -0
  184. data/docs/PdfToJpgResult.md +9 -0
  185. data/docs/PdfToPngResult.md +9 -0
  186. data/docs/PptxToPngResult.md +9 -0
  187. data/docs/PresentationResult.md +10 -0
  188. data/docs/RemoveDocxHeadersAndFootersRequest.md +11 -0
  189. data/docs/RemoveDocxHeadersAndFootersResponse.md +9 -0
  190. data/docs/RemoveDocxPagesRequest.md +11 -0
  191. data/docs/RemoveHtmlFromTextRequest.md +8 -0
  192. data/docs/RemoveHtmlFromTextResponse.md +9 -0
  193. data/docs/RemovePptxSlidesRequest.md +11 -0
  194. data/docs/RemoveWhitespaceFromTextRequest.md +8 -0
  195. data/docs/RemoveWhitespaceFromTextResponse.md +9 -0
  196. data/docs/RemoveXlsxWorksheetRequest.md +10 -0
  197. data/docs/RenameXlsxWorksheetRequest.md +11 -0
  198. data/docs/RenameXlsxWorksheetResponse.md +9 -0
  199. data/docs/ReplaceDocxParagraphRequest.md +12 -0
  200. data/docs/ReplaceDocxParagraphResponse.md +9 -0
  201. data/docs/ReplaceStringRegexRequest.md +10 -0
  202. data/docs/ReplaceStringRegexResponse.md +9 -0
  203. data/docs/ReplaceStringRequest.md +12 -0
  204. data/docs/ReplaceStringSimpleRequest.md +10 -0
  205. data/docs/ReplaceStringSimpleResponse.md +9 -0
  206. data/docs/RtfToJpgResult.md +9 -0
  207. data/docs/RtfToPngResult.md +9 -0
  208. data/docs/ScreenshotRequest.md +11 -0
  209. data/docs/SetFormFieldValue.md +11 -0
  210. data/docs/SetPdfFormFieldsRequest.md +9 -0
  211. data/docs/SetPdfMetadataRequest.md +9 -0
  212. data/docs/SetXlsxCellByIdentifierRequest.md +12 -0
  213. data/docs/SetXlsxCellByIdentifierResponse.md +9 -0
  214. data/docs/SetXlsxCellRequest.md +13 -0
  215. data/docs/SetXlsxCellResponse.md +9 -0
  216. data/docs/SingleReplaceString.md +10 -0
  217. data/docs/SplitDocumentApi.md +361 -0
  218. data/docs/SplitDocumentResult.md +10 -0
  219. data/docs/SplitDocxDocumentResult.md +9 -0
  220. data/docs/SplitPdfResult.md +9 -0
  221. data/docs/SplitPptxPresentationResult.md +9 -0
  222. data/docs/SplitTextDocumentByLinesResult.md +10 -0
  223. data/docs/SplitTextDocumentByStringResult.md +10 -0
  224. data/docs/SplitXlsxWorksheetResult.md +9 -0
  225. data/docs/TextConversionResult.md +9 -0
  226. data/docs/TextDocumentElement.md +9 -0
  227. data/docs/TextDocumentLine.md +9 -0
  228. data/docs/TextEncodingDetectResponse.md +9 -0
  229. data/docs/Thumbnail.md +9 -0
  230. data/docs/TransformDocumentApi.md +140 -0
  231. data/docs/UpdateDocxTableCellRequest.md +13 -0
  232. data/docs/UpdateDocxTableCellResponse.md +9 -0
  233. data/docs/UpdateDocxTableRowRequest.md +12 -0
  234. data/docs/UpdateDocxTableRowResponse.md +9 -0
  235. data/docs/UrlToPdfRequest.md +11 -0
  236. data/docs/UrlToTextRequest.md +8 -0
  237. data/docs/UrlToTextResponse.md +9 -0
  238. data/docs/ValidateDocumentApi.md +833 -0
  239. data/docs/ViewerResponse.md +9 -0
  240. data/docs/ViewerToolsApi.md +63 -0
  241. data/docs/WorksheetResult.md +11 -0
  242. data/docs/XlsxImage.md +12 -0
  243. data/docs/XlsxSpreadsheetCell.md +12 -0
  244. data/docs/XlsxSpreadsheetColumn.md +9 -0
  245. data/docs/XlsxSpreadsheetRow.md +9 -0
  246. data/docs/XlsxToPngResult.md +9 -0
  247. data/docs/XlsxWorksheet.md +9 -0
  248. data/docs/XmlAddAttributeWithXPathResult.md +10 -0
  249. data/docs/XmlAddChildWithXPathResult.md +10 -0
  250. data/docs/XmlFilterWithXPathResult.md +10 -0
  251. data/docs/XmlQueryWithXQueryMultiResult.md +10 -0
  252. data/docs/XmlQueryWithXQueryResult.md +10 -0
  253. data/docs/XmlRemoveAllChildrenWithXPathResult.md +10 -0
  254. data/docs/XmlRemoveWithXPathResult.md +11 -0
  255. data/docs/XmlReplaceWithXPathResult.md +10 -0
  256. data/docs/XmlSetValueWithXPathResult.md +10 -0
  257. data/docs/ZipArchiveApi.md +306 -0
  258. data/docs/ZipDirectory.md +10 -0
  259. data/docs/ZipEncryptionAdvancedRequest.md +10 -0
  260. data/docs/ZipExtractResponse.md +10 -0
  261. data/docs/ZipFile.md +9 -0
  262. data/git_push.sh +55 -0
  263. data/lib/cloudmersive-convert-api-client.rb +295 -0
  264. data/lib/cloudmersive-convert-api-client/api/compare_document_api.rb +85 -0
  265. data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +966 -0
  266. data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +4360 -0
  267. data/lib/cloudmersive-convert-api-client/api/convert_image_api.rb +273 -0
  268. data/lib/cloudmersive-convert-api-client/api/convert_template_api.rb +135 -0
  269. data/lib/cloudmersive-convert-api-client/api/convert_web_api.rb +456 -0
  270. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +2994 -0
  271. data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +270 -0
  272. data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +1163 -0
  273. data/lib/cloudmersive-convert-api-client/api/edit_text_api.rb +735 -0
  274. data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +911 -0
  275. data/lib/cloudmersive-convert-api-client/api/split_document_api.rb +375 -0
  276. data/lib/cloudmersive-convert-api-client/api/transform_document_api.rb +161 -0
  277. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +848 -0
  278. data/lib/cloudmersive-convert-api-client/api/viewer_tools_api.rb +78 -0
  279. data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +330 -0
  280. data/lib/cloudmersive-convert-api-client/api_client.rb +391 -0
  281. data/lib/cloudmersive-convert-api-client/api_error.rb +38 -0
  282. data/lib/cloudmersive-convert-api-client/configuration.rb +209 -0
  283. data/lib/cloudmersive-convert-api-client/models/add_pdf_annotation_request.rb +213 -0
  284. data/lib/cloudmersive-convert-api-client/models/alternate_file_format_candidate.rb +206 -0
  285. data/lib/cloudmersive-convert-api-client/models/append_xlsx_row_request.rb +231 -0
  286. data/lib/cloudmersive-convert-api-client/models/append_xlsx_row_response.rb +196 -0
  287. data/lib/cloudmersive-convert-api-client/models/autodetect_document_validation_result.rb +227 -0
  288. data/lib/cloudmersive-convert-api-client/models/autodetect_get_info_result.rb +248 -0
  289. data/lib/cloudmersive-convert-api-client/models/autodetect_to_jpg_result.rb +198 -0
  290. data/lib/cloudmersive-convert-api-client/models/autodetect_to_png_result.rb +198 -0
  291. data/lib/cloudmersive-convert-api-client/models/autodetect_to_thumbnails_result.rb +198 -0
  292. data/lib/cloudmersive-convert-api-client/models/base64_decode_request.rb +186 -0
  293. data/lib/cloudmersive-convert-api-client/models/base64_decode_response.rb +211 -0
  294. data/lib/cloudmersive-convert-api-client/models/base64_detect_request.rb +186 -0
  295. data/lib/cloudmersive-convert-api-client/models/base64_detect_response.rb +196 -0
  296. data/lib/cloudmersive-convert-api-client/models/base64_encode_request.rb +201 -0
  297. data/lib/cloudmersive-convert-api-client/models/base64_encode_response.rb +196 -0
  298. data/lib/cloudmersive-convert-api-client/models/change_line_ending_response.rb +196 -0
  299. data/lib/cloudmersive-convert-api-client/models/clear_xlsx_cell_request.rb +241 -0
  300. data/lib/cloudmersive-convert-api-client/models/clear_xlsx_cell_response.rb +196 -0
  301. data/lib/cloudmersive-convert-api-client/models/clear_xlsx_row_request.rb +231 -0
  302. data/lib/cloudmersive-convert-api-client/models/clear_xlsx_row_response.rb +196 -0
  303. data/lib/cloudmersive-convert-api-client/models/converted_jpg_page.rb +211 -0
  304. data/lib/cloudmersive-convert-api-client/models/converted_png_page.rb +196 -0
  305. data/lib/cloudmersive-convert-api-client/models/create_blank_docx_request.rb +186 -0
  306. data/lib/cloudmersive-convert-api-client/models/create_blank_docx_response.rb +196 -0
  307. data/lib/cloudmersive-convert-api-client/models/create_blank_spreadsheet_request.rb +186 -0
  308. data/lib/cloudmersive-convert-api-client/models/create_blank_spreadsheet_response.rb +196 -0
  309. data/lib/cloudmersive-convert-api-client/models/create_spreadsheet_from_data_request.rb +198 -0
  310. data/lib/cloudmersive-convert-api-client/models/create_spreadsheet_from_data_response.rb +196 -0
  311. data/lib/cloudmersive-convert-api-client/models/create_zip_archive_request.rb +200 -0
  312. data/lib/cloudmersive-convert-api-client/models/csv_collection.rb +208 -0
  313. data/lib/cloudmersive-convert-api-client/models/csv_file_result.rb +211 -0
  314. data/lib/cloudmersive-convert-api-client/models/delete_docx_table_row_range_request.rb +241 -0
  315. data/lib/cloudmersive-convert-api-client/models/delete_docx_table_row_range_response.rb +196 -0
  316. data/lib/cloudmersive-convert-api-client/models/delete_docx_table_row_request.rb +231 -0
  317. data/lib/cloudmersive-convert-api-client/models/delete_docx_table_row_response.rb +196 -0
  318. data/lib/cloudmersive-convert-api-client/models/detect_line_endings_response.rb +216 -0
  319. data/lib/cloudmersive-convert-api-client/models/disable_shared_workbook_request.rb +211 -0
  320. data/lib/cloudmersive-convert-api-client/models/disable_shared_workbook_response.rb +196 -0
  321. data/lib/cloudmersive-convert-api-client/models/document_validation_error.rb +216 -0
  322. data/lib/cloudmersive-convert-api-client/models/document_validation_result.rb +228 -0
  323. data/lib/cloudmersive-convert-api-client/models/docx_body.rb +209 -0
  324. data/lib/cloudmersive-convert-api-client/models/docx_cell_style.rb +216 -0
  325. data/lib/cloudmersive-convert-api-client/models/docx_comment.rb +266 -0
  326. data/lib/cloudmersive-convert-api-client/models/docx_footer.rb +210 -0
  327. data/lib/cloudmersive-convert-api-client/models/docx_header.rb +210 -0
  328. data/lib/cloudmersive-convert-api-client/models/docx_image.rb +305 -0
  329. data/lib/cloudmersive-convert-api-client/models/docx_insert_comment_on_paragraph_request.rb +231 -0
  330. data/lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb +296 -0
  331. data/lib/cloudmersive-convert-api-client/models/docx_insert_image_response.rb +196 -0
  332. data/lib/cloudmersive-convert-api-client/models/docx_page.rb +198 -0
  333. data/lib/cloudmersive-convert-api-client/models/docx_paragraph.rb +218 -0
  334. data/lib/cloudmersive-convert-api-client/models/docx_remove_object_request.rb +221 -0
  335. data/lib/cloudmersive-convert-api-client/models/docx_remove_object_response.rb +196 -0
  336. data/lib/cloudmersive-convert-api-client/models/docx_run.rb +258 -0
  337. data/lib/cloudmersive-convert-api-client/models/docx_section.rb +198 -0
  338. data/lib/cloudmersive-convert-api-client/models/docx_set_footer_add_page_number_request.rb +221 -0
  339. data/lib/cloudmersive-convert-api-client/models/docx_set_footer_request.rb +221 -0
  340. data/lib/cloudmersive-convert-api-client/models/docx_set_footer_response.rb +196 -0
  341. data/lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb +221 -0
  342. data/lib/cloudmersive-convert-api-client/models/docx_set_header_response.rb +196 -0
  343. data/lib/cloudmersive-convert-api-client/models/docx_style.rb +246 -0
  344. data/lib/cloudmersive-convert-api-client/models/docx_table.rb +568 -0
  345. data/lib/cloudmersive-convert-api-client/models/docx_table_cell.rb +258 -0
  346. data/lib/cloudmersive-convert-api-client/models/docx_table_row.rb +208 -0
  347. data/lib/cloudmersive-convert-api-client/models/docx_template_application_request.rb +188 -0
  348. data/lib/cloudmersive-convert-api-client/models/docx_template_operation.rb +239 -0
  349. data/lib/cloudmersive-convert-api-client/models/docx_text.rb +206 -0
  350. data/lib/cloudmersive-convert-api-client/models/docx_to_jpg_result.rb +198 -0
  351. data/lib/cloudmersive-convert-api-client/models/docx_to_png_result.rb +198 -0
  352. data/lib/cloudmersive-convert-api-client/models/docx_top_level_comment.rb +248 -0
  353. data/lib/cloudmersive-convert-api-client/models/eml_attachment.rb +211 -0
  354. data/lib/cloudmersive-convert-api-client/models/eml_to_html_result.rb +268 -0
  355. data/lib/cloudmersive-convert-api-client/models/eml_to_jpg_result.rb +198 -0
  356. data/lib/cloudmersive-convert-api-client/models/eml_to_png_result.rb +198 -0
  357. data/lib/cloudmersive-convert-api-client/models/enable_shared_workbook_request.rb +211 -0
  358. data/lib/cloudmersive-convert-api-client/models/enable_shared_workbook_response.rb +196 -0
  359. data/lib/cloudmersive-convert-api-client/models/exif_value.rb +206 -0
  360. data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_request.rb +231 -0
  361. data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_response.rb +208 -0
  362. data/lib/cloudmersive-convert-api-client/models/find_regex_match.rb +228 -0
  363. data/lib/cloudmersive-convert-api-client/models/find_string_match.rb +206 -0
  364. data/lib/cloudmersive-convert-api-client/models/find_string_regex_request.rb +206 -0
  365. data/lib/cloudmersive-convert-api-client/models/find_string_regex_response.rb +208 -0
  366. data/lib/cloudmersive-convert-api-client/models/find_string_simple_request.rb +196 -0
  367. data/lib/cloudmersive-convert-api-client/models/find_string_simple_response.rb +208 -0
  368. data/lib/cloudmersive-convert-api-client/models/finish_editing_request.rb +186 -0
  369. data/lib/cloudmersive-convert-api-client/models/get_docx_body_request.rb +211 -0
  370. data/lib/cloudmersive-convert-api-client/models/get_docx_body_response.rb +196 -0
  371. data/lib/cloudmersive-convert-api-client/models/get_docx_comments_hierarchical_response.rb +208 -0
  372. data/lib/cloudmersive-convert-api-client/models/get_docx_comments_response.rb +208 -0
  373. data/lib/cloudmersive-convert-api-client/models/get_docx_get_comments_hierarchical_request.rb +211 -0
  374. data/lib/cloudmersive-convert-api-client/models/get_docx_get_comments_request.rb +211 -0
  375. data/lib/cloudmersive-convert-api-client/models/get_docx_headers_and_footers_request.rb +211 -0
  376. data/lib/cloudmersive-convert-api-client/models/get_docx_headers_and_footers_response.rb +208 -0
  377. data/lib/cloudmersive-convert-api-client/models/get_docx_images_request.rb +211 -0
  378. data/lib/cloudmersive-convert-api-client/models/get_docx_images_response.rb +198 -0
  379. data/lib/cloudmersive-convert-api-client/models/get_docx_pages_request.rb +221 -0
  380. data/lib/cloudmersive-convert-api-client/models/get_docx_pages_response.rb +208 -0
  381. data/lib/cloudmersive-convert-api-client/models/get_docx_sections_request.rb +211 -0
  382. data/lib/cloudmersive-convert-api-client/models/get_docx_sections_response.rb +198 -0
  383. data/lib/cloudmersive-convert-api-client/models/get_docx_styles_request.rb +211 -0
  384. data/lib/cloudmersive-convert-api-client/models/get_docx_styles_response.rb +198 -0
  385. data/lib/cloudmersive-convert-api-client/models/get_docx_table_by_index_request.rb +221 -0
  386. data/lib/cloudmersive-convert-api-client/models/get_docx_table_by_index_response.rb +196 -0
  387. data/lib/cloudmersive-convert-api-client/models/get_docx_table_row_request.rb +231 -0
  388. data/lib/cloudmersive-convert-api-client/models/get_docx_table_row_response.rb +196 -0
  389. data/lib/cloudmersive-convert-api-client/models/get_docx_tables_request.rb +211 -0
  390. data/lib/cloudmersive-convert-api-client/models/get_docx_tables_response.rb +198 -0
  391. data/lib/cloudmersive-convert-api-client/models/get_file_type_icon_result.rb +221 -0
  392. data/lib/cloudmersive-convert-api-client/models/get_image_info_result.rb +347 -0
  393. data/lib/cloudmersive-convert-api-client/models/get_pdf_annotations_result.rb +198 -0
  394. data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_request.rb +231 -0
  395. data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_response.rb +196 -0
  396. data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_request.rb +241 -0
  397. data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_response.rb +196 -0
  398. data/lib/cloudmersive-convert-api-client/models/get_xlsx_columns_request.rb +221 -0
  399. data/lib/cloudmersive-convert-api-client/models/get_xlsx_columns_response.rb +198 -0
  400. data/lib/cloudmersive-convert-api-client/models/get_xlsx_images_request.rb +221 -0
  401. data/lib/cloudmersive-convert-api-client/models/get_xlsx_images_response.rb +198 -0
  402. data/lib/cloudmersive-convert-api-client/models/get_xlsx_rows_and_cells_request.rb +221 -0
  403. data/lib/cloudmersive-convert-api-client/models/get_xlsx_rows_and_cells_response.rb +198 -0
  404. data/lib/cloudmersive-convert-api-client/models/get_xlsx_specific_row_request.rb +231 -0
  405. data/lib/cloudmersive-convert-api-client/models/get_xlsx_specific_row_response.rb +196 -0
  406. data/lib/cloudmersive-convert-api-client/models/get_xlsx_styles_request.rb +211 -0
  407. data/lib/cloudmersive-convert-api-client/models/get_xlsx_styles_response.rb +198 -0
  408. data/lib/cloudmersive-convert-api-client/models/get_xlsx_worksheets_request.rb +211 -0
  409. data/lib/cloudmersive-convert-api-client/models/get_xlsx_worksheets_response.rb +198 -0
  410. data/lib/cloudmersive-convert-api-client/models/html_md_result.rb +196 -0
  411. data/lib/cloudmersive-convert-api-client/models/html_template_application_request.rb +208 -0
  412. data/lib/cloudmersive-convert-api-client/models/html_template_application_response.rb +196 -0
  413. data/lib/cloudmersive-convert-api-client/models/html_template_operation.rb +239 -0
  414. data/lib/cloudmersive-convert-api-client/models/html_to_office_request.rb +186 -0
  415. data/lib/cloudmersive-convert-api-client/models/html_to_pdf_request.rb +216 -0
  416. data/lib/cloudmersive-convert-api-client/models/html_to_png_request.rb +216 -0
  417. data/lib/cloudmersive-convert-api-client/models/html_to_text_request.rb +186 -0
  418. data/lib/cloudmersive-convert-api-client/models/html_to_text_response.rb +196 -0
  419. data/lib/cloudmersive-convert-api-client/models/insert_docx_comment_on_paragraph_response.rb +196 -0
  420. data/lib/cloudmersive-convert-api-client/models/insert_docx_insert_paragraph_request.rb +241 -0
  421. data/lib/cloudmersive-convert-api-client/models/insert_docx_insert_paragraph_response.rb +196 -0
  422. data/lib/cloudmersive-convert-api-client/models/insert_docx_table_row_request.rb +241 -0
  423. data/lib/cloudmersive-convert-api-client/models/insert_docx_table_row_response.rb +196 -0
  424. data/lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb +241 -0
  425. data/lib/cloudmersive-convert-api-client/models/insert_docx_tables_response.rb +196 -0
  426. data/lib/cloudmersive-convert-api-client/models/insert_xlsx_worksheet_request.rb +221 -0
  427. data/lib/cloudmersive-convert-api-client/models/insert_xlsx_worksheet_response.rb +196 -0
  428. data/lib/cloudmersive-convert-api-client/models/keynote_to_jpg_result.rb +198 -0
  429. data/lib/cloudmersive-convert-api-client/models/keynote_to_png_result.rb +198 -0
  430. data/lib/cloudmersive-convert-api-client/models/msg_attachment.rb +211 -0
  431. data/lib/cloudmersive-convert-api-client/models/msg_to_html_result.rb +268 -0
  432. data/lib/cloudmersive-convert-api-client/models/msg_to_jpg_result.rb +198 -0
  433. data/lib/cloudmersive-convert-api-client/models/msg_to_png_result.rb +198 -0
  434. data/lib/cloudmersive-convert-api-client/models/multi_replace_string_request.rb +223 -0
  435. data/lib/cloudmersive-convert-api-client/models/multipage_image_format_conversion_result.rb +208 -0
  436. data/lib/cloudmersive-convert-api-client/models/odp_to_jpg_result.rb +198 -0
  437. data/lib/cloudmersive-convert-api-client/models/odp_to_png_result.rb +198 -0
  438. data/lib/cloudmersive-convert-api-client/models/ods_to_jpg_result.rb +198 -0
  439. data/lib/cloudmersive-convert-api-client/models/ods_to_png_result.rb +198 -0
  440. data/lib/cloudmersive-convert-api-client/models/odt_to_jpg_result.rb +198 -0
  441. data/lib/cloudmersive-convert-api-client/models/odt_to_png_result.rb +198 -0
  442. data/lib/cloudmersive-convert-api-client/models/page_conversion_result.rb +211 -0
  443. data/lib/cloudmersive-convert-api-client/models/pdf_annotation.rb +296 -0
  444. data/lib/cloudmersive-convert-api-client/models/pdf_document.rb +221 -0
  445. data/lib/cloudmersive-convert-api-client/models/pdf_form_field.rb +216 -0
  446. data/lib/cloudmersive-convert-api-client/models/pdf_form_fields.rb +198 -0
  447. data/lib/cloudmersive-convert-api-client/models/pdf_metadata.rb +266 -0
  448. data/lib/cloudmersive-convert-api-client/models/pdf_page_text.rb +196 -0
  449. data/lib/cloudmersive-convert-api-client/models/pdf_text_by_page_result.rb +198 -0
  450. data/lib/cloudmersive-convert-api-client/models/pdf_to_jpg_result.rb +198 -0
  451. data/lib/cloudmersive-convert-api-client/models/pdf_to_png_result.rb +198 -0
  452. data/lib/cloudmersive-convert-api-client/models/pptx_to_png_result.rb +198 -0
  453. data/lib/cloudmersive-convert-api-client/models/presentation_result.rb +221 -0
  454. data/lib/cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_request.rb +231 -0
  455. data/lib/cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_response.rb +196 -0
  456. data/lib/cloudmersive-convert-api-client/models/remove_docx_pages_request.rb +231 -0
  457. data/lib/cloudmersive-convert-api-client/models/remove_html_from_text_request.rb +186 -0
  458. data/lib/cloudmersive-convert-api-client/models/remove_html_from_text_response.rb +196 -0
  459. data/lib/cloudmersive-convert-api-client/models/remove_pptx_slides_request.rb +231 -0
  460. data/lib/cloudmersive-convert-api-client/models/remove_whitespace_from_text_request.rb +186 -0
  461. data/lib/cloudmersive-convert-api-client/models/remove_whitespace_from_text_response.rb +196 -0
  462. data/lib/cloudmersive-convert-api-client/models/remove_xlsx_worksheet_request.rb +221 -0
  463. data/lib/cloudmersive-convert-api-client/models/rename_xlsx_worksheet_request.rb +231 -0
  464. data/lib/cloudmersive-convert-api-client/models/rename_xlsx_worksheet_response.rb +196 -0
  465. data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_request.rb +241 -0
  466. data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_response.rb +196 -0
  467. data/lib/cloudmersive-convert-api-client/models/replace_string_regex_request.rb +206 -0
  468. data/lib/cloudmersive-convert-api-client/models/replace_string_regex_response.rb +196 -0
  469. data/lib/cloudmersive-convert-api-client/models/replace_string_request.rb +241 -0
  470. data/lib/cloudmersive-convert-api-client/models/replace_string_simple_request.rb +206 -0
  471. data/lib/cloudmersive-convert-api-client/models/replace_string_simple_response.rb +196 -0
  472. data/lib/cloudmersive-convert-api-client/models/rtf_to_jpg_result.rb +198 -0
  473. data/lib/cloudmersive-convert-api-client/models/rtf_to_png_result.rb +198 -0
  474. data/lib/cloudmersive-convert-api-client/models/screenshot_request.rb +216 -0
  475. data/lib/cloudmersive-convert-api-client/models/set_form_field_value.rb +216 -0
  476. data/lib/cloudmersive-convert-api-client/models/set_pdf_form_fields_request.rb +213 -0
  477. data/lib/cloudmersive-convert-api-client/models/set_pdf_metadata_request.rb +211 -0
  478. data/lib/cloudmersive-convert-api-client/models/set_xlsx_cell_by_identifier_request.rb +241 -0
  479. data/lib/cloudmersive-convert-api-client/models/set_xlsx_cell_by_identifier_response.rb +196 -0
  480. data/lib/cloudmersive-convert-api-client/models/set_xlsx_cell_request.rb +251 -0
  481. data/lib/cloudmersive-convert-api-client/models/set_xlsx_cell_response.rb +196 -0
  482. data/lib/cloudmersive-convert-api-client/models/single_replace_string.rb +206 -0
  483. data/lib/cloudmersive-convert-api-client/models/split_document_result.rb +221 -0
  484. data/lib/cloudmersive-convert-api-client/models/split_docx_document_result.rb +197 -0
  485. data/lib/cloudmersive-convert-api-client/models/split_pdf_result.rb +198 -0
  486. data/lib/cloudmersive-convert-api-client/models/split_pptx_presentation_result.rb +197 -0
  487. data/lib/cloudmersive-convert-api-client/models/split_text_document_by_lines_result.rb +207 -0
  488. data/lib/cloudmersive-convert-api-client/models/split_text_document_by_string_result.rb +207 -0
  489. data/lib/cloudmersive-convert-api-client/models/split_xlsx_worksheet_result.rb +197 -0
  490. data/lib/cloudmersive-convert-api-client/models/text_conversion_result.rb +196 -0
  491. data/lib/cloudmersive-convert-api-client/models/text_document_element.rb +196 -0
  492. data/lib/cloudmersive-convert-api-client/models/text_document_line.rb +196 -0
  493. data/lib/cloudmersive-convert-api-client/models/text_encoding_detect_response.rb +196 -0
  494. data/lib/cloudmersive-convert-api-client/models/thumbnail.rb +211 -0
  495. data/lib/cloudmersive-convert-api-client/models/update_docx_table_cell_request.rb +251 -0
  496. data/lib/cloudmersive-convert-api-client/models/update_docx_table_cell_response.rb +196 -0
  497. data/lib/cloudmersive-convert-api-client/models/update_docx_table_row_request.rb +241 -0
  498. data/lib/cloudmersive-convert-api-client/models/update_docx_table_row_response.rb +196 -0
  499. data/lib/cloudmersive-convert-api-client/models/url_to_pdf_request.rb +216 -0
  500. data/lib/cloudmersive-convert-api-client/models/url_to_text_request.rb +186 -0
  501. data/lib/cloudmersive-convert-api-client/models/url_to_text_response.rb +196 -0
  502. data/lib/cloudmersive-convert-api-client/models/viewer_response.rb +194 -0
  503. data/lib/cloudmersive-convert-api-client/models/worksheet_result.rb +231 -0
  504. data/lib/cloudmersive-convert-api-client/models/xlsx_image.rb +225 -0
  505. data/lib/cloudmersive-convert-api-client/models/xlsx_spreadsheet_cell.rb +225 -0
  506. data/lib/cloudmersive-convert-api-client/models/xlsx_spreadsheet_column.rb +196 -0
  507. data/lib/cloudmersive-convert-api-client/models/xlsx_spreadsheet_row.rb +198 -0
  508. data/lib/cloudmersive-convert-api-client/models/xlsx_to_png_result.rb +198 -0
  509. data/lib/cloudmersive-convert-api-client/models/xlsx_worksheet.rb +196 -0
  510. data/lib/cloudmersive-convert-api-client/models/xml_add_attribute_with_x_path_result.rb +206 -0
  511. data/lib/cloudmersive-convert-api-client/models/xml_add_child_with_x_path_result.rb +206 -0
  512. data/lib/cloudmersive-convert-api-client/models/xml_filter_with_x_path_result.rb +208 -0
  513. data/lib/cloudmersive-convert-api-client/models/xml_query_with_x_query_multi_result.rb +206 -0
  514. data/lib/cloudmersive-convert-api-client/models/xml_query_with_x_query_result.rb +206 -0
  515. data/lib/cloudmersive-convert-api-client/models/xml_remove_all_children_with_x_path_result.rb +206 -0
  516. data/lib/cloudmersive-convert-api-client/models/xml_remove_with_x_path_result.rb +218 -0
  517. data/lib/cloudmersive-convert-api-client/models/xml_replace_with_x_path_result.rb +206 -0
  518. data/lib/cloudmersive-convert-api-client/models/xml_set_value_with_x_path_result.rb +206 -0
  519. data/lib/cloudmersive-convert-api-client/models/zip_directory.rb +210 -0
  520. data/lib/cloudmersive-convert-api-client/models/zip_encryption_advanced_request.rb +221 -0
  521. data/lib/cloudmersive-convert-api-client/models/zip_extract_response.rb +210 -0
  522. data/lib/cloudmersive-convert-api-client/models/zip_file.rb +211 -0
  523. data/lib/cloudmersive-convert-api-client/version.rb +15 -0
  524. data/spec/api/compare_document_api_spec.rb +48 -0
  525. data/spec/api/convert_data_api_spec.rb +240 -0
  526. data/spec/api/convert_document_api_spec.rb +998 -0
  527. data/spec/api/convert_image_api_spec.rb +88 -0
  528. data/spec/api/convert_template_api_spec.rb +60 -0
  529. data/spec/api/convert_web_api_spec.rb +131 -0
  530. data/spec/api/edit_document_api_spec.rb +695 -0
  531. data/spec/api/edit_html_api_spec.rb +96 -0
  532. data/spec/api/edit_pdf_api_spec.rb +282 -0
  533. data/spec/api/edit_text_api_spec.rb +192 -0
  534. data/spec/api/merge_document_api_spec.rb +239 -0
  535. data/spec/api/split_document_api_spec.rb +113 -0
  536. data/spec/api/transform_document_api_spec.rb +67 -0
  537. data/spec/api/validate_document_api_spec.rb +215 -0
  538. data/spec/api/viewer_tools_api_spec.rb +47 -0
  539. data/spec/api/zip_archive_api_spec.rb +105 -0
  540. data/spec/api_client_spec.rb +243 -0
  541. data/spec/configuration_spec.rb +42 -0
  542. data/spec/models/add_pdf_annotation_request_spec.rb +47 -0
  543. data/spec/models/alternate_file_format_candidate_spec.rb +53 -0
  544. data/spec/models/append_xlsx_row_request_spec.rb +59 -0
  545. data/spec/models/append_xlsx_row_response_spec.rb +47 -0
  546. data/spec/models/autodetect_document_validation_result_spec.rb +65 -0
  547. data/spec/models/autodetect_get_info_result_spec.rb +77 -0
  548. data/spec/models/autodetect_to_jpg_result_spec.rb +47 -0
  549. data/spec/models/autodetect_to_png_result_spec.rb +47 -0
  550. data/spec/models/autodetect_to_thumbnails_result_spec.rb +47 -0
  551. data/spec/models/base64_decode_request_spec.rb +41 -0
  552. data/spec/models/base64_decode_response_spec.rb +47 -0
  553. data/spec/models/base64_detect_request_spec.rb +41 -0
  554. data/spec/models/base64_detect_response_spec.rb +47 -0
  555. data/spec/models/base64_encode_request_spec.rb +41 -0
  556. data/spec/models/base64_encode_response_spec.rb +47 -0
  557. data/spec/models/change_line_ending_response_spec.rb +47 -0
  558. data/spec/models/clear_xlsx_cell_request_spec.rb +65 -0
  559. data/spec/models/clear_xlsx_cell_response_spec.rb +47 -0
  560. data/spec/models/clear_xlsx_row_request_spec.rb +59 -0
  561. data/spec/models/clear_xlsx_row_response_spec.rb +47 -0
  562. data/spec/models/converted_jpg_page_spec.rb +47 -0
  563. data/spec/models/converted_png_page_spec.rb +47 -0
  564. data/spec/models/create_blank_docx_request_spec.rb +41 -0
  565. data/spec/models/create_blank_docx_response_spec.rb +47 -0
  566. data/spec/models/create_blank_spreadsheet_request_spec.rb +41 -0
  567. data/spec/models/create_blank_spreadsheet_response_spec.rb +47 -0
  568. data/spec/models/create_spreadsheet_from_data_request_spec.rb +47 -0
  569. data/spec/models/create_spreadsheet_from_data_response_spec.rb +47 -0
  570. data/spec/models/create_zip_archive_request_spec.rb +47 -0
  571. data/spec/models/csv_collection_spec.rb +53 -0
  572. data/spec/models/csv_file_result_spec.rb +47 -0
  573. data/spec/models/delete_docx_table_row_range_request_spec.rb +65 -0
  574. data/spec/models/delete_docx_table_row_range_response_spec.rb +47 -0
  575. data/spec/models/delete_docx_table_row_request_spec.rb +59 -0
  576. data/spec/models/delete_docx_table_row_response_spec.rb +47 -0
  577. data/spec/models/detect_line_endings_response_spec.rb +59 -0
  578. data/spec/models/disable_shared_workbook_request_spec.rb +47 -0
  579. data/spec/models/disable_shared_workbook_response_spec.rb +47 -0
  580. data/spec/models/document_validation_error_spec.rb +59 -0
  581. data/spec/models/document_validation_result_spec.rb +65 -0
  582. data/spec/models/docx_body_spec.rb +53 -0
  583. data/spec/models/docx_cell_style_spec.rb +59 -0
  584. data/spec/models/docx_comment_spec.rb +89 -0
  585. data/spec/models/docx_footer_spec.rb +53 -0
  586. data/spec/models/docx_header_spec.rb +53 -0
  587. data/spec/models/docx_image_spec.rb +113 -0
  588. data/spec/models/docx_insert_comment_on_paragraph_request_spec.rb +59 -0
  589. data/spec/models/docx_insert_image_request_spec.rb +89 -0
  590. data/spec/models/docx_insert_image_response_spec.rb +47 -0
  591. data/spec/models/docx_page_spec.rb +47 -0
  592. data/spec/models/docx_paragraph_spec.rb +59 -0
  593. data/spec/models/docx_remove_object_request_spec.rb +53 -0
  594. data/spec/models/docx_remove_object_response_spec.rb +47 -0
  595. data/spec/models/docx_run_spec.rb +83 -0
  596. data/spec/models/docx_section_spec.rb +47 -0
  597. data/spec/models/docx_set_footer_add_page_number_request_spec.rb +53 -0
  598. data/spec/models/docx_set_footer_request_spec.rb +53 -0
  599. data/spec/models/docx_set_footer_response_spec.rb +47 -0
  600. data/spec/models/docx_set_header_request_spec.rb +53 -0
  601. data/spec/models/docx_set_header_response_spec.rb +47 -0
  602. data/spec/models/docx_style_spec.rb +77 -0
  603. data/spec/models/docx_table_cell_spec.rb +83 -0
  604. data/spec/models/docx_table_row_spec.rb +53 -0
  605. data/spec/models/docx_table_spec.rb +269 -0
  606. data/spec/models/docx_template_application_request_spec.rb +41 -0
  607. data/spec/models/docx_template_operation_spec.rb +57 -0
  608. data/spec/models/docx_text_spec.rb +53 -0
  609. data/spec/models/docx_to_jpg_result_spec.rb +47 -0
  610. data/spec/models/docx_to_png_result_spec.rb +47 -0
  611. data/spec/models/docx_top_level_comment_spec.rb +77 -0
  612. data/spec/models/eml_attachment_spec.rb +47 -0
  613. data/spec/models/eml_to_html_result_spec.rb +89 -0
  614. data/spec/models/eml_to_jpg_result_spec.rb +47 -0
  615. data/spec/models/eml_to_png_result_spec.rb +47 -0
  616. data/spec/models/enable_shared_workbook_request_spec.rb +47 -0
  617. data/spec/models/enable_shared_workbook_response_spec.rb +47 -0
  618. data/spec/models/exif_value_spec.rb +53 -0
  619. data/spec/models/find_docx_paragraph_request_spec.rb +59 -0
  620. data/spec/models/find_docx_paragraph_response_spec.rb +53 -0
  621. data/spec/models/find_regex_match_spec.rb +65 -0
  622. data/spec/models/find_string_match_spec.rb +53 -0
  623. data/spec/models/find_string_regex_request_spec.rb +53 -0
  624. data/spec/models/find_string_regex_response_spec.rb +53 -0
  625. data/spec/models/find_string_simple_request_spec.rb +47 -0
  626. data/spec/models/find_string_simple_response_spec.rb +53 -0
  627. data/spec/models/finish_editing_request_spec.rb +41 -0
  628. data/spec/models/get_docx_body_request_spec.rb +47 -0
  629. data/spec/models/get_docx_body_response_spec.rb +47 -0
  630. data/spec/models/get_docx_comments_hierarchical_response_spec.rb +53 -0
  631. data/spec/models/get_docx_comments_response_spec.rb +53 -0
  632. data/spec/models/get_docx_get_comments_hierarchical_request_spec.rb +47 -0
  633. data/spec/models/get_docx_get_comments_request_spec.rb +47 -0
  634. data/spec/models/get_docx_headers_and_footers_request_spec.rb +47 -0
  635. data/spec/models/get_docx_headers_and_footers_response_spec.rb +53 -0
  636. data/spec/models/get_docx_images_request_spec.rb +47 -0
  637. data/spec/models/get_docx_images_response_spec.rb +47 -0
  638. data/spec/models/get_docx_pages_request_spec.rb +53 -0
  639. data/spec/models/get_docx_pages_response_spec.rb +53 -0
  640. data/spec/models/get_docx_sections_request_spec.rb +47 -0
  641. data/spec/models/get_docx_sections_response_spec.rb +47 -0
  642. data/spec/models/get_docx_styles_request_spec.rb +47 -0
  643. data/spec/models/get_docx_styles_response_spec.rb +47 -0
  644. data/spec/models/get_docx_table_by_index_request_spec.rb +53 -0
  645. data/spec/models/get_docx_table_by_index_response_spec.rb +47 -0
  646. data/spec/models/get_docx_table_row_request_spec.rb +59 -0
  647. data/spec/models/get_docx_table_row_response_spec.rb +47 -0
  648. data/spec/models/get_docx_tables_request_spec.rb +47 -0
  649. data/spec/models/get_docx_tables_response_spec.rb +47 -0
  650. data/spec/models/get_file_type_icon_result_spec.rb +53 -0
  651. data/spec/models/get_image_info_result_spec.rb +137 -0
  652. data/spec/models/get_pdf_annotations_result_spec.rb +47 -0
  653. data/spec/models/get_xlsx_cell_by_identifier_request_spec.rb +59 -0
  654. data/spec/models/get_xlsx_cell_by_identifier_response_spec.rb +47 -0
  655. data/spec/models/get_xlsx_cell_request_spec.rb +65 -0
  656. data/spec/models/get_xlsx_cell_response_spec.rb +47 -0
  657. data/spec/models/get_xlsx_columns_request_spec.rb +53 -0
  658. data/spec/models/get_xlsx_columns_response_spec.rb +47 -0
  659. data/spec/models/get_xlsx_images_request_spec.rb +53 -0
  660. data/spec/models/get_xlsx_images_response_spec.rb +47 -0
  661. data/spec/models/get_xlsx_rows_and_cells_request_spec.rb +53 -0
  662. data/spec/models/get_xlsx_rows_and_cells_response_spec.rb +47 -0
  663. data/spec/models/get_xlsx_specific_row_request_spec.rb +59 -0
  664. data/spec/models/get_xlsx_specific_row_response_spec.rb +47 -0
  665. data/spec/models/get_xlsx_styles_request_spec.rb +47 -0
  666. data/spec/models/get_xlsx_styles_response_spec.rb +47 -0
  667. data/spec/models/get_xlsx_worksheets_request_spec.rb +47 -0
  668. data/spec/models/get_xlsx_worksheets_response_spec.rb +47 -0
  669. data/spec/models/html_md_result_spec.rb +47 -0
  670. data/spec/models/html_template_application_request_spec.rb +53 -0
  671. data/spec/models/html_template_application_response_spec.rb +47 -0
  672. data/spec/models/html_template_operation_spec.rb +57 -0
  673. data/spec/models/html_to_office_request_spec.rb +41 -0
  674. data/spec/models/html_to_pdf_request_spec.rb +59 -0
  675. data/spec/models/html_to_png_request_spec.rb +59 -0
  676. data/spec/models/html_to_text_request_spec.rb +41 -0
  677. data/spec/models/html_to_text_response_spec.rb +47 -0
  678. data/spec/models/insert_docx_comment_on_paragraph_response_spec.rb +47 -0
  679. data/spec/models/insert_docx_insert_paragraph_request_spec.rb +65 -0
  680. data/spec/models/insert_docx_insert_paragraph_response_spec.rb +47 -0
  681. data/spec/models/insert_docx_table_row_request_spec.rb +65 -0
  682. data/spec/models/insert_docx_table_row_response_spec.rb +47 -0
  683. data/spec/models/insert_docx_tables_request_spec.rb +65 -0
  684. data/spec/models/insert_docx_tables_response_spec.rb +47 -0
  685. data/spec/models/insert_xlsx_worksheet_request_spec.rb +53 -0
  686. data/spec/models/insert_xlsx_worksheet_response_spec.rb +47 -0
  687. data/spec/models/keynote_to_jpg_result_spec.rb +47 -0
  688. data/spec/models/keynote_to_png_result_spec.rb +47 -0
  689. data/spec/models/msg_attachment_spec.rb +47 -0
  690. data/spec/models/msg_to_html_result_spec.rb +89 -0
  691. data/spec/models/msg_to_jpg_result_spec.rb +47 -0
  692. data/spec/models/msg_to_png_result_spec.rb +47 -0
  693. data/spec/models/multi_replace_string_request_spec.rb +53 -0
  694. data/spec/models/multipage_image_format_conversion_result_spec.rb +53 -0
  695. data/spec/models/odp_to_jpg_result_spec.rb +47 -0
  696. data/spec/models/odp_to_png_result_spec.rb +47 -0
  697. data/spec/models/ods_to_jpg_result_spec.rb +47 -0
  698. data/spec/models/ods_to_png_result_spec.rb +47 -0
  699. data/spec/models/odt_to_jpg_result_spec.rb +47 -0
  700. data/spec/models/odt_to_png_result_spec.rb +47 -0
  701. data/spec/models/page_conversion_result_spec.rb +47 -0
  702. data/spec/models/pdf_annotation_spec.rb +107 -0
  703. data/spec/models/pdf_document_spec.rb +53 -0
  704. data/spec/models/pdf_form_field_spec.rb +59 -0
  705. data/spec/models/pdf_form_fields_spec.rb +47 -0
  706. data/spec/models/pdf_metadata_spec.rb +89 -0
  707. data/spec/models/pdf_page_text_spec.rb +47 -0
  708. data/spec/models/pdf_text_by_page_result_spec.rb +47 -0
  709. data/spec/models/pdf_to_jpg_result_spec.rb +47 -0
  710. data/spec/models/pdf_to_png_result_spec.rb +47 -0
  711. data/spec/models/pptx_to_png_result_spec.rb +47 -0
  712. data/spec/models/presentation_result_spec.rb +53 -0
  713. data/spec/models/remove_docx_headers_and_footers_request_spec.rb +59 -0
  714. data/spec/models/remove_docx_headers_and_footers_response_spec.rb +47 -0
  715. data/spec/models/remove_docx_pages_request_spec.rb +59 -0
  716. data/spec/models/remove_html_from_text_request_spec.rb +41 -0
  717. data/spec/models/remove_html_from_text_response_spec.rb +47 -0
  718. data/spec/models/remove_pptx_slides_request_spec.rb +59 -0
  719. data/spec/models/remove_whitespace_from_text_request_spec.rb +41 -0
  720. data/spec/models/remove_whitespace_from_text_response_spec.rb +47 -0
  721. data/spec/models/remove_xlsx_worksheet_request_spec.rb +53 -0
  722. data/spec/models/rename_xlsx_worksheet_request_spec.rb +59 -0
  723. data/spec/models/rename_xlsx_worksheet_response_spec.rb +47 -0
  724. data/spec/models/replace_docx_paragraph_request_spec.rb +65 -0
  725. data/spec/models/replace_docx_paragraph_response_spec.rb +47 -0
  726. data/spec/models/replace_string_regex_request_spec.rb +53 -0
  727. data/spec/models/replace_string_regex_response_spec.rb +47 -0
  728. data/spec/models/replace_string_request_spec.rb +65 -0
  729. data/spec/models/replace_string_simple_request_spec.rb +53 -0
  730. data/spec/models/replace_string_simple_response_spec.rb +47 -0
  731. data/spec/models/rtf_to_jpg_result_spec.rb +47 -0
  732. data/spec/models/rtf_to_png_result_spec.rb +47 -0
  733. data/spec/models/screenshot_request_spec.rb +59 -0
  734. data/spec/models/set_form_field_value_spec.rb +59 -0
  735. data/spec/models/set_pdf_form_fields_request_spec.rb +47 -0
  736. data/spec/models/set_pdf_metadata_request_spec.rb +47 -0
  737. data/spec/models/set_xlsx_cell_by_identifier_request_spec.rb +65 -0
  738. data/spec/models/set_xlsx_cell_by_identifier_response_spec.rb +47 -0
  739. data/spec/models/set_xlsx_cell_request_spec.rb +71 -0
  740. data/spec/models/set_xlsx_cell_response_spec.rb +47 -0
  741. data/spec/models/single_replace_string_spec.rb +53 -0
  742. data/spec/models/split_document_result_spec.rb +53 -0
  743. data/spec/models/split_docx_document_result_spec.rb +47 -0
  744. data/spec/models/split_pdf_result_spec.rb +47 -0
  745. data/spec/models/split_pptx_presentation_result_spec.rb +47 -0
  746. data/spec/models/split_text_document_by_lines_result_spec.rb +53 -0
  747. data/spec/models/split_text_document_by_string_result_spec.rb +53 -0
  748. data/spec/models/split_xlsx_worksheet_result_spec.rb +47 -0
  749. data/spec/models/text_conversion_result_spec.rb +47 -0
  750. data/spec/models/text_document_element_spec.rb +47 -0
  751. data/spec/models/text_document_line_spec.rb +47 -0
  752. data/spec/models/text_encoding_detect_response_spec.rb +47 -0
  753. data/spec/models/thumbnail_spec.rb +47 -0
  754. data/spec/models/update_docx_table_cell_request_spec.rb +71 -0
  755. data/spec/models/update_docx_table_cell_response_spec.rb +47 -0
  756. data/spec/models/update_docx_table_row_request_spec.rb +65 -0
  757. data/spec/models/update_docx_table_row_response_spec.rb +47 -0
  758. data/spec/models/url_to_pdf_request_spec.rb +59 -0
  759. data/spec/models/url_to_text_request_spec.rb +41 -0
  760. data/spec/models/url_to_text_response_spec.rb +47 -0
  761. data/spec/models/viewer_response_spec.rb +47 -0
  762. data/spec/models/worksheet_result_spec.rb +59 -0
  763. data/spec/models/xlsx_image_spec.rb +65 -0
  764. data/spec/models/xlsx_spreadsheet_cell_spec.rb +65 -0
  765. data/spec/models/xlsx_spreadsheet_column_spec.rb +47 -0
  766. data/spec/models/xlsx_spreadsheet_row_spec.rb +47 -0
  767. data/spec/models/xlsx_to_png_result_spec.rb +47 -0
  768. data/spec/models/xlsx_worksheet_spec.rb +47 -0
  769. data/spec/models/xml_add_attribute_with_x_path_result_spec.rb +53 -0
  770. data/spec/models/xml_add_child_with_x_path_result_spec.rb +53 -0
  771. data/spec/models/xml_filter_with_x_path_result_spec.rb +53 -0
  772. data/spec/models/xml_query_with_x_query_multi_result_spec.rb +53 -0
  773. data/spec/models/xml_query_with_x_query_result_spec.rb +53 -0
  774. data/spec/models/xml_remove_all_children_with_x_path_result_spec.rb +53 -0
  775. data/spec/models/xml_remove_with_x_path_result_spec.rb +59 -0
  776. data/spec/models/xml_replace_with_x_path_result_spec.rb +53 -0
  777. data/spec/models/xml_set_value_with_x_path_result_spec.rb +53 -0
  778. data/spec/models/zip_directory_spec.rb +53 -0
  779. data/spec/models/zip_encryption_advanced_request_spec.rb +53 -0
  780. data/spec/models/zip_extract_response_spec.rb +53 -0
  781. data/spec/models/zip_file_spec.rb +47 -0
  782. data/spec/spec_helper.rb +111 -0
  783. metadata +785 -4
@@ -0,0 +1,4344 @@
1
+ # CloudmersiveConvertApiClient::ConvertDocumentApi
2
+
3
+ All URIs are relative to *https://api.cloudmersive.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**convert_document_autodetect_get_info**](ConvertDocumentApi.md#convert_document_autodetect_get_info) | **POST** /convert/autodetect/get-info | Get document type information
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
+ [**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_png_array**](ConvertDocumentApi.md#convert_document_autodetect_to_png_array) | **POST** /convert/autodetect/to/png | Convert Document to PNG array
11
+ [**convert_document_autodetect_to_thumbnail**](ConvertDocumentApi.md#convert_document_autodetect_to_thumbnail) | **POST** /convert/autodetect/to/thumbnail | Convert File to Thumbnail Image
12
+ [**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
13
+ [**convert_document_autodetect_to_txt**](ConvertDocumentApi.md#convert_document_autodetect_to_txt) | **POST** /convert/autodetect/to/txt | Convert Document to Text (txt)
14
+ [**convert_document_csv_multi_to_xlsx**](ConvertDocumentApi.md#convert_document_csv_multi_to_xlsx) | **POST** /convert/csv/multi/to/xlsx | Convert Multiple CSV Files into a Single XLSX Spreadsheet
15
+ [**convert_document_csv_to_html**](ConvertDocumentApi.md#convert_document_csv_to_html) | **POST** /convert/csv/to/html | Convert CSV to HTML document
16
+ [**convert_document_csv_to_pdf**](ConvertDocumentApi.md#convert_document_csv_to_pdf) | **POST** /convert/csv/to/pdf | Convert CSV to PDF document
17
+ [**convert_document_csv_to_xlsx**](ConvertDocumentApi.md#convert_document_csv_to_xlsx) | **POST** /convert/csv/to/xlsx | Convert CSV to Excel XLSX Spreadsheet
18
+ [**convert_document_doc_to_docx**](ConvertDocumentApi.md#convert_document_doc_to_docx) | **POST** /convert/doc/to/docx | Convert Word DOC (97-03) Document to DOCX
19
+ [**convert_document_doc_to_pdf**](ConvertDocumentApi.md#convert_document_doc_to_pdf) | **POST** /convert/doc/to/pdf | Convert Word DOC (97-03) Document to PDF
20
+ [**convert_document_doc_to_txt**](ConvertDocumentApi.md#convert_document_doc_to_txt) | **POST** /convert/doc/to/txt | Convert Word DOC (97-03) Document to Text (txt)
21
+ [**convert_document_docx_to_html**](ConvertDocumentApi.md#convert_document_docx_to_html) | **POST** /convert/docx/to/html | Convert Word DOCX Document to HTML Document
22
+ [**convert_document_docx_to_jpg**](ConvertDocumentApi.md#convert_document_docx_to_jpg) | **POST** /convert/docx/to/jpg | Convert Word DOCX Document to JPG/JPEG image array
23
+ [**convert_document_docx_to_pdf**](ConvertDocumentApi.md#convert_document_docx_to_pdf) | **POST** /convert/docx/to/pdf | Convert Word DOCX Document to PDF
24
+ [**convert_document_docx_to_png**](ConvertDocumentApi.md#convert_document_docx_to_png) | **POST** /convert/docx/to/png | Convert Word DOCX Document to PNG image array
25
+ [**convert_document_docx_to_rtf**](ConvertDocumentApi.md#convert_document_docx_to_rtf) | **POST** /convert/docx/to/rtf | Convert Word DOCX Document to RTF
26
+ [**convert_document_docx_to_txt**](ConvertDocumentApi.md#convert_document_docx_to_txt) | **POST** /convert/docx/to/txt | Convert Word DOCX Document to Text (txt)
27
+ [**convert_document_eml_to_html**](ConvertDocumentApi.md#convert_document_eml_to_html) | **POST** /convert/eml/to/html | Convert Email EML file to HTML string
28
+ [**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
29
+ [**convert_document_eml_to_pdf**](ConvertDocumentApi.md#convert_document_eml_to_pdf) | **POST** /convert/eml/to/pdf | Convert Email EML file to PDF document
30
+ [**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
31
+ [**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
32
+ [**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
33
+ [**convert_document_html_to_pdf**](ConvertDocumentApi.md#convert_document_html_to_pdf) | **POST** /convert/html/to/pdf | Convert HTML document file to PDF Document
34
+ [**convert_document_html_to_png**](ConvertDocumentApi.md#convert_document_html_to_png) | **POST** /convert/html/to/png | Convert HTML document file to PNG image array
35
+ [**convert_document_html_to_txt**](ConvertDocumentApi.md#convert_document_html_to_txt) | **POST** /convert/html/to/txt | HTML Document file to Text (txt)
36
+ [**convert_document_keynote_to_jpg**](ConvertDocumentApi.md#convert_document_keynote_to_jpg) | **POST** /convert/key/to/jpg | Convert Keynote Presentation (KEY) to JPG/JPEG image array
37
+ [**convert_document_keynote_to_pdf**](ConvertDocumentApi.md#convert_document_keynote_to_pdf) | **POST** /convert/key/to/pdf | Convert Keynote Presentation (KEY) to PDF
38
+ [**convert_document_keynote_to_png**](ConvertDocumentApi.md#convert_document_keynote_to_png) | **POST** /convert/key/to/png | Convert Keynote Presentation (KEY) to PNG image array
39
+ [**convert_document_keynote_to_pptx**](ConvertDocumentApi.md#convert_document_keynote_to_pptx) | **POST** /convert/key/to/pptx | Convert Keynote Presentation (KEY) to PPTX
40
+ [**convert_document_msg_to_html**](ConvertDocumentApi.md#convert_document_msg_to_html) | **POST** /convert/msg/to/html | Convert Email MSG file to HTML string
41
+ [**convert_document_msg_to_jpg**](ConvertDocumentApi.md#convert_document_msg_to_jpg) | **POST** /convert/msg/to/jpg | Convert Email MSG file to JPG/JPEG image array
42
+ [**convert_document_msg_to_pdf**](ConvertDocumentApi.md#convert_document_msg_to_pdf) | **POST** /convert/msg/to/pdf | Convert Email MSG file to PDF document
43
+ [**convert_document_msg_to_png**](ConvertDocumentApi.md#convert_document_msg_to_png) | **POST** /convert/msg/to/png | Convert Email MSG file to PNG image array
44
+ [**convert_document_odp_to_jpg**](ConvertDocumentApi.md#convert_document_odp_to_jpg) | **POST** /convert/odp/to/jpg | Convert ODP Presentation to JPG/JPEG image array
45
+ [**convert_document_odp_to_pdf**](ConvertDocumentApi.md#convert_document_odp_to_pdf) | **POST** /convert/odp/to/pdf | Convert ODP Presentation to PDF
46
+ [**convert_document_odp_to_png**](ConvertDocumentApi.md#convert_document_odp_to_png) | **POST** /convert/odp/to/png | Convert ODP Presentation to PNG image array
47
+ [**convert_document_odp_to_pptx**](ConvertDocumentApi.md#convert_document_odp_to_pptx) | **POST** /convert/odp/to/pptx | Convert ODP Presentation to PPTX
48
+ [**convert_document_ods_to_jpg**](ConvertDocumentApi.md#convert_document_ods_to_jpg) | **POST** /convert/ods/to/jpg | Convert ODS Spreadsheet to JPG/JPEG image array
49
+ [**convert_document_ods_to_pdf**](ConvertDocumentApi.md#convert_document_ods_to_pdf) | **POST** /convert/ods/to/pdf | Convert ODS Spreadsheet to PDF
50
+ [**convert_document_ods_to_png**](ConvertDocumentApi.md#convert_document_ods_to_png) | **POST** /convert/ods/to/png | Convert ODS Spreadsheet to PNG image array
51
+ [**convert_document_ods_to_xlsx**](ConvertDocumentApi.md#convert_document_ods_to_xlsx) | **POST** /convert/ods/to/xlsx | Convert ODS Spreadsheet to XLSX
52
+ [**convert_document_odt_to_docx**](ConvertDocumentApi.md#convert_document_odt_to_docx) | **POST** /convert/odt/to/docx | Convert ODT Text File to Word DOCX
53
+ [**convert_document_odt_to_jpg**](ConvertDocumentApi.md#convert_document_odt_to_jpg) | **POST** /convert/odt/to/jpg | Convert ODT Text File to JPG/JPEG image array
54
+ [**convert_document_odt_to_pdf**](ConvertDocumentApi.md#convert_document_odt_to_pdf) | **POST** /convert/odt/to/pdf | Convert ODT Text File to PDF
55
+ [**convert_document_odt_to_png**](ConvertDocumentApi.md#convert_document_odt_to_png) | **POST** /convert/odt/to/png | Convert ODT Text File to PNG image array
56
+ [**convert_document_pdf_to_docx**](ConvertDocumentApi.md#convert_document_pdf_to_docx) | **POST** /convert/pdf/to/docx | Convert PDF to Word DOCX Document
57
+ [**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
58
+ [**convert_document_pdf_to_jpg**](ConvertDocumentApi.md#convert_document_pdf_to_jpg) | **POST** /convert/pdf/to/jpg | Convert PDF to JPG/JPEG image array
59
+ [**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
60
+ [**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
61
+ [**convert_document_pdf_to_pptx**](ConvertDocumentApi.md#convert_document_pdf_to_pptx) | **POST** /convert/pdf/to/pptx | Convert PDF to PowerPoint PPTX Presentation
62
+ [**convert_document_pdf_to_txt**](ConvertDocumentApi.md#convert_document_pdf_to_txt) | **POST** /convert/pdf/to/txt | Convert PDF Document to Text (txt)
63
+ [**convert_document_png_array_to_pdf**](ConvertDocumentApi.md#convert_document_png_array_to_pdf) | **POST** /convert/png/to/pdf | Convert PNG Array to PDF
64
+ [**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
65
+ [**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
66
+ [**convert_document_pptx_to_pdf**](ConvertDocumentApi.md#convert_document_pptx_to_pdf) | **POST** /convert/pptx/to/pdf | Convert PowerPoint PPTX Presentation to PDF
67
+ [**convert_document_pptx_to_png**](ConvertDocumentApi.md#convert_document_pptx_to_png) | **POST** /convert/pptx/to/png | Convert PowerPoint PPTX to PNG image array
68
+ [**convert_document_pptx_to_txt**](ConvertDocumentApi.md#convert_document_pptx_to_txt) | **POST** /convert/pptx/to/txt | Convert PowerPoint PPTX Presentation to Text (txt)
69
+ [**convert_document_rtf_to_docx**](ConvertDocumentApi.md#convert_document_rtf_to_docx) | **POST** /convert/rtf/to/docx | Convert Rich Text Format RTF to DOCX Document
70
+ [**convert_document_rtf_to_html**](ConvertDocumentApi.md#convert_document_rtf_to_html) | **POST** /convert/rtf/to/html | Convert Rich Text Format RTF to HTML Document
71
+ [**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
72
+ [**convert_document_rtf_to_pdf**](ConvertDocumentApi.md#convert_document_rtf_to_pdf) | **POST** /convert/rtf/to/pdf | Convert Rich Text Format RTF to PDF
73
+ [**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
74
+ [**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
75
+ [**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
76
+ [**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
77
+ [**convert_document_xlsx_to_csv**](ConvertDocumentApi.md#convert_document_xlsx_to_csv) | **POST** /convert/xlsx/to/csv | Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
78
+ [**convert_document_xlsx_to_csv_multi**](ConvertDocumentApi.md#convert_document_xlsx_to_csv_multi) | **POST** /convert/xlsx/to/csv/multi | Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
79
+ [**convert_document_xlsx_to_html**](ConvertDocumentApi.md#convert_document_xlsx_to_html) | **POST** /convert/xlsx/to/html | Convert Excel XLSX Spreadsheet to HTML Document
80
+ [**convert_document_xlsx_to_pdf**](ConvertDocumentApi.md#convert_document_xlsx_to_pdf) | **POST** /convert/xlsx/to/pdf | Convert Excel XLSX Spreadsheet to PDF
81
+ [**convert_document_xlsx_to_png**](ConvertDocumentApi.md#convert_document_xlsx_to_png) | **POST** /convert/xlsx/to/png | Convert Excel XLSX spreadsheet to PNG image array
82
+ [**convert_document_xlsx_to_txt**](ConvertDocumentApi.md#convert_document_xlsx_to_txt) | **POST** /convert/xlsx/to/txt | Convert Excel XLSX Spreadsheet to Text (txt)
83
+
84
+
85
+ # **convert_document_autodetect_get_info**
86
+ > AutodetectGetInfoResult convert_document_autodetect_get_info(input_file)
87
+
88
+ Get document type information
89
+
90
+ Auto-detects a document's type information; does not require file extension. Analyzes file contents to confirm file type. Even if no file extension is present, the auto-detect system will reliably analyze the contents of the file and identify its file type. Supports over 100 image file formats, Office document file formats, PDF, and more.
91
+
92
+ ### Example
93
+ ```ruby
94
+ # load the gem
95
+ require 'cloudmersive-convert-api-client'
96
+ # setup authorization
97
+ CloudmersiveConvertApiClient.configure do |config|
98
+ # Configure API key authorization: Apikey
99
+ config.api_key['Apikey'] = 'YOUR API KEY'
100
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
101
+ #config.api_key_prefix['Apikey'] = 'Bearer'
102
+ end
103
+
104
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
105
+
106
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
107
+
108
+
109
+ begin
110
+ #Get document type information
111
+ result = api_instance.convert_document_autodetect_get_info(input_file)
112
+ p result
113
+ rescue CloudmersiveConvertApiClient::ApiError => e
114
+ puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_get_info: #{e}"
115
+ end
116
+ ```
117
+
118
+ ### Parameters
119
+
120
+ Name | Type | Description | Notes
121
+ ------------- | ------------- | ------------- | -------------
122
+ **input_file** | **File**| Input file to perform the operation on. |
123
+
124
+ ### Return type
125
+
126
+ [**AutodetectGetInfoResult**](AutodetectGetInfoResult.md)
127
+
128
+ ### Authorization
129
+
130
+ [Apikey](../README.md#Apikey)
131
+
132
+ ### HTTP request headers
133
+
134
+ - **Content-Type**: multipart/form-data
135
+ - **Accept**: application/json, text/json, application/xml, text/xml
136
+
137
+
138
+
139
+ # **convert_document_autodetect_to_jpg**
140
+ > AutodetectToJpgResult convert_document_autodetect_to_jpg(input_file, opts)
141
+
142
+ Convert Document to JPG/JPEG image array
143
+
144
+ Automatically detect file type and convert it to an array of JPG/JPEG Images. 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. Customize image quality using quality header.
145
+
146
+ ### Example
147
+ ```ruby
148
+ # load the gem
149
+ require 'cloudmersive-convert-api-client'
150
+ # setup authorization
151
+ CloudmersiveConvertApiClient.configure do |config|
152
+ # Configure API key authorization: Apikey
153
+ config.api_key['Apikey'] = 'YOUR API KEY'
154
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
155
+ #config.api_key_prefix['Apikey'] = 'Bearer'
156
+ end
157
+
158
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
159
+
160
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
161
+
162
+ opts = {
163
+ quality: 56 # Integer | Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
164
+ }
165
+
166
+ begin
167
+ #Convert Document to JPG/JPEG image array
168
+ result = api_instance.convert_document_autodetect_to_jpg(input_file, opts)
169
+ p result
170
+ rescue CloudmersiveConvertApiClient::ApiError => e
171
+ puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_jpg: #{e}"
172
+ end
173
+ ```
174
+
175
+ ### Parameters
176
+
177
+ Name | Type | Description | Notes
178
+ ------------- | ------------- | ------------- | -------------
179
+ **input_file** | **File**| Input file to perform the operation on. |
180
+ **quality** | **Integer**| Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75. | [optional]
181
+
182
+ ### Return type
183
+
184
+ [**AutodetectToJpgResult**](AutodetectToJpgResult.md)
185
+
186
+ ### Authorization
187
+
188
+ [Apikey](../README.md#Apikey)
189
+
190
+ ### HTTP request headers
191
+
192
+ - **Content-Type**: multipart/form-data
193
+ - **Accept**: application/json, text/json, application/xml, text/xml
194
+
195
+
196
+
197
+ # **convert_document_autodetect_to_pdf**
198
+ > String convert_document_autodetect_to_pdf(input_file)
199
+
200
+ Convert Document to PDF
201
+
202
+ 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.
203
+
204
+ ### Example
205
+ ```ruby
206
+ # load the gem
207
+ require 'cloudmersive-convert-api-client'
208
+ # setup authorization
209
+ CloudmersiveConvertApiClient.configure do |config|
210
+ # Configure API key authorization: Apikey
211
+ config.api_key['Apikey'] = 'YOUR API KEY'
212
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
213
+ #config.api_key_prefix['Apikey'] = 'Bearer'
214
+ end
215
+
216
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
217
+
218
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
219
+
220
+
221
+ begin
222
+ #Convert Document to PDF
223
+ result = api_instance.convert_document_autodetect_to_pdf(input_file)
224
+ p result
225
+ rescue CloudmersiveConvertApiClient::ApiError => e
226
+ puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_pdf: #{e}"
227
+ end
228
+ ```
229
+
230
+ ### Parameters
231
+
232
+ Name | Type | Description | Notes
233
+ ------------- | ------------- | ------------- | -------------
234
+ **input_file** | **File**| Input file to perform the operation on. |
235
+
236
+ ### Return type
237
+
238
+ **String**
239
+
240
+ ### Authorization
241
+
242
+ [Apikey](../README.md#Apikey)
243
+
244
+ ### HTTP request headers
245
+
246
+ - **Content-Type**: multipart/form-data
247
+ - **Accept**: application/octet-stream
248
+
249
+
250
+
251
+ # **convert_document_autodetect_to_png_array**
252
+ > AutodetectToPngResult convert_document_autodetect_to_png_array(input_file)
253
+
254
+ Convert Document to PNG array
255
+
256
+ 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.
257
+
258
+ ### Example
259
+ ```ruby
260
+ # load the gem
261
+ require 'cloudmersive-convert-api-client'
262
+ # setup authorization
263
+ CloudmersiveConvertApiClient.configure do |config|
264
+ # Configure API key authorization: Apikey
265
+ config.api_key['Apikey'] = 'YOUR API KEY'
266
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
267
+ #config.api_key_prefix['Apikey'] = 'Bearer'
268
+ end
269
+
270
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
271
+
272
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
273
+
274
+
275
+ begin
276
+ #Convert Document to PNG array
277
+ result = api_instance.convert_document_autodetect_to_png_array(input_file)
278
+ p result
279
+ rescue CloudmersiveConvertApiClient::ApiError => e
280
+ puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_png_array: #{e}"
281
+ end
282
+ ```
283
+
284
+ ### Parameters
285
+
286
+ Name | Type | Description | Notes
287
+ ------------- | ------------- | ------------- | -------------
288
+ **input_file** | **File**| Input file to perform the operation on. |
289
+
290
+ ### Return type
291
+
292
+ [**AutodetectToPngResult**](AutodetectToPngResult.md)
293
+
294
+ ### Authorization
295
+
296
+ [Apikey](../README.md#Apikey)
297
+
298
+ ### HTTP request headers
299
+
300
+ - **Content-Type**: multipart/form-data
301
+ - **Accept**: application/json, text/json, application/xml, text/xml
302
+
303
+
304
+
305
+ # **convert_document_autodetect_to_thumbnail**
306
+ > String convert_document_autodetect_to_thumbnail(input_file, opts)
307
+
308
+ Convert File to Thumbnail Image
309
+
310
+ Automatically detect file type and convert it to a PNG thumbnail. 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. Returns a generic PNG thumbnail for unsupported formats. Maximum thumbnail size is 2048x2048.
311
+
312
+ ### Example
313
+ ```ruby
314
+ # load the gem
315
+ require 'cloudmersive-convert-api-client'
316
+ # setup authorization
317
+ CloudmersiveConvertApiClient.configure do |config|
318
+ # Configure API key authorization: Apikey
319
+ config.api_key['Apikey'] = 'YOUR API KEY'
320
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
321
+ #config.api_key_prefix['Apikey'] = 'Bearer'
322
+ end
323
+
324
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
325
+
326
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
327
+
328
+ opts = {
329
+ max_width: 56, # Integer | Optional; Maximum width of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
330
+ max_height: 56, # Integer | Optional; Maximum height of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
331
+ extension: 'extension_example' # String | Optional; Specify the file extension of the inputFile. This will improve the response time in most cases. Also allows unsupported files without extensions to still return a corresponding generic icon.
332
+ }
333
+
334
+ begin
335
+ #Convert File to Thumbnail Image
336
+ result = api_instance.convert_document_autodetect_to_thumbnail(input_file, opts)
337
+ p result
338
+ rescue CloudmersiveConvertApiClient::ApiError => e
339
+ puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_thumbnail: #{e}"
340
+ end
341
+ ```
342
+
343
+ ### Parameters
344
+
345
+ Name | Type | Description | Notes
346
+ ------------- | ------------- | ------------- | -------------
347
+ **input_file** | **File**| Input file to perform the operation on. |
348
+ **max_width** | **Integer**| Optional; Maximum width of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128. | [optional]
349
+ **max_height** | **Integer**| Optional; Maximum height of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128. | [optional]
350
+ **extension** | **String**| Optional; Specify the file extension of the inputFile. This will improve the response time in most cases. Also allows unsupported files without extensions to still return a corresponding generic icon. | [optional]
351
+
352
+ ### Return type
353
+
354
+ **String**
355
+
356
+ ### Authorization
357
+
358
+ [Apikey](../README.md#Apikey)
359
+
360
+ ### HTTP request headers
361
+
362
+ - **Content-Type**: multipart/form-data
363
+ - **Accept**: application/octet-stream
364
+
365
+
366
+
367
+ # **convert_document_autodetect_to_thumbnails_advanced**
368
+ > AutodetectToThumbnailsResult convert_document_autodetect_to_thumbnails_advanced(input_file, opts)
369
+
370
+ Convert File to Thumbnail Image Object
371
+
372
+ Automatically detect file type and convert it to an array of PNG thumbnails, returned as an object. May specify the number of pages for multiple thumbnails; default is one thumbnail. 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. Returns a generic PNG thumbnail for unsupported formats. Maximum thumbnail size is 2048x2048.
373
+
374
+ ### Example
375
+ ```ruby
376
+ # load the gem
377
+ require 'cloudmersive-convert-api-client'
378
+ # setup authorization
379
+ CloudmersiveConvertApiClient.configure do |config|
380
+ # Configure API key authorization: Apikey
381
+ config.api_key['Apikey'] = 'YOUR API KEY'
382
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
383
+ #config.api_key_prefix['Apikey'] = 'Bearer'
384
+ end
385
+
386
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
387
+
388
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
389
+
390
+ opts = {
391
+ pages: 56, # Integer | Optional; Specify how many pages of the document will be converted to thumbnails. Default is 1 page.
392
+ max_width: 56, # Integer | Optional; Maximum width of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
393
+ max_height: 56, # Integer | Optional; Maximum height of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128.
394
+ extension: 'extension_example' # String | Optional; Specify the file extension of the inputFile. This will improve the response time in most cases. Also allows unsupported files without extensions to still return a corresponding generic icon.
395
+ }
396
+
397
+ begin
398
+ #Convert File to Thumbnail Image Object
399
+ result = api_instance.convert_document_autodetect_to_thumbnails_advanced(input_file, opts)
400
+ p result
401
+ rescue CloudmersiveConvertApiClient::ApiError => e
402
+ puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_thumbnails_advanced: #{e}"
403
+ end
404
+ ```
405
+
406
+ ### Parameters
407
+
408
+ Name | Type | Description | Notes
409
+ ------------- | ------------- | ------------- | -------------
410
+ **input_file** | **File**| Input file to perform the operation on. |
411
+ **pages** | **Integer**| Optional; Specify how many pages of the document will be converted to thumbnails. Default is 1 page. | [optional]
412
+ **max_width** | **Integer**| Optional; Maximum width of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128. | [optional]
413
+ **max_height** | **Integer**| Optional; Maximum height of the output thumbnail - final image will be as large as possible while less than or equal to this width. Default is 128. | [optional]
414
+ **extension** | **String**| Optional; Specify the file extension of the inputFile. This will improve the response time in most cases. Also allows unsupported files without extensions to still return a corresponding generic icon. | [optional]
415
+
416
+ ### Return type
417
+
418
+ [**AutodetectToThumbnailsResult**](AutodetectToThumbnailsResult.md)
419
+
420
+ ### Authorization
421
+
422
+ [Apikey](../README.md#Apikey)
423
+
424
+ ### HTTP request headers
425
+
426
+ - **Content-Type**: multipart/form-data
427
+ - **Accept**: application/json, text/json, application/xml, text/xml
428
+
429
+
430
+
431
+ # **convert_document_autodetect_to_txt**
432
+ > TextConversionResult convert_document_autodetect_to_txt(input_file, opts)
433
+
434
+ Convert Document to Text (txt)
435
+
436
+ Automatically detect file type and convert it to Text. Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files. For spreadsheets, all worksheets will be included. If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.
437
+
438
+ ### Example
439
+ ```ruby
440
+ # load the gem
441
+ require 'cloudmersive-convert-api-client'
442
+ # setup authorization
443
+ CloudmersiveConvertApiClient.configure do |config|
444
+ # Configure API key authorization: Apikey
445
+ config.api_key['Apikey'] = 'YOUR API KEY'
446
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
447
+ #config.api_key_prefix['Apikey'] = 'Bearer'
448
+ end
449
+
450
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
451
+
452
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
453
+
454
+ opts = {
455
+ text_formatting_mode: 'text_formatting_mode_example' # String | Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'.
456
+ }
457
+
458
+ begin
459
+ #Convert Document to Text (txt)
460
+ result = api_instance.convert_document_autodetect_to_txt(input_file, opts)
461
+ p result
462
+ rescue CloudmersiveConvertApiClient::ApiError => e
463
+ puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_txt: #{e}"
464
+ end
465
+ ```
466
+
467
+ ### Parameters
468
+
469
+ Name | Type | Description | Notes
470
+ ------------- | ------------- | ------------- | -------------
471
+ **input_file** | **File**| Input file to perform the operation on. |
472
+ **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'. | [optional]
473
+
474
+ ### Return type
475
+
476
+ [**TextConversionResult**](TextConversionResult.md)
477
+
478
+ ### Authorization
479
+
480
+ [Apikey](../README.md#Apikey)
481
+
482
+ ### HTTP request headers
483
+
484
+ - **Content-Type**: multipart/form-data
485
+ - **Accept**: application/json, text/json, application/xml, text/xml
486
+
487
+
488
+
489
+ # **convert_document_csv_multi_to_xlsx**
490
+ > String convert_document_csv_multi_to_xlsx(input_file1, input_file2, opts)
491
+
492
+ Convert Multiple CSV Files into a Single XLSX Spreadsheet
493
+
494
+ Convert multiple Comma-Separated Values (CSV) files into a single Excel XLSX Spreadsheet, with one worksheet corresponding to each CSV file.
495
+
496
+ ### Example
497
+ ```ruby
498
+ # load the gem
499
+ require 'cloudmersive-convert-api-client'
500
+ # setup authorization
501
+ CloudmersiveConvertApiClient.configure do |config|
502
+ # Configure API key authorization: Apikey
503
+ config.api_key['Apikey'] = 'YOUR API KEY'
504
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
505
+ #config.api_key_prefix['Apikey'] = 'Bearer'
506
+ end
507
+
508
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
509
+
510
+ input_file1 = File.new('/path/to/file.txt') # File | First input file to perform the operation on.
511
+
512
+ input_file2 = File.new('/path/to/file.txt') # File | Second input file to perform the operation on.
513
+
514
+ opts = {
515
+ input_file3: File.new('/path/to/file.txt'), # File | Third input file to perform the operation on.
516
+ input_file4: File.new('/path/to/file.txt'), # File | Fourth input file to perform the operation on.
517
+ input_file5: File.new('/path/to/file.txt'), # File | Fifth input file to perform the operation on.
518
+ input_file6: File.new('/path/to/file.txt'), # File | Sixth input file to perform the operation on.
519
+ input_file7: File.new('/path/to/file.txt'), # File | Seventh input file to perform the operation on.
520
+ input_file8: File.new('/path/to/file.txt'), # File | Eighth input file to perform the operation on.
521
+ input_file9: File.new('/path/to/file.txt'), # File | Ninth input file to perform the operation on.
522
+ input_file10: File.new('/path/to/file.txt'), # File | Tenth input file to perform the operation on.
523
+ worksheet_names: 'worksheet_names_example' # String | Optional; Specify the name of each CSV's worksheet in order, separated with commas (e.g. \"worksheet1,worksheet2,worksheet3\"). Defaults to the names of the input CSV files. Recommended when inputting the files directly, without file names.
524
+ }
525
+
526
+ begin
527
+ #Convert Multiple CSV Files into a Single XLSX Spreadsheet
528
+ result = api_instance.convert_document_csv_multi_to_xlsx(input_file1, input_file2, opts)
529
+ p result
530
+ rescue CloudmersiveConvertApiClient::ApiError => e
531
+ puts "Exception when calling ConvertDocumentApi->convert_document_csv_multi_to_xlsx: #{e}"
532
+ end
533
+ ```
534
+
535
+ ### Parameters
536
+
537
+ Name | Type | Description | Notes
538
+ ------------- | ------------- | ------------- | -------------
539
+ **input_file1** | **File**| First input file to perform the operation on. |
540
+ **input_file2** | **File**| Second input file to perform the operation on. |
541
+ **input_file3** | **File**| Third input file to perform the operation on. | [optional]
542
+ **input_file4** | **File**| Fourth input file to perform the operation on. | [optional]
543
+ **input_file5** | **File**| Fifth input file to perform the operation on. | [optional]
544
+ **input_file6** | **File**| Sixth input file to perform the operation on. | [optional]
545
+ **input_file7** | **File**| Seventh input file to perform the operation on. | [optional]
546
+ **input_file8** | **File**| Eighth input file to perform the operation on. | [optional]
547
+ **input_file9** | **File**| Ninth input file to perform the operation on. | [optional]
548
+ **input_file10** | **File**| Tenth input file to perform the operation on. | [optional]
549
+ **worksheet_names** | **String**| Optional; Specify the name of each CSV's worksheet in order, separated with commas (e.g. \"worksheet1,worksheet2,worksheet3\"). Defaults to the names of the input CSV files. Recommended when inputting the files directly, without file names. | [optional]
550
+
551
+ ### Return type
552
+
553
+ **String**
554
+
555
+ ### Authorization
556
+
557
+ [Apikey](../README.md#Apikey)
558
+
559
+ ### HTTP request headers
560
+
561
+ - **Content-Type**: multipart/form-data
562
+ - **Accept**: application/octet-stream
563
+
564
+
565
+
566
+ # **convert_document_csv_to_html**
567
+ > String convert_document_csv_to_html(input_file)
568
+
569
+ Convert CSV to HTML document
570
+
571
+ Convert Comma-Separated Values (CSV) file to HTML document.
572
+
573
+ ### Example
574
+ ```ruby
575
+ # load the gem
576
+ require 'cloudmersive-convert-api-client'
577
+ # setup authorization
578
+ CloudmersiveConvertApiClient.configure do |config|
579
+ # Configure API key authorization: Apikey
580
+ config.api_key['Apikey'] = 'YOUR API KEY'
581
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
582
+ #config.api_key_prefix['Apikey'] = 'Bearer'
583
+ end
584
+
585
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
586
+
587
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
588
+
589
+
590
+ begin
591
+ #Convert CSV to HTML document
592
+ result = api_instance.convert_document_csv_to_html(input_file)
593
+ p result
594
+ rescue CloudmersiveConvertApiClient::ApiError => e
595
+ puts "Exception when calling ConvertDocumentApi->convert_document_csv_to_html: #{e}"
596
+ end
597
+ ```
598
+
599
+ ### Parameters
600
+
601
+ Name | Type | Description | Notes
602
+ ------------- | ------------- | ------------- | -------------
603
+ **input_file** | **File**| Input file to perform the operation on. |
604
+
605
+ ### Return type
606
+
607
+ **String**
608
+
609
+ ### Authorization
610
+
611
+ [Apikey](../README.md#Apikey)
612
+
613
+ ### HTTP request headers
614
+
615
+ - **Content-Type**: multipart/form-data
616
+ - **Accept**: application/octet-stream
617
+
618
+
619
+
620
+ # **convert_document_csv_to_pdf**
621
+ > String convert_document_csv_to_pdf(input_file)
622
+
623
+ Convert CSV to PDF document
624
+
625
+ Convert Comma-Separated Values (CSV) file to PDF document.
626
+
627
+ ### Example
628
+ ```ruby
629
+ # load the gem
630
+ require 'cloudmersive-convert-api-client'
631
+ # setup authorization
632
+ CloudmersiveConvertApiClient.configure do |config|
633
+ # Configure API key authorization: Apikey
634
+ config.api_key['Apikey'] = 'YOUR API KEY'
635
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
636
+ #config.api_key_prefix['Apikey'] = 'Bearer'
637
+ end
638
+
639
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
640
+
641
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
642
+
643
+
644
+ begin
645
+ #Convert CSV to PDF document
646
+ result = api_instance.convert_document_csv_to_pdf(input_file)
647
+ p result
648
+ rescue CloudmersiveConvertApiClient::ApiError => e
649
+ puts "Exception when calling ConvertDocumentApi->convert_document_csv_to_pdf: #{e}"
650
+ end
651
+ ```
652
+
653
+ ### Parameters
654
+
655
+ Name | Type | Description | Notes
656
+ ------------- | ------------- | ------------- | -------------
657
+ **input_file** | **File**| Input file to perform the operation on. |
658
+
659
+ ### Return type
660
+
661
+ **String**
662
+
663
+ ### Authorization
664
+
665
+ [Apikey](../README.md#Apikey)
666
+
667
+ ### HTTP request headers
668
+
669
+ - **Content-Type**: multipart/form-data
670
+ - **Accept**: application/octet-stream
671
+
672
+
673
+
674
+ # **convert_document_csv_to_xlsx**
675
+ > String convert_document_csv_to_xlsx(input_file)
676
+
677
+ Convert CSV to Excel XLSX Spreadsheet
678
+
679
+ Convert CSV file to Office Excel XLSX Workbooks file format.
680
+
681
+ ### Example
682
+ ```ruby
683
+ # load the gem
684
+ require 'cloudmersive-convert-api-client'
685
+ # setup authorization
686
+ CloudmersiveConvertApiClient.configure do |config|
687
+ # Configure API key authorization: Apikey
688
+ config.api_key['Apikey'] = 'YOUR API KEY'
689
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
690
+ #config.api_key_prefix['Apikey'] = 'Bearer'
691
+ end
692
+
693
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
694
+
695
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
696
+
697
+
698
+ begin
699
+ #Convert CSV to Excel XLSX Spreadsheet
700
+ result = api_instance.convert_document_csv_to_xlsx(input_file)
701
+ p result
702
+ rescue CloudmersiveConvertApiClient::ApiError => e
703
+ puts "Exception when calling ConvertDocumentApi->convert_document_csv_to_xlsx: #{e}"
704
+ end
705
+ ```
706
+
707
+ ### Parameters
708
+
709
+ Name | Type | Description | Notes
710
+ ------------- | ------------- | ------------- | -------------
711
+ **input_file** | **File**| Input file to perform the operation on. |
712
+
713
+ ### Return type
714
+
715
+ **String**
716
+
717
+ ### Authorization
718
+
719
+ [Apikey](../README.md#Apikey)
720
+
721
+ ### HTTP request headers
722
+
723
+ - **Content-Type**: multipart/form-data
724
+ - **Accept**: application/octet-stream
725
+
726
+
727
+
728
+ # **convert_document_doc_to_docx**
729
+ > String convert_document_doc_to_docx(input_file)
730
+
731
+ Convert Word DOC (97-03) Document to DOCX
732
+
733
+ Convert/upgrade Office Word (97-2003 Format) Documents (doc) to the modern DOCX format
734
+
735
+ ### Example
736
+ ```ruby
737
+ # load the gem
738
+ require 'cloudmersive-convert-api-client'
739
+ # setup authorization
740
+ CloudmersiveConvertApiClient.configure do |config|
741
+ # Configure API key authorization: Apikey
742
+ config.api_key['Apikey'] = 'YOUR API KEY'
743
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
744
+ #config.api_key_prefix['Apikey'] = 'Bearer'
745
+ end
746
+
747
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
748
+
749
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
750
+
751
+
752
+ begin
753
+ #Convert Word DOC (97-03) Document to DOCX
754
+ result = api_instance.convert_document_doc_to_docx(input_file)
755
+ p result
756
+ rescue CloudmersiveConvertApiClient::ApiError => e
757
+ puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_docx: #{e}"
758
+ end
759
+ ```
760
+
761
+ ### Parameters
762
+
763
+ Name | Type | Description | Notes
764
+ ------------- | ------------- | ------------- | -------------
765
+ **input_file** | **File**| Input file to perform the operation on. |
766
+
767
+ ### Return type
768
+
769
+ **String**
770
+
771
+ ### Authorization
772
+
773
+ [Apikey](../README.md#Apikey)
774
+
775
+ ### HTTP request headers
776
+
777
+ - **Content-Type**: multipart/form-data
778
+ - **Accept**: application/octet-stream
779
+
780
+
781
+
782
+ # **convert_document_doc_to_pdf**
783
+ > String convert_document_doc_to_pdf(input_file)
784
+
785
+ Convert Word DOC (97-03) Document to PDF
786
+
787
+ Convert Office Word (97-2003 Format) Documents (doc) to standard PDF
788
+
789
+ ### Example
790
+ ```ruby
791
+ # load the gem
792
+ require 'cloudmersive-convert-api-client'
793
+ # setup authorization
794
+ CloudmersiveConvertApiClient.configure do |config|
795
+ # Configure API key authorization: Apikey
796
+ config.api_key['Apikey'] = 'YOUR API KEY'
797
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
798
+ #config.api_key_prefix['Apikey'] = 'Bearer'
799
+ end
800
+
801
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
802
+
803
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
804
+
805
+
806
+ begin
807
+ #Convert Word DOC (97-03) Document to PDF
808
+ result = api_instance.convert_document_doc_to_pdf(input_file)
809
+ p result
810
+ rescue CloudmersiveConvertApiClient::ApiError => e
811
+ puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_pdf: #{e}"
812
+ end
813
+ ```
814
+
815
+ ### Parameters
816
+
817
+ Name | Type | Description | Notes
818
+ ------------- | ------------- | ------------- | -------------
819
+ **input_file** | **File**| Input file to perform the operation on. |
820
+
821
+ ### Return type
822
+
823
+ **String**
824
+
825
+ ### Authorization
826
+
827
+ [Apikey](../README.md#Apikey)
828
+
829
+ ### HTTP request headers
830
+
831
+ - **Content-Type**: multipart/form-data
832
+ - **Accept**: application/octet-stream
833
+
834
+
835
+
836
+ # **convert_document_doc_to_txt**
837
+ > TextConversionResult convert_document_doc_to_txt(input_file)
838
+
839
+ Convert Word DOC (97-03) Document to Text (txt)
840
+
841
+ Convert Office Word DOC (97-03) Document (doc) to text
842
+
843
+ ### Example
844
+ ```ruby
845
+ # load the gem
846
+ require 'cloudmersive-convert-api-client'
847
+ # setup authorization
848
+ CloudmersiveConvertApiClient.configure do |config|
849
+ # Configure API key authorization: Apikey
850
+ config.api_key['Apikey'] = 'YOUR API KEY'
851
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
852
+ #config.api_key_prefix['Apikey'] = 'Bearer'
853
+ end
854
+
855
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
856
+
857
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
858
+
859
+
860
+ begin
861
+ #Convert Word DOC (97-03) Document to Text (txt)
862
+ result = api_instance.convert_document_doc_to_txt(input_file)
863
+ p result
864
+ rescue CloudmersiveConvertApiClient::ApiError => e
865
+ puts "Exception when calling ConvertDocumentApi->convert_document_doc_to_txt: #{e}"
866
+ end
867
+ ```
868
+
869
+ ### Parameters
870
+
871
+ Name | Type | Description | Notes
872
+ ------------- | ------------- | ------------- | -------------
873
+ **input_file** | **File**| Input file to perform the operation on. |
874
+
875
+ ### Return type
876
+
877
+ [**TextConversionResult**](TextConversionResult.md)
878
+
879
+ ### Authorization
880
+
881
+ [Apikey](../README.md#Apikey)
882
+
883
+ ### HTTP request headers
884
+
885
+ - **Content-Type**: multipart/form-data
886
+ - **Accept**: application/json, text/json, application/xml, text/xml
887
+
888
+
889
+
890
+ # **convert_document_docx_to_html**
891
+ > String convert_document_docx_to_html(input_file)
892
+
893
+ Convert Word DOCX Document to HTML Document
894
+
895
+ Convert Office Word Document (DOCX) to HTML Document
896
+
897
+ ### Example
898
+ ```ruby
899
+ # load the gem
900
+ require 'cloudmersive-convert-api-client'
901
+ # setup authorization
902
+ CloudmersiveConvertApiClient.configure do |config|
903
+ # Configure API key authorization: Apikey
904
+ config.api_key['Apikey'] = 'YOUR API KEY'
905
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
906
+ #config.api_key_prefix['Apikey'] = 'Bearer'
907
+ end
908
+
909
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
910
+
911
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
912
+
913
+
914
+ begin
915
+ #Convert Word DOCX Document to HTML Document
916
+ result = api_instance.convert_document_docx_to_html(input_file)
917
+ p result
918
+ rescue CloudmersiveConvertApiClient::ApiError => e
919
+ puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_html: #{e}"
920
+ end
921
+ ```
922
+
923
+ ### Parameters
924
+
925
+ Name | Type | Description | Notes
926
+ ------------- | ------------- | ------------- | -------------
927
+ **input_file** | **File**| Input file to perform the operation on. |
928
+
929
+ ### Return type
930
+
931
+ **String**
932
+
933
+ ### Authorization
934
+
935
+ [Apikey](../README.md#Apikey)
936
+
937
+ ### HTTP request headers
938
+
939
+ - **Content-Type**: multipart/form-data
940
+ - **Accept**: application/octet-stream
941
+
942
+
943
+
944
+ # **convert_document_docx_to_jpg**
945
+ > DocxToJpgResult convert_document_docx_to_jpg(input_file, opts)
946
+
947
+ Convert Word DOCX Document to JPG/JPEG image array
948
+
949
+ Converts an Office Word Document (DOCX) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
950
+
951
+ ### Example
952
+ ```ruby
953
+ # load the gem
954
+ require 'cloudmersive-convert-api-client'
955
+ # setup authorization
956
+ CloudmersiveConvertApiClient.configure do |config|
957
+ # Configure API key authorization: Apikey
958
+ config.api_key['Apikey'] = 'YOUR API KEY'
959
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
960
+ #config.api_key_prefix['Apikey'] = 'Bearer'
961
+ end
962
+
963
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
964
+
965
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
966
+
967
+ opts = {
968
+ quality: 56 # Integer | Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
969
+ }
970
+
971
+ begin
972
+ #Convert Word DOCX Document to JPG/JPEG image array
973
+ result = api_instance.convert_document_docx_to_jpg(input_file, opts)
974
+ p result
975
+ rescue CloudmersiveConvertApiClient::ApiError => e
976
+ puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_jpg: #{e}"
977
+ end
978
+ ```
979
+
980
+ ### Parameters
981
+
982
+ Name | Type | Description | Notes
983
+ ------------- | ------------- | ------------- | -------------
984
+ **input_file** | **File**| Input file to perform the operation on. |
985
+ **quality** | **Integer**| Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75. | [optional]
986
+
987
+ ### Return type
988
+
989
+ [**DocxToJpgResult**](DocxToJpgResult.md)
990
+
991
+ ### Authorization
992
+
993
+ [Apikey](../README.md#Apikey)
994
+
995
+ ### HTTP request headers
996
+
997
+ - **Content-Type**: multipart/form-data
998
+ - **Accept**: application/json, text/json, application/xml, text/xml
999
+
1000
+
1001
+
1002
+ # **convert_document_docx_to_pdf**
1003
+ > String convert_document_docx_to_pdf(input_file)
1004
+
1005
+ Convert Word DOCX Document to PDF
1006
+
1007
+ Convert Office Word Documents (docx) to standard PDF
1008
+
1009
+ ### Example
1010
+ ```ruby
1011
+ # load the gem
1012
+ require 'cloudmersive-convert-api-client'
1013
+ # setup authorization
1014
+ CloudmersiveConvertApiClient.configure do |config|
1015
+ # Configure API key authorization: Apikey
1016
+ config.api_key['Apikey'] = 'YOUR API KEY'
1017
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1018
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1019
+ end
1020
+
1021
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1022
+
1023
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1024
+
1025
+
1026
+ begin
1027
+ #Convert Word DOCX Document to PDF
1028
+ result = api_instance.convert_document_docx_to_pdf(input_file)
1029
+ p result
1030
+ rescue CloudmersiveConvertApiClient::ApiError => e
1031
+ puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_pdf: #{e}"
1032
+ end
1033
+ ```
1034
+
1035
+ ### Parameters
1036
+
1037
+ Name | Type | Description | Notes
1038
+ ------------- | ------------- | ------------- | -------------
1039
+ **input_file** | **File**| Input file to perform the operation on. |
1040
+
1041
+ ### Return type
1042
+
1043
+ **String**
1044
+
1045
+ ### Authorization
1046
+
1047
+ [Apikey](../README.md#Apikey)
1048
+
1049
+ ### HTTP request headers
1050
+
1051
+ - **Content-Type**: multipart/form-data
1052
+ - **Accept**: application/octet-stream
1053
+
1054
+
1055
+
1056
+ # **convert_document_docx_to_png**
1057
+ > DocxToPngResult convert_document_docx_to_png(input_file)
1058
+
1059
+ Convert Word DOCX Document to PNG image array
1060
+
1061
+ Converts an Office Word Document (DOCX) file to an array of PNG images, one for each page.
1062
+
1063
+ ### Example
1064
+ ```ruby
1065
+ # load the gem
1066
+ require 'cloudmersive-convert-api-client'
1067
+ # setup authorization
1068
+ CloudmersiveConvertApiClient.configure do |config|
1069
+ # Configure API key authorization: Apikey
1070
+ config.api_key['Apikey'] = 'YOUR API KEY'
1071
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1072
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1073
+ end
1074
+
1075
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1076
+
1077
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1078
+
1079
+
1080
+ begin
1081
+ #Convert Word DOCX Document to PNG image array
1082
+ result = api_instance.convert_document_docx_to_png(input_file)
1083
+ p result
1084
+ rescue CloudmersiveConvertApiClient::ApiError => e
1085
+ puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_png: #{e}"
1086
+ end
1087
+ ```
1088
+
1089
+ ### Parameters
1090
+
1091
+ Name | Type | Description | Notes
1092
+ ------------- | ------------- | ------------- | -------------
1093
+ **input_file** | **File**| Input file to perform the operation on. |
1094
+
1095
+ ### Return type
1096
+
1097
+ [**DocxToPngResult**](DocxToPngResult.md)
1098
+
1099
+ ### Authorization
1100
+
1101
+ [Apikey](../README.md#Apikey)
1102
+
1103
+ ### HTTP request headers
1104
+
1105
+ - **Content-Type**: multipart/form-data
1106
+ - **Accept**: application/json, text/json, application/xml, text/xml
1107
+
1108
+
1109
+
1110
+ # **convert_document_docx_to_rtf**
1111
+ > String convert_document_docx_to_rtf(input_file)
1112
+
1113
+ Convert Word DOCX Document to RTF
1114
+
1115
+ Convert an Office Word Document (DOCX) to Rich Text Format Document (RTF)
1116
+
1117
+ ### Example
1118
+ ```ruby
1119
+ # load the gem
1120
+ require 'cloudmersive-convert-api-client'
1121
+ # setup authorization
1122
+ CloudmersiveConvertApiClient.configure do |config|
1123
+ # Configure API key authorization: Apikey
1124
+ config.api_key['Apikey'] = 'YOUR API KEY'
1125
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1126
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1127
+ end
1128
+
1129
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1130
+
1131
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1132
+
1133
+
1134
+ begin
1135
+ #Convert Word DOCX Document to RTF
1136
+ result = api_instance.convert_document_docx_to_rtf(input_file)
1137
+ p result
1138
+ rescue CloudmersiveConvertApiClient::ApiError => e
1139
+ puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_rtf: #{e}"
1140
+ end
1141
+ ```
1142
+
1143
+ ### Parameters
1144
+
1145
+ Name | Type | Description | Notes
1146
+ ------------- | ------------- | ------------- | -------------
1147
+ **input_file** | **File**| Input file to perform the operation on. |
1148
+
1149
+ ### Return type
1150
+
1151
+ **String**
1152
+
1153
+ ### Authorization
1154
+
1155
+ [Apikey](../README.md#Apikey)
1156
+
1157
+ ### HTTP request headers
1158
+
1159
+ - **Content-Type**: multipart/form-data
1160
+ - **Accept**: application/octet-stream
1161
+
1162
+
1163
+
1164
+ # **convert_document_docx_to_txt**
1165
+ > TextConversionResult convert_document_docx_to_txt(input_file, opts)
1166
+
1167
+ Convert Word DOCX Document to Text (txt)
1168
+
1169
+ Convert Office Word Documents (docx) to text
1170
+
1171
+ ### Example
1172
+ ```ruby
1173
+ # load the gem
1174
+ require 'cloudmersive-convert-api-client'
1175
+ # setup authorization
1176
+ CloudmersiveConvertApiClient.configure do |config|
1177
+ # Configure API key authorization: Apikey
1178
+ config.api_key['Apikey'] = 'YOUR API KEY'
1179
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1180
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1181
+ end
1182
+
1183
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1184
+
1185
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1186
+
1187
+ opts = {
1188
+ text_formatting_mode: 'text_formatting_mode_example' # String | Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'minimizeWhitespace'.
1189
+ }
1190
+
1191
+ begin
1192
+ #Convert Word DOCX Document to Text (txt)
1193
+ result = api_instance.convert_document_docx_to_txt(input_file, opts)
1194
+ p result
1195
+ rescue CloudmersiveConvertApiClient::ApiError => e
1196
+ puts "Exception when calling ConvertDocumentApi->convert_document_docx_to_txt: #{e}"
1197
+ end
1198
+ ```
1199
+
1200
+ ### Parameters
1201
+
1202
+ Name | Type | Description | Notes
1203
+ ------------- | ------------- | ------------- | -------------
1204
+ **input_file** | **File**| Input file to perform the operation on. |
1205
+ **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'minimizeWhitespace'. | [optional]
1206
+
1207
+ ### Return type
1208
+
1209
+ [**TextConversionResult**](TextConversionResult.md)
1210
+
1211
+ ### Authorization
1212
+
1213
+ [Apikey](../README.md#Apikey)
1214
+
1215
+ ### HTTP request headers
1216
+
1217
+ - **Content-Type**: multipart/form-data
1218
+ - **Accept**: application/json, text/json, application/xml, text/xml
1219
+
1220
+
1221
+
1222
+ # **convert_document_eml_to_html**
1223
+ > EmlToHtmlResult convert_document_eml_to_html(input_file, opts)
1224
+
1225
+ Convert Email EML file to HTML string
1226
+
1227
+ Convert Outlook Email EML file to HTML string and attachments. Supports images if they are base 64 inline.
1228
+
1229
+ ### Example
1230
+ ```ruby
1231
+ # load the gem
1232
+ require 'cloudmersive-convert-api-client'
1233
+ # setup authorization
1234
+ CloudmersiveConvertApiClient.configure do |config|
1235
+ # Configure API key authorization: Apikey
1236
+ config.api_key['Apikey'] = 'YOUR API KEY'
1237
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1238
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1239
+ end
1240
+
1241
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1242
+
1243
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1244
+
1245
+ opts = {
1246
+ body_only: true, # BOOLEAN | Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
1247
+ include_attachments: true # BOOLEAN | Optional; If false, the response object will not include any attachment files from the input file. Default is true.
1248
+ }
1249
+
1250
+ begin
1251
+ #Convert Email EML file to HTML string
1252
+ result = api_instance.convert_document_eml_to_html(input_file, opts)
1253
+ p result
1254
+ rescue CloudmersiveConvertApiClient::ApiError => e
1255
+ puts "Exception when calling ConvertDocumentApi->convert_document_eml_to_html: #{e}"
1256
+ end
1257
+ ```
1258
+
1259
+ ### Parameters
1260
+
1261
+ Name | Type | Description | Notes
1262
+ ------------- | ------------- | ------------- | -------------
1263
+ **input_file** | **File**| Input file to perform the operation on. |
1264
+ **body_only** | **BOOLEAN**| Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false. | [optional]
1265
+ **include_attachments** | **BOOLEAN**| Optional; If false, the response object will not include any attachment files from the input file. Default is true. | [optional]
1266
+
1267
+ ### Return type
1268
+
1269
+ [**EmlToHtmlResult**](EmlToHtmlResult.md)
1270
+
1271
+ ### Authorization
1272
+
1273
+ [Apikey](../README.md#Apikey)
1274
+
1275
+ ### HTTP request headers
1276
+
1277
+ - **Content-Type**: multipart/form-data
1278
+ - **Accept**: application/json, text/json, application/xml, text/xml
1279
+
1280
+
1281
+
1282
+ # **convert_document_eml_to_jpg**
1283
+ > EmlToJpgResult convert_document_eml_to_jpg(input_file, opts)
1284
+
1285
+ Convert Email EML file to JPG/JPEG image array
1286
+
1287
+ Converts an Outlook Email File (EML) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
1288
+
1289
+ ### Example
1290
+ ```ruby
1291
+ # load the gem
1292
+ require 'cloudmersive-convert-api-client'
1293
+ # setup authorization
1294
+ CloudmersiveConvertApiClient.configure do |config|
1295
+ # Configure API key authorization: Apikey
1296
+ config.api_key['Apikey'] = 'YOUR API KEY'
1297
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1298
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1299
+ end
1300
+
1301
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1302
+
1303
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1304
+
1305
+ opts = {
1306
+ quality: 56 # Integer | Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
1307
+ }
1308
+
1309
+ begin
1310
+ #Convert Email EML file to JPG/JPEG image array
1311
+ result = api_instance.convert_document_eml_to_jpg(input_file, opts)
1312
+ p result
1313
+ rescue CloudmersiveConvertApiClient::ApiError => e
1314
+ puts "Exception when calling ConvertDocumentApi->convert_document_eml_to_jpg: #{e}"
1315
+ end
1316
+ ```
1317
+
1318
+ ### Parameters
1319
+
1320
+ Name | Type | Description | Notes
1321
+ ------------- | ------------- | ------------- | -------------
1322
+ **input_file** | **File**| Input file to perform the operation on. |
1323
+ **quality** | **Integer**| Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75. | [optional]
1324
+
1325
+ ### Return type
1326
+
1327
+ [**EmlToJpgResult**](EmlToJpgResult.md)
1328
+
1329
+ ### Authorization
1330
+
1331
+ [Apikey](../README.md#Apikey)
1332
+
1333
+ ### HTTP request headers
1334
+
1335
+ - **Content-Type**: multipart/form-data
1336
+ - **Accept**: application/json, text/json, application/xml, text/xml
1337
+
1338
+
1339
+
1340
+ # **convert_document_eml_to_pdf**
1341
+ > String convert_document_eml_to_pdf(input_file, opts)
1342
+
1343
+ Convert Email EML file to PDF document
1344
+
1345
+ Convert Outlook Email EML file to PDF document. Supports images if they are base 64 inline.
1346
+
1347
+ ### Example
1348
+ ```ruby
1349
+ # load the gem
1350
+ require 'cloudmersive-convert-api-client'
1351
+ # setup authorization
1352
+ CloudmersiveConvertApiClient.configure do |config|
1353
+ # Configure API key authorization: Apikey
1354
+ config.api_key['Apikey'] = 'YOUR API KEY'
1355
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1356
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1357
+ end
1358
+
1359
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1360
+
1361
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1362
+
1363
+ opts = {
1364
+ body_only: true # BOOLEAN | Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
1365
+ }
1366
+
1367
+ begin
1368
+ #Convert Email EML file to PDF document
1369
+ result = api_instance.convert_document_eml_to_pdf(input_file, opts)
1370
+ p result
1371
+ rescue CloudmersiveConvertApiClient::ApiError => e
1372
+ puts "Exception when calling ConvertDocumentApi->convert_document_eml_to_pdf: #{e}"
1373
+ end
1374
+ ```
1375
+
1376
+ ### Parameters
1377
+
1378
+ Name | Type | Description | Notes
1379
+ ------------- | ------------- | ------------- | -------------
1380
+ **input_file** | **File**| Input file to perform the operation on. |
1381
+ **body_only** | **BOOLEAN**| Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false. | [optional]
1382
+
1383
+ ### Return type
1384
+
1385
+ **String**
1386
+
1387
+ ### Authorization
1388
+
1389
+ [Apikey](../README.md#Apikey)
1390
+
1391
+ ### HTTP request headers
1392
+
1393
+ - **Content-Type**: multipart/form-data
1394
+ - **Accept**: application/octet-stream
1395
+
1396
+
1397
+
1398
+ # **convert_document_eml_to_png**
1399
+ > EmlToPngResult convert_document_eml_to_png(input_file)
1400
+
1401
+ Convert Email EML file to PNG image array
1402
+
1403
+ Converts an Outlook Email File (EML) to an array of PNG images, one for each page.
1404
+
1405
+ ### Example
1406
+ ```ruby
1407
+ # load the gem
1408
+ require 'cloudmersive-convert-api-client'
1409
+ # setup authorization
1410
+ CloudmersiveConvertApiClient.configure do |config|
1411
+ # Configure API key authorization: Apikey
1412
+ config.api_key['Apikey'] = 'YOUR API KEY'
1413
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1414
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1415
+ end
1416
+
1417
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1418
+
1419
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1420
+
1421
+
1422
+ begin
1423
+ #Convert Email EML file to PNG image array
1424
+ result = api_instance.convert_document_eml_to_png(input_file)
1425
+ p result
1426
+ rescue CloudmersiveConvertApiClient::ApiError => e
1427
+ puts "Exception when calling ConvertDocumentApi->convert_document_eml_to_png: #{e}"
1428
+ end
1429
+ ```
1430
+
1431
+ ### Parameters
1432
+
1433
+ Name | Type | Description | Notes
1434
+ ------------- | ------------- | ------------- | -------------
1435
+ **input_file** | **File**| Input file to perform the operation on. |
1436
+
1437
+ ### Return type
1438
+
1439
+ [**EmlToPngResult**](EmlToPngResult.md)
1440
+
1441
+ ### Authorization
1442
+
1443
+ [Apikey](../README.md#Apikey)
1444
+
1445
+ ### HTTP request headers
1446
+
1447
+ - **Content-Type**: multipart/form-data
1448
+ - **Accept**: application/json, text/json, application/xml, text/xml
1449
+
1450
+
1451
+
1452
+ # **convert_document_get_file_type_icon**
1453
+ > String convert_document_get_file_type_icon(file_extension, opts)
1454
+
1455
+ Get PNG icon file for the file extension
1456
+
1457
+ 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.
1458
+
1459
+ ### Example
1460
+ ```ruby
1461
+ # load the gem
1462
+ require 'cloudmersive-convert-api-client'
1463
+ # setup authorization
1464
+ CloudmersiveConvertApiClient.configure do |config|
1465
+ # Configure API key authorization: Apikey
1466
+ config.api_key['Apikey'] = 'YOUR API KEY'
1467
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1468
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1469
+ end
1470
+
1471
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1472
+
1473
+ file_extension = 'file_extension_example' # String | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
1474
+
1475
+ opts = {
1476
+ icon_size: 56 # Integer | Optional; The desired width of the icon, preserving its aspect ratio.
1477
+ }
1478
+
1479
+ begin
1480
+ #Get PNG icon file for the file extension
1481
+ result = api_instance.convert_document_get_file_type_icon(file_extension, opts)
1482
+ p result
1483
+ rescue CloudmersiveConvertApiClient::ApiError => e
1484
+ puts "Exception when calling ConvertDocumentApi->convert_document_get_file_type_icon: #{e}"
1485
+ end
1486
+ ```
1487
+
1488
+ ### Parameters
1489
+
1490
+ Name | Type | Description | Notes
1491
+ ------------- | ------------- | ------------- | -------------
1492
+ **file_extension** | **String**| Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters. |
1493
+ **icon_size** | **Integer**| Optional; The desired width of the icon, preserving its aspect ratio. | [optional]
1494
+
1495
+ ### Return type
1496
+
1497
+ **String**
1498
+
1499
+ ### Authorization
1500
+
1501
+ [Apikey](../README.md#Apikey)
1502
+
1503
+ ### HTTP request headers
1504
+
1505
+ - **Content-Type**: Not defined
1506
+ - **Accept**: application/octet-stream
1507
+
1508
+
1509
+
1510
+ # **convert_document_get_file_type_icon_advanced**
1511
+ > GetFileTypeIconResult convert_document_get_file_type_icon_advanced(file_extension, opts)
1512
+
1513
+ Get PNG icon byte array for the file extension
1514
+
1515
+ Returns a PNG icon for the given file format extension directly as a byte array. User may specify the icon size. Supports over 100 file formats, with a generic icon for unsupported formats.
1516
+
1517
+ ### Example
1518
+ ```ruby
1519
+ # load the gem
1520
+ require 'cloudmersive-convert-api-client'
1521
+ # setup authorization
1522
+ CloudmersiveConvertApiClient.configure do |config|
1523
+ # Configure API key authorization: Apikey
1524
+ config.api_key['Apikey'] = 'YOUR API KEY'
1525
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1526
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1527
+ end
1528
+
1529
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1530
+
1531
+ file_extension = 'file_extension_example' # String | Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters.
1532
+
1533
+ opts = {
1534
+ icon_size: 56 # Integer | Optional; The desired width of the icon, preserving its aspect ratio.
1535
+ }
1536
+
1537
+ begin
1538
+ #Get PNG icon byte array for the file extension
1539
+ result = api_instance.convert_document_get_file_type_icon_advanced(file_extension, opts)
1540
+ p result
1541
+ rescue CloudmersiveConvertApiClient::ApiError => e
1542
+ puts "Exception when calling ConvertDocumentApi->convert_document_get_file_type_icon_advanced: #{e}"
1543
+ end
1544
+ ```
1545
+
1546
+ ### Parameters
1547
+
1548
+ Name | Type | Description | Notes
1549
+ ------------- | ------------- | ------------- | -------------
1550
+ **file_extension** | **String**| Required; The file extension to be used for the icon. Limited to 4 AlphaNumeric characters. |
1551
+ **icon_size** | **Integer**| Optional; The desired width of the icon, preserving its aspect ratio. | [optional]
1552
+
1553
+ ### Return type
1554
+
1555
+ [**GetFileTypeIconResult**](GetFileTypeIconResult.md)
1556
+
1557
+ ### Authorization
1558
+
1559
+ [Apikey](../README.md#Apikey)
1560
+
1561
+ ### HTTP request headers
1562
+
1563
+ - **Content-Type**: Not defined
1564
+ - **Accept**: application/json, text/json, application/xml, text/xml
1565
+
1566
+
1567
+
1568
+ # **convert_document_html_to_pdf**
1569
+ > String convert_document_html_to_pdf(input_file, opts)
1570
+
1571
+ Convert HTML document file to PDF Document
1572
+
1573
+ Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to PDF. To use external files such as images, use an absolute URL to the file.
1574
+
1575
+ ### Example
1576
+ ```ruby
1577
+ # load the gem
1578
+ require 'cloudmersive-convert-api-client'
1579
+ # setup authorization
1580
+ CloudmersiveConvertApiClient.configure do |config|
1581
+ # Configure API key authorization: Apikey
1582
+ config.api_key['Apikey'] = 'YOUR API KEY'
1583
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1584
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1585
+ end
1586
+
1587
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1588
+
1589
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1590
+
1591
+ opts = {
1592
+ include_background_graphics: true, # BOOLEAN | Optional: Set to true to include background graphics in the PDF, or false to not include. Default is true.
1593
+ 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%.
1594
+ }
1595
+
1596
+ begin
1597
+ #Convert HTML document file to PDF Document
1598
+ result = api_instance.convert_document_html_to_pdf(input_file, opts)
1599
+ p result
1600
+ rescue CloudmersiveConvertApiClient::ApiError => e
1601
+ puts "Exception when calling ConvertDocumentApi->convert_document_html_to_pdf: #{e}"
1602
+ end
1603
+ ```
1604
+
1605
+ ### Parameters
1606
+
1607
+ Name | Type | Description | Notes
1608
+ ------------- | ------------- | ------------- | -------------
1609
+ **input_file** | **File**| Input file to perform the operation on. |
1610
+ **include_background_graphics** | **BOOLEAN**| Optional: Set to true to include background graphics in the PDF, or false to not include. Default is true. | [optional]
1611
+ **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]
1612
+
1613
+ ### Return type
1614
+
1615
+ **String**
1616
+
1617
+ ### Authorization
1618
+
1619
+ [Apikey](../README.md#Apikey)
1620
+
1621
+ ### HTTP request headers
1622
+
1623
+ - **Content-Type**: multipart/form-data
1624
+ - **Accept**: application/octet-stream
1625
+
1626
+
1627
+
1628
+ # **convert_document_html_to_png**
1629
+ > PdfToPngResult convert_document_html_to_png(input_file)
1630
+
1631
+ Convert HTML document file to PNG image array
1632
+
1633
+ Convert standard HTML, with full support for CSS, JavaScript, Images, and other complex behavior to an array of PNG images, one for each page. To use external files in your HTML such as images, use an absolute URL to the file.
1634
+
1635
+ ### Example
1636
+ ```ruby
1637
+ # load the gem
1638
+ require 'cloudmersive-convert-api-client'
1639
+ # setup authorization
1640
+ CloudmersiveConvertApiClient.configure do |config|
1641
+ # Configure API key authorization: Apikey
1642
+ config.api_key['Apikey'] = 'YOUR API KEY'
1643
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1644
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1645
+ end
1646
+
1647
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1648
+
1649
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1650
+
1651
+
1652
+ begin
1653
+ #Convert HTML document file to PNG image array
1654
+ result = api_instance.convert_document_html_to_png(input_file)
1655
+ p result
1656
+ rescue CloudmersiveConvertApiClient::ApiError => e
1657
+ puts "Exception when calling ConvertDocumentApi->convert_document_html_to_png: #{e}"
1658
+ end
1659
+ ```
1660
+
1661
+ ### Parameters
1662
+
1663
+ Name | Type | Description | Notes
1664
+ ------------- | ------------- | ------------- | -------------
1665
+ **input_file** | **File**| Input file to perform the operation on. |
1666
+
1667
+ ### Return type
1668
+
1669
+ [**PdfToPngResult**](PdfToPngResult.md)
1670
+
1671
+ ### Authorization
1672
+
1673
+ [Apikey](../README.md#Apikey)
1674
+
1675
+ ### HTTP request headers
1676
+
1677
+ - **Content-Type**: multipart/form-data
1678
+ - **Accept**: application/json, text/json, application/xml, text/xml
1679
+
1680
+
1681
+
1682
+ # **convert_document_html_to_txt**
1683
+ > TextConversionResult convert_document_html_to_txt(input_file)
1684
+
1685
+ HTML Document file to Text (txt)
1686
+
1687
+ HTML document to text
1688
+
1689
+ ### Example
1690
+ ```ruby
1691
+ # load the gem
1692
+ require 'cloudmersive-convert-api-client'
1693
+ # setup authorization
1694
+ CloudmersiveConvertApiClient.configure do |config|
1695
+ # Configure API key authorization: Apikey
1696
+ config.api_key['Apikey'] = 'YOUR API KEY'
1697
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1698
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1699
+ end
1700
+
1701
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1702
+
1703
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1704
+
1705
+
1706
+ begin
1707
+ #HTML Document file to Text (txt)
1708
+ result = api_instance.convert_document_html_to_txt(input_file)
1709
+ p result
1710
+ rescue CloudmersiveConvertApiClient::ApiError => e
1711
+ puts "Exception when calling ConvertDocumentApi->convert_document_html_to_txt: #{e}"
1712
+ end
1713
+ ```
1714
+
1715
+ ### Parameters
1716
+
1717
+ Name | Type | Description | Notes
1718
+ ------------- | ------------- | ------------- | -------------
1719
+ **input_file** | **File**| Input file to perform the operation on. |
1720
+
1721
+ ### Return type
1722
+
1723
+ [**TextConversionResult**](TextConversionResult.md)
1724
+
1725
+ ### Authorization
1726
+
1727
+ [Apikey](../README.md#Apikey)
1728
+
1729
+ ### HTTP request headers
1730
+
1731
+ - **Content-Type**: multipart/form-data
1732
+ - **Accept**: application/json, text/json, application/xml, text/xml
1733
+
1734
+
1735
+
1736
+ # **convert_document_keynote_to_jpg**
1737
+ > KeynoteToJpgResult convert_document_keynote_to_jpg(input_file, opts)
1738
+
1739
+ Convert Keynote Presentation (KEY) to JPG/JPEG image array
1740
+
1741
+ Converts a Mac Keynote Presentation (KEY) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
1742
+
1743
+ ### Example
1744
+ ```ruby
1745
+ # load the gem
1746
+ require 'cloudmersive-convert-api-client'
1747
+ # setup authorization
1748
+ CloudmersiveConvertApiClient.configure do |config|
1749
+ # Configure API key authorization: Apikey
1750
+ config.api_key['Apikey'] = 'YOUR API KEY'
1751
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1752
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1753
+ end
1754
+
1755
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1756
+
1757
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1758
+
1759
+ opts = {
1760
+ quality: 56 # Integer | Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
1761
+ }
1762
+
1763
+ begin
1764
+ #Convert Keynote Presentation (KEY) to JPG/JPEG image array
1765
+ result = api_instance.convert_document_keynote_to_jpg(input_file, opts)
1766
+ p result
1767
+ rescue CloudmersiveConvertApiClient::ApiError => e
1768
+ puts "Exception when calling ConvertDocumentApi->convert_document_keynote_to_jpg: #{e}"
1769
+ end
1770
+ ```
1771
+
1772
+ ### Parameters
1773
+
1774
+ Name | Type | Description | Notes
1775
+ ------------- | ------------- | ------------- | -------------
1776
+ **input_file** | **File**| Input file to perform the operation on. |
1777
+ **quality** | **Integer**| Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75. | [optional]
1778
+
1779
+ ### Return type
1780
+
1781
+ [**KeynoteToJpgResult**](KeynoteToJpgResult.md)
1782
+
1783
+ ### Authorization
1784
+
1785
+ [Apikey](../README.md#Apikey)
1786
+
1787
+ ### HTTP request headers
1788
+
1789
+ - **Content-Type**: multipart/form-data
1790
+ - **Accept**: application/json, text/json, application/xml, text/xml
1791
+
1792
+
1793
+
1794
+ # **convert_document_keynote_to_pdf**
1795
+ > String convert_document_keynote_to_pdf(input_file)
1796
+
1797
+ Convert Keynote Presentation (KEY) to PDF
1798
+
1799
+ Convert Mac Keynote Presentation (KEY) to standard PDF
1800
+
1801
+ ### Example
1802
+ ```ruby
1803
+ # load the gem
1804
+ require 'cloudmersive-convert-api-client'
1805
+ # setup authorization
1806
+ CloudmersiveConvertApiClient.configure do |config|
1807
+ # Configure API key authorization: Apikey
1808
+ config.api_key['Apikey'] = 'YOUR API KEY'
1809
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1810
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1811
+ end
1812
+
1813
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1814
+
1815
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1816
+
1817
+
1818
+ begin
1819
+ #Convert Keynote Presentation (KEY) to PDF
1820
+ result = api_instance.convert_document_keynote_to_pdf(input_file)
1821
+ p result
1822
+ rescue CloudmersiveConvertApiClient::ApiError => e
1823
+ puts "Exception when calling ConvertDocumentApi->convert_document_keynote_to_pdf: #{e}"
1824
+ end
1825
+ ```
1826
+
1827
+ ### Parameters
1828
+
1829
+ Name | Type | Description | Notes
1830
+ ------------- | ------------- | ------------- | -------------
1831
+ **input_file** | **File**| Input file to perform the operation on. |
1832
+
1833
+ ### Return type
1834
+
1835
+ **String**
1836
+
1837
+ ### Authorization
1838
+
1839
+ [Apikey](../README.md#Apikey)
1840
+
1841
+ ### HTTP request headers
1842
+
1843
+ - **Content-Type**: multipart/form-data
1844
+ - **Accept**: application/octet-stream
1845
+
1846
+
1847
+
1848
+ # **convert_document_keynote_to_png**
1849
+ > KeynoteToPngResult convert_document_keynote_to_png(input_file)
1850
+
1851
+ Convert Keynote Presentation (KEY) to PNG image array
1852
+
1853
+ Converts a Mac Keynote Presentation (KEY) to an array of PNG images, one for each page.
1854
+
1855
+ ### Example
1856
+ ```ruby
1857
+ # load the gem
1858
+ require 'cloudmersive-convert-api-client'
1859
+ # setup authorization
1860
+ CloudmersiveConvertApiClient.configure do |config|
1861
+ # Configure API key authorization: Apikey
1862
+ config.api_key['Apikey'] = 'YOUR API KEY'
1863
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1864
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1865
+ end
1866
+
1867
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1868
+
1869
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1870
+
1871
+
1872
+ begin
1873
+ #Convert Keynote Presentation (KEY) to PNG image array
1874
+ result = api_instance.convert_document_keynote_to_png(input_file)
1875
+ p result
1876
+ rescue CloudmersiveConvertApiClient::ApiError => e
1877
+ puts "Exception when calling ConvertDocumentApi->convert_document_keynote_to_png: #{e}"
1878
+ end
1879
+ ```
1880
+
1881
+ ### Parameters
1882
+
1883
+ Name | Type | Description | Notes
1884
+ ------------- | ------------- | ------------- | -------------
1885
+ **input_file** | **File**| Input file to perform the operation on. |
1886
+
1887
+ ### Return type
1888
+
1889
+ [**KeynoteToPngResult**](KeynoteToPngResult.md)
1890
+
1891
+ ### Authorization
1892
+
1893
+ [Apikey](../README.md#Apikey)
1894
+
1895
+ ### HTTP request headers
1896
+
1897
+ - **Content-Type**: multipart/form-data
1898
+ - **Accept**: application/json, text/json, application/xml, text/xml
1899
+
1900
+
1901
+
1902
+ # **convert_document_keynote_to_pptx**
1903
+ > String convert_document_keynote_to_pptx(input_file)
1904
+
1905
+ Convert Keynote Presentation (KEY) to PPTX
1906
+
1907
+ Convert Mac Keynote Presentation (KEY) to PowerPoint Presentation (PPTX)
1908
+
1909
+ ### Example
1910
+ ```ruby
1911
+ # load the gem
1912
+ require 'cloudmersive-convert-api-client'
1913
+ # setup authorization
1914
+ CloudmersiveConvertApiClient.configure do |config|
1915
+ # Configure API key authorization: Apikey
1916
+ config.api_key['Apikey'] = 'YOUR API KEY'
1917
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1918
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1919
+ end
1920
+
1921
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1922
+
1923
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1924
+
1925
+
1926
+ begin
1927
+ #Convert Keynote Presentation (KEY) to PPTX
1928
+ result = api_instance.convert_document_keynote_to_pptx(input_file)
1929
+ p result
1930
+ rescue CloudmersiveConvertApiClient::ApiError => e
1931
+ puts "Exception when calling ConvertDocumentApi->convert_document_keynote_to_pptx: #{e}"
1932
+ end
1933
+ ```
1934
+
1935
+ ### Parameters
1936
+
1937
+ Name | Type | Description | Notes
1938
+ ------------- | ------------- | ------------- | -------------
1939
+ **input_file** | **File**| Input file to perform the operation on. |
1940
+
1941
+ ### Return type
1942
+
1943
+ **String**
1944
+
1945
+ ### Authorization
1946
+
1947
+ [Apikey](../README.md#Apikey)
1948
+
1949
+ ### HTTP request headers
1950
+
1951
+ - **Content-Type**: multipart/form-data
1952
+ - **Accept**: application/octet-stream
1953
+
1954
+
1955
+
1956
+ # **convert_document_msg_to_html**
1957
+ > MsgToHtmlResult convert_document_msg_to_html(input_file, opts)
1958
+
1959
+ Convert Email MSG file to HTML string
1960
+
1961
+ Convert Outlook Email MSG file to HTML string and attachments. Supports images if they are base 64 inline. Supports most, but not all, RTF bodied MSG files.
1962
+
1963
+ ### Example
1964
+ ```ruby
1965
+ # load the gem
1966
+ require 'cloudmersive-convert-api-client'
1967
+ # setup authorization
1968
+ CloudmersiveConvertApiClient.configure do |config|
1969
+ # Configure API key authorization: Apikey
1970
+ config.api_key['Apikey'] = 'YOUR API KEY'
1971
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1972
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1973
+ end
1974
+
1975
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
1976
+
1977
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1978
+
1979
+ opts = {
1980
+ body_only: true, # BOOLEAN | Optional; If true, the HTML string will only include the body of the MSG. Other information such as subject will still be given as properties in the response object. Default is false.
1981
+ include_attachments: true # BOOLEAN | Optional; If false, the response object will not include any attachment files from the input file. Default is true.
1982
+ }
1983
+
1984
+ begin
1985
+ #Convert Email MSG file to HTML string
1986
+ result = api_instance.convert_document_msg_to_html(input_file, opts)
1987
+ p result
1988
+ rescue CloudmersiveConvertApiClient::ApiError => e
1989
+ puts "Exception when calling ConvertDocumentApi->convert_document_msg_to_html: #{e}"
1990
+ end
1991
+ ```
1992
+
1993
+ ### Parameters
1994
+
1995
+ Name | Type | Description | Notes
1996
+ ------------- | ------------- | ------------- | -------------
1997
+ **input_file** | **File**| Input file to perform the operation on. |
1998
+ **body_only** | **BOOLEAN**| Optional; If true, the HTML string will only include the body of the MSG. Other information such as subject will still be given as properties in the response object. Default is false. | [optional]
1999
+ **include_attachments** | **BOOLEAN**| Optional; If false, the response object will not include any attachment files from the input file. Default is true. | [optional]
2000
+
2001
+ ### Return type
2002
+
2003
+ [**MsgToHtmlResult**](MsgToHtmlResult.md)
2004
+
2005
+ ### Authorization
2006
+
2007
+ [Apikey](../README.md#Apikey)
2008
+
2009
+ ### HTTP request headers
2010
+
2011
+ - **Content-Type**: multipart/form-data
2012
+ - **Accept**: application/json, text/json, application/xml, text/xml
2013
+
2014
+
2015
+
2016
+ # **convert_document_msg_to_jpg**
2017
+ > MsgToJpgResult convert_document_msg_to_jpg(input_file, opts)
2018
+
2019
+ Convert Email MSG file to JPG/JPEG image array
2020
+
2021
+ Converts an Outlook Message File (MSG) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
2022
+
2023
+ ### Example
2024
+ ```ruby
2025
+ # load the gem
2026
+ require 'cloudmersive-convert-api-client'
2027
+ # setup authorization
2028
+ CloudmersiveConvertApiClient.configure do |config|
2029
+ # Configure API key authorization: Apikey
2030
+ config.api_key['Apikey'] = 'YOUR API KEY'
2031
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2032
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2033
+ end
2034
+
2035
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2036
+
2037
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2038
+
2039
+ opts = {
2040
+ quality: 56 # Integer | Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
2041
+ }
2042
+
2043
+ begin
2044
+ #Convert Email MSG file to JPG/JPEG image array
2045
+ result = api_instance.convert_document_msg_to_jpg(input_file, opts)
2046
+ p result
2047
+ rescue CloudmersiveConvertApiClient::ApiError => e
2048
+ puts "Exception when calling ConvertDocumentApi->convert_document_msg_to_jpg: #{e}"
2049
+ end
2050
+ ```
2051
+
2052
+ ### Parameters
2053
+
2054
+ Name | Type | Description | Notes
2055
+ ------------- | ------------- | ------------- | -------------
2056
+ **input_file** | **File**| Input file to perform the operation on. |
2057
+ **quality** | **Integer**| Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75. | [optional]
2058
+
2059
+ ### Return type
2060
+
2061
+ [**MsgToJpgResult**](MsgToJpgResult.md)
2062
+
2063
+ ### Authorization
2064
+
2065
+ [Apikey](../README.md#Apikey)
2066
+
2067
+ ### HTTP request headers
2068
+
2069
+ - **Content-Type**: multipart/form-data
2070
+ - **Accept**: application/json, text/json, application/xml, text/xml
2071
+
2072
+
2073
+
2074
+ # **convert_document_msg_to_pdf**
2075
+ > String convert_document_msg_to_pdf(input_file, opts)
2076
+
2077
+ Convert Email MSG file to PDF document
2078
+
2079
+ Convert Outlook Email MSG file to PDF document. Supports images if they are base 64 inline. Supports most, but not all, RTF bodied MSG files.
2080
+
2081
+ ### Example
2082
+ ```ruby
2083
+ # load the gem
2084
+ require 'cloudmersive-convert-api-client'
2085
+ # setup authorization
2086
+ CloudmersiveConvertApiClient.configure do |config|
2087
+ # Configure API key authorization: Apikey
2088
+ config.api_key['Apikey'] = 'YOUR API KEY'
2089
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2090
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2091
+ end
2092
+
2093
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2094
+
2095
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2096
+
2097
+ opts = {
2098
+ body_only: true # BOOLEAN | Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false.
2099
+ }
2100
+
2101
+ begin
2102
+ #Convert Email MSG file to PDF document
2103
+ result = api_instance.convert_document_msg_to_pdf(input_file, opts)
2104
+ p result
2105
+ rescue CloudmersiveConvertApiClient::ApiError => e
2106
+ puts "Exception when calling ConvertDocumentApi->convert_document_msg_to_pdf: #{e}"
2107
+ end
2108
+ ```
2109
+
2110
+ ### Parameters
2111
+
2112
+ Name | Type | Description | Notes
2113
+ ------------- | ------------- | ------------- | -------------
2114
+ **input_file** | **File**| Input file to perform the operation on. |
2115
+ **body_only** | **BOOLEAN**| Optional; If true, the HTML string will only include the body of the email. Other information such as subject will still be given as properties in the response object. Default is false. | [optional]
2116
+
2117
+ ### Return type
2118
+
2119
+ **String**
2120
+
2121
+ ### Authorization
2122
+
2123
+ [Apikey](../README.md#Apikey)
2124
+
2125
+ ### HTTP request headers
2126
+
2127
+ - **Content-Type**: multipart/form-data
2128
+ - **Accept**: application/octet-stream
2129
+
2130
+
2131
+
2132
+ # **convert_document_msg_to_png**
2133
+ > MsgToPngResult convert_document_msg_to_png(input_file)
2134
+
2135
+ Convert Email MSG file to PNG image array
2136
+
2137
+ Converts an Outlook Email Message File (MSG) to an array of PNG images, one for each page.
2138
+
2139
+ ### Example
2140
+ ```ruby
2141
+ # load the gem
2142
+ require 'cloudmersive-convert-api-client'
2143
+ # setup authorization
2144
+ CloudmersiveConvertApiClient.configure do |config|
2145
+ # Configure API key authorization: Apikey
2146
+ config.api_key['Apikey'] = 'YOUR API KEY'
2147
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2148
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2149
+ end
2150
+
2151
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2152
+
2153
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2154
+
2155
+
2156
+ begin
2157
+ #Convert Email MSG file to PNG image array
2158
+ result = api_instance.convert_document_msg_to_png(input_file)
2159
+ p result
2160
+ rescue CloudmersiveConvertApiClient::ApiError => e
2161
+ puts "Exception when calling ConvertDocumentApi->convert_document_msg_to_png: #{e}"
2162
+ end
2163
+ ```
2164
+
2165
+ ### Parameters
2166
+
2167
+ Name | Type | Description | Notes
2168
+ ------------- | ------------- | ------------- | -------------
2169
+ **input_file** | **File**| Input file to perform the operation on. |
2170
+
2171
+ ### Return type
2172
+
2173
+ [**MsgToPngResult**](MsgToPngResult.md)
2174
+
2175
+ ### Authorization
2176
+
2177
+ [Apikey](../README.md#Apikey)
2178
+
2179
+ ### HTTP request headers
2180
+
2181
+ - **Content-Type**: multipart/form-data
2182
+ - **Accept**: application/json, text/json, application/xml, text/xml
2183
+
2184
+
2185
+
2186
+ # **convert_document_odp_to_jpg**
2187
+ > OdpToJpgResult convert_document_odp_to_jpg(input_file, opts)
2188
+
2189
+ Convert ODP Presentation to JPG/JPEG image array
2190
+
2191
+ Converts an Open Document Presentation (ODP) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
2192
+
2193
+ ### Example
2194
+ ```ruby
2195
+ # load the gem
2196
+ require 'cloudmersive-convert-api-client'
2197
+ # setup authorization
2198
+ CloudmersiveConvertApiClient.configure do |config|
2199
+ # Configure API key authorization: Apikey
2200
+ config.api_key['Apikey'] = 'YOUR API KEY'
2201
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2202
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2203
+ end
2204
+
2205
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2206
+
2207
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2208
+
2209
+ opts = {
2210
+ quality: 56 # Integer | Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
2211
+ }
2212
+
2213
+ begin
2214
+ #Convert ODP Presentation to JPG/JPEG image array
2215
+ result = api_instance.convert_document_odp_to_jpg(input_file, opts)
2216
+ p result
2217
+ rescue CloudmersiveConvertApiClient::ApiError => e
2218
+ puts "Exception when calling ConvertDocumentApi->convert_document_odp_to_jpg: #{e}"
2219
+ end
2220
+ ```
2221
+
2222
+ ### Parameters
2223
+
2224
+ Name | Type | Description | Notes
2225
+ ------------- | ------------- | ------------- | -------------
2226
+ **input_file** | **File**| Input file to perform the operation on. |
2227
+ **quality** | **Integer**| Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75. | [optional]
2228
+
2229
+ ### Return type
2230
+
2231
+ [**OdpToJpgResult**](OdpToJpgResult.md)
2232
+
2233
+ ### Authorization
2234
+
2235
+ [Apikey](../README.md#Apikey)
2236
+
2237
+ ### HTTP request headers
2238
+
2239
+ - **Content-Type**: multipart/form-data
2240
+ - **Accept**: application/json, text/json, application/xml, text/xml
2241
+
2242
+
2243
+
2244
+ # **convert_document_odp_to_pdf**
2245
+ > String convert_document_odp_to_pdf(input_file)
2246
+
2247
+ Convert ODP Presentation to PDF
2248
+
2249
+ Convert Office Open Document Presentation (ODP) to standard PDF
2250
+
2251
+ ### Example
2252
+ ```ruby
2253
+ # load the gem
2254
+ require 'cloudmersive-convert-api-client'
2255
+ # setup authorization
2256
+ CloudmersiveConvertApiClient.configure do |config|
2257
+ # Configure API key authorization: Apikey
2258
+ config.api_key['Apikey'] = 'YOUR API KEY'
2259
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2260
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2261
+ end
2262
+
2263
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2264
+
2265
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2266
+
2267
+
2268
+ begin
2269
+ #Convert ODP Presentation to PDF
2270
+ result = api_instance.convert_document_odp_to_pdf(input_file)
2271
+ p result
2272
+ rescue CloudmersiveConvertApiClient::ApiError => e
2273
+ puts "Exception when calling ConvertDocumentApi->convert_document_odp_to_pdf: #{e}"
2274
+ end
2275
+ ```
2276
+
2277
+ ### Parameters
2278
+
2279
+ Name | Type | Description | Notes
2280
+ ------------- | ------------- | ------------- | -------------
2281
+ **input_file** | **File**| Input file to perform the operation on. |
2282
+
2283
+ ### Return type
2284
+
2285
+ **String**
2286
+
2287
+ ### Authorization
2288
+
2289
+ [Apikey](../README.md#Apikey)
2290
+
2291
+ ### HTTP request headers
2292
+
2293
+ - **Content-Type**: multipart/form-data
2294
+ - **Accept**: application/octet-stream
2295
+
2296
+
2297
+
2298
+ # **convert_document_odp_to_png**
2299
+ > OdpToPngResult convert_document_odp_to_png(input_file)
2300
+
2301
+ Convert ODP Presentation to PNG image array
2302
+
2303
+ Converts an Office Open Document Presentation (ODP) to an array of PNG images, one for each page.
2304
+
2305
+ ### Example
2306
+ ```ruby
2307
+ # load the gem
2308
+ require 'cloudmersive-convert-api-client'
2309
+ # setup authorization
2310
+ CloudmersiveConvertApiClient.configure do |config|
2311
+ # Configure API key authorization: Apikey
2312
+ config.api_key['Apikey'] = 'YOUR API KEY'
2313
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2314
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2315
+ end
2316
+
2317
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2318
+
2319
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2320
+
2321
+
2322
+ begin
2323
+ #Convert ODP Presentation to PNG image array
2324
+ result = api_instance.convert_document_odp_to_png(input_file)
2325
+ p result
2326
+ rescue CloudmersiveConvertApiClient::ApiError => e
2327
+ puts "Exception when calling ConvertDocumentApi->convert_document_odp_to_png: #{e}"
2328
+ end
2329
+ ```
2330
+
2331
+ ### Parameters
2332
+
2333
+ Name | Type | Description | Notes
2334
+ ------------- | ------------- | ------------- | -------------
2335
+ **input_file** | **File**| Input file to perform the operation on. |
2336
+
2337
+ ### Return type
2338
+
2339
+ [**OdpToPngResult**](OdpToPngResult.md)
2340
+
2341
+ ### Authorization
2342
+
2343
+ [Apikey](../README.md#Apikey)
2344
+
2345
+ ### HTTP request headers
2346
+
2347
+ - **Content-Type**: multipart/form-data
2348
+ - **Accept**: application/json, text/json, application/xml, text/xml
2349
+
2350
+
2351
+
2352
+ # **convert_document_odp_to_pptx**
2353
+ > String convert_document_odp_to_pptx(input_file)
2354
+
2355
+ Convert ODP Presentation to PPTX
2356
+
2357
+ Convert Office Open Document Presentation (ODP) to PowerPoint Presentation (PPTX)
2358
+
2359
+ ### Example
2360
+ ```ruby
2361
+ # load the gem
2362
+ require 'cloudmersive-convert-api-client'
2363
+ # setup authorization
2364
+ CloudmersiveConvertApiClient.configure do |config|
2365
+ # Configure API key authorization: Apikey
2366
+ config.api_key['Apikey'] = 'YOUR API KEY'
2367
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2368
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2369
+ end
2370
+
2371
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2372
+
2373
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2374
+
2375
+
2376
+ begin
2377
+ #Convert ODP Presentation to PPTX
2378
+ result = api_instance.convert_document_odp_to_pptx(input_file)
2379
+ p result
2380
+ rescue CloudmersiveConvertApiClient::ApiError => e
2381
+ puts "Exception when calling ConvertDocumentApi->convert_document_odp_to_pptx: #{e}"
2382
+ end
2383
+ ```
2384
+
2385
+ ### Parameters
2386
+
2387
+ Name | Type | Description | Notes
2388
+ ------------- | ------------- | ------------- | -------------
2389
+ **input_file** | **File**| Input file to perform the operation on. |
2390
+
2391
+ ### Return type
2392
+
2393
+ **String**
2394
+
2395
+ ### Authorization
2396
+
2397
+ [Apikey](../README.md#Apikey)
2398
+
2399
+ ### HTTP request headers
2400
+
2401
+ - **Content-Type**: multipart/form-data
2402
+ - **Accept**: application/octet-stream
2403
+
2404
+
2405
+
2406
+ # **convert_document_ods_to_jpg**
2407
+ > OdsToJpgResult convert_document_ods_to_jpg(input_file, opts)
2408
+
2409
+ Convert ODS Spreadsheet to JPG/JPEG image array
2410
+
2411
+ Converts an Open Document Spreadsheet (ODS) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
2412
+
2413
+ ### Example
2414
+ ```ruby
2415
+ # load the gem
2416
+ require 'cloudmersive-convert-api-client'
2417
+ # setup authorization
2418
+ CloudmersiveConvertApiClient.configure do |config|
2419
+ # Configure API key authorization: Apikey
2420
+ config.api_key['Apikey'] = 'YOUR API KEY'
2421
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2422
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2423
+ end
2424
+
2425
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2426
+
2427
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2428
+
2429
+ opts = {
2430
+ quality: 56 # Integer | Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
2431
+ }
2432
+
2433
+ begin
2434
+ #Convert ODS Spreadsheet to JPG/JPEG image array
2435
+ result = api_instance.convert_document_ods_to_jpg(input_file, opts)
2436
+ p result
2437
+ rescue CloudmersiveConvertApiClient::ApiError => e
2438
+ puts "Exception when calling ConvertDocumentApi->convert_document_ods_to_jpg: #{e}"
2439
+ end
2440
+ ```
2441
+
2442
+ ### Parameters
2443
+
2444
+ Name | Type | Description | Notes
2445
+ ------------- | ------------- | ------------- | -------------
2446
+ **input_file** | **File**| Input file to perform the operation on. |
2447
+ **quality** | **Integer**| Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75. | [optional]
2448
+
2449
+ ### Return type
2450
+
2451
+ [**OdsToJpgResult**](OdsToJpgResult.md)
2452
+
2453
+ ### Authorization
2454
+
2455
+ [Apikey](../README.md#Apikey)
2456
+
2457
+ ### HTTP request headers
2458
+
2459
+ - **Content-Type**: multipart/form-data
2460
+ - **Accept**: application/json, text/json, application/xml, text/xml
2461
+
2462
+
2463
+
2464
+ # **convert_document_ods_to_pdf**
2465
+ > String convert_document_ods_to_pdf(input_file)
2466
+
2467
+ Convert ODS Spreadsheet to PDF
2468
+
2469
+ Convert Office Open Document Spreadsheet (ODS) to standard PDF
2470
+
2471
+ ### Example
2472
+ ```ruby
2473
+ # load the gem
2474
+ require 'cloudmersive-convert-api-client'
2475
+ # setup authorization
2476
+ CloudmersiveConvertApiClient.configure do |config|
2477
+ # Configure API key authorization: Apikey
2478
+ config.api_key['Apikey'] = 'YOUR API KEY'
2479
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2480
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2481
+ end
2482
+
2483
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2484
+
2485
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2486
+
2487
+
2488
+ begin
2489
+ #Convert ODS Spreadsheet to PDF
2490
+ result = api_instance.convert_document_ods_to_pdf(input_file)
2491
+ p result
2492
+ rescue CloudmersiveConvertApiClient::ApiError => e
2493
+ puts "Exception when calling ConvertDocumentApi->convert_document_ods_to_pdf: #{e}"
2494
+ end
2495
+ ```
2496
+
2497
+ ### Parameters
2498
+
2499
+ Name | Type | Description | Notes
2500
+ ------------- | ------------- | ------------- | -------------
2501
+ **input_file** | **File**| Input file to perform the operation on. |
2502
+
2503
+ ### Return type
2504
+
2505
+ **String**
2506
+
2507
+ ### Authorization
2508
+
2509
+ [Apikey](../README.md#Apikey)
2510
+
2511
+ ### HTTP request headers
2512
+
2513
+ - **Content-Type**: multipart/form-data
2514
+ - **Accept**: application/octet-stream
2515
+
2516
+
2517
+
2518
+ # **convert_document_ods_to_png**
2519
+ > OdsToPngResult convert_document_ods_to_png(input_file)
2520
+
2521
+ Convert ODS Spreadsheet to PNG image array
2522
+
2523
+ Converts an Office Open Document Spreadsheet (ODS) to an array of PNG images, one for each page.
2524
+
2525
+ ### Example
2526
+ ```ruby
2527
+ # load the gem
2528
+ require 'cloudmersive-convert-api-client'
2529
+ # setup authorization
2530
+ CloudmersiveConvertApiClient.configure do |config|
2531
+ # Configure API key authorization: Apikey
2532
+ config.api_key['Apikey'] = 'YOUR API KEY'
2533
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2534
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2535
+ end
2536
+
2537
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2538
+
2539
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2540
+
2541
+
2542
+ begin
2543
+ #Convert ODS Spreadsheet to PNG image array
2544
+ result = api_instance.convert_document_ods_to_png(input_file)
2545
+ p result
2546
+ rescue CloudmersiveConvertApiClient::ApiError => e
2547
+ puts "Exception when calling ConvertDocumentApi->convert_document_ods_to_png: #{e}"
2548
+ end
2549
+ ```
2550
+
2551
+ ### Parameters
2552
+
2553
+ Name | Type | Description | Notes
2554
+ ------------- | ------------- | ------------- | -------------
2555
+ **input_file** | **File**| Input file to perform the operation on. |
2556
+
2557
+ ### Return type
2558
+
2559
+ [**OdsToPngResult**](OdsToPngResult.md)
2560
+
2561
+ ### Authorization
2562
+
2563
+ [Apikey](../README.md#Apikey)
2564
+
2565
+ ### HTTP request headers
2566
+
2567
+ - **Content-Type**: multipart/form-data
2568
+ - **Accept**: application/json, text/json, application/xml, text/xml
2569
+
2570
+
2571
+
2572
+ # **convert_document_ods_to_xlsx**
2573
+ > String convert_document_ods_to_xlsx(input_file)
2574
+
2575
+ Convert ODS Spreadsheet to XLSX
2576
+
2577
+ Convert Office Open Document Spreadsheet (ODS) to Excel Spreadsheet (XLSX)
2578
+
2579
+ ### Example
2580
+ ```ruby
2581
+ # load the gem
2582
+ require 'cloudmersive-convert-api-client'
2583
+ # setup authorization
2584
+ CloudmersiveConvertApiClient.configure do |config|
2585
+ # Configure API key authorization: Apikey
2586
+ config.api_key['Apikey'] = 'YOUR API KEY'
2587
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2588
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2589
+ end
2590
+
2591
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2592
+
2593
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2594
+
2595
+
2596
+ begin
2597
+ #Convert ODS Spreadsheet to XLSX
2598
+ result = api_instance.convert_document_ods_to_xlsx(input_file)
2599
+ p result
2600
+ rescue CloudmersiveConvertApiClient::ApiError => e
2601
+ puts "Exception when calling ConvertDocumentApi->convert_document_ods_to_xlsx: #{e}"
2602
+ end
2603
+ ```
2604
+
2605
+ ### Parameters
2606
+
2607
+ Name | Type | Description | Notes
2608
+ ------------- | ------------- | ------------- | -------------
2609
+ **input_file** | **File**| Input file to perform the operation on. |
2610
+
2611
+ ### Return type
2612
+
2613
+ **String**
2614
+
2615
+ ### Authorization
2616
+
2617
+ [Apikey](../README.md#Apikey)
2618
+
2619
+ ### HTTP request headers
2620
+
2621
+ - **Content-Type**: multipart/form-data
2622
+ - **Accept**: application/octet-stream
2623
+
2624
+
2625
+
2626
+ # **convert_document_odt_to_docx**
2627
+ > String convert_document_odt_to_docx(input_file)
2628
+
2629
+ Convert ODT Text File to Word DOCX
2630
+
2631
+ Convert Office Open Document Text File (ODT) to Word DOCX Document
2632
+
2633
+ ### Example
2634
+ ```ruby
2635
+ # load the gem
2636
+ require 'cloudmersive-convert-api-client'
2637
+ # setup authorization
2638
+ CloudmersiveConvertApiClient.configure do |config|
2639
+ # Configure API key authorization: Apikey
2640
+ config.api_key['Apikey'] = 'YOUR API KEY'
2641
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2642
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2643
+ end
2644
+
2645
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2646
+
2647
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2648
+
2649
+
2650
+ begin
2651
+ #Convert ODT Text File to Word DOCX
2652
+ result = api_instance.convert_document_odt_to_docx(input_file)
2653
+ p result
2654
+ rescue CloudmersiveConvertApiClient::ApiError => e
2655
+ puts "Exception when calling ConvertDocumentApi->convert_document_odt_to_docx: #{e}"
2656
+ end
2657
+ ```
2658
+
2659
+ ### Parameters
2660
+
2661
+ Name | Type | Description | Notes
2662
+ ------------- | ------------- | ------------- | -------------
2663
+ **input_file** | **File**| Input file to perform the operation on. |
2664
+
2665
+ ### Return type
2666
+
2667
+ **String**
2668
+
2669
+ ### Authorization
2670
+
2671
+ [Apikey](../README.md#Apikey)
2672
+
2673
+ ### HTTP request headers
2674
+
2675
+ - **Content-Type**: multipart/form-data
2676
+ - **Accept**: application/octet-stream
2677
+
2678
+
2679
+
2680
+ # **convert_document_odt_to_jpg**
2681
+ > OdtToJpgResult convert_document_odt_to_jpg(input_file, opts)
2682
+
2683
+ Convert ODT Text File to JPG/JPEG image array
2684
+
2685
+ Converts an Open Document Text File (ODT) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
2686
+
2687
+ ### Example
2688
+ ```ruby
2689
+ # load the gem
2690
+ require 'cloudmersive-convert-api-client'
2691
+ # setup authorization
2692
+ CloudmersiveConvertApiClient.configure do |config|
2693
+ # Configure API key authorization: Apikey
2694
+ config.api_key['Apikey'] = 'YOUR API KEY'
2695
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2696
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2697
+ end
2698
+
2699
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2700
+
2701
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2702
+
2703
+ opts = {
2704
+ quality: 56 # Integer | Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
2705
+ }
2706
+
2707
+ begin
2708
+ #Convert ODT Text File to JPG/JPEG image array
2709
+ result = api_instance.convert_document_odt_to_jpg(input_file, opts)
2710
+ p result
2711
+ rescue CloudmersiveConvertApiClient::ApiError => e
2712
+ puts "Exception when calling ConvertDocumentApi->convert_document_odt_to_jpg: #{e}"
2713
+ end
2714
+ ```
2715
+
2716
+ ### Parameters
2717
+
2718
+ Name | Type | Description | Notes
2719
+ ------------- | ------------- | ------------- | -------------
2720
+ **input_file** | **File**| Input file to perform the operation on. |
2721
+ **quality** | **Integer**| Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75. | [optional]
2722
+
2723
+ ### Return type
2724
+
2725
+ [**OdtToJpgResult**](OdtToJpgResult.md)
2726
+
2727
+ ### Authorization
2728
+
2729
+ [Apikey](../README.md#Apikey)
2730
+
2731
+ ### HTTP request headers
2732
+
2733
+ - **Content-Type**: multipart/form-data
2734
+ - **Accept**: application/json, text/json, application/xml, text/xml
2735
+
2736
+
2737
+
2738
+ # **convert_document_odt_to_pdf**
2739
+ > String convert_document_odt_to_pdf(input_file)
2740
+
2741
+ Convert ODT Text File to PDF
2742
+
2743
+ Convert Office Open Document Text File (ODT) to standard PDF
2744
+
2745
+ ### Example
2746
+ ```ruby
2747
+ # load the gem
2748
+ require 'cloudmersive-convert-api-client'
2749
+ # setup authorization
2750
+ CloudmersiveConvertApiClient.configure do |config|
2751
+ # Configure API key authorization: Apikey
2752
+ config.api_key['Apikey'] = 'YOUR API KEY'
2753
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2754
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2755
+ end
2756
+
2757
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2758
+
2759
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2760
+
2761
+
2762
+ begin
2763
+ #Convert ODT Text File to PDF
2764
+ result = api_instance.convert_document_odt_to_pdf(input_file)
2765
+ p result
2766
+ rescue CloudmersiveConvertApiClient::ApiError => e
2767
+ puts "Exception when calling ConvertDocumentApi->convert_document_odt_to_pdf: #{e}"
2768
+ end
2769
+ ```
2770
+
2771
+ ### Parameters
2772
+
2773
+ Name | Type | Description | Notes
2774
+ ------------- | ------------- | ------------- | -------------
2775
+ **input_file** | **File**| Input file to perform the operation on. |
2776
+
2777
+ ### Return type
2778
+
2779
+ **String**
2780
+
2781
+ ### Authorization
2782
+
2783
+ [Apikey](../README.md#Apikey)
2784
+
2785
+ ### HTTP request headers
2786
+
2787
+ - **Content-Type**: multipart/form-data
2788
+ - **Accept**: application/octet-stream
2789
+
2790
+
2791
+
2792
+ # **convert_document_odt_to_png**
2793
+ > OdtToPngResult convert_document_odt_to_png(input_file)
2794
+
2795
+ Convert ODT Text File to PNG image array
2796
+
2797
+ Converts an Office Open Document Text File (ODT) to an array of PNG images, one for each page.
2798
+
2799
+ ### Example
2800
+ ```ruby
2801
+ # load the gem
2802
+ require 'cloudmersive-convert-api-client'
2803
+ # setup authorization
2804
+ CloudmersiveConvertApiClient.configure do |config|
2805
+ # Configure API key authorization: Apikey
2806
+ config.api_key['Apikey'] = 'YOUR API KEY'
2807
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2808
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2809
+ end
2810
+
2811
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2812
+
2813
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2814
+
2815
+
2816
+ begin
2817
+ #Convert ODT Text File to PNG image array
2818
+ result = api_instance.convert_document_odt_to_png(input_file)
2819
+ p result
2820
+ rescue CloudmersiveConvertApiClient::ApiError => e
2821
+ puts "Exception when calling ConvertDocumentApi->convert_document_odt_to_png: #{e}"
2822
+ end
2823
+ ```
2824
+
2825
+ ### Parameters
2826
+
2827
+ Name | Type | Description | Notes
2828
+ ------------- | ------------- | ------------- | -------------
2829
+ **input_file** | **File**| Input file to perform the operation on. |
2830
+
2831
+ ### Return type
2832
+
2833
+ [**OdtToPngResult**](OdtToPngResult.md)
2834
+
2835
+ ### Authorization
2836
+
2837
+ [Apikey](../README.md#Apikey)
2838
+
2839
+ ### HTTP request headers
2840
+
2841
+ - **Content-Type**: multipart/form-data
2842
+ - **Accept**: application/json, text/json, application/xml, text/xml
2843
+
2844
+
2845
+
2846
+ # **convert_document_pdf_to_docx**
2847
+ > String convert_document_pdf_to_docx(input_file)
2848
+
2849
+ Convert PDF to Word DOCX Document
2850
+
2851
+ Convert standard PDF to Office Word Documents (docx). Converts a PDF at high fidelity into Word format, where it can be easily edited and processed.
2852
+
2853
+ ### Example
2854
+ ```ruby
2855
+ # load the gem
2856
+ require 'cloudmersive-convert-api-client'
2857
+ # setup authorization
2858
+ CloudmersiveConvertApiClient.configure do |config|
2859
+ # Configure API key authorization: Apikey
2860
+ config.api_key['Apikey'] = 'YOUR API KEY'
2861
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2862
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2863
+ end
2864
+
2865
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2866
+
2867
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2868
+
2869
+
2870
+ begin
2871
+ #Convert PDF to Word DOCX Document
2872
+ result = api_instance.convert_document_pdf_to_docx(input_file)
2873
+ p result
2874
+ rescue CloudmersiveConvertApiClient::ApiError => e
2875
+ puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_docx: #{e}"
2876
+ end
2877
+ ```
2878
+
2879
+ ### Parameters
2880
+
2881
+ Name | Type | Description | Notes
2882
+ ------------- | ------------- | ------------- | -------------
2883
+ **input_file** | **File**| Input file to perform the operation on. |
2884
+
2885
+ ### Return type
2886
+
2887
+ **String**
2888
+
2889
+ ### Authorization
2890
+
2891
+ [Apikey](../README.md#Apikey)
2892
+
2893
+ ### HTTP request headers
2894
+
2895
+ - **Content-Type**: multipart/form-data
2896
+ - **Accept**: application/octet-stream
2897
+
2898
+
2899
+
2900
+ # **convert_document_pdf_to_docx_rasterize**
2901
+ > String convert_document_pdf_to_docx_rasterize(input_file)
2902
+
2903
+ Convert PDF to Word DOCX Document based on rasterized version of the PDF
2904
+
2905
+ Convert standard PDF to Office Word Documents (docx), but first rasterize the PDF. Converts a PDF at high fidelity into Word format.
2906
+
2907
+ ### Example
2908
+ ```ruby
2909
+ # load the gem
2910
+ require 'cloudmersive-convert-api-client'
2911
+ # setup authorization
2912
+ CloudmersiveConvertApiClient.configure do |config|
2913
+ # Configure API key authorization: Apikey
2914
+ config.api_key['Apikey'] = 'YOUR API KEY'
2915
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2916
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2917
+ end
2918
+
2919
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2920
+
2921
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2922
+
2923
+
2924
+ begin
2925
+ #Convert PDF to Word DOCX Document based on rasterized version of the PDF
2926
+ result = api_instance.convert_document_pdf_to_docx_rasterize(input_file)
2927
+ p result
2928
+ rescue CloudmersiveConvertApiClient::ApiError => e
2929
+ puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_docx_rasterize: #{e}"
2930
+ end
2931
+ ```
2932
+
2933
+ ### Parameters
2934
+
2935
+ Name | Type | Description | Notes
2936
+ ------------- | ------------- | ------------- | -------------
2937
+ **input_file** | **File**| Input file to perform the operation on. |
2938
+
2939
+ ### Return type
2940
+
2941
+ **String**
2942
+
2943
+ ### Authorization
2944
+
2945
+ [Apikey](../README.md#Apikey)
2946
+
2947
+ ### HTTP request headers
2948
+
2949
+ - **Content-Type**: multipart/form-data
2950
+ - **Accept**: application/octet-stream
2951
+
2952
+
2953
+
2954
+ # **convert_document_pdf_to_jpg**
2955
+ > PdfToJpgResult convert_document_pdf_to_jpg(input_file, opts)
2956
+
2957
+ Convert PDF to JPG/JPEG image array
2958
+
2959
+ Converts a PDF Document to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
2960
+
2961
+ ### Example
2962
+ ```ruby
2963
+ # load the gem
2964
+ require 'cloudmersive-convert-api-client'
2965
+ # setup authorization
2966
+ CloudmersiveConvertApiClient.configure do |config|
2967
+ # Configure API key authorization: Apikey
2968
+ config.api_key['Apikey'] = 'YOUR API KEY'
2969
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2970
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2971
+ end
2972
+
2973
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
2974
+
2975
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
2976
+
2977
+ opts = {
2978
+ quality: 56 # Integer | Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
2979
+ }
2980
+
2981
+ begin
2982
+ #Convert PDF to JPG/JPEG image array
2983
+ result = api_instance.convert_document_pdf_to_jpg(input_file, opts)
2984
+ p result
2985
+ rescue CloudmersiveConvertApiClient::ApiError => e
2986
+ puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_jpg: #{e}"
2987
+ end
2988
+ ```
2989
+
2990
+ ### Parameters
2991
+
2992
+ Name | Type | Description | Notes
2993
+ ------------- | ------------- | ------------- | -------------
2994
+ **input_file** | **File**| Input file to perform the operation on. |
2995
+ **quality** | **Integer**| Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75. | [optional]
2996
+
2997
+ ### Return type
2998
+
2999
+ [**PdfToJpgResult**](PdfToJpgResult.md)
3000
+
3001
+ ### Authorization
3002
+
3003
+ [Apikey](../README.md#Apikey)
3004
+
3005
+ ### HTTP request headers
3006
+
3007
+ - **Content-Type**: multipart/form-data
3008
+ - **Accept**: application/json, text/json, application/xml, text/xml
3009
+
3010
+
3011
+
3012
+ # **convert_document_pdf_to_png_array**
3013
+ > PdfToPngResult convert_document_pdf_to_png_array(input_file)
3014
+
3015
+ Convert PDF to PNG Image Array
3016
+
3017
+ Convert PDF document to PNG array, one image per page.
3018
+
3019
+ ### Example
3020
+ ```ruby
3021
+ # load the gem
3022
+ require 'cloudmersive-convert-api-client'
3023
+ # setup authorization
3024
+ CloudmersiveConvertApiClient.configure do |config|
3025
+ # Configure API key authorization: Apikey
3026
+ config.api_key['Apikey'] = 'YOUR API KEY'
3027
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3028
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3029
+ end
3030
+
3031
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3032
+
3033
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3034
+
3035
+
3036
+ begin
3037
+ #Convert PDF to PNG Image Array
3038
+ result = api_instance.convert_document_pdf_to_png_array(input_file)
3039
+ p result
3040
+ rescue CloudmersiveConvertApiClient::ApiError => e
3041
+ puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_png_array: #{e}"
3042
+ end
3043
+ ```
3044
+
3045
+ ### Parameters
3046
+
3047
+ Name | Type | Description | Notes
3048
+ ------------- | ------------- | ------------- | -------------
3049
+ **input_file** | **File**| Input file to perform the operation on. |
3050
+
3051
+ ### Return type
3052
+
3053
+ [**PdfToPngResult**](PdfToPngResult.md)
3054
+
3055
+ ### Authorization
3056
+
3057
+ [Apikey](../README.md#Apikey)
3058
+
3059
+ ### HTTP request headers
3060
+
3061
+ - **Content-Type**: multipart/form-data
3062
+ - **Accept**: application/json, text/json, application/xml, text/xml
3063
+
3064
+
3065
+
3066
+ # **convert_document_pdf_to_png_single**
3067
+ > String convert_document_pdf_to_png_single(input_file)
3068
+
3069
+ Convert PDF to Single PNG image
3070
+
3071
+ Convert PDF document to a single tall PNG image, by stacking/concatenating the images vertically into a single \"tall\" image
3072
+
3073
+ ### Example
3074
+ ```ruby
3075
+ # load the gem
3076
+ require 'cloudmersive-convert-api-client'
3077
+ # setup authorization
3078
+ CloudmersiveConvertApiClient.configure do |config|
3079
+ # Configure API key authorization: Apikey
3080
+ config.api_key['Apikey'] = 'YOUR API KEY'
3081
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3082
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3083
+ end
3084
+
3085
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3086
+
3087
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3088
+
3089
+
3090
+ begin
3091
+ #Convert PDF to Single PNG image
3092
+ result = api_instance.convert_document_pdf_to_png_single(input_file)
3093
+ p result
3094
+ rescue CloudmersiveConvertApiClient::ApiError => e
3095
+ puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_png_single: #{e}"
3096
+ end
3097
+ ```
3098
+
3099
+ ### Parameters
3100
+
3101
+ Name | Type | Description | Notes
3102
+ ------------- | ------------- | ------------- | -------------
3103
+ **input_file** | **File**| Input file to perform the operation on. |
3104
+
3105
+ ### Return type
3106
+
3107
+ **String**
3108
+
3109
+ ### Authorization
3110
+
3111
+ [Apikey](../README.md#Apikey)
3112
+
3113
+ ### HTTP request headers
3114
+
3115
+ - **Content-Type**: multipart/form-data
3116
+ - **Accept**: application/octet-stream
3117
+
3118
+
3119
+
3120
+ # **convert_document_pdf_to_pptx**
3121
+ > String convert_document_pdf_to_pptx(input_file)
3122
+
3123
+ Convert PDF to PowerPoint PPTX Presentation
3124
+
3125
+ Convert standard PDF to Office PowerPoint Presentation (pptx). Converts a PDF file at high fidelity into PowerPoint format, where it can be easily edited and processed.
3126
+
3127
+ ### Example
3128
+ ```ruby
3129
+ # load the gem
3130
+ require 'cloudmersive-convert-api-client'
3131
+ # setup authorization
3132
+ CloudmersiveConvertApiClient.configure do |config|
3133
+ # Configure API key authorization: Apikey
3134
+ config.api_key['Apikey'] = 'YOUR API KEY'
3135
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3136
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3137
+ end
3138
+
3139
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3140
+
3141
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3142
+
3143
+
3144
+ begin
3145
+ #Convert PDF to PowerPoint PPTX Presentation
3146
+ result = api_instance.convert_document_pdf_to_pptx(input_file)
3147
+ p result
3148
+ rescue CloudmersiveConvertApiClient::ApiError => e
3149
+ puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_pptx: #{e}"
3150
+ end
3151
+ ```
3152
+
3153
+ ### Parameters
3154
+
3155
+ Name | Type | Description | Notes
3156
+ ------------- | ------------- | ------------- | -------------
3157
+ **input_file** | **File**| Input file to perform the operation on. |
3158
+
3159
+ ### Return type
3160
+
3161
+ **String**
3162
+
3163
+ ### Authorization
3164
+
3165
+ [Apikey](../README.md#Apikey)
3166
+
3167
+ ### HTTP request headers
3168
+
3169
+ - **Content-Type**: multipart/form-data
3170
+ - **Accept**: application/octet-stream
3171
+
3172
+
3173
+
3174
+ # **convert_document_pdf_to_txt**
3175
+ > TextConversionResult convert_document_pdf_to_txt(input_file, opts)
3176
+
3177
+ Convert PDF Document to Text (txt)
3178
+
3179
+ PDF document to text
3180
+
3181
+ ### Example
3182
+ ```ruby
3183
+ # load the gem
3184
+ require 'cloudmersive-convert-api-client'
3185
+ # setup authorization
3186
+ CloudmersiveConvertApiClient.configure do |config|
3187
+ # Configure API key authorization: Apikey
3188
+ config.api_key['Apikey'] = 'YOUR API KEY'
3189
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3190
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3191
+ end
3192
+
3193
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3194
+
3195
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3196
+
3197
+ opts = {
3198
+ text_formatting_mode: 'text_formatting_mode_example' # String | Optional; specify how whitespace should be handled when converting PDF to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'.
3199
+ }
3200
+
3201
+ begin
3202
+ #Convert PDF Document to Text (txt)
3203
+ result = api_instance.convert_document_pdf_to_txt(input_file, opts)
3204
+ p result
3205
+ rescue CloudmersiveConvertApiClient::ApiError => e
3206
+ puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_txt: #{e}"
3207
+ end
3208
+ ```
3209
+
3210
+ ### Parameters
3211
+
3212
+ Name | Type | Description | Notes
3213
+ ------------- | ------------- | ------------- | -------------
3214
+ **input_file** | **File**| Input file to perform the operation on. |
3215
+ **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting PDF to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'. | [optional]
3216
+
3217
+ ### Return type
3218
+
3219
+ [**TextConversionResult**](TextConversionResult.md)
3220
+
3221
+ ### Authorization
3222
+
3223
+ [Apikey](../README.md#Apikey)
3224
+
3225
+ ### HTTP request headers
3226
+
3227
+ - **Content-Type**: multipart/form-data
3228
+ - **Accept**: application/json, text/json, application/xml, text/xml
3229
+
3230
+
3231
+
3232
+ # **convert_document_png_array_to_pdf**
3233
+ > String convert_document_png_array_to_pdf(input_file1, input_file2, opts)
3234
+
3235
+ Convert PNG Array to PDF
3236
+
3237
+ Convert an array of PNG images, one image per page, into a newly-created PDF. Supports images of different sizes as input.
3238
+
3239
+ ### Example
3240
+ ```ruby
3241
+ # load the gem
3242
+ require 'cloudmersive-convert-api-client'
3243
+ # setup authorization
3244
+ CloudmersiveConvertApiClient.configure do |config|
3245
+ # Configure API key authorization: Apikey
3246
+ config.api_key['Apikey'] = 'YOUR API KEY'
3247
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3248
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3249
+ end
3250
+
3251
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3252
+
3253
+ input_file1 = File.new('/path/to/file.txt') # File | First input file to perform the operation on.
3254
+
3255
+ input_file2 = File.new('/path/to/file.txt') # File | Second input file to perform the operation on.
3256
+
3257
+ opts = {
3258
+ input_file3: File.new('/path/to/file.txt'), # File | Third input file to perform the operation on.
3259
+ input_file4: File.new('/path/to/file.txt'), # File | Fourth input file to perform the operation on.
3260
+ input_file5: File.new('/path/to/file.txt'), # File | Fifth input file to perform the operation on.
3261
+ input_file6: File.new('/path/to/file.txt'), # File | Sixth input file to perform the operation on.
3262
+ input_file7: File.new('/path/to/file.txt'), # File | Seventh input file to perform the operation on.
3263
+ input_file8: File.new('/path/to/file.txt'), # File | Eighth input file to perform the operation on.
3264
+ input_file9: File.new('/path/to/file.txt'), # File | Ninth input file to perform the operation on.
3265
+ input_file10: File.new('/path/to/file.txt') # File | Tenth input file to perform the operation on.
3266
+ }
3267
+
3268
+ begin
3269
+ #Convert PNG Array to PDF
3270
+ result = api_instance.convert_document_png_array_to_pdf(input_file1, input_file2, opts)
3271
+ p result
3272
+ rescue CloudmersiveConvertApiClient::ApiError => e
3273
+ puts "Exception when calling ConvertDocumentApi->convert_document_png_array_to_pdf: #{e}"
3274
+ end
3275
+ ```
3276
+
3277
+ ### Parameters
3278
+
3279
+ Name | Type | Description | Notes
3280
+ ------------- | ------------- | ------------- | -------------
3281
+ **input_file1** | **File**| First input file to perform the operation on. |
3282
+ **input_file2** | **File**| Second input file to perform the operation on. |
3283
+ **input_file3** | **File**| Third input file to perform the operation on. | [optional]
3284
+ **input_file4** | **File**| Fourth input file to perform the operation on. | [optional]
3285
+ **input_file5** | **File**| Fifth input file to perform the operation on. | [optional]
3286
+ **input_file6** | **File**| Sixth input file to perform the operation on. | [optional]
3287
+ **input_file7** | **File**| Seventh input file to perform the operation on. | [optional]
3288
+ **input_file8** | **File**| Eighth input file to perform the operation on. | [optional]
3289
+ **input_file9** | **File**| Ninth input file to perform the operation on. | [optional]
3290
+ **input_file10** | **File**| Tenth input file to perform the operation on. | [optional]
3291
+
3292
+ ### Return type
3293
+
3294
+ **String**
3295
+
3296
+ ### Authorization
3297
+
3298
+ [Apikey](../README.md#Apikey)
3299
+
3300
+ ### HTTP request headers
3301
+
3302
+ - **Content-Type**: multipart/form-data
3303
+ - **Accept**: application/octet-stream
3304
+
3305
+
3306
+
3307
+ # **convert_document_ppt_to_pdf**
3308
+ > String convert_document_ppt_to_pdf(input_file)
3309
+
3310
+ Convert PowerPoint PPT (97-03) Presentation to PDF
3311
+
3312
+ Convert Office PowerPoint (97-2003) Documents (ppt) to standard PDF
3313
+
3314
+ ### Example
3315
+ ```ruby
3316
+ # load the gem
3317
+ require 'cloudmersive-convert-api-client'
3318
+ # setup authorization
3319
+ CloudmersiveConvertApiClient.configure do |config|
3320
+ # Configure API key authorization: Apikey
3321
+ config.api_key['Apikey'] = 'YOUR API KEY'
3322
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3323
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3324
+ end
3325
+
3326
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3327
+
3328
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3329
+
3330
+
3331
+ begin
3332
+ #Convert PowerPoint PPT (97-03) Presentation to PDF
3333
+ result = api_instance.convert_document_ppt_to_pdf(input_file)
3334
+ p result
3335
+ rescue CloudmersiveConvertApiClient::ApiError => e
3336
+ puts "Exception when calling ConvertDocumentApi->convert_document_ppt_to_pdf: #{e}"
3337
+ end
3338
+ ```
3339
+
3340
+ ### Parameters
3341
+
3342
+ Name | Type | Description | Notes
3343
+ ------------- | ------------- | ------------- | -------------
3344
+ **input_file** | **File**| Input file to perform the operation on. |
3345
+
3346
+ ### Return type
3347
+
3348
+ **String**
3349
+
3350
+ ### Authorization
3351
+
3352
+ [Apikey](../README.md#Apikey)
3353
+
3354
+ ### HTTP request headers
3355
+
3356
+ - **Content-Type**: multipart/form-data
3357
+ - **Accept**: application/octet-stream
3358
+
3359
+
3360
+
3361
+ # **convert_document_ppt_to_pptx**
3362
+ > String convert_document_ppt_to_pptx(input_file)
3363
+
3364
+ Convert PowerPoint PPT (97-03) Presentation to PPTX
3365
+
3366
+ Convert/upgrade Office PowerPoint (97-2003) Documents (ppt) to modern PPTX
3367
+
3368
+ ### Example
3369
+ ```ruby
3370
+ # load the gem
3371
+ require 'cloudmersive-convert-api-client'
3372
+ # setup authorization
3373
+ CloudmersiveConvertApiClient.configure do |config|
3374
+ # Configure API key authorization: Apikey
3375
+ config.api_key['Apikey'] = 'YOUR API KEY'
3376
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3377
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3378
+ end
3379
+
3380
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3381
+
3382
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3383
+
3384
+
3385
+ begin
3386
+ #Convert PowerPoint PPT (97-03) Presentation to PPTX
3387
+ result = api_instance.convert_document_ppt_to_pptx(input_file)
3388
+ p result
3389
+ rescue CloudmersiveConvertApiClient::ApiError => e
3390
+ puts "Exception when calling ConvertDocumentApi->convert_document_ppt_to_pptx: #{e}"
3391
+ end
3392
+ ```
3393
+
3394
+ ### Parameters
3395
+
3396
+ Name | Type | Description | Notes
3397
+ ------------- | ------------- | ------------- | -------------
3398
+ **input_file** | **File**| Input file to perform the operation on. |
3399
+
3400
+ ### Return type
3401
+
3402
+ **String**
3403
+
3404
+ ### Authorization
3405
+
3406
+ [Apikey](../README.md#Apikey)
3407
+
3408
+ ### HTTP request headers
3409
+
3410
+ - **Content-Type**: multipart/form-data
3411
+ - **Accept**: application/octet-stream
3412
+
3413
+
3414
+
3415
+ # **convert_document_pptx_to_pdf**
3416
+ > String convert_document_pptx_to_pdf(input_file)
3417
+
3418
+ Convert PowerPoint PPTX Presentation to PDF
3419
+
3420
+ Convert Office PowerPoint Documents (pptx) to standard PDF
3421
+
3422
+ ### Example
3423
+ ```ruby
3424
+ # load the gem
3425
+ require 'cloudmersive-convert-api-client'
3426
+ # setup authorization
3427
+ CloudmersiveConvertApiClient.configure do |config|
3428
+ # Configure API key authorization: Apikey
3429
+ config.api_key['Apikey'] = 'YOUR API KEY'
3430
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3431
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3432
+ end
3433
+
3434
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3435
+
3436
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3437
+
3438
+
3439
+ begin
3440
+ #Convert PowerPoint PPTX Presentation to PDF
3441
+ result = api_instance.convert_document_pptx_to_pdf(input_file)
3442
+ p result
3443
+ rescue CloudmersiveConvertApiClient::ApiError => e
3444
+ puts "Exception when calling ConvertDocumentApi->convert_document_pptx_to_pdf: #{e}"
3445
+ end
3446
+ ```
3447
+
3448
+ ### Parameters
3449
+
3450
+ Name | Type | Description | Notes
3451
+ ------------- | ------------- | ------------- | -------------
3452
+ **input_file** | **File**| Input file to perform the operation on. |
3453
+
3454
+ ### Return type
3455
+
3456
+ **String**
3457
+
3458
+ ### Authorization
3459
+
3460
+ [Apikey](../README.md#Apikey)
3461
+
3462
+ ### HTTP request headers
3463
+
3464
+ - **Content-Type**: multipart/form-data
3465
+ - **Accept**: application/octet-stream
3466
+
3467
+
3468
+
3469
+ # **convert_document_pptx_to_png**
3470
+ > PptxToPngResult convert_document_pptx_to_png(input_file)
3471
+
3472
+ Convert PowerPoint PPTX to PNG image array
3473
+
3474
+ Converts a PowerPoint Presentation (PPTX) file to an array of PNG images, one for each page.
3475
+
3476
+ ### Example
3477
+ ```ruby
3478
+ # load the gem
3479
+ require 'cloudmersive-convert-api-client'
3480
+ # setup authorization
3481
+ CloudmersiveConvertApiClient.configure do |config|
3482
+ # Configure API key authorization: Apikey
3483
+ config.api_key['Apikey'] = 'YOUR API KEY'
3484
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3485
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3486
+ end
3487
+
3488
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3489
+
3490
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3491
+
3492
+
3493
+ begin
3494
+ #Convert PowerPoint PPTX to PNG image array
3495
+ result = api_instance.convert_document_pptx_to_png(input_file)
3496
+ p result
3497
+ rescue CloudmersiveConvertApiClient::ApiError => e
3498
+ puts "Exception when calling ConvertDocumentApi->convert_document_pptx_to_png: #{e}"
3499
+ end
3500
+ ```
3501
+
3502
+ ### Parameters
3503
+
3504
+ Name | Type | Description | Notes
3505
+ ------------- | ------------- | ------------- | -------------
3506
+ **input_file** | **File**| Input file to perform the operation on. |
3507
+
3508
+ ### Return type
3509
+
3510
+ [**PptxToPngResult**](PptxToPngResult.md)
3511
+
3512
+ ### Authorization
3513
+
3514
+ [Apikey](../README.md#Apikey)
3515
+
3516
+ ### HTTP request headers
3517
+
3518
+ - **Content-Type**: multipart/form-data
3519
+ - **Accept**: application/json, text/json, application/xml, text/xml
3520
+
3521
+
3522
+
3523
+ # **convert_document_pptx_to_txt**
3524
+ > TextConversionResult convert_document_pptx_to_txt(input_file)
3525
+
3526
+ Convert PowerPoint PPTX Presentation to Text (txt)
3527
+
3528
+ Convert Office PowerPoint Documents (pptx) to standard Text
3529
+
3530
+ ### Example
3531
+ ```ruby
3532
+ # load the gem
3533
+ require 'cloudmersive-convert-api-client'
3534
+ # setup authorization
3535
+ CloudmersiveConvertApiClient.configure do |config|
3536
+ # Configure API key authorization: Apikey
3537
+ config.api_key['Apikey'] = 'YOUR API KEY'
3538
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3539
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3540
+ end
3541
+
3542
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3543
+
3544
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3545
+
3546
+
3547
+ begin
3548
+ #Convert PowerPoint PPTX Presentation to Text (txt)
3549
+ result = api_instance.convert_document_pptx_to_txt(input_file)
3550
+ p result
3551
+ rescue CloudmersiveConvertApiClient::ApiError => e
3552
+ puts "Exception when calling ConvertDocumentApi->convert_document_pptx_to_txt: #{e}"
3553
+ end
3554
+ ```
3555
+
3556
+ ### Parameters
3557
+
3558
+ Name | Type | Description | Notes
3559
+ ------------- | ------------- | ------------- | -------------
3560
+ **input_file** | **File**| Input file to perform the operation on. |
3561
+
3562
+ ### Return type
3563
+
3564
+ [**TextConversionResult**](TextConversionResult.md)
3565
+
3566
+ ### Authorization
3567
+
3568
+ [Apikey](../README.md#Apikey)
3569
+
3570
+ ### HTTP request headers
3571
+
3572
+ - **Content-Type**: multipart/form-data
3573
+ - **Accept**: application/json, text/json, application/xml, text/xml
3574
+
3575
+
3576
+
3577
+ # **convert_document_rtf_to_docx**
3578
+ > String convert_document_rtf_to_docx(input_file)
3579
+
3580
+ Convert Rich Text Format RTF to DOCX Document
3581
+
3582
+ Convert Rich Text Format Document (RTF) to Word DOCX Document
3583
+
3584
+ ### Example
3585
+ ```ruby
3586
+ # load the gem
3587
+ require 'cloudmersive-convert-api-client'
3588
+ # setup authorization
3589
+ CloudmersiveConvertApiClient.configure do |config|
3590
+ # Configure API key authorization: Apikey
3591
+ config.api_key['Apikey'] = 'YOUR API KEY'
3592
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3593
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3594
+ end
3595
+
3596
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3597
+
3598
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3599
+
3600
+
3601
+ begin
3602
+ #Convert Rich Text Format RTF to DOCX Document
3603
+ result = api_instance.convert_document_rtf_to_docx(input_file)
3604
+ p result
3605
+ rescue CloudmersiveConvertApiClient::ApiError => e
3606
+ puts "Exception when calling ConvertDocumentApi->convert_document_rtf_to_docx: #{e}"
3607
+ end
3608
+ ```
3609
+
3610
+ ### Parameters
3611
+
3612
+ Name | Type | Description | Notes
3613
+ ------------- | ------------- | ------------- | -------------
3614
+ **input_file** | **File**| Input file to perform the operation on. |
3615
+
3616
+ ### Return type
3617
+
3618
+ **String**
3619
+
3620
+ ### Authorization
3621
+
3622
+ [Apikey](../README.md#Apikey)
3623
+
3624
+ ### HTTP request headers
3625
+
3626
+ - **Content-Type**: multipart/form-data
3627
+ - **Accept**: application/octet-stream
3628
+
3629
+
3630
+
3631
+ # **convert_document_rtf_to_html**
3632
+ > String convert_document_rtf_to_html(input_file)
3633
+
3634
+ Convert Rich Text Format RTF to HTML Document
3635
+
3636
+ Convert Rich Text Format Document (RTF) to HTML Document
3637
+
3638
+ ### Example
3639
+ ```ruby
3640
+ # load the gem
3641
+ require 'cloudmersive-convert-api-client'
3642
+ # setup authorization
3643
+ CloudmersiveConvertApiClient.configure do |config|
3644
+ # Configure API key authorization: Apikey
3645
+ config.api_key['Apikey'] = 'YOUR API KEY'
3646
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3647
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3648
+ end
3649
+
3650
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3651
+
3652
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3653
+
3654
+
3655
+ begin
3656
+ #Convert Rich Text Format RTF to HTML Document
3657
+ result = api_instance.convert_document_rtf_to_html(input_file)
3658
+ p result
3659
+ rescue CloudmersiveConvertApiClient::ApiError => e
3660
+ puts "Exception when calling ConvertDocumentApi->convert_document_rtf_to_html: #{e}"
3661
+ end
3662
+ ```
3663
+
3664
+ ### Parameters
3665
+
3666
+ Name | Type | Description | Notes
3667
+ ------------- | ------------- | ------------- | -------------
3668
+ **input_file** | **File**| Input file to perform the operation on. |
3669
+
3670
+ ### Return type
3671
+
3672
+ **String**
3673
+
3674
+ ### Authorization
3675
+
3676
+ [Apikey](../README.md#Apikey)
3677
+
3678
+ ### HTTP request headers
3679
+
3680
+ - **Content-Type**: multipart/form-data
3681
+ - **Accept**: application/octet-stream
3682
+
3683
+
3684
+
3685
+ # **convert_document_rtf_to_jpg**
3686
+ > RtfToJpgResult convert_document_rtf_to_jpg(input_file, opts)
3687
+
3688
+ Convert Rich Text Format RTF to JPG/JPEG image array
3689
+
3690
+ Converts a Rich Text Format Document (RTF) to an array of JPG/JPEG images, one for each page. Customize image quality using quality header.
3691
+
3692
+ ### Example
3693
+ ```ruby
3694
+ # load the gem
3695
+ require 'cloudmersive-convert-api-client'
3696
+ # setup authorization
3697
+ CloudmersiveConvertApiClient.configure do |config|
3698
+ # Configure API key authorization: Apikey
3699
+ config.api_key['Apikey'] = 'YOUR API KEY'
3700
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3701
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3702
+ end
3703
+
3704
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3705
+
3706
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3707
+
3708
+ opts = {
3709
+ quality: 56 # Integer | Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75.
3710
+ }
3711
+
3712
+ begin
3713
+ #Convert Rich Text Format RTF to JPG/JPEG image array
3714
+ result = api_instance.convert_document_rtf_to_jpg(input_file, opts)
3715
+ p result
3716
+ rescue CloudmersiveConvertApiClient::ApiError => e
3717
+ puts "Exception when calling ConvertDocumentApi->convert_document_rtf_to_jpg: #{e}"
3718
+ end
3719
+ ```
3720
+
3721
+ ### Parameters
3722
+
3723
+ Name | Type | Description | Notes
3724
+ ------------- | ------------- | ------------- | -------------
3725
+ **input_file** | **File**| Input file to perform the operation on. |
3726
+ **quality** | **Integer**| Optional; Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75. Default value is 75. | [optional]
3727
+
3728
+ ### Return type
3729
+
3730
+ [**RtfToJpgResult**](RtfToJpgResult.md)
3731
+
3732
+ ### Authorization
3733
+
3734
+ [Apikey](../README.md#Apikey)
3735
+
3736
+ ### HTTP request headers
3737
+
3738
+ - **Content-Type**: multipart/form-data
3739
+ - **Accept**: application/json, text/json, application/xml, text/xml
3740
+
3741
+
3742
+
3743
+ # **convert_document_rtf_to_pdf**
3744
+ > String convert_document_rtf_to_pdf(input_file)
3745
+
3746
+ Convert Rich Text Format RTF to PDF
3747
+
3748
+ Convert Rich Text Format Document (RTF) to standard PDF
3749
+
3750
+ ### Example
3751
+ ```ruby
3752
+ # load the gem
3753
+ require 'cloudmersive-convert-api-client'
3754
+ # setup authorization
3755
+ CloudmersiveConvertApiClient.configure do |config|
3756
+ # Configure API key authorization: Apikey
3757
+ config.api_key['Apikey'] = 'YOUR API KEY'
3758
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3759
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3760
+ end
3761
+
3762
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3763
+
3764
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3765
+
3766
+
3767
+ begin
3768
+ #Convert Rich Text Format RTF to PDF
3769
+ result = api_instance.convert_document_rtf_to_pdf(input_file)
3770
+ p result
3771
+ rescue CloudmersiveConvertApiClient::ApiError => e
3772
+ puts "Exception when calling ConvertDocumentApi->convert_document_rtf_to_pdf: #{e}"
3773
+ end
3774
+ ```
3775
+
3776
+ ### Parameters
3777
+
3778
+ Name | Type | Description | Notes
3779
+ ------------- | ------------- | ------------- | -------------
3780
+ **input_file** | **File**| Input file to perform the operation on. |
3781
+
3782
+ ### Return type
3783
+
3784
+ **String**
3785
+
3786
+ ### Authorization
3787
+
3788
+ [Apikey](../README.md#Apikey)
3789
+
3790
+ ### HTTP request headers
3791
+
3792
+ - **Content-Type**: multipart/form-data
3793
+ - **Accept**: application/octet-stream
3794
+
3795
+
3796
+
3797
+ # **convert_document_rtf_to_png**
3798
+ > RtfToPngResult convert_document_rtf_to_png(input_file)
3799
+
3800
+ Convert Rich Text Format RTF to PNG image array
3801
+
3802
+ Converts a Rich Text Format Document (RTF) to an array of PNG images, one for each page.
3803
+
3804
+ ### Example
3805
+ ```ruby
3806
+ # load the gem
3807
+ require 'cloudmersive-convert-api-client'
3808
+ # setup authorization
3809
+ CloudmersiveConvertApiClient.configure do |config|
3810
+ # Configure API key authorization: Apikey
3811
+ config.api_key['Apikey'] = 'YOUR API KEY'
3812
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3813
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3814
+ end
3815
+
3816
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3817
+
3818
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3819
+
3820
+
3821
+ begin
3822
+ #Convert Rich Text Format RTF to PNG image array
3823
+ result = api_instance.convert_document_rtf_to_png(input_file)
3824
+ p result
3825
+ rescue CloudmersiveConvertApiClient::ApiError => e
3826
+ puts "Exception when calling ConvertDocumentApi->convert_document_rtf_to_png: #{e}"
3827
+ end
3828
+ ```
3829
+
3830
+ ### Parameters
3831
+
3832
+ Name | Type | Description | Notes
3833
+ ------------- | ------------- | ------------- | -------------
3834
+ **input_file** | **File**| Input file to perform the operation on. |
3835
+
3836
+ ### Return type
3837
+
3838
+ [**RtfToPngResult**](RtfToPngResult.md)
3839
+
3840
+ ### Authorization
3841
+
3842
+ [Apikey](../README.md#Apikey)
3843
+
3844
+ ### HTTP request headers
3845
+
3846
+ - **Content-Type**: multipart/form-data
3847
+ - **Accept**: application/json, text/json, application/xml, text/xml
3848
+
3849
+
3850
+
3851
+ # **convert_document_xls_to_csv**
3852
+ > String convert_document_xls_to_csv(input_file)
3853
+
3854
+ Convert Excel XLS (97-03) Spreadsheet to CSV
3855
+
3856
+ Convert/upgrade Office Excel (97-2003) Workbooks (xls) to standard CSV format.
3857
+
3858
+ ### Example
3859
+ ```ruby
3860
+ # load the gem
3861
+ require 'cloudmersive-convert-api-client'
3862
+ # setup authorization
3863
+ CloudmersiveConvertApiClient.configure do |config|
3864
+ # Configure API key authorization: Apikey
3865
+ config.api_key['Apikey'] = 'YOUR API KEY'
3866
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3867
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3868
+ end
3869
+
3870
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3871
+
3872
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3873
+
3874
+
3875
+ begin
3876
+ #Convert Excel XLS (97-03) Spreadsheet to CSV
3877
+ result = api_instance.convert_document_xls_to_csv(input_file)
3878
+ p result
3879
+ rescue CloudmersiveConvertApiClient::ApiError => e
3880
+ puts "Exception when calling ConvertDocumentApi->convert_document_xls_to_csv: #{e}"
3881
+ end
3882
+ ```
3883
+
3884
+ ### Parameters
3885
+
3886
+ Name | Type | Description | Notes
3887
+ ------------- | ------------- | ------------- | -------------
3888
+ **input_file** | **File**| Input file to perform the operation on. |
3889
+
3890
+ ### Return type
3891
+
3892
+ **String**
3893
+
3894
+ ### Authorization
3895
+
3896
+ [Apikey](../README.md#Apikey)
3897
+
3898
+ ### HTTP request headers
3899
+
3900
+ - **Content-Type**: multipart/form-data
3901
+ - **Accept**: application/octet-stream
3902
+
3903
+
3904
+
3905
+ # **convert_document_xls_to_pdf**
3906
+ > String convert_document_xls_to_pdf(input_file)
3907
+
3908
+ Convert Excel XLS (97-03) Spreadsheet to PDF
3909
+
3910
+ Convert Office Excel (97-2003) Workbooks (xls) to standard PDF. Converts all worksheets in the workbook to PDF.
3911
+
3912
+ ### Example
3913
+ ```ruby
3914
+ # load the gem
3915
+ require 'cloudmersive-convert-api-client'
3916
+ # setup authorization
3917
+ CloudmersiveConvertApiClient.configure do |config|
3918
+ # Configure API key authorization: Apikey
3919
+ config.api_key['Apikey'] = 'YOUR API KEY'
3920
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3921
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3922
+ end
3923
+
3924
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3925
+
3926
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3927
+
3928
+
3929
+ begin
3930
+ #Convert Excel XLS (97-03) Spreadsheet to PDF
3931
+ result = api_instance.convert_document_xls_to_pdf(input_file)
3932
+ p result
3933
+ rescue CloudmersiveConvertApiClient::ApiError => e
3934
+ puts "Exception when calling ConvertDocumentApi->convert_document_xls_to_pdf: #{e}"
3935
+ end
3936
+ ```
3937
+
3938
+ ### Parameters
3939
+
3940
+ Name | Type | Description | Notes
3941
+ ------------- | ------------- | ------------- | -------------
3942
+ **input_file** | **File**| Input file to perform the operation on. |
3943
+
3944
+ ### Return type
3945
+
3946
+ **String**
3947
+
3948
+ ### Authorization
3949
+
3950
+ [Apikey](../README.md#Apikey)
3951
+
3952
+ ### HTTP request headers
3953
+
3954
+ - **Content-Type**: multipart/form-data
3955
+ - **Accept**: application/octet-stream
3956
+
3957
+
3958
+
3959
+ # **convert_document_xls_to_xlsx**
3960
+ > String convert_document_xls_to_xlsx(input_file)
3961
+
3962
+ Convert Excel XLS (97-03) Spreadsheet to XLSX
3963
+
3964
+ Convert/upgrade Office Excel (97-2003) Workbooks (xls) to modern XLSX format.
3965
+
3966
+ ### Example
3967
+ ```ruby
3968
+ # load the gem
3969
+ require 'cloudmersive-convert-api-client'
3970
+ # setup authorization
3971
+ CloudmersiveConvertApiClient.configure do |config|
3972
+ # Configure API key authorization: Apikey
3973
+ config.api_key['Apikey'] = 'YOUR API KEY'
3974
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3975
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3976
+ end
3977
+
3978
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
3979
+
3980
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
3981
+
3982
+
3983
+ begin
3984
+ #Convert Excel XLS (97-03) Spreadsheet to XLSX
3985
+ result = api_instance.convert_document_xls_to_xlsx(input_file)
3986
+ p result
3987
+ rescue CloudmersiveConvertApiClient::ApiError => e
3988
+ puts "Exception when calling ConvertDocumentApi->convert_document_xls_to_xlsx: #{e}"
3989
+ end
3990
+ ```
3991
+
3992
+ ### Parameters
3993
+
3994
+ Name | Type | Description | Notes
3995
+ ------------- | ------------- | ------------- | -------------
3996
+ **input_file** | **File**| Input file to perform the operation on. |
3997
+
3998
+ ### Return type
3999
+
4000
+ **String**
4001
+
4002
+ ### Authorization
4003
+
4004
+ [Apikey](../README.md#Apikey)
4005
+
4006
+ ### HTTP request headers
4007
+
4008
+ - **Content-Type**: multipart/form-data
4009
+ - **Accept**: application/octet-stream
4010
+
4011
+
4012
+
4013
+ # **convert_document_xlsx_to_csv**
4014
+ > String convert_document_xlsx_to_csv(input_file, opts)
4015
+
4016
+ Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
4017
+
4018
+ Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format. Supports both XLSX and XLSB file Excel formats. If the input file contains multiple worksheets, the first one is used. If you wish to convert all of the worksheets (not just the first one), be sure to use the xlsx/to/csv/multi API.
4019
+
4020
+ ### Example
4021
+ ```ruby
4022
+ # load the gem
4023
+ require 'cloudmersive-convert-api-client'
4024
+ # setup authorization
4025
+ CloudmersiveConvertApiClient.configure do |config|
4026
+ # Configure API key authorization: Apikey
4027
+ config.api_key['Apikey'] = 'YOUR API KEY'
4028
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4029
+ #config.api_key_prefix['Apikey'] = 'Bearer'
4030
+ end
4031
+
4032
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
4033
+
4034
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
4035
+
4036
+ opts = {
4037
+ output_encoding: 'output_encoding_example' # String | Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
4038
+ }
4039
+
4040
+ begin
4041
+ #Convert Excel XLSX Spreadsheet to CSV, Single Worksheet
4042
+ result = api_instance.convert_document_xlsx_to_csv(input_file, opts)
4043
+ p result
4044
+ rescue CloudmersiveConvertApiClient::ApiError => e
4045
+ puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_csv: #{e}"
4046
+ end
4047
+ ```
4048
+
4049
+ ### Parameters
4050
+
4051
+ Name | Type | Description | Notes
4052
+ ------------- | ------------- | ------------- | -------------
4053
+ **input_file** | **File**| Input file to perform the operation on. |
4054
+ **output_encoding** | **String**| Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8. | [optional]
4055
+
4056
+ ### Return type
4057
+
4058
+ **String**
4059
+
4060
+ ### Authorization
4061
+
4062
+ [Apikey](../README.md#Apikey)
4063
+
4064
+ ### HTTP request headers
4065
+
4066
+ - **Content-Type**: multipart/form-data
4067
+ - **Accept**: application/octet-stream
4068
+
4069
+
4070
+
4071
+ # **convert_document_xlsx_to_csv_multi**
4072
+ > CsvCollection convert_document_xlsx_to_csv_multi(input_file, opts)
4073
+
4074
+ Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
4075
+
4076
+ Convert Office Excel Workbooks (XLSX) to standard Comma-Separated Values (CSV) format, with support for multiple worksheets. Supports both XLSX and XLSB file Excel formats. Returns multiple CSV files, one for each worksheet (tab) in the spreadsheet.
4077
+
4078
+ ### Example
4079
+ ```ruby
4080
+ # load the gem
4081
+ require 'cloudmersive-convert-api-client'
4082
+ # setup authorization
4083
+ CloudmersiveConvertApiClient.configure do |config|
4084
+ # Configure API key authorization: Apikey
4085
+ config.api_key['Apikey'] = 'YOUR API KEY'
4086
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4087
+ #config.api_key_prefix['Apikey'] = 'Bearer'
4088
+ end
4089
+
4090
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
4091
+
4092
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
4093
+
4094
+ opts = {
4095
+ output_encoding: 'output_encoding_example' # String | Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8.
4096
+ }
4097
+
4098
+ begin
4099
+ #Convert Excel XLSX Spreadsheet to CSV, Multiple Worksheets
4100
+ result = api_instance.convert_document_xlsx_to_csv_multi(input_file, opts)
4101
+ p result
4102
+ rescue CloudmersiveConvertApiClient::ApiError => e
4103
+ puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_csv_multi: #{e}"
4104
+ end
4105
+ ```
4106
+
4107
+ ### Parameters
4108
+
4109
+ Name | Type | Description | Notes
4110
+ ------------- | ------------- | ------------- | -------------
4111
+ **input_file** | **File**| Input file to perform the operation on. |
4112
+ **output_encoding** | **String**| Optional, set the output text encoding for the result; possible values are UTF-8, ASCII and UTF-32. Default is UTF-8. | [optional]
4113
+
4114
+ ### Return type
4115
+
4116
+ [**CsvCollection**](CsvCollection.md)
4117
+
4118
+ ### Authorization
4119
+
4120
+ [Apikey](../README.md#Apikey)
4121
+
4122
+ ### HTTP request headers
4123
+
4124
+ - **Content-Type**: multipart/form-data
4125
+ - **Accept**: application/octet-stream
4126
+
4127
+
4128
+
4129
+ # **convert_document_xlsx_to_html**
4130
+ > String convert_document_xlsx_to_html(input_file)
4131
+
4132
+ Convert Excel XLSX Spreadsheet to HTML Document
4133
+
4134
+ Convert Office Excel Spreadsheet (XLSX) to HTML Document. Converts all worksheets to HTML. Supports both XLSX and XLSB Excel file formats.
4135
+
4136
+ ### Example
4137
+ ```ruby
4138
+ # load the gem
4139
+ require 'cloudmersive-convert-api-client'
4140
+ # setup authorization
4141
+ CloudmersiveConvertApiClient.configure do |config|
4142
+ # Configure API key authorization: Apikey
4143
+ config.api_key['Apikey'] = 'YOUR API KEY'
4144
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4145
+ #config.api_key_prefix['Apikey'] = 'Bearer'
4146
+ end
4147
+
4148
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
4149
+
4150
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
4151
+
4152
+
4153
+ begin
4154
+ #Convert Excel XLSX Spreadsheet to HTML Document
4155
+ result = api_instance.convert_document_xlsx_to_html(input_file)
4156
+ p result
4157
+ rescue CloudmersiveConvertApiClient::ApiError => e
4158
+ puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_html: #{e}"
4159
+ end
4160
+ ```
4161
+
4162
+ ### Parameters
4163
+
4164
+ Name | Type | Description | Notes
4165
+ ------------- | ------------- | ------------- | -------------
4166
+ **input_file** | **File**| Input file to perform the operation on. |
4167
+
4168
+ ### Return type
4169
+
4170
+ **String**
4171
+
4172
+ ### Authorization
4173
+
4174
+ [Apikey](../README.md#Apikey)
4175
+
4176
+ ### HTTP request headers
4177
+
4178
+ - **Content-Type**: multipart/form-data
4179
+ - **Accept**: application/octet-stream
4180
+
4181
+
4182
+
4183
+ # **convert_document_xlsx_to_pdf**
4184
+ > String convert_document_xlsx_to_pdf(input_file)
4185
+
4186
+ Convert Excel XLSX Spreadsheet to PDF
4187
+
4188
+ Convert Office Excel Workbooks (XLSX) to standard PDF. Converts all worksheets in the workbook to PDF. Supports both XLSX and XLSB Excel file formats.
4189
+
4190
+ ### Example
4191
+ ```ruby
4192
+ # load the gem
4193
+ require 'cloudmersive-convert-api-client'
4194
+ # setup authorization
4195
+ CloudmersiveConvertApiClient.configure do |config|
4196
+ # Configure API key authorization: Apikey
4197
+ config.api_key['Apikey'] = 'YOUR API KEY'
4198
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4199
+ #config.api_key_prefix['Apikey'] = 'Bearer'
4200
+ end
4201
+
4202
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
4203
+
4204
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
4205
+
4206
+
4207
+ begin
4208
+ #Convert Excel XLSX Spreadsheet to PDF
4209
+ result = api_instance.convert_document_xlsx_to_pdf(input_file)
4210
+ p result
4211
+ rescue CloudmersiveConvertApiClient::ApiError => e
4212
+ puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_pdf: #{e}"
4213
+ end
4214
+ ```
4215
+
4216
+ ### Parameters
4217
+
4218
+ Name | Type | Description | Notes
4219
+ ------------- | ------------- | ------------- | -------------
4220
+ **input_file** | **File**| Input file to perform the operation on. |
4221
+
4222
+ ### Return type
4223
+
4224
+ **String**
4225
+
4226
+ ### Authorization
4227
+
4228
+ [Apikey](../README.md#Apikey)
4229
+
4230
+ ### HTTP request headers
4231
+
4232
+ - **Content-Type**: multipart/form-data
4233
+ - **Accept**: application/octet-stream
4234
+
4235
+
4236
+
4237
+ # **convert_document_xlsx_to_png**
4238
+ > XlsxToPngResult convert_document_xlsx_to_png(input_file)
4239
+
4240
+ Convert Excel XLSX spreadsheet to PNG image array
4241
+
4242
+ Converts an Excel Spreadsheet (XLSX) file to an array of PNG images, one for each page.
4243
+
4244
+ ### Example
4245
+ ```ruby
4246
+ # load the gem
4247
+ require 'cloudmersive-convert-api-client'
4248
+ # setup authorization
4249
+ CloudmersiveConvertApiClient.configure do |config|
4250
+ # Configure API key authorization: Apikey
4251
+ config.api_key['Apikey'] = 'YOUR API KEY'
4252
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4253
+ #config.api_key_prefix['Apikey'] = 'Bearer'
4254
+ end
4255
+
4256
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
4257
+
4258
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
4259
+
4260
+
4261
+ begin
4262
+ #Convert Excel XLSX spreadsheet to PNG image array
4263
+ result = api_instance.convert_document_xlsx_to_png(input_file)
4264
+ p result
4265
+ rescue CloudmersiveConvertApiClient::ApiError => e
4266
+ puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_png: #{e}"
4267
+ end
4268
+ ```
4269
+
4270
+ ### Parameters
4271
+
4272
+ Name | Type | Description | Notes
4273
+ ------------- | ------------- | ------------- | -------------
4274
+ **input_file** | **File**| Input file to perform the operation on. |
4275
+
4276
+ ### Return type
4277
+
4278
+ [**XlsxToPngResult**](XlsxToPngResult.md)
4279
+
4280
+ ### Authorization
4281
+
4282
+ [Apikey](../README.md#Apikey)
4283
+
4284
+ ### HTTP request headers
4285
+
4286
+ - **Content-Type**: multipart/form-data
4287
+ - **Accept**: application/json, text/json, application/xml, text/xml
4288
+
4289
+
4290
+
4291
+ # **convert_document_xlsx_to_txt**
4292
+ > TextConversionResult convert_document_xlsx_to_txt(input_file)
4293
+
4294
+ Convert Excel XLSX Spreadsheet to Text (txt)
4295
+
4296
+ Convert Office Excel Workbooks (XLSX) to standard Text. Converts all worksheets in the workbook to Text. Supports both XLSX and XLSB file formats. When a spreadsheet contains multiple worksheets, will export all of the text from all of the worksheets. If you wish to export the text from only one worksheet, try using the Split XLSX API to split the spreadsheet into multiple worksheet files, and then run XLSX to Text on the individual worksheet file that you need to extract the text from.
4297
+
4298
+ ### Example
4299
+ ```ruby
4300
+ # load the gem
4301
+ require 'cloudmersive-convert-api-client'
4302
+ # setup authorization
4303
+ CloudmersiveConvertApiClient.configure do |config|
4304
+ # Configure API key authorization: Apikey
4305
+ config.api_key['Apikey'] = 'YOUR API KEY'
4306
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4307
+ #config.api_key_prefix['Apikey'] = 'Bearer'
4308
+ end
4309
+
4310
+ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
4311
+
4312
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
4313
+
4314
+
4315
+ begin
4316
+ #Convert Excel XLSX Spreadsheet to Text (txt)
4317
+ result = api_instance.convert_document_xlsx_to_txt(input_file)
4318
+ p result
4319
+ rescue CloudmersiveConvertApiClient::ApiError => e
4320
+ puts "Exception when calling ConvertDocumentApi->convert_document_xlsx_to_txt: #{e}"
4321
+ end
4322
+ ```
4323
+
4324
+ ### Parameters
4325
+
4326
+ Name | Type | Description | Notes
4327
+ ------------- | ------------- | ------------- | -------------
4328
+ **input_file** | **File**| Input file to perform the operation on. |
4329
+
4330
+ ### Return type
4331
+
4332
+ [**TextConversionResult**](TextConversionResult.md)
4333
+
4334
+ ### Authorization
4335
+
4336
+ [Apikey](../README.md#Apikey)
4337
+
4338
+ ### HTTP request headers
4339
+
4340
+ - **Content-Type**: multipart/form-data
4341
+ - **Accept**: application/json, text/json, application/xml, text/xml
4342
+
4343
+
4344
+