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

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@cloudpdf/sdk",
-        "X-Fern-SDK-Version": "3.0.0-next.14",
-        "User-Agent": "@cloudpdf/sdk/3.0.0-next.14",
+        "X-Fern-SDK-Version": "3.0.0-next.16",
+        "User-Agent": "@cloudpdf/sdk/3.0.0-next.16",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/api/errors/ContentTooLargeError.d.ts

@@ -0,0 +1,5 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+export declare class ContentTooLargeError extends errors.CloudPDFError {
+    constructor(body?: unknown, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/errors/ContentTooLargeError.js

@@ -0,0 +1,54 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentTooLargeError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class ContentTooLargeError extends errors.CloudPDFError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ContentTooLargeError",
+            statusCode: 413,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = "ContentTooLargeError";
+    }
+}
+exports.ContentTooLargeError = ContentTooLargeError;

package/dist/cjs/api/errors/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./BadGatewayError.js";
 export * from "./BadRequestError.js";
 export * from "./ConflictError.js";
+export * from "./ContentTooLargeError.js";
 export * from "./ForbiddenError.js";
 export * from "./GoneError.js";
 export * from "./NotFoundError.js";

package/dist/cjs/api/errors/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BadGatewayError.js"), exports);
 __exportStar(require("./BadRequestError.js"), exports);
 __exportStar(require("./ConflictError.js"), exports);
+__exportStar(require("./ContentTooLargeError.js"), exports);
 __exportStar(require("./ForbiddenError.js"), exports);
 __exportStar(require("./GoneError.js"), exports);
 __exportStar(require("./NotFoundError.js"), exports);

package/dist/cjs/api/resources/doc/client/Client.d.ts

@@ -3,8 +3,10 @@ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js"
 import * as core from "../../../../core/index.js";
 import * as CloudPDF from "../../../index.js";
 import { AnnotationsClient } from "../resources/annotations/client/Client.js";
+import { AttachmentsClient } from "../resources/attachments/client/Client.js";
 import { FormsClient } from "../resources/forms/client/Client.js";
 import { MetadataClient } from "../resources/metadata/client/Client.js";
+import { OutlineClient } from "../resources/outline/client/Client.js";
 import { PagesClient } from "../resources/pages/client/Client.js";
 import { RedactionsClient } from "../resources/redactions/client/Client.js";
 import { SignaturesClient } from "../resources/signatures/client/Client.js";
