cloudpdf 3.0.0.alpha.11 → 3.0.0.alpha.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (353) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +2 -2
  3. data/lib/CloudPDF/doc/annotations/client.rb +106 -0
  4. data/lib/CloudPDF/doc/annotations/types/export_appearance_annotations_request.rb +21 -0
  5. data/lib/CloudPDF/doc/annotations/types/flatten_annotations_request.rb +21 -0
  6. data/lib/CloudPDF/doc/client.rb +10 -0
  7. data/lib/CloudPDF/doc/pages/client.rb +102 -0
  8. data/lib/CloudPDF/doc/pages/types/remove_name_pages_request.rb +19 -0
  9. data/lib/CloudPDF/doc/pages/types/set_name_pages_request.rb +19 -0
  10. data/lib/CloudPDF/doc/signatures/client.rb +276 -0
  11. data/lib/CloudPDF/doc/signatures/types/abort_signatures_request.rb +19 -0
  12. data/lib/CloudPDF/doc/signatures/types/analysis_signatures_request.rb +23 -0
  13. data/lib/CloudPDF/doc/signatures/types/analysis_signatures_request_level.rb +18 -0
  14. data/lib/CloudPDF/doc/signatures/types/doc_signatures_complete_request.rb +23 -0
  15. data/lib/CloudPDF/doc/signatures/types/doc_signatures_complete_request_expected_version.rb +15 -0
  16. data/lib/CloudPDF/doc/signatures/types/list_signatures_request.rb +17 -0
  17. data/lib/CloudPDF/doc/signatures/types/prepare_signatures_request.rb +17 -0
  18. data/lib/CloudPDF/doc/versions/client.rb +342 -0
  19. data/lib/CloudPDF/doc/versions/types/analysis_versions_request.rb +27 -0
  20. data/lib/CloudPDF/doc/versions/types/analysis_versions_request_level.rb +18 -0
  21. data/lib/CloudPDF/doc/versions/types/download_versions_request.rb +17 -0
  22. data/lib/CloudPDF/doc/versions/types/list_versions_request.rb +15 -0
  23. data/lib/CloudPDF/doc/versions/types/revision_versions_request.rb +19 -0
  24. data/lib/CloudPDF/doc/versions/types/signature_contents_versions_request.rb +19 -0
  25. data/lib/CloudPDF/doc/versions/types/signature_digest_versions_request.rb +21 -0
  26. data/lib/CloudPDF/doc/versions/types/signature_digest_versions_request_algorithm.rb +18 -0
  27. data/lib/CloudPDF/doc/versions/types/signatures_versions_request.rb +17 -0
  28. data/lib/CloudPDF/types/doc_annotations_create200response_meta_cache_delta.rb +4 -0
  29. data/lib/CloudPDF/types/doc_annotations_create400response_code.rb +6 -0
  30. data/lib/CloudPDF/types/doc_annotations_create404response_code.rb +6 -0
  31. data/lib/CloudPDF/types/doc_annotations_delete200response_meta_cache_delta.rb +4 -0
  32. data/lib/CloudPDF/types/doc_annotations_delete404response_code.rb +6 -0
  33. data/lib/CloudPDF/types/doc_annotations_export_appearance400response.rb +15 -0
  34. data/lib/CloudPDF/types/doc_annotations_export_appearance400response_code.rb +35 -0
  35. data/lib/CloudPDF/types/doc_annotations_export_appearance400response_name.rb +11 -0
  36. data/lib/CloudPDF/types/doc_annotations_export_appearance404response.rb +15 -0
  37. data/lib/CloudPDF/types/doc_annotations_export_appearance404response_code.rb +35 -0
  38. data/lib/CloudPDF/types/doc_annotations_export_appearance404response_name.rb +11 -0
  39. data/lib/CloudPDF/types/doc_annotations_export_appearance_request.rb +23 -0
  40. data/lib/CloudPDF/types/doc_annotations_flatten200response.rb +9 -0
  41. data/lib/CloudPDF/types/doc_annotations_flatten200response_meta.rb +11 -0
  42. data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item.rb +13 -0
  43. data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_revision.rb +13 -0
  44. data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state.rb +15 -0
  45. data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_known.rb +9 -0
  46. data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_unknown.rb +7 -0
  47. data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta.rb +19 -0
  48. data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item.rb +11 -0
  49. data/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item_cache.rb +11 -0
  50. data/lib/CloudPDF/types/doc_annotations_flatten400response.rb +15 -0
  51. data/lib/CloudPDF/types/doc_annotations_flatten400response_code.rb +35 -0
  52. data/lib/CloudPDF/types/doc_annotations_flatten400response_name.rb +11 -0
  53. data/lib/CloudPDF/types/doc_annotations_flatten404response.rb +15 -0
  54. data/lib/CloudPDF/types/doc_annotations_flatten404response_code.rb +35 -0
  55. data/lib/CloudPDF/types/doc_annotations_flatten404response_name.rb +11 -0
  56. data/lib/CloudPDF/types/doc_annotations_flatten_request.rb +23 -0
  57. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text.rb +3 -1
  58. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text.rb +11 -0
  59. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_body.rb +37 -0
  60. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_body_align.rb +14 -0
  61. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_body_decoration_item.rb +13 -0
  62. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_body_dir.rb +12 -0
  63. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_body_margins.rb +15 -0
  64. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_body_script.rb +13 -0
  65. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_paragraphs_item.rb +21 -0
  66. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_paragraphs_item_align.rb +14 -0
  67. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_paragraphs_item_dir.rb +12 -0
  68. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_paragraphs_item_margins.rb +15 -0
  69. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_paragraphs_item_runs_0dedd5.rb +13 -0
  70. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_paragraphs_item_runs_957038.rb +13 -0
  71. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_paragraphs_item_runs_fd1f6a.rb +27 -0
  72. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_rich_text_paragraphs_item_runs_item.rb +11 -0
  73. data/lib/CloudPDF/types/doc_annotations_list404response_code.rb +6 -0
  74. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text.rb +3 -1
  75. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text.rb +11 -0
  76. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_body.rb +37 -0
  77. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_body_align.rb +14 -0
  78. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_body_d_27cc8f.rb +13 -0
  79. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_body_dir.rb +12 -0
  80. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_body_margins.rb +15 -0
  81. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_body_script.rb +13 -0
  82. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_paragr_182642.rb +13 -0
  83. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_paragr_1e6df8.rb +27 -0
  84. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_paragr_2ecf2a.rb +12 -0
  85. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_paragr_84e1e5.rb +13 -0
  86. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_paragr_99744f.rb +11 -0
  87. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_paragr_aa2697.rb +15 -0
  88. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_paragr_d0e05b.rb +14 -0
  89. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_rich_text_paragr_e928ea.rb +21 -0
  90. data/lib/CloudPDF/types/doc_annotations_list_all404response_code.rb +6 -0
  91. data/lib/CloudPDF/types/doc_annotations_list_all409response_code.rb +6 -0
  92. data/lib/CloudPDF/types/doc_annotations_update200response_meta_cache_delta.rb +4 -0
  93. data/lib/CloudPDF/types/doc_annotations_update400response_code.rb +6 -0
  94. data/lib/CloudPDF/types/doc_annotations_update404response_code.rb +6 -0
  95. data/lib/CloudPDF/types/doc_download_response_code.rb +6 -0
  96. data/lib/CloudPDF/types/doc_forms_export_data_response_code.rb +6 -0
  97. data/lib/CloudPDF/types/doc_forms_get404response_code.rb +6 -0
  98. data/lib/CloudPDF/types/doc_forms_import_data200response_meta_cache_delta.rb +4 -0
  99. data/lib/CloudPDF/types/doc_forms_import_data400response_code.rb +6 -0
  100. data/lib/CloudPDF/types/doc_forms_import_data404response_code.rb +6 -0
  101. data/lib/CloudPDF/types/doc_forms_reset200response_meta_cache_delta.rb +4 -0
  102. data/lib/CloudPDF/types/doc_forms_reset404response_code.rb +6 -0
  103. data/lib/CloudPDF/types/doc_forms_set_value200response_meta_cache_delta.rb +4 -0
  104. data/lib/CloudPDF/types/doc_forms_set_value400response_code.rb +6 -0
  105. data/lib/CloudPDF/types/doc_forms_set_value404response_code.rb +6 -0
  106. data/lib/CloudPDF/types/doc_head404response_code.rb +6 -0
  107. data/lib/CloudPDF/types/doc_manifest200response.rb +6 -0
  108. data/lib/CloudPDF/types/doc_manifest404response_code.rb +6 -0
  109. data/lib/CloudPDF/types/doc_metadata_get404response_code.rb +6 -0
  110. data/lib/CloudPDF/types/doc_pages_delete200response_meta_cache_delta.rb +4 -0
  111. data/lib/CloudPDF/types/doc_pages_delete400response_code.rb +6 -0
  112. data/lib/CloudPDF/types/doc_pages_delete404response_code.rb +6 -0
  113. data/lib/CloudPDF/types/doc_pages_extract400response_code.rb +6 -0
  114. data/lib/CloudPDF/types/doc_pages_extract404response_code.rb +6 -0
  115. data/lib/CloudPDF/types/doc_pages_flatten200response_meta_cache_delta.rb +4 -0
  116. data/lib/CloudPDF/types/doc_pages_flatten400response_code.rb +6 -0
  117. data/lib/CloudPDF/types/doc_pages_flatten404response_code.rb +6 -0
  118. data/lib/CloudPDF/types/doc_pages_insert200response_meta_cache_delta.rb +4 -0
  119. data/lib/CloudPDF/types/doc_pages_insert400response_code.rb +6 -0
  120. data/lib/CloudPDF/types/doc_pages_insert404response_code.rb +6 -0
  121. data/lib/CloudPDF/types/doc_pages_insert_blank200response_meta_cache_delta.rb +4 -0
  122. data/lib/CloudPDF/types/doc_pages_insert_blank400response_code.rb +6 -0
  123. data/lib/CloudPDF/types/doc_pages_insert_blank404response_code.rb +6 -0
  124. data/lib/CloudPDF/types/doc_pages_move200response_meta_cache_delta.rb +4 -0
  125. data/lib/CloudPDF/types/doc_pages_move400response_code.rb +6 -0
  126. data/lib/CloudPDF/types/doc_pages_move404response_code.rb +6 -0
  127. data/lib/CloudPDF/types/doc_pages_remove_name200response.rb +9 -0
  128. data/lib/CloudPDF/types/doc_pages_remove_name200response_meta.rb +11 -0
  129. data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item.rb +13 -0
  130. data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_revision.rb +13 -0
  131. data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state.rb +15 -0
  132. data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_known.rb +9 -0
  133. data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_unknown.rb +7 -0
  134. data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta.rb +19 -0
  135. data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item.rb +11 -0
  136. data/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item_cache.rb +11 -0
  137. data/lib/CloudPDF/types/doc_pages_remove_name400response.rb +15 -0
  138. data/lib/CloudPDF/types/doc_pages_remove_name400response_code.rb +35 -0
  139. data/lib/CloudPDF/types/doc_pages_remove_name400response_name.rb +11 -0
  140. data/lib/CloudPDF/types/doc_pages_remove_name404response.rb +15 -0
  141. data/lib/CloudPDF/types/doc_pages_remove_name404response_code.rb +35 -0
  142. data/lib/CloudPDF/types/doc_pages_remove_name404response_name.rb +11 -0
  143. data/lib/CloudPDF/types/doc_pages_remove_name_request.rb +23 -0
  144. data/lib/CloudPDF/types/doc_pages_rotate200response_meta_cache_delta.rb +4 -0
  145. data/lib/CloudPDF/types/doc_pages_rotate400response_code.rb +6 -0
  146. data/lib/CloudPDF/types/doc_pages_rotate404response_code.rb +6 -0
  147. data/lib/CloudPDF/types/doc_pages_set_name200response.rb +9 -0
  148. data/lib/CloudPDF/types/doc_pages_set_name200response_meta.rb +11 -0
  149. data/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item.rb +13 -0
  150. data/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_revision.rb +13 -0
  151. data/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state.rb +15 -0
  152. data/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_known.rb +9 -0
  153. data/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_unknown.rb +7 -0
  154. data/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta.rb +19 -0
  155. data/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item.rb +11 -0
  156. data/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item_cache.rb +11 -0
  157. data/lib/CloudPDF/types/doc_pages_set_name400response.rb +15 -0
  158. data/lib/CloudPDF/types/doc_pages_set_name400response_code.rb +35 -0
  159. data/lib/CloudPDF/types/doc_pages_set_name400response_name.rb +11 -0
  160. data/lib/CloudPDF/types/doc_pages_set_name404response.rb +15 -0
  161. data/lib/CloudPDF/types/doc_pages_set_name404response_code.rb +35 -0
  162. data/lib/CloudPDF/types/doc_pages_set_name404response_name.rb +11 -0
  163. data/lib/CloudPDF/types/doc_pages_set_name_request.rb +23 -0
  164. data/lib/CloudPDF/types/doc_redactions_apply200response_meta_cache_delta.rb +4 -0
  165. data/lib/CloudPDF/types/doc_redactions_apply400response_code.rb +6 -0
  166. data/lib/CloudPDF/types/doc_redactions_apply404response_code.rb +6 -0
  167. data/lib/CloudPDF/types/doc_render_response_code.rb +6 -0
  168. data/lib/CloudPDF/types/doc_signatures_abort200response.rb +9 -0
  169. data/lib/CloudPDF/types/doc_signatures_abort200response_status.rb +13 -0
  170. data/lib/CloudPDF/types/doc_signatures_abort404response.rb +15 -0
  171. data/lib/CloudPDF/types/doc_signatures_abort404response_code.rb +35 -0
  172. data/lib/CloudPDF/types/doc_signatures_abort404response_name.rb +11 -0
  173. data/lib/CloudPDF/types/doc_signatures_analysis200response.rb +27 -0
  174. data/lib/CloudPDF/types/doc_signatures_analysis200response_basis.rb +13 -0
  175. data/lib/CloudPDF/types/doc_signatures_analysis200response_basis_source.rb +12 -0
  176. data/lib/CloudPDF/types/doc_signatures_analysis200response_basis_version.rb +11 -0
  177. data/lib/CloudPDF/types/doc_signatures_analysis200response_current.rb +17 -0
  178. data/lib/CloudPDF/types/doc_signatures_analysis200response_current_findings_item.rb +17 -0
  179. data/lib/CloudPDF/types/doc_signatures_analysis200response_current_findings_item_verdict.rb +13 -0
  180. data/lib/CloudPDF/types/doc_signatures_analysis200response_current_method.rb +12 -0
  181. data/lib/CloudPDF/types/doc_signatures_analysis200response_current_primary.rb +17 -0
  182. data/lib/CloudPDF/types/doc_signatures_analysis200response_current_primary_verdict.rb +13 -0
  183. data/lib/CloudPDF/types/doc_signatures_analysis200response_current_verdict.rb +14 -0
  184. data/lib/CloudPDF/types/doc_signatures_analysis200response_later.rb +11 -0
  185. data/lib/CloudPDF/types/doc_signatures_analysis200response_mode.rb +12 -0
  186. data/lib/CloudPDF/types/doc_signatures_analysis200response_restrictions_item.rb +19 -0
  187. data/lib/CloudPDF/types/doc_signatures_analysis200response_restrictions_item_source.rb +13 -0
  188. data/lib/CloudPDF/types/doc_signatures_analysis200response_since.rb +11 -0
  189. data/lib/CloudPDF/types/doc_signatures_analysis200response_until.rb +9 -0
  190. data/lib/CloudPDF/types/doc_signatures_analysis200response_verdict.rb +14 -0
  191. data/lib/CloudPDF/types/doc_signatures_analysis400response.rb +15 -0
  192. data/lib/CloudPDF/types/doc_signatures_analysis400response_code.rb +35 -0
  193. data/lib/CloudPDF/types/doc_signatures_analysis400response_name.rb +11 -0
  194. data/lib/CloudPDF/types/doc_signatures_analysis404response.rb +15 -0
  195. data/lib/CloudPDF/types/doc_signatures_analysis404response_code.rb +35 -0
  196. data/lib/CloudPDF/types/doc_signatures_analysis404response_name.rb +11 -0
  197. data/lib/CloudPDF/types/doc_signatures_complete200response.rb +19 -0
  198. data/lib/CloudPDF/types/doc_signatures_complete200response_meta.rb +11 -0
  199. data/lib/CloudPDF/types/doc_signatures_complete200response_meta_affected_pages_item.rb +13 -0
  200. data/lib/CloudPDF/types/doc_signatures_complete200response_meta_affected_pages_item_revision.rb +13 -0
  201. data/lib/CloudPDF/types/doc_signatures_complete200response_meta_affected_pages_item_weak_annotation_state.rb +15 -0
  202. data/lib/CloudPDF/types/doc_signatures_complete200response_meta_affected_pages_item_weak_annotation_state_known.rb +9 -0
  203. data/lib/CloudPDF/types/doc_signatures_complete200response_meta_affected_pages_item_weak_annotation_state_unknown.rb +7 -0
  204. data/lib/CloudPDF/types/doc_signatures_complete200response_meta_cache_delta.rb +19 -0
  205. data/lib/CloudPDF/types/doc_signatures_complete200response_meta_cache_delta_pages_item.rb +11 -0
  206. data/lib/CloudPDF/types/doc_signatures_complete200response_meta_cache_delta_pages_item_cache.rb +11 -0
  207. data/lib/CloudPDF/types/doc_signatures_complete200response_previous.rb +11 -0
  208. data/lib/CloudPDF/types/doc_signatures_complete200response_protection.rb +17 -0
  209. data/lib/CloudPDF/types/doc_signatures_complete200response_protection_certification.rb +11 -0
  210. data/lib/CloudPDF/types/doc_signatures_complete200response_protection_enforced.rb +14 -0
  211. data/lib/CloudPDF/types/doc_signatures_complete200response_protection_field_locks_item.rb +13 -0
  212. data/lib/CloudPDF/types/doc_signatures_complete200response_protection_field_locks_item_source.rb +12 -0
  213. data/lib/CloudPDF/types/doc_signatures_complete200response_protection_field_locks_item_spec.rb +13 -0
  214. data/lib/CloudPDF/types/doc_signatures_complete200response_protection_field_locks_item_spec_action.rb +13 -0
  215. data/lib/CloudPDF/types/doc_signatures_complete200response_protection_judged.rb +14 -0
  216. data/lib/CloudPDF/types/doc_signatures_complete200response_signature.rb +43 -0
  217. data/lib/CloudPDF/types/doc_signatures_complete200response_signature_coverage.rb +13 -0
  218. data/lib/CloudPDF/types/doc_signatures_complete200response_signature_field.rb +15 -0
  219. data/lib/CloudPDF/types/doc_signatures_complete200response_signature_field_fqn.rb +9 -0
  220. data/lib/CloudPDF/types/doc_signatures_complete200response_signature_field_mdp.rb +13 -0
  221. data/lib/CloudPDF/types/doc_signatures_complete200response_signature_field_mdp_action.rb +13 -0
  222. data/lib/CloudPDF/types/doc_signatures_complete200response_signature_field_object_number.rb +9 -0
  223. data/lib/CloudPDF/types/doc_signatures_complete200response_signature_kind.rb +12 -0
  224. data/lib/CloudPDF/types/doc_signatures_complete200response_signature_lock.rb +13 -0
  225. data/lib/CloudPDF/types/doc_signatures_complete200response_signature_lock_action.rb +13 -0
  226. data/lib/CloudPDF/types/doc_signatures_complete200response_signature_seed_value.rb +25 -0
  227. data/lib/CloudPDF/types/doc_signatures_complete200response_signature_signer.rb +17 -0
  228. data/lib/CloudPDF/types/doc_signatures_complete200response_signature_widget.rb +11 -0
  229. data/lib/CloudPDF/types/doc_signatures_complete200response_status.rb +12 -0
  230. data/lib/CloudPDF/types/doc_signatures_complete200response_version.rb +11 -0
  231. data/lib/CloudPDF/types/doc_signatures_complete400response.rb +15 -0
  232. data/lib/CloudPDF/types/doc_signatures_complete400response_code.rb +35 -0
  233. data/lib/CloudPDF/types/doc_signatures_complete400response_name.rb +11 -0
  234. data/lib/CloudPDF/types/doc_signatures_complete404response.rb +15 -0
  235. data/lib/CloudPDF/types/doc_signatures_complete404response_code.rb +35 -0
  236. data/lib/CloudPDF/types/doc_signatures_complete404response_name.rb +11 -0
  237. data/lib/CloudPDF/types/doc_signatures_complete409response.rb +15 -0
  238. data/lib/CloudPDF/types/doc_signatures_complete409response_code.rb +35 -0
  239. data/lib/CloudPDF/types/doc_signatures_complete409response_name.rb +11 -0
  240. data/lib/CloudPDF/types/doc_signatures_list200response.rb +15 -0
  241. data/lib/CloudPDF/types/doc_signatures_list200response_protection.rb +17 -0
  242. data/lib/CloudPDF/types/doc_signatures_list200response_protection_certification.rb +11 -0
  243. data/lib/CloudPDF/types/doc_signatures_list200response_protection_enforced.rb +14 -0
  244. data/lib/CloudPDF/types/doc_signatures_list200response_protection_field_locks_item.rb +13 -0
  245. data/lib/CloudPDF/types/doc_signatures_list200response_protection_field_locks_item_source.rb +12 -0
  246. data/lib/CloudPDF/types/doc_signatures_list200response_protection_field_locks_item_spec.rb +13 -0
  247. data/lib/CloudPDF/types/doc_signatures_list200response_protection_field_locks_item_spec_action.rb +13 -0
  248. data/lib/CloudPDF/types/doc_signatures_list200response_protection_judged.rb +14 -0
  249. data/lib/CloudPDF/types/doc_signatures_list200response_revisions_item.rb +15 -0
  250. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item.rb +43 -0
  251. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item_coverage.rb +13 -0
  252. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item_field.rb +15 -0
  253. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item_field_fqn.rb +9 -0
  254. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item_field_mdp.rb +13 -0
  255. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item_field_mdp_action.rb +13 -0
  256. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item_field_object_number.rb +9 -0
  257. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item_kind.rb +12 -0
  258. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item_lock.rb +13 -0
  259. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item_lock_action.rb +13 -0
  260. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item_seed_value.rb +25 -0
  261. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item_signer.rb +17 -0
  262. data/lib/CloudPDF/types/doc_signatures_list200response_signatures_item_widget.rb +11 -0
  263. data/lib/CloudPDF/types/doc_signatures_list404response.rb +15 -0
  264. data/lib/CloudPDF/types/doc_signatures_list404response_code.rb +35 -0
  265. data/lib/CloudPDF/types/doc_signatures_list404response_name.rb +11 -0
  266. data/lib/CloudPDF/types/doc_signatures_prepare200response.rb +23 -0
  267. data/lib/CloudPDF/types/doc_signatures_prepare200response_algorithm.rb +13 -0
  268. data/lib/CloudPDF/types/doc_signatures_prepare200response_expected_version.rb +11 -0
  269. data/lib/CloudPDF/types/doc_signatures_prepare400response.rb +15 -0
  270. data/lib/CloudPDF/types/doc_signatures_prepare400response_code.rb +35 -0
  271. data/lib/CloudPDF/types/doc_signatures_prepare400response_name.rb +11 -0
  272. data/lib/CloudPDF/types/doc_signatures_prepare404response.rb +15 -0
  273. data/lib/CloudPDF/types/doc_signatures_prepare404response_code.rb +35 -0
  274. data/lib/CloudPDF/types/doc_signatures_prepare404response_name.rb +11 -0
  275. data/lib/CloudPDF/types/doc_signatures_prepare409response.rb +15 -0
  276. data/lib/CloudPDF/types/doc_signatures_prepare409response_code.rb +35 -0
  277. data/lib/CloudPDF/types/doc_signatures_prepare409response_name.rb +11 -0
  278. data/lib/CloudPDF/types/doc_text404response_code.rb +6 -0
  279. data/lib/CloudPDF/types/doc_versions_analysis200response.rb +27 -0
  280. data/lib/CloudPDF/types/doc_versions_analysis200response_basis.rb +13 -0
  281. data/lib/CloudPDF/types/doc_versions_analysis200response_basis_source.rb +12 -0
  282. data/lib/CloudPDF/types/doc_versions_analysis200response_basis_version.rb +11 -0
  283. data/lib/CloudPDF/types/doc_versions_analysis200response_current.rb +17 -0
  284. data/lib/CloudPDF/types/doc_versions_analysis200response_current_findings_item.rb +17 -0
  285. data/lib/CloudPDF/types/doc_versions_analysis200response_current_findings_item_verdict.rb +13 -0
  286. data/lib/CloudPDF/types/doc_versions_analysis200response_current_method.rb +12 -0
  287. data/lib/CloudPDF/types/doc_versions_analysis200response_current_primary.rb +17 -0
  288. data/lib/CloudPDF/types/doc_versions_analysis200response_current_primary_verdict.rb +13 -0
  289. data/lib/CloudPDF/types/doc_versions_analysis200response_current_verdict.rb +14 -0
  290. data/lib/CloudPDF/types/doc_versions_analysis200response_later.rb +11 -0
  291. data/lib/CloudPDF/types/doc_versions_analysis200response_mode.rb +12 -0
  292. data/lib/CloudPDF/types/doc_versions_analysis200response_restrictions_item.rb +19 -0
  293. data/lib/CloudPDF/types/doc_versions_analysis200response_restrictions_item_source.rb +13 -0
  294. data/lib/CloudPDF/types/doc_versions_analysis200response_since.rb +11 -0
  295. data/lib/CloudPDF/types/doc_versions_analysis200response_until.rb +9 -0
  296. data/lib/CloudPDF/types/doc_versions_analysis200response_verdict.rb +14 -0
  297. data/lib/CloudPDF/types/doc_versions_analysis400response.rb +15 -0
  298. data/lib/CloudPDF/types/doc_versions_analysis400response_code.rb +35 -0
  299. data/lib/CloudPDF/types/doc_versions_analysis400response_name.rb +11 -0
  300. data/lib/CloudPDF/types/doc_versions_analysis404response.rb +15 -0
  301. data/lib/CloudPDF/types/doc_versions_analysis404response_code.rb +35 -0
  302. data/lib/CloudPDF/types/doc_versions_analysis404response_name.rb +11 -0
  303. data/lib/CloudPDF/types/doc_versions_download_response.rb +15 -0
  304. data/lib/CloudPDF/types/doc_versions_download_response_code.rb +35 -0
  305. data/lib/CloudPDF/types/doc_versions_download_response_name.rb +11 -0
  306. data/lib/CloudPDF/types/doc_versions_list200response.rb +11 -0
  307. data/lib/CloudPDF/types/doc_versions_list200response_versions_item.rb +21 -0
  308. data/lib/CloudPDF/types/doc_versions_list200response_versions_item_producer.rb +12 -0
  309. data/lib/CloudPDF/types/doc_versions_list404response.rb +15 -0
  310. data/lib/CloudPDF/types/doc_versions_list404response_code.rb +35 -0
  311. data/lib/CloudPDF/types/doc_versions_list404response_name.rb +11 -0
  312. data/lib/CloudPDF/types/doc_versions_revision_response.rb +15 -0
  313. data/lib/CloudPDF/types/doc_versions_revision_response_code.rb +35 -0
  314. data/lib/CloudPDF/types/doc_versions_revision_response_name.rb +11 -0
  315. data/lib/CloudPDF/types/doc_versions_signature_contents_response.rb +15 -0
  316. data/lib/CloudPDF/types/doc_versions_signature_contents_response_code.rb +35 -0
  317. data/lib/CloudPDF/types/doc_versions_signature_contents_response_name.rb +11 -0
  318. data/lib/CloudPDF/types/doc_versions_signature_digest_response.rb +15 -0
  319. data/lib/CloudPDF/types/doc_versions_signature_digest_response_code.rb +35 -0
  320. data/lib/CloudPDF/types/doc_versions_signature_digest_response_name.rb +11 -0
  321. data/lib/CloudPDF/types/doc_versions_signatures200response.rb +15 -0
  322. data/lib/CloudPDF/types/doc_versions_signatures200response_protection.rb +17 -0
  323. data/lib/CloudPDF/types/doc_versions_signatures200response_protection_certification.rb +11 -0
  324. data/lib/CloudPDF/types/doc_versions_signatures200response_protection_enforced.rb +14 -0
  325. data/lib/CloudPDF/types/doc_versions_signatures200response_protection_field_locks_item.rb +13 -0
  326. data/lib/CloudPDF/types/doc_versions_signatures200response_protection_field_locks_item_source.rb +12 -0
  327. data/lib/CloudPDF/types/doc_versions_signatures200response_protection_field_locks_item_spec.rb +13 -0
  328. data/lib/CloudPDF/types/doc_versions_signatures200response_protection_field_locks_item_spec_action.rb +13 -0
  329. data/lib/CloudPDF/types/doc_versions_signatures200response_protection_judged.rb +14 -0
  330. data/lib/CloudPDF/types/doc_versions_signatures200response_revisions_item.rb +15 -0
  331. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item.rb +43 -0
  332. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item_coverage.rb +13 -0
  333. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item_field.rb +15 -0
  334. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item_field_fqn.rb +9 -0
  335. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item_field_mdp.rb +13 -0
  336. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item_field_mdp_action.rb +13 -0
  337. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item_field_object_number.rb +9 -0
  338. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item_kind.rb +12 -0
  339. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item_lock.rb +13 -0
  340. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item_lock_action.rb +13 -0
  341. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item_seed_value.rb +25 -0
  342. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item_signer.rb +17 -0
  343. data/lib/CloudPDF/types/doc_versions_signatures200response_signatures_item_widget.rb +11 -0
  344. data/lib/CloudPDF/types/doc_versions_signatures404response.rb +15 -0
  345. data/lib/CloudPDF/types/doc_versions_signatures404response_code.rb +35 -0
  346. data/lib/CloudPDF/types/doc_versions_signatures404response_name.rb +11 -0
  347. data/lib/CloudPDF/types/engine_error_payload_code.rb +6 -0
  348. data/lib/CloudPDF/version.rb +1 -1
  349. data/lib/cloudpdf.rb +288 -2
  350. data/reference.md +1384 -6
  351. metadata +290 -4
  352. data/lib/CloudPDF/types/doc_annotations_list200response_annotations_item_free_text_font_family.rb +0 -24
  353. data/lib/CloudPDF/types/doc_annotations_list_all200response_pages_item_annotations_item_free_text_font_family.rb +0 -24
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Signatures
6
+ module Types
7
+ module AnalysisSignaturesRequestLevel
8
+ extend CloudPDF::Internal::Types::Enum
9
+
10
+ NONE = "none"
11
+ LTA = "lta"
12
+ FILL = "fill"
13
+ ANNOTATE = "annotate"
14
+ end
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Signatures
6
+ module Types
7
+ class DocSignaturesCompleteRequest < Internal::Types::Model
8
+ field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
9
+
10
+ field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName"
11
+
12
+ field :signing_id, -> { String }, optional: false, nullable: false, api_name: "signingId"
13
+
14
+ field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
15
+
16
+ field :cms, -> { String }, optional: false, nullable: false
17
+
18
+ field :expected_version, -> { CloudPDF::Doc::Signatures::Types::DocSignaturesCompleteRequestExpectedVersion }, optional: false, nullable: false, api_name: "expectedVersion"
19
+ end
20
+ end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Signatures
6
+ module Types
7
+ class DocSignaturesCompleteRequestExpectedVersion < Internal::Types::Model
8
+ field :base_sha256, -> { String }, optional: false, nullable: false, api_name: "baseSha256"
9
+
10
+ field :edits_version, -> { Integer }, optional: false, nullable: false, api_name: "editsVersion"
11
+ end
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Signatures
6
+ module Types
7
+ class ListSignaturesRequest < Internal::Types::Model
8
+ field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
9
+
10
+ field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName"
11
+
12
+ field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Signatures
6
+ module Types
7
+ class PrepareSignaturesRequest < Internal::Types::Model
8
+ field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
9
+
10
+ field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName"
11
+
12
+ field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,342 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Versions
6
+ class Client
7
+ # @param client [CloudPDF::Internal::Http::RawClient]
8
+ #
9
+ # @return [void]
10
+ def initialize(client:)
11
+ @client = client
12
+ end
13
+
14
+ # Every completed signature publishes a new version. Never cached: the list grows.
15
+ #
16
+ # @param request_options [Hash]
17
+ # @param params [Hash]
18
+ # @option request_options [String] :base_url
19
+ # @option request_options [Hash{String => Object}] :additional_headers
20
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
21
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
22
+ # @option request_options [Integer] :timeout_in_seconds
23
+ # @option params [String] :doc_id
24
+ # @option params [String, nil] :document_password
25
+ #
26
+ # @example
27
+ # client.doc.versions.list(doc_id: "docId")
28
+ #
29
+ # @return [CloudPDF::Types::DocVersionsList200Response]
30
+ def list(request_options: {}, **params)
31
+ params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
32
+ headers = {}
33
+ headers["X-Document-Password"] = params[:document_password] if params[:document_password]
34
+
35
+ request = CloudPDF::Internal::JSON::Request.new(
36
+ base_url: request_options[:base_url],
37
+ method: "GET",
38
+ path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/versions",
39
+ headers: headers,
40
+ request_options: request_options
41
+ )
42
+ begin
43
+ response = @client.send(request)
44
+ rescue Net::HTTPRequestTimeout
45
+ raise CloudPDF::Errors::TimeoutError
46
+ end
47
+ code = response.code.to_i
48
+ if code.between?(200, 299)
49
+ CloudPDF::Types::DocVersionsList200Response.load(response.body)
50
+ else
51
+ error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
52
+ raise error_class.new(response.body, code: code)
53
+ end
54
+ end
55
+
56
+ # Exactly one of `since.signature` / `since.revision`; `until=<revision>` defaults to the last. The same answer
57
+ # for every layer and every caller.
58
+ #
59
+ # @param request_options [Hash]
60
+ # @param params [Hash]
61
+ # @option request_options [String] :base_url
62
+ # @option request_options [Hash{String => Object}] :additional_headers
63
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
64
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
65
+ # @option request_options [Integer] :timeout_in_seconds
66
+ # @option params [String] :doc_id
67
+ # @option params [String] :sha
68
+ # @option params [Integer, nil] :since_signature
69
+ # @option params [Integer, nil] :since_revision
70
+ # @option params [CloudPDF::Doc::Versions::Types::AnalysisVersionsRequestLevel, nil] :level
71
+ # @option params [Integer, nil] :until_
72
+ # @option params [Integer, nil] :policy
73
+ # @option params [String, nil] :document_password
74
+ #
75
+ # @example
76
+ # client.doc.versions.analysis(
77
+ # doc_id: "docId",
78
+ # sha: "sha"
79
+ # )
80
+ #
81
+ # @return [CloudPDF::Types::DocVersionsAnalysis200Response]
82
+ def analysis(request_options: {}, **params)
83
+ params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
84
+ query_params = {}
85
+ query_params["since.signature"] = params[:since_signature] if params.key?(:since_signature)
86
+ query_params["since.revision"] = params[:since_revision] if params.key?(:since_revision)
87
+ query_params["level"] = params[:level] if params.key?(:level)
88
+ query_params["until"] = params[:until_] if params.key?(:until_)
89
+ query_params["policy"] = params[:policy] if params.key?(:policy)
90
+
91
+ headers = {}
92
+ headers["X-Document-Password"] = params[:document_password] if params[:document_password]
93
+
94
+ request = CloudPDF::Internal::JSON::Request.new(
95
+ base_url: request_options[:base_url],
96
+ method: "GET",
97
+ path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/versions/analysis/#{URI.encode_uri_component(params[:sha].to_s)}",
98
+ headers: headers,
99
+ query: query_params,
100
+ request_options: request_options
101
+ )
102
+ begin
103
+ response = @client.send(request)
104
+ rescue Net::HTTPRequestTimeout
105
+ raise CloudPDF::Errors::TimeoutError
106
+ end
107
+ code = response.code.to_i
108
+ if code.between?(200, 299)
109
+ CloudPDF::Types::DocVersionsAnalysis200Response.load(response.body)
110
+ else
111
+ error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
112
+ raise error_class.new(response.body, code: code)
113
+ end
114
+ end
115
+
116
+ # @param request_options [Hash]
117
+ # @param params [Hash]
118
+ # @option request_options [String] :base_url
119
+ # @option request_options [Hash{String => Object}] :additional_headers
120
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
121
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
122
+ # @option request_options [Integer] :timeout_in_seconds
123
+ # @option params [String] :doc_id
124
+ # @option params [String] :sha
125
+ # @option params [String, nil] :document_password
126
+ #
127
+ # @example
128
+ # client.doc.versions.download(
129
+ # doc_id: "docId",
130
+ # sha: "sha"
131
+ # )
132
+ #
133
+ # @return [untyped]
134
+ def download(request_options: {}, **params)
135
+ params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
136
+ headers = {}
137
+ headers["X-Document-Password"] = params[:document_password] if params[:document_password]
138
+
139
+ request = CloudPDF::Internal::JSON::Request.new(
140
+ base_url: request_options[:base_url],
141
+ method: "GET",
142
+ path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/versions/download/#{URI.encode_uri_component(params[:sha].to_s)}",
143
+ headers: headers,
144
+ request_options: request_options
145
+ )
146
+ begin
147
+ response = @client.send(request)
148
+ rescue Net::HTTPRequestTimeout
149
+ raise CloudPDF::Errors::TimeoutError
150
+ end
151
+ code = response.code.to_i
152
+ return if code.between?(200, 299)
153
+
154
+ error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
155
+ raise error_class.new(response.body, code: code)
156
+ end
157
+
158
+ # @param request_options [Hash]
159
+ # @param params [Hash]
160
+ # @option request_options [String] :base_url
161
+ # @option request_options [Hash{String => Object}] :additional_headers
162
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
163
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
164
+ # @option request_options [Integer] :timeout_in_seconds
165
+ # @option params [String] :doc_id
166
+ # @option params [String] :sha
167
+ # @option params [Integer] :index
168
+ # @option params [String, nil] :document_password
169
+ #
170
+ # @example
171
+ # client.doc.versions.revision(
172
+ # doc_id: "docId",
173
+ # sha: "sha",
174
+ # index: 1
175
+ # )
176
+ #
177
+ # @return [untyped]
178
+ def revision(request_options: {}, **params)
179
+ params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
180
+ headers = {}
181
+ headers["X-Document-Password"] = params[:document_password] if params[:document_password]
182
+
183
+ request = CloudPDF::Internal::JSON::Request.new(
184
+ base_url: request_options[:base_url],
185
+ method: "GET",
186
+ path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/versions/revisions/#{URI.encode_uri_component(params[:sha].to_s)}/#{URI.encode_uri_component(params[:index].to_s)}",
187
+ headers: headers,
188
+ request_options: request_options
189
+ )
190
+ begin
191
+ response = @client.send(request)
192
+ rescue Net::HTTPRequestTimeout
193
+ raise CloudPDF::Errors::TimeoutError
194
+ end
195
+ code = response.code.to_i
196
+ return if code.between?(200, 299)
197
+
198
+ error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
199
+ raise error_class.new(response.body, code: code)
200
+ end
201
+
202
+ # @param request_options [Hash]
203
+ # @param params [Hash]
204
+ # @option request_options [String] :base_url
205
+ # @option request_options [Hash{String => Object}] :additional_headers
206
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
207
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
208
+ # @option request_options [Integer] :timeout_in_seconds
209
+ # @option params [String] :doc_id
210
+ # @option params [String] :sha
211
+ # @option params [String, nil] :document_password
212
+ #
213
+ # @example
214
+ # client.doc.versions.signatures(
215
+ # doc_id: "docId",
216
+ # sha: "sha"
217
+ # )
218
+ #
219
+ # @return [CloudPDF::Types::DocVersionsSignatures200Response]
220
+ def signatures(request_options: {}, **params)
221
+ params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
222
+ headers = {}
223
+ headers["X-Document-Password"] = params[:document_password] if params[:document_password]
224
+
225
+ request = CloudPDF::Internal::JSON::Request.new(
226
+ base_url: request_options[:base_url],
227
+ method: "GET",
228
+ path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/versions/signatures/#{URI.encode_uri_component(params[:sha].to_s)}",
229
+ headers: headers,
230
+ request_options: request_options
231
+ )
232
+ begin
233
+ response = @client.send(request)
234
+ rescue Net::HTTPRequestTimeout
235
+ raise CloudPDF::Errors::TimeoutError
236
+ end
237
+ code = response.code.to_i
238
+ if code.between?(200, 299)
239
+ CloudPDF::Types::DocVersionsSignatures200Response.load(response.body)
240
+ else
241
+ error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
242
+ raise error_class.new(response.body, code: code)
243
+ end
244
+ end
245
+
246
+ # `fieldKey` is the field's fully qualified name, token-text encoded (the same encoding attachment keys use).
247
+ #
248
+ # @param request_options [Hash]
249
+ # @param params [Hash]
250
+ # @option request_options [String] :base_url
251
+ # @option request_options [Hash{String => Object}] :additional_headers
252
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
253
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
254
+ # @option request_options [Integer] :timeout_in_seconds
255
+ # @option params [String] :doc_id
256
+ # @option params [String] :sha
257
+ # @option params [String] :field_key
258
+ # @option params [String, nil] :document_password
259
+ #
260
+ # @example
261
+ # client.doc.versions.signature_contents(
262
+ # doc_id: "docId",
263
+ # sha: "sha",
264
+ # field_key: "fieldKey"
265
+ # )
266
+ #
267
+ # @return [untyped]
268
+ def signature_contents(request_options: {}, **params)
269
+ params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
270
+ headers = {}
271
+ headers["X-Document-Password"] = params[:document_password] if params[:document_password]
272
+
273
+ request = CloudPDF::Internal::JSON::Request.new(
274
+ base_url: request_options[:base_url],
275
+ method: "GET",
276
+ path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/versions/signatures/#{URI.encode_uri_component(params[:sha].to_s)}/#{URI.encode_uri_component(params[:field_key].to_s)}/contents",
277
+ headers: headers,
278
+ request_options: request_options
279
+ )
280
+ begin
281
+ response = @client.send(request)
282
+ rescue Net::HTTPRequestTimeout
283
+ raise CloudPDF::Errors::TimeoutError
284
+ end
285
+ code = response.code.to_i
286
+ return if code.between?(200, 299)
287
+
288
+ error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
289
+ raise error_class.new(response.body, code: code)
290
+ end
291
+
292
+ # What a CMS verifier compares its message digest to.
293
+ #
294
+ # @param request_options [Hash]
295
+ # @param params [Hash]
296
+ # @option request_options [String] :base_url
297
+ # @option request_options [Hash{String => Object}] :additional_headers
298
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
299
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
300
+ # @option request_options [Integer] :timeout_in_seconds
301
+ # @option params [String] :doc_id
302
+ # @option params [String] :sha
303
+ # @option params [String] :field_key
304
+ # @option params [CloudPDF::Doc::Versions::Types::SignatureDigestVersionsRequestAlgorithm] :algorithm
305
+ # @option params [String, nil] :document_password
306
+ #
307
+ # @example
308
+ # client.doc.versions.signature_digest(
309
+ # doc_id: "docId",
310
+ # sha: "sha",
311
+ # field_key: "fieldKey",
312
+ # algorithm: "sha1"
313
+ # )
314
+ #
315
+ # @return [untyped]
316
+ def signature_digest(request_options: {}, **params)
317
+ params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
318
+ headers = {}
319
+ headers["X-Document-Password"] = params[:document_password] if params[:document_password]
320
+
321
+ request = CloudPDF::Internal::JSON::Request.new(
322
+ base_url: request_options[:base_url],
323
+ method: "GET",
324
+ path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/versions/signatures/#{URI.encode_uri_component(params[:sha].to_s)}/#{URI.encode_uri_component(params[:field_key].to_s)}/digest/#{URI.encode_uri_component(params[:algorithm].to_s)}",
325
+ headers: headers,
326
+ request_options: request_options
327
+ )
328
+ begin
329
+ response = @client.send(request)
330
+ rescue Net::HTTPRequestTimeout
331
+ raise CloudPDF::Errors::TimeoutError
332
+ end
333
+ code = response.code.to_i
334
+ return if code.between?(200, 299)
335
+
336
+ error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
337
+ raise error_class.new(response.body, code: code)
338
+ end
339
+ end
340
+ end
341
+ end
342
+ end
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Versions
6
+ module Types
7
+ class AnalysisVersionsRequest < Internal::Types::Model
8
+ field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
9
+
10
+ field :sha, -> { String }, optional: false, nullable: false
11
+
12
+ field :since_signature, -> { Integer }, optional: true, nullable: false, api_name: "since.signature"
13
+
14
+ field :since_revision, -> { Integer }, optional: true, nullable: false, api_name: "since.revision"
15
+
16
+ field :level, -> { CloudPDF::Doc::Versions::Types::AnalysisVersionsRequestLevel }, optional: true, nullable: false
17
+
18
+ field :until_, -> { Integer }, optional: true, nullable: false, api_name: "until"
19
+
20
+ field :policy, -> { Integer }, optional: true, nullable: false
21
+
22
+ field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
23
+ end
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Versions
6
+ module Types
7
+ module AnalysisVersionsRequestLevel
8
+ extend CloudPDF::Internal::Types::Enum
9
+
10
+ NONE = "none"
11
+ LTA = "lta"
12
+ FILL = "fill"
13
+ ANNOTATE = "annotate"
14
+ end
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Versions
6
+ module Types
7
+ class DownloadVersionsRequest < Internal::Types::Model
8
+ field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
9
+
10
+ field :sha, -> { String }, optional: false, nullable: false
11
+
12
+ field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Versions
6
+ module Types
7
+ class ListVersionsRequest < Internal::Types::Model
8
+ field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
9
+
10
+ field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
11
+ end
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Versions
6
+ module Types
7
+ class RevisionVersionsRequest < Internal::Types::Model
8
+ field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
9
+
10
+ field :sha, -> { String }, optional: false, nullable: false
11
+
12
+ field :index, -> { Integer }, optional: false, nullable: false
13
+
14
+ field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
15
+ end
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Versions
6
+ module Types
7
+ class SignatureContentsVersionsRequest < Internal::Types::Model
8
+ field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
9
+
10
+ field :sha, -> { String }, optional: false, nullable: false
11
+
12
+ field :field_key, -> { String }, optional: false, nullable: false, api_name: "fieldKey"
13
+
14
+ field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
15
+ end
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Versions
6
+ module Types
7
+ class SignatureDigestVersionsRequest < Internal::Types::Model
8
+ field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
9
+
10
+ field :sha, -> { String }, optional: false, nullable: false
11
+
12
+ field :field_key, -> { String }, optional: false, nullable: false, api_name: "fieldKey"
13
+
14
+ field :algorithm, -> { CloudPDF::Doc::Versions::Types::SignatureDigestVersionsRequestAlgorithm }, optional: false, nullable: false
15
+
16
+ field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
17
+ end
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Versions
6
+ module Types
7
+ module SignatureDigestVersionsRequestAlgorithm
8
+ extend CloudPDF::Internal::Types::Enum
9
+
10
+ SHA1 = "sha1"
11
+ SHA256 = "sha256"
12
+ SHA384 = "sha384"
13
+ SHA512 = "sha512"
14
+ end
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Versions
6
+ module Types
7
+ class SignaturesVersionsRequest < Internal::Types::Model
8
+ field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
9
+
10
+ field :sha, -> { String }, optional: false, nullable: false
11
+
12
+ field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
@@ -9,6 +9,10 @@ module CloudPDF
9
9
 
