@googleapis/docs 14.0.1 → 14.1.0
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/CHANGELOG.md +7 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +697 -0
- package/build/v1.js.map +1 -1
- package/package.json +1 -1
- package/tsconfig.build.json +10 -0
- package/v1.ts +691 -0
package/build/v1.d.ts
CHANGED
|
@@ -70,6 +70,41 @@ export declare namespace docs_v1 {
|
|
|
70
70
|
documents: Resource$Documents;
|
|
71
71
|
constructor(options: GlobalOptions, google?: GoogleConfigurable);
|
|
72
72
|
}
|
|
73
|
+
/**
|
|
74
|
+
* Accepts a suggestion. Returns a 403 forbidden error if the requesting user does not have edit access to the document. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
75
|
+
*/
|
|
76
|
+
export interface Schema$AcceptSuggestionRequest {
|
|
77
|
+
/**
|
|
78
|
+
* The ID of the suggestion.
|
|
79
|
+
*/
|
|
80
|
+
suggestionId?: string | null;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Inserts a reply Post into a CommentThread or SuggestionThread. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
84
|
+
*/
|
|
85
|
+
export interface Schema$AddCommentReplyRequest {
|
|
86
|
+
/**
|
|
87
|
+
* The ID of the CommentThread to add the reply to.
|
|
88
|
+
*/
|
|
89
|
+
commentId?: string | null;
|
|
90
|
+
/**
|
|
91
|
+
* The Post representing the reply.
|
|
92
|
+
*/
|
|
93
|
+
post?: Schema$Post;
|
|
94
|
+
/**
|
|
95
|
+
* The ID of the SuggestionThread to add the reply to.
|
|
96
|
+
*/
|
|
97
|
+
suggestionId?: string | null;
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Response message for adding a reply. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
101
|
+
*/
|
|
102
|
+
export interface Schema$AddCommentReplyResponse {
|
|
103
|
+
/**
|
|
104
|
+
* The newly-inserted reply Post.
|
|
105
|
+
*/
|
|
106
|
+
post?: Schema$Post;
|
|
107
|
+
}
|
|
73
108
|
/**
|
|
74
109
|
* Adds a document tab. When a tab is added at a given index, all subsequent tabs' indexes are incremented.
|
|
75
110
|
*/
|
|
@@ -150,6 +185,10 @@ export declare namespace docs_v1 {
|
|
|
150
185
|
* Response message from a BatchUpdateDocument request.
|
|
151
186
|
*/
|
|
152
187
|
export interface Schema$BatchUpdateDocumentResponse {
|
|
188
|
+
/**
|
|
189
|
+
* Whether comment updates were applied in the batch request. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
190
|
+
*/
|
|
191
|
+
commentUpdateState?: string | null;
|
|
153
192
|
/**
|
|
154
193
|
* The ID of the document to which the updates were applied to.
|
|
155
194
|
*/
|
|
@@ -158,6 +197,10 @@ export declare namespace docs_v1 {
|
|
|
158
197
|
* The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.
|
|
159
198
|
*/
|
|
160
199
|
replies?: Schema$Response[];
|
|
200
|
+
/**
|
|
201
|
+
* The suggestions which were affected by each update. This maps 1:1 with the updates. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
202
|
+
*/
|
|
203
|
+
suggestionResponses?: Schema$SuggestionResponse[];
|
|
161
204
|
/**
|
|
162
205
|
* The updated write control after applying the request.
|
|
163
206
|
*/
|
|
@@ -251,6 +294,70 @@ export declare namespace docs_v1 {
|
|
|
251
294
|
*/
|
|
252
295
|
textStyle?: Schema$TextStyle;
|
|
253
296
|
}
|
|
297
|
+
/**
|
|
298
|
+
* 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. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
299
|
+
*/
|
|
300
|
+
export interface Schema$CommentAnchor {
|
|
301
|
+
/**
|
|
302
|
+
* The ID of the comment anchor.
|
|
303
|
+
*/
|
|
304
|
+
anchorId?: string | null;
|
|
305
|
+
/**
|
|
306
|
+
* A collection of Ranges in the document which are tied to this anchor.
|
|
307
|
+
*/
|
|
308
|
+
ranges?: Schema$Range[];
|
|
309
|
+
}
|
|
310
|
+
/**
|
|
311
|
+
* Represents a single comment thread. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
312
|
+
*/
|
|
313
|
+
export interface Schema$CommentThread {
|
|
314
|
+
/**
|
|
315
|
+
* The ID of the CommentAnchor in the document that this thread is tied to. Multiple comment threads may be anchored to the same CommentAnchor.
|
|
316
|
+
*/
|
|
317
|
+
anchorId?: string | null;
|
|
318
|
+
/**
|
|
319
|
+
* The unique ID of the comment thread.
|
|
320
|
+
*/
|
|
321
|
+
commentId?: string | null;
|
|
322
|
+
/**
|
|
323
|
+
* The first post in the thread.
|
|
324
|
+
*/
|
|
325
|
+
headPost?: Schema$Post;
|
|
326
|
+
/**
|
|
327
|
+
* The quoted text from the document when the comment was created, formatted as plain-text.
|
|
328
|
+
*/
|
|
329
|
+
plainTextQuote?: string | null;
|
|
330
|
+
/**
|
|
331
|
+
* Replies to the head post.
|
|
332
|
+
*/
|
|
333
|
+
replies?: Schema$Post[];
|
|
334
|
+
/**
|
|
335
|
+
* Whether the thread is open or resolved.
|
|
336
|
+
*/
|
|
337
|
+
status?: string | null;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Creates a new DropdownDefinition in the document.
|
|
341
|
+
*/
|
|
342
|
+
export interface Schema$CreateDropdownDefinitionRequest {
|
|
343
|
+
/**
|
|
344
|
+
* Required. The DropdownDefinition to create.
|
|
345
|
+
*/
|
|
346
|
+
dropdownDefinition?: Schema$DropdownDefinition;
|
|
347
|
+
/**
|
|
348
|
+
* 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.
|
|
349
|
+
*/
|
|
350
|
+
tabId?: string | null;
|
|
351
|
+
}
|
|
352
|
+
/**
|
|
353
|
+
* Response message for creating a dropdown definition.
|
|
354
|
+
*/
|
|
355
|
+
export interface Schema$CreateDropdownDefinitionResponse {
|
|
356
|
+
/**
|
|
357
|
+
* The newly-created DropdownDefinition.
|
|
358
|
+
*/
|
|
359
|
+
dropdownDefinition?: Schema$DropdownDefinition;
|
|
360
|
+
}
|
|
254
361
|
/**
|
|
255
362
|
* 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.
|
|
256
363
|
*/
|
|
@@ -493,6 +600,32 @@ export declare namespace docs_v1 {
|
|
|
493
600
|
*/
|
|
494
601
|
timeZoneIdSuggested?: boolean | null;
|
|
495
602
|
}
|
|
603
|
+
/**
|
|
604
|
+
* 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. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
605
|
+
*/
|
|
606
|
+
export interface Schema$DeleteCommentReplyRequest {
|
|
607
|
+
/**
|
|
608
|
+
* The ID of the CommentThread which the post belongs to.
|
|
609
|
+
*/
|
|
610
|
+
commentId?: string | null;
|
|
611
|
+
/**
|
|
612
|
+
* The ID of the reply Post being deleted.
|
|
613
|
+
*/
|
|
614
|
+
postId?: string | null;
|
|
615
|
+
/**
|
|
616
|
+
* The ID of the SuggestionThread which the post belongs to.
|
|
617
|
+
*/
|
|
618
|
+
suggestionId?: string | null;
|
|
619
|
+
}
|
|
620
|
+
/**
|
|
621
|
+
* Deletes a CommentThread. Returns a 400 bad request error if the requesting user is not the author of the headPost. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
622
|
+
*/
|
|
623
|
+
export interface Schema$DeleteCommentRequest {
|
|
624
|
+
/**
|
|
625
|
+
* The ID of the CommentThread that is being deleted.
|
|
626
|
+
*/
|
|
627
|
+
commentId?: string | null;
|
|
628
|
+
}
|
|
496
629
|
/**
|
|
497
630
|
* Deletes content from the document.
|
|
498
631
|
*/
|
|
@@ -502,6 +635,19 @@ export declare namespace docs_v1 {
|
|
|
502
635
|
*/
|
|
503
636
|
range?: Schema$Range;
|
|
504
637
|
}
|
|
638
|
+
/**
|
|
639
|
+
* Deletes a DropdownDefinition. If the dropdown definition is referenced by any dropdown instances (chips) in the document, a 400 bad request error is returned.
|
|
640
|
+
*/
|
|
641
|
+
export interface Schema$DeleteDropdownDefinitionRequest {
|
|
642
|
+
/**
|
|
643
|
+
* The ID of the DropdownDefinition to delete.
|
|
644
|
+
*/
|
|
645
|
+
dropdownDefinitionId?: string | null;
|
|
646
|
+
/**
|
|
647
|
+
* 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.
|
|
648
|
+
*/
|
|
649
|
+
tabId?: string | null;
|
|
650
|
+
}
|
|
505
651
|
/**
|
|
506
652
|
* Deletes a Footer from the document.
|
|
507
653
|
*/
|
|
@@ -567,6 +713,15 @@ export declare namespace docs_v1 {
|
|
|
567
713
|
*/
|
|
568
714
|
tabId?: string | null;
|
|
569
715
|
}
|
|
716
|
+
/**
|
|
717
|
+
* Deletes a suggestion. Returns a 403 forbidden error if the requesting user is not the author of the suggestion. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
718
|
+
*/
|
|
719
|
+
export interface Schema$DeleteSuggestionRequest {
|
|
720
|
+
/**
|
|
721
|
+
* The ID of the suggestion.
|
|
722
|
+
*/
|
|
723
|
+
suggestionId?: string | null;
|
|
724
|
+
}
|
|
570
725
|
/**
|
|
571
726
|
* Deletes a column from a table.
|
|
572
727
|
*/
|
|
@@ -615,6 +770,14 @@ export declare namespace docs_v1 {
|
|
|
615
770
|
* 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.
|
|
616
771
|
*/
|
|
617
772
|
body?: Schema$Body;
|
|
773
|
+
/**
|
|
774
|
+
* 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).
|
|
775
|
+
*/
|
|
776
|
+
comments?: Schema$CommentThread[];
|
|
777
|
+
/**
|
|
778
|
+
* Output only. The comments view mode applied to the document. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
779
|
+
*/
|
|
780
|
+
commentsViewMode?: string | null;
|
|
618
781
|
/**
|
|
619
782
|
* Output only. The ID of the document.
|
|
620
783
|
*/
|
|
@@ -685,6 +848,10 @@ export declare namespace docs_v1 {
|
|
|
685
848
|
suggestedNamedStylesChanges?: {
|
|
686
849
|
[key: string]: Schema$SuggestedNamedStyles;
|
|
687
850
|
} | null;
|
|
851
|
+
/**
|
|
852
|
+
* 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).
|
|
853
|
+
*/
|
|
854
|
+
suggestions?: Schema$SuggestionThread[];
|
|
688
855
|
/**
|
|
689
856
|
* 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.
|
|
690
857
|
*/
|
|
@@ -881,10 +1048,22 @@ export declare namespace docs_v1 {
|
|
|
881
1048
|
* The main body of the document tab.
|
|
882
1049
|
*/
|
|
883
1050
|
body?: Schema$Body;
|
|
1051
|
+
/**
|
|
1052
|
+
* 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).
|
|
1053
|
+
*/
|
|
1054
|
+
commentAnchors?: {
|
|
1055
|
+
[key: string]: Schema$CommentAnchor;
|
|
1056
|
+
} | null;
|
|
884
1057
|
/**
|
|
885
1058
|
* The style of the document tab.
|
|
886
1059
|
*/
|
|
887
1060
|
documentStyle?: Schema$DocumentStyle;
|
|
1061
|
+
/**
|
|
1062
|
+
* The dropdown definitions in a document tab, keyed by dropdown definition ID.
|
|
1063
|
+
*/
|
|
1064
|
+
dropdownDefinitions?: {
|
|
1065
|
+
[key: string]: Schema$DropdownDefinition;
|
|
1066
|
+
} | null;
|
|
888
1067
|
/**
|
|
889
1068
|
* The footers in the document tab, keyed by footer ID.
|
|
890
1069
|
*/
|
|
@@ -944,6 +1123,139 @@ export declare namespace docs_v1 {
|
|
|
944
1123
|
[key: string]: Schema$SuggestedNamedStyles;
|
|
945
1124
|
} | null;
|
|
946
1125
|
}
|
|
1126
|
+
/**
|
|
1127
|
+
* 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.
|
|
1128
|
+
*/
|
|
1129
|
+
export interface Schema$Dropdown {
|
|
1130
|
+
/**
|
|
1131
|
+
* The ID of this dropdown.
|
|
1132
|
+
*/
|
|
1133
|
+
dropdownId?: string | null;
|
|
1134
|
+
/**
|
|
1135
|
+
* The properties of this dropdown.
|
|
1136
|
+
*/
|
|
1137
|
+
dropdownProperties?: Schema$DropdownProperties;
|
|
1138
|
+
/**
|
|
1139
|
+
* IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion.
|
|
1140
|
+
*/
|
|
1141
|
+
suggestedDeletionIds?: string[] | null;
|
|
1142
|
+
/**
|
|
1143
|
+
* The suggested properties changes to this dropdown, keyed by suggestion ID.
|
|
1144
|
+
*/
|
|
1145
|
+
suggestedDropdownPropertiesChanges?: {
|
|
1146
|
+
[key: string]: Schema$SuggestedDropdownProperties;
|
|
1147
|
+
} | null;
|
|
1148
|
+
/**
|
|
1149
|
+
* IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion.
|
|
1150
|
+
*/
|
|
1151
|
+
suggestedInsertionIds?: string[] | null;
|
|
1152
|
+
/**
|
|
1153
|
+
* The suggested text style changes to this dropdown, keyed by suggestion ID.
|
|
1154
|
+
*/
|
|
1155
|
+
suggestedTextStyleChanges?: {
|
|
1156
|
+
[key: string]: Schema$SuggestedTextStyle;
|
|
1157
|
+
} | null;
|
|
1158
|
+
/**
|
|
1159
|
+
* The text style of this dropdown.
|
|
1160
|
+
*/
|
|
1161
|
+
textStyle?: Schema$TextStyle;
|
|
1162
|
+
}
|
|
1163
|
+
/**
|
|
1164
|
+
* A dropdown definition in the document.
|
|
1165
|
+
*/
|
|
1166
|
+
export interface Schema$DropdownDefinition {
|
|
1167
|
+
/**
|
|
1168
|
+
* 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.
|
|
1169
|
+
*/
|
|
1170
|
+
dropdownDefinitionId?: string | null;
|
|
1171
|
+
/**
|
|
1172
|
+
* The properties of this dropdown definition.
|
|
1173
|
+
*/
|
|
1174
|
+
dropdownDefinitionProperties?: Schema$DropdownDefinitionProperties;
|
|
1175
|
+
/**
|
|
1176
|
+
* ID for suggestion that deletes this dropdown definition.
|
|
1177
|
+
*/
|
|
1178
|
+
suggestedDeletionId?: string | null;
|
|
1179
|
+
/**
|
|
1180
|
+
* Suggested property changes to this definition, keyed by suggestion ID.
|
|
1181
|
+
*/
|
|
1182
|
+
suggestedDropdownDefinitionPropertiesChanges?: {
|
|
1183
|
+
[key: string]: Schema$SuggestedDropdownDefinitionProperties;
|
|
1184
|
+
} | null;
|
|
1185
|
+
/**
|
|
1186
|
+
* ID for suggestion that inserts this dropdown definition.
|
|
1187
|
+
*/
|
|
1188
|
+
suggestedInsertionId?: string | null;
|
|
1189
|
+
}
|
|
1190
|
+
/**
|
|
1191
|
+
* Properties of a dropdown definition.
|
|
1192
|
+
*/
|
|
1193
|
+
export interface Schema$DropdownDefinitionProperties {
|
|
1194
|
+
/**
|
|
1195
|
+
* The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options.
|
|
1196
|
+
*/
|
|
1197
|
+
options?: Schema$DropdownOption[];
|
|
1198
|
+
/**
|
|
1199
|
+
* The title of the dropdown definition.
|
|
1200
|
+
*/
|
|
1201
|
+
title?: string | null;
|
|
1202
|
+
}
|
|
1203
|
+
/**
|
|
1204
|
+
* 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.
|
|
1205
|
+
*/
|
|
1206
|
+
export interface Schema$DropdownDefinitionPropertiesSuggestionState {
|
|
1207
|
+
/**
|
|
1208
|
+
* Indicates if there was a suggested change to options.
|
|
1209
|
+
*/
|
|
1210
|
+
optionsSuggested?: boolean | null;
|
|
1211
|
+
/**
|
|
1212
|
+
* Indicates if there was a suggested change to title.
|
|
1213
|
+
*/
|
|
1214
|
+
titleSuggested?: boolean | null;
|
|
1215
|
+
}
|
|
1216
|
+
/**
|
|
1217
|
+
* An option in a Dropdown.
|
|
1218
|
+
*/
|
|
1219
|
+
export interface Schema$DropdownOption {
|
|
1220
|
+
/**
|
|
1221
|
+
* The display value of this dropdown option.
|
|
1222
|
+
*/
|
|
1223
|
+
displayValue?: string | null;
|
|
1224
|
+
/**
|
|
1225
|
+
* 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.
|
|
1226
|
+
*/
|
|
1227
|
+
optionId?: string | null;
|
|
1228
|
+
/**
|
|
1229
|
+
* 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.
|
|
1230
|
+
*/
|
|
1231
|
+
textStyle?: Schema$TextStyle;
|
|
1232
|
+
}
|
|
1233
|
+
/**
|
|
1234
|
+
* Properties specific to a dropdown.
|
|
1235
|
+
*/
|
|
1236
|
+
export interface Schema$DropdownProperties {
|
|
1237
|
+
/**
|
|
1238
|
+
* 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.
|
|
1239
|
+
*/
|
|
1240
|
+
displayValue?: string | null;
|
|
1241
|
+
/**
|
|
1242
|
+
* The ID of the DropdownDefinition that defines the options for this dropdown.
|
|
1243
|
+
*/
|
|
1244
|
+
dropdownDefinitionId?: string | null;
|
|
1245
|
+
/**
|
|
1246
|
+
* The ID of the selected option in this dropdown.
|
|
1247
|
+
*/
|
|
1248
|
+
selectedOptionId?: string | null;
|
|
1249
|
+
}
|
|
1250
|
+
/**
|
|
1251
|
+
* 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.
|
|
1252
|
+
*/
|
|
1253
|
+
export interface Schema$DropdownPropertiesSuggestionState {
|
|
1254
|
+
/**
|
|
1255
|
+
* Indicates if there was a suggested change to selected_option_id.
|
|
1256
|
+
*/
|
|
1257
|
+
selectedOptionIdSuggested?: boolean | null;
|
|
1258
|
+
}
|
|
947
1259
|
/**
|
|
948
1260
|
* 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.
|
|
949
1261
|
*/
|
|
@@ -1364,6 +1676,32 @@ export declare namespace docs_v1 {
|
|
|
1364
1676
|
*/
|
|
1365
1677
|
embeddedObjectSuggestionState?: Schema$EmbeddedObjectSuggestionState;
|
|
1366
1678
|
}
|
|
1679
|
+
/**
|
|
1680
|
+
* Inserts a CommentThread into the document. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
1681
|
+
*/
|
|
1682
|
+
export interface Schema$InsertCommentRequest {
|
|
1683
|
+
/**
|
|
1684
|
+
* 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.
|
|
1685
|
+
*/
|
|
1686
|
+
assigneeEmailAddress?: string | null;
|
|
1687
|
+
/**
|
|
1688
|
+
* 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.
|
|
1689
|
+
*/
|
|
1690
|
+
content?: string | null;
|
|
1691
|
+
/**
|
|
1692
|
+
* The Range in the document that is tied to this comment.
|
|
1693
|
+
*/
|
|
1694
|
+
range?: Schema$Range;
|
|
1695
|
+
}
|
|
1696
|
+
/**
|
|
1697
|
+
* Response message for inserting a comment. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
1698
|
+
*/
|
|
1699
|
+
export interface Schema$InsertCommentResponse {
|
|
1700
|
+
/**
|
|
1701
|
+
* The newly-inserted comment thread.
|
|
1702
|
+
*/
|
|
1703
|
+
commentThread?: Schema$CommentThread;
|
|
1704
|
+
}
|
|
1367
1705
|
/**
|
|
1368
1706
|
* Inserts a date at the specified location.
|
|
1369
1707
|
*/
|
|
@@ -1381,6 +1719,36 @@ export declare namespace docs_v1 {
|
|
|
1381
1719
|
*/
|
|
1382
1720
|
location?: Schema$Location;
|
|
1383
1721
|
}
|
|
1722
|
+
/**
|
|
1723
|
+
* Inserts a Dropdown at the specified location.
|
|
1724
|
+
*/
|
|
1725
|
+
export interface Schema$InsertDropdownRequest {
|
|
1726
|
+
/**
|
|
1727
|
+
* Required. The DropdownDefinition ID.
|
|
1728
|
+
*/
|
|
1729
|
+
dropdownDefinitionId?: string | null;
|
|
1730
|
+
/**
|
|
1731
|
+
* The EndOfSegmentLocation in the document to insert the dropdown at.
|
|
1732
|
+
*/
|
|
1733
|
+
endOfSegmentLocation?: Schema$EndOfSegmentLocation;
|
|
1734
|
+
/**
|
|
1735
|
+
* The Location in the document to insert the dropdown at.
|
|
1736
|
+
*/
|
|
1737
|
+
location?: Schema$Location;
|
|
1738
|
+
/**
|
|
1739
|
+
* 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.
|
|
1740
|
+
*/
|
|
1741
|
+
selectedOptionId?: string | null;
|
|
1742
|
+
}
|
|
1743
|
+
/**
|
|
1744
|
+
* The result of inserting a Dropdown.
|
|
1745
|
+
*/
|
|
1746
|
+
export interface Schema$InsertDropdownResponse {
|
|
1747
|
+
/**
|
|
1748
|
+
* The newly-inserted Dropdown.
|
|
1749
|
+
*/
|
|
1750
|
+
dropdown?: Schema$Dropdown;
|
|
1751
|
+
}
|
|
1384
1752
|
/**
|
|
1385
1753
|
* Inserts an InlineObject containing an image at the given location.
|
|
1386
1754
|
*/
|
|
@@ -1935,6 +2303,10 @@ export declare namespace docs_v1 {
|
|
|
1935
2303
|
* A paragraph element that represents a date.
|
|
1936
2304
|
*/
|
|
1937
2305
|
dateElement?: Schema$DateElement;
|
|
2306
|
+
/**
|
|
2307
|
+
* A paragraph element that represents a dropdown menu.
|
|
2308
|
+
*/
|
|
2309
|
+
dropdown?: Schema$Dropdown;
|
|
1938
2310
|
/**
|
|
1939
2311
|
* The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
|
|
1940
2312
|
*/
|
|
@@ -2302,6 +2674,84 @@ export declare namespace docs_v1 {
|
|
|
2302
2674
|
*/
|
|
2303
2675
|
positioningSuggestionState?: Schema$PositionedObjectPositioningSuggestionState;
|
|
2304
2676
|
}
|
|
2677
|
+
/**
|
|
2678
|
+
* Represents a single post in a comment or suggestion thread. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
2679
|
+
*/
|
|
2680
|
+
export interface Schema$Post {
|
|
2681
|
+
/**
|
|
2682
|
+
* 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.
|
|
2683
|
+
*/
|
|
2684
|
+
assigneeEmail?: string | null;
|
|
2685
|
+
/**
|
|
2686
|
+
* Output only. The user who created the post.
|
|
2687
|
+
*/
|
|
2688
|
+
author?: Schema$PostAuthor;
|
|
2689
|
+
/**
|
|
2690
|
+
* Optional. The action type for comment posts.
|
|
2691
|
+
*/
|
|
2692
|
+
commentAction?: string | null;
|
|
2693
|
+
/**
|
|
2694
|
+
* 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.
|
|
2695
|
+
*/
|
|
2696
|
+
content?: string | null;
|
|
2697
|
+
/**
|
|
2698
|
+
* Output only. The content of the post as HTML.
|
|
2699
|
+
*/
|
|
2700
|
+
contentHtml?: string | null;
|
|
2701
|
+
/**
|
|
2702
|
+
* Output only. The time the post was created.
|
|
2703
|
+
*/
|
|
2704
|
+
createTime?: string | null;
|
|
2705
|
+
/**
|
|
2706
|
+
* Output only. Whether the post is deleted. If `true`, content and author fields will be empty.
|
|
2707
|
+
*/
|
|
2708
|
+
deleted?: boolean | null;
|
|
2709
|
+
/**
|
|
2710
|
+
* Output only. Whether the post is from a copied document. This field cannot be set directly by callers.
|
|
2711
|
+
*/
|
|
2712
|
+
fromCopiedDocument?: boolean | null;
|
|
2713
|
+
/**
|
|
2714
|
+
* Output only. Whether the post is from a document comparison. This field cannot be set directly by callers.
|
|
2715
|
+
*/
|
|
2716
|
+
fromDocumentComparison?: boolean | null;
|
|
2717
|
+
/**
|
|
2718
|
+
* Output only. Whether the post is from an imported document. This field cannot be set directly by callers.
|
|
2719
|
+
*/
|
|
2720
|
+
fromImportedDocument?: boolean | null;
|
|
2721
|
+
/**
|
|
2722
|
+
* Output only. The unique ID of the post.
|
|
2723
|
+
*/
|
|
2724
|
+
postId?: string | null;
|
|
2725
|
+
/**
|
|
2726
|
+
* Output only. The action type for suggestion posts.
|
|
2727
|
+
*/
|
|
2728
|
+
suggestionAction?: string | null;
|
|
2729
|
+
/**
|
|
2730
|
+
* Output only. The time the post was last updated.
|
|
2731
|
+
*/
|
|
2732
|
+
updateTime?: string | null;
|
|
2733
|
+
}
|
|
2734
|
+
/**
|
|
2735
|
+
* Represents a user who authored a comment or suggestion post. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
2736
|
+
*/
|
|
2737
|
+
export interface Schema$PostAuthor {
|
|
2738
|
+
/**
|
|
2739
|
+
* Whether the user is anonymous.
|
|
2740
|
+
*/
|
|
2741
|
+
anonymous?: boolean | null;
|
|
2742
|
+
/**
|
|
2743
|
+
* The display name of the user. May be absent if the author is anonymous.
|
|
2744
|
+
*/
|
|
2745
|
+
displayName?: string | null;
|
|
2746
|
+
/**
|
|
2747
|
+
* Whether the user is the authenticated user making the request.
|
|
2748
|
+
*/
|
|
2749
|
+
me?: boolean | null;
|
|
2750
|
+
/**
|
|
2751
|
+
* 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.
|
|
2752
|
+
*/
|
|
2753
|
+
user?: string | null;
|
|
2754
|
+
}
|
|
2305
2755
|
/**
|
|
2306
2756
|
* Specifies a contiguous range of text.
|
|
2307
2757
|
*/
|
|
@@ -2323,6 +2773,15 @@ export declare namespace docs_v1 {
|
|
|
2323
2773
|
*/
|
|
2324
2774
|
tabId?: string | null;
|
|
2325
2775
|
}
|
|
2776
|
+
/**
|
|
2777
|
+
* 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. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
2778
|
+
*/
|
|
2779
|
+
export interface Schema$RejectSuggestionRequest {
|
|
2780
|
+
/**
|
|
2781
|
+
* The ID of the suggestion.
|
|
2782
|
+
*/
|
|
2783
|
+
suggestionId?: string | null;
|
|
2784
|
+
}
|
|
2326
2785
|
/**
|
|
2327
2786
|
* Replaces all instances of text matching a criteria with replace text.
|
|
2328
2787
|
*/
|
|
@@ -2395,10 +2854,22 @@ export declare namespace docs_v1 {
|
|
|
2395
2854
|
* A single update to apply to a document.
|
|
2396
2855
|
*/
|
|
2397
2856
|
export interface Schema$Request {
|
|
2857
|
+
/**
|
|
2858
|
+
* Accepts a suggestion. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
2859
|
+
*/
|
|
2860
|
+
acceptSuggestion?: Schema$AcceptSuggestionRequest;
|
|
2861
|
+
/**
|
|
2862
|
+
* Adds a reply to a CommentThread or SuggestionThread. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
2863
|
+
*/
|
|
2864
|
+
addCommentReply?: Schema$AddCommentReplyRequest;
|
|
2398
2865
|
/**
|
|
2399
2866
|
* Adds a document tab.
|
|
2400
2867
|
*/
|
|
2401
2868
|
addDocumentTab?: Schema$AddDocumentTabRequest;
|
|
2869
|
+
/**
|
|
2870
|
+
* Creates a DropdownDefinition.
|
|
2871
|
+
*/
|
|
2872
|
+
createDropdownDefinition?: Schema$CreateDropdownDefinitionRequest;
|
|
2402
2873
|
/**
|
|
2403
2874
|
* Creates a footer.
|
|
2404
2875
|
*/
|
|
@@ -2419,10 +2890,22 @@ export declare namespace docs_v1 {
|
|
|
2419
2890
|
* Creates bullets for paragraphs.
|
|
2420
2891
|
*/
|
|
2421
2892
|
createParagraphBullets?: Schema$CreateParagraphBulletsRequest;
|
|
2893
|
+
/**
|
|
2894
|
+
* Deletes a CommentThread. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
2895
|
+
*/
|
|
2896
|
+
deleteComment?: Schema$DeleteCommentRequest;
|
|
2897
|
+
/**
|
|
2898
|
+
* Deletes a reply Post from a CommentThread or SuggestionThread. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
2899
|
+
*/
|
|
2900
|
+
deleteCommentReply?: Schema$DeleteCommentReplyRequest;
|
|
2422
2901
|
/**
|
|
2423
2902
|
* Deletes content from the document.
|
|
2424
2903
|
*/
|
|
2425
2904
|
deleteContentRange?: Schema$DeleteContentRangeRequest;
|
|
2905
|
+
/**
|
|
2906
|
+
* Deletes a DropdownDefinition.
|
|
2907
|
+
*/
|
|
2908
|
+
deleteDropdownDefinition?: Schema$DeleteDropdownDefinitionRequest;
|
|
2426
2909
|
/**
|
|
2427
2910
|
* Deletes a footer from the document.
|
|
2428
2911
|
*/
|
|
@@ -2443,6 +2926,10 @@ export declare namespace docs_v1 {
|
|
|
2443
2926
|
* Deletes a positioned object from the document.
|
|
2444
2927
|
*/
|
|
2445
2928
|
deletePositionedObject?: Schema$DeletePositionedObjectRequest;
|
|
2929
|
+
/**
|
|
2930
|
+
* Deletes a suggestion. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
2931
|
+
*/
|
|
2932
|
+
deleteSuggestion?: Schema$DeleteSuggestionRequest;
|
|
2446
2933
|
/**
|
|
2447
2934
|
* Deletes a document tab.
|
|
2448
2935
|
*/
|
|
@@ -2455,10 +2942,18 @@ export declare namespace docs_v1 {
|
|
|
2455
2942
|
* Deletes a row from a table.
|
|
2456
2943
|
*/
|
|
2457
2944
|
deleteTableRow?: Schema$DeleteTableRowRequest;
|
|
2945
|
+
/**
|
|
2946
|
+
* Inserts a CommentThread into the document. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
2947
|
+
*/
|
|
2948
|
+
insertComment?: Schema$InsertCommentRequest;
|
|
2458
2949
|
/**
|
|
2459
2950
|
* Inserts a date.
|
|
2460
2951
|
*/
|
|
2461
2952
|
insertDate?: Schema$InsertDateRequest;
|
|
2953
|
+
/**
|
|
2954
|
+
* Inserts a Dropdown at the specified location.
|
|
2955
|
+
*/
|
|
2956
|
+
insertDropdown?: Schema$InsertDropdownRequest;
|
|
2462
2957
|
/**
|
|
2463
2958
|
* Inserts an inline image at the specified location.
|
|
2464
2959
|
*/
|
|
@@ -2503,6 +2998,10 @@ export declare namespace docs_v1 {
|
|
|
2503
2998
|
* Updates the number of pinned header rows in a table.
|
|
2504
2999
|
*/
|
|
2505
3000
|
pinTableHeaderRows?: Schema$PinTableHeaderRowsRequest;
|
|
3001
|
+
/**
|
|
3002
|
+
* Rejects a suggestion. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
3003
|
+
*/
|
|
3004
|
+
rejectSuggestion?: Schema$RejectSuggestionRequest;
|
|
2506
3005
|
/**
|
|
2507
3006
|
* Replaces all instances of the specified text.
|
|
2508
3007
|
*/
|
|
@@ -2519,6 +3018,10 @@ export declare namespace docs_v1 {
|
|
|
2519
3018
|
* Unmerges cells in a table.
|
|
2520
3019
|
*/
|
|
2521
3020
|
unmergeTableCells?: Schema$UnmergeTableCellsRequest;
|
|
3021
|
+
/**
|
|
3022
|
+
* Updates an existing post (head post or reply) of a CommentThread or SuggestionThread. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
3023
|
+
*/
|
|
3024
|
+
updateCommentPost?: Schema$UpdateCommentPostRequest;
|
|
2522
3025
|
/**
|
|
2523
3026
|
* Updates the style of the document.
|
|
2524
3027
|
*/
|
|
@@ -2527,6 +3030,14 @@ export declare namespace docs_v1 {
|
|
|
2527
3030
|
* Updates the properties of a document tab.
|
|
2528
3031
|
*/
|
|
2529
3032
|
updateDocumentTabProperties?: Schema$UpdateDocumentTabPropertiesRequest;
|
|
3033
|
+
/**
|
|
3034
|
+
* Updates the properties of a DropdownDefinition.
|
|
3035
|
+
*/
|
|
3036
|
+
updateDropdownDefinitionProperties?: Schema$UpdateDropdownDefinitionPropertiesRequest;
|
|
3037
|
+
/**
|
|
3038
|
+
* Updates the properties of a Dropdown.
|
|
3039
|
+
*/
|
|
3040
|
+
updateDropdownProperties?: Schema$UpdateDropdownPropertiesRequest;
|
|
2530
3041
|
/**
|
|
2531
3042
|
* Updates a named style.
|
|
2532
3043
|
*/
|
|
@@ -2560,10 +3071,18 @@ export declare namespace docs_v1 {
|
|
|
2560
3071
|
* A single response from an update.
|
|
2561
3072
|
*/
|
|
2562
3073
|
export interface Schema$Response {
|
|
3074
|
+
/**
|
|
3075
|
+
* The result of adding a reply to a comment or suggestion. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
3076
|
+
*/
|
|
3077
|
+
addCommentReply?: Schema$AddCommentReplyResponse;
|
|
2563
3078
|
/**
|
|
2564
3079
|
* The result of adding a document tab.
|
|
2565
3080
|
*/
|
|
2566
3081
|
addDocumentTab?: Schema$AddDocumentTabResponse;
|
|
3082
|
+
/**
|
|
3083
|
+
* The result of creating a dropdown definition.
|
|
3084
|
+
*/
|
|
3085
|
+
createDropdownDefinition?: Schema$CreateDropdownDefinitionResponse;
|
|
2567
3086
|
/**
|
|
2568
3087
|
* The result of creating a footer.
|
|
2569
3088
|
*/
|
|
@@ -2580,6 +3099,14 @@ export declare namespace docs_v1 {
|
|
|
2580
3099
|
* The result of creating a named range.
|
|
2581
3100
|
*/
|
|
2582
3101
|
createNamedRange?: Schema$CreateNamedRangeResponse;
|
|
3102
|
+
/**
|
|
3103
|
+
* The result of inserting a comment. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
3104
|
+
*/
|
|
3105
|
+
insertComment?: Schema$InsertCommentResponse;
|
|
3106
|
+
/**
|
|
3107
|
+
* The result of inserting a dropdown.
|
|
3108
|
+
*/
|
|
3109
|
+
insertDropdown?: Schema$InsertDropdownResponse;
|
|
2583
3110
|
/**
|
|
2584
3111
|
* The result of inserting an inline image.
|
|
2585
3112
|
*/
|
|
@@ -2924,6 +3451,32 @@ export declare namespace docs_v1 {
|
|
|
2924
3451
|
*/
|
|
2925
3452
|
documentStyleSuggestionState?: Schema$DocumentStyleSuggestionState;
|
|
2926
3453
|
}
|
|
3454
|
+
/**
|
|
3455
|
+
* A suggested change to dropdown definition properties.
|
|
3456
|
+
*/
|
|
3457
|
+
export interface Schema$SuggestedDropdownDefinitionProperties {
|
|
3458
|
+
/**
|
|
3459
|
+
* 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.
|
|
3460
|
+
*/
|
|
3461
|
+
dropdownDefinitionProperties?: Schema$DropdownDefinitionProperties;
|
|
3462
|
+
/**
|
|
3463
|
+
* A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion.
|
|
3464
|
+
*/
|
|
3465
|
+
dropdownDefinitionPropertiesSuggestionState?: Schema$DropdownDefinitionPropertiesSuggestionState;
|
|
3466
|
+
}
|
|
3467
|
+
/**
|
|
3468
|
+
* A suggested change to dropdown properties.
|
|
3469
|
+
*/
|
|
3470
|
+
export interface Schema$SuggestedDropdownProperties {
|
|
3471
|
+
/**
|
|
3472
|
+
* 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.
|
|
3473
|
+
*/
|
|
3474
|
+
dropdownProperties?: Schema$DropdownProperties;
|
|
3475
|
+
/**
|
|
3476
|
+
* A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion.
|
|
3477
|
+
*/
|
|
3478
|
+
dropdownPropertiesSuggestionState?: Schema$DropdownPropertiesSuggestionState;
|
|
3479
|
+
}
|
|
2927
3480
|
/**
|
|
2928
3481
|
* A suggested change to InlineObjectProperties.
|
|
2929
3482
|
*/
|
|
@@ -3028,6 +3581,60 @@ export declare namespace docs_v1 {
|
|
|
3028
3581
|
*/
|
|
3029
3582
|
textStyleSuggestionState?: Schema$TextStyleSuggestionState;
|
|
3030
3583
|
}
|
|
3584
|
+
/**
|
|
3585
|
+
* The suggestions which were affected by a given update. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
3586
|
+
*/
|
|
3587
|
+
export interface Schema$SuggestionResponse {
|
|
3588
|
+
/**
|
|
3589
|
+
* The IDs of suggestions which were accepted during the update.
|
|
3590
|
+
*/
|
|
3591
|
+
acceptedSuggestionIds?: string[] | null;
|
|
3592
|
+
/**
|
|
3593
|
+
* The IDs of suggestions which were created during the update.
|
|
3594
|
+
*/
|
|
3595
|
+
createdSuggestionIds?: string[] | null;
|
|
3596
|
+
/**
|
|
3597
|
+
* The IDs of suggestions which were deleted during the update.
|
|
3598
|
+
*/
|
|
3599
|
+
deletedSuggestionIds?: string[] | null;
|
|
3600
|
+
/**
|
|
3601
|
+
* The IDs of suggestions which were rejected during the update.
|
|
3602
|
+
*/
|
|
3603
|
+
rejectedSuggestionIds?: string[] | null;
|
|
3604
|
+
/**
|
|
3605
|
+
* The IDs of suggestions whose summaries were updated during the update.
|
|
3606
|
+
*/
|
|
3607
|
+
updatedSummarySuggestionIds?: string[] | null;
|
|
3608
|
+
}
|
|
3609
|
+
/**
|
|
3610
|
+
* 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. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
3611
|
+
*/
|
|
3612
|
+
export interface Schema$SuggestionThread {
|
|
3613
|
+
/**
|
|
3614
|
+
* The first post in the thread.
|
|
3615
|
+
*/
|
|
3616
|
+
headPost?: Schema$Post;
|
|
3617
|
+
/**
|
|
3618
|
+
* Replies to the head post.
|
|
3619
|
+
*/
|
|
3620
|
+
replies?: Schema$Post[];
|
|
3621
|
+
/**
|
|
3622
|
+
* Whether the thread is open, accepted, or rejected.
|
|
3623
|
+
*/
|
|
3624
|
+
status?: string | null;
|
|
3625
|
+
/**
|
|
3626
|
+
* The unique ID of the suggestion.
|
|
3627
|
+
*/
|
|
3628
|
+
suggestionId?: string | null;
|
|
3629
|
+
/**
|
|
3630
|
+
* Summary of the suggested differences in the document, in HTML. May be empty.
|
|
3631
|
+
*/
|
|
3632
|
+
summaryHtml?: string | null;
|
|
3633
|
+
/**
|
|
3634
|
+
* Summary of the suggested differences in the document, in plain text. May be empty.
|
|
3635
|
+
*/
|
|
3636
|
+
summaryText?: string | null;
|
|
3637
|
+
}
|
|
3031
3638
|
/**
|
|
3032
3639
|
* A tab in a document.
|
|
3033
3640
|
*/
|
|
@@ -3551,6 +4158,27 @@ export declare namespace docs_v1 {
|
|
|
3551
4158
|
*/
|
|
3552
4159
|
tableRange?: Schema$TableRange;
|
|
3553
4160
|
}
|
|
4161
|
+
/**
|
|
4162
|
+
* 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. [Developer Preview](https://developers.google.com/workspace/preview).
|
|
4163
|
+
*/
|
|
4164
|
+
export interface Schema$UpdateCommentPostRequest {
|
|
4165
|
+
/**
|
|
4166
|
+
* The ID of the CommentThread which the post belongs to.
|
|
4167
|
+
*/
|
|
4168
|
+
commentId?: string | null;
|
|
4169
|
+
/**
|
|
4170
|
+
* 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.
|
|
4171
|
+
*/
|
|
4172
|
+
content?: string | null;
|
|
4173
|
+
/**
|
|
4174
|
+
* The ID of the post being updated.
|
|
4175
|
+
*/
|
|
4176
|
+
postId?: string | null;
|
|
4177
|
+
/**
|
|
4178
|
+
* The ID of the SuggestionThread which the post belongs to.
|
|
4179
|
+
*/
|
|
4180
|
+
suggestionId?: string | null;
|
|
4181
|
+
}
|
|
3554
4182
|
/**
|
|
3555
4183
|
* Updates the DocumentStyle.
|
|
3556
4184
|
*/
|
|
@@ -3581,6 +4209,54 @@ export declare namespace docs_v1 {
|
|
|
3581
4209
|
*/
|
|
3582
4210
|
tabProperties?: Schema$TabProperties;
|
|
3583
4211
|
}
|
|
4212
|
+
/**
|
|
4213
|
+
* Updates the properties of a DropdownDefinition.
|
|
4214
|
+
*/
|
|
4215
|
+
export interface Schema$UpdateDropdownDefinitionPropertiesRequest {
|
|
4216
|
+
/**
|
|
4217
|
+
* The ID of the DropdownDefinition to update.
|
|
4218
|
+
*/
|
|
4219
|
+
dropdownDefinitionId?: string | null;
|
|
4220
|
+
/**
|
|
4221
|
+
* The properties to update.
|
|
4222
|
+
*/
|
|
4223
|
+
dropdownDefinitionProperties?: Schema$DropdownDefinitionProperties;
|
|
4224
|
+
/**
|
|
4225
|
+
* 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`.
|
|
4226
|
+
*/
|
|
4227
|
+
fields?: string | null;
|
|
4228
|
+
/**
|
|
4229
|
+
* 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"\}`.
|
|
4230
|
+
*/
|
|
4231
|
+
selectedOptionIdReplacements?: {
|
|
4232
|
+
[key: string]: string;
|
|
4233
|
+
} | null;
|
|
4234
|
+
/**
|
|
4235
|
+
* 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.
|
|
4236
|
+
*/
|
|
4237
|
+
tabId?: string | null;
|
|
4238
|
+
}
|
|
4239
|
+
/**
|
|
4240
|
+
* Updates the properties of a Dropdown.
|
|
4241
|
+
*/
|
|
4242
|
+
export interface Schema$UpdateDropdownPropertiesRequest {
|
|
4243
|
+
/**
|
|
4244
|
+
* Required. The Dropdown ID.
|
|
4245
|
+
*/
|
|
4246
|
+
dropdownId?: string | null;
|
|
4247
|
+
/**
|
|
4248
|
+
* The properties to update.
|
|
4249
|
+
*/
|
|
4250
|
+
dropdownProperties?: Schema$DropdownProperties;
|
|
4251
|
+
/**
|
|
4252
|
+
* 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.
|
|
4253
|
+
*/
|
|
4254
|
+
fields?: string | null;
|
|
4255
|
+
/**
|
|
4256
|
+
* 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.
|
|
4257
|
+
*/
|
|
4258
|
+
tabId?: string | null;
|
|
4259
|
+
}
|
|
3584
4260
|
/**
|
|
3585
4261
|
* Updates a named style.
|
|
3586
4262
|
*/
|
|
@@ -3737,6 +4413,10 @@ export declare namespace docs_v1 {
|
|
|
3737
4413
|
* 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.
|
|
3738
4414
|
*/
|
|
3739
4415
|
targetRevisionId?: string | null;
|
|
4416
|
+
/**
|
|
4417
|
+
* 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).
|
|
4418
|
+
*/
|
|
4419
|
+
writeMode?: string | null;
|
|
3740
4420
|
}
|
|
3741
4421
|
export class Resource$Documents {
|
|
3742
4422
|
context: APIRequestContext;
|
|
@@ -3792,8 +4472,10 @@ export declare namespace docs_v1 {
|
|
|
3792
4472
|
*
|
|
3793
4473
|
* // Example response
|
|
3794
4474
|
* // {
|
|
4475
|
+
* // "commentUpdateState": "my_commentUpdateState",
|
|
3795
4476
|
* // "documentId": "my_documentId",
|
|
3796
4477
|
* // "replies": [],
|
|
4478
|
+
* // "suggestionResponses": [],
|
|
3797
4479
|
* // "writeControl": {}
|
|
3798
4480
|
* // }
|
|
3799
4481
|
* }
|
|
@@ -3856,6 +4538,8 @@ export declare namespace docs_v1 {
|
|
|
3856
4538
|
* // request body parameters
|
|
3857
4539
|
* // {
|
|
3858
4540
|
* // "body": {},
|
|
4541
|
+
* // "comments": [],
|
|
4542
|
+
* // "commentsViewMode": "my_commentsViewMode",
|
|
3859
4543
|
* // "documentId": "my_documentId",
|
|
3860
4544
|
* // "documentStyle": {},
|
|
3861
4545
|
* // "footers": {},
|
|
@@ -3869,6 +4553,7 @@ export declare namespace docs_v1 {
|
|
|
3869
4553
|
* // "revisionId": "my_revisionId",
|
|
3870
4554
|
* // "suggestedDocumentStyleChanges": {},
|
|
3871
4555
|
* // "suggestedNamedStylesChanges": {},
|
|
4556
|
+
* // "suggestions": [],
|
|
3872
4557
|
* // "suggestionsViewMode": "my_suggestionsViewMode",
|
|
3873
4558
|
* // "tabs": [],
|
|
3874
4559
|
* // "title": "my_title"
|
|
@@ -3880,6 +4565,8 @@ export declare namespace docs_v1 {
|
|
|
3880
4565
|
* // Example response
|
|
3881
4566
|
* // {
|
|
3882
4567
|
* // "body": {},
|
|
4568
|
+
* // "comments": [],
|
|
4569
|
+
* // "commentsViewMode": "my_commentsViewMode",
|
|
3883
4570
|
* // "documentId": "my_documentId",
|
|
3884
4571
|
* // "documentStyle": {},
|
|
3885
4572
|
* // "footers": {},
|
|
@@ -3893,6 +4580,7 @@ export declare namespace docs_v1 {
|
|
|
3893
4580
|
* // "revisionId": "my_revisionId",
|
|
3894
4581
|
* // "suggestedDocumentStyleChanges": {},
|
|
3895
4582
|
* // "suggestedNamedStylesChanges": {},
|
|
4583
|
+
* // "suggestions": [],
|
|
3896
4584
|
* // "suggestionsViewMode": "my_suggestionsViewMode",
|
|
3897
4585
|
* // "tabs": [],
|
|
3898
4586
|
* // "title": "my_title"
|
|
@@ -3954,6 +4642,8 @@ export declare namespace docs_v1 {
|
|
|
3954
4642
|
*
|
|
3955
4643
|
* // Do the magic
|
|
3956
4644
|
* const res = await docs.documents.get({
|
|
4645
|
+
* // 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).
|
|
4646
|
+
* commentsViewMode: 'placeholder-value',
|
|
3957
4647
|
* // The ID of the document to retrieve.
|
|
3958
4648
|
* documentId: 'placeholder-value',
|
|
3959
4649
|
* // 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`.
|
|
@@ -3966,6 +4656,8 @@ export declare namespace docs_v1 {
|
|
|
3966
4656
|
* // Example response
|
|
3967
4657
|
* // {
|
|
3968
4658
|
* // "body": {},
|
|
4659
|
+
* // "comments": [],
|
|
4660
|
+
* // "commentsViewMode": "my_commentsViewMode",
|
|
3969
4661
|
* // "documentId": "my_documentId",
|
|
3970
4662
|
* // "documentStyle": {},
|
|
3971
4663
|
* // "footers": {},
|
|
@@ -3979,6 +4671,7 @@ export declare namespace docs_v1 {
|
|
|
3979
4671
|
* // "revisionId": "my_revisionId",
|
|
3980
4672
|
* // "suggestedDocumentStyleChanges": {},
|
|
3981
4673
|
* // "suggestedNamedStylesChanges": {},
|
|
4674
|
+
* // "suggestions": [],
|
|
3982
4675
|
* // "suggestionsViewMode": "my_suggestionsViewMode",
|
|
3983
4676
|
* // "tabs": [],
|
|
3984
4677
|
* // "title": "my_title"
|
|
@@ -4021,6 +4714,10 @@ export declare namespace docs_v1 {
|
|
|
4021
4714
|
requestBody?: Schema$Document;
|
|
4022
4715
|
}
|
|
4023
4716
|
export interface Params$Resource$Documents$Get extends StandardParameters {
|
|
4717
|
+
/**
|
|
4718
|
+
* 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).
|
|
4719
|
+
*/
|
|
4720
|
+
commentsViewMode?: string;
|
|
4024
4721
|
/**
|
|
4025
4722
|
* The ID of the document to retrieve.
|
|
4026
4723
|
*/
|