@maxim_mazurok/gapi.client.workflowexecutions-v1 0.0.20220808

package/index.d.ts

@@ -0,0 +1,372 @@
+/* Type definitions for non-npm package Workflow Executions API v1 0.0 */
+// Project: https://cloud.google.com/workflows
+// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
+//                 Nick Amoscato <https://github.com/namoscato>
+//                 Declan Vong <https://github.com/declanvong>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.8
+
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+// Generated from: https://workflowexecutions.googleapis.com/$discovery/rest?version=v1
+// Revision: 20220808
+
+/// <reference types="gapi.client" />
+
+declare namespace gapi.client {
+    /** Load Workflow Executions API v1 */
+    function load(urlOrObject: "https://workflowexecutions.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "workflowexecutions", version: "v1"): Promise<void>;
+    /** @deprecated Please load APIs with discovery documents. */
+    function load(name: "workflowexecutions", version: "v1", callback: () => any): void;
+
+    namespace workflowexecutions {
+        // tslint:disable-next-line:no-empty-interface
+        interface CancelExecutionRequest {
+        }
+        interface Error {
+            /** Human-readable stack trace string. */
+            context?: string;
+            /** Error message and data returned represented as a JSON string. */
+            payload?: string;
+            /** Stack trace with detailed information of where error was generated. */
+            stackTrace?: StackTrace;
+        }
+        interface Execution {
+            /**
+             * Input parameters of the execution represented as a JSON string. The size limit is 32KB. *Note*: If you are using the REST API directly to run your workflow, you must escape any JSON
+             * string value of `argument`. Example: `'{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'`
+             */
+            argument?: string;
+            /** The call logging level associated to this execution. */
+            callLogLevel?: string;
+            /** Output only. Marks the end of execution, successful or not. */
+            endTime?: string;
+            /** Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is `FAILED` or `CANCELLED`. */
+            error?: Error;
+            /** Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} */
+            name?: string;
+            /** Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is `SUCCEEDED`. */
+            result?: string;
+            /** Output only. Marks the beginning of execution. */
+            startTime?: string;
+            /** Output only. Current state of the execution. */
+            state?: string;
+            /** Output only. Revision of the workflow this execution is using. */
+            workflowRevisionId?: string;
+        }
+        interface ListExecutionsResponse {
+            /** The executions which match the request. */
+            executions?: Execution[];
+            /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+            nextPageToken?: string;
+        }
+        interface Position {
+            /** The source code column position (of the line) the current instruction was generated from. */
+            column?: string;
+            /** The number of bytes of source code making up this stack trace element. */
+            length?: string;
+            /** The source code line number the current instruction was generated from. */
+            line?: string;
+        }
+        interface PubsubMessage {
+            /** Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription. */
+            attributes?: { [P in string]: string };
+            /** The message data field. If this field is empty, the message must contain at least one attribute. */
+            data?: string;
+            /**
+             * ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a
+             * `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
+             */
+            messageId?: string;
+            /**
+             * If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the
+             * same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given
+             * `PublishRequest` must specify the same `ordering_key` value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering).
+             */
+            orderingKey?: string;
+            /** The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */
+            publishTime?: string;
+        }
+        interface StackTrace {
+            /** An array of stack elements. */
+            elements?: StackTraceElement[];
+        }
+        interface StackTraceElement {
+            /** The source position information of the stack trace element. */
+            position?: Position;
+            /** The routine where the error occurred. */
+            routine?: string;
+            /** The step the error occurred at. */
+            step?: string;
+        }
+        interface TriggerPubsubExecutionRequest {
+            /** Required. LINT: LEGACY_NAMES The query parameter value for __GCP_CloudEventsMode, set by the Eventarc service when configuring triggers. */
+            GCPCloudEventsMode?: string;
+            /** Required. The message of the Pub/Sub push notification. */
+            message?: PubsubMessage;
+            /** Required. The subscription of the Pub/Sub push notification. Format: projects/{project}/subscriptions/{sub} */
+            subscription?: string;
+        }
+        interface ExecutionsResource {
+            /** Cancels an execution of the given name. */
+            cancel(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** 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. */
+                key?: string;
+                /** Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** 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. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Request body */
+                resource: CancelExecutionRequest;
+            }): Request<Execution>;
+            cancel(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** 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. */
+                key?: string;
+                /** Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** 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. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            },
+            body: CancelExecutionRequest): Request<Execution>;
+            /** Creates a new execution using the latest revision of the given workflow. */
+            create(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** 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. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /**
+                 * Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow
+                 * will be used.
+                 */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** 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. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Request body */
+                resource: Execution;
+            }): Request<Execution>;
+            create(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** 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. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /**
+                 * Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow
+                 * will be used.
+                 */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** 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. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            },
+            body: Execution): Request<Execution>;
+            /** Returns an execution of the given name. */
+            get(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** 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. */
+                key?: string;
+                /** Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** 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. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view. */
+                view?: string;
+            }): Request<Execution>;
+            /**
+             * Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their
+             * start time (newest first).
+             */
+            list(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** 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. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /**
+                 * Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 10000 for BASIC and 100 for FULL. The default value used if the
+                 * field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.
+                 */
+                pageSize?: number;
+                /**
+                 * A page token, received from a previous `ListExecutions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListExecutions`
+                 * must match the call that provided the page token.
+                 */
+                pageToken?: string;
+                /** Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow} */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** 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. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view. */
+                view?: string;
+            }): Request<ListExecutionsResponse>;
+        }
+        interface WorkflowsResource {
+            /** Triggers a new execution using the latest revision of the given workflow by a Pub/Sub push notification. */
+            triggerPubsubExecution(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** 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. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** 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. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} */
+                workflow: string;
+                /** Request body */
+                resource: TriggerPubsubExecutionRequest;
+            }): Request<Execution>;
+            triggerPubsubExecution(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** 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. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** 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. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} */
+                workflow: string;
+            },
+            body: TriggerPubsubExecutionRequest): Request<Execution>;
+            executions: ExecutionsResource;
+        }
+        interface LocationsResource {
+            workflows: WorkflowsResource;
+        }
+        interface ProjectsResource {
+            locations: LocationsResource;
+        }
+
+        const projects: ProjectsResource;
+    }
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.workflowexecutions-v1",
+  "version": "0.0.20220808",
+  "description": "TypeScript typings for Workflow Executions API v1",
+  "license": "MIT",
+  "author": {
+    "email": "maxim@mazurok.com",
+    "name": "Maxim Mazurok",
+    "url": "https://maxim.mazurok.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
+  "types": "index.d.ts",
+  "dependencies": {
+    "@types/gapi.client": "*",
+    "@types/gapi.client.discovery": "*"
+  }
+}

