@maxim_mazurok/gapi.client.drive-v3 0.0.20230430 → 0.0.20230517

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@maxim_mazurok/gapi.client.drive-v3",
-  "version": "0.0.20230430",
-  "description": "TypeScript typings for Drive API v3",
+  "version": "0.0.20230517",
+  "description": "TypeScript typings for Google Drive API v3",
   "license": "MIT",
   "author": {
     "email": "maxim@mazurok.com",

package/readme.md

@@ -1,11 +1,11 @@
-# TypeScript typings for Drive API v3
+# TypeScript typings for Google Drive API v3
 
-Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.
+The Google Drive API allows clients to access resources from Google Drive.
 For detailed description please check [documentation](https://developers.google.com/drive/).
 
 ## Installing
 
-Install typings for Drive API:
+Install typings for Google Drive API:
 
 ```
 npm install @types/gapi.client.drive-v3 --save-dev
@@ -83,7 +83,7 @@ gapi.auth.authorize(
 });
 ```
 
-After that you can use Drive API resources: <!-- TODO: make this work for multiple namespaces -->
+After that you can use Google Drive API resources: <!-- TODO: make this work for multiple namespaces -->
 
 ```typescript
 
@@ -103,12 +103,12 @@ Lists the changes for a user or shared drive.
 await gapi.client.drive.changes.list({ pageToken: "pageToken",  });
 
 /*
-Subscribes to changes for a user. To use this method, you must include the pageToken query parameter.
+Subscribes to changes for a user.
 */
 await gapi.client.drive.changes.watch({ pageToken: "pageToken",  });
 
 /*
-Stop watching resources through this channel
+Stops watching resources through this channel.
 */
 await gapi.client.drive.channels.stop({  });
 
@@ -158,7 +158,7 @@ Hides a shared drive from the default view.
 await gapi.client.drive.drives.hide({ driveId: "driveId",  });
 
 /*
-Lists the user's shared drives.
+ Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.
 */
 await gapi.client.drive.drives.list({  });
 
@@ -168,17 +168,17 @@ Restores a shared drive to the default view.
 await gapi.client.drive.drives.unhide({ driveId: "driveId",  });
 
 /*
-Updates the metadata for a shared drive.
+Updates the metadate for a shared drive.
 */
 await gapi.client.drive.drives.update({ driveId: "driveId",  });
 
 /*
-Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.
+Creates a copy of a file and applies any requested updates with patch semantics.
 */
 await gapi.client.drive.files.copy({ fileId: "fileId",  });
 
 /*
-Creates a file.
+ Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.
 */
 await gapi.client.drive.files.create({  });
 
@@ -188,7 +188,7 @@ Permanently deletes a file owned by the user without moving it to the trash. If
 await gapi.client.drive.files.delete({ fileId: "fileId",  });
 
 /*
-Permanently deletes all trashed files of a user or shared drive.
+Permanently deletes all of the user's trashed files.
 */
 await gapi.client.drive.files.emptyTrash({  });
 
@@ -203,12 +203,12 @@ Generates a set of file IDs which can be provided in create or copy requests.
 await gapi.client.drive.files.generateIds({  });
 
 /*
-Gets a file's metadata or content by ID.
+ Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).
 */
 await gapi.client.drive.files.get({ fileId: "fileId",  });
 
 /*
-Lists or searches files.
+ Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.
 */
 await gapi.client.drive.files.list({  });
 
@@ -218,27 +218,27 @@ Lists the labels on a file.
 await gapi.client.drive.files.listLabels({ fileId: "fileId",  });
 
 /*
-Modifies the set of labels on a file.
+Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.
 */
 await gapi.client.drive.files.modifyLabels({ fileId: "fileId",  });
 
 /*
-Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.
+ Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).
 */
 await gapi.client.drive.files.update({ fileId: "fileId",  });
 
 /*
-Subscribe to changes on a file.
+Subscribes to changes to a file.
 */
 await gapi.client.drive.files.watch({ fileId: "fileId",  });
 
 /*
-Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders & drives.
+Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
 */
 await gapi.client.drive.permissions.create({ fileId: "fileId",  });
 
 /*
-Deletes a permission.
+Deletes a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
 */
 await gapi.client.drive.permissions.delete({ fileId: "fileId", permissionId: "permissionId",  });
 
@@ -253,7 +253,7 @@ Lists a file's or shared drive's permissions.
 await gapi.client.drive.permissions.list({ fileId: "fileId",  });
 
 /*
-Updates a permission with patch semantics.
+Updates a permission with patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
 */
 await gapi.client.drive.permissions.update({ fileId: "fileId", permissionId: "permissionId",  });
 
@@ -303,27 +303,27 @@ Updates a revision with patch semantics.
 await gapi.client.drive.revisions.update({ fileId: "fileId", revisionId: "revisionId",  });
 
 /*
-Deprecated use drives.create instead.
+Deprecated: Use `drives.create` instead.
 */
 await gapi.client.drive.teamdrives.create({ requestId: "requestId",  });
 
 /*
-Deprecated use drives.delete instead.
+Deprecated: Use `drives.delete` instead.
 */
 await gapi.client.drive.teamdrives.delete({ teamDriveId: "teamDriveId",  });
 
 /*
-Deprecated use drives.get instead.
+Deprecated: Use `drives.get` instead.
 */
 await gapi.client.drive.teamdrives.get({ teamDriveId: "teamDriveId",  });
 
 /*
-Deprecated use drives.list instead.
+Deprecated: Use `drives.list` instead.
 */
 await gapi.client.drive.teamdrives.list({  });
 
 /*
-Deprecated use drives.update instead
+Deprecated: Use `drives.update` instead.
 */
 await gapi.client.drive.teamdrives.update({ teamDriveId: "teamDriveId",  });
 ```

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: 20230430
+// Revision: 20230517
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -44,7 +44,8 @@ gapi.load('client', async () => {
 
     async function run() {
         /** Gets information about the user, the user's Drive, and system capabilities. */
-        await gapi.client.drive.about.get();
+        await gapi.client.drive.about.get({
+        });
         /** Gets the starting pageToken for listing future changes. */
         await gapi.client.drive.changes.getStartPageToken({
             driveId: "Test string",
@@ -69,7 +70,7 @@ gapi.load('client', async () => {
             supportsTeamDrives: true,
             teamDriveId: "Test string",
         });
-        /** Subscribes to changes for a user. To use this method, you must include the pageToken query parameter. */
+        /** Subscribes to changes for a user. */
         await gapi.client.drive.changes.watch({
             driveId: "Test string",
             includeCorpusRemovals: true,
@@ -99,8 +100,9 @@ gapi.load('client', async () => {
             token: "Test string",
             type: "Test string",
         });
-        /** Stop watching resources through this channel */
-        await gapi.client.drive.channels.stop({} , {
+        /** Stops watching resources through this channel. */
+        await gapi.client.drive.channels.stop({
+        }, {
             address: "Test string",
             expiration: "Test string",
             id: "Test string",
@@ -290,7 +292,10 @@ gapi.load('client', async () => {
         await gapi.client.drive.drives.hide({
             driveId: "Test string",
         });
-        /** Lists the user's shared drives. */
+        /**
+         * Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared
+         * drives](/drive/api/guides/search-shareddrives) guide.
+         */
         await gapi.client.drive.drives.list({
             pageSize: 42,
             pageToken: "Test string",
@@ -301,7 +306,7 @@ gapi.load('client', async () => {
         await gapi.client.drive.drives.unhide({
             driveId: "Test string",
         });
-        /** Updates the metadata for a shared drive. */
+        /** Updates the metadate for a shared drive. */
         await gapi.client.drive.drives.update({
             driveId: "Test string",
             useDomainAdminAccess: true,
@@ -351,7 +356,7 @@ gapi.load('client', async () => {
             },
             themeId: "Test string",
         });
-        /** Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied. */
+        /** Creates a copy of a file and applies any requested updates with patch semantics. */
         await gapi.client.drive.files.copy({
             enforceSingleParent: true,
             fileId: "Test string",
@@ -634,7 +639,15 @@ gapi.load('client', async () => {
             webViewLink: "Test string",
             writersCanShare: true,
         });
-        /** Creates a file. */
+        /**
+         * Creates a new file. This method supports an *‍/upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME
+         * types:*`*‍/*` Note: Specify a valid MIME type, rather than the literal `*‍/*` value. The literal `*‍/*` is only used to indicate that any valid MIME type can be uploaded. For more
+         * information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type
+         * `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file
+         * should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally
+         * specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with
+         * extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.
+         */
         await gapi.client.drive.files.create({
             enforceSingleParent: true,
             ignoreDefaultVisibility: true,
@@ -927,7 +940,7 @@ gapi.load('client', async () => {
             supportsAllDrives: true,
             supportsTeamDrives: true,
         });
-        /** Permanently deletes all trashed files of a user or shared drive. */
+        /** Permanently deletes all of the user's trashed files. */
         await gapi.client.drive.files.emptyTrash({
             driveId: "Test string",
             enforceSingleParent: true,
@@ -943,7 +956,11 @@ gapi.load('client', async () => {
             space: "Test string",
             type: "Test string",
         });
-        /** Gets a file's metadata or content by ID. */
+        /**
+         * Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with
+         * `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more
+         * information, see [Download & export files](/drive/api/guides/manage-downloads).
+         */
         await gapi.client.drive.files.get({
             acknowledgeAbuse: true,
             fileId: "Test string",
@@ -952,7 +969,11 @@ gapi.load('client', async () => {
             supportsAllDrives: true,
             supportsTeamDrives: true,
         });
-        /** Lists or searches files. */
+        /**
+         * Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files &
+         * folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use
+         * the `trashed=false` query parameter to remove trashed files from the results.
+         */
         await gapi.client.drive.files.list({
             corpora: "Test string",
             corpus: "Test string",
@@ -976,7 +997,7 @@ gapi.load('client', async () => {
             maxResults: 42,
             pageToken: "Test string",
         });
-        /** Modifies the set of labels on a file. */
+        /** Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified. */
         await gapi.client.drive.files.modifyLabels({
             fileId: "Test string",
         }, {
@@ -1012,8 +1033,10 @@ gapi.load('client', async () => {
             ],
         });
         /**
-         * Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change
-         * automatically, such as modifiedDate. This method supports patch semantics.
+         * Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed
+         * automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an *‍/upload* URI and accepts uploaded media with the following characteristics: -
+         * *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*‍/*` Note: Specify a valid MIME type, rather than the literal `*‍/*` value. The literal `*‍/*` is only used to indicate
+         * that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).
          */
         await gapi.client.drive.files.update({
             addParents: "Test string",
@@ -1299,7 +1322,7 @@ gapi.load('client', async () => {
             webViewLink: "Test string",
             writersCanShare: true,
         });
-        /** Subscribe to changes on a file. */
+        /** Subscribes to changes to a file. */
         await gapi.client.drive.files.watch({
             acknowledgeAbuse: true,
             fileId: "Test string",
@@ -1321,7 +1344,7 @@ gapi.load('client', async () => {
             token: "Test string",
             type: "Test string",
         });
-        /** Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders & drives. */
+        /** Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied. */
         await gapi.client.drive.permissions.create({
             emailMessage: "Test string",
             enforceSingleParent: true,
@@ -1363,7 +1386,7 @@ gapi.load('client', async () => {
             type: "Test string",
             view: "Test string",
         });
-        /** Deletes a permission. */
+        /** Deletes a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied. */
         await gapi.client.drive.permissions.delete({
             fileId: "Test string",
             permissionId: "Test string",
@@ -1389,7 +1412,7 @@ gapi.load('client', async () => {
             supportsTeamDrives: true,
             useDomainAdminAccess: true,
         });
-        /** Updates a permission with patch semantics. */
+        /** Updates a permission with patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied. */
         await gapi.client.drive.permissions.update({
             fileId: "Test string",
             permissionId: "Test string",
@@ -1544,7 +1567,7 @@ gapi.load('client', async () => {
             publishedOutsideDomain: true,
             size: "Test string",
         });
-        /** Deprecated use drives.create instead. */
+        /** Deprecated: Use `drives.create` instead. */
         await gapi.client.drive.teamdrives.create({
             requestId: "Test string",
         }, {
@@ -1593,23 +1616,23 @@ gapi.load('client', async () => {
             },
             themeId: "Test string",
         });
-        /** Deprecated use drives.delete instead. */
+        /** Deprecated: Use `drives.delete` instead. */
         await gapi.client.drive.teamdrives.delete({
             teamDriveId: "Test string",
         });
-        /** Deprecated use drives.get instead. */
+        /** Deprecated: Use `drives.get` instead. */
         await gapi.client.drive.teamdrives.get({
             teamDriveId: "Test string",
             useDomainAdminAccess: true,
         });
-        /** Deprecated use drives.list instead. */
+        /** Deprecated: Use `drives.list` instead. */
         await gapi.client.drive.teamdrives.list({
             pageSize: 42,
             pageToken: "Test string",
             q: "Test string",
             useDomainAdminAccess: true,
         });
-        /** Deprecated use drives.update instead */
+        /** Deprecated: Use `drives.update` instead. */
         await gapi.client.drive.teamdrives.update({
             teamDriveId: "Test string",
             useDomainAdminAccess: true,