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

package/reference.md

@@ -105,7 +105,7 @@ await client.doc.head({
 <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`. Bytes (a stamp's drawing, an attached file, a signature's artwork) 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.
+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>
@@ -2120,10 +2120,24 @@ await client.doc.annotations.readAppearance({
 </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">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>
@@ -2133,15 +2147,11 @@ await client.doc.annotations.readAppearance({
 <dd>
 
 ```typescript
-await client.doc.annotations.exportAppearance({
+await client.doc.annotations.readFile({
     docId: "docId",
     layerName: "layerName",
     pageKey: "pageKey",
-    body: {
-        "string": {
-            "key": "value"
-        }
-    }
+    annotKey: "annotKey"
 });
 
 ```
@@ -2158,7 +2168,7 @@ await client.doc.annotations.exportAppearance({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ExportAppearanceAnnotationsRequest` 
+**request:** `CloudPDF.doc.ReadFileAnnotationsRequest` 
     
 </dd>
 </dl>
@@ -2178,7 +2188,7 @@ 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">exportAppearance</a>({ ...params }) -> core.BinaryResponse</code></summary>
 <dl>
 <dd>
 
@@ -2191,12 +2201,14 @@ await client.doc.annotations.exportAppearance({
 <dd>
 
 ```typescript
-await client.doc.annotations.flatten({
+await client.doc.annotations.exportAppearance({
     docId: "docId",
     layerName: "layerName",
     pageKey: "pageKey",
     body: {
-        "key": "value"
+        "string": {
+            "key": "value"
+        }
     }
 });
 
@@ -2214,7 +2226,7 @@ await client.doc.annotations.flatten({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.FlattenAnnotationsRequest` 
+**request:** `CloudPDF.doc.ExportAppearanceAnnotationsRequest` 
     
 </dd>
 </dl>
@@ -2234,7 +2246,7 @@ await client.doc.annotations.flatten({
 </dl>
 </details>
 
-<details><summary><code>client.doc.annotations.<a href="/src/api/resources/doc/resources/annotations/client/Client.ts">reorder</a>({ ...params }) -> CloudPDF.DocAnnotationsReorder200Response</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>
 
@@ -2247,19 +2259,13 @@ await client.doc.annotations.flatten({
 <dd>
 
 ```typescript
-await client.doc.annotations.reorder({
+await client.doc.annotations.flatten({
     docId: "docId",
     layerName: "layerName",
     pageKey: "pageKey",
-    refs: [{
-            kind: "objectNumber",
-            page: {
-                kind: "objectNumber",
-                objectNumber: 1
-            },
-            objectNumber: 1
-        }],
-    position: "start"
+    body: {
+        "key": "value"
+    }
 });
 
 ```
@@ -2276,7 +2282,7 @@ await client.doc.annotations.reorder({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.DocAnnotationsReorderRequest` 
+**request:** `CloudPDF.doc.FlattenAnnotationsRequest` 
     
 </dd>
 </dl>
@@ -2296,8 +2302,7 @@ await client.doc.annotations.reorder({
 </dl>
 </details>
 
-## 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>
+<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>
 
@@ -2310,9 +2315,19 @@ await client.doc.annotations.reorder({
 <dd>
 
 ```typescript
-await client.doc.forms.list({
+await client.doc.annotations.reorder({
     docId: "docId",
-    layerName: "layerName"
+    layerName: "layerName",
+    pageKey: "pageKey",
+    refs: [{
+            kind: "objectNumber",
+            page: {
+                kind: "objectNumber",
+                objectNumber: 1
+            },
+            objectNumber: 1
+        }],
+    position: "start"
 });
 
 ```
@@ -2329,7 +2344,7 @@ await client.doc.forms.list({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ListFormsRequest` 
+**request:** `CloudPDF.doc.DocAnnotationsReorderRequest` 
     
 </dd>
 </dl>
@@ -2337,7 +2352,7 @@ await client.doc.forms.list({
 <dl>
 <dd>
 
-**requestOptions:** `FormsClient.RequestOptions` 
+**requestOptions:** `AnnotationsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2349,10 +2364,25 @@ await client.doc.forms.list({
 </dl>
 </details>
 
-<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">reorderCalculations</a>({ ...params }) -> CloudPDF.DocFormsReorderCalculations200Response</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>
@@ -2362,14 +2392,10 @@ await client.doc.forms.list({
 <dd>
 
 ```typescript
-await client.doc.forms.reorderCalculations({
+await client.doc.attachments.download({
     docId: "docId",
     layerName: "layerName",
-    fields: [{
-            kind: "objectNumber",
-            objectNumber: 1
-        }],
-    position: "start"
+    fileKey: "fileKey"
 });
 
 ```
@@ -2386,7 +2412,7 @@ await client.doc.forms.reorderCalculations({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.DocFormsReorderCalculationsRequest` 
+**request:** `CloudPDF.doc.DownloadAttachmentsRequest` 
     
 </dd>
 </dl>
@@ -2394,7 +2420,7 @@ await client.doc.forms.reorderCalculations({
 <dl>
 <dd>
 
-**requestOptions:** `FormsClient.RequestOptions` 
+**requestOptions:** `AttachmentsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2406,10 +2432,24 @@ await client.doc.forms.reorderCalculations({
 </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>
@@ -2419,13 +2459,9 @@ await client.doc.forms.reorderCalculations({
 <dd>
 
 ```typescript
-await client.doc.forms.setValue({
+await client.doc.attachments.list({
     docId: "docId",
-    layerName: "layerName",
-    fieldKey: "fieldKey",
-    body: {
-        "key": "value"
-    }
+    layerName: "layerName"
 });
 
 ```
@@ -2442,7 +2478,7 @@ await client.doc.forms.setValue({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.SetValueFormsRequest` 
+**request:** `CloudPDF.doc.ListAttachmentsRequest` 
     
 </dd>
 </dl>
@@ -2450,7 +2486,7 @@ await client.doc.forms.setValue({
 <dl>
 <dd>
 
-**requestOptions:** `FormsClient.RequestOptions` 
+**requestOptions:** `AttachmentsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2462,7 +2498,8 @@ await client.doc.forms.setValue({
 </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 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>
 
@@ -2475,7 +2512,7 @@ await client.doc.forms.setValue({
 <dd>
 
 ```typescript
-await client.doc.forms.reset({
+await client.doc.forms.list({
     docId: "docId",
     layerName: "layerName"
 });
@@ -2494,7 +2531,7 @@ await client.doc.forms.reset({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.DocFormsResetRequest` 
+**request:** `CloudPDF.doc.ListFormsRequest` 
     
 </dd>
 </dl>
@@ -2514,7 +2551,7 @@ await client.doc.forms.reset({
 </dl>
 </details>
 
-<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">deleteWidget</a>({ ...params }) -> CloudPDF.DocFormsDeleteWidget200Response</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>
 
@@ -2527,11 +2564,14 @@ await client.doc.forms.reset({
 <dd>
 
 ```typescript
-await client.doc.forms.deleteWidget({
+await client.doc.forms.reorderCalculations({
     docId: "docId",
     layerName: "layerName",
-    pageKey: "pageKey",
-    annotKey: "annotKey"
+    fields: [{
+            kind: "objectNumber",
+            objectNumber: 1
+        }],
+    position: "start"
 });
 
 ```
@@ -2548,7 +2588,7 @@ await client.doc.forms.deleteWidget({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.DeleteWidgetFormsRequest` 
+**request:** `CloudPDF.doc.DocFormsReorderCalculationsRequest` 
     
 </dd>
 </dl>
@@ -2568,7 +2608,7 @@ await client.doc.forms.deleteWidget({
 </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>
+<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>
 
@@ -2581,12 +2621,13 @@ await client.doc.forms.deleteWidget({
 <dd>
 
 ```typescript
-await client.doc.forms.updateWidget({
+await client.doc.forms.setValue({
     docId: "docId",
     layerName: "layerName",
-    pageKey: "pageKey",
-    annotKey: "annotKey",
-    patch: {}
+    fieldKey: "fieldKey",
+    body: {
+        "key": "value"
+    }
 });
 
 ```
@@ -2603,7 +2644,7 @@ await client.doc.forms.updateWidget({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.DocFormsUpdateWidgetRequest` 
+**request:** `CloudPDF.doc.SetValueFormsRequest` 
     
 </dd>
 </dl>
@@ -2623,7 +2664,7 @@ await client.doc.forms.updateWidget({
 </dl>
 </details>
 
-<details><summary><code>client.doc.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">reorderWidgets</a>({ ...params }) -> CloudPDF.DocFormsReorderWidgets200Response</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>
 
@@ -2636,19 +2677,9 @@ await client.doc.forms.updateWidget({
 <dd>
 
 ```typescript
-await client.doc.forms.reorderWidgets({
+await client.doc.forms.reset({
     docId: "docId",
-    layerName: "layerName",
-    pageKey: "pageKey",
-    widgets: [{
-            kind: "objectNumber",
-            page: {
-                kind: "objectNumber",
-                objectNumber: 1
-            },
-            objectNumber: 1
-        }],
-    position: "start"
+    layerName: "layerName"
 });
 
 ```
@@ -2665,7 +2696,7 @@ await client.doc.forms.reorderWidgets({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.DocFormsReorderWidgetsRequest` 
+**request:** `CloudPDF.doc.DocFormsResetRequest` 
     
 </dd>
 </dl>
@@ -2685,8 +2716,7 @@ await client.doc.forms.reorderWidgets({
 </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>
+<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>
 
@@ -2699,9 +2729,11 @@ await client.doc.forms.reorderWidgets({
 <dd>
 
 ```typescript
-await client.doc.metadata.get({
+await client.doc.forms.deleteWidget({
     docId: "docId",
-    layerName: "layerName"
+    layerName: "layerName",
+    pageKey: "pageKey",
+    annotKey: "annotKey"
 });
 
 ```
@@ -2718,7 +2750,7 @@ await client.doc.metadata.get({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.GetMetadataRequest` 
+**request:** `CloudPDF.doc.DeleteWidgetFormsRequest` 
     
 </dd>
 </dl>
@@ -2726,7 +2758,7 @@ await client.doc.metadata.get({
 <dl>
 <dd>
 
-**requestOptions:** `MetadataClient.RequestOptions` 
+**requestOptions:** `FormsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2738,8 +2770,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">updateWidget</a>({ ...params }) -> CloudPDF.DocFormsUpdateWidget200Response</code></summary>
 <dl>
 <dd>
 
@@ -2752,10 +2783,12 @@ await client.doc.metadata.get({
 <dd>
 
 ```typescript
-await client.doc.pages.setScale({
+await client.doc.forms.updateWidget({
     docId: "docId",
     layerName: "layerName",
-    pageKey: "pageKey"
+    pageKey: "pageKey",
+    annotKey: "annotKey",
+    patch: {}
 });
 
 ```
@@ -2772,7 +2805,7 @@ await client.doc.pages.setScale({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.DocPagesSetScaleRequest` 
+**request:** `CloudPDF.doc.DocFormsUpdateWidgetRequest` 
     
 </dd>
 </dl>
@@ -2780,7 +2813,7 @@ await client.doc.pages.setScale({
 <dl>
 <dd>
 
-**requestOptions:** `PagesClient.RequestOptions` 
+**requestOptions:** `FormsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2792,7 +2825,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">reorderWidgets</a>({ ...params }) -> CloudPDF.DocFormsReorderWidgets200Response</code></summary>
 <dl>
 <dd>
 
@@ -2805,10 +2838,19 @@ await client.doc.pages.setScale({
 <dd>
 
 ```typescript
-await client.doc.pages.viewports({
+await client.doc.forms.reorderWidgets({
     docId: "docId",
     layerName: "layerName",
-    pageKey: "pageKey"
+    pageKey: "pageKey",
+    widgets: [{
+            kind: "objectNumber",
+            page: {
+                kind: "objectNumber",
+                objectNumber: 1
+            },
+            objectNumber: 1
+        }],
+    position: "start"
 });
 
 ```
@@ -2825,7 +2867,7 @@ await client.doc.pages.viewports({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ViewportsPagesRequest` 
+**request:** `CloudPDF.doc.DocFormsReorderWidgetsRequest` 
     
 </dd>
 </dl>
@@ -2833,7 +2875,7 @@ await client.doc.pages.viewports({
 <dl>
 <dd>
 
-**requestOptions:** `PagesClient.RequestOptions` 
+**requestOptions:** `FormsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2845,7 +2887,8 @@ 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>
+## 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>
 
@@ -2858,12 +2901,9 @@ await client.doc.pages.viewports({
 <dd>
 
 ```typescript
-await client.doc.pages.delete({
+await client.doc.metadata.get({
     docId: "docId",
-    layerName: "layerName",
-    body: {
-        "key": "value"
-    }
+    layerName: "layerName"
 });
 
 ```
@@ -2880,7 +2920,7 @@ await client.doc.pages.delete({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.DeletePagesRequest` 
+**request:** `CloudPDF.doc.GetMetadataRequest` 
     
 </dd>
 </dl>
@@ -2888,7 +2928,7 @@ await client.doc.pages.delete({
 <dl>
 <dd>
 
-**requestOptions:** `PagesClient.RequestOptions` 
+**requestOptions:** `MetadataClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2900,24 +2940,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>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
+## 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>
 
-A read, not a mutation: the source document is untouched and no event is published. Body is `{"pages": PageRef[]}`; the response body is the new PDF.
-</dd>
-</dl>
-</dd>
-</dl>
-
 #### 🔌 Usage
 
 <dl>
@@ -2927,14 +2954,9 @@ 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.outline.get({
     docId: "docId",
-    layerName: "layerName",
-    body: {
-        "string": {
-            "key": "value"
-        }
-    }
+    layerName: "layerName"
 });
 
 ```
@@ -2951,7 +2973,7 @@ await client.doc.pages.extract({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ExtractPagesRequest` 
+**request:** `CloudPDF.doc.GetOutlineRequest` 
     
 </dd>
 </dl>
@@ -2959,7 +2981,7 @@ await client.doc.pages.extract({
 <dl>
 <dd>
 
-**requestOptions:** `PagesClient.RequestOptions` 
+**requestOptions:** `OutlineClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2971,7 +2993,8 @@ 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>
+## 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>
 
@@ -2984,12 +3007,10 @@ await client.doc.pages.extract({
 <dd>
 
 ```typescript
-await client.doc.pages.flatten({
+await client.doc.pages.setScale({
     docId: "docId",
     layerName: "layerName",
-    body: {
-        "key": "value"
-    }
+    pageKey: "pageKey"
 });
 
 ```
@@ -3006,7 +3027,7 @@ await client.doc.pages.flatten({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.FlattenPagesRequest` 
+**request:** `CloudPDF.doc.DocPagesSetScaleRequest` 
     
 </dd>
 </dl>
@@ -3026,24 +3047,10 @@ 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>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
+<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>
 
-Multipart: a JSON `body` part `{"position"?: PagePosition, "resources": {"source": "<key>"}}` (position omitted → the end), and the standalone PDF whose pages are copied in as the part `resource:<key>`. The inserted copies get fresh page object numbers, returned in insertion order.
-</dd>
-</dl>
-</dd>
-</dl>
-
 #### 🔌 Usage
 
 <dl>
@@ -3053,10 +3060,10 @@ Multipart: a JSON `body` part `{"position"?: PagePosition, "resources": {"source
 <dd>
 
 ```typescript
-await client.doc.pages.insert({
-    file: fs.createReadStream("/path/to/your/file"),
+await client.doc.pages.viewports({
     docId: "docId",
-    layerName: "layerName"
+    layerName: "layerName",
+    pageKey: "pageKey"
 });
 
 ```
@@ -3073,7 +3080,7 @@ await client.doc.pages.insert({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.InsertPagesRequest` 
+**request:** `CloudPDF.doc.ViewportsPagesRequest` 
     
 </dd>
 </dl>
@@ -3093,7 +3100,7 @@ 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>
+<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>
 
@@ -3105,7 +3112,7 @@ await client.doc.pages.insert({
 <dl>
 <dd>
 
-Body is `{"size": {"width", "height"}, "count"?, "position"?}` — size in PDF points, count in [1, 100], `position` a `PagePosition` (omitted → the end).
+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>
@@ -3120,11 +3127,13 @@ Body is `{"size": {"width", "height"}, "count"?, "position"?}` — size in PDF p
 <dd>
 
 ```typescript
-await client.doc.pages.insertBlank({
+await client.doc.pages.extract({
     docId: "docId",
     layerName: "layerName",
     body: {
-        "key": "value"
+        "string": {
+            "key": "value"
+        }
     }
 });
 
@@ -3142,7 +3151,7 @@ await client.doc.pages.insertBlank({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.InsertBlankPagesRequest` 
+**request:** `CloudPDF.doc.ExtractPagesRequest` 
     
 </dd>
 </dl>
@@ -3162,7 +3171,7 @@ await client.doc.pages.insertBlank({
 </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>
 
@@ -3175,7 +3184,7 @@ await client.doc.pages.insertBlank({
 <dd>
 
 ```typescript
-await client.doc.pages.setName({
+await client.doc.pages.flatten({
     docId: "docId",
     layerName: "layerName",
     body: {
@@ -3197,7 +3206,7 @@ await client.doc.pages.setName({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.SetNamePagesRequest` 
+**request:** `CloudPDF.doc.FlattenPagesRequest` 
     
 </dd>
 </dl>
@@ -3217,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>
 
@@ -3230,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: {
@@ -3252,64 +3261,7 @@ await client.doc.pages.removeName({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.RemoveNamePagesRequest` 
-    
-</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">reorder</a>({ ...params }) -> CloudPDF.DocPagesReorder200Response</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.doc.pages.reorder({
-    docId: "docId",
-    layerName: "layerName",
-    pages: [{
-            kind: "objectNumber",
-            objectNumber: 1
-        }],
-    position: "start"
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `CloudPDF.doc.DocPagesReorderRequest` 
+**request:** `CloudPDF.doc.SetNamePagesRequest` 
     
 </dd>
 </dl>
@@ -3329,7 +3281,7 @@ await client.doc.pages.reorder({
 </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>
 
@@ -3342,7 +3294,7 @@ await client.doc.pages.reorder({
 <dd>
 
 ```typescript
-await client.doc.pages.rotate({
+await client.doc.pages.removeName({
     docId: "docId",
     layerName: "layerName",
     body: {
@@ -3364,7 +3316,7 @@ await client.doc.pages.rotate({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.RotatePagesRequest` 
+**request:** `CloudPDF.doc.RemoveNamePagesRequest` 
     
 </dd>
 </dl>