@maxim_mazurok/gapi.client.storage-v1 0.0.20231007 → 0.0.20231012

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: 20231007
+// Revision: 20231012
 
 /// <reference types="gapi.client" />
 
@@ -618,6 +618,43 @@ declare namespace gapi.client {
             nextPageToken?:
                 string;
         }
+        interface ManagedFolder {
+            /** The name of the bucket containing this managed folder. */
+            bucket?:
+                string;
+            /** The creation time of the managed folder in RFC 3339 format. */
+            createTime?:
+                string;
+            /** The ID of the managed folder, including the bucket name and managed folder name. */
+            id?:
+                string;
+            /** The kind of item this is. For managed folders, this is always storage#managedFolder. */
+            kind?:
+                string;
+            /** The version of the metadata for this managed folder. Used for preconditions and for detecting changes in metadata. */
+            metageneration?:
+                string;
+            /** The name of the managed folder. Required if not specified by URL parameter. */
+            name?:
+                string;
+            /** The link to this managed folder. */
+            selfLink?:
+                string;
+            /** The last update time of the managed folder metadata in RFC 3339 format. */
+            updateTime?:
+                string;
+        }
+        interface ManagedFolders {
+            /** The list of items. */
+            items?:
+                ManagedFolder[];
+            /** The kind of item this is. For lists of managed folders, this is always storage#managedFolders. */
+            kind?:
+                string;
+            /** 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;
+        }
         interface Notification {
             /** An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription. */
             custom_attributes?:
@@ -943,9 +980,9 @@ declare namespace gapi.client {
             kind?:
                 string;
             /**
-             * The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object for objects. A specific
-             * generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be
-             * denoted with #0. This field is ignored on input.
+             * The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, projects/_/buckets/bucket/objects/object for objects, and
+             * projects/_/buckets/bucket/managedFolders/managedFolder. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g.
+             * projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
              */
             resourceId?:
                 string;
@@ -987,8 +1024,8 @@ declare namespace gapi.client {
             kind?:
                 string;
             /**
-             * The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets or objects. The supported permissions are as
-             * follows:
+             * The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets, objects, or managedFolders. The supported
+             * permissions are as follows:
              * - storage.buckets.delete — Delete bucket.
              * - storage.buckets.get — Read bucket metadata.
              * - storage.buckets.getIamPolicy — Read bucket IAM policy.
@@ -1003,6 +1040,12 @@ declare namespace gapi.client {
              * - storage.objects.list — List objects.
              * - storage.objects.setIamPolicy — Update object IAM policy.
              * - storage.objects.update — Update object metadata.
+             * - storage.managedFolders.delete — Delete managed folder.
+             * - storage.managedFolders.get — Read managed folder metadata.
+             * - storage.managedFolders.getIamPolicy — Read managed folder IAM policy.
+             * - storage.managedFolders.create — Create managed folder.
+             * - storage.managedFolders.list — List managed folders.
+             * - storage.managedFolders.setIamPolicy — Update managed folder IAM policy.
              */
             permissions?:
                 string[];
@@ -2323,6 +2366,344 @@ declare namespace gapi.client {
             },
             body: ObjectAccessControl): Request<ObjectAccessControl>;
         }
+        interface ManagedFoldersResource {
+            /** Permanently deletes a managed folder. */
+            delete(request?: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket containing the managed folder. */
+                bucket:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** If set, only deletes the managed folder if its metageneration matches this value. */
+                ifMetagenerationMatch?:
+                    string;
+                /** If set, only deletes the managed folder if its metageneration does not match this 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;
+                /** The managed folder name/path. */
+                managedFolder:
+                    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<void>;
+            /** Returns metadata of the specified managed folder. */
+            get(request?: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket containing the managed folder. */
+                bucket:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration matches the given value. */
+                ifMetagenerationMatch?:
+                    string;
+                /** Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration does not 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;
+                /** The managed folder name/path. */
+                managedFolder:
+                    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<ManagedFolder>;
+            /** Returns an IAM policy for the specified managed folder. */
+            getIamPolicy(request?: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket containing the managed folder. */
+                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;
+                /** The managed folder name/path. */
+                managedFolder:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /**
+                 * The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request
+                 * fails.
+                 */
+                optionsRequestedPolicyVersion?:
+                    number;
+                /** 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<Policy>;
+            /** Creates a new managed folder. */
+            insert(request: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket containing the managed folder. */
+                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:
+                    ManagedFolder;
+            }): Request<ManagedFolder>;
+            insert(request: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket containing the managed folder. */
+                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: ManagedFolder): Request<ManagedFolder>;
+            /** Lists managed folders in the given bucket. */
+            list(request?: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket containing the managed folder. */
+                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;
+                /** Maximum number of items return in a single page of responses. */
+                pageSize?:
+                    number;
+                /** A previously-returned page token representing part of the larger set of results to view. */
+                pageToken?:
+                    string;
+                /** The managed folder name/path prefix to filter the output list of results. */
+                prefix?:
+                    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<ManagedFolders>;
+            /** Updates an IAM policy for the specified managed folder. */
+            setIamPolicy(request: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket containing the managed folder. */
+                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;
+                /** The managed folder name/path. */
+                managedFolder:
+                    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 body */
+                resource:
+                    Policy;
+            }): Request<Policy>;
+            setIamPolicy(request: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket containing the managed folder. */
+                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;
+                /** The managed folder name/path. */
+                managedFolder:
+                    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;
+            },
+            body: Policy): Request<Policy>;
+            /** Tests a set of permissions on the given managed folder to see which, if any, are held by the caller. */
+            testIamPermissions(request?: {
+                /** Data format for the response. */
+                alt?:
+                    string;
+                /** Name of the bucket containing the managed folder. */
+                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;
+                /** The managed folder name/path. */
+                managedFolder:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Permissions to test. */
+                permissions:
+                    string | 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<TestIamPermissionsResponse>;
+        }
         interface NotificationsResource {
             /** Permanently deletes a notification subscription. */
             delete(request?: {
@@ -3638,6 +4019,9 @@ declare namespace gapi.client {
                 /** Selector specifying which fields to include in a partial response. */
                 fields?:
                     string;
+                /** Only applicable if delimiter is set to '/'. If true, will also include folders and managed folders (besides objects) in the returned prefixes. */
+                includeFoldersAsPrefixes?:
+                    boolean;
                 /** If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes. */
                 includeTrailingDelimiter?:
                     boolean;
@@ -5013,6 +5397,8 @@ declare namespace gapi.client {
 
         const defaultObjectAccessControls: DefaultObjectAccessControlsResource;
 
+        const managedFolders: ManagedFoldersResource;
+
         const notifications: NotificationsResource;
 
         const objectAccessControls: ObjectAccessControlsResource;

package/package.json

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

package/readme.md

@@ -193,6 +193,41 @@ Updates a default object ACL entry on the specified bucket.
 */
 await gapi.client.storage.defaultObjectAccessControls.update({ bucket: "bucket", entity: "entity",  });
 
+/*
+Permanently deletes a managed folder.
+*/
+await gapi.client.storage.managedFolders.delete({ bucket: "bucket", managedFolder: "managedFolder",  });
+
+/*
+Returns metadata of the specified managed folder.
+*/
+await gapi.client.storage.managedFolders.get({ bucket: "bucket", managedFolder: "managedFolder",  });
+
+/*
+Returns an IAM policy for the specified managed folder.
+*/
+await gapi.client.storage.managedFolders.getIamPolicy({ bucket: "bucket", managedFolder: "managedFolder",  });
+
+/*
+Creates a new managed folder.
+*/
+await gapi.client.storage.managedFolders.insert({ bucket: "bucket",  });
+
+/*
+Lists managed folders in the given bucket.
+*/
+await gapi.client.storage.managedFolders.list({ bucket: "bucket",  });
+
+/*
+Updates an IAM policy for the specified managed folder.
+*/
+await gapi.client.storage.managedFolders.setIamPolicy({ bucket: "bucket", managedFolder: "managedFolder",  });
+
+/*
+Tests a set of permissions on the given managed folder to see which, if any, are held by the caller.
+*/
+await gapi.client.storage.managedFolders.testIamPermissions({ bucket: "bucket", managedFolder: "managedFolder", permissions: "permissions",  });
+
 /*
 Permanently deletes a notification subscription.
 */

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: 20231007
+// Revision: 20231012
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -781,6 +781,79 @@ gapi.load('client', async () => {
             role: "Test string",
             selfLink: "Test string",
         });
+        /** Permanently deletes a managed folder. */
+        await gapi.client.storage.managedFolders.delete({
+            bucket: "Test string",
+            ifMetagenerationMatch: "Test string",
+            ifMetagenerationNotMatch: "Test string",
+            managedFolder: "Test string",
+        });
+        /** Returns metadata of the specified managed folder. */
+        await gapi.client.storage.managedFolders.get({
+            bucket: "Test string",
+            ifMetagenerationMatch: "Test string",
+            ifMetagenerationNotMatch: "Test string",
+            managedFolder: "Test string",
+        });
+        /** Returns an IAM policy for the specified managed folder. */
+        await gapi.client.storage.managedFolders.getIamPolicy({
+            bucket: "Test string",
+            managedFolder: "Test string",
+            optionsRequestedPolicyVersion: 42,
+            userProject: "Test string",
+        });
+        /** Creates a new managed folder. */
+        await gapi.client.storage.managedFolders.insert({
+            bucket: "Test string",
+        }, {
+            bucket: "Test string",
+            createTime: "Test string",
+            id: "Test string",
+            kind: "Test string",
+            metageneration: "Test string",
+            name: "Test string",
+            selfLink: "Test string",
+            updateTime: "Test string",
+        });
+        /** Lists managed folders in the given bucket. */
+        await gapi.client.storage.managedFolders.list({
+            bucket: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            prefix: "Test string",
+        });
+        /** Updates an IAM policy for the specified managed folder. */
+        await gapi.client.storage.managedFolders.setIamPolicy({
+            bucket: "Test string",
+            managedFolder: "Test string",
+            userProject: "Test string",
+        }, {
+            bindings: [
+                {
+                    condition: {
+                        description: "Test string",
+                        expression: "Test string",
+                        location: "Test string",
+                        title: "Test string",
+                    },
+                    members: [
+                        "Test string"
+                    ],
+                    role: "Test string",
+                }
+            ],
+            etag: "Test string",
+            kind: "Test string",
+            resourceId: "Test string",
+            version: 42,
+        });
+        /** Tests a set of permissions on the given managed folder to see which, if any, are held by the caller. */
+        await gapi.client.storage.managedFolders.testIamPermissions({
+            bucket: "Test string",
+            managedFolder: "Test string",
+            permissions: "Test string",
+            userProject: "Test string",
+        });
         /** Permanently deletes a notification subscription. */
         await gapi.client.storage.notifications.delete({
             bucket: "Test string",
@@ -1216,6 +1289,7 @@ gapi.load('client', async () => {
             bucket: "Test string",
             delimiter: "Test string",
             endOffset: "Test string",
+            includeFoldersAsPrefixes: true,
             includeTrailingDelimiter: true,
             matchGlob: "Test string",
             maxResults: 42,