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

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: 20240722
+// Revision: 20240730
 
 /// <reference types="gapi.client" />
 
@@ -217,37 +217,37 @@ declare namespace gapi.client {
       unit?: string;
     }
     interface Document {
-      /** Output only. The main body of the document. */
+      /** Output only. The main body of the document. Legacy field: Instead, use Document.tabs.documentTab.body, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
       body?: Body;
       /** Output only. The ID of the document. */
       documentId?: string;
-      /** Output only. The style of the document. */
+      /** Output only. The style of the document. Legacy field: Instead, use Document.tabs.documentTab.documentStyle, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
       documentStyle?: DocumentStyle;
-      /** Output only. The footers in the document, keyed by footer ID. */
+      /** Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
       footers?: {[P in string]: Footer};
-      /** Output only. The footnotes in the document, keyed by footnote ID. */
+      /** Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
       footnotes?: {[P in string]: Footnote};
-      /** Output only. The headers in the document, keyed by header ID. */
+      /** Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
       headers?: {[P in string]: Header};
-      /** Output only. The inline objects in the document, keyed by object ID. */
+      /** Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
       inlineObjects?: {[P in string]: InlineObject};
-      /** Output only. The lists in the document, keyed by list ID. */
+      /** Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
       lists?: {[P in string]: List};
-      /** Output only. The named ranges in the document, keyed by name. */
+      /** Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
       namedRanges?: {[P in string]: NamedRanges};
-      /** Output only. The named styles of the document. */
+      /** Output only. The named styles of the document. Legacy field: Instead, use Document.tabs.documentTab.namedStyles, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
       namedStyles?: NamedStyles;
-      /** Output only. The positioned objects in the document, keyed by object ID. */
+      /** Output only. The positioned objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
       positionedObjects?: {[P in string]: PositionedObject};
       /** Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes. */
       revisionId?: string;
-      /** Output only. The suggested changes to the style of the document, keyed by suggestion ID. */
+      /** Output only. The suggested changes to the style of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
       suggestedDocumentStyleChanges?: {[P in string]: SuggestedDocumentStyle};
-      /** Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. */
+      /** Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
       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 that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field. */
       tabs?: Tab[];
       /** The title of the document. */
       title?: string;
@@ -617,13 +617,13 @@ 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. */
+      /** A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId 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. */
+      /** The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the 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. */
+      /** A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId 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. */
+      /** The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. */
       headingId?: string;
       /** The ID of a tab in this document. */
       tabId?: string;
@@ -1453,7 +1453,7 @@ declare namespace gapi.client {
       tableColumnProperties?: TableColumnProperties[];
     }
     interface TabProperties {
-      /** The index of the tab within the parent. */
+      /** The zero-based 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;
@@ -1739,7 +1739,7 @@ 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. */
+        /** 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;

package/package.json

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