cloudmersive-convert-api-client 2.0.6 → 2.1.2

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 +597 -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 +998 -0
  239. data/docs/ViewerResponse.md +9 -0
  240. data/docs/ViewerToolsApi.md +69 -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 +1013 -0
  278. data/lib/cloudmersive-convert-api-client/api/viewer_tools_api.rb +84 -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 +251 -0
  538. data/spec/api/viewer_tools_api_spec.rb +49 -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,9 @@
1
+ # CloudmersiveConvertApiClient::DocxSetFooterResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
7
+ **edited_document_url** | **String** | URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. | [optional]
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::DocxSetHeaderRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional]
7
+ **input_file_url** | **String** | Optional: URL of a file to operate on as input. This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional]
8
+ **header_to_apply** | [**DocxHeader**](DocxHeader.md) | Header to apply | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::DocxSetHeaderResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
7
+ **edited_document_url** | **String** | URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. | [optional]
8
+
9
+
@@ -0,0 +1,14 @@
1
+ # CloudmersiveConvertApiClient::DocxStyle
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **style_id** | **String** | ID of the style | [optional]
7
+ **path** | **String** | The Path of the location of this object; leave blank for new tables | [optional]
8
+ **bold** | **BOOLEAN** | Style applies bold formatting | [optional]
9
+ **italic** | **BOOLEAN** | Style applies italic formatting | [optional]
10
+ **underline** | **BOOLEAN** | Style applies underline formatting | [optional]
11
+ **font_size** | **String** | Font size | [optional]
12
+ **font_family** | **String** | Font family | [optional]
13
+
14
+
@@ -0,0 +1,46 @@
1
+ # CloudmersiveConvertApiClient::DocxTable
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **table_id** | **String** | The ID of the table; leave blank for new tables | [optional]
7
+ **path** | **String** | The Path of the location of this table object; leave blank for new tables | [optional]
8
+ **width** | **String** | The Width of the table, or 0 if not specified | [optional]
9
+ **width_type** | **String** | The Width configuration type of the table | [optional]
10
+ **table_rows** | [**Array<DocxTableRow>**](DocxTableRow.md) | Rows in the table; this is where the contents is located | [optional]
11
+ **top_border_type** | **String** | Type for the top border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
12
+ **top_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
13
+ **top_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
14
+ **top_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
15
+ **bottom_border_type** | **String** | Type for the bottom border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
16
+ **bottom_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
17
+ **bottom_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
18
+ **bottom_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
19
+ **left_border_type** | **String** | Type for the left border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
20
+ **left_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
21
+ **left_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
22
+ **left_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
23
+ **right_border_type** | **String** | Type for the right border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
24
+ **right_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
25
+ **right_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
26
+ **right_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
27
+ **cell_horizontal_border_type** | **String** | Type for the cell horizontal border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
28
+ **cell_horizontal_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
29
+ **cell_horizontal_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
30
+ **cell_horizontal_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
31
+ **cell_vertical_border_type** | **String** | Type for the cell vertical border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
32
+ **cell_vertical_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
33
+ **cell_vertical_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
34
+ **cell_vertical_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
35
+ **start_border_type** | **String** | Type for the start border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
36
+ **start_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
37
+ **start_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
38
+ **start_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
39
+ **end_border_type** | **String** | Type for the end border - can be a Single, DashDotStroked, Dashed, DashSmallGap, DotDash, DotDotDash, Dotted, Double, DoubleWave, Inset, Nil, None, Outset, Thick, ThickThinLargeGap, ThickThinMediumGap, ThickThinSmallGap, ThinThickLargeGap, ThinThickMediumGap, ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave | [optional]
40
+ **end_border_size** | **Integer** | Width of the border in points (1/72nd of an inch) | [optional]
41
+ **end_border_space** | **Integer** | Spacing around the border in points (1/72nd of an inch) | [optional]
42
+ **end_border_color** | **String** | HTML-style color hex value (do not include a #) | [optional]
43
+ **table_indentation_mode** | **String** | Table indentation type | [optional]
44
+ **table_indentation_width** | **Integer** | Table indentation width | [optional]
45
+
46
+
@@ -0,0 +1,15 @@
1
+ # CloudmersiveConvertApiClient::DocxTableCell
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **cell_index** | **Integer** | The index of the cell, 0-based | [optional]
7
+ **path** | **String** | The Path of the location of this object; leave blank for new tables | [optional]
8
+ **paragraphs** | [**Array<DocxParagraph>**](DocxParagraph.md) | Paragraphs inside the cell; this is where the contents of the cell are stored | [optional]
9
+ **cell_shading_color** | **String** | Color of the cell shading | [optional]
10
+ **cell_shading_fill** | **String** | Fill of the cell shading | [optional]
11
+ **cell_shading_pattern** | **String** | Pattern of the cell shading | [optional]
12
+ **cell_width_mode** | **String** | Width mode of the cell; can be auto (for automatic) or manual | [optional]
13
+ **cell_width** | **String** | Width of the cell | [optional]
14
+
15
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::DocxTableRow
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **row_index** | **Integer** | Index of the row, 0-based | [optional]
7
+ **path** | **String** | The Path of the location of this table row object; leave blank for new tables | [optional]
8
+ **row_cells** | [**Array<DocxTableCell>**](DocxTableCell.md) | Cells in the row; this is where the contents of the row is stored | [optional]
9
+
10
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveConvertApiClient::DocxTemplateApplicationRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **operations** | [**Array<DocxTemplateOperation>**](DocxTemplateOperation.md) | Operations to apply to this template | [optional]
7
+
8
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::DocxTemplateOperation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **action** | **Integer** | Operation action to take; possible values are \"Replace\" | [optional]
7
+ **match_against** | **String** | For Replace operations, the string to match against (to be replaced with ReplaceWith string) | [optional]
8
+ **replace_with** | **String** | For Replace operations, the string to Replace the original string with | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConvertApiClient::DocxText
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **text_index** | **Integer** | Index of the text content in the run; 0-based | [optional]
7
+ **path** | **String** | The Path of the location of this Text object; leave blank for creation | [optional]
8
+ **text_content** | **String** | Text string containing the text content of this text content item | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::DocxToJpgResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **jpg_result_pages** | [**Array<ConvertedJpgPage>**](ConvertedJpgPage.md) | Array of converted pages | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConvertApiClient::DocxToPngResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **png_result_pages** | [**Array<ConvertedPngPage>**](ConvertedPngPage.md) | Array of converted pages | [optional]
8
+
9
+
@@ -0,0 +1,14 @@
1
+ # CloudmersiveConvertApiClient::DocxTopLevelComment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **path** | **String** | Path to the comment in the document | [optional]
7
+ **author** | **String** | Author name of the comment | [optional]
8
+ **author_initials** | **String** | Initials of the author of the comment | [optional]
9
+ **comment_text** | **String** | Text content of the comment | [optional]
10
+ **comment_date** | **DateTime** | Date timestamp of the comment | [optional]
11
+ **reply_child_comments** | [**Array<DocxComment>**](DocxComment.md) | Child comments, that are replies to this one | [optional]
12
+ **done** | **BOOLEAN** | True if this comment is marked as Done in Word, otherwise it is false | [optional]
13
+
14
+
@@ -0,0 +1,3253 @@
1
+ # CloudmersiveConvertApiClient::EditDocumentApi
2
+
3
+ All URIs are relative to *https://api.cloudmersive.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**edit_document_begin_editing**](EditDocumentApi.md#edit_document_begin_editing) | **POST** /convert/edit/begin-editing | Begin editing a document
8
+ [**edit_document_docx_accept_all_track_changes**](EditDocumentApi.md#edit_document_docx_accept_all_track_changes) | **POST** /convert/edit/docx/track-changes/accept-all | Accept all tracked changes, revisions in a Word DOCX document
9
+ [**edit_document_docx_body**](EditDocumentApi.md#edit_document_docx_body) | **POST** /convert/edit/docx/get-body | Get body from a Word DOCX document
10
+ [**edit_document_docx_create_blank_document**](EditDocumentApi.md#edit_document_docx_create_blank_document) | **POST** /convert/edit/docx/create/blank | Create a blank Word DOCX document
11
+ [**edit_document_docx_delete_pages**](EditDocumentApi.md#edit_document_docx_delete_pages) | **POST** /convert/edit/docx/delete-pages | Delete, remove pages from a Word DOCX document
12
+ [**edit_document_docx_delete_table_row**](EditDocumentApi.md#edit_document_docx_delete_table_row) | **POST** /convert/edit/docx/delete-table-row | Deletes a table row in an existing table in a Word DOCX document
13
+ [**edit_document_docx_delete_table_row_range**](EditDocumentApi.md#edit_document_docx_delete_table_row_range) | **POST** /convert/edit/docx/delete-table-row/range | Deletes a range of multiple table rows in an existing table in a Word DOCX document
14
+ [**edit_document_docx_disable_track_changes**](EditDocumentApi.md#edit_document_docx_disable_track_changes) | **POST** /convert/edit/docx/track-changes/disable | Disable track changes, revisions in a Word DOCX document
15
+ [**edit_document_docx_enable_track_changes**](EditDocumentApi.md#edit_document_docx_enable_track_changes) | **POST** /convert/edit/docx/track-changes/enable | Enable track changes, revisions in a Word DOCX document
16
+ [**edit_document_docx_find_paragraph**](EditDocumentApi.md#edit_document_docx_find_paragraph) | **POST** /convert/edit/docx/find/paragraph | Find matching paragraphs in a Word DOCX document
17
+ [**edit_document_docx_get_comments**](EditDocumentApi.md#edit_document_docx_get_comments) | **POST** /convert/edit/docx/get-comments/flat-list | Get comments from a Word DOCX document as a flat list
18
+ [**edit_document_docx_get_comments_hierarchical**](EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
19
+ [**edit_document_docx_get_headers_and_footers**](EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
20
+ [**edit_document_docx_get_images**](EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a Word DOCX document
21
+ [**edit_document_docx_get_sections**](EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a Word DOCX document
22
+ [**edit_document_docx_get_styles**](EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a Word DOCX document
23
+ [**edit_document_docx_get_table_by_index**](EditDocumentApi.md#edit_document_docx_get_table_by_index) | **POST** /convert/edit/docx/get-table/by-index | Get a specific table by index in a Word DOCX document
24
+ [**edit_document_docx_get_table_row**](EditDocumentApi.md#edit_document_docx_get_table_row) | **POST** /convert/edit/docx/get-table-row | Gets the contents of an existing table row in an existing table in a Word DOCX document
25
+ [**edit_document_docx_get_tables**](EditDocumentApi.md#edit_document_docx_get_tables) | **POST** /convert/edit/docx/get-tables | Get all tables in Word DOCX document
26
+ [**edit_document_docx_insert_comment_on_paragraph**](EditDocumentApi.md#edit_document_docx_insert_comment_on_paragraph) | **POST** /convert/edit/docx/insert-comment/on/paragraph | Insert a new comment into a Word DOCX document attached to a paragraph
27
+ [**edit_document_docx_insert_image**](EditDocumentApi.md#edit_document_docx_insert_image) | **POST** /convert/edit/docx/insert-image | Insert image into a Word DOCX document
28
+ [**edit_document_docx_insert_paragraph**](EditDocumentApi.md#edit_document_docx_insert_paragraph) | **POST** /convert/edit/docx/insert-paragraph | Insert a new paragraph into a Word DOCX document
29
+ [**edit_document_docx_insert_table**](EditDocumentApi.md#edit_document_docx_insert_table) | **POST** /convert/edit/docx/insert-table | Insert a new table into a Word DOCX document
30
+ [**edit_document_docx_insert_table_row**](EditDocumentApi.md#edit_document_docx_insert_table_row) | **POST** /convert/edit/docx/insert-table-row | Insert a new row into an existing table in a Word DOCX document
31
+ [**edit_document_docx_pages**](EditDocumentApi.md#edit_document_docx_pages) | **POST** /convert/edit/docx/get-pages | Get pages and content from a Word DOCX document
32
+ [**edit_document_docx_remove_all_comments**](EditDocumentApi.md#edit_document_docx_remove_all_comments) | **POST** /convert/edit/docx/comments/remove-all | Remove all comments from a Word DOCX document
33
+ [**edit_document_docx_remove_headers_and_footers**](EditDocumentApi.md#edit_document_docx_remove_headers_and_footers) | **POST** /convert/edit/docx/remove-headers-and-footers | Remove headers and footers from Word DOCX document
34
+ [**edit_document_docx_remove_object**](EditDocumentApi.md#edit_document_docx_remove_object) | **POST** /convert/edit/docx/remove-object | Delete any object in a Word DOCX document
35
+ [**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
36
+ [**edit_document_docx_replace_multi**](EditDocumentApi.md#edit_document_docx_replace_multi) | **POST** /convert/edit/docx/replace-all/multi | Replace multiple strings in Word DOCX document
37
+ [**edit_document_docx_replace_paragraph**](EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
38
+ [**edit_document_docx_set_footer**](EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
39
+ [**edit_document_docx_set_footer_add_page_number**](EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
40
+ [**edit_document_docx_set_header**](EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
41
+ [**edit_document_docx_update_table_cell**](EditDocumentApi.md#edit_document_docx_update_table_cell) | **POST** /convert/edit/docx/update-table-cell | Update, set contents of a table cell in an existing table in a Word DOCX document
42
+ [**edit_document_docx_update_table_row**](EditDocumentApi.md#edit_document_docx_update_table_row) | **POST** /convert/edit/docx/update-table-row | Update, set contents of a table row in an existing table in a Word DOCX document
43
+ [**edit_document_finish_editing**](EditDocumentApi.md#edit_document_finish_editing) | **POST** /convert/edit/finish-editing | Finish editing document, and download result from document editing
44
+ [**edit_document_pptx_delete_slides**](EditDocumentApi.md#edit_document_pptx_delete_slides) | **POST** /convert/edit/pptx/delete-slides | Delete, remove slides from a PowerPoint PPTX presentation document
45
+ [**edit_document_pptx_replace**](EditDocumentApi.md#edit_document_pptx_replace) | **POST** /convert/edit/pptx/replace-all | Replace string in PowerPoint PPTX presentation
46
+ [**edit_document_xlsx_append_row**](EditDocumentApi.md#edit_document_xlsx_append_row) | **POST** /convert/edit/xlsx/append-row | Append row to a Excel XLSX spreadsheet, worksheet
47
+ [**edit_document_xlsx_clear_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_clear_cell_by_index) | **POST** /convert/edit/xlsx/clear-cell/by-index | Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
48
+ [**edit_document_xlsx_clear_row**](EditDocumentApi.md#edit_document_xlsx_clear_row) | **POST** /convert/edit/xlsx/clear-row | Clear row from a Excel XLSX spreadsheet, worksheet
49
+ [**edit_document_xlsx_create_blank_spreadsheet**](EditDocumentApi.md#edit_document_xlsx_create_blank_spreadsheet) | **POST** /convert/edit/xlsx/create/blank | Create a blank Excel XLSX spreadsheet
50
+ [**edit_document_xlsx_create_spreadsheet_from_data**](EditDocumentApi.md#edit_document_xlsx_create_spreadsheet_from_data) | **POST** /convert/edit/xlsx/create/from/data | Create a new Excel XLSX spreadsheet from column and row data
51
+ [**edit_document_xlsx_delete_worksheet**](EditDocumentApi.md#edit_document_xlsx_delete_worksheet) | **POST** /convert/edit/xlsx/delete-worksheet | Delete, remove worksheet from an Excel XLSX spreadsheet document
52
+ [**edit_document_xlsx_disable_shared_workbook**](EditDocumentApi.md#edit_document_xlsx_disable_shared_workbook) | **POST** /convert/edit/xlsx/configuration/disable-shared-workbook | Disable Shared Workbook (legacy) in Excel XLSX spreadsheet
53
+ [**edit_document_xlsx_enable_shared_workbook**](EditDocumentApi.md#edit_document_xlsx_enable_shared_workbook) | **POST** /convert/edit/xlsx/configuration/enable-shared-workbook | Enable Shared Workbook (legacy) in Excel XLSX spreadsheet
54
+ [**edit_document_xlsx_get_cell_by_identifier**](EditDocumentApi.md#edit_document_xlsx_get_cell_by_identifier) | **POST** /convert/edit/xlsx/get-cell/by-identifier | Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
55
+ [**edit_document_xlsx_get_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_get_cell_by_index) | **POST** /convert/edit/xlsx/get-cell/by-index | Get cell from an Excel XLSX spreadsheet, worksheet by index
56
+ [**edit_document_xlsx_get_columns**](EditDocumentApi.md#edit_document_xlsx_get_columns) | **POST** /convert/edit/xlsx/get-columns | Get columns from a Excel XLSX spreadsheet, worksheet
57
+ [**edit_document_xlsx_get_images**](EditDocumentApi.md#edit_document_xlsx_get_images) | **POST** /convert/edit/xlsx/get-images | Get images from a Excel XLSX spreadsheet, worksheet
58
+ [**edit_document_xlsx_get_rows_and_cells**](EditDocumentApi.md#edit_document_xlsx_get_rows_and_cells) | **POST** /convert/edit/xlsx/get-rows-and-cells | Get rows and cells from a Excel XLSX spreadsheet, worksheet
59
+ [**edit_document_xlsx_get_specific_row**](EditDocumentApi.md#edit_document_xlsx_get_specific_row) | **POST** /convert/edit/xlsx/get-specific-row | Get a specific row from a Excel XLSX spreadsheet, worksheet by path
60
+ [**edit_document_xlsx_get_styles**](EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
61
+ [**edit_document_xlsx_get_worksheets**](EditDocumentApi.md#edit_document_xlsx_get_worksheets) | **POST** /convert/edit/xlsx/get-worksheets | Get worksheets from a Excel XLSX spreadsheet
62
+ [**edit_document_xlsx_insert_worksheet**](EditDocumentApi.md#edit_document_xlsx_insert_worksheet) | **POST** /convert/edit/xlsx/insert-worksheet | Insert a new worksheet into an Excel XLSX spreadsheet
63
+ [**edit_document_xlsx_rename_worksheet**](EditDocumentApi.md#edit_document_xlsx_rename_worksheet) | **POST** /convert/edit/xlsx/rename-worksheet | Rename a specific worksheet in a Excel XLSX spreadsheet
64
+ [**edit_document_xlsx_set_cell_by_identifier**](EditDocumentApi.md#edit_document_xlsx_set_cell_by_identifier) | **POST** /convert/edit/xlsx/set-cell/by-identifier | Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier
65
+ [**edit_document_xlsx_set_cell_by_index**](EditDocumentApi.md#edit_document_xlsx_set_cell_by_index) | **POST** /convert/edit/xlsx/set-cell/by-index | Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
66
+
67
+
68
+ # **edit_document_begin_editing**
69
+ > String edit_document_begin_editing(input_file)
70
+
71
+ Begin editing a document
72
+
73
+ Uploads a document to Cloudmersive to begin a series of one or more editing operations. To edit a document, first call Begin Editing on the document. Then perform operations on the document using the secure URL returned from BeginEditing, such as Word DOCX Delete Pages and Insert Table. Finally, perform finish editing on the URL to return the resulting edited document. The editing URL is temporary and only stored in-memory cache, and will automatically expire from the cache after 30 minutes, and cannot be directly accessed.
74
+
75
+ ### Example
76
+ ```ruby
77
+ # load the gem
78
+ require 'cloudmersive-convert-api-client'
79
+ # setup authorization
80
+ CloudmersiveConvertApiClient.configure do |config|
81
+ # Configure API key authorization: Apikey
82
+ config.api_key['Apikey'] = 'YOUR API KEY'
83
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
84
+ #config.api_key_prefix['Apikey'] = 'Bearer'
85
+ end
86
+
87
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
88
+
89
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
90
+
91
+
92
+ begin
93
+ #Begin editing a document
94
+ result = api_instance.edit_document_begin_editing(input_file)
95
+ p result
96
+ rescue CloudmersiveConvertApiClient::ApiError => e
97
+ puts "Exception when calling EditDocumentApi->edit_document_begin_editing: #{e}"
98
+ end
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+ Name | Type | Description | Notes
104
+ ------------- | ------------- | ------------- | -------------
105
+ **input_file** | **File**| Input file to perform the operation on. |
106
+
107
+ ### Return type
108
+
109
+ **String**
110
+
111
+ ### Authorization
112
+
113
+ [Apikey](../README.md#Apikey)
114
+
115
+ ### HTTP request headers
116
+
117
+ - **Content-Type**: multipart/form-data
118
+ - **Accept**: application/json, text/json, application/xml, text/xml
119
+
120
+
121
+
122
+ # **edit_document_docx_accept_all_track_changes**
123
+ > String edit_document_docx_accept_all_track_changes(input_file)
124
+
125
+ Accept all tracked changes, revisions in a Word DOCX document
126
+
127
+ Accepts all tracked changes and revisions in a Word DOCX document. This will accept all pending changes in the document when tracked changes is turned on. Track changes will remain on (if it is on) after this oepration is completed.
128
+
129
+ ### Example
130
+ ```ruby
131
+ # load the gem
132
+ require 'cloudmersive-convert-api-client'
133
+ # setup authorization
134
+ CloudmersiveConvertApiClient.configure do |config|
135
+ # Configure API key authorization: Apikey
136
+ config.api_key['Apikey'] = 'YOUR API KEY'
137
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
138
+ #config.api_key_prefix['Apikey'] = 'Bearer'
139
+ end
140
+
141
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
142
+
143
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
144
+
145
+
146
+ begin
147
+ #Accept all tracked changes, revisions in a Word DOCX document
148
+ result = api_instance.edit_document_docx_accept_all_track_changes(input_file)
149
+ p result
150
+ rescue CloudmersiveConvertApiClient::ApiError => e
151
+ puts "Exception when calling EditDocumentApi->edit_document_docx_accept_all_track_changes: #{e}"
152
+ end
153
+ ```
154
+
155
+ ### Parameters
156
+
157
+ Name | Type | Description | Notes
158
+ ------------- | ------------- | ------------- | -------------
159
+ **input_file** | **File**| Input file to perform the operation on. |
160
+
161
+ ### Return type
162
+
163
+ **String**
164
+
165
+ ### Authorization
166
+
167
+ [Apikey](../README.md#Apikey)
168
+
169
+ ### HTTP request headers
170
+
171
+ - **Content-Type**: multipart/form-data
172
+ - **Accept**: application/json, text/json, application/xml, text/xml
173
+
174
+
175
+
176
+ # **edit_document_docx_body**
177
+ > GetDocxBodyResponse edit_document_docx_body(req_config)
178
+
179
+ Get body from a Word DOCX document
180
+
181
+ Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document
182
+
183
+ ### Example
184
+ ```ruby
185
+ # load the gem
186
+ require 'cloudmersive-convert-api-client'
187
+ # setup authorization
188
+ CloudmersiveConvertApiClient.configure do |config|
189
+ # Configure API key authorization: Apikey
190
+ config.api_key['Apikey'] = 'YOUR API KEY'
191
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
192
+ #config.api_key_prefix['Apikey'] = 'Bearer'
193
+ end
194
+
195
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
196
+
197
+ req_config = CloudmersiveConvertApiClient::GetDocxBodyRequest.new # GetDocxBodyRequest | Document input request
198
+
199
+
200
+ begin
201
+ #Get body from a Word DOCX document
202
+ result = api_instance.edit_document_docx_body(req_config)
203
+ p result
204
+ rescue CloudmersiveConvertApiClient::ApiError => e
205
+ puts "Exception when calling EditDocumentApi->edit_document_docx_body: #{e}"
206
+ end
207
+ ```
208
+
209
+ ### Parameters
210
+
211
+ Name | Type | Description | Notes
212
+ ------------- | ------------- | ------------- | -------------
213
+ **req_config** | [**GetDocxBodyRequest**](GetDocxBodyRequest.md)| Document input request |
214
+
215
+ ### Return type
216
+
217
+ [**GetDocxBodyResponse**](GetDocxBodyResponse.md)
218
+
219
+ ### Authorization
220
+
221
+ [Apikey](../README.md#Apikey)
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
226
+ - **Accept**: application/json, text/json, application/xml, text/xml
227
+
228
+
229
+
230
+ # **edit_document_docx_create_blank_document**
231
+ > CreateBlankDocxResponse edit_document_docx_create_blank_document(input)
232
+
233
+ Create a blank Word DOCX document
234
+
235
+ Returns a blank Word DOCX Document format file. The file is blank, with no contents. Use additional editing commands such as Insert Paragraph or Insert Table or Insert Image to populate the document.
236
+
237
+ ### Example
238
+ ```ruby
239
+ # load the gem
240
+ require 'cloudmersive-convert-api-client'
241
+ # setup authorization
242
+ CloudmersiveConvertApiClient.configure do |config|
243
+ # Configure API key authorization: Apikey
244
+ config.api_key['Apikey'] = 'YOUR API KEY'
245
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
246
+ #config.api_key_prefix['Apikey'] = 'Bearer'
247
+ end
248
+
249
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
250
+
251
+ input = CloudmersiveConvertApiClient::CreateBlankDocxRequest.new # CreateBlankDocxRequest | Document input request
252
+
253
+
254
+ begin
255
+ #Create a blank Word DOCX document
256
+ result = api_instance.edit_document_docx_create_blank_document(input)
257
+ p result
258
+ rescue CloudmersiveConvertApiClient::ApiError => e
259
+ puts "Exception when calling EditDocumentApi->edit_document_docx_create_blank_document: #{e}"
260
+ end
261
+ ```
262
+
263
+ ### Parameters
264
+
265
+ Name | Type | Description | Notes
266
+ ------------- | ------------- | ------------- | -------------
267
+ **input** | [**CreateBlankDocxRequest**](CreateBlankDocxRequest.md)| Document input request |
268
+
269
+ ### Return type
270
+
271
+ [**CreateBlankDocxResponse**](CreateBlankDocxResponse.md)
272
+
273
+ ### Authorization
274
+
275
+ [Apikey](../README.md#Apikey)
276
+
277
+ ### HTTP request headers
278
+
279
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
280
+ - **Accept**: application/json, text/json, application/xml, text/xml
281
+
282
+
283
+
284
+ # **edit_document_docx_delete_pages**
285
+ > String edit_document_docx_delete_pages(req_config)
286
+
287
+ Delete, remove pages from a Word DOCX document
288
+
289
+ Returns the edited Word Document in the Word Document (DOCX) format file with the specified pages removed
290
+
291
+ ### Example
292
+ ```ruby
293
+ # load the gem
294
+ require 'cloudmersive-convert-api-client'
295
+ # setup authorization
296
+ CloudmersiveConvertApiClient.configure do |config|
297
+ # Configure API key authorization: Apikey
298
+ config.api_key['Apikey'] = 'YOUR API KEY'
299
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
300
+ #config.api_key_prefix['Apikey'] = 'Bearer'
301
+ end
302
+
303
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
304
+
305
+ req_config = CloudmersiveConvertApiClient::RemoveDocxPagesRequest.new # RemoveDocxPagesRequest | Document input request
306
+
307
+
308
+ begin
309
+ #Delete, remove pages from a Word DOCX document
310
+ result = api_instance.edit_document_docx_delete_pages(req_config)
311
+ p result
312
+ rescue CloudmersiveConvertApiClient::ApiError => e
313
+ puts "Exception when calling EditDocumentApi->edit_document_docx_delete_pages: #{e}"
314
+ end
315
+ ```
316
+
317
+ ### Parameters
318
+
319
+ Name | Type | Description | Notes
320
+ ------------- | ------------- | ------------- | -------------
321
+ **req_config** | [**RemoveDocxPagesRequest**](RemoveDocxPagesRequest.md)| Document input request |
322
+
323
+ ### Return type
324
+
325
+ **String**
326
+
327
+ ### Authorization
328
+
329
+ [Apikey](../README.md#Apikey)
330
+
331
+ ### HTTP request headers
332
+
333
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
334
+ - **Accept**: application/octet-stream
335
+
336
+
337
+
338
+ # **edit_document_docx_delete_table_row**
339
+ > DeleteDocxTableRowResponse edit_document_docx_delete_table_row(req_config)
340
+
341
+ Deletes a table row in an existing table in a Word DOCX document
342
+
343
+ Deletes an existing table row in a Word DOCX Document and returns the result.
344
+
345
+ ### Example
346
+ ```ruby
347
+ # load the gem
348
+ require 'cloudmersive-convert-api-client'
349
+ # setup authorization
350
+ CloudmersiveConvertApiClient.configure do |config|
351
+ # Configure API key authorization: Apikey
352
+ config.api_key['Apikey'] = 'YOUR API KEY'
353
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
354
+ #config.api_key_prefix['Apikey'] = 'Bearer'
355
+ end
356
+
357
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
358
+
359
+ req_config = CloudmersiveConvertApiClient::DeleteDocxTableRowRequest.new # DeleteDocxTableRowRequest | Document input request
360
+
361
+
362
+ begin
363
+ #Deletes a table row in an existing table in a Word DOCX document
364
+ result = api_instance.edit_document_docx_delete_table_row(req_config)
365
+ p result
366
+ rescue CloudmersiveConvertApiClient::ApiError => e
367
+ puts "Exception when calling EditDocumentApi->edit_document_docx_delete_table_row: #{e}"
368
+ end
369
+ ```
370
+
371
+ ### Parameters
372
+
373
+ Name | Type | Description | Notes
374
+ ------------- | ------------- | ------------- | -------------
375
+ **req_config** | [**DeleteDocxTableRowRequest**](DeleteDocxTableRowRequest.md)| Document input request |
376
+
377
+ ### Return type
378
+
379
+ [**DeleteDocxTableRowResponse**](DeleteDocxTableRowResponse.md)
380
+
381
+ ### Authorization
382
+
383
+ [Apikey](../README.md#Apikey)
384
+
385
+ ### HTTP request headers
386
+
387
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
388
+ - **Accept**: application/json, text/json, application/xml, text/xml
389
+
390
+
391
+
392
+ # **edit_document_docx_delete_table_row_range**
393
+ > DeleteDocxTableRowRangeResponse edit_document_docx_delete_table_row_range(req_config)
394
+
395
+ Deletes a range of multiple table rows in an existing table in a Word DOCX document
396
+
397
+ Deletes a range of 1 or more existing table rows in a Word DOCX Document and returns the result.
398
+
399
+ ### Example
400
+ ```ruby
401
+ # load the gem
402
+ require 'cloudmersive-convert-api-client'
403
+ # setup authorization
404
+ CloudmersiveConvertApiClient.configure do |config|
405
+ # Configure API key authorization: Apikey
406
+ config.api_key['Apikey'] = 'YOUR API KEY'
407
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
408
+ #config.api_key_prefix['Apikey'] = 'Bearer'
409
+ end
410
+
411
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
412
+
413
+ req_config = CloudmersiveConvertApiClient::DeleteDocxTableRowRangeRequest.new # DeleteDocxTableRowRangeRequest | Document input request
414
+
415
+
416
+ begin
417
+ #Deletes a range of multiple table rows in an existing table in a Word DOCX document
418
+ result = api_instance.edit_document_docx_delete_table_row_range(req_config)
419
+ p result
420
+ rescue CloudmersiveConvertApiClient::ApiError => e
421
+ puts "Exception when calling EditDocumentApi->edit_document_docx_delete_table_row_range: #{e}"
422
+ end
423
+ ```
424
+
425
+ ### Parameters
426
+
427
+ Name | Type | Description | Notes
428
+ ------------- | ------------- | ------------- | -------------
429
+ **req_config** | [**DeleteDocxTableRowRangeRequest**](DeleteDocxTableRowRangeRequest.md)| Document input request |
430
+
431
+ ### Return type
432
+
433
+ [**DeleteDocxTableRowRangeResponse**](DeleteDocxTableRowRangeResponse.md)
434
+
435
+ ### Authorization
436
+
437
+ [Apikey](../README.md#Apikey)
438
+
439
+ ### HTTP request headers
440
+
441
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
442
+ - **Accept**: application/json, text/json, application/xml, text/xml
443
+
444
+
445
+
446
+ # **edit_document_docx_disable_track_changes**
447
+ > String edit_document_docx_disable_track_changes(input_file)
448
+
449
+ Disable track changes, revisions in a Word DOCX document
450
+
451
+ Diables tracking of changes and revisions in a Word DOCX document, and accepts any pending changes. Users editing the document will no longer see changes tracked automatically.
452
+
453
+ ### Example
454
+ ```ruby
455
+ # load the gem
456
+ require 'cloudmersive-convert-api-client'
457
+ # setup authorization
458
+ CloudmersiveConvertApiClient.configure do |config|
459
+ # Configure API key authorization: Apikey
460
+ config.api_key['Apikey'] = 'YOUR API KEY'
461
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
462
+ #config.api_key_prefix['Apikey'] = 'Bearer'
463
+ end
464
+
465
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
466
+
467
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
468
+
469
+
470
+ begin
471
+ #Disable track changes, revisions in a Word DOCX document
472
+ result = api_instance.edit_document_docx_disable_track_changes(input_file)
473
+ p result
474
+ rescue CloudmersiveConvertApiClient::ApiError => e
475
+ puts "Exception when calling EditDocumentApi->edit_document_docx_disable_track_changes: #{e}"
476
+ end
477
+ ```
478
+
479
+ ### Parameters
480
+
481
+ Name | Type | Description | Notes
482
+ ------------- | ------------- | ------------- | -------------
483
+ **input_file** | **File**| Input file to perform the operation on. |
484
+
485
+ ### Return type
486
+
487
+ **String**
488
+
489
+ ### Authorization
490
+
491
+ [Apikey](../README.md#Apikey)
492
+
493
+ ### HTTP request headers
494
+
495
+ - **Content-Type**: multipart/form-data
496
+ - **Accept**: application/json, text/json, application/xml, text/xml
497
+
498
+
499
+
500
+ # **edit_document_docx_enable_track_changes**
501
+ > String edit_document_docx_enable_track_changes(input_file)
502
+
503
+ Enable track changes, revisions in a Word DOCX document
504
+
505
+ Enables tracking of changes and revisions in a Word DOCX document. Users editing the document will see changes tracked automatically, with edits highlighted, and the ability to accept or reject changes made to the document.
506
+
507
+ ### Example
508
+ ```ruby
509
+ # load the gem
510
+ require 'cloudmersive-convert-api-client'
511
+ # setup authorization
512
+ CloudmersiveConvertApiClient.configure do |config|
513
+ # Configure API key authorization: Apikey
514
+ config.api_key['Apikey'] = 'YOUR API KEY'
515
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
516
+ #config.api_key_prefix['Apikey'] = 'Bearer'
517
+ end
518
+
519
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
520
+
521
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
522
+
523
+
524
+ begin
525
+ #Enable track changes, revisions in a Word DOCX document
526
+ result = api_instance.edit_document_docx_enable_track_changes(input_file)
527
+ p result
528
+ rescue CloudmersiveConvertApiClient::ApiError => e
529
+ puts "Exception when calling EditDocumentApi->edit_document_docx_enable_track_changes: #{e}"
530
+ end
531
+ ```
532
+
533
+ ### Parameters
534
+
535
+ Name | Type | Description | Notes
536
+ ------------- | ------------- | ------------- | -------------
537
+ **input_file** | **File**| Input file to perform the operation on. |
538
+
539
+ ### Return type
540
+
541
+ **String**
542
+
543
+ ### Authorization
544
+
545
+ [Apikey](../README.md#Apikey)
546
+
547
+ ### HTTP request headers
548
+
549
+ - **Content-Type**: multipart/form-data
550
+ - **Accept**: application/json, text/json, application/xml, text/xml
551
+
552
+
553
+
554
+ # **edit_document_docx_find_paragraph**
555
+ > FindDocxParagraphResponse edit_document_docx_find_paragraph(req_config)
556
+
557
+ Find matching paragraphs in a Word DOCX document
558
+
559
+ Returns the paragraphs defined in the Word Document (DOCX) format file that match the input criteria
560
+
561
+ ### Example
562
+ ```ruby
563
+ # load the gem
564
+ require 'cloudmersive-convert-api-client'
565
+ # setup authorization
566
+ CloudmersiveConvertApiClient.configure do |config|
567
+ # Configure API key authorization: Apikey
568
+ config.api_key['Apikey'] = 'YOUR API KEY'
569
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
570
+ #config.api_key_prefix['Apikey'] = 'Bearer'
571
+ end
572
+
573
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
574
+
575
+ req_config = CloudmersiveConvertApiClient::FindDocxParagraphRequest.new # FindDocxParagraphRequest | Document input request
576
+
577
+
578
+ begin
579
+ #Find matching paragraphs in a Word DOCX document
580
+ result = api_instance.edit_document_docx_find_paragraph(req_config)
581
+ p result
582
+ rescue CloudmersiveConvertApiClient::ApiError => e
583
+ puts "Exception when calling EditDocumentApi->edit_document_docx_find_paragraph: #{e}"
584
+ end
585
+ ```
586
+
587
+ ### Parameters
588
+
589
+ Name | Type | Description | Notes
590
+ ------------- | ------------- | ------------- | -------------
591
+ **req_config** | [**FindDocxParagraphRequest**](FindDocxParagraphRequest.md)| Document input request |
592
+
593
+ ### Return type
594
+
595
+ [**FindDocxParagraphResponse**](FindDocxParagraphResponse.md)
596
+
597
+ ### Authorization
598
+
599
+ [Apikey](../README.md#Apikey)
600
+
601
+ ### HTTP request headers
602
+
603
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
604
+ - **Accept**: application/json, text/json, application/xml, text/xml
605
+
606
+
607
+
608
+ # **edit_document_docx_get_comments**
609
+ > GetDocxCommentsResponse edit_document_docx_get_comments(req_config)
610
+
611
+ Get comments from a Word DOCX document as a flat list
612
+
613
+ Returns the comments and review annotations stored in the Word Document (DOCX) format file as a flattened list (not as a hierarchy of comments and replies).
614
+
615
+ ### Example
616
+ ```ruby
617
+ # load the gem
618
+ require 'cloudmersive-convert-api-client'
619
+ # setup authorization
620
+ CloudmersiveConvertApiClient.configure do |config|
621
+ # Configure API key authorization: Apikey
622
+ config.api_key['Apikey'] = 'YOUR API KEY'
623
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
624
+ #config.api_key_prefix['Apikey'] = 'Bearer'
625
+ end
626
+
627
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
628
+
629
+ req_config = CloudmersiveConvertApiClient::GetDocxGetCommentsRequest.new # GetDocxGetCommentsRequest | Document input request
630
+
631
+
632
+ begin
633
+ #Get comments from a Word DOCX document as a flat list
634
+ result = api_instance.edit_document_docx_get_comments(req_config)
635
+ p result
636
+ rescue CloudmersiveConvertApiClient::ApiError => e
637
+ puts "Exception when calling EditDocumentApi->edit_document_docx_get_comments: #{e}"
638
+ end
639
+ ```
640
+
641
+ ### Parameters
642
+
643
+ Name | Type | Description | Notes
644
+ ------------- | ------------- | ------------- | -------------
645
+ **req_config** | [**GetDocxGetCommentsRequest**](GetDocxGetCommentsRequest.md)| Document input request |
646
+
647
+ ### Return type
648
+
649
+ [**GetDocxCommentsResponse**](GetDocxCommentsResponse.md)
650
+
651
+ ### Authorization
652
+
653
+ [Apikey](../README.md#Apikey)
654
+
655
+ ### HTTP request headers
656
+
657
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
658
+ - **Accept**: application/json, text/json, application/xml, text/xml
659
+
660
+
661
+
662
+ # **edit_document_docx_get_comments_hierarchical**
663
+ > GetDocxCommentsHierarchicalResponse edit_document_docx_get_comments_hierarchical(req_config)
664
+
665
+ Get comments from a Word DOCX document hierarchically
666
+
667
+ Returns the comments and review annotations stored in the Word Document (DOCX) format file hierarchically, where reply comments are nested as children under top-level comments in the results returned.
668
+
669
+ ### Example
670
+ ```ruby
671
+ # load the gem
672
+ require 'cloudmersive-convert-api-client'
673
+ # setup authorization
674
+ CloudmersiveConvertApiClient.configure do |config|
675
+ # Configure API key authorization: Apikey
676
+ config.api_key['Apikey'] = 'YOUR API KEY'
677
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
678
+ #config.api_key_prefix['Apikey'] = 'Bearer'
679
+ end
680
+
681
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
682
+
683
+ req_config = CloudmersiveConvertApiClient::GetDocxGetCommentsHierarchicalRequest.new # GetDocxGetCommentsHierarchicalRequest | Document input request
684
+
685
+
686
+ begin
687
+ #Get comments from a Word DOCX document hierarchically
688
+ result = api_instance.edit_document_docx_get_comments_hierarchical(req_config)
689
+ p result
690
+ rescue CloudmersiveConvertApiClient::ApiError => e
691
+ puts "Exception when calling EditDocumentApi->edit_document_docx_get_comments_hierarchical: #{e}"
692
+ end
693
+ ```
694
+
695
+ ### Parameters
696
+
697
+ Name | Type | Description | Notes
698
+ ------------- | ------------- | ------------- | -------------
699
+ **req_config** | [**GetDocxGetCommentsHierarchicalRequest**](GetDocxGetCommentsHierarchicalRequest.md)| Document input request |
700
+
701
+ ### Return type
702
+
703
+ [**GetDocxCommentsHierarchicalResponse**](GetDocxCommentsHierarchicalResponse.md)
704
+
705
+ ### Authorization
706
+
707
+ [Apikey](../README.md#Apikey)
708
+
709
+ ### HTTP request headers
710
+
711
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
712
+ - **Accept**: application/json, text/json, application/xml, text/xml
713
+
714
+
715
+
716
+ # **edit_document_docx_get_headers_and_footers**
717
+ > GetDocxHeadersAndFootersResponse edit_document_docx_get_headers_and_footers(req_config)
718
+
719
+ Get content of a footer from a Word DOCX document
720
+
721
+ Returns the footer content from a Word Document (DOCX) format file
722
+
723
+ ### Example
724
+ ```ruby
725
+ # load the gem
726
+ require 'cloudmersive-convert-api-client'
727
+ # setup authorization
728
+ CloudmersiveConvertApiClient.configure do |config|
729
+ # Configure API key authorization: Apikey
730
+ config.api_key['Apikey'] = 'YOUR API KEY'
731
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
732
+ #config.api_key_prefix['Apikey'] = 'Bearer'
733
+ end
734
+
735
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
736
+
737
+ req_config = CloudmersiveConvertApiClient::GetDocxHeadersAndFootersRequest.new # GetDocxHeadersAndFootersRequest | Document input request
738
+
739
+
740
+ begin
741
+ #Get content of a footer from a Word DOCX document
742
+ result = api_instance.edit_document_docx_get_headers_and_footers(req_config)
743
+ p result
744
+ rescue CloudmersiveConvertApiClient::ApiError => e
745
+ puts "Exception when calling EditDocumentApi->edit_document_docx_get_headers_and_footers: #{e}"
746
+ end
747
+ ```
748
+
749
+ ### Parameters
750
+
751
+ Name | Type | Description | Notes
752
+ ------------- | ------------- | ------------- | -------------
753
+ **req_config** | [**GetDocxHeadersAndFootersRequest**](GetDocxHeadersAndFootersRequest.md)| Document input request |
754
+
755
+ ### Return type
756
+
757
+ [**GetDocxHeadersAndFootersResponse**](GetDocxHeadersAndFootersResponse.md)
758
+
759
+ ### Authorization
760
+
761
+ [Apikey](../README.md#Apikey)
762
+
763
+ ### HTTP request headers
764
+
765
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
766
+ - **Accept**: application/json, text/json, application/xml, text/xml
767
+
768
+
769
+
770
+ # **edit_document_docx_get_images**
771
+ > GetDocxImagesResponse edit_document_docx_get_images(req_config)
772
+
773
+ Get images from a Word DOCX document
774
+
775
+ Returns the images defined in the Word Document (DOCX) format file
776
+
777
+ ### Example
778
+ ```ruby
779
+ # load the gem
780
+ require 'cloudmersive-convert-api-client'
781
+ # setup authorization
782
+ CloudmersiveConvertApiClient.configure do |config|
783
+ # Configure API key authorization: Apikey
784
+ config.api_key['Apikey'] = 'YOUR API KEY'
785
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
786
+ #config.api_key_prefix['Apikey'] = 'Bearer'
787
+ end
788
+
789
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
790
+
791
+ req_config = CloudmersiveConvertApiClient::GetDocxImagesRequest.new # GetDocxImagesRequest | Document input request
792
+
793
+
794
+ begin
795
+ #Get images from a Word DOCX document
796
+ result = api_instance.edit_document_docx_get_images(req_config)
797
+ p result
798
+ rescue CloudmersiveConvertApiClient::ApiError => e
799
+ puts "Exception when calling EditDocumentApi->edit_document_docx_get_images: #{e}"
800
+ end
801
+ ```
802
+
803
+ ### Parameters
804
+
805
+ Name | Type | Description | Notes
806
+ ------------- | ------------- | ------------- | -------------
807
+ **req_config** | [**GetDocxImagesRequest**](GetDocxImagesRequest.md)| Document input request |
808
+
809
+ ### Return type
810
+
811
+ [**GetDocxImagesResponse**](GetDocxImagesResponse.md)
812
+
813
+ ### Authorization
814
+
815
+ [Apikey](../README.md#Apikey)
816
+
817
+ ### HTTP request headers
818
+
819
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
820
+ - **Accept**: application/json, text/json, application/xml, text/xml
821
+
822
+
823
+
824
+ # **edit_document_docx_get_sections**
825
+ > GetDocxSectionsResponse edit_document_docx_get_sections(req_config)
826
+
827
+ Get sections from a Word DOCX document
828
+
829
+ Returns the sections defined in the Word Document (DOCX) format file
830
+
831
+ ### Example
832
+ ```ruby
833
+ # load the gem
834
+ require 'cloudmersive-convert-api-client'
835
+ # setup authorization
836
+ CloudmersiveConvertApiClient.configure do |config|
837
+ # Configure API key authorization: Apikey
838
+ config.api_key['Apikey'] = 'YOUR API KEY'
839
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
840
+ #config.api_key_prefix['Apikey'] = 'Bearer'
841
+ end
842
+
843
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
844
+
845
+ req_config = CloudmersiveConvertApiClient::GetDocxSectionsRequest.new # GetDocxSectionsRequest | Document input request
846
+
847
+
848
+ begin
849
+ #Get sections from a Word DOCX document
850
+ result = api_instance.edit_document_docx_get_sections(req_config)
851
+ p result
852
+ rescue CloudmersiveConvertApiClient::ApiError => e
853
+ puts "Exception when calling EditDocumentApi->edit_document_docx_get_sections: #{e}"
854
+ end
855
+ ```
856
+
857
+ ### Parameters
858
+
859
+ Name | Type | Description | Notes
860
+ ------------- | ------------- | ------------- | -------------
861
+ **req_config** | [**GetDocxSectionsRequest**](GetDocxSectionsRequest.md)| Document input request |
862
+
863
+ ### Return type
864
+
865
+ [**GetDocxSectionsResponse**](GetDocxSectionsResponse.md)
866
+
867
+ ### Authorization
868
+
869
+ [Apikey](../README.md#Apikey)
870
+
871
+ ### HTTP request headers
872
+
873
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
874
+ - **Accept**: application/json, text/json, application/xml, text/xml
875
+
876
+
877
+
878
+ # **edit_document_docx_get_styles**
879
+ > GetDocxStylesResponse edit_document_docx_get_styles(req_config)
880
+
881
+ Get styles from a Word DOCX document
882
+
883
+ Returns the styles defined in the Word Document (DOCX) format file
884
+
885
+ ### Example
886
+ ```ruby
887
+ # load the gem
888
+ require 'cloudmersive-convert-api-client'
889
+ # setup authorization
890
+ CloudmersiveConvertApiClient.configure do |config|
891
+ # Configure API key authorization: Apikey
892
+ config.api_key['Apikey'] = 'YOUR API KEY'
893
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
894
+ #config.api_key_prefix['Apikey'] = 'Bearer'
895
+ end
896
+
897
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
898
+
899
+ req_config = CloudmersiveConvertApiClient::GetDocxStylesRequest.new # GetDocxStylesRequest | Document input request
900
+
901
+
902
+ begin
903
+ #Get styles from a Word DOCX document
904
+ result = api_instance.edit_document_docx_get_styles(req_config)
905
+ p result
906
+ rescue CloudmersiveConvertApiClient::ApiError => e
907
+ puts "Exception when calling EditDocumentApi->edit_document_docx_get_styles: #{e}"
908
+ end
909
+ ```
910
+
911
+ ### Parameters
912
+
913
+ Name | Type | Description | Notes
914
+ ------------- | ------------- | ------------- | -------------
915
+ **req_config** | [**GetDocxStylesRequest**](GetDocxStylesRequest.md)| Document input request |
916
+
917
+ ### Return type
918
+
919
+ [**GetDocxStylesResponse**](GetDocxStylesResponse.md)
920
+
921
+ ### Authorization
922
+
923
+ [Apikey](../README.md#Apikey)
924
+
925
+ ### HTTP request headers
926
+
927
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
928
+ - **Accept**: application/json, text/json, application/xml, text/xml
929
+
930
+
931
+
932
+ # **edit_document_docx_get_table_by_index**
933
+ > GetDocxTableByIndexResponse edit_document_docx_get_table_by_index(req_config)
934
+
935
+ Get a specific table by index in a Word DOCX document
936
+
937
+ Returns the specific table object by its 0-based index in an Office Word Document (DOCX)
938
+
939
+ ### Example
940
+ ```ruby
941
+ # load the gem
942
+ require 'cloudmersive-convert-api-client'
943
+ # setup authorization
944
+ CloudmersiveConvertApiClient.configure do |config|
945
+ # Configure API key authorization: Apikey
946
+ config.api_key['Apikey'] = 'YOUR API KEY'
947
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
948
+ #config.api_key_prefix['Apikey'] = 'Bearer'
949
+ end
950
+
951
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
952
+
953
+ req_config = CloudmersiveConvertApiClient::GetDocxTableByIndexRequest.new # GetDocxTableByIndexRequest | Document input request
954
+
955
+
956
+ begin
957
+ #Get a specific table by index in a Word DOCX document
958
+ result = api_instance.edit_document_docx_get_table_by_index(req_config)
959
+ p result
960
+ rescue CloudmersiveConvertApiClient::ApiError => e
961
+ puts "Exception when calling EditDocumentApi->edit_document_docx_get_table_by_index: #{e}"
962
+ end
963
+ ```
964
+
965
+ ### Parameters
966
+
967
+ Name | Type | Description | Notes
968
+ ------------- | ------------- | ------------- | -------------
969
+ **req_config** | [**GetDocxTableByIndexRequest**](GetDocxTableByIndexRequest.md)| Document input request |
970
+
971
+ ### Return type
972
+
973
+ [**GetDocxTableByIndexResponse**](GetDocxTableByIndexResponse.md)
974
+
975
+ ### Authorization
976
+
977
+ [Apikey](../README.md#Apikey)
978
+
979
+ ### HTTP request headers
980
+
981
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
982
+ - **Accept**: application/json, text/json, application/xml, text/xml
983
+
984
+
985
+
986
+ # **edit_document_docx_get_table_row**
987
+ > GetDocxTableRowResponse edit_document_docx_get_table_row(req_config)
988
+
989
+ Gets the contents of an existing table row in an existing table in a Word DOCX document
990
+
991
+ Gets the contents of an existing table row in a Word DOCX Document and returns the result.
992
+
993
+ ### Example
994
+ ```ruby
995
+ # load the gem
996
+ require 'cloudmersive-convert-api-client'
997
+ # setup authorization
998
+ CloudmersiveConvertApiClient.configure do |config|
999
+ # Configure API key authorization: Apikey
1000
+ config.api_key['Apikey'] = 'YOUR API KEY'
1001
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1002
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1003
+ end
1004
+
1005
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1006
+
1007
+ req_config = CloudmersiveConvertApiClient::GetDocxTableRowRequest.new # GetDocxTableRowRequest | Document input request
1008
+
1009
+
1010
+ begin
1011
+ #Gets the contents of an existing table row in an existing table in a Word DOCX document
1012
+ result = api_instance.edit_document_docx_get_table_row(req_config)
1013
+ p result
1014
+ rescue CloudmersiveConvertApiClient::ApiError => e
1015
+ puts "Exception when calling EditDocumentApi->edit_document_docx_get_table_row: #{e}"
1016
+ end
1017
+ ```
1018
+
1019
+ ### Parameters
1020
+
1021
+ Name | Type | Description | Notes
1022
+ ------------- | ------------- | ------------- | -------------
1023
+ **req_config** | [**GetDocxTableRowRequest**](GetDocxTableRowRequest.md)| Document input request |
1024
+
1025
+ ### Return type
1026
+
1027
+ [**GetDocxTableRowResponse**](GetDocxTableRowResponse.md)
1028
+
1029
+ ### Authorization
1030
+
1031
+ [Apikey](../README.md#Apikey)
1032
+
1033
+ ### HTTP request headers
1034
+
1035
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1036
+ - **Accept**: application/json, text/json, application/xml, text/xml
1037
+
1038
+
1039
+
1040
+ # **edit_document_docx_get_tables**
1041
+ > GetDocxTablesResponse edit_document_docx_get_tables(req_config)
1042
+
1043
+ Get all tables in Word DOCX document
1044
+
1045
+ Returns all the table objects in an Office Word Document (docx)
1046
+
1047
+ ### Example
1048
+ ```ruby
1049
+ # load the gem
1050
+ require 'cloudmersive-convert-api-client'
1051
+ # setup authorization
1052
+ CloudmersiveConvertApiClient.configure do |config|
1053
+ # Configure API key authorization: Apikey
1054
+ config.api_key['Apikey'] = 'YOUR API KEY'
1055
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1056
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1057
+ end
1058
+
1059
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1060
+
1061
+ req_config = CloudmersiveConvertApiClient::GetDocxTablesRequest.new # GetDocxTablesRequest | Document input request
1062
+
1063
+
1064
+ begin
1065
+ #Get all tables in Word DOCX document
1066
+ result = api_instance.edit_document_docx_get_tables(req_config)
1067
+ p result
1068
+ rescue CloudmersiveConvertApiClient::ApiError => e
1069
+ puts "Exception when calling EditDocumentApi->edit_document_docx_get_tables: #{e}"
1070
+ end
1071
+ ```
1072
+
1073
+ ### Parameters
1074
+
1075
+ Name | Type | Description | Notes
1076
+ ------------- | ------------- | ------------- | -------------
1077
+ **req_config** | [**GetDocxTablesRequest**](GetDocxTablesRequest.md)| Document input request |
1078
+
1079
+ ### Return type
1080
+
1081
+ [**GetDocxTablesResponse**](GetDocxTablesResponse.md)
1082
+
1083
+ ### Authorization
1084
+
1085
+ [Apikey](../README.md#Apikey)
1086
+
1087
+ ### HTTP request headers
1088
+
1089
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1090
+ - **Accept**: application/json, text/json, application/xml, text/xml
1091
+
1092
+
1093
+
1094
+ # **edit_document_docx_insert_comment_on_paragraph**
1095
+ > InsertDocxCommentOnParagraphResponse edit_document_docx_insert_comment_on_paragraph(req_config)
1096
+
1097
+ Insert a new comment into a Word DOCX document attached to a paragraph
1098
+
1099
+ Adds a new comment into a Word DOCX document attached to a paragraph and returns the result. Call Finish Editing on the output URL to complete the operation.
1100
+
1101
+ ### Example
1102
+ ```ruby
1103
+ # load the gem
1104
+ require 'cloudmersive-convert-api-client'
1105
+ # setup authorization
1106
+ CloudmersiveConvertApiClient.configure do |config|
1107
+ # Configure API key authorization: Apikey
1108
+ config.api_key['Apikey'] = 'YOUR API KEY'
1109
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1110
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1111
+ end
1112
+
1113
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1114
+
1115
+ req_config = CloudmersiveConvertApiClient::DocxInsertCommentOnParagraphRequest.new # DocxInsertCommentOnParagraphRequest | Document input request
1116
+
1117
+
1118
+ begin
1119
+ #Insert a new comment into a Word DOCX document attached to a paragraph
1120
+ result = api_instance.edit_document_docx_insert_comment_on_paragraph(req_config)
1121
+ p result
1122
+ rescue CloudmersiveConvertApiClient::ApiError => e
1123
+ puts "Exception when calling EditDocumentApi->edit_document_docx_insert_comment_on_paragraph: #{e}"
1124
+ end
1125
+ ```
1126
+
1127
+ ### Parameters
1128
+
1129
+ Name | Type | Description | Notes
1130
+ ------------- | ------------- | ------------- | -------------
1131
+ **req_config** | [**DocxInsertCommentOnParagraphRequest**](DocxInsertCommentOnParagraphRequest.md)| Document input request |
1132
+
1133
+ ### Return type
1134
+
1135
+ [**InsertDocxCommentOnParagraphResponse**](InsertDocxCommentOnParagraphResponse.md)
1136
+
1137
+ ### Authorization
1138
+
1139
+ [Apikey](../README.md#Apikey)
1140
+
1141
+ ### HTTP request headers
1142
+
1143
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1144
+ - **Accept**: application/json, text/json, application/xml, text/xml
1145
+
1146
+
1147
+
1148
+ # **edit_document_docx_insert_image**
1149
+ > DocxInsertImageResponse edit_document_docx_insert_image(req_config)
1150
+
1151
+ Insert image into a Word DOCX document
1152
+
1153
+ Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
1154
+
1155
+ ### Example
1156
+ ```ruby
1157
+ # load the gem
1158
+ require 'cloudmersive-convert-api-client'
1159
+ # setup authorization
1160
+ CloudmersiveConvertApiClient.configure do |config|
1161
+ # Configure API key authorization: Apikey
1162
+ config.api_key['Apikey'] = 'YOUR API KEY'
1163
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1164
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1165
+ end
1166
+
1167
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1168
+
1169
+ req_config = CloudmersiveConvertApiClient::DocxInsertImageRequest.new # DocxInsertImageRequest | Document input request
1170
+
1171
+
1172
+ begin
1173
+ #Insert image into a Word DOCX document
1174
+ result = api_instance.edit_document_docx_insert_image(req_config)
1175
+ p result
1176
+ rescue CloudmersiveConvertApiClient::ApiError => e
1177
+ puts "Exception when calling EditDocumentApi->edit_document_docx_insert_image: #{e}"
1178
+ end
1179
+ ```
1180
+
1181
+ ### Parameters
1182
+
1183
+ Name | Type | Description | Notes
1184
+ ------------- | ------------- | ------------- | -------------
1185
+ **req_config** | [**DocxInsertImageRequest**](DocxInsertImageRequest.md)| Document input request |
1186
+
1187
+ ### Return type
1188
+
1189
+ [**DocxInsertImageResponse**](DocxInsertImageResponse.md)
1190
+
1191
+ ### Authorization
1192
+
1193
+ [Apikey](../README.md#Apikey)
1194
+
1195
+ ### HTTP request headers
1196
+
1197
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1198
+ - **Accept**: application/json, text/json, application/xml, text/xml
1199
+
1200
+
1201
+
1202
+ # **edit_document_docx_insert_paragraph**
1203
+ > InsertDocxInsertParagraphResponse edit_document_docx_insert_paragraph(req_config)
1204
+
1205
+ Insert a new paragraph into a Word DOCX document
1206
+
1207
+ Adds a new paragraph into a DOCX and returns the result. You can insert at the beginning/end of a document, or before/after an existing object using its Path (location within the document). Call Finish Editing on the output URL to complete the operation.
1208
+
1209
+ ### Example
1210
+ ```ruby
1211
+ # load the gem
1212
+ require 'cloudmersive-convert-api-client'
1213
+ # setup authorization
1214
+ CloudmersiveConvertApiClient.configure do |config|
1215
+ # Configure API key authorization: Apikey
1216
+ config.api_key['Apikey'] = 'YOUR API KEY'
1217
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1218
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1219
+ end
1220
+
1221
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1222
+
1223
+ req_config = CloudmersiveConvertApiClient::InsertDocxInsertParagraphRequest.new # InsertDocxInsertParagraphRequest | Document input request
1224
+
1225
+
1226
+ begin
1227
+ #Insert a new paragraph into a Word DOCX document
1228
+ result = api_instance.edit_document_docx_insert_paragraph(req_config)
1229
+ p result
1230
+ rescue CloudmersiveConvertApiClient::ApiError => e
1231
+ puts "Exception when calling EditDocumentApi->edit_document_docx_insert_paragraph: #{e}"
1232
+ end
1233
+ ```
1234
+
1235
+ ### Parameters
1236
+
1237
+ Name | Type | Description | Notes
1238
+ ------------- | ------------- | ------------- | -------------
1239
+ **req_config** | [**InsertDocxInsertParagraphRequest**](InsertDocxInsertParagraphRequest.md)| Document input request |
1240
+
1241
+ ### Return type
1242
+
1243
+ [**InsertDocxInsertParagraphResponse**](InsertDocxInsertParagraphResponse.md)
1244
+
1245
+ ### Authorization
1246
+
1247
+ [Apikey](../README.md#Apikey)
1248
+
1249
+ ### HTTP request headers
1250
+
1251
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1252
+ - **Accept**: application/json, text/json, application/xml, text/xml
1253
+
1254
+
1255
+
1256
+ # **edit_document_docx_insert_table**
1257
+ > InsertDocxTablesResponse edit_document_docx_insert_table(req_config)
1258
+
1259
+ Insert a new table into a Word DOCX document
1260
+
1261
+ Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation.
1262
+
1263
+ ### Example
1264
+ ```ruby
1265
+ # load the gem
1266
+ require 'cloudmersive-convert-api-client'
1267
+ # setup authorization
1268
+ CloudmersiveConvertApiClient.configure do |config|
1269
+ # Configure API key authorization: Apikey
1270
+ config.api_key['Apikey'] = 'YOUR API KEY'
1271
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1272
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1273
+ end
1274
+
1275
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1276
+
1277
+ req_config = CloudmersiveConvertApiClient::InsertDocxTablesRequest.new # InsertDocxTablesRequest | Document input request
1278
+
1279
+
1280
+ begin
1281
+ #Insert a new table into a Word DOCX document
1282
+ result = api_instance.edit_document_docx_insert_table(req_config)
1283
+ p result
1284
+ rescue CloudmersiveConvertApiClient::ApiError => e
1285
+ puts "Exception when calling EditDocumentApi->edit_document_docx_insert_table: #{e}"
1286
+ end
1287
+ ```
1288
+
1289
+ ### Parameters
1290
+
1291
+ Name | Type | Description | Notes
1292
+ ------------- | ------------- | ------------- | -------------
1293
+ **req_config** | [**InsertDocxTablesRequest**](InsertDocxTablesRequest.md)| Document input request |
1294
+
1295
+ ### Return type
1296
+
1297
+ [**InsertDocxTablesResponse**](InsertDocxTablesResponse.md)
1298
+
1299
+ ### Authorization
1300
+
1301
+ [Apikey](../README.md#Apikey)
1302
+
1303
+ ### HTTP request headers
1304
+
1305
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1306
+ - **Accept**: application/json, text/json, application/xml, text/xml
1307
+
1308
+
1309
+
1310
+ # **edit_document_docx_insert_table_row**
1311
+ > InsertDocxTableRowResponse edit_document_docx_insert_table_row(req_config)
1312
+
1313
+ Insert a new row into an existing table in a Word DOCX document
1314
+
1315
+ Adds a new table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
1316
+
1317
+ ### Example
1318
+ ```ruby
1319
+ # load the gem
1320
+ require 'cloudmersive-convert-api-client'
1321
+ # setup authorization
1322
+ CloudmersiveConvertApiClient.configure do |config|
1323
+ # Configure API key authorization: Apikey
1324
+ config.api_key['Apikey'] = 'YOUR API KEY'
1325
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1326
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1327
+ end
1328
+
1329
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1330
+
1331
+ req_config = CloudmersiveConvertApiClient::InsertDocxTableRowRequest.new # InsertDocxTableRowRequest | Document input request
1332
+
1333
+
1334
+ begin
1335
+ #Insert a new row into an existing table in a Word DOCX document
1336
+ result = api_instance.edit_document_docx_insert_table_row(req_config)
1337
+ p result
1338
+ rescue CloudmersiveConvertApiClient::ApiError => e
1339
+ puts "Exception when calling EditDocumentApi->edit_document_docx_insert_table_row: #{e}"
1340
+ end
1341
+ ```
1342
+
1343
+ ### Parameters
1344
+
1345
+ Name | Type | Description | Notes
1346
+ ------------- | ------------- | ------------- | -------------
1347
+ **req_config** | [**InsertDocxTableRowRequest**](InsertDocxTableRowRequest.md)| Document input request |
1348
+
1349
+ ### Return type
1350
+
1351
+ [**InsertDocxTableRowResponse**](InsertDocxTableRowResponse.md)
1352
+
1353
+ ### Authorization
1354
+
1355
+ [Apikey](../README.md#Apikey)
1356
+
1357
+ ### HTTP request headers
1358
+
1359
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1360
+ - **Accept**: application/json, text/json, application/xml, text/xml
1361
+
1362
+
1363
+
1364
+ # **edit_document_docx_pages**
1365
+ > GetDocxPagesResponse edit_document_docx_pages(req_config)
1366
+
1367
+ Get pages and content from a Word DOCX document
1368
+
1369
+ Returns the pages and contents of each page defined in the Word Document (DOCX) format file
1370
+
1371
+ ### Example
1372
+ ```ruby
1373
+ # load the gem
1374
+ require 'cloudmersive-convert-api-client'
1375
+ # setup authorization
1376
+ CloudmersiveConvertApiClient.configure do |config|
1377
+ # Configure API key authorization: Apikey
1378
+ config.api_key['Apikey'] = 'YOUR API KEY'
1379
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1380
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1381
+ end
1382
+
1383
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1384
+
1385
+ req_config = CloudmersiveConvertApiClient::GetDocxPagesRequest.new # GetDocxPagesRequest | Document input request
1386
+
1387
+
1388
+ begin
1389
+ #Get pages and content from a Word DOCX document
1390
+ result = api_instance.edit_document_docx_pages(req_config)
1391
+ p result
1392
+ rescue CloudmersiveConvertApiClient::ApiError => e
1393
+ puts "Exception when calling EditDocumentApi->edit_document_docx_pages: #{e}"
1394
+ end
1395
+ ```
1396
+
1397
+ ### Parameters
1398
+
1399
+ Name | Type | Description | Notes
1400
+ ------------- | ------------- | ------------- | -------------
1401
+ **req_config** | [**GetDocxPagesRequest**](GetDocxPagesRequest.md)| Document input request |
1402
+
1403
+ ### Return type
1404
+
1405
+ [**GetDocxPagesResponse**](GetDocxPagesResponse.md)
1406
+
1407
+ ### Authorization
1408
+
1409
+ [Apikey](../README.md#Apikey)
1410
+
1411
+ ### HTTP request headers
1412
+
1413
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1414
+ - **Accept**: application/json, text/json, application/xml, text/xml
1415
+
1416
+
1417
+
1418
+ # **edit_document_docx_remove_all_comments**
1419
+ > String edit_document_docx_remove_all_comments(input_file)
1420
+
1421
+ Remove all comments from a Word DOCX document
1422
+
1423
+ Removes all of the comments from a Word Document.
1424
+
1425
+ ### Example
1426
+ ```ruby
1427
+ # load the gem
1428
+ require 'cloudmersive-convert-api-client'
1429
+ # setup authorization
1430
+ CloudmersiveConvertApiClient.configure do |config|
1431
+ # Configure API key authorization: Apikey
1432
+ config.api_key['Apikey'] = 'YOUR API KEY'
1433
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1434
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1435
+ end
1436
+
1437
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1438
+
1439
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1440
+
1441
+
1442
+ begin
1443
+ #Remove all comments from a Word DOCX document
1444
+ result = api_instance.edit_document_docx_remove_all_comments(input_file)
1445
+ p result
1446
+ rescue CloudmersiveConvertApiClient::ApiError => e
1447
+ puts "Exception when calling EditDocumentApi->edit_document_docx_remove_all_comments: #{e}"
1448
+ end
1449
+ ```
1450
+
1451
+ ### Parameters
1452
+
1453
+ Name | Type | Description | Notes
1454
+ ------------- | ------------- | ------------- | -------------
1455
+ **input_file** | **File**| Input file to perform the operation on. |
1456
+
1457
+ ### Return type
1458
+
1459
+ **String**
1460
+
1461
+ ### Authorization
1462
+
1463
+ [Apikey](../README.md#Apikey)
1464
+
1465
+ ### HTTP request headers
1466
+
1467
+ - **Content-Type**: multipart/form-data
1468
+ - **Accept**: application/json, text/json, application/xml, text/xml
1469
+
1470
+
1471
+
1472
+ # **edit_document_docx_remove_headers_and_footers**
1473
+ > RemoveDocxHeadersAndFootersResponse edit_document_docx_remove_headers_and_footers(req_config)
1474
+
1475
+ Remove headers and footers from Word DOCX document
1476
+
1477
+ Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
1478
+
1479
+ ### Example
1480
+ ```ruby
1481
+ # load the gem
1482
+ require 'cloudmersive-convert-api-client'
1483
+ # setup authorization
1484
+ CloudmersiveConvertApiClient.configure do |config|
1485
+ # Configure API key authorization: Apikey
1486
+ config.api_key['Apikey'] = 'YOUR API KEY'
1487
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1488
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1489
+ end
1490
+
1491
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1492
+
1493
+ req_config = CloudmersiveConvertApiClient::RemoveDocxHeadersAndFootersRequest.new # RemoveDocxHeadersAndFootersRequest | Document input request
1494
+
1495
+
1496
+ begin
1497
+ #Remove headers and footers from Word DOCX document
1498
+ result = api_instance.edit_document_docx_remove_headers_and_footers(req_config)
1499
+ p result
1500
+ rescue CloudmersiveConvertApiClient::ApiError => e
1501
+ puts "Exception when calling EditDocumentApi->edit_document_docx_remove_headers_and_footers: #{e}"
1502
+ end
1503
+ ```
1504
+
1505
+ ### Parameters
1506
+
1507
+ Name | Type | Description | Notes
1508
+ ------------- | ------------- | ------------- | -------------
1509
+ **req_config** | [**RemoveDocxHeadersAndFootersRequest**](RemoveDocxHeadersAndFootersRequest.md)| Document input request |
1510
+
1511
+ ### Return type
1512
+
1513
+ [**RemoveDocxHeadersAndFootersResponse**](RemoveDocxHeadersAndFootersResponse.md)
1514
+
1515
+ ### Authorization
1516
+
1517
+ [Apikey](../README.md#Apikey)
1518
+
1519
+ ### HTTP request headers
1520
+
1521
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1522
+ - **Accept**: application/json, text/json, application/xml, text/xml
1523
+
1524
+
1525
+
1526
+ # **edit_document_docx_remove_object**
1527
+ > DocxRemoveObjectResponse edit_document_docx_remove_object(req_config)
1528
+
1529
+ Delete any object in a Word DOCX document
1530
+
1531
+ Delete any object, such as a paragraph, table, image, etc. from a Word Document (DOCX). Pass in the Path of the object you would like to delete. You can call other functions such as Get-Tables, Get-Images, Get-Body, etc. to get the paths of the objects in the document. Call Finish Editing on the output URL to complete the operation.
1532
+
1533
+ ### Example
1534
+ ```ruby
1535
+ # load the gem
1536
+ require 'cloudmersive-convert-api-client'
1537
+ # setup authorization
1538
+ CloudmersiveConvertApiClient.configure do |config|
1539
+ # Configure API key authorization: Apikey
1540
+ config.api_key['Apikey'] = 'YOUR API KEY'
1541
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1542
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1543
+ end
1544
+
1545
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1546
+
1547
+ req_config = CloudmersiveConvertApiClient::DocxRemoveObjectRequest.new # DocxRemoveObjectRequest | Document input request
1548
+
1549
+
1550
+ begin
1551
+ #Delete any object in a Word DOCX document
1552
+ result = api_instance.edit_document_docx_remove_object(req_config)
1553
+ p result
1554
+ rescue CloudmersiveConvertApiClient::ApiError => e
1555
+ puts "Exception when calling EditDocumentApi->edit_document_docx_remove_object: #{e}"
1556
+ end
1557
+ ```
1558
+
1559
+ ### Parameters
1560
+
1561
+ Name | Type | Description | Notes
1562
+ ------------- | ------------- | ------------- | -------------
1563
+ **req_config** | [**DocxRemoveObjectRequest**](DocxRemoveObjectRequest.md)| Document input request |
1564
+
1565
+ ### Return type
1566
+
1567
+ [**DocxRemoveObjectResponse**](DocxRemoveObjectResponse.md)
1568
+
1569
+ ### Authorization
1570
+
1571
+ [Apikey](../README.md#Apikey)
1572
+
1573
+ ### HTTP request headers
1574
+
1575
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1576
+ - **Accept**: application/json, text/json, application/xml, text/xml
1577
+
1578
+
1579
+
1580
+ # **edit_document_docx_replace**
1581
+ > String edit_document_docx_replace(req_config)
1582
+
1583
+ Replace string in Word DOCX document
1584
+
1585
+ Replace all instances of a string in an Office Word Document (docx)
1586
+
1587
+ ### Example
1588
+ ```ruby
1589
+ # load the gem
1590
+ require 'cloudmersive-convert-api-client'
1591
+ # setup authorization
1592
+ CloudmersiveConvertApiClient.configure do |config|
1593
+ # Configure API key authorization: Apikey
1594
+ config.api_key['Apikey'] = 'YOUR API KEY'
1595
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1596
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1597
+ end
1598
+
1599
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1600
+
1601
+ req_config = CloudmersiveConvertApiClient::ReplaceStringRequest.new # ReplaceStringRequest | Document string replacement configuration input
1602
+
1603
+
1604
+ begin
1605
+ #Replace string in Word DOCX document
1606
+ result = api_instance.edit_document_docx_replace(req_config)
1607
+ p result
1608
+ rescue CloudmersiveConvertApiClient::ApiError => e
1609
+ puts "Exception when calling EditDocumentApi->edit_document_docx_replace: #{e}"
1610
+ end
1611
+ ```
1612
+
1613
+ ### Parameters
1614
+
1615
+ Name | Type | Description | Notes
1616
+ ------------- | ------------- | ------------- | -------------
1617
+ **req_config** | [**ReplaceStringRequest**](ReplaceStringRequest.md)| Document string replacement configuration input |
1618
+
1619
+ ### Return type
1620
+
1621
+ **String**
1622
+
1623
+ ### Authorization
1624
+
1625
+ [Apikey](../README.md#Apikey)
1626
+
1627
+ ### HTTP request headers
1628
+
1629
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1630
+ - **Accept**: application/octet-stream
1631
+
1632
+
1633
+
1634
+ # **edit_document_docx_replace_multi**
1635
+ > String edit_document_docx_replace_multi(req_config)
1636
+
1637
+ Replace multiple strings in Word DOCX document
1638
+
1639
+ Replace all instances of multiple strings in an Office Word Document (docx)
1640
+
1641
+ ### Example
1642
+ ```ruby
1643
+ # load the gem
1644
+ require 'cloudmersive-convert-api-client'
1645
+ # setup authorization
1646
+ CloudmersiveConvertApiClient.configure do |config|
1647
+ # Configure API key authorization: Apikey
1648
+ config.api_key['Apikey'] = 'YOUR API KEY'
1649
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1650
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1651
+ end
1652
+
1653
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1654
+
1655
+ req_config = CloudmersiveConvertApiClient::MultiReplaceStringRequest.new # MultiReplaceStringRequest | Document string replacement configuration input
1656
+
1657
+
1658
+ begin
1659
+ #Replace multiple strings in Word DOCX document
1660
+ result = api_instance.edit_document_docx_replace_multi(req_config)
1661
+ p result
1662
+ rescue CloudmersiveConvertApiClient::ApiError => e
1663
+ puts "Exception when calling EditDocumentApi->edit_document_docx_replace_multi: #{e}"
1664
+ end
1665
+ ```
1666
+
1667
+ ### Parameters
1668
+
1669
+ Name | Type | Description | Notes
1670
+ ------------- | ------------- | ------------- | -------------
1671
+ **req_config** | [**MultiReplaceStringRequest**](MultiReplaceStringRequest.md)| Document string replacement configuration input |
1672
+
1673
+ ### Return type
1674
+
1675
+ **String**
1676
+
1677
+ ### Authorization
1678
+
1679
+ [Apikey](../README.md#Apikey)
1680
+
1681
+ ### HTTP request headers
1682
+
1683
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1684
+ - **Accept**: application/octet-stream
1685
+
1686
+
1687
+
1688
+ # **edit_document_docx_replace_paragraph**
1689
+ > ReplaceDocxParagraphResponse edit_document_docx_replace_paragraph(req_config)
1690
+
1691
+ Replace matching paragraphs in a Word DOCX document
1692
+
1693
+ Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested. Replace a paragraph with another object such as an image. Useful for performing templating operations.
1694
+
1695
+ ### Example
1696
+ ```ruby
1697
+ # load the gem
1698
+ require 'cloudmersive-convert-api-client'
1699
+ # setup authorization
1700
+ CloudmersiveConvertApiClient.configure do |config|
1701
+ # Configure API key authorization: Apikey
1702
+ config.api_key['Apikey'] = 'YOUR API KEY'
1703
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1704
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1705
+ end
1706
+
1707
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1708
+
1709
+ req_config = CloudmersiveConvertApiClient::ReplaceDocxParagraphRequest.new # ReplaceDocxParagraphRequest | Document input request
1710
+
1711
+
1712
+ begin
1713
+ #Replace matching paragraphs in a Word DOCX document
1714
+ result = api_instance.edit_document_docx_replace_paragraph(req_config)
1715
+ p result
1716
+ rescue CloudmersiveConvertApiClient::ApiError => e
1717
+ puts "Exception when calling EditDocumentApi->edit_document_docx_replace_paragraph: #{e}"
1718
+ end
1719
+ ```
1720
+
1721
+ ### Parameters
1722
+
1723
+ Name | Type | Description | Notes
1724
+ ------------- | ------------- | ------------- | -------------
1725
+ **req_config** | [**ReplaceDocxParagraphRequest**](ReplaceDocxParagraphRequest.md)| Document input request |
1726
+
1727
+ ### Return type
1728
+
1729
+ [**ReplaceDocxParagraphResponse**](ReplaceDocxParagraphResponse.md)
1730
+
1731
+ ### Authorization
1732
+
1733
+ [Apikey](../README.md#Apikey)
1734
+
1735
+ ### HTTP request headers
1736
+
1737
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1738
+ - **Accept**: application/json, text/json, application/xml, text/xml
1739
+
1740
+
1741
+
1742
+ # **edit_document_docx_set_footer**
1743
+ > DocxSetFooterResponse edit_document_docx_set_footer(req_config)
1744
+
1745
+ Set the footer in a Word DOCX document
1746
+
1747
+ Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
1748
+
1749
+ ### Example
1750
+ ```ruby
1751
+ # load the gem
1752
+ require 'cloudmersive-convert-api-client'
1753
+ # setup authorization
1754
+ CloudmersiveConvertApiClient.configure do |config|
1755
+ # Configure API key authorization: Apikey
1756
+ config.api_key['Apikey'] = 'YOUR API KEY'
1757
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1758
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1759
+ end
1760
+
1761
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1762
+
1763
+ req_config = CloudmersiveConvertApiClient::DocxSetFooterRequest.new # DocxSetFooterRequest | Document input request
1764
+
1765
+
1766
+ begin
1767
+ #Set the footer in a Word DOCX document
1768
+ result = api_instance.edit_document_docx_set_footer(req_config)
1769
+ p result
1770
+ rescue CloudmersiveConvertApiClient::ApiError => e
1771
+ puts "Exception when calling EditDocumentApi->edit_document_docx_set_footer: #{e}"
1772
+ end
1773
+ ```
1774
+
1775
+ ### Parameters
1776
+
1777
+ Name | Type | Description | Notes
1778
+ ------------- | ------------- | ------------- | -------------
1779
+ **req_config** | [**DocxSetFooterRequest**](DocxSetFooterRequest.md)| Document input request |
1780
+
1781
+ ### Return type
1782
+
1783
+ [**DocxSetFooterResponse**](DocxSetFooterResponse.md)
1784
+
1785
+ ### Authorization
1786
+
1787
+ [Apikey](../README.md#Apikey)
1788
+
1789
+ ### HTTP request headers
1790
+
1791
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1792
+ - **Accept**: application/json, text/json, application/xml, text/xml
1793
+
1794
+
1795
+
1796
+ # **edit_document_docx_set_footer_add_page_number**
1797
+ > DocxSetFooterResponse edit_document_docx_set_footer_add_page_number(req_config)
1798
+
1799
+ Add page number to footer in a Word DOCX document
1800
+
1801
+ Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation.
1802
+
1803
+ ### Example
1804
+ ```ruby
1805
+ # load the gem
1806
+ require 'cloudmersive-convert-api-client'
1807
+ # setup authorization
1808
+ CloudmersiveConvertApiClient.configure do |config|
1809
+ # Configure API key authorization: Apikey
1810
+ config.api_key['Apikey'] = 'YOUR API KEY'
1811
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1812
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1813
+ end
1814
+
1815
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1816
+
1817
+ req_config = CloudmersiveConvertApiClient::DocxSetFooterAddPageNumberRequest.new # DocxSetFooterAddPageNumberRequest | Document input request
1818
+
1819
+
1820
+ begin
1821
+ #Add page number to footer in a Word DOCX document
1822
+ result = api_instance.edit_document_docx_set_footer_add_page_number(req_config)
1823
+ p result
1824
+ rescue CloudmersiveConvertApiClient::ApiError => e
1825
+ puts "Exception when calling EditDocumentApi->edit_document_docx_set_footer_add_page_number: #{e}"
1826
+ end
1827
+ ```
1828
+
1829
+ ### Parameters
1830
+
1831
+ Name | Type | Description | Notes
1832
+ ------------- | ------------- | ------------- | -------------
1833
+ **req_config** | [**DocxSetFooterAddPageNumberRequest**](DocxSetFooterAddPageNumberRequest.md)| Document input request |
1834
+
1835
+ ### Return type
1836
+
1837
+ [**DocxSetFooterResponse**](DocxSetFooterResponse.md)
1838
+
1839
+ ### Authorization
1840
+
1841
+ [Apikey](../README.md#Apikey)
1842
+
1843
+ ### HTTP request headers
1844
+
1845
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1846
+ - **Accept**: application/json, text/json, application/xml, text/xml
1847
+
1848
+
1849
+
1850
+ # **edit_document_docx_set_header**
1851
+ > DocxSetHeaderResponse edit_document_docx_set_header(req_config)
1852
+
1853
+ Set the header in a Word DOCX document
1854
+
1855
+ Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation.
1856
+
1857
+ ### Example
1858
+ ```ruby
1859
+ # load the gem
1860
+ require 'cloudmersive-convert-api-client'
1861
+ # setup authorization
1862
+ CloudmersiveConvertApiClient.configure do |config|
1863
+ # Configure API key authorization: Apikey
1864
+ config.api_key['Apikey'] = 'YOUR API KEY'
1865
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1866
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1867
+ end
1868
+
1869
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1870
+
1871
+ req_config = CloudmersiveConvertApiClient::DocxSetHeaderRequest.new # DocxSetHeaderRequest | Document input request
1872
+
1873
+
1874
+ begin
1875
+ #Set the header in a Word DOCX document
1876
+ result = api_instance.edit_document_docx_set_header(req_config)
1877
+ p result
1878
+ rescue CloudmersiveConvertApiClient::ApiError => e
1879
+ puts "Exception when calling EditDocumentApi->edit_document_docx_set_header: #{e}"
1880
+ end
1881
+ ```
1882
+
1883
+ ### Parameters
1884
+
1885
+ Name | Type | Description | Notes
1886
+ ------------- | ------------- | ------------- | -------------
1887
+ **req_config** | [**DocxSetHeaderRequest**](DocxSetHeaderRequest.md)| Document input request |
1888
+
1889
+ ### Return type
1890
+
1891
+ [**DocxSetHeaderResponse**](DocxSetHeaderResponse.md)
1892
+
1893
+ ### Authorization
1894
+
1895
+ [Apikey](../README.md#Apikey)
1896
+
1897
+ ### HTTP request headers
1898
+
1899
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1900
+ - **Accept**: application/json, text/json, application/xml, text/xml
1901
+
1902
+
1903
+
1904
+ # **edit_document_docx_update_table_cell**
1905
+ > UpdateDocxTableCellResponse edit_document_docx_update_table_cell(req_config)
1906
+
1907
+ Update, set contents of a table cell in an existing table in a Word DOCX document
1908
+
1909
+ Sets the contents of a table cell into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
1910
+
1911
+ ### Example
1912
+ ```ruby
1913
+ # load the gem
1914
+ require 'cloudmersive-convert-api-client'
1915
+ # setup authorization
1916
+ CloudmersiveConvertApiClient.configure do |config|
1917
+ # Configure API key authorization: Apikey
1918
+ config.api_key['Apikey'] = 'YOUR API KEY'
1919
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1920
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1921
+ end
1922
+
1923
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1924
+
1925
+ req_config = CloudmersiveConvertApiClient::UpdateDocxTableCellRequest.new # UpdateDocxTableCellRequest | Document input request
1926
+
1927
+
1928
+ begin
1929
+ #Update, set contents of a table cell in an existing table in a Word DOCX document
1930
+ result = api_instance.edit_document_docx_update_table_cell(req_config)
1931
+ p result
1932
+ rescue CloudmersiveConvertApiClient::ApiError => e
1933
+ puts "Exception when calling EditDocumentApi->edit_document_docx_update_table_cell: #{e}"
1934
+ end
1935
+ ```
1936
+
1937
+ ### Parameters
1938
+
1939
+ Name | Type | Description | Notes
1940
+ ------------- | ------------- | ------------- | -------------
1941
+ **req_config** | [**UpdateDocxTableCellRequest**](UpdateDocxTableCellRequest.md)| Document input request |
1942
+
1943
+ ### Return type
1944
+
1945
+ [**UpdateDocxTableCellResponse**](UpdateDocxTableCellResponse.md)
1946
+
1947
+ ### Authorization
1948
+
1949
+ [Apikey](../README.md#Apikey)
1950
+
1951
+ ### HTTP request headers
1952
+
1953
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1954
+ - **Accept**: application/json, text/json, application/xml, text/xml
1955
+
1956
+
1957
+
1958
+ # **edit_document_docx_update_table_row**
1959
+ > UpdateDocxTableRowResponse edit_document_docx_update_table_row(req_config)
1960
+
1961
+ Update, set contents of a table row in an existing table in a Word DOCX document
1962
+
1963
+ Sets the contents of a table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation.
1964
+
1965
+ ### Example
1966
+ ```ruby
1967
+ # load the gem
1968
+ require 'cloudmersive-convert-api-client'
1969
+ # setup authorization
1970
+ CloudmersiveConvertApiClient.configure do |config|
1971
+ # Configure API key authorization: Apikey
1972
+ config.api_key['Apikey'] = 'YOUR API KEY'
1973
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1974
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1975
+ end
1976
+
1977
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
1978
+
1979
+ req_config = CloudmersiveConvertApiClient::UpdateDocxTableRowRequest.new # UpdateDocxTableRowRequest | Document input request
1980
+
1981
+
1982
+ begin
1983
+ #Update, set contents of a table row in an existing table in a Word DOCX document
1984
+ result = api_instance.edit_document_docx_update_table_row(req_config)
1985
+ p result
1986
+ rescue CloudmersiveConvertApiClient::ApiError => e
1987
+ puts "Exception when calling EditDocumentApi->edit_document_docx_update_table_row: #{e}"
1988
+ end
1989
+ ```
1990
+
1991
+ ### Parameters
1992
+
1993
+ Name | Type | Description | Notes
1994
+ ------------- | ------------- | ------------- | -------------
1995
+ **req_config** | [**UpdateDocxTableRowRequest**](UpdateDocxTableRowRequest.md)| Document input request |
1996
+
1997
+ ### Return type
1998
+
1999
+ [**UpdateDocxTableRowResponse**](UpdateDocxTableRowResponse.md)
2000
+
2001
+ ### Authorization
2002
+
2003
+ [Apikey](../README.md#Apikey)
2004
+
2005
+ ### HTTP request headers
2006
+
2007
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2008
+ - **Accept**: application/json, text/json, application/xml, text/xml
2009
+
2010
+
2011
+
2012
+ # **edit_document_finish_editing**
2013
+ > String edit_document_finish_editing(req_config)
2014
+
2015
+ Finish editing document, and download result from document editing
2016
+
2017
+ Once done editing a document, download the result. Begin editing a document by calling begin-editing, then perform operations, then call finish-editing to get the result.
2018
+
2019
+ ### Example
2020
+ ```ruby
2021
+ # load the gem
2022
+ require 'cloudmersive-convert-api-client'
2023
+ # setup authorization
2024
+ CloudmersiveConvertApiClient.configure do |config|
2025
+ # Configure API key authorization: Apikey
2026
+ config.api_key['Apikey'] = 'YOUR API KEY'
2027
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2028
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2029
+ end
2030
+
2031
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2032
+
2033
+ req_config = CloudmersiveConvertApiClient::FinishEditingRequest.new # FinishEditingRequest | Cloudmersive Document URL to complete editing on
2034
+
2035
+
2036
+ begin
2037
+ #Finish editing document, and download result from document editing
2038
+ result = api_instance.edit_document_finish_editing(req_config)
2039
+ p result
2040
+ rescue CloudmersiveConvertApiClient::ApiError => e
2041
+ puts "Exception when calling EditDocumentApi->edit_document_finish_editing: #{e}"
2042
+ end
2043
+ ```
2044
+
2045
+ ### Parameters
2046
+
2047
+ Name | Type | Description | Notes
2048
+ ------------- | ------------- | ------------- | -------------
2049
+ **req_config** | [**FinishEditingRequest**](FinishEditingRequest.md)| Cloudmersive Document URL to complete editing on |
2050
+
2051
+ ### Return type
2052
+
2053
+ **String**
2054
+
2055
+ ### Authorization
2056
+
2057
+ [Apikey](../README.md#Apikey)
2058
+
2059
+ ### HTTP request headers
2060
+
2061
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2062
+ - **Accept**: application/octet-stream
2063
+
2064
+
2065
+
2066
+ # **edit_document_pptx_delete_slides**
2067
+ > String edit_document_pptx_delete_slides(req_config)
2068
+
2069
+ Delete, remove slides from a PowerPoint PPTX presentation document
2070
+
2071
+ Edits the input PowerPoint PPTX presentation document to remove the specified slides
2072
+
2073
+ ### Example
2074
+ ```ruby
2075
+ # load the gem
2076
+ require 'cloudmersive-convert-api-client'
2077
+ # setup authorization
2078
+ CloudmersiveConvertApiClient.configure do |config|
2079
+ # Configure API key authorization: Apikey
2080
+ config.api_key['Apikey'] = 'YOUR API KEY'
2081
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2082
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2083
+ end
2084
+
2085
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2086
+
2087
+ req_config = CloudmersiveConvertApiClient::RemovePptxSlidesRequest.new # RemovePptxSlidesRequest | Presentation input request
2088
+
2089
+
2090
+ begin
2091
+ #Delete, remove slides from a PowerPoint PPTX presentation document
2092
+ result = api_instance.edit_document_pptx_delete_slides(req_config)
2093
+ p result
2094
+ rescue CloudmersiveConvertApiClient::ApiError => e
2095
+ puts "Exception when calling EditDocumentApi->edit_document_pptx_delete_slides: #{e}"
2096
+ end
2097
+ ```
2098
+
2099
+ ### Parameters
2100
+
2101
+ Name | Type | Description | Notes
2102
+ ------------- | ------------- | ------------- | -------------
2103
+ **req_config** | [**RemovePptxSlidesRequest**](RemovePptxSlidesRequest.md)| Presentation input request |
2104
+
2105
+ ### Return type
2106
+
2107
+ **String**
2108
+
2109
+ ### Authorization
2110
+
2111
+ [Apikey](../README.md#Apikey)
2112
+
2113
+ ### HTTP request headers
2114
+
2115
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2116
+ - **Accept**: application/octet-stream
2117
+
2118
+
2119
+
2120
+ # **edit_document_pptx_replace**
2121
+ > String edit_document_pptx_replace(req_config)
2122
+
2123
+ Replace string in PowerPoint PPTX presentation
2124
+
2125
+ Replace all instances of a string in an Office PowerPoint Document (pptx)
2126
+
2127
+ ### Example
2128
+ ```ruby
2129
+ # load the gem
2130
+ require 'cloudmersive-convert-api-client'
2131
+ # setup authorization
2132
+ CloudmersiveConvertApiClient.configure do |config|
2133
+ # Configure API key authorization: Apikey
2134
+ config.api_key['Apikey'] = 'YOUR API KEY'
2135
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2136
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2137
+ end
2138
+
2139
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2140
+
2141
+ req_config = CloudmersiveConvertApiClient::ReplaceStringRequest.new # ReplaceStringRequest | Replacement document configuration input
2142
+
2143
+
2144
+ begin
2145
+ #Replace string in PowerPoint PPTX presentation
2146
+ result = api_instance.edit_document_pptx_replace(req_config)
2147
+ p result
2148
+ rescue CloudmersiveConvertApiClient::ApiError => e
2149
+ puts "Exception when calling EditDocumentApi->edit_document_pptx_replace: #{e}"
2150
+ end
2151
+ ```
2152
+
2153
+ ### Parameters
2154
+
2155
+ Name | Type | Description | Notes
2156
+ ------------- | ------------- | ------------- | -------------
2157
+ **req_config** | [**ReplaceStringRequest**](ReplaceStringRequest.md)| Replacement document configuration input |
2158
+
2159
+ ### Return type
2160
+
2161
+ **String**
2162
+
2163
+ ### Authorization
2164
+
2165
+ [Apikey](../README.md#Apikey)
2166
+
2167
+ ### HTTP request headers
2168
+
2169
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2170
+ - **Accept**: application/octet-stream
2171
+
2172
+
2173
+
2174
+ # **edit_document_xlsx_append_row**
2175
+ > AppendXlsxRowResponse edit_document_xlsx_append_row(input)
2176
+
2177
+ Append row to a Excel XLSX spreadsheet, worksheet
2178
+
2179
+ Appends a row to the end of an Excel Spreadsheet worksheet.
2180
+
2181
+ ### Example
2182
+ ```ruby
2183
+ # load the gem
2184
+ require 'cloudmersive-convert-api-client'
2185
+ # setup authorization
2186
+ CloudmersiveConvertApiClient.configure do |config|
2187
+ # Configure API key authorization: Apikey
2188
+ config.api_key['Apikey'] = 'YOUR API KEY'
2189
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2190
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2191
+ end
2192
+
2193
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2194
+
2195
+ input = CloudmersiveConvertApiClient::AppendXlsxRowRequest.new # AppendXlsxRowRequest | Document input request
2196
+
2197
+
2198
+ begin
2199
+ #Append row to a Excel XLSX spreadsheet, worksheet
2200
+ result = api_instance.edit_document_xlsx_append_row(input)
2201
+ p result
2202
+ rescue CloudmersiveConvertApiClient::ApiError => e
2203
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_append_row: #{e}"
2204
+ end
2205
+ ```
2206
+
2207
+ ### Parameters
2208
+
2209
+ Name | Type | Description | Notes
2210
+ ------------- | ------------- | ------------- | -------------
2211
+ **input** | [**AppendXlsxRowRequest**](AppendXlsxRowRequest.md)| Document input request |
2212
+
2213
+ ### Return type
2214
+
2215
+ [**AppendXlsxRowResponse**](AppendXlsxRowResponse.md)
2216
+
2217
+ ### Authorization
2218
+
2219
+ [Apikey](../README.md#Apikey)
2220
+
2221
+ ### HTTP request headers
2222
+
2223
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2224
+ - **Accept**: application/json, text/json, application/xml, text/xml
2225
+
2226
+
2227
+
2228
+ # **edit_document_xlsx_clear_cell_by_index**
2229
+ > ClearXlsxCellResponse edit_document_xlsx_clear_cell_by_index(input)
2230
+
2231
+ Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
2232
+
2233
+ Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
2234
+
2235
+ ### Example
2236
+ ```ruby
2237
+ # load the gem
2238
+ require 'cloudmersive-convert-api-client'
2239
+ # setup authorization
2240
+ CloudmersiveConvertApiClient.configure do |config|
2241
+ # Configure API key authorization: Apikey
2242
+ config.api_key['Apikey'] = 'YOUR API KEY'
2243
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2244
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2245
+ end
2246
+
2247
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2248
+
2249
+ input = CloudmersiveConvertApiClient::ClearXlsxCellRequest.new # ClearXlsxCellRequest | Document input request
2250
+
2251
+
2252
+ begin
2253
+ #Clear cell contents in an Excel XLSX spreadsheet, worksheet by index
2254
+ result = api_instance.edit_document_xlsx_clear_cell_by_index(input)
2255
+ p result
2256
+ rescue CloudmersiveConvertApiClient::ApiError => e
2257
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_clear_cell_by_index: #{e}"
2258
+ end
2259
+ ```
2260
+
2261
+ ### Parameters
2262
+
2263
+ Name | Type | Description | Notes
2264
+ ------------- | ------------- | ------------- | -------------
2265
+ **input** | [**ClearXlsxCellRequest**](ClearXlsxCellRequest.md)| Document input request |
2266
+
2267
+ ### Return type
2268
+
2269
+ [**ClearXlsxCellResponse**](ClearXlsxCellResponse.md)
2270
+
2271
+ ### Authorization
2272
+
2273
+ [Apikey](../README.md#Apikey)
2274
+
2275
+ ### HTTP request headers
2276
+
2277
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2278
+ - **Accept**: application/json, text/json, application/xml, text/xml
2279
+
2280
+
2281
+
2282
+ # **edit_document_xlsx_clear_row**
2283
+ > ClearXlsxRowResponse edit_document_xlsx_clear_row(input)
2284
+
2285
+ Clear row from a Excel XLSX spreadsheet, worksheet
2286
+
2287
+ Clears data from a specific row in the Excel Spreadsheet worksheet, leaving a blank row. Use the Get Rows And Cells API to enumerate available rows in a spreadsheet.
2288
+
2289
+ ### Example
2290
+ ```ruby
2291
+ # load the gem
2292
+ require 'cloudmersive-convert-api-client'
2293
+ # setup authorization
2294
+ CloudmersiveConvertApiClient.configure do |config|
2295
+ # Configure API key authorization: Apikey
2296
+ config.api_key['Apikey'] = 'YOUR API KEY'
2297
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2298
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2299
+ end
2300
+
2301
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2302
+
2303
+ input = CloudmersiveConvertApiClient::ClearXlsxRowRequest.new # ClearXlsxRowRequest | Document input request
2304
+
2305
+
2306
+ begin
2307
+ #Clear row from a Excel XLSX spreadsheet, worksheet
2308
+ result = api_instance.edit_document_xlsx_clear_row(input)
2309
+ p result
2310
+ rescue CloudmersiveConvertApiClient::ApiError => e
2311
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_clear_row: #{e}"
2312
+ end
2313
+ ```
2314
+
2315
+ ### Parameters
2316
+
2317
+ Name | Type | Description | Notes
2318
+ ------------- | ------------- | ------------- | -------------
2319
+ **input** | [**ClearXlsxRowRequest**](ClearXlsxRowRequest.md)| Document input request |
2320
+
2321
+ ### Return type
2322
+
2323
+ [**ClearXlsxRowResponse**](ClearXlsxRowResponse.md)
2324
+
2325
+ ### Authorization
2326
+
2327
+ [Apikey](../README.md#Apikey)
2328
+
2329
+ ### HTTP request headers
2330
+
2331
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2332
+ - **Accept**: application/json, text/json, application/xml, text/xml
2333
+
2334
+
2335
+
2336
+ # **edit_document_xlsx_create_blank_spreadsheet**
2337
+ > CreateBlankSpreadsheetResponse edit_document_xlsx_create_blank_spreadsheet(input)
2338
+
2339
+ Create a blank Excel XLSX spreadsheet
2340
+
2341
+ Returns a blank Excel XLSX Spreadsheet (XLSX) format file
2342
+
2343
+ ### Example
2344
+ ```ruby
2345
+ # load the gem
2346
+ require 'cloudmersive-convert-api-client'
2347
+ # setup authorization
2348
+ CloudmersiveConvertApiClient.configure do |config|
2349
+ # Configure API key authorization: Apikey
2350
+ config.api_key['Apikey'] = 'YOUR API KEY'
2351
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2352
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2353
+ end
2354
+
2355
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2356
+
2357
+ input = CloudmersiveConvertApiClient::CreateBlankSpreadsheetRequest.new # CreateBlankSpreadsheetRequest | Document input request
2358
+
2359
+
2360
+ begin
2361
+ #Create a blank Excel XLSX spreadsheet
2362
+ result = api_instance.edit_document_xlsx_create_blank_spreadsheet(input)
2363
+ p result
2364
+ rescue CloudmersiveConvertApiClient::ApiError => e
2365
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_create_blank_spreadsheet: #{e}"
2366
+ end
2367
+ ```
2368
+
2369
+ ### Parameters
2370
+
2371
+ Name | Type | Description | Notes
2372
+ ------------- | ------------- | ------------- | -------------
2373
+ **input** | [**CreateBlankSpreadsheetRequest**](CreateBlankSpreadsheetRequest.md)| Document input request |
2374
+
2375
+ ### Return type
2376
+
2377
+ [**CreateBlankSpreadsheetResponse**](CreateBlankSpreadsheetResponse.md)
2378
+
2379
+ ### Authorization
2380
+
2381
+ [Apikey](../README.md#Apikey)
2382
+
2383
+ ### HTTP request headers
2384
+
2385
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2386
+ - **Accept**: application/json, text/json, application/xml, text/xml
2387
+
2388
+
2389
+
2390
+ # **edit_document_xlsx_create_spreadsheet_from_data**
2391
+ > CreateSpreadsheetFromDataResponse edit_document_xlsx_create_spreadsheet_from_data(input)
2392
+
2393
+ Create a new Excel XLSX spreadsheet from column and row data
2394
+
2395
+ Returns a new Excel XLSX Spreadsheet (XLSX) format file populated with column and row data specified as input
2396
+
2397
+ ### Example
2398
+ ```ruby
2399
+ # load the gem
2400
+ require 'cloudmersive-convert-api-client'
2401
+ # setup authorization
2402
+ CloudmersiveConvertApiClient.configure do |config|
2403
+ # Configure API key authorization: Apikey
2404
+ config.api_key['Apikey'] = 'YOUR API KEY'
2405
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2406
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2407
+ end
2408
+
2409
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2410
+
2411
+ input = CloudmersiveConvertApiClient::CreateSpreadsheetFromDataRequest.new # CreateSpreadsheetFromDataRequest | Document input request
2412
+
2413
+
2414
+ begin
2415
+ #Create a new Excel XLSX spreadsheet from column and row data
2416
+ result = api_instance.edit_document_xlsx_create_spreadsheet_from_data(input)
2417
+ p result
2418
+ rescue CloudmersiveConvertApiClient::ApiError => e
2419
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_create_spreadsheet_from_data: #{e}"
2420
+ end
2421
+ ```
2422
+
2423
+ ### Parameters
2424
+
2425
+ Name | Type | Description | Notes
2426
+ ------------- | ------------- | ------------- | -------------
2427
+ **input** | [**CreateSpreadsheetFromDataRequest**](CreateSpreadsheetFromDataRequest.md)| Document input request |
2428
+
2429
+ ### Return type
2430
+
2431
+ [**CreateSpreadsheetFromDataResponse**](CreateSpreadsheetFromDataResponse.md)
2432
+
2433
+ ### Authorization
2434
+
2435
+ [Apikey](../README.md#Apikey)
2436
+
2437
+ ### HTTP request headers
2438
+
2439
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2440
+ - **Accept**: application/json, text/json, application/xml, text/xml
2441
+
2442
+
2443
+
2444
+ # **edit_document_xlsx_delete_worksheet**
2445
+ > String edit_document_xlsx_delete_worksheet(req_config)
2446
+
2447
+ Delete, remove worksheet from an Excel XLSX spreadsheet document
2448
+
2449
+ Edits the input Excel XLSX spreadsheet document to remove the specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.
2450
+
2451
+ ### Example
2452
+ ```ruby
2453
+ # load the gem
2454
+ require 'cloudmersive-convert-api-client'
2455
+ # setup authorization
2456
+ CloudmersiveConvertApiClient.configure do |config|
2457
+ # Configure API key authorization: Apikey
2458
+ config.api_key['Apikey'] = 'YOUR API KEY'
2459
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2460
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2461
+ end
2462
+
2463
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2464
+
2465
+ req_config = CloudmersiveConvertApiClient::RemoveXlsxWorksheetRequest.new # RemoveXlsxWorksheetRequest | Spreadsheet input request
2466
+
2467
+
2468
+ begin
2469
+ #Delete, remove worksheet from an Excel XLSX spreadsheet document
2470
+ result = api_instance.edit_document_xlsx_delete_worksheet(req_config)
2471
+ p result
2472
+ rescue CloudmersiveConvertApiClient::ApiError => e
2473
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_delete_worksheet: #{e}"
2474
+ end
2475
+ ```
2476
+
2477
+ ### Parameters
2478
+
2479
+ Name | Type | Description | Notes
2480
+ ------------- | ------------- | ------------- | -------------
2481
+ **req_config** | [**RemoveXlsxWorksheetRequest**](RemoveXlsxWorksheetRequest.md)| Spreadsheet input request |
2482
+
2483
+ ### Return type
2484
+
2485
+ **String**
2486
+
2487
+ ### Authorization
2488
+
2489
+ [Apikey](../README.md#Apikey)
2490
+
2491
+ ### HTTP request headers
2492
+
2493
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2494
+ - **Accept**: application/octet-stream
2495
+
2496
+
2497
+
2498
+ # **edit_document_xlsx_disable_shared_workbook**
2499
+ > DisableSharedWorkbookResponse edit_document_xlsx_disable_shared_workbook(input)
2500
+
2501
+ Disable Shared Workbook (legacy) in Excel XLSX spreadsheet
2502
+
2503
+ Disable the Shared Workbook (legacy) mode in an Excel XLSX spreadsheet
2504
+
2505
+ ### Example
2506
+ ```ruby
2507
+ # load the gem
2508
+ require 'cloudmersive-convert-api-client'
2509
+ # setup authorization
2510
+ CloudmersiveConvertApiClient.configure do |config|
2511
+ # Configure API key authorization: Apikey
2512
+ config.api_key['Apikey'] = 'YOUR API KEY'
2513
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2514
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2515
+ end
2516
+
2517
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2518
+
2519
+ input = CloudmersiveConvertApiClient::DisableSharedWorkbookRequest.new # DisableSharedWorkbookRequest | Document input request
2520
+
2521
+
2522
+ begin
2523
+ #Disable Shared Workbook (legacy) in Excel XLSX spreadsheet
2524
+ result = api_instance.edit_document_xlsx_disable_shared_workbook(input)
2525
+ p result
2526
+ rescue CloudmersiveConvertApiClient::ApiError => e
2527
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_disable_shared_workbook: #{e}"
2528
+ end
2529
+ ```
2530
+
2531
+ ### Parameters
2532
+
2533
+ Name | Type | Description | Notes
2534
+ ------------- | ------------- | ------------- | -------------
2535
+ **input** | [**DisableSharedWorkbookRequest**](DisableSharedWorkbookRequest.md)| Document input request |
2536
+
2537
+ ### Return type
2538
+
2539
+ [**DisableSharedWorkbookResponse**](DisableSharedWorkbookResponse.md)
2540
+
2541
+ ### Authorization
2542
+
2543
+ [Apikey](../README.md#Apikey)
2544
+
2545
+ ### HTTP request headers
2546
+
2547
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2548
+ - **Accept**: application/json, text/json, application/xml, text/xml
2549
+
2550
+
2551
+
2552
+ # **edit_document_xlsx_enable_shared_workbook**
2553
+ > EnableSharedWorkbookResponse edit_document_xlsx_enable_shared_workbook(input)
2554
+
2555
+ Enable Shared Workbook (legacy) in Excel XLSX spreadsheet
2556
+
2557
+ Enables the Shared Workbook (legacy) mode in an Excel XLSX spreadsheet
2558
+
2559
+ ### Example
2560
+ ```ruby
2561
+ # load the gem
2562
+ require 'cloudmersive-convert-api-client'
2563
+ # setup authorization
2564
+ CloudmersiveConvertApiClient.configure do |config|
2565
+ # Configure API key authorization: Apikey
2566
+ config.api_key['Apikey'] = 'YOUR API KEY'
2567
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2568
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2569
+ end
2570
+
2571
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2572
+
2573
+ input = CloudmersiveConvertApiClient::EnableSharedWorkbookRequest.new # EnableSharedWorkbookRequest | Document input request
2574
+
2575
+
2576
+ begin
2577
+ #Enable Shared Workbook (legacy) in Excel XLSX spreadsheet
2578
+ result = api_instance.edit_document_xlsx_enable_shared_workbook(input)
2579
+ p result
2580
+ rescue CloudmersiveConvertApiClient::ApiError => e
2581
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_enable_shared_workbook: #{e}"
2582
+ end
2583
+ ```
2584
+
2585
+ ### Parameters
2586
+
2587
+ Name | Type | Description | Notes
2588
+ ------------- | ------------- | ------------- | -------------
2589
+ **input** | [**EnableSharedWorkbookRequest**](EnableSharedWorkbookRequest.md)| Document input request |
2590
+
2591
+ ### Return type
2592
+
2593
+ [**EnableSharedWorkbookResponse**](EnableSharedWorkbookResponse.md)
2594
+
2595
+ ### Authorization
2596
+
2597
+ [Apikey](../README.md#Apikey)
2598
+
2599
+ ### HTTP request headers
2600
+
2601
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2602
+ - **Accept**: application/json, text/json, application/xml, text/xml
2603
+
2604
+
2605
+
2606
+ # **edit_document_xlsx_get_cell_by_identifier**
2607
+ > GetXlsxCellByIdentifierResponse edit_document_xlsx_get_cell_by_identifier(input)
2608
+
2609
+ Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
2610
+
2611
+ Returns the value of a specific cell based on its identifier (e.g. A1, B22, C33, etc.) in the Excel Spreadsheet worksheet
2612
+
2613
+ ### Example
2614
+ ```ruby
2615
+ # load the gem
2616
+ require 'cloudmersive-convert-api-client'
2617
+ # setup authorization
2618
+ CloudmersiveConvertApiClient.configure do |config|
2619
+ # Configure API key authorization: Apikey
2620
+ config.api_key['Apikey'] = 'YOUR API KEY'
2621
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2622
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2623
+ end
2624
+
2625
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2626
+
2627
+ input = CloudmersiveConvertApiClient::GetXlsxCellByIdentifierRequest.new # GetXlsxCellByIdentifierRequest | Document input request
2628
+
2629
+
2630
+ begin
2631
+ #Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier
2632
+ result = api_instance.edit_document_xlsx_get_cell_by_identifier(input)
2633
+ p result
2634
+ rescue CloudmersiveConvertApiClient::ApiError => e
2635
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_cell_by_identifier: #{e}"
2636
+ end
2637
+ ```
2638
+
2639
+ ### Parameters
2640
+
2641
+ Name | Type | Description | Notes
2642
+ ------------- | ------------- | ------------- | -------------
2643
+ **input** | [**GetXlsxCellByIdentifierRequest**](GetXlsxCellByIdentifierRequest.md)| Document input request |
2644
+
2645
+ ### Return type
2646
+
2647
+ [**GetXlsxCellByIdentifierResponse**](GetXlsxCellByIdentifierResponse.md)
2648
+
2649
+ ### Authorization
2650
+
2651
+ [Apikey](../README.md#Apikey)
2652
+
2653
+ ### HTTP request headers
2654
+
2655
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2656
+ - **Accept**: application/json, text/json, application/xml, text/xml
2657
+
2658
+
2659
+
2660
+ # **edit_document_xlsx_get_cell_by_index**
2661
+ > GetXlsxCellResponse edit_document_xlsx_get_cell_by_index(input)
2662
+
2663
+ Get cell from an Excel XLSX spreadsheet, worksheet by index
2664
+
2665
+ Returns the value and definition of a specific cell in a specific row in the Excel Spreadsheet worksheet
2666
+
2667
+ ### Example
2668
+ ```ruby
2669
+ # load the gem
2670
+ require 'cloudmersive-convert-api-client'
2671
+ # setup authorization
2672
+ CloudmersiveConvertApiClient.configure do |config|
2673
+ # Configure API key authorization: Apikey
2674
+ config.api_key['Apikey'] = 'YOUR API KEY'
2675
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2676
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2677
+ end
2678
+
2679
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2680
+
2681
+ input = CloudmersiveConvertApiClient::GetXlsxCellRequest.new # GetXlsxCellRequest | Document input request
2682
+
2683
+
2684
+ begin
2685
+ #Get cell from an Excel XLSX spreadsheet, worksheet by index
2686
+ result = api_instance.edit_document_xlsx_get_cell_by_index(input)
2687
+ p result
2688
+ rescue CloudmersiveConvertApiClient::ApiError => e
2689
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_cell_by_index: #{e}"
2690
+ end
2691
+ ```
2692
+
2693
+ ### Parameters
2694
+
2695
+ Name | Type | Description | Notes
2696
+ ------------- | ------------- | ------------- | -------------
2697
+ **input** | [**GetXlsxCellRequest**](GetXlsxCellRequest.md)| Document input request |
2698
+
2699
+ ### Return type
2700
+
2701
+ [**GetXlsxCellResponse**](GetXlsxCellResponse.md)
2702
+
2703
+ ### Authorization
2704
+
2705
+ [Apikey](../README.md#Apikey)
2706
+
2707
+ ### HTTP request headers
2708
+
2709
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2710
+ - **Accept**: application/json, text/json, application/xml, text/xml
2711
+
2712
+
2713
+
2714
+ # **edit_document_xlsx_get_columns**
2715
+ > GetXlsxColumnsResponse edit_document_xlsx_get_columns(input)
2716
+
2717
+ Get columns from a Excel XLSX spreadsheet, worksheet
2718
+
2719
+ Returns the columns defined in the Excel Spreadsheet worksheet
2720
+
2721
+ ### Example
2722
+ ```ruby
2723
+ # load the gem
2724
+ require 'cloudmersive-convert-api-client'
2725
+ # setup authorization
2726
+ CloudmersiveConvertApiClient.configure do |config|
2727
+ # Configure API key authorization: Apikey
2728
+ config.api_key['Apikey'] = 'YOUR API KEY'
2729
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2730
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2731
+ end
2732
+
2733
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2734
+
2735
+ input = CloudmersiveConvertApiClient::GetXlsxColumnsRequest.new # GetXlsxColumnsRequest | Document input request
2736
+
2737
+
2738
+ begin
2739
+ #Get columns from a Excel XLSX spreadsheet, worksheet
2740
+ result = api_instance.edit_document_xlsx_get_columns(input)
2741
+ p result
2742
+ rescue CloudmersiveConvertApiClient::ApiError => e
2743
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_columns: #{e}"
2744
+ end
2745
+ ```
2746
+
2747
+ ### Parameters
2748
+
2749
+ Name | Type | Description | Notes
2750
+ ------------- | ------------- | ------------- | -------------
2751
+ **input** | [**GetXlsxColumnsRequest**](GetXlsxColumnsRequest.md)| Document input request |
2752
+
2753
+ ### Return type
2754
+
2755
+ [**GetXlsxColumnsResponse**](GetXlsxColumnsResponse.md)
2756
+
2757
+ ### Authorization
2758
+
2759
+ [Apikey](../README.md#Apikey)
2760
+
2761
+ ### HTTP request headers
2762
+
2763
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2764
+ - **Accept**: application/json, text/json, application/xml, text/xml
2765
+
2766
+
2767
+
2768
+ # **edit_document_xlsx_get_images**
2769
+ > GetXlsxImagesResponse edit_document_xlsx_get_images(input)
2770
+
2771
+ Get images from a Excel XLSX spreadsheet, worksheet
2772
+
2773
+ Returns the images defined in the Excel Spreadsheet worksheet
2774
+
2775
+ ### Example
2776
+ ```ruby
2777
+ # load the gem
2778
+ require 'cloudmersive-convert-api-client'
2779
+ # setup authorization
2780
+ CloudmersiveConvertApiClient.configure do |config|
2781
+ # Configure API key authorization: Apikey
2782
+ config.api_key['Apikey'] = 'YOUR API KEY'
2783
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2784
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2785
+ end
2786
+
2787
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2788
+
2789
+ input = CloudmersiveConvertApiClient::GetXlsxImagesRequest.new # GetXlsxImagesRequest | Document input request
2790
+
2791
+
2792
+ begin
2793
+ #Get images from a Excel XLSX spreadsheet, worksheet
2794
+ result = api_instance.edit_document_xlsx_get_images(input)
2795
+ p result
2796
+ rescue CloudmersiveConvertApiClient::ApiError => e
2797
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_images: #{e}"
2798
+ end
2799
+ ```
2800
+
2801
+ ### Parameters
2802
+
2803
+ Name | Type | Description | Notes
2804
+ ------------- | ------------- | ------------- | -------------
2805
+ **input** | [**GetXlsxImagesRequest**](GetXlsxImagesRequest.md)| Document input request |
2806
+
2807
+ ### Return type
2808
+
2809
+ [**GetXlsxImagesResponse**](GetXlsxImagesResponse.md)
2810
+
2811
+ ### Authorization
2812
+
2813
+ [Apikey](../README.md#Apikey)
2814
+
2815
+ ### HTTP request headers
2816
+
2817
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2818
+ - **Accept**: application/json, text/json, application/xml, text/xml
2819
+
2820
+
2821
+
2822
+ # **edit_document_xlsx_get_rows_and_cells**
2823
+ > GetXlsxRowsAndCellsResponse edit_document_xlsx_get_rows_and_cells(input)
2824
+
2825
+ Get rows and cells from a Excel XLSX spreadsheet, worksheet
2826
+
2827
+ Returns the rows and cells defined in the Excel Spreadsheet worksheet
2828
+
2829
+ ### Example
2830
+ ```ruby
2831
+ # load the gem
2832
+ require 'cloudmersive-convert-api-client'
2833
+ # setup authorization
2834
+ CloudmersiveConvertApiClient.configure do |config|
2835
+ # Configure API key authorization: Apikey
2836
+ config.api_key['Apikey'] = 'YOUR API KEY'
2837
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2838
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2839
+ end
2840
+
2841
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2842
+
2843
+ input = CloudmersiveConvertApiClient::GetXlsxRowsAndCellsRequest.new # GetXlsxRowsAndCellsRequest | Document input request
2844
+
2845
+
2846
+ begin
2847
+ #Get rows and cells from a Excel XLSX spreadsheet, worksheet
2848
+ result = api_instance.edit_document_xlsx_get_rows_and_cells(input)
2849
+ p result
2850
+ rescue CloudmersiveConvertApiClient::ApiError => e
2851
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_rows_and_cells: #{e}"
2852
+ end
2853
+ ```
2854
+
2855
+ ### Parameters
2856
+
2857
+ Name | Type | Description | Notes
2858
+ ------------- | ------------- | ------------- | -------------
2859
+ **input** | [**GetXlsxRowsAndCellsRequest**](GetXlsxRowsAndCellsRequest.md)| Document input request |
2860
+
2861
+ ### Return type
2862
+
2863
+ [**GetXlsxRowsAndCellsResponse**](GetXlsxRowsAndCellsResponse.md)
2864
+
2865
+ ### Authorization
2866
+
2867
+ [Apikey](../README.md#Apikey)
2868
+
2869
+ ### HTTP request headers
2870
+
2871
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2872
+ - **Accept**: application/json, text/json, application/xml, text/xml
2873
+
2874
+
2875
+
2876
+ # **edit_document_xlsx_get_specific_row**
2877
+ > GetXlsxSpecificRowResponse edit_document_xlsx_get_specific_row(input)
2878
+
2879
+ Get a specific row from a Excel XLSX spreadsheet, worksheet by path
2880
+
2881
+ Returns the specific row and its cells defined in the Excel Spreadsheet worksheet based on the specified path.
2882
+
2883
+ ### Example
2884
+ ```ruby
2885
+ # load the gem
2886
+ require 'cloudmersive-convert-api-client'
2887
+ # setup authorization
2888
+ CloudmersiveConvertApiClient.configure do |config|
2889
+ # Configure API key authorization: Apikey
2890
+ config.api_key['Apikey'] = 'YOUR API KEY'
2891
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2892
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2893
+ end
2894
+
2895
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2896
+
2897
+ input = CloudmersiveConvertApiClient::GetXlsxSpecificRowRequest.new # GetXlsxSpecificRowRequest | Document input request
2898
+
2899
+
2900
+ begin
2901
+ #Get a specific row from a Excel XLSX spreadsheet, worksheet by path
2902
+ result = api_instance.edit_document_xlsx_get_specific_row(input)
2903
+ p result
2904
+ rescue CloudmersiveConvertApiClient::ApiError => e
2905
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_specific_row: #{e}"
2906
+ end
2907
+ ```
2908
+
2909
+ ### Parameters
2910
+
2911
+ Name | Type | Description | Notes
2912
+ ------------- | ------------- | ------------- | -------------
2913
+ **input** | [**GetXlsxSpecificRowRequest**](GetXlsxSpecificRowRequest.md)| Document input request |
2914
+
2915
+ ### Return type
2916
+
2917
+ [**GetXlsxSpecificRowResponse**](GetXlsxSpecificRowResponse.md)
2918
+
2919
+ ### Authorization
2920
+
2921
+ [Apikey](../README.md#Apikey)
2922
+
2923
+ ### HTTP request headers
2924
+
2925
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2926
+ - **Accept**: application/json, text/json, application/xml, text/xml
2927
+
2928
+
2929
+
2930
+ # **edit_document_xlsx_get_styles**
2931
+ > GetXlsxStylesResponse edit_document_xlsx_get_styles(input)
2932
+
2933
+ Get styles from a Excel XLSX spreadsheet, worksheet
2934
+
2935
+ Returns the style defined in the Excel Spreadsheet
2936
+
2937
+ ### Example
2938
+ ```ruby
2939
+ # load the gem
2940
+ require 'cloudmersive-convert-api-client'
2941
+ # setup authorization
2942
+ CloudmersiveConvertApiClient.configure do |config|
2943
+ # Configure API key authorization: Apikey
2944
+ config.api_key['Apikey'] = 'YOUR API KEY'
2945
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2946
+ #config.api_key_prefix['Apikey'] = 'Bearer'
2947
+ end
2948
+
2949
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
2950
+
2951
+ input = CloudmersiveConvertApiClient::GetXlsxStylesRequest.new # GetXlsxStylesRequest | Document input request
2952
+
2953
+
2954
+ begin
2955
+ #Get styles from a Excel XLSX spreadsheet, worksheet
2956
+ result = api_instance.edit_document_xlsx_get_styles(input)
2957
+ p result
2958
+ rescue CloudmersiveConvertApiClient::ApiError => e
2959
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_styles: #{e}"
2960
+ end
2961
+ ```
2962
+
2963
+ ### Parameters
2964
+
2965
+ Name | Type | Description | Notes
2966
+ ------------- | ------------- | ------------- | -------------
2967
+ **input** | [**GetXlsxStylesRequest**](GetXlsxStylesRequest.md)| Document input request |
2968
+
2969
+ ### Return type
2970
+
2971
+ [**GetXlsxStylesResponse**](GetXlsxStylesResponse.md)
2972
+
2973
+ ### Authorization
2974
+
2975
+ [Apikey](../README.md#Apikey)
2976
+
2977
+ ### HTTP request headers
2978
+
2979
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
2980
+ - **Accept**: application/json, text/json, application/xml, text/xml
2981
+
2982
+
2983
+
2984
+ # **edit_document_xlsx_get_worksheets**
2985
+ > GetXlsxWorksheetsResponse edit_document_xlsx_get_worksheets(input)
2986
+
2987
+ Get worksheets from a Excel XLSX spreadsheet
2988
+
2989
+ Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file
2990
+
2991
+ ### Example
2992
+ ```ruby
2993
+ # load the gem
2994
+ require 'cloudmersive-convert-api-client'
2995
+ # setup authorization
2996
+ CloudmersiveConvertApiClient.configure do |config|
2997
+ # Configure API key authorization: Apikey
2998
+ config.api_key['Apikey'] = 'YOUR API KEY'
2999
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3000
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3001
+ end
3002
+
3003
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
3004
+
3005
+ input = CloudmersiveConvertApiClient::GetXlsxWorksheetsRequest.new # GetXlsxWorksheetsRequest | Document input request
3006
+
3007
+
3008
+ begin
3009
+ #Get worksheets from a Excel XLSX spreadsheet
3010
+ result = api_instance.edit_document_xlsx_get_worksheets(input)
3011
+ p result
3012
+ rescue CloudmersiveConvertApiClient::ApiError => e
3013
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_get_worksheets: #{e}"
3014
+ end
3015
+ ```
3016
+
3017
+ ### Parameters
3018
+
3019
+ Name | Type | Description | Notes
3020
+ ------------- | ------------- | ------------- | -------------
3021
+ **input** | [**GetXlsxWorksheetsRequest**](GetXlsxWorksheetsRequest.md)| Document input request |
3022
+
3023
+ ### Return type
3024
+
3025
+ [**GetXlsxWorksheetsResponse**](GetXlsxWorksheetsResponse.md)
3026
+
3027
+ ### Authorization
3028
+
3029
+ [Apikey](../README.md#Apikey)
3030
+
3031
+ ### HTTP request headers
3032
+
3033
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
3034
+ - **Accept**: application/json, text/json, application/xml, text/xml
3035
+
3036
+
3037
+
3038
+ # **edit_document_xlsx_insert_worksheet**
3039
+ > InsertXlsxWorksheetResponse edit_document_xlsx_insert_worksheet(input)
3040
+
3041
+ Insert a new worksheet into an Excel XLSX spreadsheet
3042
+
3043
+ Inserts a new worksheet into an Excel Spreadsheet
3044
+
3045
+ ### Example
3046
+ ```ruby
3047
+ # load the gem
3048
+ require 'cloudmersive-convert-api-client'
3049
+ # setup authorization
3050
+ CloudmersiveConvertApiClient.configure do |config|
3051
+ # Configure API key authorization: Apikey
3052
+ config.api_key['Apikey'] = 'YOUR API KEY'
3053
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3054
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3055
+ end
3056
+
3057
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
3058
+
3059
+ input = CloudmersiveConvertApiClient::InsertXlsxWorksheetRequest.new # InsertXlsxWorksheetRequest | Document input request
3060
+
3061
+
3062
+ begin
3063
+ #Insert a new worksheet into an Excel XLSX spreadsheet
3064
+ result = api_instance.edit_document_xlsx_insert_worksheet(input)
3065
+ p result
3066
+ rescue CloudmersiveConvertApiClient::ApiError => e
3067
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_insert_worksheet: #{e}"
3068
+ end
3069
+ ```
3070
+
3071
+ ### Parameters
3072
+
3073
+ Name | Type | Description | Notes
3074
+ ------------- | ------------- | ------------- | -------------
3075
+ **input** | [**InsertXlsxWorksheetRequest**](InsertXlsxWorksheetRequest.md)| Document input request |
3076
+
3077
+ ### Return type
3078
+
3079
+ [**InsertXlsxWorksheetResponse**](InsertXlsxWorksheetResponse.md)
3080
+
3081
+ ### Authorization
3082
+
3083
+ [Apikey](../README.md#Apikey)
3084
+
3085
+ ### HTTP request headers
3086
+
3087
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
3088
+ - **Accept**: application/json, text/json, application/xml, text/xml
3089
+
3090
+
3091
+
3092
+ # **edit_document_xlsx_rename_worksheet**
3093
+ > RenameXlsxWorksheetResponse edit_document_xlsx_rename_worksheet(input)
3094
+
3095
+ Rename a specific worksheet in a Excel XLSX spreadsheet
3096
+
3097
+ Edits the input Excel XLSX spreadsheet document to rename a specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet.
3098
+
3099
+ ### Example
3100
+ ```ruby
3101
+ # load the gem
3102
+ require 'cloudmersive-convert-api-client'
3103
+ # setup authorization
3104
+ CloudmersiveConvertApiClient.configure do |config|
3105
+ # Configure API key authorization: Apikey
3106
+ config.api_key['Apikey'] = 'YOUR API KEY'
3107
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3108
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3109
+ end
3110
+
3111
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
3112
+
3113
+ input = CloudmersiveConvertApiClient::RenameXlsxWorksheetRequest.new # RenameXlsxWorksheetRequest | Document input request
3114
+
3115
+
3116
+ begin
3117
+ #Rename a specific worksheet in a Excel XLSX spreadsheet
3118
+ result = api_instance.edit_document_xlsx_rename_worksheet(input)
3119
+ p result
3120
+ rescue CloudmersiveConvertApiClient::ApiError => e
3121
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_rename_worksheet: #{e}"
3122
+ end
3123
+ ```
3124
+
3125
+ ### Parameters
3126
+
3127
+ Name | Type | Description | Notes
3128
+ ------------- | ------------- | ------------- | -------------
3129
+ **input** | [**RenameXlsxWorksheetRequest**](RenameXlsxWorksheetRequest.md)| Document input request |
3130
+
3131
+ ### Return type
3132
+
3133
+ [**RenameXlsxWorksheetResponse**](RenameXlsxWorksheetResponse.md)
3134
+
3135
+ ### Authorization
3136
+
3137
+ [Apikey](../README.md#Apikey)
3138
+
3139
+ ### HTTP request headers
3140
+
3141
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
3142
+ - **Accept**: application/json, text/json, application/xml, text/xml
3143
+
3144
+
3145
+
3146
+ # **edit_document_xlsx_set_cell_by_identifier**
3147
+ > SetXlsxCellByIdentifierResponse edit_document_xlsx_set_cell_by_identifier(input)
3148
+
3149
+ Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier
3150
+
3151
+ Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet using its cell identifier (e.g. A1, B22, C33) in the worksheet
3152
+
3153
+ ### Example
3154
+ ```ruby
3155
+ # load the gem
3156
+ require 'cloudmersive-convert-api-client'
3157
+ # setup authorization
3158
+ CloudmersiveConvertApiClient.configure do |config|
3159
+ # Configure API key authorization: Apikey
3160
+ config.api_key['Apikey'] = 'YOUR API KEY'
3161
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3162
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3163
+ end
3164
+
3165
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
3166
+
3167
+ input = CloudmersiveConvertApiClient::SetXlsxCellByIdentifierRequest.new # SetXlsxCellByIdentifierRequest | Document input request
3168
+
3169
+
3170
+ begin
3171
+ #Set, update cell contents in an Excel XLSX spreadsheet, worksheet by cell identifier
3172
+ result = api_instance.edit_document_xlsx_set_cell_by_identifier(input)
3173
+ p result
3174
+ rescue CloudmersiveConvertApiClient::ApiError => e
3175
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_set_cell_by_identifier: #{e}"
3176
+ end
3177
+ ```
3178
+
3179
+ ### Parameters
3180
+
3181
+ Name | Type | Description | Notes
3182
+ ------------- | ------------- | ------------- | -------------
3183
+ **input** | [**SetXlsxCellByIdentifierRequest**](SetXlsxCellByIdentifierRequest.md)| Document input request |
3184
+
3185
+ ### Return type
3186
+
3187
+ [**SetXlsxCellByIdentifierResponse**](SetXlsxCellByIdentifierResponse.md)
3188
+
3189
+ ### Authorization
3190
+
3191
+ [Apikey](../README.md#Apikey)
3192
+
3193
+ ### HTTP request headers
3194
+
3195
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
3196
+ - **Accept**: application/json, text/json, application/xml, text/xml
3197
+
3198
+
3199
+
3200
+ # **edit_document_xlsx_set_cell_by_index**
3201
+ > SetXlsxCellResponse edit_document_xlsx_set_cell_by_index(input)
3202
+
3203
+ Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
3204
+
3205
+ Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet
3206
+
3207
+ ### Example
3208
+ ```ruby
3209
+ # load the gem
3210
+ require 'cloudmersive-convert-api-client'
3211
+ # setup authorization
3212
+ CloudmersiveConvertApiClient.configure do |config|
3213
+ # Configure API key authorization: Apikey
3214
+ config.api_key['Apikey'] = 'YOUR API KEY'
3215
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3216
+ #config.api_key_prefix['Apikey'] = 'Bearer'
3217
+ end
3218
+
3219
+ api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new
3220
+
3221
+ input = CloudmersiveConvertApiClient::SetXlsxCellRequest.new # SetXlsxCellRequest | Document input request
3222
+
3223
+
3224
+ begin
3225
+ #Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index
3226
+ result = api_instance.edit_document_xlsx_set_cell_by_index(input)
3227
+ p result
3228
+ rescue CloudmersiveConvertApiClient::ApiError => e
3229
+ puts "Exception when calling EditDocumentApi->edit_document_xlsx_set_cell_by_index: #{e}"
3230
+ end
3231
+ ```
3232
+
3233
+ ### Parameters
3234
+
3235
+ Name | Type | Description | Notes
3236
+ ------------- | ------------- | ------------- | -------------
3237
+ **input** | [**SetXlsxCellRequest**](SetXlsxCellRequest.md)| Document input request |
3238
+
3239
+ ### Return type
3240
+
3241
+ [**SetXlsxCellResponse**](SetXlsxCellResponse.md)
3242
+
3243
+ ### Authorization
3244
+
3245
+ [Apikey](../README.md#Apikey)
3246
+
3247
+ ### HTTP request headers
3248
+
3249
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
3250
+ - **Accept**: application/json, text/json, application/xml, text/xml
3251
+
3252
+
3253
+