cloudpdf 3.0.0.alpha.18 → 3.0.0.alpha.19

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 (154) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +2 -2
  3. data/lib/CloudPDF/client.rb +3 -3
  4. data/lib/CloudPDF/documents/layers/client.rb +2 -2
  5. data/lib/CloudPDF/documents/layers/types/list_layers_request.rb +1 -1
  6. data/lib/CloudPDF/folders/client.rb +1 -1
  7. data/lib/CloudPDF/{shares → grants}/client.rb +55 -55
  8. data/lib/CloudPDF/{shares/types/archive_shares_request.rb → grants/types/archive_grants_request.rb} +3 -3
  9. data/lib/CloudPDF/{shares/types/delete_shares_request.rb → grants/types/delete_grants_request.rb} +3 -3
  10. data/lib/CloudPDF/{shares/types/get_shares_request.rb → grants/types/get_grants_request.rb} +3 -3
  11. data/lib/CloudPDF/{shares/types/shares_create_request.rb → grants/types/grants_create_request.rb} +7 -5
  12. data/lib/CloudPDF/{shares/types/shares_create_request_layer_mode.rb → grants/types/grants_create_request_layer_mode.rb} +2 -2
  13. data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity.rb → grants/types/grants_create_request_visitor_identity.rb} +4 -4
  14. data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_ask.rb → grants/types/grants_create_request_visitor_identity_ask.rb} +2 -2
  15. data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_fields.rb → grants/types/grants_create_request_visitor_identity_fields.rb} +7 -7
  16. 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
  17. 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
  18. 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
  19. 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
  20. 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
  21. data/lib/CloudPDF/grants/types/grants_exchange_request.rb +19 -0
  22. data/lib/CloudPDF/{shares/types/shares_exchange_request_visitor_identity.rb → grants/types/grants_exchange_request_visitor_identity.rb} +2 -2
  23. data/lib/CloudPDF/{shares/types/shares_update_request.rb → grants/types/grants_update_request.rb} +8 -6
  24. data/lib/CloudPDF/{shares/types/shares_update_request_layer_mode.rb → grants/types/grants_update_request_layer_mode.rb} +2 -2
  25. data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity.rb → grants/types/grants_update_request_visitor_identity.rb} +4 -4
  26. data/lib/CloudPDF/{shares/types/shares_create_request_visitor_identity_ask.rb → grants/types/grants_update_request_visitor_identity_ask.rb} +2 -2
  27. data/lib/CloudPDF/{shares/types/shares_update_request_visitor_identity_fields.rb → grants/types/grants_update_request_visitor_identity_fields.rb} +7 -7
  28. 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
  29. 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
  30. 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
  31. 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
  32. 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
  33. data/lib/CloudPDF/{shares/types/list_shares_request.rb → grants/types/list_grants_request.rb} +2 -2
  34. data/lib/CloudPDF/{shares → grants}/visitors/client.rb +12 -12
  35. data/lib/CloudPDF/{shares → grants}/visitors/types/delete_visitors_request.rb +2 -2
  36. data/lib/CloudPDF/{shares → grants}/visitors/types/list_visitors_request.rb +2 -2
  37. data/lib/CloudPDF/tenants/client.rb +1 -1
  38. data/lib/CloudPDF/types/documents_layers_list200response_layers_item.rb +1 -1
  39. data/lib/CloudPDF/types/engine_error_payload_code.rb +1 -1
  40. data/lib/CloudPDF/types/grants_archive200response.rb +9 -0
  41. data/lib/CloudPDF/types/{shares_archive200response_share.rb → grants_archive200response_grant.rb} +6 -4
  42. data/lib/CloudPDF/types/{shares_archive200response_share_layer_mode.rb → grants_archive200response_grant_layer_mode.rb} +1 -1
  43. data/lib/CloudPDF/types/grants_archive200response_grant_visitor_identity.rb +15 -0
  44. data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_ask.rb → grants_archive200response_grant_visitor_identity_ask.rb} +1 -1
  45. data/lib/CloudPDF/types/grants_archive200response_grant_visitor_identity_fields.rb +17 -0
  46. data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_display_name.rb → grants_archive200response_grant_visitor_identity_fields_display_name.rb} +1 -1
  47. data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_email.rb → grants_archive200response_grant_visitor_identity_fields_email.rb} +1 -1
  48. data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_organization.rb → grants_archive200response_grant_visitor_identity_fields_organization.rb} +1 -1
  49. data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_organizational_unit.rb → grants_archive200response_grant_visitor_identity_fields_organizational_unit.rb} +1 -1
  50. data/lib/CloudPDF/types/{shares_archive200response_share_visitor_identity_fields_title.rb → grants_archive200response_grant_visitor_identity_fields_title.rb} +1 -1
  51. data/lib/CloudPDF/types/{shares_archive404response.rb → grants_archive404response.rb} +2 -2
  52. data/lib/CloudPDF/types/grants_create200response.rb +9 -0
  53. data/lib/CloudPDF/types/{shares_update200response_share.rb → grants_create200response_grant.rb} +6 -4
  54. data/lib/CloudPDF/types/{shares_create200response_share_layer_mode.rb → grants_create200response_grant_layer_mode.rb} +1 -1
  55. data/lib/CloudPDF/types/grants_create200response_grant_visitor_identity.rb +15 -0
  56. data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_ask.rb → grants_create200response_grant_visitor_identity_ask.rb} +1 -1
  57. data/lib/CloudPDF/types/grants_create200response_grant_visitor_identity_fields.rb +17 -0
  58. data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_display_name.rb → grants_create200response_grant_visitor_identity_fields_display_name.rb} +1 -1
  59. data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_email.rb → grants_create200response_grant_visitor_identity_fields_email.rb} +1 -1
  60. data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_organization.rb → grants_create200response_grant_visitor_identity_fields_organization.rb} +1 -1
  61. data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_organizational_unit.rb → grants_create200response_grant_visitor_identity_fields_organizational_unit.rb} +1 -1
  62. data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_title.rb → grants_create200response_grant_visitor_identity_fields_title.rb} +1 -1
  63. data/lib/CloudPDF/types/{shares_delete404response.rb → grants_create400response.rb} +2 -2
  64. data/lib/CloudPDF/types/{shares_create400response.rb → grants_create403response.rb} +2 -2
  65. data/lib/CloudPDF/types/{shares_create403response.rb → grants_create404response.rb} +2 -2
  66. data/lib/CloudPDF/types/{shares_create404response.rb → grants_delete404response.rb} +2 -2
  67. data/lib/CloudPDF/types/grants_delete409response.rb +23 -0
  68. data/lib/CloudPDF/types/{shares_exchange200response.rb → grants_exchange200response.rb} +3 -3
  69. data/lib/CloudPDF/types/{shares_exchange200response_layer_mode.rb → grants_exchange200response_layer_mode.rb} +1 -1
  70. data/lib/CloudPDF/types/{shares_exchange200response_visitor.rb → grants_exchange200response_visitor.rb} +2 -2
  71. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request.rb → grants_exchange200response_visitor_identity_request.rb} +4 -4
  72. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields.rb → grants_exchange200response_visitor_identity_request_fields.rb} +6 -6
  73. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_display_name.rb → grants_exchange200response_visitor_identity_request_fields_display_name.rb} +1 -1
  74. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_email.rb → grants_exchange200response_visitor_identity_request_fields_email.rb} +1 -1
  75. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_organization.rb → grants_exchange200response_visitor_identity_request_fields_organization.rb} +1 -1
  76. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_organizational_unit.rb → grants_exchange200response_visitor_identity_request_fields_organizational_unit.rb} +1 -1
  77. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_fields_title.rb → grants_exchange200response_visitor_identity_request_fields_title.rb} +1 -1
  78. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_invalid_item.rb → grants_exchange200response_visitor_identity_request_invalid_item.rb} +1 -1
  79. data/lib/CloudPDF/types/{shares_exchange200response_visitor_identity_request_missing_item.rb → grants_exchange200response_visitor_identity_request_missing_item.rb} +1 -1
  80. data/lib/CloudPDF/types/{shares_exchange400response.rb → grants_exchange400response.rb} +2 -2
  81. data/lib/CloudPDF/types/{shares_exchange403response.rb → grants_exchange403response.rb} +2 -2
  82. data/lib/CloudPDF/types/{shares_exchange404response.rb → grants_exchange404response.rb} +2 -2
  83. data/lib/CloudPDF/types/{shares_exchange410response.rb → grants_exchange410response.rb} +2 -2
  84. data/lib/CloudPDF/types/grants_exchange422response.rb +23 -0
  85. data/lib/CloudPDF/types/grants_get200response.rb +9 -0
  86. data/lib/CloudPDF/types/{shares_get200response_share.rb → grants_get200response_grant.rb} +6 -4
  87. data/lib/CloudPDF/types/{shares_get200response_share_layer_mode.rb → grants_get200response_grant_layer_mode.rb} +1 -1
  88. data/lib/CloudPDF/types/grants_get200response_grant_visitor_identity.rb +15 -0
  89. data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_ask.rb → grants_get200response_grant_visitor_identity_ask.rb} +1 -1
  90. data/lib/CloudPDF/types/grants_get200response_grant_visitor_identity_fields.rb +17 -0
  91. data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_display_name.rb → grants_get200response_grant_visitor_identity_fields_display_name.rb} +1 -1
  92. data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_email.rb → grants_get200response_grant_visitor_identity_fields_email.rb} +1 -1
  93. data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_organization.rb → grants_get200response_grant_visitor_identity_fields_organization.rb} +1 -1
  94. data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_organizational_unit.rb → grants_get200response_grant_visitor_identity_fields_organizational_unit.rb} +1 -1
  95. data/lib/CloudPDF/types/{shares_get200response_share_visitor_identity_fields_title.rb → grants_get200response_grant_visitor_identity_fields_title.rb} +1 -1
  96. data/lib/CloudPDF/types/{shares_get404response.rb → grants_get404response.rb} +2 -2
  97. data/lib/CloudPDF/types/{shares_list200response.rb → grants_list200response.rb} +2 -2
  98. data/lib/CloudPDF/types/{shares_list200response_shares_item.rb → grants_list200response_grants_item.rb} +6 -4
  99. data/lib/CloudPDF/types/grants_list200response_grants_item_layer_mode.rb +12 -0
  100. data/lib/CloudPDF/types/grants_list200response_grants_item_visitor_identity.rb +15 -0
  101. data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_ask.rb → grants_list200response_grants_item_visitor_identity_ask.rb} +1 -1
  102. data/lib/CloudPDF/types/grants_list200response_grants_item_visitor_identity_fields.rb +17 -0
  103. 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
  104. data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_email.rb → grants_list200response_grants_item_visitor_identity_fields_email.rb} +1 -1
  105. data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_organization.rb → grants_list200response_grants_item_visitor_identity_fields_organization.rb} +1 -1
  106. 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
  107. data/lib/CloudPDF/types/{shares_list200response_shares_item_visitor_identity_fields_title.rb → grants_list200response_grants_item_visitor_identity_fields_title.rb} +1 -1
  108. data/lib/CloudPDF/types/{shares_list400response.rb → grants_list400response.rb} +2 -2
  109. data/lib/CloudPDF/types/grants_update200response.rb +9 -0
  110. data/lib/CloudPDF/types/{shares_create200response_share.rb → grants_update200response_grant.rb} +6 -4
  111. data/lib/CloudPDF/types/{shares_update200response_share_layer_mode.rb → grants_update200response_grant_layer_mode.rb} +1 -1
  112. data/lib/CloudPDF/types/grants_update200response_grant_visitor_identity.rb +15 -0
  113. data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_ask.rb → grants_update200response_grant_visitor_identity_ask.rb} +1 -1
  114. data/lib/CloudPDF/types/grants_update200response_grant_visitor_identity_fields.rb +17 -0
  115. data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_display_name.rb → grants_update200response_grant_visitor_identity_fields_display_name.rb} +1 -1
  116. data/lib/CloudPDF/types/{shares_create200response_share_visitor_identity_fields_email.rb → grants_update200response_grant_visitor_identity_fields_email.rb} +1 -1
  117. data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_organization.rb → grants_update200response_grant_visitor_identity_fields_organization.rb} +1 -1
  118. data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_organizational_unit.rb → grants_update200response_grant_visitor_identity_fields_organizational_unit.rb} +1 -1
  119. data/lib/CloudPDF/types/{shares_update200response_share_visitor_identity_fields_title.rb → grants_update200response_grant_visitor_identity_fields_title.rb} +1 -1
  120. data/lib/CloudPDF/types/grants_update400response.rb +23 -0
  121. data/lib/CloudPDF/types/grants_update404response.rb +23 -0
  122. data/lib/CloudPDF/types/grants_update409response.rb +23 -0
  123. data/lib/CloudPDF/types/{shares_visitors_delete_response.rb → grants_visitors_delete_response.rb} +2 -2
  124. data/lib/CloudPDF/types/{shares_visitors_list200response.rb → grants_visitors_list200response.rb} +2 -2
  125. data/lib/CloudPDF/types/{shares_visitors_list200response_visitors_item.rb → grants_visitors_list200response_visitors_item.rb} +3 -3
  126. data/lib/CloudPDF/types/{shares_visitors_list200response_visitors_item_answers.rb → grants_visitors_list200response_visitors_item_answers.rb} +1 -1
  127. data/lib/CloudPDF/types/{shares_visitors_list200response_visitors_item_layer.rb → grants_visitors_list200response_visitors_item_layer.rb} +1 -1
  128. data/lib/CloudPDF/types/{shares_visitors_list400response.rb → grants_visitors_list400response.rb} +2 -2
  129. data/lib/CloudPDF/types/{shares_visitors_list404response.rb → grants_visitors_list404response.rb} +2 -2
  130. data/lib/CloudPDF/version.rb +1 -1
  131. data/lib/cloudpdf.rb +120 -120
  132. data/reference.md +73 -57
  133. metadata +122 -122
  134. data/lib/CloudPDF/shares/types/shares_exchange_request.rb +0 -19
  135. data/lib/CloudPDF/types/shares_archive200response.rb +0 -9
  136. data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity.rb +0 -15
  137. data/lib/CloudPDF/types/shares_archive200response_share_visitor_identity_fields.rb +0 -17
  138. data/lib/CloudPDF/types/shares_create200response.rb +0 -9
  139. data/lib/CloudPDF/types/shares_create200response_share_visitor_identity.rb +0 -15
  140. data/lib/CloudPDF/types/shares_create200response_share_visitor_identity_fields.rb +0 -17
  141. data/lib/CloudPDF/types/shares_delete409response.rb +0 -23
  142. data/lib/CloudPDF/types/shares_exchange422response.rb +0 -23
  143. data/lib/CloudPDF/types/shares_get200response.rb +0 -9
  144. data/lib/CloudPDF/types/shares_get200response_share_visitor_identity.rb +0 -15
  145. data/lib/CloudPDF/types/shares_get200response_share_visitor_identity_fields.rb +0 -17
  146. data/lib/CloudPDF/types/shares_list200response_shares_item_layer_mode.rb +0 -12
  147. data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity.rb +0 -15
  148. data/lib/CloudPDF/types/shares_list200response_shares_item_visitor_identity_fields.rb +0 -17
  149. data/lib/CloudPDF/types/shares_update200response.rb +0 -9
  150. data/lib/CloudPDF/types/shares_update200response_share_visitor_identity.rb +0 -15
  151. data/lib/CloudPDF/types/shares_update200response_share_visitor_identity_fields.rb +0 -17
  152. data/lib/CloudPDF/types/shares_update400response.rb +0 -23
  153. data/lib/CloudPDF/types/shares_update404response.rb +0 -23
  154. data/lib/CloudPDF/types/shares_update409response.rb +0 -23
