aspose_pdf_cloud 20.7.0 → 21.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (415) hide show
  1. checksums.yaml +4 -4
  2. data/Examples/delete_annotation.rb +22 -0
  3. data/Examples/delete_document_annotations.rb +18 -0
  4. data/Examples/delete_page_annotations.rb +17 -0
  5. data/Examples/example_data/PdfWithAnnotations.pdf +0 -0
  6. data/Examples/get_carret_annotation.rb +20 -0
  7. data/Examples/get_circle_annotation.rb +21 -0
  8. data/Examples/get_circle_annotations.rb +17 -0
  9. data/Examples/get_document_annotations.rb +15 -0
  10. data/Examples/get_document_free_text_annotations.rb +17 -0
  11. data/Examples/get_document_highlight_annotations.rb +16 -0
  12. data/Examples/get_document_ink_annotations.rb +15 -0
  13. data/Examples/get_document_line_annotations.rb +16 -0
  14. data/Examples/get_document_movie_annotations.rb +16 -0
  15. data/Examples/get_document_polygon_annotations.rb +16 -0
  16. data/Examples/get_document_polyline_annotations.rb +17 -0
  17. data/Examples/get_document_popup_annotation_by_parent.rb +17 -0
  18. data/Examples/get_document_popup_annotations.rb +16 -0
  19. data/Examples/get_document_redaction_annotations.rb +16 -0
  20. data/Examples/get_document_screen_annotations.rb +17 -0
  21. data/Examples/get_document_sound_annotations.rb +18 -0
  22. data/Examples/get_document_squiggly_annotations.rb +18 -0
  23. data/Examples/get_document_stamp_annotations.rb +17 -0
  24. data/Examples/get_document_strike_out_annotation.rb +17 -0
  25. data/Examples/get_document_text_annotations.rb +17 -0
  26. data/Examples/get_document_underline_annotations.rb +17 -0
  27. data/Examples/get_documnet_carret_annotation.rb +17 -0
  28. data/Examples/get_file_attachment_annotation.rb +21 -0
  29. data/Examples/get_file_attachment_annotation_data.rb +21 -0
  30. data/Examples/get_file_attachment_annotations.rb +19 -0
  31. data/Examples/get_free_text_annotation.rb +20 -0
  32. data/Examples/get_hightlight_annotations.rb +20 -0
  33. data/Examples/get_ink_annotation.rb +21 -0
  34. data/Examples/get_line_annotation.rb +20 -0
  35. data/Examples/get_movie_annotation.rb +20 -0
  36. data/Examples/get_page_annotations.rb +19 -0
  37. data/Examples/get_page_carret_annotations.rb +17 -0
  38. data/Examples/get_page_file_attachment_annotations.rb +19 -0
  39. data/Examples/get_page_free_text_annotations.rb +18 -0
  40. data/Examples/get_page_highlight_annotations.rb +18 -0
  41. data/Examples/get_page_ink_annotations.rb +17 -0
  42. data/Examples/get_page_line_annotations.rb +17 -0
  43. data/Examples/get_page_movie_annotations.rb +18 -0
  44. data/Examples/get_page_polygon_annotations.rb +18 -0
  45. data/Examples/get_page_polyline_annotations.rb +21 -0
  46. data/Examples/get_page_redaction_annotations.rb +17 -0
  47. data/Examples/get_page_screen_annotations.rb +19 -0
  48. data/Examples/get_page_sound_annotations.rb +20 -0
  49. data/Examples/get_page_square_annotations.rb +18 -0
  50. data/Examples/get_page_squiggly_annotations.rb +17 -0
  51. data/Examples/get_page_stamp_annotations.rb +17 -0
  52. data/Examples/get_page_strikeout_annotations.rb +17 -0
  53. data/Examples/get_page_text_annotations.rb +17 -0
  54. data/Examples/get_page_underline_annotations.rb +17 -0
  55. data/Examples/get_polygon_annotation.rb +20 -0
  56. data/Examples/get_polyline_annotation.rb +22 -0
  57. data/Examples/get_redaction_annotation.rb +19 -0
  58. data/Examples/get_screen_annotation.rb +22 -0
  59. data/Examples/get_screen_annotation_data.rb +19 -0
  60. data/Examples/get_screen_annotations.rb +21 -0
  61. data/Examples/get_sound_annotation.rb +25 -0
  62. data/Examples/get_sound_annotation_data.rb +19 -0
  63. data/Examples/get_square_annotation.rb +19 -0
  64. data/Examples/get_squiggly_annotation.rb +19 -0
  65. data/Examples/get_stamp_annotation.rb +20 -0
  66. data/Examples/get_stamp_annotation_data.rb +20 -0
  67. data/Examples/get_strike_out_annotation.rb +19 -0
  68. data/Examples/get_text_annotation.rb +19 -0
  69. data/Examples/get_underline_annotation.rb +19 -0
  70. data/Examples/post_page_carret_annotations.rb +28 -0
  71. data/Examples/post_page_circle_annotations.rb +27 -0
  72. data/Examples/post_page_file_attachnment_annotations.rb +38 -0
  73. data/Examples/post_page_free_text_annotations.rb +35 -0
  74. data/Examples/post_page_hightlight_annotations.rb +32 -0
  75. data/Examples/post_page_ink_annotations.rb +39 -0
  76. data/Examples/post_page_line_annotations.rb +28 -0
  77. data/Examples/post_page_movie_annotations.rb +30 -0
  78. data/Examples/post_page_polygon_annotations.rb +33 -0
  79. data/Examples/post_page_polyline_annotations.rb +35 -0
  80. data/Examples/post_page_redaction_annotations.rb +28 -0
  81. data/Examples/post_page_screen_annotations.rb +31 -0
  82. data/Examples/post_page_sound_annotations.rb +35 -0
  83. data/Examples/post_page_square_annotations.rb +27 -0
  84. data/Examples/post_page_squiggly_annotations.rb +33 -0
  85. data/Examples/post_page_stamp_annotations.rb +34 -0
  86. data/Examples/post_page_strike_out_annotation.rb +33 -0
  87. data/Examples/post_page_text_annotations.rb +26 -0
  88. data/Examples/post_page_underline_annotations.rb +33 -0
  89. data/Examples/post_popup_annotation.rb +25 -0
  90. data/Examples/put_annotations_flatten.rb +20 -0
  91. data/Examples/put_carret_annotation.rb +30 -0
  92. data/Examples/put_circle_annotation.rb +29 -0
  93. data/Examples/put_file_attachment_annotation.rb +38 -0
  94. data/Examples/put_file_attachment_annotion_data_extract.rb +21 -0
  95. data/Examples/put_free_text_annotation.rb +38 -0
  96. data/Examples/put_highlight_annotation.rb +34 -0
  97. data/Examples/put_ink_annotation.rb +41 -0
  98. data/Examples/put_line_annotation.rb +30 -0
  99. data/Examples/put_movie_annotation.rb +31 -0
  100. data/Examples/put_polygon_annotation.rb +35 -0
  101. data/Examples/put_polyline_annotation.rb +36 -0
  102. data/Examples/put_redaction_annotation.rb +31 -0
  103. data/Examples/put_screen_annotation.rb +33 -0
  104. data/Examples/put_screen_annotation_data_extract.rb +19 -0
  105. data/Examples/put_sound_annotation.rb +42 -0
  106. data/Examples/put_sound_annotation_data_extract.rb +20 -0
  107. data/Examples/put_square_annotation.rb +28 -0
  108. data/Examples/put_squiggly_annotation.rb +35 -0
  109. data/Examples/put_stamp_annotation.rb +35 -0
  110. data/Examples/put_strike_out_annotation.rb +35 -0
  111. data/Examples/put_text_annotation.rb +29 -0
  112. data/Examples/put_underline_annotation.rb +35 -0
  113. data/README.md +71 -51
  114. data/aspose_pdf_cloud.gemspec +53 -53
  115. data/docs/Paragraph.md +2 -2
  116. data/docs/PdfApi.md +8 -102
  117. data/docs/RedactionAnnotation.md +1 -1
  118. data/docs/SignatureCustomAppearance.md +1 -1
  119. data/docs/TextReplace.md +1 -1
  120. data/docs/TextState.md +2 -1
  121. data/docs/TextStyle.md +1 -0
  122. data/lib/aspose_pdf_cloud/api/pdf_api.rb +29142 -29421
  123. data/lib/aspose_pdf_cloud/api_client.rb +1 -1
  124. data/lib/aspose_pdf_cloud/api_error.rb +47 -47
  125. data/lib/aspose_pdf_cloud/configuration.rb +172 -172
  126. data/lib/aspose_pdf_cloud/models/annotation.rb +318 -318
  127. data/lib/aspose_pdf_cloud/models/annotation_flags.rb +53 -53
  128. data/lib/aspose_pdf_cloud/models/annotation_info.rb +333 -333
  129. data/lib/aspose_pdf_cloud/models/annotation_state.rb +50 -50
  130. data/lib/aspose_pdf_cloud/models/annotation_type.rb +70 -70
  131. data/lib/aspose_pdf_cloud/models/annotations_info.rb +213 -213
  132. data/lib/aspose_pdf_cloud/models/annotations_info_response.rb +224 -224
  133. data/lib/aspose_pdf_cloud/models/antialiasing_processing_type.rb +44 -44
  134. data/lib/aspose_pdf_cloud/models/aspose_response.rb +214 -214
  135. data/lib/aspose_pdf_cloud/models/attachment.rb +276 -276
  136. data/lib/aspose_pdf_cloud/models/attachment_response.rb +224 -224
  137. data/lib/aspose_pdf_cloud/models/attachments.rb +213 -213
  138. data/lib/aspose_pdf_cloud/models/attachments_response.rb +224 -224
  139. data/lib/aspose_pdf_cloud/models/bookmark.rb +361 -361
  140. data/lib/aspose_pdf_cloud/models/bookmark_response.rb +224 -224
  141. data/lib/aspose_pdf_cloud/models/bookmarks.rb +213 -213
  142. data/lib/aspose_pdf_cloud/models/bookmarks_response.rb +224 -224
  143. data/lib/aspose_pdf_cloud/models/border.rb +249 -249
  144. data/lib/aspose_pdf_cloud/models/border_corner_style.rb +44 -44
  145. data/lib/aspose_pdf_cloud/models/border_effect.rb +44 -44
  146. data/lib/aspose_pdf_cloud/models/border_info.rb +239 -239
  147. data/lib/aspose_pdf_cloud/models/border_style.rb +47 -47
  148. data/lib/aspose_pdf_cloud/models/box_style.rb +48 -48
  149. data/lib/aspose_pdf_cloud/models/cap_style.rb +44 -44
  150. data/lib/aspose_pdf_cloud/models/caption_position.rb +44 -44
  151. data/lib/aspose_pdf_cloud/models/caret_annotation.rb +378 -378
  152. data/lib/aspose_pdf_cloud/models/caret_annotation_response.rb +224 -224
  153. data/lib/aspose_pdf_cloud/models/caret_annotations.rb +213 -213
  154. data/lib/aspose_pdf_cloud/models/caret_annotations_response.rb +224 -224
  155. data/lib/aspose_pdf_cloud/models/caret_symbol.rb +44 -44
  156. data/lib/aspose_pdf_cloud/models/cell.rb +353 -353
  157. data/lib/aspose_pdf_cloud/models/cell_recognized.rb +209 -209
  158. data/lib/aspose_pdf_cloud/models/check_box_field.rb +455 -455
  159. data/lib/aspose_pdf_cloud/models/check_box_field_response.rb +224 -224
  160. data/lib/aspose_pdf_cloud/models/check_box_fields.rb +213 -213
  161. data/lib/aspose_pdf_cloud/models/check_box_fields_response.rb +224 -224
  162. data/lib/aspose_pdf_cloud/models/choice_field.rb +418 -418
  163. data/lib/aspose_pdf_cloud/models/circle_annotation.rb +378 -378
  164. data/lib/aspose_pdf_cloud/models/circle_annotation_response.rb +224 -224
  165. data/lib/aspose_pdf_cloud/models/circle_annotations.rb +213 -213
  166. data/lib/aspose_pdf_cloud/models/circle_annotations_response.rb +224 -224
  167. data/lib/aspose_pdf_cloud/models/color.rb +249 -249
  168. data/lib/aspose_pdf_cloud/models/color_depth.rb +46 -46
  169. data/lib/aspose_pdf_cloud/models/column_adjustment.rb +45 -45
  170. data/lib/aspose_pdf_cloud/models/combo_box_field.rb +460 -460
  171. data/lib/aspose_pdf_cloud/models/combo_box_field_response.rb +224 -224
  172. data/lib/aspose_pdf_cloud/models/combo_box_fields.rb +213 -213
  173. data/lib/aspose_pdf_cloud/models/combo_box_fields_response.rb +224 -224
  174. data/lib/aspose_pdf_cloud/models/common_figure_annotation.rb +378 -378
  175. data/lib/aspose_pdf_cloud/models/compression_type.rb +47 -47
  176. data/lib/aspose_pdf_cloud/models/crypto_algorithm.rb +46 -46
  177. data/lib/aspose_pdf_cloud/models/dash.rb +219 -219
  178. data/lib/aspose_pdf_cloud/models/default_page_config.rb +209 -209
  179. data/lib/aspose_pdf_cloud/models/direction.rb +44 -44
  180. data/lib/aspose_pdf_cloud/models/disc_usage.rb +219 -219
  181. data/lib/aspose_pdf_cloud/models/display_properties.rb +291 -291
  182. data/lib/aspose_pdf_cloud/models/display_properties_response.rb +224 -224
  183. data/lib/aspose_pdf_cloud/models/doc_format.rb +44 -44
  184. data/lib/aspose_pdf_cloud/models/doc_mdp_access_permission_type.rb +45 -45
  185. data/lib/aspose_pdf_cloud/models/doc_recognition_mode.rb +44 -44
  186. data/lib/aspose_pdf_cloud/models/document.rb +231 -231
  187. data/lib/aspose_pdf_cloud/models/document_config.rb +234 -234
  188. data/lib/aspose_pdf_cloud/models/document_page_response.rb +224 -224
  189. data/lib/aspose_pdf_cloud/models/document_pages_response.rb +224 -224
  190. data/lib/aspose_pdf_cloud/models/document_privilege.rb +299 -299
  191. data/lib/aspose_pdf_cloud/models/document_properties.rb +213 -213
  192. data/lib/aspose_pdf_cloud/models/document_properties_response.rb +224 -224
  193. data/lib/aspose_pdf_cloud/models/document_property.rb +236 -236
  194. data/lib/aspose_pdf_cloud/models/document_property_response.rb +224 -224
  195. data/lib/aspose_pdf_cloud/models/document_response.rb +236 -236
  196. data/lib/aspose_pdf_cloud/models/epub_recognition_mode.rb +45 -45
  197. data/lib/aspose_pdf_cloud/models/error.rb +229 -229
  198. data/lib/aspose_pdf_cloud/models/error_details.rb +214 -214
  199. data/lib/aspose_pdf_cloud/models/field.rb +260 -260
  200. data/lib/aspose_pdf_cloud/models/field_response.rb +224 -224
  201. data/lib/aspose_pdf_cloud/models/field_type.rb +46 -46
  202. data/lib/aspose_pdf_cloud/models/fields.rb +218 -218
  203. data/lib/aspose_pdf_cloud/models/fields_response.rb +224 -224
  204. data/lib/aspose_pdf_cloud/models/file_attachment_annotation.rb +408 -408
  205. data/lib/aspose_pdf_cloud/models/file_attachment_annotation_response.rb +224 -224
  206. data/lib/aspose_pdf_cloud/models/file_attachment_annotations.rb +213 -213
  207. data/lib/aspose_pdf_cloud/models/file_attachment_annotations_response.rb +224 -224
  208. data/lib/aspose_pdf_cloud/models/file_icon.rb +46 -46
  209. data/lib/aspose_pdf_cloud/models/file_version.rb +274 -274
  210. data/lib/aspose_pdf_cloud/models/file_versions.rb +201 -201
  211. data/lib/aspose_pdf_cloud/models/files_list.rb +201 -201
  212. data/lib/aspose_pdf_cloud/models/files_upload_result.rb +213 -213
  213. data/lib/aspose_pdf_cloud/models/font_encoding_rules.rb +44 -44
  214. data/lib/aspose_pdf_cloud/models/font_saving_modes.rb +46 -46
  215. data/lib/aspose_pdf_cloud/models/font_styles.rb +46 -46
  216. data/lib/aspose_pdf_cloud/models/form_field.rb +398 -398
  217. data/lib/aspose_pdf_cloud/models/free_text_annotation.rb +403 -403
  218. data/lib/aspose_pdf_cloud/models/free_text_annotation_response.rb +224 -224
  219. data/lib/aspose_pdf_cloud/models/free_text_annotations.rb +213 -213
  220. data/lib/aspose_pdf_cloud/models/free_text_annotations_response.rb +224 -224
  221. data/lib/aspose_pdf_cloud/models/free_text_intent.rb +45 -45
  222. data/lib/aspose_pdf_cloud/models/graph_info.rb +301 -301
  223. data/lib/aspose_pdf_cloud/models/highlight_annotation.rb +370 -370
  224. data/lib/aspose_pdf_cloud/models/highlight_annotation_response.rb +224 -224
  225. data/lib/aspose_pdf_cloud/models/highlight_annotations.rb +213 -213
  226. data/lib/aspose_pdf_cloud/models/highlight_annotations_response.rb +224 -224
  227. data/lib/aspose_pdf_cloud/models/horizontal_alignment.rb +46 -46
  228. data/lib/aspose_pdf_cloud/models/html_document_type.rb +44 -44
  229. data/lib/aspose_pdf_cloud/models/html_markup_generation_modes.rb +44 -44
  230. data/lib/aspose_pdf_cloud/models/image.rb +266 -266
  231. data/lib/aspose_pdf_cloud/models/image_compression_version.rb +45 -45
  232. data/lib/aspose_pdf_cloud/models/image_encoding.rb +46 -46
  233. data/lib/aspose_pdf_cloud/models/image_footer.rb +341 -341
  234. data/lib/aspose_pdf_cloud/models/image_fragment.rb +283 -283
  235. data/lib/aspose_pdf_cloud/models/image_header.rb +341 -341
  236. data/lib/aspose_pdf_cloud/models/image_response.rb +224 -224
  237. data/lib/aspose_pdf_cloud/models/image_src_type.rb +44 -44
  238. data/lib/aspose_pdf_cloud/models/image_stamp.rb +361 -361
  239. data/lib/aspose_pdf_cloud/models/image_template.rb +301 -301
  240. data/lib/aspose_pdf_cloud/models/image_templates_request.rb +231 -231
  241. data/lib/aspose_pdf_cloud/models/images.rb +213 -213
  242. data/lib/aspose_pdf_cloud/models/images_response.rb +224 -224
  243. data/lib/aspose_pdf_cloud/models/ink_annotation.rb +380 -380
  244. data/lib/aspose_pdf_cloud/models/ink_annotation_response.rb +224 -224
  245. data/lib/aspose_pdf_cloud/models/ink_annotations.rb +213 -213
  246. data/lib/aspose_pdf_cloud/models/ink_annotations_response.rb +224 -224
  247. data/lib/aspose_pdf_cloud/models/justification.rb +45 -45
  248. data/lib/aspose_pdf_cloud/models/letters_positioning_methods.rb +44 -44
  249. data/lib/aspose_pdf_cloud/models/line_annotation.rb +488 -488
  250. data/lib/aspose_pdf_cloud/models/line_annotation_response.rb +224 -224
  251. data/lib/aspose_pdf_cloud/models/line_annotations.rb +213 -213
  252. data/lib/aspose_pdf_cloud/models/line_annotations_response.rb +224 -224
  253. data/lib/aspose_pdf_cloud/models/line_ending.rb +52 -52
  254. data/lib/aspose_pdf_cloud/models/line_intent.rb +45 -45
  255. data/lib/aspose_pdf_cloud/models/line_spacing.rb +44 -44
  256. data/lib/aspose_pdf_cloud/models/link.rb +229 -229
  257. data/lib/aspose_pdf_cloud/models/link_action_type.rb +48 -48
  258. data/lib/aspose_pdf_cloud/models/link_annotation.rb +294 -294
  259. data/lib/aspose_pdf_cloud/models/link_annotation_response.rb +224 -224
  260. data/lib/aspose_pdf_cloud/models/link_annotations.rb +213 -213
  261. data/lib/aspose_pdf_cloud/models/link_annotations_response.rb +224 -224
  262. data/lib/aspose_pdf_cloud/models/link_element.rb +201 -201
  263. data/lib/aspose_pdf_cloud/models/link_highlighting_mode.rb +47 -47
  264. data/lib/aspose_pdf_cloud/models/list_box_field.rb +462 -462
  265. data/lib/aspose_pdf_cloud/models/list_box_field_response.rb +224 -224
  266. data/lib/aspose_pdf_cloud/models/list_box_fields.rb +213 -213
  267. data/lib/aspose_pdf_cloud/models/list_box_fields_response.rb +224 -224
  268. data/lib/aspose_pdf_cloud/models/margin_info.rb +229 -229
  269. data/lib/aspose_pdf_cloud/models/markup_annotation.rb +358 -358
  270. data/lib/aspose_pdf_cloud/models/merge_documents.rb +206 -206
  271. data/lib/aspose_pdf_cloud/models/movie_annotation.rb +348 -348
  272. data/lib/aspose_pdf_cloud/models/movie_annotation_response.rb +224 -224
  273. data/lib/aspose_pdf_cloud/models/movie_annotations.rb +213 -213
  274. data/lib/aspose_pdf_cloud/models/movie_annotations_response.rb +224 -224
  275. data/lib/aspose_pdf_cloud/models/object_exist.rb +219 -219
  276. data/lib/aspose_pdf_cloud/models/optimize_options.rb +319 -319
  277. data/lib/aspose_pdf_cloud/models/option.rb +229 -229
  278. data/lib/aspose_pdf_cloud/models/output_format.rb +44 -44
  279. data/lib/aspose_pdf_cloud/models/page.rb +236 -236
  280. data/lib/aspose_pdf_cloud/models/page_layout.rb +49 -49
  281. data/lib/aspose_pdf_cloud/models/page_mode.rb +48 -48
  282. data/lib/aspose_pdf_cloud/models/page_number_stamp.rb +351 -351
  283. data/lib/aspose_pdf_cloud/models/page_word_count.rb +219 -219
  284. data/lib/aspose_pdf_cloud/models/pages.rb +213 -213
  285. data/lib/aspose_pdf_cloud/models/paragraph.rb +316 -316
  286. data/lib/aspose_pdf_cloud/models/parts_embedding_modes.rb +45 -45
  287. data/lib/aspose_pdf_cloud/models/pdf_a_type.rb +45 -45
  288. data/lib/aspose_pdf_cloud/models/pdf_page_stamp.rb +351 -351
  289. data/lib/aspose_pdf_cloud/models/permissions_flags.rb +50 -50
  290. data/lib/aspose_pdf_cloud/models/point.rb +219 -219
  291. data/lib/aspose_pdf_cloud/models/poly_annotation.rb +415 -415
  292. data/lib/aspose_pdf_cloud/models/poly_intent.rb +46 -46
  293. data/lib/aspose_pdf_cloud/models/poly_line_annotation.rb +415 -415
  294. data/lib/aspose_pdf_cloud/models/poly_line_annotation_response.rb +224 -224
  295. data/lib/aspose_pdf_cloud/models/poly_line_annotations.rb +213 -213
  296. data/lib/aspose_pdf_cloud/models/poly_line_annotations_response.rb +224 -224
  297. data/lib/aspose_pdf_cloud/models/polygon_annotation.rb +415 -415
  298. data/lib/aspose_pdf_cloud/models/polygon_annotation_response.rb +224 -224
  299. data/lib/aspose_pdf_cloud/models/polygon_annotations.rb +213 -213
  300. data/lib/aspose_pdf_cloud/models/polygon_annotations_response.rb +224 -224
  301. data/lib/aspose_pdf_cloud/models/popup_annotation.rb +328 -328
  302. data/lib/aspose_pdf_cloud/models/popup_annotation_response.rb +224 -224
  303. data/lib/aspose_pdf_cloud/models/popup_annotation_with_parent.rb +338 -338
  304. data/lib/aspose_pdf_cloud/models/popup_annotations.rb +213 -213
  305. data/lib/aspose_pdf_cloud/models/popup_annotations_response.rb +224 -224
  306. data/lib/aspose_pdf_cloud/models/position.rb +219 -219
  307. data/lib/aspose_pdf_cloud/models/radio_button_field.rb +452 -452
  308. data/lib/aspose_pdf_cloud/models/radio_button_field_response.rb +224 -224
  309. data/lib/aspose_pdf_cloud/models/radio_button_fields.rb +213 -213
  310. data/lib/aspose_pdf_cloud/models/radio_button_fields_response.rb +224 -224
  311. data/lib/aspose_pdf_cloud/models/radio_button_option_field.rb +418 -418
  312. data/lib/aspose_pdf_cloud/models/raster_images_saving_modes.rb +45 -45
  313. data/lib/aspose_pdf_cloud/models/rectangle.rb +249 -249
  314. data/lib/aspose_pdf_cloud/models/redaction_annotation.rb +380 -380
  315. data/lib/aspose_pdf_cloud/models/redaction_annotation_response.rb +224 -224
  316. data/lib/aspose_pdf_cloud/models/redaction_annotations.rb +213 -213
  317. data/lib/aspose_pdf_cloud/models/redaction_annotations_response.rb +224 -224
  318. data/lib/aspose_pdf_cloud/models/rotation.rb +46 -46
  319. data/lib/aspose_pdf_cloud/models/row.rb +306 -306
  320. data/lib/aspose_pdf_cloud/models/row_recognized.rb +211 -211
  321. data/lib/aspose_pdf_cloud/models/screen_annotation.rb +338 -338
  322. data/lib/aspose_pdf_cloud/models/screen_annotation_response.rb +224 -224
  323. data/lib/aspose_pdf_cloud/models/screen_annotations.rb +213 -213
  324. data/lib/aspose_pdf_cloud/models/screen_annotations_response.rb +224 -224
  325. data/lib/aspose_pdf_cloud/models/segment.rb +233 -233
  326. data/lib/aspose_pdf_cloud/models/shape_type.rb +45 -45
  327. data/lib/aspose_pdf_cloud/models/signature.rb +388 -388
  328. data/lib/aspose_pdf_cloud/models/signature_custom_appearance.rb +329 -329
  329. data/lib/aspose_pdf_cloud/models/signature_field.rb +408 -408
  330. data/lib/aspose_pdf_cloud/models/signature_field_response.rb +224 -224
  331. data/lib/aspose_pdf_cloud/models/signature_fields.rb +213 -213
  332. data/lib/aspose_pdf_cloud/models/signature_fields_response.rb +224 -224
  333. data/lib/aspose_pdf_cloud/models/signature_type.rb +45 -45
  334. data/lib/aspose_pdf_cloud/models/signature_verify_response.rb +229 -229
  335. data/lib/aspose_pdf_cloud/models/sound_annotation.rb +442 -442
  336. data/lib/aspose_pdf_cloud/models/sound_annotation_response.rb +224 -224
  337. data/lib/aspose_pdf_cloud/models/sound_annotations.rb +213 -213
  338. data/lib/aspose_pdf_cloud/models/sound_annotations_response.rb +224 -224
  339. data/lib/aspose_pdf_cloud/models/sound_encoding.rb +46 -46
  340. data/lib/aspose_pdf_cloud/models/sound_icon.rb +44 -44
  341. data/lib/aspose_pdf_cloud/models/split_result.rb +201 -201
  342. data/lib/aspose_pdf_cloud/models/split_result_document.rb +244 -244
  343. data/lib/aspose_pdf_cloud/models/split_result_response.rb +224 -224
  344. data/lib/aspose_pdf_cloud/models/square_annotation.rb +378 -378
  345. data/lib/aspose_pdf_cloud/models/square_annotation_response.rb +224 -224
  346. data/lib/aspose_pdf_cloud/models/square_annotations.rb +213 -213
  347. data/lib/aspose_pdf_cloud/models/square_annotations_response.rb +224 -224
  348. data/lib/aspose_pdf_cloud/models/squiggly_annotation.rb +370 -370
  349. data/lib/aspose_pdf_cloud/models/squiggly_annotation_response.rb +224 -224
  350. data/lib/aspose_pdf_cloud/models/squiggly_annotations.rb +213 -213
  351. data/lib/aspose_pdf_cloud/models/squiggly_annotations_response.rb +224 -224
  352. data/lib/aspose_pdf_cloud/models/stamp.rb +414 -414
  353. data/lib/aspose_pdf_cloud/models/stamp_annotation.rb +388 -388
  354. data/lib/aspose_pdf_cloud/models/stamp_annotation_response.rb +224 -224
  355. data/lib/aspose_pdf_cloud/models/stamp_annotations.rb +213 -213
  356. data/lib/aspose_pdf_cloud/models/stamp_annotations_response.rb +224 -224
  357. data/lib/aspose_pdf_cloud/models/stamp_base.rb +281 -281
  358. data/lib/aspose_pdf_cloud/models/stamp_icon.rb +56 -56
  359. data/lib/aspose_pdf_cloud/models/stamp_info.rb +276 -276
  360. data/lib/aspose_pdf_cloud/models/stamp_type.rb +46 -46
  361. data/lib/aspose_pdf_cloud/models/stamps_info.rb +213 -213
  362. data/lib/aspose_pdf_cloud/models/stamps_info_response.rb +224 -224
  363. data/lib/aspose_pdf_cloud/models/storage_exist.rb +204 -204
  364. data/lib/aspose_pdf_cloud/models/storage_file.rb +249 -249
  365. data/lib/aspose_pdf_cloud/models/strike_out_annotation.rb +370 -370
  366. data/lib/aspose_pdf_cloud/models/strike_out_annotation_response.rb +224 -224
  367. data/lib/aspose_pdf_cloud/models/strike_out_annotations.rb +213 -213
  368. data/lib/aspose_pdf_cloud/models/strike_out_annotations_response.rb +224 -224
  369. data/lib/aspose_pdf_cloud/models/table.rb +438 -438
  370. data/lib/aspose_pdf_cloud/models/table_broken.rb +45 -45
  371. data/lib/aspose_pdf_cloud/models/table_recognized.rb +243 -243
  372. data/lib/aspose_pdf_cloud/models/table_recognized_response.rb +224 -224
  373. data/lib/aspose_pdf_cloud/models/tables_recognized.rb +213 -213
  374. data/lib/aspose_pdf_cloud/models/tables_recognized_response.rb +224 -224
  375. data/lib/aspose_pdf_cloud/models/text_annotation.rb +388 -388
  376. data/lib/aspose_pdf_cloud/models/text_annotation_response.rb +224 -224
  377. data/lib/aspose_pdf_cloud/models/text_annotations.rb +213 -213
  378. data/lib/aspose_pdf_cloud/models/text_annotations_response.rb +224 -224
  379. data/lib/aspose_pdf_cloud/models/text_box_field.rb +458 -458
  380. data/lib/aspose_pdf_cloud/models/text_box_field_response.rb +224 -224
  381. data/lib/aspose_pdf_cloud/models/text_box_fields.rb +213 -213
  382. data/lib/aspose_pdf_cloud/models/text_box_fields_response.rb +224 -224
  383. data/lib/aspose_pdf_cloud/models/text_footer.rb +341 -341
  384. data/lib/aspose_pdf_cloud/models/text_header.rb +341 -341
  385. data/lib/aspose_pdf_cloud/models/text_horizontal_alignment.rb +48 -48
  386. data/lib/aspose_pdf_cloud/models/text_icon.rb +53 -53
  387. data/lib/aspose_pdf_cloud/models/text_line.rb +216 -216
  388. data/lib/aspose_pdf_cloud/models/text_rect.rb +269 -269
  389. data/lib/aspose_pdf_cloud/models/text_rects.rb +201 -201
  390. data/lib/aspose_pdf_cloud/models/text_rects_response.rb +224 -224
  391. data/lib/aspose_pdf_cloud/models/text_replace.rb +268 -292
  392. data/lib/aspose_pdf_cloud/models/text_replace_list_request.rb +236 -236
  393. data/lib/aspose_pdf_cloud/models/text_replace_response.rb +229 -229
  394. data/lib/aspose_pdf_cloud/models/text_stamp.rb +361 -361
  395. data/lib/aspose_pdf_cloud/models/text_state.rb +259 -249
  396. data/lib/aspose_pdf_cloud/models/text_style.rb +244 -234
  397. data/lib/aspose_pdf_cloud/models/timestamp_settings.rb +209 -209
  398. data/lib/aspose_pdf_cloud/models/underline_annotation.rb +370 -370
  399. data/lib/aspose_pdf_cloud/models/underline_annotation_response.rb +224 -224
  400. data/lib/aspose_pdf_cloud/models/underline_annotations.rb +213 -213
  401. data/lib/aspose_pdf_cloud/models/underline_annotations_response.rb +224 -224
  402. data/lib/aspose_pdf_cloud/models/vertical_alignment.rb +46 -46
  403. data/lib/aspose_pdf_cloud/models/word_count.rb +200 -200
  404. data/lib/aspose_pdf_cloud/models/word_count_response.rb +224 -224
  405. data/lib/aspose_pdf_cloud/models/wrap_mode.rb +45 -45
  406. data/lib/aspose_pdf_cloud/version.rb +24 -24
  407. data/lib/aspose_pdf_cloud.rb +325 -326
  408. data/test/pdf_tests.rb +6 -3
  409. data/test_data/FormDataXfdf_in.xfdf +21 -21
  410. data/test_data/Righteous-Regular.ttf +0 -0
  411. data/test_data/TexExample.tex +304 -304
  412. data/test_data/sample.tex +105 -105
  413. metadata +118 -9
  414. data/docs/ApiInfo.md +0 -10
  415. data/lib/aspose_pdf_cloud/models/api_info.rb +0 -209
