@cloudpdf/sdk 3.0.0-next.14 → 3.0.0-next.16

package/reference.md

@@ -89,6 +89,75 @@ await client.doc.head({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.doc.<a href="/src/api/resources/doc/client/Client.ts">changes</a>({ ...params }) -> CloudPDF.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>
+
+```typescript
+await client.doc.changes({
+    docId: "docId",
+    layerName: "layerName",
+    changes: [{
+            opId: "opId"
+        }]
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CloudPDF.DocChangesRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DocClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -227,7 +296,7 @@ Render parameters (viewport, format) pass as flat dotted query keys, e.g. `?view
 await client.doc.render({
     docId: "docId",
     layerName: "layerName",
-    pon: 1
+    pageKey: "pageKey"
 });
 
 ```
@@ -280,7 +349,7 @@ await client.doc.render({
 await client.doc.text({
     docId: "docId",
     layerName: "layerName",
-    pon: 1
+    pageKey: "pageKey"
 });
 
 ```
@@ -446,7 +515,7 @@ await client.shares.list({
 <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>
@@ -1709,7 +1778,7 @@ await 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>
@@ -1779,7 +1848,7 @@ await client.doc.annotations.listAll({
 await client.doc.annotations.list({
     docId: "docId",
     layerName: "layerName",
-    pon: 1
+    pageKey: "pageKey"
 });
 
 ```
@@ -1846,7 +1915,7 @@ Doc JWTs may instead carry collab scopes (annotations:create:self, …) that ref
 await client.doc.annotations.create({
     docId: "docId",
     layerName: "layerName",
-    pon: 1,
+    pageKey: "pageKey",
     body: {
         "key": "value"
     }
@@ -1902,7 +1971,7 @@ await client.doc.annotations.create({
 await client.doc.annotations.delete({
     docId: "docId",
     layerName: "layerName",
-    pon: 1,
+    pageKey: "pageKey",
     annotKey: "annotKey"
 });
 
@@ -1956,7 +2025,7 @@ await client.doc.annotations.delete({
 await client.doc.annotations.update({
     docId: "docId",
     layerName: "layerName",
-    pon: 1,
+    pageKey: "pageKey",
     annotKey: "annotKey",
     body: {
         "key": "value"
@@ -1997,7 +2066,7 @@ await client.doc.annotations.update({
 </dl>
 </details>
 
-<details><summary><code>client.doc.annotations.<a href="/src/api/resources/doc/resources/annotations/client/Client.ts">exportAppearance</a>({ ...params }) -> core.BinaryResponse</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/src/api/resources/doc/resources/annotations/client/Client.ts">readAppearance</a>({ ...params }) -> core.BinaryResponse</code></summary>
 <dl>
 <dd>
 
@@ -2010,15 +2079,11 @@ await client.doc.annotations.update({
 <dd>
 
 ```typescript
-await client.doc.annotations.exportAppearance({
+await client.doc.annotations.readAppearance({
     docId: "docId",
     layerName: "layerName",
-    pon: 1,
-    body: {
-        "string": {
-            "key": "value"
-        }
-    }
+    pageKey: "pageKey",
+    annotKey: "annotKey"
 });
 
 ```
@@ -2035,7 +2100,7 @@ await client.doc.annotations.exportAppearance({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ExportAppearanceAnnotationsRequest` 
+**request:** `CloudPDF.doc.ReadAppearanceAnnotationsRequest` 
     
 </dd>
 </dl>
@@ -2055,10 +2120,24 @@ await client.doc.annotations.exportAppearance({
 </dl>
 </details>
 
-<details><summary><code>client.doc.annotations.<a href="/src/api/resources/doc/resources/annotations/client/Client.ts">flatten</a>({ ...params }) -> CloudPDF.DocAnnotationsFlatten200Response</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/src/api/resources/doc/resources/annotations/client/Client.ts">readFile</a>({ ...params }) -> core.BinaryResponse</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>
@@ -2068,13 +2147,11 @@ await client.doc.annotations.exportAppearance({
 <dd>
 
 ```typescript
-await client.doc.annotations.flatten({
+await client.doc.annotations.readFile({
     docId: "docId",
     layerName: "layerName",
-    pon: 1,
-    body: {
-        "key": "value"
-    }
+    pageKey: "pageKey",
+    annotKey: "annotKey"
 });
 
 ```
@@ -2091,7 +2168,7 @@ await client.doc.annotations.flatten({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.FlattenAnnotationsRequest` 
+**request:** `CloudPDF.doc.ReadFileAnnotationsRequest` 
     
 </dd>
 </dl>
@@ -2111,8 +2188,7 @@ await client.doc.annotations.flatten({
 </dl>
 </details>
 
-## Doc Forms
-<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">get</a>({ ...params }) -> CloudPDF.DocFormsGet200Response</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/src/api/resources/doc/resources/annotations/client/Client.ts">exportAppearance</a>({ ...params }) -> core.BinaryResponse</code></summary>
 <dl>
 <dd>
 
@@ -2125,9 +2201,15 @@ await client.doc.annotations.flatten({
 <dd>
 
 ```typescript
-await client.doc.forms.get({
+await client.doc.annotations.exportAppearance({
     docId: "docId",
-    layerName: "layerName"
+    layerName: "layerName",
+    pageKey: "pageKey",
+    body: {
+        "string": {
+            "key": "value"
+        }
+    }
 });
 
 ```
@@ -2144,7 +2226,7 @@ await client.doc.forms.get({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.GetFormsRequest` 
+**request:** `CloudPDF.doc.ExportAppearanceAnnotationsRequest` 
     
 </dd>
 </dl>
@@ -2152,7 +2234,7 @@ await client.doc.forms.get({
 <dl>
 <dd>
 
-**requestOptions:** `FormsClient.RequestOptions` 
+**requestOptions:** `AnnotationsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2164,7 +2246,7 @@ await client.doc.forms.get({
 </dl>
 </details>
 
-<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">exportData</a>({ ...params }) -> core.BinaryResponse</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/src/api/resources/doc/resources/annotations/client/Client.ts">flatten</a>({ ...params }) -> CloudPDF.DocAnnotationsFlatten200Response</code></summary>
 <dl>
 <dd>
 
@@ -2177,9 +2259,13 @@ await client.doc.forms.get({
 <dd>
 
 ```typescript
-await client.doc.forms.exportData({
+await client.doc.annotations.flatten({
     docId: "docId",
-    layerName: "layerName"
+    layerName: "layerName",
+    pageKey: "pageKey",
+    body: {
+        "key": "value"
+    }
 });
 
 ```
@@ -2196,7 +2282,7 @@ await client.doc.forms.exportData({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ExportDataFormsRequest` 
+**request:** `CloudPDF.doc.FlattenAnnotationsRequest` 
     
 </dd>
 </dl>
@@ -2204,7 +2290,7 @@ await client.doc.forms.exportData({
 <dl>
 <dd>
 
-**requestOptions:** `FormsClient.RequestOptions` 
+**requestOptions:** `AnnotationsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2216,7 +2302,7 @@ await client.doc.forms.exportData({
 </dl>
 </details>
 
-<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">importData</a>({ ...params }) -> CloudPDF.DocFormsImportData200Response</code></summary>
+<details><summary><code>client.doc.annotations.<a href="/src/api/resources/doc/resources/annotations/client/Client.ts">reorder</a>({ ...params }) -> CloudPDF.DocAnnotationsReorder200Response</code></summary>
 <dl>
 <dd>
 
@@ -2229,12 +2315,19 @@ await client.doc.forms.exportData({
 <dd>
 
 ```typescript
-await client.doc.forms.importData({
+await client.doc.annotations.reorder({
     docId: "docId",
     layerName: "layerName",
-    body: {
-        "key": "value"
-    }
+    pageKey: "pageKey",
+    refs: [{
+            kind: "objectNumber",
+            page: {
+                kind: "objectNumber",
+                objectNumber: 1
+            },
+            objectNumber: 1
+        }],
+    position: "start"
 });
 
 ```
@@ -2251,7 +2344,7 @@ await client.doc.forms.importData({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ImportDataFormsRequest` 
+**request:** `CloudPDF.doc.DocAnnotationsReorderRequest` 
     
 </dd>
 </dl>
@@ -2259,7 +2352,7 @@ await client.doc.forms.importData({
 <dl>
 <dd>
 
-**requestOptions:** `FormsClient.RequestOptions` 
+**requestOptions:** `AnnotationsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2271,10 +2364,25 @@ await client.doc.forms.importData({
 </dl>
 </details>
 
-<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">reset</a>({ ...params }) -> CloudPDF.DocFormsReset200Response</code></summary>
+## Doc Attachments
+<details><summary><code>client.doc.attachments.<a href="/src/api/resources/doc/resources/attachments/client/Client.ts">download</a>({ ...params }) -> core.BinaryResponse</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>
@@ -2284,10 +2392,10 @@ await client.doc.forms.importData({
 <dd>
 
 ```typescript
-await client.doc.forms.reset({
+await client.doc.attachments.download({
     docId: "docId",
     layerName: "layerName",
-    fieldKey: "fieldKey"
+    fileKey: "fileKey"
 });
 
 ```
@@ -2304,7 +2412,7 @@ await client.doc.forms.reset({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ResetFormsRequest` 
+**request:** `CloudPDF.doc.DownloadAttachmentsRequest` 
     
 </dd>
 </dl>
@@ -2312,7 +2420,7 @@ await client.doc.forms.reset({
 <dl>
 <dd>
 
-**requestOptions:** `FormsClient.RequestOptions` 
+**requestOptions:** `AttachmentsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2324,10 +2432,24 @@ await client.doc.forms.reset({
 </dl>
 </details>
 
-<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">setValue</a>({ ...params }) -> CloudPDF.DocFormsSetValue200Response</code></summary>
+<details><summary><code>client.doc.attachments.<a href="/src/api/resources/doc/resources/attachments/client/Client.ts">list</a>({ ...params }) -> CloudPDF.DocAttachmentsList200Response</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>
@@ -2337,13 +2459,9 @@ await client.doc.forms.reset({
 <dd>
 
 ```typescript
-await client.doc.forms.setValue({
+await client.doc.attachments.list({
     docId: "docId",
-    layerName: "layerName",
-    fieldKey: "fieldKey",
-    body: {
-        "key": "value"
-    }
+    layerName: "layerName"
 });
 
 ```
@@ -2360,7 +2478,7 @@ await client.doc.forms.setValue({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.SetValueFormsRequest` 
+**request:** `CloudPDF.doc.ListAttachmentsRequest` 
     
 </dd>
 </dl>
@@ -2368,7 +2486,7 @@ await client.doc.forms.setValue({
 <dl>
 <dd>
 
-**requestOptions:** `FormsClient.RequestOptions` 
+**requestOptions:** `AttachmentsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2380,8 +2498,8 @@ await client.doc.forms.setValue({
 </dl>
 </details>
 
-## Doc Metadata
-<details><summary><code>client.doc.metadata.<a href="/src/api/resources/doc/resources/metadata/client/Client.ts">get</a>({ ...params }) -> CloudPDF.DocMetadataGet200Response</code></summary>
+## Doc Forms
+<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">list</a>({ ...params }) -> CloudPDF.DocFormsList200Response</code></summary>
 <dl>
 <dd>
 
@@ -2394,7 +2512,7 @@ await client.doc.forms.setValue({
 <dd>
 
 ```typescript
-await client.doc.metadata.get({
+await client.doc.forms.list({
     docId: "docId",
     layerName: "layerName"
 });
@@ -2413,7 +2531,7 @@ await client.doc.metadata.get({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.GetMetadataRequest` 
+**request:** `CloudPDF.doc.ListFormsRequest` 
     
 </dd>
 </dl>
@@ -2421,7 +2539,7 @@ await client.doc.metadata.get({
 <dl>
 <dd>
 
-**requestOptions:** `MetadataClient.RequestOptions` 
+**requestOptions:** `FormsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2433,8 +2551,7 @@ await client.doc.metadata.get({
 </dl>
 </details>
 
-## Doc Pages
-<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">setScale</a>({ ...params }) -> CloudPDF.DocPagesSetScale200Response</code></summary>
+<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">reorderCalculations</a>({ ...params }) -> CloudPDF.DocFormsReorderCalculations200Response</code></summary>
 <dl>
 <dd>
 
@@ -2447,10 +2564,14 @@ await client.doc.metadata.get({
 <dd>
 
 ```typescript
-await client.doc.pages.setScale({
+await client.doc.forms.reorderCalculations({
     docId: "docId",
     layerName: "layerName",
-    pon: 1
+    fields: [{
+            kind: "objectNumber",
+            objectNumber: 1
+        }],
+    position: "start"
 });
 
 ```
@@ -2467,7 +2588,7 @@ await client.doc.pages.setScale({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.DocPagesSetScaleRequest` 
+**request:** `CloudPDF.doc.DocFormsReorderCalculationsRequest` 
     
 </dd>
 </dl>
@@ -2475,7 +2596,7 @@ await client.doc.pages.setScale({
 <dl>
 <dd>
 
-**requestOptions:** `PagesClient.RequestOptions` 
+**requestOptions:** `FormsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2487,7 +2608,7 @@ await client.doc.pages.setScale({
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">viewports</a>({ ...params }) -> CloudPDF.DocPagesViewports200Response</code></summary>
+<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">setValue</a>({ ...params }) -> CloudPDF.DocFormsSetValue200Response</code></summary>
 <dl>
 <dd>
 
@@ -2500,10 +2621,13 @@ await client.doc.pages.setScale({
 <dd>
 
 ```typescript
-await client.doc.pages.viewports({
+await client.doc.forms.setValue({
     docId: "docId",
     layerName: "layerName",
-    pon: 1
+    fieldKey: "fieldKey",
+    body: {
+        "key": "value"
+    }
 });
 
 ```
@@ -2520,7 +2644,7 @@ await client.doc.pages.viewports({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ViewportsPagesRequest` 
+**request:** `CloudPDF.doc.SetValueFormsRequest` 
     
 </dd>
 </dl>
@@ -2528,7 +2652,7 @@ await client.doc.pages.viewports({
 <dl>
 <dd>
 
-**requestOptions:** `PagesClient.RequestOptions` 
+**requestOptions:** `FormsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2540,7 +2664,7 @@ await client.doc.pages.viewports({
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">delete</a>({ ...params }) -> CloudPDF.DocPagesDelete200Response</code></summary>
+<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">reset</a>({ ...params }) -> CloudPDF.DocFormsReset200Response</code></summary>
 <dl>
 <dd>
 
@@ -2553,12 +2677,9 @@ await client.doc.pages.viewports({
 <dd>
 
 ```typescript
-await client.doc.pages.delete({
+await client.doc.forms.reset({
     docId: "docId",
-    layerName: "layerName",
-    body: {
-        "key": "value"
-    }
+    layerName: "layerName"
 });
 
 ```
@@ -2575,7 +2696,7 @@ await client.doc.pages.delete({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.DeletePagesRequest` 
+**request:** `CloudPDF.doc.DocFormsResetRequest` 
     
 </dd>
 </dl>
@@ -2583,7 +2704,7 @@ await client.doc.pages.delete({
 <dl>
 <dd>
 
-**requestOptions:** `PagesClient.RequestOptions` 
+**requestOptions:** `FormsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2595,11 +2716,11 @@ await client.doc.pages.delete({
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">extract</a>({ ...params }) -> core.BinaryResponse</code></summary>
+<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">deleteWidget</a>({ ...params }) -> CloudPDF.DocFormsDeleteWidget200Response</code></summary>
 <dl>
 <dd>
 
-#### 📝 Description
+#### 🔌 Usage
 
 <dl>
 <dd>
@@ -2607,12 +2728,52 @@ await client.doc.pages.delete({
 <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.
+```typescript
+await client.doc.forms.deleteWidget({
+    docId: "docId",
+    layerName: "layerName",
+    pageKey: "pageKey",
+    annotKey: "annotKey"
+});
+
+```
 </dd>
 </dl>
 </dd>
 </dl>
 
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CloudPDF.doc.DeleteWidgetFormsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `FormsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">updateWidget</a>({ ...params }) -> CloudPDF.DocFormsUpdateWidget200Response</code></summary>
+<dl>
+<dd>
+
 #### 🔌 Usage
 
 <dl>
@@ -2622,14 +2783,12 @@ A read, not a mutation: the source document is untouched and no event is publish
 <dd>
 
 ```typescript
-await client.doc.pages.extract({
+await client.doc.forms.updateWidget({
     docId: "docId",
     layerName: "layerName",
-    body: {
-        "string": {
-            "key": "value"
-        }
-    }
+    pageKey: "pageKey",
+    annotKey: "annotKey",
+    patch: {}
 });
 
 ```
@@ -2646,7 +2805,7 @@ await client.doc.pages.extract({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ExtractPagesRequest` 
+**request:** `CloudPDF.doc.DocFormsUpdateWidgetRequest` 
     
 </dd>
 </dl>
@@ -2654,7 +2813,7 @@ await client.doc.pages.extract({
 <dl>
 <dd>
 
-**requestOptions:** `PagesClient.RequestOptions` 
+**requestOptions:** `FormsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2666,7 +2825,7 @@ await client.doc.pages.extract({
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">flatten</a>({ ...params }) -> CloudPDF.DocPagesFlatten200Response</code></summary>
+<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">reorderWidgets</a>({ ...params }) -> CloudPDF.DocFormsReorderWidgets200Response</code></summary>
 <dl>
 <dd>
 
@@ -2679,12 +2838,19 @@ await client.doc.pages.extract({
 <dd>
 
 ```typescript
-await client.doc.pages.flatten({
+await client.doc.forms.reorderWidgets({
     docId: "docId",
     layerName: "layerName",
-    body: {
-        "key": "value"
-    }
+    pageKey: "pageKey",
+    widgets: [{
+            kind: "objectNumber",
+            page: {
+                kind: "objectNumber",
+                objectNumber: 1
+            },
+            objectNumber: 1
+        }],
+    position: "start"
 });
 
 ```
@@ -2701,7 +2867,7 @@ await client.doc.pages.flatten({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.FlattenPagesRequest` 
+**request:** `CloudPDF.doc.DocFormsReorderWidgetsRequest` 
     
 </dd>
 </dl>
@@ -2709,7 +2875,7 @@ await client.doc.pages.flatten({
 <dl>
 <dd>
 
-**requestOptions:** `PagesClient.RequestOptions` 
+**requestOptions:** `FormsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2721,11 +2887,32 @@ await client.doc.pages.flatten({
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">insert</a>({ ...params }) -> CloudPDF.DocPagesInsert200Response</code></summary>
+## Doc Metadata
+<details><summary><code>client.doc.metadata.<a href="/src/api/resources/doc/resources/metadata/client/Client.ts">get</a>({ ...params }) -> CloudPDF.DocMetadataGet200Response</code></summary>
 <dl>
 <dd>
 
-#### 📝 Description
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.doc.metadata.get({
+    docId: "docId",
+    layerName: "layerName"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
 
 <dl>
 <dd>
@@ -2733,11 +2920,30 @@ await 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.
+**request:** `CloudPDF.doc.GetMetadataRequest` 
+    
 </dd>
 </dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `MetadataClient.RequestOptions` 
+    
 </dd>
 </dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## Doc Outline
+<details><summary><code>client.doc.outline.<a href="/src/api/resources/doc/resources/outline/client/Client.ts">get</a>({ ...params }) -> CloudPDF.DocOutlineGet200Response</code></summary>
+<dl>
+<dd>
 
 #### 🔌 Usage
 
@@ -2748,8 +2954,7 @@ Multipart mutation envelope: a `body` field holding `{"destIndex"?: number}` (om
 <dd>
 
 ```typescript
-await client.doc.pages.insert({
-    file: fs.createReadStream("/path/to/your/file"),
+await client.doc.outline.get({
     docId: "docId",
     layerName: "layerName"
 });
@@ -2768,7 +2973,7 @@ await client.doc.pages.insert({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.InsertPagesRequest` 
+**request:** `CloudPDF.doc.GetOutlineRequest` 
     
 </dd>
 </dl>
@@ -2776,7 +2981,7 @@ await client.doc.pages.insert({
 <dl>
 <dd>
 
-**requestOptions:** `PagesClient.RequestOptions` 
+**requestOptions:** `OutlineClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2788,11 +2993,12 @@ await client.doc.pages.insert({
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">insertBlank</a>({ ...params }) -> CloudPDF.DocPagesInsertBlank200Response</code></summary>
+## Doc Pages
+<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">setScale</a>({ ...params }) -> CloudPDF.DocPagesSetScale200Response</code></summary>
 <dl>
 <dd>
 
-#### 📝 Description
+#### 🔌 Usage
 
 <dl>
 <dd>
@@ -2800,12 +3006,51 @@ await client.doc.pages.insert({
 <dl>
 <dd>
 
-Body is `{"size": {"width", "height"}, "count"?, "destIndex"?}` — size in PDF points, count in [1, 100], destIndex omitted → append.
+```typescript
+await client.doc.pages.setScale({
+    docId: "docId",
+    layerName: "layerName",
+    pageKey: "pageKey"
+});
+
+```
 </dd>
 </dl>
 </dd>
 </dl>
 
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CloudPDF.doc.DocPagesSetScaleRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PagesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">viewports</a>({ ...params }) -> CloudPDF.DocPagesViewports200Response</code></summary>
+<dl>
+<dd>
+
 #### 🔌 Usage
 
 <dl>
@@ -2815,12 +3060,10 @@ Body is `{"size": {"width", "height"}, "count"?, "destIndex"?}` — size in PDF
 <dd>
 
 ```typescript
-await client.doc.pages.insertBlank({
+await client.doc.pages.viewports({
     docId: "docId",
     layerName: "layerName",
-    body: {
-        "key": "value"
-    }
+    pageKey: "pageKey"
 });
 
 ```
@@ -2837,7 +3080,7 @@ await client.doc.pages.insertBlank({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.InsertBlankPagesRequest` 
+**request:** `CloudPDF.doc.ViewportsPagesRequest` 
     
 </dd>
 </dl>
@@ -2857,10 +3100,24 @@ await client.doc.pages.insertBlank({
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">move</a>({ ...params }) -> CloudPDF.DocPagesMove200Response</code></summary>
+<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">extract</a>({ ...params }) -> core.BinaryResponse</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>
@@ -2870,11 +3127,13 @@ await client.doc.pages.insertBlank({
 <dd>
 
 ```typescript
-await client.doc.pages.move({
+await client.doc.pages.extract({
     docId: "docId",
     layerName: "layerName",
     body: {
-        "key": "value"
+        "string": {
+            "key": "value"
+        }
     }
 });
 
@@ -2892,7 +3151,7 @@ await client.doc.pages.move({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.MovePagesRequest` 
+**request:** `CloudPDF.doc.ExtractPagesRequest` 
     
 </dd>
 </dl>
@@ -2912,7 +3171,7 @@ await client.doc.pages.move({
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">setName</a>({ ...params }) -> CloudPDF.DocPagesSetName200Response</code></summary>
+<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">flatten</a>({ ...params }) -> CloudPDF.DocPagesFlatten200Response</code></summary>
 <dl>
 <dd>
 
@@ -2925,7 +3184,7 @@ await client.doc.pages.move({
 <dd>
 
 ```typescript
-await client.doc.pages.setName({
+await client.doc.pages.flatten({
     docId: "docId",
     layerName: "layerName",
     body: {
@@ -2947,7 +3206,7 @@ await client.doc.pages.setName({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.SetNamePagesRequest` 
+**request:** `CloudPDF.doc.FlattenPagesRequest` 
     
 </dd>
 </dl>
@@ -2967,7 +3226,7 @@ await client.doc.pages.setName({
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">removeName</a>({ ...params }) -> CloudPDF.DocPagesRemoveName200Response</code></summary>
+<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">setName</a>({ ...params }) -> CloudPDF.DocPagesSetName200Response</code></summary>
 <dl>
 <dd>
 
@@ -2980,7 +3239,7 @@ await client.doc.pages.setName({
 <dd>
 
 ```typescript
-await client.doc.pages.removeName({
+await client.doc.pages.setName({
     docId: "docId",
     layerName: "layerName",
     body: {
@@ -3002,7 +3261,7 @@ await client.doc.pages.removeName({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.RemoveNamePagesRequest` 
+**request:** `CloudPDF.doc.SetNamePagesRequest` 
     
 </dd>
 </dl>
@@ -3022,7 +3281,7 @@ await client.doc.pages.removeName({
 </dl>
 </details>
 
-<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">rotate</a>({ ...params }) -> CloudPDF.DocPagesRotate200Response</code></summary>
+<details><summary><code>client.doc.pages.<a href="/src/api/resources/doc/resources/pages/client/Client.ts">removeName</a>({ ...params }) -> CloudPDF.DocPagesRemoveName200Response</code></summary>
 <dl>
 <dd>
 
@@ -3035,7 +3294,7 @@ await client.doc.pages.removeName({
 <dd>
 
 ```typescript
-await client.doc.pages.rotate({
+await client.doc.pages.removeName({
     docId: "docId",
     layerName: "layerName",
     body: {
@@ -3057,7 +3316,7 @@ await client.doc.pages.rotate({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.RotatePagesRequest` 
+**request:** `CloudPDF.doc.RemoveNamePagesRequest` 
     
 </dd>
 </dl>
@@ -3093,10 +3352,7 @@ await client.doc.pages.rotate({
 ```typescript
 await client.doc.redactions.apply({
     docId: "docId",
-    layerName: "layerName",
-    body: {
-        "key": "value"
-    }
+    layerName: "layerName"
 });
 
 ```
@@ -3113,7 +3369,7 @@ await client.doc.redactions.apply({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ApplyRedactionsRequest` 
+**request:** `CloudPDF.doc.DocRedactionsApplyRequest` 
     
 </dd>
 </dl>
@@ -3200,7 +3456,7 @@ await client.doc.signatures.list({
 </dl>
 </details>
 
-<details><summary><code>client.doc.signatures.<a href="/src/api/resources/doc/resources/signatures/client/Client.ts">abort</a>({ ...params }) -> CloudPDF.DocSignaturesAbort200Response</code></summary>
+<details><summary><code>client.doc.signatures.<a href="/src/api/resources/doc/resources/signatures/client/Client.ts">cancel</a>({ ...params }) -> CloudPDF.DocSignaturesCancel200Response</code></summary>
 <dl>
 <dd>
 
@@ -3213,7 +3469,7 @@ await client.doc.signatures.list({
 <dd>
 
 ```typescript
-await client.doc.signatures.abort({
+await client.doc.signatures.cancel({
     docId: "docId",
     layerName: "layerName",
     signingId: "signingId"
@@ -3233,7 +3489,7 @@ await client.doc.signatures.abort({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.AbortSignaturesRequest` 
+**request:** `CloudPDF.doc.CancelSignaturesRequest` 
     
 </dd>
 </dl>
@@ -3403,7 +3659,7 @@ await 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>
@@ -3882,3 +4138,56 @@ await client.doc.versions.signatureDigest({
 </dl>
 </details>
 
+## Doc Metadata Custom
+<details><summary><code>client.doc.metadata.custom.<a href="/src/api/resources/doc/resources/metadata/resources/custom/client/Client.ts">get</a>({ ...params }) -> CloudPDF.DocMetadataCustomGet200Response</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.doc.metadata.custom.get({
+    docId: "docId",
+    layerName: "layerName"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CloudPDF.doc.metadata.GetCustomRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CustomClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+