cloudpdf 3.0.0.alpha.15 → 3.0.0.alpha.16

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 (229) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +2 -2
  3. data/lib/CloudPDF/doc/annotations/client.rb +48 -0
  4. data/lib/CloudPDF/doc/{pages/types/delete_pages_request.rb → annotations/types/read_file_annotations_request.rb} +5 -5
  5. data/lib/CloudPDF/doc/attachments/client.rb +109 -0
  6. data/lib/CloudPDF/doc/{pages/types/insert_pages_request.rb → attachments/types/download_attachments_request.rb} +4 -4
  7. data/lib/CloudPDF/doc/{pages/types/rotate_pages_request.rb → attachments/types/list_attachments_request.rb} +2 -6
  8. data/lib/CloudPDF/doc/client.rb +15 -4
  9. data/lib/CloudPDF/doc/outline/client.rb +60 -0
  10. data/lib/CloudPDF/doc/{pages/types/insert_blank_pages_request.rb → outline/types/get_outline_request.rb} +2 -6
  11. data/lib/CloudPDF/doc/pages/client.rb +6 -274
  12. data/lib/CloudPDF/types/annotation_file_attachment.rb +1 -1
  13. data/lib/CloudPDF/types/attachment.rb +25 -0
  14. data/lib/CloudPDF/types/attachment_file_base.rb +13 -0
  15. data/lib/CloudPDF/types/{annotation_file_attachment_file.rb → attachment_file_info.rb} +1 -1
  16. data/lib/CloudPDF/types/attachment_list.rb +9 -0
  17. data/lib/CloudPDF/types/attachment_mutation_meta.rb +17 -0
  18. data/lib/CloudPDF/types/attachment_ref.rb +11 -0
  19. data/lib/CloudPDF/types/attachment_ref_kind.rb +11 -0
  20. data/lib/CloudPDF/types/cache_delta.rb +2 -0
  21. data/lib/CloudPDF/types/change_item.rb +28 -0
  22. data/lib/CloudPDF/types/change_item_attachments_create.rb +11 -0
  23. data/lib/CloudPDF/types/change_item_attachments_delete.rb +9 -0
  24. data/lib/CloudPDF/types/change_item_attachments_restore.rb +11 -0
  25. data/lib/CloudPDF/types/change_item_outline_create.rb +13 -0
  26. data/lib/CloudPDF/types/change_item_outline_delete.rb +9 -0
  27. data/lib/CloudPDF/types/change_item_outline_move.rb +11 -0
  28. data/lib/CloudPDF/types/change_item_outline_restore.rb +13 -0
  29. data/lib/CloudPDF/types/change_item_outline_update.rb +13 -0
  30. data/lib/CloudPDF/types/{doc_pages_reorder200response.rb → change_item_pages_delete.rb} +2 -2
  31. data/lib/CloudPDF/types/{doc_pages_insert200response_layout.rb → change_item_pages_delete_layout.rb} +3 -3
  32. data/lib/CloudPDF/types/change_item_pages_delete_layout_named_pages_item.rb +11 -0
  33. data/lib/CloudPDF/types/change_item_pages_delete_layout_named_pages_item_target.rb +17 -0
  34. data/lib/CloudPDF/types/change_item_pages_delete_layout_named_pages_item_target_dangling.rb +7 -0
  35. data/lib/CloudPDF/types/{doc_pages_insert200response_layout_named_pages_item_target_page.rb → change_item_pages_delete_layout_named_pages_item_target_page.rb} +1 -1
  36. data/lib/CloudPDF/types/{doc_pages_insert200response_layout_named_pages_item_target_template.rb → change_item_pages_delete_layout_named_pages_item_target_template.rb} +1 -1
  37. data/lib/CloudPDF/types/change_item_pages_delete_layout_pages_item.rb +27 -0
  38. data/lib/CloudPDF/types/change_item_pages_delete_layout_pages_item_boxes.rb +17 -0
  39. data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_pages_item_boxes_art.rb → change_item_pages_delete_layout_pages_item_boxes_art.rb} +1 -1
  40. data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_boxes_art.rb → change_item_pages_delete_layout_pages_item_boxes_bleed.rb} +1 -1
  41. data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_boxes_art.rb → change_item_pages_delete_layout_pages_item_boxes_crop.rb} +1 -1
  42. data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_boxes_trim.rb → change_item_pages_delete_layout_pages_item_boxes_media.rb} +1 -1
  43. data/lib/CloudPDF/types/change_item_pages_delete_layout_pages_item_boxes_trim.rb +15 -0
  44. data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_pdf_crop_box.rb → change_item_pages_delete_layout_pages_item_pdf_crop_box.rb} +1 -1
  45. data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_pages_item_size.rb → change_item_pages_delete_layout_pages_item_size.rb} +1 -1
  46. data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_tab_order.rb → change_item_pages_delete_layout_pages_item_tab_order.rb} +1 -1
  47. data/lib/CloudPDF/types/{doc_pages_insert200response.rb → change_item_pages_insert.rb} +2 -2
  48. data/lib/CloudPDF/types/{doc_pages_insert_blank200response.rb → change_item_pages_insert_blank.rb} +2 -2
  49. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout.rb → change_item_pages_insert_blank_layout.rb} +3 -3
  50. data/lib/CloudPDF/types/change_item_pages_insert_blank_layout_named_pages_item.rb +11 -0
  51. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_named_pages_item_target.rb → change_item_pages_insert_blank_layout_named_pages_item_target.rb} +4 -4
  52. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_named_pages_item_target_dangling.rb → change_item_pages_insert_blank_layout_named_pages_item_target_dangling.rb} +1 -1
  53. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_named_pages_item_target_page.rb → change_item_pages_insert_blank_layout_named_pages_item_target_page.rb} +1 -1
  54. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_named_pages_item_target_template.rb → change_item_pages_insert_blank_layout_named_pages_item_target_template.rb} +1 -1
  55. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item.rb → change_item_pages_insert_blank_layout_pages_item.rb} +5 -5
  56. data/lib/CloudPDF/types/change_item_pages_insert_blank_layout_pages_item_boxes.rb +17 -0
  57. data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_boxes_crop.rb → change_item_pages_insert_blank_layout_pages_item_boxes_art.rb} +1 -1
  58. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item_boxes_bleed.rb → change_item_pages_insert_blank_layout_pages_item_boxes_bleed.rb} +1 -1
  59. data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_boxes_bleed.rb → change_item_pages_insert_blank_layout_pages_item_boxes_crop.rb} +1 -1
  60. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item_boxes_media.rb → change_item_pages_insert_blank_layout_pages_item_boxes_media.rb} +1 -1
  61. data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_boxes_media.rb → change_item_pages_insert_blank_layout_pages_item_boxes_trim.rb} +1 -1
  62. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item_pdf_crop_box.rb → change_item_pages_insert_blank_layout_pages_item_pdf_crop_box.rb} +1 -1
  63. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item_size.rb → change_item_pages_insert_blank_layout_pages_item_size.rb} +1 -1
  64. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item_tab_order.rb → change_item_pages_insert_blank_layout_pages_item_tab_order.rb} +1 -1
  65. data/lib/CloudPDF/types/{doc_pages_delete200response_layout.rb → change_item_pages_insert_layout.rb} +3 -3
  66. data/lib/CloudPDF/types/change_item_pages_insert_layout_named_pages_item.rb +11 -0
  67. data/lib/CloudPDF/types/change_item_pages_insert_layout_named_pages_item_target.rb +17 -0
  68. data/lib/CloudPDF/types/change_item_pages_insert_layout_named_pages_item_target_dangling.rb +7 -0
  69. data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_named_pages_item_target_page.rb → change_item_pages_insert_layout_named_pages_item_target_page.rb} +1 -1
  70. data/lib/CloudPDF/types/{doc_pages_delete200response_layout_named_pages_item_target_template.rb → change_item_pages_insert_layout_named_pages_item_target_template.rb} +1 -1
  71. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item.rb +27 -0
  72. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes.rb +17 -0
  73. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_art.rb +15 -0
  74. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_bleed.rb +15 -0
  75. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_crop.rb +15 -0
  76. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_media.rb +15 -0
  77. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_trim.rb +15 -0
  78. data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_pdf_crop_box.rb → change_item_pages_insert_layout_pages_item_pdf_crop_box.rb} +1 -1
  79. data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_size.rb → change_item_pages_insert_layout_pages_item_size.rb} +1 -1
  80. data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_pages_item_tab_order.rb → change_item_pages_insert_layout_pages_item_tab_order.rb} +1 -1
  81. data/lib/CloudPDF/types/change_item_pages_reorder.rb +13 -0
  82. data/lib/CloudPDF/types/{doc_pages_rotate200response_layout.rb → change_item_pages_reorder_layout.rb} +3 -3
  83. data/lib/CloudPDF/types/change_item_pages_reorder_layout_named_pages_item.rb +11 -0
  84. data/lib/CloudPDF/types/change_item_pages_reorder_layout_named_pages_item_target.rb +17 -0
  85. data/lib/CloudPDF/types/change_item_pages_reorder_layout_named_pages_item_target_dangling.rb +7 -0
  86. data/lib/CloudPDF/types/{doc_pages_delete200response_layout_named_pages_item_target_page.rb → change_item_pages_reorder_layout_named_pages_item_target_page.rb} +1 -1
  87. data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_named_pages_item_target_template.rb → change_item_pages_reorder_layout_named_pages_item_target_template.rb} +1 -1
  88. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item.rb +27 -0
  89. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes.rb +17 -0
  90. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_art.rb +15 -0
  91. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_bleed.rb +15 -0
  92. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_crop.rb +15 -0
  93. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_media.rb +15 -0
  94. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_trim.rb +15 -0
  95. data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_pages_item_pdf_crop_box.rb → change_item_pages_reorder_layout_pages_item_pdf_crop_box.rb} +1 -1
  96. data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_size.rb → change_item_pages_reorder_layout_pages_item_size.rb} +1 -1
  97. data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_tab_order.rb → change_item_pages_reorder_layout_pages_item_tab_order.rb} +1 -1
  98. data/lib/CloudPDF/types/change_item_pages_restore.rb +13 -0
  99. data/lib/CloudPDF/types/change_item_pages_restore_layout.rb +13 -0
  100. data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item.rb +11 -0
  101. data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item_target.rb +17 -0
  102. data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item_target_dangling.rb +7 -0
  103. data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item_target_page.rb +9 -0
  104. data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item_target_template.rb +9 -0
  105. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item.rb +27 -0
  106. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes.rb +17 -0
  107. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_art.rb +15 -0
  108. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_bleed.rb +15 -0
  109. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_crop.rb +15 -0
  110. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_media.rb +15 -0
  111. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_trim.rb +15 -0
  112. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_pdf_crop_box.rb +15 -0
  113. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_size.rb +11 -0
  114. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_tab_order.rb +15 -0
  115. data/lib/CloudPDF/types/change_item_pages_rotate.rb +15 -0
  116. data/lib/CloudPDF/types/change_item_pages_rotate_layout.rb +13 -0
  117. data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item.rb +11 -0
  118. data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item_target.rb +17 -0
  119. data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item_target_dangling.rb +7 -0
  120. data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item_target_page.rb +9 -0
  121. data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item_target_template.rb +9 -0
  122. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item.rb +27 -0
  123. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes.rb +17 -0
  124. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_art.rb +15 -0
  125. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_bleed.rb +15 -0
  126. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_crop.rb +15 -0
  127. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_media.rb +15 -0
  128. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_trim.rb +15 -0
  129. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_pdf_crop_box.rb +15 -0
  130. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_size.rb +11 -0
  131. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_tab_order.rb +15 -0
  132. data/lib/CloudPDF/types/change_item_skipped_op.rb +15 -0
  133. data/lib/CloudPDF/types/change_op.rb +22 -0
  134. data/lib/CloudPDF/types/change_op_attachments_create.rb +11 -0
  135. data/lib/CloudPDF/types/change_op_attachments_create_resources.rb +9 -0
  136. data/lib/CloudPDF/types/change_op_attachments_delete.rb +9 -0
  137. data/lib/CloudPDF/types/change_op_outline_create.rb +15 -0
  138. data/lib/CloudPDF/types/change_op_outline_delete.rb +11 -0
  139. data/lib/CloudPDF/types/change_op_outline_move.rb +13 -0
  140. data/lib/CloudPDF/types/change_op_outline_update.rb +13 -0
  141. data/lib/CloudPDF/types/change_op_pages_delete.rb +9 -0
  142. data/lib/CloudPDF/types/change_op_pages_insert.rb +11 -0
  143. data/lib/CloudPDF/types/change_op_pages_insert_blank.rb +13 -0
  144. data/lib/CloudPDF/types/change_op_pages_insert_blank_spec.rb +11 -0
  145. data/lib/CloudPDF/types/change_op_pages_insert_blank_spec_size.rb +11 -0
  146. data/lib/CloudPDF/types/change_op_pages_insert_resources.rb +9 -0
  147. data/lib/CloudPDF/types/change_op_pages_reorder.rb +11 -0
  148. data/lib/CloudPDF/types/change_op_pages_rotate.rb +11 -0
  149. data/lib/CloudPDF/types/{doc_pages_delete404response.rb → doc_annotations_read_file400response.rb} +2 -2
  150. data/lib/CloudPDF/types/{doc_pages_delete_request.rb → doc_annotations_read_file404response.rb} +2 -2
  151. data/lib/CloudPDF/types/doc_annotations_read_file413response.rb +23 -0
  152. data/lib/CloudPDF/types/doc_attachments_download400response.rb +23 -0
  153. data/lib/CloudPDF/types/doc_attachments_download404response.rb +23 -0
  154. data/lib/CloudPDF/types/doc_attachments_download413response.rb +23 -0
  155. data/lib/CloudPDF/types/{doc_pages_insert400response.rb → doc_attachments_list200response.rb} +2 -2
  156. data/lib/CloudPDF/types/{doc_pages_delete400response.rb → doc_attachments_list404response.rb} +2 -2
  157. data/lib/CloudPDF/types/doc_manifest200response.rb +2 -0
  158. data/lib/CloudPDF/types/doc_manifest200response_scopes.rb +2 -0
  159. data/lib/CloudPDF/types/doc_manifest200response_scopes_outline.rb +12 -0
  160. data/lib/CloudPDF/types/{doc_pages_insert_blank_request.rb → doc_outline_get200response.rb} +2 -2
  161. data/lib/CloudPDF/types/{doc_pages_rotate_request.rb → doc_outline_get404response.rb} +2 -2
  162. data/lib/CloudPDF/types/document_outline.rb +11 -0
  163. data/lib/CloudPDF/types/outline_item.rb +25 -0
  164. data/lib/CloudPDF/types/outline_item_draft.rb +17 -0
  165. data/lib/CloudPDF/types/outline_item_patch.rb +19 -0
  166. data/lib/CloudPDF/types/{doc_pages_insert_blank200response_layout_named_pages_item_target_template.rb → outline_item_ref.rb} +3 -1
  167. data/lib/CloudPDF/types/outline_item_ref_kind.rb +11 -0
  168. data/lib/CloudPDF/types/outline_mutation_meta.rb +17 -0
  169. data/lib/CloudPDF/types/outline_order.rb +11 -0
  170. data/lib/CloudPDF/types/outline_position.rb +13 -0
  171. data/lib/CloudPDF/types/outline_position_after.rb +11 -0
  172. data/lib/CloudPDF/types/outline_position_zero.rb +12 -0
  173. data/lib/CloudPDF/version.rb +1 -1
  174. data/lib/cloudpdf.rb +163 -107
  175. data/reference.md +235 -353
  176. metadata +162 -106
  177. data/lib/CloudPDF/doc/pages/types/doc_pages_reorder_request.rb +0 -23
  178. data/lib/CloudPDF/types/doc_pages_delete200response.rb +0 -11
  179. data/lib/CloudPDF/types/doc_pages_delete200response_layout_named_pages_item.rb +0 -11
  180. data/lib/CloudPDF/types/doc_pages_delete200response_layout_named_pages_item_target.rb +0 -17
  181. data/lib/CloudPDF/types/doc_pages_delete200response_layout_named_pages_item_target_dangling.rb +0 -7
  182. data/lib/CloudPDF/types/doc_pages_delete200response_layout_pages_item.rb +0 -27
  183. data/lib/CloudPDF/types/doc_pages_delete200response_layout_pages_item_boxes.rb +0 -17
  184. data/lib/CloudPDF/types/doc_pages_delete200response_layout_pages_item_boxes_bleed.rb +0 -15
  185. data/lib/CloudPDF/types/doc_pages_delete200response_layout_pages_item_boxes_media.rb +0 -15
  186. data/lib/CloudPDF/types/doc_pages_insert200response_layout_named_pages_item.rb +0 -11
  187. data/lib/CloudPDF/types/doc_pages_insert200response_layout_named_pages_item_target.rb +0 -17
  188. data/lib/CloudPDF/types/doc_pages_insert200response_layout_named_pages_item_target_dangling.rb +0 -7
  189. data/lib/CloudPDF/types/doc_pages_insert200response_layout_pages_item.rb +0 -27
  190. data/lib/CloudPDF/types/doc_pages_insert200response_layout_pages_item_boxes.rb +0 -17
  191. data/lib/CloudPDF/types/doc_pages_insert200response_layout_pages_item_boxes_crop.rb +0 -15
  192. data/lib/CloudPDF/types/doc_pages_insert200response_layout_pages_item_boxes_trim.rb +0 -15
  193. data/lib/CloudPDF/types/doc_pages_insert404response.rb +0 -23
  194. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout.rb +0 -13
  195. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_named_pages_item.rb +0 -11
  196. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_named_pages_item_target.rb +0 -17
  197. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_named_pages_item_target_dangling.rb +0 -7
  198. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_named_pages_item_target_page.rb +0 -9
  199. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item.rb +0 -27
  200. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes.rb +0 -17
  201. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_art.rb +0 -15
  202. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_bleed.rb +0 -15
  203. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_crop.rb +0 -15
  204. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_media.rb +0 -15
  205. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_trim.rb +0 -15
  206. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_pdf_crop_box.rb +0 -15
  207. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_size.rb +0 -11
  208. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_tab_order.rb +0 -15
  209. data/lib/CloudPDF/types/doc_pages_insert_blank400response.rb +0 -23
  210. data/lib/CloudPDF/types/doc_pages_insert_blank404response.rb +0 -23
  211. data/lib/CloudPDF/types/doc_pages_reorder200response_layout_named_pages_item.rb +0 -11
  212. data/lib/CloudPDF/types/doc_pages_reorder200response_layout_pages_item_boxes.rb +0 -17
  213. data/lib/CloudPDF/types/doc_pages_reorder200response_layout_pages_item_boxes_art.rb +0 -15
  214. data/lib/CloudPDF/types/doc_pages_reorder200response_layout_pages_item_boxes_crop.rb +0 -15
  215. data/lib/CloudPDF/types/doc_pages_reorder200response_layout_pages_item_boxes_trim.rb +0 -15
  216. data/lib/CloudPDF/types/doc_pages_reorder400response.rb +0 -23
  217. data/lib/CloudPDF/types/doc_pages_reorder404response.rb +0 -23
  218. data/lib/CloudPDF/types/doc_pages_rotate200response.rb +0 -11
  219. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_named_pages_item.rb +0 -11
  220. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_named_pages_item_target.rb +0 -17
  221. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_named_pages_item_target_dangling.rb +0 -7
  222. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item.rb +0 -27
  223. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes.rb +0 -17
  224. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes_bleed.rb +0 -15
  225. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes_crop.rb +0 -15
  226. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes_media.rb +0 -15
  227. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes_trim.rb +0 -15
  228. data/lib/CloudPDF/types/doc_pages_rotate400response.rb +0 -23
  229. data/lib/CloudPDF/types/doc_pages_rotate404response.rb +0 -23