10
10
  field :annotations_version, -> { Integer }, optional: true, nullable: false, api_name: "annotationsVersion"
11
11
 
12
+ field :layer_version, -> { Integer }, optional: true, nullable: false, api_name: "layerVersion"
13
+
14
+ field :working, -> { Internal::Types::Boolean }, optional: true, nullable: false
15
+
12
16
  field :pages, -> { Internal::Types::Array[CloudPDF::Types::DocAnnotationsCreate200ResponseMetaCacheDeltaPagesItem] }, optional: false, nullable: false
13
17
  end
14
18
  end
@@ -24,6 +24,12 @@ module CloudPDF
24
24
  LAYER_VERSION_CONFLICT = "LayerVersionConflict"
25
25
  NOT_IMPLEMENTED = "NotImplemented"
26
26
  MALFORMED_PDF = "MalformedPdf"
27
+ SIGNING_PENDING = "SigningPending"
28
+ SIGNING_EXPIRED = "SigningExpired"
29
+ SIGNING_VERSION_MISMATCH = "SigningVersionMismatch"
30
+ SIGNATURE_REFUSED = "SignatureRefused"
31
+ PROTECTED_DOCUMENT = "ProtectedDocument"
32
+ STALE_BASE = "StaleBase"
27
33
  end
28
34
  end