@@ -17,16 +19,20 @@ export declare namespace DocClient {
 export declare class DocClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<DocClient.Options>;
     protected _annotations: AnnotationsClient | undefined;
+    protected _attachments: AttachmentsClient | undefined;
     protected _forms: FormsClient | undefined;
     protected _metadata: MetadataClient | undefined;
+    protected _outline: OutlineClient | undefined;
     protected _pages: PagesClient | undefined;
     protected _redactions: RedactionsClient | undefined;
     protected _signatures: SignaturesClient | undefined;
     protected _versions: VersionsClient | undefined;
     constructor(options: DocClient.Options);
     get annotations(): AnnotationsClient;
+    get attachments(): AttachmentsClient;
     get forms(): FormsClient;
     get metadata(): MetadataClient;
+    get outline(): OutlineClient;
     get pages(): PagesClient;
     get redactions(): RedactionsClient;
     get signatures(): SignaturesClient;
@@ -46,6 +52,30 @@ export declare class DocClient {
      */
     head(request: CloudPDF.HeadDocRequest, requestOptions?: DocClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocHead200Response>;
     private __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`, 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.
+     *
+     * @param {CloudPDF.DocChangesRequest} request
+     * @param {DocClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link CloudPDF.ConflictError}
+     * @throws {@link CloudPDF.ContentTooLargeError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.changes({
+     *         docId: "docId",
+     *         layerName: "layerName",
+     *         changes: [{
+     *                 opId: "opId"
+     *             }]
+     *     })
+     */
+    changes(request: CloudPDF.DocChangesRequest, requestOptions?: DocClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocChanges200Response>;
+    private __changes;
     /**
      * @throws {@link CloudPDF.NotFoundError}
      * @throws {@link errors.CloudPDFError}
@@ -90,7 +120,7 @@ export declare class DocClient {
      *     await client.doc.text({
      *         docId: "docId",
      *         layerName: "layerName",
-     *         pon: 1
+     *         pageKey: "pageKey"
      *     })
      */
     text(request: CloudPDF.TextDocRequest, requestOptions?: DocClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocText200Response>;

package/dist/cjs/api/resources/doc/client/Client.js

@@ -42,21 +42,35 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocClient = void 0;
 const BaseClient_js_1 = require("../../../../BaseClient.js");
 const headers_js_1 = require("../../../../core/headers.js");
 const core = __importStar(require("../../../../core/index.js"));
+const requestBody_js_1 = require("../../../../core/requestBody.js");
 const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
 const errors = __importStar(require("../../../../errors/index.js"));
 const CloudPDF = __importStar(require("../../../index.js"));
 const Client_js_1 = require("../resources/annotations/client/Client.js");
-const Client_js_2 = require("../resources/forms/client/Client.js");
-const Client_js_3 = require("../resources/metadata/client/Client.js");
-const Client_js_4 = require("../resources/pages/client/Client.js");
-const Client_js_5 = require("../resources/redactions/client/Client.js");
-const Client_js_6 = require("../resources/signatures/client/Client.js");
-const Client_js_7 = require("../resources/versions/client/Client.js");
+const Client_js_2 = require("../resources/attachments/client/Client.js");
+const Client_js_3 = require("../resources/forms/client/Client.js");
+const Client_js_4 = require("../resources/metadata/client/Client.js");
+const Client_js_5 = require("../resources/outline/client/Client.js");
+const Client_js_6 = require("../resources/pages/client/Client.js");
+const Client_js_7 = require("../resources/redactions/client/Client.js");
+const Client_js_8 = require("../resources/signatures/client/Client.js");
+const Client_js_9 = require("../resources/versions/client/Client.js");
 class DocClient {
     constructor(options) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
@@ -65,29 +79,37 @@ class DocClient {
         var _a;
         return ((_a = this._annotations) !== null && _a !== void 0 ? _a : (this._annotations = new Client_js_1.AnnotationsClient(this._options)));
     }
+    get attachments() {
+        var _a;
+        return ((_a = this._attachments) !== null && _a !== void 0 ? _a : (this._attachments = new Client_js_2.AttachmentsClient(this._options)));
+    }
     get forms() {
         var _a;
-        return ((_a = this._forms) !== null && _a !== void 0 ? _a : (this._forms = new Client_js_2.FormsClient(this._options)));
+        return ((_a = this._forms) !== null && _a !== void 0 ? _a : (this._forms = new Client_js_3.FormsClient(this._options)));
     }
     get metadata() {
         var _a;
-        return ((_a = this._metadata) !== null && _a !== void 0 ? _a : (this._metadata = new Client_js_3.MetadataClient(this._options)));
+        return ((_a = this._metadata) !== null && _a !== void 0 ? _a : (this._metadata = new Client_js_4.MetadataClient(this._options)));
+    }
+    get outline() {
+        var _a;
+        return ((_a = this._outline) !== null && _a !== void 0 ? _a : (this._outline = new Client_js_5.OutlineClient(this._options)));
     }
     get pages() {
         var _a;
-        return ((_a = this._pages) !== null && _a !== void 0 ? _a : (this._pages = new Client_js_4.PagesClient(this._options)));
+        return ((_a = this._pages) !== null && _a !== void 0 ? _a : (this._pages = new Client_js_6.PagesClient(this._options)));
     }
     get redactions() {
         var _a;
-        return ((_a = this._redactions) !== null && _a !== void 0 ? _a : (this._redactions = new Client_js_5.RedactionsClient(this._options)));
+        return ((_a = this._redactions) !== null && _a !== void 0 ? _a : (this._redactions = new Client_js_7.RedactionsClient(this._options)));
     }
     get signatures() {
         var _a;
-        return ((_a = this._signatures) !== null && _a !== void 0 ? _a : (this._signatures = new Client_js_6.SignaturesClient(this._options)));
+        return ((_a = this._signatures) !== null && _a !== void 0 ? _a : (this._signatures = new Client_js_8.SignaturesClient(this._options)));
     }
     get versions() {
         var _a;
-        return ((_a = this._versions) !== null && _a !== void 0 ? _a : (this._versions = new Client_js_7.VersionsClient(this._options)));
+        return ((_a = this._versions) !== null && _a !== void 0 ? _a : (this._versions = new Client_js_9.VersionsClient(this._options)));
     }
     /**
      * @param {CloudPDF.HeadDocRequest} request
@@ -140,6 +162,75 @@ class DocClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/docs/{docId}/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`, 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.
+     *
+     * @param {CloudPDF.DocChangesRequest} request
+     * @param {DocClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link CloudPDF.ConflictError}
+     * @throws {@link CloudPDF.ContentTooLargeError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.changes({
+     *         docId: "docId",
+     *         layerName: "layerName",
+     *         changes: [{
+     *                 opId: "opId"
+     *             }]
+     *     })
+     */
+    changes(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__changes(request, requestOptions));
+    }
+    __changes(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { docId, layerName, "X-Document-Password": documentPassword } = request, _body = __rest(request, ["docId", "layerName", "X-Document-Password"]);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Document-Password": documentPassword }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `v1/docs/${core.url.encodePathParam(docId)}/layers/${core.url.encodePathParam(layerName)}/changes`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(_body, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
+                timeoutMs: ((_e = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _c !== void 0 ? _c : (_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) !== null && _e !== void 0 ? _e : 60) * 1000,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new CloudPDF.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new CloudPDF.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new CloudPDF.ConflictError(_response.error.body, _response.rawResponse);
+                    case 413:
+                        throw new CloudPDF.ContentTooLargeError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.CloudPDFError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/changes");
+        });
+    }
     /**
      * @throws {@link CloudPDF.NotFoundError}
      * @throws {@link errors.CloudPDFError}
@@ -249,11 +340,11 @@ class DocClient {
     __render(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
-            const { docId, layerName, pon, "X-Document-Password": documentPassword } = request;
+            const { docId, layerName, pageKey, "X-Document-Password": documentPassword } = request;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Document-Password": documentPassword }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `v1/docs/${core.url.encodePathParam(docId)}/layers/${core.url.encodePathParam(layerName)}/render/pages/${core.url.encodePathParam(pon)}/data`),
+                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `v1/docs/${core.url.encodePathParam(docId)}/layers/${core.url.encodePathParam(layerName)}/render/pages/${core.url.encodePathParam(pageKey)}/data`),
                 method: "GET",
                 headers: _headers,
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
@@ -279,7 +370,7 @@ class DocClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/docs/{docId}/layers/{layerName}/render/pages/{pon}/data");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/docs/{docId}/layers/{layerName}/render/pages/{pageKey}/data");
         });
     }
     /**
@@ -294,7 +385,7 @@ class DocClient {
      *     await client.doc.text({
      *         docId: "docId",
      *         layerName: "layerName",
-     *         pon: 1
+     *         pageKey: "pageKey"
      *     })
      */
     text(request, requestOptions) {
@@ -303,11 +394,11 @@ class DocClient {
     __text(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
-            const { docId, layerName, pon, "X-Document-Password": documentPassword } = request;
+            const { docId, layerName, pageKey, "X-Document-Password": documentPassword } = request;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "X-Document-Password": documentPassword }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `v1/docs/${core.url.encodePathParam(docId)}/layers/${core.url.encodePathParam(layerName)}/text/pages/${core.url.encodePathParam(pon)}/data`),
+                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment)), `v1/docs/${core.url.encodePathParam(docId)}/layers/${core.url.encodePathParam(layerName)}/text/pages/${core.url.encodePathParam(pageKey)}/data`),
                 method: "GET",
                 headers: _headers,
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
@@ -332,7 +423,7 @@ class DocClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/docs/{docId}/layers/{layerName}/text/pages/{pon}/data");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/docs/{docId}/layers/{layerName}/text/pages/{pageKey}/data");
         });
     }
 }

