@maxim_mazurok/gapi.client.sheets-v4 0.3.20260915 → 0.3.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://sheets.googleapis.com/$discovery/rest?version=v4
-// Revision: 20260915
+// Revision: 20260923
 
 /// <reference types="gapi.client" />
 
@@ -40,6 +40,16 @@ declare namespace gapi.client {
       /** The newly added chart. */
       chart?: EmbeddedChart;
     }
+    interface AddCommentReplyRequest {
+      /** The ID of the CommentThread to add the reply to. */
+      commentId?: string;
+      /** The Post representing the reply. */
+      post?: Post;
+    }
+    interface AddCommentReplyResponse {
+      /** The newly-inserted reply Post. */
+      post?: Post;
+    }
     interface AddConditionalFormatRuleRequest {
       /** The zero-based index where the rule should be inserted. */
       index?: number;
@@ -367,6 +377,12 @@ declare namespace gapi.client {
       valueRanges?: ValueRange[];
     }
     interface BatchUpdateSpreadsheetRequest {
+      /** The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. Meaningful only if include_spreadsheet_in_response is 'true'. [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';
       /** Determines if the update response should include the spreadsheet resource. */
       includeSpreadsheetInResponse?: boolean;
       /** A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied. */
@@ -377,6 +393,12 @@ declare namespace gapi.client {
       responseRanges?: string[];
     }
     interface BatchUpdateSpreadsheetResponse {
+      /** 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 reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty. */
       replies?: Response[];
       /** The spreadsheet the updates were applied to. */
@@ -850,6 +872,26 @@ declare namespace gapi.client {
         | 'ACCENT6'
         | 'LINK';
     }
+    interface CommentAnchor {
+      /** The unique ID of the comment anchor. Output only. */
+      anchorId?: string;
+      /** The coordinate range inside the sheet where this comment is anchored. */
+      range?: GridRange;
+    }
+    interface CommentThread {
+      /** The ID of the CommentAnchor in the sheet that this thread is tied to. */
+      anchorId?: string;
+      /** The unique ID of the comment thread. */
+      commentId?: string;
+      /** The first post in the thread. */
+      headPost?: Post;
+      /** The quoted text from the spreadsheet 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 ConditionalFormatRule {
       /** The formatting is either "on" or "off" according to the rule. */
       booleanRule?: BooleanRule;
@@ -1156,6 +1198,16 @@ declare namespace gapi.client {
       /** The ID of the banded range to delete. */
       bandedRangeId?: number;
     }
+    interface DeleteCommentReplyRequest {
+      /** The ID of the CommentThread which the post belongs to. */
+      commentId?: string;
+      /** The ID of the reply Post being deleted. */
+      postId?: string;
+    }
+    interface DeleteCommentRequest {
+      /** The ID of the CommentThread that is being deleted. */
+      commentId?: string;
+    }
     interface DeleteConditionalFormatRuleRequest {
       /** The zero-based index of the rule to be deleted. */
       index?: number;
@@ -1468,6 +1520,12 @@ declare namespace gapi.client {
       valuesChanged?: number;
     }
     interface GetSpreadsheetByDataFilterRequest {
+      /** The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. [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 DataFilters used to select which ranges to retrieve from the spreadsheet. */
       dataFilters?: DataFilter[];
       /** True if tables should be excluded in the banded ranges. False if not set. */
@@ -1566,6 +1624,18 @@ declare namespace gapi.client {
       /** The data for this histogram series. */
       data?: ChartData;
     }
+    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 Sheets 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 GridCoordinate in the sheet that is tied to this comment. */
+      coordinate?: GridCoordinate;
+    }
+    interface InsertCommentResponse {
+      /** The newly-inserted comment thread. */
+      commentThread?: CommentThread;
+    }
     interface InsertDimensionRequest {
       /** Whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions. True to inherit from the dimensions before (in which case the start index must be greater than 0), and false to inherit from the dimensions after. For example, if row index 0 has red background and row index 1 has a green background, then inserting 2 rows at index 1 can inherit either the green or red background. If `inheritFromBefore` is true, the two new rows will be red (because the row before the insertion point was red), whereas if `inheritFromBefore` is false, the two new rows will be green (because the row after the insertion point was green). */
       inheritFromBefore?: boolean;
@@ -1918,6 +1988,44 @@ declare namespace gapi.client {
       /** The point size. If empty, a default size is used. */
       size?: number;
     }
+    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. - commentAction is specified as `RESOLVE` or `REOPEN`. - `assignee_email` exceeds 2048 UTF-8 code units. */
+      assigneeEmail?: string;
+      /** Output only. The user who created the post. */
+      author?: PostAuthor;
+      /** Action taken as part of creating the post. */
+      commentAction?:
+        | 'COMMENT_ACTION_TYPE_UNSPECIFIED'
+        | 'NO_COMMENT_ACTION_CHANGE'
+        | 'RESOLVE'
+        | 'REOPEN';
+      /** The content of the post. Required to be non-empty if comment_action is not `RESOLVE` or `REOPEN`. This text content will be handled similarly to comments created in the Sheets 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 spreadsheet. This field cannot be set directly by callers. */
+      fromCopiedSpreadsheet?: boolean;
+      /** Output only. Whether the post is from an imported spreadsheet. This field cannot be set directly by callers. */
+      fromImportedSpreadsheet?: boolean;
+      /** Output only. The unique ID of the post. */
+      postId?: string;
+      /** 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 spreadsheet. */
+      user?: string;
+    }
     interface ProtectedRange {
       /** The description of this protected range. */
       description?: string;
@@ -1990,6 +2098,8 @@ declare namespace gapi.client {
       addBanding?: AddBandingRequest;
       /** Adds a chart. */
       addChart?: AddChartRequest;
+      /** Adds a reply to a CommentThread. [Developer Preview](https://developers.google.com/workspace/preview). */
+      addCommentReply?: AddCommentReplyRequest;
       /** Adds a new conditional format rule. */
       addConditionalFormatRule?: AddConditionalFormatRuleRequest;
       /** Adds a data source. */
@@ -2028,6 +2138,10 @@ declare namespace gapi.client {
       cutPaste?: CutPasteRequest;
       /** Removes a banded range */
       deleteBanding?: DeleteBandingRequest;
+      /** Deletes a CommentThread. [Developer Preview](https://developers.google.com/workspace/preview). */
+      deleteComment?: DeleteCommentRequest;
+      /** Deletes a reply Post from a CommentThread [Developer Preview](https://developers.google.com/workspace/preview). */
+      deleteCommentReply?: DeleteCommentReplyRequest;
       /** Deletes an existing conditional format rule. */
       deleteConditionalFormatRule?: DeleteConditionalFormatRuleRequest;
       /** Deletes a data source. */
@@ -2060,6 +2174,8 @@ declare namespace gapi.client {
       duplicateSheet?: DuplicateSheetRequest;
       /** Finds and replaces occurrences of some text with other text. */
       findReplace?: FindReplaceRequest;
+      /** Inserts a CommentThread into the spreadsheet. [Developer Preview](https://developers.google.com/workspace/preview). */
+      insertComment?: InsertCommentRequest;
       /** Inserts new rows or columns in a sheet. */
       insertDimension?: InsertDimensionRequest;
       /** Inserts new cells in a sheet, shifting the existing cells. */
@@ -2096,6 +2212,8 @@ declare namespace gapi.client {
       updateCells?: UpdateCellsRequest;
       /** Updates a chart's specifications. */
       updateChartSpec?: UpdateChartSpecRequest;
+      /** Updates an existing post (head post or reply) of a CommentThread. [Developer Preview](https://developers.google.com/workspace/preview). */
+      updateCommentPost?: UpdateCommentPostRequest;
       /** Updates an existing conditional format rule. */
       updateConditionalFormatRule?: UpdateConditionalFormatRuleRequest;
       /** Updates a data source. */
@@ -2130,6 +2248,8 @@ declare namespace gapi.client {
       addBanding?: AddBandingResponse;
       /** A reply from adding a chart. */
       addChart?: AddChartResponse;
+      /** The result of creating a reply. [Developer Preview](https://developers.google.com/workspace/preview). */
+      addCommentReply?: AddCommentReplyResponse;
       /** A reply from adding a data source. */
       addDataSource?: AddDataSourceResponse;
       /** A reply from adding a dimension group. */
@@ -2164,6 +2284,8 @@ declare namespace gapi.client {
       duplicateSheet?: DuplicateSheetResponse;
       /** A reply from doing a find/replace. */
       findReplace?: FindReplaceResponse;
+      /** The result of creating a comment. [Developer Preview](https://developers.google.com/workspace/preview). */
+      insertComment?: InsertCommentResponse;
       /** A reply from refreshing data source objects. */
       refreshDataSource?: RefreshDataSourceResponse;
       /** A reply from trimming whitespace. */
@@ -2242,6 +2364,8 @@ declare namespace gapi.client {
       charts?: EmbeddedChart[];
       /** All column groups on this sheet, ordered by increasing range start index, then by group depth. */
       columnGroups?: DimensionGroup[];
+      /** The comment anchors on this sheet. [Developer Preview](https://developers.google.com/workspace/preview). */
+      commentAnchors?: CommentAnchor[];
       /** The conditional format rules in this sheet. */
       conditionalFormats?: ConditionalFormatRule[];
       /** Data in the grid, if this is a grid sheet. The number of GridData objects returned is dependent on the number of ranges requested on this sheet. For example, if this is representing `Sheet1`, and the spreadsheet was requested with ranges `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a startRow/startColumn of `0`, while the second one will have `startRow 14` (zero-based row 15), and `startColumn 3` (zero-based column D). For a DATA_SOURCE sheet, you can not request a specific range, the GridData contains all the values. */
@@ -2345,6 +2469,14 @@ declare namespace gapi.client {
       source?: GridRange;
     }
     interface Spreadsheet {
+      /** The comment threads associated with the spreadsheet. [Developer Preview](https://developers.google.com/workspace/preview). */
+      comments?: CommentThread[];
+      /** Output only. The comments view mode applied to the spreadsheet. [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';
       /** A list of external data sources connected with the spreadsheet. */
       dataSources?: DataSource[];
       /** Output only. A list of data source refresh schedules. */
@@ -2612,6 +2744,14 @@ declare namespace gapi.client {
       /** The specification to apply to the chart. */
       spec?: ChartSpec;
     }
+    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 Sheets 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;
+    }
     interface UpdateConditionalFormatRuleRequest {
       /** The zero-based index of the rule that should be replaced or moved. */
       index?: number;
@@ -3695,6 +3835,12 @@ declare namespace gapi.client {
         alt?: 'json' | 'media' | 'proto';
         /** JSONP */
         callback?: string;
+        /** The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. [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';
         /** True if tables should be excluded in the banded ranges. False if not set. */
         excludeTablesInBandedRanges?: boolean;
         /** Selector specifying which fields to include in a partial response. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.sheets-v4",
-  "version": "0.3.20260915",
+  "version": "0.3.20260923",
   "description": "TypeScript typings for Google Sheets API v4",
   "repository": {
     "type": "git",