package/readme.md

@@ -0,0 +1,68 @@
+# TypeScript typings for Workflow Executions API v1
+
+Execute workflows created with Workflows API.
+For detailed description please check [documentation](https://cloud.google.com/workflows).
+
+## Installing
+
+Install typings for Workflow Executions API:
+
+```
+npm install @types/gapi.client.workflowexecutions-v1 --save-dev
+```
+
+## Usage
+
+You need to initialize Google API client in your code:
+
+```typescript
+gapi.load('client', () => {
+  // now we can use gapi.client
+  // ...
+});
+```
+
+Then load api client wrapper:
+
+```typescript
+gapi.client.load('https://workflowexecutions.googleapis.com/$discovery/rest?version=v1', () => {
+  // now we can use:
+  // gapi.client.workflowexecutions
+});
+```
+
+```typescript
+// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
+gapi.client.load('workflowexecutions', 'v1', () => {
+  // now we can use:
+  // gapi.client.workflowexecutions
+});
+```
+
+Don't forget to authenticate your client before sending any request to resources:
+
+```typescript
+// declare client_id registered in Google Developers Console
+var client_id = '',
+  scope = [
+      // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
+      'https://www.googleapis.com/auth/cloud-platform',
+    ],
+    immediate = true;
+// ...
+
+gapi.auth.authorize(
+  { client_id: client_id, scope: scope, immediate: immediate },
+  authResult => {
+    if (authResult && !authResult.error) {
+        /* handle successful authorization */
+    } else {
+        /* handle authorization error */
+    }
+});
+```
+
+After that you can use Workflow Executions API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+```

package/tests.ts

@@ -0,0 +1,99 @@
+/* This is stub file for gapi.client.workflowexecutions-v1 definition tests */
+// IMPORTANT
+// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
+// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
+
+// Revision: 20220808
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://workflowexecutions.googleapis.com/$discovery/rest?version=v1');
+    /** now we can use gapi.client.workflowexecutions */
+
+    /** don't forget to authenticate your client before sending any request to resources: */
+    /** declare client_id registered in Google Developers Console */
+    const client_id = '<<PUT YOUR CLIENT ID HERE>>';
+    const scope = [
+        /** See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. */
+        'https://www.googleapis.com/auth/cloud-platform',
+    ];
+    const immediate = false;
+    gapi.auth.authorize({ client_id, scope, immediate }, authResult => {
+        if (authResult && !authResult.error) {
+            /** handle successful authorization */
+            run();
+        } else {
+            /** handle authorization error */
+        }
+    });
+
+    async function run() {
+        /** Triggers a new execution using the latest revision of the given workflow by a Pub/Sub push notification. */
+        await gapi.client.workflowexecutions.projects.locations.workflows.triggerPubsubExecution({
+            workflow: "Test string",
+        }, {
+            GCPCloudEventsMode: "Test string",
+            message: {
+                attributes: {
+                    A: "Test string"
+                },
+                data: "Test string",
+                messageId: "Test string",
+                orderingKey: "Test string",
+                publishTime: "Test string",
+            },
+            subscription: "Test string",
+        });
+        /** Cancels an execution of the given name. */
+        await gapi.client.workflowexecutions.projects.locations.workflows.executions.cancel({
+            name: "Test string",
+        }, {
+        });
+        /** Creates a new execution using the latest revision of the given workflow. */
+        await gapi.client.workflowexecutions.projects.locations.workflows.executions.create({
+            parent: "Test string",
+        }, {
+            argument: "Test string",
+            callLogLevel: "Test string",
+            endTime: "Test string",
+            error: {
+                context: "Test string",
+                payload: "Test string",
+                stackTrace: {
+                    elements: [
+                        {
+                            position: {
+                                column: "Test string",
+                                length: "Test string",
+                                line: "Test string",
+                            },
+                            routine: "Test string",
+                            step: "Test string",
+                        }
+                    ],
+                },
+            },
+            name: "Test string",
+            result: "Test string",
+            startTime: "Test string",
+            state: "Test string",
+            workflowRevisionId: "Test string",
+        });
+        /** Returns an execution of the given name. */
+        await gapi.client.workflowexecutions.projects.locations.workflows.executions.get({
+            name: "Test string",
+            view: "Test string",
+        });
+        /**
+         * Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start
+         * time (newest first).
+         */
+        await gapi.client.workflowexecutions.projects.locations.workflows.executions.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+            view: "Test string",
+        });
+    }
+});

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": ["es6", "dom"],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true,
+        "strictFunctionTypes": true
+    },
+    "files": ["index.d.ts", "tests.ts"]
+}

package/tslint.json

@@ -0,0 +1,6 @@
+{
+    "extends": "dtslint/dtslint.json",
+    "rules": {
+        "no-redundant-jsdoc": false
+    }
+}