cloudpdf 3.0.0.alpha.18 → 3.0.0.alpha.20

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 (310) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +2 -2
  3. data/README.md +9 -1
  4. data/lib/CloudPDF/client.rb +4 -4
  5. data/lib/CloudPDF/doc/client.rb +5 -0
  6. data/lib/CloudPDF/doc/fonts/client.rb +116 -0
  7. data/lib/CloudPDF/doc/fonts/programs/client.rb +111 -0
  8. data/lib/CloudPDF/doc/fonts/programs/types/download_programs_request.rb +21 -0
  9. data/lib/CloudPDF/doc/fonts/programs/types/get_programs_request.rb +21 -0
  10. data/lib/CloudPDF/doc/fonts/types/list_fonts_request.rb +17 -0
  11. data/lib/CloudPDF/doc/fonts/types/resolve_fonts_request.rb +19 -0
  12. data/lib/CloudPDF/documents/client.rb +9 -1
  13. data/lib/CloudPDF/documents/layers/client.rb +2 -2
  14. data/lib/CloudPDF/documents/layers/types/list_layers_request.rb +1 -1
  15. data/lib/CloudPDF/environment.rb +7 -0
  16. data/lib/CloudPDF/folders/client.rb +1 -1
  17. data/lib/CloudPDF/{shares → grants}/client.rb +57 -56
  18. data/lib/CloudPDF/{shares/types/archive_shares_request.rb → grants/types/archive_grants_request.rb} +3 -3
  19. data/lib/CloudPDF/{shares/types/delete_shares_request.rb → grants/types/delete_grants_request.rb} +3 -3
  20. data/lib/CloudPDF/{shares/types/get_shares_request.rb → grants/types/get_grants_request.rb} +3 -3
  21. data/lib/CloudPDF/{shares/types/shares_create_request.rb → grants/types/grants_create_request.rb} +7 -5
  22. data/lib/CloudPDF/{shares/types/shares_create_request_layer_mode.rb → grants/types/grants_create_request_layer_mode.rb} +2 -2
  23. data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity.rb → grants/types/grants_create_request_visitor_identity.rb} +4 -4
  24. data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_ask.rb → grants/types/grants_create_request_visitor_identity_ask.rb} +2 -2
  25. data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields.rb → grants/types/grants_create_request_visitor_identity_fields.rb} +7 -7
  26. data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields_display_name.rb → grants/types/grants_create_request_visitor_identity_fields_display_name.rb} +2 -2
  27. data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields_title.rb → grants/types/grants_create_request_visitor_identity_fields_email.rb} +2 -2
  28. data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields_organization.rb → grants/types/grants_create_request_visitor_identity_fields_organization.rb} +2 -2
  29. data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields_organizational_unit.rb → grants/types/grants_create_request_visitor_identity_fields_organizational_unit.rb} +2 -2
  30. data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields_email.rb → grants/types/grants_create_request_visitor_identity_fields_title.rb} +2 -2
  31. data/lib/CloudPDF/grants/types/grants_exchange_request.rb +19 -0
  32. data/lib/CloudPDF/{shares/types/shares_exchange_request_visitor_identity.rb → grants/types/grants_exchange_request_visitor_identity.rb} +2 -2
  33. data/lib/CloudPDF/{shares/types/shares_update_request.rb → grants/types/grants_update_request.rb} +8 -6
  34. data/lib/CloudPDF/{shares/types/shares_update_request_layer_mode.rb → grants/types/grants_update_request_layer_mode.rb} +2 -2
  35. data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity.rb → grants/types/grants_update_request_visitor_identity.rb} +4 -4
  36. data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_ask.rb → grants/types/grants_update_request_visitor_identity_ask.rb} +2 -2
  37. data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields.rb → grants/types/grants_update_request_visitor_identity_fields.rb} +7 -7
  38. data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields_display_name.rb → grants/types/grants_update_request_visitor_identity_fields_display_name.rb} +2 -2
  39. data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields_title.rb → grants/types/grants_update_request_visitor_identity_fields_email.rb} +2 -2
  40. data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields_organization.rb → grants/types/grants_update_request_visitor_identity_fields_organization.rb} +2 -2
  41. data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields_organizational_unit.rb → grants/types/grants_update_request_visitor_identity_fields_organizational_unit.rb} +2 -2
  42. data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields_email.rb → grants/types/grants_update_request_visitor_identity_fields_title.rb} +2 -2
  43. data/lib/CloudPDF/{shares/types/list_shares_request.rb → grants/types/list_grants_request.rb} +2 -2
  44. data/lib/CloudPDF/{shares → grants}/visitors/client.rb +12 -12
  45. data/lib/CloudPDF/{shares → grants}/visitors/types/delete_visitors_request.rb +2 -2
  46. data/lib/CloudPDF/{shares → grants}/visitors/types/list_visitors_request.rb +2 -2
  47. data/lib/CloudPDF/tenants/client.rb +1 -1
  48. data/lib/CloudPDF/tokens/client.rb +4 -2
  49. data/lib/CloudPDF/types/annotation_caret.rb +2 -0
  50. data/lib/CloudPDF/types/annotation_circle.rb +2 -0
  51. data/lib/CloudPDF/types/annotation_draft_caret.rb +2 -0
  52. data/lib/CloudPDF/types/annotation_draft_circle.rb +2 -0
  53. data/lib/CloudPDF/types/annotation_draft_file_attachment.rb +2 -0
  54. data/lib/CloudPDF/types/annotation_draft_free_text.rb +2 -0
  55. data/lib/CloudPDF/types/annotation_draft_highlight.rb +2 -0
  56. data/lib/CloudPDF/types/annotation_draft_ink.rb +2 -0
  57. data/lib/CloudPDF/types/annotation_draft_line.rb +2 -0
  58. data/lib/CloudPDF/types/annotation_draft_link.rb +2 -0
  59. data/lib/CloudPDF/types/annotation_draft_polygon.rb +2 -0
  60. data/lib/CloudPDF/types/annotation_draft_polyline.rb +2 -0
  61. data/lib/CloudPDF/types/annotation_draft_popup.rb +2 -0
  62. data/lib/CloudPDF/types/annotation_draft_redact.rb +2 -0
  63. data/lib/CloudPDF/types/annotation_draft_square.rb +2 -0
  64. data/lib/CloudPDF/types/annotation_draft_squiggly.rb +2 -0
  65. data/lib/CloudPDF/types/annotation_draft_stamp.rb +2 -0
  66. data/lib/CloudPDF/types/annotation_draft_strikeout.rb +2 -0
  67. data/lib/CloudPDF/types/annotation_draft_text.rb +2 -0
  68. data/lib/CloudPDF/types/annotation_draft_underline.rb +2 -0
  69. data/lib/CloudPDF/types/annotation_draft_widget.rb +2 -0
  70. data/lib/CloudPDF/types/annotation_file_attachment.rb +2 -0
  71. data/lib/CloudPDF/types/annotation_free_text.rb +2 -0
  72. data/lib/CloudPDF/types/annotation_highlight.rb +2 -0
  73. data/lib/CloudPDF/types/annotation_ink.rb +2 -0
  74. data/lib/CloudPDF/types/annotation_line.rb +2 -0
  75. data/lib/CloudPDF/types/annotation_link.rb +2 -0
  76. data/lib/CloudPDF/types/annotation_mutation_meta.rb +2 -0
  77. data/lib/CloudPDF/types/annotation_patch_caret.rb +2 -0
  78. data/lib/CloudPDF/types/annotation_patch_circle.rb +2 -0
  79. data/lib/CloudPDF/types/annotation_patch_file_attachment.rb +2 -0
  80. data/lib/CloudPDF/types/annotation_patch_free_text.rb +2 -0
  81. data/lib/CloudPDF/types/annotation_patch_highlight.rb +2 -0
  82. data/lib/CloudPDF/types/annotation_patch_ink.rb +2 -0
  83. data/lib/CloudPDF/types/annotation_patch_line.rb +2 -0
  84. data/lib/CloudPDF/types/annotation_patch_link.rb +2 -0
  85. data/lib/CloudPDF/types/annotation_patch_polygon.rb +2 -0
  86. data/lib/CloudPDF/types/annotation_patch_polyline.rb +2 -0
  87. data/lib/CloudPDF/types/annotation_patch_popup.rb +2 -0
  88. data/lib/CloudPDF/types/annotation_patch_redact.rb +2 -0
  89. data/lib/CloudPDF/types/annotation_patch_square.rb +2 -0
  90. data/lib/CloudPDF/types/annotation_patch_squiggly.rb +2 -0
  91. data/lib/CloudPDF/types/annotation_patch_stamp.rb +2 -0
  92. data/lib/CloudPDF/types/annotation_patch_strikeout.rb +2 -0
  93. data/lib/CloudPDF/types/annotation_patch_text.rb +2 -0
  94. data/lib/CloudPDF/types/annotation_patch_underline.rb +2 -0
  95. data/lib/CloudPDF/types/annotation_polygon.rb +2 -0
  96. data/lib/CloudPDF/types/annotation_polyline.rb +2 -0
  97. data/lib/CloudPDF/types/annotation_popup.rb +2 -0
  98. data/lib/CloudPDF/types/annotation_redact.rb +2 -0
  99. data/lib/CloudPDF/types/annotation_square.rb +2 -0
  100. data/lib/CloudPDF/types/annotation_squiggly.rb +2 -0
  101. data/lib/CloudPDF/types/annotation_stamp.rb +2 -0
  102. data/lib/CloudPDF/types/annotation_strikeout.rb +2 -0
  103. data/lib/CloudPDF/types/annotation_text.rb +2 -0
  104. data/lib/CloudPDF/types/annotation_underline.rb +2 -0
  105. data/lib/CloudPDF/types/annotation_unsupported.rb +2 -0
  106. data/lib/CloudPDF/types/attachment_mutation_meta.rb +2 -0
  107. data/lib/CloudPDF/types/cache_delta.rb +2 -0
  108. data/lib/CloudPDF/types/change_item.rb +2 -0
  109. data/lib/CloudPDF/types/change_item_pages_copy.rb +13 -0
  110. data/lib/CloudPDF/types/change_item_pages_copy_layout.rb +15 -0
  111. data/lib/CloudPDF/types/change_item_pages_copy_layout_labels_item.rb +15 -0
  112. data/lib/CloudPDF/types/change_item_pages_copy_layout_labels_item_style.rb +15 -0
  113. data/lib/CloudPDF/types/change_item_pages_copy_layout_named_pages_item.rb +11 -0
  114. data/lib/CloudPDF/types/change_item_pages_copy_layout_named_pages_item_target.rb +17 -0
  115. data/lib/CloudPDF/types/change_item_pages_copy_layout_named_pages_item_target_dangling.rb +7 -0
  116. data/lib/CloudPDF/types/change_item_pages_copy_layout_named_pages_item_target_page.rb +9 -0
  117. data/lib/CloudPDF/types/change_item_pages_copy_layout_named_pages_item_target_template.rb +9 -0
  118. data/lib/CloudPDF/types/change_item_pages_copy_layout_pages_item.rb +27 -0
  119. data/lib/CloudPDF/types/change_item_pages_copy_layout_pages_item_boxes.rb +17 -0
  120. data/lib/CloudPDF/types/change_item_pages_copy_layout_pages_item_boxes_art.rb +15 -0
  121. data/lib/CloudPDF/types/change_item_pages_copy_layout_pages_item_boxes_bleed.rb +15 -0
  122. data/lib/CloudPDF/types/change_item_pages_copy_layout_pages_item_boxes_crop.rb +15 -0
  123. data/lib/CloudPDF/types/change_item_pages_copy_layout_pages_item_boxes_media.rb +15 -0
  124. data/lib/CloudPDF/types/change_item_pages_copy_layout_pages_item_boxes_trim.rb +15 -0
  125. data/lib/CloudPDF/types/change_item_pages_copy_layout_pages_item_pdf_crop_box.rb +15 -0
  126. data/lib/CloudPDF/types/change_item_pages_copy_layout_pages_item_size.rb +11 -0
  127. data/lib/CloudPDF/types/change_item_pages_copy_layout_pages_item_tab_order.rb +15 -0
  128. data/lib/CloudPDF/types/change_item_pages_delete_layout.rb +2 -0
  129. data/lib/CloudPDF/types/change_item_pages_delete_layout_labels_item.rb +15 -0
  130. data/lib/CloudPDF/types/change_item_pages_delete_layout_labels_item_style.rb +15 -0
  131. data/lib/CloudPDF/types/change_item_pages_insert_blank_layout.rb +2 -0
  132. data/lib/CloudPDF/types/change_item_pages_insert_blank_layout_labels_item.rb +15 -0
  133. data/lib/CloudPDF/types/change_item_pages_insert_blank_layout_labels_item_style.rb +15 -0
  134. data/lib/CloudPDF/types/change_item_pages_insert_layout.rb +2 -0
  135. data/lib/CloudPDF/types/change_item_pages_insert_layout_labels_item.rb +15 -0
  136. data/lib/CloudPDF/types/change_item_pages_insert_layout_labels_item_style.rb +15 -0
  137. data/lib/CloudPDF/types/change_item_pages_reorder_layout.rb +2 -0
  138. data/lib/CloudPDF/types/change_item_pages_reorder_layout_labels_item.rb +15 -0
  139. data/lib/CloudPDF/types/change_item_pages_reorder_layout_labels_item_style.rb +15 -0
  140. data/lib/CloudPDF/types/change_item_pages_restore_layout.rb +2 -0
  141. data/lib/CloudPDF/types/change_item_pages_restore_layout_labels_item.rb +15 -0
  142. data/lib/CloudPDF/types/change_item_pages_restore_layout_labels_item_style.rb +15 -0
  143. data/lib/CloudPDF/types/change_item_pages_rotate_layout.rb +2 -0
  144. data/lib/CloudPDF/types/change_item_pages_rotate_layout_labels_item.rb +15 -0
  145. data/lib/CloudPDF/types/change_item_pages_rotate_layout_labels_item_style.rb +15 -0
  146. data/lib/CloudPDF/types/change_item_skipped_op.rb +1 -0
  147. data/lib/CloudPDF/types/change_op.rb +2 -0
  148. data/lib/CloudPDF/types/change_op_pages_copy.rb +13 -0
  149. data/lib/CloudPDF/types/change_op_pages_insert.rb +2 -0
  150. data/lib/CloudPDF/types/{shares_get404response.rb → doc_fonts_list200response.rb} +2 -2
  151. data/lib/CloudPDF/types/{shares_archive404response.rb → doc_fonts_list404response.rb} +2 -2
  152. data/lib/CloudPDF/types/doc_fonts_programs_download403response.rb +23 -0
  153. data/lib/CloudPDF/types/doc_fonts_programs_download404response.rb +23 -0
  154. data/lib/CloudPDF/types/doc_fonts_programs_get200response.rb +23 -0
  155. data/lib/CloudPDF/types/doc_fonts_programs_get404response.rb +23 -0
  156. data/lib/CloudPDF/types/doc_fonts_resolve200response.rb +23 -0
  157. data/lib/CloudPDF/types/doc_fonts_resolve400response.rb +23 -0
  158. data/lib/CloudPDF/types/doc_fonts_resolve404response.rb +23 -0
  159. data/lib/CloudPDF/types/doc_fonts_resolve_request.rb +23 -0
  160. data/lib/CloudPDF/types/doc_manifest200response.rb +4 -0
  161. data/lib/CloudPDF/types/doc_pages_remove_name200response_layout.rb +2 -0
  162. data/lib/CloudPDF/types/doc_pages_remove_name200response_layout_labels_item.rb +15 -0
  163. data/lib/CloudPDF/types/doc_pages_remove_name200response_layout_labels_item_style.rb +15 -0
  164. data/lib/CloudPDF/types/doc_pages_set_name200response_layout.rb +2 -0
  165. data/lib/CloudPDF/types/doc_pages_set_name200response_layout_labels_item.rb +15 -0
  166. data/lib/CloudPDF/types/doc_pages_set_name200response_layout_labels_item_style.rb +15 -0
  167. data/lib/CloudPDF/types/documents_init403response.rb +23 -0
  168. data/lib/CloudPDF/types/documents_layers_list200response_layers_item.rb +1 -1
  169. data/lib/CloudPDF/types/documents_upload_proxy404response.rb +23 -0
  170. data/lib/CloudPDF/types/engine_error_payload_code.rb +1 -1
  171. data/lib/CloudPDF/types/font.rb +25 -0
  172. data/lib/CloudPDF/types/font_list.rb +13 -0
  173. data/lib/CloudPDF/types/font_program.rb +19 -0
  174. data/lib/CloudPDF/types/font_program_embedded.rb +13 -0
  175. data/lib/CloudPDF/types/font_program_embedding_permission.rb +13 -0
  176. data/lib/CloudPDF/types/font_program_format.rb +15 -0
  177. data/lib/CloudPDF/types/font_program_info.rb +25 -0
  178. data/lib/CloudPDF/types/font_program_info_covers_item.rb +11 -0
  179. data/lib/CloudPDF/types/font_program_info_embedded.rb +13 -0
  180. data/lib/CloudPDF/types/font_program_info_embedding_permission.rb +13 -0
  181. data/lib/CloudPDF/types/font_program_info_format.rb +15 -0
  182. data/lib/CloudPDF/types/font_resolution.rb +11 -0
  183. data/lib/CloudPDF/types/font_resolve_request.rb +11 -0
  184. data/lib/CloudPDF/types/font_resolve_run.rb +17 -0
  185. data/lib/CloudPDF/types/font_restrictions_item.rb +16 -0
  186. data/lib/CloudPDF/types/font_source.rb +13 -0
  187. data/lib/CloudPDF/types/form_mutation_meta.rb +2 -0
  188. data/lib/CloudPDF/types/grants_archive200response.rb +9 -0
  189. data/lib/CloudPDF/types/{shares_archive200response_share.rb → grants_archive200response_grant.rb} +6 -4
  190. data/lib/CloudPDF/types/{shares_archive200response_share_layer_mode.rb → grants_archive200response_grant_layer_mode.rb} +1 -1
  191. data/lib/CloudPDF/types/grants_archive200response_grant_visitor_identity.rb +15 -0
  192. data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_ask.rb → grants_archive200response_grant_visitor_identity_ask.rb} +1 -1
  193. data/lib/CloudPDF/types/grants_archive200response_grant_visitor_identity_fields.rb +17 -0
  194. data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_display_name.rb → grants_archive200response_grant_visitor_identity_fields_display_name.rb} +1 -1
  195. data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_email.rb → grants_archive200response_grant_visitor_identity_fields_email.rb} +1 -1
  196. data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_organization.rb → grants_archive200response_grant_visitor_identity_fields_organization.rb} +1 -1
  197. data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_organizational_unit.rb → grants_archive200response_grant_visitor_identity_fields_organizational_unit.rb} +1 -1
  198. data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_title.rb → grants_archive200response_grant_visitor_identity_fields_title.rb} +1 -1
  199. data/lib/CloudPDF/types/grants_archive404response.rb +23 -0
  200. data/lib/CloudPDF/types/grants_create200response.rb +9 -0
  201. data/lib/CloudPDF/types/{shares_update200response_share.rb → grants_create200response_grant.rb} +6 -4
  202. data/lib/CloudPDF/types/{shares_create200response_share_layer_mode.rb → grants_create200response_grant_layer_mode.rb} +1 -1
  203. data/lib/CloudPDF/types/grants_create200response_grant_visitor_identity.rb +15 -0
  204. data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_ask.rb → grants_create200response_grant_visitor_identity_ask.rb} +1 -1
  205. data/lib/CloudPDF/types/grants_create200response_grant_visitor_identity_fields.rb +17 -0
  206. data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_display_name.rb → grants_create200response_grant_visitor_identity_fields_display_name.rb} +1 -1
  207. data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_email.rb → grants_create200response_grant_visitor_identity_fields_email.rb} +1 -1
  208. data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_organization.rb → grants_create200response_grant_visitor_identity_fields_organization.rb} +1 -1
  209. data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_organizational_unit.rb → grants_create200response_grant_visitor_identity_fields_organizational_unit.rb} +1 -1
  210. data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_title.rb → grants_create200response_grant_visitor_identity_fields_title.rb} +1 -1
  211. data/lib/CloudPDF/types/{shares_delete404response.rb → grants_create400response.rb} +2 -2
  212. data/lib/CloudPDF/types/{shares_create400response.rb → grants_create403response.rb} +2 -2
  213. data/lib/CloudPDF/types/{shares_create403response.rb → grants_create404response.rb} +2 -2
  214. data/lib/CloudPDF/types/{shares_create404response.rb → grants_delete404response.rb} +2 -2
  215. data/lib/CloudPDF/types/grants_delete409response.rb +23 -0
  216. data/lib/CloudPDF/types/{shares_exchange200response.rb → grants_exchange200response.rb} +3 -3
  217. data/lib/CloudPDF/types/{shares_exchange200response_layer_mode.rb → grants_exchange200response_layer_mode.rb} +1 -1
  218. data/lib/CloudPDF/types/{shares_exchange200response_visitor.rb → grants_exchange200response_visitor.rb} +2 -2
  219. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request.rb → grants_exchange200response_visitor_identity_request.rb} +4 -4
  220. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields.rb → grants_exchange200response_visitor_identity_request_fields.rb} +6 -6
  221. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_display_name.rb → grants_exchange200response_visitor_identity_request_fields_display_name.rb} +1 -1
  222. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_email.rb → grants_exchange200response_visitor_identity_request_fields_email.rb} +1 -1
  223. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_organization.rb → grants_exchange200response_visitor_identity_request_fields_organization.rb} +1 -1
  224. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_organizational_unit.rb → grants_exchange200response_visitor_identity_request_fields_organizational_unit.rb} +1 -1
  225. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_title.rb → grants_exchange200response_visitor_identity_request_fields_title.rb} +1 -1
  226. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_invalid_item.rb → grants_exchange200response_visitor_identity_request_invalid_item.rb} +1 -1
  227. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_missing_item.rb → grants_exchange200response_visitor_identity_request_missing_item.rb} +1 -1
  228. data/lib/CloudPDF/types/{shares_exchange400response.rb → grants_exchange400response.rb} +2 -2
  229. data/lib/CloudPDF/types/{shares_exchange403response.rb → grants_exchange403response.rb} +2 -2
  230. data/lib/CloudPDF/types/{shares_exchange404response.rb → grants_exchange404response.rb} +2 -2
  231. data/lib/CloudPDF/types/{shares_exchange410response.rb → grants_exchange410response.rb} +2 -2
  232. data/lib/CloudPDF/types/grants_exchange422response.rb +23 -0
  233. data/lib/CloudPDF/types/grants_get200response.rb +9 -0
  234. data/lib/CloudPDF/types/{shares_get200response_share.rb → grants_get200response_grant.rb} +6 -4
  235. data/lib/CloudPDF/types/{shares_get200response_share_layer_mode.rb → grants_get200response_grant_layer_mode.rb} +1 -1
  236. data/lib/CloudPDF/types/grants_get200response_grant_visitor_identity.rb +15 -0
  237. data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_ask.rb → grants_get200response_grant_visitor_identity_ask.rb} +1 -1
  238. data/lib/CloudPDF/types/grants_get200response_grant_visitor_identity_fields.rb +17 -0
  239. data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_display_name.rb → grants_get200response_grant_visitor_identity_fields_display_name.rb} +1 -1
  240. data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_email.rb → grants_get200response_grant_visitor_identity_fields_email.rb} +1 -1
  241. data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_organization.rb → grants_get200response_grant_visitor_identity_fields_organization.rb} +1 -1
  242. data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_organizational_unit.rb → grants_get200response_grant_visitor_identity_fields_organizational_unit.rb} +1 -1
  243. data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_title.rb → grants_get200response_grant_visitor_identity_fields_title.rb} +1 -1
  244. data/lib/CloudPDF/types/{shares_list400response.rb → grants_get404response.rb} +2 -2
  245. data/lib/CloudPDF/types/{shares_list200response.rb → grants_list200response.rb} +2 -2
  246. data/lib/CloudPDF/types/{shares_list200response_shares_item.rb → grants_list200response_grants_item.rb} +6 -4
  247. data/lib/CloudPDF/types/grants_list200response_grants_item_layer_mode.rb +12 -0
  248. data/lib/CloudPDF/types/grants_list200response_grants_item_visitor_identity.rb +15 -0
  249. data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_ask.rb → grants_list200response_grants_item_visitor_identity_ask.rb} +1 -1
  250. data/lib/CloudPDF/types/grants_list200response_grants_item_visitor_identity_fields.rb +17 -0
  251. data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_display_name.rb → grants_list200response_grants_item_visitor_identity_fields_display_name.rb} +1 -1
  252. data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_email.rb → grants_list200response_grants_item_visitor_identity_fields_email.rb} +1 -1
  253. data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_organization.rb → grants_list200response_grants_item_visitor_identity_fields_organization.rb} +1 -1
  254. data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_organizational_unit.rb → grants_list200response_grants_item_visitor_identity_fields_organizational_unit.rb} +1 -1
  255. data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_title.rb → grants_list200response_grants_item_visitor_identity_fields_title.rb} +1 -1
  256. data/lib/CloudPDF/types/grants_list400response.rb +23 -0
  257. data/lib/CloudPDF/types/grants_update200response.rb +9 -0
  258. data/lib/CloudPDF/types/{shares_create200response_share.rb → grants_update200response_grant.rb} +6 -4
  259. data/lib/CloudPDF/types/{shares_update200response_share_layer_mode.rb → grants_update200response_grant_layer_mode.rb} +1 -1
  260. data/lib/CloudPDF/types/grants_update200response_grant_visitor_identity.rb +15 -0
  261. data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_ask.rb → grants_update200response_grant_visitor_identity_ask.rb} +1 -1
  262. data/lib/CloudPDF/types/grants_update200response_grant_visitor_identity_fields.rb +17 -0
  263. data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_display_name.rb → grants_update200response_grant_visitor_identity_fields_display_name.rb} +1 -1
  264. data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_email.rb → grants_update200response_grant_visitor_identity_fields_email.rb} +1 -1
  265. data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_organization.rb → grants_update200response_grant_visitor_identity_fields_organization.rb} +1 -1
  266. data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_organizational_unit.rb → grants_update200response_grant_visitor_identity_fields_organizational_unit.rb} +1 -1
  267. data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_title.rb → grants_update200response_grant_visitor_identity_fields_title.rb} +1 -1
  268. data/lib/CloudPDF/types/grants_update400response.rb +23 -0
  269. data/lib/CloudPDF/types/grants_update403response.rb +23 -0
  270. data/lib/CloudPDF/types/grants_update404response.rb +23 -0
  271. data/lib/CloudPDF/types/grants_update409response.rb +23 -0
  272. data/lib/CloudPDF/types/{shares_visitors_delete_response.rb → grants_visitors_delete_response.rb} +2 -2
  273. data/lib/CloudPDF/types/{shares_visitors_list200response.rb → grants_visitors_list200response.rb} +2 -2
  274. data/lib/CloudPDF/types/{shares_visitors_list200response_visitors_item.rb → grants_visitors_list200response_visitors_item.rb} +3 -3
  275. data/lib/CloudPDF/types/{shares_visitors_list200response_visitors_item_answers.rb → grants_visitors_list200response_visitors_item_answers.rb} +1 -1
  276. data/lib/CloudPDF/types/{shares_visitors_list200response_visitors_item_layer.rb → grants_visitors_list200response_visitors_item_layer.rb} +1 -1
  277. data/lib/CloudPDF/types/{shares_visitors_list400response.rb → grants_visitors_list400response.rb} +2 -2
  278. data/lib/CloudPDF/types/{shares_visitors_list404response.rb → grants_visitors_list404response.rb} +2 -2
  279. data/lib/CloudPDF/types/mutation_meta.rb +2 -0
  280. data/lib/CloudPDF/types/outline_mutation_meta.rb +2 -0
  281. data/lib/CloudPDF/types/resolved_font_run.rb +19 -0
  282. data/lib/CloudPDF/types/tokens_issue_request.rb +2 -0
  283. data/lib/CloudPDF/types/tokens_issue_request_upload.rb +21 -0
  284. data/lib/CloudPDF/types/widget_annotation.rb +2 -0
  285. data/lib/CloudPDF/types/widget_patch.rb +2 -0
  286. data/lib/CloudPDF/version.rb +1 -1
  287. data/lib/cloudpdf.rb +194 -120
  288. data/reference.md +416 -59
  289. metadata +196 -122
  290. data/lib/CloudPDF/shares/types/shares_exchange_request.rb +0 -19
  291. data/lib/CloudPDF/types/shares_archive200response.rb +0 -9
  292. data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity.rb +0 -15
  293. data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields.rb +0 -17
  294. data/lib/CloudPDF/types/shares_create200response.rb +0 -9
  295. data/lib/CloudPDF/types/shares_create200response_share_visitor_identity.rb +0 -15
  296. data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields.rb +0 -17
  297. data/lib/CloudPDF/types/shares_delete409response.rb +0 -23
  298. data/lib/CloudPDF/types/shares_exchange422response.rb +0 -23
  299. data/lib/CloudPDF/types/shares_get200response.rb +0 -9
  300. data/lib/CloudPDF/types/shares_get200response_share_visitor_identity.rb +0 -15
  301. data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields.rb +0 -17
  302. data/lib/CloudPDF/types/shares_list200response_shares_item_layer_mode.rb +0 -12
  303. data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity.rb +0 -15
  304. data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields.rb +0 -17
  305. data/lib/CloudPDF/types/shares_update200response.rb +0 -9
  306. data/lib/CloudPDF/types/shares_update200response_share_visitor_identity.rb +0 -15
  307. data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields.rb +0 -17
  308. data/lib/CloudPDF/types/shares_update400response.rb +0 -23
  309. data/lib/CloudPDF/types/shares_update404response.rb +0 -23
  310. data/lib/CloudPDF/types/shares_update409response.rb +0 -23
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  class Client
6
6
  # @param client [CloudPDF::Internal::Http::RawClient]
