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

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

@@ -47,13 +47,16 @@ __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemHighlightRef
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemInkInReplyTo.js"), exports);
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemInkRef.js"), exports);
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemLineInReplyTo.js"), exports);
+__exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemLineMeasure.js"), exports);
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemLineRef.js"), exports);
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemLinkInReplyTo.js"), exports);
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemLinkRef.js"), exports);
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemLinkTarget.js"), exports);
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemPolygonInReplyTo.js"), exports);
+__exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemPolygonMeasure.js"), exports);
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemPolygonRef.js"), exports);
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemPolylineInReplyTo.js"), exports);
+__exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemPolylineMeasure.js"), exports);
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemPolylineRef.js"), exports);
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemRedactInReplyTo.js"), exports);
 __exportStar(require("./DocAnnotationsList200ResponseAnnotationsItemRedactRef.js"), exports);
@@ -90,13 +93,16 @@ __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItem
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemInkInReplyTo.js"), exports);
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemInkRef.js"), exports);
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemLineInReplyTo.js"), exports);
+__exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemLineMeasure.js"), exports);
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemLineRef.js"), exports);
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemLinkInReplyTo.js"), exports);
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemLinkRef.js"), exports);
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemLinkTarget.js"), exports);
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemPolygonInReplyTo.js"), exports);
+__exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemPolygonMeasure.js"), exports);
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemPolygonRef.js"), exports);
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemPolylineInReplyTo.js"), exports);
+__exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemPolylineMeasure.js"), exports);
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemPolylineRef.js"), exports);
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemRedactInReplyTo.js"), exports);
 __exportStar(require("./DocAnnotationsListAll200ResponsePagesItemAnnotationsItemRedactRef.js"), exports);
