@superdoc/sdk 2.0.0 → 2.2.0

package/dist/generated/client.d.ts

@@ -17013,6 +17013,13 @@ export interface DocCommentsCreateParams {
         textboxId: string;
     });
     parentId?: string;
+    commentId?: string;
+    externalId?: string;
+    author?: string;
+    authorId?: string;
+    authorEmail?: string;
+    authorImage?: string;
+    metadata?: Record<string, unknown>;
     blockId?: string;
     start?: number;
     end?: number;
@@ -25381,6 +25388,40 @@ export interface DocCitationsGetParams {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
+        storyId?: string;
+        fieldId?: string;
+        occurrenceIndex?: number;
     };
 }
 export interface DocCitationsInsertParams {
@@ -25455,6 +25496,40 @@ export interface DocCitationsUpdateParams {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
+        storyId?: string;
+        fieldId?: string;
+        occurrenceIndex?: number;
     };
     patch: {
         sourceIds?: Array<string>;
@@ -25481,6 +25556,40 @@ export interface DocCitationsRemoveParams {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
+        storyId?: string;
+        fieldId?: string;
+        occurrenceIndex?: number;
     };
 }
 export interface DocCitationsSourcesListParams {
@@ -27880,6 +27989,8 @@ export type DocClearContentResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -31456,6 +31567,8 @@ export type DocBlocksDeleteResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -31686,6 +31799,8 @@ export type DocBlocksDeleteRangeResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -32028,6 +32143,8 @@ export type DocBlocksSplitResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -32370,6 +32487,8 @@ export type DocBlocksMergeResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -79322,6 +79441,8 @@ export type DocListsAttachResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -79744,6 +79865,8 @@ export type DocListsIndentResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -80123,6 +80246,8 @@ export type DocListsOutdentResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -80528,6 +80653,8 @@ export type DocListsSetLevelResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -80907,6 +81034,8 @@ export type DocListsSetValueResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -81286,6 +81415,8 @@ export type DocListsContinuePreviousResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -81670,6 +81801,8 @@ export type DocListsSetLevelRestartResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -82088,6 +82221,8 @@ export type DocListsApplyTemplateResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -82467,6 +82602,8 @@ export type DocListsApplyPresetResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -82846,6 +82983,8 @@ export type DocListsSetTypeResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -83246,6 +83385,8 @@ export type DocListsSetLevelNumberingResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -83625,6 +83766,8 @@ export type DocListsSetLevelBulletResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -84004,6 +84147,8 @@ export type DocListsSetLevelPictureBulletResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -84383,6 +84528,8 @@ export type DocListsSetLevelAlignmentResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -84762,6 +84909,8 @@ export type DocListsSetLevelIndentsResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -85141,6 +85290,8 @@ export type DocListsSetLevelTrailingCharacterResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -85520,6 +85671,8 @@ export type DocListsSetLevelMarkerFontResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -85899,6 +86052,8 @@ export type DocListsClearLevelOverridesResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -86300,6 +86455,8 @@ export type DocListsApplyStyleResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -86679,6 +86836,8 @@ export type DocListsRestartAtResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -87058,6 +87217,8 @@ export type DocListsSetLevelNumberStyleResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -87437,6 +87598,8 @@ export type DocListsSetLevelTextResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -87816,6 +87979,8 @@ export type DocListsSetLevelStartResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -88195,6 +88360,8 @@ export type DocListsSetLevelLayoutResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -88591,6 +88758,8 @@ export type DocListsApplyResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -88970,6 +89139,8 @@ export type DocListsContinueResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -89349,6 +89520,8 @@ export type DocListsRestartResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -89728,6 +89901,8 @@ export type DocListsRemoveResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -90433,6 +90608,8 @@ export type DocCommentsPatchResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -90977,6 +91154,8 @@ export type DocCommentsDeleteResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -90988,6 +91167,8 @@ export type DocCommentsGetResult = {
         entityId: string;
     };
     commentId: string;
+    externalId?: string;
+    metadata?: Record<string, unknown>;
     importedId?: string;
     rawOoxmlId?: string;
     rawOoxmlOccurrenceIndex?: number;
@@ -91042,7 +91223,9 @@ export type DocCommentsGetResult = {
     anchoredText?: string;
     createdTime?: number;
     creatorName?: string;
+    creatorId?: string;
     creatorEmail?: string;
+    creatorImage?: string;
     trackedChange?: boolean;
     trackedChangeType?: "insertion" | "deletion" | "replacement" | "formatting" | "move" | "structural" | "insert" | "delete" | "format";
     trackedChangeDisplayType?: unknown;
@@ -91106,6 +91289,8 @@ export type DocCommentsListResult = {
             entityType: "comment";
             entityId: string;
         };
+        externalId?: string;
+        metadata?: Record<string, unknown>;
         importedId?: string;
         rawOoxmlId?: string;
         rawOoxmlOccurrenceIndex?: number;
@@ -91160,7 +91345,9 @@ export type DocCommentsListResult = {
         anchoredText?: string;
         createdTime?: number;
         creatorName?: string;
+        creatorId?: string;
         creatorEmail?: string;
+        creatorImage?: string;
         trackedChange?: boolean;
         trackedChangeType?: "insertion" | "deletion" | "replacement" | "formatting" | "move" | "structural" | "insert" | "delete" | "format";
         trackedChangeDisplayType?: unknown;
@@ -91369,6 +91556,12 @@ export type DocTrackChangesListResult = {
             relationship?: "parent" | "child" | "standalone";
             parentId?: string;
         };
+        customAttributes?: Array<{
+            name: string;
+            namespaceUri: string;
+            localName: string;
+            value: string;
+        }>;
     }>;
     page: {
         limit: number;
@@ -91666,6 +91859,12 @@ export type DocTrackChangesGetResult = {
         relationship?: "parent" | "child" | "standalone";
         parentId?: string;
     };
+    customAttributes?: Array<{
+        name: string;
+        namespaceUri: string;
+        localName: string;
+        value: string;
+    }>;
 };
 export type DocTrackChangesDecideResult = {
     success: true;
@@ -92207,6 +92406,8 @@ export type DocTrackChangesDecideResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -98798,6 +98999,8 @@ export type DocHistoryUndoResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     status?: "applied" | "noop" | "rejected" | "partial" | "repaired";
@@ -99353,6 +99556,8 @@ export type DocHistoryRedoResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     status?: "applied" | "noop" | "rejected" | "partial" | "repaired";
@@ -99964,6 +100169,7 @@ export type DocContentControlsListResult = {
             coordinateSpace?: "visible" | "tracked";
         }) | null;
         text?: string;
+        isEmpty?: boolean;
     }>;
     total: number;
 };
@@ -100171,6 +100377,7 @@ export type DocContentControlsGetResult = {
         coordinateSpace?: "visible" | "tracked";
     }) | null;
     text?: string;
