@maxim_mazurok/gapi.client.storage-v1 0.0.20230823 → 0.0.20230907

package/index.d.ts

@@ -9,7 +9,7 @@
 // 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
 // Generated from: https://storage.googleapis.com/$discovery/rest?version=v1
-// Revision: 20230823
+// Revision: 20230907
 
 /// <reference types="gapi.client" />
 
@@ -396,6 +396,27 @@ declare namespace gapi.client {
             nextPageToken?:
                 string;
         }
+        interface BulkRestoreObjectsRequest {
+            /**
+             * If false (default), the restore will not overwrite live objects with the same name at the destination. This means some deleted objects may be skipped. If true, live objects will be
+             * overwritten resulting in a noncurrent object (if versioning is enabled). If versioning is not enabled, overwriting the object will result in a soft-deleted object. In either case,
+             * if a noncurrent object already exists with the same name, a live version can be written without issue.
+             */
+            allowOverwrite?:
+                boolean;
+            /** If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false. */
+            copySourceAcl?:
+                boolean;
+            /** Restores only the objects matching any of the specified glob(s). If this parameter is not specified, all objects will be restored within the specified time range. */
+            matchGlobs?:
+                string[];
+            /** Restores only the objects that were soft-deleted after this time. */
+            softDeletedAfterTime?:
+                string;
+            /** Restores only the objects that were soft-deleted before this time. */
+            softDeletedBeforeTime?:
+                string;
+        }
         interface Channel {
             /** The address where notifications are delivered for this channel. */
             address?:
@@ -474,6 +495,52 @@ declare namespace gapi.client {
             title?:
                 string;
         }
+        interface GoogleLongrunningListOperationsResponse {
+            /** The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */
+            nextPageToken?:
+                string;
+            /** A list of operations that matches the specified filter in the request. */
+            operations?:
+                GoogleLongrunningOperation[];
+        }
+        interface GoogleLongrunningOperation {
+            /** If the value is "false", it means the operation is still in progress. If "true", the operation is completed, and either "error" or "response" is available. */
+            done?:
+                boolean;
+            /** The error result of the operation in case of failure or cancellation. */
+            error?:
+                GoogleRpcStatus;
+            /**
+             * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
+             * metadata. Any method that returns a long-running operation should document the metadata type, if any.
+             */
+            metadata?:
+                { [P in string]: any };
+            /**
+             * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the "name" should be a resource name ending
+             * with "operations/{operationId}".
+             */
+            name?:
+                string;
+            /**
+             * The normal response of the operation in case of success. If the original method returns no data on success, such as "Delete", the response is google.protobuf.Empty. If the original
+             * method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type "XxxResponse", where "Xxx" is the original method
+             * name. For example, if the original method name is "TakeSnapshot()", the inferred response type is "TakeSnapshotResponse".
+             */
+            response?:
+                { [P in string]: any };
+        }
+        interface GoogleRpcStatus {
+            /** The status code, which should be an enum value of google.rpc.Code. */
+            code?:
+                number;
+            /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
+            details?:
+                Array<{ [P in string]: any }>;
+            /** A developer-facing error message, which should be in English. */
+            message?:
+                string;
+        }
         interface HmacKey {
             /** The kind of item this is. For HMAC keys, this is always storage#hmacKey. */
             kind?:
@@ -2792,6 +2859,69 @@ declare namespace gapi.client {
             body: ObjectAccessControl): Request<ObjectAccessControl>;
         }
         interface ObjectsResource {
+            /** Initiates a long-running bulk restore operation on the specified bucket. */
+            bulkRestore(request: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket in which the object resides. */
+                bucket:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "media", "multipart", "resumable"). */
+                uploadType?:
+                    string;
+                /** Deprecated. Please use quotaUser instead. */
+                userIp?:
+                    string;
+                /** Request body */
+                resource:
+                    BulkRestoreObjectsRequest;
+            }): Request<GoogleLongrunningOperation>;
+            bulkRestore(request: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket in which the object resides. */
+                bucket:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "media", "multipart", "resumable"). */
+                uploadType?:
+                    string;
+                /** Deprecated. Please use quotaUser instead. */
+                userIp?:
+                    string;
+            },
+            body: BulkRestoreObjectsRequest): Request<GoogleLongrunningOperation>;
             /** Concatenates a list of existing objects into a new object in the same bucket. */
             compose(request: {
                 /** Data format for the response. */
@@ -3221,6 +3351,9 @@ declare namespace gapi.client {
                 /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
                 quotaUser?:
                     string;
+                /** If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete. */
+                softDeleted?:
+                    boolean;
                 /** Upload protocol for media (e.g. "media", "multipart", "resumable"). */
                 uploadType?:
                     string;
@@ -3490,6 +3623,9 @@ declare namespace gapi.client {
                 /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
                 quotaUser?:
                     string;
+                /** If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete. */
+                softDeleted?:
+                    boolean;
                 /**
                  * Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset
                  * (inclusive) and endOffset (exclusive).
@@ -3650,6 +3786,135 @@ declare namespace gapi.client {
             body: Object
             // tslint:disable-next-line:ban-types
             ): Request<Object>;
+            /** Restores a soft-deleted object. */
+            restore(request: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket in which the object resides. */
+                bucket:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** Selects a specific revision of this object. */
+                generation:
+                    string;
+                /**
+                 * Makes the operation conditional on whether the object's one live generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions
+                 * of the object.
+                 */
+                ifGenerationMatch?:
+                    string;
+                /**
+                 * Makes the operation conditional on whether none of the object's live generations match the given value. If no live object exists, the precondition fails. Setting to 0 makes the
+                 * operation succeed only if there is a live version of the object.
+                 */
+                ifGenerationNotMatch?:
+                    string;
+                /** Makes the operation conditional on whether the object's one live metageneration matches the given value. */
+                ifMetagenerationMatch?:
+                    string;
+                /** Makes the operation conditional on whether none of the object's live metagenerations match the given value. */
+                ifMetagenerationNotMatch?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */
+                object:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Set of properties to return. Defaults to full. */
+                projection?:
+                    string;
+                /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "media", "multipart", "resumable"). */
+                uploadType?:
+                    string;
+                /** Deprecated. Please use quotaUser instead. */
+                userIp?:
+                    string;
+                /** The project to be billed for this request. Required for Requester Pays buckets. */
+                userProject?:
+                    string;
+                /** Request body */
+                resource:
+                    // tslint:disable-next-line:ban-types
+                    Object;
+            }
+            // tslint:disable-next-line:ban-types
+            ): Request<Object>;
+            restore(request: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket in which the object resides. */
+                bucket:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** Selects a specific revision of this object. */
+                generation:
+                    string;
+                /**
+                 * Makes the operation conditional on whether the object's one live generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions
+                 * of the object.
+                 */
+                ifGenerationMatch?:
+                    string;
+                /**
+                 * Makes the operation conditional on whether none of the object's live generations match the given value. If no live object exists, the precondition fails. Setting to 0 makes the
+                 * operation succeed only if there is a live version of the object.
+                 */
+                ifGenerationNotMatch?:
+                    string;
+                /** Makes the operation conditional on whether the object's one live metageneration matches the given value. */
+                ifMetagenerationMatch?:
+                    string;
+                /** Makes the operation conditional on whether none of the object's live metagenerations match the given value. */
+                ifMetagenerationNotMatch?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */
+                object:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Set of properties to return. Defaults to full. */
+                projection?:
+                    string;
+                /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "media", "multipart", "resumable"). */
+                uploadType?:
+                    string;
+                /** Deprecated. Please use quotaUser instead. */
+                userIp?:
+                    string;
+                /** The project to be billed for this request. Required for Requester Pays buckets. */
+                userProject?:
+                    string;
+            },
+            // tslint:disable-next-line:ban-types
+            body: Object
+            // tslint:disable-next-line:ban-types
+            ): Request<Object>;
             /** Rewrites a source object to a destination object. Optionally overrides metadata. */
             rewrite(request: {
                 /** Data format for the response. */
@@ -4288,6 +4553,116 @@ declare namespace gapi.client {
             },
             body: Channel): Request<Channel>;
         }