7
7
  #
@@ -10,17 +10,17 @@ module CloudPDF
10
10
  @client = client
11
11
  end
12
12
 
13
- # Unauthenticated, but requires a browser Origin header, checked against the grant allowlist. Unknown, revoked,
14
- # and disabled tokens are indistinguishable (404). Passphrase-protected grants return 422 SharePasswordRequired
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).
13
+ # Unauthenticated, but requires a browser Origin header, checked against the grant allowlist. Unknown, deleted,
14
+ # paused and archived grants are indistinguishable (404). Passphrase-protected grants return 422
15
+ # GrantPassphraseRequired until `passphrase` is supplied. A grant that asks its visitors who they are on open
16
+ # returns 422 VisitorIdentityRequired until the required answers are given; `error.details` carries `fields` (what
17
+ # the grant asks), `missing`, `invalid`, `purpose` and `privacyUrl`. A grant that asks before the first change
18
+ # issues the session at once with `visitor.identityRequest`, and writes answer 403 VisitorIdentityRequired with
19
+ # the same details until the visitor exchanges again with their answers. Answers that can not be taken answer 422
20
+ # on any grant. Mounted only when the deployment can sign (HS256 mode).
21
21
  #
22
22
  # @param request_options [Hash]
23
- # @param params [CloudPDF::Shares::Types::SharesExchangeRequest]
23
+ # @param params [CloudPDF::Grants::Types::GrantsExchangeRequest]
24
24
  # @option request_options [String] :base_url
