@maxim_mazurok/gapi.client.docs-v1 0.4.20261005 → 0.5.20261007
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 +19 -19
- 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: 20261007
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -75,7 +75,7 @@ declare namespace gapi.client {
|
|
|
75
75
|
writeControl?: WriteControl;
|
|
76
76
|
}
|
|
77
77
|
interface BatchUpdateDocumentResponse {
|
|
78
|
-
/** Whether comment updates were applied in the batch request.
|
|
78
|
+
/** Whether comment updates were applied in the batch request. */
|
|
79
79
|
commentUpdateState?:
|
|
80
80
|
| 'COMMENT_UPDATE_STATE_UNSPECIFIED'
|
|
81
81
|
| 'NO_UPDATES_REQUESTED'
|
|
@@ -85,7 +85,7 @@ declare namespace gapi.client {
|
|
|
85
85
|
documentId?: string;
|
|
86
86
|
/** The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty. */
|
|
87
87
|
replies?: Response[];
|
|
88
|
-
/** The suggestions which were affected by each update. This maps 1:1 with the updates.
|
|
88
|
+
/** The suggestions which were affected by each update. This maps 1:1 with the updates. */
|
|
89
89
|
suggestionResponses?: SuggestionResponse[];
|
|
90
90
|
/** The updated write control after applying the request. */
|
|
91
91
|
writeControl?: WriteControl;
|
|
@@ -377,9 +377,9 @@ declare namespace gapi.client {
|
|
|
377
377
|
interface Document {
|
|
378
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. */
|
|
379
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`).
|
|
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`). */
|
|
381
381
|
comments?: CommentThread[];
|
|
382
|
-
/** Output only. The comments view mode applied to the document.
|
|
382
|
+
/** Output only. The comments view mode applied to the document. */
|
|
383
383
|
commentsViewMode?:
|
|
384
384
|
| 'COMMENTS_VIEW_MODE_UNSPECIFIED'
|
|
385
385
|
| 'COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS'
|
|
@@ -411,7 +411,7 @@ declare namespace gapi.client {
|
|
|
411
411
|
suggestedDocumentStyleChanges?: {[P in string]: SuggestedDocumentStyle};
|
|
412
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. */
|
|
413
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`).
|
|
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`). */
|
|
415
415
|
suggestions?: SuggestionThread[];
|
|
416
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. */
|
|
417
417
|
suggestionsViewMode?:
|
|
@@ -513,7 +513,7 @@ declare namespace gapi.client {
|
|
|
513
513
|
interface DocumentTab {
|
|
514
514
|
/** The main body of the document tab. */
|
|
515
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`).
|
|
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`). */
|
|
517
517
|
commentAnchors?: {[P in string]: CommentAnchor};
|
|
518
518
|
/** The style of the document tab. */
|
|
519
519
|
documentStyle?: DocumentStyle;
|
|
@@ -1412,9 +1412,9 @@ declare namespace gapi.client {
|
|
|
1412
1412
|
text?: string;
|
|
1413
1413
|
}
|
|
1414
1414
|
interface Request {
|
|
1415
|
-
/** Accepts a suggestion.
|
|
1415
|
+
/** Accepts a suggestion. */
|
|
1416
1416
|
acceptSuggestion?: AcceptSuggestionRequest;
|
|
1417
|
-
/** Adds a reply to a CommentThread or SuggestionThread.
|
|
1417
|
+
/** Adds a reply to a CommentThread or SuggestionThread. */
|
|
1418
1418
|
addCommentReply?: AddCommentReplyRequest;
|
|
1419
1419
|
/** Adds a document tab. */
|
|
1420
1420
|
addDocumentTab?: AddDocumentTabRequest;
|
|
@@ -1430,9 +1430,9 @@ declare namespace gapi.client {
|
|
|
1430
1430
|
createNamedRange?: CreateNamedRangeRequest;
|
|
1431
1431
|
/** Creates bullets for paragraphs. */
|
|
1432
1432
|
createParagraphBullets?: CreateParagraphBulletsRequest;
|
|
1433
|
-
/** Deletes a CommentThread.
|
|
1433
|
+
/** Deletes a CommentThread. */
|
|
1434
1434
|
deleteComment?: DeleteCommentRequest;
|
|
1435
|
-
/** Deletes a reply Post from a CommentThread or SuggestionThread.
|
|
1435
|
+
/** Deletes a reply Post from a CommentThread or SuggestionThread. */
|
|
1436
1436
|
deleteCommentReply?: DeleteCommentReplyRequest;
|
|
1437
1437
|
/** Deletes content from the document. */
|
|
1438
1438
|
deleteContentRange?: DeleteContentRangeRequest;
|
|
@@ -1448,7 +1448,7 @@ declare namespace gapi.client {
|
|
|
1448
1448
|
deleteParagraphBullets?: DeleteParagraphBulletsRequest;
|
|
1449
1449
|
/** Deletes a positioned object from the document. */
|
|
1450
1450
|
deletePositionedObject?: DeletePositionedObjectRequest;
|
|
1451
|
-
/** Deletes a suggestion.
|
|
1451
|
+
/** Deletes a suggestion. */
|
|
1452
1452
|
deleteSuggestion?: DeleteSuggestionRequest;
|
|
1453
1453
|
/** Deletes a document tab. */
|
|
1454
1454
|
deleteTab?: DeleteTabRequest;
|
|
@@ -1456,7 +1456,7 @@ declare namespace gapi.client {
|
|
|
1456
1456
|
deleteTableColumn?: DeleteTableColumnRequest;
|
|
1457
1457
|
/** Deletes a row from a table. */
|
|
1458
1458
|
deleteTableRow?: DeleteTableRowRequest;
|
|
1459
|
-
/** Inserts a CommentThread into the document.
|
|
1459
|
+
/** Inserts a CommentThread into the document. */
|
|
1460
1460
|
insertComment?: InsertCommentRequest;
|
|
1461
1461
|
/** Inserts a date. */
|
|
1462
1462
|
insertDate?: InsertDateRequest;
|
|
@@ -1484,7 +1484,7 @@ declare namespace gapi.client {
|
|
|
1484
1484
|
mergeTableCells?: MergeTableCellsRequest;
|
|
1485
1485
|
/** Updates the number of pinned header rows in a table. */
|
|
1486
1486
|
pinTableHeaderRows?: PinTableHeaderRowsRequest;
|
|
1487
|
-
/** Rejects a suggestion.
|
|
1487
|
+
/** Rejects a suggestion. */
|
|
1488
1488
|
rejectSuggestion?: RejectSuggestionRequest;
|
|
1489
1489
|
/** Replaces all instances of the specified text. */
|
|
1490
1490
|
replaceAllText?: ReplaceAllTextRequest;
|
|
@@ -1494,7 +1494,7 @@ declare namespace gapi.client {
|
|
|
1494
1494
|
replaceNamedRangeContent?: ReplaceNamedRangeContentRequest;
|
|
1495
1495
|
/** Unmerges cells in a table. */
|
|
1496
1496
|
unmergeTableCells?: UnmergeTableCellsRequest;
|
|
1497
|
-
/** Updates an existing post (head post or reply) of a CommentThread or SuggestionThread.
|
|
1497
|
+
/** Updates an existing post (head post or reply) of a CommentThread or SuggestionThread. */
|
|
1498
1498
|
updateCommentPost?: UpdateCommentPostRequest;
|
|
1499
1499
|
/** Updates the style of the document. */
|
|
1500
1500
|
updateDocumentStyle?: UpdateDocumentStyleRequest;
|
|
@@ -1520,7 +1520,7 @@ declare namespace gapi.client {
|
|
|
1520
1520
|
updateTextStyle?: UpdateTextStyleRequest;
|
|
1521
1521
|
}
|
|
1522
1522
|
interface Response {
|
|
1523
|
-
/** The result of adding a reply to a comment or suggestion.
|
|
1523
|
+
/** The result of adding a reply to a comment or suggestion. */
|
|
1524
1524
|
addCommentReply?: AddCommentReplyResponse;
|
|
1525
1525
|
/** The result of adding a document tab. */
|
|
1526
1526
|
addDocumentTab?: AddDocumentTabResponse;
|
|
@@ -1534,7 +1534,7 @@ declare namespace gapi.client {
|
|
|
1534
1534
|
createHeader?: CreateHeaderResponse;
|
|
1535
1535
|
/** The result of creating a named range. */
|
|
1536
1536
|
createNamedRange?: CreateNamedRangeResponse;
|
|
1537
|
-
/** The result of inserting a comment.
|
|
1537
|
+
/** The result of inserting a comment. */
|
|
1538
1538
|
insertComment?: InsertCommentResponse;
|
|
1539
1539
|
/** The result of inserting a dropdown. */
|
|
1540
1540
|
insertDropdown?: InsertDropdownResponse;
|
|
@@ -2163,7 +2163,7 @@ declare namespace gapi.client {
|
|
|
2163
2163
|
requiredRevisionId?: string;
|
|
2164
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. */
|
|
2165
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.
|
|
2166
|
+
/** How the request updates should be applied to the document. If unspecified, the request updates will be applied as normal edits. */
|
|
2167
2167
|
writeMode?: 'WRITE_MODE_UNSPECIFIED' | 'EDIT' | 'SUGGEST';
|
|
2168
2168
|
}
|
|
2169
2169
|
interface DocumentsResource {
|
|
@@ -2289,7 +2289,7 @@ declare namespace gapi.client {
|
|
|
2289
2289
|
alt?: 'json' | 'media' | 'proto';
|
|
2290
2290
|
/** JSONP */
|
|
2291
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.
|
|
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. */
|
|
2293
2293
|
commentsViewMode?:
|
|
2294
2294
|
| 'COMMENTS_VIEW_MODE_UNSPECIFIED'
|
|
2295
2295
|
| 'COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS'
|