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

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`. 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.
+</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"
@@ -1993,6 +2062,60 @@ await client.doc.annotations.update({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<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>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.doc.annotations.readAppearance({
+    docId: "docId",
+    layerName: "layerName",
+    pageKey: "pageKey",
+    annotKey: "annotKey"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CloudPDF.doc.ReadAppearanceAnnotationsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AnnotationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2013,7 +2136,7 @@ await client.doc.annotations.update({
 await client.doc.annotations.exportAppearance({
     docId: "docId",
     layerName: "layerName",
-    pon: 1,
+    pageKey: "pageKey",
     body: {
         "string": {
             "key": "value"
@@ -2071,7 +2194,7 @@ await client.doc.annotations.exportAppearance({
 await client.doc.annotations.flatten({
     docId: "docId",
     layerName: "layerName",
-    pon: 1,
+    pageKey: "pageKey",
     body: {
         "key": "value"
     }
@@ -2107,12 +2230,74 @@ await client.doc.annotations.flatten({
 </dl>
 
 
+</dd>
+</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>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.doc.annotations.reorder({
+    docId: "docId",
+    layerName: "layerName",
+    pageKey: "pageKey",
+    refs: [{
+            kind: "objectNumber",
+            page: {
+                kind: "objectNumber",
+                objectNumber: 1
+            },
+            objectNumber: 1
+        }],
+    position: "start"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CloudPDF.doc.DocAnnotationsReorderRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AnnotationsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </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.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">list</a>({ ...params }) -> CloudPDF.DocFormsList200Response</code></summary>
 <dl>
 <dd>
 
@@ -2125,7 +2310,7 @@ await client.doc.annotations.flatten({
 <dd>
 
 ```typescript
