@googleapis/docs 0.2.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -0
- package/README.md +4 -23
- package/build/v1.d.ts +57 -5
- package/build/v1.js.map +1 -1
- package/package.json +2 -2
- package/v1.ts +57 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
### [0.4.1](https://github.com/googleapis/google-api-nodejs-client/compare/docs-v0.4.0...docs-v0.4.1) (2022-04-01)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* **docs:** update the API ([644ab97](https://github.com/googleapis/google-api-nodejs-client/commit/644ab97c8136cfae8b9992ce68b6a3d5914d5a88))
|
|
9
|
+
|
|
10
|
+
## [0.4.0](https://www.github.com/googleapis/google-api-nodejs-client/compare/docs-v0.3.0...docs-v0.4.0) (2021-09-14)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* **auth:** adds support workload identity federation ([#2517](https://www.github.com/googleapis/google-api-nodejs-client/issues/2517)) ([a10707c](https://www.github.com/googleapis/google-api-nodejs-client/commit/a10707c477759e7c9ef6360a2fe800856fb600c1))
|
|
16
|
+
* **docs:** update the API ([4d84c10](https://www.github.com/googleapis/google-api-nodejs-client/commit/4d84c1075833ab7a155a68022a62e6c19dc1822b))
|
|
17
|
+
* **docs:** update the API ([d854642](https://www.github.com/googleapis/google-api-nodejs-client/commit/d8546425ed347c70a702f38ea028ea163a8214ac))
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Bug Fixes
|
|
21
|
+
|
|
22
|
+
* **deps:** update dependency googleapis-common to v5 ([#2497](https://www.github.com/googleapis/google-api-nodejs-client/issues/2497)) ([fec087a](https://www.github.com/googleapis/google-api-nodejs-client/commit/fec087abcf3d994dd41c3ffa0a0c12b1f9f09dae))
|
|
23
|
+
* **docs:** update the API ([d7a259c](https://www.github.com/googleapis/google-api-nodejs-client/commit/d7a259c33610a3892a71e38ee319743b7b4b36fc))
|
|
24
|
+
* upgrade webpack from 4 to 5 ([#2524](https://www.github.com/googleapis/google-api-nodejs-client/issues/2524)) ([ecfd8bf](https://www.github.com/googleapis/google-api-nodejs-client/commit/ecfd8bfcd06e1beabff7ec9a8c4000222379eb8d))
|
|
25
|
+
|
|
26
|
+
## [0.3.0](https://www.github.com/googleapis/google-api-nodejs-client/compare/docs-v0.2.0...docs-v0.3.0) (2021-07-08)
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
### Features
|
|
30
|
+
|
|
31
|
+
* **docs:** update the API ([4d84c10](https://www.github.com/googleapis/google-api-nodejs-client/commit/4d84c1075833ab7a155a68022a62e6c19dc1822b))
|
|
32
|
+
|
|
3
33
|
## [0.2.0](https://www.github.com/googleapis/google-api-nodejs-client/compare/docs-v0.1.0...docs-v0.2.0) (2021-03-18)
|
|
4
34
|
|
|
5
35
|
|
package/README.md
CHANGED
|
@@ -7,37 +7,18 @@
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
9
9
|
```sh
|
|
10
|
-
$ npm install googleapis
|
|
10
|
+
$ npm install @googleapis/docs
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Usage
|
|
14
14
|
All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client).
|
|
15
|
-
|
|
16
|
-
## Building a browser bundle
|
|
17
|
-
|
|
18
|
-
This library can be used in a browser. To prepare a single file bundle, clone the
|
|
19
|
-
[repository](https://github.com/googleapis/google-api-nodejs-client) and run
|
|
20
|
-
|
|
21
|
-
```sh
|
|
22
|
-
$ cd src/apis/docs
|
|
23
|
-
$ npm install
|
|
24
|
-
$ npm run webpack
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
The generated bundle will be written to `dist/docs.min.js`. Use it from your HTML file:
|
|
28
|
-
|
|
29
|
-
```html
|
|
30
|
-
<script src="/path/to/docs.min.js"></script>
|
|
31
|
-
<script>
|
|
32
|
-
const { docs, auth } = Docs;
|
|
33
|
-
</script>
|
|
34
|
-
```
|
|
15
|
+
Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/docs/classes/Docs.html).
|
|
35
16
|
|
|
36
17
|
## License
|
|
37
|
-
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/
|
|
18
|
+
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE).
|
|
38
19
|
|
|
39
20
|
## Contributing
|
|
40
|
-
We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/
|
|
21
|
+
We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md).
|
|
41
22
|
|
|
42
23
|
## Questions/problems?
|
|
43
24
|
* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client).
|
package/build/v1.d.ts
CHANGED
|
@@ -222,7 +222,7 @@ export declare namespace docs_v1 {
|
|
|
222
222
|
textStyle?: Schema$TextStyle;
|
|
223
223
|
}
|
|
224
224
|
/**
|
|
225
|
-
* Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if
|
|
225
|
+
* 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.
|
|
226
226
|
*/
|
|
227
227
|
export interface Schema$CreateFooterRequest {
|
|
228
228
|
/**
|
|
@@ -266,7 +266,7 @@ export declare namespace docs_v1 {
|
|
|
266
266
|
footnoteId?: string | null;
|
|
267
267
|
}
|
|
268
268
|
/**
|
|
269
|
-
* Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if
|
|
269
|
+
* Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned.
|
|
270
270
|
*/
|
|
271
271
|
export interface Schema$CreateHeaderRequest {
|
|
272
272
|
/**
|
|
@@ -524,7 +524,7 @@ export declare namespace docs_v1 {
|
|
|
524
524
|
[key: string]: Schema$PositionedObject;
|
|
525
525
|
} | null;
|
|
526
526
|
/**
|
|
527
|
-
* Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The format of the revision ID
|
|
527
|
+
* Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes.
|
|
528
528
|
*/
|
|
529
529
|
revisionId?: string | null;
|
|
530
530
|
/**
|
|
@@ -1633,6 +1633,10 @@ export declare namespace docs_v1 {
|
|
|
1633
1633
|
* A paragraph element that links to a person or email address.
|
|
1634
1634
|
*/
|
|
1635
1635
|
person?: Schema$Person;
|
|
1636
|
+
/**
|
|
1637
|
+
* A paragraph element that links to a Google resource (such as a file in Drive, a Youtube video, a Calendar event, etc.)
|
|
1638
|
+
*/
|
|
1639
|
+
richLink?: Schema$RichLink;
|
|
1636
1640
|
/**
|
|
1637
1641
|
* The zero-based start index of this paragraph element, in UTF-16 code units.
|
|
1638
1642
|
*/
|
|
@@ -2203,6 +2207,54 @@ export declare namespace docs_v1 {
|
|
|
2203
2207
|
*/
|
|
2204
2208
|
red?: number | null;
|
|
2205
2209
|
}
|
|
2210
|
+
/**
|
|
2211
|
+
* A link to a Google resource (e.g., a file in Drive, a YouTube video, a Calendar event, etc.).
|
|
2212
|
+
*/
|
|
2213
|
+
export interface Schema$RichLink {
|
|
2214
|
+
/**
|
|
2215
|
+
* Output only. The ID of this link.
|
|
2216
|
+
*/
|
|
2217
|
+
richLinkId?: string | null;
|
|
2218
|
+
/**
|
|
2219
|
+
* Output only. The properties of this RichLink. This field is always present.
|
|
2220
|
+
*/
|
|
2221
|
+
richLinkProperties?: Schema$RichLinkProperties;
|
|
2222
|
+
/**
|
|
2223
|
+
* IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest to delete it. If empty, then this person link isn't suggested for deletion.
|
|
2224
|
+
*/
|
|
2225
|
+
suggestedDeletionIds?: string[] | null;
|
|
2226
|
+
/**
|
|
2227
|
+
* IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it is a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
|
|
2228
|
+
*/
|
|
2229
|
+
suggestedInsertionIds?: string[] | null;
|
|
2230
|
+
/**
|
|
2231
|
+
* The suggested text style changes to this RichLink, keyed by suggestion ID.
|
|
2232
|
+
*/
|
|
2233
|
+
suggestedTextStyleChanges?: {
|
|
2234
|
+
[key: string]: Schema$SuggestedTextStyle;
|
|
2235
|
+
} | null;
|
|
2236
|
+
/**
|
|
2237
|
+
* The text style of this RichLink.
|
|
2238
|
+
*/
|
|
2239
|
+
textStyle?: Schema$TextStyle;
|
|
2240
|
+
}
|
|
2241
|
+
/**
|
|
2242
|
+
* Properties specific to a RichLink.
|
|
2243
|
+
*/
|
|
2244
|
+
export interface Schema$RichLinkProperties {
|
|
2245
|
+
/**
|
|
2246
|
+
* Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there is one (i.e., when it is a file in Drive).
|
|
2247
|
+
*/
|
|
2248
|
+
mimeType?: string | null;
|
|
2249
|
+
/**
|
|
2250
|
+
* Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
|
|
2251
|
+
*/
|
|
2252
|
+
title?: string | null;
|
|
2253
|
+
/**
|
|
2254
|
+
* Output only. The URI to the RichLink. This is always present.
|
|
2255
|
+
*/
|
|
2256
|
+
uri?: string | null;
|
|
2257
|
+
}
|
|
2206
2258
|
/**
|
|
2207
2259
|
* A StructuralElement representing a section break. A section is a range of content which has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break.
|
|
2208
2260
|
*/
|
|
@@ -3157,11 +3209,11 @@ export declare namespace docs_v1 {
|
|
|
3157
3209
|
*/
|
|
3158
3210
|
export interface Schema$WriteControl {
|
|
3159
3211
|
/**
|
|
3160
|
-
* The revision ID of the document
|
|
3212
|
+
* The optional revision ID of the document the write request is applied to. If this is not the latest revision of the document, the request is not processed and returns a 400 bad request error. When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied.
|
|
3161
3213
|
*/
|
|
3162
3214
|
requiredRevisionId?: string | null;
|
|
3163
3215
|
/**
|
|
3164
|
-
* The target revision ID of the document
|
|
3216
|
+
* 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.
|
|
3165
3217
|
*/
|
|
3166
3218
|
targetRevisionId?: string | null;
|
|
3167
3219
|
}
|
package/build/v1.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"v1.js","sourceRoot":"","sources":["../v1.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,gDAAgD;AAChD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;AAEjC,uDAAuD;AACvD,yDAAyD;AACzD,sDAAsD;AACtD,0DAA0D;AAC1D,oDAAoD;AACpD,4CAA4C;AAE5C,yDAe2B;AAG3B,IAAiB,OAAO,
|
|
1
|
+
{"version":3,"file":"v1.js","sourceRoot":"","sources":["../v1.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,gDAAgD;AAChD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;AAEjC,uDAAuD;AACvD,yDAAyD;AACzD,sDAAsD;AACtD,0DAA0D;AAC1D,oDAAoD;AACpD,4CAA4C;AAE5C,yDAe2B;AAG3B,IAAiB,OAAO,CAuoHvB;AAvoHD,WAAiB,OAAO;IAgEtB;;;;;;;;;;OAUG;IACH,MAAa,IAAI;QAIf,YAAY,OAAsB,EAAE,MAA2B;YAC7D,IAAI,CAAC,OAAO,GAAG;gBACb,QAAQ,EAAE,OAAO,IAAI,EAAE;gBACvB,MAAM;aACP,CAAC;YAEF,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC;KACF;IAZY,YAAI,OAYhB,CAAA;IA2jGD,MAAa,kBAAkB;QAE7B,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QA8FD,WAAW,CACT,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB;gBAC5B,EAAE,CAA0C,CAAC;YAC/C,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE;gBAC1C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAA2C,CAAC;gBACrD,OAAO,GAAG,EAAE,CAAC;aACd;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;gBAC3C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;aACd;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,8BAA8B,CAAC;YAClE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,wCAAwC,CAAC,CAAC,OAAO,CAC/D,cAAc,EACd,IAAI,CACL;oBACD,MAAM,EAAE,MAAM;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,YAAY,CAAC;gBAC9B,UAAU,EAAE,CAAC,YAAY,CAAC;gBAC1B,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE;gBACZ,oCAAgB,CACd,UAAU,EACV,QAAyC,CAC1C,CAAC;aACH;iBAAM;gBACL,OAAO,oCAAgB,CAAqC,UAAU,CAAC,CAAC;aACzE;QACH,CAAC;QAkHD,MAAM,CACJ,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAElC,IAAI,MAAM,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAqC,CAAC;YAC1E,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE;gBAC1C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAAsC,CAAC;gBAChD,OAAO,GAAG,EAAE,CAAC;aACd;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;gBAC3C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;aACd;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,8BAA8B,CAAC;YAClE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,eAAe,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC;oBAC9D,MAAM,EAAE,MAAM;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,EAAE;gBAClB,UAAU,EAAE,EAAE;gBACd,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE;gBACZ,oCAAgB,CACd,UAAU,EACV,QAAyC,CAC1C,CAAC;aACH;iBAAM;gBACL,OAAO,oCAAgB,CAAkB,UAAU,CAAC,CAAC;aACtD;QACH,CAAC;QAkGD,GAAG,CACD,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAElC,IAAI,MAAM,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAkC,CAAC;YACvE,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE;gBAC1C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAAmC,CAAC;gBAC7C,OAAO,GAAG,EAAE,CAAC;aACd;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;gBAC3C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;aACd;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,8BAA8B,CAAC;YAClE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,4BAA4B,CAAC,CAAC,OAAO,CACnD,cAAc,EACd,IAAI,CACL;oBACD,MAAM,EAAE,KAAK;iBACd,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,CAAC,YAAY,CAAC;gBAC9B,UAAU,EAAE,CAAC,YAAY,CAAC;gBAC1B,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE;gBACZ,oCAAgB,CACd,UAAU,EACV,QAAyC,CAC1C,CAAC;aACH;iBAAM;gBACL,OAAO,oCAAgB,CAAkB,UAAU,CAAC,CAAC;aACtD;QACH,CAAC;KACF;IAvdY,0BAAkB,qBAud9B,CAAA;AA8BH,CAAC,EAvoHgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAuoHvB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@googleapis/docs",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.1",
|
|
4
4
|
"description": "docs",
|
|
5
5
|
"main": "build/index.js",
|
|
6
6
|
"types": "build/index.d.ts",
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"@microsoft/api-extractor": "^7.8.10",
|
|
36
36
|
"gts": "^2.0.0",
|
|
37
37
|
"null-loader": "^4.0.0",
|
|
38
|
-
"ts-loader": "^
|
|
38
|
+
"ts-loader": "^9.0.0",
|
|
39
39
|
"typescript": "~3.7.0",
|
|
40
40
|
"webpack": "^5.0.0",
|
|
41
41
|
"webpack-cli": "^4.0.0"
|
package/v1.ts
CHANGED
|
@@ -276,7 +276,7 @@ export namespace docs_v1 {
|
|
|
276
276
|
textStyle?: Schema$TextStyle;
|
|
277
277
|
}
|
|
278
278
|
/**
|
|
279
|
-
* Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if
|
|
279
|
+
* 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.
|
|
280
280
|
*/
|
|
281
281
|
export interface Schema$CreateFooterRequest {
|
|
282
282
|
/**
|
|
@@ -320,7 +320,7 @@ export namespace docs_v1 {
|
|
|
320
320
|
footnoteId?: string | null;
|
|
321
321
|
}
|
|
322
322
|
/**
|
|
323
|
-
* Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if
|
|
323
|
+
* Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned.
|
|
324
324
|
*/
|
|
325
325
|
export interface Schema$CreateHeaderRequest {
|
|
326
326
|
/**
|
|
@@ -564,7 +564,7 @@ export namespace docs_v1 {
|
|
|
564
564
|
*/
|
|
565
565
|
positionedObjects?: {[key: string]: Schema$PositionedObject} | null;
|
|
566
566
|
/**
|
|
567
|
-
* Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The format of the revision ID
|
|
567
|
+
* Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes.
|
|
568
568
|
*/
|
|
569
569
|
revisionId?: string | null;
|
|
570
570
|
/**
|
|
@@ -1669,6 +1669,10 @@ export namespace docs_v1 {
|
|
|
1669
1669
|
* A paragraph element that links to a person or email address.
|
|
1670
1670
|
*/
|
|
1671
1671
|
person?: Schema$Person;
|
|
1672
|
+
/**
|
|
1673
|
+
* A paragraph element that links to a Google resource (such as a file in Drive, a Youtube video, a Calendar event, etc.)
|
|
1674
|
+
*/
|
|
1675
|
+
richLink?: Schema$RichLink;
|
|
1672
1676
|
/**
|
|
1673
1677
|
* The zero-based start index of this paragraph element, in UTF-16 code units.
|
|
1674
1678
|
*/
|
|
@@ -2239,6 +2243,54 @@ export namespace docs_v1 {
|
|
|
2239
2243
|
*/
|
|
2240
2244
|
red?: number | null;
|
|
2241
2245
|
}
|
|
2246
|
+
/**
|
|
2247
|
+
* A link to a Google resource (e.g., a file in Drive, a YouTube video, a Calendar event, etc.).
|
|
2248
|
+
*/
|
|
2249
|
+
export interface Schema$RichLink {
|
|
2250
|
+
/**
|
|
2251
|
+
* Output only. The ID of this link.
|
|
2252
|
+
*/
|
|
2253
|
+
richLinkId?: string | null;
|
|
2254
|
+
/**
|
|
2255
|
+
* Output only. The properties of this RichLink. This field is always present.
|
|
2256
|
+
*/
|
|
2257
|
+
richLinkProperties?: Schema$RichLinkProperties;
|
|
2258
|
+
/**
|
|
2259
|
+
* IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest to delete it. If empty, then this person link isn't suggested for deletion.
|
|
2260
|
+
*/
|
|
2261
|
+
suggestedDeletionIds?: string[] | null;
|
|
2262
|
+
/**
|
|
2263
|
+
* IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it is a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
|
|
2264
|
+
*/
|
|
2265
|
+
suggestedInsertionIds?: string[] | null;
|
|
2266
|
+
/**
|
|
2267
|
+
* The suggested text style changes to this RichLink, keyed by suggestion ID.
|
|
2268
|
+
*/
|
|
2269
|
+
suggestedTextStyleChanges?: {
|
|
2270
|
+
[key: string]: Schema$SuggestedTextStyle;
|
|
2271
|
+
} | null;
|
|
2272
|
+
/**
|
|
2273
|
+
* The text style of this RichLink.
|
|
2274
|
+
*/
|
|
2275
|
+
textStyle?: Schema$TextStyle;
|
|
2276
|
+
}
|
|
2277
|
+
/**
|
|
2278
|
+
* Properties specific to a RichLink.
|
|
2279
|
+
*/
|
|
2280
|
+
export interface Schema$RichLinkProperties {
|
|
2281
|
+
/**
|
|
2282
|
+
* Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there is one (i.e., when it is a file in Drive).
|
|
2283
|
+
*/
|
|
2284
|
+
mimeType?: string | null;
|
|
2285
|
+
/**
|
|
2286
|
+
* Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
|
|
2287
|
+
*/
|
|
2288
|
+
title?: string | null;
|
|
2289
|
+
/**
|
|
2290
|
+
* Output only. The URI to the RichLink. This is always present.
|
|
2291
|
+
*/
|
|
2292
|
+
uri?: string | null;
|
|
2293
|
+
}
|
|
2242
2294
|
/**
|
|
2243
2295
|
* A StructuralElement representing a section break. A section is a range of content which has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break.
|
|
2244
2296
|
*/
|
|
@@ -3193,11 +3245,11 @@ export namespace docs_v1 {
|
|
|
3193
3245
|
*/
|
|
3194
3246
|
export interface Schema$WriteControl {
|
|
3195
3247
|
/**
|
|
3196
|
-
* The revision ID of the document
|
|
3248
|
+
* The optional revision ID of the document the write request is applied to. If this is not the latest revision of the document, the request is not processed and returns a 400 bad request error. When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied.
|
|
3197
3249
|
*/
|
|
3198
3250
|
requiredRevisionId?: string | null;
|
|
3199
3251
|
/**
|
|
3200
|
-
* The target revision ID of the document
|
|
3252
|
+
* 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.
|
|
3201
3253
|
*/
|
|
3202
3254
|
targetRevisionId?: string | null;
|
|
3203
3255
|
}
|