@cloudpdf/sdk 3.0.0-next.11 → 3.0.0-next.13

package/dist/esm/api/resources/doc/resources/signatures/client/Client.d.mts

@@ -0,0 +1,115 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as CloudPDF from "../../../../../index.mjs";
+export declare namespace SignaturesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class SignaturesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<SignaturesClient.Options>;
+    constructor(options: SignaturesClient.Options);
+    /**
+     * Describes the bytes the layer is over: the base version's signatures plus the layer's own edits as the last revision. Signed bytes (contents, digests, revision prefixes) are served per base version under /versions.
+     *
+     * @param {CloudPDF.doc.ListSignaturesRequest} request
+     * @param {SignaturesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.signatures.list({
+     *         docId: "docId",
+     *         layerName: "layerName"
+     *     })
+     */
+    list(request: CloudPDF.doc.ListSignaturesRequest, requestOptions?: SignaturesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocSignaturesList200Response>;
+    private __list;
+    /**
+     * @param {CloudPDF.doc.AbortSignaturesRequest} request
+     * @param {SignaturesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.signatures.abort({
+     *         docId: "docId",
+     *         layerName: "layerName",
+     *         signingId: "signingId"
+     *     })
+     */
+    abort(request: CloudPDF.doc.AbortSignaturesRequest, requestOptions?: SignaturesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocSignaturesAbort200Response>;
+    private __abort;
+    /**
+     * `cms` is the detached CMS over the prepared digest, base64. `expectedVersion` must be what prepare returned. Idempotent by signing id: the same CMS again answers `already-completed`. Every layer of the document then sits over the new version; refetch the manifest after a completion.
+     *
+     * @param {CloudPDF.doc.DocSignaturesCompleteRequest} request
+     * @param {SignaturesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link CloudPDF.ConflictError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.signatures.complete({
+     *         docId: "docId",
+     *         layerName: "layerName",
+     *         signingId: "signingId",
+     *         cms: "cms",
+     *         expectedVersion: {
+     *             baseSha256: "baseSha256",
+     *             editsVersion: 1
+     *         }
+     *     })
+     */
+    complete(request: CloudPDF.doc.DocSignaturesCompleteRequest, requestOptions?: SignaturesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocSignaturesComplete200Response>;
+    private __complete;
+    /**
+     * Exactly one of `since.signature=<index>` or `since.revision=<index>`; the layer's pending edits are the end. `level=fill|annotate|lta|none` evaluates exploratorily and never becomes a verdict. For history between two base revisions use the version analysis.
+     *
+     * @param {CloudPDF.doc.AnalysisSignaturesRequest} request
+     * @param {SignaturesClient.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.signatures.analysis({
+     *         docId: "docId",
+     *         layerName: "layerName"
+     *     })
+     */
+    analysis(request: CloudPDF.doc.AnalysisSignaturesRequest, requestOptions?: SignaturesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocSignaturesAnalysis200Response>;
+    private __analysis;
+    /**
+     * The multipart envelope: a JSON `body` part (field, subFilter, digest, contentsSize, signer, certify, lock, appearance) and an optional `resource:<key>` PDF part the body's `appearance.resource` names. A certification (`certify.permission`) additionally requires `doc.sign.certify`. The layer is read-only until the signing completes, is aborted, or expires (15 minutes). A layer behind the document head cannot sign (StaleBase).
+     *
+     * @param {CloudPDF.doc.PrepareSignaturesRequest} request
+     * @param {SignaturesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link CloudPDF.ConflictError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.doc.signatures.prepare({
+     *         file: fs.createReadStream("/path/to/your/file"),
+     *         docId: "docId",
+     *         layerName: "layerName"
+     *     })
+     */
+    prepare(request: CloudPDF.doc.PrepareSignaturesRequest, requestOptions?: SignaturesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocSignaturesPrepare200Response>;
+    private __prepare;
+}

package/dist/esm/api/resources/doc/resources/signatures/client/Client.mjs

@@ -0,0 +1,357 @@
+// This file was auto-generated by Fern from our API Definition.
+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());
+    });
+};
+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;
+};
+import { normalizeClientOptionsWithAuth } from "../../../../../../BaseClient.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import { mergeAdditionalBodyParameters } from "../../../../../../core/requestBody.mjs";
+import { handleNonStatusCodeError } from "../../../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../../../errors/index.mjs";
+import * as CloudPDF from "../../../../../index.mjs";
+export class SignaturesClient {
+    constructor(options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * Describes the bytes the layer is over: the base version's signatures plus the layer's own edits as the last revision. Signed bytes (contents, digests, revision prefixes) are served per base version under /versions.
+     *
+     * @param {CloudPDF.doc.ListSignaturesRequest} request
+     * @param {SignaturesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.signatures.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 = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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)}/signatures`),
+                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 handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/docs/{docId}/layers/{layerName}/signatures");
+        });
+    }
+    /**
+     * @param {CloudPDF.doc.AbortSignaturesRequest} request
+     * @param {SignaturesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.signatures.abort({
+     *         docId: "docId",
+     *         layerName: "layerName",
+     *         signingId: "signingId"
+     *     })
+     */
+    abort(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__abort(request, requestOptions));
+    }
+    __abort(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { docId, layerName, signingId, "X-Document-Password": documentPassword } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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)}/signatures/${core.url.encodePathParam(signingId)}`),
+                method: "DELETE",
+                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 handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v1/docs/{docId}/layers/{layerName}/signatures/{signingId}");
+        });
+    }
+    /**
+     * `cms` is the detached CMS over the prepared digest, base64. `expectedVersion` must be what prepare returned. Idempotent by signing id: the same CMS again answers `already-completed`. Every layer of the document then sits over the new version; refetch the manifest after a completion.
+     *
+     * @param {CloudPDF.doc.DocSignaturesCompleteRequest} request
+     * @param {SignaturesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link CloudPDF.ConflictError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.signatures.complete({
+     *         docId: "docId",
+     *         layerName: "layerName",
+     *         signingId: "signingId",
+     *         cms: "cms",
+     *         expectedVersion: {
+     *             baseSha256: "baseSha256",
+     *             editsVersion: 1
+     *         }
+     *     })
+     */
+    complete(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__complete(request, requestOptions));
+    }
+    __complete(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { docId, layerName, signingId, "X-Document-Password": documentPassword } = request, _body = __rest(request, ["docId", "layerName", "signingId", "X-Document-Password"]);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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)}/signatures/${core.url.encodePathParam(signingId)}/complete`),
+                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: 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);
+                    default:
+                        throw new errors.CloudPDFError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/signatures/{signingId}/complete");
+        });
+    }
+    /**
+     * Exactly one of `since.signature=<index>` or `since.revision=<index>`; the layer's pending edits are the end. `level=fill|annotate|lta|none` evaluates exploratorily and never becomes a verdict. For history between two base revisions use the version analysis.
+     *
+     * @param {CloudPDF.doc.AnalysisSignaturesRequest} request
+     * @param {SignaturesClient.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.signatures.analysis({
+     *         docId: "docId",
+     *         layerName: "layerName"
+     *     })
+     */
+    analysis(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__analysis(request, requestOptions));
+    }
+    __analysis(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { docId, layerName, "since.signature": sinceSignature, "since.revision": sinceRevision, level, "X-Document-Password": documentPassword, } = request;
+            const _queryParams = {
+                "since.signature": sinceSignature,
+                "since.revision": sinceRevision,
+                level: level != null ? level : undefined,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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)}/signatures/analysis`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .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 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 handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v1/docs/{docId}/layers/{layerName}/signatures/analysis");
+        });
+    }
+    /**
+     * The multipart envelope: a JSON `body` part (field, subFilter, digest, contentsSize, signer, certify, lock, appearance) and an optional `resource:<key>` PDF part the body's `appearance.resource` names. A certification (`certify.permission`) additionally requires `doc.sign.certify`. The layer is read-only until the signing completes, is aborted, or expires (15 minutes). A layer behind the document head cannot sign (StaleBase).
+     *
+     * @param {CloudPDF.doc.PrepareSignaturesRequest} request
+     * @param {SignaturesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.BadRequestError}
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link CloudPDF.ConflictError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.doc.signatures.prepare({
+     *         file: fs.createReadStream("/path/to/your/file"),
+     *         docId: "docId",
+     *         layerName: "layerName"
+     *     })
+     */
+    prepare(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__prepare(request, requestOptions));
+    }
+    __prepare(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const _body = yield core.newFormData();
+            yield _body.appendFile("file", request.file);
+            const _maybeEncodedRequest = yield _body.getRequest();
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({ "X-Document-Password": request["X-Document-Password"] }, _maybeEncodedRequest.headers)), 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(request.docId)}/layers/${core.url.encodePathParam(request.layerName)}/signatures/prepare`),
+                method: "POST",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
+                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);
+                    default:
+                        throw new errors.CloudPDFError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/docs/{docId}/layers/{layerName}/signatures/prepare");
+        });
+    }
+}

package/dist/esm/api/resources/doc/resources/signatures/client/index.d.mts

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

package/dist/esm/api/resources/doc/resources/signatures/client/index.mjs

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

package/dist/esm/api/resources/doc/resources/signatures/client/requests/AbortSignaturesRequest.d.mts

@@ -0,0 +1,15 @@
+/**
+ * @example
+ *     {
+ *         docId: "docId",
+ *         layerName: "layerName",
+ *         signingId: "signingId"
+ *     }
+ */
+export interface AbortSignaturesRequest {
+    docId: string;
+    layerName: string;
+    signingId: 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/esm/api/resources/doc/resources/signatures/client/requests/AbortSignaturesRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/doc/resources/signatures/client/requests/AnalysisSignaturesRequest.d.mts

@@ -0,0 +1,17 @@
+import type * as CloudPDF from "../../../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         docId: "docId",
+ *         layerName: "layerName"
+ *     }
+ */
+export interface AnalysisSignaturesRequest {
+    docId: string;
+    layerName: string;
+    "since.signature"?: number;
+    "since.revision"?: number;
+    level?: CloudPDF.doc.AnalysisSignaturesRequestLevel;
+    /** 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/esm/api/resources/doc/resources/signatures/client/requests/AnalysisSignaturesRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/doc/resources/signatures/client/requests/DocSignaturesCompleteRequest.d.mts

@@ -0,0 +1,28 @@
+/**
+ * @example
+ *     {
+ *         docId: "docId",
+ *         layerName: "layerName",
+ *         signingId: "signingId",
+ *         cms: "cms",
+ *         expectedVersion: {
+ *             baseSha256: "baseSha256",
+ *             editsVersion: 1
+ *         }
+ *     }
+ */
+export interface DocSignaturesCompleteRequest {
+    docId: string;
+    layerName: string;
+    signingId: 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;
+    cms: string;
+    expectedVersion: DocSignaturesCompleteRequest.ExpectedVersion;
+}
+export declare namespace DocSignaturesCompleteRequest {
+    interface ExpectedVersion {
+        baseSha256: string;
+        editsVersion: number;
+    }
+}

package/dist/esm/api/resources/doc/resources/signatures/client/requests/DocSignaturesCompleteRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/doc/resources/signatures/client/requests/ListSignaturesRequest.d.mts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         docId: "docId",
+ *         layerName: "layerName"
+ *     }
+ */
+export interface ListSignaturesRequest {
+    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;
+}

package/dist/esm/api/resources/doc/resources/signatures/client/requests/ListSignaturesRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/doc/resources/signatures/client/requests/PrepareSignaturesRequest.d.mts

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

package/dist/esm/api/resources/doc/resources/signatures/client/requests/PrepareSignaturesRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/doc/resources/signatures/client/requests/index.d.mts

@@ -0,0 +1,5 @@
+export type { AbortSignaturesRequest } from "./AbortSignaturesRequest.mjs";
+export type { AnalysisSignaturesRequest } from "./AnalysisSignaturesRequest.mjs";
+export type { DocSignaturesCompleteRequest } from "./DocSignaturesCompleteRequest.mjs";
+export type { ListSignaturesRequest } from "./ListSignaturesRequest.mjs";
+export type { PrepareSignaturesRequest } from "./PrepareSignaturesRequest.mjs";

package/dist/esm/api/resources/doc/resources/signatures/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/doc/resources/signatures/exports.d.mts

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

package/dist/esm/api/resources/doc/resources/signatures/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { SignaturesClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/doc/resources/signatures/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/doc/resources/signatures/index.mjs

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/doc/resources/signatures/types/AnalysisSignaturesRequestLevel.d.mts

@@ -0,0 +1,7 @@
+export declare const AnalysisSignaturesRequestLevel: {
+    readonly None: "none";
+    readonly Lta: "lta";
+    readonly Fill: "fill";
+    readonly Annotate: "annotate";
+};
+export type AnalysisSignaturesRequestLevel = (typeof AnalysisSignaturesRequestLevel)[keyof typeof AnalysisSignaturesRequestLevel];

package/dist/esm/api/resources/doc/resources/signatures/types/AnalysisSignaturesRequestLevel.mjs

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+export const AnalysisSignaturesRequestLevel = {
+    None: "none",
+    Lta: "lta",
+    Fill: "fill",
+    Annotate: "annotate",
+};

package/dist/esm/api/resources/doc/resources/signatures/types/index.d.mts

@@ -0,0 +1 @@
+export * from "./AnalysisSignaturesRequestLevel.mjs";