25
25
  # @option request_options [Hash{String => Object}] :additional_headers
26
26
  # @option request_options [Hash{String => Object}] :additional_query_parameters
@@ -28,16 +28,16 @@ module CloudPDF
28
28
  # @option request_options [Integer] :timeout_in_seconds
29
29
  #
30
30
  # @example
31
- # client.shares.exchange(share_token: "shareToken")
31
+ # client.grants.exchange(grant: "grant")
32
32
  #
33
- # @return [CloudPDF::Types::SharesExchange200Response]
33
+ # @return [CloudPDF::Types::GrantsExchange200Response]
34
34
  def exchange(request_options: {}, **params)
35
35
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
36
36
  request = CloudPDF::Internal::JSON::Request.new(
37
37
  base_url: request_options[:base_url],
38
38
  method: "POST",
39
- path: "v1/share-sessions",
40
- body: CloudPDF::Shares::Types::SharesExchangeRequest.new(params).to_h,
39
+ path: "v1/grant-sessions",
40
+ body: CloudPDF::Grants::Types::GrantsExchangeRequest.new(params).to_h,
41
41
  request_options: request_options
42
42
  )
43
43
  begin
@@ -47,7 +47,7 @@ module CloudPDF
47
47
  end
48
48
  code = response.code.to_i
