cloudpdf 3.0.0.alpha.15 → 3.0.0.alpha.17

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 (347) 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 +70 -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/doc/types/doc_download_link_request.rb +17 -0
  13. data/lib/CloudPDF/documents/client.rb +5 -0
  14. data/lib/CloudPDF/documents/layers/client.rb +103 -0
  15. data/lib/CloudPDF/documents/layers/types/delete_layers_request.rb +17 -0
  16. data/lib/CloudPDF/documents/layers/types/list_layers_request.rb +21 -0
  17. data/lib/CloudPDF/shares/client.rb +56 -1
  18. data/lib/CloudPDF/shares/types/archive_shares_request.rb +13 -0
  19. data/lib/CloudPDF/shares/types/list_shares_request.rb +2 -0
  20. data/lib/CloudPDF/shares/types/shares_create_request.rb +8 -0
  21. data/lib/CloudPDF/shares/types/shares_create_request_layer_mode.rb +14 -0
  22. data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity.rb +17 -0
  23. data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_ask.rb +14 -0
  24. data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_fields.rb +19 -0
  25. data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_fields_display_name.rb +14 -0
  26. data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_fields_email.rb +14 -0
  27. data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_fields_organization.rb +14 -0
  28. data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_fields_organizational_unit.rb +14 -0
  29. data/lib/CloudPDF/shares/types/shares_create_request_visitor_identity_fields_title.rb +14 -0
  30. data/lib/CloudPDF/shares/types/shares_exchange_request.rb +6 -0
  31. data/lib/CloudPDF/shares/types/shares_exchange_request_visitor_identity.rb +19 -0
  32. data/lib/CloudPDF/shares/types/shares_update_request.rb +10 -0
  33. data/lib/CloudPDF/shares/types/shares_update_request_layer_mode.rb +14 -0
  34. data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity.rb +17 -0
  35. data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_ask.rb +14 -0
  36. data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_fields.rb +19 -0
  37. data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_fields_display_name.rb +14 -0
  38. data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_fields_email.rb +14 -0
  39. data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_fields_organization.rb +14 -0
  40. data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_fields_organizational_unit.rb +14 -0
  41. data/lib/CloudPDF/shares/types/shares_update_request_visitor_identity_fields_title.rb +14 -0
  42. data/lib/CloudPDF/shares/visitors/client.rb +106 -0
  43. data/lib/CloudPDF/shares/visitors/types/delete_visitors_request.rb +17 -0
  44. data/lib/CloudPDF/shares/visitors/types/list_visitors_request.rb +19 -0
  45. data/lib/CloudPDF/types/admin_error_payload_error.rb +2 -0
  46. data/lib/CloudPDF/types/annotation_file_attachment.rb +1 -1
  47. data/lib/CloudPDF/types/attachment.rb +25 -0
  48. data/lib/CloudPDF/types/attachment_file_base.rb +13 -0
  49. data/lib/CloudPDF/types/{annotation_file_attachment_file.rb → attachment_file_info.rb} +1 -1
  50. data/lib/CloudPDF/types/attachment_list.rb +9 -0
  51. data/lib/CloudPDF/types/attachment_mutation_meta.rb +17 -0
  52. data/lib/CloudPDF/types/attachment_ref.rb +11 -0
  53. data/lib/CloudPDF/types/attachment_ref_kind.rb +11 -0
  54. data/lib/CloudPDF/types/cache_delta.rb +2 -0
  55. data/lib/CloudPDF/types/change_item.rb +28 -0
  56. data/lib/CloudPDF/types/change_item_attachments_create.rb +11 -0
  57. data/lib/CloudPDF/types/change_item_attachments_delete.rb +9 -0
  58. data/lib/CloudPDF/types/change_item_attachments_restore.rb +11 -0
  59. data/lib/CloudPDF/types/change_item_outline_create.rb +13 -0
  60. data/lib/CloudPDF/types/change_item_outline_delete.rb +9 -0
  61. data/lib/CloudPDF/types/change_item_outline_move.rb +11 -0
  62. data/lib/CloudPDF/types/change_item_outline_restore.rb +13 -0
  63. data/lib/CloudPDF/types/change_item_outline_update.rb +13 -0
  64. data/lib/CloudPDF/types/{doc_pages_reorder200response.rb → change_item_pages_delete.rb} +2 -2
  65. data/lib/CloudPDF/types/{doc_pages_insert200response_layout.rb → change_item_pages_delete_layout.rb} +3 -3
  66. data/lib/CloudPDF/types/change_item_pages_delete_layout_named_pages_item.rb +11 -0
  67. data/lib/CloudPDF/types/change_item_pages_delete_layout_named_pages_item_target.rb +17 -0
  68. data/lib/CloudPDF/types/change_item_pages_delete_layout_named_pages_item_target_dangling.rb +7 -0
  69. 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
  70. 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
  71. data/lib/CloudPDF/types/change_item_pages_delete_layout_pages_item.rb +27 -0
  72. data/lib/CloudPDF/types/change_item_pages_delete_layout_pages_item_boxes.rb +17 -0
  73. 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
  74. 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
  75. 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
  76. 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
  77. data/lib/CloudPDF/types/change_item_pages_delete_layout_pages_item_boxes_trim.rb +15 -0
  78. 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
  79. data/lib/CloudPDF/types/{doc_pages_rotate200response_layout_pages_item_size.rb → change_item_pages_delete_layout_pages_item_size.rb} +1 -1
  80. 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
  81. data/lib/CloudPDF/types/{doc_pages_insert200response.rb → change_item_pages_insert.rb} +2 -2
  82. data/lib/CloudPDF/types/{doc_pages_insert_blank200response.rb → change_item_pages_insert_blank.rb} +2 -2
  83. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout.rb → change_item_pages_insert_blank_layout.rb} +3 -3
  84. data/lib/CloudPDF/types/change_item_pages_insert_blank_layout_named_pages_item.rb +11 -0
  85. 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
  86. 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
  87. 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
  88. 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
  89. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item.rb → change_item_pages_insert_blank_layout_pages_item.rb} +5 -5
  90. data/lib/CloudPDF/types/change_item_pages_insert_blank_layout_pages_item_boxes.rb +17 -0
  91. 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
  92. 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
  93. 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
  94. 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
  95. 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
  96. 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
  97. data/lib/CloudPDF/types/{doc_pages_reorder200response_layout_pages_item_size.rb → change_item_pages_insert_blank_layout_pages_item_size.rb} +1 -1
  98. 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
  99. data/lib/CloudPDF/types/{doc_pages_delete200response_layout.rb → change_item_pages_insert_layout.rb} +3 -3
  100. data/lib/CloudPDF/types/change_item_pages_insert_layout_named_pages_item.rb +11 -0
  101. data/lib/CloudPDF/types/change_item_pages_insert_layout_named_pages_item_target.rb +17 -0
  102. data/lib/CloudPDF/types/change_item_pages_insert_layout_named_pages_item_target_dangling.rb +7 -0
  103. 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
  104. 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
  105. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item.rb +27 -0
  106. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes.rb +17 -0
  107. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_art.rb +15 -0
  108. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_bleed.rb +15 -0
  109. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_crop.rb +15 -0
  110. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_media.rb +15 -0
  111. data/lib/CloudPDF/types/change_item_pages_insert_layout_pages_item_boxes_trim.rb +15 -0
  112. 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
  113. data/lib/CloudPDF/types/{doc_pages_insert200response_layout_pages_item_size.rb → change_item_pages_insert_layout_pages_item_size.rb} +1 -1
  114. 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
  115. data/lib/CloudPDF/types/change_item_pages_reorder.rb +13 -0
  116. data/lib/CloudPDF/types/{doc_pages_rotate200response_layout.rb → change_item_pages_reorder_layout.rb} +3 -3
  117. data/lib/CloudPDF/types/change_item_pages_reorder_layout_named_pages_item.rb +11 -0
  118. data/lib/CloudPDF/types/change_item_pages_reorder_layout_named_pages_item_target.rb +17 -0
  119. data/lib/CloudPDF/types/change_item_pages_reorder_layout_named_pages_item_target_dangling.rb +7 -0
  120. 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
  121. 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
  122. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item.rb +27 -0
  123. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes.rb +17 -0
  124. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_art.rb +15 -0
  125. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_bleed.rb +15 -0
  126. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_crop.rb +15 -0
  127. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_media.rb +15 -0
  128. data/lib/CloudPDF/types/change_item_pages_reorder_layout_pages_item_boxes_trim.rb +15 -0
  129. 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
  130. data/lib/CloudPDF/types/{doc_pages_delete200response_layout_pages_item_size.rb → change_item_pages_reorder_layout_pages_item_size.rb} +1 -1
  131. 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
  132. data/lib/CloudPDF/types/change_item_pages_restore.rb +13 -0
  133. data/lib/CloudPDF/types/change_item_pages_restore_layout.rb +13 -0
  134. data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item.rb +11 -0
  135. data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item_target.rb +17 -0
  136. data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item_target_dangling.rb +7 -0
  137. data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item_target_page.rb +9 -0
  138. data/lib/CloudPDF/types/change_item_pages_restore_layout_named_pages_item_target_template.rb +9 -0
  139. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item.rb +27 -0
  140. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes.rb +17 -0
  141. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_art.rb +15 -0
  142. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_bleed.rb +15 -0
  143. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_crop.rb +15 -0
  144. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_media.rb +15 -0
  145. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_boxes_trim.rb +15 -0
  146. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_pdf_crop_box.rb +15 -0
  147. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_size.rb +11 -0
  148. data/lib/CloudPDF/types/change_item_pages_restore_layout_pages_item_tab_order.rb +15 -0
  149. data/lib/CloudPDF/types/change_item_pages_rotate.rb +15 -0
  150. data/lib/CloudPDF/types/change_item_pages_rotate_layout.rb +13 -0
  151. data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item.rb +11 -0
  152. data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item_target.rb +17 -0
  153. data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item_target_dangling.rb +7 -0
  154. data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item_target_page.rb +9 -0
  155. data/lib/CloudPDF/types/change_item_pages_rotate_layout_named_pages_item_target_template.rb +9 -0
  156. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item.rb +27 -0
  157. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes.rb +17 -0
  158. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_art.rb +15 -0
  159. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_bleed.rb +15 -0
  160. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_crop.rb +15 -0
  161. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_media.rb +15 -0
  162. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_boxes_trim.rb +15 -0
  163. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_pdf_crop_box.rb +15 -0
  164. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_size.rb +11 -0
  165. data/lib/CloudPDF/types/change_item_pages_rotate_layout_pages_item_tab_order.rb +15 -0
  166. data/lib/CloudPDF/types/change_item_skipped_op.rb +15 -0
  167. data/lib/CloudPDF/types/change_op.rb +22 -0
  168. data/lib/CloudPDF/types/change_op_attachments_create.rb +11 -0
  169. data/lib/CloudPDF/types/change_op_attachments_create_resources.rb +9 -0
  170. data/lib/CloudPDF/types/change_op_attachments_delete.rb +9 -0
  171. data/lib/CloudPDF/types/change_op_outline_create.rb +15 -0
  172. data/lib/CloudPDF/types/change_op_outline_delete.rb +11 -0
  173. data/lib/CloudPDF/types/change_op_outline_move.rb +13 -0
  174. data/lib/CloudPDF/types/change_op_outline_update.rb +13 -0
  175. data/lib/CloudPDF/types/change_op_pages_delete.rb +9 -0
  176. data/lib/CloudPDF/types/change_op_pages_insert.rb +11 -0
  177. data/lib/CloudPDF/types/change_op_pages_insert_blank.rb +13 -0
  178. data/lib/CloudPDF/types/change_op_pages_insert_blank_spec.rb +11 -0
  179. data/lib/CloudPDF/types/change_op_pages_insert_blank_spec_size.rb +11 -0
  180. data/lib/CloudPDF/types/change_op_pages_insert_resources.rb +9 -0
  181. data/lib/CloudPDF/types/change_op_pages_reorder.rb +11 -0
  182. data/lib/CloudPDF/types/change_op_pages_rotate.rb +11 -0
  183. data/lib/CloudPDF/types/doc_annotations_read_file400response.rb +23 -0
  184. data/lib/CloudPDF/types/doc_annotations_read_file404response.rb +23 -0
  185. data/lib/CloudPDF/types/doc_annotations_read_file413response.rb +23 -0
  186. data/lib/CloudPDF/types/doc_attachments_download400response.rb +23 -0
  187. data/lib/CloudPDF/types/doc_attachments_download404response.rb +23 -0
  188. data/lib/CloudPDF/types/doc_attachments_download413response.rb +23 -0
  189. data/lib/CloudPDF/types/{doc_pages_insert400response.rb → doc_attachments_list200response.rb} +2 -2
  190. data/lib/CloudPDF/types/doc_attachments_list404response.rb +23 -0
  191. data/lib/CloudPDF/types/doc_download_link200response.rb +11 -0
  192. data/lib/CloudPDF/types/{doc_pages_reorder400response.rb → doc_download_link404response.rb} +2 -2
  193. data/lib/CloudPDF/types/{doc_pages_reorder404response.rb → doc_download_link501response.rb} +2 -2
  194. data/lib/CloudPDF/types/doc_manifest200response.rb +2 -0
  195. data/lib/CloudPDF/types/doc_manifest200response_scopes.rb +2 -0
  196. data/lib/CloudPDF/types/doc_manifest200response_scopes_outline.rb +12 -0
  197. data/lib/CloudPDF/types/{doc_pages_insert_blank_request.rb → doc_outline_get200response.rb} +2 -2
  198. data/lib/CloudPDF/types/doc_outline_get404response.rb +23 -0
  199. data/lib/CloudPDF/types/document_outline.rb +11 -0
  200. data/lib/CloudPDF/types/documents_layers_delete403response.rb +23 -0
  201. data/lib/CloudPDF/types/documents_layers_delete404response.rb +23 -0
  202. data/lib/CloudPDF/types/documents_layers_delete409response.rb +23 -0
  203. data/lib/CloudPDF/types/documents_layers_list200response.rb +11 -0
  204. data/lib/CloudPDF/types/documents_layers_list200response_layers_item.rb +23 -0
  205. data/lib/CloudPDF/types/documents_layers_list400response.rb +23 -0
  206. data/lib/CloudPDF/types/documents_layers_list403response.rb +23 -0
  207. data/lib/CloudPDF/types/documents_layers_list404response.rb +23 -0
  208. data/lib/CloudPDF/types/engine_error_payload_code.rb +2 -0
  209. data/lib/CloudPDF/types/outline_item.rb +25 -0
  210. data/lib/CloudPDF/types/outline_item_draft.rb +17 -0
  211. data/lib/CloudPDF/types/outline_item_patch.rb +19 -0
  212. data/lib/CloudPDF/types/{doc_pages_insert_blank200response_layout_named_pages_item_target_template.rb → outline_item_ref.rb} +3 -1
  213. data/lib/CloudPDF/types/outline_item_ref_kind.rb +11 -0
  214. data/lib/CloudPDF/types/outline_mutation_meta.rb +17 -0
  215. data/lib/CloudPDF/types/outline_order.rb +11 -0
  216. data/lib/CloudPDF/types/outline_position.rb +13 -0
  217. data/lib/CloudPDF/types/outline_position_after.rb +11 -0
  218. data/lib/CloudPDF/types/outline_position_zero.rb +12 -0
  219. data/lib/CloudPDF/types/shares_archive200response.rb +9 -0
  220. data/lib/CloudPDF/types/shares_archive200response_share.rb +47 -0
  221. data/lib/CloudPDF/types/shares_archive200response_share_layer_mode.rb +12 -0
  222. data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity.rb +15 -0
  223. data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_ask.rb +12 -0
  224. data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields.rb +17 -0
  225. data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_display_name.rb +12 -0
  226. data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_email.rb +12 -0
  227. data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_organization.rb +12 -0
  228. data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_organizational_unit.rb +12 -0
  229. data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields_title.rb +12 -0
  230. data/lib/CloudPDF/types/shares_archive404response.rb +23 -0
  231. data/lib/CloudPDF/types/shares_create200response_share.rb +11 -1
  232. data/lib/CloudPDF/types/shares_create200response_share_layer_mode.rb +12 -0
  233. data/lib/CloudPDF/types/shares_create200response_share_visitor_identity.rb +15 -0
  234. data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_ask.rb +12 -0
  235. data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields.rb +17 -0
  236. data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields_display_name.rb +12 -0
  237. data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields_email.rb +12 -0
  238. data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields_organization.rb +12 -0
  239. data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields_organizational_unit.rb +12 -0
  240. data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields_title.rb +12 -0
  241. data/lib/CloudPDF/types/{doc_pages_rotate_request.rb → shares_delete404response.rb} +2 -2
  242. data/lib/CloudPDF/types/{shares_delete_response.rb → shares_delete409response.rb} +2 -2
  243. data/lib/CloudPDF/types/shares_exchange200response.rb +4 -0
  244. data/lib/CloudPDF/types/shares_exchange200response_layer_mode.rb +12 -0
  245. data/lib/CloudPDF/types/shares_exchange200response_visitor.rb +13 -0
  246. data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request.rb +17 -0
  247. data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_fields.rb +17 -0
  248. data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_fields_display_name.rb +12 -0
  249. data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_fields_email.rb +12 -0
  250. data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_fields_organization.rb +12 -0
  251. data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_fields_organizational_unit.rb +12 -0
  252. data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_fields_title.rb +12 -0
  253. data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_invalid_item.rb +15 -0
  254. data/lib/CloudPDF/types/shares_exchange200response_visitor_identity_request_missing_item.rb +15 -0
  255. data/lib/CloudPDF/types/shares_get200response_share.rb +11 -1
  256. data/lib/CloudPDF/types/shares_get200response_share_layer_mode.rb +12 -0
  257. data/lib/CloudPDF/types/shares_get200response_share_visitor_identity.rb +15 -0
  258. data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_ask.rb +12 -0
  259. data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields.rb +17 -0
  260. data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields_display_name.rb +12 -0
  261. data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields_email.rb +12 -0
  262. data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields_organization.rb +12 -0
  263. data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields_organizational_unit.rb +12 -0
  264. data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields_title.rb +12 -0
  265. data/lib/CloudPDF/types/shares_list200response_shares_item.rb +11 -1
  266. data/lib/CloudPDF/types/shares_list200response_shares_item_layer_mode.rb +12 -0
  267. data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity.rb +15 -0
  268. data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_ask.rb +12 -0
  269. data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields.rb +17 -0
  270. data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields_display_name.rb +12 -0
  271. data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields_email.rb +12 -0
  272. data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields_organization.rb +12 -0
  273. data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields_organizational_unit.rb +12 -0
  274. data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields_title.rb +12 -0
  275. data/lib/CloudPDF/types/shares_update200response_share.rb +11 -1
  276. data/lib/CloudPDF/types/shares_update200response_share_layer_mode.rb +12 -0
  277. data/lib/CloudPDF/types/shares_update200response_share_visitor_identity.rb +15 -0
  278. data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_ask.rb +12 -0
  279. data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields.rb +17 -0
  280. data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields_display_name.rb +12 -0
  281. data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields_email.rb +12 -0
  282. data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields_organization.rb +12 -0
  283. data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields_organizational_unit.rb +12 -0
  284. data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields_title.rb +12 -0
  285. data/lib/CloudPDF/types/{doc_pages_delete_request.rb → shares_update409response.rb} +2 -2
  286. data/lib/CloudPDF/types/{doc_pages_delete400response.rb → shares_visitors_delete_response.rb} +2 -2
  287. data/lib/CloudPDF/types/shares_visitors_list200response.rb +11 -0
  288. data/lib/CloudPDF/types/shares_visitors_list200response_visitors_item.rb +21 -0
  289. data/lib/CloudPDF/types/shares_visitors_list200response_visitors_item_answers.rb +17 -0
  290. data/lib/CloudPDF/types/shares_visitors_list200response_visitors_item_layer.rb +11 -0
  291. data/lib/CloudPDF/types/{doc_pages_delete404response.rb → shares_visitors_list400response.rb} +2 -2
  292. data/lib/CloudPDF/types/shares_visitors_list404response.rb +23 -0
  293. data/lib/CloudPDF/version.rb +1 -1
  294. data/lib/cloudpdf.rb +270 -108
  295. data/reference.md +853 -381
  296. metadata +269 -107
  297. data/lib/CloudPDF/doc/pages/types/doc_pages_reorder_request.rb +0 -23
  298. data/lib/CloudPDF/types/doc_pages_delete200response.rb +0 -11
  299. data/lib/CloudPDF/types/doc_pages_delete200response_layout_named_pages_item.rb +0 -11
  300. data/lib/CloudPDF/types/doc_pages_delete200response_layout_named_pages_item_target.rb +0 -17
  301. data/lib/CloudPDF/types/doc_pages_delete200response_layout_named_pages_item_target_dangling.rb +0 -7
  302. data/lib/CloudPDF/types/doc_pages_delete200response_layout_pages_item.rb +0 -27
  303. data/lib/CloudPDF/types/doc_pages_delete200response_layout_pages_item_boxes.rb +0 -17
  304. data/lib/CloudPDF/types/doc_pages_delete200response_layout_pages_item_boxes_bleed.rb +0 -15
  305. data/lib/CloudPDF/types/doc_pages_delete200response_layout_pages_item_boxes_media.rb +0 -15
  306. data/lib/CloudPDF/types/doc_pages_insert200response_layout_named_pages_item.rb +0 -11
  307. data/lib/CloudPDF/types/doc_pages_insert200response_layout_named_pages_item_target.rb +0 -17
  308. data/lib/CloudPDF/types/doc_pages_insert200response_layout_named_pages_item_target_dangling.rb +0 -7
  309. data/lib/CloudPDF/types/doc_pages_insert200response_layout_pages_item.rb +0 -27
  310. data/lib/CloudPDF/types/doc_pages_insert200response_layout_pages_item_boxes.rb +0 -17
  311. data/lib/CloudPDF/types/doc_pages_insert200response_layout_pages_item_boxes_crop.rb +0 -15
  312. data/lib/CloudPDF/types/doc_pages_insert200response_layout_pages_item_boxes_trim.rb +0 -15
  313. data/lib/CloudPDF/types/doc_pages_insert404response.rb +0 -23
  314. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout.rb +0 -13
  315. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_named_pages_item.rb +0 -11
  316. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_named_pages_item_target.rb +0 -17
  317. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_named_pages_item_target_dangling.rb +0 -7
  318. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_named_pages_item_target_page.rb +0 -9
  319. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item.rb +0 -27
  320. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes.rb +0 -17
  321. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_art.rb +0 -15
  322. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_bleed.rb +0 -15
  323. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_crop.rb +0 -15
  324. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_media.rb +0 -15
  325. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_boxes_trim.rb +0 -15
  326. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_pdf_crop_box.rb +0 -15
  327. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_size.rb +0 -11
  328. data/lib/CloudPDF/types/doc_pages_insert_blank200response_layout_pages_item_tab_order.rb +0 -15
  329. data/lib/CloudPDF/types/doc_pages_insert_blank400response.rb +0 -23
  330. data/lib/CloudPDF/types/doc_pages_insert_blank404response.rb +0 -23
  331. data/lib/CloudPDF/types/doc_pages_reorder200response_layout_named_pages_item.rb +0 -11
  332. data/lib/CloudPDF/types/doc_pages_reorder200response_layout_pages_item_boxes.rb +0 -17
  333. data/lib/CloudPDF/types/doc_pages_reorder200response_layout_pages_item_boxes_art.rb +0 -15
  334. data/lib/CloudPDF/types/doc_pages_reorder200response_layout_pages_item_boxes_crop.rb +0 -15
  335. data/lib/CloudPDF/types/doc_pages_reorder200response_layout_pages_item_boxes_trim.rb +0 -15
  336. data/lib/CloudPDF/types/doc_pages_rotate200response.rb +0 -11
  337. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_named_pages_item.rb +0 -11
  338. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_named_pages_item_target.rb +0 -17
  339. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_named_pages_item_target_dangling.rb +0 -7
  340. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item.rb +0 -27
  341. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes.rb +0 -17
  342. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes_bleed.rb +0 -15
  343. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes_crop.rb +0 -15
  344. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes_media.rb +0 -15
  345. data/lib/CloudPDF/types/doc_pages_rotate200response_layout_pages_item_boxes_trim.rb +0 -15
  346. data/lib/CloudPDF/types/doc_pages_rotate400response.rb +0 -23
  347. data/lib/CloudPDF/types/doc_pages_rotate404response.rb +0 -23
