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

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

@@ -42,6 +42,17 @@ 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.AnnotationsClient = void 0;
 const BaseClient_js_1 = require("../../../../../../BaseClient.js");
@@ -56,7 +67,7 @@ class AnnotationsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(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.
@@ -127,7 +138,7 @@ class AnnotationsClient {
      *     await client.doc.annotations.list({
      *         docId: "docId",
      *         layerName: "layerName",
-     *         pon: 1
+     *         pageKey: "pageKey"
      *     })
      */
     list(request, requestOptions) {
@@ -136,11 +147,11 @@ class AnnotationsClient {
     __list(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)}/annotations/pages/${core.url.encodePathParam(pon)}/items`),
+                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)}/annotations/pages/${core.url.encodePathParam(pageKey)}/items`),
                 method: "GET",
                 headers: _headers,
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
@@ -168,7 +179,7 @@ class AnnotationsClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pageKey}/items");
         });
     }
     /**
@@ -186,7 +197,7 @@ class AnnotationsClient {
      *     await client.doc.annotations.create({
      *         docId: "docId",
      *         layerName: "layerName",
-     *         pon: 1,
+     *         pageKey: "pageKey",
      *         body: {
      *             "key": "value"
      *         }
@@ -198,11 +209,11 @@ class AnnotationsClient {
     __create(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, body: _body } = request;
+            const { docId, layerName, pageKey, "X-Document-Password": documentPassword, "Idempotency-Key": idempotencyKey, body: _body, } = 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 _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, "Idempotency-Key": idempotencyKey }), 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)}/annotations/pages/${core.url.encodePathParam(pon)}/items`),
+                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)}/annotations/pages/${core.url.encodePathParam(pageKey)}/items`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
@@ -235,7 +246,7 @@ class AnnotationsClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pageKey}/items");
         });
     }
     /**
@@ -250,7 +261,7 @@ class AnnotationsClient {
      *     await client.doc.annotations.delete({
      *         docId: "docId",
      *         layerName: "layerName",
-     *         pon: 1,
+     *         pageKey: "pageKey",
      *         annotKey: "annotKey"
      *     })
      */
@@ -260,11 +271,11 @@ class AnnotationsClient {
     __delete(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
-            const { docId, layerName, pon, annotKey, "X-Document-Password": documentPassword } = request;
+            const { docId, layerName, pageKey, annotKey, "X-Document-Password": documentPassword, "Idempotency-Key": idempotencyKey, } = 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 _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, "Idempotency-Key": idempotencyKey }), 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)}/annotations/pages/${core.url.encodePathParam(pon)}/items/${core.url.encodePathParam(annotKey)}`),
+                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)}/annotations/pages/${core.url.encodePathParam(pageKey)}/items/${core.url.encodePathParam(annotKey)}`),
                 method: "DELETE",
                 headers: _headers,
                 queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
