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
data/reference.md CHANGED
@@ -2581,6 +2581,182 @@ client.doc.annotations.update(
2581
2581
  </dl>
2582
2582
 
2583
2583
 
2584
+ </dd>
2585
+ </dl>
2586
+ </details>
2587
+
2588
+ <details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">export_appearance</a>(doc_id:, layer_name:, pon:, request) -> String</code></summary>
2589
+ <dl>
2590
+ <dd>
2591
+
2592
+ #### 🔌 Usage
2593
+
2594
+ <dl>
2595
+ <dd>
2596
+
2597
+ <dl>
2598
+ <dd>
2599
+
2600
+ ```ruby
2601
+ client.doc.annotations.export_appearance(
2602
+ doc_id: "docId",
2603
+ layer_name: "layerName",
2604
+ pon: 1,
2605
+ request: {
2606
+ string: {
2607
+ key: "value"
2608
+ }
2609
+ }
2610
+ )
2611
+ ```
2612
+ </dd>
2613
+ </dl>
2614
+ </dd>
2615
+ </dl>
2616
+
2617
+ #### ⚙️ Parameters
2618
+
2619
+ <dl>
2620
+ <dd>
2621
+
2622
+ <dl>
2623
+ <dd>
2624
+
2625
+ **doc_id:** `String`
2626
+
2627
+ </dd>
2628
+ </dl>
2629
+
2630
+ <dl>
2631
+ <dd>
2632
+
2633
+ **layer_name:** `String`
2634
+
2635
+ </dd>
2636
+ </dl>
2637
+
2638
+ <dl>
2639
+ <dd>
2640
+
2641
+ **pon:** `Integer`
2642
+
2643
+ </dd>
2644
+ </dl>
2645
+
2646
+ <dl>
2647
+ <dd>
2648
+
2649
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
2650
+
2651
+ </dd>
2652
+ </dl>
2653
+
2654
+ <dl>
2655
+ <dd>
2656
+
2657
+ **request:** `Internal::Types::Hash[String, Object]`
2658
+
2659
+ </dd>
2660
+ </dl>
2661
+
2662
+ <dl>
2663
+ <dd>
2664
+
2665
+ **request_options:** `CloudPDF::Doc::Annotations::RequestOptions`
2666
+
2667
+ </dd>
2668
+ </dl>
2669
+ </dd>
2670
+ </dl>
2671
+
2672
+
2673
+ </dd>
2674
+ </dl>
2675
+ </details>
2676
+
2677
+ <details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">flatten</a>(doc_id:, layer_name:, pon:, request) -> CloudPDF::Types::DocAnnotationsFlatten200Response</code></summary>
2678
+ <dl>
2679
+ <dd>
2680
+
2681
+ #### 🔌 Usage
2682
+
2683
+ <dl>
2684
+ <dd>
2685
+
2686
+ <dl>
2687
+ <dd>
2688
+
2689
+ ```ruby
2690
+ client.doc.annotations.flatten(
2691
+ doc_id: "docId",
2692
+ layer_name: "layerName",
2693
+ pon: 1,
2694
+ request: {
2695
+ key: "value"
2696
+ }
2697
+ )
2698
+ ```
2699
+ </dd>
2700
+ </dl>
2701
+ </dd>
2702
+ </dl>
2703
+
2704
+ #### ⚙️ Parameters
2705
+
2706
+ <dl>
2707
+ <dd>
2708
+
2709
+ <dl>
2710
+ <dd>
2711
+
2712
+ **doc_id:** `String`
2713
+
2714
+ </dd>
2715
+ </dl>
2716
+
2717
+ <dl>
2718
+ <dd>
2719
+
2720
+ **layer_name:** `String`
2721
+
2722
+ </dd>
2723
+ </dl>
2724
+
2725
+ <dl>
2726
+ <dd>
2727
+
2728
+ **pon:** `Integer`
2729
+
2730
+ </dd>
2731
+ </dl>
2732
+
2733
+ <dl>
2734
+ <dd>
2735
+
2736
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
2737
+
2738
+ </dd>
2739
+ </dl>
2740
+
2741
+ <dl>
2742
+ <dd>
2743
+
2744
+ **request:** `Internal::Types::Hash[String, Object]`
2745
+
2746
+ </dd>
2747
+ </dl>
2748
+
2749
+ <dl>
2750
+ <dd>
2751
+
2752
+ **request_options:** `CloudPDF::Doc::Annotations::RequestOptions`
2753
+
2754
+ </dd>
2755
+ </dl>
2756
+ </dd>
2757
+ </dl>
2758
+
2759
+
2584
2760
  </dd>
2585
2761
  </dl>
2586
2762
  </details>
@@ -3539,7 +3715,7 @@ client.doc.pages.move(
3539
3715
  </dl>
3540
3716
  </details>
3541
3717
 
3542
- <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">rotate</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesRotate200Response</code></summary>
3718
+ <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">set_name</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesSetName200Response</code></summary>
3543
3719
  <dl>
3544
3720
  <dd>
3545
3721
 
@@ -3552,7 +3728,7 @@ client.doc.pages.move(
3552
3728
  <dd>
3553
3729
 
3554
3730
  ```ruby
3555
- client.doc.pages.rotate(
3731
+ client.doc.pages.set_name(
3556
3732
  doc_id: "docId",
3557
3733
  layer_name: "layerName",
3558
3734
  request: {
@@ -3617,8 +3793,7 @@ client.doc.pages.rotate(
3617
3793
  </dl>
3618
3794
  </details>
3619
3795
 
3620
- ## Doc Redactions
3621
- <details><summary><code>client.doc.redactions.<a href="/lib/CloudPDF/doc/redactions/client.rb">apply</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocRedactionsApply200Response</code></summary>
3796
+ <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">remove_name</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesRemoveName200Response</code></summary>
3622
3797
  <dl>
3623
3798
  <dd>
3624
3799
 
@@ -3631,7 +3806,7 @@ client.doc.pages.rotate(
3631
3806
  <dd>
3632
3807
 
3633
3808
  ```ruby
3634
- client.doc.redactions.apply(
3809
+ client.doc.pages.remove_name(
3635
3810
  doc_id: "docId",
3636
3811
  layer_name: "layerName",
3637
3812
  request: {
@@ -3684,7 +3859,1210 @@ client.doc.redactions.apply(
3684
3859
  <dl>
3685
3860
  <dd>
3686
3861
 
3687
- **request_options:** `CloudPDF::Doc::Redactions::RequestOptions`
3862
+ **request_options:** `CloudPDF::Doc::Pages::RequestOptions`
3863
+
3864
+ </dd>
3865
+ </dl>
3866
+ </dd>
3867
+ </dl>
3868
+
3869
+
3870
+ </dd>
3871
+ </dl>
3872
+ </details>
3873
+
3874
+ <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">rotate</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesRotate200Response</code></summary>
3875
+ <dl>
3876
+ <dd>
3877
+
3878
+ #### 🔌 Usage
3879
+
3880
+ <dl>
3881
+ <dd>
3882
+
3883
+ <dl>
3884
+ <dd>
3885
+
3886
+ ```ruby
3887
+ client.doc.pages.rotate(
3888
+ doc_id: "docId",
3889
+ layer_name: "layerName",
3890
+ request: {
3891
+ key: "value"
3892
+ }
3893
+ )
3894
+ ```
3895
+ </dd>
3896
+ </dl>
3897
+ </dd>
3898
+ </dl>
3899
+
3900
+ #### ⚙️ Parameters
3901
+
3902
+ <dl>
3903
+ <dd>
3904
+
3905
+ <dl>
3906
+ <dd>
3907
+
3908
+ **doc_id:** `String`
3909
+
3910
+ </dd>
3911
+ </dl>
3912
+
3913
+ <dl>
3914
+ <dd>
3915
+
3916
+ **layer_name:** `String`
3917
+
3918
+ </dd>
3919
+ </dl>
3920
+
3921
+ <dl>
3922
+ <dd>
3923
+
3924
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
3925
+
3926
+ </dd>
3927
+ </dl>
3928
+
3929
+ <dl>
3930
+ <dd>
3931
+
3932
+ **request:** `Internal::Types::Hash[String, Object]`
3933
+
3934
+ </dd>
3935
+ </dl>
3936
+
3937
+ <dl>
3938
+ <dd>
3939
+
3940
+ **request_options:** `CloudPDF::Doc::Pages::RequestOptions`
3941
+
3942
+ </dd>
3943
+ </dl>
3944
+ </dd>
3945
+ </dl>
3946
+
3947
+
3948
+ </dd>
3949
+ </dl>
3950
+ </details>
3951
+
3952
+ ## Doc Redactions
3953
+ <details><summary><code>client.doc.redactions.<a href="/lib/CloudPDF/doc/redactions/client.rb">apply</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocRedactionsApply200Response</code></summary>
3954
+ <dl>
3955
+ <dd>
3956
+
3957
+ #### 🔌 Usage
3958
+
3959
+ <dl>
3960
+ <dd>
3961
+
3962
+ <dl>
3963
+ <dd>
3964
+
3965
+ ```ruby
3966
+ client.doc.redactions.apply(
3967
+ doc_id: "docId",
3968
+ layer_name: "layerName",
3969
+ request: {
3970
+ key: "value"
3971
+ }
3972
+ )
3973
+ ```
3974
+ </dd>
3975
+ </dl>
3976
+ </dd>
3977
+ </dl>
3978
+
3979
+ #### ⚙️ Parameters
3980
+
3981
+ <dl>
3982
+ <dd>
3983
+
3984
+ <dl>
3985
+ <dd>
3986
+
3987
+ **doc_id:** `String`
3988
+
3989
+ </dd>
3990
+ </dl>
3991
+
3992
+ <dl>
3993
+ <dd>
3994
+
3995
+ **layer_name:** `String`
3996
+
3997
+ </dd>
3998
+ </dl>
3999
+
4000
+ <dl>
4001
+ <dd>
4002
+
4003
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
4004
+
4005
+ </dd>
4006
+ </dl>
4007
+
4008
+ <dl>
4009
+ <dd>
4010
+
4011
+ **request:** `Internal::Types::Hash[String, Object]`
4012
+
4013
+ </dd>
4014
+ </dl>
4015
+
4016
+ <dl>
4017
+ <dd>
4018
+
4019
+ **request_options:** `CloudPDF::Doc::Redactions::RequestOptions`
4020
+
4021
+ </dd>
4022
+ </dl>
4023
+ </dd>
4024
+ </dl>
4025
+
4026
+
4027
+ </dd>
4028
+ </dl>
4029
+ </details>
4030
+
4031
+ ## Doc Signatures
4032
+ <details><summary><code>client.doc.signatures.<a href="/lib/CloudPDF/doc/signatures/client.rb">list</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocSignaturesList200Response</code></summary>
4033
+ <dl>
4034
+ <dd>
4035
+
4036
+ #### 📝 Description
4037
+
4038
+ <dl>
4039
+ <dd>
4040
+
4041
+ <dl>
4042
+ <dd>
4043
+
4044
+ Describes the bytes the layer is over: the base version's signatures plus the layer's own edits as the last revision. Signed bytes (contents, digests, revision prefixes) are served per base version under /versions.
4045
+ </dd>
4046
+ </dl>
4047
+ </dd>
4048
+ </dl>
4049
+
4050
+ #### 🔌 Usage
4051
+
4052
+ <dl>
4053
+ <dd>
4054
+
4055
+ <dl>
4056
+ <dd>
4057
+
4058
+ ```ruby
4059
+ client.doc.signatures.list(
4060
+ doc_id: "docId",
4061
+ layer_name: "layerName"
4062
+ )
4063
+ ```
4064
+ </dd>
4065
+ </dl>
4066
+ </dd>
4067
+ </dl>
4068
+
4069
+ #### ⚙️ Parameters
4070
+
4071
+ <dl>
4072
+ <dd>
4073
+
4074
+ <dl>
4075
+ <dd>
4076
+
4077
+ **doc_id:** `String`
4078
+
4079
+ </dd>
4080
+ </dl>
4081
+
4082
+ <dl>
4083
+ <dd>
4084
+
4085
+ **layer_name:** `String`
4086
+
4087
+ </dd>
4088
+ </dl>
4089
+
4090
+ <dl>
4091
+ <dd>
4092
+
4093
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
4094
+
4095
+ </dd>
4096
+ </dl>
4097
+
4098
+ <dl>
4099
+ <dd>
4100
+
4101
+ **request_options:** `CloudPDF::Doc::Signatures::RequestOptions`
4102
+
4103
+ </dd>
4104
+ </dl>
4105
+ </dd>
4106
+ </dl>
4107
+
4108
+
4109
+ </dd>
4110
+ </dl>
4111
+ </details>
4112
+
4113
+ <details><summary><code>client.doc.signatures.<a href="/lib/CloudPDF/doc/signatures/client.rb">abort</a>(doc_id:, layer_name:, signing_id:) -> CloudPDF::Types::DocSignaturesAbort200Response</code></summary>
4114
+ <dl>
4115
+ <dd>
4116
+
4117
+ #### 🔌 Usage
4118
+
4119
+ <dl>
4120
+ <dd>
4121
+
4122
+ <dl>
4123
+ <dd>
4124
+
4125
+ ```ruby
4126
+ client.doc.signatures.abort(
4127
+ doc_id: "docId",
4128
+ layer_name: "layerName",
4129
+ signing_id: "signingId"
4130
+ )
4131
+ ```
4132
+ </dd>
4133
+ </dl>
4134
+ </dd>
4135
+ </dl>
4136
+
4137
+ #### ⚙️ Parameters
4138
+
4139
+ <dl>
4140
+ <dd>
4141
+
4142
+ <dl>
4143
+ <dd>
4144
+
4145
+ **doc_id:** `String`
4146
+
4147
+ </dd>
4148
+ </dl>
4149
+
4150
+ <dl>
4151
+ <dd>
4152
+
4153
+ **layer_name:** `String`
4154
+
4155
+ </dd>
4156
+ </dl>
4157
+
4158
+ <dl>
4159
+ <dd>
4160
+
4161
+ **signing_id:** `String`
4162
+
4163
+ </dd>
4164
+ </dl>
4165
+
4166
+ <dl>
4167
+ <dd>
4168
+
4169
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
4170
+
4171
+ </dd>
4172
+ </dl>
4173
+
4174
+ <dl>
4175
+ <dd>
4176
+
4177
+ **request_options:** `CloudPDF::Doc::Signatures::RequestOptions`
4178
+
4179
+ </dd>
4180
+ </dl>
4181
+ </dd>
4182
+ </dl>
4183
+
4184
+
4185
+ </dd>
4186
+ </dl>
4187
+ </details>
4188
+
4189
+ <details><summary><code>client.doc.signatures.<a href="/lib/CloudPDF/doc/signatures/client.rb">complete</a>(doc_id:, layer_name:, signing_id:, request) -> CloudPDF::Types::DocSignaturesComplete200Response</code></summary>
4190
+ <dl>
4191
+ <dd>
4192
+
4193
+ #### 📝 Description
4194
+
4195
+ <dl>
4196
+ <dd>
4197
+
4198
+ <dl>
4199
+ <dd>
4200
+
4201
+ `cms` is the detached CMS over the prepared digest, base64. `expectedVersion` must be what prepare returned. Idempotent by signing id: the same CMS again answers `already-completed`. Every layer of the document then sits over the new version; refetch the manifest after a completion.
4202
+ </dd>
4203
+ </dl>
4204
+ </dd>
4205
+ </dl>
4206
+
4207
+ #### 🔌 Usage
4208
+
4209
+ <dl>
4210
+ <dd>
4211
+
4212
+ <dl>
4213
+ <dd>
4214
+
4215
+ ```ruby
4216
+ client.doc.signatures.complete(
4217
+ doc_id: "docId",
4218
+ layer_name: "layerName",
4219
+ signing_id: "signingId",
4220
+ cms: "cms",
4221
+ expected_version: {
4222
+ base_sha256: "baseSha256",
4223
+ edits_version: 1
4224
+ }
4225
+ )
4226
+ ```
4227
+ </dd>
4228
+ </dl>
4229
+ </dd>
4230
+ </dl>
4231
+
4232
+ #### ⚙️ Parameters
4233
+
4234
+ <dl>
4235
+ <dd>
4236
+
4237
+ <dl>
4238
+ <dd>
4239
+
4240
+ **doc_id:** `String`
4241
+
4242
+ </dd>
4243
+ </dl>
4244
+
4245
+ <dl>
4246
+ <dd>
4247
+
4248
+ **layer_name:** `String`
4249
+
4250
+ </dd>
4251
+ </dl>
4252
+
4253
+ <dl>
4254
+ <dd>
4255
+
4256
+ **signing_id:** `String`
4257
+
4258
+ </dd>
4259
+ </dl>
4260
+
4261
+ <dl>
4262
+ <dd>
4263
+
4264
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
4265
+
4266
+ </dd>
4267
+ </dl>
4268
+
4269
+ <dl>
4270
+ <dd>
4271
+
4272
+ **cms:** `String`
4273
+
4274
+ </dd>
4275
+ </dl>
4276
+
4277
+ <dl>
4278
+ <dd>
4279
+
4280
+ **expected_version:** `CloudPDF::Doc::Signatures::Types::DocSignaturesCompleteRequestExpectedVersion`
4281
+
4282
+ </dd>
4283
+ </dl>
4284
+
4285
+ <dl>
4286
+ <dd>
4287
+
4288
+ **request_options:** `CloudPDF::Doc::Signatures::RequestOptions`
4289
+
4290
+ </dd>
4291
+ </dl>
4292
+ </dd>
4293
+ </dl>
4294
+
4295
+
4296
+ </dd>
4297
+ </dl>
4298
+ </details>
4299
+
4300
+ <details><summary><code>client.doc.signatures.<a href="/lib/CloudPDF/doc/signatures/client.rb">analysis</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocSignaturesAnalysis200Response</code></summary>
4301
+ <dl>
4302
+ <dd>
4303
+
4304
+ #### 📝 Description
4305
+
4306
+ <dl>
4307
+ <dd>
4308
+
4309
+ <dl>
4310
+ <dd>
4311
+
4312
+ Exactly one of `since.signature=<index>` or `since.revision=<index>`; the layer's pending edits are the end. `level=fill|annotate|lta|none` evaluates exploratorily and never becomes a verdict. For history between two base revisions use the version analysis.
4313
+ </dd>
4314
+ </dl>
4315
+ </dd>
4316
+ </dl>
4317
+
4318
+ #### 🔌 Usage
4319
+
4320
+ <dl>
4321
+ <dd>
4322
+
4323
+ <dl>
4324
+ <dd>
4325
+
4326
+ ```ruby
4327
+ client.doc.signatures.analysis(
4328
+ doc_id: "docId",
4329
+ layer_name: "layerName"
4330
+ )
4331
+ ```
4332
+ </dd>
4333
+ </dl>
4334
+ </dd>
4335
+ </dl>
4336
+
4337
+ #### ⚙️ Parameters
4338
+
4339
+ <dl>
4340
+ <dd>
4341
+
4342
+ <dl>
4343
+ <dd>
4344
+
4345
+ **doc_id:** `String`
4346
+
4347
+ </dd>
4348
+ </dl>
4349
+
4350
+ <dl>
4351
+ <dd>
4352
+
4353
+ **layer_name:** `String`
4354
+
4355
+ </dd>
4356
+ </dl>
4357
+
4358
+ <dl>
4359
+ <dd>
4360
+
4361
+ **since_signature:** `Integer`
4362
+
4363
+ </dd>
4364
+ </dl>
4365
+
4366
+ <dl>
4367
+ <dd>
4368
+
4369
+ **since_revision:** `Integer`
4370
+
4371
+ </dd>
4372
+ </dl>
4373
+
4374
+ <dl>
4375
+ <dd>
4376
+
4377
+ **level:** `CloudPDF::Doc::Signatures::Types::AnalysisSignaturesRequestLevel`
4378
+
4379
+ </dd>
4380
+ </dl>
4381
+
4382
+ <dl>
4383
+ <dd>
4384
+
4385
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
4386
+
4387
+ </dd>
4388
+ </dl>
4389
+
4390
+ <dl>
4391
+ <dd>
4392
+
4393
+ **request_options:** `CloudPDF::Doc::Signatures::RequestOptions`
4394
+
4395
+ </dd>
4396
+ </dl>
4397
+ </dd>
4398
+ </dl>
4399
+
4400
+
4401
+ </dd>
4402
+ </dl>
4403
+ </details>
4404
+
4405
+ <details><summary><code>client.doc.signatures.<a href="/lib/CloudPDF/doc/signatures/client.rb">prepare</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocSignaturesPrepare200Response</code></summary>
4406
+ <dl>
4407
+ <dd>
4408
+
4409
+ #### 📝 Description
4410
+
4411
+ <dl>
4412
+ <dd>
4413
+
4414
+ <dl>
4415
+ <dd>
4416
+
4417
+ The multipart envelope: a JSON `body` part (field, subFilter, digest, contentsSize, signer, certify, lock, appearance) and an optional `resource:<key>` PDF part the body's `appearance.resource` names. A certification (`certify.permission`) additionally requires `doc.sign.certify`. The layer is read-only until the signing completes, is aborted, or expires (15 minutes). A layer behind the document head cannot sign (StaleBase).
4418
+ </dd>
4419
+ </dl>
4420
+ </dd>
4421
+ </dl>
4422
+
4423
+ #### 🔌 Usage
4424
+
4425
+ <dl>
4426
+ <dd>
4427
+
4428
+ <dl>
4429
+ <dd>
4430
+
4431
+ ```ruby
4432
+ client.doc.signatures.prepare(
4433
+ doc_id: "docId",
4434
+ layer_name: "layerName"
4435
+ )
4436
+ ```
4437
+ </dd>
4438
+ </dl>
4439
+ </dd>
4440
+ </dl>
4441
+
4442
+ #### ⚙️ Parameters
4443
+
4444
+ <dl>
4445
+ <dd>
4446
+
4447
+ <dl>
4448
+ <dd>
4449
+
4450
+ **doc_id:** `String`
4451
+
4452
+ </dd>
4453
+ </dl>
4454
+
4455
+ <dl>
4456
+ <dd>
4457
+
4458
+ **layer_name:** `String`
4459
+
4460
+ </dd>
4461
+ </dl>
4462
+
4463
+ <dl>
4464
+ <dd>
4465
+
4466
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
4467
+
4468
+ </dd>
4469
+ </dl>
4470
+
4471
+ <dl>
4472
+ <dd>
4473
+
4474
+ **request_options:** `CloudPDF::Doc::Signatures::RequestOptions`
4475
+
4476
+ </dd>
4477
+ </dl>
4478
+ </dd>
4479
+ </dl>
4480
+
4481
+
4482
+ </dd>
4483
+ </dl>
4484
+ </details>
4485
+
4486
+ ## Doc Versions
4487
+ <details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">list</a>(doc_id:) -> CloudPDF::Types::DocVersionsList200Response</code></summary>
4488
+ <dl>
4489
+ <dd>
4490
+
4491
+ #### 📝 Description
4492
+
4493
+ <dl>
4494
+ <dd>
4495
+
4496
+ <dl>
4497
+ <dd>
4498
+
4499
+ Every completed signature publishes a new version. Never cached: the list grows.
4500
+ </dd>
4501
+ </dl>
4502
+ </dd>
4503
+ </dl>
4504
+
4505
+ #### 🔌 Usage
4506
+
4507
+ <dl>
4508
+ <dd>
4509
+
4510
+ <dl>
4511
+ <dd>
4512
+
4513
+ ```ruby
4514
+ client.doc.versions.list(doc_id: "docId")
4515
+ ```
4516
+ </dd>
4517
+ </dl>
4518
+ </dd>
4519
+ </dl>
4520
+
4521
+ #### ⚙️ Parameters
4522
+
4523
+ <dl>
4524
+ <dd>
4525
+
4526
+ <dl>
4527
+ <dd>
4528
+
4529
+ **doc_id:** `String`
4530
+
4531
+ </dd>
4532
+ </dl>
4533
+
4534
+ <dl>
4535
+ <dd>
4536
+
4537
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
4538
+
4539
+ </dd>
4540
+ </dl>
4541
+
4542
+ <dl>
4543
+ <dd>
4544
+
4545
+ **request_options:** `CloudPDF::Doc::Versions::RequestOptions`
4546
+
4547
+ </dd>
4548
+ </dl>
4549
+ </dd>
4550
+ </dl>
4551
+
4552
+
4553
+ </dd>
4554
+ </dl>
4555
+ </details>
4556
+
4557
+ <details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">analysis</a>(doc_id:, sha:) -> CloudPDF::Types::DocVersionsAnalysis200Response</code></summary>
4558
+ <dl>
4559
+ <dd>
4560
+
4561
+ #### 📝 Description
4562
+
4563
+ <dl>
4564
+ <dd>
4565
+
4566
+ <dl>
4567
+ <dd>
4568
+
4569
+ Exactly one of `since.signature` / `since.revision`; `until=<revision>` defaults to the last. The same answer for every layer and every caller.
4570
+ </dd>
4571
+ </dl>
4572
+ </dd>
4573
+ </dl>
4574
+
4575
+ #### 🔌 Usage
4576
+
4577
+ <dl>
4578
+ <dd>
4579
+
4580
+ <dl>
4581
+ <dd>
4582
+
4583
+ ```ruby
4584
+ client.doc.versions.analysis(
4585
+ doc_id: "docId",
4586
+ sha: "sha"
4587
+ )
4588
+ ```
4589
+ </dd>
4590
+ </dl>
4591
+ </dd>
4592
+ </dl>
4593
+
4594
+ #### ⚙️ Parameters
4595
+
4596
+ <dl>
4597
+ <dd>
4598
+
4599
+ <dl>
4600
+ <dd>
4601
+
4602
+ **doc_id:** `String`
4603
+
4604
+ </dd>
4605
+ </dl>
4606
+
4607
+ <dl>
4608
+ <dd>
4609
+
4610
+ **sha:** `String`
4611
+
4612
+ </dd>
4613
+ </dl>
4614
+
4615
+ <dl>
4616
+ <dd>
4617
+
4618
+ **since_signature:** `Integer`
4619
+
4620
+ </dd>
4621
+ </dl>
4622
+
4623
+ <dl>
4624
+ <dd>
4625
+
4626
+ **since_revision:** `Integer`
4627
+
4628
+ </dd>
4629
+ </dl>
4630
+
4631
+ <dl>
4632
+ <dd>
4633
+
4634
+ **level:** `CloudPDF::Doc::Versions::Types::AnalysisVersionsRequestLevel`
4635
+
4636
+ </dd>
4637
+ </dl>
4638
+
4639
+ <dl>
4640
+ <dd>
4641
+
4642
+ **until_:** `Integer`
4643
+
4644
+ </dd>
4645
+ </dl>
4646
+
4647
+ <dl>
4648
+ <dd>
4649
+
4650
+ **policy:** `Integer`
4651
+
4652
+ </dd>
4653
+ </dl>
4654
+
4655
+ <dl>
4656
+ <dd>
4657
+
4658
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
4659
+
4660
+ </dd>
4661
+ </dl>
4662
+
4663
+ <dl>
4664
+ <dd>
4665
+
4666
+ **request_options:** `CloudPDF::Doc::Versions::RequestOptions`
4667
+
4668
+ </dd>
4669
+ </dl>
4670
+ </dd>
4671
+ </dl>
4672
+
4673
+
4674
+ </dd>
4675
+ </dl>
4676
+ </details>
4677
+
4678
+ <details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">download</a>(doc_id:, sha:) -> String</code></summary>
4679
+ <dl>
4680
+ <dd>
4681
+
4682
+ #### 🔌 Usage
4683
+
4684
+ <dl>
4685
+ <dd>
4686
+
4687
+ <dl>
4688
+ <dd>
4689
+
4690
+ ```ruby
4691
+ client.doc.versions.download(
4692
+ doc_id: "docId",
4693
+ sha: "sha"
4694
+ )
4695
+ ```
4696
+ </dd>
4697
+ </dl>
4698
+ </dd>
4699
+ </dl>
4700
+
4701
+ #### ⚙️ Parameters
4702
+
4703
+ <dl>
4704
+ <dd>
4705
+
4706
+ <dl>
4707
+ <dd>
4708
+
4709
+ **doc_id:** `String`
4710
+
4711
+ </dd>
4712
+ </dl>
4713
+
4714
+ <dl>
4715
+ <dd>
4716
+
4717
+ **sha:** `String`
4718
+
4719
+ </dd>
4720
+ </dl>
4721
+
4722
+ <dl>
4723
+ <dd>
4724
+
4725
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
4726
+
4727
+ </dd>
4728
+ </dl>
4729
+
4730
+ <dl>
4731
+ <dd>
4732
+
4733
+ **request_options:** `CloudPDF::Doc::Versions::RequestOptions`
4734
+
4735
+ </dd>
4736
+ </dl>
4737
+ </dd>
4738
+ </dl>
4739
+
4740
+
4741
+ </dd>
4742
+ </dl>
4743
+ </details>
4744
+
4745
+ <details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">revision</a>(doc_id:, sha:, index:) -> String</code></summary>
4746
+ <dl>
4747
+ <dd>
4748
+
4749
+ #### 🔌 Usage
4750
+
4751
+ <dl>
4752
+ <dd>
4753
+
4754
+ <dl>
4755
+ <dd>
4756
+
4757
+ ```ruby
4758
+ client.doc.versions.revision(
4759
+ doc_id: "docId",
4760
+ sha: "sha",
4761
+ index: 1
4762
+ )
4763
+ ```
4764
+ </dd>
4765
+ </dl>
4766
+ </dd>
4767
+ </dl>
4768
+
4769
+ #### ⚙️ Parameters
4770
+
4771
+ <dl>
4772
+ <dd>
4773
+
4774
+ <dl>
4775
+ <dd>
4776
+
4777
+ **doc_id:** `String`
4778
+
4779
+ </dd>
4780
+ </dl>
4781
+
4782
+ <dl>
4783
+ <dd>
4784
+
4785
+ **sha:** `String`
4786
+
4787
+ </dd>
4788
+ </dl>
4789
+
4790
+ <dl>
4791
+ <dd>
4792
+
4793
+ **index:** `Integer`
4794
+
4795
+ </dd>
4796
+ </dl>
4797
+
4798
+ <dl>
4799
+ <dd>
4800
+
4801
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
4802
+
4803
+ </dd>
4804
+ </dl>
4805
+
4806
+ <dl>
4807
+ <dd>
4808
+
4809
+ **request_options:** `CloudPDF::Doc::Versions::RequestOptions`
4810
+
4811
+ </dd>
4812
+ </dl>
4813
+ </dd>
4814
+ </dl>
4815
+
4816
+
4817
+ </dd>
4818
+ </dl>
4819
+ </details>
4820
+
4821
+ <details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signatures</a>(doc_id:, sha:) -> CloudPDF::Types::DocVersionsSignatures200Response</code></summary>
4822
+ <dl>
4823
+ <dd>
4824
+
4825
+ #### 🔌 Usage
4826
+
4827
+ <dl>
4828
+ <dd>
4829
+
4830
+ <dl>
4831
+ <dd>
4832
+
4833
+ ```ruby
4834
+ client.doc.versions.signatures(
4835
+ doc_id: "docId",
4836
+ sha: "sha"
4837
+ )
4838
+ ```
4839
+ </dd>
4840
+ </dl>
4841
+ </dd>
4842
+ </dl>
4843
+
4844
+ #### ⚙️ Parameters
4845
+
4846
+ <dl>
4847
+ <dd>
4848
+
4849
+ <dl>
4850
+ <dd>
4851
+
4852
+ **doc_id:** `String`
4853
+
4854
+ </dd>
4855
+ </dl>
4856
+
4857
+ <dl>
4858
+ <dd>
4859
+
4860
+ **sha:** `String`
4861
+
4862
+ </dd>
4863
+ </dl>
4864
+
4865
+ <dl>
4866
+ <dd>
4867
+
4868
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
4869
+
4870
+ </dd>
4871
+ </dl>
4872
+
4873
+ <dl>
4874
+ <dd>
4875
+
4876
+ **request_options:** `CloudPDF::Doc::Versions::RequestOptions`
4877
+
4878
+ </dd>
4879
+ </dl>
4880
+ </dd>
4881
+ </dl>
4882
+
4883
+
4884
+ </dd>
4885
+ </dl>
4886
+ </details>
4887
+
4888
+ <details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signature_contents</a>(doc_id:, sha:, field_key:) -> String</code></summary>
4889
+ <dl>
4890
+ <dd>
4891
+
4892
+ #### 📝 Description
4893
+
4894
+ <dl>
4895
+ <dd>
4896
+
4897
+ <dl>
4898
+ <dd>
4899
+
4900
+ `fieldKey` is the field's fully qualified name, token-text encoded (the same encoding attachment keys use).
4901
+ </dd>
4902
+ </dl>
4903
+ </dd>
4904
+ </dl>
4905
+
4906
+ #### 🔌 Usage
4907
+
4908
+ <dl>
4909
+ <dd>
4910
+
4911
+ <dl>
4912
+ <dd>
4913
+
4914
+ ```ruby
4915
+ client.doc.versions.signature_contents(
4916
+ doc_id: "docId",
4917
+ sha: "sha",
4918
+ field_key: "fieldKey"
4919
+ )
4920
+ ```
4921
+ </dd>
4922
+ </dl>
4923
+ </dd>
4924
+ </dl>
4925
+
4926
+ #### ⚙️ Parameters
4927
+
4928
+ <dl>
4929
+ <dd>
4930
+
4931
+ <dl>
4932
+ <dd>
4933
+
4934
+ **doc_id:** `String`
4935
+
4936
+ </dd>
4937
+ </dl>
4938
+
4939
+ <dl>
4940
+ <dd>
4941
+
4942
+ **sha:** `String`
4943
+
4944
+ </dd>
4945
+ </dl>
4946
+
4947
+ <dl>
4948
+ <dd>
4949
+
4950
+ **field_key:** `String`
4951
+
4952
+ </dd>
4953
+ </dl>
4954
+
4955
+ <dl>
4956
+ <dd>
4957
+
4958
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
4959
+
4960
+ </dd>
4961
+ </dl>
4962
+
4963
+ <dl>
4964
+ <dd>
4965
+
4966
+ **request_options:** `CloudPDF::Doc::Versions::RequestOptions`
4967
+
4968
+ </dd>
4969
+ </dl>
4970
+ </dd>
4971
+ </dl>
4972
+
4973
+
4974
+ </dd>
4975
+ </dl>
4976
+ </details>
4977
+
4978
+ <details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signature_digest</a>(doc_id:, sha:, field_key:, algorithm:) -> String</code></summary>
4979
+ <dl>
4980
+ <dd>
4981
+
4982
+ #### 📝 Description
4983
+
4984
+ <dl>
4985
+ <dd>
4986
+
4987
+ <dl>
4988
+ <dd>
4989
+
4990
+ What a CMS verifier compares its message digest to.
4991
+ </dd>
4992
+ </dl>
4993
+ </dd>
4994
+ </dl>
4995
+
4996
+ #### 🔌 Usage
4997
+
4998
+ <dl>
4999
+ <dd>
5000
+
5001
+ <dl>
5002
+ <dd>
5003
+
5004
+ ```ruby
5005
+ client.doc.versions.signature_digest(
5006
+ doc_id: "docId",
5007
+ sha: "sha",
5008
+ field_key: "fieldKey",
5009
+ algorithm: "sha1"
5010
+ )
5011
+ ```
5012
+ </dd>
5013
+ </dl>
5014
+ </dd>
5015
+ </dl>
5016
+
5017
+ #### ⚙️ Parameters
5018
+
5019
+ <dl>
5020
+ <dd>
5021
+
5022
+ <dl>
5023
+ <dd>
5024
+
5025
+ **doc_id:** `String`
5026
+
5027
+ </dd>
5028
+ </dl>
5029
+
5030
+ <dl>
5031
+ <dd>
5032
+
5033
+ **sha:** `String`
5034
+
5035
+ </dd>
5036
+ </dl>
5037
+
5038
+ <dl>
5039
+ <dd>
5040
+
5041
+ **field_key:** `String`
5042
+
5043
+ </dd>
5044
+ </dl>
5045
+
5046
+ <dl>
5047
+ <dd>
5048
+
5049
+ **algorithm:** `CloudPDF::Doc::Versions::Types::SignatureDigestVersionsRequestAlgorithm`
5050
+
5051
+ </dd>
5052
+ </dl>
5053
+
5054
+ <dl>
5055
+ <dd>
5056
+
5057
+ **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
5058
+
5059
+ </dd>
5060
+ </dl>
5061
+
5062
+ <dl>
5063
+ <dd>
5064
+
5065
+ **request_options:** `CloudPDF::Doc::Versions::RequestOptions`
3688
5066
 
3689
5067
  </dd>
3690
5068
  </dl>