@@ -110,61 +110,13 @@ module CloudPDF
110
110
  end
111
111
  end
112
112
 
113
- # @param request_options [Hash]
114
- # @param params [CloudPDF::Types::DocPagesDeleteRequest]
115
- # @option request_options [String] :base_url
116
- # @option request_options [Hash{String => Object}] :additional_headers
117
- # @option request_options [Hash{String => Object}] :additional_query_parameters
118
- # @option request_options [Hash{String => Object}] :additional_body_parameters
119
- # @option request_options [Integer] :timeout_in_seconds
120
- # @option params [String] :doc_id
121
- # @option params [String] :layer_name
122
- # @option params [String, nil] :document_password
123
- # @option params [String, nil] :idempotency_key
124
- #
125
- # @example
126
- # client.doc.pages.delete(
127
- # doc_id: "docId",
128
- # layer_name: "layerName",
129
- # request: {
130
- # key: "value"
131
- # }
132
- # )
133
- #
134
- # @return [CloudPDF::Types::DocPagesDelete200Response]
135
- def delete(request_options: {}, **params)
136
- params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
137
- path_param_names = %i[doc_id layer_name]
138
- body_params = params.except(*path_param_names)
139
-
140
- headers = {}
141
- headers["X-Document-Password"] = params[:document_password] if params[:document_password]
142
- headers["Idempotency-Key"] = params[:idempotency_key] if params[:idempotency_key]
143
-
144
- request = CloudPDF::Internal::JSON::Request.new(
145
- base_url: request_options[:base_url],
146
- method: "POST",
147
- path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/pages/delete",
148
- headers: headers,
149
- body: body_params,
150
- request_options: request_options
151
- )
152
- begin
153
- response = @client.send(request)
154
- rescue Net::HTTPRequestTimeout
155
- raise CloudPDF::Errors::TimeoutError
156
- end
157
- code = response.code.to_i
158
- if code.between?(200, 299)
159
- (response.body.to_s.empty? ? nil : CloudPDF::Types::DocPagesDelete200Response.load(response.body))
160
- else
161
- error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
162
- raise error_class.new(response.body, code: code)
163
- end
164
- end
165
-
166
113
  # A read, not a mutation: the source document is untouched and no event is published. Body is `{"pages":
