cloudmersive-convert-api-client 2.0.5 → 2.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (783) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +7 -0
  3. data/README.md +596 -0
  4. data/Rakefile +8 -0
  5. data/cloudmersive-convert-api-client.gemspec +45 -0
  6. data/docs/AddPdfAnnotationRequest.md +9 -0
  7. data/docs/AlternateFileFormatCandidate.md +10 -0
  8. data/docs/AppendXlsxRowRequest.md +11 -0
  9. data/docs/AppendXlsxRowResponse.md +9 -0
  10. data/docs/AutodetectDocumentValidationResult.md +12 -0
  11. data/docs/AutodetectGetInfoResult.md +14 -0
  12. data/docs/AutodetectToJpgResult.md +9 -0
  13. data/docs/AutodetectToPngResult.md +9 -0
  14. data/docs/AutodetectToThumbnailsResult.md +9 -0
  15. data/docs/Base64DecodeRequest.md +8 -0
  16. data/docs/Base64DecodeResponse.md +9 -0
  17. data/docs/Base64DetectRequest.md +8 -0
  18. data/docs/Base64DetectResponse.md +9 -0
  19. data/docs/Base64EncodeRequest.md +8 -0
  20. data/docs/Base64EncodeResponse.md +9 -0
  21. data/docs/ChangeLineEndingResponse.md +9 -0
  22. data/docs/ClearXlsxCellRequest.md +12 -0
  23. data/docs/ClearXlsxCellResponse.md +9 -0
  24. data/docs/ClearXlsxRowRequest.md +11 -0
  25. data/docs/ClearXlsxRowResponse.md +9 -0
  26. data/docs/CompareDocumentApi.md +66 -0
  27. data/docs/ConvertDataApi.md +1016 -0
  28. data/docs/ConvertDocumentApi.md +4503 -0
  29. data/docs/ConvertImageApi.md +243 -0
  30. data/docs/ConvertTemplateApi.md +122 -0
  31. data/docs/ConvertWebApi.md +448 -0
  32. data/docs/ConvertedJpgPage.md +9 -0
  33. data/docs/ConvertedPngPage.md +9 -0
  34. data/docs/CreateBlankDocxRequest.md +8 -0
  35. data/docs/CreateBlankDocxResponse.md +9 -0
  36. data/docs/CreateBlankSpreadsheetRequest.md +8 -0
  37. data/docs/CreateBlankSpreadsheetResponse.md +9 -0
  38. data/docs/CreateSpreadsheetFromDataRequest.md +9 -0
  39. data/docs/CreateSpreadsheetFromDataResponse.md +9 -0
  40. data/docs/CreateZipArchiveRequest.md +9 -0
  41. data/docs/CsvCollection.md +10 -0
  42. data/docs/CsvFileResult.md +9 -0
  43. data/docs/DeleteDocxTableRowRangeRequest.md +12 -0
  44. data/docs/DeleteDocxTableRowRangeResponse.md +9 -0
  45. data/docs/DeleteDocxTableRowRequest.md +11 -0
  46. data/docs/DeleteDocxTableRowResponse.md +9 -0
  47. data/docs/DetectLineEndingsResponse.md +11 -0
  48. data/docs/DisableSharedWorkbookRequest.md +9 -0
  49. data/docs/DisableSharedWorkbookResponse.md +9 -0
  50. data/docs/DocumentValidationError.md +11 -0
  51. data/docs/DocumentValidationResult.md +12 -0
  52. data/docs/DocxBody.md +10 -0
  53. data/docs/DocxCellStyle.md +11 -0
  54. data/docs/DocxComment.md +16 -0
  55. data/docs/DocxFooter.md +10 -0
  56. data/docs/DocxHeader.md +10 -0
  57. data/docs/DocxImage.md +20 -0
  58. data/docs/DocxInsertCommentOnParagraphRequest.md +11 -0
  59. data/docs/DocxInsertImageRequest.md +16 -0
  60. data/docs/DocxInsertImageResponse.md +9 -0
  61. data/docs/DocxPage.md +9 -0
  62. data/docs/DocxParagraph.md +11 -0
  63. data/docs/DocxRemoveObjectRequest.md +10 -0
  64. data/docs/DocxRemoveObjectResponse.md +9 -0
  65. data/docs/DocxRun.md +15 -0
  66. data/docs/DocxSection.md +9 -0
  67. data/docs/DocxSetFooterAddPageNumberRequest.md +10 -0
  68. data/docs/DocxSetFooterRequest.md +10 -0
  69. data/docs/DocxSetFooterResponse.md +9 -0
  70. data/docs/DocxSetHeaderRequest.md +10 -0
  71. data/docs/DocxSetHeaderResponse.md +9 -0
  72. data/docs/DocxStyle.md +14 -0
  73. data/docs/DocxTable.md +46 -0
  74. data/docs/DocxTableCell.md +15 -0
  75. data/docs/DocxTableRow.md +10 -0
  76. data/docs/DocxTemplateApplicationRequest.md +8 -0
  77. data/docs/DocxTemplateOperation.md +10 -0
  78. data/docs/DocxText.md +10 -0
  79. data/docs/DocxToJpgResult.md +9 -0
  80. data/docs/DocxToPngResult.md +9 -0
  81. data/docs/DocxTopLevelComment.md +14 -0
  82. data/docs/EditDocumentApi.md +3253 -0
  83. data/docs/EditHtmlApi.md +329 -0
  84. data/docs/EditPdfApi.md +1310 -0
  85. data/docs/EditTextApi.md +726 -0
  86. data/docs/EmlAttachment.md +9 -0
  87. data/docs/EmlToHtmlResult.md +16 -0
  88. data/docs/EmlToJpgResult.md +9 -0
  89. data/docs/EmlToPngResult.md +9 -0
  90. data/docs/EnableSharedWorkbookRequest.md +9 -0
  91. data/docs/EnableSharedWorkbookResponse.md +9 -0
  92. data/docs/ExifValue.md +10 -0
  93. data/docs/FindDocxParagraphRequest.md +11 -0
  94. data/docs/FindDocxParagraphResponse.md +10 -0
  95. data/docs/FindRegexMatch.md +12 -0
  96. data/docs/FindStringMatch.md +10 -0
  97. data/docs/FindStringRegexRequest.md +10 -0
  98. data/docs/FindStringRegexResponse.md +10 -0
  99. data/docs/FindStringSimpleRequest.md +9 -0
  100. data/docs/FindStringSimpleResponse.md +10 -0
  101. data/docs/FinishEditingRequest.md +8 -0
  102. data/docs/GetDocxBodyRequest.md +9 -0
  103. data/docs/GetDocxBodyResponse.md +9 -0
  104. data/docs/GetDocxCommentsHierarchicalResponse.md +10 -0
  105. data/docs/GetDocxCommentsResponse.md +10 -0
  106. data/docs/GetDocxGetCommentsHierarchicalRequest.md +9 -0
  107. data/docs/GetDocxGetCommentsRequest.md +9 -0
  108. data/docs/GetDocxHeadersAndFootersRequest.md +9 -0
  109. data/docs/GetDocxHeadersAndFootersResponse.md +10 -0
  110. data/docs/GetDocxImagesRequest.md +9 -0
  111. data/docs/GetDocxImagesResponse.md +9 -0
  112. data/docs/GetDocxPagesRequest.md +10 -0
  113. data/docs/GetDocxPagesResponse.md +10 -0
  114. data/docs/GetDocxSectionsRequest.md +9 -0
  115. data/docs/GetDocxSectionsResponse.md +9 -0
  116. data/docs/GetDocxStylesRequest.md +9 -0
  117. data/docs/GetDocxStylesResponse.md +9 -0
  118. data/docs/GetDocxTableByIndexRequest.md +10 -0
  119. data/docs/GetDocxTableByIndexResponse.md +9 -0
  120. data/docs/GetDocxTableRowRequest.md +11 -0
  121. data/docs/GetDocxTableRowResponse.md +9 -0
  122. data/docs/GetDocxTablesRequest.md +9 -0
  123. data/docs/GetDocxTablesResponse.md +9 -0
  124. data/docs/GetFileTypeIconResult.md +10 -0
  125. data/docs/GetImageInfoResult.md +24 -0
  126. data/docs/GetPdfAnnotationsResult.md +9 -0
  127. data/docs/GetXlsxCellByIdentifierRequest.md +11 -0
  128. data/docs/GetXlsxCellByIdentifierResponse.md +9 -0
  129. data/docs/GetXlsxCellRequest.md +12 -0
  130. data/docs/GetXlsxCellResponse.md +9 -0
  131. data/docs/GetXlsxColumnsRequest.md +10 -0
  132. data/docs/GetXlsxColumnsResponse.md +9 -0
  133. data/docs/GetXlsxImagesRequest.md +10 -0
  134. data/docs/GetXlsxImagesResponse.md +9 -0
  135. data/docs/GetXlsxRowsAndCellsRequest.md +10 -0
  136. data/docs/GetXlsxRowsAndCellsResponse.md +9 -0
  137. data/docs/GetXlsxSpecificRowRequest.md +11 -0
  138. data/docs/GetXlsxSpecificRowResponse.md +9 -0
  139. data/docs/GetXlsxStylesRequest.md +9 -0
  140. data/docs/GetXlsxStylesResponse.md +9 -0
  141. data/docs/GetXlsxWorksheetsRequest.md +9 -0
  142. data/docs/GetXlsxWorksheetsResponse.md +9 -0
  143. data/docs/HtmlMdResult.md +9 -0
  144. data/docs/HtmlTemplateApplicationRequest.md +10 -0
  145. data/docs/HtmlTemplateApplicationResponse.md +9 -0
  146. data/docs/HtmlTemplateOperation.md +10 -0
  147. data/docs/HtmlToOfficeRequest.md +8 -0
  148. data/docs/HtmlToPdfRequest.md +11 -0
  149. data/docs/HtmlToPngRequest.md +11 -0
  150. data/docs/HtmlToTextRequest.md +8 -0
  151. data/docs/HtmlToTextResponse.md +9 -0
  152. data/docs/InsertDocxCommentOnParagraphResponse.md +9 -0
  153. data/docs/InsertDocxInsertParagraphRequest.md +12 -0
  154. data/docs/InsertDocxInsertParagraphResponse.md +9 -0
  155. data/docs/InsertDocxTableRowRequest.md +12 -0
  156. data/docs/InsertDocxTableRowResponse.md +9 -0
  157. data/docs/InsertDocxTablesRequest.md +12 -0
  158. data/docs/InsertDocxTablesResponse.md +9 -0
  159. data/docs/InsertXlsxWorksheetRequest.md +10 -0
  160. data/docs/InsertXlsxWorksheetResponse.md +9 -0
  161. data/docs/KeynoteToJpgResult.md +9 -0
  162. data/docs/KeynoteToPngResult.md +9 -0
  163. data/docs/MergeDocumentApi.md +812 -0
  164. data/docs/MsgAttachment.md +9 -0
  165. data/docs/MsgToHtmlResult.md +16 -0
  166. data/docs/MsgToJpgResult.md +9 -0
  167. data/docs/MsgToPngResult.md +9 -0
  168. data/docs/MultiReplaceStringRequest.md +10 -0
  169. data/docs/MultipageImageFormatConversionResult.md +10 -0
  170. data/docs/OdpToJpgResult.md +9 -0
  171. data/docs/OdpToPngResult.md +9 -0
  172. data/docs/OdsToJpgResult.md +9 -0
  173. data/docs/OdsToPngResult.md +9 -0
  174. data/docs/OdtToJpgResult.md +9 -0
  175. data/docs/OdtToPngResult.md +9 -0
  176. data/docs/PageConversionResult.md +9 -0
  177. data/docs/PdfAnnotation.md +19 -0
  178. data/docs/PdfDocument.md +10 -0
  179. data/docs/PdfFormField.md +11 -0
  180. data/docs/PdfFormFields.md +9 -0
  181. data/docs/PdfMetadata.md +16 -0
  182. data/docs/PdfPageText.md +9 -0
  183. data/docs/PdfTextByPageResult.md +9 -0
  184. data/docs/PdfToJpgResult.md +9 -0
  185. data/docs/PdfToPngResult.md +9 -0
  186. data/docs/PptxToPngResult.md +9 -0
  187. data/docs/PresentationResult.md +10 -0
  188. data/docs/RemoveDocxHeadersAndFootersRequest.md +11 -0
  189. data/docs/RemoveDocxHeadersAndFootersResponse.md +9 -0
  190. data/docs/RemoveDocxPagesRequest.md +11 -0
  191. data/docs/RemoveHtmlFromTextRequest.md +8 -0
  192. data/docs/RemoveHtmlFromTextResponse.md +9 -0
  193. data/docs/RemovePptxSlidesRequest.md +11 -0
  194. data/docs/RemoveWhitespaceFromTextRequest.md +8 -0
  195. data/docs/RemoveWhitespaceFromTextResponse.md +9 -0
  196. data/docs/RemoveXlsxWorksheetRequest.md +10 -0
  197. data/docs/RenameXlsxWorksheetRequest.md +11 -0
  198. data/docs/RenameXlsxWorksheetResponse.md +9 -0
  199. data/docs/ReplaceDocxParagraphRequest.md +12 -0
  200. data/docs/ReplaceDocxParagraphResponse.md +9 -0
  201. data/docs/ReplaceStringRegexRequest.md +10 -0
  202. data/docs/ReplaceStringRegexResponse.md +9 -0
  203. data/docs/ReplaceStringRequest.md +12 -0
  204. data/docs/ReplaceStringSimpleRequest.md +10 -0
  205. data/docs/ReplaceStringSimpleResponse.md +9 -0
  206. data/docs/RtfToJpgResult.md +9 -0
  207. data/docs/RtfToPngResult.md +9 -0
  208. data/docs/ScreenshotRequest.md +11 -0
  209. data/docs/SetFormFieldValue.md +11 -0
  210. data/docs/SetPdfFormFieldsRequest.md +9 -0
  211. data/docs/SetPdfMetadataRequest.md +9 -0
  212. data/docs/SetXlsxCellByIdentifierRequest.md +12 -0
  213. data/docs/SetXlsxCellByIdentifierResponse.md +9 -0
  214. data/docs/SetXlsxCellRequest.md +13 -0
  215. data/docs/SetXlsxCellResponse.md +9 -0
  216. data/docs/SingleReplaceString.md +10 -0
  217. data/docs/SplitDocumentApi.md +361 -0
  218. data/docs/SplitDocumentResult.md +10 -0
  219. data/docs/SplitDocxDocumentResult.md +9 -0
  220. data/docs/SplitPdfResult.md +9 -0
  221. data/docs/SplitPptxPresentationResult.md +9 -0
  222. data/docs/SplitTextDocumentByLinesResult.md +10 -0
  223. data/docs/SplitTextDocumentByStringResult.md +10 -0
  224. data/docs/SplitXlsxWorksheetResult.md +9 -0
  225. data/docs/TextConversionResult.md +9 -0
  226. data/docs/TextDocumentElement.md +9 -0
  227. data/docs/TextDocumentLine.md +9 -0
  228. data/docs/TextEncodingDetectResponse.md +9 -0
  229. data/docs/Thumbnail.md +9 -0
  230. data/docs/TransformDocumentApi.md +140 -0
  231. data/docs/UpdateDocxTableCellRequest.md +13 -0
  232. data/docs/UpdateDocxTableCellResponse.md +9 -0
  233. data/docs/UpdateDocxTableRowRequest.md +12 -0
  234. data/docs/UpdateDocxTableRowResponse.md +9 -0
  235. data/docs/UrlToPdfRequest.md +11 -0
  236. data/docs/UrlToTextRequest.md +8 -0
  237. data/docs/UrlToTextResponse.md +9 -0
  238. data/docs/ValidateDocumentApi.md +943 -0
  239. data/docs/ViewerResponse.md +9 -0
  240. data/docs/ViewerToolsApi.md +63 -0
  241. data/docs/WorksheetResult.md +11 -0
  242. data/docs/XlsxImage.md +12 -0
  243. data/docs/XlsxSpreadsheetCell.md +12 -0
  244. data/docs/XlsxSpreadsheetColumn.md +9 -0
  245. data/docs/XlsxSpreadsheetRow.md +9 -0
  246. data/docs/XlsxToPngResult.md +9 -0
  247. data/docs/XlsxWorksheet.md +9 -0
  248. data/docs/XmlAddAttributeWithXPathResult.md +10 -0
  249. data/docs/XmlAddChildWithXPathResult.md +10 -0
  250. data/docs/XmlFilterWithXPathResult.md +10 -0
  251. data/docs/XmlQueryWithXQueryMultiResult.md +10 -0
  252. data/docs/XmlQueryWithXQueryResult.md +10 -0
  253. data/docs/XmlRemoveAllChildrenWithXPathResult.md +10 -0
  254. data/docs/XmlRemoveWithXPathResult.md +11 -0
  255. data/docs/XmlReplaceWithXPathResult.md +10 -0
  256. data/docs/XmlSetValueWithXPathResult.md +10 -0
  257. data/docs/ZipArchiveApi.md +386 -0
  258. data/docs/ZipDirectory.md +10 -0
  259. data/docs/ZipEncryptionAdvancedRequest.md +10 -0
  260. data/docs/ZipExtractResponse.md +10 -0
  261. data/docs/ZipFile.md +9 -0
  262. data/git_push.sh +55 -0
  263. data/lib/cloudmersive-convert-api-client.rb +295 -0
  264. data/lib/cloudmersive-convert-api-client/api/compare_document_api.rb +85 -0
  265. data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +1079 -0
  266. data/lib/cloudmersive-convert-api-client/api/convert_document_api.rb +4516 -0
  267. data/lib/cloudmersive-convert-api-client/api/convert_image_api.rb +273 -0
  268. data/lib/cloudmersive-convert-api-client/api/convert_template_api.rb +135 -0
  269. data/lib/cloudmersive-convert-api-client/api/convert_web_api.rb +456 -0
  270. data/lib/cloudmersive-convert-api-client/api/edit_document_api.rb +3214 -0
  271. data/lib/cloudmersive-convert-api-client/api/edit_html_api.rb +339 -0
  272. data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +1393 -0
  273. data/lib/cloudmersive-convert-api-client/api/edit_text_api.rb +735 -0
  274. data/lib/cloudmersive-convert-api-client/api/merge_document_api.rb +911 -0
  275. data/lib/cloudmersive-convert-api-client/api/split_document_api.rb +375 -0
  276. data/lib/cloudmersive-convert-api-client/api/transform_document_api.rb +161 -0
  277. data/lib/cloudmersive-convert-api-client/api/validate_document_api.rb +958 -0
  278. data/lib/cloudmersive-convert-api-client/api/viewer_tools_api.rb +78 -0
  279. data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +422 -0
  280. data/lib/cloudmersive-convert-api-client/api_client.rb +391 -0
  281. data/lib/cloudmersive-convert-api-client/api_error.rb +38 -0
  282. data/lib/cloudmersive-convert-api-client/configuration.rb +209 -0
  283. data/lib/cloudmersive-convert-api-client/models/add_pdf_annotation_request.rb +213 -0
  284. data/lib/cloudmersive-convert-api-client/models/alternate_file_format_candidate.rb +206 -0
  285. data/lib/cloudmersive-convert-api-client/models/append_xlsx_row_request.rb +231 -0
  286. data/lib/cloudmersive-convert-api-client/models/append_xlsx_row_response.rb +196 -0
  287. data/lib/cloudmersive-convert-api-client/models/autodetect_document_validation_result.rb +227 -0
  288. data/lib/cloudmersive-convert-api-client/models/autodetect_get_info_result.rb +248 -0
  289. data/lib/cloudmersive-convert-api-client/models/autodetect_to_jpg_result.rb +198 -0
  290. data/lib/cloudmersive-convert-api-client/models/autodetect_to_png_result.rb +198 -0
  291. data/lib/cloudmersive-convert-api-client/models/autodetect_to_thumbnails_result.rb +198 -0
  292. data/lib/cloudmersive-convert-api-client/models/base64_decode_request.rb +186 -0
  293. data/lib/cloudmersive-convert-api-client/models/base64_decode_response.rb +211 -0
  294. data/lib/cloudmersive-convert-api-client/models/base64_detect_request.rb +186 -0
  295. data/lib/cloudmersive-convert-api-client/models/base64_detect_response.rb +196 -0
  296. data/lib/cloudmersive-convert-api-client/models/base64_encode_request.rb +201 -0
  297. data/lib/cloudmersive-convert-api-client/models/base64_encode_response.rb +196 -0
  298. data/lib/cloudmersive-convert-api-client/models/change_line_ending_response.rb +196 -0
  299. data/lib/cloudmersive-convert-api-client/models/clear_xlsx_cell_request.rb +241 -0
  300. data/lib/cloudmersive-convert-api-client/models/clear_xlsx_cell_response.rb +196 -0
  301. data/lib/cloudmersive-convert-api-client/models/clear_xlsx_row_request.rb +231 -0
  302. data/lib/cloudmersive-convert-api-client/models/clear_xlsx_row_response.rb +196 -0
  303. data/lib/cloudmersive-convert-api-client/models/converted_jpg_page.rb +211 -0
  304. data/lib/cloudmersive-convert-api-client/models/converted_png_page.rb +196 -0
  305. data/lib/cloudmersive-convert-api-client/models/create_blank_docx_request.rb +186 -0
  306. data/lib/cloudmersive-convert-api-client/models/create_blank_docx_response.rb +196 -0
  307. data/lib/cloudmersive-convert-api-client/models/create_blank_spreadsheet_request.rb +186 -0
  308. data/lib/cloudmersive-convert-api-client/models/create_blank_spreadsheet_response.rb +196 -0
  309. data/lib/cloudmersive-convert-api-client/models/create_spreadsheet_from_data_request.rb +198 -0
  310. data/lib/cloudmersive-convert-api-client/models/create_spreadsheet_from_data_response.rb +196 -0
  311. data/lib/cloudmersive-convert-api-client/models/create_zip_archive_request.rb +200 -0
  312. data/lib/cloudmersive-convert-api-client/models/csv_collection.rb +208 -0
  313. data/lib/cloudmersive-convert-api-client/models/csv_file_result.rb +211 -0
  314. data/lib/cloudmersive-convert-api-client/models/delete_docx_table_row_range_request.rb +241 -0
  315. data/lib/cloudmersive-convert-api-client/models/delete_docx_table_row_range_response.rb +196 -0
  316. data/lib/cloudmersive-convert-api-client/models/delete_docx_table_row_request.rb +231 -0
  317. data/lib/cloudmersive-convert-api-client/models/delete_docx_table_row_response.rb +196 -0
  318. data/lib/cloudmersive-convert-api-client/models/detect_line_endings_response.rb +216 -0
  319. data/lib/cloudmersive-convert-api-client/models/disable_shared_workbook_request.rb +211 -0
  320. data/lib/cloudmersive-convert-api-client/models/disable_shared_workbook_response.rb +196 -0
  321. data/lib/cloudmersive-convert-api-client/models/document_validation_error.rb +216 -0
  322. data/lib/cloudmersive-convert-api-client/models/document_validation_result.rb +228 -0
  323. data/lib/cloudmersive-convert-api-client/models/docx_body.rb +209 -0
  324. data/lib/cloudmersive-convert-api-client/models/docx_cell_style.rb +216 -0
  325. data/lib/cloudmersive-convert-api-client/models/docx_comment.rb +266 -0
  326. data/lib/cloudmersive-convert-api-client/models/docx_footer.rb +210 -0
  327. data/lib/cloudmersive-convert-api-client/models/docx_header.rb +210 -0
  328. data/lib/cloudmersive-convert-api-client/models/docx_image.rb +305 -0
  329. data/lib/cloudmersive-convert-api-client/models/docx_insert_comment_on_paragraph_request.rb +231 -0
  330. data/lib/cloudmersive-convert-api-client/models/docx_insert_image_request.rb +296 -0
  331. data/lib/cloudmersive-convert-api-client/models/docx_insert_image_response.rb +196 -0
  332. data/lib/cloudmersive-convert-api-client/models/docx_page.rb +198 -0
  333. data/lib/cloudmersive-convert-api-client/models/docx_paragraph.rb +218 -0
  334. data/lib/cloudmersive-convert-api-client/models/docx_remove_object_request.rb +221 -0
  335. data/lib/cloudmersive-convert-api-client/models/docx_remove_object_response.rb +196 -0
  336. data/lib/cloudmersive-convert-api-client/models/docx_run.rb +258 -0
  337. data/lib/cloudmersive-convert-api-client/models/docx_section.rb +198 -0
  338. data/lib/cloudmersive-convert-api-client/models/docx_set_footer_add_page_number_request.rb +221 -0
  339. data/lib/cloudmersive-convert-api-client/models/docx_set_footer_request.rb +221 -0
  340. data/lib/cloudmersive-convert-api-client/models/docx_set_footer_response.rb +196 -0
  341. data/lib/cloudmersive-convert-api-client/models/docx_set_header_request.rb +221 -0
  342. data/lib/cloudmersive-convert-api-client/models/docx_set_header_response.rb +196 -0
  343. data/lib/cloudmersive-convert-api-client/models/docx_style.rb +246 -0
  344. data/lib/cloudmersive-convert-api-client/models/docx_table.rb +568 -0
  345. data/lib/cloudmersive-convert-api-client/models/docx_table_cell.rb +258 -0
  346. data/lib/cloudmersive-convert-api-client/models/docx_table_row.rb +208 -0
  347. data/lib/cloudmersive-convert-api-client/models/docx_template_application_request.rb +188 -0
  348. data/lib/cloudmersive-convert-api-client/models/docx_template_operation.rb +239 -0
  349. data/lib/cloudmersive-convert-api-client/models/docx_text.rb +206 -0
  350. data/lib/cloudmersive-convert-api-client/models/docx_to_jpg_result.rb +198 -0
  351. data/lib/cloudmersive-convert-api-client/models/docx_to_png_result.rb +198 -0
  352. data/lib/cloudmersive-convert-api-client/models/docx_top_level_comment.rb +248 -0
  353. data/lib/cloudmersive-convert-api-client/models/eml_attachment.rb +211 -0
  354. data/lib/cloudmersive-convert-api-client/models/eml_to_html_result.rb +268 -0
  355. data/lib/cloudmersive-convert-api-client/models/eml_to_jpg_result.rb +198 -0
  356. data/lib/cloudmersive-convert-api-client/models/eml_to_png_result.rb +198 -0
  357. data/lib/cloudmersive-convert-api-client/models/enable_shared_workbook_request.rb +211 -0
  358. data/lib/cloudmersive-convert-api-client/models/enable_shared_workbook_response.rb +196 -0
  359. data/lib/cloudmersive-convert-api-client/models/exif_value.rb +206 -0
  360. data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_request.rb +231 -0
  361. data/lib/cloudmersive-convert-api-client/models/find_docx_paragraph_response.rb +208 -0
  362. data/lib/cloudmersive-convert-api-client/models/find_regex_match.rb +228 -0
  363. data/lib/cloudmersive-convert-api-client/models/find_string_match.rb +206 -0
  364. data/lib/cloudmersive-convert-api-client/models/find_string_regex_request.rb +206 -0
  365. data/lib/cloudmersive-convert-api-client/models/find_string_regex_response.rb +208 -0
  366. data/lib/cloudmersive-convert-api-client/models/find_string_simple_request.rb +196 -0
  367. data/lib/cloudmersive-convert-api-client/models/find_string_simple_response.rb +208 -0
  368. data/lib/cloudmersive-convert-api-client/models/finish_editing_request.rb +186 -0
  369. data/lib/cloudmersive-convert-api-client/models/get_docx_body_request.rb +211 -0
  370. data/lib/cloudmersive-convert-api-client/models/get_docx_body_response.rb +196 -0
  371. data/lib/cloudmersive-convert-api-client/models/get_docx_comments_hierarchical_response.rb +208 -0
  372. data/lib/cloudmersive-convert-api-client/models/get_docx_comments_response.rb +208 -0
  373. data/lib/cloudmersive-convert-api-client/models/get_docx_get_comments_hierarchical_request.rb +211 -0
  374. data/lib/cloudmersive-convert-api-client/models/get_docx_get_comments_request.rb +211 -0
  375. data/lib/cloudmersive-convert-api-client/models/get_docx_headers_and_footers_request.rb +211 -0
  376. data/lib/cloudmersive-convert-api-client/models/get_docx_headers_and_footers_response.rb +208 -0
  377. data/lib/cloudmersive-convert-api-client/models/get_docx_images_request.rb +211 -0
  378. data/lib/cloudmersive-convert-api-client/models/get_docx_images_response.rb +198 -0
  379. data/lib/cloudmersive-convert-api-client/models/get_docx_pages_request.rb +221 -0
  380. data/lib/cloudmersive-convert-api-client/models/get_docx_pages_response.rb +208 -0
  381. data/lib/cloudmersive-convert-api-client/models/get_docx_sections_request.rb +211 -0
  382. data/lib/cloudmersive-convert-api-client/models/get_docx_sections_response.rb +198 -0
  383. data/lib/cloudmersive-convert-api-client/models/get_docx_styles_request.rb +211 -0
  384. data/lib/cloudmersive-convert-api-client/models/get_docx_styles_response.rb +198 -0
  385. data/lib/cloudmersive-convert-api-client/models/get_docx_table_by_index_request.rb +221 -0
  386. data/lib/cloudmersive-convert-api-client/models/get_docx_table_by_index_response.rb +196 -0
  387. data/lib/cloudmersive-convert-api-client/models/get_docx_table_row_request.rb +231 -0
  388. data/lib/cloudmersive-convert-api-client/models/get_docx_table_row_response.rb +196 -0
  389. data/lib/cloudmersive-convert-api-client/models/get_docx_tables_request.rb +211 -0
  390. data/lib/cloudmersive-convert-api-client/models/get_docx_tables_response.rb +198 -0
  391. data/lib/cloudmersive-convert-api-client/models/get_file_type_icon_result.rb +221 -0
  392. data/lib/cloudmersive-convert-api-client/models/get_image_info_result.rb +347 -0
  393. data/lib/cloudmersive-convert-api-client/models/get_pdf_annotations_result.rb +198 -0
  394. data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_request.rb +231 -0
  395. data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_by_identifier_response.rb +196 -0
  396. data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_request.rb +241 -0
  397. data/lib/cloudmersive-convert-api-client/models/get_xlsx_cell_response.rb +196 -0
  398. data/lib/cloudmersive-convert-api-client/models/get_xlsx_columns_request.rb +221 -0
  399. data/lib/cloudmersive-convert-api-client/models/get_xlsx_columns_response.rb +198 -0
  400. data/lib/cloudmersive-convert-api-client/models/get_xlsx_images_request.rb +221 -0
  401. data/lib/cloudmersive-convert-api-client/models/get_xlsx_images_response.rb +198 -0
  402. data/lib/cloudmersive-convert-api-client/models/get_xlsx_rows_and_cells_request.rb +221 -0
  403. data/lib/cloudmersive-convert-api-client/models/get_xlsx_rows_and_cells_response.rb +198 -0
  404. data/lib/cloudmersive-convert-api-client/models/get_xlsx_specific_row_request.rb +231 -0
  405. data/lib/cloudmersive-convert-api-client/models/get_xlsx_specific_row_response.rb +196 -0
  406. data/lib/cloudmersive-convert-api-client/models/get_xlsx_styles_request.rb +211 -0
  407. data/lib/cloudmersive-convert-api-client/models/get_xlsx_styles_response.rb +198 -0
  408. data/lib/cloudmersive-convert-api-client/models/get_xlsx_worksheets_request.rb +211 -0
  409. data/lib/cloudmersive-convert-api-client/models/get_xlsx_worksheets_response.rb +198 -0
  410. data/lib/cloudmersive-convert-api-client/models/html_md_result.rb +196 -0
  411. data/lib/cloudmersive-convert-api-client/models/html_template_application_request.rb +208 -0
  412. data/lib/cloudmersive-convert-api-client/models/html_template_application_response.rb +196 -0
  413. data/lib/cloudmersive-convert-api-client/models/html_template_operation.rb +239 -0
  414. data/lib/cloudmersive-convert-api-client/models/html_to_office_request.rb +186 -0
  415. data/lib/cloudmersive-convert-api-client/models/html_to_pdf_request.rb +216 -0
  416. data/lib/cloudmersive-convert-api-client/models/html_to_png_request.rb +216 -0
  417. data/lib/cloudmersive-convert-api-client/models/html_to_text_request.rb +186 -0
  418. data/lib/cloudmersive-convert-api-client/models/html_to_text_response.rb +196 -0
  419. data/lib/cloudmersive-convert-api-client/models/insert_docx_comment_on_paragraph_response.rb +196 -0
  420. data/lib/cloudmersive-convert-api-client/models/insert_docx_insert_paragraph_request.rb +241 -0
  421. data/lib/cloudmersive-convert-api-client/models/insert_docx_insert_paragraph_response.rb +196 -0
  422. data/lib/cloudmersive-convert-api-client/models/insert_docx_table_row_request.rb +241 -0
  423. data/lib/cloudmersive-convert-api-client/models/insert_docx_table_row_response.rb +196 -0
  424. data/lib/cloudmersive-convert-api-client/models/insert_docx_tables_request.rb +241 -0
  425. data/lib/cloudmersive-convert-api-client/models/insert_docx_tables_response.rb +196 -0
  426. data/lib/cloudmersive-convert-api-client/models/insert_xlsx_worksheet_request.rb +221 -0
  427. data/lib/cloudmersive-convert-api-client/models/insert_xlsx_worksheet_response.rb +196 -0
  428. data/lib/cloudmersive-convert-api-client/models/keynote_to_jpg_result.rb +198 -0
  429. data/lib/cloudmersive-convert-api-client/models/keynote_to_png_result.rb +198 -0
  430. data/lib/cloudmersive-convert-api-client/models/msg_attachment.rb +211 -0
  431. data/lib/cloudmersive-convert-api-client/models/msg_to_html_result.rb +268 -0
  432. data/lib/cloudmersive-convert-api-client/models/msg_to_jpg_result.rb +198 -0
  433. data/lib/cloudmersive-convert-api-client/models/msg_to_png_result.rb +198 -0
  434. data/lib/cloudmersive-convert-api-client/models/multi_replace_string_request.rb +223 -0
  435. data/lib/cloudmersive-convert-api-client/models/multipage_image_format_conversion_result.rb +208 -0
  436. data/lib/cloudmersive-convert-api-client/models/odp_to_jpg_result.rb +198 -0
  437. data/lib/cloudmersive-convert-api-client/models/odp_to_png_result.rb +198 -0
  438. data/lib/cloudmersive-convert-api-client/models/ods_to_jpg_result.rb +198 -0
  439. data/lib/cloudmersive-convert-api-client/models/ods_to_png_result.rb +198 -0
  440. data/lib/cloudmersive-convert-api-client/models/odt_to_jpg_result.rb +198 -0
  441. data/lib/cloudmersive-convert-api-client/models/odt_to_png_result.rb +198 -0
  442. data/lib/cloudmersive-convert-api-client/models/page_conversion_result.rb +211 -0
  443. data/lib/cloudmersive-convert-api-client/models/pdf_annotation.rb +296 -0
  444. data/lib/cloudmersive-convert-api-client/models/pdf_document.rb +221 -0
  445. data/lib/cloudmersive-convert-api-client/models/pdf_form_field.rb +216 -0
  446. data/lib/cloudmersive-convert-api-client/models/pdf_form_fields.rb +198 -0
  447. data/lib/cloudmersive-convert-api-client/models/pdf_metadata.rb +266 -0
  448. data/lib/cloudmersive-convert-api-client/models/pdf_page_text.rb +196 -0
  449. data/lib/cloudmersive-convert-api-client/models/pdf_text_by_page_result.rb +198 -0
  450. data/lib/cloudmersive-convert-api-client/models/pdf_to_jpg_result.rb +198 -0
  451. data/lib/cloudmersive-convert-api-client/models/pdf_to_png_result.rb +198 -0
  452. data/lib/cloudmersive-convert-api-client/models/pptx_to_png_result.rb +198 -0
  453. data/lib/cloudmersive-convert-api-client/models/presentation_result.rb +221 -0
  454. data/lib/cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_request.rb +231 -0
  455. data/lib/cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_response.rb +196 -0
  456. data/lib/cloudmersive-convert-api-client/models/remove_docx_pages_request.rb +231 -0
  457. data/lib/cloudmersive-convert-api-client/models/remove_html_from_text_request.rb +186 -0
  458. data/lib/cloudmersive-convert-api-client/models/remove_html_from_text_response.rb +196 -0
  459. data/lib/cloudmersive-convert-api-client/models/remove_pptx_slides_request.rb +231 -0
  460. data/lib/cloudmersive-convert-api-client/models/remove_whitespace_from_text_request.rb +186 -0
  461. data/lib/cloudmersive-convert-api-client/models/remove_whitespace_from_text_response.rb +196 -0
  462. data/lib/cloudmersive-convert-api-client/models/remove_xlsx_worksheet_request.rb +221 -0
  463. data/lib/cloudmersive-convert-api-client/models/rename_xlsx_worksheet_request.rb +231 -0
  464. data/lib/cloudmersive-convert-api-client/models/rename_xlsx_worksheet_response.rb +196 -0
  465. data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_request.rb +241 -0
  466. data/lib/cloudmersive-convert-api-client/models/replace_docx_paragraph_response.rb +196 -0
  467. data/lib/cloudmersive-convert-api-client/models/replace_string_regex_request.rb +206 -0
  468. data/lib/cloudmersive-convert-api-client/models/replace_string_regex_response.rb +196 -0
  469. data/lib/cloudmersive-convert-api-client/models/replace_string_request.rb +241 -0
  470. data/lib/cloudmersive-convert-api-client/models/replace_string_simple_request.rb +206 -0
  471. data/lib/cloudmersive-convert-api-client/models/replace_string_simple_response.rb +196 -0
  472. data/lib/cloudmersive-convert-api-client/models/rtf_to_jpg_result.rb +198 -0
  473. data/lib/cloudmersive-convert-api-client/models/rtf_to_png_result.rb +198 -0
  474. data/lib/cloudmersive-convert-api-client/models/screenshot_request.rb +216 -0
  475. data/lib/cloudmersive-convert-api-client/models/set_form_field_value.rb +216 -0
  476. data/lib/cloudmersive-convert-api-client/models/set_pdf_form_fields_request.rb +213 -0
  477. data/lib/cloudmersive-convert-api-client/models/set_pdf_metadata_request.rb +211 -0
  478. data/lib/cloudmersive-convert-api-client/models/set_xlsx_cell_by_identifier_request.rb +241 -0
  479. data/lib/cloudmersive-convert-api-client/models/set_xlsx_cell_by_identifier_response.rb +196 -0
  480. data/lib/cloudmersive-convert-api-client/models/set_xlsx_cell_request.rb +251 -0
  481. data/lib/cloudmersive-convert-api-client/models/set_xlsx_cell_response.rb +196 -0
  482. data/lib/cloudmersive-convert-api-client/models/single_replace_string.rb +206 -0
  483. data/lib/cloudmersive-convert-api-client/models/split_document_result.rb +221 -0
  484. data/lib/cloudmersive-convert-api-client/models/split_docx_document_result.rb +197 -0
  485. data/lib/cloudmersive-convert-api-client/models/split_pdf_result.rb +198 -0
  486. data/lib/cloudmersive-convert-api-client/models/split_pptx_presentation_result.rb +197 -0
  487. data/lib/cloudmersive-convert-api-client/models/split_text_document_by_lines_result.rb +207 -0
  488. data/lib/cloudmersive-convert-api-client/models/split_text_document_by_string_result.rb +207 -0
  489. data/lib/cloudmersive-convert-api-client/models/split_xlsx_worksheet_result.rb +197 -0
  490. data/lib/cloudmersive-convert-api-client/models/text_conversion_result.rb +196 -0
  491. data/lib/cloudmersive-convert-api-client/models/text_document_element.rb +196 -0
  492. data/lib/cloudmersive-convert-api-client/models/text_document_line.rb +196 -0
  493. data/lib/cloudmersive-convert-api-client/models/text_encoding_detect_response.rb +196 -0
  494. data/lib/cloudmersive-convert-api-client/models/thumbnail.rb +211 -0
  495. data/lib/cloudmersive-convert-api-client/models/update_docx_table_cell_request.rb +251 -0
  496. data/lib/cloudmersive-convert-api-client/models/update_docx_table_cell_response.rb +196 -0
  497. data/lib/cloudmersive-convert-api-client/models/update_docx_table_row_request.rb +241 -0
  498. data/lib/cloudmersive-convert-api-client/models/update_docx_table_row_response.rb +196 -0
  499. data/lib/cloudmersive-convert-api-client/models/url_to_pdf_request.rb +216 -0
  500. data/lib/cloudmersive-convert-api-client/models/url_to_text_request.rb +186 -0
  501. data/lib/cloudmersive-convert-api-client/models/url_to_text_response.rb +196 -0
  502. data/lib/cloudmersive-convert-api-client/models/viewer_response.rb +194 -0
  503. data/lib/cloudmersive-convert-api-client/models/worksheet_result.rb +231 -0
  504. data/lib/cloudmersive-convert-api-client/models/xlsx_image.rb +225 -0
  505. data/lib/cloudmersive-convert-api-client/models/xlsx_spreadsheet_cell.rb +225 -0
  506. data/lib/cloudmersive-convert-api-client/models/xlsx_spreadsheet_column.rb +196 -0
  507. data/lib/cloudmersive-convert-api-client/models/xlsx_spreadsheet_row.rb +198 -0
  508. data/lib/cloudmersive-convert-api-client/models/xlsx_to_png_result.rb +198 -0
  509. data/lib/cloudmersive-convert-api-client/models/xlsx_worksheet.rb +196 -0
  510. data/lib/cloudmersive-convert-api-client/models/xml_add_attribute_with_x_path_result.rb +206 -0
  511. data/lib/cloudmersive-convert-api-client/models/xml_add_child_with_x_path_result.rb +206 -0
  512. data/lib/cloudmersive-convert-api-client/models/xml_filter_with_x_path_result.rb +208 -0
  513. data/lib/cloudmersive-convert-api-client/models/xml_query_with_x_query_multi_result.rb +206 -0
  514. data/lib/cloudmersive-convert-api-client/models/xml_query_with_x_query_result.rb +206 -0
  515. data/lib/cloudmersive-convert-api-client/models/xml_remove_all_children_with_x_path_result.rb +206 -0
  516. data/lib/cloudmersive-convert-api-client/models/xml_remove_with_x_path_result.rb +218 -0
  517. data/lib/cloudmersive-convert-api-client/models/xml_replace_with_x_path_result.rb +206 -0
  518. data/lib/cloudmersive-convert-api-client/models/xml_set_value_with_x_path_result.rb +206 -0
  519. data/lib/cloudmersive-convert-api-client/models/zip_directory.rb +210 -0
  520. data/lib/cloudmersive-convert-api-client/models/zip_encryption_advanced_request.rb +221 -0
  521. data/lib/cloudmersive-convert-api-client/models/zip_extract_response.rb +210 -0
  522. data/lib/cloudmersive-convert-api-client/models/zip_file.rb +211 -0
  523. data/lib/cloudmersive-convert-api-client/version.rb +15 -0
  524. data/spec/api/compare_document_api_spec.rb +48 -0
  525. data/spec/api/convert_data_api_spec.rb +265 -0
  526. data/spec/api/convert_document_api_spec.rb +1033 -0
  527. data/spec/api/convert_image_api_spec.rb +88 -0
  528. data/spec/api/convert_template_api_spec.rb +60 -0
  529. data/spec/api/convert_web_api_spec.rb +131 -0
  530. data/spec/api/edit_document_api_spec.rb +743 -0
  531. data/spec/api/edit_html_api_spec.rb +114 -0
  532. data/spec/api/edit_pdf_api_spec.rb +332 -0
  533. data/spec/api/edit_text_api_spec.rb +192 -0
  534. data/spec/api/merge_document_api_spec.rb +239 -0
  535. data/spec/api/split_document_api_spec.rb +113 -0
  536. data/spec/api/transform_document_api_spec.rb +67 -0
  537. data/spec/api/validate_document_api_spec.rb +239 -0
  538. data/spec/api/viewer_tools_api_spec.rb +47 -0
  539. data/spec/api/zip_archive_api_spec.rb +128 -0
  540. data/spec/api_client_spec.rb +243 -0
  541. data/spec/configuration_spec.rb +42 -0
  542. data/spec/models/add_pdf_annotation_request_spec.rb +47 -0
  543. data/spec/models/alternate_file_format_candidate_spec.rb +53 -0
  544. data/spec/models/append_xlsx_row_request_spec.rb +59 -0
  545. data/spec/models/append_xlsx_row_response_spec.rb +47 -0
  546. data/spec/models/autodetect_document_validation_result_spec.rb +65 -0
  547. data/spec/models/autodetect_get_info_result_spec.rb +77 -0
  548. data/spec/models/autodetect_to_jpg_result_spec.rb +47 -0
  549. data/spec/models/autodetect_to_png_result_spec.rb +47 -0
  550. data/spec/models/autodetect_to_thumbnails_result_spec.rb +47 -0
  551. data/spec/models/base64_decode_request_spec.rb +41 -0
  552. data/spec/models/base64_decode_response_spec.rb +47 -0
  553. data/spec/models/base64_detect_request_spec.rb +41 -0
  554. data/spec/models/base64_detect_response_spec.rb +47 -0
  555. data/spec/models/base64_encode_request_spec.rb +41 -0
  556. data/spec/models/base64_encode_response_spec.rb +47 -0
  557. data/spec/models/change_line_ending_response_spec.rb +47 -0
  558. data/spec/models/clear_xlsx_cell_request_spec.rb +65 -0
  559. data/spec/models/clear_xlsx_cell_response_spec.rb +47 -0
  560. data/spec/models/clear_xlsx_row_request_spec.rb +59 -0
  561. data/spec/models/clear_xlsx_row_response_spec.rb +47 -0
  562. data/spec/models/converted_jpg_page_spec.rb +47 -0
  563. data/spec/models/converted_png_page_spec.rb +47 -0
  564. data/spec/models/create_blank_docx_request_spec.rb +41 -0
  565. data/spec/models/create_blank_docx_response_spec.rb +47 -0
  566. data/spec/models/create_blank_spreadsheet_request_spec.rb +41 -0
  567. data/spec/models/create_blank_spreadsheet_response_spec.rb +47 -0
  568. data/spec/models/create_spreadsheet_from_data_request_spec.rb +47 -0
  569. data/spec/models/create_spreadsheet_from_data_response_spec.rb +47 -0
  570. data/spec/models/create_zip_archive_request_spec.rb +47 -0
  571. data/spec/models/csv_collection_spec.rb +53 -0
  572. data/spec/models/csv_file_result_spec.rb +47 -0
  573. data/spec/models/delete_docx_table_row_range_request_spec.rb +65 -0
  574. data/spec/models/delete_docx_table_row_range_response_spec.rb +47 -0
  575. data/spec/models/delete_docx_table_row_request_spec.rb +59 -0
  576. data/spec/models/delete_docx_table_row_response_spec.rb +47 -0
  577. data/spec/models/detect_line_endings_response_spec.rb +59 -0
  578. data/spec/models/disable_shared_workbook_request_spec.rb +47 -0
  579. data/spec/models/disable_shared_workbook_response_spec.rb +47 -0
  580. data/spec/models/document_validation_error_spec.rb +59 -0
  581. data/spec/models/document_validation_result_spec.rb +65 -0
  582. data/spec/models/docx_body_spec.rb +53 -0
  583. data/spec/models/docx_cell_style_spec.rb +59 -0
  584. data/spec/models/docx_comment_spec.rb +89 -0
  585. data/spec/models/docx_footer_spec.rb +53 -0
  586. data/spec/models/docx_header_spec.rb +53 -0
  587. data/spec/models/docx_image_spec.rb +113 -0
  588. data/spec/models/docx_insert_comment_on_paragraph_request_spec.rb +59 -0
  589. data/spec/models/docx_insert_image_request_spec.rb +89 -0
  590. data/spec/models/docx_insert_image_response_spec.rb +47 -0
  591. data/spec/models/docx_page_spec.rb +47 -0
  592. data/spec/models/docx_paragraph_spec.rb +59 -0
  593. data/spec/models/docx_remove_object_request_spec.rb +53 -0
  594. data/spec/models/docx_remove_object_response_spec.rb +47 -0
  595. data/spec/models/docx_run_spec.rb +83 -0
  596. data/spec/models/docx_section_spec.rb +47 -0
  597. data/spec/models/docx_set_footer_add_page_number_request_spec.rb +53 -0
  598. data/spec/models/docx_set_footer_request_spec.rb +53 -0
  599. data/spec/models/docx_set_footer_response_spec.rb +47 -0
  600. data/spec/models/docx_set_header_request_spec.rb +53 -0
  601. data/spec/models/docx_set_header_response_spec.rb +47 -0
  602. data/spec/models/docx_style_spec.rb +77 -0
  603. data/spec/models/docx_table_cell_spec.rb +83 -0
  604. data/spec/models/docx_table_row_spec.rb +53 -0
  605. data/spec/models/docx_table_spec.rb +269 -0
  606. data/spec/models/docx_template_application_request_spec.rb +41 -0
  607. data/spec/models/docx_template_operation_spec.rb +57 -0
  608. data/spec/models/docx_text_spec.rb +53 -0
  609. data/spec/models/docx_to_jpg_result_spec.rb +47 -0
  610. data/spec/models/docx_to_png_result_spec.rb +47 -0
  611. data/spec/models/docx_top_level_comment_spec.rb +77 -0
  612. data/spec/models/eml_attachment_spec.rb +47 -0
  613. data/spec/models/eml_to_html_result_spec.rb +89 -0
  614. data/spec/models/eml_to_jpg_result_spec.rb +47 -0
  615. data/spec/models/eml_to_png_result_spec.rb +47 -0
  616. data/spec/models/enable_shared_workbook_request_spec.rb +47 -0
  617. data/spec/models/enable_shared_workbook_response_spec.rb +47 -0
  618. data/spec/models/exif_value_spec.rb +53 -0
  619. data/spec/models/find_docx_paragraph_request_spec.rb +59 -0
  620. data/spec/models/find_docx_paragraph_response_spec.rb +53 -0
  621. data/spec/models/find_regex_match_spec.rb +65 -0
  622. data/spec/models/find_string_match_spec.rb +53 -0
  623. data/spec/models/find_string_regex_request_spec.rb +53 -0
  624. data/spec/models/find_string_regex_response_spec.rb +53 -0
  625. data/spec/models/find_string_simple_request_spec.rb +47 -0
  626. data/spec/models/find_string_simple_response_spec.rb +53 -0
  627. data/spec/models/finish_editing_request_spec.rb +41 -0
  628. data/spec/models/get_docx_body_request_spec.rb +47 -0
  629. data/spec/models/get_docx_body_response_spec.rb +47 -0
  630. data/spec/models/get_docx_comments_hierarchical_response_spec.rb +53 -0
  631. data/spec/models/get_docx_comments_response_spec.rb +53 -0
  632. data/spec/models/get_docx_get_comments_hierarchical_request_spec.rb +47 -0
  633. data/spec/models/get_docx_get_comments_request_spec.rb +47 -0
  634. data/spec/models/get_docx_headers_and_footers_request_spec.rb +47 -0
  635. data/spec/models/get_docx_headers_and_footers_response_spec.rb +53 -0
  636. data/spec/models/get_docx_images_request_spec.rb +47 -0
  637. data/spec/models/get_docx_images_response_spec.rb +47 -0
  638. data/spec/models/get_docx_pages_request_spec.rb +53 -0
  639. data/spec/models/get_docx_pages_response_spec.rb +53 -0
  640. data/spec/models/get_docx_sections_request_spec.rb +47 -0
  641. data/spec/models/get_docx_sections_response_spec.rb +47 -0
  642. data/spec/models/get_docx_styles_request_spec.rb +47 -0
  643. data/spec/models/get_docx_styles_response_spec.rb +47 -0
  644. data/spec/models/get_docx_table_by_index_request_spec.rb +53 -0
  645. data/spec/models/get_docx_table_by_index_response_spec.rb +47 -0
  646. data/spec/models/get_docx_table_row_request_spec.rb +59 -0
  647. data/spec/models/get_docx_table_row_response_spec.rb +47 -0
  648. data/spec/models/get_docx_tables_request_spec.rb +47 -0
  649. data/spec/models/get_docx_tables_response_spec.rb +47 -0
  650. data/spec/models/get_file_type_icon_result_spec.rb +53 -0
  651. data/spec/models/get_image_info_result_spec.rb +137 -0
  652. data/spec/models/get_pdf_annotations_result_spec.rb +47 -0
  653. data/spec/models/get_xlsx_cell_by_identifier_request_spec.rb +59 -0
  654. data/spec/models/get_xlsx_cell_by_identifier_response_spec.rb +47 -0
  655. data/spec/models/get_xlsx_cell_request_spec.rb +65 -0
  656. data/spec/models/get_xlsx_cell_response_spec.rb +47 -0
  657. data/spec/models/get_xlsx_columns_request_spec.rb +53 -0
  658. data/spec/models/get_xlsx_columns_response_spec.rb +47 -0
  659. data/spec/models/get_xlsx_images_request_spec.rb +53 -0
  660. data/spec/models/get_xlsx_images_response_spec.rb +47 -0
  661. data/spec/models/get_xlsx_rows_and_cells_request_spec.rb +53 -0
  662. data/spec/models/get_xlsx_rows_and_cells_response_spec.rb +47 -0
  663. data/spec/models/get_xlsx_specific_row_request_spec.rb +59 -0
  664. data/spec/models/get_xlsx_specific_row_response_spec.rb +47 -0
  665. data/spec/models/get_xlsx_styles_request_spec.rb +47 -0
  666. data/spec/models/get_xlsx_styles_response_spec.rb +47 -0
  667. data/spec/models/get_xlsx_worksheets_request_spec.rb +47 -0
  668. data/spec/models/get_xlsx_worksheets_response_spec.rb +47 -0
  669. data/spec/models/html_md_result_spec.rb +47 -0
  670. data/spec/models/html_template_application_request_spec.rb +53 -0
  671. data/spec/models/html_template_application_response_spec.rb +47 -0
  672. data/spec/models/html_template_operation_spec.rb +57 -0
  673. data/spec/models/html_to_office_request_spec.rb +41 -0
  674. data/spec/models/html_to_pdf_request_spec.rb +59 -0
  675. data/spec/models/html_to_png_request_spec.rb +59 -0
  676. data/spec/models/html_to_text_request_spec.rb +41 -0
  677. data/spec/models/html_to_text_response_spec.rb +47 -0
  678. data/spec/models/insert_docx_comment_on_paragraph_response_spec.rb +47 -0
  679. data/spec/models/insert_docx_insert_paragraph_request_spec.rb +65 -0
  680. data/spec/models/insert_docx_insert_paragraph_response_spec.rb +47 -0
  681. data/spec/models/insert_docx_table_row_request_spec.rb +65 -0
  682. data/spec/models/insert_docx_table_row_response_spec.rb +47 -0
  683. data/spec/models/insert_docx_tables_request_spec.rb +65 -0
  684. data/spec/models/insert_docx_tables_response_spec.rb +47 -0
  685. data/spec/models/insert_xlsx_worksheet_request_spec.rb +53 -0
  686. data/spec/models/insert_xlsx_worksheet_response_spec.rb +47 -0
  687. data/spec/models/keynote_to_jpg_result_spec.rb +47 -0
  688. data/spec/models/keynote_to_png_result_spec.rb +47 -0
  689. data/spec/models/msg_attachment_spec.rb +47 -0
  690. data/spec/models/msg_to_html_result_spec.rb +89 -0
  691. data/spec/models/msg_to_jpg_result_spec.rb +47 -0
  692. data/spec/models/msg_to_png_result_spec.rb +47 -0
  693. data/spec/models/multi_replace_string_request_spec.rb +53 -0
  694. data/spec/models/multipage_image_format_conversion_result_spec.rb +53 -0
  695. data/spec/models/odp_to_jpg_result_spec.rb +47 -0
  696. data/spec/models/odp_to_png_result_spec.rb +47 -0
  697. data/spec/models/ods_to_jpg_result_spec.rb +47 -0
  698. data/spec/models/ods_to_png_result_spec.rb +47 -0
  699. data/spec/models/odt_to_jpg_result_spec.rb +47 -0
  700. data/spec/models/odt_to_png_result_spec.rb +47 -0
  701. data/spec/models/page_conversion_result_spec.rb +47 -0
  702. data/spec/models/pdf_annotation_spec.rb +107 -0
  703. data/spec/models/pdf_document_spec.rb +53 -0
  704. data/spec/models/pdf_form_field_spec.rb +59 -0
  705. data/spec/models/pdf_form_fields_spec.rb +47 -0
  706. data/spec/models/pdf_metadata_spec.rb +89 -0
  707. data/spec/models/pdf_page_text_spec.rb +47 -0
  708. data/spec/models/pdf_text_by_page_result_spec.rb +47 -0
  709. data/spec/models/pdf_to_jpg_result_spec.rb +47 -0
  710. data/spec/models/pdf_to_png_result_spec.rb +47 -0
  711. data/spec/models/pptx_to_png_result_spec.rb +47 -0
  712. data/spec/models/presentation_result_spec.rb +53 -0
  713. data/spec/models/remove_docx_headers_and_footers_request_spec.rb +59 -0
  714. data/spec/models/remove_docx_headers_and_footers_response_spec.rb +47 -0
  715. data/spec/models/remove_docx_pages_request_spec.rb +59 -0
  716. data/spec/models/remove_html_from_text_request_spec.rb +41 -0
  717. data/spec/models/remove_html_from_text_response_spec.rb +47 -0
  718. data/spec/models/remove_pptx_slides_request_spec.rb +59 -0
  719. data/spec/models/remove_whitespace_from_text_request_spec.rb +41 -0
  720. data/spec/models/remove_whitespace_from_text_response_spec.rb +47 -0
  721. data/spec/models/remove_xlsx_worksheet_request_spec.rb +53 -0
  722. data/spec/models/rename_xlsx_worksheet_request_spec.rb +59 -0
  723. data/spec/models/rename_xlsx_worksheet_response_spec.rb +47 -0
  724. data/spec/models/replace_docx_paragraph_request_spec.rb +65 -0
  725. data/spec/models/replace_docx_paragraph_response_spec.rb +47 -0
  726. data/spec/models/replace_string_regex_request_spec.rb +53 -0
  727. data/spec/models/replace_string_regex_response_spec.rb +47 -0
  728. data/spec/models/replace_string_request_spec.rb +65 -0
  729. data/spec/models/replace_string_simple_request_spec.rb +53 -0
  730. data/spec/models/replace_string_simple_response_spec.rb +47 -0
  731. data/spec/models/rtf_to_jpg_result_spec.rb +47 -0
  732. data/spec/models/rtf_to_png_result_spec.rb +47 -0
  733. data/spec/models/screenshot_request_spec.rb +59 -0
  734. data/spec/models/set_form_field_value_spec.rb +59 -0
  735. data/spec/models/set_pdf_form_fields_request_spec.rb +47 -0
  736. data/spec/models/set_pdf_metadata_request_spec.rb +47 -0
  737. data/spec/models/set_xlsx_cell_by_identifier_request_spec.rb +65 -0
  738. data/spec/models/set_xlsx_cell_by_identifier_response_spec.rb +47 -0
  739. data/spec/models/set_xlsx_cell_request_spec.rb +71 -0
  740. data/spec/models/set_xlsx_cell_response_spec.rb +47 -0
  741. data/spec/models/single_replace_string_spec.rb +53 -0
  742. data/spec/models/split_document_result_spec.rb +53 -0
  743. data/spec/models/split_docx_document_result_spec.rb +47 -0
  744. data/spec/models/split_pdf_result_spec.rb +47 -0
  745. data/spec/models/split_pptx_presentation_result_spec.rb +47 -0
  746. data/spec/models/split_text_document_by_lines_result_spec.rb +53 -0
  747. data/spec/models/split_text_document_by_string_result_spec.rb +53 -0
  748. data/spec/models/split_xlsx_worksheet_result_spec.rb +47 -0
  749. data/spec/models/text_conversion_result_spec.rb +47 -0
  750. data/spec/models/text_document_element_spec.rb +47 -0
  751. data/spec/models/text_document_line_spec.rb +47 -0
  752. data/spec/models/text_encoding_detect_response_spec.rb +47 -0
  753. data/spec/models/thumbnail_spec.rb +47 -0
  754. data/spec/models/update_docx_table_cell_request_spec.rb +71 -0
  755. data/spec/models/update_docx_table_cell_response_spec.rb +47 -0
  756. data/spec/models/update_docx_table_row_request_spec.rb +65 -0
  757. data/spec/models/update_docx_table_row_response_spec.rb +47 -0
  758. data/spec/models/url_to_pdf_request_spec.rb +59 -0
  759. data/spec/models/url_to_text_request_spec.rb +41 -0
  760. data/spec/models/url_to_text_response_spec.rb +47 -0
  761. data/spec/models/viewer_response_spec.rb +47 -0
  762. data/spec/models/worksheet_result_spec.rb +59 -0
  763. data/spec/models/xlsx_image_spec.rb +65 -0
  764. data/spec/models/xlsx_spreadsheet_cell_spec.rb +65 -0
  765. data/spec/models/xlsx_spreadsheet_column_spec.rb +47 -0
  766. data/spec/models/xlsx_spreadsheet_row_spec.rb +47 -0
  767. data/spec/models/xlsx_to_png_result_spec.rb +47 -0
  768. data/spec/models/xlsx_worksheet_spec.rb +47 -0
  769. data/spec/models/xml_add_attribute_with_x_path_result_spec.rb +53 -0
  770. data/spec/models/xml_add_child_with_x_path_result_spec.rb +53 -0
  771. data/spec/models/xml_filter_with_x_path_result_spec.rb +53 -0
  772. data/spec/models/xml_query_with_x_query_multi_result_spec.rb +53 -0
  773. data/spec/models/xml_query_with_x_query_result_spec.rb +53 -0
  774. data/spec/models/xml_remove_all_children_with_x_path_result_spec.rb +53 -0
  775. data/spec/models/xml_remove_with_x_path_result_spec.rb +59 -0
  776. data/spec/models/xml_replace_with_x_path_result_spec.rb +53 -0
  777. data/spec/models/xml_set_value_with_x_path_result_spec.rb +53 -0
  778. data/spec/models/zip_directory_spec.rb +53 -0
  779. data/spec/models/zip_encryption_advanced_request_spec.rb +53 -0
  780. data/spec/models/zip_extract_response_spec.rb +53 -0
  781. data/spec/models/zip_file_spec.rb +47 -0
  782. data/spec/spec_helper.rb +111 -0
  783. metadata +785 -4