package/dist/cjs/api/resources/doc/client/requests/DocChangesRequest.d.ts

@@ -0,0 +1,28 @@
+import type * as CloudPDF from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         docId: "docId",
+ *         layerName: "layerName",
+ *         changes: [{
+ *                 opId: "opId"
+ *             }]
+ *     }
+ */
+export interface DocChangesRequest {
+    docId: string;
+    layerName: 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. */
+    "X-Document-Password"?: string;
+    changes: DocChangesRequest.Changes.Item[];
+}
+export declare namespace DocChangesRequest {
+    type Changes = Changes.Item[];
+    namespace Changes {
+        interface Item {
+            opId: string;
+            ops?: CloudPDF.ChangeOp[] | undefined;
+            undoOf?: string | undefined;
+        }
+    }
+}

package/dist/cjs/api/resources/doc/client/requests/RenderDocRequest.d.ts

@@ -3,13 +3,14 @@
  *     {
  *         docId: "docId",
  *         layerName: "layerName",
- *         pon: 1
+ *         pageKey: "pageKey"
  *     }
  */
 export interface RenderDocRequest {
     docId: string;
     layerName: string;
-    pon: number;
+    /** The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`. */
+    pageKey: 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. */
     "X-Document-Password"?: string;
 }

package/dist/cjs/api/resources/doc/client/requests/TextDocRequest.d.ts