167
- # PageRef[]}`; the response body is the new PDF.
114
+ # PageRef[], "flatten"?: {"usage"?: "display" | "print"}, "includeAnnotations"?: boolean, "includeFormFields"?:
115
+ # boolean}`; the response body is the new PDF. With `flatten` the copy is the pages as they draw for `usage`
116
+ # (`"print"`: a print copy): the annotations and form fields painted in, nothing interactive left, layers in
117
+ # their state for the usage. A flattened copy takes `doc.download` or `doc.download.flattened`, and paints only
118
+ # what the caller may read; `includeAnnotations` and `includeFormFields` choose what it paints, and are refused
119
+ # without `flatten`.
168
120
  #
169
121
  # @param request_options [Hash]
170
122
  # @param params [CloudPDF::Types::DocPagesExtractRequest]
@@ -270,117 +222,6 @@ module CloudPDF
270
222
  end
271
223
  end
272
224
 
273
- # Multipart: a JSON `body` part `{"position"?: PagePosition, "resources": {"source": "<key>"}}` (position
274
- # omitted → the end), and the standalone PDF whose pages are copied in as the part `resource:<key>`. The
275
- # inserted copies get fresh page object numbers, returned in insertion order.
276
- #
277
- # @param request_options [Hash]
278
- # @param params [void]
279
- # @option request_options [String] :base_url
280
- # @option request_options [Hash{String => Object}] :additional_headers
281
- # @option request_options [Hash{String => Object}] :additional_query_parameters
282
- # @option request_options [Hash{String => Object}] :additional_body_parameters
283
- # @option request_options [Integer] :timeout_in_seconds
284
- # @option params [String] :doc_id
285
- # @option params [String] :layer_name
286
- # @option params [String, nil] :document_password
287
- # @option params [String, nil] :idempotency_key
288
- #
289
- # @example
290
- # client.doc.pages.insert(
291
- # doc_id: "docId",
292
- # layer_name: "layerName"
293
- # )
294
- #
295
- # @return [CloudPDF::Types::DocPagesInsert200Response]
296
- def insert(request_options: {}, **params)
297
- params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
298
- body = Internal::Multipart::FormData.new
299
-
300
- if params[:file]
301
- body.add_file(
302
- name: "file",
303
- file: params[:file]
304
- )
305
- end
306
-
307
- request = CloudPDF::Internal::Multipart::Request.new(
308
- base_url: request_options[:base_url],
309
- method: "POST",
310
- path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/pages/insert",
311
- body: body,
312
- request_options: request_options
313
- )
314
- begin
315
- response = @client.send(request)
316
- rescue Net::HTTPRequestTimeout
317
- raise CloudPDF::Errors::TimeoutError
318
- end
319
- code = response.code.to_i
320
- if code.between?(200, 299)
321
- (response.body.to_s.empty? ? nil : CloudPDF::Types::DocPagesInsert200Response.load(response.body))
322
- else
323
- error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
324
- raise error_class.new(response.body, code: code)
325
- end
326
- end
327
-
328
- # Body is `{"size": {"width", "height"}, "count"?, "position"?}` — size in PDF points, count in [1, 100],
329
- # `position` a `PagePosition` (omitted → the end).
330
- #
331
- # @param request_options [Hash]
332
- # @param params [CloudPDF::Types::DocPagesInsertBlankRequest]
333
- # @option request_options [String] :base_url
334
- # @option request_options [Hash{String => Object}] :additional_headers
335
- # @option request_options [Hash{String => Object}] :additional_query_parameters
336
- # @option request_options [Hash{String => Object}] :additional_body_parameters
337
- # @option request_options [Integer] :timeout_in_seconds
338
- # @option params [String] :doc_id
339
- # @option params [String] :layer_name
340
- # @option params [String, nil] :document_password
341
- # @option params [String, nil] :idempotency_key
342
- #
343
- # @example
344
- # client.doc.pages.insert_blank(
345
- # doc_id: "docId",
346
- # layer_name: "layerName",
347
- # request: {
348
- # key: "value"
349
- # }
350
- # )
351
- #
352
- # @return [CloudPDF::Types::DocPagesInsertBlank200Response]
353
- def insert_blank(request_options: {}, **params)
354
- params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
355
- path_param_names = %i[doc_id layer_name]
356
- body_params = params.except(*path_param_names)
357
-
358
- headers = {}
359
- headers["X-Document-Password"] = params[:document_password] if params[:document_password]
360
- headers["Idempotency-Key"] = params[:idempotency_key] if params[:idempotency_key]
361
-
362
- request = CloudPDF::Internal::JSON::Request.new(
363
- base_url: request_options[:base_url],
364
- method: "POST",
365
- path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/pages/insert-blank",
366
- headers: headers,
367
- body: body_params,
368
- request_options: request_options
369
- )
370
- begin
371
- response = @client.send(request)
372
- rescue Net::HTTPRequestTimeout
373
- raise CloudPDF::Errors::TimeoutError
374
- end
375
- code = response.code.to_i
376
- if code.between?(200, 299)
377
- (response.body.to_s.empty? ? nil : CloudPDF::Types::DocPagesInsertBlank200Response.load(response.body))
378
- else
379
- error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
380
- raise error_class.new(response.body, code: code)
381
- end
382
- end
383
-
384
225
  # @param request_options [Hash]