49
49
  if code.between?(200, 299)
50
- (response.body.to_s.empty? ? nil : CloudPDF::Types::SharesExchange200Response.load(response.body))
50
+ (response.body.to_s.empty? ? nil : CloudPDF::Types::GrantsExchange200Response.load(response.body))
51
51
  else
52
52
  error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
53
53
  raise error_class.new(response.body, code: code)
@@ -68,9 +68,9 @@ module CloudPDF
68
68
  # @option params [Boolean, nil] :archived
69
69
  #
70
70
  # @example
71
- # client.shares.list(tenant_id: "tenantId")
71
+ # client.grants.list(tenant_id: "tenantId")
72
72
  #
73
- # @return [CloudPDF::Types::SharesList200Response]
73
+ # @return [CloudPDF::Types::GrantsList200Response]
74
74
  def list(request_options: {}, **params)
75
75
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
76
76
  query_params = {}
@@ -82,7 +82,7 @@ module CloudPDF
82
82
  request = CloudPDF::Internal::JSON::Request.new(
83
83
  base_url: request_options[:base_url],
84
84
  method: "GET",
85
- path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/shares",
85
+ path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/grants",
86
86
  query: query_params,
87
87
  request_options: request_options
88
88
  )
@@ -93,18 +93,19 @@ module CloudPDF
93
93
  end
