@cloudpdf/sdk 3.0.0-next.15 → 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.15",
-        "User-Agent": "@cloudpdf/sdk/3.0.0-next.15",
+        "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

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

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;
@@ -47,7 +53,7 @@ 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`. Bytes (a stamp's drawing, an attached file, a signature's artwork) travel as multipart: a JSON `body` part, each op naming its files by role as `resources: { <role>: '<key>' }`, and each file as the part `resource:<key>`. At most 64 changes per request and 512 ops per change.
+     * Each change stands on its own and names itself by `opId`: a refused change rolls back alone, and the answer lists every change in order, applied with its result or refused with its error. Asked again under its `opId`, a change gets the same answer, refusals included; a different change under an answered `opId` is refused (IdempotencyKeyReused). `{ opId, undoOf }` undoes an earlier change of the caller, here or in an earlier request; an undo leaves alone what was changed since, and the undo of an undo redoes. A redaction, a flatten, a form repair or a completed signature ends undo for the changes before it (UndoUnavailable). Each op is checked against its own capability: annotation ops need `doc.annotate.modify`, form values `doc.forms.fill`, form structure `doc.forms.modify`, metadata `doc.metadata.modify`, outline `doc.outline.modify`, pages `doc.pages.assemble`, embedded files `doc.attachments.modify`. Bytes (a stamp's drawing, an attached file, a signature's artwork, a PDF whose pages come in) travel as multipart: a JSON `body` part, each op naming its files by role as `resources: { <role>: '<key>' }`, and each file as the part `resource:<key>`. At most 64 changes per request and 512 ops per change.
      *
      * @param {CloudPDF.DocChangesRequest} request
      * @param {DocClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -63,12 +63,14 @@ const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatu
 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);
@@ -77,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
@@ -153,7 +163,7 @@ class DocClient {
         });
     }
     /**
-     * Each change stands on its own and names itself by `opId`: a refused change rolls back alone, and the answer lists every change in order, applied with its result or refused with its error. Asked again under its `opId`, a change gets the same answer, refusals included; a different change under an answered `opId` is refused (IdempotencyKeyReused). `{ opId, undoOf }` undoes an earlier change of the caller, here or in an earlier request; an undo leaves alone what was changed since, and the undo of an undo redoes. A redaction, a flatten, a form repair or a completed signature ends undo for the changes before it (UndoUnavailable). Each op is checked against its own capability: annotation ops need `doc.annotate.modify`, form values `doc.forms.fill`, form structure `doc.forms.modify`, metadata `doc.metadata.modify`. Bytes (a stamp's drawing, an attached file, a signature's artwork) travel as multipart: a JSON `body` part, each op naming its files by role as `resources: { <role>: '<key>' }`, and each file as the part `resource:<key>`. At most 64 changes per request and 512 ops per change.
+     * Each change stands on its own and names itself by `opId`: a refused change rolls back alone, and the answer lists every change in order, applied with its result or refused with its error. Asked again under its `opId`, a change gets the same answer, refusals included; a different change under an answered `opId` is refused (IdempotencyKeyReused). `{ opId, undoOf }` undoes an earlier change of the caller, here or in an earlier request; an undo leaves alone what was changed since, and the undo of an undo redoes. A redaction, a flatten, a form repair or a completed signature ends undo for the changes before it (UndoUnavailable). Each op is checked against its own capability: annotation ops need `doc.annotate.modify`, form values `doc.forms.fill`, form structure `doc.forms.modify`, metadata `doc.metadata.modify`, outline `doc.outline.modify`, pages `doc.pages.assemble`, embedded files `doc.attachments.modify`. Bytes (a stamp's drawing, an attached file, a signature's artwork, a PDF whose pages come in) travel as multipart: a JSON `body` part, each op naming its files by role as `resources: { <role>: '<key>' }`, and each file as the part `resource:<key>`. At most 64 changes per request and 512 ops per change.
      *
      * @param {CloudPDF.DocChangesRequest} request
      * @param {DocClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -117,6 +117,17 @@ export declare class AnnotationsClient {
      */
     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}

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

@@ -419,6 +419,58 @@ class AnnotationsClient {
             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");
+        });
+    }
     /**
      * @throws {@link CloudPDF.BadRequestError}
      * @throws {@link CloudPDF.NotFoundError}

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/index.d.ts

@@ -6,4 +6,5 @@ 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";

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

@@ -0,0 +1,42 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.js";
+import * as core from "../../../../../../core/index.js";
+import * as CloudPDF from "../../../../../index.js";
+export declare namespace AttachmentsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class AttachmentsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<AttachmentsClient.Options>;
+    constructor(options: AttachmentsClient.Options);
+    /**
+     * 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}
+     */
+    download(request: CloudPDF.doc.DownloadAttachmentsRequest, requestOptions?: AttachmentsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __download;
+    /**
+     * A file-attachment annotation's file is listed with the annotation; read its bytes with `doc.annotations.readFile`.
+     *
+     * @param {CloudPDF.doc.ListAttachmentsRequest} request
+     * @param {AttachmentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.attachments.list({
+     *         docId: "docId",
+     *         layerName: "layerName"
+     *     })
+     */
+    list(request: CloudPDF.doc.ListAttachmentsRequest, requestOptions?: AttachmentsClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocAttachmentsList200Response>;
+    private __list;
+}

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

@@ -0,0 +1,167 @@
+"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;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachmentsClient = 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 handleNonStatusCodeError_js_1 = require("../../../../../../errors/handleNonStatusCodeError.js");
+const errors = __importStar(require("../../../../../../errors/index.js"));
+const CloudPDF = __importStar(require("../../../../../index.js"));
+class AttachmentsClient {
+    constructor(options) {
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
+    }
+    /**
+     * 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}
+     */
+    download(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__download(request, requestOptions));
+    }
+    __download(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { docId, layerName, fileKey, "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)}/attachment-files/${core.url.encodePathParam(fileKey)}/data`),
+                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}/attachment-files/{fileKey}/data");
+        });
+    }
+    /**
+     * A file-attachment annotation's file is listed with the annotation; read its bytes with `doc.annotations.readFile`.
+     *
+     * @param {CloudPDF.doc.ListAttachmentsRequest} request
+     * @param {AttachmentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.attachments.list({
+     *         docId: "docId",
+     *         layerName: "layerName"
+     *     })
+     */
+    list(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
+    }
+    __list(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;
+            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)}/attachments`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                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 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}/attachments");
+        });
+    }
+}
+exports.AttachmentsClient = AttachmentsClient;

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

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/dist/cjs/api/resources/doc/resources/attachments/client/index.js

@@ -0,0 +1,17 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests/index.js"), exports);

package/dist/cjs/api/resources/doc/resources/{pages/client/requests/DeletePagesRequest.d.ts → attachments/client/requests/DownloadAttachmentsRequest.d.ts}

@@ -1,20 +1,16 @@
-import type * as CloudPDF from "../../../../../../index.js";
 /**
  * @example
  *     {
  *         docId: "docId",
  *         layerName: "layerName",
- *         body: {
- *             "key": "value"
- *         }
+ *         fileKey: "fileKey"
  *     }
  */
-export interface DeletePagesRequest {
+export interface DownloadAttachmentsRequest {
     docId: string;
     layerName: string;
+    /** The embedded file's name-tree key (its `ref.key`), token-text encoded, as `fieldKey` is. */
+    fileKey: 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.DocPagesDeleteRequest;
 }

package/dist/cjs/api/resources/doc/resources/{pages/client/requests/InsertPagesRequest.d.ts → attachments/client/requests/ListAttachmentsRequest.d.ts}

@@ -1,18 +1,13 @@
-import type * as core from "../../../../../../../core/index.js";
 /**
  * @example
  *     {
- *         file: fs.createReadStream("/path/to/your/file"),
  *         docId: "docId",
  *         layerName: "layerName"
  *     }
  */
-export interface InsertPagesRequest {
+export interface ListAttachmentsRequest {
     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;
-    /** 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;
-    file: core.file.Uploadable;
 }

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

@@ -0,0 +1,2 @@
+export type { DownloadAttachmentsRequest } from "./DownloadAttachmentsRequest.js";
+export type { ListAttachmentsRequest } from "./ListAttachmentsRequest.js";

package/dist/cjs/api/resources/doc/resources/attachments/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/doc/resources/attachments/exports.d.ts

@@ -0,0 +1,2 @@
+export { AttachmentsClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/cjs/api/resources/doc/resources/attachments/exports.js

@@ -0,0 +1,21 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachmentsClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "AttachmentsClient", { enumerable: true, get: function () { return Client_js_1.AttachmentsClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/doc/resources/attachments/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/cjs/api/resources/doc/resources/attachments/index.js

@@ -0,0 +1,17 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);

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

@@ -1,9 +1,13 @@
 export * from "./annotations/client/requests/index.js";
 export * as annotations from "./annotations/index.js";
+export * from "./attachments/client/requests/index.js";
+export * as attachments from "./attachments/index.js";
 export * from "./forms/client/requests/index.js";
 export * as forms from "./forms/index.js";
 export * from "./metadata/client/requests/index.js";
 export * as metadata from "./metadata/index.js";
+export * from "./outline/client/requests/index.js";
+export * as outline from "./outline/index.js";
 export * from "./pages/client/requests/index.js";
 export * as pages from "./pages/index.js";
 export * from "./redactions/client/requests/index.js";

package/dist/cjs/api/resources/doc/resources/index.js

@@ -36,13 +36,17 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.versions = exports.signatures = exports.redactions = exports.pages = exports.metadata = exports.forms = exports.annotations = void 0;
+exports.versions = exports.signatures = exports.redactions = exports.pages = exports.outline = exports.metadata = exports.forms = exports.attachments = exports.annotations = void 0;
 __exportStar(require("./annotations/client/requests/index.js"), exports);
 exports.annotations = __importStar(require("./annotations/index.js"));
+__exportStar(require("./attachments/client/requests/index.js"), exports);
+exports.attachments = __importStar(require("./attachments/index.js"));
 __exportStar(require("./forms/client/requests/index.js"), exports);
 exports.forms = __importStar(require("./forms/index.js"));
 __exportStar(require("./metadata/client/requests/index.js"), exports);
 exports.metadata = __importStar(require("./metadata/index.js"));
+__exportStar(require("./outline/client/requests/index.js"), exports);
+exports.outline = __importStar(require("./outline/index.js"));
 __exportStar(require("./pages/client/requests/index.js"), exports);
 exports.pages = __importStar(require("./pages/index.js"));
 __exportStar(require("./redactions/client/requests/index.js"), exports);