385
226
  # @param params [CloudPDF::Types::DocPagesSetNameRequest]
386
227
  # @option request_options [String] :base_url
@@ -486,115 +327,6 @@ module CloudPDF
486
327
  raise error_class.new(response.body, code: code)
487
328
  end
488
329
  end
489
-
490
- # @param request_options [Hash]
491
- # @param params [CloudPDF::Doc::Pages::Types::DocPagesReorderRequest]
492
- # @option request_options [String] :base_url
493
- # @option request_options [Hash{String => Object}] :additional_headers
494
- # @option request_options [Hash{String => Object}] :additional_query_parameters
495
- # @option request_options [Hash{String => Object}] :additional_body_parameters
496
- # @option request_options [Integer] :timeout_in_seconds
497
- # @option params [String] :doc_id
498
- # @option params [String] :layer_name
499
- # @option params [String, nil] :document_password
500
- # @option params [String, nil] :idempotency_key
501
- #
502
- # @example
503
- # client.doc.pages.reorder(
504
- # doc_id: "docId",
505
- # layer_name: "layerName",
506
- # pages: [{
507
- # kind: "objectNumber",
508
- # object_number: 1
509
- # }],
510
- # position: "start"
511
- # )
512
- #
513
- # @return [CloudPDF::Types::DocPagesReorder200Response]
514
- def reorder(request_options: {}, **params)
515
- params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
516
- request_data = CloudPDF::Doc::Pages::Types::DocPagesReorderRequest.new(params).to_h
517
- non_body_param_names = %w[docId layerName X-Document-Password Idempotency-Key]
518
- body = request_data.except(*non_body_param_names)
519
-
520
- headers = {}
521
- headers["X-Document-Password"] = params[:document_password] if params[:document_password]
522
- headers["Idempotency-Key"] = params[:idempotency_key] if params[:idempotency_key]
523
-
524
- request = CloudPDF::Internal::JSON::Request.new(
525
- base_url: request_options[:base_url],
526
- method: "POST",
527
- path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/pages/reorder",
528
- headers: headers,
529
- body: body,
530
- request_options: request_options
531
- )
532
- begin
533
- response = @client.send(request)
534
- rescue Net::HTTPRequestTimeout
535
- raise CloudPDF::Errors::TimeoutError
536
- end
537
- code = response.code.to_i
538
- if code.between?(200, 299)
539
- (response.body.to_s.empty? ? nil : CloudPDF::Types::DocPagesReorder200Response.load(response.body))
540
- else
541
- error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
542
- raise error_class.new(response.body, code: code)
543
- end
544
- end
545
-
546
- # @param request_options [Hash]
547
- # @param params [CloudPDF::Types::DocPagesRotateRequest]
548
- # @option request_options [String] :base_url
549
- # @option request_options [Hash{String => Object}] :additional_headers
550
- # @option request_options [Hash{String => Object}] :additional_query_parameters
551
- # @option request_options [Hash{String => Object}] :additional_body_parameters
552
- # @option request_options [Integer] :timeout_in_seconds
553
- # @option params [String] :doc_id
554
- # @option params [String] :layer_name
555
- # @option params [String, nil] :document_password
556
- # @option params [String, nil] :idempotency_key
557
- #
558
- # @example
559
- # client.doc.pages.rotate(
560
- # doc_id: "docId",
561
- # layer_name: "layerName",
562
- # request: {
563
- # key: "value"
564
- # }
565
- # )
566
- #
567
- # @return [CloudPDF::Types::DocPagesRotate200Response]
568
- def rotate(request_options: {}, **params)
569
- params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
570
- path_param_names = %i[doc_id layer_name]
571
- body_params = params.except(*path_param_names)
572
-
573
- headers = {}
574
- headers["X-Document-Password"] = params[:document_password] if params[:document_password]
575
- headers["Idempotency-Key"] = params[:idempotency_key] if params[:idempotency_key]
576
-
577
- request = CloudPDF::Internal::JSON::Request.new(
578
- base_url: request_options[:base_url],
579
- method: "POST",
580
- path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/pages/rotate",
581
- headers: headers,
582
- body: body_params,
583
- request_options: request_options
584
- )
585
- begin
586
- response = @client.send(request)
587
- rescue Net::HTTPRequestTimeout
588
- raise CloudPDF::Errors::TimeoutError
589
- end
590
- code = response.code.to_i
591
- if code.between?(200, 299)
592
- (response.body.to_s.empty? ? nil : CloudPDF::Types::DocPagesRotate200Response.load(response.body))
593
- else
594
- error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
595
- raise error_class.new(response.body, code: code)
596
- end
597
- end
598
330
  end
