@maxim_mazurok/gapi.client.docs-v1 0.0.20221004 → 0.0.20221013

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.
Files changed (3) hide show
  1. package/index.d.ts +86 -84
  2. package/package.json +1 -1
  3. package/tests.ts +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: 20221004
12
+ // Revision: 20221013
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -25,7 +25,7 @@ declare namespace gapi.client {
25
25
  interface AutoText {
26
26
  /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
27
27
  suggestedDeletionIds?: string[];
28
- /** The suggested insertion IDs. An AutoText may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
28
+ /** The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
29
29
  suggestedInsertionIds?: string[];
30
30
  /** The suggested text style changes to this AutoText, keyed by suggestion ID. */
31
31
  suggestedTextStyleChanges?: { [P in string]: SuggestedTextStyle };
@@ -65,7 +65,7 @@ declare namespace gapi.client {
65
65
  listId?: string;
66
66
  /** The nesting level of this paragraph in the list. */
67
67
  nestingLevel?: number;
68
- /** The paragraph specific text style applied to this bullet. */
68
+ /** The paragraph-specific text style applied to this bullet. */
69
69
  textStyle?: TextStyle;
70
70
  }
71
71
  interface BulletSuggestionState {
@@ -83,13 +83,13 @@ declare namespace gapi.client {
83
83
  interface ColumnBreak {
84
84
  /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
85
85
  suggestedDeletionIds?: string[];
86
- /** The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
86
+ /** The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
87
87
  suggestedInsertionIds?: string[];
88
88
  /** The suggested text style changes to this ColumnBreak, keyed by suggestion ID. */
89
89
  suggestedTextStyleChanges?: { [P in string]: SuggestedTextStyle };
90
90
  /**
91
91
  * 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
92
- * styling of text inserted adjacent to it.
92
+ * styling of text inserted next to it.
93
93
  */
94
94
  textStyle?: TextStyle;
95
95
  }
@@ -277,28 +277,28 @@ declare namespace gapi.client {
277
277
  interface DocumentStyle {
278
278
  /** The background of the document. Documents cannot have a transparent background color. */
279
279
  background?: Background;
280
- /** The ID of the default footer. If not set, there is no default footer. This property is read-only. */
280
+ /** The ID of the default footer. If not set, there's no default footer. This property is read-only. */
281
281
  defaultFooterId?: string;
282
- /** The ID of the default header. If not set, there is no default header. This property is read-only. */
282
+ /** The ID of the default header. If not set, there's no default header. This property is read-only. */
283
283
  defaultHeaderId?: string;
284
284
  /**
285
285
  * The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages.
286
- * If not set, there is no even page footer. This property is read-only.
286
+ * If not set, there's no even page footer. This property is read-only.
287
287
  */
288
288
  evenPageFooterId?: string;
289
289
  /**
290
290
  * The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages.
291
- * If not set, there is no even page header. This property is read-only.
291
+ * If not set, there's no even page header. This property is read-only.
292
292
  */
293
293
  evenPageHeaderId?: string;
294
294
  /**
295
295
  * The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to
296
- * use the default_footer_id or this value for the footer on the first page. If not set, there is no first page footer. This property is read-only.
296
+ * use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only.
297
297
  */
298
298
  firstPageFooterId?: string;
299
299
  /**
300
300
  * The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to
301
- * use the default_header_id or this value for the header on the first page. If not set, there is no first page header. This property is read-only.
301
+ * use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only.
302
302
  */
303
303
  firstPageHeaderId?: string;
304
304
  /** The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. */
@@ -381,8 +381,8 @@ declare namespace gapi.client {
381
381
  /** The properties of an image. */
382
382
  imageProperties?: ImageProperties;
383
383
  /**
384
- * A reference to the external linked source content. For example, it contains a reference to the source Sheets chart when the embedded object is a linked chart. If unset, then the
385
- * embedded object is not linked.
384
+ * A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then
385
+ * the embedded object is not linked.
386
386
  */
387
387
  linkedContentReference?: LinkedContentReference;
388
388
  /** The bottom margin of the embedded object. */
@@ -449,7 +449,7 @@ declare namespace gapi.client {
449
449
  interface Equation {
450
450
  /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
451
451
  suggestedDeletionIds?: string[];
452
- /** The suggested insertion IDs. A Equation may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
452
+ /** The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
453
453
  suggestedInsertionIds?: string[];
454
454
  }
455
455
  interface Footer {
@@ -471,7 +471,7 @@ declare namespace gapi.client {
471
471
  footnoteNumber?: string;
472
472
  /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
473
473
  suggestedDeletionIds?: string[];
474
- /** The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
474
+ /** The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
475
475
  suggestedInsertionIds?: string[];
476
476
  /** The suggested text style changes to this FootnoteReference, keyed by suggestion ID. */
477
477
  suggestedTextStyleChanges?: { [P in string]: SuggestedTextStyle };
@@ -493,7 +493,7 @@ declare namespace gapi.client {
493
493
  suggestedTextStyleChanges?: { [P in string]: SuggestedTextStyle };
494
494
  /**
495
495
  * The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the
496
- * styling of text inserted adjacent to it.
496
+ * styling of text inserted next to it.
497
497
  */
498
498
  textStyle?: TextStyle;
499
499
  }
@@ -513,7 +513,7 @@ declare namespace gapi.client {
513
513
  cropProperties?: CropProperties;
514
514
  /** The source URI is the URI used to insert the image. The source URI can be empty. */
515
515
  sourceUri?: string;
516
- /** The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. */
516
+ /** The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. */
517
517
  transparency?: number;
518
518
  }
519
519
  interface ImagePropertiesSuggestionState {
@@ -549,13 +549,13 @@ declare namespace gapi.client {
549
549
  inlineObjectId?: string;
550
550
  /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
551
551
  suggestedDeletionIds?: string[];
552
- /** The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
552
+ /** The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
553
553
  suggestedInsertionIds?: string[];
554
554
  /** The suggested text style changes to this InlineObject, keyed by suggestion ID. */
555
555
  suggestedTextStyleChanges?: { [P in string]: SuggestedTextStyle };
556
556
  /**
557
557
  * The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as
558
- * well as the styling of text inserted adjacent to it.
558
+ * well as the styling of text inserted next to it.
559
559
  */
560
560
  textStyle?: TextStyle;
561
561
  }
@@ -703,8 +703,8 @@ declare namespace gapi.client {
703
703
  }
704
704
  interface ListProperties {
705
705
  /**
706
- * Describes the properties of the bullets at the associated level. A list has at most nine levels of nesting with nesting level 0 corresponding to the top-most level and nesting level
707
- * 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
706
+ * Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8
707
+ * corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
708
708
  */
709
709
  nestingLevels?: NestingLevel[];
710
710
  }
@@ -752,13 +752,13 @@ declare namespace gapi.client {
752
752
  textStyle?: TextStyle;
753
753
  }
754
754
  interface NamedStyles {
755
- /** The named styles. There is an entry for each of the possible named style types. */
755
+ /** The named styles. There's an entry for each of the possible named style types. */
756
756
  styles?: NamedStyle[];
757
757
  }
758
758
  interface NamedStylesSuggestionState {
759
759
  /**
760
- * A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states match the
761
- * order of the corresponding named style within the named styles suggestion.
760
+ * A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches
761
+ * the order of the corresponding named style within the named styles suggestion.
762
762
  */
763
763
  stylesSuggestionStates?: NamedStyleSuggestionState[];
764
764
  }
@@ -774,7 +774,7 @@ declare namespace gapi.client {
774
774
  /** The alignment of the bullet within the space allotted for rendering the bullet. */
775
775
  bulletAlignment?: string;
776
776
  /**
777
- * The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholder are replaced with the appropriate values
777
+ * The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values
778
778
  * depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format
779
779
  * follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered
780
780
  * glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format
@@ -800,8 +800,8 @@ declare namespace gapi.client {
800
800
  /** The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. */
801
801
  indentStart?: Dimension;
802
802
  /**
803
- * The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and roman numeraled lists, i.e. for values of both 0 and 1,
804
- * lettered and roman numeraled lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
803
+ * The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and
804
+ * Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
805
805
  */
806
806
  startNumber?: number;
807
807
  /** The text style of bullets at this level of nesting. */
@@ -836,20 +836,20 @@ declare namespace gapi.client {
836
836
  interface PageBreak {
837
837
  /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
838
838
  suggestedDeletionIds?: string[];
839
- /** The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
839
+ /** The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
840
840
  suggestedInsertionIds?: string[];
841
841
  /** The suggested text style changes to this PageBreak, keyed by suggestion ID. */
842
842
  suggestedTextStyleChanges?: { [P in string]: SuggestedTextStyle };
843
843
  /**
844
844
  * The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of
845
- * text inserted adjacent to it.
845
+ * text inserted next to it.
846
846
  */
847
847
  textStyle?: TextStyle;
848
848
  }
849
849
  interface Paragraph {
850
850
  /** The bullet for this paragraph. If not present, the paragraph does not belong to a list. */
851
851
  bullet?: Bullet;
852
- /** The content of the paragraph broken down into its component parts. */
852
+ /** The content of the paragraph, broken down into its component parts. */
853
853
  elements?: ParagraphElement[];
854
854
  /** The style of this paragraph. */
855
855
  paragraphStyle?: ParagraphStyle;
@@ -859,7 +859,7 @@ declare namespace gapi.client {
859
859
  suggestedBulletChanges?: { [P in string]: SuggestedBullet };
860
860
  /** The suggested paragraph style changes to this paragraph, keyed by suggestion ID. */
861
861
  suggestedParagraphStyleChanges?: { [P in string]: SuggestedParagraphStyle };
862
- /** The IDs of the positioned objects that are suggested to be attached to this paragraph, keyed by suggestion ID. */
862
+ /** The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. */
863
863
  suggestedPositionedObjectIds?: { [P in string]: ObjectReferences };
864
864
  }
865
865
  interface ParagraphBorder {
@@ -891,7 +891,7 @@ declare namespace gapi.client {
891
891
  pageBreak?: PageBreak;
892
892
  /** A paragraph element that links to a person or email address. */
893
893
  person?: Person;
894
- /** A paragraph element that links to a Google resource (such as a file in Drive, a Youtube video, a Calendar event, etc.) */
894
+ /** A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) */
895
895
  richLink?: RichLink;
896
896
  /** The zero-based start index of this paragraph element, in UTF-16 code units. */
897
897
  startIndex?: number;
@@ -905,27 +905,27 @@ declare namespace gapi.client {
905
905
  avoidWidowAndOrphan?: boolean;
906
906
  /**
907
907
  * The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph
908
- * has the same border and indent properties. Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety.
908
+ * has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
909
909
  */
910
910
  borderBetween?: ParagraphBorder;
911
911
  /**
912
912
  * The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent
913
- * properties. Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety.
913
+ * properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
914
914
  */
915
915
  borderBottom?: ParagraphBorder;
916
916
  /**
917
- * The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When making changes to a paragraph border
918
- * the new border must be specified in its entirety.
917
+ * The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new
918
+ * border must be specified in its entirety.
919
919
  */
920
920
  borderLeft?: ParagraphBorder;
921
921
  /**
922
- * The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When making changes to a paragraph border
923
- * the new border must be specified in its entirety.
922
+ * The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new
923
+ * border must be specified in its entirety.
924
924
  */
925
925
  borderRight?: ParagraphBorder;
926
926
  /**
927
927
  * The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent
928
- * properties. Paragraph borders cannot be partially updated. When making changes to a paragraph border the new border must be specified in its entirety.
928
+ * properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
929
929
  */
930
930
  borderTop?: ParagraphBorder;
931
931
  /** The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. */
@@ -957,7 +957,7 @@ declare namespace gapi.client {
957
957
  namedStyleType?: string;
958
958
  /**
959
959
  * 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
960
- * in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state which returns a 400 bad request error.
960
+ * in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
961
961
  */
962
962
  pageBreakBefore?: boolean;
963
963
  /** The shading of the paragraph. If unset, the value is inherited from the parent. */
@@ -1021,12 +1021,12 @@ declare namespace gapi.client {
1021
1021
  /** Output only. The properties of this Person. This field is always present. */
1022
1022
  personProperties?: PersonProperties;
1023
1023
  /**
1024
- * IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest to delete it. If empty, then
1024
+ * IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then
1025
1025
  * this person link isn't suggested for deletion.
1026
1026
  */
1027
1027
  suggestedDeletionIds?: string[];
1028
1028
  /**
1029
- * IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it is a nested suggested change (a suggestion within a suggestion
1029
+ * IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion
1030
1030
  * made by a different user, for example). If empty, then this person link isn't a suggested insertion.
1031
1031
  */
1032
1032
  suggestedInsertionIds?: string[];
@@ -1038,7 +1038,7 @@ declare namespace gapi.client {
1038
1038
  interface PersonProperties {
1039
1039
  /** Output only. The email address linked to this Person. This field is always present. */
1040
1040
  email?: string;
1041
- /** Output only. The name of the person if it is displayed in the link text instead of the person's email address. */
1041
+ /** Output only. The name of the person if it's displayed in the link text instead of the person's email address. */
1042
1042
  name?: string;
1043
1043
  }
1044
1044
  interface PinTableHeaderRowsRequest {
@@ -1063,12 +1063,12 @@ declare namespace gapi.client {
1063
1063
  /** The layout of this positioned object. */
1064
1064
  layout?: string;
1065
1065
  /**
1066
- * The offset of the left edge of the positioned object relative to the beginning of the Paragraph it is tethered to. The exact positioning of the object can depend on other content in
1066
+ * The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in
1067
1067
  * the document and the document's styling.
1068
1068
  */
1069
1069
  leftOffset?: Dimension;
1070
1070
  /**
1071
- * The offset of the top edge of the positioned object relative to the beginning of the Paragraph it is tethered to. The exact positioning of the object can depend on other content in
1071
+ * The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in
1072
1072
  * the document and the document's styling.
1073
1073
  */
1074
1074
  topOffset?: Dimension;
@@ -1099,7 +1099,7 @@ declare namespace gapi.client {
1099
1099
  * future use cases with open-ended ranges.
1100
1100
  */
1101
1101
  endIndex?: number;
1102
- /** The ID of the header, footer or footnote that this range is contained in. An empty segment ID signifies the document's body. */
1102
+ /** The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. */
1103
1103
  segmentId?: string;
1104
1104
  /**
1105
1105
  * The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use
@@ -1238,13 +1238,13 @@ declare namespace gapi.client {
1238
1238
  /** Output only. The properties of this RichLink. This field is always present. */
1239
1239
  richLinkProperties?: RichLinkProperties;
1240
1240
  /**
1241
- * 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
1241
+ * IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this
1242
1242
  * person link isn't suggested for deletion.
1243
1243
  */
1244
1244
  suggestedDeletionIds?: string[];
1245
1245
  /**
1246
- * 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
1247
- * by a different user, for example). If empty, then this person link isn't a suggested insertion.
1246
+ * IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by
1247
+ * a different user, for example). If empty, then this person link isn't a suggested insertion.
1248
1248
  */
1249
1249
  suggestedInsertionIds?: string[];
1250
1250
  /** The suggested text style changes to this RichLink, keyed by suggestion ID. */
@@ -1253,7 +1253,7 @@ declare namespace gapi.client {
1253
1253
  textStyle?: TextStyle;
1254
1254
  }
1255
1255
  interface RichLinkProperties {
1256
- /** 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). */
1256
+ /** Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). */
1257
1257
  mimeType?: string;
1258
1258
  /**
1259
1259
  * 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
@@ -1268,7 +1268,7 @@ declare namespace gapi.client {
1268
1268
  sectionStyle?: SectionStyle;
1269
1269
  /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
1270
1270
  suggestedDeletionIds?: string[];
1271
- /** The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
1271
+ /** The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
1272
1272
  suggestedInsertionIds?: string[];
1273
1273
  }
1274
1274
  interface SectionColumnProperties {
@@ -1279,12 +1279,12 @@ declare namespace gapi.client {
1279
1279
  }
1280
1280
  interface SectionStyle {
1281
1281
  /**
1282
- * The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than three
1283
- * columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
1282
+ * The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns.
1283
+ * When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
1284
1284
  */
1285
1285
  columnProperties?: SectionColumnProperties[];
1286
1286
  /**
1287
- * The style of column separators. This style can be set even when there is one column in the section. When updating this property, setting a concrete value is required. Unsetting this
1287
+ * The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this
1288
1288
  * property results in a 400 bad request error.
1289
1289
  */
1290
1290
  columnSeparatorStyle?: string;
@@ -1305,58 +1305,60 @@ declare namespace gapi.client {
1305
1305
  defaultHeaderId?: string;
1306
1306
  /**
1307
1307
  * The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section.
1308
- * If it is false, the footers on even pages uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first
1308
+ * If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first
1309
1309
  * SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
1310
1310
  */
1311
1311
  evenPageFooterId?: string;
1312
1312
  /**
1313
1313
  * The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section.
1314
- * If it is false, the headers on even pages uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first
1314
+ * If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first
1315
1315
  * SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
1316
1316
  */
1317
1317
  evenPageHeaderId?: string;
1318
1318
  /**
1319
- * The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it
1320
- * is false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset
1319
+ * The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If
1320
+ * it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset
1321
1321
  * in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
1322
1322
  */
1323
1323
  firstPageFooterId?: string;
1324
1324
  /**
1325
- * The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it
1326
- * is false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset
1325
+ * The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If
1326
+ * it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset
1327
1327
  * in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
1328
1328
  */
1329
1329
  firstPageHeaderId?: string;
1330
1330
  /**
1331
- * The bottom page margin of the section. If unset, uses margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property
1332
- * results in a 400 bad request error.
1331
+ * The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting
1332
+ * this property results in a 400 bad request error.
1333
1333
  */
1334
1334
  marginBottom?: Dimension;
1335
1335
  /**
1336
- * The footer margin of the section. If unset, uses margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of
1337
- * use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required.
1338
- * Unsetting this property results in a 400 bad request error.
1336
+ * The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The
1337
+ * value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is
1338
+ * required. Unsetting this property results in a 400 bad request error.
1339
1339
  */
1340
1340
  marginFooter?: Dimension;
1341
1341
  /**
1342
- * The header margin of the section. If unset, uses margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of
1343
- * use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is
1342
+ * The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The
1343
+ * value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is
1344
1344
  * required. Unsetting this property results in a 400 bad request error.
1345
1345
  */
1346
1346
  marginHeader?: Dimension;
1347
1347
  /**
1348
- * The left page margin of the section. If unset, uses margin_left from DocumentStyle. Updating left margin causes columns in this section to resize. Since the margin affects column
1349
- * width, it is applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
1348
+ * The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the
1349
+ * margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad
1350
+ * request error.
1350
1351
  */
1351
1352
  marginLeft?: Dimension;
1352
1353
  /**
1353
- * The right page margin of the section. If unset, uses margin_right from DocumentStyle. Updating right margin causes columns in this section to resize. Since the margin affects column
1354
- * width, it is applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
1354
+ * The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the
1355
+ * margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad
1356
+ * request error.
1355
1357
  */
1356
1358
  marginRight?: Dimension;
1357
1359
  /**
1358
- * The top page margin of the section. If unset, uses margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results
1359
- * in a 400 bad request error.
1360
+ * The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this
1361
+ * property results in a 400 bad request error.
1360
1362
  */
1361
1363
  marginTop?: Dimension;
1362
1364
  /**
@@ -1383,7 +1385,7 @@ declare namespace gapi.client {
1383
1385
  backgroundColorSuggested?: boolean;
1384
1386
  }
1385
1387
  interface SheetsChartReference {
1386
- /** The ID of the specific chart in the Google Sheets spreadsheet that is embedded. */
1388
+ /** The ID of the specific chart in the Google Sheets spreadsheet that's embedded. */
1387
1389
  chartId?: number;
1388
1390
  /** The ID of the Google Sheets spreadsheet that contains the source chart. */
1389
1391
  spreadsheetId?: string;
@@ -1514,13 +1516,13 @@ declare namespace gapi.client {
1514
1516
  textStyleSuggestionState?: TextStyleSuggestionState;
1515
1517
  }
1516
1518
  interface Table {
1517
- /** Number of columns in the table. It is possible for a table to be non-rectangular, so some rows may have a different number of cells. */
1519
+ /** Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. */
1518
1520
  columns?: number;
1519
1521
  /** Number of rows in the table. */
1520
1522
  rows?: number;
1521
1523
  /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
1522
1524
  suggestedDeletionIds?: string[];
1523
- /** The suggested insertion IDs. A Table may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
1525
+ /** The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
1524
1526
  suggestedInsertionIds?: string[];
1525
1527
  /** The contents and style of each row. */
1526
1528
  tableRows?: TableRow[];
@@ -1536,7 +1538,7 @@ declare namespace gapi.client {
1536
1538
  startIndex?: number;
1537
1539
  /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
1538
1540
  suggestedDeletionIds?: string[];
1539
- /** The suggested insertion IDs. A TableCell may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
1541
+ /** The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
1540
1542
  suggestedInsertionIds?: string[];
1541
1543
  /** The suggested changes to the table cell style, keyed by suggestion ID. */
1542
1544
  suggestedTableCellStyleChanges?: { [P in string]: SuggestedTableCellStyle };
@@ -1640,12 +1642,12 @@ declare namespace gapi.client {
1640
1642
  startIndex?: number;
1641
1643
  /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
1642
1644
  suggestedDeletionIds?: string[];
1643
- /** The suggested insertion IDs. A TableRow may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
1645
+ /** The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
1644
1646
  suggestedInsertionIds?: string[];
1645
1647
  /** The suggested style changes to this row, keyed by suggestion ID. */
1646
1648
  suggestedTableRowStyleChanges?: { [P in string]: SuggestedTableRowStyle };
1647
1649
  /**
1648
- * The contents and style of each cell in this row. It is possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same
1650
+ * The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same
1649
1651
  * table.
1650
1652
  */
1651
1653
  tableCells?: TableCell[];
@@ -1679,7 +1681,7 @@ declare namespace gapi.client {
1679
1681
  content?: string;
1680
1682
  /** The suggested deletion IDs. If empty, then there are no suggested deletions of this content. */
1681
1683
  suggestedDeletionIds?: string[];
1682
- /** The suggested insertion IDs. A TextRun may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. */
1684
+ /** The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. */
1683
1685
  suggestedInsertionIds?: string[];
1684
1686
  /** The suggested text style changes to this run, keyed by suggestion ID. */
1685
1687
  suggestedTextStyleChanges?: { [P in string]: SuggestedTextStyle };
@@ -1691,7 +1693,7 @@ declare namespace gapi.client {
1691
1693
  backgroundColor?: OptionalColor;
1692
1694
  /**
1693
1695
  * The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the
1694
- * `font_size` field. The `font_size` itself is not affected by changes in this field.
1696
+ * `font_size` field. Changes in this field don't affect the `font_size`.
1695
1697
  */
1696
1698
  baselineOffset?: string;
1697
1699
  /** Whether or not the text is rendered as bold. */
@@ -1703,7 +1705,7 @@ declare namespace gapi.client {
1703
1705
  /** Whether or not the text is italicized. */
1704
1706
  italic?: boolean;
1705
1707
  /**
1706
- * The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the
1708
+ * The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the
1707
1709
  * text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in
1708
1710
  * the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to
1709
1711
  * point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will
@@ -1867,9 +1869,9 @@ declare namespace gapi.client {
1867
1869
  */
1868
1870
  fontFamily?: string;
1869
1871
  /**
1870
- * The weight of the font. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the
1872
+ * The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the
1871
1873
  * CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font
1872
- * weight makes up just one component of the rendered font weight. The rendered weight is determined by a combination of the `weight` and the text style's resolved `bold` value, after
1874
+ * weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after
1873
1875
  * accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to
1874
1876
  * `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold,
1875
1877
  * the rendered weight is equal to the weight.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.docs-v1",
3
- "version": "0.0.20221004",
3
+ "version": "0.0.20221013",
4
4
  "description": "TypeScript typings for Google Docs API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20221004
6
+ // Revision: 20221013
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */