@maxim_mazurok/gapi.client.drive-v3 0.0.20230212 → 0.0.20230306

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://www.googleapis.com/discovery/v1/apis/drive/v3/rest
-// Revision: 20230212
+// Revision: 20230306
 
 /// <reference types="gapi.client" />
 
@@ -191,7 +191,7 @@ declare namespace gapi.client {
         }
         interface Drive {
             /**
-             * An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that
+             * An image file and cropping parameters from which a background image for this shared drive is set. This is a write-only field; it can only be set on drive.drives.update requests that
              * don't set themeId. When specified, all fields of the backgroundImageFile must be set.
              */
             backgroundImageFile?: {
@@ -258,7 +258,7 @@ declare namespace gapi.client {
                 /** Whether the current user can trash children from folders in this shared drive. */
                 canTrashChildren?: boolean;
             };
-            /** The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId. */
+            /** The color of this shared drive as an RGB hex string. It can only be set on drive.drives.update requests that don't set themeId. */
             colorRgb?: string;
             /** The time at which the shared drive was created (RFC 3339 date-time). */
             createdTime?: string;
@@ -292,7 +292,7 @@ declare namespace gapi.client {
                 sharingFoldersRequiresOrganizerPermission?: boolean;
             };
             /**
-             * The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a
+             * The ID of the theme from which the background image and color are set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a
              * drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set
              * colorRgb or backgroundImageFile.
              */
@@ -780,44 +780,48 @@ declare namespace gapi.client {
             deleted?: boolean;
             /**
              * The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
-             * - user - User's full name, as defined for their Google account, such as "Joe Smith."
+             * - user - User's full name, as defined for their Google Account, such as "Joe Smith."
              * - group - Name of the Google Group, such as "The Company Administrators."
-             * - domain - String domain name, such as "thecompany.com."
+             * - domain - String domain name, such as "your-company.com."
              * - anyone - No displayName is present.
              */
             displayName?: string;
-            /** The domain to which this permission refers. */
+            /**
+             * The domain to which this permission refers. The following options are currently allowed:
+             * - The entire domain, such as "your-company.com."
+             * - A target audience, such as "ID.audience.googledomains.com."
+             */
             domain?: string;
             /** The email address of the user or group to which this permission refers. */
             emailAddress?: string;
             /**
              * The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
-             * - They cannot be set on shared drive items
-             * - They can only be set on user and group permissions
-             * - The time must be in the future
-             * - The time cannot be more than a year in the future
+             * - They cannot be set on shared drive items.
+             * - They can only be set on user and group permissions.
+             * - The time must be in the future.
+             * - The time cannot be more than one year in the future.
              */
             expirationTime?: string;
             /** The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values. */
             id?: string;
             /** Identifies what kind of resource this is. Value: the fixed string "drive#permission". */
             kind?: string;
-            /** Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. */
+            /** Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive. */
             pendingOwner?: boolean;
-            /** Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. */
+            /** Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items. */
             permissionDetails?: Array<{
                 /** Whether this permission is inherited. This field is always populated. This is an output-only field. */
                 inherited?: boolean;
                 /** The ID of the item from which this permission is inherited. This is an output-only field. */
                 inheritedFrom?: string;
                 /**
-                 * The permission type for this user. While new values may be added in future, the following are currently possible:
+                 * The permission type for this user. While new values may be added in future, the following are currently allowed:
                  * - file
                  * - member
                  */
                 permissionType?: string;
                 /**
-                 * The primary role for this user. While new values may be added in the future, the following are currently possible:
+                 * The primary role for this user. While new values may be added in the future, the following are currently allowed:
                  * - organizer
                  * - fileOrganizer
                  * - writer
@@ -855,7 +859,7 @@ declare namespace gapi.client {
              * - group
              * - domain
              * - anyone  When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't
-             * extra information required for a anyone type.
+             * extra information required for the anyone type.
              */
             type?: string;
             /** Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. */
@@ -1191,7 +1195,7 @@ declare namespace gapi.client {
                 /** Deprecated. Please use quotaUser instead. */
                 userIp?: string;
             }): Request<ChangeList>;
-            /** Subscribes to changes for a user. */
+            /** Subscribes to changes for a user. To use this method, you must include the pageToken query parameter. */
             watch(request: {
                 /** Data format for the response. */
                 alt?: string;
@@ -1657,7 +1661,7 @@ declare namespace gapi.client {
                 /** Deprecated. Please use quotaUser instead. */
                 userIp?: string;
             }): Request<Drive>;
-            /** Updates the metadate for a shared drive. */
+            /** Updates the metadata for a shared drive. */
             update(request: {
                 /** Data format for the response. */
                 alt?: string;
@@ -1673,10 +1677,7 @@ declare namespace gapi.client {
                 prettyPrint?: boolean;
                 /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
                 quotaUser?: string;
-                /**
-                 * Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive
-                 * belongs.
-                 */
+                /** Issue the request as a domain administrator. If set to true, then the requester is granted access if they're an administrator of the domain to which the shared drive belongs. */
                 useDomainAdminAccess?: boolean;
                 /** Deprecated. Please use quotaUser instead. */
                 userIp?: string;
@@ -1698,10 +1699,7 @@ declare namespace gapi.client {
                 prettyPrint?: boolean;
                 /** An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */
                 quotaUser?: string;
-                /**
-                 * Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive
-                 * belongs.
-                 */
+                /** Issue the request as a domain administrator. If set to true, then the requester is granted access if they're an administrator of the domain to which the shared drive belongs. */
                 useDomainAdminAccess?: boolean;
                 /** Deprecated. Please use quotaUser instead. */
                 userIp?: string;
@@ -2267,7 +2265,7 @@ declare namespace gapi.client {
             body: Channel): Request<Channel>;
         }
         interface PermissionsResource {
-            /** Creates a permission for a file or shared drive. */
+            /** Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders & drives. */
             create(request: {
                 /** Data format for the response. */
                 alt?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.drive-v3",
-  "version": "0.0.20230212",
+  "version": "0.0.20230306",
   "description": "TypeScript typings for Drive API v3",
   "license": "MIT",
   "author": {

package/readme.md

@@ -103,7 +103,7 @@ Lists the changes for a user or shared drive.
 await gapi.client.drive.changes.list({ pageToken: "pageToken",  });
 
 /*
-Subscribes to changes for a user.
+Subscribes to changes for a user. To use this method, you must include the pageToken query parameter.
 */
 await gapi.client.drive.changes.watch({ pageToken: "pageToken",  });
 
@@ -168,7 +168,7 @@ Restores a shared drive to the default view.
 await gapi.client.drive.drives.unhide({ driveId: "driveId",  });
 
 /*
-Updates the metadate for a shared drive.
+Updates the metadata for a shared drive.
 */
 await gapi.client.drive.drives.update({ driveId: "driveId",  });
 
@@ -233,7 +233,7 @@ Subscribes to changes to a file. While you can establish a channel for changes t
 await gapi.client.drive.files.watch({ fileId: "fileId",  });
 
 /*
-Creates a permission for a file or shared drive.
+Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders & drives.
 */
 await gapi.client.drive.permissions.create({ fileId: "fileId",  });
 

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: 20230212
+// Revision: 20230306
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -69,7 +69,7 @@ gapi.load('client', async () => {
             supportsTeamDrives: true,
             teamDriveId: "Test string",
         });
-        /** Subscribes to changes for a user. */
+        /** Subscribes to changes for a user. To use this method, you must include the pageToken query parameter. */
         await gapi.client.drive.changes.watch({
             driveId: "Test string",
             includeCorpusRemovals: true,
@@ -301,7 +301,7 @@ gapi.load('client', async () => {
         await gapi.client.drive.drives.unhide({
             driveId: "Test string",
         });
-        /** Updates the metadate for a shared drive. */
+        /** Updates the metadata for a shared drive. */
         await gapi.client.drive.drives.update({
             driveId: "Test string",
             useDomainAdminAccess: true,
@@ -1320,7 +1320,7 @@ gapi.load('client', async () => {
             token: "Test string",
             type: "Test string",
         });
-        /** Creates a permission for a file or shared drive. */
+        /** Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders & drives. */
         await gapi.client.drive.permissions.create({
             emailMessage: "Test string",
             enforceSingleParent: true,