@@ -0,0 +1,329 @@
1
+ # CloudmersiveConvertApiClient::EditHtmlApi
2
+
3
+ All URIs are relative to *https://api.cloudmersive.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**edit_html_html_append_heading**](EditHtmlApi.md#edit_html_html_append_heading) | **POST** /convert/edit/html/append/heading | Append a Heading to an HTML Document
8
+ [**edit_html_html_append_image_from_url**](EditHtmlApi.md#edit_html_html_append_image_from_url) | **POST** /convert/edit/html/append/image/from-url | Append an Image to an HTML Document from a URL
9
+ [**edit_html_html_append_image_inline**](EditHtmlApi.md#edit_html_html_append_image_inline) | **POST** /convert/edit/html/append/image/inline | Append a Base64 Inline Image to an HTML Document
10
+ [**edit_html_html_append_paragraph**](EditHtmlApi.md#edit_html_html_append_paragraph) | **POST** /convert/edit/html/append/paragraph | Append a Paragraph to an HTML Document
11
+ [**edit_html_html_create_blank_document**](EditHtmlApi.md#edit_html_html_create_blank_document) | **POST** /convert/edit/html/create/blank | Create a Blank HTML Document
12
+
13
+
14
+ # **edit_html_html_append_heading**
15
+ > String edit_html_html_append_heading(heading_text, opts)
16
+
17
+ Append a Heading to an HTML Document
18
+
19
+ Appends a heading to the end of an HTML document.
20
+
21
+ ### Example
22
+ ```ruby
23
+ # load the gem
24
+ require 'cloudmersive-convert-api-client'
25
+ # setup authorization
26
+ CloudmersiveConvertApiClient.configure do |config|
27
+ # Configure API key authorization: Apikey
28
+ config.api_key['Apikey'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ #config.api_key_prefix['Apikey'] = 'Bearer'
31
+ end
32
+
33
+ api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
34
+
35
+ heading_text = 'heading_text_example' # String | The text content to be used in the header.
36
+
37
+ opts = {
38
+ input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
39
+ input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input.
40
+ heading_size: 56, # Integer | Optional: The heading size number. Default is 1. Accepts values between 1 and 6.
41
+ css_style: 'css_style_example' # String | Optional: The CSS style for the heading.
42
+ }
43
+
44
+ begin
45
+ #Append a Heading to an HTML Document
46
+ result = api_instance.edit_html_html_append_heading(heading_text, opts)
47
+ p result
48
+ rescue CloudmersiveConvertApiClient::ApiError => e
49
+ puts "Exception when calling EditHtmlApi->edit_html_html_append_heading: #{e}"
50
+ end
51
+ ```
52
+
53
+ ### Parameters
54
+
55
+ Name | Type | Description | Notes
56
+ ------------- | ------------- | ------------- | -------------
57
+ **heading_text** | **String**| The text content to be used in the header. |
58
+ **input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
59
+ **input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
60
+ **heading_size** | **Integer**| Optional: The heading size number. Default is 1. Accepts values between 1 and 6. | [optional]
61
+ **css_style** | **String**| Optional: The CSS style for the heading. | [optional]
62
+
63
+ ### Return type
64
+
65
+ **String**
66
+
67
+ ### Authorization
68
+
69
+ [Apikey](../README.md#Apikey)
70
+
71
+ ### HTTP request headers
72
+
73
+ - **Content-Type**: Not defined
74
+ - **Accept**: application/json, text/json, application/xml, text/xml
75
+
76
+
77
+
78
+ # **edit_html_html_append_image_from_url**
79
+ > String edit_html_html_append_image_from_url(image_url, opts)
80
+
81
+ Append an Image to an HTML Document from a URL
82
+
83
+ Appends an image to the end of an HTML document using a URL.
84
+
85
+ ### Example
86
+ ```ruby
87
+ # load the gem
88
+ require 'cloudmersive-convert-api-client'
89
+ # setup authorization
90
+ CloudmersiveConvertApiClient.configure do |config|
91
+ # Configure API key authorization: Apikey
92
+ config.api_key['Apikey'] = 'YOUR API KEY'
93
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
94
+ #config.api_key_prefix['Apikey'] = 'Bearer'
95
+ end
96
+
97
+ api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
98
+
99
+ image_url = 'image_url_example' # String | The URL for the image.
100
+
101
+ opts = {
102
+ input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
103
+ input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input.
104
+ css_style: 'css_style_example' # String | Optional: CSS style for the image.
105
+ }
106
+
107
+ begin
108
+ #Append an Image to an HTML Document from a URL
109
+ result = api_instance.edit_html_html_append_image_from_url(image_url, opts)
110
+ p result
111
+ rescue CloudmersiveConvertApiClient::ApiError => e
112
+ puts "Exception when calling EditHtmlApi->edit_html_html_append_image_from_url: #{e}"
113
+ end
114
+ ```
115
+
116
+ ### Parameters
117
+
118
+ Name | Type | Description | Notes
119
+ ------------- | ------------- | ------------- | -------------
120
+ **image_url** | **String**| The URL for the image. |
121
+ **input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
122
+ **input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
123
+ **css_style** | **String**| Optional: CSS style for the image. | [optional]
124
+
125
+ ### Return type
126
+
127
+ **String**
128
+
129
+ ### Authorization
130
+
131
+ [Apikey](../README.md#Apikey)
132
+
133
+ ### HTTP request headers
134
+
135
+ - **Content-Type**: Not defined
136
+ - **Accept**: application/json, text/json, application/xml, text/xml
137
+
138
+
139
+
140
+ # **edit_html_html_append_image_inline**
141
+ > String edit_html_html_append_image_inline(opts)
142
+
143
+ Append a Base64 Inline Image to an HTML Document
144
+
145
+ Appends a base64 inline image to the end of an HTML document from an input file or URL.
146
+
147
+ ### Example
148
+ ```ruby
149
+ # load the gem
150
+ require 'cloudmersive-convert-api-client'
151
+ # setup authorization
152
+ CloudmersiveConvertApiClient.configure do |config|
153
+ # Configure API key authorization: Apikey
154
+ config.api_key['Apikey'] = 'YOUR API KEY'
155
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
156
+ #config.api_key_prefix['Apikey'] = 'Bearer'
157
+ end
158
+
159
+ api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
160
+
161
+ opts = {
162
+ input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
163
+ input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input.
164
+ image_file: File.new('/path/to/file.txt'), # File | Optional: Image file to be appended as base64 inline image.
165
+ image_url: 'image_url_example', # String | Optional: Image URL to be appended as base64 inline image.
166
+ css_style: 'css_style_example', # String | Optional: CSS style for the image.
167
+ image_extension: 'image_extension_example' # String | Optional: The extension (JPG, PNG, GIF, etc.) of the image file. Recommended if uploading an imageFile directly, instead of using imageUrl. If no extension can be determined, will default to JPG.
168
+ }
169
+
170
+ begin
171
+ #Append a Base64 Inline Image to an HTML Document
172
+ result = api_instance.edit_html_html_append_image_inline(opts)
173
+ p result
174
+ rescue CloudmersiveConvertApiClient::ApiError => e
175
+ puts "Exception when calling EditHtmlApi->edit_html_html_append_image_inline: #{e}"
176
+ end
177
+ ```
178
+
179
+ ### Parameters
180
+
181
+ Name | Type | Description | Notes
182
+ ------------- | ------------- | ------------- | -------------
183
+ **input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
184
+ **input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
185
+ **image_file** | **File**| Optional: Image file to be appended as base64 inline image. | [optional]
186
+ **image_url** | **String**| Optional: Image URL to be appended as base64 inline image. | [optional]
187
+ **css_style** | **String**| Optional: CSS style for the image. | [optional]
188
+ **image_extension** | **String**| Optional: The extension (JPG, PNG, GIF, etc.) of the image file. Recommended if uploading an imageFile directly, instead of using imageUrl. If no extension can be determined, will default to JPG. | [optional]
189
+
190
+ ### Return type
191
+
192
+ **String**
193
+
194
+ ### Authorization
195
+
196
+ [Apikey](../README.md#Apikey)
197
+
198
+ ### HTTP request headers
199
+
200
+ - **Content-Type**: multipart/form-data
201
+ - **Accept**: application/json, text/json, application/xml, text/xml
202
+
203
+
204
+
205
+ # **edit_html_html_append_paragraph**
206
+ > String edit_html_html_append_paragraph(paragraph_text, opts)
207
+
208
+ Append a Paragraph to an HTML Document
209
+
210
+ Appends a paragraph to the end of an HTML document.
211
+
212
+ ### Example
213
+ ```ruby
214
+ # load the gem
215
+ require 'cloudmersive-convert-api-client'
216
+ # setup authorization
217
+ CloudmersiveConvertApiClient.configure do |config|
218
+ # Configure API key authorization: Apikey
219
+ config.api_key['Apikey'] = 'YOUR API KEY'
220
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
221
+ #config.api_key_prefix['Apikey'] = 'Bearer'
222
+ end
223
+
224
+ api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
225
+
226
+ paragraph_text = 'paragraph_text_example' # String | The text content to be used in the paragraph.
227
+
228
+ opts = {
229
+ input_file: File.new('/path/to/file.txt'), # File | Optional: Input file to perform the operation on.
230
+ input_file_url: 'input_file_url_example', # String | Optional: URL of a file to operate on as input.
231
+ css_style: 'css_style_example' # String | Optional: The CSS style for the paragraph.
232
+ }
233
+
234
+ begin
235
+ #Append a Paragraph to an HTML Document
236
+ result = api_instance.edit_html_html_append_paragraph(paragraph_text, opts)
237
+ p result
238
+ rescue CloudmersiveConvertApiClient::ApiError => e
239
+ puts "Exception when calling EditHtmlApi->edit_html_html_append_paragraph: #{e}"
240
+ end
241
+ ```
242
+
243
+ ### Parameters
244
+
245
+ Name | Type | Description | Notes
246
+ ------------- | ------------- | ------------- | -------------
247
+ **paragraph_text** | **String**| The text content to be used in the paragraph. |
248
+ **input_file** | **File**| Optional: Input file to perform the operation on. | [optional]
249
+ **input_file_url** | **String**| Optional: URL of a file to operate on as input. | [optional]
250
+ **css_style** | **String**| Optional: The CSS style for the paragraph. | [optional]
251
+
252
+ ### Return type
253
+
254
+ **String**
255
+
256
+ ### Authorization
257
+
258
+ [Apikey](../README.md#Apikey)
259
+
260
+ ### HTTP request headers
261
+
262
+ - **Content-Type**: Not defined
263
+ - **Accept**: application/json, text/json, application/xml, text/xml
264
+
265
+
266
+
267
+ # **edit_html_html_create_blank_document**
268
+ > String edit_html_html_create_blank_document(opts)
269
+
270
+ Create a Blank HTML Document
271
+
272
+ Returns a blank HTML Document format file. The file is blank, with no contents by default. Use the optional input parameters to add various starting elements. Use additional editing commands such as Append Header, Append Paragraph or Append Image from URL to populate the document.
273
+
274
+ ### Example
275
+ ```ruby
276
+ # load the gem
277
+ require 'cloudmersive-convert-api-client'
278
+ # setup authorization
279
+ CloudmersiveConvertApiClient.configure do |config|
280
+ # Configure API key authorization: Apikey
281
+ config.api_key['Apikey'] = 'YOUR API KEY'
282
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
283
+ #config.api_key_prefix['Apikey'] = 'Bearer'
284
+ end
285
+
286
+ api_instance = CloudmersiveConvertApiClient::EditHtmlApi.new
287
+
288
+ opts = {
289
+ title: 'title_example', # String | Optional: The title of the HTML document
290
+ css_url: 'css_url_example', # String | Optional: A CSS style URL to be added to the document.
291
+ css_inline: 'css_inline_example', # String | Optional: An inline CSS style to be added to the document.
292
+ javascript_url: 'javascript_url_example', # String | Optional: Javascript URL to be added to the document.
293
+ javascript_inline: 'javascript_inline_example' # String | Optional: Inline Javascript to be added to the document.
294
+ }
295
+
296
+ begin
297
+ #Create a Blank HTML Document
298
+ result = api_instance.edit_html_html_create_blank_document(opts)
299
+ p result
300
+ rescue CloudmersiveConvertApiClient::ApiError => e
301
+ puts "Exception when calling EditHtmlApi->edit_html_html_create_blank_document: #{e}"
302
+ end
303
+ ```
304
+
305
+ ### Parameters
306
+
307
+ Name | Type | Description | Notes
308
+ ------------- | ------------- | ------------- | -------------
309
+ **title** | **String**| Optional: The title of the HTML document | [optional]
310
+ **css_url** | **String**| Optional: A CSS style URL to be added to the document. | [optional]
311
+ **css_inline** | **String**| Optional: An inline CSS style to be added to the document. | [optional]
312
+ **javascript_url** | **String**| Optional: Javascript URL to be added to the document. | [optional]
313
+ **javascript_inline** | **String**| Optional: Inline Javascript to be added to the document. | [optional]
314
+
315
+ ### Return type
316
+
317
+ **String**
318
+
319
+ ### Authorization
320
+
321
+ [Apikey](../README.md#Apikey)
322
+
323
+ ### HTTP request headers
324
+
325
+ - **Content-Type**: Not defined
326
+ - **Accept**: application/json, text/json, application/xml, text/xml
327
+
328
+
329
+
@@ -0,0 +1,1310 @@
1
+ # CloudmersiveConvertApiClient::EditPdfApi
2
+
3
+ All URIs are relative to *https://api.cloudmersive.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**edit_pdf_add_annotations**](EditPdfApi.md#edit_pdf_add_annotations) | **POST** /convert/edit/pdf/annotations/add-item | Add one or more PDF annotations, comments in the PDF document
8
+ [**edit_pdf_convert_to_pdf_a**](EditPdfApi.md#edit_pdf_convert_to_pdf_a) | **POST** /convert/edit/pdf/optimize/pdf-a | Convert a PDF file to PDF/A
9
+ [**edit_pdf_decrypt**](EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
10
+ [**edit_pdf_delete_pages**](EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove, delete pages from a PDF document
11
+ [**edit_pdf_encrypt**](EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
12
+ [**edit_pdf_get_annotations**](EditPdfApi.md#edit_pdf_get_annotations) | **POST** /convert/edit/pdf/annotations/list | Get PDF annotations, including comments in the document
13
+ [**edit_pdf_get_form_fields**](EditPdfApi.md#edit_pdf_get_form_fields) | **POST** /convert/edit/pdf/form/get-fields | Gets PDF Form fields and values
14
+ [**edit_pdf_get_metadata**](EditPdfApi.md#edit_pdf_get_metadata) | **POST** /convert/edit/pdf/get-metadata | Get PDF document metadata
15
+ [**edit_pdf_get_pdf_text_by_pages**](EditPdfApi.md#edit_pdf_get_pdf_text_by_pages) | **POST** /convert/edit/pdf/pages/get-text | Get text in a PDF document by page
16
+ [**edit_pdf_insert_pages**](EditPdfApi.md#edit_pdf_insert_pages) | **POST** /convert/edit/pdf/pages/insert | Insert, copy pages from one PDF document into another
17
+ [**edit_pdf_linearize**](EditPdfApi.md#edit_pdf_linearize) | **POST** /convert/edit/pdf/optimize/linearize | Linearize and optimize a PDF for streaming download
18
+ [**edit_pdf_rasterize**](EditPdfApi.md#edit_pdf_rasterize) | **POST** /convert/edit/pdf/rasterize | Rasterize a PDF to an image-based PDF
19
+ [**edit_pdf_reduce_file_size**](EditPdfApi.md#edit_pdf_reduce_file_size) | **POST** /convert/edit/pdf/optimize/reduce-file-size | Reduce the file size and optimize a PDF
20
+ [**edit_pdf_remove_all_annotations**](EditPdfApi.md#edit_pdf_remove_all_annotations) | **POST** /convert/edit/pdf/annotations/remove-all | Remove all PDF annotations, including comments in the document
21
+ [**edit_pdf_remove_annotation_item**](EditPdfApi.md#edit_pdf_remove_annotation_item) | **POST** /convert/edit/pdf/annotations/remove-item | Remove a specific PDF annotation, comment in the document
22
+ [**edit_pdf_resize**](EditPdfApi.md#edit_pdf_resize) | **POST** /convert/edit/pdf/resize | Change PDF Document's Paper Size
23
+ [**edit_pdf_rotate_all_pages**](EditPdfApi.md#edit_pdf_rotate_all_pages) | **POST** /convert/edit/pdf/pages/rotate/all | Rotate all pages in a PDF document
24
+ [**edit_pdf_rotate_page_range**](EditPdfApi.md#edit_pdf_rotate_page_range) | **POST** /convert/edit/pdf/pages/rotate/page-range | Rotate a range, subset of pages in a PDF document
25
+ [**edit_pdf_set_form_fields**](EditPdfApi.md#edit_pdf_set_form_fields) | **POST** /convert/edit/pdf/form/set-fields | Sets ands fills PDF Form field values
26
+ [**edit_pdf_set_metadata**](EditPdfApi.md#edit_pdf_set_metadata) | **POST** /convert/edit/pdf/set-metadata | Sets PDF document metadata
27
+ [**edit_pdf_set_permissions**](EditPdfApi.md#edit_pdf_set_permissions) | **POST** /convert/edit/pdf/encrypt/set-permissions | Encrypt, password-protect and set restricted permissions on a PDF
28
+ [**edit_pdf_watermark_text**](EditPdfApi.md#edit_pdf_watermark_text) | **POST** /convert/edit/pdf/watermark/text | Add a text watermark to a PDF
29
+
30
+
31
+ # **edit_pdf_add_annotations**
32
+ > String edit_pdf_add_annotations(request)
33
+
34
+ Add one or more PDF annotations, comments in the PDF document
35
+
36
+ Adds one or more annotations, comments to a PDF document.
37
+
38
+ ### Example
39
+ ```ruby
40
+ # load the gem
41
+ require 'cloudmersive-convert-api-client'
42
+ # setup authorization
43
+ CloudmersiveConvertApiClient.configure do |config|
44
+ # Configure API key authorization: Apikey
45
+ config.api_key['Apikey'] = 'YOUR API KEY'
46
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
47
+ #config.api_key_prefix['Apikey'] = 'Bearer'
48
+ end
49
+
50
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
51
+
52
+ request = CloudmersiveConvertApiClient::AddPdfAnnotationRequest.new # AddPdfAnnotationRequest |
53
+
54
+
55
+ begin
56
+ #Add one or more PDF annotations, comments in the PDF document
57
+ result = api_instance.edit_pdf_add_annotations(request)
58
+ p result
59
+ rescue CloudmersiveConvertApiClient::ApiError => e
60
+ puts "Exception when calling EditPdfApi->edit_pdf_add_annotations: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ Name | Type | Description | Notes
67
+ ------------- | ------------- | ------------- | -------------
68
+ **request** | [**AddPdfAnnotationRequest**](AddPdfAnnotationRequest.md)| |
69
+
70
+ ### Return type
71
+
72
+ **String**
73
+
74
+ ### Authorization
75
+
76
+ [Apikey](../README.md#Apikey)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
81
+ - **Accept**: application/octet-stream
82
+
83
+
84
+
85
+ # **edit_pdf_convert_to_pdf_a**
86
+ > String edit_pdf_convert_to_pdf_a(input_file, opts)
87
+
88
+ Convert a PDF file to PDF/A
89
+
90
+ Converts the input PDF file to a PDF/A-1b or PDF/A-2b standardized PDF.
91
+
92
+ ### Example
93
+ ```ruby
94
+ # load the gem
95
+ require 'cloudmersive-convert-api-client'
96
+ # setup authorization
97
+ CloudmersiveConvertApiClient.configure do |config|
98
+ # Configure API key authorization: Apikey
99
+ config.api_key['Apikey'] = 'YOUR API KEY'
100
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
101
+ #config.api_key_prefix['Apikey'] = 'Bearer'
102
+ end
103
+
104
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
105
+
106
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
107
+
108
+ opts = {
109
+ conformance_level: 'conformance_level_example' # String | Optional: Select the conformance level for PDF/A - specify '1b' for PDF/A-1b or specify '2b' for PDF/A-2b; default is PDF/A-1b
110
+ }
111
+
112
+ begin
113
+ #Convert a PDF file to PDF/A
114
+ result = api_instance.edit_pdf_convert_to_pdf_a(input_file, opts)
115
+ p result
116
+ rescue CloudmersiveConvertApiClient::ApiError => e
117
+ puts "Exception when calling EditPdfApi->edit_pdf_convert_to_pdf_a: #{e}"
118
+ end
119
+ ```
120
+
121
+ ### Parameters
122
+
123
+ Name | Type | Description | Notes
124
+ ------------- | ------------- | ------------- | -------------
125
+ **input_file** | **File**| Input file to perform the operation on. |
126
+ **conformance_level** | **String**| Optional: Select the conformance level for PDF/A - specify '1b' for PDF/A-1b or specify '2b' for PDF/A-2b; default is PDF/A-1b | [optional]
127
+
128
+ ### Return type
129
+
130
+ **String**
131
+
132
+ ### Authorization
133
+
134
+ [Apikey](../README.md#Apikey)
135
+
136
+ ### HTTP request headers
137
+
138
+ - **Content-Type**: multipart/form-data
139
+ - **Accept**: application/octet-stream
140
+
141
+
142
+
143
+ # **edit_pdf_decrypt**
144
+ > String edit_pdf_decrypt(password, input_file)
145
+
146
+ Decrypt and password-protect a PDF
147
+
148
+ Decrypt a PDF document with a password. Decrypted PDF will no longer require a password to open.
149
+
150
+ ### Example
151
+ ```ruby
152
+ # load the gem
153
+ require 'cloudmersive-convert-api-client'
154
+ # setup authorization
155
+ CloudmersiveConvertApiClient.configure do |config|
156
+ # Configure API key authorization: Apikey
157
+ config.api_key['Apikey'] = 'YOUR API KEY'
158
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
159
+ #config.api_key_prefix['Apikey'] = 'Bearer'
160
+ end
161
+
162
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
163
+
164
+ password = 'password_example' # String | Valid password for the PDF file
165
+
166
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
167
+
168
+
169
+ begin
170
+ #Decrypt and password-protect a PDF
171
+ result = api_instance.edit_pdf_decrypt(password, input_file)
172
+ p result
173
+ rescue CloudmersiveConvertApiClient::ApiError => e
174
+ puts "Exception when calling EditPdfApi->edit_pdf_decrypt: #{e}"
175
+ end
176
+ ```
177
+
178
+ ### Parameters
179
+
180
+ Name | Type | Description | Notes
181
+ ------------- | ------------- | ------------- | -------------
182
+ **password** | **String**| Valid password for the PDF file |
183
+ **input_file** | **File**| Input file to perform the operation on. |
184
+
185
+ ### Return type
186
+
187
+ **String**
188
+
189
+ ### Authorization
190
+
191
+ [Apikey](../README.md#Apikey)
192
+
193
+ ### HTTP request headers
194
+
195
+ - **Content-Type**: multipart/form-data
196
+ - **Accept**: application/octet-stream
197
+
198
+
199
+
200
+ # **edit_pdf_delete_pages**
201
+ > String edit_pdf_delete_pages(input_file, page_start, page_end)
202
+
203
+ Remove, delete pages from a PDF document
204
+
205
+ Remove one or more pages from a PDF document
206
+
207
+ ### Example
208
+ ```ruby
209
+ # load the gem
210
+ require 'cloudmersive-convert-api-client'
211
+ # setup authorization
212
+ CloudmersiveConvertApiClient.configure do |config|
213
+ # Configure API key authorization: Apikey
214
+ config.api_key['Apikey'] = 'YOUR API KEY'
215
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
216
+ #config.api_key_prefix['Apikey'] = 'Bearer'
217
+ end
218
+
219
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
220
+
221
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
222
+
223
+ page_start = 56 # Integer | Page number (1 based) to start deleting pages from (inclusive).
224
+
225
+ page_end = 56 # Integer | Page number (1 based) to stop deleting pages from (inclusive).
226
+
227
+
228
+ begin
229
+ #Remove, delete pages from a PDF document
230
+ result = api_instance.edit_pdf_delete_pages(input_file, page_start, page_end)
231
+ p result
232
+ rescue CloudmersiveConvertApiClient::ApiError => e
233
+ puts "Exception when calling EditPdfApi->edit_pdf_delete_pages: #{e}"
234
+ end
235
+ ```
236
+
237
+ ### Parameters
238
+
239
+ Name | Type | Description | Notes
240
+ ------------- | ------------- | ------------- | -------------
241
+ **input_file** | **File**| Input file to perform the operation on. |
242
+ **page_start** | **Integer**| Page number (1 based) to start deleting pages from (inclusive). |
243
+ **page_end** | **Integer**| Page number (1 based) to stop deleting pages from (inclusive). |
244
+
245
+ ### Return type
246
+
247
+ **String**
248
+
249
+ ### Authorization
250
+
251
+ [Apikey](../README.md#Apikey)
252
+
253
+ ### HTTP request headers
254
+
255
+ - **Content-Type**: multipart/form-data
256
+ - **Accept**: application/octet-stream
257
+
258
+
259
+
260
+ # **edit_pdf_encrypt**
261
+ > String edit_pdf_encrypt(input_file, opts)
262
+
263
+ Encrypt and password-protect a PDF
264
+
265
+ Encrypt a PDF document with a password. Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF. Set the password fields null to omit the given password.
266
+
267
+ ### Example
268
+ ```ruby
269
+ # load the gem
270
+ require 'cloudmersive-convert-api-client'
271
+ # setup authorization
272
+ CloudmersiveConvertApiClient.configure do |config|
273
+ # Configure API key authorization: Apikey
274
+ config.api_key['Apikey'] = 'YOUR API KEY'
275
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
276
+ #config.api_key_prefix['Apikey'] = 'Bearer'
277
+ end
278
+
279
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
280
+
281
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
282
+
283
+ opts = {
284
+ user_password: 'user_password_example', # String | Password of a user (reader) of the PDF file
285
+ owner_password: 'owner_password_example', # String | Password of a owner (creator/editor) of the PDF file
286
+ encryption_key_length: 'encryption_key_length_example' # String | Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256.
287
+ }
288
+
289
+ begin
290
+ #Encrypt and password-protect a PDF
291
+ result = api_instance.edit_pdf_encrypt(input_file, opts)
292
+ p result
293
+ rescue CloudmersiveConvertApiClient::ApiError => e
294
+ puts "Exception when calling EditPdfApi->edit_pdf_encrypt: #{e}"
295
+ end
296
+ ```
297
+
298
+ ### Parameters
299
+
300
+ Name | Type | Description | Notes
301
+ ------------- | ------------- | ------------- | -------------
302
+ **input_file** | **File**| Input file to perform the operation on. |
303
+ **user_password** | **String**| Password of a user (reader) of the PDF file | [optional]
304
+ **owner_password** | **String**| Password of a owner (creator/editor) of the PDF file | [optional]
305
+ **encryption_key_length** | **String**| Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256. | [optional]
306
+
307
+ ### Return type
308
+
309
+ **String**
310
+
311
+ ### Authorization
312
+
313
+ [Apikey](../README.md#Apikey)
314
+
315
+ ### HTTP request headers
316
+
317
+ - **Content-Type**: multipart/form-data
318
+ - **Accept**: application/octet-stream
319
+
320
+
321
+
322
+ # **edit_pdf_get_annotations**
323
+ > GetPdfAnnotationsResult edit_pdf_get_annotations(input_file)
324
+
325
+ Get PDF annotations, including comments in the document
326
+
327
+ Enumerates the annotations, including comments and notes, in a PDF document.
328
+
329
+ ### Example
330
+ ```ruby
331
+ # load the gem
332
+ require 'cloudmersive-convert-api-client'
333
+ # setup authorization
334
+ CloudmersiveConvertApiClient.configure do |config|
335
+ # Configure API key authorization: Apikey
336
+ config.api_key['Apikey'] = 'YOUR API KEY'
337
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
338
+ #config.api_key_prefix['Apikey'] = 'Bearer'
339
+ end
340
+
341
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
342
+
343
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
344
+
345
+
346
+ begin
347
+ #Get PDF annotations, including comments in the document
348
+ result = api_instance.edit_pdf_get_annotations(input_file)
349
+ p result
350
+ rescue CloudmersiveConvertApiClient::ApiError => e
351
+ puts "Exception when calling EditPdfApi->edit_pdf_get_annotations: #{e}"
352
+ end
353
+ ```
354
+
355
+ ### Parameters
356
+
357
+ Name | Type | Description | Notes
358
+ ------------- | ------------- | ------------- | -------------
359
+ **input_file** | **File**| Input file to perform the operation on. |
360
+
361
+ ### Return type
362
+
363
+ [**GetPdfAnnotationsResult**](GetPdfAnnotationsResult.md)
364
+
365
+ ### Authorization
366
+
367
+ [Apikey](../README.md#Apikey)
368
+
369
+ ### HTTP request headers
370
+
371
+ - **Content-Type**: multipart/form-data
372
+ - **Accept**: application/octet-stream
373
+
374
+
375
+
376
+ # **edit_pdf_get_form_fields**
377
+ > PdfFormFields edit_pdf_get_form_fields(input_file)
378
+
379
+ Gets PDF Form fields and values
380
+
381
+ Encrypt a PDF document with a password. Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF. Set the password fields null to omit the given password.
382
+
383
+ ### Example
384
+ ```ruby
385
+ # load the gem
386
+ require 'cloudmersive-convert-api-client'
387
+ # setup authorization
388
+ CloudmersiveConvertApiClient.configure do |config|
389
+ # Configure API key authorization: Apikey
390
+ config.api_key['Apikey'] = 'YOUR API KEY'
391
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
392
+ #config.api_key_prefix['Apikey'] = 'Bearer'
393
+ end
394
+
395
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
396
+
397
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
398
+
399
+
400
+ begin
401
+ #Gets PDF Form fields and values
402
+ result = api_instance.edit_pdf_get_form_fields(input_file)
403
+ p result
404
+ rescue CloudmersiveConvertApiClient::ApiError => e
405
+ puts "Exception when calling EditPdfApi->edit_pdf_get_form_fields: #{e}"
406
+ end
407
+ ```
408
+
409
+ ### Parameters
410
+
411
+ Name | Type | Description | Notes
412
+ ------------- | ------------- | ------------- | -------------
413
+ **input_file** | **File**| Input file to perform the operation on. |
414
+
415
+ ### Return type
416
+
417
+ [**PdfFormFields**](PdfFormFields.md)
418
+
419
+ ### Authorization
420
+
421
+ [Apikey](../README.md#Apikey)
422
+
423
+ ### HTTP request headers
424
+
425
+ - **Content-Type**: multipart/form-data
426
+ - **Accept**: application/octet-stream
427
+
428
+
429
+
430
+ # **edit_pdf_get_metadata**
431
+ > PdfMetadata edit_pdf_get_metadata(input_file)
432
+
433
+ Get PDF document metadata
434
+
435
+ Returns the metadata from the PDF document, including Title, Author, etc.
436
+
437
+ ### Example
438
+ ```ruby
439
+ # load the gem
440
+ require 'cloudmersive-convert-api-client'
441
+ # setup authorization
442
+ CloudmersiveConvertApiClient.configure do |config|
443
+ # Configure API key authorization: Apikey
444
+ config.api_key['Apikey'] = 'YOUR API KEY'
445
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
446
+ #config.api_key_prefix['Apikey'] = 'Bearer'
447
+ end
448
+
449
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
450
+
451
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
452
+
453
+
454
+ begin
455
+ #Get PDF document metadata
456
+ result = api_instance.edit_pdf_get_metadata(input_file)
457
+ p result
458
+ rescue CloudmersiveConvertApiClient::ApiError => e
459
+ puts "Exception when calling EditPdfApi->edit_pdf_get_metadata: #{e}"
460
+ end
461
+ ```
462
+
463
+ ### Parameters
464
+
465
+ Name | Type | Description | Notes
466
+ ------------- | ------------- | ------------- | -------------
467
+ **input_file** | **File**| Input file to perform the operation on. |
468
+
469
+ ### Return type
470
+
471
+ [**PdfMetadata**](PdfMetadata.md)
472
+
473
+ ### Authorization
474
+
475
+ [Apikey](../README.md#Apikey)
476
+
477
+ ### HTTP request headers
478
+
479
+ - **Content-Type**: multipart/form-data
480
+ - **Accept**: application/json, text/json, application/xml, text/xml
481
+
482
+
483
+
484
+ # **edit_pdf_get_pdf_text_by_pages**
485
+ > PdfTextByPageResult edit_pdf_get_pdf_text_by_pages(input_file, opts)
486
+
487
+ Get text in a PDF document by page
488
+
489
+ Gets the text in a PDF by page
490
+
491
+ ### Example
492
+ ```ruby
493
+ # load the gem
494
+ require 'cloudmersive-convert-api-client'
495
+ # setup authorization
496
+ CloudmersiveConvertApiClient.configure do |config|
497
+ # Configure API key authorization: Apikey
498
+ config.api_key['Apikey'] = 'YOUR API KEY'
499
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
500
+ #config.api_key_prefix['Apikey'] = 'Bearer'
501
+ end
502
+
503
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
504
+
505
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
506
+
507
+ opts = {
508
+ text_formatting_mode: 'text_formatting_mode_example' # String | Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'.
509
+ }
510
+
511
+ begin
512
+ #Get text in a PDF document by page
513
+ result = api_instance.edit_pdf_get_pdf_text_by_pages(input_file, opts)
514
+ p result
515
+ rescue CloudmersiveConvertApiClient::ApiError => e
516
+ puts "Exception when calling EditPdfApi->edit_pdf_get_pdf_text_by_pages: #{e}"
517
+ end
518
+ ```
519
+
520
+ ### Parameters
521
+
522
+ Name | Type | Description | Notes
523
+ ------------- | ------------- | ------------- | -------------
524
+ **input_file** | **File**| Input file to perform the operation on. |
525
+ **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'. | [optional]
526
+
527
+ ### Return type
528
+
529
+ [**PdfTextByPageResult**](PdfTextByPageResult.md)
530
+
531
+ ### Authorization
532
+
533
+ [Apikey](../README.md#Apikey)
534
+
535
+ ### HTTP request headers
536
+
537
+ - **Content-Type**: multipart/form-data
538
+ - **Accept**: application/json, text/json, application/xml, text/xml
539
+
540
+
541
+
542
+ # **edit_pdf_insert_pages**
543
+ > String edit_pdf_insert_pages(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation)
544
+
545
+ Insert, copy pages from one PDF document into another
546
+
547
+ Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document).
548
+
549
+ ### Example
550
+ ```ruby
551
+ # load the gem
552
+ require 'cloudmersive-convert-api-client'
553
+ # setup authorization
554
+ CloudmersiveConvertApiClient.configure do |config|
555
+ # Configure API key authorization: Apikey
556
+ config.api_key['Apikey'] = 'YOUR API KEY'
557
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
558
+ #config.api_key_prefix['Apikey'] = 'Bearer'
559
+ end
560
+
561
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
562
+
563
+ source_file = File.new('/path/to/file.txt') # File | Source PDF file to copy pages from.
564
+
565
+ destination_file = File.new('/path/to/file.txt') # File | Destination PDF file to copy pages into.
566
+
567
+ page_start_source = 56 # Integer | Page number (1 based) to start copying pages from (inclusive) in the Source file.
568
+
569
+ page_end_source = 56 # Integer | Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
570
+
571
+ page_insert_before_desitnation = 56 # Integer | Page number (1 based) to insert the pages before in the Destination file.
572
+
573
+
574
+ begin
575
+ #Insert, copy pages from one PDF document into another
576
+ result = api_instance.edit_pdf_insert_pages(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation)
577
+ p result
578
+ rescue CloudmersiveConvertApiClient::ApiError => e
579
+ puts "Exception when calling EditPdfApi->edit_pdf_insert_pages: #{e}"
580
+ end
581
+ ```
582
+
583
+ ### Parameters
584
+
585
+ Name | Type | Description | Notes
586
+ ------------- | ------------- | ------------- | -------------
587
+ **source_file** | **File**| Source PDF file to copy pages from. |
588
+ **destination_file** | **File**| Destination PDF file to copy pages into. |
589
+ **page_start_source** | **Integer**| Page number (1 based) to start copying pages from (inclusive) in the Source file. |
590
+ **page_end_source** | **Integer**| Page number (1 based) to stop copying pages pages from (inclusive) in the Source file. |
591
+ **page_insert_before_desitnation** | **Integer**| Page number (1 based) to insert the pages before in the Destination file. |
592
+
593
+ ### Return type
594
+
595
+ **String**
596
+
597
+ ### Authorization
598
+
599
+ [Apikey](../README.md#Apikey)
600
+
601
+ ### HTTP request headers
602
+
603
+ - **Content-Type**: multipart/form-data
604
+ - **Accept**: application/octet-stream
605
+
606
+
607
+
608
+ # **edit_pdf_linearize**
609
+ > String edit_pdf_linearize(input_file)
610
+
611
+ Linearize and optimize a PDF for streaming download
612
+
613
+ Linearizes the content of a PDF to optimize it for streaming download, particularly over web streaming.
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::EditPdfApi.new
628
+
629
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
630
+
631
+
632
+ begin
633
+ #Linearize and optimize a PDF for streaming download
634
+ result = api_instance.edit_pdf_linearize(input_file)
635
+ p result
636
+ rescue CloudmersiveConvertApiClient::ApiError => e
637
+ puts "Exception when calling EditPdfApi->edit_pdf_linearize: #{e}"
638
+ end
639
+ ```
640
+
641
+ ### Parameters
642
+
643
+ Name | Type | Description | Notes
644
+ ------------- | ------------- | ------------- | -------------
645
+ **input_file** | **File**| Input file to perform the operation on. |
646
+
647
+ ### Return type
648
+
649
+ **String**
650
+
651
+ ### Authorization
652
+
653
+ [Apikey](../README.md#Apikey)
654
+
655
+ ### HTTP request headers
656
+
657
+ - **Content-Type**: multipart/form-data
658
+ - **Accept**: application/octet-stream
659
+
660
+
661
+
662
+ # **edit_pdf_rasterize**
663
+ > String edit_pdf_rasterize(input_file)
664
+
665
+ Rasterize a PDF to an image-based PDF
666
+
667
+ Rasterize a PDF into an image-based PDF. The output is a PDF where each page is comprised of a high-resolution image, with all text, figures and other components removed.
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::EditPdfApi.new
682
+
683
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
684
+
685
+
686
+ begin
687
+ #Rasterize a PDF to an image-based PDF
688
+ result = api_instance.edit_pdf_rasterize(input_file)
689
+ p result
690
+ rescue CloudmersiveConvertApiClient::ApiError => e
691
+ puts "Exception when calling EditPdfApi->edit_pdf_rasterize: #{e}"
692
+ end
693
+ ```
694
+
695
+ ### Parameters
696
+
697
+ Name | Type | Description | Notes
698
+ ------------- | ------------- | ------------- | -------------
699
+ **input_file** | **File**| Input file to perform the operation on. |
700
+
701
+ ### Return type
702
+
703
+ **String**
704
+
705
+ ### Authorization
706
+
707
+ [Apikey](../README.md#Apikey)
708
+
709
+ ### HTTP request headers
710
+
711
+ - **Content-Type**: multipart/form-data
712
+ - **Accept**: application/octet-stream
713
+
714
+
715
+
716
+ # **edit_pdf_reduce_file_size**
717
+ > String edit_pdf_reduce_file_size(input_file)
718
+
719
+ Reduce the file size and optimize a PDF
720
+
721
+ Reduces the file size and optimizes the content of a PDF to minimize its file size.
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::EditPdfApi.new
736
+
737
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
738
+
739
+
740
+ begin
741
+ #Reduce the file size and optimize a PDF
742
+ result = api_instance.edit_pdf_reduce_file_size(input_file)
743
+ p result
744
+ rescue CloudmersiveConvertApiClient::ApiError => e
745
+ puts "Exception when calling EditPdfApi->edit_pdf_reduce_file_size: #{e}"
746
+ end
747
+ ```
748
+
749
+ ### Parameters
750
+
751
+ Name | Type | Description | Notes
752
+ ------------- | ------------- | ------------- | -------------
753
+ **input_file** | **File**| Input file to perform the operation on. |
754
+
755
+ ### Return type
756
+
757
+ **String**
758
+
759
+ ### Authorization
760
+
761
+ [Apikey](../README.md#Apikey)
762
+
763
+ ### HTTP request headers
764
+
765
+ - **Content-Type**: multipart/form-data
766
+ - **Accept**: application/octet-stream
767
+
768
+
769
+
770
+ # **edit_pdf_remove_all_annotations**
771
+ > String edit_pdf_remove_all_annotations(input_file)
772
+
773
+ Remove all PDF annotations, including comments in the document
774
+
775
+ Removes all of the annotations, including comments and notes, in a PDF document.
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::EditPdfApi.new
790
+
791
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
792
+
793
+
794
+ begin
795
+ #Remove all PDF annotations, including comments in the document
796
+ result = api_instance.edit_pdf_remove_all_annotations(input_file)
797
+ p result
798
+ rescue CloudmersiveConvertApiClient::ApiError => e
799
+ puts "Exception when calling EditPdfApi->edit_pdf_remove_all_annotations: #{e}"
800
+ end
801
+ ```
802
+
803
+ ### Parameters
804
+
805
+ Name | Type | Description | Notes
806
+ ------------- | ------------- | ------------- | -------------
807
+ **input_file** | **File**| Input file to perform the operation on. |
808
+
809
+ ### Return type
810
+
811
+ **String**
812
+
813
+ ### Authorization
814
+
815
+ [Apikey](../README.md#Apikey)
816
+
817
+ ### HTTP request headers
818
+
819
+ - **Content-Type**: multipart/form-data
820
+ - **Accept**: application/octet-stream
821
+
822
+
823
+
824
+ # **edit_pdf_remove_annotation_item**
825
+ > String edit_pdf_remove_annotation_item(input_file, annotation_index)
826
+
827
+ Remove a specific PDF annotation, comment in the document
828
+
829
+ Removes a specific annotation in a PDF document, using the AnnotationIndex. To enumerate AnnotationIndex for all of the annotations in the PDF document, use the /edit/pdf/annotations/list API.
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::EditPdfApi.new
844
+
845
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
846
+
847
+ annotation_index = 56 # Integer | The 0-based index of the annotation in the document
848
+
849
+
850
+ begin
851
+ #Remove a specific PDF annotation, comment in the document
852
+ result = api_instance.edit_pdf_remove_annotation_item(input_file, annotation_index)
853
+ p result
854
+ rescue CloudmersiveConvertApiClient::ApiError => e
855
+ puts "Exception when calling EditPdfApi->edit_pdf_remove_annotation_item: #{e}"
856
+ end
857
+ ```
858
+
859
+ ### Parameters
860
+
861
+ Name | Type | Description | Notes
862
+ ------------- | ------------- | ------------- | -------------
863
+ **input_file** | **File**| Input file to perform the operation on. |
864
+ **annotation_index** | **Integer**| The 0-based index of the annotation in the document |
865
+
866
+ ### Return type
867
+
868
+ **String**
869
+
870
+ ### Authorization
871
+
872
+ [Apikey](../README.md#Apikey)
873
+
874
+ ### HTTP request headers
875
+
876
+ - **Content-Type**: multipart/form-data
877
+ - **Accept**: application/octet-stream
878
+
879
+
880
+
881
+ # **edit_pdf_resize**
882
+ > String edit_pdf_resize(input_file, paper_size)
883
+
884
+ Change PDF Document's Paper Size
885
+
886
+ Resizes a PDF document's paper size.
887
+
888
+ ### Example
889
+ ```ruby
890
+ # load the gem
891
+ require 'cloudmersive-convert-api-client'
892
+ # setup authorization
893
+ CloudmersiveConvertApiClient.configure do |config|
894
+ # Configure API key authorization: Apikey
895
+ config.api_key['Apikey'] = 'YOUR API KEY'
896
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
897
+ #config.api_key_prefix['Apikey'] = 'Bearer'
898
+ end
899
+
900
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
901
+
902
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
903
+
904
+ paper_size = 'paper_size_example' # String | The desired paper size for the resized PDF document. Size ranges from A7 (smallest) to A0 (largest).
905
+
906
+
907
+ begin
908
+ #Change PDF Document's Paper Size
909
+ result = api_instance.edit_pdf_resize(input_file, paper_size)
910
+ p result
911
+ rescue CloudmersiveConvertApiClient::ApiError => e
912
+ puts "Exception when calling EditPdfApi->edit_pdf_resize: #{e}"
913
+ end
914
+ ```
915
+
916
+ ### Parameters
917
+
918
+ Name | Type | Description | Notes
919
+ ------------- | ------------- | ------------- | -------------
920
+ **input_file** | **File**| Input file to perform the operation on. |
921
+ **paper_size** | **String**| The desired paper size for the resized PDF document. Size ranges from A7 (smallest) to A0 (largest). |
922
+
923
+ ### Return type
924
+
925
+ **String**
926
+
927
+ ### Authorization
928
+
929
+ [Apikey](../README.md#Apikey)
930
+
931
+ ### HTTP request headers
932
+
933
+ - **Content-Type**: multipart/form-data
934
+ - **Accept**: application/octet-stream
935
+
936
+
937
+
938
+ # **edit_pdf_rotate_all_pages**
939
+ > String edit_pdf_rotate_all_pages(input_file, rotation_angle)
940
+
941
+ Rotate all pages in a PDF document
942
+
943
+ Rotate all of the pages in a PDF document by a multiple of 90 degrees
944
+
945
+ ### Example
946
+ ```ruby
947
+ # load the gem
948
+ require 'cloudmersive-convert-api-client'
949
+ # setup authorization
950
+ CloudmersiveConvertApiClient.configure do |config|
951
+ # Configure API key authorization: Apikey
952
+ config.api_key['Apikey'] = 'YOUR API KEY'
953
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
954
+ #config.api_key_prefix['Apikey'] = 'Bearer'
955
+ end
956
+
957
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
958
+
959
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
960
+
961
+ rotation_angle = 56 # Integer | The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc.
962
+
963
+
964
+ begin
965
+ #Rotate all pages in a PDF document
966
+ result = api_instance.edit_pdf_rotate_all_pages(input_file, rotation_angle)
967
+ p result
968
+ rescue CloudmersiveConvertApiClient::ApiError => e
969
+ puts "Exception when calling EditPdfApi->edit_pdf_rotate_all_pages: #{e}"
970
+ end
971
+ ```
972
+
973
+ ### Parameters
974
+
975
+ Name | Type | Description | Notes
976
+ ------------- | ------------- | ------------- | -------------
977
+ **input_file** | **File**| Input file to perform the operation on. |
978
+ **rotation_angle** | **Integer**| The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc. |
979
+
980
+ ### Return type
981
+
982
+ **String**
983
+
984
+ ### Authorization
985
+
986
+ [Apikey](../README.md#Apikey)
987
+
988
+ ### HTTP request headers
989
+
990
+ - **Content-Type**: multipart/form-data
991
+ - **Accept**: application/octet-stream
992
+
993
+
994
+
995
+ # **edit_pdf_rotate_page_range**
996
+ > String edit_pdf_rotate_page_range(input_file, rotation_angle, page_start, page_end)
997
+
998
+ Rotate a range, subset of pages in a PDF document
999
+
1000
+ Rotate a range of specific pages in a PDF document by a multiple of 90 degrees
1001
+
1002
+ ### Example
1003
+ ```ruby
1004
+ # load the gem
1005
+ require 'cloudmersive-convert-api-client'
1006
+ # setup authorization
1007
+ CloudmersiveConvertApiClient.configure do |config|
1008
+ # Configure API key authorization: Apikey
1009
+ config.api_key['Apikey'] = 'YOUR API KEY'
1010
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1011
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1012
+ end
1013
+
1014
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
1015
+
1016
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1017
+
1018
+ rotation_angle = 56 # Integer | The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc.
1019
+
1020
+ page_start = 56 # Integer | Page number (1 based) to start rotating pages from (inclusive).
1021
+
1022
+ page_end = 56 # Integer | Page number (1 based) to stop rotating pages from (inclusive).
1023
+
1024
+
1025
+ begin
1026
+ #Rotate a range, subset of pages in a PDF document
1027
+ result = api_instance.edit_pdf_rotate_page_range(input_file, rotation_angle, page_start, page_end)
1028
+ p result
1029
+ rescue CloudmersiveConvertApiClient::ApiError => e
1030
+ puts "Exception when calling EditPdfApi->edit_pdf_rotate_page_range: #{e}"
1031
+ end
1032
+ ```
1033
+
1034
+ ### Parameters
1035
+
1036
+ Name | Type | Description | Notes
1037
+ ------------- | ------------- | ------------- | -------------
1038
+ **input_file** | **File**| Input file to perform the operation on. |
1039
+ **rotation_angle** | **Integer**| The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc. |
1040
+ **page_start** | **Integer**| Page number (1 based) to start rotating pages from (inclusive). |
1041
+ **page_end** | **Integer**| Page number (1 based) to stop rotating pages from (inclusive). |
1042
+
1043
+ ### Return type
1044
+
1045
+ **String**
1046
+
1047
+ ### Authorization
1048
+
1049
+ [Apikey](../README.md#Apikey)
1050
+
1051
+ ### HTTP request headers
1052
+
1053
+ - **Content-Type**: multipart/form-data
1054
+ - **Accept**: application/octet-stream
1055
+
1056
+
1057
+
1058
+ # **edit_pdf_set_form_fields**
1059
+ > String edit_pdf_set_form_fields(field_values)
1060
+
1061
+ Sets ands fills PDF Form field values
1062
+
1063
+ Fill in the form fields in a PDF form with specific values. Use form/get-fields to enumerate the available fields and their data types in an input form.
1064
+
1065
+ ### Example
1066
+ ```ruby
1067
+ # load the gem
1068
+ require 'cloudmersive-convert-api-client'
1069
+ # setup authorization
1070
+ CloudmersiveConvertApiClient.configure do |config|
1071
+ # Configure API key authorization: Apikey
1072
+ config.api_key['Apikey'] = 'YOUR API KEY'
1073
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1074
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1075
+ end
1076
+
1077
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
1078
+
1079
+ field_values = CloudmersiveConvertApiClient::SetPdfFormFieldsRequest.new # SetPdfFormFieldsRequest |
1080
+
1081
+
1082
+ begin
1083
+ #Sets ands fills PDF Form field values
1084
+ result = api_instance.edit_pdf_set_form_fields(field_values)
1085
+ p result
1086
+ rescue CloudmersiveConvertApiClient::ApiError => e
1087
+ puts "Exception when calling EditPdfApi->edit_pdf_set_form_fields: #{e}"
1088
+ end
1089
+ ```
1090
+
1091
+ ### Parameters
1092
+
1093
+ Name | Type | Description | Notes
1094
+ ------------- | ------------- | ------------- | -------------
1095
+ **field_values** | [**SetPdfFormFieldsRequest**](SetPdfFormFieldsRequest.md)| |
1096
+
1097
+ ### Return type
1098
+
1099
+ **String**
1100
+
1101
+ ### Authorization
1102
+
1103
+ [Apikey](../README.md#Apikey)
1104
+
1105
+ ### HTTP request headers
1106
+
1107
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1108
+ - **Accept**: application/octet-stream
1109
+
1110
+
1111
+
1112
+ # **edit_pdf_set_metadata**
1113
+ > String edit_pdf_set_metadata(request)
1114
+
1115
+ Sets PDF document metadata
1116
+
1117
+ Sets (writes) metadata into the input PDF document, including Title, Author, etc.
1118
+
1119
+ ### Example
1120
+ ```ruby
1121
+ # load the gem
1122
+ require 'cloudmersive-convert-api-client'
1123
+ # setup authorization
1124
+ CloudmersiveConvertApiClient.configure do |config|
1125
+ # Configure API key authorization: Apikey
1126
+ config.api_key['Apikey'] = 'YOUR API KEY'
1127
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1128
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1129
+ end
1130
+
1131
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
1132
+
1133
+ request = CloudmersiveConvertApiClient::SetPdfMetadataRequest.new # SetPdfMetadataRequest |
1134
+
1135
+
1136
+ begin
1137
+ #Sets PDF document metadata
1138
+ result = api_instance.edit_pdf_set_metadata(request)
1139
+ p result
1140
+ rescue CloudmersiveConvertApiClient::ApiError => e
1141
+ puts "Exception when calling EditPdfApi->edit_pdf_set_metadata: #{e}"
1142
+ end
1143
+ ```
1144
+
1145
+ ### Parameters
1146
+
1147
+ Name | Type | Description | Notes
1148
+ ------------- | ------------- | ------------- | -------------
1149
+ **request** | [**SetPdfMetadataRequest**](SetPdfMetadataRequest.md)| |
1150
+
1151
+ ### Return type
1152
+
1153
+ **String**
1154
+
1155
+ ### Authorization
1156
+
1157
+ [Apikey](../README.md#Apikey)
1158
+
1159
+ ### HTTP request headers
1160
+
1161
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
1162
+ - **Accept**: application/octet-stream
1163
+
1164
+
1165
+
1166
+ # **edit_pdf_set_permissions**
1167
+ > String edit_pdf_set_permissions(owner_password, user_password, input_file, opts)
1168
+
1169
+ Encrypt, password-protect and set restricted permissions on a PDF
1170
+
1171
+ Encrypt a PDF document with a password, and set permissions on the PDF. Set an owner password to control owner (editor/creator) permissions [required], and set a user (reader) password to control the viewer of the PDF [optional]. Set the reader password to null to omit the password. Restrict or allow printing, copying content, document assembly, editing (read-only), form filling, modification of annotations, and degraded printing through document Digital Rights Management (DRM).
1172
+
1173
+ ### Example
1174
+ ```ruby
1175
+ # load the gem
1176
+ require 'cloudmersive-convert-api-client'
1177
+ # setup authorization
1178
+ CloudmersiveConvertApiClient.configure do |config|
1179
+ # Configure API key authorization: Apikey
1180
+ config.api_key['Apikey'] = 'YOUR API KEY'
1181
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1182
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1183
+ end
1184
+
1185
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
1186
+
1187
+ owner_password = 'owner_password_example' # String | Password of a owner (creator/editor) of the PDF file (required)
1188
+
1189
+ user_password = 'user_password_example' # String | Password of a user (reader) of the PDF file (optional)
1190
+
1191
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1192
+
1193
+ opts = {
1194
+ encryption_key_length: 'encryption_key_length_example', # String | Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256.
1195
+ allow_printing: true, # BOOLEAN | Set to false to disable printing through DRM. Default is true.
1196
+ allow_document_assembly: true, # BOOLEAN | Set to false to disable document assembly through DRM. Default is true.
1197
+ allow_content_extraction: true, # BOOLEAN | Set to false to disable copying/extracting content out of the PDF through DRM. Default is true.
1198
+ allow_form_filling: true, # BOOLEAN | Set to false to disable filling out form fields in the PDF through DRM. Default is true.
1199
+ allow_editing: true, # BOOLEAN | Set to false to disable editing in the PDF through DRM (making the PDF read-only). Default is true.
1200
+ allow_annotations: true, # BOOLEAN | Set to false to disable annotations and editing of annotations in the PDF through DRM. Default is true.
1201
+ allow_degraded_printing: true # BOOLEAN | Set to false to disable degraded printing of the PDF through DRM. Default is true.
1202
+ }
1203
+
1204
+ begin
1205
+ #Encrypt, password-protect and set restricted permissions on a PDF
1206
+ result = api_instance.edit_pdf_set_permissions(owner_password, user_password, input_file, opts)
1207
+ p result
1208
+ rescue CloudmersiveConvertApiClient::ApiError => e
1209
+ puts "Exception when calling EditPdfApi->edit_pdf_set_permissions: #{e}"
1210
+ end
1211
+ ```
1212
+
1213
+ ### Parameters
1214
+
1215
+ Name | Type | Description | Notes
1216
+ ------------- | ------------- | ------------- | -------------
1217
+ **owner_password** | **String**| Password of a owner (creator/editor) of the PDF file (required) |
1218
+ **user_password** | **String**| Password of a user (reader) of the PDF file (optional) |
1219
+ **input_file** | **File**| Input file to perform the operation on. |
1220
+ **encryption_key_length** | **String**| Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256. | [optional]
1221
+ **allow_printing** | **BOOLEAN**| Set to false to disable printing through DRM. Default is true. | [optional]
1222
+ **allow_document_assembly** | **BOOLEAN**| Set to false to disable document assembly through DRM. Default is true. | [optional]
1223
+ **allow_content_extraction** | **BOOLEAN**| Set to false to disable copying/extracting content out of the PDF through DRM. Default is true. | [optional]
1224
+ **allow_form_filling** | **BOOLEAN**| Set to false to disable filling out form fields in the PDF through DRM. Default is true. | [optional]
1225
+ **allow_editing** | **BOOLEAN**| Set to false to disable editing in the PDF through DRM (making the PDF read-only). Default is true. | [optional]
1226
+ **allow_annotations** | **BOOLEAN**| Set to false to disable annotations and editing of annotations in the PDF through DRM. Default is true. | [optional]
1227
+ **allow_degraded_printing** | **BOOLEAN**| Set to false to disable degraded printing of the PDF through DRM. Default is true. | [optional]
1228
+
1229
+ ### Return type
1230
+
1231
+ **String**
1232
+
1233
+ ### Authorization
1234
+
1235
+ [Apikey](../README.md#Apikey)
1236
+
1237
+ ### HTTP request headers
1238
+
1239
+ - **Content-Type**: multipart/form-data
1240
+ - **Accept**: application/octet-stream
1241
+
1242
+
1243
+
1244
+ # **edit_pdf_watermark_text**
1245
+ > String edit_pdf_watermark_text(watermark_text, input_file, opts)
1246
+
1247
+ Add a text watermark to a PDF
1248
+
1249
+ Adds a text watermark to a PDF
1250
+
1251
+ ### Example
1252
+ ```ruby
1253
+ # load the gem
1254
+ require 'cloudmersive-convert-api-client'
1255
+ # setup authorization
1256
+ CloudmersiveConvertApiClient.configure do |config|
1257
+ # Configure API key authorization: Apikey
1258
+ config.api_key['Apikey'] = 'YOUR API KEY'
1259
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1260
+ #config.api_key_prefix['Apikey'] = 'Bearer'
1261
+ end
1262
+
1263
+ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
1264
+
1265
+ watermark_text = 'watermark_text_example' # String | Watermark text to add to the PDF (required)
1266
+
1267
+ input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
1268
+
1269
+ opts = {
1270
+ font_name: 'font_name_example', # String | Font Family Name for the watermark text; default is Times New Roman
1271
+ font_size: 8.14, # Float | Font Size in points of the text; default is 150
1272
+ font_color: 'font_color_example', # String | Font color in hexadecimal or HTML color name; default is Red
1273
+ font_transparency: 8.14 # Float | Font transparency between 0.0 (completely transparent) to 1.0 (fully opaque); default is 0.5
1274
+ }
1275
+
1276
+ begin
1277
+ #Add a text watermark to a PDF
1278
+ result = api_instance.edit_pdf_watermark_text(watermark_text, input_file, opts)
1279
+ p result
1280
+ rescue CloudmersiveConvertApiClient::ApiError => e
1281
+ puts "Exception when calling EditPdfApi->edit_pdf_watermark_text: #{e}"
1282
+ end
1283
+ ```
1284
+
1285
+ ### Parameters
1286
+
1287
+ Name | Type | Description | Notes
1288
+ ------------- | ------------- | ------------- | -------------
1289
+ **watermark_text** | **String**| Watermark text to add to the PDF (required) |
1290
+ **input_file** | **File**| Input file to perform the operation on. |
1291
+ **font_name** | **String**| Font Family Name for the watermark text; default is Times New Roman | [optional]
1292
+ **font_size** | **Float**| Font Size in points of the text; default is 150 | [optional]
1293
+ **font_color** | **String**| Font color in hexadecimal or HTML color name; default is Red | [optional]
1294
+ **font_transparency** | **Float**| Font transparency between 0.0 (completely transparent) to 1.0 (fully opaque); default is 0.5 | [optional]
1295
+
1296
+ ### Return type
1297
+
1298
+ **String**
1299
+
1300
+ ### Authorization
1301
+
1302
+ [Apikey](../README.md#Apikey)
1303
+
1304
+ ### HTTP request headers
1305
+
1306
+ - **Content-Type**: multipart/form-data
1307
+ - **Accept**: application/octet-stream
1308
+
1309
+
1310
+