-await client.doc.forms.get({
+await client.doc.forms.list({
     docId: "docId",
     layerName: "layerName"
 });
@@ -2144,7 +2329,7 @@ await client.doc.forms.get({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.GetFormsRequest` 
+**request:** `CloudPDF.doc.ListFormsRequest` 
     
 </dd>
 </dl>
@@ -2164,7 +2349,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.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">reorderCalculations</a>({ ...params }) -> CloudPDF.DocFormsReorderCalculations200Response</code></summary>
 <dl>
 <dd>
 
@@ -2177,9 +2362,14 @@ await client.doc.forms.get({
 <dd>
 
 ```typescript
-await client.doc.forms.exportData({
+await client.doc.forms.reorderCalculations({
     docId: "docId",
-    layerName: "layerName"
+    layerName: "layerName",
+    fields: [{
+            kind: "objectNumber",
+            objectNumber: 1
+        }],
+    position: "start"
 });
 
 ```
@@ -2196,7 +2386,7 @@ await client.doc.forms.exportData({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ExportDataFormsRequest` 
+**request:** `CloudPDF.doc.DocFormsReorderCalculationsRequest` 
     
 </dd>
 </dl>
@@ -2216,7 +2406,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.forms.<a href="/src/api/resources/doc/resources/forms/client/Client.ts">setValue</a>({ ...params }) -> CloudPDF.DocFormsSetValue200Response</code></summary>
 <dl>
 <dd>
 
@@ -2229,9 +2419,10 @@ await client.doc.forms.exportData({
 <dd>
 
 ```typescript
-await client.doc.forms.importData({
+await client.doc.forms.setValue({
     docId: "docId",
     layerName: "layerName",
+    fieldKey: "fieldKey",
     body: {
         "key": "value"
     }
@@ -2251,7 +2442,7 @@ await client.doc.forms.importData({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ImportDataFormsRequest` 
+**request:** `CloudPDF.doc.SetValueFormsRequest` 
     
 </dd>
 </dl>
@@ -2285,9 +2476,62 @@ await client.doc.forms.importData({
 
 ```typescript
 await client.doc.forms.reset({
+    docId: "docId",
+    layerName: "layerName"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CloudPDF.doc.DocFormsResetRequest` 
+    
+</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">deleteWidget</a>({ ...params }) -> CloudPDF.DocFormsDeleteWidget200Response</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.doc.forms.deleteWidget({
     docId: "docId",
     layerName: "layerName",
-    fieldKey: "fieldKey"
+    pageKey: "pageKey",
+    annotKey: "annotKey"
 });
 
 ```
@@ -2304,7 +2548,7 @@ await client.doc.forms.reset({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ResetFormsRequest` 
+**request:** `CloudPDF.doc.DeleteWidgetFormsRequest` 
     
 </dd>
 </dl>
@@ -2324,7 +2568,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">setValue</a>({ ...params }) -> CloudPDF.DocFormsSetValue200Response</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>
 
@@ -2337,13 +2581,12 @@ await client.doc.forms.reset({
 <dd>
 
 ```typescript
-await client.doc.forms.setValue({
+await client.doc.forms.updateWidget({
     docId: "docId",
     layerName: "layerName",
-    fieldKey: "fieldKey",
-    body: {
-        "key": "value"
-    }
+    pageKey: "pageKey",
+    annotKey: "annotKey",
+    patch: {}
 });
 
 ```
@@ -2360,7 +2603,69 @@ await client.doc.forms.setValue({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.SetValueFormsRequest` 
+**request:** `CloudPDF.doc.DocFormsUpdateWidgetRequest` 
+    
+</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">reorderWidgets</a>({ ...params }) -> CloudPDF.DocFormsReorderWidgets200Response</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.doc.forms.reorderWidgets({
+    docId: "docId",
+    layerName: "layerName",
+    pageKey: "pageKey",
+    widgets: [{
+            kind: "objectNumber",
+            page: {
+                kind: "objectNumber",
+                objectNumber: 1
+            },
+            objectNumber: 1
+        }],
+    position: "start"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CloudPDF.doc.DocFormsReorderWidgetsRequest` 
     
 </dd>
 </dl>
@@ -2450,7 +2755,7 @@ await client.doc.metadata.get({
 await client.doc.pages.setScale({
     docId: "docId",
     layerName: "layerName",
-    pon: 1
+    pageKey: "pageKey"
 });
 
 ```
@@ -2503,7 +2808,7 @@ await client.doc.pages.setScale({
 await client.doc.pages.viewports({
     docId: "docId",
     layerName: "layerName",
-    pon: 1
+    pageKey: "pageKey"
 });
 
 ```
@@ -2607,7 +2912,7 @@ 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.
+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>
@@ -2733,7 +3038,7 @@ 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.
+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>
@@ -2800,7 +3105,7 @@ 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.
+Body is `{"size": {"width", "height"}, "count"?, "position"?}` — size in PDF points, count in [1, 100], `position` a `PagePosition` (omitted → the end).
 </dd>
 </dl>
 </dd>
@@ -2857,7 +3162,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">move</a>({ ...params }) -> CloudPDF.DocPagesMove200Response</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>
 
@@ -2870,7 +3175,7 @@ await client.doc.pages.insertBlank({
 <dd>
 
 ```typescript
-await client.doc.pages.move({
+await client.doc.pages.setName({
     docId: "docId",
     layerName: "layerName",
     body: {
@@ -2892,7 +3197,7 @@ await client.doc.pages.move({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.MovePagesRequest` 
+**request:** `CloudPDF.doc.SetNamePagesRequest` 
     
 </dd>
 </dl>
@@ -2912,7 +3217,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">removeName</a>({ ...params }) -> CloudPDF.DocPagesRemoveName200Response</code></summary>
 <dl>
 <dd>
 
@@ -2925,7 +3230,7 @@ await client.doc.pages.move({
 <dd>
 
 ```typescript
-await client.doc.pages.setName({
+await client.doc.pages.removeName({
     docId: "docId",
     layerName: "layerName",
     body: {
@@ -2947,7 +3252,7 @@ await client.doc.pages.setName({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.SetNamePagesRequest` 
+**request:** `CloudPDF.doc.RemoveNamePagesRequest` 
     
 </dd>
 </dl>
@@ -2967,7 +3272,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">reorder</a>({ ...params }) -> CloudPDF.DocPagesReorder200Response</code></summary>
 <dl>
 <dd>
 
@@ -2980,12 +3285,14 @@ await client.doc.pages.setName({
 <dd>
 
 ```typescript
-await client.doc.pages.removeName({
+await client.doc.pages.reorder({
     docId: "docId",
     layerName: "layerName",
-    body: {
-        "key": "value"
-    }
+    pages: [{
+            kind: "objectNumber",
+            objectNumber: 1
+        }],
+    position: "start"
 });
 
 ```
@@ -3002,7 +3309,7 @@ await client.doc.pages.removeName({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.RemoveNamePagesRequest` 
+**request:** `CloudPDF.doc.DocPagesReorderRequest` 
     
 </dd>
 </dl>
@@ -3093,10 +3400,7 @@ await client.doc.pages.rotate({
 ```typescript
 await client.doc.redactions.apply({
     docId: "docId",
-    layerName: "layerName",
-    body: {
-        "key": "value"
-    }
+    layerName: "layerName"
 });
 
 ```
@@ -3113,7 +3417,7 @@ await client.doc.redactions.apply({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.ApplyRedactionsRequest` 
+**request:** `CloudPDF.doc.DocRedactionsApplyRequest` 
     
 </dd>
 </dl>
@@ -3200,7 +3504,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 +3517,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 +3537,7 @@ await client.doc.signatures.abort({
 <dl>
 <dd>
 
-**request:** `CloudPDF.doc.AbortSignaturesRequest` 
+**request:** `CloudPDF.doc.CancelSignaturesRequest` 
     
 </dd>
 </dl>
@@ -3403,7 +3707,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 +4186,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>
+