@maxim_mazurok/gapi.client.docs-v1 0.0.20240711 → 0.0.20240722

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://docs.googleapis.com/$discovery/rest?version=v1
-// Revision: 20240711
+// Revision: 20240722
 
 /// <reference types="gapi.client" />
 
@@ -62,6 +62,12 @@ declare namespace gapi.client {
       /** The contents of the body. The indexes for the body's content begin at zero. */
       content?: StructuralElement[];
     }
+    interface BookmarkLink {
+      /** The ID of a bookmark in this document. */
+      id?: string;
+      /** The ID of the tab containing this bookmark. */
+      tabId?: string;
+    }
     interface Bullet {
       /** The ID of the list this paragraph belongs to. */
       listId?: string;
@@ -169,16 +175,22 @@ declare namespace gapi.client {
     interface DeleteFooterRequest {
       /** The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section. */
       footerId?: string;
+      /** The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
+      tabId?: string;
     }
     interface DeleteHeaderRequest {
       /** The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section. */
       headerId?: string;
+      /** The tab containing the header to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
+      tabId?: string;
     }
     interface DeleteNamedRangeRequest {
       /** The name of the range(s) to delete. All named ranges with the given name will be deleted. */
       name?: string;
       /** The ID of the named range to delete. */
       namedRangeId?: string;
+      /** Optional. The criteria used to specify which tab(s) the range deletion should occur in. When omitted, the range deletion is applied to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the range deletion applies to the singular tab. In a document containing multiple tabs: - If provided, the range deletion applies to the specified tabs. - If not provided, the range deletion applies to all tabs. */
+      tabsCriteria?: TabsCriteria;
     }
     interface DeleteParagraphBulletsRequest {
       /** The range to delete bullets from. */
@@ -187,6 +199,8 @@ declare namespace gapi.client {
     interface DeletePositionedObjectRequest {
       /** The ID of the positioned object to delete. */
       objectId?: string;
+      /** The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
+      tabId?: string;
     }
     interface DeleteTableColumnRequest {
       /** The reference table cell location from which the column will be deleted. The column this cell spans will be deleted. If this is a merged cell that spans multiple columns, all columns that the cell spans will be deleted. If no columns remain in the table after this deletion, the whole table is deleted. */
@@ -233,6 +247,8 @@ declare namespace gapi.client {
       suggestedNamedStylesChanges?: {[P in string]: SuggestedNamedStyles};
       /** Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. */
       suggestionsViewMode?: string;
+      /** Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.child_tabs field. */
+      tabs?: Tab[];
       /** The title of the document. */
       title?: string;
     }
@@ -316,6 +332,32 @@ declare namespace gapi.client {
       /** Indicates if there was a suggested change to use_first_page_header_footer. */
       useFirstPageHeaderFooterSuggested?: boolean;
     }
+    interface DocumentTab {
+      /** The main body of the document tab. */
+      body?: Body;
+      /** The style of the document tab. */
+      documentStyle?: DocumentStyle;
+      /** The footers in the document tab, keyed by footer ID. */
+      footers?: {[P in string]: Footer};
+      /** The footnotes in the document tab, keyed by footnote ID. */
+      footnotes?: {[P in string]: Footnote};
+      /** The headers in the document tab, keyed by header ID. */
+      headers?: {[P in string]: Header};
+      /** The inline objects in the document tab, keyed by object ID. */
+      inlineObjects?: {[P in string]: InlineObject};
+      /** The lists in the document tab, keyed by list ID. */
+      lists?: {[P in string]: List};
+      /** The named ranges in the document tab, keyed by name. */
+      namedRanges?: {[P in string]: NamedRanges};
+      /** The named styles of the document tab. */
+      namedStyles?: NamedStyles;
+      /** The positioned objects in the document tab, keyed by object ID. */
+      positionedObjects?: {[P in string]: PositionedObject};
+      /** The suggested changes to the style of the document tab, keyed by suggestion ID. */
+      suggestedDocumentStyleChanges?: {[P in string]: SuggestedDocumentStyle};
+      /** The suggested changes to the named styles of the document tab, keyed by suggestion ID. */
+      suggestedNamedStylesChanges?: {[P in string]: SuggestedNamedStyles};
+    }
     interface EmbeddedDrawingProperties {}
     interface EmbeddedDrawingPropertiesSuggestionState {}
     interface EmbeddedObject {
@@ -389,6 +431,8 @@ declare namespace gapi.client {
     interface EndOfSegmentLocation {
       /** The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. */
       segmentId?: string;
+      /** The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
+      tabId?: string;
     }
     interface Equation {
       /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
@@ -428,6 +472,12 @@ declare namespace gapi.client {
       /** The ID of the header. */
       headerId?: string;
     }
+    interface HeadingLink {
+      /** The ID of a heading in this document. */
+      id?: string;
+      /** The ID of the tab containing this heading. */
+      tabId?: string;
+    }
     interface HorizontalRule {
       /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
       suggestedDeletionIds?: string[];
@@ -567,10 +617,16 @@ declare namespace gapi.client {
       text?: string;
     }
     interface Link {
+      /** A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. */
+      bookmark?: BookmarkLink;
       /** The ID of a bookmark in this document. */
       bookmarkId?: string;
+      /** A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. */
+      heading?: HeadingLink;
       /** The ID of a heading in this document. */
       headingId?: string;
+      /** The ID of a tab in this document. */
+      tabId?: string;
       /** An external URL. */
       url?: string;
     }
@@ -605,6 +661,8 @@ declare namespace gapi.client {
       index?: number;
       /** The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. */
       segmentId?: string;
+      /** The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
+      tabId?: string;
     }
     interface MergeTableCellsRequest {
       /** The table range specifying which cells of the table to merge. Any text in the cells being merged will be concatenated and stored in the "head" cell of the range. This is the upper-left cell of the range when the content direction is left to right, and the upper-right cell of the range otherwise. If the range is non-rectangular (which can occur in some cases where the range covers cells that are already merged or where the table is non-rectangular), a 400 bad request error is returned. */
@@ -919,12 +977,16 @@ declare namespace gapi.client {
       segmentId?: string;
       /** The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. */
       startIndex?: number;
+      /** The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
+      tabId?: string;
     }
     interface ReplaceAllTextRequest {
       /** Finds text in the document matching this substring. */
       containsText?: SubstringMatchCriteria;
       /** The text that will replace the matched text. */
       replaceText?: string;
+      /** Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs. */
+      tabsCriteria?: TabsCriteria;
     }
     interface ReplaceAllTextResponse {
       /** The number of occurrences changed by replacing all text. */
@@ -935,6 +997,8 @@ declare namespace gapi.client {
       imageObjectId?: string;
       /** The replacement method. */
       imageReplaceMethod?: string;
+      /** The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
+      tabId?: string;
       /** The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field. */
       uri?: string;
     }
@@ -943,6 +1007,8 @@ declare namespace gapi.client {
       namedRangeId?: string;
       /** The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op. */
       namedRangeName?: string;
+      /** Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs. */
+      tabsCriteria?: TabsCriteria;
       /** Replaces the content of the specified named range(s) with the given text. */
       text?: string;
     }
@@ -1226,6 +1292,14 @@ declare namespace gapi.client {
       /** A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. */
       textStyleSuggestionState?: TextStyleSuggestionState;
     }
+    interface Tab {
+      /** The child tabs nested within this tab. */
+      childTabs?: Tab[];
+      /** A tab with document contents, like text and images. */
+      documentTab?: DocumentTab;
+      /** The properties of the tab, like ID and title. */
+      tabProperties?: TabProperties;
+    }
     interface Table {
       /** Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. */
       columns?: number;
@@ -1378,6 +1452,22 @@ declare namespace gapi.client {
       /** The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. */
       tableColumnProperties?: TableColumnProperties[];
     }
+    interface TabProperties {
+      /** The index of the tab within the parent. */
+      index?: number;
+      /** Output only. The depth of the tab within the document. Root-level tabs start at 0. */
+      nestingLevel?: number;
+      /** Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents. */
+      parentTabId?: string;
+      /** Output only. The ID of the tab. This field can't be changed. */
+      tabId?: string;
+      /** The user-visible name of the tab. */
+      title?: string;
+    }
+    interface TabsCriteria {
+      /** The list of tab IDs in which the request executes. */
+      tabIds?: string[];
+    }
     interface TabStop {
       /** The alignment of this tab stop. If unset, the value defaults to START. */
       alignment?: string;
@@ -1453,6 +1543,8 @@ declare namespace gapi.client {
       documentStyle?: DocumentStyle;
       /** The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `"background"`. */
       fields?: string;
+      /** The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document. */
+      tabId?: string;
     }
     interface UpdateParagraphStyleRequest {
       /** The fields that should be updated. At least one field must be specified. The root `paragraph_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the paragraph style's alignment property, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. */
@@ -1647,6 +1739,8 @@ declare namespace gapi.client {
         documentId: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
+        /** Whether to populate the Document.tabs field instead of the text content fields like body and documentStyle on Document. - When `True`: Document content populates in the Document.tabs field instead of the text content fields in Document. - When `False`: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty. */
+        includeTabsContent?: boolean;
         /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
         key?: string;
         /** OAuth 2.0 token for the current user. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.docs-v1",
-  "version": "0.0.20240711",
+  "version": "0.0.20240722",
   "description": "TypeScript typings for Google Docs API v1",
   "repository": {
     "type": "git",