cloudmersive-convert-api-client 2.0.2 → 2.0.7

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