@maxim_mazurok/gapi.client.drive-v3
Advanced tools
Comparing version 0.0.20230514 to 0.0.20230517
{ | ||
"name": "@maxim_mazurok/gapi.client.drive-v3", | ||
"version": "0.0.20230514", | ||
"description": "TypeScript typings for Drive API v3", | ||
"version": "0.0.20230517", | ||
"description": "TypeScript typings for Google Drive API v3", | ||
"license": "MIT", | ||
@@ -6,0 +6,0 @@ "author": { |
@@ -1,4 +0,4 @@ | ||
# 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/). | ||
@@ -8,3 +8,3 @@ | ||
Install typings for Drive API: | ||
Install typings for Google Drive API: | ||
@@ -87,3 +87,3 @@ ``` | ||
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 --> | ||
@@ -108,3 +108,3 @@ ```typescript | ||
/* | ||
Subscribes to changes for a user. To use this method, you must include the pageToken query parameter. | ||
Subscribes to changes for a user. | ||
*/ | ||
@@ -114,3 +114,3 @@ await gapi.client.drive.changes.watch({ pageToken: "pageToken", }); | ||
/* | ||
Stop watching resources through this channel | ||
Stops watching resources through this channel. | ||
*/ | ||
@@ -165,3 +165,3 @@ await gapi.client.drive.channels.stop({ }); | ||
/* | ||
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. | ||
*/ | ||
@@ -176,3 +176,3 @@ await gapi.client.drive.drives.list({ }); | ||
/* | ||
Updates the metadata for a shared drive. | ||
Updates the metadate for a shared drive. | ||
*/ | ||
@@ -182,3 +182,3 @@ 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. | ||
*/ | ||
@@ -188,3 +188,3 @@ 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. | ||
*/ | ||
@@ -199,3 +199,3 @@ await gapi.client.drive.files.create({ }); | ||
/* | ||
Permanently deletes all trashed files of a user or shared drive. | ||
Permanently deletes all of the user's trashed files. | ||
*/ | ||
@@ -215,3 +215,3 @@ await gapi.client.drive.files.emptyTrash({ }); | ||
/* | ||
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). | ||
*/ | ||
@@ -221,3 +221,3 @@ 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. | ||
*/ | ||
@@ -232,3 +232,3 @@ await gapi.client.drive.files.list({ }); | ||
/* | ||
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. | ||
*/ | ||
@@ -238,3 +238,3 @@ 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). | ||
*/ | ||
@@ -244,3 +244,3 @@ await gapi.client.drive.files.update({ fileId: "fileId", }); | ||
/* | ||
Subscribe to changes on a file. | ||
Subscribes to changes to a file. | ||
*/ | ||
@@ -250,3 +250,3 @@ 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. | ||
*/ | ||
@@ -256,3 +256,3 @@ 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. | ||
*/ | ||
@@ -272,3 +272,3 @@ await gapi.client.drive.permissions.delete({ fileId: "fileId", permissionId: "permissionId", }); | ||
/* | ||
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. | ||
*/ | ||
@@ -323,3 +323,3 @@ await gapi.client.drive.permissions.update({ fileId: "fileId", permissionId: "permissionId", }); | ||
/* | ||
Deprecated use drives.create instead. | ||
Deprecated: Use `drives.create` instead. | ||
*/ | ||
@@ -329,3 +329,3 @@ await gapi.client.drive.teamdrives.create({ requestId: "requestId", }); | ||
/* | ||
Deprecated use drives.delete instead. | ||
Deprecated: Use `drives.delete` instead. | ||
*/ | ||
@@ -335,3 +335,3 @@ await gapi.client.drive.teamdrives.delete({ teamDriveId: "teamDriveId", }); | ||
/* | ||
Deprecated use drives.get instead. | ||
Deprecated: Use `drives.get` instead. | ||
*/ | ||
@@ -341,3 +341,3 @@ await gapi.client.drive.teamdrives.get({ teamDriveId: "teamDriveId", }); | ||
/* | ||
Deprecated use drives.list instead. | ||
Deprecated: Use `drives.list` instead. | ||
*/ | ||
@@ -347,5 +347,5 @@ await gapi.client.drive.teamdrives.list({ }); | ||
/* | ||
Deprecated use drives.update instead | ||
Deprecated: Use `drives.update` instead. | ||
*/ | ||
await gapi.client.drive.teamdrives.update({ teamDriveId: "teamDriveId", }); | ||
``` |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
325555
6641