@googleapis/docs 14.0.1 → 14.1.1

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.
package/v1.ts CHANGED
@@ -124,6 +124,41 @@ export namespace docs_v1 {
124
124
  }
125
125
  }
126
126
 
127
+ /**
128
+ * Accepts a suggestion. Returns a 403 forbidden error if the requesting user does not have edit access to the document.
129
+ */
130
+ export interface Schema$AcceptSuggestionRequest {
131
+ /**
132
+ * The ID of the suggestion.
133
+ */
134
+ suggestionId?: string | null;
135
+ }
136
+ /**
137
+ * Inserts a reply Post into a CommentThread or SuggestionThread.
138
+ */
139
+ export interface Schema$AddCommentReplyRequest {
140
+ /**
141
+ * The ID of the CommentThread to add the reply to.
142
+ */
143
+ commentId?: string | null;
144
+ /**
145
+ * The Post representing the reply.
146
+ */
147
+ post?: Schema$Post;
148
+ /**
149
+ * The ID of the SuggestionThread to add the reply to.
150
+ */
151
+ suggestionId?: string | null;
152
+ }
153
+ /**
154
+ * Response message for adding a reply.
155
+ */
156
+ export interface Schema$AddCommentReplyResponse {
157
+ /**
158
+ * The newly-inserted reply Post.
159
+ */
160
+ post?: Schema$Post;
161
+ }
127
162
  /**
128
163
  * Adds a document tab. When a tab is added at a given index, all subsequent tabs' indexes are incremented.
129
164
  */
