@maxim_mazurok/gapi.client.docs-v1 0.4.20260909 → 0.4.20260928
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/index.d.ts +345 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://docs.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260928
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -24,6 +24,22 @@ declare namespace gapi.client {
|
|
|
24
24
|
function load(name: 'docs', version: 'v1', callback: () => any): void;
|
|
25
25
|
|
|
26
26
|
namespace docs {
|
|
27
|
+
interface AcceptSuggestionRequest {
|
|
28
|
+
/** The ID of the suggestion. */
|
|
29
|
+
suggestionId?: string;
|
|
30
|
+
}
|
|
31
|
+
interface AddCommentReplyRequest {
|
|
32
|
+
/** The ID of the CommentThread to add the reply to. */
|
|
33
|
+
commentId?: string;
|
|
34
|
+
/** The Post representing the reply. */
|
|
35
|
+
post?: Post;
|
|
36
|
+
/** The ID of the SuggestionThread to add the reply to. */
|
|
37
|
+
suggestionId?: string;
|
|
38
|
+
}
|
|
39
|
+
interface AddCommentReplyResponse {
|
|
40
|
+
/** The newly-inserted reply Post. */
|
|
41
|
+
post?: Post;
|
|
42
|
+
}
|
|
27
43
|
interface AddDocumentTabRequest {
|
|
28
44
|
/** The properties of the tab to add. All properties are optional. */
|
|
29
45
|
tabProperties?: TabProperties;
|
|
@@ -59,10 +75,18 @@ declare namespace gapi.client {
|
|
|
59
75
|
writeControl?: WriteControl;
|
|
60
76
|
}
|
|
61
77
|
interface BatchUpdateDocumentResponse {
|
|
78
|
+
/** Whether comment updates were applied in the batch request. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
79
|
+
commentUpdateState?:
|
|
80
|
+
| 'COMMENT_UPDATE_STATE_UNSPECIFIED'
|
|
81
|
+
| 'NO_UPDATES_REQUESTED'
|
|
82
|
+
| 'ALL_SAVED'
|
|
83
|
+
| 'ALL_FAILED_UNKNOWN_REASON';
|
|
62
84
|
/** The ID of the document to which the updates were applied to. */
|
|
63
85
|
documentId?: string;
|
|
64
86
|
/** The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty. */
|
|
65
87
|
replies?: Response[];
|
|
88
|
+
/** The suggestions which were affected by each update. This maps 1:1 with the updates. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
89
|
+
suggestionResponses?: SuggestionResponse[];
|
|
66
90
|
/** The updated write control after applying the request. */
|
|
67
91
|
writeControl?: WriteControl;
|
|
68
92
|
}
|
|
@@ -106,6 +130,36 @@ declare namespace gapi.client {
|
|
|
106
130
|
/** The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. */
|
|
107
131
|
textStyle?: TextStyle;
|
|
108
132
|
}
|
|
133
|
+
interface CommentAnchor {
|
|
134
|
+
/** The ID of the comment anchor. */
|
|
135
|
+
anchorId?: string;
|
|
136
|
+
/** A collection of Ranges in the document which are tied to this anchor. */
|
|
137
|
+
ranges?: Range[];
|
|
138
|
+
}
|
|
139
|
+
interface CommentThread {
|
|
140
|
+
/** The ID of the CommentAnchor in the document that this thread is tied to. Multiple comment threads may be anchored to the same CommentAnchor. */
|
|
141
|
+
anchorId?: string;
|
|
142
|
+
/** The unique ID of the comment thread. */
|
|
143
|
+
commentId?: string;
|
|
144
|
+
/** The first post in the thread. */
|
|
145
|
+
headPost?: Post;
|
|
146
|
+
/** The quoted text from the document when the comment was created, formatted as plain-text. */
|
|
147
|
+
plainTextQuote?: string;
|
|
148
|
+
/** Replies to the head post. */
|
|
149
|
+
replies?: Post[];
|
|
150
|
+
/** Whether the thread is open or resolved. */
|
|
151
|
+
status?: 'STATUS_UNSPECIFIED' | 'OPEN' | 'RESOLVED';
|
|
152
|
+
}
|
|
153
|
+
interface CreateDropdownDefinitionRequest {
|
|
154
|
+
/** Required. The DropdownDefinition to create. */
|
|
155
|
+
dropdownDefinition?: DropdownDefinition;
|
|
156
|
+
/** 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. */
|
|
157
|
+
tabId?: string;
|
|
158
|
+
}
|
|
159
|
+
interface CreateDropdownDefinitionResponse {
|
|
160
|
+
/** The newly-created DropdownDefinition. */
|
|
161
|
+
dropdownDefinition?: DropdownDefinition;
|
|
162
|
+
}
|
|
109
163
|
interface CreateFooterRequest {
|
|
110
164
|
/** The location of the SectionBreak immediately preceding the section whose SectionStyle this footer should belong to. If this is unset or refers to the first section break in the document, the footer applies to the document style. */
|
|
111
165
|
sectionBreakLocation?: Location;
|
|
@@ -246,10 +300,28 @@ declare namespace gapi.client {
|
|
|
246
300
|
/** Indicates if there was a suggested change to time_zone_id. */
|
|
247
301
|
timeZoneIdSuggested?: boolean;
|
|
248
302
|
}
|
|
303
|
+
interface DeleteCommentReplyRequest {
|
|
304
|
+
/** The ID of the CommentThread which the post belongs to. */
|
|
305
|
+
commentId?: string;
|
|
306
|
+
/** The ID of the reply Post being deleted. */
|
|
307
|
+
postId?: string;
|
|
308
|
+
/** The ID of the SuggestionThread which the post belongs to. */
|
|
309
|
+
suggestionId?: string;
|
|
310
|
+
}
|
|
311
|
+
interface DeleteCommentRequest {
|
|
312
|
+
/** The ID of the CommentThread that is being deleted. */
|
|
313
|
+
commentId?: string;
|
|
314
|
+
}
|
|
249
315
|
interface DeleteContentRangeRequest {
|
|
250
316
|
/** The range of content to delete. Deleting text that crosses a paragraph boundary may result in changes to paragraph styles, lists, positioned objects and bookmarks as the two paragraphs are merged. Attempting to delete certain ranges can result in an invalid document structure in which case a 400 bad request error is returned. Some examples of invalid delete requests include: * Deleting one code unit of a surrogate pair. * Deleting the last newline character of a Body, Header, Footer, Footnote, TableCell or TableOfContents. * Deleting the start or end of a Table, TableOfContents or Equation without deleting the entire element. * Deleting the newline character before a Table, TableOfContents or SectionBreak without deleting the element. * Deleting individual rows or cells of a table. Deleting the content within a table cell is allowed. */
|
|
251
317
|
range?: Range;
|
|
252
318
|
}
|
|
319
|
+
interface DeleteDropdownDefinitionRequest {
|
|
320
|
+
/** The ID of the DropdownDefinition to delete. */
|
|
321
|
+
dropdownDefinitionId?: string;
|
|
322
|
+
/** 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. */
|
|
323
|
+
tabId?: string;
|
|
324
|
+
}
|
|
253
325
|
interface DeleteFooterRequest {
|
|
254
326
|
/** The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section. */
|
|
255
327
|
footerId?: string;
|
|
@@ -280,6 +352,10 @@ declare namespace gapi.client {
|
|
|
280
352
|
/** The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
281
353
|
tabId?: string;
|
|
282
354
|
}
|
|
355
|
+
interface DeleteSuggestionRequest {
|
|
356
|
+
/** The ID of the suggestion. */
|
|
357
|
+
suggestionId?: string;
|
|
358
|
+
}
|
|
283
359
|
interface DeleteTableColumnRequest {
|
|
284
360
|
/** The reference table cell location from which the column will be deleted. The column this cell spans will be deleted. If this is a merged cell that spans multiple columns, all columns that the cell spans will be deleted. If no columns remain in the table after this deletion, the whole table is deleted. */
|
|
285
361
|
tableCellLocation?: TableCellLocation;
|
|
@@ -301,6 +377,14 @@ declare namespace gapi.client {
|
|
|
301
377
|
interface Document {
|
|
302
378
|
/** 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. */
|
|
303
379
|
body?: Body;
|
|
380
|
+
/** 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). */
|
|
381
|
+
comments?: CommentThread[];
|
|
382
|
+
/** Output only. The comments view mode applied to the document. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
383
|
+
commentsViewMode?:
|
|
384
|
+
| 'COMMENTS_VIEW_MODE_UNSPECIFIED'
|
|
385
|
+
| 'COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS'
|
|
386
|
+
| 'COMMENTS_VIEW_MODE_OMITTED'
|
|
387
|
+
| 'COMMENTS_VIEW_MODE_INCLUDED';
|
|
304
388
|
/** Output only. The ID of the document. */
|
|
305
389
|
documentId?: string;
|
|
306
390
|
/** Output only. The style of the document. Legacy field: Instead, use Document.tabs.documentTab.documentStyle, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
@@ -327,6 +411,8 @@ declare namespace gapi.client {
|
|
|
327
411
|
suggestedDocumentStyleChanges?: {[P in string]: SuggestedDocumentStyle};
|
|
328
412
|
/** Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */
|
|
329
413
|
suggestedNamedStylesChanges?: {[P in string]: SuggestedNamedStyles};
|
|
414
|
+
/** 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). */
|
|
415
|
+
suggestions?: SuggestionThread[];
|
|
330
416
|
/** 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. */
|
|
331
417
|
suggestionsViewMode?:
|
|
332
418
|
| 'DEFAULT_FOR_CURRENT_ACCESS'
|
|
@@ -427,8 +513,12 @@ declare namespace gapi.client {
|
|
|
427
513
|
interface DocumentTab {
|
|
428
514
|
/** The main body of the document tab. */
|
|
429
515
|
body?: Body;
|
|
516
|
+
/** 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). */
|
|
517
|
+
commentAnchors?: {[P in string]: CommentAnchor};
|
|
430
518
|
/** The style of the document tab. */
|
|
431
519
|
documentStyle?: DocumentStyle;
|
|
520
|
+
/** The dropdown definitions in a document tab, keyed by dropdown definition ID. */
|
|
521
|
+
dropdownDefinitions?: {[P in string]: DropdownDefinition};
|
|
432
522
|
/** The footers in the document tab, keyed by footer ID. */
|
|
433
523
|
footers?: {[P in string]: Footer};
|
|
434
524
|
/** The footnotes in the document tab, keyed by footnote ID. */
|
|
@@ -450,6 +540,70 @@ declare namespace gapi.client {
|
|
|
450
540
|
/** The suggested changes to the named styles of the document tab, keyed by suggestion ID. */
|
|
451
541
|
suggestedNamedStylesChanges?: {[P in string]: SuggestedNamedStyles};
|
|
452
542
|
}
|
|
543
|
+
interface Dropdown {
|
|
544
|
+
/** The ID of this dropdown. */
|
|
545
|
+
dropdownId?: string;
|
|
546
|
+
/** The properties of this dropdown. */
|
|
547
|
+
dropdownProperties?: DropdownProperties;
|
|
548
|
+
/** IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. */
|
|
549
|
+
suggestedDeletionIds?: string[];
|
|
550
|
+
/** The suggested properties changes to this dropdown, keyed by suggestion ID. */
|
|
551
|
+
suggestedDropdownPropertiesChanges?: {
|
|
552
|
+
[P in string]: SuggestedDropdownProperties;
|
|
553
|
+
};
|
|
554
|
+
/** IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. */
|
|
555
|
+
suggestedInsertionIds?: string[];
|
|
556
|
+
/** The suggested text style changes to this dropdown, keyed by suggestion ID. */
|
|
557
|
+
suggestedTextStyleChanges?: {[P in string]: SuggestedTextStyle};
|
|
558
|
+
/** The text style of this dropdown. */
|
|
559
|
+
textStyle?: TextStyle;
|
|
560
|
+
}
|
|
561
|
+
interface DropdownDefinition {
|
|
562
|
+
/** 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. */
|
|
563
|
+
dropdownDefinitionId?: string;
|
|
564
|
+
/** The properties of this dropdown definition. */
|
|
565
|
+
dropdownDefinitionProperties?: DropdownDefinitionProperties;
|
|
566
|
+
/** ID for suggestion that deletes this dropdown definition. */
|
|
567
|
+
suggestedDeletionId?: string;
|
|
568
|
+
/** Suggested property changes to this definition, keyed by suggestion ID. */
|
|
569
|
+
suggestedDropdownDefinitionPropertiesChanges?: {
|
|
570
|
+
[P in string]: SuggestedDropdownDefinitionProperties;
|
|
571
|
+
};
|
|
572
|
+
/** ID for suggestion that inserts this dropdown definition. */
|
|
573
|
+
suggestedInsertionId?: string;
|
|
574
|
+
}
|
|
575
|
+
interface DropdownDefinitionProperties {
|
|
576
|
+
/** The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. */
|
|
577
|
+
options?: DropdownOption[];
|
|
578
|
+
/** The title of the dropdown definition. */
|
|
579
|
+
title?: string;
|
|
580
|
+
}
|
|
581
|
+
interface DropdownDefinitionPropertiesSuggestionState {
|
|
582
|
+
/** Indicates if there was a suggested change to options. */
|
|
583
|
+
optionsSuggested?: boolean;
|
|
584
|
+
/** Indicates if there was a suggested change to title. */
|
|
585
|
+
titleSuggested?: boolean;
|
|
586
|
+
}
|
|
587
|
+
interface DropdownOption {
|
|
588
|
+
/** The display value of this dropdown option. */
|
|
589
|
+
displayValue?: string;
|
|
590
|
+
/** 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. */
|
|
591
|
+
optionId?: string;
|
|
592
|
+
/** 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. */
|
|
593
|
+
textStyle?: TextStyle;
|
|
594
|
+
}
|
|
595
|
+
interface DropdownProperties {
|
|
596
|
+
/** 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. */
|
|
597
|
+
displayValue?: string;
|
|
598
|
+
/** The ID of the DropdownDefinition that defines the options for this dropdown. */
|
|
599
|
+
dropdownDefinitionId?: string;
|
|
600
|
+
/** The ID of the selected option in this dropdown. */
|
|
601
|
+
selectedOptionId?: string;
|
|
602
|
+
}
|
|
603
|
+
interface DropdownPropertiesSuggestionState {
|
|
604
|
+
/** Indicates if there was a suggested change to selected_option_id. */
|
|
605
|
+
selectedOptionIdSuggested?: boolean;
|
|
606
|
+
}
|
|
453
607
|
interface EmbeddedDrawingProperties {}
|
|
454
608
|
interface EmbeddedDrawingPropertiesSuggestionState {}
|
|
455
609
|
interface EmbeddedObject {
|
|
@@ -646,6 +800,18 @@ declare namespace gapi.client {
|
|
|
646
800
|
/** A mask that indicates which of the fields in embedded_object have been changed in this suggestion. */
|
|
647
801
|
embeddedObjectSuggestionState?: EmbeddedObjectSuggestionState;
|
|
648
802
|
}
|
|
803
|
+
interface InsertCommentRequest {
|
|
804
|
+
/** 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. */
|
|
805
|
+
assigneeEmailAddress?: string;
|
|
806
|
+
/** 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. */
|
|
807
|
+
content?: string;
|
|
808
|
+
/** The Range in the document that is tied to this comment. */
|
|
809
|
+
range?: Range;
|
|
810
|
+
}
|
|
811
|
+
interface InsertCommentResponse {
|
|
812
|
+
/** The newly-inserted comment thread. */
|
|
813
|
+
commentThread?: CommentThread;
|
|
814
|
+
}
|
|
649
815
|
interface InsertDateRequest {
|
|
650
816
|
/** The properties of the date to insert. */
|
|
651
817
|
dateElementProperties?: DateElementProperties;
|
|
@@ -654,6 +820,20 @@ declare namespace gapi.client {
|
|
|
654
820
|
/** Inserts the date at a specific index in the document. The date must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between an existing table and its preceding paragraph). */
|
|
655
821
|
location?: Location;
|
|
656
822
|
}
|
|
823
|
+
interface InsertDropdownRequest {
|
|
824
|
+
/** Required. The DropdownDefinition ID. */
|
|
825
|
+
dropdownDefinitionId?: string;
|
|
826
|
+
/** The EndOfSegmentLocation in the document to insert the dropdown at. */
|
|
827
|
+
endOfSegmentLocation?: EndOfSegmentLocation;
|
|
828
|
+
/** The Location in the document to insert the dropdown at. */
|
|
829
|
+
location?: Location;
|
|
830
|
+
/** 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. */
|
|
831
|
+
selectedOptionId?: string;
|
|
832
|
+
}
|
|
833
|
+
interface InsertDropdownResponse {
|
|
834
|
+
/** The newly-inserted Dropdown. */
|
|
835
|
+
dropdown?: Dropdown;
|
|
836
|
+
}
|
|
657
837
|
interface InsertInlineImageRequest {
|
|
658
838
|
/** Inserts the text at the end of a header, footer or the document body. Inline images cannot be inserted inside a footnote. */
|
|
659
839
|
endOfSegmentLocation?: EndOfSegmentLocation;
|
|
@@ -938,6 +1118,8 @@ declare namespace gapi.client {
|
|
|
938
1118
|
columnBreak?: ColumnBreak;
|
|
939
1119
|
/** A paragraph element that represents a date. */
|
|
940
1120
|
dateElement?: DateElement;
|
|
1121
|
+
/** A paragraph element that represents a dropdown menu. */
|
|
1122
|
+
dropdown?: Dropdown;
|
|
941
1123
|
/** The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. */
|
|
942
1124
|
endIndex?: number;
|
|
943
1125
|
/** An equation paragraph element. */
|
|
@@ -1137,6 +1319,52 @@ declare namespace gapi.client {
|
|
|
1137
1319
|
/** A mask that indicates which of the fields in positioning have been changed in this suggestion. */
|
|
1138
1320
|
positioningSuggestionState?: PositionedObjectPositioningSuggestionState;
|
|
1139
1321
|
}
|
|
1322
|
+
interface Post {
|
|
1323
|
+
/** 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. */
|
|
1324
|
+
assigneeEmail?: string;
|
|
1325
|
+
/** Output only. The user who created the post. */
|
|
1326
|
+
author?: PostAuthor;
|
|
1327
|
+
/** Optional. The action type for comment posts. */
|
|
1328
|
+
commentAction?:
|
|
1329
|
+
| 'COMMENT_ACTION_TYPE_UNSPECIFIED'
|
|
1330
|
+
| 'NO_COMMENT_ACTION_CHANGE'
|
|
1331
|
+
| 'RESOLVE'
|
|
1332
|
+
| 'REOPEN';
|
|
1333
|
+
/** 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. */
|
|
1334
|
+
content?: string;
|
|
1335
|
+
/** Output only. The content of the post as HTML. */
|
|
1336
|
+
contentHtml?: string;
|
|
1337
|
+
/** Output only. The time the post was created. */
|
|
1338
|
+
createTime?: string;
|
|
1339
|
+
/** Output only. Whether the post is deleted. If `true`, content and author fields will be empty. */
|
|
1340
|
+
deleted?: boolean;
|
|
1341
|
+
/** Output only. Whether the post is from a copied document. This field cannot be set directly by callers. */
|
|
1342
|
+
fromCopiedDocument?: boolean;
|
|
1343
|
+
/** Output only. Whether the post is from a document comparison. This field cannot be set directly by callers. */
|
|
1344
|
+
fromDocumentComparison?: boolean;
|
|
1345
|
+
/** Output only. Whether the post is from an imported document. This field cannot be set directly by callers. */
|
|
1346
|
+
fromImportedDocument?: boolean;
|
|
1347
|
+
/** Output only. The unique ID of the post. */
|
|
1348
|
+
postId?: string;
|
|
1349
|
+
/** Output only. The action type for suggestion posts. */
|
|
1350
|
+
suggestionAction?:
|
|
1351
|
+
| 'SUGGESTION_ACTION_TYPE_UNSPECIFIED'
|
|
1352
|
+
| 'NO_SUGGESTION_ACTION_CHANGE'
|
|
1353
|
+
| 'ACCEPT'
|
|
1354
|
+
| 'REJECT';
|
|
1355
|
+
/** Output only. The time the post was last updated. */
|
|
1356
|
+
updateTime?: string;
|
|
1357
|
+
}
|
|
1358
|
+
interface PostAuthor {
|
|
1359
|
+
/** Whether the user is anonymous. */
|
|
1360
|
+
anonymous?: boolean;
|
|
1361
|
+
/** The display name of the user. May be absent if the author is anonymous. */
|
|
1362
|
+
displayName?: string;
|
|
1363
|
+
/** Whether the user is the authenticated user making the request. */
|
|
1364
|
+
me?: boolean;
|
|
1365
|
+
/** 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. */
|
|
1366
|
+
user?: string;
|
|
1367
|
+
}
|
|
1140
1368
|
interface Range {
|
|
1141
1369
|
/** The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. */
|
|
1142
1370
|
endIndex?: number;
|
|
@@ -1147,6 +1375,10 @@ declare namespace gapi.client {
|
|
|
1147
1375
|
/** The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. */
|
|
1148
1376
|
tabId?: string;
|
|
1149
1377
|
}
|
|
1378
|
+
interface RejectSuggestionRequest {
|
|
1379
|
+
/** The ID of the suggestion. */
|
|
1380
|
+
suggestionId?: string;
|
|
1381
|
+
}
|
|
1150
1382
|
interface ReplaceAllTextRequest {
|
|
1151
1383
|
/** Finds text in the document matching this substring. */
|
|
1152
1384
|
containsText?: SubstringMatchCriteria;
|
|
@@ -1180,8 +1412,14 @@ declare namespace gapi.client {
|
|
|
1180
1412
|
text?: string;
|
|
1181
1413
|
}
|
|
1182
1414
|
interface Request {
|
|
1415
|
+
/** Accepts a suggestion. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
1416
|
+
acceptSuggestion?: AcceptSuggestionRequest;
|
|
1417
|
+
/** Adds a reply to a CommentThread or SuggestionThread. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
1418
|
+
addCommentReply?: AddCommentReplyRequest;
|
|
1183
1419
|
/** Adds a document tab. */
|
|
1184
1420
|
addDocumentTab?: AddDocumentTabRequest;
|
|
1421
|
+
/** Creates a DropdownDefinition. */
|
|
1422
|
+
createDropdownDefinition?: CreateDropdownDefinitionRequest;
|
|
1185
1423
|
/** Creates a footer. */
|
|
1186
1424
|
createFooter?: CreateFooterRequest;
|
|
1187
1425
|
/** Creates a footnote. */
|
|
@@ -1192,8 +1430,14 @@ declare namespace gapi.client {
|
|
|
1192
1430
|
createNamedRange?: CreateNamedRangeRequest;
|
|
1193
1431
|
/** Creates bullets for paragraphs. */
|
|
1194
1432
|
createParagraphBullets?: CreateParagraphBulletsRequest;
|
|
1433
|
+
/** Deletes a CommentThread. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
1434
|
+
deleteComment?: DeleteCommentRequest;
|
|
1435
|
+
/** Deletes a reply Post from a CommentThread or SuggestionThread. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
1436
|
+
deleteCommentReply?: DeleteCommentReplyRequest;
|
|
1195
1437
|
/** Deletes content from the document. */
|
|
1196
1438
|
deleteContentRange?: DeleteContentRangeRequest;
|
|
1439
|
+
/** Deletes a DropdownDefinition. */
|
|
1440
|
+
deleteDropdownDefinition?: DeleteDropdownDefinitionRequest;
|
|
1197
1441
|
/** Deletes a footer from the document. */
|
|
1198
1442
|
deleteFooter?: DeleteFooterRequest;
|
|
1199
1443
|
/** Deletes a header from the document. */
|
|
@@ -1204,14 +1448,20 @@ declare namespace gapi.client {
|
|
|
1204
1448
|
deleteParagraphBullets?: DeleteParagraphBulletsRequest;
|
|
1205
1449
|
/** Deletes a positioned object from the document. */
|
|
1206
1450
|
deletePositionedObject?: DeletePositionedObjectRequest;
|
|
1451
|
+
/** Deletes a suggestion. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
1452
|
+
deleteSuggestion?: DeleteSuggestionRequest;
|
|
1207
1453
|
/** Deletes a document tab. */
|
|
1208
1454
|
deleteTab?: DeleteTabRequest;
|
|
1209
1455
|
/** Deletes a column from a table. */
|
|
1210
1456
|
deleteTableColumn?: DeleteTableColumnRequest;
|
|
1211
1457
|
/** Deletes a row from a table. */
|
|
1212
1458
|
deleteTableRow?: DeleteTableRowRequest;
|
|
1459
|
+
/** Inserts a CommentThread into the document. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
1460
|
+
insertComment?: InsertCommentRequest;
|
|
1213
1461
|
/** Inserts a date. */
|
|
1214
1462
|
insertDate?: InsertDateRequest;
|
|
1463
|
+
/** Inserts a Dropdown at the specified location. */
|
|
1464
|
+
insertDropdown?: InsertDropdownRequest;
|
|
1215
1465
|
/** Inserts an inline image at the specified location. */
|
|
1216
1466
|
insertInlineImage?: InsertInlineImageRequest;
|
|
1217
1467
|
/** Inserts a page break at the specified location. */
|
|
@@ -1234,6 +1484,8 @@ declare namespace gapi.client {
|
|
|
1234
1484
|
mergeTableCells?: MergeTableCellsRequest;
|
|
1235
1485
|
/** Updates the number of pinned header rows in a table. */
|
|
1236
1486
|
pinTableHeaderRows?: PinTableHeaderRowsRequest;
|
|
1487
|
+
/** Rejects a suggestion. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
1488
|
+
rejectSuggestion?: RejectSuggestionRequest;
|
|
1237
1489
|
/** Replaces all instances of the specified text. */
|
|
1238
1490
|
replaceAllText?: ReplaceAllTextRequest;
|
|
1239
1491
|
/** Replaces an image in the document. */
|
|
@@ -1242,10 +1494,16 @@ declare namespace gapi.client {
|
|
|
1242
1494
|
replaceNamedRangeContent?: ReplaceNamedRangeContentRequest;
|
|
1243
1495
|
/** Unmerges cells in a table. */
|
|
1244
1496
|
unmergeTableCells?: UnmergeTableCellsRequest;
|
|
1497
|
+
/** Updates an existing post (head post or reply) of a CommentThread or SuggestionThread. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
1498
|
+
updateCommentPost?: UpdateCommentPostRequest;
|
|
1245
1499
|
/** Updates the style of the document. */
|
|
1246
1500
|
updateDocumentStyle?: UpdateDocumentStyleRequest;
|
|
1247
1501
|
/** Updates the properties of a document tab. */
|
|
1248
1502
|
updateDocumentTabProperties?: UpdateDocumentTabPropertiesRequest;
|
|
1503
|
+
/** Updates the properties of a DropdownDefinition. */
|
|
1504
|
+
updateDropdownDefinitionProperties?: UpdateDropdownDefinitionPropertiesRequest;
|
|
1505
|
+
/** Updates the properties of a Dropdown. */
|
|
1506
|
+
updateDropdownProperties?: UpdateDropdownPropertiesRequest;
|
|
1249
1507
|
/** Updates a named style. */
|
|
1250
1508
|
updateNamedStyle?: UpdateNamedStyleRequest;
|
|
1251
1509
|
/** Updates the paragraph style at the specified range. */
|
|
@@ -1262,8 +1520,12 @@ declare namespace gapi.client {
|
|
|
1262
1520
|
updateTextStyle?: UpdateTextStyleRequest;
|
|
1263
1521
|
}
|
|
1264
1522
|
interface Response {
|
|
1523
|
+
/** The result of adding a reply to a comment or suggestion. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
1524
|
+
addCommentReply?: AddCommentReplyResponse;
|
|
1265
1525
|
/** The result of adding a document tab. */
|
|
1266
1526
|
addDocumentTab?: AddDocumentTabResponse;
|
|
1527
|
+
/** The result of creating a dropdown definition. */
|
|
1528
|
+
createDropdownDefinition?: CreateDropdownDefinitionResponse;
|
|
1267
1529
|
/** The result of creating a footer. */
|
|
1268
1530
|
createFooter?: CreateFooterResponse;
|
|
1269
1531
|
/** The result of creating a footnote. */
|
|
@@ -1272,6 +1534,10 @@ declare namespace gapi.client {
|
|
|
1272
1534
|
createHeader?: CreateHeaderResponse;
|
|
1273
1535
|
/** The result of creating a named range. */
|
|
1274
1536
|
createNamedRange?: CreateNamedRangeResponse;
|
|
1537
|
+
/** The result of inserting a comment. [Developer Preview](https://developers.google.com/workspace/preview). */
|
|
1538
|
+
insertComment?: InsertCommentResponse;
|
|
1539
|
+
/** The result of inserting a dropdown. */
|
|
1540
|
+
insertDropdown?: InsertDropdownResponse;
|
|
1275
1541
|
/** The result of inserting an inline image. */
|
|
1276
1542
|
insertInlineImage?: InsertInlineImageResponse;
|
|
1277
1543
|
/** The result of inserting an inline Google Sheets chart. */
|
|
@@ -1437,6 +1703,18 @@ declare namespace gapi.client {
|
|
|
1437
1703
|
/** A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. */
|
|
1438
1704
|
documentStyleSuggestionState?: DocumentStyleSuggestionState;
|
|
1439
1705
|
}
|
|
1706
|
+
interface SuggestedDropdownDefinitionProperties {
|
|
1707
|
+
/** 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. */
|
|
1708
|
+
dropdownDefinitionProperties?: DropdownDefinitionProperties;
|
|
1709
|
+
/** A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. */
|
|
1710
|
+
dropdownDefinitionPropertiesSuggestionState?: DropdownDefinitionPropertiesSuggestionState;
|
|
1711
|
+
}
|
|
1712
|
+
interface SuggestedDropdownProperties {
|
|
1713
|
+
/** 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. */
|
|
1714
|
+
dropdownProperties?: DropdownProperties;
|
|
1715
|
+
/** A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. */
|
|
1716
|
+
dropdownPropertiesSuggestionState?: DropdownPropertiesSuggestionState;
|
|
1717
|
+
}
|
|
1440
1718
|
interface SuggestedInlineObjectProperties {
|
|
1441
1719
|
/** An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. */
|
|
1442
1720
|
inlineObjectProperties?: InlineObjectProperties;
|
|
@@ -1485,6 +1763,32 @@ declare namespace gapi.client {
|
|
|
1485
1763
|
/** A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. */
|
|
1486
1764
|
textStyleSuggestionState?: TextStyleSuggestionState;
|
|
1487
1765
|
}
|
|
1766
|
+
interface SuggestionResponse {
|
|
1767
|
+
/** The IDs of suggestions which were accepted during the update. */
|
|
1768
|
+
acceptedSuggestionIds?: string[];
|
|
1769
|
+
/** The IDs of suggestions which were created during the update. */
|
|
1770
|
+
createdSuggestionIds?: string[];
|
|
1771
|
+
/** The IDs of suggestions which were deleted during the update. */
|
|
1772
|
+
deletedSuggestionIds?: string[];
|
|
1773
|
+
/** The IDs of suggestions which were rejected during the update. */
|
|
1774
|
+
rejectedSuggestionIds?: string[];
|
|
1775
|
+
/** The IDs of suggestions whose summaries were updated during the update. */
|
|
1776
|
+
updatedSummarySuggestionIds?: string[];
|
|
1777
|
+
}
|
|
1778
|
+
interface SuggestionThread {
|
|
1779
|
+
/** The first post in the thread. */
|
|
1780
|
+
headPost?: Post;
|
|
1781
|
+
/** Replies to the head post. */
|
|
1782
|
+
replies?: Post[];
|
|
1783
|
+
/** Whether the thread is open, accepted, or rejected. */
|
|
1784
|
+
status?: 'STATUS_UNSPECIFIED' | 'OPEN' | 'ACCEPTED' | 'REJECTED';
|
|
1785
|
+
/** The unique ID of the suggestion. */
|
|
1786
|
+
suggestionId?: string;
|
|
1787
|
+
/** Summary of the suggested differences in the document, in HTML. May be empty. */
|
|
1788
|
+
summaryHtml?: string;
|
|
1789
|
+
/** Summary of the suggested differences in the document, in plain text. May be empty. */
|
|
1790
|
+
summaryText?: string;
|
|
1791
|
+
}
|
|
1488
1792
|
interface Tab {
|
|
1489
1793
|
/** The child tabs nested within this tab. */
|
|
1490
1794
|
childTabs?: Tab[];
|
|
@@ -1740,6 +2044,16 @@ declare namespace gapi.client {
|
|
|
1740
2044
|
/** The table range specifying which cells of the table to unmerge. All merged cells in this range will be unmerged, and cells that are already unmerged will not be affected. If the range has no merged cells, the request will do nothing. If there is text in any of the merged cells, the text will remain in the "head" cell of the resulting block of unmerged cells. The "head" cell is the upper-left cell when the content direction is from left to right, and the upper-right otherwise. */
|
|
1741
2045
|
tableRange?: TableRange;
|
|
1742
2046
|
}
|
|
2047
|
+
interface UpdateCommentPostRequest {
|
|
2048
|
+
/** The ID of the CommentThread which the post belongs to. */
|
|
2049
|
+
commentId?: string;
|
|
2050
|
+
/** 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. */
|
|
2051
|
+
content?: string;
|
|
2052
|
+
/** The ID of the post being updated. */
|
|
2053
|
+
postId?: string;
|
|
2054
|
+
/** The ID of the SuggestionThread which the post belongs to. */
|
|
2055
|
+
suggestionId?: string;
|
|
2056
|
+
}
|
|
1743
2057
|
interface UpdateDocumentStyleRequest {
|
|
1744
2058
|
/** The styles to set on the document. Certain document style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of DocumentStyle for more information. */
|
|
1745
2059
|
documentStyle?: DocumentStyle;
|
|
@@ -1754,6 +2068,28 @@ declare namespace gapi.client {
|
|
|
1754
2068
|
/** The tab properties to update. */
|
|
1755
2069
|
tabProperties?: TabProperties;
|
|
1756
2070
|
}
|
|
2071
|
+
interface UpdateDropdownDefinitionPropertiesRequest {
|
|
2072
|
+
/** The ID of the DropdownDefinition to update. */
|
|
2073
|
+
dropdownDefinitionId?: string;
|
|
2074
|
+
/** The properties to update. */
|
|
2075
|
+
dropdownDefinitionProperties?: DropdownDefinitionProperties;
|
|
2076
|
+
/** 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`. */
|
|
2077
|
+
fields?: string;
|
|
2078
|
+
/** 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"}`. */
|
|
2079
|
+
selectedOptionIdReplacements?: {[P in string]: string};
|
|
2080
|
+
/** 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. */
|
|
2081
|
+
tabId?: string;
|
|
2082
|
+
}
|
|
2083
|
+
interface UpdateDropdownPropertiesRequest {
|
|
2084
|
+
/** Required. The Dropdown ID. */
|
|
2085
|
+
dropdownId?: string;
|
|
2086
|
+
/** The properties to update. */
|
|
2087
|
+
dropdownProperties?: DropdownProperties;
|
|
2088
|
+
/** 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. */
|
|
2089
|
+
fields?: string;
|
|
2090
|
+
/** 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. */
|
|
2091
|
+
tabId?: string;
|
|
2092
|
+
}
|
|
1757
2093
|
interface UpdateNamedStyleRequest {
|
|
1758
2094
|
/** The NamedStyle fields that should be updated. At least `named_style_type` must be specified. The root `named_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to include `"text_style"` and `"text_style.bold"`. To update the paragraph style's alignment property, set `fields` to include `"paragraph_style"` and `"paragraph_style.alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. Specifying `"text_style"` or `"paragraph_style"` with an empty TextStyle or ParagraphStyle will reset all of its nested fields. */
|
|
1759
2095
|
fields?: string;
|
|
@@ -1827,6 +2163,8 @@ declare namespace gapi.client {
|
|
|
1827
2163
|
requiredRevisionId?: string;
|
|
1828
2164
|
/** 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. */
|
|
1829
2165
|
targetRevisionId?: string;
|
|
2166
|
+
/** 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). */
|
|
2167
|
+
writeMode?: 'WRITE_MODE_UNSPECIFIED' | 'EDIT' | 'SUGGEST';
|
|
1830
2168
|
}
|
|
1831
2169
|
interface DocumentsResource {
|
|
1832
2170
|
/** Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically. */
|
|
@@ -1951,6 +2289,12 @@ declare namespace gapi.client {
|
|
|
1951
2289
|
alt?: 'json' | 'media' | 'proto';
|
|
1952
2290
|
/** JSONP */
|
|
1953
2291
|
callback?: string;
|
|
2292
|
+
/** 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). */
|
|
2293
|
+
commentsViewMode?:
|
|
2294
|
+
| 'COMMENTS_VIEW_MODE_UNSPECIFIED'
|
|
2295
|
+
| 'COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS'
|
|
2296
|
+
| 'COMMENTS_VIEW_MODE_OMITTED'
|
|
2297
|
+
| 'COMMENTS_VIEW_MODE_INCLUDED';
|
|
1954
2298
|
/** The ID of the document to retrieve. */
|
|
1955
2299
|
documentId: string;
|
|
1956
2300
|
/** Selector specifying which fields to include in a partial response. */
|