cloudmersive-convert-api-client 2.0.5 → 2.1.1

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