@pikku/addon-google-sheets 0.0.2
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/README.md +12 -0
- package/dist/.pikku/addon/pikku-addon-types.gen.d.ts +67 -0
- package/dist/.pikku/addon/pikku-addon-types.gen.d.ts.map +1 -0
- package/dist/.pikku/addon/pikku-addon-types.gen.js +78 -0
- package/dist/.pikku/addon/pikku-addon-types.gen.js.map +1 -0
- package/dist/.pikku/addon/pikku-addon-types.gen.ts +106 -0
- package/dist/.pikku/addon/pikku-package.gen.d.ts +2 -0
- package/dist/.pikku/addon/pikku-package.gen.d.ts.map +1 -0
- package/dist/.pikku/addon/pikku-package.gen.js +11 -0
- package/dist/.pikku/addon/pikku-package.gen.js.map +1 -0
- package/dist/.pikku/addon/pikku-package.gen.ts +13 -0
- package/dist/.pikku/agent/pikku-agent-map.gen.d.ts +4 -0
- package/dist/.pikku/agent/pikku-agent-types.gen.d.ts +47 -0
- package/dist/.pikku/agent/pikku-agent-types.gen.d.ts.map +1 -0
- package/dist/.pikku/agent/pikku-agent-types.gen.js +18 -0
- package/dist/.pikku/agent/pikku-agent-types.gen.js.map +1 -0
- package/dist/.pikku/agent/pikku-agent-types.gen.ts +82 -0
- package/dist/.pikku/channel/pikku-channel-types.gen.d.ts +112 -0
- package/dist/.pikku/channel/pikku-channel-types.gen.d.ts.map +1 -0
- package/dist/.pikku/channel/pikku-channel-types.gen.js +60 -0
- package/dist/.pikku/channel/pikku-channel-types.gen.js.map +1 -0
- package/dist/.pikku/channel/pikku-channel-types.gen.ts +177 -0
- package/dist/.pikku/console/pikku-addon-meta.gen.json +26 -0
- package/dist/.pikku/console/pikku-node-types.gen.d.ts +7 -0
- package/dist/.pikku/console/pikku-node-types.gen.d.ts.map +1 -0
- package/dist/.pikku/console/pikku-node-types.gen.js +2 -0
- package/dist/.pikku/console/pikku-node-types.gen.js.map +1 -0
- package/dist/.pikku/console/pikku-node-types.gen.ts +8 -0
- package/dist/.pikku/credentials/pikku-credentials-meta.gen.json +23 -0
- package/dist/.pikku/credentials/pikku-credentials.gen.d.ts +15 -0
- package/dist/.pikku/credentials/pikku-credentials.gen.d.ts.map +1 -0
- package/dist/.pikku/credentials/pikku-credentials.gen.js +13 -0
- package/dist/.pikku/credentials/pikku-credentials.gen.js.map +1 -0
- package/dist/.pikku/credentials/pikku-credentials.gen.ts +23 -0
- package/dist/.pikku/function/pikku-function-types.gen.d.ts +490 -0
- package/dist/.pikku/function/pikku-function-types.gen.d.ts.map +1 -0
- package/dist/.pikku/function/pikku-function-types.gen.js +334 -0
- package/dist/.pikku/function/pikku-function-types.gen.js.map +1 -0
- package/dist/.pikku/function/pikku-function-types.gen.ts +754 -0
- package/dist/.pikku/function/pikku-functions-meta-verbose.gen.json +524 -0
- package/dist/.pikku/function/pikku-functions-meta.gen.d.ts +2 -0
- package/dist/.pikku/function/pikku-functions-meta.gen.d.ts.map +1 -0
- package/dist/.pikku/function/pikku-functions-meta.gen.js +7 -0
- package/dist/.pikku/function/pikku-functions-meta.gen.js.map +1 -0
- package/dist/.pikku/function/pikku-functions-meta.gen.json +344 -0
- package/dist/.pikku/function/pikku-functions-meta.gen.ts +7 -0
- package/dist/.pikku/function/pikku-functions.gen.d.ts +2 -0
- package/dist/.pikku/function/pikku-functions.gen.d.ts.map +1 -0
- package/dist/.pikku/function/pikku-functions.gen.js +42 -0
- package/dist/.pikku/function/pikku-functions.gen.js.map +1 -0
- package/dist/.pikku/function/pikku-functions.gen.ts +42 -0
- package/dist/.pikku/http/pikku-http-types.gen.d.ts +120 -0
- package/dist/.pikku/http/pikku-http-types.gen.d.ts.map +1 -0
- package/dist/.pikku/http/pikku-http-types.gen.js +72 -0
- package/dist/.pikku/http/pikku-http-types.gen.js.map +1 -0
- package/dist/.pikku/http/pikku-http-types.gen.ts +147 -0
- package/dist/.pikku/mcp/pikku-mcp-types.gen.d.ts +131 -0
- package/dist/.pikku/mcp/pikku-mcp-types.gen.d.ts.map +1 -0
- package/dist/.pikku/mcp/pikku-mcp-types.gen.js +38 -0
- package/dist/.pikku/mcp/pikku-mcp-types.gen.js.map +1 -0
- package/dist/.pikku/mcp/pikku-mcp-types.gen.ts +183 -0
- package/dist/.pikku/pikku-bootstrap.gen.d.ts +9 -0
- package/dist/.pikku/pikku-bootstrap.gen.d.ts.map +1 -0
- package/dist/.pikku/pikku-bootstrap.gen.js +9 -0
- package/dist/.pikku/pikku-bootstrap.gen.js.map +1 -0
- package/dist/.pikku/pikku-bootstrap.gen.ts +8 -0
- package/dist/.pikku/pikku-meta-service.gen.d.ts +8 -0
- package/dist/.pikku/pikku-meta-service.gen.d.ts.map +1 -0
- package/dist/.pikku/pikku-meta-service.gen.js +10 -0
- package/dist/.pikku/pikku-meta-service.gen.js.map +1 -0
- package/dist/.pikku/pikku-meta-service.gen.ts +10 -0
- package/dist/.pikku/pikku-services.gen.d.ts +36 -0
- package/dist/.pikku/pikku-services.gen.d.ts.map +1 -0
- package/dist/.pikku/pikku-services.gen.js +32 -0
- package/dist/.pikku/pikku-services.gen.js.map +1 -0
- package/dist/.pikku/pikku-services.gen.ts +45 -0
- package/dist/.pikku/pikku-types.gen.d.ts +12 -0
- package/dist/.pikku/pikku-types.gen.d.ts.map +1 -0
- package/dist/.pikku/pikku-types.gen.js +17 -0
- package/dist/.pikku/pikku-types.gen.js.map +1 -0
- package/dist/.pikku/pikku-types.gen.ts +21 -0
- package/dist/.pikku/queue/pikku-queue-types.gen.d.ts +24 -0
- package/dist/.pikku/queue/pikku-queue-types.gen.d.ts.map +1 -0
- package/dist/.pikku/queue/pikku-queue-types.gen.js +17 -0
- package/dist/.pikku/queue/pikku-queue-types.gen.js.map +1 -0
- package/dist/.pikku/queue/pikku-queue-types.gen.ts +27 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-map.gen.d.ts +1356 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-map.internal.gen.d.ts +1374 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.d.ts +2 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.d.ts.map +1 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.js +7 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.js.map +1 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.json +20 -0
- package/dist/.pikku/rpc/pikku-rpc-wirings-meta.internal.gen.ts +6 -0
- package/dist/.pikku/scheduler/pikku-scheduler-types.gen.d.ts +22 -0
- package/dist/.pikku/scheduler/pikku-scheduler-types.gen.d.ts.map +1 -0
- package/dist/.pikku/scheduler/pikku-scheduler-types.gen.js +17 -0
- package/dist/.pikku/scheduler/pikku-scheduler-types.gen.js.map +1 -0
- package/dist/.pikku/scheduler/pikku-scheduler-types.gen.ts +25 -0
- package/dist/.pikku/schemas/register.gen.d.ts +2 -0
- package/dist/.pikku/schemas/register.gen.d.ts.map +1 -0
- package/dist/.pikku/schemas/register.gen.js +83 -0
- package/dist/.pikku/schemas/register.gen.js.map +1 -0
- package/dist/.pikku/schemas/register.gen.ts +159 -0
- package/dist/.pikku/schemas/schemas/BatchUpdateInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/BatchUpdateOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/CreateInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/CreateOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/CredentialSchema_googleSheets.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/DeveloperMetadataGetInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/DeveloperMetadataGetOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/DeveloperMetadataSearchInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/DeveloperMetadataSearchOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/GetByDataFilterInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/GetByDataFilterOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/GetInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/GetOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ReadRowsInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ReadRowsOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/SecretSchema_googleSheetsOAuthApp.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/SheetsCopyToInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/SheetsCopyToOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesAppendInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesAppendOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesBatchClearByDataFilterInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesBatchClearByDataFilterOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesBatchClearInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesBatchClearOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesBatchGetByDataFilterInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesBatchGetByDataFilterOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesBatchGetInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesBatchGetOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesBatchUpdateByDataFilterInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesBatchUpdateByDataFilterOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesBatchUpdateInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesBatchUpdateOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesClearInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesClearOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesGetInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesGetOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesUpdateInput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/ValuesUpdateOutput.schema.json +1 -0
- package/dist/.pikku/schemas/schemas/VariableSchema_GOOGLE_SHEETS_BASE_URL.schema.json +1 -0
- package/dist/.pikku/secrets/pikku-secret-types.gen.d.ts +6 -0
- package/dist/.pikku/secrets/pikku-secret-types.gen.d.ts.map +1 -0
- package/dist/.pikku/secrets/pikku-secret-types.gen.js +5 -0
- package/dist/.pikku/secrets/pikku-secret-types.gen.js.map +1 -0
- package/dist/.pikku/secrets/pikku-secret-types.gen.ts +5 -0
- package/dist/.pikku/secrets/pikku-secrets-meta.gen.json +10 -0
- package/dist/.pikku/secrets/pikku-secrets.gen.d.ts +15 -0
- package/dist/.pikku/secrets/pikku-secrets.gen.d.ts.map +1 -0
- package/dist/.pikku/secrets/pikku-secrets.gen.js +13 -0
- package/dist/.pikku/secrets/pikku-secrets.gen.js.map +1 -0
- package/dist/.pikku/secrets/pikku-secrets.gen.ts +23 -0
- package/dist/.pikku/trigger/pikku-trigger-types.gen.d.ts +114 -0
- package/dist/.pikku/trigger/pikku-trigger-types.gen.d.ts.map +1 -0
- package/dist/.pikku/trigger/pikku-trigger-types.gen.js +34 -0
- package/dist/.pikku/trigger/pikku-trigger-types.gen.js.map +1 -0
- package/dist/.pikku/trigger/pikku-trigger-types.gen.ts +160 -0
- package/dist/.pikku/variables/pikku-variable-types.gen.d.ts +6 -0
- package/dist/.pikku/variables/pikku-variable-types.gen.d.ts.map +1 -0
- package/dist/.pikku/variables/pikku-variable-types.gen.js +5 -0
- package/dist/.pikku/variables/pikku-variable-types.gen.js.map +1 -0
- package/dist/.pikku/variables/pikku-variable-types.gen.ts +5 -0
- package/dist/.pikku/variables/pikku-variables-meta.gen.json +10 -0
- package/dist/.pikku/variables/pikku-variables.gen.d.ts +15 -0
- package/dist/.pikku/variables/pikku-variables.gen.d.ts.map +1 -0
- package/dist/.pikku/variables/pikku-variables.gen.js +13 -0
- package/dist/.pikku/variables/pikku-variables.gen.js.map +1 -0
- package/dist/.pikku/variables/pikku-variables.gen.ts +23 -0
- package/dist/.pikku/workflow/pikku-workflow-map.gen.d.ts +38 -0
- package/dist/.pikku/workflow/pikku-workflow-types.gen.d.ts +90 -0
- package/dist/.pikku/workflow/pikku-workflow-types.gen.d.ts.map +1 -0
- package/dist/.pikku/workflow/pikku-workflow-types.gen.js +18 -0
- package/dist/.pikku/workflow/pikku-workflow-types.gen.js.map +1 -0
- package/dist/.pikku/workflow/pikku-workflow-types.gen.ts +167 -0
- package/dist/.pikku/workflow/pikku-workflow-wirings-meta.gen.d.ts +2 -0
- package/dist/.pikku/workflow/pikku-workflow-wirings-meta.gen.d.ts.map +1 -0
- package/dist/.pikku/workflow/pikku-workflow-wirings-meta.gen.js +7 -0
- package/dist/.pikku/workflow/pikku-workflow-wirings-meta.gen.js.map +1 -0
- package/dist/.pikku/workflow/pikku-workflow-wirings-meta.gen.ts +9 -0
- package/dist/.pikku/workflow/pikku-workflow-wirings.gen.d.ts +5 -0
- package/dist/.pikku/workflow/pikku-workflow-wirings.gen.d.ts.map +1 -0
- package/dist/.pikku/workflow/pikku-workflow-wirings.gen.js +5 -0
- package/dist/.pikku/workflow/pikku-workflow-wirings.gen.js.map +1 -0
- package/dist/.pikku/workflow/pikku-workflow-wirings.gen.ts +3 -0
- package/dist/src/functions/batchUpdate.function.d.ts +5 -0
- package/dist/src/functions/batchUpdate.function.d.ts.map +1 -0
- package/dist/src/functions/batchUpdate.function.js +13 -0
- package/dist/src/functions/batchUpdate.function.js.map +1 -0
- package/dist/src/functions/create.function.d.ts +5 -0
- package/dist/src/functions/create.function.d.ts.map +1 -0
- package/dist/src/functions/create.function.js +13 -0
- package/dist/src/functions/create.function.js.map +1 -0
- package/dist/src/functions/developerMetadataGet.function.d.ts +146 -0
- package/dist/src/functions/developerMetadataGet.function.d.ts.map +1 -0
- package/dist/src/functions/developerMetadataGet.function.js +43 -0
- package/dist/src/functions/developerMetadataGet.function.js.map +1 -0
- package/dist/src/functions/developerMetadataSearch.function.d.ts +438 -0
- package/dist/src/functions/developerMetadataSearch.function.d.ts.map +1 -0
- package/dist/src/functions/developerMetadataSearch.function.js +104 -0
- package/dist/src/functions/developerMetadataSearch.function.js.map +1 -0
- package/dist/src/functions/get.function.d.ts +72 -0
- package/dist/src/functions/get.function.d.ts.map +1 -0
- package/dist/src/functions/get.function.js +28 -0
- package/dist/src/functions/get.function.js.map +1 -0
- package/dist/src/functions/getByDataFilter.function.d.ts +208 -0
- package/dist/src/functions/getByDataFilter.function.d.ts.map +1 -0
- package/dist/src/functions/getByDataFilter.function.js +56 -0
- package/dist/src/functions/getByDataFilter.function.js.map +1 -0
- package/dist/src/functions/readRows.function.d.ts +25 -0
- package/dist/src/functions/readRows.function.d.ts.map +1 -0
- package/dist/src/functions/readRows.function.js +38 -0
- package/dist/src/functions/readRows.function.js.map +1 -0
- package/dist/src/functions/readRows.function.test.d.ts +2 -0
- package/dist/src/functions/readRows.function.test.d.ts.map +1 -0
- package/dist/src/functions/readRows.function.test.js +47 -0
- package/dist/src/functions/readRows.function.test.js.map +1 -0
- package/dist/src/functions/sheetsCopyTo.function.d.ts +298 -0
- package/dist/src/functions/sheetsCopyTo.function.d.ts.map +1 -0
- package/dist/src/functions/sheetsCopyTo.function.js +74 -0
- package/dist/src/functions/sheetsCopyTo.function.js.map +1 -0
- package/dist/src/functions/valuesAppend.function.d.ts +178 -0
- package/dist/src/functions/valuesAppend.function.d.ts.map +1 -0
- package/dist/src/functions/valuesAppend.function.js +49 -0
- package/dist/src/functions/valuesAppend.function.js.map +1 -0
- package/dist/src/functions/valuesBatchClear.function.d.ts +80 -0
- package/dist/src/functions/valuesBatchClear.function.d.ts.map +1 -0
- package/dist/src/functions/valuesBatchClear.function.js +30 -0
- package/dist/src/functions/valuesBatchClear.function.js.map +1 -0
- package/dist/src/functions/valuesBatchClearByDataFilter.function.d.ts +216 -0
- package/dist/src/functions/valuesBatchClearByDataFilter.function.d.ts.map +1 -0
- package/dist/src/functions/valuesBatchClearByDataFilter.function.js +58 -0
- package/dist/src/functions/valuesBatchClearByDataFilter.function.js.map +1 -0
- package/dist/src/functions/valuesBatchGet.function.d.ts +123 -0
- package/dist/src/functions/valuesBatchGet.function.d.ts.map +1 -0
- package/dist/src/functions/valuesBatchGet.function.js +37 -0
- package/dist/src/functions/valuesBatchGet.function.js.map +1 -0
- package/dist/src/functions/valuesBatchGetByDataFilter.function.d.ts +407 -0
- package/dist/src/functions/valuesBatchGetByDataFilter.function.d.ts.map +1 -0
- package/dist/src/functions/valuesBatchGetByDataFilter.function.js +96 -0
- package/dist/src/functions/valuesBatchGetByDataFilter.function.js.map +1 -0
- package/dist/src/functions/valuesBatchUpdate.function.d.ts +191 -0
- package/dist/src/functions/valuesBatchUpdate.function.d.ts.map +1 -0
- package/dist/src/functions/valuesBatchUpdate.function.js +53 -0
- package/dist/src/functions/valuesBatchUpdate.function.js.map +1 -0
- package/dist/src/functions/valuesBatchUpdateByDataFilter.function.d.ts +463 -0
- package/dist/src/functions/valuesBatchUpdateByDataFilter.function.d.ts.map +1 -0
- package/dist/src/functions/valuesBatchUpdateByDataFilter.function.js +109 -0
- package/dist/src/functions/valuesBatchUpdateByDataFilter.function.js.map +1 -0
- package/dist/src/functions/valuesClear.function.d.ts +80 -0
- package/dist/src/functions/valuesClear.function.d.ts.map +1 -0
- package/dist/src/functions/valuesClear.function.js +30 -0
- package/dist/src/functions/valuesClear.function.js.map +1 -0
- package/dist/src/functions/valuesGet.function.d.ts +111 -0
- package/dist/src/functions/valuesGet.function.d.ts.map +1 -0
- package/dist/src/functions/valuesGet.function.js +34 -0
- package/dist/src/functions/valuesGet.function.js.map +1 -0
- package/dist/src/functions/valuesUpdate.function.d.ts +155 -0
- package/dist/src/functions/valuesUpdate.function.d.ts.map +1 -0
- package/dist/src/functions/valuesUpdate.function.js +44 -0
- package/dist/src/functions/valuesUpdate.function.js.map +1 -0
- package/dist/src/google-sheets-api.service.d.ts +15 -0
- package/dist/src/google-sheets-api.service.d.ts.map +1 -0
- package/dist/src/google-sheets-api.service.js +426 -0
- package/dist/src/google-sheets-api.service.js.map +1 -0
- package/dist/src/google-sheets.credential.d.ts +10 -0
- package/dist/src/google-sheets.credential.d.ts.map +1 -0
- package/dist/src/google-sheets.credential.js +33 -0
- package/dist/src/google-sheets.credential.js.map +1 -0
- package/dist/src/google-sheets.types.d.ts +7 -0
- package/dist/src/google-sheets.types.d.ts.map +1 -0
- package/dist/src/google-sheets.types.js +8 -0
- package/dist/src/google-sheets.types.js.map +1 -0
- package/dist/src/google-sheets.variable.d.ts +5 -0
- package/dist/src/google-sheets.variable.d.ts.map +1 -0
- package/dist/src/google-sheets.variable.js +11 -0
- package/dist/src/google-sheets.variable.js.map +1 -0
- package/dist/src/index.d.ts +18 -0
- package/dist/src/index.d.ts.map +1 -0
- package/dist/src/index.js +18 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/services.d.ts +2 -0
- package/dist/src/services.d.ts.map +1 -0
- package/dist/src/services.js +7 -0
- package/dist/src/services.js.map +1 -0
- package/package.json +39 -0
|
@@ -0,0 +1,1356 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was generated by @pikku/cli@0.12.54
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* This provides the structure needed for typescript to be aware of RPCs and their return types
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
export type BatchUpdateInput = any
|
|
13
|
+
export type BatchUpdateOutput = any
|
|
14
|
+
export type CreateInput = any
|
|
15
|
+
export type CreateOutput = any
|
|
16
|
+
export type CredentialSchema_googleSheets = {
|
|
17
|
+
accessToken: string;
|
|
18
|
+
refreshToken?: string | undefined;
|
|
19
|
+
}
|
|
20
|
+
export type DeveloperMetadataGetInput = {
|
|
21
|
+
/** The ID of the spreadsheet to retrieve metadata from. */
|
|
22
|
+
spreadsheetId: string;
|
|
23
|
+
/** The ID of the developer metadata to retrieve. */
|
|
24
|
+
metadataId: number;
|
|
25
|
+
/** V1 error format. */
|
|
26
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
27
|
+
/** OAuth access token. */
|
|
28
|
+
access_token?: string | undefined;
|
|
29
|
+
/** Data format for response. */
|
|
30
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
31
|
+
/** JSONP */
|
|
32
|
+
callback?: string | undefined;
|
|
33
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
34
|
+
fields?: string | undefined;
|
|
35
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
36
|
+
key?: string | undefined;
|
|
37
|
+
/** OAuth 2.0 token for the current user. */
|
|
38
|
+
oauth_token?: string | undefined;
|
|
39
|
+
/** Returns response with indentations and line breaks. */
|
|
40
|
+
prettyPrint?: boolean | undefined;
|
|
41
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
42
|
+
quotaUser?: string | undefined;
|
|
43
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
44
|
+
upload_protocol?: string | undefined;
|
|
45
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
46
|
+
uploadType?: string | undefined;
|
|
47
|
+
}
|
|
48
|
+
export type DeveloperMetadataGetOutput = {
|
|
49
|
+
/** The location where the metadata is associated. */
|
|
50
|
+
location?: {
|
|
51
|
+
/** Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns. */
|
|
52
|
+
dimensionRange?: {
|
|
53
|
+
/** The dimension of the span. */
|
|
54
|
+
dimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
55
|
+
/** The end (exclusive) of the span, or not set if unbounded. */
|
|
56
|
+
endIndex?: number | undefined;
|
|
57
|
+
/** The sheet this span is on. */
|
|
58
|
+
sheetId?: number | undefined;
|
|
59
|
+
/** The start (inclusive) of the span, or not set if unbounded. */
|
|
60
|
+
startIndex?: number | undefined;
|
|
61
|
+
} | undefined;
|
|
62
|
+
/** The type of location this object represents. This field is read-only. */
|
|
63
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
64
|
+
/** The ID of the sheet when metadata is associated with an entire sheet. */
|
|
65
|
+
sheetId?: number | undefined;
|
|
66
|
+
/** True when metadata is associated with an entire spreadsheet. */
|
|
67
|
+
spreadsheet?: boolean | undefined;
|
|
68
|
+
} | undefined;
|
|
69
|
+
/** The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive. */
|
|
70
|
+
metadataId?: number | undefined;
|
|
71
|
+
/** The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified. */
|
|
72
|
+
metadataKey?: string | undefined;
|
|
73
|
+
/** Data associated with the metadata's key. */
|
|
74
|
+
metadataValue?: string | undefined;
|
|
75
|
+
/** The metadata visibility. Developer metadata must always have a visibility specified. */
|
|
76
|
+
visibility?: ("DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED" | "DOCUMENT" | "PROJECT") | undefined;
|
|
77
|
+
}
|
|
78
|
+
export type DeveloperMetadataSearchInput = {
|
|
79
|
+
/** The ID of the spreadsheet to retrieve metadata from. */
|
|
80
|
+
spreadsheetId: string;
|
|
81
|
+
/** V1 error format. */
|
|
82
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
83
|
+
/** OAuth access token. */
|
|
84
|
+
access_token?: string | undefined;
|
|
85
|
+
/** Data format for response. */
|
|
86
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
87
|
+
/** JSONP */
|
|
88
|
+
callback?: string | undefined;
|
|
89
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
90
|
+
fields?: string | undefined;
|
|
91
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
92
|
+
key?: string | undefined;
|
|
93
|
+
/** OAuth 2.0 token for the current user. */
|
|
94
|
+
oauth_token?: string | undefined;
|
|
95
|
+
/** Returns response with indentations and line breaks. */
|
|
96
|
+
prettyPrint?: boolean | undefined;
|
|
97
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
98
|
+
quotaUser?: string | undefined;
|
|
99
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
100
|
+
upload_protocol?: string | undefined;
|
|
101
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
102
|
+
uploadType?: string | undefined;
|
|
103
|
+
/** The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters are included in the response. */
|
|
104
|
+
dataFilters?: {
|
|
105
|
+
/** Selects data that matches the specified A1 range. */
|
|
106
|
+
a1Range?: string | undefined;
|
|
107
|
+
/** Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup. */
|
|
108
|
+
developerMetadataLookup?: {
|
|
109
|
+
/** Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified. */
|
|
110
|
+
locationMatchingStrategy?: ("DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED" | "EXACT_LOCATION" | "INTERSECTING_LOCATION") | undefined;
|
|
111
|
+
/** Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT. */
|
|
112
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
113
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id. */
|
|
114
|
+
metadataId?: number | undefined;
|
|
115
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key. */
|
|
116
|
+
metadataKey?: string | undefined;
|
|
117
|
+
/** Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy. */
|
|
118
|
+
metadataLocation?: {
|
|
119
|
+
/** Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns. */
|
|
120
|
+
dimensionRange?: {
|
|
121
|
+
/** The dimension of the span. */
|
|
122
|
+
dimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
123
|
+
/** The end (exclusive) of the span, or not set if unbounded. */
|
|
124
|
+
endIndex?: number | undefined;
|
|
125
|
+
/** The sheet this span is on. */
|
|
126
|
+
sheetId?: number | undefined;
|
|
127
|
+
/** The start (inclusive) of the span, or not set if unbounded. */
|
|
128
|
+
startIndex?: number | undefined;
|
|
129
|
+
} | undefined;
|
|
130
|
+
/** The type of location this object represents. This field is read-only. */
|
|
131
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
132
|
+
/** The ID of the sheet when metadata is associated with an entire sheet. */
|
|
133
|
+
sheetId?: number | undefined;
|
|
134
|
+
/** True when metadata is associated with an entire spreadsheet. */
|
|
135
|
+
spreadsheet?: boolean | undefined;
|
|
136
|
+
} | undefined;
|
|
137
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value. */
|
|
138
|
+
metadataValue?: string | undefined;
|
|
139
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered. */
|
|
140
|
+
visibility?: ("DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED" | "DOCUMENT" | "PROJECT") | undefined;
|
|
141
|
+
} | undefined;
|
|
142
|
+
/** Selects data that matches the range described by the GridRange. */
|
|
143
|
+
gridRange?: {
|
|
144
|
+
/** The end column (exclusive) of the range, or not set if unbounded. */
|
|
145
|
+
endColumnIndex?: number | undefined;
|
|
146
|
+
/** The end row (exclusive) of the range, or not set if unbounded. */
|
|
147
|
+
endRowIndex?: number | undefined;
|
|
148
|
+
/** The sheet this range is on. */
|
|
149
|
+
sheetId?: number | undefined;
|
|
150
|
+
/** The start column (inclusive) of the range, or not set if unbounded. */
|
|
151
|
+
startColumnIndex?: number | undefined;
|
|
152
|
+
/** The start row (inclusive) of the range, or not set if unbounded. */
|
|
153
|
+
startRowIndex?: number | undefined;
|
|
154
|
+
} | undefined;
|
|
155
|
+
}[] | undefined;
|
|
156
|
+
}
|
|
157
|
+
export type DeveloperMetadataSearchOutput = {
|
|
158
|
+
/** The metadata matching the criteria of the search request. */
|
|
159
|
+
matchedDeveloperMetadata?: {
|
|
160
|
+
/** All filters matching the returned developer metadata. */
|
|
161
|
+
dataFilters?: {
|
|
162
|
+
/** Selects data that matches the specified A1 range. */
|
|
163
|
+
a1Range?: string | undefined;
|
|
164
|
+
/** Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup. */
|
|
165
|
+
developerMetadataLookup?: {
|
|
166
|
+
/** Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified. */
|
|
167
|
+
locationMatchingStrategy?: ("DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED" | "EXACT_LOCATION" | "INTERSECTING_LOCATION") | undefined;
|
|
168
|
+
/** Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT. */
|
|
169
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
170
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id. */
|
|
171
|
+
metadataId?: number | undefined;
|
|
172
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key. */
|
|
173
|
+
metadataKey?: string | undefined;
|
|
174
|
+
/** Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy. */
|
|
175
|
+
metadataLocation?: {
|
|
176
|
+
/** Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns. */
|
|
177
|
+
dimensionRange?: {
|
|
178
|
+
/** The dimension of the span. */
|
|
179
|
+
dimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
180
|
+
/** The end (exclusive) of the span, or not set if unbounded. */
|
|
181
|
+
endIndex?: number | undefined;
|
|
182
|
+
/** The sheet this span is on. */
|
|
183
|
+
sheetId?: number | undefined;
|
|
184
|
+
/** The start (inclusive) of the span, or not set if unbounded. */
|
|
185
|
+
startIndex?: number | undefined;
|
|
186
|
+
} | undefined;
|
|
187
|
+
/** The type of location this object represents. This field is read-only. */
|
|
188
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
189
|
+
/** The ID of the sheet when metadata is associated with an entire sheet. */
|
|
190
|
+
sheetId?: number | undefined;
|
|
191
|
+
/** True when metadata is associated with an entire spreadsheet. */
|
|
192
|
+
spreadsheet?: boolean | undefined;
|
|
193
|
+
} | undefined;
|
|
194
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value. */
|
|
195
|
+
metadataValue?: string | undefined;
|
|
196
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered. */
|
|
197
|
+
visibility?: ("DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED" | "DOCUMENT" | "PROJECT") | undefined;
|
|
198
|
+
} | undefined;
|
|
199
|
+
/** Selects data that matches the range described by the GridRange. */
|
|
200
|
+
gridRange?: {
|
|
201
|
+
/** The end column (exclusive) of the range, or not set if unbounded. */
|
|
202
|
+
endColumnIndex?: number | undefined;
|
|
203
|
+
/** The end row (exclusive) of the range, or not set if unbounded. */
|
|
204
|
+
endRowIndex?: number | undefined;
|
|
205
|
+
/** The sheet this range is on. */
|
|
206
|
+
sheetId?: number | undefined;
|
|
207
|
+
/** The start column (inclusive) of the range, or not set if unbounded. */
|
|
208
|
+
startColumnIndex?: number | undefined;
|
|
209
|
+
/** The start row (inclusive) of the range, or not set if unbounded. */
|
|
210
|
+
startRowIndex?: number | undefined;
|
|
211
|
+
} | undefined;
|
|
212
|
+
}[] | undefined;
|
|
213
|
+
/** The developer metadata matching the specified filters. */
|
|
214
|
+
developerMetadata?: {
|
|
215
|
+
/** The location where the metadata is associated. */
|
|
216
|
+
location?: {
|
|
217
|
+
/** Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns. */
|
|
218
|
+
dimensionRange?: {
|
|
219
|
+
/** The dimension of the span. */
|
|
220
|
+
dimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
221
|
+
/** The end (exclusive) of the span, or not set if unbounded. */
|
|
222
|
+
endIndex?: number | undefined;
|
|
223
|
+
/** The sheet this span is on. */
|
|
224
|
+
sheetId?: number | undefined;
|
|
225
|
+
/** The start (inclusive) of the span, or not set if unbounded. */
|
|
226
|
+
startIndex?: number | undefined;
|
|
227
|
+
} | undefined;
|
|
228
|
+
/** The type of location this object represents. This field is read-only. */
|
|
229
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
230
|
+
/** The ID of the sheet when metadata is associated with an entire sheet. */
|
|
231
|
+
sheetId?: number | undefined;
|
|
232
|
+
/** True when metadata is associated with an entire spreadsheet. */
|
|
233
|
+
spreadsheet?: boolean | undefined;
|
|
234
|
+
} | undefined;
|
|
235
|
+
/** The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive. */
|
|
236
|
+
metadataId?: number | undefined;
|
|
237
|
+
/** The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified. */
|
|
238
|
+
metadataKey?: string | undefined;
|
|
239
|
+
/** Data associated with the metadata's key. */
|
|
240
|
+
metadataValue?: string | undefined;
|
|
241
|
+
/** The metadata visibility. Developer metadata must always have a visibility specified. */
|
|
242
|
+
visibility?: ("DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED" | "DOCUMENT" | "PROJECT") | undefined;
|
|
243
|
+
} | undefined;
|
|
244
|
+
}[] | undefined;
|
|
245
|
+
}
|
|
246
|
+
export type GetByDataFilterInput = {
|
|
247
|
+
/** The spreadsheet to request. */
|
|
248
|
+
spreadsheetId: string;
|
|
249
|
+
/** V1 error format. */
|
|
250
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
251
|
+
/** OAuth access token. */
|
|
252
|
+
access_token?: string | undefined;
|
|
253
|
+
/** Data format for response. */
|
|
254
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
255
|
+
/** JSONP */
|
|
256
|
+
callback?: string | undefined;
|
|
257
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
258
|
+
fields?: string | undefined;
|
|
259
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
260
|
+
key?: string | undefined;
|
|
261
|
+
/** OAuth 2.0 token for the current user. */
|
|
262
|
+
oauth_token?: string | undefined;
|
|
263
|
+
/** Returns response with indentations and line breaks. */
|
|
264
|
+
prettyPrint?: boolean | undefined;
|
|
265
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
266
|
+
quotaUser?: string | undefined;
|
|
267
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
268
|
+
upload_protocol?: string | undefined;
|
|
269
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
270
|
+
uploadType?: string | undefined;
|
|
271
|
+
/** The DataFilters used to select which ranges to retrieve from the spreadsheet. */
|
|
272
|
+
dataFilters?: {
|
|
273
|
+
/** Selects data that matches the specified A1 range. */
|
|
274
|
+
a1Range?: string | undefined;
|
|
275
|
+
/** Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup. */
|
|
276
|
+
developerMetadataLookup?: {
|
|
277
|
+
/** Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified. */
|
|
278
|
+
locationMatchingStrategy?: ("DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED" | "EXACT_LOCATION" | "INTERSECTING_LOCATION") | undefined;
|
|
279
|
+
/** Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT. */
|
|
280
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
281
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id. */
|
|
282
|
+
metadataId?: number | undefined;
|
|
283
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key. */
|
|
284
|
+
metadataKey?: string | undefined;
|
|
285
|
+
/** Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy. */
|
|
286
|
+
metadataLocation?: {
|
|
287
|
+
/** Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns. */
|
|
288
|
+
dimensionRange?: {
|
|
289
|
+
/** The dimension of the span. */
|
|
290
|
+
dimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
291
|
+
/** The end (exclusive) of the span, or not set if unbounded. */
|
|
292
|
+
endIndex?: number | undefined;
|
|
293
|
+
/** The sheet this span is on. */
|
|
294
|
+
sheetId?: number | undefined;
|
|
295
|
+
/** The start (inclusive) of the span, or not set if unbounded. */
|
|
296
|
+
startIndex?: number | undefined;
|
|
297
|
+
} | undefined;
|
|
298
|
+
/** The type of location this object represents. This field is read-only. */
|
|
299
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
300
|
+
/** The ID of the sheet when metadata is associated with an entire sheet. */
|
|
301
|
+
sheetId?: number | undefined;
|
|
302
|
+
/** True when metadata is associated with an entire spreadsheet. */
|
|
303
|
+
spreadsheet?: boolean | undefined;
|
|
304
|
+
} | undefined;
|
|
305
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value. */
|
|
306
|
+
metadataValue?: string | undefined;
|
|
307
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered. */
|
|
308
|
+
visibility?: ("DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED" | "DOCUMENT" | "PROJECT") | undefined;
|
|
309
|
+
} | undefined;
|
|
310
|
+
/** Selects data that matches the range described by the GridRange. */
|
|
311
|
+
gridRange?: {
|
|
312
|
+
/** The end column (exclusive) of the range, or not set if unbounded. */
|
|
313
|
+
endColumnIndex?: number | undefined;
|
|
314
|
+
/** The end row (exclusive) of the range, or not set if unbounded. */
|
|
315
|
+
endRowIndex?: number | undefined;
|
|
316
|
+
/** The sheet this range is on. */
|
|
317
|
+
sheetId?: number | undefined;
|
|
318
|
+
/** The start column (inclusive) of the range, or not set if unbounded. */
|
|
319
|
+
startColumnIndex?: number | undefined;
|
|
320
|
+
/** The start row (inclusive) of the range, or not set if unbounded. */
|
|
321
|
+
startRowIndex?: number | undefined;
|
|
322
|
+
} | undefined;
|
|
323
|
+
}[] | undefined;
|
|
324
|
+
/** True if grid data should be returned. This parameter is ignored if a field mask was set in the request. */
|
|
325
|
+
includeGridData?: boolean | undefined;
|
|
326
|
+
}
|
|
327
|
+
export type GetByDataFilterOutput = any
|
|
328
|
+
export type GetInput = {
|
|
329
|
+
/** The spreadsheet to request. */
|
|
330
|
+
spreadsheetId: string;
|
|
331
|
+
/** V1 error format. */
|
|
332
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
333
|
+
/** OAuth access token. */
|
|
334
|
+
access_token?: string | undefined;
|
|
335
|
+
/** Data format for response. */
|
|
336
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
337
|
+
/** JSONP */
|
|
338
|
+
callback?: string | undefined;
|
|
339
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
340
|
+
fields?: string | undefined;
|
|
341
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
342
|
+
key?: string | undefined;
|
|
343
|
+
/** OAuth 2.0 token for the current user. */
|
|
344
|
+
oauth_token?: string | undefined;
|
|
345
|
+
/** Returns response with indentations and line breaks. */
|
|
346
|
+
prettyPrint?: boolean | undefined;
|
|
347
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
348
|
+
quotaUser?: string | undefined;
|
|
349
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
350
|
+
upload_protocol?: string | undefined;
|
|
351
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
352
|
+
uploadType?: string | undefined;
|
|
353
|
+
/** True if grid data should be returned. This parameter is ignored if a field mask was set in the request. */
|
|
354
|
+
includeGridData?: boolean | undefined;
|
|
355
|
+
/** The ranges to retrieve from the spreadsheet. */
|
|
356
|
+
ranges?: string[] | undefined;
|
|
357
|
+
}
|
|
358
|
+
export type GetOutput = any
|
|
359
|
+
export type ReadRowsInput = {
|
|
360
|
+
/** The ID of the spreadsheet to read rows from. */
|
|
361
|
+
spreadsheetId: string;
|
|
362
|
+
/** The A1 notation of the range to read, e.g. `Sheet1!A:D`. The first row is treated as the header. */
|
|
363
|
+
range: string;
|
|
364
|
+
/** How cell values should be represented. */
|
|
365
|
+
valueRenderOption?: ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA") | undefined;
|
|
366
|
+
}
|
|
367
|
+
export type ReadRowsOutput = {
|
|
368
|
+
[key: string]: unknown;
|
|
369
|
+
}[]
|
|
370
|
+
export type SecretSchema_googleSheetsOAuthApp = {
|
|
371
|
+
/** OAuth2 app client ID */
|
|
372
|
+
clientId: string;
|
|
373
|
+
/** OAuth2 app client secret */
|
|
374
|
+
clientSecret: string;
|
|
375
|
+
}
|
|
376
|
+
export type SheetsCopyToInput = {
|
|
377
|
+
/** The ID of the spreadsheet containing the sheet to copy. */
|
|
378
|
+
spreadsheetId: string;
|
|
379
|
+
/** The ID of the sheet to copy. */
|
|
380
|
+
sheetId: number;
|
|
381
|
+
/** V1 error format. */
|
|
382
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
383
|
+
/** OAuth access token. */
|
|
384
|
+
access_token?: string | undefined;
|
|
385
|
+
/** Data format for response. */
|
|
386
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
387
|
+
/** JSONP */
|
|
388
|
+
callback?: string | undefined;
|
|
389
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
390
|
+
fields?: string | undefined;
|
|
391
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
392
|
+
key?: string | undefined;
|
|
393
|
+
/** OAuth 2.0 token for the current user. */
|
|
394
|
+
oauth_token?: string | undefined;
|
|
395
|
+
/** Returns response with indentations and line breaks. */
|
|
396
|
+
prettyPrint?: boolean | undefined;
|
|
397
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
398
|
+
quotaUser?: string | undefined;
|
|
399
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
400
|
+
upload_protocol?: string | undefined;
|
|
401
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
402
|
+
uploadType?: string | undefined;
|
|
403
|
+
/** The ID of the spreadsheet to copy the sheet to. */
|
|
404
|
+
destinationSpreadsheetId?: string | undefined;
|
|
405
|
+
}
|
|
406
|
+
export type SheetsCopyToOutput = {
|
|
407
|
+
/** Output only. If present, the field contains DATA_SOURCE sheet specific properties. */
|
|
408
|
+
dataSourceSheetProperties?: {
|
|
409
|
+
/** The columns displayed on the sheet, corresponding to the values in RowData. */
|
|
410
|
+
columns?: {
|
|
411
|
+
/** The formula of the calculated column. */
|
|
412
|
+
formula?: string | undefined;
|
|
413
|
+
/** The column reference. */
|
|
414
|
+
reference?: {
|
|
415
|
+
/** The display name of the column. It should be unique within a data source. */
|
|
416
|
+
name?: string | undefined;
|
|
417
|
+
} | undefined;
|
|
418
|
+
}[] | undefined;
|
|
419
|
+
/** The data execution status. */
|
|
420
|
+
dataExecutionStatus?: {
|
|
421
|
+
/** The error code. */
|
|
422
|
+
errorCode?: ("DATA_EXECUTION_ERROR_CODE_UNSPECIFIED" | "TIMED_OUT" | "TOO_MANY_ROWS" | "TOO_MANY_COLUMNS" | "TOO_MANY_CELLS" | "ENGINE" | "PARAMETER_INVALID" | "UNSUPPORTED_DATA_TYPE" | "DUPLICATE_COLUMN_NAMES" | "INTERRUPTED" | "CONCURRENT_QUERY" | "OTHER" | "TOO_MANY_CHARS_PER_CELL" | "DATA_NOT_FOUND" | "PERMISSION_DENIED" | "MISSING_COLUMN_ALIAS" | "OBJECT_NOT_FOUND" | "OBJECT_IN_ERROR_STATE" | "OBJECT_SPEC_INVALID") | undefined;
|
|
423
|
+
/** The error message, which may be empty. */
|
|
424
|
+
errorMessage?: string | undefined;
|
|
425
|
+
/** Gets the time the data last successfully refreshed. */
|
|
426
|
+
lastRefreshTime?: string | undefined;
|
|
427
|
+
/** The state of the data execution. */
|
|
428
|
+
state?: ("DATA_EXECUTION_STATE_UNSPECIFIED" | "NOT_STARTED" | "RUNNING" | "SUCCEEDED" | "FAILED") | undefined;
|
|
429
|
+
} | undefined;
|
|
430
|
+
/** ID of the DataSource the sheet is connected to. */
|
|
431
|
+
dataSourceId?: string | undefined;
|
|
432
|
+
} | undefined;
|
|
433
|
+
/** Additional properties of the sheet if this sheet is a grid. (If the sheet is an object sheet, containing a chart or image, then this field will be absent.) When writing it is an error to set any grid properties on non-grid sheets. If this sheet is a DATA_SOURCE sheet, this field is output only but contains the properties that reflect how a data source sheet is rendered in the UI, e.g. row_count. */
|
|
434
|
+
gridProperties?: {
|
|
435
|
+
/** The number of columns in the grid. */
|
|
436
|
+
columnCount?: number | undefined;
|
|
437
|
+
/** True if the column grouping control toggle is shown after the group. */
|
|
438
|
+
columnGroupControlAfter?: boolean | undefined;
|
|
439
|
+
/** The number of columns that are frozen in the grid. */
|
|
440
|
+
frozenColumnCount?: number | undefined;
|
|
441
|
+
/** The number of rows that are frozen in the grid. */
|
|
442
|
+
frozenRowCount?: number | undefined;
|
|
443
|
+
/** True if the grid isn't showing gridlines in the UI. */
|
|
444
|
+
hideGridlines?: boolean | undefined;
|
|
445
|
+
/** The number of rows in the grid. */
|
|
446
|
+
rowCount?: number | undefined;
|
|
447
|
+
/** True if the row grouping control toggle is shown after the group. */
|
|
448
|
+
rowGroupControlAfter?: boolean | undefined;
|
|
449
|
+
} | undefined;
|
|
450
|
+
/** True if the sheet is hidden in the UI, false if it's visible. */
|
|
451
|
+
hidden?: boolean | undefined;
|
|
452
|
+
/** The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in "before the move" indexes. For example, if there were 3 sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1. */
|
|
453
|
+
index?: number | undefined;
|
|
454
|
+
/** True if the sheet is an RTL sheet instead of an LTR sheet. */
|
|
455
|
+
rightToLeft?: boolean | undefined;
|
|
456
|
+
/** The ID of the sheet. Must be non-negative. This field cannot be changed once set. */
|
|
457
|
+
sheetId?: number | undefined;
|
|
458
|
+
/** The type of sheet. Defaults to GRID. This field cannot be changed once set. */
|
|
459
|
+
sheetType?: ("SHEET_TYPE_UNSPECIFIED" | "GRID" | "OBJECT" | "DATA_SOURCE") | undefined;
|
|
460
|
+
/** The color of the tab in the UI. Deprecated: Use tab_color_style. */
|
|
461
|
+
tabColor?: {
|
|
462
|
+
/** The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). */
|
|
463
|
+
alpha?: number | undefined;
|
|
464
|
+
/** The amount of blue in the color as a value in the interval [0, 1]. */
|
|
465
|
+
blue?: number | undefined;
|
|
466
|
+
/** The amount of green in the color as a value in the interval [0, 1]. */
|
|
467
|
+
green?: number | undefined;
|
|
468
|
+
/** The amount of red in the color as a value in the interval [0, 1]. */
|
|
469
|
+
red?: number | undefined;
|
|
470
|
+
} | undefined;
|
|
471
|
+
/** The color of the tab in the UI. If tab_color is also set, this field takes precedence. */
|
|
472
|
+
tabColorStyle?: {
|
|
473
|
+
/** RGB color. The [`alpha`](/sheets/api/reference/rest/v4/spreadsheets/other#Color.FIELDS.alpha) value in the [`Color`](/sheets/api/reference/rest/v4/spreadsheets/other#color) object isn't generally supported. */
|
|
474
|
+
rgbColor?: {
|
|
475
|
+
/** The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). */
|
|
476
|
+
alpha?: number | undefined;
|
|
477
|
+
/** The amount of blue in the color as a value in the interval [0, 1]. */
|
|
478
|
+
blue?: number | undefined;
|
|
479
|
+
/** The amount of green in the color as a value in the interval [0, 1]. */
|
|
480
|
+
green?: number | undefined;
|
|
481
|
+
/** The amount of red in the color as a value in the interval [0, 1]. */
|
|
482
|
+
red?: number | undefined;
|
|
483
|
+
} | undefined;
|
|
484
|
+
/** Theme color. */
|
|
485
|
+
themeColor?: ("THEME_COLOR_TYPE_UNSPECIFIED" | "TEXT" | "BACKGROUND" | "ACCENT1" | "ACCENT2" | "ACCENT3" | "ACCENT4" | "ACCENT5" | "ACCENT6" | "LINK") | undefined;
|
|
486
|
+
} | undefined;
|
|
487
|
+
/** The name of the sheet. */
|
|
488
|
+
title?: string | undefined;
|
|
489
|
+
}
|
|
490
|
+
export type ValuesAppendInput = {
|
|
491
|
+
/** The ID of the spreadsheet to update. */
|
|
492
|
+
spreadsheetId: string;
|
|
493
|
+
/** The [A1 notation](/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table. */
|
|
494
|
+
range: string;
|
|
495
|
+
/** V1 error format. */
|
|
496
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
497
|
+
/** OAuth access token. */
|
|
498
|
+
access_token?: string | undefined;
|
|
499
|
+
/** Data format for response. */
|
|
500
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
501
|
+
/** JSONP */
|
|
502
|
+
callback?: string | undefined;
|
|
503
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
504
|
+
fields?: string | undefined;
|
|
505
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
506
|
+
key?: string | undefined;
|
|
507
|
+
/** OAuth 2.0 token for the current user. */
|
|
508
|
+
oauth_token?: string | undefined;
|
|
509
|
+
/** Returns response with indentations and line breaks. */
|
|
510
|
+
prettyPrint?: boolean | undefined;
|
|
511
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
512
|
+
quotaUser?: string | undefined;
|
|
513
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
514
|
+
upload_protocol?: string | undefined;
|
|
515
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
516
|
+
uploadType?: string | undefined;
|
|
517
|
+
/** Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values. */
|
|
518
|
+
includeValuesInResponse?: boolean | undefined;
|
|
519
|
+
/** How the input data should be inserted. */
|
|
520
|
+
insertDataOption?: ("OVERWRITE" | "INSERT_ROWS") | undefined;
|
|
521
|
+
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
522
|
+
responseDateTimeRenderOption?: ("SERIAL_NUMBER" | "FORMATTED_STRING") | undefined;
|
|
523
|
+
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
524
|
+
responseValueRenderOption?: ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA") | undefined;
|
|
525
|
+
/** How the input data should be interpreted. */
|
|
526
|
+
valueInputOption?: ("INPUT_VALUE_OPTION_UNSPECIFIED" | "RAW" | "USER_ENTERED") | undefined;
|
|
527
|
+
/** The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */
|
|
528
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
529
|
+
/** The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */
|
|
530
|
+
values?: unknown[][] | undefined;
|
|
531
|
+
}
|
|
532
|
+
export type ValuesAppendOutput = {
|
|
533
|
+
/** The spreadsheet the updates were applied to. */
|
|
534
|
+
spreadsheetId?: string | undefined;
|
|
535
|
+
/** The range (in A1 notation) of the table that values are being appended to (before the values were appended). Empty if no table was found. */
|
|
536
|
+
tableRange?: string | undefined;
|
|
537
|
+
/** Information about the updates that were applied. */
|
|
538
|
+
updates?: {
|
|
539
|
+
/** The spreadsheet the updates were applied to. */
|
|
540
|
+
spreadsheetId?: string | undefined;
|
|
541
|
+
/** The number of cells updated. */
|
|
542
|
+
updatedCells?: number | undefined;
|
|
543
|
+
/** The number of columns where at least one cell in the column was updated. */
|
|
544
|
+
updatedColumns?: number | undefined;
|
|
545
|
+
/** The values of the cells after updates were applied. This is only included if the request's `includeValuesInResponse` field was `true`. */
|
|
546
|
+
updatedData?: {
|
|
547
|
+
/** The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */
|
|
548
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
549
|
+
/** The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. */
|
|
550
|
+
range?: string | undefined;
|
|
551
|
+
/** The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */
|
|
552
|
+
values?: unknown[][] | undefined;
|
|
553
|
+
} | undefined;
|
|
554
|
+
/** The range (in A1 notation) that updates were applied to. */
|
|
555
|
+
updatedRange?: string | undefined;
|
|
556
|
+
/** The number of rows where at least one cell in the row was updated. */
|
|
557
|
+
updatedRows?: number | undefined;
|
|
558
|
+
} | undefined;
|
|
559
|
+
}
|
|
560
|
+
export type ValuesBatchClearByDataFilterInput = {
|
|
561
|
+
/** The ID of the spreadsheet to update. */
|
|
562
|
+
spreadsheetId: string;
|
|
563
|
+
/** V1 error format. */
|
|
564
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
565
|
+
/** OAuth access token. */
|
|
566
|
+
access_token?: string | undefined;
|
|
567
|
+
/** Data format for response. */
|
|
568
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
569
|
+
/** JSONP */
|
|
570
|
+
callback?: string | undefined;
|
|
571
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
572
|
+
fields?: string | undefined;
|
|
573
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
574
|
+
key?: string | undefined;
|
|
575
|
+
/** OAuth 2.0 token for the current user. */
|
|
576
|
+
oauth_token?: string | undefined;
|
|
577
|
+
/** Returns response with indentations and line breaks. */
|
|
578
|
+
prettyPrint?: boolean | undefined;
|
|
579
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
580
|
+
quotaUser?: string | undefined;
|
|
581
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
582
|
+
upload_protocol?: string | undefined;
|
|
583
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
584
|
+
uploadType?: string | undefined;
|
|
585
|
+
/** The DataFilters used to determine which ranges to clear. */
|
|
586
|
+
dataFilters?: {
|
|
587
|
+
/** Selects data that matches the specified A1 range. */
|
|
588
|
+
a1Range?: string | undefined;
|
|
589
|
+
/** Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup. */
|
|
590
|
+
developerMetadataLookup?: {
|
|
591
|
+
/** Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified. */
|
|
592
|
+
locationMatchingStrategy?: ("DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED" | "EXACT_LOCATION" | "INTERSECTING_LOCATION") | undefined;
|
|
593
|
+
/** Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT. */
|
|
594
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
595
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id. */
|
|
596
|
+
metadataId?: number | undefined;
|
|
597
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key. */
|
|
598
|
+
metadataKey?: string | undefined;
|
|
599
|
+
/** Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy. */
|
|
600
|
+
metadataLocation?: {
|
|
601
|
+
/** Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns. */
|
|
602
|
+
dimensionRange?: {
|
|
603
|
+
/** The dimension of the span. */
|
|
604
|
+
dimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
605
|
+
/** The end (exclusive) of the span, or not set if unbounded. */
|
|
606
|
+
endIndex?: number | undefined;
|
|
607
|
+
/** The sheet this span is on. */
|
|
608
|
+
sheetId?: number | undefined;
|
|
609
|
+
/** The start (inclusive) of the span, or not set if unbounded. */
|
|
610
|
+
startIndex?: number | undefined;
|
|
611
|
+
} | undefined;
|
|
612
|
+
/** The type of location this object represents. This field is read-only. */
|
|
613
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
614
|
+
/** The ID of the sheet when metadata is associated with an entire sheet. */
|
|
615
|
+
sheetId?: number | undefined;
|
|
616
|
+
/** True when metadata is associated with an entire spreadsheet. */
|
|
617
|
+
spreadsheet?: boolean | undefined;
|
|
618
|
+
} | undefined;
|
|
619
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value. */
|
|
620
|
+
metadataValue?: string | undefined;
|
|
621
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered. */
|
|
622
|
+
visibility?: ("DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED" | "DOCUMENT" | "PROJECT") | undefined;
|
|
623
|
+
} | undefined;
|
|
624
|
+
/** Selects data that matches the range described by the GridRange. */
|
|
625
|
+
gridRange?: {
|
|
626
|
+
/** The end column (exclusive) of the range, or not set if unbounded. */
|
|
627
|
+
endColumnIndex?: number | undefined;
|
|
628
|
+
/** The end row (exclusive) of the range, or not set if unbounded. */
|
|
629
|
+
endRowIndex?: number | undefined;
|
|
630
|
+
/** The sheet this range is on. */
|
|
631
|
+
sheetId?: number | undefined;
|
|
632
|
+
/** The start column (inclusive) of the range, or not set if unbounded. */
|
|
633
|
+
startColumnIndex?: number | undefined;
|
|
634
|
+
/** The start row (inclusive) of the range, or not set if unbounded. */
|
|
635
|
+
startRowIndex?: number | undefined;
|
|
636
|
+
} | undefined;
|
|
637
|
+
}[] | undefined;
|
|
638
|
+
}
|
|
639
|
+
export type ValuesBatchClearByDataFilterOutput = {
|
|
640
|
+
/** The ranges that were cleared, in [A1 notation](/sheets/api/guides/concepts#cell). If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits. */
|
|
641
|
+
clearedRanges?: string[] | undefined;
|
|
642
|
+
/** The spreadsheet the updates were applied to. */
|
|
643
|
+
spreadsheetId?: string | undefined;
|
|
644
|
+
}
|
|
645
|
+
export type ValuesBatchClearInput = {
|
|
646
|
+
/** The ID of the spreadsheet to update. */
|
|
647
|
+
spreadsheetId: string;
|
|
648
|
+
/** V1 error format. */
|
|
649
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
650
|
+
/** OAuth access token. */
|
|
651
|
+
access_token?: string | undefined;
|
|
652
|
+
/** Data format for response. */
|
|
653
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
654
|
+
/** JSONP */
|
|
655
|
+
callback?: string | undefined;
|
|
656
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
657
|
+
fields?: string | undefined;
|
|
658
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
659
|
+
key?: string | undefined;
|
|
660
|
+
/** OAuth 2.0 token for the current user. */
|
|
661
|
+
oauth_token?: string | undefined;
|
|
662
|
+
/** Returns response with indentations and line breaks. */
|
|
663
|
+
prettyPrint?: boolean | undefined;
|
|
664
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
665
|
+
quotaUser?: string | undefined;
|
|
666
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
667
|
+
upload_protocol?: string | undefined;
|
|
668
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
669
|
+
uploadType?: string | undefined;
|
|
670
|
+
/** The ranges to clear, in [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell). */
|
|
671
|
+
ranges?: string[] | undefined;
|
|
672
|
+
}
|
|
673
|
+
export type ValuesBatchClearOutput = {
|
|
674
|
+
/** The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits. */
|
|
675
|
+
clearedRanges?: string[] | undefined;
|
|
676
|
+
/** The spreadsheet the updates were applied to. */
|
|
677
|
+
spreadsheetId?: string | undefined;
|
|
678
|
+
}
|
|
679
|
+
export type ValuesBatchGetByDataFilterInput = {
|
|
680
|
+
/** The ID of the spreadsheet to retrieve data from. */
|
|
681
|
+
spreadsheetId: string;
|
|
682
|
+
/** V1 error format. */
|
|
683
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
684
|
+
/** OAuth access token. */
|
|
685
|
+
access_token?: string | undefined;
|
|
686
|
+
/** Data format for response. */
|
|
687
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
688
|
+
/** JSONP */
|
|
689
|
+
callback?: string | undefined;
|
|
690
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
691
|
+
fields?: string | undefined;
|
|
692
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
693
|
+
key?: string | undefined;
|
|
694
|
+
/** OAuth 2.0 token for the current user. */
|
|
695
|
+
oauth_token?: string | undefined;
|
|
696
|
+
/** Returns response with indentations and line breaks. */
|
|
697
|
+
prettyPrint?: boolean | undefined;
|
|
698
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
699
|
+
quotaUser?: string | undefined;
|
|
700
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
701
|
+
upload_protocol?: string | undefined;
|
|
702
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
703
|
+
uploadType?: string | undefined;
|
|
704
|
+
/** The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters are included in the response. */
|
|
705
|
+
dataFilters?: {
|
|
706
|
+
/** Selects data that matches the specified A1 range. */
|
|
707
|
+
a1Range?: string | undefined;
|
|
708
|
+
/** Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup. */
|
|
709
|
+
developerMetadataLookup?: {
|
|
710
|
+
/** Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified. */
|
|
711
|
+
locationMatchingStrategy?: ("DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED" | "EXACT_LOCATION" | "INTERSECTING_LOCATION") | undefined;
|
|
712
|
+
/** Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT. */
|
|
713
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
714
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id. */
|
|
715
|
+
metadataId?: number | undefined;
|
|
716
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key. */
|
|
717
|
+
metadataKey?: string | undefined;
|
|
718
|
+
/** Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy. */
|
|
719
|
+
metadataLocation?: {
|
|
720
|
+
/** Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns. */
|
|
721
|
+
dimensionRange?: {
|
|
722
|
+
/** The dimension of the span. */
|
|
723
|
+
dimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
724
|
+
/** The end (exclusive) of the span, or not set if unbounded. */
|
|
725
|
+
endIndex?: number | undefined;
|
|
726
|
+
/** The sheet this span is on. */
|
|
727
|
+
sheetId?: number | undefined;
|
|
728
|
+
/** The start (inclusive) of the span, or not set if unbounded. */
|
|
729
|
+
startIndex?: number | undefined;
|
|
730
|
+
} | undefined;
|
|
731
|
+
/** The type of location this object represents. This field is read-only. */
|
|
732
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
733
|
+
/** The ID of the sheet when metadata is associated with an entire sheet. */
|
|
734
|
+
sheetId?: number | undefined;
|
|
735
|
+
/** True when metadata is associated with an entire spreadsheet. */
|
|
736
|
+
spreadsheet?: boolean | undefined;
|
|
737
|
+
} | undefined;
|
|
738
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value. */
|
|
739
|
+
metadataValue?: string | undefined;
|
|
740
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered. */
|
|
741
|
+
visibility?: ("DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED" | "DOCUMENT" | "PROJECT") | undefined;
|
|
742
|
+
} | undefined;
|
|
743
|
+
/** Selects data that matches the range described by the GridRange. */
|
|
744
|
+
gridRange?: {
|
|
745
|
+
/** The end column (exclusive) of the range, or not set if unbounded. */
|
|
746
|
+
endColumnIndex?: number | undefined;
|
|
747
|
+
/** The end row (exclusive) of the range, or not set if unbounded. */
|
|
748
|
+
endRowIndex?: number | undefined;
|
|
749
|
+
/** The sheet this range is on. */
|
|
750
|
+
sheetId?: number | undefined;
|
|
751
|
+
/** The start column (inclusive) of the range, or not set if unbounded. */
|
|
752
|
+
startColumnIndex?: number | undefined;
|
|
753
|
+
/** The start row (inclusive) of the range, or not set if unbounded. */
|
|
754
|
+
startRowIndex?: number | undefined;
|
|
755
|
+
} | undefined;
|
|
756
|
+
}[] | undefined;
|
|
757
|
+
/** How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
758
|
+
dateTimeRenderOption?: ("SERIAL_NUMBER" | "FORMATTED_STRING") | undefined;
|
|
759
|
+
/** The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. */
|
|
760
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
761
|
+
/** How values should be represented in the output. The default render option is FORMATTED_VALUE. */
|
|
762
|
+
valueRenderOption?: ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA") | undefined;
|
|
763
|
+
}
|
|
764
|
+
export type ValuesBatchGetByDataFilterOutput = {
|
|
765
|
+
/** The ID of the spreadsheet the data was retrieved from. */
|
|
766
|
+
spreadsheetId?: string | undefined;
|
|
767
|
+
/** The requested values with the list of data filters that matched them. */
|
|
768
|
+
valueRanges?: {
|
|
769
|
+
/** The DataFilters from the request that matched the range of values. */
|
|
770
|
+
dataFilters?: {
|
|
771
|
+
/** Selects data that matches the specified A1 range. */
|
|
772
|
+
a1Range?: string | undefined;
|
|
773
|
+
/** Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup. */
|
|
774
|
+
developerMetadataLookup?: {
|
|
775
|
+
/** Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified. */
|
|
776
|
+
locationMatchingStrategy?: ("DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED" | "EXACT_LOCATION" | "INTERSECTING_LOCATION") | undefined;
|
|
777
|
+
/** Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT. */
|
|
778
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
779
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id. */
|
|
780
|
+
metadataId?: number | undefined;
|
|
781
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key. */
|
|
782
|
+
metadataKey?: string | undefined;
|
|
783
|
+
/** Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy. */
|
|
784
|
+
metadataLocation?: {
|
|
785
|
+
/** Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns. */
|
|
786
|
+
dimensionRange?: {
|
|
787
|
+
/** The dimension of the span. */
|
|
788
|
+
dimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
789
|
+
/** The end (exclusive) of the span, or not set if unbounded. */
|
|
790
|
+
endIndex?: number | undefined;
|
|
791
|
+
/** The sheet this span is on. */
|
|
792
|
+
sheetId?: number | undefined;
|
|
793
|
+
/** The start (inclusive) of the span, or not set if unbounded. */
|
|
794
|
+
startIndex?: number | undefined;
|
|
795
|
+
} | undefined;
|
|
796
|
+
/** The type of location this object represents. This field is read-only. */
|
|
797
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
798
|
+
/** The ID of the sheet when metadata is associated with an entire sheet. */
|
|
799
|
+
sheetId?: number | undefined;
|
|
800
|
+
/** True when metadata is associated with an entire spreadsheet. */
|
|
801
|
+
spreadsheet?: boolean | undefined;
|
|
802
|
+
} | undefined;
|
|
803
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value. */
|
|
804
|
+
metadataValue?: string | undefined;
|
|
805
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered. */
|
|
806
|
+
visibility?: ("DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED" | "DOCUMENT" | "PROJECT") | undefined;
|
|
807
|
+
} | undefined;
|
|
808
|
+
/** Selects data that matches the range described by the GridRange. */
|
|
809
|
+
gridRange?: {
|
|
810
|
+
/** The end column (exclusive) of the range, or not set if unbounded. */
|
|
811
|
+
endColumnIndex?: number | undefined;
|
|
812
|
+
/** The end row (exclusive) of the range, or not set if unbounded. */
|
|
813
|
+
endRowIndex?: number | undefined;
|
|
814
|
+
/** The sheet this range is on. */
|
|
815
|
+
sheetId?: number | undefined;
|
|
816
|
+
/** The start column (inclusive) of the range, or not set if unbounded. */
|
|
817
|
+
startColumnIndex?: number | undefined;
|
|
818
|
+
/** The start row (inclusive) of the range, or not set if unbounded. */
|
|
819
|
+
startRowIndex?: number | undefined;
|
|
820
|
+
} | undefined;
|
|
821
|
+
}[] | undefined;
|
|
822
|
+
/** The values matched by the DataFilter. */
|
|
823
|
+
valueRange?: {
|
|
824
|
+
/** The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */
|
|
825
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
826
|
+
/** The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. */
|
|
827
|
+
range?: string | undefined;
|
|
828
|
+
/** The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */
|
|
829
|
+
values?: unknown[][] | undefined;
|
|
830
|
+
} | undefined;
|
|
831
|
+
}[] | undefined;
|
|
832
|
+
}
|
|
833
|
+
export type ValuesBatchGetInput = {
|
|
834
|
+
/** The ID of the spreadsheet to retrieve data from. */
|
|
835
|
+
spreadsheetId: string;
|
|
836
|
+
/** V1 error format. */
|
|
837
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
838
|
+
/** OAuth access token. */
|
|
839
|
+
access_token?: string | undefined;
|
|
840
|
+
/** Data format for response. */
|
|
841
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
842
|
+
/** JSONP */
|
|
843
|
+
callback?: string | undefined;
|
|
844
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
845
|
+
fields?: string | undefined;
|
|
846
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
847
|
+
key?: string | undefined;
|
|
848
|
+
/** OAuth 2.0 token for the current user. */
|
|
849
|
+
oauth_token?: string | undefined;
|
|
850
|
+
/** Returns response with indentations and line breaks. */
|
|
851
|
+
prettyPrint?: boolean | undefined;
|
|
852
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
853
|
+
quotaUser?: string | undefined;
|
|
854
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
855
|
+
upload_protocol?: string | undefined;
|
|
856
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
857
|
+
uploadType?: string | undefined;
|
|
858
|
+
/** How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
859
|
+
dateTimeRenderOption?: ("SERIAL_NUMBER" | "FORMATTED_STRING") | undefined;
|
|
860
|
+
/** The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=["A1:B2"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=["A1:B2"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. */
|
|
861
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
862
|
+
/** The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from. */
|
|
863
|
+
ranges?: string[] | undefined;
|
|
864
|
+
/** How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE. */
|
|
865
|
+
valueRenderOption?: ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA") | undefined;
|
|
866
|
+
}
|
|
867
|
+
export type ValuesBatchGetOutput = {
|
|
868
|
+
/** The ID of the spreadsheet the data was retrieved from. */
|
|
869
|
+
spreadsheetId?: string | undefined;
|
|
870
|
+
/** The requested values. The order of the ValueRanges is the same as the order of the requested ranges. */
|
|
871
|
+
valueRanges?: {
|
|
872
|
+
/** The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */
|
|
873
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
874
|
+
/** The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. */
|
|
875
|
+
range?: string | undefined;
|
|
876
|
+
/** The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */
|
|
877
|
+
values?: unknown[][] | undefined;
|
|
878
|
+
}[] | undefined;
|
|
879
|
+
}
|
|
880
|
+
export type ValuesBatchUpdateByDataFilterInput = {
|
|
881
|
+
/** The ID of the spreadsheet to update. */
|
|
882
|
+
spreadsheetId: string;
|
|
883
|
+
/** V1 error format. */
|
|
884
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
885
|
+
/** OAuth access token. */
|
|
886
|
+
access_token?: string | undefined;
|
|
887
|
+
/** Data format for response. */
|
|
888
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
889
|
+
/** JSONP */
|
|
890
|
+
callback?: string | undefined;
|
|
891
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
892
|
+
fields?: string | undefined;
|
|
893
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
894
|
+
key?: string | undefined;
|
|
895
|
+
/** OAuth 2.0 token for the current user. */
|
|
896
|
+
oauth_token?: string | undefined;
|
|
897
|
+
/** Returns response with indentations and line breaks. */
|
|
898
|
+
prettyPrint?: boolean | undefined;
|
|
899
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
900
|
+
quotaUser?: string | undefined;
|
|
901
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
902
|
+
upload_protocol?: string | undefined;
|
|
903
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
904
|
+
uploadType?: string | undefined;
|
|
905
|
+
/** The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values are applied to all of those ranges. */
|
|
906
|
+
data?: {
|
|
907
|
+
/** The data filter describing the location of the values in the spreadsheet. */
|
|
908
|
+
dataFilter?: {
|
|
909
|
+
/** Selects data that matches the specified A1 range. */
|
|
910
|
+
a1Range?: string | undefined;
|
|
911
|
+
/** Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup. */
|
|
912
|
+
developerMetadataLookup?: {
|
|
913
|
+
/** Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified. */
|
|
914
|
+
locationMatchingStrategy?: ("DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED" | "EXACT_LOCATION" | "INTERSECTING_LOCATION") | undefined;
|
|
915
|
+
/** Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT. */
|
|
916
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
917
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id. */
|
|
918
|
+
metadataId?: number | undefined;
|
|
919
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key. */
|
|
920
|
+
metadataKey?: string | undefined;
|
|
921
|
+
/** Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy. */
|
|
922
|
+
metadataLocation?: {
|
|
923
|
+
/** Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns. */
|
|
924
|
+
dimensionRange?: {
|
|
925
|
+
/** The dimension of the span. */
|
|
926
|
+
dimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
927
|
+
/** The end (exclusive) of the span, or not set if unbounded. */
|
|
928
|
+
endIndex?: number | undefined;
|
|
929
|
+
/** The sheet this span is on. */
|
|
930
|
+
sheetId?: number | undefined;
|
|
931
|
+
/** The start (inclusive) of the span, or not set if unbounded. */
|
|
932
|
+
startIndex?: number | undefined;
|
|
933
|
+
} | undefined;
|
|
934
|
+
/** The type of location this object represents. This field is read-only. */
|
|
935
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
936
|
+
/** The ID of the sheet when metadata is associated with an entire sheet. */
|
|
937
|
+
sheetId?: number | undefined;
|
|
938
|
+
/** True when metadata is associated with an entire spreadsheet. */
|
|
939
|
+
spreadsheet?: boolean | undefined;
|
|
940
|
+
} | undefined;
|
|
941
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value. */
|
|
942
|
+
metadataValue?: string | undefined;
|
|
943
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered. */
|
|
944
|
+
visibility?: ("DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED" | "DOCUMENT" | "PROJECT") | undefined;
|
|
945
|
+
} | undefined;
|
|
946
|
+
/** Selects data that matches the range described by the GridRange. */
|
|
947
|
+
gridRange?: {
|
|
948
|
+
/** The end column (exclusive) of the range, or not set if unbounded. */
|
|
949
|
+
endColumnIndex?: number | undefined;
|
|
950
|
+
/** The end row (exclusive) of the range, or not set if unbounded. */
|
|
951
|
+
endRowIndex?: number | undefined;
|
|
952
|
+
/** The sheet this range is on. */
|
|
953
|
+
sheetId?: number | undefined;
|
|
954
|
+
/** The start column (inclusive) of the range, or not set if unbounded. */
|
|
955
|
+
startColumnIndex?: number | undefined;
|
|
956
|
+
/** The start row (inclusive) of the range, or not set if unbounded. */
|
|
957
|
+
startRowIndex?: number | undefined;
|
|
958
|
+
} | undefined;
|
|
959
|
+
} | undefined;
|
|
960
|
+
/** The major dimension of the values. */
|
|
961
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
962
|
+
/** The data to be written. If the provided values exceed any of the ranges matched by the data filter then the request fails. If the provided values are less than the matched ranges only the specified values are written, existing values in the matched ranges remain unaffected. */
|
|
963
|
+
values?: unknown[][] | undefined;
|
|
964
|
+
}[] | undefined;
|
|
965
|
+
/** Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). */
|
|
966
|
+
includeValuesInResponse?: boolean | undefined;
|
|
967
|
+
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
968
|
+
responseDateTimeRenderOption?: ("SERIAL_NUMBER" | "FORMATTED_STRING") | undefined;
|
|
969
|
+
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
970
|
+
responseValueRenderOption?: ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA") | undefined;
|
|
971
|
+
/** How the input data should be interpreted. */
|
|
972
|
+
valueInputOption?: ("INPUT_VALUE_OPTION_UNSPECIFIED" | "RAW" | "USER_ENTERED") | undefined;
|
|
973
|
+
}
|
|
974
|
+
export type ValuesBatchUpdateByDataFilterOutput = {
|
|
975
|
+
/** The response for each range updated. */
|
|
976
|
+
responses?: {
|
|
977
|
+
/** The data filter that selected the range that was updated. */
|
|
978
|
+
dataFilter?: {
|
|
979
|
+
/** Selects data that matches the specified A1 range. */
|
|
980
|
+
a1Range?: string | undefined;
|
|
981
|
+
/** Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup. */
|
|
982
|
+
developerMetadataLookup?: {
|
|
983
|
+
/** Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified. */
|
|
984
|
+
locationMatchingStrategy?: ("DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED" | "EXACT_LOCATION" | "INTERSECTING_LOCATION") | undefined;
|
|
985
|
+
/** Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT. */
|
|
986
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
987
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id. */
|
|
988
|
+
metadataId?: number | undefined;
|
|
989
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key. */
|
|
990
|
+
metadataKey?: string | undefined;
|
|
991
|
+
/** Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy. */
|
|
992
|
+
metadataLocation?: {
|
|
993
|
+
/** Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns. */
|
|
994
|
+
dimensionRange?: {
|
|
995
|
+
/** The dimension of the span. */
|
|
996
|
+
dimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
997
|
+
/** The end (exclusive) of the span, or not set if unbounded. */
|
|
998
|
+
endIndex?: number | undefined;
|
|
999
|
+
/** The sheet this span is on. */
|
|
1000
|
+
sheetId?: number | undefined;
|
|
1001
|
+
/** The start (inclusive) of the span, or not set if unbounded. */
|
|
1002
|
+
startIndex?: number | undefined;
|
|
1003
|
+
} | undefined;
|
|
1004
|
+
/** The type of location this object represents. This field is read-only. */
|
|
1005
|
+
locationType?: ("DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED" | "ROW" | "COLUMN" | "SHEET" | "SPREADSHEET") | undefined;
|
|
1006
|
+
/** The ID of the sheet when metadata is associated with an entire sheet. */
|
|
1007
|
+
sheetId?: number | undefined;
|
|
1008
|
+
/** True when metadata is associated with an entire spreadsheet. */
|
|
1009
|
+
spreadsheet?: boolean | undefined;
|
|
1010
|
+
} | undefined;
|
|
1011
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value. */
|
|
1012
|
+
metadataValue?: string | undefined;
|
|
1013
|
+
/** Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered. */
|
|
1014
|
+
visibility?: ("DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED" | "DOCUMENT" | "PROJECT") | undefined;
|
|
1015
|
+
} | undefined;
|
|
1016
|
+
/** Selects data that matches the range described by the GridRange. */
|
|
1017
|
+
gridRange?: {
|
|
1018
|
+
/** The end column (exclusive) of the range, or not set if unbounded. */
|
|
1019
|
+
endColumnIndex?: number | undefined;
|
|
1020
|
+
/** The end row (exclusive) of the range, or not set if unbounded. */
|
|
1021
|
+
endRowIndex?: number | undefined;
|
|
1022
|
+
/** The sheet this range is on. */
|
|
1023
|
+
sheetId?: number | undefined;
|
|
1024
|
+
/** The start column (inclusive) of the range, or not set if unbounded. */
|
|
1025
|
+
startColumnIndex?: number | undefined;
|
|
1026
|
+
/** The start row (inclusive) of the range, or not set if unbounded. */
|
|
1027
|
+
startRowIndex?: number | undefined;
|
|
1028
|
+
} | undefined;
|
|
1029
|
+
} | undefined;
|
|
1030
|
+
/** The number of cells updated. */
|
|
1031
|
+
updatedCells?: number | undefined;
|
|
1032
|
+
/** The number of columns where at least one cell in the column was updated. */
|
|
1033
|
+
updatedColumns?: number | undefined;
|
|
1034
|
+
/** The values of the cells in the range matched by the dataFilter after all updates were applied. This is only included if the request's `includeValuesInResponse` field was `true`. */
|
|
1035
|
+
updatedData?: {
|
|
1036
|
+
/** The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */
|
|
1037
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
1038
|
+
/** The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. */
|
|
1039
|
+
range?: string | undefined;
|
|
1040
|
+
/** The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */
|
|
1041
|
+
values?: unknown[][] | undefined;
|
|
1042
|
+
} | undefined;
|
|
1043
|
+
/** The range (in [A1 notation](/sheets/api/guides/concepts#cell)) that updates were applied to. */
|
|
1044
|
+
updatedRange?: string | undefined;
|
|
1045
|
+
/** The number of rows where at least one cell in the row was updated. */
|
|
1046
|
+
updatedRows?: number | undefined;
|
|
1047
|
+
}[] | undefined;
|
|
1048
|
+
/** The spreadsheet the updates were applied to. */
|
|
1049
|
+
spreadsheetId?: string | undefined;
|
|
1050
|
+
/** The total number of cells updated. */
|
|
1051
|
+
totalUpdatedCells?: number | undefined;
|
|
1052
|
+
/** The total number of columns where at least one cell in the column was updated. */
|
|
1053
|
+
totalUpdatedColumns?: number | undefined;
|
|
1054
|
+
/** The total number of rows where at least one cell in the row was updated. */
|
|
1055
|
+
totalUpdatedRows?: number | undefined;
|
|
1056
|
+
/** The total number of sheets where at least one cell in the sheet was updated. */
|
|
1057
|
+
totalUpdatedSheets?: number | undefined;
|
|
1058
|
+
}
|
|
1059
|
+
export type ValuesBatchUpdateInput = {
|
|
1060
|
+
/** The ID of the spreadsheet to update. */
|
|
1061
|
+
spreadsheetId: string;
|
|
1062
|
+
/** V1 error format. */
|
|
1063
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
1064
|
+
/** OAuth access token. */
|
|
1065
|
+
access_token?: string | undefined;
|
|
1066
|
+
/** Data format for response. */
|
|
1067
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
1068
|
+
/** JSONP */
|
|
1069
|
+
callback?: string | undefined;
|
|
1070
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1071
|
+
fields?: string | undefined;
|
|
1072
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1073
|
+
key?: string | undefined;
|
|
1074
|
+
/** OAuth 2.0 token for the current user. */
|
|
1075
|
+
oauth_token?: string | undefined;
|
|
1076
|
+
/** Returns response with indentations and line breaks. */
|
|
1077
|
+
prettyPrint?: boolean | undefined;
|
|
1078
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1079
|
+
quotaUser?: string | undefined;
|
|
1080
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1081
|
+
upload_protocol?: string | undefined;
|
|
1082
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1083
|
+
uploadType?: string | undefined;
|
|
1084
|
+
/** The new values to apply to the spreadsheet. */
|
|
1085
|
+
data?: {
|
|
1086
|
+
/** The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */
|
|
1087
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
1088
|
+
/** The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. */
|
|
1089
|
+
range?: string | undefined;
|
|
1090
|
+
/** The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */
|
|
1091
|
+
values?: unknown[][] | undefined;
|
|
1092
|
+
}[] | undefined;
|
|
1093
|
+
/** Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). */
|
|
1094
|
+
includeValuesInResponse?: boolean | undefined;
|
|
1095
|
+
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
1096
|
+
responseDateTimeRenderOption?: ("SERIAL_NUMBER" | "FORMATTED_STRING") | undefined;
|
|
1097
|
+
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
1098
|
+
responseValueRenderOption?: ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA") | undefined;
|
|
1099
|
+
/** How the input data should be interpreted. */
|
|
1100
|
+
valueInputOption?: ("INPUT_VALUE_OPTION_UNSPECIFIED" | "RAW" | "USER_ENTERED") | undefined;
|
|
1101
|
+
}
|
|
1102
|
+
export type ValuesBatchUpdateOutput = {
|
|
1103
|
+
/** One UpdateValuesResponse per requested range, in the same order as the requests appeared. */
|
|
1104
|
+
responses?: {
|
|
1105
|
+
/** The spreadsheet the updates were applied to. */
|
|
1106
|
+
spreadsheetId?: string | undefined;
|
|
1107
|
+
/** The number of cells updated. */
|
|
1108
|
+
updatedCells?: number | undefined;
|
|
1109
|
+
/** The number of columns where at least one cell in the column was updated. */
|
|
1110
|
+
updatedColumns?: number | undefined;
|
|
1111
|
+
/** The values of the cells after updates were applied. This is only included if the request's `includeValuesInResponse` field was `true`. */
|
|
1112
|
+
updatedData?: {
|
|
1113
|
+
/** The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */
|
|
1114
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
1115
|
+
/** The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. */
|
|
1116
|
+
range?: string | undefined;
|
|
1117
|
+
/** The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */
|
|
1118
|
+
values?: unknown[][] | undefined;
|
|
1119
|
+
} | undefined;
|
|
1120
|
+
/** The range (in A1 notation) that updates were applied to. */
|
|
1121
|
+
updatedRange?: string | undefined;
|
|
1122
|
+
/** The number of rows where at least one cell in the row was updated. */
|
|
1123
|
+
updatedRows?: number | undefined;
|
|
1124
|
+
}[] | undefined;
|
|
1125
|
+
/** The spreadsheet the updates were applied to. */
|
|
1126
|
+
spreadsheetId?: string | undefined;
|
|
1127
|
+
/** The total number of cells updated. */
|
|
1128
|
+
totalUpdatedCells?: number | undefined;
|
|
1129
|
+
/** The total number of columns where at least one cell in the column was updated. */
|
|
1130
|
+
totalUpdatedColumns?: number | undefined;
|
|
1131
|
+
/** The total number of rows where at least one cell in the row was updated. */
|
|
1132
|
+
totalUpdatedRows?: number | undefined;
|
|
1133
|
+
/** The total number of sheets where at least one cell in the sheet was updated. */
|
|
1134
|
+
totalUpdatedSheets?: number | undefined;
|
|
1135
|
+
}
|
|
1136
|
+
export type ValuesClearInput = {
|
|
1137
|
+
/** The ID of the spreadsheet to update. */
|
|
1138
|
+
spreadsheetId: string;
|
|
1139
|
+
/** The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear. */
|
|
1140
|
+
range: string;
|
|
1141
|
+
/** V1 error format. */
|
|
1142
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
1143
|
+
/** OAuth access token. */
|
|
1144
|
+
access_token?: string | undefined;
|
|
1145
|
+
/** Data format for response. */
|
|
1146
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
1147
|
+
/** JSONP */
|
|
1148
|
+
callback?: string | undefined;
|
|
1149
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1150
|
+
fields?: string | undefined;
|
|
1151
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1152
|
+
key?: string | undefined;
|
|
1153
|
+
/** OAuth 2.0 token for the current user. */
|
|
1154
|
+
oauth_token?: string | undefined;
|
|
1155
|
+
/** Returns response with indentations and line breaks. */
|
|
1156
|
+
prettyPrint?: boolean | undefined;
|
|
1157
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1158
|
+
quotaUser?: string | undefined;
|
|
1159
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1160
|
+
upload_protocol?: string | undefined;
|
|
1161
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1162
|
+
uploadType?: string | undefined;
|
|
1163
|
+
}
|
|
1164
|
+
export type ValuesClearOutput = {
|
|
1165
|
+
/** The range (in A1 notation) that was cleared. (If the request was for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual range that was cleared, bounded to the sheet's limits.) */
|
|
1166
|
+
clearedRange?: string | undefined;
|
|
1167
|
+
/** The spreadsheet the updates were applied to. */
|
|
1168
|
+
spreadsheetId?: string | undefined;
|
|
1169
|
+
}
|
|
1170
|
+
export type ValuesGetInput = {
|
|
1171
|
+
/** The ID of the spreadsheet to retrieve data from. */
|
|
1172
|
+
spreadsheetId: string;
|
|
1173
|
+
/** The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the range to retrieve values from. */
|
|
1174
|
+
range: string;
|
|
1175
|
+
/** V1 error format. */
|
|
1176
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
1177
|
+
/** OAuth access token. */
|
|
1178
|
+
access_token?: string | undefined;
|
|
1179
|
+
/** Data format for response. */
|
|
1180
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
1181
|
+
/** JSONP */
|
|
1182
|
+
callback?: string | undefined;
|
|
1183
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1184
|
+
fields?: string | undefined;
|
|
1185
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1186
|
+
key?: string | undefined;
|
|
1187
|
+
/** OAuth 2.0 token for the current user. */
|
|
1188
|
+
oauth_token?: string | undefined;
|
|
1189
|
+
/** Returns response with indentations and line breaks. */
|
|
1190
|
+
prettyPrint?: boolean | undefined;
|
|
1191
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1192
|
+
quotaUser?: string | undefined;
|
|
1193
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1194
|
+
upload_protocol?: string | undefined;
|
|
1195
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1196
|
+
uploadType?: string | undefined;
|
|
1197
|
+
/** How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
1198
|
+
dateTimeRenderOption?: ("SERIAL_NUMBER" | "FORMATTED_STRING") | undefined;
|
|
1199
|
+
/** The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. */
|
|
1200
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
1201
|
+
/** How values should be represented in the output. The default render option is FORMATTED_VALUE. */
|
|
1202
|
+
valueRenderOption?: ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA") | undefined;
|
|
1203
|
+
}
|
|
1204
|
+
export type ValuesGetOutput = {
|
|
1205
|
+
/** The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */
|
|
1206
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
1207
|
+
/** The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. */
|
|
1208
|
+
range?: string | undefined;
|
|
1209
|
+
/** The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */
|
|
1210
|
+
values?: unknown[][] | undefined;
|
|
1211
|
+
}
|
|
1212
|
+
export type ValuesUpdateInput = {
|
|
1213
|
+
/** The ID of the spreadsheet to update. */
|
|
1214
|
+
spreadsheetId: string;
|
|
1215
|
+
/** The [A1 notation](/sheets/api/guides/concepts#cell) of the values to update. */
|
|
1216
|
+
range: string;
|
|
1217
|
+
/** V1 error format. */
|
|
1218
|
+
"$.xgafv"?: ("1" | "2") | undefined;
|
|
1219
|
+
/** OAuth access token. */
|
|
1220
|
+
access_token?: string | undefined;
|
|
1221
|
+
/** Data format for response. */
|
|
1222
|
+
alt?: ("json" | "media" | "proto") | undefined;
|
|
1223
|
+
/** JSONP */
|
|
1224
|
+
callback?: string | undefined;
|
|
1225
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1226
|
+
fields?: string | undefined;
|
|
1227
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1228
|
+
key?: string | undefined;
|
|
1229
|
+
/** OAuth 2.0 token for the current user. */
|
|
1230
|
+
oauth_token?: string | undefined;
|
|
1231
|
+
/** Returns response with indentations and line breaks. */
|
|
1232
|
+
prettyPrint?: boolean | undefined;
|
|
1233
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1234
|
+
quotaUser?: string | undefined;
|
|
1235
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1236
|
+
upload_protocol?: string | undefined;
|
|
1237
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1238
|
+
uploadType?: string | undefined;
|
|
1239
|
+
/** Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). */
|
|
1240
|
+
includeValuesInResponse?: boolean | undefined;
|
|
1241
|
+
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
1242
|
+
responseDateTimeRenderOption?: ("SERIAL_NUMBER" | "FORMATTED_STRING") | undefined;
|
|
1243
|
+
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
1244
|
+
responseValueRenderOption?: ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA") | undefined;
|
|
1245
|
+
/** How the input data should be interpreted. */
|
|
1246
|
+
valueInputOption?: ("INPUT_VALUE_OPTION_UNSPECIFIED" | "RAW" | "USER_ENTERED") | undefined;
|
|
1247
|
+
/** The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */
|
|
1248
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
1249
|
+
/** The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */
|
|
1250
|
+
values?: unknown[][] | undefined;
|
|
1251
|
+
}
|
|
1252
|
+
export type ValuesUpdateOutput = {
|
|
1253
|
+
/** The spreadsheet the updates were applied to. */
|
|
1254
|
+
spreadsheetId?: string | undefined;
|
|
1255
|
+
/** The number of cells updated. */
|
|
1256
|
+
updatedCells?: number | undefined;
|
|
1257
|
+
/** The number of columns where at least one cell in the column was updated. */
|
|
1258
|
+
updatedColumns?: number | undefined;
|
|
1259
|
+
/** The values of the cells after updates were applied. This is only included if the request's `includeValuesInResponse` field was `true`. */
|
|
1260
|
+
updatedData?: {
|
|
1261
|
+
/** The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS. */
|
|
1262
|
+
majorDimension?: ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS") | undefined;
|
|
1263
|
+
/** The range the values cover, in [A1 notation](/sheets/api/guides/concepts#cell). For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended. */
|
|
1264
|
+
range?: string | undefined;
|
|
1265
|
+
/** The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string. */
|
|
1266
|
+
values?: unknown[][] | undefined;
|
|
1267
|
+
} | undefined;
|
|
1268
|
+
/** The range (in A1 notation) that updates were applied to. */
|
|
1269
|
+
updatedRange?: string | undefined;
|
|
1270
|
+
/** The number of rows where at least one cell in the row was updated. */
|
|
1271
|
+
updatedRows?: number | undefined;
|
|
1272
|
+
}
|
|
1273
|
+
export type VariableSchema_GOOGLE_SHEETS_BASE_URL = "https://sheets.googleapis.com/"
|
|
1274
|
+
|
|
1275
|
+
interface RPCHandler<I, O> {
|
|
1276
|
+
input: I;
|
|
1277
|
+
output: O;
|
|
1278
|
+
}
|
|
1279
|
+
|
|
1280
|
+
export type RPCMap = {
|
|
1281
|
+
};
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
// No addon packages, use RPCMap directly
|
|
1286
|
+
export type FlattenedRPCMap = RPCMap
|
|
1287
|
+
|
|
1288
|
+
type IsAny<T> = 0 extends (1 & T) ? true : false
|
|
1289
|
+
type IsVoidishInput<T> = IsAny<T> extends true
|
|
1290
|
+
? false
|
|
1291
|
+
: [T] extends [void | null | undefined]
|
|
1292
|
+
? true
|
|
1293
|
+
: false
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
export type RPCInvoke = <Name extends keyof FlattenedRPCMap>(
|
|
1297
|
+
...args: IsVoidishInput<FlattenedRPCMap[Name]['input']> extends true
|
|
1298
|
+
? [name: Name]
|
|
1299
|
+
: [name: Name, data: FlattenedRPCMap[Name]['input']]
|
|
1300
|
+
) => Promise<FlattenedRPCMap[Name]['output']>
|
|
1301
|
+
|
|
1302
|
+
export type RPCRemote = <Name extends keyof FlattenedRPCMap>(
|
|
1303
|
+
...args: IsVoidishInput<FlattenedRPCMap[Name]['input']> extends true
|
|
1304
|
+
? [name: Name]
|
|
1305
|
+
: [name: Name, data: FlattenedRPCMap[Name]['input']]
|
|
1306
|
+
) => Promise<FlattenedRPCMap[Name]['output']>
|
|
1307
|
+
|
|
1308
|
+
import type { FlattenedWorkflowMap } from '../workflow/pikku-workflow-map.gen.d.js'
|
|
1309
|
+
|
|
1310
|
+
import type { AgentMap } from '../agent/pikku-agent-map.gen.d.js'
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
type FlattenedAgentMap = AgentMap
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
import type { PikkuRPC } from '@pikku/core/rpc'
|
|
1317
|
+
|
|
1318
|
+
interface AIAgentInput {
|
|
1319
|
+
message: string
|
|
1320
|
+
threadId: string
|
|
1321
|
+
resourceId: string
|
|
1322
|
+
}
|
|
1323
|
+
|
|
1324
|
+
export type TypedStartWorkflow = <Name extends keyof FlattenedWorkflowMap>(
|
|
1325
|
+
name: Name,
|
|
1326
|
+
input: FlattenedWorkflowMap[Name]['input'],
|
|
1327
|
+
options?: { startNode?: string }
|
|
1328
|
+
) => Promise<{ runId: string }>
|
|
1329
|
+
|
|
1330
|
+
export type TypedRunWorkflow = <Name extends keyof FlattenedWorkflowMap>(
|
|
1331
|
+
name: Name,
|
|
1332
|
+
input: FlattenedWorkflowMap[Name]['input']
|
|
1333
|
+
) => Promise<FlattenedWorkflowMap[Name]['output']>
|
|
1334
|
+
|
|
1335
|
+
export type TypedWorkflowStatus = (
|
|
1336
|
+
workflowName: string,
|
|
1337
|
+
runId: string
|
|
1338
|
+
) => Promise<{ id: string; status: 'running' | 'suspended' | 'completed' | 'failed' | 'cancelled'; output?: unknown; error?: { message?: string } }>
|
|
1339
|
+
|
|
1340
|
+
type TypedAgentRun = [keyof FlattenedAgentMap] extends [never]
|
|
1341
|
+
? (name: string, input: AIAgentInput) => Promise<any>
|
|
1342
|
+
: <Name extends keyof FlattenedAgentMap>(
|
|
1343
|
+
name: Name,
|
|
1344
|
+
input: AIAgentInput
|
|
1345
|
+
) => Promise<{ runId: string; result: FlattenedAgentMap[Name]['output']; usage: { inputTokens: number; outputTokens: number } }>
|
|
1346
|
+
|
|
1347
|
+
type TypedAgentStream = [keyof FlattenedAgentMap] extends [never]
|
|
1348
|
+
? (name: string, input: AIAgentInput, options?: { requiresToolApproval?: 'all' | 'explicit' | false }) => Promise<void>
|
|
1349
|
+
: <Name extends keyof FlattenedAgentMap>(
|
|
1350
|
+
name: Name,
|
|
1351
|
+
input: AIAgentInput,
|
|
1352
|
+
options?: { requiresToolApproval?: 'all' | 'explicit' | false }
|
|
1353
|
+
) => Promise<void>
|
|
1354
|
+
|
|
1355
|
+
export type TypedPikkuRPC = PikkuRPC<RPCInvoke, RPCRemote, TypedStartWorkflow, TypedAgentRun, TypedAgentStream>
|
|
1356
|
+
|