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

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;
+        }
+    }
+}

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

@@ -0,0 +1,106 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DocPagesSetScaleRequest;
+(function (DocPagesSetScaleRequest) {
+    let Measure;
+    (function (Measure) {
+        Measure.Subtype = {
+            Rl: "RL",
+        };
+        let X;
+        (function (X) {
+            let Item;
+            (function (Item) {
+                Item.Fraction = {
+                    Decimal: "decimal",
+                    Fraction: "fraction",
+                    Round: "round",
+                    Truncate: "truncate",
+                };
+                Item.LabelPosition = {
+                    Suffix: "suffix",
+                    Prefix: "prefix",
+                };
+            })(Item = X.Item || (X.Item = {}));
+        })(X = Measure.X || (Measure.X = {}));
+        let Y;
+        (function (Y) {
+            let Item;
+            (function (Item) {
+                Item.Fraction = {
+                    Decimal: "decimal",
+                    Fraction: "fraction",
+                    Round: "round",
+                    Truncate: "truncate",
+                };
+                Item.LabelPosition = {
+                    Suffix: "suffix",
+                    Prefix: "prefix",
+                };
+            })(Item = Y.Item || (Y.Item = {}));
+        })(Y = Measure.Y || (Measure.Y = {}));
+        let Distance;
+        (function (Distance) {
+            let Item;
+            (function (Item) {
+                Item.Fraction = {
+                    Decimal: "decimal",
+                    Fraction: "fraction",
+                    Round: "round",
+                    Truncate: "truncate",
+                };
+                Item.LabelPosition = {
+                    Suffix: "suffix",
+                    Prefix: "prefix",
+                };
+            })(Item = Distance.Item || (Distance.Item = {}));
+        })(Distance = Measure.Distance || (Measure.Distance = {}));
+        let Area;
+        (function (Area) {
+            let Item;
+            (function (Item) {
+                Item.Fraction = {
+                    Decimal: "decimal",
+                    Fraction: "fraction",
+                    Round: "round",
+                    Truncate: "truncate",
+                };
+                Item.LabelPosition = {
+                    Suffix: "suffix",
+                    Prefix: "prefix",
+                };
+            })(Item = Area.Item || (Area.Item = {}));
+        })(Area = Measure.Area || (Measure.Area = {}));
+        let Angle;
+        (function (Angle) {
+            let Item;
+            (function (Item) {
+                Item.Fraction = {
+                    Decimal: "decimal",
+                    Fraction: "fraction",
+                    Round: "round",
+                    Truncate: "truncate",
+                };
+                Item.LabelPosition = {
+                    Suffix: "suffix",
+                    Prefix: "prefix",
+                };
+            })(Item = Angle.Item || (Angle.Item = {}));
+        })(Angle = Measure.Angle || (Measure.Angle = {}));
+        let Slope;
+        (function (Slope) {
+            let Item;
+            (function (Item) {
+                Item.Fraction = {
+                    Decimal: "decimal",
+                    Fraction: "fraction",
+                    Round: "round",
+                    Truncate: "truncate",
+                };
+                Item.LabelPosition = {
+                    Suffix: "suffix",
+                    Prefix: "prefix",
+                };
+            })(Item = Slope.Item || (Slope.Item = {}));
+        })(Slope = Measure.Slope || (Measure.Slope = {}));
+    })(Measure = DocPagesSetScaleRequest.Measure || (DocPagesSetScaleRequest.Measure = {}));
+})(DocPagesSetScaleRequest || (DocPagesSetScaleRequest = {}));

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

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

package/dist/esm/api/resources/doc/resources/pages/client/requests/ViewportsPagesRequest.mjs

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

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

@@ -1,4 +1,5 @@
 export type { DeletePagesRequest } from "./DeletePagesRequest.mjs";
+export { DocPagesSetScaleRequest } from "./DocPagesSetScaleRequest.mjs";
 export type { ExtractPagesRequest } from "./ExtractPagesRequest.mjs";
 export type { FlattenPagesRequest } from "./FlattenPagesRequest.mjs";
 export type { InsertBlankPagesRequest } from "./InsertBlankPagesRequest.mjs";
