cloudmersive-convert-api-client 2.0.5 → 2.1.1

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