data/reference.md CHANGED
@@ -109,7 +109,7 @@ client.doc.head(doc_id: "docId")
109
109
  <dl>
110
110
  <dd>
111
111
 
112
- Each change stands on its own and names itself by `opId`: a refused change rolls back alone, and the answer lists every change in order, applied with its result or refused with its error. Asked again under its `opId`, a change gets the same answer, refusals included; a different change under an answered `opId` is refused (IdempotencyKeyReused). `{ opId, undoOf }` undoes an earlier change of the caller, here or in an earlier request; an undo leaves alone what was changed since, and the undo of an undo redoes. A redaction, a flatten, a form repair or a completed signature ends undo for the changes before it (UndoUnavailable). Each op is checked against its own capability: annotation ops need `doc.annotate.modify`, form values `doc.forms.fill`, form structure `doc.forms.modify`, metadata `doc.metadata.modify`. Bytes (a stamp's drawing, an attached file, a signature's artwork) travel as multipart: a JSON `body` part, each op naming its files by role as `resources: { <role>: '<key>' }`, and each file as the part `resource:<key>`. At most 64 changes per request and 512 ops per change.
112
+ Each change stands on its own and names itself by `opId`: a refused change rolls back alone, and the answer lists every change in order, applied with its result or refused with its error. Asked again under its `opId`, a change gets the same answer, refusals included; a different change under an answered `opId` is refused (IdempotencyKeyReused). `{ opId, undoOf }` undoes an earlier change of the caller, here or in an earlier request; an undo leaves alone what was changed since, and the undo of an undo redoes. A redaction, a flatten, a form repair or a completed signature ends undo for the changes before it (UndoUnavailable). Each op is checked against its own capability: annotation ops need `doc.annotate.modify`, form values `doc.forms.fill`, form structure `doc.forms.modify`, metadata `doc.metadata.modify`, outline `doc.outline.modify`, pages `doc.pages.assemble`, embedded files `doc.attachments.modify`. Bytes (a stamp's drawing, an attached file, a signature's artwork, a PDF whose pages come in) travel as multipart: a JSON `body` part, each op naming its files by role as `resources: { <role>: '<key>' }`, and each file as the part `resource:<key>`. At most 64 changes per request and 512 ops per change.
113
113
  </dd>