94
94
  code = response.code.to_i
95
95
  if code.between?(200, 299)
96
- (response.body.to_s.empty? ? nil : CloudPDF::Types::SharesList200Response.load(response.body))
96
+ (response.body.to_s.empty? ? nil : CloudPDF::Types::GrantsList200Response.load(response.body))
97
97
  else
98
98
  error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
99
99
  raise error_class.new(response.body, code: code)
100
100
  end
101
101
  end
102
102
 
103
- # The returned share id is the public share token. Mounted only when the deployment can sign (HS256 mode) —
104
- # exchange mints session JWTs, so grants exist only where minting does.
103
+ # The returned id is what a link page or an embed opens. Its scope gives only document permissions the caller
104
+ # holds itself, as tokens.issue does. Mounted only when the deployment can sign (HS256 mode) — exchange mints
105
+ # session JWTs, so grants exist only where minting does.
105
106
  #
106
107
  # @param request_options [Hash]
107
- # @param params [CloudPDF::Shares::Types::SharesCreateRequest]
108
+ # @param params [CloudPDF::Grants::Types::GrantsCreateRequest]
108
109
  # @option request_options [String] :base_url
109
110
  # @option request_options [Hash{String => Object}] :additional_headers
110
111
  # @option request_options [Hash{String => Object}] :additional_query_parameters