599
331
  end
600
332
  end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Doc
5
+ module Types
6
+ class DocDownloadLinkRequest < Internal::Types::Model
7
+ field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
8
+
9
+ field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName"
10
+
11
+ field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password"
12
+
13
+ field :expires_in, -> { Integer }, optional: true, nullable: false, api_name: "expiresIn"
14
+ end
15
+ end
16
+ end
17
+ end
@@ -392,6 +392,11 @@ module CloudPDF
392
392
  raise error_class.new(response.body, code: code)
393
393
  end
394
394
  end
395
+
396
+ # @return [CloudPDF::Layers::Client]
397
+ def layers
398
+ @layers ||= CloudPDF::Documents::Layers::Client.new(client: @client)
399
+ end
395
400
  end
396
401
  end
397
402
  end
@@ -0,0 +1,103 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Documents
5
+ module Layers
6
+ class Client
7
+ # @param client [CloudPDF::Internal::Http::RawClient]
8
+ #
9
+ # @return [void]
10
+ def initialize(client:)
11
+ @client = client
12
+ end
13
+
14
+ # @param request_options [Hash]
15
+ # @param params [Hash]
16
+ # @option request_options [String] :base_url
17
+ # @option request_options [Hash{String => Object}] :additional_headers
18
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
19
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
20
+ # @option request_options [Integer] :timeout_in_seconds
21
+ # @option params [String] :tenant_id
22
+ # @option params [String] :id
23
+ # @option params [Integer, nil] :limit
24
+ # @option params [String, nil] :cursor
25
+ # @option params [String, nil] :share_id
26
+ #
27
+ # @example
28
+ # client.documents.layers.list(
29
+ # tenant_id: "tenantId",
30
+ # id: "id"
31
+ # )
32
+ #
33
+ # @return [CloudPDF::Types::DocumentsLayersList200Response]
34
+ def list(request_options: {}, **params)
35
+ params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
36
+ query_params = {}
37
+ query_params["limit"] = params[:limit] if params.key?(:limit)
38
+ query_params["cursor"] = params[:cursor] if params.key?(:cursor)
39
+ query_params["shareId"] = params[:share_id] if params.key?(:share_id)
40
+
41
+ request = CloudPDF::Internal::JSON::Request.new(
42
+ base_url: request_options[:base_url],
43
+ method: "GET",
44
+ path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/documents/#{URI.encode_uri_component(params[:id].to_s)}/layers",
45
+ query: query_params,
46
+ request_options: request_options
47
+ )
48
+ begin
49
+ response = @client.send(request)
50
+ rescue Net::HTTPRequestTimeout
51
+ raise CloudPDF::Errors::TimeoutError
52
+ end
53
+ code = response.code.to_i
54
+ if code.between?(200, 299)
55
+ (response.body.to_s.empty? ? nil : CloudPDF::Types::DocumentsLayersList200Response.load(response.body))
56
+ else
57
+ error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
58
+ raise error_class.new(response.body, code: code)
59
+ end
60
+ end
61
+
62
+ # @param request_options [Hash]
63
+ # @param params [Hash]
64
+ # @option request_options [String] :base_url
65
+ # @option request_options [Hash{String => Object}] :additional_headers
66
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
67
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
68
+ # @option request_options [Integer] :timeout_in_seconds
69
+ # @option params [String] :tenant_id
70
+ # @option params [String] :id
71
+ # @option params [String] :layer_name
72
+ #
73
+ # @example
74
+ # client.documents.layers.delete(
75
+ # tenant_id: "tenantId",
76
+ # id: "id",
77
+ # layer_name: "layerName"
78
+ # )
79
+ #
80
+ # @return [untyped]
81
+ def delete(request_options: {}, **params)
82
+ params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
83
+ request = CloudPDF::Internal::JSON::Request.new(
84
+ base_url: request_options[:base_url],
85
+ method: "DELETE",
86
+ path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/documents/#{URI.encode_uri_component(params[:id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}",
87
+ request_options: request_options
88
+ )
89
+ begin
90
+ response = @client.send(request)
91
+ rescue Net::HTTPRequestTimeout
92
+ raise CloudPDF::Errors::TimeoutError
93
+ end
94
+ code = response.code.to_i
95
+ return if code.between?(200, 299)
96
+
97
+ error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
98
+ raise error_class.new(response.body, code: code)
99
+ end
100
+ end
101
+ end
102
+ end
103
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Documents
5
+ module Layers
6
+ module Types
7
+ class DeleteLayersRequest < Internal::Types::Model
8
+ field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
9
+
10
+ field :id, -> { String }, optional: false, nullable: false
11
+
12
+ field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName"
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Documents
5
+ module Layers
6
+ module Types
7
+ class ListLayersRequest < Internal::Types::Model
8
+ field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
9
+
10
+ field :id, -> { String }, optional: false, nullable: false
11
+
12
+ field :limit, -> { Integer }, optional: true, nullable: false
13
+
14
+ field :cursor, -> { String }, optional: true, nullable: false
15
+
16
+ field :share_id, -> { String }, optional: true, nullable: false, api_name: "shareId"
17
+ end
18
+ end
19
+ end
20
+ end
21
+ end
@@ -12,7 +12,12 @@ module CloudPDF
12
12
 
