@maxim_mazurok/gapi.client.securitycenter-v1beta1 0.0.20220809

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.securitycenter-v1beta1",
+  "version": "0.0.20220809",
+  "description": "TypeScript typings for Security Command Center API v1beta1",
+  "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,78 @@
+# TypeScript typings for Security Command Center API v1beta1
+
+Security Command Center API provides access to temporal views of assets and findings within an organization.
+For detailed description please check [documentation](https://cloud.google.com/security-command-center).
+
+## Installing
+
+Install typings for Security Command Center API:
+
+```
+npm install @types/gapi.client.securitycenter-v1beta1 --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://securitycenter.googleapis.com/$discovery/rest?version=v1beta1', () => {
+  // now we can use:
+  // gapi.client.securitycenter
+});
+```
+
+```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('securitycenter', 'v1beta1', () => {
+  // now we can use:
+  // gapi.client.securitycenter
+});
+```
+
+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 Security Command Center API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+/*
+Gets the settings for an organization.
+*/
+await gapi.client.securitycenter.organizations.getOrganizationSettings({ name: "name",  });
+
+/*
+Updates an organization's settings.
+*/
+await gapi.client.securitycenter.organizations.updateOrganizationSettings({ name: "name",  });
+```

package/tests.ts

@@ -0,0 +1,292 @@
+/* This is stub file for gapi.client.securitycenter-v1beta1 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: 20220809
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://securitycenter.googleapis.com/$discovery/rest?version=v1beta1');
+    /** now we can use gapi.client.securitycenter */
+
+    /** 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() {
+        /** Gets the settings for an organization. */
+        await gapi.client.securitycenter.organizations.getOrganizationSettings({
+            name: "Test string",
+        });
+        /** Updates an organization's settings. */
+        await gapi.client.securitycenter.organizations.updateOrganizationSettings({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            assetDiscoveryConfig: {
+                inclusionMode: "Test string",
+                projectIds: [
+                    "Test string"
+                ],
+            },
+            enableAssetDiscovery: true,
+            name: "Test string",
+        });
+        /** Filters an organization's assets and groups them by their specified properties. */
+        await gapi.client.securitycenter.organizations.assets.group({
+            parent: "Test string",
+        }, {
+            compareDuration: "Test string",
+            filter: "Test string",
+            groupBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            readTime: "Test string",
+        });
+        /** Lists an organization's assets. */
+        await gapi.client.securitycenter.organizations.assets.list({
+            compareDuration: "Test string",
+            fieldMask: "Test string",
+            filter: "Test string",
+            orderBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+            readTime: "Test string",
+        });
+        /**
+         * Runs asset discovery. The discovery is tracked with a long-running operation. This API can only be called with limited frequency for an organization. If it is called too frequently the
+         * caller will receive a TOO_MANY_REQUESTS error.
+         */
+        await gapi.client.securitycenter.organizations.assets.runDiscovery({
+            parent: "Test string",
+        }, {
+        });
+        /** Updates security marks. */
+        await gapi.client.securitycenter.organizations.assets.updateSecurityMarks({
+            name: "Test string",
+            startTime: "Test string",
+            updateMask: "Test string",
+        }, {
+            marks: {
+                A: "Test string"
+            },
+            name: "Test string",
+        });
+        /**
+         * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this
+         * method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation
+         * completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of
+         * 1, corresponding to `Code.CANCELLED`.
+         */
+        await gapi.client.securitycenter.organizations.operations.cancel({
+            name: "Test string",
+        }, {
+        });
+        /**
+         * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support
+         * this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+         */
+        await gapi.client.securitycenter.organizations.operations.delete({
+            name: "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.securitycenter.organizations.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.securitycenter.organizations.operations.list({
+            filter: "Test string",
+            name: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+        });
+        /** Creates a source. */
+        await gapi.client.securitycenter.organizations.sources.create({
+            parent: "Test string",
+        }, {
+            description: "Test string",
+            displayName: "Test string",
+            name: "Test string",
+        });
+        /** Gets a source. */
+        await gapi.client.securitycenter.organizations.sources.get({
+            name: "Test string",
+        });
+        /** Gets the access control policy on the specified Source. */
+        await gapi.client.securitycenter.organizations.sources.getIamPolicy({
+            resource: "Test string",
+        }, {
+            options: {
+                requestedPolicyVersion: 42,
+            },
+        });
+        /** Lists all sources belonging to an organization. */
+        await gapi.client.securitycenter.organizations.sources.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Updates a source. */
+        await gapi.client.securitycenter.organizations.sources.patch({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            description: "Test string",
+            displayName: "Test string",
+            name: "Test string",
+        });
+        /** Sets the access control policy on the specified Source. */
+        await gapi.client.securitycenter.organizations.sources.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 the permissions that a caller has on the specified source. */
+        await gapi.client.securitycenter.organizations.sources.testIamPermissions({
+            resource: "Test string",
+        }, {
+            permissions: [
+                "Test string"
+            ],
+        });
+        /** Creates a finding. The corresponding source must exist for finding creation to succeed. */
+        await gapi.client.securitycenter.organizations.sources.findings.create({
+            findingId: "Test string",
+            parent: "Test string",
+        }, {
+            category: "Test string",
+            createTime: "Test string",
+            eventTime: "Test string",
+            externalUri: "Test string",
+            name: "Test string",
+            parent: "Test string",
+            resourceName: "Test string",
+            securityMarks: {
+                marks: {
+                    A: "Test string"
+                },
+                name: "Test string",
+            },
+            sourceProperties: {
+                A: 42
+            },
+            state: "Test string",
+        });
+        /**
+         * Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example:
+         * /v1beta1/organizations/{organization_id}/sources/-/findings
+         */
+        await gapi.client.securitycenter.organizations.sources.findings.group({
+            parent: "Test string",
+        }, {
+            filter: "Test string",
+            groupBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            readTime: "Test string",
+        });
+        /** Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1beta1/organizations/{organization_id}/sources/-/findings */
+        await gapi.client.securitycenter.organizations.sources.findings.list({
+            fieldMask: "Test string",
+            filter: "Test string",
+            orderBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+            readTime: "Test string",
+        });
+        /** Creates or updates a finding. The corresponding source must exist for a finding creation to succeed. */
+        await gapi.client.securitycenter.organizations.sources.findings.patch({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            category: "Test string",
+            createTime: "Test string",
+            eventTime: "Test string",
+            externalUri: "Test string",
+            name: "Test string",
+            parent: "Test string",
+            resourceName: "Test string",
+            securityMarks: {
+                marks: {
+                    A: "Test string"
+                },
+                name: "Test string",
+            },
+            sourceProperties: {
+                A: 42
+            },
+            state: "Test string",
+        });
+        /** Updates the state of a finding. */
+        await gapi.client.securitycenter.organizations.sources.findings.setState({
+            name: "Test string",
+        }, {
+            startTime: "Test string",
+            state: "Test string",
+        });
+        /** Updates security marks. */
+        await gapi.client.securitycenter.organizations.sources.findings.updateSecurityMarks({
+            name: "Test string",
+            startTime: "Test string",
+            updateMask: "Test string",
+        }, {
+            marks: {
+                A: "Test string"
+            },
+            name: "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
+    }
+}