@superdoc/sdk 2.16.1 → 2.17.0-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -346,6 +346,12 @@ function createDocApi(runtime) {
346
346
  create: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.headerFooters.parts.create"], params, options),
347
347
  delete: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.headerFooters.parts.delete"], params, options),
348
348
  },
349
+ pageNumbers: {
350
+ get: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.headerFooters.pageNumbers.get"], params, options),
351
+ insert: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.headerFooters.pageNumbers.insert"], params, options),
352
+ set: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.headerFooters.pageNumbers.set"], params, options),
353
+ remove: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.headerFooters.pageNumbers.remove"], params, options),
354
+ },
349
355
  },
350
356
  watermarks: {
351
357
  apply: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.watermarks.apply"], params, options),
@@ -920,6 +926,12 @@ function createBoundDocApi(runtime) {
920
926
  create: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.headerFooters.parts.create"], params, options),
921
927
  delete: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.headerFooters.parts.delete"], params, options),
922
928
  },
929
+ pageNumbers: {
930
+ get: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.headerFooters.pageNumbers.get"], params, options),
931
+ insert: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.headerFooters.pageNumbers.insert"], params, options),
932
+ set: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.headerFooters.pageNumbers.set"], params, options),
933
+ remove: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.headerFooters.pageNumbers.remove"], params, options),
934
+ },
923
935
  },
924
936
  watermarks: {
925
937
  apply: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.watermarks.apply"], params, options),
@@ -13089,7 +13089,7 @@ export interface DocSectionsSetPageNumberingParams {
13089
13089
  kind: "section";
13090
13090
  sectionId: string;
13091
13091
  };
13092
- start?: number;
13092
+ start?: number | unknown;
13093
13093
  format?: string;
13094
13094
  chapterStyle?: number;
13095
13095
  chapterSeparator?: string;
@@ -25180,6 +25180,46 @@ export interface DocCreateImageParams {
25180
25180
  });
25181
25181
  };
25182
25182
  offset?: number;
25183
+ }) | ({
25184
+ kind: "inContentControl";
25185
+ target: {
25186
+ kind: "block" | "inline";
25187
+ nodeType: "sdt";
25188
+ nodeId: string;
25189
+ story?: ({
25190
+ kind: "story";
25191
+ storyType: "body";
25192
+ }) | ({
25193
+ kind: "story";
25194
+ storyType: "headerFooterSlot";
25195
+ section: {
25196
+ kind: "section";
25197
+ sectionId: string;
25198
+ };
25199
+ headerFooterKind: "header" | "footer";
25200
+ variant: "default" | "first" | "even";
25201
+ resolution?: "effective" | "explicit";
25202
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
25203
+ }) | ({
25204
+ kind: "story";
25205
+ storyType: "headerFooterPart";
25206
+ refId: string;
25207
+ }) | ({
25208
+ kind: "story";
25209
+ storyType: "footnote";
25210
+ noteId: string;
25211
+ }) | ({
25212
+ kind: "story";
25213
+ storyType: "endnote";
25214
+ noteId: string;
25215
+ }) | ({
25216
+ kind: "story";
25217
+ storyType: "textbox";
25218
+ textboxId: string;
25219
+ });
25220
+ };
25221
+ position?: "start" | "end";
25222
+ replaceContent?: boolean;
25183
25223
  });
25184
25224
  }
25185
25225
  export interface DocImagesListParams {
@@ -25975,6 +26015,64 @@ export interface DocHeaderFootersPartsDeleteParams {
25975
26015
  refId: string;
25976
26016
  };
25977
26017
  }
