@maxim_mazurok/gapi.client.redis-v1 0.0.20220728

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.redis-v1",
+  "version": "0.0.20220728",
+  "description": "TypeScript typings for Google Cloud Memorystore for Redis 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 Google Cloud Memorystore for Redis API v1
+
+Creates and manages Redis instances on the Google Cloud Platform.
+For detailed description please check [documentation](https://cloud.google.com/memorystore/docs/redis/).
+
+## Installing
+
+Install typings for Google Cloud Memorystore for Redis API:
+
+```
+npm install @types/gapi.client.redis-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://redis.googleapis.com/$discovery/rest?version=v1', () => {
+  // now we can use:
+  // gapi.client.redis
+});
+```
+
+```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('redis', 'v1', () => {
+  // now we can use:
+  // gapi.client.redis
+});
+```
+
+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 Google Cloud Memorystore for Redis API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+```

package/tests.ts

@@ -0,0 +1,318 @@
+/* This is stub file for gapi.client.redis-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: 20220728
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://redis.googleapis.com/$discovery/rest?version=v1');
+    /** now we can use gapi.client.redis */
+
+    /** 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 information about a location. */
+        await gapi.client.redis.projects.locations.get({
+            name: "Test string",
+        });
+        /** Lists information about the supported locations for this service. */
+        await gapi.client.redis.projects.locations.list({
+            filter: "Test string",
+            name: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+        });
+        /**
+         * Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's [default network](https://cloud.google.com/vpc/docs/vpc).
+         * The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional.
+         * Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to
+         * call DeleteOperation.
+         */
+        await gapi.client.redis.projects.locations.instances.create({
+            instanceId: "Test string",
+            parent: "Test string",
+        }, {
+            alternativeLocationId: "Test string",
+            authEnabled: true,
+            authorizedNetwork: "Test string",
+            connectMode: "Test string",
+            createTime: "Test string",
+            currentLocationId: "Test string",
+            customerManagedKey: "Test string",
+            displayName: "Test string",
+            host: "Test string",
+            labels: {
+                A: "Test string"
+            },
+            locationId: "Test string",
+            maintenancePolicy: {
+                createTime: "Test string",
+                description: "Test string",
+                updateTime: "Test string",
+                weeklyMaintenanceWindow: [
+                    {
+                        day: "Test string",
+                        duration: "Test string",
+                        startTime: {
+                            hours: 42,
+                            minutes: 42,
+                            nanos: 42,
+                            seconds: 42,
+                        },
+                    }
+                ],
+            },
+            maintenanceSchedule: {
+                canReschedule: true,
+                endTime: "Test string",
+                scheduleDeadlineTime: "Test string",
+                startTime: "Test string",
+            },
+            memorySizeGb: 42,
+            name: "Test string",
+            nodes: [
+                {
+                    id: "Test string",
+                    zone: "Test string",
+                }
+            ],
+            persistenceConfig: {
+                persistenceMode: "Test string",
+                rdbNextSnapshotTime: "Test string",
+                rdbSnapshotPeriod: "Test string",
+                rdbSnapshotStartTime: "Test string",
+            },
+            persistenceIamIdentity: "Test string",
+            port: 42,
+            readEndpoint: "Test string",
+            readEndpointPort: 42,
+            readReplicasMode: "Test string",
+            redisConfigs: {
+                A: "Test string"
+            },
+            redisVersion: "Test string",
+            replicaCount: 42,
+            reservedIpRange: "Test string",
+            secondaryIpRange: "Test string",
+            serverCaCerts: [
+                {
+                    cert: "Test string",
+                    createTime: "Test string",
+                    expireTime: "Test string",
+                    serialNumber: "Test string",
+                    sha1Fingerprint: "Test string",
+                }
+            ],
+            state: "Test string",
+            statusMessage: "Test string",
+            suspensionReasons: [
+                "Test string"
+            ],
+            tier: "Test string",
+            transitEncryptionMode: "Test string",
+        });
+        /** Deletes a specific Redis instance. Instance stops serving and data is deleted. */
+        await gapi.client.redis.projects.locations.instances.delete({
+            name: "Test string",
+        });
+        /**
+         * Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few
+         * hours, so there is no need to call DeleteOperation.
+         */
+        await gapi.client.redis.projects.locations.instances.export({
+            name: "Test string",
+        }, {
+            outputConfig: {
+                gcsDestination: {
+                    uri: "Test string",
+                },
+            },
+        });
+        /** Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance. */
+        await gapi.client.redis.projects.locations.instances.failover({
+            name: "Test string",
+        }, {
+            dataProtectionMode: "Test string",
+        });
+        /** Gets the details of a specific Redis instance. */
+        await gapi.client.redis.projects.locations.instances.get({
+            name: "Test string",
+        });
+        /** Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance. */
+        await gapi.client.redis.projects.locations.instances.getAuthString({
+            name: "Test string",
+        });
+        /**
+         * Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When
+         * complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
+         */
+        await gapi.client.redis.projects.locations.instances.import({
+            name: "Test string",
+        }, {
+            inputConfig: {
+                gcsSource: {
+                    uri: "Test string",
+                },
+            },
+        });
+        /**
+         * Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: *
+         * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.
+         */
+        await gapi.client.redis.projects.locations.instances.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /**
+         * Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation
+         * is automatically deleted after a few hours, so there is no need to call DeleteOperation.
+         */
+        await gapi.client.redis.projects.locations.instances.patch({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            alternativeLocationId: "Test string",
+            authEnabled: true,
+            authorizedNetwork: "Test string",
+            connectMode: "Test string",
+            createTime: "Test string",
+            currentLocationId: "Test string",
+            customerManagedKey: "Test string",
+            displayName: "Test string",
+            host: "Test string",
+            labels: {
+                A: "Test string"
+            },
+            locationId: "Test string",
+            maintenancePolicy: {
+                createTime: "Test string",
+                description: "Test string",
+                updateTime: "Test string",
+                weeklyMaintenanceWindow: [
+                    {
+                        day: "Test string",
+                        duration: "Test string",
+                        startTime: {
+                            hours: 42,
+                            minutes: 42,
+                            nanos: 42,
+                            seconds: 42,
+                        },
+                    }
+                ],
+            },
+            maintenanceSchedule: {
+                canReschedule: true,
+                endTime: "Test string",
+                scheduleDeadlineTime: "Test string",
+                startTime: "Test string",
+            },
+            memorySizeGb: 42,
+            name: "Test string",
+            nodes: [
+                {
+                    id: "Test string",
+                    zone: "Test string",
+                }
+            ],
+            persistenceConfig: {
+                persistenceMode: "Test string",
+                rdbNextSnapshotTime: "Test string",
+                rdbSnapshotPeriod: "Test string",
+                rdbSnapshotStartTime: "Test string",
+            },
+            persistenceIamIdentity: "Test string",
+            port: 42,
+            readEndpoint: "Test string",
+            readEndpointPort: 42,
+            readReplicasMode: "Test string",
+            redisConfigs: {
+                A: "Test string"
+            },
+            redisVersion: "Test string",
+            replicaCount: 42,
+            reservedIpRange: "Test string",
+            secondaryIpRange: "Test string",
+            serverCaCerts: [
+                {
+                    cert: "Test string",
+                    createTime: "Test string",
+                    expireTime: "Test string",
+                    serialNumber: "Test string",
+                    sha1Fingerprint: "Test string",
+                }
+            ],
+            state: "Test string",
+            statusMessage: "Test string",
+            suspensionReasons: [
+                "Test string"
+            ],
+            tier: "Test string",
+            transitEncryptionMode: "Test string",
+        });
+        /** Reschedule maintenance for a given instance in a given project and location. */
+        await gapi.client.redis.projects.locations.instances.rescheduleMaintenance({
+            name: "Test string",
+        }, {
+            rescheduleType: "Test string",
+            scheduleTime: "Test string",
+        });
+        /** Upgrades Redis instance to the newer Redis version specified in the request. */
+        await gapi.client.redis.projects.locations.instances.upgrade({
+            name: "Test string",
+        }, {
+            redisVersion: "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.redis.projects.locations.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.redis.projects.locations.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.redis.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.redis.projects.locations.operations.list({
+            filter: "Test string",
+            name: "Test string",
+            pageSize: 42,
+            pageToken: "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
+    }
+}