@superdoc/sdk 2.13.0-next.4 → 2.13.0-next.6

package/dist/generated/client.d.ts

@@ -25735,6 +25735,173 @@ export interface DocHeaderFootersPartsDeleteParams {
         refId: string;
     };
 }
+export interface DocWatermarksListParams {
+    doc?: string;
+    sessionId?: string;
+    target?: ({
+        kind: "document";
+    }) | ({
+        kind: "headerFooterSlot";
+        section: {
+            kind: "section";
+            sectionId: string;
+        };
+        headerFooterKind: "header";
+        variant: "default" | "first" | "even";
+    });
+    limit?: number;
+    offset?: number;
+}
+export interface DocWatermarksInsertParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: string;
+    changeMode?: string;
+    dryRun?: boolean;
+    target: ({
+        kind: "document";
+    }) | ({
+        kind: "headerFooterSlot";
+        section: {
+            kind: "section";
+            sectionId: string;
+        };
+        headerFooterKind: "header";
+        variant: "default" | "first" | "even";
+    });
+    watermark: ({
+        kind: "text";
+        text: string;
+        fontFamily?: string;
+        fontSizePt?: "auto" | number;
+        bold?: boolean;
+        italic?: boolean;
+        color?: string;
+        opacity?: number;
+        orientation?: "horizontal" | "diagonal";
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+    }) | ({
+        kind: "picture";
+        src: string;
+        scalePercent?: "auto" | 50 | 100 | 150 | 200 | 500;
+        widthPt?: number;
+        heightPt?: number;
+        lockAspectRatio?: boolean;
+        washout?: boolean;
+        opacity?: number;
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+    });
+}
+export interface DocWatermarksReplaceParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: string;
+    changeMode?: string;
+    dryRun?: boolean;
+    target: {
+        kind: "watermark";
+        watermarkId: string;
+    };
+    watermark: ({
+        kind: "text";
+        text: string;
+        fontFamily?: string;
+        fontSizePt?: "auto" | number;
+        bold?: boolean;
+        italic?: boolean;
+        color?: string;
+        opacity?: number;
+        orientation?: "horizontal" | "diagonal";
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+    }) | ({
+        kind: "picture";
+        src: string;
+        scalePercent?: "auto" | 50 | 100 | 150 | 200 | 500;
+        widthPt?: number;
+        heightPt?: number;
+        lockAspectRatio?: boolean;
+        washout?: boolean;
+        opacity?: number;
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+    });
+}
+export interface DocWatermarksRemoveParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: string;
+    changeMode?: string;
+    dryRun?: boolean;
+    target: {
+        kind: "watermark";
+        watermarkId: string;
+    };
+}
 export interface DocCreateContentControlParams {
     doc?: string;
     sessionId?: string;
@@ -31196,6 +31363,10 @@ export interface DocExecuteCodeParams {
 export interface DocStatusParams {
     sessionId?: string;
 }
+export interface DocDiscoverParams {
+    query: string;
+    limit?: number;
+}
 export interface DocDescribeParams {
 }
 export interface DocDescribeCommandParams {
@@ -105025,6 +105196,30 @@ export type DocCapabilitiesGetResult = {
             dryRun: boolean;
             reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
         };
+        "watermarks.list": {
+            available: boolean;
+            tracked: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+        };
+        "watermarks.insert": {
+            available: boolean;
+            tracked: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+        };
+        "watermarks.replace": {
+            available: boolean;
+            tracked: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+        };
+        "watermarks.remove": {
+            available: boolean;
+            tracked: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+        };
         "create.contentControl": {
             available: boolean;
             tracked: boolean;
@@ -111889,6 +112084,301 @@ export type DocHeaderFootersPartsDeleteResult = {
     refId: string;
     partPath: string;
 };
+export type DocWatermarksListResult = {
+    evaluatedRevision: string;
+    total: number;
+    items: Array<{
+        watermarkId: string;
+        owner: {
+            refId: string;
+            partPath: string;
+        };
+        effectiveIn: Array<{
+            kind: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header";
+            variant: "default" | "first" | "even";
+        }>;
+        watermark: ({
+            kind: "text";
+            text: string;
+            fontFamily?: string;
+            fontSizePt?: "auto" | number;
+            bold?: boolean;
+            italic?: boolean;
+            color?: string;
+            opacity?: number;
+            orientation?: "horizontal" | "diagonal";
+            placement?: {
+                widthPt?: number;
+                heightPt?: number;
+                rotationDegrees?: number;
+                behindText?: boolean;
+                horizontal?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "left" | "center" | "right";
+                    offsetPt?: number;
+                };
+                vertical?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "top" | "center" | "bottom";
+                    offsetPt?: number;
+                };
+            };
+        }) | ({
+            kind: "picture";
+            mediaPartPath: string;
+            contentType: string;
+            scalePercent: "auto" | 50 | 100 | 150 | 200 | 500;
+            widthPt: number;
+            heightPt: number;
+            lockAspectRatio: boolean;
+            washout: boolean;
+            opacity: number;
+            placement: {
+                widthPt?: number;
+                heightPt?: number;
+                rotationDegrees?: number;
+                behindText?: boolean;
+                horizontal?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "left" | "center" | "right";
+                    offsetPt?: number;
+                };
+                vertical?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "top" | "center" | "bottom";
+                    offsetPt?: number;
+                };
+            };
+        });
+    }>;
+    page: {
+        limit: number;
+        offset: number;
+        returned: number;
+    };
+};
+export type DocWatermarksInsertResult = {
+    success: true;
+    watermark: {
+        watermarkId: string;
+        owner: {
+            refId: string;
+            partPath: string;
+        };
+        effectiveIn: Array<{
+            kind: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header";
+            variant: "default" | "first" | "even";
+        }>;
+        watermark: ({
+            kind: "text";
+            text: string;
+            fontFamily?: string;
+            fontSizePt?: "auto" | number;
+            bold?: boolean;
+            italic?: boolean;
+            color?: string;
+            opacity?: number;
+            orientation?: "horizontal" | "diagonal";
+            placement?: {
+                widthPt?: number;
+                heightPt?: number;
+                rotationDegrees?: number;
+                behindText?: boolean;
+                horizontal?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "left" | "center" | "right";
+                    offsetPt?: number;
+                };
+                vertical?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "top" | "center" | "bottom";
+                    offsetPt?: number;
+                };
+            };
+        }) | ({
+            kind: "picture";
+            mediaPartPath: string;
+            contentType: string;
+            scalePercent: "auto" | 50 | 100 | 150 | 200 | 500;
+            widthPt: number;
+            heightPt: number;
+            lockAspectRatio: boolean;
+            washout: boolean;
+            opacity: number;
+            placement: {
+                widthPt?: number;
+                heightPt?: number;
+                rotationDegrees?: number;
+                behindText?: boolean;
+                horizontal?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "left" | "center" | "right";
+                    offsetPt?: number;
+                };
+                vertical?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "top" | "center" | "bottom";
+                    offsetPt?: number;
+                };
+            };
+        });
+    };
+    watermarks?: Array<{
+        watermarkId: string;
+        owner: {
+            refId: string;
+            partPath: string;
+        };
+        effectiveIn: Array<{
+            kind: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header";
+            variant: "default" | "first" | "even";
+        }>;
+        watermark: ({
+            kind: "text";
+            text: string;
+            fontFamily?: string;
+            fontSizePt?: "auto" | number;
+            bold?: boolean;
+            italic?: boolean;
+            color?: string;
+            opacity?: number;
+            orientation?: "horizontal" | "diagonal";
+            placement?: {
+                widthPt?: number;
+                heightPt?: number;
+                rotationDegrees?: number;
+                behindText?: boolean;
+                horizontal?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "left" | "center" | "right";
+                    offsetPt?: number;
+                };
+                vertical?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "top" | "center" | "bottom";
+                    offsetPt?: number;
+                };
+            };
+        }) | ({
+            kind: "picture";
+            mediaPartPath: string;
+            contentType: string;
+            scalePercent: "auto" | 50 | 100 | 150 | 200 | 500;
+            widthPt: number;
+            heightPt: number;
+            lockAspectRatio: boolean;
+            washout: boolean;
+            opacity: number;
+            placement: {
+                widthPt?: number;
+                heightPt?: number;
+                rotationDegrees?: number;
+                behindText?: boolean;
+                horizontal?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "left" | "center" | "right";
+                    offsetPt?: number;
+                };
+                vertical?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "top" | "center" | "bottom";
+                    offsetPt?: number;
+                };
+            };
+        });
+    }>;
+};
+export type DocWatermarksReplaceResult = {
+    success: true;
+    watermark: {
+        watermarkId: string;
+        owner: {
+            refId: string;
+            partPath: string;
+        };
+        effectiveIn: Array<{
+            kind: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header";
+            variant: "default" | "first" | "even";
+        }>;
+        watermark: ({
+            kind: "text";
+            text: string;
+            fontFamily?: string;
+            fontSizePt?: "auto" | number;
+            bold?: boolean;
+            italic?: boolean;
+            color?: string;
+            opacity?: number;
+            orientation?: "horizontal" | "diagonal";
+            placement?: {
+                widthPt?: number;
+                heightPt?: number;
+                rotationDegrees?: number;
+                behindText?: boolean;
+                horizontal?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "left" | "center" | "right";
+                    offsetPt?: number;
+                };
+                vertical?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "top" | "center" | "bottom";
+                    offsetPt?: number;
+                };
+            };
+        }) | ({
+            kind: "picture";
+            mediaPartPath: string;
+            contentType: string;
+            scalePercent: "auto" | 50 | 100 | 150 | 200 | 500;
+            widthPt: number;
+            heightPt: number;
+            lockAspectRatio: boolean;
+            washout: boolean;
+            opacity: number;
+            placement: {
+                widthPt?: number;
+                heightPt?: number;
+                rotationDegrees?: number;
+                behindText?: boolean;
+                horizontal?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "left" | "center" | "right";
+                    offsetPt?: number;
+                };
+                vertical?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "top" | "center" | "bottom";
+                    offsetPt?: number;
+                };
+            };
+        });
+    };
+};
+export type DocWatermarksRemoveResult = {
+    success: true;
+    watermarkId: string;
+};
 export type DocCreateContentControlResult = {
     success: true;
     contentControl: {
@@ -119039,6 +119529,31 @@ export type DocStatusResult = {
     updatedAt?: string;
     lastSavedAt?: string;
 };
+export type DocDiscoverResult = {
+    contractVersion: string;
+    query: string;
+    interpretation: "clear" | "ambiguous" | "broad" | "no-match";
+    resultCount: number;
+    maxResults: number;
+    capped: boolean;
+    results: Array<{
+        rank: number;
+        operationId: string;
+        command: string;
+        description: string;
+        referenceGroup: string;
+        relevance: "exact" | "strong" | "relevant" | "related";
+        score: number;
+        matched: Array<string>;
+        useWhen?: string;
+        avoidWhen?: Array<string>;
+        defaults?: Record<string, unknown>;
+        schemaCommand: string;
+        input?: Record<string, unknown>;
+        relations?: Array<Record<string, unknown>>;
+    }>;
+    guidance?: string;
+};
 export type DocDescribeResult = {
     contractVersion?: string;
     operations?: Array<{
@@ -144022,6 +144537,165 @@ export interface DocHeaderFootersPartsDeleteBoundParams {
         refId: string;
     };
 }
+export interface DocWatermarksListBoundParams {
+    target?: ({
+        kind: "document";
+    }) | ({
+        kind: "headerFooterSlot";
+        section: {
+            kind: "section";
+            sectionId: string;
+        };
+        headerFooterKind: "header";
+        variant: "default" | "first" | "even";
+    });
+    limit?: number;
+    offset?: number;
+}
+export interface DocWatermarksInsertBoundParams {
+    out?: string;
+    force?: boolean;
+    expectedRevision?: string;
+    changeMode?: string;
+    dryRun?: boolean;
+    target: ({
+        kind: "document";
+    }) | ({
+        kind: "headerFooterSlot";
+        section: {
+            kind: "section";
+            sectionId: string;
+        };
+        headerFooterKind: "header";
+        variant: "default" | "first" | "even";
+    });
+    watermark: ({
+        kind: "text";
+        text: string;
+        fontFamily?: string;
+        fontSizePt?: "auto" | number;
+        bold?: boolean;
+        italic?: boolean;
+        color?: string;
+        opacity?: number;
+        orientation?: "horizontal" | "diagonal";
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+    }) | ({
+        kind: "picture";
+        src: string;
+        scalePercent?: "auto" | 50 | 100 | 150 | 200 | 500;
+        widthPt?: number;
+        heightPt?: number;
+        lockAspectRatio?: boolean;
+        washout?: boolean;
+        opacity?: number;
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+    });
+}
+export interface DocWatermarksReplaceBoundParams {
+    out?: string;
+    force?: boolean;
+    expectedRevision?: string;
+    changeMode?: string;
+    dryRun?: boolean;
+    target: {
+        kind: "watermark";
+        watermarkId: string;
+    };
+    watermark: ({
+        kind: "text";
+        text: string;
+        fontFamily?: string;
+        fontSizePt?: "auto" | number;
+        bold?: boolean;
+        italic?: boolean;
+        color?: string;
+        opacity?: number;
+        orientation?: "horizontal" | "diagonal";
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+    }) | ({
+        kind: "picture";
+        src: string;
+        scalePercent?: "auto" | 50 | 100 | 150 | 200 | 500;
+        widthPt?: number;
+        heightPt?: number;
+        lockAspectRatio?: boolean;
+        washout?: boolean;
+        opacity?: number;
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+    });
+}
+export interface DocWatermarksRemoveBoundParams {
+    out?: string;
+    force?: boolean;
+    expectedRevision?: string;
+    changeMode?: string;
+    dryRun?: boolean;
+    target: {
+        kind: "watermark";
+        watermarkId: string;
+    };
+}
 export interface DocCreateContentControlBoundParams {
     out?: string;
     force?: boolean;
@@ -149501,6 +150175,12 @@ export declare function createDocApi(runtime: RuntimeInvoker): {
             delete: (params: DocHeaderFootersPartsDeleteParams, options?: InvokeOptions) => Promise<DocHeaderFootersPartsDeleteResult>;
         };
     };
+    watermarks: {
+        list: (params?: DocWatermarksListParams, options?: InvokeOptions) => Promise<DocWatermarksListResult>;
+        insert: (params: DocWatermarksInsertParams, options?: InvokeOptions) => Promise<DocWatermarksInsertResult>;
+        replace: (params: DocWatermarksReplaceParams, options?: InvokeOptions) => Promise<DocWatermarksReplaceResult>;
+        remove: (params: DocWatermarksRemoveParams, options?: InvokeOptions) => Promise<DocWatermarksRemoveResult>;
+    };
     contentControls: {
         list: (params?: DocContentControlsListParams, options?: InvokeOptions) => Promise<DocContentControlsListResult>;
         get: (params: DocContentControlsGetParams, options?: InvokeOptions) => Promise<DocContentControlsGetResult>;
@@ -149706,6 +150386,7 @@ export declare function createDocApi(runtime: RuntimeInvoker): {
     insertLineBreak: (params?: DocInsertLineBreakParams, options?: InvokeOptions) => Promise<DocInsertLineBreakResult>;
     executeCode: (params?: DocExecuteCodeParams, options?: InvokeOptions) => Promise<DocExecuteCodeResult>;
     status: (params?: DocStatusParams, options?: InvokeOptions) => Promise<DocStatusResult>;
+    discover: (params: DocDiscoverParams, options?: InvokeOptions) => Promise<DocDiscoverResult>;
     describe: (params?: DocDescribeParams, options?: InvokeOptions) => Promise<DocDescribeResult>;
     describeCommand: (params: DocDescribeCommandParams, options?: InvokeOptions) => Promise<DocDescribeCommandResult>;
     session: {
@@ -150061,6 +150742,12 @@ export declare function createBoundDocApi(runtime: RuntimeInvoker): {
             delete: (params: DocHeaderFootersPartsDeleteBoundParams, options?: InvokeOptions) => Promise<DocHeaderFootersPartsDeleteResult>;
         };
     };
+    watermarks: {
+        list: (params?: DocWatermarksListBoundParams, options?: InvokeOptions) => Promise<DocWatermarksListResult>;
+        insert: (params: DocWatermarksInsertBoundParams, options?: InvokeOptions) => Promise<DocWatermarksInsertResult>;
+        replace: (params: DocWatermarksReplaceBoundParams, options?: InvokeOptions) => Promise<DocWatermarksReplaceResult>;
+        remove: (params: DocWatermarksRemoveBoundParams, options?: InvokeOptions) => Promise<DocWatermarksRemoveResult>;
+    };
     contentControls: {
         list: (params?: DocContentControlsListBoundParams, options?: InvokeOptions) => Promise<DocContentControlsListResult>;
         get: (params: DocContentControlsGetBoundParams, options?: InvokeOptions) => Promise<DocContentControlsGetResult>;