@maxim_mazurok/gapi.client.cloudtasks-v2beta2 0.0.20220813

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@maxim_mazurok/gapi.client.cloudtasks-v2beta2",
+  "version": "0.0.20220813",
+  "description": "TypeScript typings for Cloud Tasks API v2beta2",
+  "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 Tasks API v2beta2
+
+Manages the execution of large numbers of distributed requests.
+For detailed description please check [documentation](https://cloud.google.com/tasks/).
+
+## Installing
+
+Install typings for Cloud Tasks API:
+
+```
+npm install @types/gapi.client.cloudtasks-v2beta2 --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://cloudtasks.googleapis.com/$discovery/rest?version=v2beta2', () => {
+  // now we can use:
+  // gapi.client.cloudtasks
+});
+```
+
+```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('cloudtasks', 'v2beta2', () => {
+  // now we can use:
+  // gapi.client.cloudtasks
+});
+```
+
+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 Tasks API resources: <!-- TODO: make this work for multiple namespaces -->
+
+```typescript
+```

package/tests.ts

@@ -0,0 +1,455 @@
+/* This is stub file for gapi.client.cloudtasks-v2beta2 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: 20220813
+
+gapi.load('client', async () => {
+    /** now we can use gapi.client */
+
+    await gapi.client.load('https://cloudtasks.googleapis.com/$discovery/rest?version=v2beta2');
+    /** now we can use gapi.client.cloudtasks */
+
+    /** 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.cloudtasks.projects.locations.get({
+            name: "Test string",
+        });
+        /** Lists information about the supported locations for this service. */
+        await gapi.client.cloudtasks.projects.locations.list({
+            filter: "Test string",
+            name: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+        });
+        /**
+         * Note: This feature is in its experimental stage. You must request access to the API through the [Cloud Tasks BufferQueues Experiment Signup form](https://forms.gle/X8Zr5hiXH5tTGFqh8).
+         * Creates and buffers a new task without the need to explicitly define a Task message. The queue must be an http queue (i.e., must have HTTP target). This method is used for a simplified
+         * application of Cloud Tasks queues in buffer and rate limitting HTTP requests.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.buffer({
+            name: "Test string",
+        }, {
+            body: {
+                contentType: "Test string",
+                data: "Test string",
+                extensions: [
+                    {
+                        A: 42
+                    }
+                ],
+            },
+        });
+        /**
+         * Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was
+         * dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of
+         * Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.create({
+            parent: "Test string",
+        }, {
+            appEngineHttpTarget: {
+                appEngineRoutingOverride: {
+                    host: "Test string",
+                    instance: "Test string",
+                    service: "Test string",
+                    version: "Test string",
+                },
+            },
+            httpTarget: {
+                headerOverrides: [
+                    {
+                        header: {
+                            key: "Test string",
+                            value: "Test string",
+                        },
+                    }
+                ],
+                httpMethod: "Test string",
+                oauthToken: {
+                    scope: "Test string",
+                    serviceAccountEmail: "Test string",
+                },
+                oidcToken: {
+                    audience: "Test string",
+                    serviceAccountEmail: "Test string",
+                },
+                uriOverride: {
+                    host: "Test string",
+                    path: "Test string",
+                    port: "Test string",
+                    query: "Test string",
+                    scheme: "Test string",
+                },
+            },
+            name: "Test string",
+            pullTarget: {
+            },
+            purgeTime: "Test string",
+            rateLimits: {
+                maxBurstSize: 42,
+                maxConcurrentTasks: 42,
+                maxTasksDispatchedPerSecond: 42,
+            },
+            retryConfig: {
+                maxAttempts: 42,
+                maxBackoff: "Test string",
+                maxDoublings: 42,
+                maxRetryDuration: "Test string",
+                minBackoff: "Test string",
+                unlimitedAttempts: true,
+            },
+            state: "Test string",
+            stats: {
+                concurrentDispatchesCount: "Test string",
+                effectiveExecutionRate: 42,
+                executedLastMinuteCount: "Test string",
+                oldestEstimatedArrivalTime: "Test string",
+                tasksCount: "Test string",
+            },
+            taskTtl: "Test string",
+            tombstoneTtl: "Test string",
+        });
+        /**
+         * Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. WARNING: Using this
+         * method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and
+         * queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.delete({
+            name: "Test string",
+        });
+        /** Gets a queue. */
+        await gapi.client.cloudtasks.projects.locations.queues.get({
+            name: "Test string",
+            readMask: "Test string",
+        });
+        /**
+         * Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following [Google
+         * IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy`
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.getIamPolicy({
+            resource: "Test string",
+        }, {
+            options: {
+                requestedPolicyVersion: 42,
+            },
+        });
+        /** Lists queues. Queues are returned in lexicographical order. */
+        await gapi.client.cloudtasks.projects.locations.queues.list({
+            filter: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+            readMask: "Test string",
+        });
+        /**
+         * Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. Queues created with this method allow tasks to live for a maximum of 31 days.
+         * After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App
+         * Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this
+         * method.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.patch({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            appEngineHttpTarget: {
+                appEngineRoutingOverride: {
+                    host: "Test string",
+                    instance: "Test string",
+                    service: "Test string",
+                    version: "Test string",
+                },
+            },
+            httpTarget: {
+                headerOverrides: [
+                    {
+                        header: {
+                            key: "Test string",
+                            value: "Test string",
+                        },
+                    }
+                ],
+                httpMethod: "Test string",
+                oauthToken: {
+                    scope: "Test string",
+                    serviceAccountEmail: "Test string",
+                },
+                oidcToken: {
+                    audience: "Test string",
+                    serviceAccountEmail: "Test string",
+                },
+                uriOverride: {
+                    host: "Test string",
+                    path: "Test string",
+                    port: "Test string",
+                    query: "Test string",
+                    scheme: "Test string",
+                },
+            },
+            name: "Test string",
+            pullTarget: {
+            },
+            purgeTime: "Test string",
+            rateLimits: {
+                maxBurstSize: 42,
+                maxConcurrentTasks: 42,
+                maxTasksDispatchedPerSecond: 42,
+            },
+            retryConfig: {
+                maxAttempts: 42,
+                maxBackoff: "Test string",
+                maxDoublings: 42,
+                maxRetryDuration: "Test string",
+                minBackoff: "Test string",
+                unlimitedAttempts: true,
+            },
+            state: "Test string",
+            stats: {
+                concurrentDispatchesCount: "Test string",
+                effectiveExecutionRate: 42,
+                executedLastMinuteCount: "Test string",
+                oldestEstimatedArrivalTime: "Test string",
+                tasksCount: "Test string",
+            },
+            taskTtl: "Test string",
+            tombstoneTtl: "Test string",
+        });
+        /**
+         * Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue
+         * is paused if its state is PAUSED.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.pause({
+            name: "Test string",
+        }, {
+        });
+        /**
+         * Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks
+         * might be dispatched before the purge takes effect. A purge is irreversible.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.purge({
+            name: "Test string",
+        }, {
+        });
+        /**
+         * Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to
+         * RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in [Managing
+         * Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.resume({
+            name: "Test string",
+        }, {
+        });
+        /**
+         * Sets the access control policy for a Queue. Replaces any existing policy. Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required
+         * to use the Cloud Console. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.setIamPolicy`
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.setIamPolicy({
+            resource: "Test string",
+        }, {
+            policy: {
+                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,
+            },
+        });
+        /**
+         * Returns permissions that a caller has on a Queue. 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.cloudtasks.projects.locations.queues.testIamPermissions({
+            resource: "Test string",
+        }, {
+            permissions: [
+                "Test string"
+            ],
+        });
+        /**
+         * Acknowledges a pull task. The worker, that is, the entity that leased this task must call this method to indicate that the work associated with the task has finished. The worker must
+         * acknowledge a task within the lease_duration or the lease will expire and the task will become available to be leased again. After the task is acknowledged, it will not be returned by a
+         * later LeaseTasks, GetTask, or ListTasks.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.tasks.acknowledge({
+            name: "Test string",
+        }, {
+            scheduleTime: "Test string",
+        });
+        /**
+         * Cancel a pull task's lease. The worker can use this method to cancel a task's lease by setting its schedule_time to now. This will make the task available to be leased to the next
+         * caller of LeaseTasks.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.tasks.cancelLease({
+            name: "Test string",
+        }, {
+            responseView: "Test string",
+            scheduleTime: "Test string",
+        });
+        /**
+         * Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * For App Engine queues, the maximum task size is 100KB. * For pull
+         * queues, the maximum task size is 1MB.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.tasks.create({
+            parent: "Test string",
+        }, {
+            responseView: "Test string",
+            task: {
+                appEngineHttpRequest: {
+                    appEngineRouting: {
+                        host: "Test string",
+                        instance: "Test string",
+                        service: "Test string",
+                        version: "Test string",
+                    },
+                    headers: {
+                        A: "Test string"
+                    },
+                    httpMethod: "Test string",
+                    payload: "Test string",
+                    relativeUrl: "Test string",
+                },
+                createTime: "Test string",
+                httpRequest: {
+                    body: "Test string",
+                    headers: {
+                        A: "Test string"
+                    },
+                    httpMethod: "Test string",
+                    oauthToken: {
+                        scope: "Test string",
+                        serviceAccountEmail: "Test string",
+                    },
+                    oidcToken: {
+                        audience: "Test string",
+                        serviceAccountEmail: "Test string",
+                    },
+                    url: "Test string",
+                },
+                name: "Test string",
+                pullMessage: {
+                    payload: "Test string",
+                    tag: "Test string",
+                },
+                scheduleTime: "Test string",
+                status: {
+                    attemptDispatchCount: 42,
+                    attemptResponseCount: 42,
+                    firstAttemptStatus: {
+                        dispatchTime: "Test string",
+                        responseStatus: {
+                            code: 42,
+                            details: [
+                                {
+                                    A: 42
+                                }
+                            ],
+                            message: "Test string",
+                        },
+                        responseTime: "Test string",
+                        scheduleTime: "Test string",
+                    },
+                    lastAttemptStatus: {
+                        dispatchTime: "Test string",
+                        responseStatus: {
+                            code: 42,
+                            details: [
+                                {
+                                    A: 42
+                                }
+                            ],
+                            message: "Test string",
+                        },
+                        responseTime: "Test string",
+                        scheduleTime: "Test string",
+                    },
+                },
+                view: "Test string",
+            },
+        });
+        /** Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has completed successfully or permanently failed. */
+        await gapi.client.cloudtasks.projects.locations.queues.tasks.delete({
+            name: "Test string",
+        });
+        /** Gets a task. */
+        await gapi.client.cloudtasks.projects.locations.queues.tasks.get({
+            name: "Test string",
+            responseView: "Test string",
+        });
+        /**
+         * Leases tasks from a pull queue for lease_duration. This method is invoked by the worker to obtain a lease. The worker must acknowledge the task via AcknowledgeTask after they have
+         * performed the work associated with the task. The payload is intended to store data that the worker needs to perform the work associated with the task. To return the payloads in the
+         * response, set response_view to FULL. A maximum of 10 qps of LeaseTasks requests are allowed per queue. RESOURCE_EXHAUSTED is returned when this limit is exceeded. RESOURCE_EXHAUSTED is
+         * also returned when max_tasks_dispatched_per_second is exceeded.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.tasks.lease({
+            parent: "Test string",
+        }, {
+            filter: "Test string",
+            leaseDuration: "Test string",
+            maxTasks: 42,
+            responseView: "Test string",
+        });
+        /**
+         * Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks
+         * may be returned in any order. The ordering may change at any time.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.tasks.list({
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+            responseView: "Test string",
+        });
+        /**
+         * Renew the current lease of a pull task. The worker can use this method to extend the lease by a new duration, starting from now. The new task lease will be returned in the task's
+         * schedule_time.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.tasks.renewLease({
+            name: "Test string",
+        }, {
+            leaseDuration: "Test string",
+            responseView: "Test string",
+            scheduleTime: "Test string",
+        });
+        /**
+         * Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This
+         * command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The
+         * dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a
+         * successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay
+         * specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed. RunTask cannot be called on a pull task.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.tasks.run({
+            name: "Test string",
+        }, {
+            responseView: "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
+    }
+}