+        interface OperationsResource {
+            /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. */
+            cancel(request?: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** The parent bucket of the operation resource. */
+                bucket:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** The ID of the operation resource. */
+                operationId:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "media", "multipart", "resumable"). */
+                uploadType?:
+                    string;
+                /** Deprecated. Please use quotaUser instead. */
+                userIp?:
+                    string;
+            }): Request<void>;
+            /** Gets the latest state of a long-running operation. */
+            get(request?: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** The parent bucket of the operation resource. */
+                bucket:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** The ID of the operation resource. */
+                operationId:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "media", "multipart", "resumable"). */
+                uploadType?:
+                    string;
+                /** Deprecated. Please use quotaUser instead. */
+                userIp?:
+                    string;
+            }): Request<GoogleLongrunningOperation>;
+            /** Lists operations that match the specified filter in the request. */
+            list(request?: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket in which to look for operations. */
+                bucket:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** A filter to narrow down results to a preferred subset. The filtering language is documented in more detail in [AIP-160](https://google.aip.dev/160). */
+                filter?:
+                    string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /**
+                 * Maximum number of items to return in a single page of responses. Fewer total results may be returned than requested. The service uses this parameter or 100 items, whichever is
+                 * smaller.
+                 */
+                pageSize?:
+                    number;
+                /** A previously-returned page token representing part of the larger set of results to view. */
+                pageToken?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "media", "multipart", "resumable"). */
+                uploadType?:
+                    string;
+                /** Deprecated. Please use quotaUser instead. */
+                userIp?:
+                    string;
+            }): Request<GoogleLongrunningListOperationsResponse>;
+        }
         interface HmacKeysResource {
             /** Creates a new HMAC key for the specified service account. */
             create(request?: {
@@ -4578,6 +4953,8 @@ declare namespace gapi.client {
 
         const objects: ObjectsResource;
 
+        const operations: OperationsResource;
+
         const projects: ProjectsResource;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.storage-v1",
-  "version": "0.0.20230823",
+  "version": "0.0.20230907",
   "description": "TypeScript typings for Cloud Storage JSON API v1",
   "license": "MIT",
   "author": {

package/readme.md

@@ -243,6 +243,11 @@ Updates an ACL entry on the specified object.
 */
 await gapi.client.storage.objectAccessControls.update({ bucket: "bucket", entity: "entity", object: "object",  });
 
+/*
+Initiates a long-running bulk restore operation on the specified bucket.
+*/
+await gapi.client.storage.objects.bulkRestore({ bucket: "bucket",  });
+
 /*
 Concatenates a list of existing objects into a new object in the same bucket.
 */
@@ -283,6 +288,11 @@ Patches an object's metadata.
 */
 await gapi.client.storage.objects.patch({ bucket: "bucket", object: "object",  });
 
+/*
+Restores a soft-deleted object.
+*/
+await gapi.client.storage.objects.restore({ bucket: "bucket", generation: "generation", object: "object",  });
+
 /*
 Rewrites a source object to a destination object. Optionally overrides metadata.
 */
@@ -307,4 +317,19 @@ await gapi.client.storage.objects.update({ bucket: "bucket", object: "object",
 Watch for changes on all objects in a bucket.
 */
 await gapi.client.storage.objects.watchAll({ bucket: "bucket",  });
+
+/*
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.
+*/
+await gapi.client.storage.buckets.operations.cancel({ bucket: "bucket", operationId: "operationId",  });
+
+/*
+Gets the latest state of a long-running operation.
+*/
+await gapi.client.storage.buckets.operations.get({ bucket: "bucket", operationId: "operationId",  });
+
+/*
+Lists operations that match the specified filter in the request.
+*/
+await gapi.client.storage.buckets.operations.list({ bucket: "bucket",  });
 ```

package/tests.ts

@@ -3,7 +3,7 @@
 // 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: 20230823
+// Revision: 20230907
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -886,6 +886,18 @@ gapi.load('client', async () => {
             role: "Test string",
             selfLink: "Test string",
         });
+        /** Initiates a long-running bulk restore operation on the specified bucket. */
+        await gapi.client.storage.objects.bulkRestore({
+            bucket: "Test string",
+        }, {
+            allowOverwrite: true,
+            copySourceAcl: true,
+            matchGlobs: [
+                "Test string"
+            ],
+            softDeletedAfterTime: "Test string",
+            softDeletedBeforeTime: "Test string",
+        });
         /** Concatenates a list of existing objects into a new object in the same bucket. */
         await gapi.client.storage.objects.compose({
             destinationBucket: "Test string",
@@ -1069,6 +1081,7 @@ gapi.load('client', async () => {
             ifMetagenerationNotMatch: "Test string",
             object: "Test string",
             projection: "Test string",
+            softDeleted: true,
             userProject: "Test string",
         });
         /** Returns an IAM policy for the specified object. */
@@ -1163,6 +1176,7 @@ gapi.load('client', async () => {
             pageToken: "Test string",
             prefix: "Test string",
             projection: "Test string",
+            softDeleted: true,
             startOffset: "Test string",
             userProject: "Test string",
             versions: true,
@@ -1240,6 +1254,78 @@ gapi.load('client', async () => {
             timeStorageClassUpdated: "Test string",
             updated: "Test string",
         });
+        /** Restores a soft-deleted object. */
+        await gapi.client.storage.objects.restore({
+            bucket: "Test string",
+            generation: "Test string",
+            ifGenerationMatch: "Test string",
+            ifGenerationNotMatch: "Test string",
+            ifMetagenerationMatch: "Test string",
+            ifMetagenerationNotMatch: "Test string",
+            object: "Test string",
+            projection: "Test string",
+            userProject: "Test string",
+        }, {
+            acl: [
+                {
+                    bucket: "Test string",
+                    domain: "Test string",
+                    email: "Test string",
+                    entity: "Test string",
+                    entityId: "Test string",
+                    etag: "Test string",
+                    generation: "Test string",
+                    id: "Test string",
+                    kind: "Test string",
+                    object: "Test string",
+                    projectTeam: {
+                        projectNumber: "Test string",
+                        team: "Test string",
+                    },
+                    role: "Test string",
+                    selfLink: "Test string",
+                }
+            ],
+            bucket: "Test string",
+            cacheControl: "Test string",
+            componentCount: 42,
+            contentDisposition: "Test string",
+            contentEncoding: "Test string",
+            contentLanguage: "Test string",
+            contentType: "Test string",
+            crc32c: "Test string",
+            customerEncryption: {
+                encryptionAlgorithm: "Test string",
+                keySha256: "Test string",
+            },
+            customTime: "Test string",
+            etag: "Test string",
+            eventBasedHold: true,
+            generation: "Test string",
+            id: "Test string",
+            kind: "Test string",
+            kmsKeyName: "Test string",
+            md5Hash: "Test string",
+            mediaLink: "Test string",
+            metadata: {
+                A: "Test string"
+            },
+            metageneration: "Test string",
+            name: "Test string",
+            owner: {
+                entity: "Test string",
+                entityId: "Test string",
+            },
+            retentionExpirationTime: "Test string",
+            selfLink: "Test string",
+            size: "Test string",
+            storageClass: "Test string",
+            temporaryHold: true,
+            timeCreated: "Test string",
+            timeDeleted: "Test string",
+            timeStorageClassUpdated: "Test string",
+            updated: "Test string",
+        });
         /** Rewrites a source object to a destination object. Optionally overrides metadata. */
         await gapi.client.storage.objects.rewrite({
             destinationBucket: "Test string",
@@ -1456,6 +1542,23 @@ gapi.load('client', async () => {
             token: "Test string",
             type: "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. */
+        await gapi.client.storage.operations.cancel({
+            bucket: "Test string",
+            operationId: "Test string",
+        });
+        /** Gets the latest state of a long-running operation. */
+        await gapi.client.storage.operations.get({
+            bucket: "Test string",
+            operationId: "Test string",
+        });
+        /** Lists operations that match the specified filter in the request. */
+        await gapi.client.storage.operations.list({
+            bucket: "Test string",
+            filter: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+        });
         /** Creates a new HMAC key for the specified service account. */
         await gapi.client.storage.projects.hmacKeys.create({
             projectId: "Test string",