29
35
  end
@@ -24,6 +24,12 @@ module CloudPDF
24
24
  LAYER_VERSION_CONFLICT = "LayerVersionConflict"
25
25
  NOT_IMPLEMENTED = "NotImplemented"
26
26
  MALFORMED_PDF = "MalformedPdf"
27
+ SIGNING_PENDING = "SigningPending"
28
+ SIGNING_EXPIRED = "SigningExpired"
29
+ SIGNING_VERSION_MISMATCH = "SigningVersionMismatch"
30
+ SIGNATURE_REFUSED = "SignatureRefused"
31
+ PROTECTED_DOCUMENT = "ProtectedDocument"
32
+ STALE_BASE = "StaleBase"
27
33
  end
28
34
  end
29
35
  end
@@ -9,6 +9,10 @@ module CloudPDF
9
9
 
10
10
  field :annotations_version, -> { Integer }, optional: true, nullable: false, api_name: "annotationsVersion"
11
11
 
12
+ field :layer_version, -> { Integer }, optional: true, nullable: false, api_name: "layerVersion"
13
+
14
+ field :working, -> { Internal::Types::Boolean }, optional: true, nullable: false
15
+
12
16
  field :pages, -> { Internal::Types::Array[CloudPDF::Types::DocAnnotationsDelete200ResponseMetaCacheDeltaPagesItem] }, optional: false, nullable: false
13
17
  end
14
18
  end