@@ -1,403 +1,403 @@
1
- =begin
2
- --------------------------------------------------------------------------------------------------------------------
3
- Copyright (c) 2020 Aspose.PDF Cloud
4
- Permission is hereby granted, free of charge, to any person obtaining a copy
5
- of this software and associated documentation files (the "Software"), to deal
6
- in the Software without restriction, including without limitation the rights
7
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
- copies of the Software, and to permit persons to whom the Software is
9
- furnished to do so, subject to the following conditions:
10
- The above copyright notice and this permission notice shall be included in all
11
- copies or substantial portions of the Software.
12
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
15
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
16
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
17
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
18
- SOFTWARE.
19
- --------------------------------------------------------------------------------------------------------------------
20
- =end
21
-
22
- require 'date'
23
- require 'time'
24
-
25
- module AsposePdfCloud
26
- # Provides FreeTextAnnotation.
27
- class FreeTextAnnotation
28
- # Link to the document.
29
- attr_accessor :links
30
-
31
- # Color of the annotation.
32
- attr_accessor :color
33
-
34
- # Get the annotation content.
35
- attr_accessor :contents
36
-
37
- # The date and time when the annotation was last modified.
38
- attr_accessor :modified
39
-
40
- # Gets ID of the annotation.
41
- attr_accessor :id
42
-
43
- # Gets Flags of the annotation.
44
- attr_accessor :flags
45
-
46
- # Gets Name of the annotation.
47
- attr_accessor :name
48
-
49
- # Gets Rect of the annotation.
50
- attr_accessor :rect
51
-
52
- # Gets PageIndex of the annotation.
53
- attr_accessor :page_index
54
-
55
- # Gets ZIndex of the annotation.
56
- attr_accessor :z_index
57
-
58
- # Gets HorizontalAlignment of the annotation.
59
- attr_accessor :horizontal_alignment
60
-
61
- # Gets VerticalAlignment of the annotation.
62
- attr_accessor :vertical_alignment
63
-
64
- # The date and time when the annotation was created.
65
- attr_accessor :creation_date
66
-
67
- # Get the annotation subject.
68
- attr_accessor :subject
69
-
70
- # Get the annotation title.
71
- attr_accessor :title
72
-
73
- # Get the annotation RichText.
74
- attr_accessor :rich_text
75
-
76
- # Gets Justification of the annotation.
77
- attr_accessor :justification
78
-
79
- # Gets or sets the intent of the free text annotation.
80
- attr_accessor :intent
81
-
82
- # Angle of annotation rotation.
83
- attr_accessor :rotate
84
-
85
- # Text style of the annotation.
86
- attr_accessor :text_style
87
-
88
-
89
- # Attribute mapping from ruby-style variable name to JSON key.
90
- def self.attribute_map
91
- {
92
- :'links' => :'Links',
93
- :'color' => :'Color',
94
- :'contents' => :'Contents',
95
- :'modified' => :'Modified',
96
- :'id' => :'Id',
97
- :'flags' => :'Flags',
98
- :'name' => :'Name',
99
- :'rect' => :'Rect',
100
- :'page_index' => :'PageIndex',
101
- :'z_index' => :'ZIndex',
102
- :'horizontal_alignment' => :'HorizontalAlignment',
103
- :'vertical_alignment' => :'VerticalAlignment',
104
- :'creation_date' => :'CreationDate',
105
- :'subject' => :'Subject',
106
- :'title' => :'Title',
107
- :'rich_text' => :'RichText',
108
- :'justification' => :'Justification',
109
- :'intent' => :'Intent',
110
- :'rotate' => :'Rotate',
111
- :'text_style' => :'TextStyle'
112
- }
113
- end
114
-
115
- # Attribute type mapping.
116
- def self.swagger_types
117
- {
118
- :'links' => :'Array<Link>',
119
- :'color' => :'Color',
120
- :'contents' => :'String',
121
- :'modified' => :'String',
122
- :'id' => :'String',
123
- :'flags' => :'Array<AnnotationFlags>',
124
- :'name' => :'String',
125
- :'rect' => :'Rectangle',
126
- :'page_index' => :'Integer',
127
- :'z_index' => :'Integer',
128
- :'horizontal_alignment' => :'HorizontalAlignment',
129
- :'vertical_alignment' => :'VerticalAlignment',
130
- :'creation_date' => :'String',
131
- :'subject' => :'String',
132
- :'title' => :'String',
133
- :'rich_text' => :'String',
134
- :'justification' => :'Justification',
135
- :'intent' => :'FreeTextIntent',
136
- :'rotate' => :'Rotation',
137
- :'text_style' => :'TextStyle'
138
- }
139
- end
140
-
141
- # Initializes the object
142
- # @param [Hash] attributes Model attributes in the form of hash
143
- def initialize(attributes = {})
144
- return unless attributes.is_a?(Hash)
145
-
146
- # convert string to symbol for hash key
147
- attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
148
-
149
- if attributes.has_key?(:'Links')
150
- if (value = attributes[:'Links']).is_a?(Array)
151
- self.links = value
152
- end
153
- end
154
-
155
- if attributes.has_key?(:'Color')
156
- self.color = attributes[:'Color']
157
- end
158
-
159
- if attributes.has_key?(:'Contents')
160
- self.contents = attributes[:'Contents']
161
- end
162
-
163
- if attributes.has_key?(:'Modified')
164
- self.modified = attributes[:'Modified']
165
- end
166
-
167
- if attributes.has_key?(:'Id')
168
- self.id = attributes[:'Id']
169
- end
170
-
171
- if attributes.has_key?(:'Flags')
172
- if (value = attributes[:'Flags']).is_a?(Array)
173
- self.flags = value
174
- end
175
- end
176
-
177
- if attributes.has_key?(:'Name')
178
- self.name = attributes[:'Name']
179
- end
180
-
181
- if attributes.has_key?(:'Rect')
182
- self.rect = attributes[:'Rect']
183
- end
184
-
185
- if attributes.has_key?(:'PageIndex')
186
- self.page_index = attributes[:'PageIndex']
187
- end
188
-
189
- if attributes.has_key?(:'ZIndex')
190
- self.z_index = attributes[:'ZIndex']
191
- end
192
-
193
- if attributes.has_key?(:'HorizontalAlignment')
194
- self.horizontal_alignment = attributes[:'HorizontalAlignment']
195
- end
196
-
197
- if attributes.has_key?(:'VerticalAlignment')
198
- self.vertical_alignment = attributes[:'VerticalAlignment']
199
- end
200
-
201
- if attributes.has_key?(:'CreationDate')
202
- self.creation_date = attributes[:'CreationDate']
203
- end
204
-
205
- if attributes.has_key?(:'Subject')
206
- self.subject = attributes[:'Subject']
207
- end
208
-
209
- if attributes.has_key?(:'Title')
210
- self.title = attributes[:'Title']
211
- end
212
-
213
- if attributes.has_key?(:'RichText')
214
- self.rich_text = attributes[:'RichText']
215
- end
216
-
217
- if attributes.has_key?(:'Justification')
218
- self.justification = attributes[:'Justification']
219
- end
220
-
221
- if attributes.has_key?(:'Intent')
222
- self.intent = attributes[:'Intent']
223
- end
224
-
225
- if attributes.has_key?(:'Rotate')
226
- self.rotate = attributes[:'Rotate']
227
- end
228
-
229
- if attributes.has_key?(:'TextStyle')
230
- self.text_style = attributes[:'TextStyle']
231
- end
232
-
233
- end
234
-
235
- # Show invalid properties with the reasons. Usually used together with valid?
236
- # @return Array for valid properies with the reasons
237
- def list_invalid_properties
238
- invalid_properties = Array.new
239
- if @rect.nil?
240
- invalid_properties.push("invalid value for 'rect', rect cannot be nil.")
241
- end
242
-
243
- if @text_style.nil?
244
- invalid_properties.push("invalid value for 'text_style', text_style cannot be nil.")
245
- end
246
-
247
- return invalid_properties
248
- end
249
-
250
- # Check to see if the all the properties in the model are valid
251
- # @return true if the model is valid
252
- def valid?
253
- return false if @rect.nil?
254
- return false if @text_style.nil?
255
- return true
256
- end
257
-
258
- # Checks equality by comparing each attribute.
259
- # @param [Object] Object to be compared
260
- def ==(o)
261
- return true if self.equal?(o)
262
- self.class == o.class &&
263
- links == o.links &&
264
- color == o.color &&
265
- contents == o.contents &&
266
- modified == o.modified &&
267
- id == o.id &&
268
- flags == o.flags &&
269
- name == o.name &&
270
- rect == o.rect &&
271
- page_index == o.page_index &&
272
- z_index == o.z_index &&
273
- horizontal_alignment == o.horizontal_alignment &&
274
- vertical_alignment == o.vertical_alignment &&
275
- creation_date == o.creation_date &&
276
- subject == o.subject &&
277
- title == o.title &&
278
- rich_text == o.rich_text &&
279
- justification == o.justification &&
280
- intent == o.intent &&
281
- rotate == o.rotate &&
282
- text_style == o.text_style
283
- end
284
-
285
- # @see the `==` method
286
- # @param [Object] Object to be compared
287
- def eql?(o)
288
- self == o
289
- end
290
-
291
- # Calculates hash code according to all attributes.
292
- # @return [Fixnum] Hash code
293
- def hash
294
- [links, color, contents, modified, id, flags, name, rect, page_index, z_index, horizontal_alignment, vertical_alignment, creation_date, subject, title, rich_text, justification, intent, rotate, text_style].hash
295
- end
296
-
297
- # Builds the object from hash
298
- # @param [Hash] attributes Model attributes in the form of hash
299
- # @return [Object] Returns the model itself
300
- def build_from_hash(attributes)
301
- return nil unless attributes.is_a?(Hash)
302
- self.class.swagger_types.each_pair do |key, type|
303
- if type =~ /\AArray<(.*)>/i
304
- # check to ensure the input is an array given that the the attribute
305
- # is documented as an array but the input is not
306
- if attributes[self.class.attribute_map[key]].is_a?(Array)
307
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
308
- end
309
- elsif !attributes[self.class.attribute_map[key]].nil?
310
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
311
- end # or else data not found in attributes(hash), not an issue as the data can be optional
312
- end
313
-
314
- self
315
- end
316
-
317
- # Deserializes the data based on type
318
- # @param string type Data type
319
- # @param string value Value to be deserialized
320
- # @return [Object] Deserialized data
321
- def _deserialize(type, value)
322
- case type.to_sym
323
- when :DateTime
324
- DateTime.parse(value)
325
- when :Date
326
- Date.parse(value)
327
- when :String
328
- value.to_s
329
- when :Integer
330
- value.to_i
331
- when :Float
332
- value.to_f
333
- when :BOOLEAN
334
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
335
- true
336
- else
337
- false
338
- end
339
- when :Object
340
- # generic object (usually a Hash), return directly
341
- value
342
- when /\AArray<(?<inner_type>.+)>\z/
343
- inner_type = Regexp.last_match[:inner_type]
344
- value.map { |v| _deserialize(inner_type, v) }
345
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
346
- k_type = Regexp.last_match[:k_type]
347
- v_type = Regexp.last_match[:v_type]
348
- {}.tap do |hash|
349
- value.each do |k, v|
350
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
351
- end
352
- end
353
- else # model
354
- temp_model = AsposePdfCloud.const_get(type).new
355
- temp_model.build_from_hash(value)
356
- end
357
- end
358
-
359
- # Returns the string representation of the object
360
- # @return [String] String presentation of the object
361
- def to_s
362
- to_hash.to_s
363
- end
364
-
365
- # to_body is an alias to to_hash (backward compatibility)
366
- # @return [Hash] Returns the object in the form of hash
367
- def to_body
368
- to_hash
369
- end
370
-
371
- # Returns the object in the form of hash
372
- # @return [Hash] Returns the object in the form of hash
373
- def to_hash
374
- hash = {}
375
- self.class.attribute_map.each_pair do |attr, param|
376
- value = self.send(attr)
377
- next if value.nil?
378
- hash[param] = _to_hash(value)
379
- end
380
- hash
381
- end
382
-
383
- # Outputs non-array value in the form of hash
384
- # For object, use to_hash. Otherwise, just return the value
385
- # @param [Object] value Any valid value
386
- # @return [Hash] Returns the value in the form of hash
387
- def _to_hash(value)
388
- if value.is_a?(Array)
389
- value.compact.map{ |v| _to_hash(v) }
390
- elsif value.is_a?(Hash)
391
- {}.tap do |hash|
392
- value.each { |k, v| hash[k] = _to_hash(v) }
393
- end
394
- elsif value.respond_to? :to_hash
395
- value.to_hash
396
- else
397
- value
398
- end
399
- end
400
-
401
- end
402
-
403
- end
1
+ =begin
2
+ --------------------------------------------------------------------------------------------------------------------
3
+ Copyright (c) 2021 Aspose.PDF Cloud
4
+ Permission is hereby granted, free of charge, to any person obtaining a copy
5
+ of this software and associated documentation files (the "Software"), to deal
6
+ in the Software without restriction, including without limitation the rights
7
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ copies of the Software, and to permit persons to whom the Software is
9
+ furnished to do so, subject to the following conditions:
10
+ The above copyright notice and this permission notice shall be included in all
11
+ copies or substantial portions of the Software.
12
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
15
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
16
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
17
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
18
+ SOFTWARE.
19
+ --------------------------------------------------------------------------------------------------------------------
20
+ =end
21
+
22
+ require 'date'
23
+ require 'time'
24
+
25
+ module AsposePdfCloud
26
+ # Provides FreeTextAnnotation.
27
+ class FreeTextAnnotation
28
+ # Link to the document.
29
+ attr_accessor :links
30
+
31
+ # Color of the annotation.
32
+ attr_accessor :color
33
+
34
+ # Get the annotation content.
35
+ attr_accessor :contents
36
+
37
+ # The date and time when the annotation was last modified.
38
+ attr_accessor :modified
39
+
40
+ # Gets ID of the annotation.
41
+ attr_accessor :id
42
+
43
+ # Gets Flags of the annotation.
44
+ attr_accessor :flags
45
+
46
+ # Gets Name of the annotation.
47
+ attr_accessor :name
48
+
49
+ # Gets Rect of the annotation.
50
+ attr_accessor :rect
51
+
52
+ # Gets PageIndex of the annotation.
53
+ attr_accessor :page_index
54
+
55
+ # Gets ZIndex of the annotation.
56
+ attr_accessor :z_index
57
+
58
+ # Gets HorizontalAlignment of the annotation.
59
+ attr_accessor :horizontal_alignment
60
+
61
+ # Gets VerticalAlignment of the annotation.
62
+ attr_accessor :vertical_alignment
63
+
64
+ # The date and time when the annotation was created.
65
+ attr_accessor :creation_date
66
+
67
+ # Get the annotation subject.
68
+ attr_accessor :subject
69
+
70
+ # Get the annotation title.
71
+ attr_accessor :title
72
+
73
+ # Get the annotation RichText.
74
+ attr_accessor :rich_text
75
+
76
+ # Gets Justification of the annotation.
77
+ attr_accessor :justification
78
+
79
+ # Gets or sets the intent of the free text annotation.
80
+ attr_accessor :intent
81
+
82
+ # Angle of annotation rotation.
83
+ attr_accessor :rotate
84
+
85
+ # Text style of the annotation.
86
+ attr_accessor :text_style
87
+
88
+
89
+ # Attribute mapping from ruby-style variable name to JSON key.
90
+ def self.attribute_map
91
+ {
92
+ :'links' => :'Links',
93
+ :'color' => :'Color',
94
+ :'contents' => :'Contents',
95
+ :'modified' => :'Modified',
96
+ :'id' => :'Id',
97
+ :'flags' => :'Flags',
98
+ :'name' => :'Name',
99
+ :'rect' => :'Rect',
100
+ :'page_index' => :'PageIndex',
101
+ :'z_index' => :'ZIndex',
102
+ :'horizontal_alignment' => :'HorizontalAlignment',
103
+ :'vertical_alignment' => :'VerticalAlignment',
104
+ :'creation_date' => :'CreationDate',
105
+ :'subject' => :'Subject',
106
+ :'title' => :'Title',
107
+ :'rich_text' => :'RichText',
108
+ :'justification' => :'Justification',
109
+ :'intent' => :'Intent',
110
+ :'rotate' => :'Rotate',
111
+ :'text_style' => :'TextStyle'
112
+ }
113
+ end
114
+
115
+ # Attribute type mapping.
116
+ def self.swagger_types
117
+ {
118
+ :'links' => :'Array<Link>',
119
+ :'color' => :'Color',
120
+ :'contents' => :'String',
121
+ :'modified' => :'String',
122
+ :'id' => :'String',
123
+ :'flags' => :'Array<AnnotationFlags>',
124
+ :'name' => :'String',
125
+ :'rect' => :'Rectangle',
126
+ :'page_index' => :'Integer',
127
+ :'z_index' => :'Integer',
128
+ :'horizontal_alignment' => :'HorizontalAlignment',
129
+ :'vertical_alignment' => :'VerticalAlignment',
130
+ :'creation_date' => :'String',
131
+ :'subject' => :'String',
132
+ :'title' => :'String',
133
+ :'rich_text' => :'String',
134
+ :'justification' => :'Justification',
135
+ :'intent' => :'FreeTextIntent',
136
+ :'rotate' => :'Rotation',
137
+ :'text_style' => :'TextStyle'
138
+ }
139
+ end
140
+
141
+ # Initializes the object
142
+ # @param [Hash] attributes Model attributes in the form of hash
143
+ def initialize(attributes = {})
144
+ return unless attributes.is_a?(Hash)
145
+
146
+ # convert string to symbol for hash key
147
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
148
+
149
+ if attributes.has_key?(:'Links')
150
+ if (value = attributes[:'Links']).is_a?(Array)
151
+ self.links = value
152
+ end
153
+ end
154
+
155
+ if attributes.has_key?(:'Color')
156
+ self.color = attributes[:'Color']
157
+ end
158
+
159
+ if attributes.has_key?(:'Contents')
160
+ self.contents = attributes[:'Contents']
161
+ end
162
+
163
+ if attributes.has_key?(:'Modified')
164
+ self.modified = attributes[:'Modified']
165
+ end
166
+
167
+ if attributes.has_key?(:'Id')
168
+ self.id = attributes[:'Id']
169
+ end
170
+
171
+ if attributes.has_key?(:'Flags')
172
+ if (value = attributes[:'Flags']).is_a?(Array)
173
+ self.flags = value
174
+ end
175
+ end
176
+
177
+ if attributes.has_key?(:'Name')
178
+ self.name = attributes[:'Name']
179
+ end
180
+
181
+ if attributes.has_key?(:'Rect')
182
+ self.rect = attributes[:'Rect']
183
+ end
184
+
185
+ if attributes.has_key?(:'PageIndex')
186
+ self.page_index = attributes[:'PageIndex']
187
+ end
188
+
189
+ if attributes.has_key?(:'ZIndex')
190
+ self.z_index = attributes[:'ZIndex']
191
+ end
192
+
193
+ if attributes.has_key?(:'HorizontalAlignment')
194
+ self.horizontal_alignment = attributes[:'HorizontalAlignment']
195
+ end
196
+
197
+ if attributes.has_key?(:'VerticalAlignment')
198
+ self.vertical_alignment = attributes[:'VerticalAlignment']
199
+ end
200
+
201
+ if attributes.has_key?(:'CreationDate')
202
+ self.creation_date = attributes[:'CreationDate']
203
+ end
204
+
205
+ if attributes.has_key?(:'Subject')
206
+ self.subject = attributes[:'Subject']
207
+ end
208
+
209
+ if attributes.has_key?(:'Title')
210
+ self.title = attributes[:'Title']
211
+ end
212
+
213
+ if attributes.has_key?(:'RichText')
214
+ self.rich_text = attributes[:'RichText']
215
+ end
216
+
217
+ if attributes.has_key?(:'Justification')
218
+ self.justification = attributes[:'Justification']
219
+ end
220
+
221
+ if attributes.has_key?(:'Intent')
222
+ self.intent = attributes[:'Intent']
223
+ end
224
+
225
+ if attributes.has_key?(:'Rotate')
226
+ self.rotate = attributes[:'Rotate']
227
+ end
228
+
229
+ if attributes.has_key?(:'TextStyle')
230
+ self.text_style = attributes[:'TextStyle']
231
+ end
232
+
233
+ end
234
+
235
+ # Show invalid properties with the reasons. Usually used together with valid?
236
+ # @return Array for valid properies with the reasons
237
+ def list_invalid_properties
238
+ invalid_properties = Array.new
239
+ if @rect.nil?
240
+ invalid_properties.push("invalid value for 'rect', rect cannot be nil.")
241
+ end
242
+
243
+ if @text_style.nil?
244
+ invalid_properties.push("invalid value for 'text_style', text_style cannot be nil.")
245
+ end
246
+
247
+ return invalid_properties
248
+ end
249
+
250
+ # Check to see if the all the properties in the model are valid
251
+ # @return true if the model is valid
252
+ def valid?
253
+ return false if @rect.nil?
254
+ return false if @text_style.nil?
255
+ return true
256
+ end
257
+
258
+ # Checks equality by comparing each attribute.
259
+ # @param [Object] Object to be compared
260
+ def ==(o)
261
+ return true if self.equal?(o)
262
+ self.class == o.class &&
263
+ links == o.links &&
264
+ color == o.color &&
265
+ contents == o.contents &&
266
+ modified == o.modified &&
267
+ id == o.id &&
268
+ flags == o.flags &&
269
+ name == o.name &&
270
+ rect == o.rect &&
271
+ page_index == o.page_index &&
272
+ z_index == o.z_index &&
273
+ horizontal_alignment == o.horizontal_alignment &&
274
+ vertical_alignment == o.vertical_alignment &&
275
+ creation_date == o.creation_date &&
276
+ subject == o.subject &&
277
+ title == o.title &&
278
+ rich_text == o.rich_text &&
279
+ justification == o.justification &&
280
+ intent == o.intent &&
281
+ rotate == o.rotate &&
282
+ text_style == o.text_style
283
+ end
284
+
285
+ # @see the `==` method
286
+ # @param [Object] Object to be compared
287
+ def eql?(o)
288
+ self == o
289
+ end
290
+
291
+ # Calculates hash code according to all attributes.
292
+ # @return [Fixnum] Hash code
293
+ def hash
294
+ [links, color, contents, modified, id, flags, name, rect, page_index, z_index, horizontal_alignment, vertical_alignment, creation_date, subject, title, rich_text, justification, intent, rotate, text_style].hash
295
+ end
296
+
297
+ # Builds the object from hash
298
+ # @param [Hash] attributes Model attributes in the form of hash
299
+ # @return [Object] Returns the model itself
300
+ def build_from_hash(attributes)
301
+ return nil unless attributes.is_a?(Hash)
302
+ self.class.swagger_types.each_pair do |key, type|
303
+ if type =~ /\AArray<(.*)>/i
304
+ # check to ensure the input is an array given that the the attribute
305
+ # is documented as an array but the input is not
306
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
307
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
308
+ end
309
+ elsif !attributes[self.class.attribute_map[key]].nil?
310
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
311
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
312
+ end
313
+
314
+ self
315
+ end
316
+
317
+ # Deserializes the data based on type
318
+ # @param string type Data type
319
+ # @param string value Value to be deserialized
320
+ # @return [Object] Deserialized data
321
+ def _deserialize(type, value)
322
+ case type.to_sym
323
+ when :DateTime
324
+ DateTime.parse(value)
325
+ when :Date
326
+ Date.parse(value)
327
+ when :String
328
+ value.to_s
329
+ when :Integer
330
+ value.to_i
331
+ when :Float
332
+ value.to_f
333
+ when :BOOLEAN
334
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
335
+ true
336
+ else
337
+ false
338
+ end
339
+ when :Object
340
+ # generic object (usually a Hash), return directly
341
+ value
342
+ when /\AArray<(?<inner_type>.+)>\z/
343
+ inner_type = Regexp.last_match[:inner_type]
344
+ value.map { |v| _deserialize(inner_type, v) }
345
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
346
+ k_type = Regexp.last_match[:k_type]
347
+ v_type = Regexp.last_match[:v_type]
348
+ {}.tap do |hash|
349
+ value.each do |k, v|
350
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
351
+ end
352
+ end
353
+ else # model
354
+ temp_model = AsposePdfCloud.const_get(type).new
355
+ temp_model.build_from_hash(value)
356
+ end
357
+ end
358
+
359
+ # Returns the string representation of the object
360
+ # @return [String] String presentation of the object
361
+ def to_s
362
+ to_hash.to_s
363
+ end
364
+
365
+ # to_body is an alias to to_hash (backward compatibility)
366
+ # @return [Hash] Returns the object in the form of hash
367
+ def to_body
368
+ to_hash
369
+ end
370
+
371
+ # Returns the object in the form of hash
372
+ # @return [Hash] Returns the object in the form of hash
373
+ def to_hash
374
+ hash = {}
375
+ self.class.attribute_map.each_pair do |attr, param|
376
+ value = self.send(attr)
377
+ next if value.nil?
378
+ hash[param] = _to_hash(value)
379
+ end
380
+ hash
381
+ end
382
+
383
+ # Outputs non-array value in the form of hash
384
+ # For object, use to_hash. Otherwise, just return the value
385
+ # @param [Object] value Any valid value
386
+ # @return [Hash] Returns the value in the form of hash
387
+ def _to_hash(value)
388
+ if value.is_a?(Array)
389
+ value.compact.map{ |v| _to_hash(v) }
390
+ elsif value.is_a?(Hash)
391
+ {}.tap do |hash|
392
+ value.each { |k, v| hash[k] = _to_hash(v) }
393
+ end
394
+ elsif value.respond_to? :to_hash
395
+ value.to_hash
396
+ else
397
+ value
398
+ end
399
+ end
400
+
401
+ end
402
+
403
+ end