@maxim_mazurok/gapi.client.cloudfunctions-v2beta 0.0.20220805

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.cloudfunctions-v2beta",
+  "version": "0.0.20220805",
+  "description": "TypeScript typings for Cloud Functions API v2beta",
+  "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 Cloud Functions API v2beta
+
+Manages lightweight user-provided functions executed in response to events.
+For detailed description please check [documentation](https://cloud.google.com/functions).
+
+## Installing
+
+Install typings for Cloud Functions API:
+
+```
+npm install @types/gapi.client.cloudfunctions-v2beta --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://cloudfunctions.googleapis.com/$discovery/rest?version=v2beta', () => {
+  // now we can use:
+  // gapi.client.cloudfunctions
+});
+```
+
+```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('cloudfunctions', 'v2beta', () => {
+  // now we can use:
+  // gapi.client.cloudfunctions
+});
+```
+
+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 Cloud Functions API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+```

package/tests.ts

@@ -0,0 +1,384 @@
+/* This is stub file for gapi.client.cloudfunctions-v2beta 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: 20220805
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://cloudfunctions.googleapis.com/$discovery/rest?version=v2beta');
+    /** now we can use gapi.client.cloudfunctions */
+
+    /** 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() {
+        /** Lists information about the supported locations for this service. */
+        await gapi.client.cloudfunctions.projects.locations.list({
+            filter: "Test string",
+            name: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+        });
+        /** Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error. */
+        await gapi.client.cloudfunctions.projects.locations.functions.create({
+            functionId: "Test string",
+            parent: "Test string",
+        }, {
+            buildConfig: {
+                build: "Test string",
+                dockerRepository: "Test string",
+                entryPoint: "Test string",
+                environmentVariables: {
+                    A: "Test string"
+                },
+                runtime: "Test string",
+                source: {
+                    repoSource: {
+                        branchName: "Test string",
+                        commitSha: "Test string",
+                        dir: "Test string",
+                        invertRegex: true,
+                        projectId: "Test string",
+                        repoName: "Test string",
+                        tagName: "Test string",
+                    },
+                    storageSource: {
+                        bucket: "Test string",
+                        generation: "Test string",
+                        object: "Test string",
+                    },
+                },
+                sourceProvenance: {
+                    resolvedRepoSource: {
+                        branchName: "Test string",
+                        commitSha: "Test string",
+                        dir: "Test string",
+                        invertRegex: true,
+                        projectId: "Test string",
+                        repoName: "Test string",
+                        tagName: "Test string",
+                    },
+                    resolvedStorageSource: {
+                        bucket: "Test string",
+                        generation: "Test string",
+                        object: "Test string",
+                    },
+                },
+                workerPool: "Test string",
+            },
+            description: "Test string",
+            environment: "Test string",
+            eventTrigger: {
+                channel: "Test string",
+                eventFilters: [
+                    {
+                        attribute: "Test string",
+                        operator: "Test string",
+                        value: "Test string",
+                    }
+                ],
+                eventType: "Test string",
+                pubsubTopic: "Test string",
+                retryPolicy: "Test string",
+                serviceAccountEmail: "Test string",
+                trigger: "Test string",
+                triggerRegion: "Test string",
+            },
+            labels: {
+                A: "Test string"
+            },
+            name: "Test string",
+            serviceConfig: {
+                allTrafficOnLatestRevision: true,
+                availableMemory: "Test string",
+                environmentVariables: {
+                    A: "Test string"
+                },
+                ingressSettings: "Test string",
+                maxInstanceCount: 42,
+                minInstanceCount: 42,
+                revision: "Test string",
+                secretEnvironmentVariables: [
+                    {
+                        key: "Test string",
+                        projectId: "Test string",
+                        secret: "Test string",
+                        version: "Test string",
+                    }
+                ],
+                secretVolumes: [
+                    {
+                        mountPath: "Test string",
+                        projectId: "Test string",
+                        secret: "Test string",
+                        versions: [
+                            {
+                                path: "Test string",
+                                version: "Test string",
+                            }
+                        ],
+                    }
+                ],
+                service: "Test string",
+                serviceAccountEmail: "Test string",
+                timeoutSeconds: 42,
+                uri: "Test string",
+                vpcConnector: "Test string",
+                vpcConnectorEgressSettings: "Test string",
+            },
+            state: "Test string",
+            stateMessages: [
+                {
+                    message: "Test string",
+                    severity: "Test string",
+                    type: "Test string",
+                }
+            ],
+            updateTime: "Test string",
+        });
+        /** Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function. */
+        await gapi.client.cloudfunctions.projects.locations.functions.delete({
+            name: "Test string",
+        });
+        /**
+         * Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within 30 minutes of generation. For more information
+         * about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls
+         */
+        await gapi.client.cloudfunctions.projects.locations.functions.generateDownloadUrl({
+            name: "Test string",
+        }, {
+        });
+        /**
+         * Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once
+         * the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When
+         * uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * No credentials should be attached - the signed URLs
+         * provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have
+         * permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` And this header SHOULD NOT be
+         * specified: * `Authorization: Bearer YOUR_TOKEN`
+         */
+        await gapi.client.cloudfunctions.projects.locations.functions.generateUploadUrl({
+            parent: "Test string",
+        }, {
+        });
+        /** Returns a function with the given name from the requested project. */
+        await gapi.client.cloudfunctions.projects.locations.functions.get({
+            name: "Test string",
+        });
+        /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
+        await gapi.client.cloudfunctions.projects.locations.functions.getIamPolicy({
+            "options.requestedPolicyVersion": 42,
+            resource: "Test string",
+        });
+        /** Returns a list of functions that belong to the requested project. */
+        await gapi.client.cloudfunctions.projects.locations.functions.list({
+            filter: "Test string",
+            orderBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Updates existing function. */
+        await gapi.client.cloudfunctions.projects.locations.functions.patch({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            buildConfig: {
+                build: "Test string",
+                dockerRepository: "Test string",
+                entryPoint: "Test string",
+                environmentVariables: {
+                    A: "Test string"
+                },
+                runtime: "Test string",
+                source: {
+                    repoSource: {
+                        branchName: "Test string",
+                        commitSha: "Test string",
+                        dir: "Test string",
+                        invertRegex: true,
+                        projectId: "Test string",
+                        repoName: "Test string",
+                        tagName: "Test string",
+                    },
+                    storageSource: {
+                        bucket: "Test string",
+                        generation: "Test string",
+                        object: "Test string",
+                    },
+                },
+                sourceProvenance: {
+                    resolvedRepoSource: {
+                        branchName: "Test string",
+                        commitSha: "Test string",
+                        dir: "Test string",
+                        invertRegex: true,
+                        projectId: "Test string",
+                        repoName: "Test string",
+                        tagName: "Test string",
+                    },
+                    resolvedStorageSource: {
+                        bucket: "Test string",
+                        generation: "Test string",
+                        object: "Test string",
+                    },
+                },
+                workerPool: "Test string",
+            },
+            description: "Test string",
+            environment: "Test string",
+            eventTrigger: {
+                channel: "Test string",
+                eventFilters: [
+                    {
+                        attribute: "Test string",
+                        operator: "Test string",
+                        value: "Test string",
+                    }
+                ],
+                eventType: "Test string",
+                pubsubTopic: "Test string",
+                retryPolicy: "Test string",
+                serviceAccountEmail: "Test string",
+                trigger: "Test string",
+                triggerRegion: "Test string",
+            },
+            labels: {
+                A: "Test string"
+            },
+            name: "Test string",
+            serviceConfig: {
+                allTrafficOnLatestRevision: true,
+                availableMemory: "Test string",
+                environmentVariables: {
+                    A: "Test string"
+                },
+                ingressSettings: "Test string",
+                maxInstanceCount: 42,
+                minInstanceCount: 42,
+                revision: "Test string",
+                secretEnvironmentVariables: [
+                    {
+                        key: "Test string",
+                        projectId: "Test string",
+                        secret: "Test string",
+                        version: "Test string",
+                    }
+                ],
+                secretVolumes: [
+                    {
+                        mountPath: "Test string",
+                        projectId: "Test string",
+                        secret: "Test string",
+                        versions: [
+                            {
+                                path: "Test string",
+                                version: "Test string",
+                            }
+                        ],
+                    }
+                ],
+                service: "Test string",
+                serviceAccountEmail: "Test string",
+                timeoutSeconds: 42,
+                uri: "Test string",
+                vpcConnector: "Test string",
+                vpcConnectorEgressSettings: "Test string",
+            },
+            state: "Test string",
+            stateMessages: [
+                {
+                    message: "Test string",
+                    severity: "Test string",
+                    type: "Test string",
+                }
+            ],
+            updateTime: "Test string",
+        });
+        /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
+        await gapi.client.cloudfunctions.projects.locations.functions.setIamPolicy({
+            resource: "Test string",
+        }, {
+            policy: {
+                auditConfigs: [
+                    {
+                        auditLogConfigs: [
+                            {
+                                exemptedMembers: [
+                                    "Test string"
+                                ],
+                                logType: "Test string",
+                            }
+                        ],
+                        service: "Test string",
+                    }
+                ],
+                bindings: [
+                    {
+                        condition: {
+                            description: "Test string",
+                            expression: "Test string",
+                            location: "Test string",
+                            title: "Test string",
+                        },
+                        members: [
+                            "Test string"
+                        ],
+                        role: "Test string",
+                    }
+                ],
+                etag: "Test string",
+                version: 42,
+            },
+            updateMask: "Test string",
+        });
+        /**
+         * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
+         * operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+         */
+        await gapi.client.cloudfunctions.projects.locations.functions.testIamPermissions({
+            resource: "Test string",
+        }, {
+            permissions: [
+                "Test string"
+            ],
+        });
+        /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
+        await gapi.client.cloudfunctions.projects.locations.operations.get({
+            name: "Test string",
+        });
+        /**
+         * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to
+         * override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
+         * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
+         * ensure the name binding is the parent resource, without the operations collection id.
+         */
+        await gapi.client.cloudfunctions.projects.locations.operations.list({
+            filter: "Test string",
+            name: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+        });
+        /** Returns a list of runtimes that are supported for the requested project. */
+        await gapi.client.cloudfunctions.projects.locations.runtimes.list({
+            filter: "Test string",
+            parent: "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
+    }
+}