13
13
  # Unauthenticated, but requires a browser Origin header, checked against the grant allowlist. Unknown, revoked,
14
14
  # and disabled tokens are indistinguishable (404). Passphrase-protected grants return 422 SharePasswordRequired
15
- # until `password` is supplied. Mounted only when the deployment can sign (HS256 mode).
15
+ # until `password` is supplied. A link that asks its visitors who they are on open returns 422
16
+ # VisitorIdentityRequired until the required answers are given; `error.details` carries `fields` (what the link
17
+ # asks), `missing`, `invalid`, `purpose` and `privacyUrl`. A link that asks before the first change issues the
18
+ # session at once with `visitor.identityRequest`, and writes answer 403 VisitorIdentityRequired with the same
19
+ # details until the visitor exchanges again with their answers. Answers that can not be taken answer 422 on any
20
+ # link. Mounted only when the deployment can sign (HS256 mode).
16
21
  #
17
22
  # @param request_options [Hash]
18
23
  # @param params [CloudPDF::Shares::Types::SharesExchangeRequest]
@@ -60,6 +65,7 @@ module CloudPDF
60
65
  # @option params [Integer, nil] :limit
61
66
  # @option params [String, nil] :cursor
62
67
  # @option params [String, nil] :doc_id
68
+ # @option params [Boolean, nil] :archived
63
69
  #