@@ -204,6 +239,10 @@ export namespace docs_v1 {
204
239
  * Response message from a BatchUpdateDocument request.
205
240
  */
206
241
  export interface Schema$BatchUpdateDocumentResponse {
242
+ /**
243
+ * Whether comment updates were applied in the batch request.
244
+ */
245
+ commentUpdateState?: string | null;
207
246
  /**
208
247
  * The ID of the document to which the updates were applied to.
209
248
  */
@@ -212,6 +251,10 @@ export namespace docs_v1 {
212
251
  * The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.
213
252
  */
214
253
  replies?: Schema$Response[];
254
+ /**
255
+ * The suggestions which were affected by each update. This maps 1:1 with the updates.
256
+ */
257
+ suggestionResponses?: Schema$SuggestionResponse[];
215
258
  /**
216
259
  * The updated write control after applying the request.
217
260
  */
@@ -305,6 +348,70 @@ export namespace docs_v1 {
305
348
  */
306
349
  textStyle?: Schema$TextStyle;
307
350
  }
351
+ /**
352
+ * One or more locations in the document that are tied to CommentThreads with the same anchorId. Note: Multiple anchors may refer to the same location.
353
+ */
354
+ export interface Schema$CommentAnchor {
355
+ /**
356
+ * The ID of the comment anchor.
357
+ */
358
+ anchorId?: string | null;
359
+ /**
360
+ * A collection of Ranges in the document which are tied to this anchor.
361
+ */
362
+ ranges?: Schema$Range[];
363
+ }
364
+ /**
365
+ * Represents a single comment thread.
366
+ */
367
+ export interface Schema$CommentThread {
368
+ /**
369
+ * The ID of the CommentAnchor in the document that this thread is tied to. Multiple comment threads may be anchored to the same CommentAnchor.
370
+ */
371
+ anchorId?: string | null;
372
+ /**
373
+ * The unique ID of the comment thread.
374
+ */
375
+ commentId?: string | null;
376
+ /**
377
+ * The first post in the thread.
378
+ */
379
+ headPost?: Schema$Post;
380
+ /**
381
+ * The quoted text from the document when the comment was created, formatted as plain-text.
382
+ */
383
+ plainTextQuote?: string | null;
384
+ /**
385
+ * Replies to the head post.
386
+ */
387
+ replies?: Schema$Post[];
388
+ /**
389
+ * Whether the thread is open or resolved.
390
+ */
391
+ status?: string | null;
392
+ }
393
+ /**
394
+ * Creates a new DropdownDefinition in the document.
395
+ */
396
+ export interface Schema$CreateDropdownDefinitionRequest {
397
+ /**
398
+ * Required. The DropdownDefinition to create.
399
+ */
400
+ dropdownDefinition?: Schema$DropdownDefinition;
401
+ /**
402
+ * The ID of the tab to create the dropdown definition 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.
403
+ */
404
+ tabId?: string | null;
405
+ }
406
+ /**
407
+ * Response message for creating a dropdown definition.
408
+ */
409
+ export interface Schema$CreateDropdownDefinitionResponse {
410
+ /**
411
+ * The newly-created DropdownDefinition.
412
+ */
413
+ dropdownDefinition?: Schema$DropdownDefinition;
414
+ }
308
415
  /**
309
416
  * Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned.
310
417
  */
@@ -547,6 +654,32 @@ export namespace docs_v1 {
547
654
  */
548
655
  timeZoneIdSuggested?: boolean | null;
549
656
  }
657
+ /**
658
+ * Deletes a reply Post from a CommentThread or SuggestionThread. Returns a 400 bad request error if: - The requesting user is not the author of the post. - The reply post contains an action. - The reply post contains an assignee.
659
+ */
660
+ export interface Schema$DeleteCommentReplyRequest {
661
+ /**
662
+ * The ID of the CommentThread which the post belongs to.
663
+ */
664
+ commentId?: string | null;
665
+ /**
666
+ * The ID of the reply Post being deleted.
667
+ */
668
+ postId?: string | null;
669
+ /**
670
+ * The ID of the SuggestionThread which the post belongs to.
671
+ */
672
+ suggestionId?: string | null;
673
+ }
674
+ /**
675
+ * Deletes a CommentThread. Returns a 400 bad request error if the requesting user is not the author of the headPost.
676
+ */
677
+ export interface Schema$DeleteCommentRequest {
678
+ /**
679
+ * The ID of the CommentThread that is being deleted.
680
+ */
681
+ commentId?: string | null;
682
+ }
550
683
  /**
551
684
  * Deletes content from the document.
552
685
  */
@@ -556,6 +689,19 @@ export namespace docs_v1 {
556
689
  */
557
690
  range?: Schema$Range;
558
691
  }
692
+ /**
693
+ * Deletes a DropdownDefinition. If the dropdown definition is referenced by any dropdown instances (chips) in the document, a 400 bad request error is returned.
694
+ */
695
+ export interface Schema$DeleteDropdownDefinitionRequest {
696
+ /**
697
+ * The ID of the DropdownDefinition to delete.
698
+ */
699
+ dropdownDefinitionId?: string | null;
700
+ /**
701
+ * The ID of the tab that contains the dropdown definition 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.
702
+ */
703
+ tabId?: string | null;
704
+ }
559
705
  /**
560
706
  * Deletes a Footer from the document.
561
707
  */
@@ -621,6 +767,15 @@ export namespace docs_v1 {
621
767
  */
622
768
  tabId?: string | null;
623
769
  }
770
+ /**
771
+ * Deletes a suggestion. Returns a 403 forbidden error if the requesting user is not the author of the suggestion.
772
+ */
773
+ export interface Schema$DeleteSuggestionRequest {
774
+ /**
775
+ * The ID of the suggestion.
776
+ */
777
+ suggestionId?: string | null;
778
+ }
624
779
  /**
625
780
  * Deletes a column from a table.
626
781
  */
@@ -669,6 +824,14 @@ export namespace docs_v1 {
669
824
  * 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.
670
825
  */
671
826
  body?: Schema$Body;
827
+ /**
828
+ * 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`).
829
+ */
830
+ comments?: Schema$CommentThread[];
831
+ /**
832
+ * Output only. The comments view mode applied to the document.
833
+ */
834
+ commentsViewMode?: string | null;
672
835
  /**
673
836
  * Output only. The ID of the document.
674
837
  */
@@ -725,6 +888,10 @@ export namespace docs_v1 {
725
888
  suggestedNamedStylesChanges?: {
726
889
  [key: string]: Schema$SuggestedNamedStyles;
727
890
  } | null;
891
+ /**
892
+ * 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`).
893
+ */
894
+ suggestions?: Schema$SuggestionThread[];
728
895
  /**
729
896
  * 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.
730
897
  */
@@ -921,10 +1088,18 @@ export namespace docs_v1 {
921
1088
  * The main body of the document tab.
922
1089
  */
923
1090
  body?: Schema$Body;
1091
+ /**
1092
+ * 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`).
1093
+ */
1094
+ commentAnchors?: {[key: string]: Schema$CommentAnchor} | null;
924
1095
  /**
925
1096
  * The style of the document tab.
926
1097
  */
927
1098
  documentStyle?: Schema$DocumentStyle;
1099
+ /**
1100
+ * The dropdown definitions in a document tab, keyed by dropdown definition ID.
1101
+ */
1102
+ dropdownDefinitions?: {[key: string]: Schema$DropdownDefinition} | null;
928
1103
  /**
929
1104
  * The footers in the document tab, keyed by footer ID.
930
1105
  */
@@ -970,6 +1145,139 @@ export namespace docs_v1 {
970
1145
  [key: string]: Schema$SuggestedNamedStyles;
971
1146
  } | null;
972
1147
  }
1148
+ /**
1149
+ * A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options.
1150
+ */
1151
+ export interface Schema$Dropdown {
1152
+ /**
1153
+ * The ID of this dropdown.
1154
+ */
1155
+ dropdownId?: string | null;
1156
+ /**
1157
+ * The properties of this dropdown.
1158
+ */
1159
+ dropdownProperties?: Schema$DropdownProperties;
1160
+ /**
1161
+ * IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion.
1162
+ */
1163
+ suggestedDeletionIds?: string[] | null;
1164
+ /**
1165
+ * The suggested properties changes to this dropdown, keyed by suggestion ID.
1166
+ */
1167
+ suggestedDropdownPropertiesChanges?: {
1168
+ [key: string]: Schema$SuggestedDropdownProperties;
1169
+ } | null;
1170
+ /**
1171
+ * IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion.
1172
+ */
1173
+ suggestedInsertionIds?: string[] | null;
1174
+ /**
1175
+ * The suggested text style changes to this dropdown, keyed by suggestion ID.
1176
+ */
1177
+ suggestedTextStyleChanges?: {
1178
+ [key: string]: Schema$SuggestedTextStyle;
1179
+ } | null;
1180
+ /**
1181
+ * The text style of this dropdown.
1182
+ */
1183
+ textStyle?: Schema$TextStyle;
1184
+ }
1185
+ /**
1186
+ * A dropdown definition in the document.
1187
+ */
1188
+ export interface Schema$DropdownDefinition {
1189
+ /**
1190
+ * The ID of this dropdown definition. If you specify an ID, it must be unique among all IDs in the tab. The ID must start with `kix.` and match regex `^kix\.[a-zA-Z0-9_-]{2,14\}$` (length 6-18 chars). If you don't specify an ID, a unique one is generated.
1191
+ */
1192
+ dropdownDefinitionId?: string | null;
1193
+ /**
1194
+ * The properties of this dropdown definition.
1195
+ */
1196
+ dropdownDefinitionProperties?: Schema$DropdownDefinitionProperties;
1197
+ /**
1198
+ * ID for suggestion that deletes this dropdown definition.
1199
+ */
1200
+ suggestedDeletionId?: string | null;
1201
+ /**
1202
+ * Suggested property changes to this definition, keyed by suggestion ID.
1203
+ */
1204
+ suggestedDropdownDefinitionPropertiesChanges?: {
1205
+ [key: string]: Schema$SuggestedDropdownDefinitionProperties;
1206
+ } | null;
1207
+ /**
1208
+ * ID for suggestion that inserts this dropdown definition.
1209
+ */
1210
+ suggestedInsertionId?: string | null;
1211
+ }
1212
+ /**
1213
+ * Properties of a dropdown definition.
1214
+ */
1215
+ export interface Schema$DropdownDefinitionProperties {
1216
+ /**
1217
+ * The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options.
1218
+ */
1219
+ options?: Schema$DropdownOption[];
1220
+ /**
1221
+ * The title of the dropdown definition.
1222
+ */
1223
+ title?: string | null;
1224
+ }
1225
+ /**
1226
+ * A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.
1227
+ */
1228
+ export interface Schema$DropdownDefinitionPropertiesSuggestionState {
1229
+ /**
1230
+ * Indicates if there was a suggested change to options.
1231
+ */
1232
+ optionsSuggested?: boolean | null;
1233
+ /**
1234
+ * Indicates if there was a suggested change to title.
1235
+ */
1236
+ titleSuggested?: boolean | null;
1237
+ }
1238
+ /**
1239
+ * An option in a Dropdown.
1240
+ */
1241
+ export interface Schema$DropdownOption {
1242
+ /**
1243
+ * The display value of this dropdown option.
1244
+ */
1245
+ displayValue?: string | null;
1246
+ /**
1247
+ * The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14\}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated.
1248
+ */
1249
+ optionId?: string | null;
1250
+ /**
1251
+ * The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned.
1252
+ */
1253
+ textStyle?: Schema$TextStyle;
1254
+ }
1255
+ /**
1256
+ * Properties specific to a dropdown.
1257
+ */
1258
+ export interface Schema$DropdownProperties {
1259
+ /**
1260
+ * The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes.
1261
+ */
1262
+ displayValue?: string | null;
1263
+ /**
1264
+ * The ID of the DropdownDefinition that defines the options for this dropdown.
1265
+ */
1266
+ dropdownDefinitionId?: string | null;
1267
+ /**
1268
+ * The ID of the selected option in this dropdown.
1269
+ */
1270
+ selectedOptionId?: string | null;
1271
+ }
1272
+ /**
1273
+ * A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.
1274
+ */
1275
+ export interface Schema$DropdownPropertiesSuggestionState {
1276
+ /**
1277
+ * Indicates if there was a suggested change to selected_option_id.
1278
+ */
1279
+ selectedOptionIdSuggested?: boolean | null;
1280
+ }
973
1281
  /**
974
1282
  * The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported.
975
1283
  */
@@ -1388,6 +1696,32 @@ export namespace docs_v1 {
1388
1696
  */
1389
1697
  embeddedObjectSuggestionState?: Schema$EmbeddedObjectSuggestionState;
1390
1698
  }
1699
+ /**
1700
+ * Inserts a CommentThread into the document.
1701
+ */
1702
+ export interface Schema$InsertCommentRequest {
1703
+ /**
1704
+ * 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.
1705
+ */
1706
+ assigneeEmailAddress?: string | null;
1707
+ /**
1708
+ * 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.
1709
+ */
1710
+ content?: string | null;
1711
+ /**
1712
+ * The Range in the document that is tied to this comment.
1713
+ */
1714
+ range?: Schema$Range;
1715
+ }
1716
+ /**
1717
+ * Response message for inserting a comment.
1718
+ */
1719
+ export interface Schema$InsertCommentResponse {
1720
+ /**
1721
+ * The newly-inserted comment thread.
1722
+ */
1723
+ commentThread?: Schema$CommentThread;
1724
+ }
1391
1725
  /**
1392
1726
  * Inserts a date at the specified location.
1393
1727
  */
@@ -1405,6 +1739,36 @@ export namespace docs_v1 {
1405
1739
  */
1406
1740
  location?: Schema$Location;
1407
1741
  }
1742
+ /**
1743
+ * Inserts a Dropdown at the specified location.
1744
+ */
1745
+ export interface Schema$InsertDropdownRequest {
1746
+ /**
1747
+ * Required. The DropdownDefinition ID.
1748
+ */
1749
+ dropdownDefinitionId?: string | null;
1750
+ /**
1751
+ * The EndOfSegmentLocation in the document to insert the dropdown at.
1752
+ */
1753
+ endOfSegmentLocation?: Schema$EndOfSegmentLocation;
1754
+ /**
1755
+ * The Location in the document to insert the dropdown at.
1756
+ */
1757
+ location?: Schema$Location;
1758
+ /**
1759
+ * Optional initial value for the dropdown. If this field is not specified, the new dropdown will default to selecting the first option defined in the dropdown definition. If this field is specified but does not reference a valid option in the dropdown definition, a 400 bad request error is returned.
1760
+ */
1761
+ selectedOptionId?: string | null;
1762
+ }
1763
+ /**
1764
+ * The result of inserting a Dropdown.
1765
+ */
1766
+ export interface Schema$InsertDropdownResponse {
1767
+ /**
1768
+ * The newly-inserted Dropdown.
1769
+ */
1770
+ dropdown?: Schema$Dropdown;
1771
+ }
1408
1772
  /**
1409
1773
  * Inserts an InlineObject containing an image at the given location.
1410
1774
  */
@@ -1957,6 +2321,10 @@ export namespace docs_v1 {
1957
2321
  * A paragraph element that represents a date.
1958
2322
  */
1959
2323
  dateElement?: Schema$DateElement;
2324
+ /**
2325
+ * A paragraph element that represents a dropdown menu.
2326
+ */
2327
+ dropdown?: Schema$Dropdown;
1960
2328
  /**
1961
2329
  * The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
1962
2330
  */
@@ -2324,6 +2692,84 @@ export namespace docs_v1 {
2324
2692
  */
2325
2693
  positioningSuggestionState?: Schema$PositionedObjectPositioningSuggestionState;
2326
2694
  }
2695
+ /**
2696
+ * Represents a single post in a comment or suggestion thread.
2697
+ */
2698
+ export interface Schema$Post {
2699
+ /**
2700
+ * 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.
2701
+ */
2702
+ assigneeEmail?: string | null;
2703
+ /**
2704
+ * Output only. The user who created the post.
2705
+ */
2706
+ author?: Schema$PostAuthor;
2707
+ /**
2708
+ * Optional. The action type for comment posts.
2709
+ */
2710
+ commentAction?: string | null;
2711
+ /**
2712
+ * 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.
2713
+ */
2714
+ content?: string | null;
2715
+ /**
2716
+ * Output only. The content of the post as HTML.
2717
+ */
2718
+ contentHtml?: string | null;
2719
+ /**
2720
+ * Output only. The time the post was created.
2721
+ */
2722
+ createTime?: string | null;
2723
+ /**
2724
+ * Output only. Whether the post is deleted. If `true`, content and author fields will be empty.
2725
+ */
2726
+ deleted?: boolean | null;
2727
+ /**
2728
+ * Output only. Whether the post is from a copied document. This field cannot be set directly by callers.
2729
+ */
2730
+ fromCopiedDocument?: boolean | null;
2731
+ /**
2732
+ * Output only. Whether the post is from a document comparison. This field cannot be set directly by callers.
2733
+ */
2734
+ fromDocumentComparison?: boolean | null;
2735
+ /**
2736
+ * Output only. Whether the post is from an imported document. This field cannot be set directly by callers.
2737
+ */
2738
+ fromImportedDocument?: boolean | null;
2739
+ /**
2740
+ * Output only. The unique ID of the post.
2741
+ */
2742
+ postId?: string | null;
2743
+ /**
2744
+ * Output only. The action type for suggestion posts.
2745
+ */
2746
+ suggestionAction?: string | null;
2747
+ /**
2748
+ * Output only. The time the post was last updated.
2749
+ */
2750
+ updateTime?: string | null;
2751
+ }
2752
+ /**
2753
+ * Represents a user who authored a comment or suggestion post.
2754
+ */
2755
+ export interface Schema$PostAuthor {
2756
+ /**
2757
+ * Whether the user is anonymous.
2758
+ */
2759
+ anonymous?: boolean | null;
2760
+ /**
2761
+ * The display name of the user. May be absent if the author is anonymous.
2762
+ */
2763
+ displayName?: string | null;
2764
+ /**
2765
+ * Whether the user is the authenticated user making the request.
2766
+ */
2767
+ me?: boolean | null;
2768
+ /**
2769
+ * 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.
2770
+ */
2771
+ user?: string | null;
2772
+ }
2327
2773
  /**
2328
2774
  * Specifies a contiguous range of text.
2329
2775
  */
@@ -2345,6 +2791,15 @@ export namespace docs_v1 {
2345
2791
  */
2346
2792
  tabId?: string | null;
2347
2793
  }
2794
+ /**
2795
+ * Rejects a suggestion. Returns a 403 forbidden error if the requesting user does not have edit access to the document and is not the author of the suggestion.
2796
+ */
2797
+ export interface Schema$RejectSuggestionRequest {
2798
+ /**
2799
+ * The ID of the suggestion.
2800
+ */
2801
+ suggestionId?: string | null;
2802
+ }
2348
2803
  /**
2349
2804
  * Replaces all instances of text matching a criteria with replace text.
2350
2805
  */
@@ -2417,10 +2872,22 @@ export namespace docs_v1 {
2417
2872
  * A single update to apply to a document.
2418
2873
  */
2419
2874
  export interface Schema$Request {
2875
+ /**
2876
+ * Accepts a suggestion.
2877
+ */
2878
+ acceptSuggestion?: Schema$AcceptSuggestionRequest;
2879
+ /**
2880
+ * Adds a reply to a CommentThread or SuggestionThread.
2881
+ */
2882
+ addCommentReply?: Schema$AddCommentReplyRequest;
2420
2883
  /**
2421
2884
  * Adds a document tab.
2422
2885
  */
2423
2886
  addDocumentTab?: Schema$AddDocumentTabRequest;
2887
+ /**
2888
+ * Creates a DropdownDefinition.
2889
+ */
2890
+ createDropdownDefinition?: Schema$CreateDropdownDefinitionRequest;
2424
2891
  /**
2425
2892
  * Creates a footer.
2426
2893
  */
@@ -2441,10 +2908,22 @@ export namespace docs_v1 {
2441
2908
  * Creates bullets for paragraphs.
2442
2909
  */
2443
2910
  createParagraphBullets?: Schema$CreateParagraphBulletsRequest;
2911
+ /**
2912
+ * Deletes a CommentThread.
2913
+ */
2914
+ deleteComment?: Schema$DeleteCommentRequest;
2915
+ /**
2916
+ * Deletes a reply Post from a CommentThread or SuggestionThread.
2917
+ */
2918
+ deleteCommentReply?: Schema$DeleteCommentReplyRequest;
2444
2919
  /**
2445
2920
  * Deletes content from the document.
2446
2921
  */
2447
2922
  deleteContentRange?: Schema$DeleteContentRangeRequest;
2923
+ /**
2924
+ * Deletes a DropdownDefinition.
2925
+ */
2926
+ deleteDropdownDefinition?: Schema$DeleteDropdownDefinitionRequest;
2448
2927
  /**
2449
2928
  * Deletes a footer from the document.
2450
2929
  */
@@ -2465,6 +2944,10 @@ export namespace docs_v1 {
2465
2944
  * Deletes a positioned object from the document.
2466
2945
  */
2467
2946
  deletePositionedObject?: Schema$DeletePositionedObjectRequest;
2947
+ /**
2948
+ * Deletes a suggestion.
2949
+ */
2950
+ deleteSuggestion?: Schema$DeleteSuggestionRequest;
2468
2951
  /**
2469
2952
  * Deletes a document tab.
2470
2953
  */
@@ -2477,10 +2960,18 @@ export namespace docs_v1 {
2477
2960
  * Deletes a row from a table.
2478
2961
  */
2479
2962
  deleteTableRow?: Schema$DeleteTableRowRequest;
2963
+ /**
2964
+ * Inserts a CommentThread into the document.
2965
+ */
2966
+ insertComment?: Schema$InsertCommentRequest;
2480
2967
  /**
2481
2968
  * Inserts a date.
2482
2969
  */
2483
2970
  insertDate?: Schema$InsertDateRequest;
2971
+ /**
2972
+ * Inserts a Dropdown at the specified location.
2973
+ */
2974
+ insertDropdown?: Schema$InsertDropdownRequest;
2484
2975
  /**
2485
2976
  * Inserts an inline image at the specified location.
2486
2977
  */
@@ -2525,6 +3016,10 @@ export namespace docs_v1 {
2525
3016
  * Updates the number of pinned header rows in a table.
2526
3017
  */
2527
3018
  pinTableHeaderRows?: Schema$PinTableHeaderRowsRequest;
3019
+ /**
3020
+ * Rejects a suggestion.
3021
+ */
3022
+ rejectSuggestion?: Schema$RejectSuggestionRequest;
2528
3023
  /**
2529
3024
  * Replaces all instances of the specified text.
2530
3025
  */
@@ -2541,6 +3036,10 @@ export namespace docs_v1 {
2541
3036
  * Unmerges cells in a table.
2542
3037
  */
2543
3038
  unmergeTableCells?: Schema$UnmergeTableCellsRequest;
3039
+ /**
3040
+ * Updates an existing post (head post or reply) of a CommentThread or SuggestionThread.
3041
+ */
3042
+ updateCommentPost?: Schema$UpdateCommentPostRequest;
2544
3043
  /**
2545
3044
  * Updates the style of the document.
2546
3045
  */
@@ -2549,6 +3048,14 @@ export namespace docs_v1 {
2549
3048
  * Updates the properties of a document tab.
2550
3049
  */
2551
3050
  updateDocumentTabProperties?: Schema$UpdateDocumentTabPropertiesRequest;
3051
+ /**
3052
+ * Updates the properties of a DropdownDefinition.
3053
+ */
3054
+ updateDropdownDefinitionProperties?: Schema$UpdateDropdownDefinitionPropertiesRequest;
3055
+ /**
3056
+ * Updates the properties of a Dropdown.
3057
+ */
3058
+ updateDropdownProperties?: Schema$UpdateDropdownPropertiesRequest;
2552
3059
  /**
2553
3060
  * Updates a named style.
2554
3061
  */
@@ -2582,10 +3089,18 @@ export namespace docs_v1 {
2582
3089
  * A single response from an update.
2583
3090
  */
2584
3091
  export interface Schema$Response {
3092
+ /**
3093
+ * The result of adding a reply to a comment or suggestion.
3094
+ */
3095
+ addCommentReply?: Schema$AddCommentReplyResponse;
2585
3096
  /**
2586
3097
  * The result of adding a document tab.
2587
3098
  */
2588
3099
  addDocumentTab?: Schema$AddDocumentTabResponse;
3100
+ /**
3101
+ * The result of creating a dropdown definition.
3102
+ */
3103
+ createDropdownDefinition?: Schema$CreateDropdownDefinitionResponse;
2589
3104
  /**
2590
3105
  * The result of creating a footer.
2591
3106
  */
@@ -2602,6 +3117,14 @@ export namespace docs_v1 {
2602
3117
  * The result of creating a named range.
2603
3118
  */
2604
3119
  createNamedRange?: Schema$CreateNamedRangeResponse;
3120
+ /**
3121
+ * The result of inserting a comment.
3122
+ */
3123
+ insertComment?: Schema$InsertCommentResponse;
3124
+ /**
3125
+ * The result of inserting a dropdown.
3126
+ */
3127
+ insertDropdown?: Schema$InsertDropdownResponse;
2605
3128
  /**
2606
3129
  * The result of inserting an inline image.
2607
3130
  */
@@ -2946,6 +3469,32 @@ export namespace docs_v1 {
2946
3469
  */
2947
3470
  documentStyleSuggestionState?: Schema$DocumentStyleSuggestionState;
2948
3471
  }
3472
+ /**
3473
+ * A suggested change to dropdown definition properties.
3474
+ */
3475
+ export interface Schema$SuggestedDropdownDefinitionProperties {
3476
+ /**
3477
+ * A DropdownDefinitionProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_definition_properties_suggestion_state to see which fields have changed and their new values.
3478
+ */
3479
+ dropdownDefinitionProperties?: Schema$DropdownDefinitionProperties;
3480
+ /**
3481
+ * A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion.
3482
+ */
3483
+ dropdownDefinitionPropertiesSuggestionState?: Schema$DropdownDefinitionPropertiesSuggestionState;
3484
+ }
3485
+ /**
3486
+ * A suggested change to dropdown properties.
3487
+ */
3488
+ export interface Schema$SuggestedDropdownProperties {
3489
+ /**
3490
+ * A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values.
3491
+ */
3492
+ dropdownProperties?: Schema$DropdownProperties;
3493
+ /**
3494
+ * A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion.
3495
+ */
3496
+ dropdownPropertiesSuggestionState?: Schema$DropdownPropertiesSuggestionState;
3497
+ }
2949
3498
  /**
2950
3499
  * A suggested change to InlineObjectProperties.
2951
3500
  */
@@ -3050,6 +3599,60 @@ export namespace docs_v1 {
3050
3599
  */
3051
3600
  textStyleSuggestionState?: Schema$TextStyleSuggestionState;
3052
3601
  }
3602
+ /**
3603
+ * The suggestions which were affected by a given update.
3604
+ */
3605
+ export interface Schema$SuggestionResponse {
3606
+ /**
3607
+ * The IDs of suggestions which were accepted during the update.
3608
+ */
3609
+ acceptedSuggestionIds?: string[] | null;
3610
+ /**
3611
+ * The IDs of suggestions which were created during the update.
3612
+ */
3613
+ createdSuggestionIds?: string[] | null;
3614
+ /**
3615
+ * The IDs of suggestions which were deleted during the update.
3616
+ */
3617
+ deletedSuggestionIds?: string[] | null;
3618
+ /**
3619
+ * The IDs of suggestions which were rejected during the update.
3620
+ */
3621
+ rejectedSuggestionIds?: string[] | null;
3622
+ /**
3623
+ * The IDs of suggestions whose summaries were updated during the update.
3624
+ */
3625
+ updatedSummarySuggestionIds?: string[] | null;
3626
+ }
3627
+ /**
3628
+ * Represents a single suggestion thread. Suggestion threads are created as a byproduct of saving changes to the document while in suggestion mode, and cannot be created directly.
3629
+ */
3630
+ export interface Schema$SuggestionThread {
3631
+ /**
3632
+ * The first post in the thread.
3633
+ */
3634
+ headPost?: Schema$Post;
3635
+ /**
3636
+ * Replies to the head post.
3637
+ */
3638
+ replies?: Schema$Post[];
3639
+ /**
3640
+ * Whether the thread is open, accepted, or rejected.
3641
+ */
3642
+ status?: string | null;
3643
+ /**
3644
+ * The unique ID of the suggestion.
3645
+ */
3646
+ suggestionId?: string | null;
3647
+ /**
3648
+ * Summary of the suggested differences in the document, in HTML. May be empty.
3649
+ */
3650
+ summaryHtml?: string | null;
3651
+ /**
3652
+ * Summary of the suggested differences in the document, in plain text. May be empty.
3653
+ */
3654
+ summaryText?: string | null;
3655
+ }
3053
3656
  /**
3054
3657
  * A tab in a document.
3055
3658
  */
@@ -3573,6 +4176,27 @@ export namespace docs_v1 {
3573
4176
  */
3574
4177
  tableRange?: Schema$TableRange;
3575
4178
  }
4179
+ /**
4180
+ * Updates a Post in a CommentThread or SuggestionThread. Returns a 400 bad request error if: - The post is the headPost of a SuggestionThread. - The requesting user is not the author of the post.
4181
+ */
4182
+ export interface Schema$UpdateCommentPostRequest {
4183
+ /**
4184
+ * The ID of the CommentThread which the post belongs to.
4185
+ */
4186
+ commentId?: string | null;
4187
+ /**
4188
+ * 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.
4189
+ */
4190
+ content?: string | null;
4191
+ /**
4192
+ * The ID of the post being updated.
4193
+ */
4194
+ postId?: string | null;
4195
+ /**
4196
+ * The ID of the SuggestionThread which the post belongs to.
4197
+ */
4198
+ suggestionId?: string | null;
4199
+ }
3576
4200
  /**
3577
4201
  * Updates the DocumentStyle.
3578
4202
  */
@@ -3603,6 +4227,52 @@ export namespace docs_v1 {
3603
4227
  */
3604
4228
  tabProperties?: Schema$TabProperties;
3605
4229
  }
4230
+ /**
4231
+ * Updates the properties of a DropdownDefinition.
4232
+ */
4233
+ export interface Schema$UpdateDropdownDefinitionPropertiesRequest {
4234
+ /**
4235
+ * The ID of the DropdownDefinition to update.
4236
+ */
4237
+ dropdownDefinitionId?: string | null;
4238
+ /**
4239
+ * The properties to update.
4240
+ */
4241
+ dropdownDefinitionProperties?: Schema$DropdownDefinitionProperties;
4242
+ /**
4243
+ * The fields that should be updated. At least one field must be specified. The root `dropdown_definition_properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. When `dropdown_definition_properties.options` is included in the field mask, the full, complete list of desired options must be provided in `dropdown_definition_properties.options`.
4244
+ */
4245
+ fields?: string | null;
4246
+ /**
4247
+ * A map of option IDs to their replacements, used to automatically reassign orphaned Dropdown chips when an option is deleted. The keys are the IDs of the options being deleted, and the values are the IDs of their replacement options. If an option being deleted is selected in one or more Dropdown chips in the document, a replacement entry for that option must be provided in this map, and the replacement option ID must exist in the updated DropdownDefinition. If a replacement is required but not provided, a 400 bad request error is returned. Options being deleted that are not selected in any Dropdown chips do not require a replacement. For example, if option A is being replaced by option B, the map should be `{"A": "B"\}`.
4248
+ */
4249
+ selectedOptionIdReplacements?: {[key: string]: string} | null;
4250
+ /**
4251
+ * The ID of the tab that contains the dropdown definition to update. 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.
4252
+ */
4253
+ tabId?: string | null;
4254
+ }
4255
+ /**
4256
+ * Updates the properties of a Dropdown.
4257
+ */
4258
+ export interface Schema$UpdateDropdownPropertiesRequest {
4259
+ /**
4260
+ * Required. The Dropdown ID.
4261
+ */
4262
+ dropdownId?: string | null;
4263
+ /**
4264
+ * The properties to update.
4265
+ */
4266
+ dropdownProperties?: Schema$DropdownProperties;
4267
+ /**
4268
+ * The fields that should be updated. At least one field must be specified. The root `dropdown_properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field.
4269
+ */
4270
+ fields?: string | null;
4271
+ /**
4272
+ * The ID of the tab that contains the dropdown to update. 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.
4273
+ */
4274
+ tabId?: string | null;
4275
+ }
3606
4276
  /**
3607
4277
  * Updates a named style.
3608
4278
  */
@@ -3759,6 +4429,10 @@ export namespace docs_v1 {
3759
4429
  * 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.
3760
4430
  */
3761
4431
  targetRevisionId?: string | null;
4432
+ /**
4433
+ * How the request updates should be applied to the document. If unspecified, the request updates will be applied as normal edits.
4434
+ */
4435
+ writeMode?: string | null;
3762
4436
  }
3763
4437
 
3764
4438
  export class Resource$Documents {
@@ -3818,8 +4492,10 @@ export namespace docs_v1 {
3818
4492
  *
3819
4493
  * // Example response
3820
4494
  * // {
4495
+ * // "commentUpdateState": "my_commentUpdateState",
3821
4496
  * // "documentId": "my_documentId",
3822
4497
  * // "replies": [],
4498
+ * // "suggestionResponses": [],
3823
4499
  * // "writeControl": {}
3824
4500
  * // }
3825
4501
  * }
@@ -3963,6 +4639,8 @@ export namespace docs_v1 {
3963
4639
  * // request body parameters
3964
4640
  * // {
3965
4641
  * // "body": {},
4642
+ * // "comments": [],
4643
+ * // "commentsViewMode": "my_commentsViewMode",
3966
4644
  * // "documentId": "my_documentId",
3967
4645
  * // "documentStyle": {},
3968
4646
  * // "footers": {},
@@ -3976,6 +4654,7 @@ export namespace docs_v1 {
3976
4654
  * // "revisionId": "my_revisionId",
3977
4655
  * // "suggestedDocumentStyleChanges": {},
3978
4656
  * // "suggestedNamedStylesChanges": {},
4657
+ * // "suggestions": [],
3979
4658
  * // "suggestionsViewMode": "my_suggestionsViewMode",
3980
4659
  * // "tabs": [],
3981
4660
  * // "title": "my_title"
@@ -3987,6 +4666,8 @@ export namespace docs_v1 {
3987
4666
  * // Example response
3988
4667
  * // {
3989
4668
  * // "body": {},
4669
+ * // "comments": [],
4670
+ * // "commentsViewMode": "my_commentsViewMode",
3990
4671
  * // "documentId": "my_documentId",
3991
4672
  * // "documentStyle": {},
3992
4673
  * // "footers": {},
@@ -4000,6 +4681,7 @@ export namespace docs_v1 {
4000
4681
  * // "revisionId": "my_revisionId",
4001
4682
  * // "suggestedDocumentStyleChanges": {},
4002
4683
  * // "suggestedNamedStylesChanges": {},
4684
+ * // "suggestions": [],
4003
4685
  * // "suggestionsViewMode": "my_suggestionsViewMode",
4004
4686
  * // "tabs": [],
4005
4687
  * // "title": "my_title"
@@ -4133,6 +4815,8 @@ export namespace docs_v1 {
4133
4815
  *
4134
4816
  * // Do the magic
4135
4817
  * const res = await docs.documents.get({
4818
+ * // 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.
4819
+ * commentsViewMode: 'placeholder-value',
4136
4820
  * // The ID of the document to retrieve.
4137
4821
  * documentId: 'placeholder-value',
4138
4822
  * // 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. If you use a field mask that references the `Document.tabs` field (or any subfield), the API implicitly treats the request as if you set `include_tabs_content` to `true`.
@@ -4145,6 +4829,8 @@ export namespace docs_v1 {
4145
4829
  * // Example response
4146
4830
  * // {
4147
4831
  * // "body": {},
4832
+ * // "comments": [],
4833
+ * // "commentsViewMode": "my_commentsViewMode",
4148
4834
  * // "documentId": "my_documentId",
4149
4835
  * // "documentStyle": {},
4150
4836
  * // "footers": {},
@@ -4158,6 +4844,7 @@ export namespace docs_v1 {
4158
4844
  * // "revisionId": "my_revisionId",
4159
4845
  * // "suggestedDocumentStyleChanges": {},
4160
4846
  * // "suggestedNamedStylesChanges": {},
4847
+ * // "suggestions": [],
4161
4848
  * // "suggestionsViewMode": "my_suggestionsViewMode",
4162
4849
  * // "tabs": [],
4163
4850
  * // "title": "my_title"
@@ -4276,6 +4963,10 @@ export namespace docs_v1 {
4276
4963
  requestBody?: Schema$Document;
4277
4964
  }
4278
4965
  export interface Params$Resource$Documents$Get extends StandardParameters {
4966
+ /**
4967
+ * 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.
4968
+ */
4969
+ commentsViewMode?: string;
4279
4970
  /**
4280
4971
  * The ID of the document to retrieve.
4281
4972
  */