@@ -216,12 +222,38 @@ __exportStar(require("./DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnot
 __exportStar(require("./DocPagesSetName400Response.js"), exports);
 __exportStar(require("./DocPagesSetName404Response.js"), exports);
 __exportStar(require("./DocPagesSetNameRequest.js"), exports);
+__exportStar(require("./DocPagesSetScale200Response.js"), exports);
+__exportStar(require("./DocPagesSetScale200ResponseMetaAffectedPagesItemWeakAnnotationState.js"), exports);
+__exportStar(require("./DocPagesSetScale400Response.js"), exports);
+__exportStar(require("./DocPagesSetScale404Response.js"), exports);
+__exportStar(require("./DocPagesViewports200Response.js"), exports);
+__exportStar(require("./DocPagesViewports200ResponseItem.js"), exports);
+__exportStar(require("./DocPagesViewports200ResponseItemMeasure.js"), exports);
+__exportStar(require("./DocPagesViewports404Response.js"), exports);
 __exportStar(require("./DocRedactionsApply200Response.js"), exports);
 __exportStar(require("./DocRedactionsApply200ResponseMetaAffectedPagesItemWeakAnnotationState.js"), exports);
 __exportStar(require("./DocRedactionsApply400Response.js"), exports);
 __exportStar(require("./DocRedactionsApply404Response.js"), exports);
 __exportStar(require("./DocRedactionsApplyRequest.js"), exports);
 __exportStar(require("./DocRenderResponse.js"), exports);
+__exportStar(require("./DocSignaturesAbort200Response.js"), exports);
+__exportStar(require("./DocSignaturesAbort404Response.js"), exports);
+__exportStar(require("./DocSignaturesAnalysis200Response.js"), exports);
+__exportStar(require("./DocSignaturesAnalysis400Response.js"), exports);
+__exportStar(require("./DocSignaturesAnalysis404Response.js"), exports);
+__exportStar(require("./DocSignaturesComplete200Response.js"), exports);
+__exportStar(require("./DocSignaturesComplete200ResponseMetaAffectedPagesItemWeakAnnotationState.js"), exports);
+__exportStar(require("./DocSignaturesComplete200ResponseSignatureField.js"), exports);
+__exportStar(require("./DocSignaturesComplete400Response.js"), exports);
+__exportStar(require("./DocSignaturesComplete404Response.js"), exports);
+__exportStar(require("./DocSignaturesComplete409Response.js"), exports);
+__exportStar(require("./DocSignaturesList200Response.js"), exports);
+__exportStar(require("./DocSignaturesList200ResponseSignaturesItemField.js"), exports);
+__exportStar(require("./DocSignaturesList404Response.js"), exports);
+__exportStar(require("./DocSignaturesPrepare200Response.js"), exports);
+__exportStar(require("./DocSignaturesPrepare400Response.js"), exports);
+__exportStar(require("./DocSignaturesPrepare404Response.js"), exports);
+__exportStar(require("./DocSignaturesPrepare409Response.js"), exports);
 __exportStar(require("./DocText200Response.js"), exports);
 __exportStar(require("./DocText404Response.js"), exports);
 __exportStar(require("./DocumentActionsSnapshot.js"), exports);
@@ -250,6 +282,18 @@ __exportStar(require("./DocumentsThumbnailResponse.js"), exports);
 __exportStar(require("./DocumentsUploadProxy200Response.js"), exports);
 __exportStar(require("./DocumentsUploadProxy400Response.js"), exports);
 __exportStar(require("./DocumentsUploadProxy409Response.js"), exports);
+__exportStar(require("./DocVersionsAnalysis200Response.js"), exports);
+__exportStar(require("./DocVersionsAnalysis400Response.js"), exports);
+__exportStar(require("./DocVersionsAnalysis404Response.js"), exports);
+__exportStar(require("./DocVersionsDownloadResponse.js"), exports);
+__exportStar(require("./DocVersionsList200Response.js"), exports);
+__exportStar(require("./DocVersionsList404Response.js"), exports);
+__exportStar(require("./DocVersionsRevisionResponse.js"), exports);
+__exportStar(require("./DocVersionsSignatureContentsResponse.js"), exports);
+__exportStar(require("./DocVersionsSignatureDigestResponse.js"), exports);
+__exportStar(require("./DocVersionsSignatures200Response.js"), exports);
+__exportStar(require("./DocVersionsSignatures200ResponseSignaturesItemField.js"), exports);
+__exportStar(require("./DocVersionsSignatures404Response.js"), exports);
 __exportStar(require("./EngineErrorPayload.js"), exports);
 __exportStar(require("./PdfActionNode.js"), exports);
 __exportStar(require("./PdfActionTargetRef.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.0.0-next.12";
+export declare const SDK_VERSION = "3.0.0-next.14";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "3.0.0-next.12";
+exports.SDK_VERSION = "3.0.0-next.14";

package/dist/esm/BaseClient.mjs

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

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

@@ -7,6 +7,8 @@ import { FormsClient } from "../resources/forms/client/Client.mjs";
 import { MetadataClient } from "../resources/metadata/client/Client.mjs";
 import { PagesClient } from "../resources/pages/client/Client.mjs";
 import { RedactionsClient } from "../resources/redactions/client/Client.mjs";
+import { SignaturesClient } from "../resources/signatures/client/Client.mjs";
+import { VersionsClient } from "../resources/versions/client/Client.mjs";
 export declare namespace DocClient {
     type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
@@ -19,12 +21,16 @@ export declare class DocClient {
     protected _metadata: MetadataClient | 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 forms(): FormsClient;
     get metadata(): MetadataClient;
     get pages(): PagesClient;
     get redactions(): RedactionsClient;
+    get signatures(): SignaturesClient;
+    get versions(): VersionsClient;
     /**
      * @param {CloudPDF.HeadDocRequest} request
      * @param {DocClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -19,6 +19,8 @@ import { FormsClient } from "../resources/forms/client/Client.mjs";
 import { MetadataClient } from "../resources/metadata/client/Client.mjs";
 import { PagesClient } from "../resources/pages/client/Client.mjs";
 import { RedactionsClient } from "../resources/redactions/client/Client.mjs";
+import { SignaturesClient } from "../resources/signatures/client/Client.mjs";
+import { VersionsClient } from "../resources/versions/client/Client.mjs";
 export class DocClient {
     constructor(options) {
         this._options = normalizeClientOptionsWithAuth(options);
@@ -43,6 +45,14 @@ export class DocClient {
         var _a;
         return ((_a = this._redactions) !== null && _a !== void 0 ? _a : (this._redactions = new RedactionsClient(this._options)));
     }
+    get signatures() {
+        var _a;
+        return ((_a = this._signatures) !== null && _a !== void 0 ? _a : (this._signatures = new SignaturesClient(this._options)));
+    }
+    get versions() {
+        var _a;
+        return ((_a = this._versions) !== null && _a !== void 0 ? _a : (this._versions = new VersionsClient(this._options)));
+    }
     /**
      * @param {CloudPDF.HeadDocRequest} request
      * @param {DocClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -9,3 +9,9 @@ export * from "./pages/client/requests/index.mjs";
 export * as pages from "./pages/index.mjs";
 export * from "./redactions/client/requests/index.mjs";
 export * as redactions from "./redactions/index.mjs";
+export * from "./signatures/client/requests/index.mjs";
+export * as signatures from "./signatures/index.mjs";
+export * from "./signatures/types/index.mjs";
+export * from "./versions/client/requests/index.mjs";
+export * as versions from "./versions/index.mjs";
+export * from "./versions/types/index.mjs";

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

@@ -9,3 +9,9 @@ export * from "./pages/client/requests/index.mjs";
 export * as pages from "./pages/index.mjs";
 export * from "./redactions/client/requests/index.mjs";
 export * as redactions from "./redactions/index.mjs";
+export * from "./signatures/client/requests/index.mjs";
+export * as signatures from "./signatures/index.mjs";
+export * from "./signatures/types/index.mjs";
+export * from "./versions/client/requests/index.mjs";
+export * as versions from "./versions/index.mjs";
+export * from "./versions/types/index.mjs";

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

@@ -10,6 +10,41 @@ export declare namespace PagesClient {
 export declare class PagesClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PagesClient.Options>;
     constructor(options: PagesClient.Options);
+    /**
+     * @param {CloudPDF.doc.DocPagesSetScaleRequest} request
+     * @param {PagesClient.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.pages.setScale({
+     *         docId: "docId",
+     *         layerName: "layerName",
+     *         pon: 1
+     *     })
+     */
+    setScale(request: CloudPDF.doc.DocPagesSetScaleRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesSetScale200Response>;
+    private __setScale;
+    /**
+     * @param {CloudPDF.doc.ViewportsPagesRequest} request
+     * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.pages.viewports({
+     *         docId: "docId",
+     *         layerName: "layerName",
+     *         pon: 1
+     *     })
+     */
+    viewports(request: CloudPDF.doc.ViewportsPagesRequest, requestOptions?: PagesClient.RequestOptions): core.HttpResponsePromise<CloudPDF.DocPagesViewports200Response>;
+    private __viewports;
     /**
      * @param {CloudPDF.doc.DeletePagesRequest} request
      * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -8,6 +8,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;
+};
 import { normalizeClientOptionsWithAuth } from "../../../../../../BaseClient.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
 import * as core from "../../../../../../core/index.mjs";
@@ -19,6 +30,121 @@ export class PagesClient {
     constructor(options) {
         this._options = normalizeClientOptionsWithAuth(options);
     }
+    /**
+     * @param {CloudPDF.doc.DocPagesSetScaleRequest} request
+     * @param {PagesClient.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.pages.setScale({
+     *         docId: "docId",
+     *         layerName: "layerName",
+     *         pon: 1
+     *     })
+     */
+    setScale(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__setScale(request, requestOptions));
+    }
+    __setScale(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, _body = __rest(request, ["docId", "layerName", "pon", "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)}/pages/${core.url.encodePathParam(pon)}/scale`),
+                method: "PUT",
+                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);
+                    default:
+                        throw new errors.CloudPDFError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v1/docs/{docId}/layers/{layerName}/pages/{pon}/scale");
+        });
+    }
+    /**
+     * @param {CloudPDF.doc.ViewportsPagesRequest} request
+     * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CloudPDF.NotFoundError}
+     * @throws {@link errors.CloudPDFError}
+     * @throws {@link errors.CloudPDFTimeoutError}
+     *
+     * @example
+     *     await client.doc.pages.viewports({
+     *         docId: "docId",
+     *         layerName: "layerName",
+     *         pon: 1
+     *     })
+     */
+    viewports(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__viewports(request, requestOptions));
+    }
+    __viewports(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 _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)}/pages/${core.url.encodePathParam(pon)}/viewports`),
+                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}/pages/{pon}/viewports");
+        });
+    }
     /**
      * @param {CloudPDF.doc.DeletePagesRequest} request
      * @param {PagesClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/doc/resources/pages/client/requests/DocPagesSetScaleRequest.d.mts

@@ -0,0 +1,214 @@
+/**
+ * @example
+ *     {
+ *         docId: "docId",
+ *         layerName: "layerName",
+ *         pon: 1
+ *     }
+ */
+export interface DocPagesSetScaleRequest {
+    docId: string;
+    layerName: string;
+    pon: number;
+    /** 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;
+    measure: DocPagesSetScaleRequest.Measure | null;
+}
+export declare namespace DocPagesSetScaleRequest {
+    interface Measure {
+        subtype: Measure.Subtype;
+        ratio?: string | undefined;
+        x: Measure.X.Item[];
+        y?: Measure.Y.Item[] | undefined;
+        distance: Measure.Distance.Item[];
+        area: Measure.Area.Item[];
+        angle?: Measure.Angle.Item[] | undefined;
+        slope?: Measure.Slope.Item[] | undefined;
+        origin?: Measure.Origin | undefined;
+        cyx?: number | undefined;
+    }
+    namespace Measure {
+        const Subtype: {
+            readonly Rl: "RL";
+        };
+        type Subtype = (typeof Subtype)[keyof typeof Subtype];
+        type X = X.Item[];
+        namespace X {
+            interface Item {
+                unit: string;
+                conversion: number;
+                fraction?: Item.Fraction | undefined;
+                precision?: number | undefined;
+                fixed?: boolean | undefined;
+                thousands?: string | undefined;
+                decimal?: string | undefined;
+                prefixSpacing?: string | undefined;
+                suffixSpacing?: string | undefined;
+                labelPosition?: Item.LabelPosition | undefined;
+            }
+            namespace Item {
+                const Fraction: {
+                    readonly Decimal: "decimal";
+                    readonly Fraction: "fraction";
+                    readonly Round: "round";
+                    readonly Truncate: "truncate";
+                };
+                type Fraction = (typeof Fraction)[keyof typeof Fraction];
+                const LabelPosition: {
+                    readonly Suffix: "suffix";
+                    readonly Prefix: "prefix";
+                };
+                type LabelPosition = (typeof LabelPosition)[keyof typeof LabelPosition];
+            }
+        }
+        type Y = Y.Item[];
+        namespace Y {
+            interface Item {
+                unit: string;
+                conversion: number;
+                fraction?: Item.Fraction | undefined;
+                precision?: number | undefined;
+                fixed?: boolean | undefined;
+                thousands?: string | undefined;
+                decimal?: string | undefined;
+                prefixSpacing?: string | undefined;
+                suffixSpacing?: string | undefined;
+                labelPosition?: Item.LabelPosition | undefined;
+            }
+            namespace Item {
+                const Fraction: {
+                    readonly Decimal: "decimal";
+                    readonly Fraction: "fraction";
+                    readonly Round: "round";
+                    readonly Truncate: "truncate";
+                };
+                type Fraction = (typeof Fraction)[keyof typeof Fraction];
+                const LabelPosition: {
+                    readonly Suffix: "suffix";
+                    readonly Prefix: "prefix";
+                };
+                type LabelPosition = (typeof LabelPosition)[keyof typeof LabelPosition];
+            }
+        }
+        type Distance = Distance.Item[];
+        namespace Distance {
+            interface Item {
+                unit: string;
+                conversion: number;
+                fraction?: Item.Fraction | undefined;
+                precision?: number | undefined;
+                fixed?: boolean | undefined;
+                thousands?: string | undefined;
+                decimal?: string | undefined;
+                prefixSpacing?: string | undefined;
+                suffixSpacing?: string | undefined;
+                labelPosition?: Item.LabelPosition | undefined;
+            }
+            namespace Item {
+                const Fraction: {
+                    readonly Decimal: "decimal";
+                    readonly Fraction: "fraction";
+                    readonly Round: "round";
+                    readonly Truncate: "truncate";
+                };
+                type Fraction = (typeof Fraction)[keyof typeof Fraction];
+                const LabelPosition: {
+                    readonly Suffix: "suffix";
+                    readonly Prefix: "prefix";
+                };
+                type LabelPosition = (typeof LabelPosition)[keyof typeof LabelPosition];
+            }
+        }
+        type Area = Area.Item[];
+        namespace Area {
+            interface Item {
+                unit: string;
+                conversion: number;
+                fraction?: Item.Fraction | undefined;
+                precision?: number | undefined;
+                fixed?: boolean | undefined;
+                thousands?: string | undefined;
+                decimal?: string | undefined;
+                prefixSpacing?: string | undefined;
+                suffixSpacing?: string | undefined;
+                labelPosition?: Item.LabelPosition | undefined;
+            }
+            namespace Item {
+                const Fraction: {
+                    readonly Decimal: "decimal";
+                    readonly Fraction: "fraction";
+                    readonly Round: "round";
+                    readonly Truncate: "truncate";
+                };
+                type Fraction = (typeof Fraction)[keyof typeof Fraction];
+                const LabelPosition: {
+                    readonly Suffix: "suffix";
+                    readonly Prefix: "prefix";
+                };
+                type LabelPosition = (typeof LabelPosition)[keyof typeof LabelPosition];
+            }
+        }
+        type Angle = Angle.Item[];
+        namespace Angle {
+            interface Item {
+                unit: string;
+                conversion: number;
+                fraction?: Item.Fraction | undefined;
+                precision?: number | undefined;
+                fixed?: boolean | undefined;
+                thousands?: string | undefined;
+                decimal?: string | undefined;
+                prefixSpacing?: string | undefined;
+                suffixSpacing?: string | undefined;
+                labelPosition?: Item.LabelPosition | undefined;
+            }
+            namespace Item {
+                const Fraction: {
+                    readonly Decimal: "decimal";
+                    readonly Fraction: "fraction";
+                    readonly Round: "round";
+                    readonly Truncate: "truncate";
+                };
+                type Fraction = (typeof Fraction)[keyof typeof Fraction];
+                const LabelPosition: {
+                    readonly Suffix: "suffix";
+                    readonly Prefix: "prefix";
+                };
+                type LabelPosition = (typeof LabelPosition)[keyof typeof LabelPosition];
+            }
+        }
+        type Slope = Slope.Item[];
+        namespace Slope {
+            interface Item {
+                unit: string;
+                conversion: number;
+                fraction?: Item.Fraction | undefined;
+                precision?: number | undefined;
+                fixed?: boolean | undefined;
+                thousands?: string | undefined;
+                decimal?: string | undefined;
+                prefixSpacing?: string | undefined;
+                suffixSpacing?: string | undefined;
+                labelPosition?: Item.LabelPosition | undefined;
+            }
+            namespace Item {
+                const Fraction: {
+                    readonly Decimal: "decimal";
+                    readonly Fraction: "fraction";
+                    readonly Round: "round";
+                    readonly Truncate: "truncate";
+                };
+                type Fraction = (typeof Fraction)[keyof typeof Fraction];
+                const LabelPosition: {
+                    readonly Suffix: "suffix";
+                    readonly Prefix: "prefix";
+                };
+                type LabelPosition = (typeof LabelPosition)[keyof typeof LabelPosition];
+            }
+        }
+        interface Origin {
+            x: number;
+            y: number;
+        }
+    }
+}