diff --git a/.fern/metadata.json b/.fern/metadata.json
index 151657f3..29c44a1e 100644
--- a/.fern/metadata.json
+++ b/.fern/metadata.json
@@ -11,10 +11,10 @@
"homepage": "https://www.cloudpdf.com"
}
},
- "originGitCommit": "c6f87eecf9636e7ef367946a7fd7f3729401ce90",
+ "originGitCommit": "7ded7de29f4cc0dc9da18042fca6afd5c9557bfc",
"originGitCommitIsDirty": false,
"invokedBy": "ci",
- "requestedVersion": "3.0.0-alpha.15",
+ "requestedVersion": "3.0.0-alpha.16",
"ciProvider": "github",
- "sdkVersion": "3.0.0-alpha.15"
+ "sdkVersion": "3.0.0-alpha.16"
}
\ No newline at end of file
diff --git a/cloudpdf-generation.json b/cloudpdf-generation.json
index 6c84da27..2f13edb3 100644
--- a/cloudpdf-generation.json
+++ b/cloudpdf-generation.json
@@ -1,12 +1,12 @@
{
"language": "php",
- "canonicalVersion": "3.0.0-next.15",
- "sdkVersion": "3.0.0-alpha.15",
+ "canonicalVersion": "3.0.0-next.16",
+ "sdkVersion": "3.0.0-alpha.16",
"source": {
"repository": "embedpdf/embed-pdf-viewer",
"openapi": "cloudpdf/contract/openapi.json",
- "openapiSha256": "9d70deca638cc7a80b0e670ec47fc45710d6603eb8f493d5fac95a38d7e5f8b3",
- "gitCommit": "c6f87eecf9636e7ef367946a7fd7f3729401ce90",
+ "openapiSha256": "06543c26918bd79d426bf242c5a3091cdb7d298d3ac3296addabee2be80edb15",
+ "gitCommit": "7ded7de29f4cc0dc9da18042fca6afd5c9557bfc",
"gitCommitIsDirty": false
},
"fern": {
diff --git a/reference.md b/reference.md
index bbd13382..c5f923b5 100644
--- a/reference.md
+++ b/reference.md
@@ -89,7 +89,7 @@ $client->doc->head(
-
-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: { : '' }`, and each file as the part `resource:`. 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: { : '' }`, and each file as the part `resource:`. At most 64 changes per request and 512 ops per change.
@@ -2555,6 +2555,98 @@ $client->doc->annotations->readAppearance(
+
+
+
+
+$client->doc->annotations->readFile($docId, $layerName, $pageKey, $annotKey, $request) -> string
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+A file that decodes past the server's limit is refused (PayloadTooLarge).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```php
+$client->doc->annotations->readFile(
+ 'docId',
+ 'layerName',
+ 'pageKey',
+ 'annotKey',
+ new ReadFileAnnotationsRequest([]),
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**$docId:** `string`
+
+
+
+
+
+-
+
+**$layerName:** `string`
+
+
+
+
+
+-
+
+**$pageKey:** `string` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
+
+
+
+
+
+-
+
+**$annotKey:** `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.
+
+
+
+
+
+-
+
+**$documentPassword:** `?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.
+
+
+
+
+
+
+
$client->doc->attachments->download($docId, $layerName, $fileKey, $request) -> string
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+A file that decodes past the server's limit is refused (PayloadTooLarge).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```php
+$client->doc->attachments->download(
+ 'docId',
+ 'layerName',
+ 'fileKey',
+ new DownloadAttachmentsRequest([]),
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**$docId:** `string`
+
+
+
+
+
+-
+
+**$layerName:** `string`
+
+
+
+
+
+-
+
+**$fileKey:** `string` — The embedded file's name-tree key (its `ref.key`), token-text encoded, as `fieldKey` is.
+
+
+
+
+
+-
+
+**$documentPassword:** `?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.
+
+
+
+
+
+
+
+
+
+$client->doc->attachments->list($docId, $layerName, $request) -> ?AttachmentList
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+A file-attachment annotation's file is listed with the annotation; read its bytes with `doc.annotations.readFile`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```php
+$client->doc->attachments->list(
+ 'docId',
+ 'layerName',
+ new ListAttachmentsRequest([]),
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**$docId:** `string`
+
+
+
+
+
+-
+
+**$layerName:** `string`
+
+
+
+
+
+-
+
+**$documentPassword:** `?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.
+
+
+
+
+
+
+
$client->doc->pages->setScale($docId, $layerName, $pageKey, $request) -> ?DocPagesSetScale200Response
+## Doc Outline
+$client->doc->outline->get($docId, $layerName, $request) -> ?DocumentOutline
-
@@ -3513,11 +3763,10 @@ $client->doc->metadata->get(
-
```php
-$client->doc->pages->setScale(
+$client->doc->outline->get(
'docId',
'layerName',
- 'pageKey',
- new DocPagesSetScaleRequest([]),
+ new GetOutlineRequest([]),
);
```
@@ -3549,47 +3798,24 @@ $client->doc->pages->setScale(
-
-**$pageKey:** `string` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
+**$documentPassword:** `?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.
+
+
-
--
-**$documentPassword:** `?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.
-
+$client->doc->pages->setScale($docId, $layerName, $pageKey, $request) -> ?DocPagesSetScale200Response
-
-**$idempotencyKey:** `?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.
-
-
-
-
-
--
-
-**$measure:** `?DocPagesSetScaleRequestMeasure`
-
-
-
-
-
-
-
-
-
-$client->doc->pages->viewports($docId, $layerName, $pageKey, $request) -> ?DocPagesViewports200Response
-
--
-
-#### 🔌 Usage
+#### 🔌 Usage
-
@@ -3598,11 +3824,11 @@ $client->doc->pages->setScale(
-
```php
-$client->doc->pages->viewports(
+$client->doc->pages->setScale(
'docId',
'layerName',
'pageKey',
- new ViewportsPagesRequest([]),
+ new DocPagesSetScaleRequest([]),
);
```
@@ -3644,70 +3870,6 @@ $client->doc->pages->viewports(
**$documentPassword:** `?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.
-
-
-
-
-
-
-
-
-$client->doc->pages->delete($docId, $layerName, $request) -> ?DocPagesDelete200Response
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```php
-$client->doc->pages->delete(
- 'docId',
- 'layerName',
- new DeletePagesRequest([
- 'body' => [
- 'key' => "value",
- ],
- ]),
-);
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**$docId:** `string`
-
-
-
-
-
--
-
-**$layerName:** `string`
-
-
-
-
-
--
-
-**$documentPassword:** `?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.
-
@@ -3722,7 +3884,7 @@ $client->doc->pages->delete(
-
-**$request:** `array`
+**$measure:** `?DocPagesSetScaleRequestMeasure`
@@ -3734,24 +3896,10 @@ $client->doc->pages->delete(
$client->doc->pages->extract($docId, $layerName, $request) -> string
-
--
-
-#### 📝 Description
-
-
--
-
+
$client->doc->pages->viewports($docId, $layerName, $pageKey, $request) -> ?DocPagesViewports200Response
-
-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.
-
-
-
-
-
#### 🔌 Usage
@@ -3761,16 +3909,11 @@ A read, not a mutation: the source document is untouched and no event is publish
-
```php
-$client->doc->pages->extract(
+$client->doc->pages->viewports(
'docId',
'layerName',
- new ExtractPagesRequest([
- 'body' => [
- 'string' => [
- 'key' => "value",
- ],
- ],
- ]),
+ 'pageKey',
+ new ViewportsPagesRequest([]),
);
```
@@ -3802,71 +3945,7 @@ $client->doc->pages->extract(
-
-**$documentPassword:** `?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:** `array`
-
-
-
-
-
-
-
-
-
-$client->doc->pages->flatten($docId, $layerName, $request) -> ?DocPagesFlatten200Response
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```php
-$client->doc->pages->flatten(
- 'docId',
- 'layerName',
- new FlattenPagesRequest([
- 'body' => [
- 'key' => "value",
- ],
- ]),
-);
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**$docId:** `string`
-
-
-
-
-
--
-
-**$layerName:** `string`
+**$pageKey:** `string` — The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`.
@@ -3876,22 +3955,6 @@ $client->doc->pages->flatten(
**$documentPassword:** `?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.
-
-
-
-
--
-
-**$idempotencyKey:** `?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.
-
-
-
-
-
--
-
-**$request:** `array`
-
@@ -3902,7 +3965,7 @@ $client->doc->pages->flatten(
$client->doc->pages->insert($docId, $layerName, $request) -> ?DocPagesInsert200Response
+$client->doc->pages->extract($docId, $layerName, $request) -> string
-
@@ -3914,7 +3977,7 @@ $client->doc->pages->flatten(
-
-Multipart: a JSON `body` part `{"position"?: PagePosition, "resources": {"source": ""}}` (position omitted → the end), and the standalone PDF whose pages are copied in as the part `resource:`. The inserted copies get fresh page object numbers, returned in insertion order.
+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`.
@@ -3929,11 +3992,15 @@ Multipart: a JSON `body` part `{"position"?: PagePosition, "resources": {"source
-
```php
-$client->doc->pages->insert(
+$client->doc->pages->extract(
'docId',
'layerName',
- new InsertPagesRequest([
- 'file' => File::createFromString("example_file", "example_file"),
+ new ExtractPagesRequest([
+ 'body' => [
+ 'string' => [
+ 'key' => "value",
+ ],
+ ],
]),
);
```
@@ -3974,7 +4041,7 @@ $client->doc->pages->insert(
-
-**$idempotencyKey:** `?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.
+**$request:** `array`
@@ -3986,24 +4053,10 @@ $client->doc->pages->insert(
$client->doc->pages->insertBlank($docId, $layerName, $request) -> ?DocPagesInsertBlank200Response
-
--
-
-#### 📝 Description
-
-
--
-
+
$client->doc->pages->flatten($docId, $layerName, $request) -> ?DocPagesFlatten200Response
-
-Body is `{"size": {"width", "height"}, "count"?, "position"?}` — size in PDF points, count in [1, 100], `position` a `PagePosition` (omitted → the end).
-
-
-
-
-
#### 🔌 Usage
@@ -4013,10 +4066,10 @@ Body is `{"size": {"width", "height"}, "count"?, "position"?}` — size in PDF p
-
```php
-$client->doc->pages->insertBlank(
+$client->doc->pages->flatten(
'docId',
'layerName',
- new InsertBlankPagesRequest([
+ new FlattenPagesRequest([
'body' => [
'key' => "value",
],
@@ -4236,178 +4289,6 @@ $client->doc->pages->removeName(
-
-
-$client->doc->pages->reorder($docId, $layerName, $request) -> ?DocPagesReorder200Response
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```php
-$client->doc->pages->reorder(
- 'docId',
- 'layerName',
- new DocPagesReorderRequest([
- 'pages' => [
- new PageRef([
- 'kind' => PageRefKind::ObjectNumber->value,
- 'objectNumber' => 1,
- ]),
- ],
- 'position' => PagePositionZero::Start->value,
- ]),
-);
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**$docId:** `string`
-
-
-
-
-
--
-
-**$layerName:** `string`
-
-
-
-
-
--
-
-**$documentPassword:** `?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.
-
-
-
-
-
--
-
-**$idempotencyKey:** `?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.
-
-
-
-
-
--
-
-**$pages:** `array`
-
-
-
-
-
--
-
-**$position:** `string|PagePositionAfter`
-
-
-
-
-
-
-
-
-
-$client->doc->pages->rotate($docId, $layerName, $request) -> ?DocPagesRotate200Response
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```php
-$client->doc->pages->rotate(
- 'docId',
- 'layerName',
- new RotatePagesRequest([
- 'body' => [
- 'key' => "value",
- ],
- ]),
-);
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**$docId:** `string`
-
-
-
-
-
--
-
-**$layerName:** `string`
-
-
-
-
-
--
-
-**$documentPassword:** `?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.
-
-
-
-
-
--
-
-**$idempotencyKey:** `?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.
-
-
-
-
-
--
-
-**$request:** `array`
-
-
-
-
-
-
-