@@ -292,7 +303,7 @@ class AnnotationsClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items/{annotKey}");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pageKey}/items/{annotKey}");
         });
     }
     /**
@@ -308,7 +319,7 @@ class AnnotationsClient {
      *     await client.doc.annotations.update({
      *         docId: "docId",
      *         layerName: "layerName",
-     *         pon: 1,
+     *         pageKey: "pageKey",
      *         annotKey: "annotKey",
      *         body: {
      *             "key": "value"
@@ -321,11 +332,11 @@ class AnnotationsClient {
     __update(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
-            const { docId, layerName, pon, annotKey, "X-Document-Password": documentPassword, body: _body } = request;
+            const { docId, layerName, pageKey, annotKey, "X-Document-Password": documentPassword, "Idempotency-Key": idempotencyKey, body: _body, } = 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 _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, "Idempotency-Key": idempotencyKey }), 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)}/annotations/pages/${core.url.encodePathParam(pon)}/items/${core.url.encodePathParam(annotKey)}`),
+                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)}/annotations/pages/${core.url.encodePathParam(pageKey)}/items/${core.url.encodePathParam(annotKey)}`),
                 method: "PATCH",
                 headers: _headers,
                 contentType: "application/json",
@@ -358,7 +369,106 @@ class AnnotationsClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items/{annotKey}");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pageKey}/items/{annotKey}");
+        });
+    }
+    /**
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     */
+    readAppearance(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__readAppearance(request, requestOptions));
+    }
+    __readAppearance(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { docId, layerName, pageKey, annotKey, "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)}/annotations/pages/${core.url.encodePathParam(pageKey)}/items/${core.url.encodePathParam(annotKey)}/resources/appearance`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                responseType: "binary-response",
+                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);
+                    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, "GET", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pageKey}/items/{annotKey}/resources/appearance");
+        });
+    }
+    /**
+     * 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, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__readFile(request, requestOptions));
+    }
+    __readFile(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { docId, layerName, pageKey, annotKey, "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)}/annotations/pages/${core.url.encodePathParam(pageKey)}/items/${core.url.encodePathParam(annotKey)}/resources/file`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                responseType: "binary-response",
+                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 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, "GET", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pageKey}/items/{annotKey}/resources/file");
         });
     }
     /**
@@ -373,11 +483,11 @@ class AnnotationsClient {
     __exportAppearance(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, body: _body } = request;
+            const { docId, layerName, pageKey, "X-Document-Password": documentPassword, body: _body } = 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)}/annotations/pages/${core.url.encodePathParam(pon)}/items/appearance`),
+                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)}/annotations/pages/${core.url.encodePathParam(pageKey)}/items/appearance`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
@@ -408,7 +518,7 @@ class AnnotationsClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items/appearance");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pageKey}/items/appearance");
         });
     }
     /**
@@ -424,7 +534,7 @@ class AnnotationsClient {
      *     await client.doc.annotations.flatten({
      *         docId: "docId",
      *         layerName: "layerName",
-     *         pon: 1,
+     *         pageKey: "pageKey",
      *         body: {
      *             "key": "value"
      *         }
@@ -436,11 +546,82 @@ class AnnotationsClient {
     __flatten(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, body: _body } = request;
+            const { docId, layerName, pageKey, "X-Document-Password": documentPassword, "Idempotency-Key": idempotencyKey, body: _body, } = 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 _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, "Idempotency-Key": idempotencyKey }), 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)}/annotations/pages/${core.url.encodePathParam(pageKey)}/items/flatten`),
+                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);
+                    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}/annotations/pages/{pageKey}/items/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, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__reorder(request, requestOptions));
+    }
+    __reorder(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { docId, layerName, pageKey, "X-Document-Password": documentPassword, "Idempotency-Key": idempotencyKey } = request, _body = __rest(request, ["docId", "layerName", "pageKey", "X-Document-Password", "Idempotency-Key"]);
+            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, "Idempotency-Key": idempotencyKey }), 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)}/annotations/pages/${core.url.encodePathParam(pon)}/items/flatten`),
+                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)}/annotations/pages/${core.url.encodePathParam(pageKey)}/items/reorder`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
@@ -473,7 +654,7 @@ class AnnotationsClient {
                         });
                 }
             }
-            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pon}/items/flatten");
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/annotations/pages/{pageKey}/items/reorder");
         });
     }
 }

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

@@ -4,7 +4,7 @@ import type * as CloudPDF from "../../../../../../index.js";
  *     {
  *         docId: "docId",
  *         layerName: "layerName",
- *         pon: 1,
+ *         pageKey: "pageKey",
  *         body: {
  *             "key": "value"
  *         }
@@ -13,8 +13,11 @@ import type * as CloudPDF from "../../../../../../index.js";
 export interface CreateAnnotationsRequest {
     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;
+    /** 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. */
+    "Idempotency-Key"?: string;
     body: CloudPDF.DocAnnotationsCreateRequest;
 }

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

@@ -3,15 +3,19 @@
  *     {
  *         docId: "docId",
  *         layerName: "layerName",
- *         pon: 1,
+ *         pageKey: "pageKey",
  *         annotKey: "annotKey"
  *     }
  */
 export interface DeleteAnnotationsRequest {
     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;
+    /** 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. */
     annotKey: 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;
+    /** 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. */
+    "Idempotency-Key"?: string;
 }

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

@@ -0,0 +1,30 @@
+import type * as CloudPDF from "../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         docId: "docId",
+ *         layerName: "layerName",
+ *         pageKey: "pageKey",
+ *         refs: [{
+ *                 kind: "objectNumber",
+ *                 page: {
+ *                     kind: "objectNumber",
+ *                     objectNumber: 1
+ *                 },
+ *                 objectNumber: 1
+ *             }],
+ *         position: "start"
+ *     }
+ */
+export interface DocAnnotationsReorderRequest {
+    docId: string;
+    layerName: string;
+    /** 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;
+    /** 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. */
+    "Idempotency-Key"?: string;
+    refs: CloudPDF.AnnotationRef[];
+    position: CloudPDF.AnnotationPosition;
+}

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