26018
+ export interface DocHeaderFootersPageNumbersGetParams {
26019
+ doc?: string;
26020
+ sessionId?: string;
26021
+ section: {
26022
+ kind: "section";
26023
+ sectionId: string;
26024
+ };
26025
+ }
26026
+ export interface DocHeaderFootersPageNumbersInsertParams {
26027
+ doc?: string;
26028
+ sessionId?: string;
26029
+ out?: string;
26030
+ force?: boolean;
26031
+ expectedRevision?: string;
26032
+ changeMode?: string;
26033
+ dryRun?: boolean;
26034
+ section: {
26035
+ kind: "section";
26036
+ sectionId: string;
26037
+ };
26038
+ kind: string;
26039
+ alignment?: string;
26040
+ showOnFirstPage?: boolean;
26041
+ format?: string;
26042
+ start?: number | unknown;
26043
+ }
26044
+ export interface DocHeaderFootersPageNumbersSetParams {
26045
+ doc?: string;
26046
+ sessionId?: string;
26047
+ out?: string;
26048
+ force?: boolean;
26049
+ expectedRevision?: string;
26050
+ changeMode?: string;
26051
+ dryRun?: boolean;
26052
+ section: {
26053
+ kind: "section";
26054
+ sectionId: string;
26055
+ };
26056
+ kind: string;
26057
+ alignment?: string;
26058
+ showOnFirstPage?: boolean;
26059
+ format?: string;
26060
+ start?: number | unknown;
26061
+ }
26062
+ export interface DocHeaderFootersPageNumbersRemoveParams {
26063
+ doc?: string;
26064
+ sessionId?: string;
26065
+ out?: string;
26066
+ force?: boolean;
26067
+ expectedRevision?: string;
26068
+ changeMode?: string;
26069
+ dryRun?: boolean;
26070
+ section: {
26071
+ kind: "section";
26072
+ sectionId: string;
26073
+ };
26074
+ kind?: string;
26075
+ }
25978
26076
  export interface DocWatermarksApplyParams {
25979
26077
  doc?: string;
25980
26078
  sessionId?: string;
@@ -105940,6 +106038,30 @@ export type DocCapabilitiesGetResult = {
105940
106038
  dryRun: boolean;
105941
106039
  reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE" | "TARGET_CONTEXT_REQUIRED" | "TARGET_UNSUPPORTED">;
105942
106040
  };
106041
+ "headerFooters.pageNumbers.get": {
106042
+ available: boolean;
106043
+ tracked: boolean;
106044
+ dryRun: boolean;
106045
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE" | "TARGET_CONTEXT_REQUIRED" | "TARGET_UNSUPPORTED">;
106046
+ };
106047
+ "headerFooters.pageNumbers.insert": {
106048
+ available: boolean;
106049
+ tracked: boolean;
106050
+ dryRun: boolean;
106051
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE" | "TARGET_CONTEXT_REQUIRED" | "TARGET_UNSUPPORTED">;
106052
+ };
106053
+ "headerFooters.pageNumbers.set": {
106054
+ available: boolean;
106055
+ tracked: boolean;
106056
+ dryRun: boolean;
106057
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE" | "TARGET_CONTEXT_REQUIRED" | "TARGET_UNSUPPORTED">;
106058
+ };
106059
+ "headerFooters.pageNumbers.remove": {
106060
+ available: boolean;
106061
+ tracked: boolean;
106062
+ dryRun: boolean;
106063
+ reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE" | "TARGET_CONTEXT_REQUIRED" | "TARGET_UNSUPPORTED">;
106064
+ };
105943
106065
  "watermarks.apply": {
105944
106066
  available: boolean;
105945
106067
  tracked: boolean;
@@ -108974,7 +109096,7 @@ export type DocCapabilitiesCheckResult = ({
108974
109096
  };
108975
109097
  });
108976
109098
  export type DocCapabilitiesResolveResult = {
108977
- operationId: "get" | "find" | "getNode" | "getNodeById" | "getText" | "getMarkdown" | "getHtml" | "projectMarkdown" | "projectHtml" | "markdownToFragment" | "htmlToFragment" | "info" | "extract" | "clearContent" | "insert" | "replace" | "delete" | "formatRange" | "blocks.findText" | "blocks.list" | "blocks.delete" | "blocks.deleteRange" | "blocks.split" | "blocks.merge" | "blocks.move" | "format.apply" | "format.bold" | "format.italic" | "format.strike" | "format.underline" | "format.highlight" | "format.color" | "format.fontSize" | "format.fontFamily" | "format.letterSpacing" | "format.vertAlign" | "format.position" | "format.dstrike" | "format.smallCaps" | "format.caps" | "format.shading" | "format.border" | "format.outline" | "format.shadow" | "format.emboss" | "format.imprint" | "format.charScale" | "format.kerning" | "format.vanish" | "format.webHidden" | "format.specVanish" | "format.rtl" | "format.cs" | "format.bCs" | "format.iCs" | "format.eastAsianLayout" | "format.em" | "format.fitText" | "format.snapToGrid" | "format.lang" | "format.oMath" | "format.rStyle" | "format.rFonts" | "format.fontSizeCs" | "format.ligatures" | "format.numForm" | "format.numSpacing" | "format.stylisticSets" | "format.contextualAlternates" | "styles.apply" | "styles.getCatalog" | "templates.apply" | "create.paragraph" | "create.heading" | "create.sectionBreak" | "sections.list" | "sections.get" | "sections.setBreakType" | "sections.setPageMargins" | "sections.setHeaderFooterMargins" | "sections.setPageSetup" | "sections.setColumns" | "sections.setLineNumbering" | "sections.setPageNumbering" | "sections.setTitlePage" | "sections.setOddEvenHeadersFooters" | "sections.setVerticalAlign" | "sections.setSectionDirection" | "sections.setHeaderFooterRef" | "sections.clearHeaderFooterRef" | "sections.setLinkToPrevious" | "sections.setPageBorders" | "sections.clearPageBorders" | "styles.paragraph.setStyle" | "styles.paragraph.setStyleRef" | "styles.paragraph.clearStyle" | "format.paragraph.resetDirectFormatting" | "format.paragraph.setAlignment" | "format.paragraph.clearAlignment" | "format.paragraph.setIndentation" | "format.paragraph.clearIndentation" | "format.paragraph.setSpacing" | "format.paragraph.clearSpacing" | "format.paragraph.setKeepOptions" | "format.paragraph.setOutlineLevel" | "format.paragraph.setFlowOptions" | "format.paragraph.setTabStop" | "format.paragraph.clearTabStop" | "format.paragraph.clearAllTabStops" | "format.paragraph.setBorder" | "format.paragraph.clearBorder" | "format.paragraph.setShading" | "format.paragraph.clearShading" | "format.paragraph.setMarkRunProps" | "format.paragraph.setDirection" | "format.paragraph.clearDirection" | "format.paragraph.setNumbering" | "lists.list" | "lists.get" | "lists.insert" | "lists.create" | "lists.attach" | "lists.detach" | "lists.delete" | "lists.indent" | "lists.outdent" | "lists.join" | "lists.canJoin" | "lists.separate" | "lists.merge" | "lists.split" | "lists.setLevel" | "lists.setValue" | "lists.continuePrevious" | "lists.canContinuePrevious" | "lists.setLevelRestart" | "lists.convertToText" | "lists.applyTemplate" | "lists.applyPreset" | "lists.setType" | "lists.captureTemplate" | "lists.setLevelNumbering" | "lists.setLevelBullet" | "lists.setLevelPictureBullet" | "lists.setLevelAlignment" | "lists.setLevelIndents" | "lists.setLevelTrailingCharacter" | "lists.setLevelMarkerFont" | "lists.clearLevelOverrides" | "lists.getStyle" | "lists.applyStyle" | "lists.restartAt" | "lists.setLevelNumberStyle" | "lists.setLevelText" | "lists.setLevelStart" | "lists.setLevelLayout" | "lists.getState" | "lists.apply" | "lists.continue" | "lists.restart" | "lists.remove" | "comments.create" | "comments.patch" | "comments.delete" | "comments.get" | "comments.list" | "trackChanges.list" | "trackChanges.get" | "trackChanges.decide" | "query.match" | "ranges.resolve" | "selection.current" | "selection.extractOoxml" | "mutations.preview" | "mutations.apply" | "plan.execute" | "capabilities.get" | "capabilities.check" | "capabilities.resolve" | "create.table" | "tables.convertFromText" | "tables.delete" | "tables.clearContents" | "tables.move" | "tables.split" | "tables.convertToText" | "tables.setLayout" | "tables.insertRow" | "tables.deleteRow" | "tables.moveRow" | "tables.setRowHeight" | "tables.distributeRows" | "tables.setRowOptions" | "tables.insertColumn" | "tables.deleteColumn" | "tables.moveColumn" | "tables.setColumnWidth" | "tables.distributeColumns" | "tables.insertCell" | "tables.deleteCell" | "tables.mergeCells" | "tables.unmergeCells" | "tables.splitCell" | "tables.setCellProperties" | "tables.setCellText" | "tables.sort" | "tables.setAltText" | "tables.setStyle" | "tables.clearStyle" | "tables.setStyleOption" | "tables.setBorder" | "tables.clearBorder" | "tables.applyBorderPreset" | "tables.setShading" | "tables.clearShading" | "tables.setTablePadding" | "tables.setCellPadding" | "tables.setCellSpacing" | "tables.clearCellSpacing" | "tables.applyStyle" | "tables.setBorders" | "tables.setTableOptions" | "tables.applyPreset" | "tables.get" | "tables.getCells" | "tables.getProperties" | "tables.getStyles" | "tables.setDefaultStyle" | "tables.clearDefaultStyle" | "create.tableOfContents" | "toc.list" | "toc.get" | "toc.configure" | "toc.update" | "toc.remove" | "toc.markEntry" | "toc.unmarkEntry" | "toc.listEntries" | "toc.getEntry" | "toc.editEntry" | "history.get" | "history.undo" | "history.redo" | "create.image" | "images.list" | "images.get" | "images.delete" | "images.move" | "images.convertToInline" | "images.convertToFloating" | "images.setSize" | "images.setWrapType" | "images.setWrapSide" | "images.setWrapDistances" | "images.setPosition" | "images.setAnchorOptions" | "images.setZOrder" | "images.scale" | "images.setLockAspectRatio" | "images.rotate" | "images.flip" | "images.crop" | "images.resetCrop" | "images.replaceSource" | "images.setAltText" | "images.setDecorative" | "images.setName" | "images.setHyperlink" | "images.insertCaption" | "images.updateCaption" | "images.removeCaption" | "hyperlinks.list" | "hyperlinks.get" | "hyperlinks.wrap" | "hyperlinks.insert" | "hyperlinks.patch" | "hyperlinks.remove" | "headerFooters.list" | "headerFooters.get" | "headerFooters.resolve" | "headerFooters.refs.set" | "headerFooters.refs.clear" | "headerFooters.refs.setLinkedToPrevious" | "headerFooters.parts.list" | "headerFooters.parts.create" | "headerFooters.parts.delete" | "watermarks.apply" | "watermarks.list" | "watermarks.insert" | "watermarks.replace" | "watermarks.remove" | "create.contentControl" | "contentControls.list" | "contentControls.get" | "contentControls.listInRange" | "contentControls.selectByTag" | "contentControls.selectByTitle" | "contentControls.listChildren" | "contentControls.getParent" | "contentControls.wrap" | "contentControls.unwrap" | "contentControls.delete" | "contentControls.copy" | "contentControls.move" | "contentControls.patch" | "contentControls.setLockMode" | "contentControls.setType" | "contentControls.getContent" | "contentControls.replaceContent" | "contentControls.clearContent" | "contentControls.appendContent" | "contentControls.prependContent" | "contentControls.insertBefore" | "contentControls.insertAfter" | "contentControls.getBinding" | "contentControls.setBinding" | "contentControls.clearBinding" | "contentControls.getRawProperties" | "contentControls.patchRawProperties" | "contentControls.validateWordCompatibility" | "contentControls.normalizeWordCompatibility" | "contentControls.normalizeTagPayload" | "contentControls.text.setMultiline" | "contentControls.text.setValue" | "contentControls.text.clearValue" | "contentControls.date.setValue" | "contentControls.date.clearValue" | "contentControls.date.setDisplayFormat" | "contentControls.date.setDisplayLocale" | "contentControls.date.setStorageFormat" | "contentControls.date.setCalendar" | "contentControls.checkbox.getState" | "contentControls.checkbox.setState" | "contentControls.checkbox.toggle" | "contentControls.checkbox.setSymbolPair" | "contentControls.choiceList.getItems" | "contentControls.choiceList.setItems" | "contentControls.choiceList.setSelected" | "contentControls.repeatingSection.listItems" | "contentControls.repeatingSection.insertItemBefore" | "contentControls.repeatingSection.insertItemAfter" | "contentControls.repeatingSection.cloneItem" | "contentControls.repeatingSection.deleteItem" | "contentControls.repeatingSection.setAllowInsertDelete" | "contentControls.group.wrap" | "contentControls.group.ungroup" | "bookmarks.list" | "bookmarks.get" | "bookmarks.insert" | "bookmarks.rename" | "bookmarks.remove" | "footnotes.list" | "footnotes.get" | "footnotes.insert" | "footnotes.update" | "footnotes.remove" | "footnotes.configure" | "clipboard.parse" | "clipboard.insert" | "clipboard.serializeSelection" | "crossRefs.list" | "crossRefs.get" | "crossRefs.insert" | "crossRefs.rebuild" | "crossRefs.remove" | "index.list" | "index.get" | "index.insert" | "index.configure" | "index.rebuild" | "index.remove" | "index.entries.list" | "index.entries.get" | "index.entries.insert" | "index.entries.update" | "index.entries.remove" | "captions.list" | "captions.get" | "captions.insert" | "captions.update" | "captions.remove" | "captions.configure" | "fields.list" | "fields.get" | "fields.insert" | "fields.rebuild" | "fields.remove" | "citations.list" | "citations.get" | "citations.insert" | "citations.update" | "citations.remove" | "citations.sources.list" | "citations.sources.get" | "citations.sources.insert" | "citations.sources.update" | "citations.sources.remove" | "citations.bibliography.get" | "citations.bibliography.insert" | "citations.bibliography.rebuild" | "citations.bibliography.configure" | "citations.bibliography.remove" | "authorities.list" | "authorities.get" | "authorities.insert" | "authorities.configure" | "authorities.rebuild" | "authorities.remove" | "authorities.entries.list" | "authorities.entries.get" | "authorities.entries.insert" | "authorities.entries.update" | "authorities.entries.remove" | "diff.capture" | "diff.compare" | "diff.apply" | "export.toDocx" | "protection.get" | "protection.setEditingRestriction" | "protection.clearEditingRestriction" | "permissionRanges.list" | "permissionRanges.get" | "permissionRanges.create" | "permissionRanges.remove" | "permissionRanges.updatePrincipal" | "customXml.parts.list" | "customXml.parts.get" | "customXml.parts.create" | "customXml.parts.patch" | "customXml.parts.remove" | "metadata.attach" | "metadata.list" | "metadata.get" | "metadata.update" | "metadata.remove" | "metadata.resolve";
109099
+ operationId: "get" | "find" | "getNode" | "getNodeById" | "getText" | "getMarkdown" | "getHtml" | "projectMarkdown" | "projectHtml" | "markdownToFragment" | "htmlToFragment" | "info" | "extract" | "clearContent" | "insert" | "replace" | "delete" | "formatRange" | "blocks.findText" | "blocks.list" | "blocks.delete" | "blocks.deleteRange" | "blocks.split" | "blocks.merge" | "blocks.move" | "format.apply" | "format.bold" | "format.italic" | "format.strike" | "format.underline" | "format.highlight" | "format.color" | "format.fontSize" | "format.fontFamily" | "format.letterSpacing" | "format.vertAlign" | "format.position" | "format.dstrike" | "format.smallCaps" | "format.caps" | "format.shading" | "format.border" | "format.outline" | "format.shadow" | "format.emboss" | "format.imprint" | "format.charScale" | "format.kerning" | "format.vanish" | "format.webHidden" | "format.specVanish" | "format.rtl" | "format.cs" | "format.bCs" | "format.iCs" | "format.eastAsianLayout" | "format.em" | "format.fitText" | "format.snapToGrid" | "format.lang" | "format.oMath" | "format.rStyle" | "format.rFonts" | "format.fontSizeCs" | "format.ligatures" | "format.numForm" | "format.numSpacing" | "format.stylisticSets" | "format.contextualAlternates" | "styles.apply" | "styles.getCatalog" | "templates.apply" | "create.paragraph" | "create.heading" | "create.sectionBreak" | "sections.list" | "sections.get" | "sections.setBreakType" | "sections.setPageMargins" | "sections.setHeaderFooterMargins" | "sections.setPageSetup" | "sections.setColumns" | "sections.setLineNumbering" | "sections.setPageNumbering" | "sections.setTitlePage" | "sections.setOddEvenHeadersFooters" | "sections.setVerticalAlign" | "sections.setSectionDirection" | "sections.setHeaderFooterRef" | "sections.clearHeaderFooterRef" | "sections.setLinkToPrevious" | "sections.setPageBorders" | "sections.clearPageBorders" | "styles.paragraph.setStyle" | "styles.paragraph.setStyleRef" | "styles.paragraph.clearStyle" | "format.paragraph.resetDirectFormatting" | "format.paragraph.setAlignment" | "format.paragraph.clearAlignment" | "format.paragraph.setIndentation" | "format.paragraph.clearIndentation" | "format.paragraph.setSpacing" | "format.paragraph.clearSpacing" | "format.paragraph.setKeepOptions" | "format.paragraph.setOutlineLevel" | "format.paragraph.setFlowOptions" | "format.paragraph.setTabStop" | "format.paragraph.clearTabStop" | "format.paragraph.clearAllTabStops" | "format.paragraph.setBorder" | "format.paragraph.clearBorder" | "format.paragraph.setShading" | "format.paragraph.clearShading" | "format.paragraph.setMarkRunProps" | "format.paragraph.setDirection" | "format.paragraph.clearDirection" | "format.paragraph.setNumbering" | "lists.list" | "lists.get" | "lists.insert" | "lists.create" | "lists.attach" | "lists.detach" | "lists.delete" | "lists.indent" | "lists.outdent" | "lists.join" | "lists.canJoin" | "lists.separate" | "lists.merge" | "lists.split" | "lists.setLevel" | "lists.setValue" | "lists.continuePrevious" | "lists.canContinuePrevious" | "lists.setLevelRestart" | "lists.convertToText" | "lists.applyTemplate" | "lists.applyPreset" | "lists.setType" | "lists.captureTemplate" | "lists.setLevelNumbering" | "lists.setLevelBullet" | "lists.setLevelPictureBullet" | "lists.setLevelAlignment" | "lists.setLevelIndents" | "lists.setLevelTrailingCharacter" | "lists.setLevelMarkerFont" | "lists.clearLevelOverrides" | "lists.getStyle" | "lists.applyStyle" | "lists.restartAt" | "lists.setLevelNumberStyle" | "lists.setLevelText" | "lists.setLevelStart" | "lists.setLevelLayout" | "lists.getState" | "lists.apply" | "lists.continue" | "lists.restart" | "lists.remove" | "comments.create" | "comments.patch" | "comments.delete" | "comments.get" | "comments.list" | "trackChanges.list" | "trackChanges.get" | "trackChanges.decide" | "query.match" | "ranges.resolve" | "selection.current" | "selection.extractOoxml" | "mutations.preview" | "mutations.apply" | "plan.execute" | "capabilities.get" | "capabilities.check" | "capabilities.resolve" | "create.table" | "tables.convertFromText" | "tables.delete" | "tables.clearContents" | "tables.move" | "tables.split" | "tables.convertToText" | "tables.setLayout" | "tables.insertRow" | "tables.deleteRow" | "tables.moveRow" | "tables.setRowHeight" | "tables.distributeRows" | "tables.setRowOptions" | "tables.insertColumn" | "tables.deleteColumn" | "tables.moveColumn" | "tables.setColumnWidth" | "tables.distributeColumns" | "tables.insertCell" | "tables.deleteCell" | "tables.mergeCells" | "tables.unmergeCells" | "tables.splitCell" | "tables.setCellProperties" | "tables.setCellText" | "tables.sort" | "tables.setAltText" | "tables.setStyle" | "tables.clearStyle" | "tables.setStyleOption" | "tables.setBorder" | "tables.clearBorder" | "tables.applyBorderPreset" | "tables.setShading" | "tables.clearShading" | "tables.setTablePadding" | "tables.setCellPadding" | "tables.setCellSpacing" | "tables.clearCellSpacing" | "tables.applyStyle" | "tables.setBorders" | "tables.setTableOptions" | "tables.applyPreset" | "tables.get" | "tables.getCells" | "tables.getProperties" | "tables.getStyles" | "tables.setDefaultStyle" | "tables.clearDefaultStyle" | "create.tableOfContents" | "toc.list" | "toc.get" | "toc.configure" | "toc.update" | "toc.remove" | "toc.markEntry" | "toc.unmarkEntry" | "toc.listEntries" | "toc.getEntry" | "toc.editEntry" | "history.get" | "history.undo" | "history.redo" | "create.image" | "images.list" | "images.get" | "images.delete" | "images.move" | "images.convertToInline" | "images.convertToFloating" | "images.setSize" | "images.setWrapType" | "images.setWrapSide" | "images.setWrapDistances" | "images.setPosition" | "images.setAnchorOptions" | "images.setZOrder" | "images.scale" | "images.setLockAspectRatio" | "images.rotate" | "images.flip" | "images.crop" | "images.resetCrop" | "images.replaceSource" | "images.setAltText" | "images.setDecorative" | "images.setName" | "images.setHyperlink" | "images.insertCaption" | "images.updateCaption" | "images.removeCaption" | "hyperlinks.list" | "hyperlinks.get" | "hyperlinks.wrap" | "hyperlinks.insert" | "hyperlinks.patch" | "hyperlinks.remove" | "headerFooters.list" | "headerFooters.get" | "headerFooters.resolve" | "headerFooters.refs.set" | "headerFooters.refs.clear" | "headerFooters.refs.setLinkedToPrevious" | "headerFooters.parts.list" | "headerFooters.parts.create" | "headerFooters.parts.delete" | "headerFooters.pageNumbers.get" | "headerFooters.pageNumbers.insert" | "headerFooters.pageNumbers.set" | "headerFooters.pageNumbers.remove" | "watermarks.apply" | "watermarks.list" | "watermarks.insert" | "watermarks.replace" | "watermarks.remove" | "create.contentControl" | "contentControls.list" | "contentControls.get" | "contentControls.listInRange" | "contentControls.selectByTag" | "contentControls.selectByTitle" | "contentControls.listChildren" | "contentControls.getParent" | "contentControls.wrap" | "contentControls.unwrap" | "contentControls.delete" | "contentControls.copy" | "contentControls.move" | "contentControls.patch" | "contentControls.setLockMode" | "contentControls.setType" | "contentControls.getContent" | "contentControls.replaceContent" | "contentControls.clearContent" | "contentControls.appendContent" | "contentControls.prependContent" | "contentControls.insertBefore" | "contentControls.insertAfter" | "contentControls.getBinding" | "contentControls.setBinding" | "contentControls.clearBinding" | "contentControls.getRawProperties" | "contentControls.patchRawProperties" | "contentControls.validateWordCompatibility" | "contentControls.normalizeWordCompatibility" | "contentControls.normalizeTagPayload" | "contentControls.text.setMultiline" | "contentControls.text.setValue" | "contentControls.text.clearValue" | "contentControls.date.setValue" | "contentControls.date.clearValue" | "contentControls.date.setDisplayFormat" | "contentControls.date.setDisplayLocale" | "contentControls.date.setStorageFormat" | "contentControls.date.setCalendar" | "contentControls.checkbox.getState" | "contentControls.checkbox.setState" | "contentControls.checkbox.toggle" | "contentControls.checkbox.setSymbolPair" | "contentControls.choiceList.getItems" | "contentControls.choiceList.setItems" | "contentControls.choiceList.setSelected" | "contentControls.repeatingSection.listItems" | "contentControls.repeatingSection.insertItemBefore" | "contentControls.repeatingSection.insertItemAfter" | "contentControls.repeatingSection.cloneItem" | "contentControls.repeatingSection.deleteItem" | "contentControls.repeatingSection.setAllowInsertDelete" | "contentControls.group.wrap" | "contentControls.group.ungroup" | "bookmarks.list" | "bookmarks.get" | "bookmarks.insert" | "bookmarks.rename" | "bookmarks.remove" | "footnotes.list" | "footnotes.get" | "footnotes.insert" | "footnotes.update" | "footnotes.remove" | "footnotes.configure" | "clipboard.parse" | "clipboard.insert" | "clipboard.serializeSelection" | "crossRefs.list" | "crossRefs.get" | "crossRefs.insert" | "crossRefs.rebuild" | "crossRefs.remove" | "index.list" | "index.get" | "index.insert" | "index.configure" | "index.rebuild" | "index.remove" | "index.entries.list" | "index.entries.get" | "index.entries.insert" | "index.entries.update" | "index.entries.remove" | "captions.list" | "captions.get" | "captions.insert" | "captions.update" | "captions.remove" | "captions.configure" | "fields.list" | "fields.get" | "fields.insert" | "fields.rebuild" | "fields.remove" | "citations.list" | "citations.get" | "citations.insert" | "citations.update" | "citations.remove" | "citations.sources.list" | "citations.sources.get" | "citations.sources.insert" | "citations.sources.update" | "citations.sources.remove" | "citations.bibliography.get" | "citations.bibliography.insert" | "citations.bibliography.rebuild" | "citations.bibliography.configure" | "citations.bibliography.remove" | "authorities.list" | "authorities.get" | "authorities.insert" | "authorities.configure" | "authorities.rebuild" | "authorities.remove" | "authorities.entries.list" | "authorities.entries.get" | "authorities.entries.insert" | "authorities.entries.update" | "authorities.entries.remove" | "diff.capture" | "diff.compare" | "diff.apply" | "export.toDocx" | "protection.get" | "protection.setEditingRestriction" | "protection.clearEditingRestriction" | "permissionRanges.list" | "permissionRanges.get" | "permissionRanges.create" | "permissionRanges.remove" | "permissionRanges.updatePrincipal" | "customXml.parts.list" | "customXml.parts.get" | "customXml.parts.create" | "customXml.parts.patch" | "customXml.parts.remove" | "metadata.attach" | "metadata.list" | "metadata.get" | "metadata.update" | "metadata.remove" | "metadata.resolve";
108978
109100
  available: ({
108979
109101
  kind: "supported";
108980
109102
  }) | ({
@@ -112870,6 +112992,61 @@ export type DocHeaderFootersPartsDeleteResult = {
112870
112992
  refId: string;
112871
112993
  partPath: string;
112872
112994
  };
112995
+ export type DocHeaderFootersPageNumbersGetResult = {
112996
+ section: {
112997
+ kind: "section";
112998
+ sectionId: string;
112999
+ };
113000
+ placements: Array<{
113001
+ kind: "header" | "footer";
113002
+ alignment: "left" | "center" | "right" | null;
113003
+ parts: Array<{
113004
+ kind: "headerFooterPart";
113005
+ refId: string;
113006
+ }>;
113007
+ }>;
113008
+ showOnFirstPage: boolean;
113009
+ titlePage: boolean;
113010
+ format: "decimal" | "lowerLetter" | "upperLetter" | "lowerRoman" | "upperRoman" | "numberInDash" | "hebrew1" | "hebrew2";
113011
+ start: number | null;
113012
+ };
113013
+ export type DocHeaderFootersPageNumbersInsertResult = {
113014
+ success: true;
113015
+ section: {
113016
+ kind: "section";
113017
+ sectionId: string;
113018
+ };
113019
+ kind: "header" | "footer";
113020
+ parts: Array<{
113021
+ kind: "headerFooterPart";
113022
+ refId: string;
113023
+ }>;
113024
+ titlePage: boolean;
113025
+ };
113026
+ export type DocHeaderFootersPageNumbersSetResult = {
113027
+ success: true;
113028
+ section: {
113029
+ kind: "section";
113030
+ sectionId: string;
113031
+ };
113032
+ kind: "header" | "footer";
113033
+ parts: Array<{
113034
+ kind: "headerFooterPart";
113035
+ refId: string;
113036
+ }>;
113037
+ titlePage: boolean;
113038
+ };
113039
+ export type DocHeaderFootersPageNumbersRemoveResult = {
113040
+ success: true;
113041
+ section: {
113042
+ kind: "section";
113043
+ sectionId: string;
113044
+ };
113045
+ parts: Array<{
113046
+ kind: "headerFooterPart";
113047
+ refId: string;
113048
+ }>;
113049
+ };
112873
113050
  export type DocWatermarksApplyResult = {
112874
113051
  success: true;
112875
113052
  watermarks: Array<{
@@ -135921,7 +136098,7 @@ export interface DocSectionsSetPageNumberingBoundParams {
135921
136098
  kind: "section";
135922
136099
  sectionId: string;
135923
136100
  };
135924
- start?: number;
136101
+ start?: number | unknown;
135925
136102
  format?: string;
135926
136103
  chapterStyle?: number;
135927
136104
  chapterSeparator?: string;
@@ -147693,6 +147870,46 @@ export interface DocCreateImageBoundParams {
147693
147870
  });
147694
147871
  };
147695
147872
  offset?: number;
147873
+ }) | ({
147874
+ kind: "inContentControl";
147875
+ target: {
147876
+ kind: "block" | "inline";
147877
+ nodeType: "sdt";
147878
+ nodeId: string;
147879
+ story?: ({
147880
+ kind: "story";
147881
+ storyType: "body";
147882
+ }) | ({
147883
+ kind: "story";
147884
+ storyType: "headerFooterSlot";
147885
+ section: {
147886
+ kind: "section";
147887
+ sectionId: string;
147888
+ };
147889
+ headerFooterKind: "header" | "footer";
147890
+ variant: "default" | "first" | "even";
147891
+ resolution?: "effective" | "explicit";
147892
+ onWrite?: "materializeIfInherited" | "editResolvedPart" | "error";
147893
+ }) | ({
147894
+ kind: "story";
147895
+ storyType: "headerFooterPart";
147896
+ refId: string;
147897
+ }) | ({
147898
+ kind: "story";
147899
+ storyType: "footnote";
147900
+ noteId: string;
147901
+ }) | ({
147902
+ kind: "story";
147903
+ storyType: "endnote";
147904
+ noteId: string;
147905
+ }) | ({
147906
+ kind: "story";
147907
+ storyType: "textbox";
147908
+ textboxId: string;
147909
+ });
147910
+ };
147911
+ position?: "start" | "end";
147912
+ replaceContent?: boolean;
147696
147913
  });
147697
147914
  }
147698
147915
  export interface DocImagesListBoundParams {
@@ -148404,6 +148621,56 @@ export interface DocHeaderFootersPartsDeleteBoundParams {
148404
148621
  refId: string;
148405
148622
  };
148406
148623
  }
148624
+ export interface DocHeaderFootersPageNumbersGetBoundParams {
148625
+ section: {
148626
+ kind: "section";
148627
+ sectionId: string;
148628
+ };
148629
+ }
148630
+ export interface DocHeaderFootersPageNumbersInsertBoundParams {
148631
+ out?: string;
148632
+ force?: boolean;
148633
+ expectedRevision?: string;
148634
+ changeMode?: string;
148635
+ dryRun?: boolean;
148636
+ section: {
148637
+ kind: "section";
148638
+ sectionId: string;
148639
+ };
148640
+ kind: string;
148641
+ alignment?: string;
148642
+ showOnFirstPage?: boolean;
148643
+ format?: string;
148644
+ start?: number | unknown;
148645
+ }
148646
+ export interface DocHeaderFootersPageNumbersSetBoundParams {
148647
+ out?: string;
148648
+ force?: boolean;
148649
+ expectedRevision?: string;
148650
+ changeMode?: string;
148651
+ dryRun?: boolean;
148652
+ section: {
148653
+ kind: "section";
148654
+ sectionId: string;
148655
+ };
148656
+ kind: string;
148657
+ alignment?: string;
148658
+ showOnFirstPage?: boolean;
148659
+ format?: string;
148660
+ start?: number | unknown;
148661
+ }
148662
+ export interface DocHeaderFootersPageNumbersRemoveBoundParams {
148663
+ out?: string;
148664
+ force?: boolean;
148665
+ expectedRevision?: string;
148666
+ changeMode?: string;
148667
+ dryRun?: boolean;
148668
+ section: {
148669
+ kind: "section";
148670
+ sectionId: string;
148671
+ };
148672
+ kind?: string;
148673
+ }
148407
148674
  export interface DocWatermarksApplyBoundParams {
148408
148675
  out?: string;
148409
148676
  force?: boolean;
@@ -154159,6 +154426,12 @@ export declare function createDocApi(runtime: RuntimeInvoker): {
154159
154426
  create: (params: DocHeaderFootersPartsCreateParams, options?: InvokeOptions) => Promise<DocHeaderFootersPartsCreateResult>;
154160
154427
  delete: (params: DocHeaderFootersPartsDeleteParams, options?: InvokeOptions) => Promise<DocHeaderFootersPartsDeleteResult>;
154161
154428
  };
154429
+ pageNumbers: {
154430
+ get: (params: DocHeaderFootersPageNumbersGetParams, options?: InvokeOptions) => Promise<DocHeaderFootersPageNumbersGetResult>;
154431
+ insert: (params: DocHeaderFootersPageNumbersInsertParams, options?: InvokeOptions) => Promise<DocHeaderFootersPageNumbersInsertResult>;
154432
+ set: (params: DocHeaderFootersPageNumbersSetParams, options?: InvokeOptions) => Promise<DocHeaderFootersPageNumbersSetResult>;
154433
+ remove: (params: DocHeaderFootersPageNumbersRemoveParams, options?: InvokeOptions) => Promise<DocHeaderFootersPageNumbersRemoveResult>;
154434
+ };
154162
154435
  };
154163
154436
  watermarks: {
154164
154437
  apply: (params: DocWatermarksApplyParams, options?: InvokeOptions) => Promise<DocWatermarksApplyResult>;
@@ -154729,6 +155002,12 @@ export declare function createBoundDocApi(runtime: RuntimeInvoker): {
154729
155002
  create: (params: DocHeaderFootersPartsCreateBoundParams, options?: InvokeOptions) => Promise<DocHeaderFootersPartsCreateResult>;
154730
155003
  delete: (params: DocHeaderFootersPartsDeleteBoundParams, options?: InvokeOptions) => Promise<DocHeaderFootersPartsDeleteResult>;
154731
155004
  };
155005
+ pageNumbers: {
155006
+ get: (params: DocHeaderFootersPageNumbersGetBoundParams, options?: InvokeOptions) => Promise<DocHeaderFootersPageNumbersGetResult>;
155007
+ insert: (params: DocHeaderFootersPageNumbersInsertBoundParams, options?: InvokeOptions) => Promise<DocHeaderFootersPageNumbersInsertResult>;
155008
+ set: (params: DocHeaderFootersPageNumbersSetBoundParams, options?: InvokeOptions) => Promise<DocHeaderFootersPageNumbersSetResult>;
155009
+ remove: (params: DocHeaderFootersPageNumbersRemoveBoundParams, options?: InvokeOptions) => Promise<DocHeaderFootersPageNumbersRemoveResult>;
155010
+ };
154732
155011
  };
154733
155012
  watermarks: {
154734
155013
  apply: (params: DocWatermarksApplyBoundParams, options?: InvokeOptions) => Promise<DocWatermarksApplyResult>;
@@ -343,6 +343,12 @@ export function createDocApi(runtime) {
343
343
  create: (params, options) => runtime.invoke(CONTRACT.operations["doc.headerFooters.parts.create"], params, options),
344
344
  delete: (params, options) => runtime.invoke(CONTRACT.operations["doc.headerFooters.parts.delete"], params, options),
345
345
  },
346
+ pageNumbers: {
347
+ get: (params, options) => runtime.invoke(CONTRACT.operations["doc.headerFooters.pageNumbers.get"], params, options),
348
+ insert: (params, options) => runtime.invoke(CONTRACT.operations["doc.headerFooters.pageNumbers.insert"], params, options),
349
+ set: (params, options) => runtime.invoke(CONTRACT.operations["doc.headerFooters.pageNumbers.set"], params, options),
350
+ remove: (params, options) => runtime.invoke(CONTRACT.operations["doc.headerFooters.pageNumbers.remove"], params, options),
351
+ },
346
352
  },
347
353
  watermarks: {
348
354
  apply: (params, options) => runtime.invoke(CONTRACT.operations["doc.watermarks.apply"], params, options),
@@ -917,6 +923,12 @@ export function createBoundDocApi(runtime) {
917
923
  create: (params, options) => runtime.invoke(CONTRACT.operations["doc.headerFooters.parts.create"], params, options),
918
924
  delete: (params, options) => runtime.invoke(CONTRACT.operations["doc.headerFooters.parts.delete"], params, options),
919
925
  },
926
+ pageNumbers: {
927
+ get: (params, options) => runtime.invoke(CONTRACT.operations["doc.headerFooters.pageNumbers.get"], params, options),
928
+ insert: (params, options) => runtime.invoke(CONTRACT.operations["doc.headerFooters.pageNumbers.insert"], params, options),
929
+ set: (params, options) => runtime.invoke(CONTRACT.operations["doc.headerFooters.pageNumbers.set"], params, options),
930
+ remove: (params, options) => runtime.invoke(CONTRACT.operations["doc.headerFooters.pageNumbers.remove"], params, options),
931
+ },
920
932
  },
921
933
  watermarks: {
922
934
  apply: (params, options) => runtime.invoke(CONTRACT.operations["doc.watermarks.apply"], params, options),