@maxim_mazurok/gapi.client.connectors-v2 0.0.20250721 → 0.0.20250813
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +142 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://connectors.googleapis.com/$discovery/rest?version=v2
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250813
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -41,6 +41,8 @@ declare namespace gapi.client {
|
|
|
41
41
|
inputJsonSchema?: JsonSchema;
|
|
42
42
|
/** List containing input parameter metadata. */
|
|
43
43
|
inputParameters?: InputParameter[];
|
|
44
|
+
/** Metadata like service latency, etc. */
|
|
45
|
+
metadata?: {[P in string]: {[P in string]: any}};
|
|
44
46
|
/** Name of the action. */
|
|
45
47
|
name?: string;
|
|
46
48
|
/** JsonSchema representation of this actions's result schema */
|
|
@@ -64,6 +66,8 @@ declare namespace gapi.client {
|
|
|
64
66
|
interface CheckStatusResponse {
|
|
65
67
|
/** When the connector is not in ACTIVE state, the description must be populated to specify the reason why it's not in ACTIVE state. */
|
|
66
68
|
description?: string;
|
|
69
|
+
/** Metadata like service latency, etc. */
|
|
70
|
+
metadata?: {[P in string]: {[P in string]: any}};
|
|
67
71
|
/** State of the connector. */
|
|
68
72
|
state?: string;
|
|
69
73
|
}
|
|
@@ -93,14 +97,19 @@ declare namespace gapi.client {
|
|
|
93
97
|
interface Entity {
|
|
94
98
|
/** Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field. */
|
|
95
99
|
fields?: {[P in string]: any};
|
|
100
|
+
/** Metadata like service latency, etc. */
|
|
101
|
+
metadata?: {[P in string]: {[P in string]: any}};
|
|
96
102
|
/** Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} */
|
|
97
103
|
name?: string;
|
|
98
104
|
}
|
|
99
105
|
interface EntityType {
|
|
106
|
+
defaultSortBy?: string;
|
|
100
107
|
/** List containing metadata information about each field of the entity type. */
|
|
101
108
|
fields?: Field[];
|
|
102
109
|
/** JsonSchema representation of this entity's schema */
|
|
103
110
|
jsonSchema?: JsonSchema;
|
|
111
|
+
/** Metadata like service latency, etc. */
|
|
112
|
+
metadata?: {[P in string]: {[P in string]: any}};
|
|
104
113
|
/** The name of the entity type. */
|
|
105
114
|
name?: string;
|
|
106
115
|
operations?: string[];
|
|
@@ -111,12 +120,16 @@ declare namespace gapi.client {
|
|
|
111
120
|
}
|
|
112
121
|
interface ExchangeAuthCodeResponse {
|
|
113
122
|
accessCredentials?: AccessCredentials;
|
|
123
|
+
/** Metadata like service latency, etc. */
|
|
124
|
+
metadata?: {[P in string]: {[P in string]: any}};
|
|
114
125
|
}
|
|
115
126
|
interface ExecuteActionRequest {
|
|
116
127
|
/** Parameters for executing the action. The parameters can be key/value pairs or nested structs. */
|
|
117
128
|
parameters?: {[P in string]: any};
|
|
118
129
|
}
|
|
119
130
|
interface ExecuteActionResponse {
|
|
131
|
+
/** Metadata like service latency, etc. */
|
|
132
|
+
metadata?: {[P in string]: {[P in string]: any}};
|
|
120
133
|
/** In the case of successful invocation of the specified action, the results Struct contains values based on the response of the action invoked. 1. If the action execution produces any entities as a result, they are returned as an array of Structs with the 'key' being the field name and the 'value' being the value of that field in each result row. { 'results': [{'key': 'value'}, ...] } */
|
|
121
134
|
results?: Array<{[P in string]: any}>;
|
|
122
135
|
}
|
|
@@ -128,6 +141,14 @@ declare namespace gapi.client {
|
|
|
128
141
|
/** In the case of successful execution of the query the response contains results returned by the external system. For example, the result rows of the query are contained in the 'results' Struct list - "results": [ { "field1": "val1", "field2": "val2",.. },.. ] Each Struct row can contain fields any type of like nested Structs or lists. */
|
|
129
142
|
results?: Array<{[P in string]: any}>;
|
|
130
143
|
}
|
|
144
|
+
interface ExecuteToolRequest {
|
|
145
|
+
/** Input parameters for the tool. */
|
|
146
|
+
parameters?: {[P in string]: any};
|
|
147
|
+
}
|
|
148
|
+
interface ExecuteToolResponse {
|
|
149
|
+
/** Output from the tool execution. */
|
|
150
|
+
result?: {[P in string]: any};
|
|
151
|
+
}
|
|
131
152
|
interface Field {
|
|
132
153
|
/** The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields. */
|
|
133
154
|
additionalDetails?: {[P in string]: any};
|
|
@@ -227,6 +248,8 @@ declare namespace gapi.client {
|
|
|
227
248
|
interface ListActionsResponse {
|
|
228
249
|
/** List of action metadata. */
|
|
229
250
|
actions?: Action[];
|
|
251
|
+
/** Metadata like service latency, etc. */
|
|
252
|
+
metadata?: {[P in string]: {[P in string]: any}};
|
|
230
253
|
/** Next page token if more actions available. */
|
|
231
254
|
nextPageToken?: string;
|
|
232
255
|
/** List of actions which contain unsupported Datatypes. Check datatype.proto for more information. */
|
|
@@ -235,10 +258,14 @@ declare namespace gapi.client {
|
|
|
235
258
|
interface ListEntitiesResponse {
|
|
236
259
|
/** List containing entity rows. */
|
|
237
260
|
entities?: Entity[];
|
|
261
|
+
/** Metadata like service latency, etc. */
|
|
262
|
+
metadata?: {[P in string]: {[P in string]: any}};
|
|
238
263
|
/** Next page token if more records are available. */
|
|
239
264
|
nextPageToken?: string;
|
|
240
265
|
}
|
|
241
266
|
interface ListEntityTypesResponse {
|
|
267
|
+
/** Metadata like service latency, etc. */
|
|
268
|
+
metadata?: {[P in string]: {[P in string]: any}};
|
|
242
269
|
/** Next page token if more entity types available. */
|
|
243
270
|
nextPageToken?: string;
|
|
244
271
|
/** List of metadata related to all entity types. */
|
|
@@ -246,6 +273,12 @@ declare namespace gapi.client {
|
|
|
246
273
|
/** List of entity type names which contain unsupported Datatypes. Check datatype.proto for more information. */
|
|
247
274
|
unsupportedTypeNames?: string[];
|
|
248
275
|
}
|
|
276
|
+
interface ListToolsResponse {
|
|
277
|
+
/** Next page token. */
|
|
278
|
+
nextPageToken?: string;
|
|
279
|
+
/** List of available tools. */
|
|
280
|
+
tools?: Tool[];
|
|
281
|
+
}
|
|
249
282
|
interface MaintenancePolicy {
|
|
250
283
|
/** Output only. The time when the resource was created. */
|
|
251
284
|
createTime?: string;
|
|
@@ -336,6 +369,8 @@ declare namespace gapi.client {
|
|
|
336
369
|
}
|
|
337
370
|
interface RefreshAccessTokenResponse {
|
|
338
371
|
accessCredentials?: AccessCredentials;
|
|
372
|
+
/** Metadata like service latency, etc. */
|
|
373
|
+
metadata?: {[P in string]: {[P in string]: any}};
|
|
339
374
|
}
|
|
340
375
|
interface ResultMetadata {
|
|
341
376
|
/** The data type of the metadata field */
|
|
@@ -383,7 +418,19 @@ declare namespace gapi.client {
|
|
|
383
418
|
/** Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. */
|
|
384
419
|
seconds?: number;
|
|
385
420
|
}
|
|
421
|
+
interface Tool {
|
|
422
|
+
/** Description of the tool. */
|
|
423
|
+
description?: string;
|
|
424
|
+
/** JSON schema for the input parameters of the tool. */
|
|
425
|
+
inputSchema?: JsonSchema;
|
|
426
|
+
/** Name of the tool. */
|
|
427
|
+
name?: string;
|
|
428
|
+
/** JSON schema for the output of the tool. */
|
|
429
|
+
outputSchema?: JsonSchema;
|
|
430
|
+
}
|
|
386
431
|
interface UpdateEntitiesWithConditionsResponse {
|
|
432
|
+
/** Metadata like service latency, etc. */
|
|
433
|
+
metadata?: {[P in string]: {[P in string]: any}};
|
|
387
434
|
/** Response returned by the external system. */
|
|
388
435
|
response?: {[P in string]: any};
|
|
389
436
|
}
|
|
@@ -832,6 +879,8 @@ declare namespace gapi.client {
|
|
|
832
879
|
alt?: string;
|
|
833
880
|
/** JSONP */
|
|
834
881
|
callback?: string;
|
|
882
|
+
/** Context metadata for request could be used to fetch customization of entity type schema. */
|
|
883
|
+
contextMetadata?: string;
|
|
835
884
|
/** Selector specifying which fields to include in a partial response. */
|
|
836
885
|
fields?: string;
|
|
837
886
|
/** 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. */
|
|
@@ -886,6 +935,97 @@ declare namespace gapi.client {
|
|
|
886
935
|
}): Request<ListEntityTypesResponse>;
|
|
887
936
|
entities: EntitiesResource;
|
|
888
937
|
}
|
|
938
|
+
interface ToolsResource {
|
|
939
|
+
/** Executes a specific tool. */
|
|
940
|
+
execute(request: {
|
|
941
|
+
/** V1 error format. */
|
|
942
|
+
'$.xgafv'?: string;
|
|
943
|
+
/** OAuth access token. */
|
|
944
|
+
access_token?: string;
|
|
945
|
+
/** Data format for response. */
|
|
946
|
+
alt?: string;
|
|
947
|
+
/** JSONP */
|
|
948
|
+
callback?: string;
|
|
949
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
950
|
+
fields?: string;
|
|
951
|
+
/** 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. */
|
|
952
|
+
key?: string;
|
|
953
|
+
/** Required. Resource name of the Tool. Format: projects/{project}/locations/{location}/connections/{connection}/tools/{tool} */
|
|
954
|
+
name: string;
|
|
955
|
+
/** OAuth 2.0 token for the current user. */
|
|
956
|
+
oauth_token?: string;
|
|
957
|
+
/** Returns response with indentations and line breaks. */
|
|
958
|
+
prettyPrint?: boolean;
|
|
959
|
+
/** 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. */
|
|
960
|
+
quotaUser?: string;
|
|
961
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
962
|
+
upload_protocol?: string;
|
|
963
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
964
|
+
uploadType?: string;
|
|
965
|
+
/** Request body */
|
|
966
|
+
resource: ExecuteToolRequest;
|
|
967
|
+
}): Request<ExecuteToolResponse>;
|
|
968
|
+
execute(
|
|
969
|
+
request: {
|
|
970
|
+
/** V1 error format. */
|
|
971
|
+
'$.xgafv'?: string;
|
|
972
|
+
/** OAuth access token. */
|
|
973
|
+
access_token?: string;
|
|
974
|
+
/** Data format for response. */
|
|
975
|
+
alt?: string;
|
|
976
|
+
/** JSONP */
|
|
977
|
+
callback?: string;
|
|
978
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
979
|
+
fields?: string;
|
|
980
|
+
/** 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. */
|
|
981
|
+
key?: string;
|
|
982
|
+
/** Required. Resource name of the Tool. Format: projects/{project}/locations/{location}/connections/{connection}/tools/{tool} */
|
|
983
|
+
name: string;
|
|
984
|
+
/** OAuth 2.0 token for the current user. */
|
|
985
|
+
oauth_token?: string;
|
|
986
|
+
/** Returns response with indentations and line breaks. */
|
|
987
|
+
prettyPrint?: boolean;
|
|
988
|
+
/** 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. */
|
|
989
|
+
quotaUser?: string;
|
|
990
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
991
|
+
upload_protocol?: string;
|
|
992
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
993
|
+
uploadType?: string;
|
|
994
|
+
},
|
|
995
|
+
body: ExecuteToolRequest,
|
|
996
|
+
): Request<ExecuteToolResponse>;
|
|
997
|
+
/** Lists all available tools. */
|
|
998
|
+
list(request?: {
|
|
999
|
+
/** V1 error format. */
|
|
1000
|
+
'$.xgafv'?: string;
|
|
1001
|
+
/** OAuth access token. */
|
|
1002
|
+
access_token?: string;
|
|
1003
|
+
/** Data format for response. */
|
|
1004
|
+
alt?: string;
|
|
1005
|
+
/** JSONP */
|
|
1006
|
+
callback?: string;
|
|
1007
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1008
|
+
fields?: string;
|
|
1009
|
+
/** 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. */
|
|
1010
|
+
key?: string;
|
|
1011
|
+
/** OAuth 2.0 token for the current user. */
|
|
1012
|
+
oauth_token?: string;
|
|
1013
|
+
/** Page size. */
|
|
1014
|
+
pageSize?: number;
|
|
1015
|
+
/** Page token. */
|
|
1016
|
+
pageToken?: string;
|
|
1017
|
+
/** Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} */
|
|
1018
|
+
parent: string;
|
|
1019
|
+
/** Returns response with indentations and line breaks. */
|
|
1020
|
+
prettyPrint?: boolean;
|
|
1021
|
+
/** 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. */
|
|
1022
|
+
quotaUser?: string;
|
|
1023
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1024
|
+
upload_protocol?: string;
|
|
1025
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1026
|
+
uploadType?: string;
|
|
1027
|
+
}): Request<ListToolsResponse>;
|
|
1028
|
+
}
|
|
889
1029
|
interface ConnectionsResource {
|
|
890
1030
|
/** Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand. */
|
|
891
1031
|
checkReadiness(request?: {
|
|
@@ -1111,6 +1251,7 @@ declare namespace gapi.client {
|
|
|
1111
1251
|
): Request<RefreshAccessTokenResponse>;
|
|
1112
1252
|
actions: ActionsResource;
|
|
1113
1253
|
entityTypes: EntityTypesResource;
|
|
1254
|
+
tools: ToolsResource;
|
|
1114
1255
|
}
|
|
1115
1256
|
interface LocationsResource {
|
|
1116
1257
|
connections: ConnectionsResource;
|