@maxim_mazurok/gapi.client.sheets-v4 0.0.20250401 → 0.0.20250415
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 +75 -5
- 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://sheets.googleapis.com/$discovery/rest?version=v4
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250415
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -104,6 +104,10 @@ declare namespace gapi.client {
|
|
|
104
104
|
/** The newly added slicer. */
|
|
105
105
|
slicer?: Slicer;
|
|
106
106
|
}
|
|
107
|
+
interface AddTableRequest {
|
|
108
|
+
/** Required. The table to add. */
|
|
109
|
+
table?: Table;
|
|
110
|
+
}
|
|
107
111
|
interface AppendCellsRequest {
|
|
108
112
|
/** The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `"*"` can be used as short-hand for listing every field. */
|
|
109
113
|
fields?: string;
|
|
@@ -111,6 +115,8 @@ declare namespace gapi.client {
|
|
|
111
115
|
rows?: RowData[];
|
|
112
116
|
/** The sheet ID to append the data to. */
|
|
113
117
|
sheetId?: number;
|
|
118
|
+
/** The ID of the table to append data to. The data will be only appended to the table body. This field also takes precedence over the `sheet_id` field. */
|
|
119
|
+
tableId?: string;
|
|
114
120
|
}
|
|
115
121
|
interface AppendDimensionRequest {
|
|
116
122
|
/** Whether rows or columns should be appended. */
|
|
@@ -261,6 +267,8 @@ declare namespace gapi.client {
|
|
|
261
267
|
range?: GridRange;
|
|
262
268
|
/** The sort order per column. Later specifications are used when values are equal in the earlier specifications. */
|
|
263
269
|
sortSpecs?: SortSpec[];
|
|
270
|
+
/** The table this filter is backed by, if any. When writing, only one of range or table_id may be set. */
|
|
271
|
+
tableId?: string;
|
|
264
272
|
}
|
|
265
273
|
interface BasicSeriesDataPointStyleOverride {
|
|
266
274
|
/** Color of the series data point. If empty, the series default is used. Deprecated: Use color_style. */
|
|
@@ -973,6 +981,10 @@ declare namespace gapi.client {
|
|
|
973
981
|
/** The ID of the sheet to delete. If the sheet is of DATA_SOURCE type, the associated DataSource is also deleted. */
|
|
974
982
|
sheetId?: number;
|
|
975
983
|
}
|
|
984
|
+
interface DeleteTableRequest {
|
|
985
|
+
/** The ID of the table to delete. */
|
|
986
|
+
tableId?: string;
|
|
987
|
+
}
|
|
976
988
|
interface DeveloperMetadata {
|
|
977
989
|
/** The location where the metadata is associated. */
|
|
978
990
|
location?: DeveloperMetadataLocation;
|
|
@@ -1142,12 +1154,14 @@ declare namespace gapi.client {
|
|
|
1142
1154
|
filterSpecs?: FilterSpec[];
|
|
1143
1155
|
/** The ID of the filter view. */
|
|
1144
1156
|
filterViewId?: number;
|
|
1145
|
-
/** The named range this filter view is backed by, if any. When writing, only one of range or named_range_id may be set. */
|
|
1157
|
+
/** The named range this filter view is backed by, if any. When writing, only one of range or named_range_id or table_id may be set. */
|
|
1146
1158
|
namedRangeId?: string;
|
|
1147
|
-
/** The range this filter view covers. When writing, only one of range or named_range_id may be set. */
|
|
1159
|
+
/** The range this filter view covers. When writing, only one of range or named_range_id or table_id may be set. */
|
|
1148
1160
|
range?: GridRange;
|
|
1149
1161
|
/** The sort order per column. Later specifications are used when values are equal in the earlier specifications. */
|
|
1150
1162
|
sortSpecs?: SortSpec[];
|
|
1163
|
+
/** The table this filter view is backed by, if any. When writing, only one of range or named_range_id or table_id may be set. */
|
|
1164
|
+
tableId?: string;
|
|
1151
1165
|
/** The name of the filter view. */
|
|
1152
1166
|
title?: string;
|
|
1153
1167
|
}
|
|
@@ -1186,6 +1200,8 @@ declare namespace gapi.client {
|
|
|
1186
1200
|
interface GetSpreadsheetByDataFilterRequest {
|
|
1187
1201
|
/** The DataFilters used to select which ranges to retrieve from the spreadsheet. */
|
|
1188
1202
|
dataFilters?: DataFilter[];
|
|
1203
|
+
/** True if tables should be excluded in the banded ranges. False if not set. */
|
|
1204
|
+
excludeTablesInBandedRanges?: boolean;
|
|
1189
1205
|
/** True if grid data should be returned. This parameter is ignored if a field mask was set in the request. */
|
|
1190
1206
|
includeGridData?: boolean;
|
|
1191
1207
|
}
|
|
@@ -1552,14 +1568,16 @@ declare namespace gapi.client {
|
|
|
1552
1568
|
description?: string;
|
|
1553
1569
|
/** The users and groups with edit access to the protected range. This field is only visible to users with edit access to the protected range and the document. Editors are not supported with warning_only protection. */
|
|
1554
1570
|
editors?: Editors;
|
|
1555
|
-
/** The named range this protected range is backed by, if any. When writing, only one of range or named_range_id may be set. */
|
|
1571
|
+
/** The named range this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set. */
|
|
1556
1572
|
namedRangeId?: string;
|
|
1557
1573
|
/** The ID of the protected range. This field is read-only. */
|
|
1558
1574
|
protectedRangeId?: number;
|
|
1559
|
-
/** The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id may be set. */
|
|
1575
|
+
/** The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id or table_id may be set. */
|
|
1560
1576
|
range?: GridRange;
|
|
1561
1577
|
/** True if the user who requested this protected range can edit the protected area. This field is read-only. */
|
|
1562
1578
|
requestingUserCanEdit?: boolean;
|
|
1579
|
+
/** The table this protected range is backed by, if any. When writing, only one of range or named_range_id or table_id may be set. */
|
|
1580
|
+
tableId?: string;
|
|
1563
1581
|
/** The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets. */
|
|
1564
1582
|
unprotectedRanges?: GridRange[];
|
|
1565
1583
|
/** True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true, then editors are ignored. Additionally, if this field is changed from true to false and the `editors` field is not set (nor included in the field mask), then the editors will be set to all the editors in the document. */
|
|
@@ -1624,6 +1642,8 @@ declare namespace gapi.client {
|
|
|
1624
1642
|
addSheet?: AddSheetRequest;
|
|
1625
1643
|
/** Adds a slicer. */
|
|
1626
1644
|
addSlicer?: AddSlicerRequest;
|
|
1645
|
+
/** Adds a table. */
|
|
1646
|
+
addTable?: AddTableRequest;
|
|
1627
1647
|
/** Appends cells after the last row with data in a sheet. */
|
|
1628
1648
|
appendCells?: AppendCellsRequest;
|
|
1629
1649
|
/** Appends dimensions to the end of a sheet. */
|
|
@@ -1668,6 +1688,8 @@ declare namespace gapi.client {
|
|
|
1668
1688
|
deleteRange?: DeleteRangeRequest;
|
|
1669
1689
|
/** Deletes a sheet. */
|
|
1670
1690
|
deleteSheet?: DeleteSheetRequest;
|
|
1691
|
+
/** A request for deleting a table. */
|
|
1692
|
+
deleteTable?: DeleteTableRequest;
|
|
1671
1693
|
/** Duplicates a filter view. */
|
|
1672
1694
|
duplicateFilterView?: DuplicateFilterViewRequest;
|
|
1673
1695
|
/** Duplicates a sheet. */
|
|
@@ -1736,6 +1758,8 @@ declare namespace gapi.client {
|
|
|
1736
1758
|
updateSlicerSpec?: UpdateSlicerSpecRequest;
|
|
1737
1759
|
/** Updates the spreadsheet's properties. */
|
|
1738
1760
|
updateSpreadsheetProperties?: UpdateSpreadsheetPropertiesRequest;
|
|
1761
|
+
/** Updates a table. */
|
|
1762
|
+
updateTable?: UpdateTableRequest;
|
|
1739
1763
|
}
|
|
1740
1764
|
interface Response {
|
|
1741
1765
|
/** A reply from adding a banded range. */
|
|
@@ -1856,6 +1880,8 @@ declare namespace gapi.client {
|
|
|
1856
1880
|
rowGroups?: DimensionGroup[];
|
|
1857
1881
|
/** The slicers on this sheet. */
|
|
1858
1882
|
slicers?: Slicer[];
|
|
1883
|
+
/** The tables on this sheet. */
|
|
1884
|
+
tables?: Table[];
|
|
1859
1885
|
}
|
|
1860
1886
|
interface SheetProperties {
|
|
1861
1887
|
/** Output only. If present, the field contains DATA_SOURCE sheet specific properties. */
|
|
@@ -1979,6 +2005,42 @@ declare namespace gapi.client {
|
|
|
1979
2005
|
/** The spreadsheet theme color pairs. To update you must provide all theme color pairs. */
|
|
1980
2006
|
themeColors?: ThemeColorPair[];
|
|
1981
2007
|
}
|
|
2008
|
+
interface Table {
|
|
2009
|
+
/** The table column properties. */
|
|
2010
|
+
columnProperties?: TableColumnProperties[];
|
|
2011
|
+
/** The table name. This is unique to all tables in the same spreadsheet. */
|
|
2012
|
+
name?: string;
|
|
2013
|
+
/** The table range. */
|
|
2014
|
+
range?: GridRange;
|
|
2015
|
+
/** The table rows properties. */
|
|
2016
|
+
rowsProperties?: TableRowsProperties;
|
|
2017
|
+
/** The id of the table. */
|
|
2018
|
+
tableId?: string;
|
|
2019
|
+
}
|
|
2020
|
+
interface TableColumnDataValidationRule {
|
|
2021
|
+
/** The condition that data in the cell must match. Valid only if the [BooleanCondition.type] is ONE_OF_LIST. */
|
|
2022
|
+
condition?: BooleanCondition;
|
|
2023
|
+
}
|
|
2024
|
+
interface TableColumnProperties {
|
|
2025
|
+
/** The 0-based column index. This index is relative to its position in the table and is not necessarily the same as the column index in the sheet. */
|
|
2026
|
+
columnIndex?: number;
|
|
2027
|
+
/** The column name. */
|
|
2028
|
+
columnName?: string;
|
|
2029
|
+
/** The column type. */
|
|
2030
|
+
columnType?: string;
|
|
2031
|
+
/** The column data validation rule. Only set for dropdown column type. */
|
|
2032
|
+
dataValidationRule?: TableColumnDataValidationRule;
|
|
2033
|
+
}
|
|
2034
|
+
interface TableRowsProperties {
|
|
2035
|
+
/** The first color that is alternating. If this field is set, the first banded row is filled with the specified color. Otherwise, the first banded row is filled with a default color. */
|
|
2036
|
+
firstBandColorStyle?: ColorStyle;
|
|
2037
|
+
/** The color of the last row. If this field is not set a footer is not added, the last row is filled with either first_band_color_style or second_band_color_style, depending on the color of the previous row. If updating an existing table without a footer to have a footer, the range will be expanded by 1 row. If updating an existing table with a footer and removing a footer, the range will be shrunk by 1 row. */
|
|
2038
|
+
footerColorStyle?: ColorStyle;
|
|
2039
|
+
/** The color of the header row. If this field is set, the header row is filled with the specified color. Otherwise, the header row is filled with a default color. */
|
|
2040
|
+
headerColorStyle?: ColorStyle;
|
|
2041
|
+
/** The second color that is alternating. If this field is set, the second banded row is filled with the specified color. Otherwise, the second banded row is filled with a default color. */
|
|
2042
|
+
secondBandColorStyle?: ColorStyle;
|
|
2043
|
+
}
|
|
1982
2044
|
interface TextFormat {
|
|
1983
2045
|
/** True if the text is bold. */
|
|
1984
2046
|
bold?: boolean;
|
|
@@ -2253,6 +2315,12 @@ declare namespace gapi.client {
|
|
|
2253
2315
|
/** The properties to update. */
|
|
2254
2316
|
properties?: SpreadsheetProperties;
|
|
2255
2317
|
}
|
|
2318
|
+
interface UpdateTableRequest {
|
|
2319
|
+
/** Required. The fields that should be updated. At least one field must be specified. The root `table` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. */
|
|
2320
|
+
fields?: string;
|
|
2321
|
+
/** Required. The table to update. */
|
|
2322
|
+
table?: Table;
|
|
2323
|
+
}
|
|
2256
2324
|
interface UpdateValuesByDataFilterResponse {
|
|
2257
2325
|
/** The data filter that selected the range that was updated. */
|
|
2258
2326
|
dataFilter?: DataFilter;
|
|
@@ -3203,6 +3271,8 @@ declare namespace gapi.client {
|
|
|
3203
3271
|
alt?: string;
|
|
3204
3272
|
/** JSONP */
|
|
3205
3273
|
callback?: string;
|
|
3274
|
+
/** True if tables should be excluded in the banded ranges. False if not set. */
|
|
3275
|
+
excludeTablesInBandedRanges?: boolean;
|
|
3206
3276
|
/** Selector specifying which fields to include in a partial response. */
|
|
3207
3277
|
fields?: string;
|
|
3208
3278
|
/** True if grid data should be returned. This parameter is ignored if a field mask was set in the request. */
|