@maxim_mazurok/gapi.client.connectors-v2 0.0.20230812 → 0.0.20230913

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +145 -2
  2. package/package.json +1 -1
  3. package/tests.ts +12 -2
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: 20230812
12
+ // Revision: 20230913
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -23,12 +23,24 @@ declare namespace gapi.client {
23
23
 
24
24
  namespace connectors {
25
25
  interface Action {
26
+ /** Brief Description of action */
27
+ description?:
28
+ string;
29
+ /** Display Name of action to be shown on client side */
30
+ displayName?:
31
+ string;
32
+ /** JsonSchema representation of this actions's input schema */
33
+ inputJsonSchema?:
34
+ JsonSchema;
26
35
  /** List containing input parameter metadata. */
27
36
  inputParameters?:
28
37
  InputParameter[];
29
38
  /** Name of the action. */
30
39
  name?:
31
40
  string;
41
+ /** JsonSchema representation of this actions's result schema */
42
+ resultJsonSchema?:
43
+ JsonSchema;
32
44
  /** List containing the metadata of result fields. */
33
45
  resultMetadata?:
34
46
  ResultMetadata[];
@@ -48,6 +60,9 @@ declare namespace gapi.client {
48
60
  /** List containing metadata information about each field of the entity type. */
49
61
  fields?:
50
62
  Field[];
63
+ /** JsonSchema representation of this entity's schema */
64
+ jsonSchema?:
65
+ JsonSchema;
51
66
  /** The name of the entity type. */
52
67
  name?:
53
68
  string;
@@ -92,6 +107,9 @@ declare namespace gapi.client {
92
107
  /** A brief description of the Field. */
93
108
  description?:
94
109
  string;
110
+ /** JsonSchema of the field, applicable only if field is of type `STRUCT` */
111
+ jsonSchema?:
112
+ JsonSchema;
95
113
  /** The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity. */
96
114
  key?:
97
115
  boolean;
@@ -106,6 +124,9 @@ declare namespace gapi.client {
106
124
  Reference;
107
125
  }
108
126
  interface InputParameter {
127
+ /** The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields. */
128
+ additionalDetails?:
129
+ { [P in string]: any };
109
130
  /** The data type of the Parameter */
110
131
  dataType?:
111
132
  string;
@@ -115,6 +136,9 @@ declare namespace gapi.client {
115
136
  /** A brief description of the Parameter. */
116
137
  description?:
117
138
  string;
139
+ /** JsonSchema of the parameter, applicable only if parameter is of type `STRUCT` */
140
+ jsonSchema?:
141
+ JsonSchema;
118
142
  /** Name of the Parameter. */
119
143
  name?:
120
144
  string;
@@ -122,6 +146,38 @@ declare namespace gapi.client {
122
146
  nullable?:
123
147
  boolean;
124
148
  }
149
+ interface JsonSchema {
150
+ /** Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema */
151
+ additionalDetails?:
152
+ { [P in string]: any };
153
+ /** The default value of the field or object described by this schema. */
154
+ default?:
155
+ any;
156
+ /** A description of this schema. */
157
+ description?:
158
+ string;
159
+ /** Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values */
160
+ enum?:
161
+ any[];
162
+ /** Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format */
163
+ format?:
164
+ string;
165
+ /** Schema that applies to array values, applicable only if this is of type `array`. */
166
+ items?:
167
+ JsonSchema;
168
+ /** JDBC datatype of the field. */
169
+ jdbcType?:
170
+ string;
171
+ /** The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property */
172
+ properties?:
173
+ { [P in string]: JsonSchema };
174
+ /** Whether this property is required. */
175
+ required?:
176
+ string[];
177
+ /** JSON Schema Validation: A Vocabulary for Structural Validation of JSON */
178
+ type?:
179
+ string[];
180
+ }
125
181
  interface ListActionsResponse {
126
182
  /** List of action metadata. */
127
183
  actions?:
@@ -170,7 +226,7 @@ declare namespace gapi.client {
170
226
  dataType?:
171
227
  string;
172
228
  value?:
173
- string;
229
+ any;
174
230
  }
175
231
  interface Reference {
176
232
  /** Name of the reference field. */
@@ -187,6 +243,9 @@ declare namespace gapi.client {
187
243
  /** A brief description of the metadata field. */
188
244
  description?:
189
245
  string;
246
+ /** JsonSchema of the result, applicable only if parameter is of type `STRUCT` */
247
+ jsonSchema?:
248
+ JsonSchema;
190
249
  /** Name of the metadata field. */
191
250
  name?:
192
251
  string;
@@ -278,6 +337,45 @@ declare namespace gapi.client {
278
337
  string;
279
338
  },
280
339
  body: ExecuteActionRequest): Request<ExecuteActionResponse>;
340
+ /** Gets the schema of the given action. */
341
+ get(request?: {
342
+ /** V1 error format. */
343
+ "$.xgafv"?:
344
+ string;
345
+ /** OAuth access token. */
346
+ access_token?:
347
+ string;
348
+ /** Data format for response. */
349
+ alt?:
350
+ string;
351
+ /** JSONP */
352
+ callback?:
353
+ string;
354
+ /** Selector specifying which fields to include in a partial response. */
355
+ fields?:
356
+ string;
357
+ /** 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. */
358
+ key?:
359
+ string;
360
+ /** Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action} */
361
+ name:
362
+ string;
363
+ /** OAuth 2.0 token for the current user. */
364
+ oauth_token?:
365
+ string;
366
+ /** Returns response with indentations and line breaks. */
367
+ prettyPrint?:
368
+ boolean;
369
+ /** 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. */
370
+ quotaUser?:
371
+ string;
372
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
373
+ upload_protocol?:
374
+ string;
375
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
376
+ uploadType?:
377
+ string;
378
+ }): Request<Action>;
281
379
  /** Gets the schema of all the actions supported by the connector. */
282
380
  list(request?: {
283
381
  /** V1 error format. */
@@ -322,6 +420,9 @@ declare namespace gapi.client {
322
420
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
323
421
  uploadType?:
324
422
  string;
423
+ /** Specifies which fields of the Action are returned in the response. */
424
+ view?:
425
+ string;
325
426
  }): Request<ListActionsResponse>;
326
427
  }
327
428
  interface EntitiesResource {
@@ -773,6 +874,45 @@ declare namespace gapi.client {
773
874
  body: Entity): Request<UpdateEntitiesWithConditionsResponse>;
774
875
  }
775
876
  interface EntityTypesResource {
877
+ /** Gets metadata of given entity type */
878
+ get(request?: {
879
+ /** V1 error format. */
880
+ "$.xgafv"?:
881
+ string;
882
+ /** OAuth access token. */
883
+ access_token?:
884
+ string;
885
+ /** Data format for response. */
886
+ alt?:
887
+ string;
888
+ /** JSONP */
889
+ callback?:
890
+ string;
891
+ /** Selector specifying which fields to include in a partial response. */
892
+ fields?:
893
+ string;
894
+ /** 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. */
895
+ key?:
896
+ string;
897
+ /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{entityType} */
898
+ name:
899
+ string;
900
+ /** OAuth 2.0 token for the current user. */
901
+ oauth_token?:
902
+ string;
903
+ /** Returns response with indentations and line breaks. */
904
+ prettyPrint?:
905
+ boolean;
906
+ /** 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. */
907
+ quotaUser?:
908
+ string;
909
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
910
+ upload_protocol?:
911
+ string;
912
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
913
+ uploadType?:
914
+ string;
915
+ }): Request<EntityType>;
776
916
  /** Lists metadata related to all entity types present in the external system. */
777
917
  list(request?: {
778
918
  /** V1 error format. */
@@ -817,6 +957,9 @@ declare namespace gapi.client {
817
957
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
818
958
  uploadType?:
819
959
  string;
960
+ /** Specifies which fields of the Entity Type are returned in the response. */
961
+ view?:
962
+ string;
820
963
  }): Request<ListEntityTypesResponse>;
821
964
  entities:
822
965
  EntitiesResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.connectors-v2",
3
- "version": "0.0.20230812",
3
+ "version": "0.0.20230913",
4
4
  "description": "TypeScript typings for Connectors API v2",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230812
6
+ // Revision: 20230913
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -42,7 +42,7 @@ gapi.load('client', async () => {
42
42
  queryParameters: [
43
43
  {
44
44
  dataType: "Test string",
45
- value: "Test string",
45
+ value: 42,
46
46
  }
47
47
  ],
48
48
  timeout: "Test string",
@@ -56,17 +56,27 @@ gapi.load('client', async () => {
56
56
  A: 42
57
57
  },
58
58
  });
59
+ /** Gets the schema of the given action. */
60
+ await gapi.client.connectors.projects.locations.connections.actions.get({
61
+ name: "Test string",
62
+ });
59
63
  /** Gets the schema of all the actions supported by the connector. */
60
64
  await gapi.client.connectors.projects.locations.connections.actions.list({
61
65
  pageSize: 42,
62
66
  pageToken: "Test string",
63
67
  parent: "Test string",
68
+ view: "Test string",
69
+ });
70
+ /** Gets metadata of given entity type */
71
+ await gapi.client.connectors.projects.locations.connections.entityTypes.get({
72
+ name: "Test string",
64
73
  });
65
74
  /** Lists metadata related to all entity types present in the external system. */
66
75
  await gapi.client.connectors.projects.locations.connections.entityTypes.list({
67
76
  pageSize: 42,
68
77
  pageToken: "Test string",
69
78
  parent: "Test string",
79
+ view: "Test string",
70
80
  });
71
81
  /**
72
82
  * Creates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request. The response message