@maxim_mazurok/gapi.client.cloudasset-v1beta1 0.0.20220805

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.cloudasset-v1beta1",
+  "version": "0.0.20220805",
+  "description": "TypeScript typings for Cloud Asset 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,93 @@
+# TypeScript typings for Cloud Asset API v1beta1
+
+The cloud asset API manages the history and inventory of cloud resources.
+For detailed description please check [documentation](https://cloud.google.com/asset-inventory/docs/quickstart).
+
+## Installing
+
+Install typings for Cloud Asset API:
+
+```
+npm install @types/gapi.client.cloudasset-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://cloudasset.googleapis.com/$discovery/rest?version=v1beta1', () => {
+  // now we can use:
+  // gapi.client.cloudasset
+});
+```
+
+```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('cloudasset', 'v1beta1', () => {
+  // now we can use:
+  // gapi.client.cloudasset
+});
+```
+
+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 Asset API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+
+/*
+Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the google.longrunning.Operation API allowing you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.
+*/
+await gapi.client.cloudasset.folders.exportAssets({ parent: "parent",  });
+
+/*
+Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.
+*/
+await gapi.client.cloudasset.organizations.batchGetAssetsHistory({ parent: "parent",  });
+
+/*
+Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the google.longrunning.Operation API allowing you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.
+*/
+await gapi.client.cloudasset.organizations.exportAssets({ parent: "parent",  });
+
+/*
+Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.
+*/
+await gapi.client.cloudasset.projects.batchGetAssetsHistory({ parent: "parent",  });
+
+/*
+Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the google.longrunning.Operation API allowing you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.
+*/
+await gapi.client.cloudasset.projects.exportAssets({ parent: "parent",  });
+```

package/tests.ts

@@ -0,0 +1,129 @@
+/* This is stub file for gapi.client.cloudasset-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: 20220805
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://cloudasset.googleapis.com/$discovery/rest?version=v1beta1');
+    /** now we can use gapi.client.cloudasset */
+
+    /** 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() {
+        /**
+         * Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the google.longrunning.Operation API
+         * allowing you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the
+         * export operation usually finishes within 5 minutes.
+         */
+        await gapi.client.cloudasset.folders.exportAssets({
+            parent: "Test string",
+        }, {
+            assetTypes: [
+                "Test string"
+            ],
+            contentType: "Test string",
+            outputConfig: {
+                gcsDestination: {
+                    uri: "Test string",
+                    uriPrefix: "Test string",
+                },
+            },
+            readTime: "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.cloudasset.folders.operations.get({
+            name: "Test string",
+        });
+        /**
+         * Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can
+         * create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an
+         * INVALID_ARGUMENT error.
+         */
+        await gapi.client.cloudasset.organizations.batchGetAssetsHistory({
+            assetNames: "Test string",
+            contentType: "Test string",
+            parent: "Test string",
+            "readTimeWindow.endTime": "Test string",
+            "readTimeWindow.startTime": "Test string",
+        });
+        /**
+         * Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the google.longrunning.Operation API
+         * allowing you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the
+         * export operation usually finishes within 5 minutes.
+         */
+        await gapi.client.cloudasset.organizations.exportAssets({
+            parent: "Test string",
+        }, {
+            assetTypes: [
+                "Test string"
+            ],
+            contentType: "Test string",
+            outputConfig: {
+                gcsDestination: {
+                    uri: "Test string",
+                    uriPrefix: "Test string",
+                },
+            },
+            readTime: "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.cloudasset.organizations.operations.get({
+            name: "Test string",
+        });
+        /**
+         * Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can
+         * create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an
+         * INVALID_ARGUMENT error.
+         */
+        await gapi.client.cloudasset.projects.batchGetAssetsHistory({
+            assetNames: "Test string",
+            contentType: "Test string",
+            parent: "Test string",
+            "readTimeWindow.endTime": "Test string",
+            "readTimeWindow.startTime": "Test string",
+        });
+        /**
+         * Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the google.longrunning.Operation API
+         * allowing you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the
+         * export operation usually finishes within 5 minutes.
+         */
+        await gapi.client.cloudasset.projects.exportAssets({
+            parent: "Test string",
+        }, {
+            assetTypes: [
+                "Test string"
+            ],
+            contentType: "Test string",
+            outputConfig: {
+                gcsDestination: {
+                    uri: "Test string",
+                    uriPrefix: "Test string",
+                },
+            },
+            readTime: "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.cloudasset.projects.operations.get({
+            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
+    }
+}