@googleapis/docs 0.2.0 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Changelog
 
+## [1.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/docs-v0.4.2...docs-v1.0.0) (2022-06-15)
+
+
+### ⚠ BREAKING CHANGES
+
+* This release has breaking changes.
+
+### Features
+
+* run the generator ([#2971](https://github.com/googleapis/google-api-nodejs-client/issues/2971)) ([adddf01](https://github.com/googleapis/google-api-nodejs-client/commit/adddf018e7cb73adab7341053dd80d72c5a6248d))
+
+### [0.4.2](https://github.com/googleapis/google-api-nodejs-client/compare/docs-v0.4.1...docs-v0.4.2) (2022-04-11)
+
+
+### Bug Fixes
+
+* **docs:** update the API ([4189154](https://github.com/googleapis/google-api-nodejs-client/commit/4189154feea1b67c29e05bd120a738a2356c2b71))
+
+### [0.4.1](https://github.com/googleapis/google-api-nodejs-client/compare/docs-v0.4.0...docs-v0.4.1) (2022-04-01)
+
+
+### Bug Fixes
+
+* **docs:** update the API ([644ab97](https://github.com/googleapis/google-api-nodejs-client/commit/644ab97c8136cfae8b9992ce68b6a3d5914d5a88))
+
+## [0.4.0](https://www.github.com/googleapis/google-api-nodejs-client/compare/docs-v0.3.0...docs-v0.4.0) (2021-09-14)
+
+
+### Features
+
+* **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))
+* **docs:** update the API ([4d84c10](https://www.github.com/googleapis/google-api-nodejs-client/commit/4d84c1075833ab7a155a68022a62e6c19dc1822b))
+* **docs:** update the API ([d854642](https://www.github.com/googleapis/google-api-nodejs-client/commit/d8546425ed347c70a702f38ea028ea163a8214ac))
+
+
+### Bug Fixes
+
+* **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))
+* **docs:** update the API ([d7a259c](https://www.github.com/googleapis/google-api-nodejs-client/commit/d7a259c33610a3892a71e38ee319743b7b4b36fc))
+* 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))
+
+## [0.3.0](https://www.github.com/googleapis/google-api-nodejs-client/compare/docs-v0.2.0...docs-v0.3.0) (2021-07-08)
+
+
+### Features
+
+* **docs:** update the API ([4d84c10](https://www.github.com/googleapis/google-api-nodejs-client/commit/4d84c1075833ab7a155a68022a62e6c19dc1822b))
+
 ## [0.2.0](https://www.github.com/googleapis/google-api-nodejs-client/compare/docs-v0.1.0...docs-v0.2.0) (2021-03-18)
 
 

package/README.md

@@ -7,37 +7,18 @@
 ## Installation
 
 ```sh
-$ npm install googleapis
+$ npm install @googleapis/docs
 ```
 
 ## Usage
 All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client).
-
-## Building a browser bundle
-
-This library can be used in a browser. To prepare a single file bundle, clone the
-[repository](https://github.com/googleapis/google-api-nodejs-client) and run
-
-```sh
-$ cd src/apis/docs
-$ npm install
-$ npm run webpack
-```
-
-The generated bundle will be written to `dist/docs.min.js`. Use it from your HTML file:
-
-```html
-<script src="/path/to/docs.min.js"></script>
-<script>
-const { docs, auth } = Docs;
-</script>
-```
+Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/docs/classes/Docs.html).
 
 ## License
-This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/master/LICENSE).
+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).
 
 ## Contributing
-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/master/.github/CONTRIBUTING.md).
+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).
 
 ## Questions/problems?
 * Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client).

package/build/v1.d.ts

@@ -222,7 +222,7 @@ export declare namespace docs_v1 {
         textStyle?: Schema$TextStyle;
     }
     /**
-     * Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if specificed, otherwise it is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned.
+     * 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.
      */
     export interface Schema$CreateFooterRequest {
         /**
@@ -266,7 +266,7 @@ export declare namespace docs_v1 {
         footnoteId?: string | null;
     }
     /**
-     * Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specificed, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned.
+     * 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.
      */
     export interface Schema$CreateHeaderRequest {
         /**
@@ -524,7 +524,7 @@ export declare namespace docs_v1 {
             [key: string]: Schema$PositionedObject;
         } | null;
         /**
-         * 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 may change over time, so it should be treated opaquely. 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.
+         * 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.
          */
         revisionId?: string | null;
         /**
@@ -1042,7 +1042,7 @@ export declare namespace docs_v1 {
          */
         inlineObjectProperties?: Schema$InlineObjectProperties;
         /**
-         * The ID of this inline object.
+         * The ID of this inline object. Can be used to update an object’s properties.
          */
         objectId?: string | null;
         /**
@@ -1633,6 +1633,10 @@ export declare namespace docs_v1 {
          * A paragraph element that links to a person or email address.
          */
         person?: Schema$Person;
+        /**
+         * A paragraph element that links to a Google resource (such as a file in Drive, a Youtube video, a Calendar event, etc.)
+         */
+        richLink?: Schema$RichLink;
         /**
          * The zero-based start index of this paragraph element, in UTF-16 code units.
          */
@@ -1710,6 +1714,10 @@ export declare namespace docs_v1 {
          * The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
          */
         namedStyleType?: string | null;
+        /**
+         * Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state which returns a 400 bad request error.
+         */
+        pageBreakBefore?: boolean | null;
         /**
          * The shading of the paragraph. If unset, the value is inherited from the parent.
          */
@@ -1799,6 +1807,10 @@ export declare namespace docs_v1 {
          * Indicates if there was a suggested change to named_style_type.
          */
         namedStyleTypeSuggested?: boolean | null;
+        /**
+         * Indicates if there was a suggested change to page_break_before.
+         */
+        pageBreakBeforeSuggested?: boolean | null;
         /**
          * A mask that indicates which of the fields in shading have been changed in this suggestion.
          */
@@ -1860,6 +1872,19 @@ export declare namespace docs_v1 {
          */
         name?: string | null;
     }
+    /**
+     * Updates the number of pinned table header rows in a table.
+     */
+    export interface Schema$PinTableHeaderRowsRequest {
+        /**
+         * The number of table rows to pin, where 0 implies that all rows are unpinned.
+         */
+        pinnedHeaderRowsCount?: number | null;
+        /**
+         * The location where the table starts in the document.
+         */
+        tableStartLocation?: Schema$Location;
+    }
     /**
      * An object that is tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.
      */
@@ -1991,7 +2016,7 @@ export declare namespace docs_v1 {
      */
     export interface Schema$ReplaceImageRequest {
         /**
-         * The ID of the existing image that will be replaced.
+         * The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request.
          */
         imageObjectId?: string | null;
         /**
@@ -1999,7 +2024,7 @@ export declare namespace docs_v1 {
          */
         imageReplaceMethod?: string | null;
         /**
-         * The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URI can be at most 2 kB in length. The URI itself is saved with the image, and exposed via the ImageProperties.source_uri field.
+         * The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.
          */
         uri?: string | null;
     }
@@ -2108,6 +2133,10 @@ export declare namespace docs_v1 {
          * Merges cells in a table.
          */
         mergeTableCells?: Schema$MergeTableCellsRequest;
+        /**
+         * Updates the number of pinned header rows in a table.
+         */
+        pinTableHeaderRows?: Schema$PinTableHeaderRowsRequest;
         /**
          * Replaces all instances of the specified text.
          */
@@ -2203,6 +2232,54 @@ export declare namespace docs_v1 {
          */
         red?: number | null;
     }
+    /**
+     * A link to a Google resource (e.g., a file in Drive, a YouTube video, a Calendar event, etc.).
+     */
+    export interface Schema$RichLink {
+        /**
+         * Output only. The ID of this link.
+         */
+        richLinkId?: string | null;
+        /**
+         * Output only. The properties of this RichLink. This field is always present.
+         */
+        richLinkProperties?: Schema$RichLinkProperties;
+        /**
+         * 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.
+         */
+        suggestedDeletionIds?: string[] | null;
+        /**
+         * 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.
+         */
+        suggestedInsertionIds?: string[] | null;
+        /**
+         * The suggested text style changes to this RichLink, keyed by suggestion ID.
+         */
+        suggestedTextStyleChanges?: {
+            [key: string]: Schema$SuggestedTextStyle;
+        } | null;
+        /**
+         * The text style of this RichLink.
+         */
+        textStyle?: Schema$TextStyle;
+    }
+    /**
+     * Properties specific to a RichLink.
+     */
+    export interface Schema$RichLinkProperties {
+        /**
+         * 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).
+         */
+        mimeType?: string | null;
+        /**
+         * 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.
+         */
+        title?: string | null;
+        /**
+         * Output only. The URI to the RichLink. This is always present.
+         */
+        uri?: string | null;
+    }
     /**
      * 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.
      */
@@ -2492,7 +2569,7 @@ export declare namespace docs_v1 {
      */
     export interface Schema$SuggestedParagraphStyle {
         /**
-         * A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_suggestion_state to see which fields have changed and their new values.
+         * A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
          */
         paragraphStyle?: Schema$ParagraphStyle;
         /**
@@ -2846,6 +2923,14 @@ export declare namespace docs_v1 {
          * The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
          */
         minRowHeight?: Schema$Dimension;
+        /**
+         * Whether the row cannot overflow across page or column boundaries.
+         */
+        preventOverflow?: boolean | null;
+        /**
+         * Whether the row is a table header.
+         */
+        tableHeader?: boolean | null;
     }
     /**
      * A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there is a new suggested value.
@@ -3030,7 +3115,7 @@ export declare namespace docs_v1 {
      */
     export interface Schema$UpdateParagraphStyleRequest {
         /**
-         * The fields that should be updated. At least one field must be specified. The root `paragraph_style` is implied and should not be specified. For example, to update the paragraph style's alignment property, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
+         * The fields that should be updated. At least one field must be specified. The root `paragraph_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 paragraph style's alignment property, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
          */
         fields?: string | null;
         /**
@@ -3157,11 +3242,11 @@ export declare namespace docs_v1 {
      */
     export interface Schema$WriteControl {
         /**
-         * The revision ID of the document that the write request will be applied to. If this is not the latest revision of the document, the request will not be processed and will return 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.
+         * 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.
          */
         requiredRevisionId?: string | null;
         /**
-         * The target revision ID of the document that the write request will be applied to. If collaborator changes have occurred after the document was read using the API, the changes produced by this write request will be transformed against the collaborator changes. This results in a new revision of the document which incorporates both the changes in the request and the collaborator changes, and the Docs server will resolve conflicting changes. When using `target_revision_id`, the API client can be thought of as another collaborator of the document. The target revision ID may only be used to write to recent versions of a document. If the target revision is too far behind the latest revision, the request will not be processed and will return a 400 bad request error and the request should be retried after reading the latest version of the document. In most cases a `revision_id` will remain valid for use as a target revision for several minutes after it is read, but for frequently-edited documents this window may be shorter.
+         * 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.
          */
         targetRevisionId?: string | null;
     }

package/build/v1.js.map

@@ -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,CAmlHvB;AAnlHD,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;IAugGD,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,EAnlHgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAmlHvB"}
+{"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,CAwqHvB;AAxqHD,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;IA4lGD,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,EAxqHgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAwqHvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@googleapis/docs",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "description": "docs",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -35,7 +35,7 @@
     "@microsoft/api-extractor": "^7.8.10",
     "gts": "^2.0.0",
     "null-loader": "^4.0.0",
-    "ts-loader": "^8.0.0",
+    "ts-loader": "^9.0.0",
     "typescript": "~3.7.0",
     "webpack": "^5.0.0",
     "webpack-cli": "^4.0.0"

package/v1.ts

@@ -276,7 +276,7 @@ export namespace docs_v1 {
     textStyle?: Schema$TextStyle;
   }
   /**
-   * Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if specificed, otherwise it is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned.
+   * 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.
    */
   export interface Schema$CreateFooterRequest {
     /**
@@ -320,7 +320,7 @@ export namespace docs_v1 {
     footnoteId?: string | null;
   }
   /**
-   * Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specificed, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned.
+   * 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.
    */
   export interface Schema$CreateHeaderRequest {
     /**
@@ -564,7 +564,7 @@ export namespace docs_v1 {
      */
     positionedObjects?: {[key: string]: Schema$PositionedObject} | null;
     /**
-     * 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 may change over time, so it should be treated opaquely. 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.
+     * 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.
      */
     revisionId?: string | null;
     /**
@@ -1080,7 +1080,7 @@ export namespace docs_v1 {
      */
     inlineObjectProperties?: Schema$InlineObjectProperties;
     /**
-     * The ID of this inline object.
+     * The ID of this inline object. Can be used to update an object’s properties.
      */
     objectId?: string | null;
     /**
@@ -1669,6 +1669,10 @@ export namespace docs_v1 {
      * A paragraph element that links to a person or email address.
      */
     person?: Schema$Person;
+    /**
+     * A paragraph element that links to a Google resource (such as a file in Drive, a Youtube video, a Calendar event, etc.)
+     */
+    richLink?: Schema$RichLink;
     /**
      * The zero-based start index of this paragraph element, in UTF-16 code units.
      */
@@ -1746,6 +1750,10 @@ export namespace docs_v1 {
      * The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
      */
     namedStyleType?: string | null;
+    /**
+     * Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state which returns a 400 bad request error.
+     */
+    pageBreakBefore?: boolean | null;
     /**
      * The shading of the paragraph. If unset, the value is inherited from the parent.
      */
@@ -1835,6 +1843,10 @@ export namespace docs_v1 {
      * Indicates if there was a suggested change to named_style_type.
      */
     namedStyleTypeSuggested?: boolean | null;
+    /**
+     * Indicates if there was a suggested change to page_break_before.
+     */
+    pageBreakBeforeSuggested?: boolean | null;
     /**
      * A mask that indicates which of the fields in shading have been changed in this suggestion.
      */
@@ -1896,6 +1908,19 @@ export namespace docs_v1 {
      */
     name?: string | null;
   }
+  /**
+   * Updates the number of pinned table header rows in a table.
+   */
+  export interface Schema$PinTableHeaderRowsRequest {
+    /**
+     * The number of table rows to pin, where 0 implies that all rows are unpinned.
+     */
+    pinnedHeaderRowsCount?: number | null;
+    /**
+     * The location where the table starts in the document.
+     */
+    tableStartLocation?: Schema$Location;
+  }
   /**
    * An object that is tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.
    */
@@ -2027,7 +2052,7 @@ export namespace docs_v1 {
    */
   export interface Schema$ReplaceImageRequest {
     /**
-     * The ID of the existing image that will be replaced.
+     * The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request.
      */
     imageObjectId?: string | null;
     /**
@@ -2035,7 +2060,7 @@ export namespace docs_v1 {
      */
     imageReplaceMethod?: string | null;
     /**
-     * The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URI can be at most 2 kB in length. The URI itself is saved with the image, and exposed via the ImageProperties.source_uri field.
+     * The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.
      */
     uri?: string | null;
   }
@@ -2144,6 +2169,10 @@ export namespace docs_v1 {
      * Merges cells in a table.
      */
     mergeTableCells?: Schema$MergeTableCellsRequest;
+    /**
+     * Updates the number of pinned header rows in a table.
+     */
+    pinTableHeaderRows?: Schema$PinTableHeaderRowsRequest;
     /**
      * Replaces all instances of the specified text.
      */
@@ -2239,6 +2268,54 @@ export namespace docs_v1 {
      */
     red?: number | null;
   }
+  /**
+   * A link to a Google resource (e.g., a file in Drive, a YouTube video, a Calendar event, etc.).
+   */
+  export interface Schema$RichLink {
+    /**
+     * Output only. The ID of this link.
+     */
+    richLinkId?: string | null;
+    /**
+     * Output only. The properties of this RichLink. This field is always present.
+     */
+    richLinkProperties?: Schema$RichLinkProperties;
+    /**
+     * 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.
+     */
+    suggestedDeletionIds?: string[] | null;
+    /**
+     * 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.
+     */
+    suggestedInsertionIds?: string[] | null;
+    /**
+     * The suggested text style changes to this RichLink, keyed by suggestion ID.
+     */
+    suggestedTextStyleChanges?: {
+      [key: string]: Schema$SuggestedTextStyle;
+    } | null;
+    /**
+     * The text style of this RichLink.
+     */
+    textStyle?: Schema$TextStyle;
+  }
+  /**
+   * Properties specific to a RichLink.
+   */
+  export interface Schema$RichLinkProperties {
+    /**
+     * 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).
+     */
+    mimeType?: string | null;
+    /**
+     * 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.
+     */
+    title?: string | null;
+    /**
+     * Output only. The URI to the RichLink. This is always present.
+     */
+    uri?: string | null;
+  }
   /**
    * 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.
    */
@@ -2528,7 +2605,7 @@ export namespace docs_v1 {
    */
   export interface Schema$SuggestedParagraphStyle {
     /**
-     * A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_suggestion_state to see which fields have changed and their new values.
+     * A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
      */
     paragraphStyle?: Schema$ParagraphStyle;
     /**
@@ -2882,6 +2959,14 @@ export namespace docs_v1 {
      * The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
      */
     minRowHeight?: Schema$Dimension;
+    /**
+     * Whether the row cannot overflow across page or column boundaries.
+     */
+    preventOverflow?: boolean | null;
+    /**
+     * Whether the row is a table header.
+     */
+    tableHeader?: boolean | null;
   }
   /**
    * A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there is a new suggested value.
@@ -3066,7 +3151,7 @@ export namespace docs_v1 {
    */
   export interface Schema$UpdateParagraphStyleRequest {
     /**
-     * The fields that should be updated. At least one field must be specified. The root `paragraph_style` is implied and should not be specified. For example, to update the paragraph style's alignment property, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
+     * The fields that should be updated. At least one field must be specified. The root `paragraph_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 paragraph style's alignment property, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset.
      */
     fields?: string | null;
     /**
@@ -3193,11 +3278,11 @@ export namespace docs_v1 {
    */
   export interface Schema$WriteControl {
     /**
-     * The revision ID of the document that the write request will be applied to. If this is not the latest revision of the document, the request will not be processed and will return 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.
+     * 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.
      */
     requiredRevisionId?: string | null;
     /**
-     * The target revision ID of the document that the write request will be applied to. If collaborator changes have occurred after the document was read using the API, the changes produced by this write request will be transformed against the collaborator changes. This results in a new revision of the document which incorporates both the changes in the request and the collaborator changes, and the Docs server will resolve conflicting changes. When using `target_revision_id`, the API client can be thought of as another collaborator of the document. The target revision ID may only be used to write to recent versions of a document. If the target revision is too far behind the latest revision, the request will not be processed and will return a 400 bad request error and the request should be retried after reading the latest version of the document. In most cases a `revision_id` will remain valid for use as a target revision for several minutes after it is read, but for frequently-edited documents this window may be shorter.
+     * 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.
      */
     targetRevisionId?: string | null;
   }