@@ -4,7 +4,7 @@ import type * as CloudPDF from "../../../../../../index.js";
  *     {
  *         docId: "docId",
  *         layerName: "layerName",
- *         pon: 1,
+ *         pageKey: "pageKey",
  *         body: {
  *             "string": {
  *                 "key": "value"
@@ -15,7 +15,8 @@ import type * as CloudPDF from "../../../../../../index.js";
 export interface ExportAppearanceAnnotationsRequest {
     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;
     body: CloudPDF.DocAnnotationsExportAppearanceRequest;

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

@@ -4,7 +4,7 @@ import type * as CloudPDF from "../../../../../../index.js";
  *     {
  *         docId: "docId",
  *         layerName: "layerName",
- *         pon: 1,
+ *         pageKey: "pageKey",
  *         body: {
  *             "key": "value"
  *         }
@@ -13,8 +13,11 @@ import type * as CloudPDF from "../../../../../../index.js";
 export interface FlattenAnnotationsRequest {
     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;
+    /** 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. */
+    "Idempotency-Key"?: string;
     body: CloudPDF.DocAnnotationsFlattenRequest;
 }

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

@@ -3,13 +3,14 @@
  *     {
  *         docId: "docId",
  *         layerName: "layerName",
- *         pon: 1
+ *         pageKey: "pageKey"
  *     }
  */
 export interface ListAnnotationsRequest {
     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/resources/annotations/client/requests/ReadAppearanceAnnotationsRequest.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @example
+ *     {
+ *         docId: "docId",
+ *         layerName: "layerName",
+ *         pageKey: "pageKey",
+ *         annotKey: "annotKey"
+ *     }
+ */
+export interface ReadAppearanceAnnotationsRequest {
+    docId: string;
+    layerName: string;
+    /** 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;
+    /** 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. */
+    annotKey: 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/resources/annotations/client/requests/ReadFileAnnotationsRequest.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @example
+ *     {
+ *         docId: "docId",
+ *         layerName: "layerName",
+ *         pageKey: "pageKey",
+ *         annotKey: "annotKey"
+ *     }
+ */
+export interface ReadFileAnnotationsRequest {
+    docId: string;
+    layerName: string;
+    /** 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;
+    /** 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. */
+    annotKey: 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/resources/annotations/client/requests/UpdateAnnotationsRequest.d.ts

@@ -4,7 +4,7 @@ import type * as CloudPDF from "../../../../../../index.js";
  *     {
  *         docId: "docId",
  *         layerName: "layerName",
- *         pon: 1,
+ *         pageKey: "pageKey",
  *         annotKey: "annotKey",
  *         body: {
  *             "key": "value"
@@ -14,9 +14,13 @@ import type * as CloudPDF from "../../../../../../index.js";
 export interface UpdateAnnotationsRequest {
     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;
+    /** 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. */
     annotKey: 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;
+    /** 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. */
+    "Idempotency-Key"?: string;
     body: CloudPDF.DocAnnotationsUpdateRequest;
 }

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

@@ -1,7 +1,10 @@
 export type { CreateAnnotationsRequest } from "./CreateAnnotationsRequest.js";
 export type { DeleteAnnotationsRequest } from "./DeleteAnnotationsRequest.js";
+export type { DocAnnotationsReorderRequest } from "./DocAnnotationsReorderRequest.js";
 export type { ExportAppearanceAnnotationsRequest } from "./ExportAppearanceAnnotationsRequest.js";
 export type { FlattenAnnotationsRequest } from "./FlattenAnnotationsRequest.js";
 export type { ListAllAnnotationsRequest } from "./ListAllAnnotationsRequest.js";
 export type { ListAnnotationsRequest } from "./ListAnnotationsRequest.js";
+export type { ReadAppearanceAnnotationsRequest } from "./ReadAppearanceAnnotationsRequest.js";
+export type { ReadFileAnnotationsRequest } from "./ReadFileAnnotationsRequest.js";
 export type { UpdateAnnotationsRequest } from "./UpdateAnnotationsRequest.js";