@maxim_mazurok/gapi.client.docs-v1 0.4.20260909 → 0.4.20260923

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: 20260909
+// Revision: 20260923
 
 /// <reference types="gapi.client" />
 
@@ -24,6 +24,22 @@ declare namespace gapi.client {
   function load(name: 'docs', version: 'v1', callback: () => any): void;
 
   namespace docs {
+    interface AcceptSuggestionRequest {
+      /** The ID of the suggestion. */
+      suggestionId?: string;
+    }
+    interface AddCommentReplyRequest {
+      /** The ID of the CommentThread to add the reply to. */
+      commentId?: string;
+      /** The Post representing the reply. */
+      post?: Post;
+      /** The ID of the SuggestionThread to add the reply to. */
+      suggestionId?: string;
+    }
+    interface AddCommentReplyResponse {
+      /** The newly-inserted reply Post. */
+      post?: Post;
+    }
     interface AddDocumentTabRequest {
       /** The properties of the tab to add. All properties are optional. */
       tabProperties?: TabProperties;
@@ -59,10 +75,18 @@ declare namespace gapi.client {
       writeControl?: WriteControl;
     }
     interface BatchUpdateDocumentResponse {
+      /** Whether comment updates were applied in the batch request. [Developer Preview](https://developers.google.com/workspace/preview). */
+      commentUpdateState?:
+        | 'COMMENT_UPDATE_STATE_UNSPECIFIED'
+        | 'NO_UPDATES_REQUESTED'
+        | 'ALL_SAVED'
+        | 'ALL_FAILED_UNKNOWN_REASON';
       /** The ID of the document to which the updates were applied to. */
       documentId?: string;
       /** The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty. */
       replies?: Response[];
+      /** The suggestions which were affected by each update. This maps 1:1 with the updates. [Developer Preview](https://developers.google.com/workspace/preview). */
+      suggestionResponses?: SuggestionResponse[];
       /** The updated write control after applying the request. */
       writeControl?: WriteControl;
     }
@@ -106,6 +130,26 @@ declare namespace gapi.client {
       /** The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. */
       textStyle?: TextStyle;
     }
+    interface CommentAnchor {
+      /** The ID of the comment anchor. */
+      anchorId?: string;
+      /** A collection of Ranges in the document which are tied to this anchor. */
+      ranges?: Range[];
+    }
+    interface CommentThread {
+      /** The ID of the CommentAnchor in the document that this thread is tied to. Multiple comment threads may be anchored to the same CommentAnchor. */
+      anchorId?: string;
+      /** The unique ID of the comment thread. */
+      commentId?: string;
+      /** The first post in the thread. */
+      headPost?: Post;
+      /** The quoted text from the document when the comment was created, formatted as plain-text. */
+      plainTextQuote?: string;
+      /** Replies to the head post. */
+      replies?: Post[];
+      /** Whether the thread is open or resolved. */
+      status?: 'STATUS_UNSPECIFIED' | 'OPEN' | 'RESOLVED';
+    }
     interface CreateFooterRequest {
       /** The location of the SectionBreak immediately preceding the section whose SectionStyle this footer should belong to. If this is unset or refers to the first section break in the document, the footer applies to the document style. */
       sectionBreakLocation?: Location;
@@ -246,6 +290,18 @@ declare namespace gapi.client {
       /** Indicates if there was a suggested change to time_zone_id. */
       timeZoneIdSuggested?: boolean;
     }
+    interface DeleteCommentReplyRequest {
+      /** The ID of the CommentThread which the post belongs to. */
+      commentId?: string;
+      /** The ID of the reply Post being deleted. */
+      postId?: string;
+      /** The ID of the SuggestionThread which the post belongs to. */
+      suggestionId?: string;
+    }
+    interface DeleteCommentRequest {
+      /** The ID of the CommentThread that is being deleted. */
+      commentId?: string;
+    }
     interface DeleteContentRangeRequest {
       /** The range of content to delete. Deleting text that crosses a paragraph boundary may result in changes to paragraph styles, lists, positioned objects and bookmarks as the two paragraphs are merged. Attempting to delete certain ranges can result in an invalid document structure in which case a 400 bad request error is returned. Some examples of invalid delete requests include: * Deleting one code unit of a surrogate pair. * Deleting the last newline character of a Body, Header, Footer, Footnote, TableCell or TableOfContents. * Deleting the start or end of a Table, TableOfContents or Equation without deleting the entire element. * Deleting the newline character before a Table, TableOfContents or SectionBreak without deleting the element. * Deleting individual rows or cells of a table. Deleting the content within a table cell is allowed. */
       range?: Range;
@@ -280,6 +336,10 @@ declare namespace gapi.client {
       /** 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 DeleteSuggestionRequest {
+      /** The ID of the suggestion. */
+      suggestionId?: 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. */
       tableCellLocation?: TableCellLocation;
@@ -301,6 +361,14 @@ declare namespace gapi.client {
     interface 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 comments associated with the document. Only populated if the commentsViewMode parameter is set to require comments (such as `COMMENTS_VIEW_MODE_INCLUDED`). [Developer Preview](https://developers.google.com/workspace/preview). */
+      comments?: CommentThread[];
+      /** Output only. The comments view mode applied to the document. [Developer Preview](https://developers.google.com/workspace/preview). */
+      commentsViewMode?:
+        | 'COMMENTS_VIEW_MODE_UNSPECIFIED'
+        | 'COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS'
+        | 'COMMENTS_VIEW_MODE_OMITTED'
+        | 'COMMENTS_VIEW_MODE_INCLUDED';
       /** Output only. The ID of the document. */
       documentId?: string;
       /** 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. */
@@ -327,6 +395,8 @@ declare namespace gapi.client {
       suggestedDocumentStyleChanges?: {[P in string]: SuggestedDocumentStyle};
       /** 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 associated with the document. Only populated if the commentsViewMode parameter is set to require comments (such as `COMMENTS_VIEW_MODE_INCLUDED`). [Developer Preview](https://developers.google.com/workspace/preview). */
+      suggestions?: SuggestionThread[];
       /** 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?:
         | 'DEFAULT_FOR_CURRENT_ACCESS'
@@ -427,6 +497,8 @@ declare namespace gapi.client {
     interface DocumentTab {
       /** The main body of the document tab. */
       body?: Body;
+      /** The comment anchors in a document tab, keyed by anchor ID. Only populated if the commentsViewMode parameter is set to require comments (such as `COMMENTS_VIEW_MODE_INCLUDED`). [Developer Preview](https://developers.google.com/workspace/preview). */
+      commentAnchors?: {[P in string]: CommentAnchor};
       /** The style of the document tab. */
       documentStyle?: DocumentStyle;
       /** The footers in the document tab, keyed by footer ID. */
@@ -646,6 +718,18 @@ declare namespace gapi.client {
       /** A mask that indicates which of the fields in embedded_object have been changed in this suggestion. */
       embeddedObjectSuggestionState?: EmbeddedObjectSuggestionState;
     }
+    interface InsertCommentRequest {
+      /** Optional. The email address of the assignee of the comment. Leave empty for a non-assigned comment. May not exceed 2048 UTF-8 code units. */
+      assigneeEmailAddress?: string;
+      /** The text of the comment, as plain text. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units. */
+      content?: string;
+      /** The Range in the document that is tied to this comment. */
+      range?: Range;
+    }
+    interface InsertCommentResponse {
+      /** The newly-inserted comment thread. */
+      commentThread?: CommentThread;
+    }
     interface InsertDateRequest {
       /** The properties of the date to insert. */
       dateElementProperties?: DateElementProperties;
@@ -1137,6 +1221,52 @@ declare namespace gapi.client {
       /** A mask that indicates which of the fields in positioning have been changed in this suggestion. */
       positioningSuggestionState?: PositionedObjectPositioningSuggestionState;
     }
+    interface Post {
+      /** Optional. The email of the user who is being newly assigned to the thread as part of this post. Returns a 400 bad request error if: - The parent thread is a CommentThread whose headPost does not have an assignee. - The parent thread is a SuggestionThread. - commentAction is specified as `RESOLVE` or `REOPEN`. - `assigneeEmail` exceeds 2048 UTF-8 code units. */
+      assigneeEmail?: string;
+      /** Output only. The user who created the post. */
+      author?: PostAuthor;
+      /** Optional. The action type for comment posts. */
+      commentAction?:
+        | 'COMMENT_ACTION_TYPE_UNSPECIFIED'
+        | 'NO_COMMENT_ACTION_CHANGE'
+        | 'RESOLVE'
+        | 'REOPEN';
+      /** The content of the post. Required to be non-empty if commentAction is not `RESOLVE` or `REOPEN`. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. May not exceed 2048 UTF-8 code units. */
+      content?: string;
+      /** Output only. The content of the post as HTML. */
+      contentHtml?: string;
+      /** Output only. The time the post was created. */
+      createTime?: string;
+      /** Output only. Whether the post is deleted. If `true`, content and author fields will be empty. */
+      deleted?: boolean;
+      /** Output only. Whether the post is from a copied document. This field cannot be set directly by callers. */
+      fromCopiedDocument?: boolean;
+      /** Output only. Whether the post is from a document comparison. This field cannot be set directly by callers. */
+      fromDocumentComparison?: boolean;
+      /** Output only. Whether the post is from an imported document. This field cannot be set directly by callers. */
+      fromImportedDocument?: boolean;
+      /** Output only. The unique ID of the post. */
+      postId?: string;
+      /** Output only. The action type for suggestion posts. */
+      suggestionAction?:
+        | 'SUGGESTION_ACTION_TYPE_UNSPECIFIED'
+        | 'NO_SUGGESTION_ACTION_CHANGE'
+        | 'ACCEPT'
+        | 'REJECT';
+      /** Output only. The time the post was last updated. */
+      updateTime?: string;
+    }
+    interface PostAuthor {
+      /** Whether the user is anonymous. */
+      anonymous?: boolean;
+      /** The display name of the user. May be absent if the author is anonymous. */
+      displayName?: string;
+      /** Whether the user is the authenticated user making the request. */
+      me?: boolean;
+      /** The resource name of the post author user, which can also be used to identify the user in the [Google People API](https://developers.google.com/people/api/rest/v1/people). Format: `users/{user}`. Will not be populated if the anonymous field is `true` or if the post is from an imported document. */
+      user?: string;
+    }
     interface Range {
       /** The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. */
       endIndex?: number;
@@ -1147,6 +1277,10 @@ declare namespace gapi.client {
       /** 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 RejectSuggestionRequest {
+      /** The ID of the suggestion. */
+      suggestionId?: string;
+    }
     interface ReplaceAllTextRequest {
       /** Finds text in the document matching this substring. */
       containsText?: SubstringMatchCriteria;
@@ -1180,6 +1314,10 @@ declare namespace gapi.client {
       text?: string;
     }
     interface Request {
+      /** Accepts a suggestion. [Developer Preview](https://developers.google.com/workspace/preview). */
+      acceptSuggestion?: AcceptSuggestionRequest;
+      /** Adds a reply to a CommentThread or SuggestionThread. [Developer Preview](https://developers.google.com/workspace/preview). */
+      addCommentReply?: AddCommentReplyRequest;
       /** Adds a document tab. */
       addDocumentTab?: AddDocumentTabRequest;
       /** Creates a footer. */
@@ -1192,6 +1330,10 @@ declare namespace gapi.client {
       createNamedRange?: CreateNamedRangeRequest;
       /** Creates bullets for paragraphs. */
       createParagraphBullets?: CreateParagraphBulletsRequest;
+      /** Deletes a CommentThread. [Developer Preview](https://developers.google.com/workspace/preview). */
+      deleteComment?: DeleteCommentRequest;
+      /** Deletes a reply Post from a CommentThread or SuggestionThread. [Developer Preview](https://developers.google.com/workspace/preview). */
+      deleteCommentReply?: DeleteCommentReplyRequest;
       /** Deletes content from the document. */
       deleteContentRange?: DeleteContentRangeRequest;
       /** Deletes a footer from the document. */
@@ -1204,12 +1346,16 @@ declare namespace gapi.client {
       deleteParagraphBullets?: DeleteParagraphBulletsRequest;
       /** Deletes a positioned object from the document. */
       deletePositionedObject?: DeletePositionedObjectRequest;
+      /** Deletes a suggestion. [Developer Preview](https://developers.google.com/workspace/preview). */
+      deleteSuggestion?: DeleteSuggestionRequest;
       /** Deletes a document tab. */
       deleteTab?: DeleteTabRequest;
       /** Deletes a column from a table. */
       deleteTableColumn?: DeleteTableColumnRequest;
       /** Deletes a row from a table. */
       deleteTableRow?: DeleteTableRowRequest;
+      /** Inserts a CommentThread into the document. [Developer Preview](https://developers.google.com/workspace/preview). */
+      insertComment?: InsertCommentRequest;
       /** Inserts a date. */
       insertDate?: InsertDateRequest;
       /** Inserts an inline image at the specified location. */
@@ -1234,6 +1380,8 @@ declare namespace gapi.client {
       mergeTableCells?: MergeTableCellsRequest;
       /** Updates the number of pinned header rows in a table. */
       pinTableHeaderRows?: PinTableHeaderRowsRequest;
+      /** Rejects a suggestion. [Developer Preview](https://developers.google.com/workspace/preview). */
+      rejectSuggestion?: RejectSuggestionRequest;
       /** Replaces all instances of the specified text. */
       replaceAllText?: ReplaceAllTextRequest;
       /** Replaces an image in the document. */
@@ -1242,6 +1390,8 @@ declare namespace gapi.client {
       replaceNamedRangeContent?: ReplaceNamedRangeContentRequest;
       /** Unmerges cells in a table. */
       unmergeTableCells?: UnmergeTableCellsRequest;
+      /** Updates an existing post (head post or reply) of a CommentThread or SuggestionThread. [Developer Preview](https://developers.google.com/workspace/preview). */
+      updateCommentPost?: UpdateCommentPostRequest;
       /** Updates the style of the document. */
       updateDocumentStyle?: UpdateDocumentStyleRequest;
       /** Updates the properties of a document tab. */
@@ -1262,6 +1412,8 @@ declare namespace gapi.client {
       updateTextStyle?: UpdateTextStyleRequest;
     }
     interface Response {
+      /** The result of adding a reply to a comment or suggestion. [Developer Preview](https://developers.google.com/workspace/preview). */
+      addCommentReply?: AddCommentReplyResponse;
       /** The result of adding a document tab. */
       addDocumentTab?: AddDocumentTabResponse;
       /** The result of creating a footer. */
@@ -1272,6 +1424,8 @@ declare namespace gapi.client {
       createHeader?: CreateHeaderResponse;
       /** The result of creating a named range. */
       createNamedRange?: CreateNamedRangeResponse;
+      /** The result of inserting a comment. [Developer Preview](https://developers.google.com/workspace/preview). */
+      insertComment?: InsertCommentResponse;
       /** The result of inserting an inline image. */
       insertInlineImage?: InsertInlineImageResponse;
       /** The result of inserting an inline Google Sheets chart. */
@@ -1485,6 +1639,32 @@ 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 SuggestionResponse {
+      /** The IDs of suggestions which were accepted during the update. */
+      acceptedSuggestionIds?: string[];
+      /** The IDs of suggestions which were created during the update. */
+      createdSuggestionIds?: string[];
+      /** The IDs of suggestions which were deleted during the update. */
+      deletedSuggestionIds?: string[];
+      /** The IDs of suggestions which were rejected during the update. */
+      rejectedSuggestionIds?: string[];
+      /** The IDs of suggestions whose summaries were updated during the update. */
+      updatedSummarySuggestionIds?: string[];
+    }
+    interface SuggestionThread {
+      /** The first post in the thread. */
+      headPost?: Post;
+      /** Replies to the head post. */
+      replies?: Post[];
+      /** Whether the thread is open, accepted, or rejected. */
+      status?: 'STATUS_UNSPECIFIED' | 'OPEN' | 'ACCEPTED' | 'REJECTED';
+      /** The unique ID of the suggestion. */
+      suggestionId?: string;
+      /** Summary of the suggested differences in the document, in HTML. May be empty. */
+      summaryHtml?: string;
+      /** Summary of the suggested differences in the document, in plain text. May be empty. */
+      summaryText?: string;
+    }
     interface Tab {
       /** The child tabs nested within this tab. */
       childTabs?: Tab[];
@@ -1740,6 +1920,16 @@ declare namespace gapi.client {
       /** The table range specifying which cells of the table to unmerge. All merged cells in this range will be unmerged, and cells that are already unmerged will not be affected. If the range has no merged cells, the request will do nothing. If there is text in any of the merged cells, the text will remain in the "head" cell of the resulting block of unmerged cells. The "head" cell is the upper-left cell when the content direction is from left to right, and the upper-right otherwise. */
       tableRange?: TableRange;
     }
+    interface UpdateCommentPostRequest {
+      /** The ID of the CommentThread which the post belongs to. */
+      commentId?: string;
+      /** The new text of the comment, as plain text. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. This field cannot be empty, and must not exceed 2048 UTF-8 code units. */
+      content?: string;
+      /** The ID of the post being updated. */
+      postId?: string;
+      /** The ID of the SuggestionThread which the post belongs to. */
+      suggestionId?: string;
+    }
     interface UpdateDocumentStyleRequest {
       /** The styles to set on the document. Certain document style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of DocumentStyle for more information. */
       documentStyle?: DocumentStyle;
@@ -1827,6 +2017,8 @@ declare namespace gapi.client {
       requiredRevisionId?: string;
       /** The optional target revision ID of the document the write request is applied to. If collaborator changes have occurred after the document was read using the API, the changes produced by this write request are applied against the collaborator changes. This results in a new revision of the document that incorporates both the collaborator changes and the changes in the request, with the Docs server resolving conflicting changes. When using target revision ID, the API client can be thought of as another collaborator of the document. The target revision ID can only be used to write to recent versions of a document. If the target revision is too far behind the latest revision, the request is not processed and returns a 400 bad request error. The request should be tried again after retrieving the latest version of the document. Usually a revision ID remains valid for use as a target revision for several minutes after it's read, but for frequently edited documents this window might be shorter. */
       targetRevisionId?: string;
+      /** How the request updates should be applied to the document. If unspecified, the request updates will be applied as normal edits. [Developer Preview](https://developers.google.com/workspace/preview). */
+      writeMode?: 'WRITE_MODE_UNSPECIFIED' | 'EDIT' | 'SUGGEST';
     }
     interface DocumentsResource {
       /** Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically. */
@@ -1951,6 +2143,12 @@ declare namespace gapi.client {
         alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
+        /** The comments view mode to apply to the document. This allows viewing the document with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. If you set comments_view_mode to any value, you must also set include_tabs_content to `true` or use a field mask that references the Document.tabs field (or any subfield). If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED, you must also explicitly set suggestions_view_mode to SUGGESTIONS_INLINE. If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED or COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, you may not set suggestions_view_mode to PREVIEW_WITHOUT_SUGGESTIONS or PREVIEW_SUGGESTIONS_ACCEPTED. [Developer Preview](https://developers.google.com/workspace/preview). */
+        commentsViewMode?:
+          | 'COMMENTS_VIEW_MODE_UNSPECIFIED'
+          | 'COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS'
+          | 'COMMENTS_VIEW_MODE_OMITTED'
+          | 'COMMENTS_VIEW_MODE_INCLUDED';
         /** The ID of the document to retrieve. */
         documentId: string;
         /** Selector specifying which fields to include in a partial response. */

package/package.json

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