@maxim_mazurok/gapi.client.docs-v1 0.2.20251020 → 0.2.20251022
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +36 -36
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://docs.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20251022
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -259,43 +259,43 @@ declare namespace gapi.client {
|
|
|
259
259
|
interface DocumentStyle {
|
|
260
260
|
/** The background of the document. Documents cannot have a transparent background color. */
|
|
261
261
|
background?: Background;
|
|
262
|
-
/** The ID of the default footer. If not set, there's no default footer. This property is read-only. */
|
|
262
|
+
/** The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
263
263
|
defaultFooterId?: string;
|
|
264
|
-
/** The ID of the default header. If not set, there's no default header. This property is read-only. */
|
|
264
|
+
/** The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
265
265
|
defaultHeaderId?: string;
|
|
266
266
|
/** Specifies document-level format settings, such as the document mode (pages vs pageless). */
|
|
267
267
|
documentFormat?: DocumentFormat;
|
|
268
|
-
/** 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. If not set, there's no even page footer. This property is read-only. */
|
|
268
|
+
/** 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. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
269
269
|
evenPageFooterId?: string;
|
|
270
|
-
/** 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. If not set, there's no even page header. This property is read-only. */
|
|
270
|
+
/** 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. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
271
271
|
evenPageHeaderId?: string;
|
|
272
|
-
/** 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 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. */
|
|
272
|
+
/** 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 use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
273
273
|
firstPageFooterId?: string;
|
|
274
|
-
/** 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 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. */
|
|
274
|
+
/** 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 use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
275
275
|
firstPageHeaderId?: string;
|
|
276
|
-
/** Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. */
|
|
276
|
+
/** Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
277
277
|
flipPageOrientation?: boolean;
|
|
278
|
-
/** The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. */
|
|
278
|
+
/** The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
279
279
|
marginBottom?: Dimension;
|
|
280
|
-
/** The amount of space between the bottom of the page and the contents of the footer. */
|
|
280
|
+
/** The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
281
281
|
marginFooter?: Dimension;
|
|
282
|
-
/** The amount of space between the top of the page and the contents of the header. */
|
|
282
|
+
/** The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
283
283
|
marginHeader?: Dimension;
|
|
284
|
-
/** The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. */
|
|
284
|
+
/** The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
285
285
|
marginLeft?: Dimension;
|
|
286
|
-
/** The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. */
|
|
286
|
+
/** The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
287
287
|
marginRight?: Dimension;
|
|
288
|
-
/** The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. */
|
|
288
|
+
/** The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
289
289
|
marginTop?: Dimension;
|
|
290
|
-
/** The page number from which to start counting the number of pages. */
|
|
290
|
+
/** The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
291
291
|
pageNumberStart?: number;
|
|
292
|
-
/** The size of a page in the document. */
|
|
292
|
+
/** The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
293
293
|
pageSize?: Size;
|
|
294
|
-
/** Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. */
|
|
294
|
+
/** Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
295
295
|
useCustomHeaderFooterMargins?: boolean;
|
|
296
|
-
/** Indicates whether to use the even page header / footer IDs for the even pages. */
|
|
296
|
+
/** Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
297
297
|
useEvenPageHeaderFooter?: boolean;
|
|
298
|
-
/** Indicates whether to use the first page header / footer IDs for the first page. */
|
|
298
|
+
/** Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. */
|
|
299
299
|
useFirstPageHeaderFooter?: boolean;
|
|
300
300
|
}
|
|
301
301
|
interface DocumentStyleSuggestionState {
|
|
@@ -585,9 +585,9 @@ declare namespace gapi.client {
|
|
|
585
585
|
location?: Location;
|
|
586
586
|
}
|
|
587
587
|
interface InsertPersonRequest {
|
|
588
|
-
/** Inserts the person at the end of a header, footer, footnote or the document body. */
|
|
588
|
+
/** Inserts the person mention at the end of a header, footer, footnote or the document body. */
|
|
589
589
|
endOfSegmentLocation?: EndOfSegmentLocation;
|
|
590
|
-
/** Inserts the person at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation. */
|
|
590
|
+
/** Inserts the person mention at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation. */
|
|
591
591
|
location?: Location;
|
|
592
592
|
/** The properties of the person mention to insert. */
|
|
593
593
|
personProperties?: PersonProperties;
|
|
@@ -1163,37 +1163,37 @@ declare namespace gapi.client {
|
|
|
1163
1163
|
columnSeparatorStyle?: string;
|
|
1164
1164
|
/** The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1165
1165
|
contentDirection?: string;
|
|
1166
|
-
/** The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. */
|
|
1166
|
+
/** The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1167
1167
|
defaultFooterId?: string;
|
|
1168
|
-
/** The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. */
|
|
1168
|
+
/** The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1169
1169
|
defaultHeaderId?: string;
|
|
1170
|
-
/** 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. 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 SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. */
|
|
1170
|
+
/** 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. 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 SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1171
1171
|
evenPageFooterId?: string;
|
|
1172
|
-
/** 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. 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 SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. */
|
|
1172
|
+
/** 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. 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 SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1173
1173
|
evenPageHeaderId?: string;
|
|
1174
|
-
/** 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'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 in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. */
|
|
1174
|
+
/** 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'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 in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1175
1175
|
firstPageFooterId?: string;
|
|
1176
|
-
/** 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'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 in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. */
|
|
1176
|
+
/** 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'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 in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */
|
|
1177
1177
|
firstPageHeaderId?: string;
|
|
1178
|
-
/** Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1178
|
+
/** Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1179
1179
|
flipPageOrientation?: boolean;
|
|
1180
|
-
/** 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 this property results in a 400 bad request error. */
|
|
1180
|
+
/** The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1181
1181
|
marginBottom?: Dimension;
|
|
1182
|
-
/** 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 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 required. Unsetting this property results in a 400 bad request error. */
|
|
1182
|
+
/** 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 value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1183
1183
|
marginFooter?: Dimension;
|
|
1184
|
-
/** 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 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 required. Unsetting this property results in a 400 bad request error. */
|
|
1184
|
+
/** 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 value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1185
1185
|
marginHeader?: Dimension;
|
|
1186
|
-
/** 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 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 request error. */
|
|
1186
|
+
/** 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 margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1187
1187
|
marginLeft?: Dimension;
|
|
1188
|
-
/** 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 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 request error. */
|
|
1188
|
+
/** 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 margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1189
1189
|
marginRight?: Dimension;
|
|
1190
|
-
/** 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 property results in a 400 bad request error. */
|
|
1190
|
+
/** The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1191
1191
|
marginTop?: Dimension;
|
|
1192
|
-
/** The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1192
|
+
/** The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1193
1193
|
pageNumberStart?: number;
|
|
1194
1194
|
/** Output only. The type of section. */
|
|
1195
1195
|
sectionType?: string;
|
|
1196
|
-
/** Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1196
|
+
/** Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */
|
|
1197
1197
|
useFirstPageHeaderFooter?: boolean;
|
|
1198
1198
|
}
|
|
1199
1199
|
interface Shading {
|