cloudpdf 3.0.0.alpha.14 → 3.0.0.alpha.16

data/reference.md

@@ -93,6 +93,98 @@ client.doc.head(doc_id: "docId")
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.doc.<a href="/lib/CloudPDF/doc/client.rb">changes</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocChanges200Response</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Each change stands on its own and names itself by `opId`: a refused change rolls back alone, and the answer lists every change in order, applied with its result or refused with its error. Asked again under its `opId`, a change gets the same answer, refusals included; a different change under an answered `opId` is refused (IdempotencyKeyReused). `{ opId, undoOf }` undoes an earlier change of the caller, here or in an earlier request; an undo leaves alone what was changed since, and the undo of an undo redoes. A redaction, a flatten, a form repair or a completed signature ends undo for the changes before it (UndoUnavailable). Each op is checked against its own capability: annotation ops need `doc.annotate.modify`, form values `doc.forms.fill`, form structure `doc.forms.modify`, metadata `doc.metadata.modify`, outline `doc.outline.modify`, pages `doc.pages.assemble`, embedded files `doc.attachments.modify`. Bytes (a stamp's drawing, an attached file, a signature's artwork, a PDF whose pages come in) travel as multipart: a JSON `body` part, each op naming its files by role as `resources: { <role>: '<key>' }`, and each file as the part `resource:<key>`. At most 64 changes per request and 512 ops per change.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.doc.changes(
+  doc_id: "docId",
+  layer_name: "layerName",
+  changes: [{
+    op_id: "opId"
+  }]
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**doc_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**layer_name:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**changes:** `Internal::Types::Array[CloudPDF::Doc::Types::DocChangesRequestChangesItem]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `CloudPDF::Doc::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -231,7 +323,7 @@ client.doc.manifest(
 </dl>
 </details>
 
-<details><summary><code>client.doc.<a href="/lib/CloudPDF/doc/client.rb">render</a>(doc_id:, layer_name:, pon:) -> String</code></summary>
+<details><summary><code>client.doc.<a href="/lib/CloudPDF/doc/client.rb">render</a>(doc_id:, layer_name:, page_key:) -> String</code></summary>
 <dl>
 <dd>
 
@@ -261,7 +353,7 @@ Render parameters (viewport, format) pass as flat dotted query keys, e.g. `?view
 client.doc.render(
   doc_id: "docId",
   layer_name: "layerName",
-  pon: 1
+  page_key: "pageKey"
 )
 ```
 </dd>
@@ -293,7 +385,7 @@ client.doc.render(
 <dl>
 <dd>
 
-**pon:** `Integer` 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
     
 </dd>
 </dl>
@@ -321,7 +413,7 @@ client.doc.render(
 </dl>
 </details>
 
-<details><summary><code>client.doc.<a href="/lib/CloudPDF/doc/client.rb">text</a>(doc_id:, layer_name:, pon:) -> CloudPDF::Types::DocText200Response</code></summary>
+<details><summary><code>client.doc.<a href="/lib/CloudPDF/doc/client.rb">text</a>(doc_id:, layer_name:, page_key:) -> CloudPDF::Types::DocText200Response</code></summary>
 <dl>
 <dd>
 
@@ -337,7 +429,7 @@ client.doc.render(
 client.doc.text(
   doc_id: "docId",
   layer_name: "layerName",
-  pon: 1
+  page_key: "pageKey"
 )
 ```
 </dd>
@@ -369,7 +461,7 @@ client.doc.text(
 <dl>
 <dd>
 
-**pon:** `Integer` 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
     
 </dd>
 </dl>
@@ -552,7 +644,7 @@ client.shares.list(tenant_id: "tenantId")
 <dl>
 <dd>
 
-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.
+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.
 </dd>
 </dl>
 </dd>
@@ -1801,7 +1893,7 @@ client.documents.import_from(tenant_id: "tenantId")
 <dl>
 <dd>
 
-**source:** `CloudPDF::Documents::Types::DocumentsImportFromRequestSource` — Where CloudPDF pulls the bytes from. The two shapes differ in WHO supplies the authority to read, not in which storage vendor holds the file.
+**source:** `CloudPDF::Documents::Types::DocumentsImportFromRequestSource` — Where CloudPDF pulls the bytes from. The two shapes differ in who supplies the authority to read, not in which storage vendor holds the file.
     
 </dd>
 </dl>
@@ -2146,7 +2238,7 @@ client.tokens.revoke(
 </details>
 
 ## Doc Annotations
-<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">list_all</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocAnnotationsListAll200Response</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">list_all</a>(doc_id:, layer_name:) -> CloudPDF::Types::AnnotationList</code></summary>
 <dl>
 <dd>
 
@@ -2158,7 +2250,7 @@ client.tokens.revoke(
 <dl>
 <dd>
 
-Returns one entry per page plus the audit-log cursor for reconciling subsequent document events. Page order is unspecified; join by `pageState.pageObjectNumber` when display order matters.
+Returns one entry per page plus the audit-log cursor for reconciling subsequent document events. Page order is unspecified; join by `page` (a `PageRef`) when display order matters.
 </dd>
 </dl>
 </dd>
@@ -2227,7 +2319,7 @@ client.doc.annotations.list_all(
 </dl>
 </details>
 
-<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">list</a>(doc_id:, layer_name:, pon:) -> CloudPDF::Types::DocAnnotationsList200Response</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">list</a>(doc_id:, layer_name:, page_key:) -> CloudPDF::Types::AnnotationList</code></summary>
 <dl>
 <dd>
 
@@ -2243,7 +2335,7 @@ client.doc.annotations.list_all(
 client.doc.annotations.list(
   doc_id: "docId",
   layer_name: "layerName",
-  pon: 1
+  page_key: "pageKey"
 )
 ```
 </dd>
@@ -2275,7 +2367,7 @@ client.doc.annotations.list(
 <dl>
 <dd>
 
-**pon:** `Integer` 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
     
 </dd>
 </dl>
@@ -2303,7 +2395,7 @@ client.doc.annotations.list(
 </dl>
 </details>
 
-<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">create</a>(doc_id:, layer_name:, pon:, request) -> CloudPDF::Types::DocAnnotationsCreate200Response</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">create</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocAnnotationsCreate200Response</code></summary>
 <dl>
 <dd>
 
@@ -2333,7 +2425,7 @@ Doc JWTs may instead carry collab scopes (annotations:create:self, …) that ref
 client.doc.annotations.create(
   doc_id: "docId",
   layer_name: "layerName",
-  pon: 1,
+  page_key: "pageKey",
   request: {
     key: "value"
   }
@@ -2368,7 +2460,7 @@ client.doc.annotations.create(
 <dl>
 <dd>
 
-**pon:** `Integer` 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
     
 </dd>
 </dl>
@@ -2384,6 +2476,14 @@ client.doc.annotations.create(
 <dl>
 <dd>
 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request:** `Internal::Types::Hash[String, Object]` 
     
 </dd>
@@ -2404,7 +2504,7 @@ client.doc.annotations.create(
 </dl>
 </details>
 
-<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">delete</a>(doc_id:, layer_name:, pon:, annot_key:) -> CloudPDF::Types::DocAnnotationsDelete200Response</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">delete</a>(doc_id:, layer_name:, page_key:, annot_key:) -> CloudPDF::Types::DocAnnotationsDelete200Response</code></summary>
 <dl>
 <dd>
 
@@ -2420,7 +2520,7 @@ client.doc.annotations.create(
 client.doc.annotations.delete(
   doc_id: "docId",
   layer_name: "layerName",
-  pon: 1,
+  page_key: "pageKey",
   annot_key: "annotKey"
 )
 ```
@@ -2453,7 +2553,7 @@ client.doc.annotations.delete(
 <dl>
 <dd>
 
-**pon:** `Integer` 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
     
 </dd>
 </dl>
@@ -2461,7 +2561,7 @@ client.doc.annotations.delete(
 <dl>
 <dd>
 
-**annot_key:** `String` 
+**annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
     
 </dd>
 </dl>
@@ -2477,6 +2577,14 @@ client.doc.annotations.delete(
 <dl>
 <dd>
 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `CloudPDF::Doc::Annotations::RequestOptions` 
     
 </dd>
@@ -2489,7 +2597,7 @@ client.doc.annotations.delete(
 </dl>
 </details>
 
-<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">update</a>(doc_id:, layer_name:, pon:, annot_key:, request) -> CloudPDF::Types::DocAnnotationsUpdate200Response</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">update</a>(doc_id:, layer_name:, page_key:, annot_key:, request) -> CloudPDF::Types::DocAnnotationsUpdate200Response</code></summary>
 <dl>
 <dd>
 
@@ -2505,7 +2613,7 @@ client.doc.annotations.delete(
 client.doc.annotations.update(
   doc_id: "docId",
   layer_name: "layerName",
-  pon: 1,
+  page_key: "pageKey",
   annot_key: "annotKey",
   request: {
     key: "value"
@@ -2541,7 +2649,7 @@ client.doc.annotations.update(
 <dl>
 <dd>
 
-**pon:** `Integer` 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
     
 </dd>
 </dl>
@@ -2549,7 +2657,7 @@ client.doc.annotations.update(
 <dl>
 <dd>
 
-**annot_key:** `String` 
+**annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
     
 </dd>
 </dl>
@@ -2565,6 +2673,14 @@ client.doc.annotations.update(
 <dl>
 <dd>
 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request:** `Internal::Types::Hash[String, Object]` 
     
 </dd>
@@ -2585,7 +2701,7 @@ client.doc.annotations.update(
 </dl>
 </details>
 
-<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">export_appearance</a>(doc_id:, layer_name:, pon:, request) -> String</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">read_appearance</a>(doc_id:, layer_name:, page_key:, annot_key:) -> String</code></summary>
 <dl>
 <dd>
 
@@ -2598,15 +2714,11 @@ client.doc.annotations.update(
 <dd>
 
 ```ruby
-client.doc.annotations.export_appearance(
+client.doc.annotations.read_appearance(
   doc_id: "docId",
   layer_name: "layerName",
-  pon: 1,
-  request: {
-    string: {
-      key: "value"
-    }
-  }
+  page_key: "pageKey",
+  annot_key: "annotKey"
 )
 ```
 </dd>
@@ -2638,7 +2750,7 @@ client.doc.annotations.export_appearance(
 <dl>
 <dd>
 
-**pon:** `Integer` 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
     
 </dd>
 </dl>
@@ -2646,7 +2758,7 @@ client.doc.annotations.export_appearance(
 <dl>
 <dd>
 
-**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
+**annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
     
 </dd>
 </dl>
@@ -2654,7 +2766,7 @@ client.doc.annotations.export_appearance(
 <dl>
 <dd>
 
-**request:** `Internal::Types::Hash[String, Object]` 
+**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
     
 </dd>
 </dl>
@@ -2674,10 +2786,24 @@ client.doc.annotations.export_appearance(
 </dl>
 </details>
 
-<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">flatten</a>(doc_id:, layer_name:, pon:, request) -> CloudPDF::Types::DocAnnotationsFlatten200Response</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">read_file</a>(doc_id:, layer_name:, page_key:, annot_key:) -> String</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+A file that decodes past the server's limit is refused (PayloadTooLarge).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2687,13 +2813,11 @@ client.doc.annotations.export_appearance(
 <dd>
 
 ```ruby
-client.doc.annotations.flatten(
+client.doc.annotations.read_file(
   doc_id: "docId",
   layer_name: "layerName",
-  pon: 1,
-  request: {
-    key: "value"
-  }
+  page_key: "pageKey",
+  annot_key: "annotKey"
 )
 ```
 </dd>
@@ -2725,7 +2849,7 @@ client.doc.annotations.flatten(
 <dl>
 <dd>
 
-**pon:** `Integer` 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
     
 </dd>
 </dl>
@@ -2733,7 +2857,7 @@ client.doc.annotations.flatten(
 <dl>
 <dd>
 
-**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
+**annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
     
 </dd>
 </dl>
@@ -2741,7 +2865,7 @@ client.doc.annotations.flatten(
 <dl>
 <dd>
 
-**request:** `Internal::Types::Hash[String, Object]` 
+**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
     
 </dd>
 </dl>
@@ -2761,8 +2885,7 @@ client.doc.annotations.flatten(
 </dl>
 </details>
 
-## Doc Forms
-<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">get</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocFormsGet200Response</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">export_appearance</a>(doc_id:, layer_name:, page_key:, request) -> String</code></summary>
 <dl>
 <dd>
 
@@ -2775,9 +2898,15 @@ client.doc.annotations.flatten(
 <dd>
 
 ```ruby
-client.doc.forms.get(
+client.doc.annotations.export_appearance(
   doc_id: "docId",
-  layer_name: "layerName"
+  layer_name: "layerName",
+  page_key: "pageKey",
+  request: {
+    string: {
+      key: "value"
+    }
+  }
 )
 ```
 </dd>
@@ -2809,6 +2938,14 @@ client.doc.forms.get(
 <dl>
 <dd>
 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
     
 </dd>
@@ -2817,7 +2954,15 @@ client.doc.forms.get(
 <dl>
 <dd>
 
-**request_options:** `CloudPDF::Doc::Forms::RequestOptions` 
+**request:** `Internal::Types::Hash[String, Object]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `CloudPDF::Doc::Annotations::RequestOptions` 
     
 </dd>
 </dl>
@@ -2829,7 +2974,7 @@ client.doc.forms.get(
 </dl>
 </details>
 
-<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">export_data</a>(doc_id:, layer_name:) -> String</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">flatten</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocAnnotationsFlatten200Response</code></summary>
 <dl>
 <dd>
 
@@ -2842,9 +2987,13 @@ client.doc.forms.get(
 <dd>
 
 ```ruby
-client.doc.forms.export_data(
+client.doc.annotations.flatten(
   doc_id: "docId",
-  layer_name: "layerName"
+  layer_name: "layerName",
+  page_key: "pageKey",
+  request: {
+    key: "value"
+  }
 )
 ```
 </dd>
@@ -2876,7 +3025,7 @@ client.doc.forms.export_data(
 <dl>
 <dd>
 
-**format:** `CloudPDF::Doc::Forms::Types::ExportDataFormsRequestFormat` 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
     
 </dd>
 </dl>
@@ -2892,7 +3041,23 @@ client.doc.forms.export_data(
 <dl>
 <dd>
 
-**request_options:** `CloudPDF::Doc::Forms::RequestOptions` 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Internal::Types::Hash[String, Object]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `CloudPDF::Doc::Annotations::RequestOptions` 
     
 </dd>
 </dl>
@@ -2904,7 +3069,7 @@ client.doc.forms.export_data(
 </dl>
 </details>
 
-<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">import_data</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocFormsImportData200Response</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/lib/CloudPDF/doc/annotations/client.rb">reorder</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocAnnotationsReorder200Response</code></summary>
 <dl>
 <dd>
 
@@ -2917,12 +3082,12 @@ client.doc.forms.export_data(
 <dd>
 
 ```ruby
-client.doc.forms.import_data(
+client.doc.annotations.reorder(
   doc_id: "docId",
   layer_name: "layerName",
-  request: {
-    key: "value"
-  }
+  page_key: "pageKey",
+  refs: [],
+  position: "start"
 )
 ```
 </dd>
@@ -2954,6 +3119,14 @@ client.doc.forms.import_data(
 <dl>
 <dd>
 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
     
 </dd>
@@ -2962,7 +3135,7 @@ client.doc.forms.import_data(
 <dl>
 <dd>
 
-**request:** `Internal::Types::Hash[String, Object]` 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
     
 </dd>
 </dl>
@@ -2970,7 +3143,23 @@ client.doc.forms.import_data(
 <dl>
 <dd>
 
-**request_options:** `CloudPDF::Doc::Forms::RequestOptions` 
+**refs:** `Internal::Types::Array[CloudPDF::Types::AnnotationRef]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**position:** `CloudPDF::Types::AnnotationPosition` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `CloudPDF::Doc::Annotations::RequestOptions` 
     
 </dd>
 </dl>
@@ -2982,10 +3171,25 @@ client.doc.forms.import_data(
 </dl>
 </details>
 
-<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reset</a>(doc_id:, layer_name:, field_key:) -> CloudPDF::Types::DocFormsReset200Response</code></summary>
+## Doc Attachments
+<details><summary><code>client.doc.attachments.<a href="/lib/CloudPDF/doc/attachments/client.rb">download</a>(doc_id:, layer_name:, file_key:) -> String</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+A file that decodes past the server's limit is refused (PayloadTooLarge).
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2995,10 +3199,10 @@ client.doc.forms.import_data(
 <dd>
 
 ```ruby
-client.doc.forms.reset(
+client.doc.attachments.download(
   doc_id: "docId",
   layer_name: "layerName",
-  field_key: "fieldKey"
+  file_key: "fileKey"
 )
 ```
 </dd>
@@ -3030,7 +3234,7 @@ client.doc.forms.reset(
 <dl>
 <dd>
 
-**field_key:** `String` 
+**file_key:** `String` — The embedded file's name-tree key (its `ref.key`), token-text encoded, as `fieldKey` is.
     
 </dd>
 </dl>
@@ -3046,7 +3250,7 @@ client.doc.forms.reset(
 <dl>
 <dd>
 
-**request_options:** `CloudPDF::Doc::Forms::RequestOptions` 
+**request_options:** `CloudPDF::Doc::Attachments::RequestOptions` 
     
 </dd>
 </dl>
@@ -3058,10 +3262,24 @@ client.doc.forms.reset(
 </dl>
 </details>
 
-<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">set_value</a>(doc_id:, layer_name:, field_key:, request) -> CloudPDF::Types::DocFormsSetValue200Response</code></summary>
+<details><summary><code>client.doc.attachments.<a href="/lib/CloudPDF/doc/attachments/client.rb">list</a>(doc_id:, layer_name:) -> CloudPDF::Types::AttachmentList</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+A file-attachment annotation's file is listed with the annotation; read its bytes with `doc.annotations.readFile`.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -3071,13 +3289,9 @@ client.doc.forms.reset(
 <dd>
 
 ```ruby
-client.doc.forms.set_value(
+client.doc.attachments.list(
   doc_id: "docId",
-  layer_name: "layerName",
-  field_key: "fieldKey",
-  request: {
-    key: "value"
-  }
+  layer_name: "layerName"
 )
 ```
 </dd>
@@ -3109,7 +3323,7 @@ client.doc.forms.set_value(
 <dl>
 <dd>
 
-**field_key:** `String` 
+**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
     
 </dd>
 </dl>
@@ -3117,15 +3331,67 @@ client.doc.forms.set_value(
 <dl>
 <dd>
 
-**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
+**request_options:** `CloudPDF::Doc::Attachments::RequestOptions` 
     
 </dd>
 </dl>
+</dd>
+</dl>
 
+
+</dd>
+</dl>
+</details>
+
+## Doc Forms
+<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">list</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocFormsList200Response</code></summary>
 <dl>
 <dd>
 
-**request:** `Internal::Types::Hash[String, Object]` 
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.doc.forms.list(
+  doc_id: "docId",
+  layer_name: "layerName"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**doc_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**layer_name:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
     
 </dd>
 </dl>
@@ -3145,8 +3411,7 @@ client.doc.forms.set_value(
 </dl>
 </details>
 
-## Doc Metadata
-<details><summary><code>client.doc.metadata.<a href="/lib/CloudPDF/doc/metadata/client.rb">get</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocMetadataGet200Response</code></summary>
+<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reorder_calculations</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocFormsReorderCalculations200Response</code></summary>
 <dl>
 <dd>
 
@@ -3159,9 +3424,11 @@ client.doc.forms.set_value(
 <dd>
 
 ```ruby
-client.doc.metadata.get(
+client.doc.forms.reorder_calculations(
   doc_id: "docId",
-  layer_name: "layerName"
+  layer_name: "layerName",
+  fields: [],
+  position: "start"
 )
 ```
 </dd>
@@ -3201,7 +3468,31 @@ client.doc.metadata.get(
 <dl>
 <dd>
 
-**request_options:** `CloudPDF::Doc::Metadata::RequestOptions` 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**fields:** `Internal::Types::Array[CloudPDF::Types::FormFieldRef]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**position:** `CloudPDF::Types::FieldPosition` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `CloudPDF::Doc::Forms::RequestOptions` 
     
 </dd>
 </dl>
@@ -3213,8 +3504,7 @@ client.doc.metadata.get(
 </dl>
 </details>
 
-## Doc Pages
-<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">set_scale</a>(doc_id:, layer_name:, pon:, request) -> CloudPDF::Types::DocPagesSetScale200Response</code></summary>
+<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">set_value</a>(doc_id:, layer_name:, field_key:, request) -> CloudPDF::Types::DocFormsSetValue200Response</code></summary>
 <dl>
 <dd>
 
@@ -3227,10 +3517,13 @@ client.doc.metadata.get(
 <dd>
 
 ```ruby
-client.doc.pages.set_scale(
+client.doc.forms.set_value(
   doc_id: "docId",
   layer_name: "layerName",
-  pon: 1
+  field_key: "fieldKey",
+  request: {
+    key: "value"
+  }
 )
 ```
 </dd>
@@ -3262,7 +3555,7 @@ client.doc.pages.set_scale(
 <dl>
 <dd>
 
-**pon:** `Integer` 
+**field_key:** `String` 
     
 </dd>
 </dl>
@@ -3278,7 +3571,7 @@ client.doc.pages.set_scale(
 <dl>
 <dd>
 
-**measure:** `CloudPDF::Doc::Pages::Types::DocPagesSetScaleRequestMeasure` 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
     
 </dd>
 </dl>
@@ -3286,7 +3579,15 @@ client.doc.pages.set_scale(
 <dl>
 <dd>
 
-**request_options:** `CloudPDF::Doc::Pages::RequestOptions` 
+**request:** `Internal::Types::Hash[String, Object]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `CloudPDF::Doc::Forms::RequestOptions` 
     
 </dd>
 </dl>
@@ -3298,7 +3599,7 @@ client.doc.pages.set_scale(
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">viewports</a>(doc_id:, layer_name:, pon:) -> Internal::Types::Array[CloudPDF::Types::DocPagesViewports200ResponseItem]</code></summary>
+<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reset</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocFormsReset200Response</code></summary>
 <dl>
 <dd>
 
@@ -3311,10 +3612,9 @@ client.doc.pages.set_scale(
 <dd>
 
 ```ruby
-client.doc.pages.viewports(
+client.doc.forms.reset(
   doc_id: "docId",
-  layer_name: "layerName",
-  pon: 1
+  layer_name: "layerName"
 )
 ```
 </dd>
@@ -3346,7 +3646,7 @@ client.doc.pages.viewports(
 <dl>
 <dd>
 
-**pon:** `Integer` 
+**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
     
 </dd>
 </dl>
@@ -3354,7 +3654,7 @@ client.doc.pages.viewports(
 <dl>
 <dd>
 
-**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
     
 </dd>
 </dl>
@@ -3362,7 +3662,15 @@ client.doc.pages.viewports(
 <dl>
 <dd>
 
-**request_options:** `CloudPDF::Doc::Pages::RequestOptions` 
+**refs:** `Internal::Types::Array[CloudPDF::Types::FormFieldRef]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `CloudPDF::Doc::Forms::RequestOptions` 
     
 </dd>
 </dl>
@@ -3374,7 +3682,7 @@ client.doc.pages.viewports(
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">delete</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesDelete200Response</code></summary>
+<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">delete_widget</a>(doc_id:, layer_name:, page_key:, annot_key:) -> CloudPDF::Types::DocFormsDeleteWidget200Response</code></summary>
 <dl>
 <dd>
 
@@ -3387,12 +3695,11 @@ client.doc.pages.viewports(
 <dd>
 
 ```ruby
-client.doc.pages.delete(
+client.doc.forms.delete_widget(
   doc_id: "docId",
   layer_name: "layerName",
-  request: {
-    key: "value"
-  }
+  page_key: "pageKey",
+  annot_key: "annotKey"
 )
 ```
 </dd>
@@ -3424,7 +3731,7 @@ client.doc.pages.delete(
 <dl>
 <dd>
 
-**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
     
 </dd>
 </dl>
@@ -3432,7 +3739,7 @@ client.doc.pages.delete(
 <dl>
 <dd>
 
-**request:** `Internal::Types::Hash[String, Object]` 
+**annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
     
 </dd>
 </dl>
@@ -3440,35 +3747,37 @@ client.doc.pages.delete(
 <dl>
 <dd>
 
-**request_options:** `CloudPDF::Doc::Pages::RequestOptions` 
+**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
     
 </dd>
 </dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
 
-<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">extract</a>(doc_id:, layer_name:, request) -> String</code></summary>
 <dl>
 <dd>
 
-#### 📝 Description
-
-<dl>
-<dd>
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
+    
+</dd>
+</dl>
 
 <dl>
 <dd>
 
-A read, not a mutation: the source document is untouched and no event is published. Body is `{"pageObjectNumbers": number[]}`; the response body is the new PDF.
+**request_options:** `CloudPDF::Doc::Forms::RequestOptions` 
+    
+</dd>
+</dl>
 </dd>
 </dl>
+
+
 </dd>
 </dl>
+</details>
+
+<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">update_widget</a>(doc_id:, layer_name:, page_key:, annot_key:, request) -> CloudPDF::Types::DocFormsUpdateWidget200Response</code></summary>
+<dl>
+<dd>
 
 #### 🔌 Usage
 
@@ -3479,14 +3788,12 @@ A read, not a mutation: the source document is untouched and no event is publish
 <dd>
 
 ```ruby
-client.doc.pages.extract(
+client.doc.forms.update_widget(
   doc_id: "docId",
   layer_name: "layerName",
-  request: {
-    string: {
-      key: "value"
-    }
-  }
+  page_key: "pageKey",
+  annot_key: "annotKey",
+  patch: {}
 )
 ```
 </dd>
@@ -3518,6 +3825,22 @@ client.doc.pages.extract(
 <dl>
 <dd>
 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**annot_key:** `String` — The annotation's address on the page: `obj:N`, its indirect object number, or `base:N` for an annotation the uploaded file stored inline (without an object number of its own), the position it was born at in the page's /Annots. The name the annotation's `ref` carries for life.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
     
 </dd>
@@ -3526,7 +3849,7 @@ client.doc.pages.extract(
 <dl>
 <dd>
 
-**request:** `Internal::Types::Hash[String, Object]` 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
     
 </dd>
 </dl>
@@ -3534,7 +3857,15 @@ client.doc.pages.extract(
 <dl>
 <dd>
 
-**request_options:** `CloudPDF::Doc::Pages::RequestOptions` 
+**patch:** `CloudPDF::Types::WidgetPatch` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `CloudPDF::Doc::Forms::RequestOptions` 
     
 </dd>
 </dl>
@@ -3546,7 +3877,7 @@ client.doc.pages.extract(
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">flatten</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesFlatten200Response</code></summary>
+<details><summary><code>client.doc.forms.<a href="/lib/CloudPDF/doc/forms/client.rb">reorder_widgets</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocFormsReorderWidgets200Response</code></summary>
 <dl>
 <dd>
 
@@ -3559,12 +3890,12 @@ client.doc.pages.extract(
 <dd>
 
 ```ruby
-client.doc.pages.flatten(
+client.doc.forms.reorder_widgets(
   doc_id: "docId",
   layer_name: "layerName",
-  request: {
-    key: "value"
-  }
+  page_key: "pageKey",
+  widgets: [],
+  position: "start"
 )
 ```
 </dd>
@@ -3596,6 +3927,14 @@ client.doc.pages.flatten(
 <dl>
 <dd>
 
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
     
 </dd>
@@ -3604,7 +3943,7 @@ client.doc.pages.flatten(
 <dl>
 <dd>
 
-**request:** `Internal::Types::Hash[String, Object]` 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
     
 </dd>
 </dl>
@@ -3612,7 +3951,23 @@ client.doc.pages.flatten(
 <dl>
 <dd>
 
-**request_options:** `CloudPDF::Doc::Pages::RequestOptions` 
+**widgets:** `Internal::Types::Array[CloudPDF::Types::AnnotationRef]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**position:** `CloudPDF::Types::AnnotationPosition` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `CloudPDF::Doc::Forms::RequestOptions` 
     
 </dd>
 </dl>
@@ -3624,11 +3979,31 @@ client.doc.pages.flatten(
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">insert</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesInsert200Response</code></summary>
+## Doc Metadata
+<details><summary><code>client.doc.metadata.<a href="/lib/CloudPDF/doc/metadata/client.rb">get</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocumentMetadata</code></summary>
 <dl>
 <dd>
 
-#### 📝 Description
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.doc.metadata.get(
+  doc_id: "docId",
+  layer_name: "layerName"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
 
 <dl>
 <dd>
@@ -3636,12 +4011,47 @@ client.doc.pages.flatten(
 <dl>
 <dd>
 
-Multipart mutation envelope: a `body` field holding `{"destIndex"?: number}` (omitted → append) plus a `resource:source` file part carrying the standalone PDF whose pages are copied in. The inserted copies get fresh page object numbers, returned in insertion order.
+**doc_id:** `String` 
+    
 </dd>
 </dl>
+
+<dl>
+<dd>
+
+**layer_name:** `String` 
+    
 </dd>
 </dl>
 
+<dl>
+<dd>
+
+**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `CloudPDF::Doc::Metadata::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## Doc Outline
+<details><summary><code>client.doc.outline.<a href="/lib/CloudPDF/doc/outline/client.rb">get</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocumentOutline</code></summary>
+<dl>
+<dd>
+
 #### 🔌 Usage
 
 <dl>
@@ -3651,7 +4061,7 @@ Multipart mutation envelope: a `body` field holding `{"destIndex"?: number}` (om
 <dd>
 
 ```ruby
-client.doc.pages.insert(
+client.doc.outline.get(
   doc_id: "docId",
   layer_name: "layerName"
 )
@@ -3693,7 +4103,7 @@ client.doc.pages.insert(
 <dl>
 <dd>
 
-**request_options:** `CloudPDF::Doc::Pages::RequestOptions` 
+**request_options:** `CloudPDF::Doc::Outline::RequestOptions` 
     
 </dd>
 </dl>
@@ -3705,23 +4115,102 @@ client.doc.pages.insert(
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">insert_blank</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesInsertBlank200Response</code></summary>
+## Doc Pages
+<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">set_scale</a>(doc_id:, layer_name:, page_key:, request) -> CloudPDF::Types::DocPagesSetScale200Response</code></summary>
 <dl>
 <dd>
 
-#### 📝 Description
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.doc.pages.set_scale(
+  doc_id: "docId",
+  layer_name: "layerName",
+  page_key: "pageKey"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**doc_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**layer_name:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
+    
+</dd>
+</dl>
 
 <dl>
 <dd>
 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
+    
+</dd>
+</dl>
+
 <dl>
 <dd>
 
-Body is `{"size": {"width", "height"}, "count"?, "destIndex"?}` — size in PDF points, count in [1, 100], destIndex omitted → append.
+**measure:** `CloudPDF::Doc::Pages::Types::DocPagesSetScaleRequestMeasure` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `CloudPDF::Doc::Pages::RequestOptions` 
+    
+</dd>
+</dl>
 </dd>
 </dl>
+
+
 </dd>
 </dl>
+</details>
+
+<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">viewports</a>(doc_id:, layer_name:, page_key:) -> CloudPDF::Types::DocPagesViewports200Response</code></summary>
+<dl>
+<dd>
 
 #### 🔌 Usage
 
@@ -3732,12 +4221,10 @@ Body is `{"size": {"width", "height"}, "count"?, "destIndex"?}` — size in PDF
 <dd>
 
 ```ruby
-client.doc.pages.insert_blank(
+client.doc.pages.viewports(
   doc_id: "docId",
   layer_name: "layerName",
-  request: {
-    key: "value"
-  }
+  page_key: "pageKey"
 )
 ```
 </dd>
@@ -3769,7 +4256,7 @@ client.doc.pages.insert_blank(
 <dl>
 <dd>
 
-**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
+**page_key:** `String` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
     
 </dd>
 </dl>
@@ -3777,7 +4264,7 @@ client.doc.pages.insert_blank(
 <dl>
 <dd>
 
-**request:** `Internal::Types::Hash[String, Object]` 
+**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
     
 </dd>
 </dl>
@@ -3797,10 +4284,24 @@ client.doc.pages.insert_blank(
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">move</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesMove200Response</code></summary>
+<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">extract</a>(doc_id:, layer_name:, request) -> String</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+A read, not a mutation: the source document is untouched and no event is published. Body is `{"pages": PageRef[], "flatten"?: {"usage"?: "display" | "print"}, "includeAnnotations"?: boolean, "includeFormFields"?: boolean}`; the response body is the new PDF. With `flatten` the copy is the pages as they draw for `usage` (`"print"`: a print copy): the annotations and form fields painted in, nothing interactive left, layers in their state for the usage. A flattened copy takes `doc.download` or `doc.download.flattened`, and paints only what the caller may read; `includeAnnotations` and `includeFormFields` choose what it paints, and are refused without `flatten`.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -3810,11 +4311,13 @@ client.doc.pages.insert_blank(
 <dd>
 
 ```ruby
-client.doc.pages.move(
+client.doc.pages.extract(
   doc_id: "docId",
   layer_name: "layerName",
   request: {
-    key: "value"
+    string: {
+      key: "value"
+    }
   }
 )
 ```
@@ -3875,7 +4378,7 @@ client.doc.pages.move(
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">set_name</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesSetName200Response</code></summary>
+<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">flatten</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesFlatten200Response</code></summary>
 <dl>
 <dd>
 
@@ -3888,7 +4391,7 @@ client.doc.pages.move(
 <dd>
 
 ```ruby
-client.doc.pages.set_name(
+client.doc.pages.flatten(
   doc_id: "docId",
   layer_name: "layerName",
   request: {
@@ -3933,6 +4436,14 @@ client.doc.pages.set_name(
 <dl>
 <dd>
 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request:** `Internal::Types::Hash[String, Object]` 
     
 </dd>
@@ -3953,7 +4464,7 @@ client.doc.pages.set_name(
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">remove_name</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesRemoveName200Response</code></summary>
+<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">set_name</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesSetName200Response</code></summary>
 <dl>
 <dd>
 
@@ -3966,7 +4477,7 @@ client.doc.pages.set_name(
 <dd>
 
 ```ruby
-client.doc.pages.remove_name(
+client.doc.pages.set_name(
   doc_id: "docId",
   layer_name: "layerName",
   request: {
@@ -4011,6 +4522,14 @@ client.doc.pages.remove_name(
 <dl>
 <dd>
 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request:** `Internal::Types::Hash[String, Object]` 
     
 </dd>
@@ -4031,7 +4550,7 @@ client.doc.pages.remove_name(
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">rotate</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesRotate200Response</code></summary>
+<details><summary><code>client.doc.pages.<a href="/lib/CloudPDF/doc/pages/client.rb">remove_name</a>(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesRemoveName200Response</code></summary>
 <dl>
 <dd>
 
@@ -4044,7 +4563,7 @@ client.doc.pages.remove_name(
 <dd>
 
 ```ruby
-client.doc.pages.rotate(
+client.doc.pages.remove_name(
   doc_id: "docId",
   layer_name: "layerName",
   request: {
@@ -4089,6 +4608,14 @@ client.doc.pages.rotate(
 <dl>
 <dd>
 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request:** `Internal::Types::Hash[String, Object]` 
     
 </dd>
@@ -4125,10 +4652,7 @@ client.doc.pages.rotate(
 ```ruby
 client.doc.redactions.apply(
   doc_id: "docId",
-  layer_name: "layerName",
-  request: {
-    key: "value"
-  }
+  layer_name: "layerName"
 )
 ```
 </dd>
@@ -4168,7 +4692,23 @@ client.doc.redactions.apply(
 <dl>
 <dd>
 
-**request:** `Internal::Types::Hash[String, Object]` 
+**idempotency_key:** `String` — Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**pages:** `Internal::Types::Array[CloudPDF::Types::PageRef]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**annotations:** `Internal::Types::Array[CloudPDF::Types::AnnotationRef]` 
     
 </dd>
 </dl>
@@ -4270,7 +4810,7 @@ client.doc.signatures.list(
 </dl>
 </details>
 
-<details><summary><code>client.doc.signatures.<a href="/lib/CloudPDF/doc/signatures/client.rb">abort</a>(doc_id:, layer_name:, signing_id:) -> CloudPDF::Types::DocSignaturesAbort200Response</code></summary>
+<details><summary><code>client.doc.signatures.<a href="/lib/CloudPDF/doc/signatures/client.rb">cancel</a>(doc_id:, layer_name:, signing_id:) -> CloudPDF::Types::DocSignaturesCancel200Response</code></summary>
 <dl>
 <dd>
 
@@ -4283,7 +4823,7 @@ client.doc.signatures.list(
 <dd>
 
 ```ruby
-client.doc.signatures.abort(
+client.doc.signatures.cancel(
   doc_id: "docId",
   layer_name: "layerName",
   signing_id: "signingId"
@@ -4574,7 +5114,7 @@ client.doc.signatures.analysis(
 <dl>
 <dd>
 
-The multipart envelope: a JSON `body` part (field, subFilter, digest, contentsSize, signer, certify, lock, appearance) and an optional `resource:<key>` PDF part the body's `appearance.resource` names. A certification (`certify.permission`) additionally requires `doc.sign.certify`. The layer is read-only until the signing completes, is aborted, or expires (15 minutes). A layer behind the document head cannot sign (StaleBase).
+Multipart: a JSON `body` part (field, subFilter, digest, contentsSize, signer, certify, lock), naming the appearance PDF it may carry as `resources: { appearance: '<key>' }`, and that PDF as the part `resource:<key>`. A certification (`certify.permission`) additionally requires `doc.sign.certify`. The layer is read-only until the signing completes, is cancelled, or expires (15 minutes). A layer behind the document head cannot sign (StaleBase).
 </dd>
 </dl>
 </dd>
@@ -5234,3 +5774,71 @@ client.doc.versions.signature_digest(
 </dl>
 </details>
 
+## Doc Metadata Custom
+<details><summary><code>client.doc.metadata.custom.<a href="/lib/CloudPDF/doc/metadata/custom/client.rb">get</a>(doc_id:, layer_name:) -> Internal::Types::Hash[String, String]</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.doc.metadata.custom.get(
+  doc_id: "docId",
+  layer_name: "layerName"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**doc_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**layer_name:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `CloudPDF::Doc::Metadata::Custom::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+