64
70
  # @example
65
71
  # client.shares.list(tenant_id: "tenantId")
@@ -71,6 +77,7 @@ module CloudPDF
71
77
  query_params["limit"] = params[:limit] if params.key?(:limit)
72
78
  query_params["cursor"] = params[:cursor] if params.key?(:cursor)
73
79
  query_params["docId"] = params[:doc_id] if params.key?(:doc_id)
80
+ query_params["archived"] = params[:archived] if params.key?(:archived)
74
81
 
75
82
  request = CloudPDF::Internal::JSON::Request.new(
76
83
  base_url: request_options[:base_url],
@@ -259,6 +266,54 @@ module CloudPDF
259
266
  raise error_class.new(response.body, code: code)
260
267
  end
261
268
  end
269
+
270
+ # Archiving is final: an archived link never exchanges again, and to share again you create a new link. Pausing
271
+ # (`disabled`) is the reversible stop. An archived link no longer counts as using its shared layer, so that layer
272
+ # can be deleted.
273
+ #
274
+ # @param request_options [Hash]
275
+ # @param params [Hash]
276
+ # @option request_options [String] :base_url
277
+ # @option request_options [Hash{String => Object}] :additional_headers
278
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
279
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
280
+ # @option request_options [Integer] :timeout_in_seconds
281
+ # @option params [String] :tenant_id
282
+ # @option params [String] :share_id
283
+ #
284
+ # @example
285
+ # client.shares.archive(
286
+ # tenant_id: "tenantId",
287
+ # share_id: "shareId"
288
+ # )
289
+ #
290
+ # @return [CloudPDF::Types::SharesArchive200Response]
291
+ def archive(request_options: {}, **params)
292
+ params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
293
+ request = CloudPDF::Internal::JSON::Request.new(
294
+ base_url: request_options[:base_url],
295
+ method: "POST",
296
+ path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/shares/#{URI.encode_uri_component(params[:share_id].to_s)}/archive",
297
+ request_options: request_options
298
+ )
299
+ begin
300
+ response = @client.send(request)
301
+ rescue Net::HTTPRequestTimeout
302
+ raise CloudPDF::Errors::TimeoutError
303
+ end
304
+ code = response.code.to_i
305
+ if code.between?(200, 299)
306
+ (response.body.to_s.empty? ? nil : CloudPDF::Types::SharesArchive200Response.load(response.body))
307
+ else
308
+ error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
309
+ raise error_class.new(response.body, code: code)
310
+ end
311
+ end
312
+
313
+ # @return [CloudPDF::Visitors::Client]
314
+ def visitors
315
+ @visitors ||= CloudPDF::Shares::Visitors::Client.new(client: @client)
316
+ end
262
317
  end
263
318
  end
264
319
  end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Shares
5
+ module Types
6
+ class ArchiveSharesRequest < Internal::Types::Model
7
+ field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
8
+
9
+ field :share_id, -> { String }, optional: false, nullable: false, api_name: "shareId"
10
+ end
11
+ end
12
+ end
13
+ end
@@ -11,6 +11,8 @@ module CloudPDF
11
11
  field :cursor, -> { String }, optional: true, nullable: false
12
12
 
13
13
  field :doc_id, -> { String }, optional: true, nullable: false, api_name: "docId"
14
+
15
+ field :archived, -> { Internal::Types::Boolean }, optional: true, nullable: false
14
16
  end
15
17
  end
16
18
  end
@@ -8,8 +8,16 @@ module CloudPDF
8
8
 
9
9
  field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId"
10
10
 
11
+ field :layer_mode, -> { CloudPDF::Shares::Types::SharesCreateRequestLayerMode }, optional: true, nullable: false, api_name: "layerMode"
12
+
11
13
  field :layer_name, -> { String }, optional: true, nullable: false, api_name: "layerName"
12
14
 
15
+ field :keep_visitor_layers, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "keepVisitorLayers"
16
+
17
+ field :visitor_idle_seconds, -> { Integer }, optional: true, nullable: false, api_name: "visitorIdleSeconds"
18
+
19
+ field :visitor_identity, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentity }, optional: true, nullable: false, api_name: "visitorIdentity"
20
+
13
21
  field :scope, -> { Internal::Types::Array[String] }, optional: false, nullable: false
