@maxim_mazurok/gapi.client.storage-v1 0.0.20240801 → 0.0.20240809

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: 20240801
+// Revision: 20240809
 
 /// <reference types="gapi.client" />
 
@@ -104,6 +104,8 @@ declare namespace gapi.client {
       };
       /** HTTP 1.1 Entity tag for the bucket. */
       etag?: string;
+      /** The generation of this bucket. */
+      generation?: string;
       /** The bucket's hierarchical namespace configuration. */
       hierarchicalNamespace?: {
         /** When set to true, hierarchical namespace is enabled for this bucket. */
@@ -151,7 +153,7 @@ declare namespace gapi.client {
       kind?: string;
       /** User-provided labels, in key/value pairs. */
       labels?: {[P in string]: string};
-      /** The bucket's lifecycle configuration. See lifecycle management for more information. */
+      /** The bucket's lifecycle configuration. See [Lifecycle Management](https://cloud.google.com/storage/docs/lifecycle) for more information. */
       lifecycle?: {
         /** A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken. */
         rule?: Array<{
@@ -191,7 +193,7 @@ declare namespace gapi.client {
           };
         }>;
       };
-      /** The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list. */
+      /** The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the [Developer's Guide](https://cloud.google.com/storage/docs/locations) for the authoritative list. */
       location?: string;
       /** The type of the bucket location. */
       locationType?: string;
@@ -232,6 +234,8 @@ declare namespace gapi.client {
       /** The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket. */
       rpo?: string;
       /** Reserved for future use. */
+      satisfiesPZI?: boolean;
+      /** Reserved for future use. */
       satisfiesPZS?: boolean;
       /** The URI of this bucket. */
       selfLink?: string;
@@ -242,7 +246,7 @@ declare namespace gapi.client {
         /** The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. */
         retentionDurationSeconds?: string;
       };
-      /** The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes. */
+      /** The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes). */
       storageClass?: string;
       /** The creation time of the bucket in RFC 3339 format. */
       timeCreated?: string;
@@ -253,7 +257,7 @@ declare namespace gapi.client {
         /** While set to true, versioning is fully enabled for this bucket. */
         enabled?: boolean;
       };
-      /** The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information. */
+      /** The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the [Static Website Examples](https://cloud.google.com/storage/docs/static-website) for more information. */
       website?: {
         /** If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages. */
         mainPageSuffix?: string;
@@ -570,7 +574,7 @@ declare namespace gapi.client {
       contentLanguage?: string;
       /** Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream. */
       contentType?: string;
-      /** CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. */
+      /** CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see [Data Validation and Change Detection](https://cloud.google.com/storage/docs/data-validation). */
       crc32c?: string;
       /** Metadata of customer-supplied encryption key, if the object is encrypted by such a key. */
       customerEncryption?: {
@@ -595,7 +599,7 @@ declare namespace gapi.client {
       kind?: string;
       /** Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request. */
       kmsKeyName?: string;
-      /** MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. */
+      /** MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see [Data Validation and Change Detection](https://cloud.google.com/storage/docs/data-validation). */
       md5Hash?: string;
       /** Media download link. */
       mediaLink?: string;
@@ -1243,7 +1247,7 @@ declare namespace gapi.client {
       ): Request<BucketAccessControl>;
     }
     interface BucketsResource {
-      /** Permanently deletes an empty bucket. */
+      /** Deletes an empty bucket. Deletions are permanent unless soft delete is enabled on the bucket. */
       delete(request?: {
         /** Data format for the response. */
         alt?: string;
@@ -1278,6 +1282,8 @@ declare namespace gapi.client {
         bucket: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
+        /** If present, specifies the generation of the bucket. This is required if softDeleted is true. */
+        generation?: string;
         /** Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. */
         ifMetagenerationMatch?: string;
         /** Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. */
@@ -1292,6 +1298,8 @@ declare namespace gapi.client {
         projection?: string;
         /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
         quotaUser?: string;
+        /** If true, return the soft-deleted version of this bucket. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete). */
+        softDeleted?: boolean;
         /** Upload protocol for media (e.g. "media", "multipart", "resumable"). */
         uploadType?: string;
         /** Deprecated. Please use quotaUser instead. */
@@ -1437,6 +1445,8 @@ declare namespace gapi.client {
         projection?: string;
         /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
         quotaUser?: string;
+        /** If true, only soft-deleted bucket versions will be returned. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete). */
+        softDeleted?: boolean;
         /** Upload protocol for media (e.g. "media", "multipart", "resumable"). */
         uploadType?: string;
         /** Deprecated. Please use quotaUser instead. */
@@ -1539,6 +1549,31 @@ declare namespace gapi.client {
         },
         body: Bucket
       ): Request<Bucket>;
+      /** Restores a soft-deleted bucket. */
+      restore(request?: {
+        /** Data format for the response. */
+        alt?: string;
+        /** Name of a bucket. */
+        bucket: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** Generation of a bucket. */
+        generation: 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;
+        /** The project to be billed for this request. Required for Requester Pays buckets. */
+        userProject?: string;
+      }): Request<void>;
       /** Updates an IAM policy for the specified bucket. */
       setIamPolicy(request: {
         /** Data format for the response. */
@@ -3070,7 +3105,7 @@ declare namespace gapi.client {
           projection?: string;
           /** 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. */
+          /** If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete). */
           softDeleted?: boolean;
           /** Upload protocol for media (e.g. "media", "multipart", "resumable"). */
           uploadType?: string;
@@ -3234,7 +3269,7 @@ declare namespace gapi.client {
         projection?: string;
         /** 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. */
+        /** If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/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). */
         startOffset?: string;
@@ -3244,7 +3279,7 @@ declare namespace gapi.client {
         userIp?: string;
         /** The project to be billed for this request. Required for Requester Pays buckets. */
         userProject?: string;
-        /** If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. */
+        /** If true, lists all versions of an object as distinct results. The default is false. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning). */
         versions?: boolean;
       }): Request<Objects>;
       /** Patches an object's metadata. */
@@ -3364,7 +3399,7 @@ declare namespace gapi.client {
           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. */
+          /** Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). */
           object: string;
           /** Returns response with indentations and line breaks. */
           prettyPrint?: boolean;
@@ -3718,7 +3753,7 @@ declare namespace gapi.client {
         userIp?: string;
         /** The project to be billed for this request. Required for Requester Pays buckets. */
         userProject?: string;
-        /** If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. */
+        /** If true, lists all versions of an object as distinct results. The default is false. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning). */
         versions?: boolean;
         /** Request body */
         resource: Channel;
@@ -3761,7 +3796,7 @@ declare namespace gapi.client {
           userIp?: string;
           /** The project to be billed for this request. Required for Requester Pays buckets. */
           userProject?: string;
-          /** If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. */
+          /** If true, lists all versions of an object as distinct results. The default is false. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning). */
           versions?: boolean;
         },
         body: Channel
@@ -3949,7 +3984,7 @@ declare namespace gapi.client {
         /** The project to be billed for this request. */
         userProject?: string;
       }): Request<HmacKeysMetadata>;
-      /** Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states. */
+      /** Updates the state of an HMAC key. See the [HMAC Key resource descriptor](https://cloud.google.com/storage/docs/json_api/v1/projects/hmacKeys/update#request-body) for valid states. */
       update(request: {
         /** Name of the HMAC key being updated. */
         accessId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.storage-v1",
-  "version": "0.0.20240801",
+  "version": "0.0.20240809",
   "description": "TypeScript typings for Cloud Storage JSON API v1",
   "repository": {
     "type": "git",

package/readme.md

@@ -174,7 +174,7 @@ await gapi.client.storage.bucketAccessControls.update({
 });
 
 /*
-Permanently deletes an empty bucket.
+Deletes an empty bucket. Deletions are permanent unless soft delete is enabled on the bucket.
 */
 await gapi.client.storage.buckets.delete({bucket: 'bucket'});
 
@@ -216,6 +216,14 @@ Patches a bucket. Changes to the bucket will be readable immediately after writi
 */
 await gapi.client.storage.buckets.patch({bucket: 'bucket'});
 
+/*
+Restores a soft-deleted bucket.
+*/
+await gapi.client.storage.buckets.restore({
+  bucket: 'bucket',
+  generation: 'generation',
+});
+
 /*
 Updates an IAM policy for the specified bucket.
 */