cloudmersive-convert-api-client 2.0.3 → 2.0.8

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