114
114
  </dl>
115
115
  </dd>
@@ -2786,10 +2786,24 @@ client.doc.annotations.read_appearance(
2786
2786
  </dl>
2787
2787
  </details>
2788
2788
 
2789
- <details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">export_appearance</a>(doc_id:, layer_name:, page_key:, request) -> String</code></summary>
2789
+ <details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">read_file</a>(doc_id:, layer_name:, page_key:, annot_key:) -> String</code></summary>
2790
+ <dl>
2791
+ <dd>
2792
+
2793
+ #### 📝 Description
2794
+
2790
2795
  <dl>
2791
2796
  <dd>
2792
2797
 
2798
+ <dl>
2799
+ <dd>
2800
+
2801
+ A file that decodes past the server's limit is refused (PayloadTooLarge).
2802
+ </dd>
2803
+ </dl>
2804
+ </dd>
2805
+ </dl>
2806
+
2793
2807
  #### 🔌 Usage
2794
2808
 
2795
2809
  <dl>
@@ -2799,15 +2813,11 @@ client.doc.annotations.read_appearance(
2799
2813
  <dd>
2800
2814
 
2801
2815
  ```ruby
2802
- client.doc.annotations.export_appearance(
2816
+ client.doc.annotations.read_file(
2803
2817
  doc_id: "docId",
2804
2818
  layer_name: "layerName",
2805
2819
  page_key: "pageKey",
2806
- request: {
2807
- string: {
2808
- key: "value"
2809
- }
2810
- }
2820
+ annot_key: "annotKey"
2811
2821
  )
2812
2822
  ```
2813
2823
  </dd>
@@ -2847,7 +2857,7 @@ client.doc.annotations.export_appearance(
2847
2857
  <dl>
2848
2858
  <dd>
2849
2859
 
2850
- **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.
2860
+ **annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
2851
2861
 
2852
2862
  </dd>
2853
2863
  </dl>
@@ -2855,7 +2865,7 @@ client.doc.annotations.export_appearance(
2855
2865
  <dl>
2856
2866
  <dd>
2857
2867
 
2858
- **request:** `Internal::Types::Hash[String, Object]`
2868
+ **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.
2859
2869
 
2860
2870
  </dd>
2861
2871
  </dl>
@@ -2875,7 +2885,7 @@ client.doc.annotations.export_appearance(
2875
2885
  </dl>
2876
2886
  </details>
2877
2887
 
2878
- <details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">flatten</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocAnnotationsFlatten200Response</code></summary>
2888
+ <details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">export_appearance</a>(doc_id:, layer_name:, page_key:, request) -> String</code></summary>
2879
2889
  <dl>
2880
2890
  <dd>
2881
2891
 
@@ -2888,12 +2898,14 @@ client.doc.annotations.export_appearance(
2888
2898
  <dd>
2889
2899
 
2890
2900
  ```ruby
2891
- client.doc.annotations.flatten(
2901
+ client.doc.annotations.export_appearance(
2892
2902
  doc_id: "docId",
2893
2903
  layer_name: "layerName",
2894
2904
  page_key: "pageKey",
2895
2905
  request: {
2896
- key: "value"
2906
+ string: {
2907
+ key: "value"
2908
+ }
2897
2909
  }
2898
2910
  )
2899
2911
  ```
@@ -2942,14 +2954,6 @@ client.doc.annotations.flatten(
2942
2954
  <dl>
2943
2955
  <dd>
2944
2956
 
2945
- **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
2946
-
2947
- </dd>
2948
- </dl>
2949
-
2950
- <dl>
2951
- <dd>
2952
-
2953
2957
  **request:** `Internal::Types::Hash[String, Object]`
2954
2958
 
2955
2959
  </dd>
@@ -2970,7 +2974,7 @@ client.doc.annotations.flatten(
2970
2974
  </dl>
2971
2975
  </details>
2972
2976
 
2973
- <details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">reorder</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocAnnotationsReorder200Response</code></summary>
2977
+ <details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">flatten</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocAnnotationsFlatten200Response</code></summary>
2974
2978
  <dl>
2975
2979
  <dd>
2976
2980
 
@@ -2983,12 +2987,13 @@ client.doc.annotations.flatten(
2983
2987
  <dd>
2984
2988
 
2985
2989
  ```ruby
2986
- client.doc.annotations.reorder(
2990
+ client.doc.annotations.flatten(
2987
2991
  doc_id: "docId",
2988
2992
  layer_name: "layerName",
2989
2993
  page_key: "pageKey",
2990
- refs: [],
2991
- position: "start"
2994
+ request: {
2995
+ key: "value"
2996
+ }
2992
2997
  )
2993
2998
  ```
2994
2999
  </dd>
@@ -3044,15 +3049,7 @@ client.doc.annotations.reorder(
3044
3049
  <dl>
3045
3050
  <dd>
3046
3051
 
3047
- **refs:** `Internal::Types::Array[CloudPDF::Types::AnnotationRef]`
3048
-
3049
- </dd>
3050
- </dl>
3051
-
3052
- <dl>
3053
- <dd>
3054
-
3055
- **position:** `CloudPDF::Types::AnnotationPosition`
3052
+ **request:** `Internal::Types::Hash[String, Object]`
3056
3053
 
3057
3054
  </dd>
3058
3055
  </dl>
@@ -3072,8 +3069,7 @@ client.doc.annotations.reorder(
3072
3069
  </dl>
3073
3070
  </details>
3074
3071
 
3075
- ## Doc Forms
3076
- <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">list</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocFormsList200Response</code></summary>
3072
+ <details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">reorder</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocAnnotationsReorder200Response</code></summary>
3077
3073
  <dl>
3078
3074
  <dd>
3079
3075
 
@@ -3086,9 +3082,12 @@ client.doc.annotations.reorder(
3086
3082
  <dd>
3087
3083
 
3088
3084
  ```ruby
3089
- client.doc.forms.list(
3085
+ client.doc.annotations.reorder(
3090
3086
  doc_id: "docId",
3091
- layer_name: "layerName"
3087
+ layer_name: "layerName",
3088
+ page_key: "pageKey",
3089
+ refs: [],
3090
+ position: "start"
3092
3091
  )
3093
3092
  ```
3094
3093
  </dd>
@@ -3120,7 +3119,7 @@ client.doc.forms.list(
3120
3119
  <dl>
3121
3120
  <dd>
3122
3121
 
3123
- **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.
3122
+ **page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
3124
3123
 
3125
3124
  </dd>
3126
3125
  </dl>
@@ -3128,52 +3127,23 @@ client.doc.forms.list(
3128
3127
  <dl>
3129
3128
  <dd>
3130
3129
 
3131
- **request_options:** `CloudPDF::Doc::Forms::RequestOptions`
3130
+ **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.
3132
3131
 
3133
3132
  </dd>
3134
3133
  </dl>
3135
- </dd>
3136
- </dl>
3137
-
3138
-
3139
- </dd>
3140
- </dl>
3141
- </details>
3142
3134
 
3143
- <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reorder_calculations</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocFormsReorderCalculations200Response</code></summary>
3144
3135
  <dl>
3145
3136
  <dd>
3146
3137
 
3147
- #### 🔌 Usage
3148
-
3149
- <dl>
3150
- <dd>
3151
-
3152
- <dl>
3153
- <dd>
3154
-
3155
- ```ruby
3156
- client.doc.forms.reorder_calculations(
3157
- doc_id: "docId",
3158
- layer_name: "layerName",
3159
- fields: [],
3160
- position: "start"
3161
- )
3162
- ```
3163
- </dd>
3164
- </dl>
3138
+ **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
3139
+
3165
3140
  </dd>
3166
3141
  </dl>
3167
3142
 
3168
- #### ⚙️ Parameters
3169
-
3170
- <dl>
3171
- <dd>
3172
-
3173
3143
  <dl>
3174
3144
  <dd>
3175
3145
 
3176
- **doc_id:** `String`
3146
+ **refs:** `Internal::Types::Array[CloudPDF::Types::AnnotationRef]`
3177
3147
 
3178
3148
  </dd>
3179
3149
  </dl>
@@ -3181,7 +3151,7 @@ client.doc.forms.reorder_calculations(
3181
3151
  <dl>
3182
3152
  <dd>
3183
3153
 
3184
- **layer_name:** `String`
3154
+ **position:** `CloudPDF::Types::AnnotationPosition`
3185
3155
 
3186
3156
  </dd>
3187
3157
  </dl>
@@ -3189,54 +3159,37 @@ client.doc.forms.reorder_calculations(
3189
3159
  <dl>
3190
3160
  <dd>
3191
3161
 
3192
- **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.
3162
+ **request_options:** `CloudPDF::Doc::Annotations::RequestOptions`
3193
3163
 
3194
3164
  </dd>
3195
3165
  </dl>
3166
+ </dd>
3167
+ </dl>
3196
3168
 
3197
- <dl>
3198
- <dd>
3199
3169
 
3200
- **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
3201
-
3202
3170
  </dd>
3203
3171
  </dl>
3172
+ </details>
3204
3173
 
3174
+ ## Doc Attachments
3175
+ <details><summary><code>client.doc.attachments.<a href="/lib/CloudPDF/doc/attachments/client.rb">download</a>(doc_id:, layer_name:, file_key:) -> String</code></summary>
3205
3176
  <dl>
3206
3177
  <dd>
3207
3178
 
3208
- **fields:** `Internal::Types::Array[CloudPDF::Types::FormFieldRef]`
3209
-
3210
- </dd>
3211
- </dl>
3179
+ #### 📝 Description
3212
3180
 
3213
3181
  <dl>
3214
3182
  <dd>
3215
3183
 
3216
- **position:** `CloudPDF::Types::FieldPosition`
3217
-
3218
- </dd>
3219
- </dl>
3220
-
3221
3184
  <dl>
3222
3185
  <dd>
3223
3186
 
3224
- **request_options:** `CloudPDF::Doc::Forms::RequestOptions`
3225
-
3187
+ A file that decodes past the server's limit is refused (PayloadTooLarge).
3226
3188
  </dd>
3227
3189
  </dl>
3228
3190
  </dd>
3229
3191
  </dl>
3230
3192
 
3231
-
3232
- </dd>
3233
- </dl>
3234
- </details>
3235
-
3236
- <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">set_value</a>(doc_id:, layer_name:, field_key:, request) -> CloudPDF::Types::DocFormsSetValue200Response</code></summary>
3237
- <dl>
3238
- <dd>
3239
-
3240
3193
  #### 🔌 Usage
3241
3194
 
3242
3195
  <dl>
@@ -3246,13 +3199,10 @@ client.doc.forms.reorder_calculations(
3246
3199
  <dd>
3247
3200
 
3248
3201
  ```ruby
3249
- client.doc.forms.set_value(
3202
+ client.doc.attachments.download(
3250
3203
  doc_id: "docId",
3251
3204
  layer_name: "layerName",
3252
- field_key: "fieldKey",
3253
- request: {
3254
- key: "value"
3255
- }
3205
+ file_key: "fileKey"
3256
3206
  )
3257
3207
  ```
3258
3208
  </dd>
@@ -3284,7 +3234,7 @@ client.doc.forms.set_value(
3284
3234
  <dl>
3285
3235
  <dd>
3286
3236
 
3287
- **field_key:** `String`
3237
+ **file_key:** `String` — The embedded file's name-tree key (its `ref.key`), token-text encoded, as `fieldKey` is.
3288
3238
 
3289
3239
  </dd>
3290
3240
  </dl>
@@ -3300,38 +3250,36 @@ client.doc.forms.set_value(
3300
3250
  <dl>
3301
3251
  <dd>
3302
3252
 
3303
- **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
3253
+ **request_options:** `CloudPDF::Doc::Attachments::RequestOptions`
3304
3254
 
3305
3255
  </dd>
3306
3256
  </dl>
3257
+ </dd>
3258
+ </dl>
3307
3259
 
3308
- <dl>
3309
- <dd>
3310
3260
 
3311
- **request:** `Internal::Types::Hash[String, Object]`
3312
-
3313
3261
  </dd>
3314
3262
  </dl>
3263
+ </details>
3315
3264
 
3265
+ <details><summary><code>client.doc.attachments.<a href="/lib/CloudPDF/doc/attachments/client.rb">list</a>(doc_id:, layer_name:) -> CloudPDF::Types::AttachmentList</code></summary>
3316
3266
  <dl>
3317
3267
  <dd>
3318
3268
 
3319
- **request_options:** `CloudPDF::Doc::Forms::RequestOptions`
3320
-
3321
- </dd>
3322
- </dl>
3323
- </dd>
3324
- </dl>
3325
-
3269
+ #### 📝 Description
3326
3270
 
3327
- </dd>
3328
- </dl>
3329
- </details>
3271
+ <dl>
3272
+ <dd>
3330
3273
 
3331
- <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reset</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocFormsReset200Response</code></summary>
3332
3274
  <dl>
3333
3275
  <dd>
3334
3276
 
3277
+ A file-attachment annotation's file is listed with the annotation; read its bytes with `doc.annotations.readFile`.
3278
+ </dd>
3279
+ </dl>
3280
+ </dd>
3281
+ </dl>
3282
+
3335
3283
  #### 🔌 Usage
3336
3284
 
3337
3285
  <dl>
@@ -3341,7 +3289,7 @@ client.doc.forms.set_value(
3341
3289
  <dd>
3342
3290
 
3343
3291
  ```ruby
3344
- client.doc.forms.reset(
3292
+ client.doc.attachments.list(
3345
3293
  doc_id: "docId",
3346
3294
  layer_name: "layerName"
3347
3295
  )
@@ -3383,23 +3331,7 @@ client.doc.forms.reset(
3383
3331
  <dl>
3384
3332
  <dd>
3385
3333
 
3386
- **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
3387
-
3388
- </dd>
3389
- </dl>
3390
-
3391
- <dl>
3392
- <dd>
3393
-
3394
- **refs:** `Internal::Types::Array[CloudPDF::Types::FormFieldRef]`
3395
-
3396
- </dd>
3397
- </dl>
3398
-
3399
- <dl>
3400
- <dd>
3401
-
3402
- **request_options:** `CloudPDF::Doc::Forms::RequestOptions`
3334
+ **request_options:** `CloudPDF::Doc::Attachments::RequestOptions`
3403
3335
 
3404
3336
  </dd>
3405
3337
  </dl>
@@ -3411,7 +3343,8 @@ client.doc.forms.reset(
3411
3343
  </dl>
3412
3344
  </details>
3413
3345
 
3414
- <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">delete_widget</a>(doc_id:, layer_name:, page_key:, annot_key:) -> CloudPDF::Types::DocFormsDeleteWidget200Response</code></summary>
3346
+ ## Doc Forms
3347
+ <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">list</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocFormsList200Response</code></summary>
3415
3348
  <dl>
3416
3349
  <dd>
3417
3350
 
@@ -3424,11 +3357,9 @@ client.doc.forms.reset(
3424
3357
  <dd>
3425
3358
 
3426
3359
  ```ruby
3427
- client.doc.forms.delete_widget(
3360
+ client.doc.forms.list(
3428
3361
  doc_id: "docId",
3429
- layer_name: "layerName",
3430
- page_key: "pageKey",
3431
- annot_key: "annotKey"
3362
+ layer_name: "layerName"
3432
3363
  )
3433
3364
  ```
3434
3365
  </dd>
@@ -3460,22 +3391,6 @@ client.doc.forms.delete_widget(
3460
3391
  <dl>
3461
3392
  <dd>
3462
3393
 
3463
- **page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
3464
-
3465
- </dd>
3466
- </dl>
3467
-
3468
- <dl>
3469
- <dd>
3470
-
3471
- **annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
3472
-
3473
- </dd>
3474
- </dl>
3475
-
3476
- <dl>
3477
- <dd>
3478
-
3479
3394
  **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.
3480
3395
 
3481
3396
  </dd>
@@ -3484,14 +3399,6 @@ client.doc.forms.delete_widget(
3484
3399
  <dl>
3485
3400
  <dd>
3486
3401
 
3487
- **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
3488
-
3489
- </dd>
3490
- </dl>
3491
-
3492
- <dl>
3493
- <dd>
3494
-
3495
3402
  **request_options:** `CloudPDF::Doc::Forms::RequestOptions`
3496
3403
 
3497
3404
  </dd>
@@ -3504,7 +3411,7 @@ client.doc.forms.delete_widget(
3504
3411
  </dl>
3505
3412
  </details>
3506
3413
 
3507
- <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">update_widget</a>(doc_id:, layer_name:, page_key:, annot_key:, request) -> CloudPDF::Types::DocFormsUpdateWidget200Response</code></summary>
3414
+ <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reorder_calculations</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocFormsReorderCalculations200Response</code></summary>
3508
3415
  <dl>
3509
3416
  <dd>
3510
3417
 
@@ -3517,12 +3424,11 @@ client.doc.forms.delete_widget(
3517
3424
  <dd>
3518
3425
 
3519
3426
  ```ruby
3520
- client.doc.forms.update_widget(
3427
+ client.doc.forms.reorder_calculations(
3521
3428
  doc_id: "docId",
3522
3429
  layer_name: "layerName",
3523
- page_key: "pageKey",
3524
- annot_key: "annotKey",
3525
- patch: {}
3430
+ fields: [],
3431
+ position: "start"
3526
3432
  )
3527
3433
  ```
3528
3434
  </dd>
@@ -3554,15 +3460,7 @@ client.doc.forms.update_widget(
3554
3460
  <dl>
3555
3461
  <dd>
3556
3462
 
3557
- **page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
3558
-
3559
- </dd>
3560
- </dl>
3561
-
3562
- <dl>
3563
- <dd>
3564
-
3565
- **annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
3463
+ **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.
3566
3464
 
3567
3465
  </dd>
3568
3466
  </dl>
@@ -3570,7 +3468,7 @@ client.doc.forms.update_widget(
3570
3468
  <dl>
3571
3469
  <dd>
3572
3470
 
3573
- **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.
3471
+ **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
3574
3472
 
3575
3473
  </dd>
3576
3474
  </dl>
@@ -3578,7 +3476,7 @@ client.doc.forms.update_widget(
3578
3476
  <dl>
3579
3477
  <dd>
3580
3478
 
3581
- **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
3479
+ **fields:** `Internal::Types::Array[CloudPDF::Types::FormFieldRef]`
3582
3480
 
3583
3481
  </dd>
3584
3482
  </dl>
@@ -3586,7 +3484,7 @@ client.doc.forms.update_widget(
3586
3484
  <dl>
3587
3485
  <dd>
3588
3486
 
3589
- **patch:** `CloudPDF::Types::WidgetPatch`
3487
+ **position:** `CloudPDF::Types::FieldPosition`
3590
3488
 
3591
3489
  </dd>
3592
3490
  </dl>
@@ -3606,7 +3504,7 @@ client.doc.forms.update_widget(
3606
3504
  </dl>
3607
3505
  </details>
3608
3506
 
3609
- <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reorder_widgets</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocFormsReorderWidgets200Response</code></summary>
3507
+ <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">set_value</a>(doc_id:, layer_name:, field_key:, request) -> CloudPDF::Types::DocFormsSetValue200Response</code></summary>
3610
3508
  <dl>
3611
3509
  <dd>
3612
3510
 
@@ -3619,12 +3517,13 @@ client.doc.forms.update_widget(
3619
3517
  <dd>
3620
3518
 
3621
3519
  ```ruby
3622
- client.doc.forms.reorder_widgets(
3520
+ client.doc.forms.set_value(
3623
3521
  doc_id: "docId",
3624
3522
  layer_name: "layerName",
3625
- page_key: "pageKey",
3626
- widgets: [],
3627
- position: "start"
3523
+ field_key: "fieldKey",
3524
+ request: {
3525
+ key: "value"
3526
+ }
3628
3527
  )
3629
3528
  ```
3630
3529
  </dd>
@@ -3656,7 +3555,7 @@ client.doc.forms.reorder_widgets(
3656
3555
  <dl>
3657
3556
  <dd>
3658
3557
 
3659
- **page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
3558
+ **field_key:** `String`
3660
3559
 
3661
3560
  </dd>
3662
3561
  </dl>
@@ -3680,15 +3579,7 @@ client.doc.forms.reorder_widgets(
3680
3579
  <dl>
3681
3580
  <dd>
3682
3581
 
3683
- **widgets:** `Internal::Types::Array[CloudPDF::Types::AnnotationRef]`
3684
-
3685
- </dd>
3686
- </dl>
3687
-
3688
- <dl>
3689
- <dd>
3690
-
3691
- **position:** `CloudPDF::Types::AnnotationPosition`
3582
+ **request:** `Internal::Types::Hash[String, Object]`
3692
3583
 
3693
3584
  </dd>
3694
3585
  </dl>
@@ -3708,8 +3599,7 @@ client.doc.forms.reorder_widgets(
3708
3599
  </dl>
3709
3600
  </details>
3710
3601
 
3711
- ## Doc Metadata
3712
- <details><summary><code>client.doc.metadata.<a href="/lib/CloudPDF/doc/metadata/client.rb">get</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocumentMetadata</code></summary>
3602
+ <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reset</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocFormsReset200Response</code></summary>
3713
3603
  <dl>
3714
3604
  <dd>
3715
3605
 
@@ -3722,7 +3612,7 @@ client.doc.forms.reorder_widgets(
3722
3612
  <dd>
3723
3613
 
3724
3614
  ```ruby
3725
- client.doc.metadata.get(
3615
+ client.doc.forms.reset(
3726
3616
  doc_id: "docId",
3727
3617
  layer_name: "layerName"
3728
3618
  )
@@ -3764,7 +3654,23 @@ client.doc.metadata.get(
3764
3654
  <dl>
3765
3655
  <dd>
3766
3656
 
3767
- **request_options:** `CloudPDF::Doc::Metadata::RequestOptions`
3657
+ **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
3658
+
3659
+ </dd>
3660
+ </dl>
3661
+
3662
+ <dl>
3663
+ <dd>
3664
+
3665
+ **refs:** `Internal::Types::Array[CloudPDF::Types::FormFieldRef]`
3666
+
3667
+ </dd>
3668
+ </dl>
3669
+
3670
+ <dl>
3671
+ <dd>
3672
+
3673
+ **request_options:** `CloudPDF::Doc::Forms::RequestOptions`
3768
3674
 
3769
3675
  </dd>
3770
3676
  </dl>
@@ -3776,8 +3682,7 @@ client.doc.metadata.get(
3776
3682
  </dl>
3777
3683
  </details>
3778
3684
 
3779
- ## Doc Pages
3780
- <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">set_scale</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocPagesSetScale200Response</code></summary>
3685
+ <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">delete_widget</a>(doc_id:, layer_name:, page_key:, annot_key:) -> CloudPDF::Types::DocFormsDeleteWidget200Response</code></summary>
3781
3686
  <dl>
3782
3687
  <dd>
3783
3688
 
@@ -3790,10 +3695,11 @@ client.doc.metadata.get(
3790
3695
  <dd>
3791
3696
 
3792
3697
  ```ruby
3793
- client.doc.pages.set_scale(
3698
+ client.doc.forms.delete_widget(
3794
3699
  doc_id: "docId",
3795
3700
  layer_name: "layerName",
3796
- page_key: "pageKey"
3701
+ page_key: "pageKey",
3702
+ annot_key: "annotKey"
3797
3703
  )
3798
3704
  ```
3799
3705
  </dd>
@@ -3833,7 +3739,7 @@ client.doc.pages.set_scale(
3833
3739
  <dl>
3834
3740
  <dd>
3835
3741
 
3836
- **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.
3742
+ **annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
3837
3743
 
3838
3744
  </dd>
3839
3745
  </dl>
@@ -3841,7 +3747,7 @@ client.doc.pages.set_scale(
3841
3747
  <dl>
3842
3748
  <dd>
3843
3749
 
3844
- **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
3750
+ **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.
3845
3751
 
3846
3752
  </dd>
3847
3753
  </dl>
@@ -3849,7 +3755,7 @@ client.doc.pages.set_scale(
3849
3755
  <dl>
3850
3756
  <dd>
3851
3757
 
3852
- **measure:** `CloudPDF::Doc::Pages::Types::DocPagesSetScaleRequestMeasure`
3758
+ **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
3853
3759
 
3854
3760
  </dd>
3855
3761
  </dl>
@@ -3857,7 +3763,7 @@ client.doc.pages.set_scale(
3857
3763
  <dl>
3858
3764
  <dd>
3859
3765
 
3860
- **request_options:** `CloudPDF::Doc::Pages::RequestOptions`
3766
+ **request_options:** `CloudPDF::Doc::Forms::RequestOptions`
3861
3767
 
3862
3768
  </dd>
3863
3769
  </dl>
@@ -3869,7 +3775,7 @@ client.doc.pages.set_scale(
3869
3775
  </dl>
3870
3776
  </details>
3871
3777
 
3872
- <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">viewports</a>(doc_id:, layer_name:, page_key:) -> CloudPDF::Types::DocPagesViewports200Response</code></summary>
3778
+ <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">update_widget</a>(doc_id:, layer_name:, page_key:, annot_key:, request) -> CloudPDF::Types::DocFormsUpdateWidget200Response</code></summary>
3873
3779
  <dl>
3874
3780
  <dd>
3875
3781
 
@@ -3882,10 +3788,12 @@ client.doc.pages.set_scale(
3882
3788
  <dd>
3883
3789
 
3884
3790
  ```ruby
3885
- client.doc.pages.viewports(
3791
+ client.doc.forms.update_widget(
3886
3792
  doc_id: "docId",
3887
3793
  layer_name: "layerName",
3888
- page_key: "pageKey"
3794
+ page_key: "pageKey",
3795
+ annot_key: "annotKey",
3796
+ patch: {}
3889
3797
  )
3890
3798
  ```
3891
3799
  </dd>
@@ -3925,6 +3833,14 @@ client.doc.pages.viewports(
3925
3833
  <dl>
3926
3834
  <dd>
3927
3835
 
3836
+ **annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
3837
+
3838
+ </dd>
3839
+ </dl>
3840
+
3841
+ <dl>
3842
+ <dd>
3843
+
3928
3844
  **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.
3929
3845
 
3930
3846
  </dd>
@@ -3933,7 +3849,23 @@ client.doc.pages.viewports(
3933
3849
  <dl>
3934
3850
  <dd>
3935
3851
 
3936
- **request_options:** `CloudPDF::Doc::Pages::RequestOptions`
3852
+ **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
3853
+
3854
+ </dd>
3855
+ </dl>
3856
+
3857
+ <dl>
3858
+ <dd>
3859
+
3860
+ **patch:** `CloudPDF::Types::WidgetPatch`
3861
+
3862
+ </dd>
3863
+ </dl>
3864
+
3865
+ <dl>
3866
+ <dd>
3867
+
3868
+ **request_options:** `CloudPDF::Doc::Forms::RequestOptions`
3937
3869
 
3938
3870
  </dd>
3939
3871
  </dl>
@@ -3945,7 +3877,7 @@ client.doc.pages.viewports(
3945
3877
  </dl>
3946
3878
  </details>
3947
3879
 
3948
- <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">delete</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesDelete200Response</code></summary>
3880
+ <details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reorder_widgets</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocFormsReorderWidgets200Response</code></summary>
3949
3881
  <dl>
3950
3882
  <dd>
3951
3883
 
@@ -3958,12 +3890,12 @@ client.doc.pages.viewports(
3958
3890
  <dd>
3959
3891
 
3960
3892
  ```ruby
3961
- client.doc.pages.delete(
3893
+ client.doc.forms.reorder_widgets(
3962
3894
  doc_id: "docId",
3963
3895
  layer_name: "layerName",
3964
- request: {
3965
- key: "value"
3966
- }
3896
+ page_key: "pageKey",
3897
+ widgets: [],
3898
+ position: "start"
3967
3899
  )
3968
3900
  ```
3969
3901
  </dd>
@@ -3995,7 +3927,7 @@ client.doc.pages.delete(
3995
3927
  <dl>
3996
3928
  <dd>
3997
3929
 
3998
- **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.
3930
+ **page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
3999
3931
 
4000
3932
  </dd>
4001
3933
  </dl>
@@ -4003,7 +3935,7 @@ client.doc.pages.delete(
4003
3935
  <dl>
4004
3936
  <dd>
4005
3937
 
4006
- **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
3938
+ **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.
4007
3939
 
4008
3940
  </dd>
4009
3941
  </dl>
@@ -4011,7 +3943,7 @@ client.doc.pages.delete(
4011
3943
  <dl>
4012
3944
  <dd>
4013
3945
 
4014
- **request:** `Internal::Types::Hash[String, Object]`
3946
+ **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
4015
3947
 
4016
3948
  </dd>
4017
3949
  </dl>
@@ -4019,35 +3951,38 @@ client.doc.pages.delete(
4019
3951
  <dl>
4020
3952
  <dd>
4021
3953
 
4022
- **request_options:** `CloudPDF::Doc::Pages::RequestOptions`
3954
+ **widgets:** `Internal::Types::Array[CloudPDF::Types::AnnotationRef]`
4023
3955
 
4024
3956
  </dd>
4025
3957
  </dl>
4026
- </dd>
4027
- </dl>
4028
-
4029
-
4030
- </dd>
4031
- </dl>
4032
- </details>
4033
3958
 
4034
- <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">extract</a>(doc_id:, layer_name:, request) -> String</code></summary>
4035
3959
  <dl>
4036
3960
  <dd>
4037
3961
 
4038
- #### 📝 Description
4039
-
4040
- <dl>
4041
- <dd>
3962
+ **position:** `CloudPDF::Types::AnnotationPosition`
3963
+
3964
+ </dd>
3965
+ </dl>
4042
3966
 
4043
3967
  <dl>
4044
3968
  <dd>
4045
3969
 
4046
- A read, not a mutation: the source document is untouched and no event is published. Body is `{"pages": PageRef[]}`; the response body is the new PDF.
3970
+ **request_options:** `CloudPDF::Doc::Forms::RequestOptions`
3971
+
3972
+ </dd>
3973
+ </dl>
4047
3974
  </dd>
4048
3975
  </dl>
3976
+
3977
+
4049
3978
  </dd>
4050
3979
  </dl>
3980
+ </details>
3981
+
3982
+ ## Doc Metadata
3983
+ <details><summary><code>client.doc.metadata.<a href="/lib/CloudPDF/doc/metadata/client.rb">get</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocumentMetadata</code></summary>
3984
+ <dl>
3985
+ <dd>
4051
3986
 
4052
3987
  #### 🔌 Usage
4053
3988
 
@@ -4058,14 +3993,9 @@ A read, not a mutation: the source document is untouched and no event is publish
4058
3993
  <dd>
4059
3994
 
4060
3995
  ```ruby
4061
- client.doc.pages.extract(
3996
+ client.doc.metadata.get(
4062
3997
  doc_id: "docId",
4063
- layer_name: "layerName",
4064
- request: {
4065
- string: {
4066
- key: "value"
4067
- }
4068
- }
3998
+ layer_name: "layerName"
4069
3999
  )
4070
4000
  ```
4071
4001
  </dd>
@@ -4105,15 +4035,7 @@ client.doc.pages.extract(
4105
4035
  <dl>
4106
4036
  <dd>
4107
4037
 
4108
- **request:** `Internal::Types::Hash[String, Object]`
4109
-
4110
- </dd>
4111
- </dl>
4112
-
4113
- <dl>
4114
- <dd>
4115
-
4116
- **request_options:** `CloudPDF::Doc::Pages::RequestOptions`
4038
+ **request_options:** `CloudPDF::Doc::Metadata::RequestOptions`
4117
4039
 
4118
4040
  </dd>
4119
4041
  </dl>
@@ -4125,7 +4047,8 @@ client.doc.pages.extract(
4125
4047
  </dl>
4126
4048
  </details>
4127
4049
 
4128
- <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">flatten</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesFlatten200Response</code></summary>
4050
+ ## Doc Outline
4051
+ <details><summary><code>client.doc.outline.<a href="/lib/CloudPDF/doc/outline/client.rb">get</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocumentOutline</code></summary>
4129
4052
  <dl>
4130
4053
  <dd>
4131
4054
 
@@ -4138,12 +4061,9 @@ client.doc.pages.extract(
4138
4061
  <dd>
4139
4062
 
4140
4063
  ```ruby
4141
- client.doc.pages.flatten(
4064
+ client.doc.outline.get(
4142
4065
  doc_id: "docId",
4143
- layer_name: "layerName",
4144
- request: {
4145
- key: "value"
4146
- }
4066
+ layer_name: "layerName"
4147
4067
  )
4148
4068
  ```
4149
4069
  </dd>
@@ -4183,23 +4103,7 @@ client.doc.pages.flatten(
4183
4103
  <dl>
4184
4104
  <dd>
4185
4105
 
4186
- **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
4187
-
4188
- </dd>
4189
- </dl>
4190
-
4191
- <dl>
4192
- <dd>
4193
-
4194
- **request:** `Internal::Types::Hash[String, Object]`
4195
-
4196
- </dd>
4197
- </dl>
4198
-
4199
- <dl>
4200
- <dd>
4201
-
4202
- **request_options:** `CloudPDF::Doc::Pages::RequestOptions`
4106
+ **request_options:** `CloudPDF::Doc::Outline::RequestOptions`
4203
4107
 
4204
4108
  </dd>
4205
4109
  </dl>
@@ -4211,24 +4115,11 @@ client.doc.pages.flatten(
4211
4115
  </dl>
4212
4116
  </details>
4213
4117
 
4214
- <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">insert</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesInsert200Response</code></summary>
4215
- <dl>
4216
- <dd>
4217
-
4218
- #### 📝 Description
4219
-
4220
- <dl>
4221
- <dd>
4222
-
4118
+ ## Doc Pages
4119
+ <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">set_scale</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocPagesSetScale200Response</code></summary>
4223
4120
  <dl>
4224
4121
  <dd>
4225
4122
 
4226
- Multipart: a JSON `body` part `{"position"?: PagePosition, "resources": {"source": "<key>"}}` (position omitted → the end), and the standalone PDF whose pages are copied in as the part `resource:<key>`. The inserted copies get fresh page object numbers, returned in insertion order.
4227
- </dd>
4228
- </dl>
4229
- </dd>
4230
- </dl>
4231
-
4232
4123
  #### 🔌 Usage
4233
4124
 
4234
4125
  <dl>
@@ -4238,9 +4129,10 @@ Multipart: a JSON `body` part `{"position"?: PagePosition, "resources": {"source
4238
4129
  <dd>
4239
4130
 
4240
4131
  ```ruby
4241
- client.doc.pages.insert(
4132
+ client.doc.pages.set_scale(
4242
4133
  doc_id: "docId",
4243
- layer_name: "layerName"
4134
+ layer_name: "layerName",
4135
+ page_key: "pageKey"
4244
4136
  )
4245
4137
  ```
4246
4138
  </dd>
@@ -4272,6 +4164,14 @@ client.doc.pages.insert(
4272
4164
  <dl>
4273
4165
  <dd>
4274
4166
 
4167
+ **page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
4168
+
4169
+ </dd>
4170
+ </dl>
4171
+
4172
+ <dl>
4173
+ <dd>
4174
+
4275
4175
  **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.
4276
4176
 
4277
4177
  </dd>
@@ -4288,6 +4188,14 @@ client.doc.pages.insert(
4288
4188
  <dl>
4289
4189
  <dd>
4290
4190
 
4191
+ **measure:** `CloudPDF::Doc::Pages::Types::DocPagesSetScaleRequestMeasure`
4192
+
4193
+ </dd>
4194
+ </dl>
4195
+
4196
+ <dl>
4197
+ <dd>
4198
+
4291
4199
  **request_options:** `CloudPDF::Doc::Pages::RequestOptions`
4292
4200
 
4293
4201
  </dd>
@@ -4300,24 +4208,10 @@ client.doc.pages.insert(
4300
4208
  </dl>
4301
4209
  </details>
4302
4210
 
4303
- <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">insert_blank</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesInsertBlank200Response</code></summary>
4304
- <dl>
4305
- <dd>
4306
-
4307
- #### 📝 Description
4308
-
4309
- <dl>
4310
- <dd>
4311
-
4211
+ <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">viewports</a>(doc_id:, layer_name:, page_key:) -> CloudPDF::Types::DocPagesViewports200Response</code></summary>
4312
4212
  <dl>
4313
4213
  <dd>
4314
4214
 
4315
- Body is `{"size": {"width", "height"}, "count"?, "position"?}` — size in PDF points, count in [1, 100], `position` a `PagePosition` (omitted → the end).
4316
- </dd>
4317
- </dl>
4318
- </dd>
4319
- </dl>
4320
-
4321
4215
  #### 🔌 Usage
4322
4216
 
4323
4217
  <dl>
@@ -4327,12 +4221,10 @@ Body is `{"size": {"width", "height"}, "count"?, "position"?}` — size in PDF p
4327
4221
  <dd>
4328
4222
 
4329
4223
  ```ruby
4330
- client.doc.pages.insert_blank(
4224
+ client.doc.pages.viewports(
4331
4225
  doc_id: "docId",
4332
4226
  layer_name: "layerName",
4333
- request: {
4334
- key: "value"
4335
- }
4227
+ page_key: "pageKey"
4336
4228
  )
4337
4229
  ```
4338
4230
  </dd>
@@ -4364,15 +4256,7 @@ client.doc.pages.insert_blank(
4364
4256
  <dl>
4365
4257
  <dd>
4366
4258
 
4367
- **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.
4368
-
4369
- </dd>
4370
- </dl>
4371
-
4372
- <dl>
4373
- <dd>
4374
-
4375
- **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
4259
+ **page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
4376
4260
 
4377
4261
  </dd>
4378
4262
  </dl>
@@ -4380,7 +4264,7 @@ client.doc.pages.insert_blank(
4380
4264
  <dl>
4381
4265
  <dd>
4382
4266
 
4383
- **request:** `Internal::Types::Hash[String, Object]`
4267
+ **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.
4384
4268
 
4385
4269
  </dd>
4386
4270
  </dl>
@@ -4400,10 +4284,24 @@ client.doc.pages.insert_blank(
4400
4284
  </dl>
4401
4285
  </details>
4402
4286
 
4403
- <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>
4287
+ <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">extract</a>(doc_id:, layer_name:, request) -> String</code></summary>
4404
4288
  <dl>
4405
4289
  <dd>
4406
4290
 
4291
+ #### 📝 Description
4292
+
4293
+ <dl>
4294
+ <dd>
4295
+
4296
+ <dl>
4297
+ <dd>
4298
+
4299
+ A read, not a mutation: the source document is untouched and no event is published. Body is `{"pages": PageRef[], "flatten"?: {"usage"?: "display" | "print"}, "includeAnnotations"?: boolean, "includeFormFields"?: boolean}`; the response body is the new PDF. With `flatten` the copy is the pages as they draw for `usage` (`"print"`: a print copy): the annotations and form fields painted in, nothing interactive left, layers in their state for the usage. A flattened copy takes `doc.download` or `doc.download.flattened`, and paints only what the caller may read; `includeAnnotations` and `includeFormFields` choose what it paints, and are refused without `flatten`.
4300
+ </dd>
4301
+ </dl>
4302
+ </dd>
4303
+ </dl>
4304
+
4407
4305
  #### 🔌 Usage
4408
4306
 
4409
4307
  <dl>
@@ -4413,11 +4311,13 @@ client.doc.pages.insert_blank(
4413
4311
  <dd>
4414
4312
 
4415
4313
  ```ruby
4416
- client.doc.pages.set_name(
4314
+ client.doc.pages.extract(
4417
4315
  doc_id: "docId",
4418
4316
  layer_name: "layerName",
4419
4317
  request: {
4420
- key: "value"
4318
+ string: {
4319
+ key: "value"
4320
+ }
4421
4321
  }
4422
4322
  )
4423
4323
  ```
@@ -4458,14 +4358,6 @@ client.doc.pages.set_name(
4458
4358
  <dl>
4459
4359
  <dd>
4460
4360
 
4461
- **idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
4462
-
4463
- </dd>
4464
- </dl>
4465
-
4466
- <dl>
4467
- <dd>
4468
-
4469
4361
  **request:** `Internal::Types::Hash[String, Object]`
4470
4362
 
4471
4363
  </dd>
@@ -4486,7 +4378,7 @@ client.doc.pages.set_name(
4486
4378
  </dl>
4487
4379
  </details>
4488
4380
 
4489
- <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>
4381
+ <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">flatten</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesFlatten200Response</code></summary>
4490
4382
  <dl>
4491
4383
  <dd>
4492
4384
 
@@ -4499,7 +4391,7 @@ client.doc.pages.set_name(
4499
4391
  <dd>
4500
4392
 
4501
4393
  ```ruby
4502
- client.doc.pages.remove_name(
4394
+ client.doc.pages.flatten(
4503
4395
  doc_id: "docId",
4504
4396
  layer_name: "layerName",
4505
4397
  request: {
@@ -4572,7 +4464,7 @@ client.doc.pages.remove_name(
4572
4464
  </dl>
4573
4465
  </details>
4574
4466
 
4575
- <details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">reorder</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesReorder200Response</code></summary>
4467
+ <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>
4576
4468
  <dl>
4577
4469
  <dd>
4578
4470
 
@@ -4585,14 +4477,12 @@ client.doc.pages.remove_name(
4585
4477
  <dd>
4586
4478
 
4587
4479
  ```ruby
4588
- client.doc.pages.reorder(
4480
+ client.doc.pages.set_name(
4589
4481
  doc_id: "docId",
4590
4482
  layer_name: "layerName",
4591
- pages: [{
4592
- kind: "objectNumber",
4593
- object_number: 1
4594
- }],
4595
- position: "start"
4483
+ request: {
4484
+ key: "value"
4485
+ }
4596
4486
  )
4597
4487
  ```
4598
4488
  </dd>
@@ -4640,15 +4530,7 @@ client.doc.pages.reorder(
4640
4530
  <dl>
4641
4531
  <dd>
4642
4532
 
4643
- **pages:** `Internal::Types::Array[CloudPDF::Types::PageRef]`
4644
-
4645
- </dd>
4646
- </dl>
4647
-
4648
- <dl>
4649
- <dd>
4650
-
4651
- **position:** `CloudPDF::Types::PagePosition`
4533
+ **request:** `Internal::Types::Hash[String, Object]`
4652
4534
 
4653
4535
  </dd>
4654
4536
  </dl>
@@ -4668,7 +4550,7 @@ client.doc.pages.reorder(
4668
4550
  </dl>
4669
4551
  </details>
4670
4552
 
4671
- <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>
4553
+ <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>
4672
4554
  <dl>
4673
4555
  <dd>
4674
4556
 
@@ -4681,7 +4563,7 @@ client.doc.pages.reorder(
4681
4563
  <dd>
4682
4564
 
4683
4565
  ```ruby
4684
- client.doc.pages.rotate(
4566
+ client.doc.pages.remove_name(
4685
4567
  doc_id: "docId",
4686
4568
  layer_name: "layerName",
4687
4569
  request: {