+    isEmpty?: boolean;
 };
 export type DocContentControlsListInRangeResult = {
     items: Array<{
@@ -100377,6 +100584,7 @@ export type DocContentControlsListInRangeResult = {
             coordinateSpace?: "visible" | "tracked";
         }) | null;
         text?: string;
+        isEmpty?: boolean;
     }>;
     total: number;
 };
@@ -100585,6 +100793,7 @@ export type DocContentControlsSelectByTagResult = {
             coordinateSpace?: "visible" | "tracked";
         }) | null;
         text?: string;
+        isEmpty?: boolean;
     }>;
     total: number;
 };
@@ -100793,6 +101002,7 @@ export type DocContentControlsSelectByTitleResult = {
             coordinateSpace?: "visible" | "tracked";
         }) | null;
         text?: string;
+        isEmpty?: boolean;
     }>;
     total: number;
 };
@@ -101001,6 +101211,7 @@ export type DocContentControlsListChildrenResult = {
             coordinateSpace?: "visible" | "tracked";
         }) | null;
         text?: string;
+        isEmpty?: boolean;
     }>;
     total: number;
 };
@@ -101208,6 +101419,7 @@ export type DocContentControlsGetParentResult = ({
         coordinateSpace?: "visible" | "tracked";
     }) | null;
     text?: string;
+    isEmpty?: boolean;
 }) | null;
 export type DocContentControlsWrapResult = {
     success: true;
@@ -101866,6 +102078,7 @@ export type DocContentControlsRepeatingSectionListItemsResult = {
             coordinateSpace?: "visible" | "tracked";
         }) | null;
         text?: string;
+        isEmpty?: boolean;
     }>;
     total: number;
 };
@@ -102654,6 +102867,8 @@ export type DocClipboardInsertResult = {
             textboxId: string;
         });
         atChar: number;
+        blockId?: string;
+        atCharInBlock?: number;
         delta: number;
     }>;
     txId?: string;
@@ -102884,6 +103099,40 @@ export type DocCitationsInsertResult = {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
+        storyId?: string;
+        fieldId?: string;
+        occurrenceIndex?: number;
     };
 };
 export type DocCitationsUpdateResult = {
@@ -102901,6 +103150,40 @@ export type DocCitationsUpdateResult = {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
+        storyId?: string;
+        fieldId?: string;
+        occurrenceIndex?: number;
     };
 };
 export type DocCitationsRemoveResult = {
@@ -102918,6 +103201,40 @@ export type DocCitationsRemoveResult = {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
+        storyId?: string;
+        fieldId?: string;
+        occurrenceIndex?: number;
     };
 };
 export type DocCitationsSourcesListResult = Record<string, unknown>;
@@ -120141,6 +120458,13 @@ export interface DocCommentsCreateBoundParams {
         textboxId: string;
     });
     parentId?: string;
+    commentId?: string;
+    externalId?: string;
+    author?: string;
+    authorId?: string;
+    authorEmail?: string;
+    authorImage?: string;
+    metadata?: Record<string, unknown>;
     blockId?: string;
     start?: number;
     end?: number;
@@ -128074,6 +128398,40 @@ export interface DocCitationsGetBoundParams {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
+        storyId?: string;
+        fieldId?: string;
+        occurrenceIndex?: number;
     };
 }
 export interface DocCitationsInsertBoundParams {
@@ -128144,6 +128502,40 @@ export interface DocCitationsUpdateBoundParams {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
+        storyId?: string;
+        fieldId?: string;
+        occurrenceIndex?: number;
     };
     patch: {
         sourceIds?: Array<string>;
@@ -128168,6 +128560,40 @@ export interface DocCitationsRemoveBoundParams {
                 offset: number;
             };
         };
+        story?: ({
+            kind: "story";
+            storyType: "body";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header" | "footer";
+            variant: "default" | "first" | "even";
+            resolution?: "effective" | "explicit";
+            onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
+        }) | ({
+            kind: "story";
+            storyType: "headerFooterPart";
+            refId: string;
+        }) | ({
+            kind: "story";
+            storyType: "footnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "endnote";
+            noteId: string;
+        }) | ({
+            kind: "story";
+            storyType: "textbox";
+            textboxId: string;
+        });
+        storyId?: string;
+        fieldId?: string;
+        occurrenceIndex?: number;
     };
 }
 export interface DocCitationsSourcesListBoundParams {