@maxim_mazurok/gapi.client.cloudshell-v1 0.0.20231113 → 0.0.20231129

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@maxim_mazurok/gapi.client.cloudshell-v1",
-  "version": "0.0.20231113",
+  "version": "0.0.20231129",
   "description": "TypeScript typings for Cloud Shell API v1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
+  },
   "license": "MIT",
   "author": {
-    "email": "maxim@mazurok.com",
     "name": "Maxim Mazurok",
+    "email": "maxim@mazurok.com",
     "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": "*",

package/readme.md

@@ -1,6 +1,6 @@
 # TypeScript typings for Cloud Shell API v1
 
-Allows users to start, configure, and connect to interactive shell sessions running in the cloud. 
+Allows users to start, configure, and connect to interactive shell sessions running in the cloud.
 For detailed description please check [documentation](https://cloud.google.com/shell/docs/).
 
 ## Installing
@@ -25,10 +25,13 @@ gapi.load('client', () => {
 Then load api client wrapper:
 
 ```typescript
-gapi.client.load('https://cloudshell.googleapis.com/$discovery/rest?version=v1', () => {
-  // now we can use:
-  // gapi.client.cloudshell
-});
+gapi.client.load(
+  'https://cloudshell.googleapis.com/$discovery/rest?version=v1',
+  () => {
+    // now we can use:
+    // gapi.client.cloudshell
+  }
+);
 ```
 
 ```typescript
@@ -45,44 +48,44 @@ Don't forget to authenticate your client before sending any request to resources
 // 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;
+    // 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 },
+  {client_id: client_id, scope: scope, immediate: immediate},
   authResult => {
     if (authResult && !authResult.error) {
-        /* handle successful authorization */
+      /* handle successful authorization */
     } else {
-        /* handle authorization error */
+      /* handle authorization error */
     }
-});
+  }
+);
 ```
 
 After that you can use Cloud Shell API resources: <!-- TODO: make this work for multiple namespaces -->
 
 ```typescript
-
 /*
 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.cloudshell.operations.cancel({ name: "name",  });
+await gapi.client.cloudshell.operations.cancel({name: 'name'});
 
 /*
 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.cloudshell.operations.delete({ name: "name",  });
+await gapi.client.cloudshell.operations.delete({name: 'name'});
 
 /*
 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.cloudshell.operations.get({ name: "name",  });
+await gapi.client.cloudshell.operations.get({name: 'name'});
 
 /*
 Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 */
-await gapi.client.cloudshell.operations.list({ name: "name",  });
+await gapi.client.cloudshell.operations.list({name: 'name'});
 ```

package/tests.ts

@@ -1,107 +0,0 @@
-/* This is stub file for gapi.client.cloudshell-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: 20231113
-
-gapi.load('client', async () => {
-    /** now we can use gapi.client */
-
-    await gapi.client.load('https://cloudshell.googleapis.com/$discovery/rest?version=v1');
-    /** now we can use gapi.client.cloudshell */
-
-    /** 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() {
-        /**
-         * 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.cloudshell.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.cloudshell.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.cloudshell.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`. */
-        await gapi.client.cloudshell.operations.list({
-            filter: "Test string",
-            name: "Test string",
-            pageSize: 42,
-            pageToken: "Test string",
-        });
-        /**
-         * Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this
-         * will error with ALREADY_EXISTS.
-         */
-        await gapi.client.cloudshell.users.environments.addPublicKey({
-            environment: "Test string",
-        }, {
-            key: "Test string",
-        });
-        /**
-         * Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without
-         * requiring the user to manually authenticate.
-         */
-        await gapi.client.cloudshell.users.environments.authorize({
-            name: "Test string",
-        }, {
-            accessToken: "Test string",
-            expireTime: "Test string",
-            idToken: "Test string",
-        });
-        /** Gets an environment. Returns NOT_FOUND if the environment does not exist. */
-        await gapi.client.cloudshell.users.environments.get({
-            name: "Test string",
-        });
-        /**
-         * Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with the same content is not
-         * present, this will error with NOT_FOUND.
-         */
-        await gapi.client.cloudshell.users.environments.removePublicKey({
-            environment: "Test string",
-        }, {
-            key: "Test string",
-        });
-        /**
-         * Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for
-         * the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a
-         * StartEnvironmentResponse in its response field.
-         */
-        await gapi.client.cloudshell.users.environments.start({
-            name: "Test string",
-        }, {
-            accessToken: "Test string",
-            publicKeys: [
-                "Test string"
-            ],
-        });
-    }
-});

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-    "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

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