@@ -113,23 +114,23 @@ module CloudPDF
113
114
  # @option params [String] :tenant_id
114
115
  #
115
116
  # @example
116
- # client.shares.create(
117
+ # client.grants.create(
117
118
  # tenant_id: "tenantId",
118
119
  # doc_id: "docId",
119
120
  # scope: ["scope"]
120
121
  # )
121
122
  #
122
- # @return [CloudPDF::Types::SharesCreate200Response]
123
+ # @return [CloudPDF::Types::GrantsCreate200Response]
123
124
  def create(request_options: {}, **params)
124
125
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
125
- request_data = CloudPDF::Shares::Types::SharesCreateRequest.new(params).to_h
126
+ request_data = CloudPDF::Grants::Types::GrantsCreateRequest.new(params).to_h
126
127
  non_body_param_names = %w[tenantId]
127
128
  body = request_data.except(*non_body_param_names)
128
129
 
129
130
  request = CloudPDF::Internal::JSON::Request.new(
130
131
  base_url: request_options[:base_url],
131
132
  method: "POST",
132
- path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/shares",
133
+ path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/grants",
133
134
  body: body,
134
135
  request_options: request_options
135
136
  )
@@ -140,7 +141,7 @@ module CloudPDF
140
141
  end
141
142
  code = response.code.to_i
142
143
  if code.between?(200, 299)
143
- (response.body.to_s.empty? ? nil : CloudPDF::Types::SharesCreate200Response.load(response.body))
144
+ (response.body.to_s.empty? ? nil : CloudPDF::Types::GrantsCreate200Response.load(response.body))
144
145
  else
145
146
  error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
146
147
  raise error_class.new(response.body, code: code)
@@ -155,21 +156,21 @@ module CloudPDF
155
156
  # @option request_options [Hash{String => Object}] :additional_body_parameters
156
157
  # @option request_options [Integer] :timeout_in_seconds
157
158
  # @option params [String] :tenant_id
158
- # @option params [String] :share_id
159
+ # @option params [String] :grant_id
159
160
  #
160
161
  # @example
161
- # client.shares.get(
162
+ # client.grants.get(
162
163
  # tenant_id: "tenantId",
163
- # share_id: "shareId"
164
+ # grant_id: "grantId"
164
165
  # )
165
166
  #
166
- # @return [CloudPDF::Types::SharesGet200Response]
167
+ # @return [CloudPDF::Types::GrantsGet200Response]
167
168
  def get(request_options: {}, **params)
168
169
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
169
170
  request = CloudPDF::Internal::JSON::Request.new(
170
171
  base_url: request_options[:base_url],
171
172
  method: "GET",
172
- path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/shares/#{URI.encode_uri_component(params[:share_id].to_s)}",
173
+ path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/grants/#{URI.encode_uri_component(params[:grant_id].to_s)}",
173
174
  request_options: request_options
174
175
  )
175
176
  begin
@@ -179,7 +180,7 @@ module CloudPDF
179
180
  end
180
181
  code = response.code.to_i
181
182
  if code.between?(200, 299)
182
- (response.body.to_s.empty? ? nil : CloudPDF::Types::SharesGet200Response.load(response.body))
183
+ (response.body.to_s.empty? ? nil : CloudPDF::Types::GrantsGet200Response.load(response.body))
183
184
  else
184
185
  error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
185
186
  raise error_class.new(response.body, code: code)
@@ -194,12 +195,12 @@ module CloudPDF
194
195
  # @option request_options [Hash{String => Object}] :additional_body_parameters
195
196
  # @option request_options [Integer] :timeout_in_seconds
196
197
  # @option params [String] :tenant_id
197
- # @option params [String] :share_id
198
+ # @option params [String] :grant_id
198
199
  #
199
200
  # @example
200
- # client.shares.delete(
201
+ # client.grants.delete(
201
202
  # tenant_id: "tenantId",
202
- # share_id: "shareId"
203
+ # grant_id: "grantId"
203
204
  # )
204
205
  #
205
206
  # @return [untyped]
@@ -208,7 +209,7 @@ module CloudPDF
208
209
  request = CloudPDF::Internal::JSON::Request.new(
209
210
  base_url: request_options[:base_url],
210
211
  method: "DELETE",
211
- path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/shares/#{URI.encode_uri_component(params[:share_id].to_s)}",
212
+ path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/grants/#{URI.encode_uri_component(params[:grant_id].to_s)}",
212
213
  request_options: request_options
213
214
  )
214
215
  begin
@@ -224,32 +225,32 @@ module CloudPDF
224
225
  end
225
226
 
226
227
  # @param request_options [Hash]
227
- # @param params [CloudPDF::Shares::Types::SharesUpdateRequest]
228
+ # @param params [CloudPDF::Grants::Types::GrantsUpdateRequest]
228
229
  # @option request_options [String] :base_url
229
230
  # @option request_options [Hash{String => Object}] :additional_headers
230
231
  # @option request_options [Hash{String => Object}] :additional_query_parameters
231
232
  # @option request_options [Hash{String => Object}] :additional_body_parameters
232
233
  # @option request_options [Integer] :timeout_in_seconds
233
234
  # @option params [String] :tenant_id
234
- # @option params [String] :share_id
235
+ # @option params [String] :grant_id
235
236
  #
236
237
  # @example
237
- # client.shares.update(
238
+ # client.grants.update(
238
239
  # tenant_id: "tenantId",
239
- # share_id: "shareId"
240
+ # grant_id: "grantId"
240
241
  # )
241
242
  #
242
- # @return [CloudPDF::Types::SharesUpdate200Response]
243
+ # @return [CloudPDF::Types::GrantsUpdate200Response]
243
244
  def update(request_options: {}, **params)
244
245
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
245
- request_data = CloudPDF::Shares::Types::SharesUpdateRequest.new(params).to_h
246
- non_body_param_names = %w[tenantId shareId]
246
+ request_data = CloudPDF::Grants::Types::GrantsUpdateRequest.new(params).to_h
247
+ non_body_param_names = %w[tenantId grantId]
247
248
  body = request_data.except(*non_body_param_names)
248
249
 
249
250
  request = CloudPDF::Internal::JSON::Request.new(
250
251
  base_url: request_options[:base_url],
251
252
  method: "PATCH",
252
- path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/shares/#{URI.encode_uri_component(params[:share_id].to_s)}",
253
+ path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/grants/#{URI.encode_uri_component(params[:grant_id].to_s)}",
253
254
  body: body,
254
255
  request_options: request_options
255
256
  )
@@ -260,16 +261,16 @@ module CloudPDF
260
261
  end
261
262
  code = response.code.to_i
262
263
  if code.between?(200, 299)