data/reference.md CHANGED
@@ -578,8 +578,8 @@ client.doc.text(
578
578
  </dl>
579
579
  </details>
580
580
 
581
- ## Shares
582
- <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">exchange</a>(request) -> CloudPDF::Types::SharesExchange200Response</code></summary>
581
+ ## Grants
582
+ <details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">exchange</a>(request) -> CloudPDF::Types::GrantsExchange200Response</code></summary>
583
583
  <dl>
584
584
  <dd>
585
585
 
@@ -591,7 +591,7 @@ client.doc.text(
591
591
  <dl>
592
592
  <dd>
593
593
 
594
- Unauthenticated, but requires a browser Origin header, checked against the grant allowlist. Unknown, revoked, and disabled tokens are indistinguishable (404). Passphrase-protected grants return 422 SharePasswordRequired until `password` is supplied. A link that asks its visitors who they are on open returns 422 VisitorIdentityRequired until the required answers are given; `error.details` carries `fields` (what the link asks), `missing`, `invalid`, `purpose` and `privacyUrl`. A link that asks before the first change issues the session at once with `visitor.identityRequest`, and writes answer 403 VisitorIdentityRequired with the same details until the visitor exchanges again with their answers. Answers that can not be taken answer 422 on any link. Mounted only when the deployment can sign (HS256 mode).
594
+ Unauthenticated, but requires a browser Origin header, checked against the grant allowlist. Unknown, deleted, paused and archived grants are indistinguishable (404). Passphrase-protected grants return 422 GrantPassphraseRequired until `passphrase` is supplied. A grant that asks its visitors who they are on open returns 422 VisitorIdentityRequired until the required answers are given; `error.details` carries `fields` (what the grant asks), `missing`, `invalid`, `purpose` and `privacyUrl`. A grant that asks before the first change issues the session at once with `visitor.identityRequest`, and writes answer 403 VisitorIdentityRequired with the same details until the visitor exchanges again with their answers. Answers that can not be taken answer 422 on any grant. Mounted only when the deployment can sign (HS256 mode).
595
595
  </dd>
596
596
  </dl>
597
597
  </dd>
@@ -606,7 +606,7 @@ Unauthenticated, but requires a browser Origin header, checked against the grant
606
606
  <dd>
607
607
 
608
608
  ```ruby
609
- client.shares.exchange(share_token: "shareToken")
609
+ client.grants.exchange(grant: "grant")
610
610
  ```
611
611
  </dd>
612
612
  </dl>
@@ -621,7 +621,7 @@ client.shares.exchange(share_token: "shareToken")
621
621
  <dl>
622
622
  <dd>
623
623
 
624
- **share_token:** `String`
624
+ **grant:** `String`
625
625
 
626
626
  </dd>
627
627
  </dl>
@@ -629,7 +629,7 @@ client.shares.exchange(share_token: "shareToken")
629
629
  <dl>
630
630
  <dd>
631
631
 
632
- **password:** `String`
632
+ **passphrase:** `String`
633
633
 
634
634
  </dd>
635
635
  </dl>
@@ -653,7 +653,7 @@ client.shares.exchange(share_token: "shareToken")
653
653
  <dl>
654
654
  <dd>
655
655
 
656
- **visitor_identity:** `CloudPDF::Shares::Types::SharesExchangeRequestVisitorIdentity`
656
+ **visitor_identity:** `CloudPDF::Grants::Types::GrantsExchangeRequestVisitorIdentity`
657
657
 
658
658
  </dd>
659
659
  </dl>
@@ -661,7 +661,7 @@ client.shares.exchange(share_token: "shareToken")
661
661
  <dl>
662
662
  <dd>
663
663
 
664
- **request_options:** `CloudPDF::Shares::RequestOptions`
664
+ **request_options:** `CloudPDF::Grants::RequestOptions`
665
665
 
666
666
  </dd>
667
667
  </dl>
@@ -673,7 +673,7 @@ client.shares.exchange(share_token: "shareToken")
673
673
  </dl>
674
674
  </details>
675
675
 
676
- <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">list</a>(tenant_id:) -> CloudPDF::Types::SharesList200Response</code></summary>
676
+ <details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">list</a>(tenant_id:) -> CloudPDF::Types::GrantsList200Response</code></summary>
677
677
  <dl>
678
678
  <dd>
679
679
 
@@ -686,7 +686,7 @@ client.shares.exchange(share_token: "shareToken")
686
686
  <dd>
687
687
 
688
688
  ```ruby
689
- client.shares.list(tenant_id: "tenantId")
689
+ client.grants.list(tenant_id: "tenantId")
690
690
  ```
691
691
  </dd>
692
692
  </dl>
@@ -741,7 +741,7 @@ client.shares.list(tenant_id: "tenantId")
741
741
  <dl>
742
742
  <dd>
743
743
 
744
- **request_options:** `CloudPDF::Shares::RequestOptions`
744
+ **request_options:** `CloudPDF::Grants::RequestOptions`
745
745
 
746
746
  </dd>
747
747
  </dl>
@@ -753,7 +753,7 @@ client.shares.list(tenant_id: "tenantId")
753
753
  </dl>
754
754
  </details>
755
755
 
756
- <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">create</a>(tenant_id:, request) -> CloudPDF::Types::SharesCreate200Response</code></summary>
756
+ <details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">create</a>(tenant_id:, request) -> CloudPDF::Types::GrantsCreate200Response</code></summary>
757
757
  <dl>
758
758
  <dd>
759
759
 
@@ -765,7 +765,7 @@ client.shares.list(tenant_id: "tenantId")
765
765
  <dl>
766
766
  <dd>
767
767
 
768
- The returned share id is the public share token. Mounted only when the deployment can sign (HS256 mode) — exchange mints session JWTs, so grants exist only where minting does.
768
+ The returned id is what a link page or an embed opens. Mounted only when the deployment can sign (HS256 mode) — exchange mints session JWTs, so grants exist only where minting does.
769
769
  </dd>
770
770
  </dl>
771
771
  </dd>
@@ -780,7 +780,7 @@ The returned share id is the public share token. Mounted only when the deploymen
780
780
  <dd>
781
781
 
782
782
  ```ruby
783
- client.shares.create(
783
+ client.grants.create(
784
784
  tenant_id: "tenantId",
785
785
  doc_id: "docId",
786
786
  scope: ["scope"]
@@ -815,7 +815,15 @@ client.shares.create(
815
815
  <dl>
816
816
  <dd>
817
817
 
818
- **layer_mode:** `CloudPDF::Shares::Types::SharesCreateRequestLayerMode`
818
+ **name:** `String`
819
+
820
+ </dd>
821
+ </dl>
822
+
823
+ <dl>
824
+ <dd>
825
+
826
+ **layer_mode:** `CloudPDF::Grants::Types::GrantsCreateRequestLayerMode`
819
827
 
820
828
  </dd>
821
829
  </dl>
@@ -847,7 +855,7 @@ client.shares.create(
847
855
  <dl>
848
856
  <dd>
849
857
 
850
- **visitor_identity:** `CloudPDF::Shares::Types::SharesCreateRequestVisitorIdentity`
858
+ **visitor_identity:** `CloudPDF::Grants::Types::GrantsCreateRequestVisitorIdentity`
851
859
 
852
860
  </dd>
853
861
  </dl>
@@ -879,7 +887,7 @@ client.shares.create(
879
887
  <dl>
880
888
  <dd>
881
889
 
882
- **password:** `String`
890
+ **passphrase:** `String`
883
891
 
884
892
  </dd>
885
893
  </dl>
@@ -903,7 +911,7 @@ client.shares.create(
903
911
  <dl>
904
912
  <dd>
905
913
 
906
- **request_options:** `CloudPDF::Shares::RequestOptions`
914
+ **request_options:** `CloudPDF::Grants::RequestOptions`
907
915
 
908
916
  </dd>
909
917
  </dl>
@@ -915,7 +923,7 @@ client.shares.create(
915
923
  </dl>
916
924
  </details>
917
925
 
918
- <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">get</a>(tenant_id:, share_id:) -> CloudPDF::Types::SharesGet200Response</code></summary>
926
+ <details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">get</a>(tenant_id:, grant_id:) -> CloudPDF::Types::GrantsGet200Response</code></summary>
919
927
  <dl>
920
928
  <dd>
921
929
 
@@ -928,9 +936,9 @@ client.shares.create(
928
936
  <dd>
929
937
 
930
938
  ```ruby
931
- client.shares.get(
939
+ client.grants.get(
932
940
  tenant_id: "tenantId",
933
- share_id: "shareId"
941
+ grant_id: "grantId"
934
942
  )
935
943
  ```
936
944
  </dd>
@@ -954,7 +962,7 @@ client.shares.get(
954
962
  <dl>
955
963
  <dd>
956
964
 
957
- **share_id:** `String`
965
+ **grant_id:** `String`
958
966
 
959
967
  </dd>
960
968
  </dl>
@@ -962,7 +970,7 @@ client.shares.get(
962
970
  <dl>
963
971
  <dd>
964
972
 
965
- **request_options:** `CloudPDF::Shares::RequestOptions`
973
+ **request_options:** `CloudPDF::Grants::RequestOptions`
966
974
 
967
975
  </dd>
968
976
  </dl>
@@ -974,7 +982,7 @@ client.shares.get(
974
982
  </dl>
975
983
  </details>
976
984
 
977
- <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">delete</a>(tenant_id:, share_id:) -> </code></summary>
985
+ <details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">delete</a>(tenant_id:, grant_id:) -> </code></summary>
978
986
  <dl>
979
987
  <dd>
980
988
 
@@ -987,9 +995,9 @@ client.shares.get(
987
995
  <dd>
988
996
 
989
997
  ```ruby
990
- client.shares.delete(
998
+ client.grants.delete(
991
999
  tenant_id: "tenantId",
992
- share_id: "shareId"
1000
+ grant_id: "grantId"
993
1001
  )
994
1002
  ```
995
1003
  </dd>
@@ -1013,7 +1021,7 @@ client.shares.delete(
1013
1021
  <dl>
1014
1022
  <dd>
1015
1023
 
1016
- **share_id:** `String`
1024
+ **grant_id:** `String`
1017
1025
 
1018
1026
  </dd>
1019
1027
  </dl>
@@ -1021,7 +1029,7 @@ client.shares.delete(
1021
1029
  <dl>
1022
1030
  <dd>
1023
1031
 
1024
- **request_options:** `CloudPDF::Shares::RequestOptions`
1032
+ **request_options:** `CloudPDF::Grants::RequestOptions`
1025
1033
 
1026
1034
  </dd>
1027
1035
  </dl>
@@ -1033,7 +1041,7 @@ client.shares.delete(
1033
1041
  </dl>
1034
1042
  </details>
1035
1043
 
1036
- <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">update</a>(tenant_id:, share_id:, request) -> CloudPDF::Types::SharesUpdate200Response</code></summary>
1044
+ <details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">update</a>(tenant_id:, grant_id:, request) -> CloudPDF::Types::GrantsUpdate200Response</code></summary>
1037
1045
  <dl>
1038
1046
  <dd>
1039
1047
 
@@ -1046,9 +1054,9 @@ client.shares.delete(
1046
1054
  <dd>
1047
1055
 
1048
1056
  ```ruby
1049
- client.shares.update(
1057
+ client.grants.update(
1050
1058
  tenant_id: "tenantId",
1051
- share_id: "shareId"
1059
+ grant_id: "grantId"
1052
1060
  )
1053
1061
  ```
1054
1062
  </dd>
@@ -1072,7 +1080,15 @@ client.shares.update(
1072
1080
  <dl>
1073
1081
  <dd>
1074
1082
 
1075
- **share_id:** `String`
1083
+ **grant_id:** `String`
1084
+
1085
+ </dd>
1086
+ </dl>
1087
+
1088
+ <dl>
1089
+ <dd>
1090
+
1091
+ **name:** `String`
1076
1092
 
1077
1093
  </dd>
1078
1094
  </dl>
@@ -1080,7 +1096,7 @@ client.shares.update(
1080
1096
  <dl>
1081
1097
  <dd>
1082
1098
 
1083
- **layer_mode:** `CloudPDF::Shares::Types::SharesUpdateRequestLayerMode`
1099
+ **layer_mode:** `CloudPDF::Grants::Types::GrantsUpdateRequestLayerMode`
1084
1100
 
1085
1101
  </dd>
1086
1102
  </dl>
@@ -1112,7 +1128,7 @@ client.shares.update(
1112
1128
  <dl>
1113
1129
  <dd>
1114
1130
 
1115
- **visitor_identity:** `CloudPDF::Shares::Types::SharesUpdateRequestVisitorIdentity`
1131
+ **visitor_identity:** `CloudPDF::Grants::Types::GrantsUpdateRequestVisitorIdentity`
1116
1132
 
1117
1133
  </dd>
1118
1134
  </dl>
@@ -1144,7 +1160,7 @@ client.shares.update(
1144
1160
  <dl>
1145
1161
  <dd>
1146
1162
 
1147
- **password:** `String`
1163
+ **passphrase:** `String`
1148
1164
 
1149
1165
  </dd>
1150
1166
  </dl>
@@ -1176,7 +1192,7 @@ client.shares.update(
1176
1192
  <dl>
1177
1193
  <dd>
1178
1194
 
1179
- **request_options:** `CloudPDF::Shares::RequestOptions`
1195
+ **request_options:** `CloudPDF::Grants::RequestOptions`
1180
1196
 
1181
1197
  </dd>
1182
1198
  </dl>
@@ -1188,7 +1204,7 @@ client.shares.update(
1188
1204
  </dl>
1189
1205
  </details>
1190
1206
 
1191
- <details><summary><code>client.shares.<a href="/lib/CloudPDF/shares/client.rb">archive</a>(tenant_id:, share_id:) -> CloudPDF::Types::SharesArchive200Response</code></summary>
1207
+ <details><summary><code>client.grants.<a href="/lib/CloudPDF/grants/client.rb">archive</a>(tenant_id:, grant_id:) -> CloudPDF::Types::GrantsArchive200Response</code></summary>
1192
1208
  <dl>
1193
1209
  <dd>
1194
1210
 
@@ -1200,7 +1216,7 @@ client.shares.update(
1200
1216
  <dl>
1201
1217
  <dd>
1202
1218
 
1203
- Archiving is final: an archived link never exchanges again, and to share again you create a new link. Pausing (`disabled`) is the reversible stop. An archived link no longer counts as using its shared layer, so that layer can be deleted.
1219
+ Archiving is final: an archived grant never exchanges again, and to give access again you create a new grant. Pausing (`disabled`) is the reversible stop. An archived grant no longer counts as using its shared layer, so that layer can be deleted.
1204
1220
  </dd>
1205
1221
  </dl>
1206
1222
  </dd>
@@ -1215,9 +1231,9 @@ Archiving is final: an archived link never exchanges again, and to share again y
1215
1231
  <dd>
1216
1232
 
1217
1233
  ```ruby
1218
- client.shares.archive(
1234
+ client.grants.archive(
1219
1235
  tenant_id: "tenantId",
1220
- share_id: "shareId"
1236
+ grant_id: "grantId"
1221
1237
  )
1222
1238
  ```
1223
1239
  </dd>
@@ -1241,7 +1257,7 @@ client.shares.archive(
1241
1257
  <dl>
1242
1258
  <dd>
1243
1259
 
1244
- **share_id:** `String`
1260
+ **grant_id:** `String`
1245
1261
 
1246
1262
  </dd>
1247
1263
  </dl>
@@ -1249,7 +1265,7 @@ client.shares.archive(
1249
1265
  <dl>
1250
1266
  <dd>
1251
1267
 
1252
- **request_options:** `CloudPDF::Shares::RequestOptions`
1268
+ **request_options:** `CloudPDF::Grants::RequestOptions`
1253
1269
 
1254
1270
  </dd>
1255
1271
  </dl>
@@ -1614,7 +1630,7 @@ client.tenants.suspend(tenant_id: "tenantId")
1614
1630
  <dl>
1615
1631
  <dd>
1616
1632
 
1617
- Facts only — no limits or billing state. Views count share exchanges plus authorized /v1/access grants, deduplicated across the two.
1633
+ Facts only — no limits or billing state. Views count grant exchanges plus authorized /v1/access requests, deduplicated across the two.
1618
1634
  </dd>
1619
1635
  </dl>
1620
1636
  </dd>
@@ -2730,7 +2746,7 @@ client.folders.get(
2730
2746
  <dl>
2731
2747
  <dd>
2732
2748
 
2733
- Without recursive, a folder with anything inside is refused: 409 Conflict with `details.reason` `not-empty` and what it holds, counted over every level below, in `details.folders` and `details.documents`. With recursive=true, the folder and every folder under it go at once, and every document in them stops opening, leaves every list and stops answering its share links at once; their stored files and links are removed in the background. Uploads into those folders that have not committed cannot commit.
2749
+ Without recursive, a folder with anything inside is refused: 409 Conflict with `details.reason` `not-empty` and what it holds, counted over every level below, in `details.folders` and `details.documents`. With recursive=true, the folder and every folder under it go at once, and every document in them stops opening, leaves every list and stops answering its grants at once; their stored files and grants are removed in the background. Uploads into those folders that have not committed cannot commit.
2734
2750
  </dd>
2735
2751
  </dl>
2736
2752
  </dd>
@@ -6864,7 +6880,7 @@ client.documents.layers.list(
6864
6880
  <dl>
6865
6881
  <dd>
6866
6882
 
6867
- **share_id:** `String`
6883
+ **grant_id:** `String`
6868
6884
 
6869
6885
  </dd>
6870
6886
  </dl>
@@ -6952,8 +6968,8 @@ client.documents.layers.delete(
6952
6968
  </dl>
6953
6969
  </details>
6954
6970
 
6955
- ## Shares Visitors
6956
- <details><summary><code>client.shares.visitors.<a href="/lib/CloudPDF/shares/visitors/client.rb">list</a>(tenant_id:, share_id:) -> CloudPDF::Types::SharesVisitorsList200Response</code></summary>
6971
+ ## Grants Visitors
6972
+ <details><summary><code>client.grants.visitors.<a href="/lib/CloudPDF/grants/visitors/client.rb">list</a>(tenant_id:, grant_id:) -> CloudPDF::Types::GrantsVisitorsList200Response</code></summary>
6957
6973
  <dl>
6958
6974
  <dd>
6959
6975
 
@@ -6965,7 +6981,7 @@ client.documents.layers.delete(
6965
6981
  <dl>
6966
6982
  <dd>
6967
6983
 
6968
- An archived link's visitors are listed too.
6984
+ An archived grant's visitors are listed too.
6969
6985
  </dd>
6970
6986
  </dl>
6971
6987
  </dd>
@@ -6980,9 +6996,9 @@ An archived link's visitors are listed too.
6980
6996
  <dd>
6981
6997
 
6982
6998
  ```ruby
6983
- client.shares.visitors.list(
6999
+ client.grants.visitors.list(
6984
7000
  tenant_id: "tenantId",
6985
- share_id: "shareId"
7001
+ grant_id: "grantId"
6986
7002
  )
6987
7003
  ```
6988
7004
  </dd>
@@ -7006,7 +7022,7 @@ client.shares.visitors.list(
7006
7022
  <dl>
7007
7023
  <dd>
7008
7024
 
7009
- **share_id:** `String`
7025
+ **grant_id:** `String`
7010
7026
 
7011
7027
  </dd>
7012
7028
  </dl>
@@ -7030,7 +7046,7 @@ client.shares.visitors.list(
7030
7046
  <dl>
7031
7047
  <dd>
7032
7048
 
7033
- **request_options:** `CloudPDF::Shares::Visitors::RequestOptions`
7049
+ **request_options:** `CloudPDF::Grants::Visitors::RequestOptions`
7034
7050
 
7035
7051
  </dd>
7036
7052
  </dl>
@@ -7042,7 +7058,7 @@ client.shares.visitors.list(
7042
7058
  </dl>
7043
7059
  </details>
7044
7060
 
7045
- <details><summary><code>client.shares.visitors.<a href="/lib/CloudPDF/shares/visitors/client.rb">delete</a>(tenant_id:, share_id:, visitor_id:) -> </code></summary>
7061
+ <details><summary><code>client.grants.visitors.<a href="/lib/CloudPDF/grants/visitors/client.rb">delete</a>(tenant_id:, grant_id:, visitor_id:) -> </code></summary>
7046
7062
  <dl>
7047
7063
  <dd>
7048
7064
 
@@ -7069,9 +7085,9 @@ Their handle brings them back as a new visitor, who is asked again. Deleting a v
7069
7085
  <dd>
7070
7086
 
7071
7087
  ```ruby
7072
- client.shares.visitors.delete(
7088
+ client.grants.visitors.delete(
7073
7089
  tenant_id: "tenantId",
7074
- share_id: "shareId",
7090
+ grant_id: "grantId",
7075
7091
  visitor_id: "visitorId"
7076
7092
  )
7077
7093
  ```
@@ -7096,7 +7112,7 @@ client.shares.visitors.delete(
7096
7112
  <dl>
7097
7113
  <dd>
7098
7114
 
7099
- **share_id:** `String`
7115
+ **grant_id:** `String`
7100
7116
 
7101
7117
  </dd>
7102
7118
  </dl>
@@ -7112,7 +7128,7 @@ client.shares.visitors.delete(
7112
7128
  <dl>
7113
7129
  <dd>
7114
7130
 
7115
- **request_options:** `CloudPDF::Shares::Visitors::RequestOptions`
7131
+ **request_options:** `CloudPDF::Grants::Visitors::RequestOptions`
7116
7132
 
7117
7133
  </dd>
7118
7134
  </dl>