@maxim_mazurok/gapi.client.workflowexecutions-v1 0.0.20230808 → 0.0.20230905

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 +119 -1
  2. package/package.json +1 -1
  3. package/tests.ts +11 -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://workflowexecutions.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230808
12
+ // Revision: 20230905
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -22,6 +22,20 @@ declare namespace gapi.client {
22
22
  function load(name: "workflowexecutions", version: "v1", callback: () => any): void;
23
23
 
24
24
  namespace workflowexecutions {
25
+ interface Callback {
26
+ /** Output only. The payloads received by the callback that have not been processed by a waiting execution step. */
27
+ availablePayloads?:
28
+ string[];
29
+ /** Output only. The method accepted by the callback. E.g. GET, POST, PUT. */
30
+ method?:
31
+ string;
32
+ /** Output only. The resource name of the callback. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/callback/{callback} */
33
+ name?:
34
+ string;
35
+ /** Output only. Number of execution steps waiting on this callback. */
36
+ waiters?:
37
+ string;
38
+ }
25
39
  // tslint:disable-next-line:no-empty-interface
26
40
  interface CancelExecutionRequest {
27
41
  }
@@ -87,6 +101,19 @@ declare namespace gapi.client {
87
101
  workflowRevisionId?:
88
102
  string;
89
103
  }
104
+ interface ExportDataResponse {
105
+ /** The JSON string with customer data and metadata of an execution of the given name */
106
+ data?:
107
+ string;
108
+ }
109
+ interface ListCallbacksResponse {
110
+ /** The callbacks which match the request. */
111
+ callbacks?:
112
+ Callback[];
113
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
114
+ nextPageToken?:
115
+ string;
116
+ }
90
117
  interface ListExecutionsResponse {
91
118
  /** The executions which match the request. */
92
119
  executions?:
@@ -188,6 +215,56 @@ declare namespace gapi.client {
188
215
  subscription?:
189
216
  string;
190
217
  }
218
+ interface CallbacksResource {
219
+ /** Returns a list of active callbacks which belong to the execution with the given name. The returned callbacks are ordered by callback ID. first). */
220
+ list(request?: {
221
+ /** V1 error format. */
222
+ "$.xgafv"?:
223
+ string;
224
+ /** OAuth access token. */
225
+ access_token?:
226
+ string;
227
+ /** Data format for response. */
228
+ alt?:
229
+ string;
230
+ /** JSONP */
231
+ callback?:
232
+ string;
233
+ /** Selector specifying which fields to include in a partial response. */
234
+ fields?:
235
+ string;
236
+ /** 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. */
237
+ key?:
238
+ string;
239
+ /** OAuth 2.0 token for the current user. */
240
+ oauth_token?:
241
+ string;
242
+ /** Maximum number of callbacks to return per call. The default value is 100 and is also the maximum value. */
243
+ pageSize?:
244
+ number;
245
+ /**
246
+ * A page token, received from a previous `ListCallbacks` call. Provide this to retrieve the subsequent page. Note that pagination is applied to dynamic data. The list of callbacks
247
+ * returned can change between page requests if callbacks are created or deleted.
248
+ */
249
+ pageToken?:
250
+ string;
251
+ /** Required. Name of the execution for which the callbacks should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} */
252
+ parent:
253
+ string;
254
+ /** Returns response with indentations and line breaks. */
255
+ prettyPrint?:
256
+ boolean;
257
+ /** 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. */
258
+ quotaUser?:
259
+ string;
260
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
261
+ upload_protocol?:
262
+ string;
263
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
264
+ uploadType?:
265
+ string;
266
+ }): Request<ListCallbacksResponse>;
267
+ }
191
268
  interface ExecutionsResource {
192
269
  /** Cancels an execution of the given name. */
193
270
  cancel(request: {
@@ -357,6 +434,45 @@ declare namespace gapi.client {
357
434
  string;
358
435
  },
359
436
  body: Execution): Request<Execution>;
437
+ /** Returns all metadata stored about an execution, excluding most data that is already accessible via other API methods. */
438
+ exportData(request?: {
439
+ /** V1 error format. */
440
+ "$.xgafv"?:
441
+ string;
442
+ /** OAuth access token. */
443
+ access_token?:
444
+ string;
445
+ /** Data format for response. */
446
+ alt?:
447
+ string;
448
+ /** JSONP */
449
+ callback?:
450
+ string;
451
+ /** Selector specifying which fields to include in a partial response. */
452
+ fields?:
453
+ string;
454
+ /** 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. */
455
+ key?:
456
+ string;
457
+ /** Required. Name of the execution to be data exported. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} */
458
+ name:
459
+ string;
460
+ /** OAuth 2.0 token for the current user. */
461
+ oauth_token?:
462
+ string;
463
+ /** Returns response with indentations and line breaks. */
464
+ prettyPrint?:
465
+ boolean;
466
+ /** 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. */
467
+ quotaUser?:
468
+ string;
469
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
470
+ upload_protocol?:
471
+ string;
472
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
473
+ uploadType?:
474
+ string;
475
+ }): Request<ExportDataResponse>;
360
476
  /** Returns an execution of the given name. */
361
477
  get(request?: {
362
478
  /** V1 error format. */
@@ -468,6 +584,8 @@ declare namespace gapi.client {
468
584
  view?:
469
585
  string;
470
586
  }): Request<ListExecutionsResponse>;
587
+ callbacks:
588
+ CallbacksResource;
471
589
  }
472
590
  interface WorkflowsResource {
473
591
  /** Triggers a new execution using the latest revision of the given workflow by a Pub/Sub push notification. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.workflowexecutions-v1",
3
- "version": "0.0.20230808",
3
+ "version": "0.0.20230905",
4
4
  "description": "TypeScript typings for Workflow Executions API v1",
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: 20230808
6
+ // Revision: 20230905
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -97,6 +97,10 @@ gapi.load('client', async () => {
97
97
  },
98
98
  workflowRevisionId: "Test string",
99
99
  });
100
+ /** Returns all metadata stored about an execution, excluding most data that is already accessible via other API methods. */
101
+ await gapi.client.workflowexecutions.projects.locations.workflows.executions.exportData({
102
+ name: "Test string",
103
+ });
100
104
  /** Returns an execution of the given name. */
101
105
  await gapi.client.workflowexecutions.projects.locations.workflows.executions.get({
102
106
  name: "Test string",
@@ -114,5 +118,11 @@ gapi.load('client', async () => {
114
118
  parent: "Test string",
115
119
  view: "Test string",
116
120
  });
121
+ /** Returns a list of active callbacks which belong to the execution with the given name. The returned callbacks are ordered by callback ID. first). */
122
+ await gapi.client.workflowexecutions.projects.locations.workflows.executions.callbacks.list({
123
+ pageSize: 42,
124
+ pageToken: "Test string",
125
+ parent: "Test string",
126
+ });
117
127
  }
118
128
  });