263
- (response.body.to_s.empty? ? nil : CloudPDF::Types::SharesUpdate200Response.load(response.body))
264
+ (response.body.to_s.empty? ? nil : CloudPDF::Types::GrantsUpdate200Response.load(response.body))
264
265
  else
265
266
  error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
266
267
  raise error_class.new(response.body, code: code)
267
268
  end
268
269
  end
269
270
 
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.
271
+ # Archiving is final: an archived grant never exchanges again, and to give access again you create a new grant.
272
+ # Pausing (`disabled`) is the reversible stop. An archived grant no longer counts as using its shared layer, so
273
+ # that layer can be deleted.
273
274
  #
274
275
  # @param request_options [Hash]
275
276
  # @param params [Hash]
@@ -279,21 +280,21 @@ module CloudPDF
279
280
  # @option request_options [Hash{String => Object}] :additional_body_parameters
280
281
  # @option request_options [Integer] :timeout_in_seconds
281
282
  # @option params [String] :tenant_id
282
- # @option params [String] :share_id
283
+ # @option params [String] :grant_id
283
284
  #
284
285
  # @example
285
- # client.shares.archive(
286
+ # client.grants.archive(
286
287
  # tenant_id: "tenantId",
287
- # share_id: "shareId"
288
+ # grant_id: "grantId"
288
289
  # )
289
290
  #
290
- # @return [CloudPDF::Types::SharesArchive200Response]
291
+ # @return [CloudPDF::Types::GrantsArchive200Response]
291
292
  def archive(request_options: {}, **params)
292
293
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
293
294
  request = CloudPDF::Internal::JSON::Request.new(
294
295
  base_url: request_options[:base_url],
295
296
  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
+ path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/grants/#{URI.encode_uri_component(params[:grant_id].to_s)}/archive",
297
298
  request_options: request_options
298
299
  )
299
300
  begin
@@ -303,7 +304,7 @@ module CloudPDF
303
304
  end
304
305
  code = response.code.to_i
305
306
  if code.between?(200, 299)
306
- (response.body.to_s.empty? ? nil : CloudPDF::Types::SharesArchive200Response.load(response.body))
307
+ (response.body.to_s.empty? ? nil : CloudPDF::Types::GrantsArchive200Response.load(response.body))
307
308
  else
308
309
  error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
309
310
  raise error_class.new(response.body, code: code)
@@ -312,7 +313,7 @@ module CloudPDF
312
313
 
313
314
  # @return [CloudPDF::Visitors::Client]
314
315
  def visitors
315
- @visitors ||= CloudPDF::Shares::Visitors::Client.new(client: @client)
316
+ @visitors ||= CloudPDF::Grants::Visitors::Client.new(client: @client)
316
317
  end
317
318
  end
318
319
  end
@@ -1,12 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- class ArchiveSharesRequest < Internal::Types::Model
6
+ class ArchiveGrantsRequest < Internal::Types::Model
7
7
  field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
8
8
 
9
- field :share_id, -> { String }, optional: false, nullable: false, api_name: "shareId"
9
+ field :grant_id, -> { String }, optional: false, nullable: false, api_name: "grantId"
10
10
  end
11
11
  end
12
12
  end
@@ -1,12 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- class DeleteSharesRequest < Internal::Types::Model
6
+ class DeleteGrantsRequest < Internal::Types::Model
7
7
  field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
8
8
 
9
- field :share_id, -> { String }, optional: false, nullable: false, api_name: "shareId"
9
+ field :grant_id, -> { String }, optional: false, nullable: false, api_name: "grantId"
10
10
  end
11
11
  end
12
12
  end
@@ -1,12 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- class GetSharesRequest < Internal::Types::Model
6
+ class GetGrantsRequest < Internal::Types::Model
7
7
  field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
8
8
 
9
- field :share_id, -> { String }, optional: false, nullable: false, api_name: "shareId"
9
+ field :grant_id, -> { String }, optional: false, nullable: false, api_name: "grantId"
10
10
  end
11
11
  end
12
12
  end
@@ -1,14 +1,16 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- class SharesCreateRequest < Internal::Types::Model
6
+ class GrantsCreateRequest < Internal::Types::Model
7
7
  field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
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"
11
+ field :name, -> { String }, optional: true, nullable: false
12
+
13
+ field :layer_mode, -> { CloudPDF::Grants::Types::GrantsCreateRequestLayerMode }, optional: true, nullable: false, api_name: "layerMode"
12
14
 
13
15
  field :layer_name, -> { String }, optional: true, nullable: false, api_name: "layerName"
14
16
 
@@ -16,7 +18,7 @@ module CloudPDF
16
18
 
17
19
  field :visitor_idle_seconds, -> { Integer }, optional: true, nullable: false, api_name: "visitorIdleSeconds"
18
20
 
19
- field :visitor_identity, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentity }, optional: true, nullable: false, api_name: "visitorIdentity"
21
+ field :visitor_identity, -> { CloudPDF::Grants::Types::GrantsCreateRequestVisitorIdentity }, optional: true, nullable: false, api_name: "visitorIdentity"
20
22
 
21
23
  field :identity, -> { CloudPDF::Types::Identity }, optional: true, nullable: false
22
24
 
@@ -24,7 +26,7 @@ module CloudPDF
24
26
 
25
27
  field :origins, -> { Internal::Types::Array[String] }, optional: true, nullable: false
26
28
 
27
- field :password, -> { String }, optional: true, nullable: false
29
+ field :passphrase, -> { String }, optional: true, nullable: false
28
30
 
29
31
  field :session_ttl_seconds, -> { Integer }, optional: true, nullable: false, api_name: "sessionTtlSeconds"
30
32
 
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- module SharesCreateRequestLayerMode
6
+ module GrantsCreateRequestLayerMode
7
7
  extend CloudPDF::Internal::Types::Enum
8
8
 
9
9
  SHARED = "shared"
@@ -1,12 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- class SharesCreateRequestVisitorIdentity < Internal::Types::Model
7
- field :fields, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityFields }, optional: false, nullable: false
6
+ class GrantsCreateRequestVisitorIdentity < Internal::Types::Model
7
+ field :fields, -> { CloudPDF::Grants::Types::GrantsCreateRequestVisitorIdentityFields }, optional: false, nullable: false
8
8
 
9
- field :ask, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityAsk }, optional: false, nullable: false
9
+ field :ask, -> { CloudPDF::Grants::Types::GrantsCreateRequestVisitorIdentityAsk }, optional: false, nullable: false
10
10
 
11
11
  field :purpose, -> { String }, optional: true, nullable: false
12
12
 
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- module SharesUpdateRequestVisitorIdentityAsk
6
+ module GrantsCreateRequestVisitorIdentityAsk
7
7
  extend CloudPDF::Internal::Types::Enum
8
8
 
9
9
  ON_OPEN = "on-open"
@@ -1,18 +1,18 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- class SharesCreateRequestVisitorIdentityFields < Internal::Types::Model
7
- field :display_name, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityFieldsDisplayName }, optional: true, nullable: false, api_name: "displayName"
6
+ class GrantsCreateRequestVisitorIdentityFields < Internal::Types::Model
7
+ field :display_name, -> { CloudPDF::Grants::Types::GrantsCreateRequestVisitorIdentityFieldsDisplayName }, optional: true, nullable: false, api_name: "displayName"
8
8
 
