@maxim_mazurok/gapi.client.workflows-v1 0.0.20221201 → 0.0.20221208

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 +16 -16
  2. package/package.json +1 -1
  3. package/tests.ts +6 -6
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://workflows.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20221201
12
+ // Revision: 20221208
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -42,7 +42,7 @@ declare namespace gapi.client {
42
42
  nextPageToken?: string;
43
43
  /** Unreachable resources. */
44
44
  unreachable?: string[];
45
- /** The workflows which match the request. */
45
+ /** The workflows that match the request. */
46
46
  workflows?: Workflow[];
47
47
  }
48
48
  interface Location {
@@ -103,18 +103,18 @@ declare namespace gapi.client {
103
103
  message?: string;
104
104
  }
105
105
  interface Workflow {
106
- /** Output only. The timestamp of when the workflow was created. */
106
+ /** Output only. The timestamp for when the workflow was created. */
107
107
  createTime?: string;
108
108
  /** Description of the workflow provided by the user. Must be at most 1000 unicode characters long. */
109
109
  description?: string;
110
110
  /**
111
111
  * Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric
112
- * characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.
112
+ * characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed.
113
113
  */
114
114
  labels?: { [P in string]: string };
115
115
  /** The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow} */
116
116
  name?: string;
117
- /** Output only. The timestamp that the latest revision of the workflow was created. */
117
+ /** Output only. The timestamp for the latest revision of the workflow's creation. */
118
118
  revisionCreateTime?: string;
119
119
  /**
120
120
  * Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code
@@ -133,7 +133,7 @@ declare namespace gapi.client {
133
133
  sourceContents?: string;
134
134
  /** Output only. State of the workflow deployment. */
135
135
  state?: string;
136
- /** Output only. The last update timestamp of the workflow. */
136
+ /** Output only. The timestamp for when the workflow was last updated. */
137
137
  updateTime?: string;
138
138
  }
139
139
  interface OperationsResource {
@@ -234,7 +234,7 @@ declare namespace gapi.client {
234
234
  }): Request<ListOperationsResponse>;
235
235
  }
236
236
  interface WorkflowsResource {
237
- /** Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error. */
237
+ /** Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation returns a ALREADY_EXISTS error. */
238
238
  create(request: {
239
239
  /** V1 error format. */
240
240
  "$.xgafv"?: string;
@@ -327,7 +327,7 @@ declare namespace gapi.client {
327
327
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
328
328
  uploadType?: string;
329
329
  }): Request<Operation>;
330
- /** Gets details of a single Workflow. */
330
+ /** Gets details of a single workflow. */
331
331
  get(request?: {
332
332
  /** V1 error format. */
333
333
  "$.xgafv"?: string;
@@ -341,7 +341,7 @@ declare namespace gapi.client {
341
341
  fields?: string;
342
342
  /** 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. */
343
343
  key?: string;
344
- /** Required. Name of the workflow which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow} */
344
+ /** Required. Name of the workflow for which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow} */
345
345
  name: string;
346
346
  /** OAuth 2.0 token for the current user. */
347
347
  oauth_token?: string;
@@ -354,7 +354,7 @@ declare namespace gapi.client {
354
354
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
355
355
  uploadType?: string;
356
356
  }): Request<Workflow>;
357
- /** Lists Workflows in a given project and location. The default order is not specified. */
357
+ /** Lists workflows in a given project and location. The default order is not specified. */
358
358
  list(request?: {
359
359
  /** V1 error format. */
360
360
  "$.xgafv"?: string;
@@ -373,13 +373,13 @@ declare namespace gapi.client {
373
373
  /** OAuth 2.0 token for the current user. */
374
374
  oauth_token?: string;
375
375
  /**
376
- * Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a "
377
- * desc" suffix. If not specified, the results will be returned in an unspecified order.
376
+ * Comma-separated list of fields that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a "desc"
377
+ * suffix. If not specified, the results are returned in an unspecified order.
378
378
  */
379
379
  orderBy?: string;
380
380
  /**
381
- * Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum
382
- * permitted value is 1000 and values greater than 1000 will be coerced down to 1000.
381
+ * Maximum number of workflows to return per call. The service might return fewer than this value even if not at the end of the collection. If a value is not specified, a default
382
+ * value of 500 is used. The maximum permitted value is 1000 and values greater than 1000 are coerced down to 1000.
383
383
  */
384
384
  pageSize?: number;
385
385
  /**
@@ -399,8 +399,8 @@ declare namespace gapi.client {
399
399
  uploadType?: string;
400
400
  }): Request<ListWorkflowsResponse>;
401
401
  /**
402
- * Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a
403
- * successful update operation. In that case, such revision will be used in new workflow executions.
402
+ * Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a
403
+ * successful update operation. In that case, the new revision is used in new workflow executions.
404
404
  */
405
405
  patch(request: {
406
406
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.workflows-v1",
3
- "version": "0.0.20221201",
3
+ "version": "0.0.20221208",
4
4
  "description": "TypeScript typings for Workflows 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: 20221201
6
+ // Revision: 20221208
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -63,7 +63,7 @@ gapi.load('client', async () => {
63
63
  pageSize: 42,
64
64
  pageToken: "Test string",
65
65
  });
66
- /** Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error. */
66
+ /** Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation returns a ALREADY_EXISTS error. */
67
67
  await gapi.client.workflows.projects.locations.workflows.create({
68
68
  parent: "Test string",
69
69
  workflowId: "Test string",
@@ -85,11 +85,11 @@ gapi.load('client', async () => {
85
85
  await gapi.client.workflows.projects.locations.workflows.delete({
86
86
  name: "Test string",
87
87
  });
88
- /** Gets details of a single Workflow. */
88
+ /** Gets details of a single workflow. */
89
89
  await gapi.client.workflows.projects.locations.workflows.get({
90
90
  name: "Test string",
91
91
  });
92
- /** Lists Workflows in a given project and location. The default order is not specified. */
92
+ /** Lists workflows in a given project and location. The default order is not specified. */
93
93
  await gapi.client.workflows.projects.locations.workflows.list({
94
94
  filter: "Test string",
95
95
  orderBy: "Test string",
@@ -98,8 +98,8 @@ gapi.load('client', async () => {
98
98
  parent: "Test string",
99
99
  });
100
100
  /**
101
- * Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful
102
- * update operation. In that case, such revision will be used in new workflow executions.
101
+ * Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a
102
+ * successful update operation. In that case, the new revision is used in new workflow executions.
103
103
  */
104
104
  await gapi.client.workflows.projects.locations.workflows.patch({
105
105
  name: "Test string",