@@ -7,3 +8,4 @@ export type { MovePagesRequest } from "./MovePagesRequest.mjs";
 export type { RemoveNamePagesRequest } from "./RemoveNamePagesRequest.mjs";
 export type { RotatePagesRequest } from "./RotatePagesRequest.mjs";
 export type { SetNamePagesRequest } from "./SetNamePagesRequest.mjs";
+export type { ViewportsPagesRequest } from "./ViewportsPagesRequest.mjs";

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

@@ -1 +1 @@
-export {};
+export { DocPagesSetScaleRequest } from "./DocPagesSetScaleRequest.mjs";

package/dist/esm/api/types/DocAnnotationsList200ResponseAnnotationsItem.d.mts

@@ -658,6 +658,9 @@ export declare namespace DocAnnotationsList200ResponseAnnotationsItem {
     }
     interface Polygon {
         subtype: "polygon";
+        intent?: DocAnnotationsList200ResponseAnnotationsItemPolygon.Intent | undefined;
+        measure?: CloudPDF.DocAnnotationsList200ResponseAnnotationsItemPolygonMeasure | undefined;
+        caption?: DocAnnotationsList200ResponseAnnotationsItemPolygon.Caption | undefined;
         ref: CloudPDF.DocAnnotationsList200ResponseAnnotationsItemPolygonRef;
         pageObjectNumber: number;
         index: number;
@@ -689,6 +692,21 @@ export declare namespace DocAnnotationsList200ResponseAnnotationsItem {
         cloudyIntensity: number | null;
     }
     namespace DocAnnotationsList200ResponseAnnotationsItemPolygon {
+        const Intent: {
+            readonly PolygonCloud: "PolygonCloud";
+            readonly PolygonDimension: "PolygonDimension";
+        };
+        type Intent = (typeof Intent)[keyof typeof Intent];
+        interface Caption {
+            enabled: boolean;
+            center?: Caption.Center | undefined;
+        }
+        namespace Caption {
+            interface Center {
+                x: number;
+                y: number;
+            }
+        }
         const IdentityQuality: {
             readonly Durable: "durable";
             readonly Weak: "weak";
@@ -763,6 +781,9 @@ export declare namespace DocAnnotationsList200ResponseAnnotationsItem {
     }
     interface Polyline {
         subtype: "polyline";
+        intent?: DocAnnotationsList200ResponseAnnotationsItemPolyline.Intent | undefined;
+        measure?: CloudPDF.DocAnnotationsList200ResponseAnnotationsItemPolylineMeasure | undefined;
+        caption?: DocAnnotationsList200ResponseAnnotationsItemPolyline.Caption | undefined;
         ref: CloudPDF.DocAnnotationsList200ResponseAnnotationsItemPolylineRef;
         pageObjectNumber: number;
         index: number;
@@ -794,6 +815,20 @@ export declare namespace DocAnnotationsList200ResponseAnnotationsItem {
         lineEndings: DocAnnotationsList200ResponseAnnotationsItemPolyline.LineEndings;
     }
     namespace DocAnnotationsList200ResponseAnnotationsItemPolyline {
+        const Intent: {
+            readonly PolyLineDimension: "PolyLineDimension";
+        };
+        type Intent = (typeof Intent)[keyof typeof Intent];
+        interface Caption {
+            enabled: boolean;
+            center?: Caption.Center | undefined;
+        }
+        namespace Caption {
+            interface Center {
+                x: number;
+                y: number;
+            }
+        }
         const IdentityQuality: {
             readonly Durable: "durable";
             readonly Weak: "weak";
@@ -900,6 +935,10 @@ export declare namespace DocAnnotationsList200ResponseAnnotationsItem {
     }
     interface Line {
         subtype: "line";
+        intent?: DocAnnotationsList200ResponseAnnotationsItemLine.Intent | undefined;
+        measure?: CloudPDF.DocAnnotationsList200ResponseAnnotationsItemLineMeasure | undefined;
+        caption?: DocAnnotationsList200ResponseAnnotationsItemLine.Caption | undefined;
+        leader?: DocAnnotationsList200ResponseAnnotationsItemLine.Leader | undefined;
         ref: CloudPDF.DocAnnotationsList200ResponseAnnotationsItemLineRef;
         pageObjectNumber: number;
         index: number;
@@ -931,6 +970,32 @@ export declare namespace DocAnnotationsList200ResponseAnnotationsItem {
         rotation?: number | undefined;
     }
     namespace DocAnnotationsList200ResponseAnnotationsItemLine {
+        const Intent: {
+            readonly LineArrow: "LineArrow";
+            readonly LineDimension: "LineDimension";
+        };
+        type Intent = (typeof Intent)[keyof typeof Intent];
+        interface Caption {
+            enabled: boolean;
+            position?: Caption.Position | undefined;
+            offset?: Caption.Offset | undefined;
+        }
+        namespace Caption {
+            const Position: {
+                readonly Inline: "inline";
+                readonly Top: "top";
+            };
+            type Position = (typeof Position)[keyof typeof Position];
+            interface Offset {
+                along: number;
+                perpendicular: number;
+            }
+        }
+        interface Leader {
+            length: number;
+            extension?: number | undefined;
+            offset?: number | undefined;
+        }
         const IdentityQuality: {
             readonly Durable: "durable";
             readonly Weak: "weak";

package/dist/esm/api/types/DocAnnotationsList200ResponseAnnotationsItem.mjs

@@ -192,6 +192,10 @@ export var DocAnnotationsList200ResponseAnnotationsItem;
     })(DocAnnotationsList200ResponseAnnotationsItemSquare = DocAnnotationsList200ResponseAnnotationsItem.DocAnnotationsList200ResponseAnnotationsItemSquare || (DocAnnotationsList200ResponseAnnotationsItem.DocAnnotationsList200ResponseAnnotationsItemSquare = {}));
     let DocAnnotationsList200ResponseAnnotationsItemPolygon;
     (function (DocAnnotationsList200ResponseAnnotationsItemPolygon) {
+        DocAnnotationsList200ResponseAnnotationsItemPolygon.Intent = {
+            PolygonCloud: "PolygonCloud",
+            PolygonDimension: "PolygonDimension",
+        };
         DocAnnotationsList200ResponseAnnotationsItemPolygon.IdentityQuality = {
             Durable: "durable",
             Weak: "weak",
@@ -227,6 +231,9 @@ export var DocAnnotationsList200ResponseAnnotationsItem;
     })(DocAnnotationsList200ResponseAnnotationsItemPolygon = DocAnnotationsList200ResponseAnnotationsItem.DocAnnotationsList200ResponseAnnotationsItemPolygon || (DocAnnotationsList200ResponseAnnotationsItem.DocAnnotationsList200ResponseAnnotationsItemPolygon = {}));
     let DocAnnotationsList200ResponseAnnotationsItemPolyline;
     (function (DocAnnotationsList200ResponseAnnotationsItemPolyline) {
+        DocAnnotationsList200ResponseAnnotationsItemPolyline.Intent = {
+            PolyLineDimension: "PolyLineDimension",
+        };
         DocAnnotationsList200ResponseAnnotationsItemPolyline.IdentityQuality = {
             Durable: "durable",
             Weak: "weak",
@@ -289,6 +296,17 @@ export var DocAnnotationsList200ResponseAnnotationsItem;
     })(DocAnnotationsList200ResponseAnnotationsItemPolyline = DocAnnotationsList200ResponseAnnotationsItem.DocAnnotationsList200ResponseAnnotationsItemPolyline || (DocAnnotationsList200ResponseAnnotationsItem.DocAnnotationsList200ResponseAnnotationsItemPolyline = {}));
     let DocAnnotationsList200ResponseAnnotationsItemLine;
     (function (DocAnnotationsList200ResponseAnnotationsItemLine) {
+        DocAnnotationsList200ResponseAnnotationsItemLine.Intent = {
+            LineArrow: "LineArrow",
+            LineDimension: "LineDimension",
+        };
+        let Caption;
+        (function (Caption) {
+            Caption.Position = {
+                Inline: "inline",
+                Top: "top",
+            };
+        })(Caption = DocAnnotationsList200ResponseAnnotationsItemLine.Caption || (DocAnnotationsList200ResponseAnnotationsItemLine.Caption = {}));
         DocAnnotationsList200ResponseAnnotationsItemLine.IdentityQuality = {
             Durable: "durable",
             Weak: "weak",