9
- field :email, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityFieldsEmail }, optional: true, nullable: false
9
+ field :email, -> { CloudPDF::Grants::Types::GrantsCreateRequestVisitorIdentityFieldsEmail }, optional: true, nullable: false
10
10
 
11
- field :title, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityFieldsTitle }, optional: true, nullable: false
11
+ field :title, -> { CloudPDF::Grants::Types::GrantsCreateRequestVisitorIdentityFieldsTitle }, optional: true, nullable: false
12
12
 
13
- field :organization, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityFieldsOrganization }, optional: true, nullable: false
13
+ field :organization, -> { CloudPDF::Grants::Types::GrantsCreateRequestVisitorIdentityFieldsOrganization }, optional: true, nullable: false
14
14
 
15
- field :organizational_unit, -> { CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentityFieldsOrganizationalUnit }, optional: true, nullable: false, api_name: "organizationalUnit"
15
+ field :organizational_unit, -> { CloudPDF::Grants::Types::GrantsCreateRequestVisitorIdentityFieldsOrganizationalUnit }, optional: true, nullable: false, api_name: "organizationalUnit"
16
16
  end
17
17
  end
18
18
  end
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- module SharesUpdateRequestVisitorIdentityFieldsDisplayName
6
+ module GrantsCreateRequestVisitorIdentityFieldsDisplayName
7
7
  extend CloudPDF::Internal::Types::Enum
8
8
 
9
9
  REQUIRED = "required"
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- module SharesCreateRequestVisitorIdentityFieldsTitle
6
+ module GrantsCreateRequestVisitorIdentityFieldsEmail
7
7
  extend CloudPDF::Internal::Types::Enum
8
8
 
9
9
  REQUIRED = "required"
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- module SharesUpdateRequestVisitorIdentityFieldsOrganization
6
+ module GrantsCreateRequestVisitorIdentityFieldsOrganization
7
7
  extend CloudPDF::Internal::Types::Enum
8
8
 
9
9
  REQUIRED = "required"
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- module SharesUpdateRequestVisitorIdentityFieldsOrganizationalUnit
6
+ module GrantsCreateRequestVisitorIdentityFieldsOrganizationalUnit
7
7
  extend CloudPDF::Internal::Types::Enum
8
8
 
9
9
  REQUIRED = "required"
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- module SharesUpdateRequestVisitorIdentityFieldsEmail
6
+ module GrantsCreateRequestVisitorIdentityFieldsTitle
7
7
  extend CloudPDF::Internal::Types::Enum
8
8
 
9
9
  REQUIRED = "required"
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CloudPDF
4
+ module Grants
5
+ module Types
6
+ class GrantsExchangeRequest < Internal::Types::Model
7
+ field :grant, -> { String }, optional: false, nullable: false
8
+
9
+ field :passphrase, -> { String }, optional: true, nullable: false
10
+
11
+ field :visitor_handle, -> { String }, optional: true, nullable: false, api_name: "visitorHandle"
12
+
13
+ field :restart, -> { Internal::Types::Boolean }, optional: true, nullable: false
14
+
15
+ field :visitor_identity, -> { CloudPDF::Grants::Types::GrantsExchangeRequestVisitorIdentity }, optional: true, nullable: false, api_name: "visitorIdentity"
16
+ end
17
+ end
18
+ end
19
+ end
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- class SharesExchangeRequestVisitorIdentity < Internal::Types::Model
6
+ class GrantsExchangeRequestVisitorIdentity < Internal::Types::Model
7
7
  field :display_name, -> { String }, optional: true, nullable: false, api_name: "displayName"
8
8
 
9
9
  field :email, -> { String }, optional: true, nullable: false
@@ -1,14 +1,16 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- class SharesUpdateRequest < Internal::Types::Model
6
+ class GrantsUpdateRequest < Internal::Types::Model
7
7
  field :tenant_id, -> { String }, optional: false, nullable: false, api_name: "tenantId"
8
8
 
9
- field :share_id, -> { String }, optional: false, nullable: false, api_name: "shareId"
9
+ field :grant_id, -> { String }, optional: false, nullable: false, api_name: "grantId"
10
10
 
11
- field :layer_mode, -> { CloudPDF::Shares::Types::SharesUpdateRequestLayerMode }, optional: true, nullable: false, api_name: "layerMode"
11
+ field :name, -> { String }, optional: true, nullable: false
12
+
13
+ field :layer_mode, -> { CloudPDF::Grants::Types::GrantsUpdateRequestLayerMode }, optional: true, nullable: false, api_name: "layerMode"
12
14
 
13
15
  field :layer_name, -> { String }, optional: true, nullable: false, api_name: "layerName"
14
16
 
@@ -16,7 +18,7 @@ module CloudPDF
16
18
 
17
19
  field :visitor_idle_seconds, -> { Integer }, optional: true, nullable: false, api_name: "visitorIdleSeconds"
18
20
 
19
- field :visitor_identity, -> { CloudPDF::Shares::Types::SharesUpdateRequestVisitorIdentity }, optional: true, nullable: false, api_name: "visitorIdentity"
21
+ field :visitor_identity, -> { CloudPDF::Grants::Types::GrantsUpdateRequestVisitorIdentity }, optional: true, nullable: false, api_name: "visitorIdentity"
20
22
 
21
23
  field :identity, -> { CloudPDF::Types::Identity }, optional: true, nullable: false
22
24
 
@@ -24,7 +26,7 @@ module CloudPDF
24
26
 
25
27
  field :origins, -> { Internal::Types::Array[String] }, optional: true, nullable: false
26
28
 
27
- field :password, -> { String }, optional: true, nullable: false
29
+ field :passphrase, -> { String }, optional: true, nullable: false
28
30
 
29
31
  field :session_ttl_seconds, -> { Integer }, optional: true, nullable: false, api_name: "sessionTtlSeconds"
30
32
 
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- module SharesUpdateRequestLayerMode
6
+ module GrantsUpdateRequestLayerMode
7
7
  extend CloudPDF::Internal::Types::Enum
8
8
 
9
9
  SHARED = "shared"
@@ -1,12 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CloudPDF
4
- module Shares
4
+ module Grants
5
5
  module Types
6
- class SharesUpdateRequestVisitorIdentity < Internal::Types::Model
7
- field :fields, -> { CloudPDF::Shares::Types::SharesUpdateRequestVisitorIdentityFields }, optional: false, nullable: false
6
+ class GrantsUpdateRequestVisitorIdentity < Internal::Types::Model
7
+ field :fields, -> { CloudPDF::Grants::Types::GrantsUpdateRequestVisitorIdentityFields }, optional: false, nullable: false
8
8
 
9
- field :ask, -> { CloudPDF::Shares::Types::SharesUpdateRequestVisitorIdentityAsk }, optional: false, nullable: false
9
+ field :ask, -> { CloudPDF::Grants::Types::GrantsUpdateRequestVisitorIdentityAsk }, optional: false, nullable: false
10
10
 
11
11
  field :purpose, -> { String }, optional: true, nullable: false
12
12