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

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

@@ -0,0 +1,17 @@
+import type * as CloudPDF from "../../../../../../index.js";
+/**
+ * @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/cjs/api/resources/doc/resources/signatures/client/requests/AnalysisSignaturesRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -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/cjs/api/resources/doc/resources/signatures/client/requests/DocSignaturesCompleteRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -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/cjs/api/resources/doc/resources/signatures/client/requests/ListSignaturesRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,16 @@
+import type * as core from "../../../../../../../core/index.js";
+/**
+ * @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/cjs/api/resources/doc/resources/signatures/client/requests/PrepareSignaturesRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

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

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

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

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

package/dist/cjs/api/resources/doc/resources/signatures/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.SignaturesClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "SignaturesClient", { enumerable: true, get: function () { return Client_js_1.SignaturesClient; } });
+__exportStar(require("./client/index.js"), exports);

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

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

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

@@ -0,0 +1,18 @@
+"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);
+__exportStar(require("./types/index.js"), exports);

package/dist/cjs/api/resources/doc/resources/signatures/types/AnalysisSignaturesRequestLevel.d.ts

@@ -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/cjs/api/resources/doc/resources/signatures/types/AnalysisSignaturesRequestLevel.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalysisSignaturesRequestLevel = void 0;
+exports.AnalysisSignaturesRequestLevel = {
+    None: "none",
+    Lta: "lta",
+    Fill: "fill",
+    Annotate: "annotate",
+};

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

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

package/dist/cjs/api/resources/doc/resources/signatures/types/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("./AnalysisSignaturesRequestLevel.js"), exports);

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

@@ -0,0 +1,97 @@
+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 VersionsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class VersionsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<VersionsClient.Options>;
+    constructor(options: VersionsClient.Options);
+    /**
+     * Every completed signature publishes a new version. Never cached: the list grows.
+     *
+     * @param {CloudPDF.doc.ListVersionsRequest} request
+     * @param {VersionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.versions.list({
+     *         docId: "docId"
+     *     })
+     */
+    list(request: CloudPDF.doc.ListVersionsRequest, requestOptions?: VersionsClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocVersionsList200Response>;
+    private __list;
+    /**
+     * Exactly one of `since.signature` / `since.revision`; `until=<revision>` defaults to the last. The same answer for every layer and every caller.
+     *
+     * @param {CloudPDF.doc.AnalysisVersionsRequest} request
+     * @param {VersionsClient.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.versions.analysis({
+     *         docId: "docId",
+     *         sha: "sha"
+     *     })
+     */
+    analysis(request: CloudPDF.doc.AnalysisVersionsRequest, requestOptions?: VersionsClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocVersionsAnalysis200Response>;
+    private __analysis;
+    /**
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     */
+    download(request: CloudPDF.doc.DownloadVersionsRequest, requestOptions?: VersionsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __download;
+    /**
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     */
+    revision(request: CloudPDF.doc.RevisionVersionsRequest, requestOptions?: VersionsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __revision;
+    /**
+     * @param {CloudPDF.doc.SignaturesVersionsRequest} request
+     * @param {VersionsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.versions.signatures({
+     *         docId: "docId",
+     *         sha: "sha"
+     *     })
+     */
+    signatures(request: CloudPDF.doc.SignaturesVersionsRequest, requestOptions?: VersionsClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocVersionsSignatures200Response>;
+    private __signatures;
+    /**
+     * `fieldKey` is the field's fully qualified name, token-text encoded (the same encoding attachment keys use).
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     */
+    signatureContents(request: CloudPDF.doc.SignatureContentsVersionsRequest, requestOptions?: VersionsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __signatureContents;
+    /**
+     * What a CMS verifier compares its message digest to.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     */
+    signatureDigest(request: CloudPDF.doc.SignatureDigestVersionsRequest, requestOptions?: VersionsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __signatureDigest;
+}