@@ -3,13 +3,14 @@
  *     {
  *         docId: "docId",
  *         layerName: "layerName",
- *         pon: 1
+ *         pageKey: "pageKey"
  *     }
  */
 export interface TextDocRequest {
     docId: string;
     layerName: string;
-    pon: number;
+    /** The page's address, `obj:N`: the page's indirect object number, the durable identity every `PageLayout.ref` carries. Mirrors `annotKey` and `fieldKey`. */
+    pageKey: 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. */
     "X-Document-Password"?: string;
 }

package/dist/cjs/api/resources/doc/client/requests/index.d.ts

@@ -1,3 +1,4 @@
+export type { DocChangesRequest } from "./DocChangesRequest.js";
 export type { DownloadDocRequest } from "./DownloadDocRequest.js";
 export type { HeadDocRequest } from "./HeadDocRequest.js";
 export type { ManifestDocRequest } from "./ManifestDocRequest.js";

package/dist/cjs/api/resources/doc/resources/annotations/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare class AnnotationsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<AnnotationsClient.Options>;
     constructor(options: AnnotationsClient.Options);
     /**
-     * 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.
      *
      * @param {CloudPDF.doc.ListAllAnnotationsRequest} request
      * @param {AnnotationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -41,7 +41,7 @@ export declare class AnnotationsClient {
      *     await client.doc.annotations.list({
      *         docId: "docId",
      *         layerName: "layerName",
-     *         pon: 1
+     *         pageKey: "pageKey"
      *     })
      */
     list(request: CloudPDF.doc.ListAnnotationsRequest, requestOptions?: AnnotationsClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocAnnotationsList200Response>;
@@ -61,7 +61,7 @@ export declare class AnnotationsClient {
      *     await client.doc.annotations.create({
      *         docId: "docId",
      *         layerName: "layerName",
-     *         pon: 1,
+     *         pageKey: "pageKey",
      *         body: {
      *             "key": "value"
      *         }
@@ -81,7 +81,7 @@ export declare class AnnotationsClient {
      *     await client.doc.annotations.delete({
      *         docId: "docId",
      *         layerName: "layerName",
-     *         pon: 1,
+     *         pageKey: "pageKey",
      *         annotKey: "annotKey"
      *     })
      */
@@ -100,7 +100,7 @@ export declare class AnnotationsClient {
      *     await client.doc.annotations.update({
      *         docId: "docId",
      *         layerName: "layerName",
-     *         pon: 1,
+     *         pageKey: "pageKey",
      *         annotKey: "annotKey",
      *         body: {
      *             "key": "value"
@@ -109,6 +109,25 @@ export declare class AnnotationsClient {
      */
     update(request: CloudPDF.doc.UpdateAnnotationsRequest, requestOptions?: AnnotationsClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocAnnotationsUpdate200Response>;
     private __update;
+    /**
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     */
+    readAppearance(request: CloudPDF.doc.ReadAppearanceAnnotationsRequest, requestOptions?: AnnotationsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __readAppearance;
+    /**
+     * A file that decodes past the server's limit is refused (PayloadTooLarge).
+     *
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link CloudPDF.ContentTooLargeError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     */
+    readFile(request: CloudPDF.doc.ReadFileAnnotationsRequest, requestOptions?: AnnotationsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __readFile;
     /**
      * @throws {@link CloudPDF.BadRequestError}
      * @throws {@link CloudPDF.NotFoundError}
@@ -130,7 +149,7 @@ export declare class AnnotationsClient {
      *     await client.doc.annotations.flatten({
      *         docId: "docId",
      *         layerName: "layerName",
-     *         pon: 1,
+     *         pageKey: "pageKey",
      *         body: {
      *             "key": "value"
      *         }
@@ -138,4 +157,31 @@ export declare class AnnotationsClient {
      */
     flatten(request: CloudPDF.doc.FlattenAnnotationsRequest, requestOptions?: AnnotationsClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocAnnotationsFlatten200Response>;
     private __flatten;
+    /**
+     * @param {CloudPDF.doc.DocAnnotationsReorderRequest} request
+     * @param {AnnotationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.annotations.reorder({
+     *         docId: "docId",
+     *         layerName: "layerName",
+     *         pageKey: "pageKey",
+     *         refs: [{
+     *                 kind: "objectNumber",
+     *                 page: {
+     *                     kind: "objectNumber",
+     *                     objectNumber: 1
+     *                 },
+     *                 objectNumber: 1
+     *             }],
+     *         position: "start"
+     *     })
+     */
+    reorder(request: CloudPDF.doc.DocAnnotationsReorderRequest, requestOptions?: AnnotationsClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocAnnotationsReorder200Response>;
+    private __reorder;
 }