14
22
 
15
23
  field :origins, -> { Internal::Types::Array[String] }, optional: true, nullable: false
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Shares
5
+ module Types
6
+ module SharesCreateRequestLayerMode
7
+ extend CloudPDF::Internal::Types::Enum
8
+
9
+ SHARED = "shared"
10
+ PER_VISITOR = "per-visitor"
11
+ end
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Shares
5
+ module Types
6
+ class SharesCreateRequestVisitorIdentity < Internal::Types::Model
7
+ field :fields, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityFields }, optional: false, nullable: false
8
+
9
+ field :ask, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityAsk }, optional: false, nullable: false
10
+
11
+ field :purpose, -> { String }, optional: true, nullable: false
12
+
13
+ field :privacy_url, -> { String }, optional: true, nullable: false, api_name: "privacyUrl"
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Shares
5
+ module Types
6
+ module SharesCreateRequestVisitorIdentityAsk
7
+ extend CloudPDF::Internal::Types::Enum
8
+
9
+ ON_OPEN = "on-open"
10
+ BEFORE_FIRST_CHANGE = "before-first-change"
11
+ end
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Shares
5
+ module Types
6
+ class SharesCreateRequestVisitorIdentityFields < Internal::Types::Model
7
+ field :display_name, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityFieldsDisplayName }, optional: true, nullable: false, api_name: "displayName"
8
+
9
+ field :email, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityFieldsEmail }, optional: true, nullable: false
10
+
11
+ field :title, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityFieldsTitle }, optional: true, nullable: false
12
+
13
+ field :organization, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityFieldsOrganization }, optional: true, nullable: false
14
+
15
+ field :organizational_unit, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityFieldsOrganizationalUnit }, optional: true, nullable: false, api_name: "organizationalUnit"
16
+ end
17
+ end
18
+ end
19
+ end