@maxim_mazurok/gapi.client.drive-v3 0.1.20250821 → 0.1.20250829
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +90 -90
- package/package.json +1 -1
- package/readme.md +13 -13
package/index.d.ts
CHANGED
@@ -9,7 +9,7 @@
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
11
11
|
// Generated from: https://www.googleapis.com/discovery/v1/apis/drive/v3/rest
|
12
|
-
// Revision:
|
12
|
+
// Revision: 20250829
|
13
13
|
|
14
14
|
/// <reference types="gapi.client" />
|
15
15
|
|
@@ -267,7 +267,7 @@ declare namespace gapi.client {
|
|
267
267
|
readOnly?: boolean;
|
268
268
|
/** Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. */
|
269
269
|
reason?: string;
|
270
|
-
/** Output only. The user who set the content restriction. Only populated if `readOnly
|
270
|
+
/** Output only. The user who set the content restriction. Only populated if `readOnly=true`. */
|
271
271
|
restrictingUser?: User;
|
272
272
|
/** The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. */
|
273
273
|
restrictionTime?: string;
|
@@ -279,13 +279,13 @@ declare namespace gapi.client {
|
|
279
279
|
interface DownloadRestriction {
|
280
280
|
/** Whether download and copy is restricted for readers. */
|
281
281
|
restrictedForReaders?: boolean;
|
282
|
-
/** Whether download and copy is restricted for writers. If true
|
282
|
+
/** Whether download and copy is restricted for writers. If `true`, download is also restricted for readers. */
|
283
283
|
restrictedForWriters?: boolean;
|
284
284
|
}
|
285
285
|
interface DownloadRestrictionsMetadata {
|
286
286
|
/** Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules. */
|
287
287
|
effectiveDownloadRestrictionWithContext?: DownloadRestriction;
|
288
|
-
/** The download restriction of the file applied directly by the owner or organizer. This
|
288
|
+
/** The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules. */
|
289
289
|
itemDownloadRestriction?: DownloadRestriction;
|
290
290
|
}
|
291
291
|
interface Drive {
|
@@ -393,13 +393,13 @@ declare namespace gapi.client {
|
|
393
393
|
* Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
|
394
394
|
*/
|
395
395
|
appProperties?: {[P in string]: string};
|
396
|
-
/** Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. */
|
396
|
+
/** Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities). */
|
397
397
|
capabilities?: {
|
398
398
|
/** Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. */
|
399
399
|
canAcceptOwnership?: boolean;
|
400
|
-
/** Output only. Whether the current user can add children to this folder. This is always false when the item
|
400
|
+
/** Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder. */
|
401
401
|
canAddChildren?: boolean;
|
402
|
-
/** Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item
|
402
|
+
/** Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. */
|
403
403
|
canAddFolderFromAnotherDrive?: boolean;
|
404
404
|
/** Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. */
|
405
405
|
canAddMyDriveParent?: boolean;
|
@@ -407,17 +407,17 @@ declare namespace gapi.client {
|
|
407
407
|
canChangeCopyRequiresWriterPermission?: boolean;
|
408
408
|
/** Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file. */
|
409
409
|
canChangeItemDownloadRestriction?: boolean;
|
410
|
-
/** Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. */
|
410
|
+
/** Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata. */
|
411
411
|
canChangeSecurityUpdateEnabled?: boolean;
|
412
412
|
/** Deprecated: Output only. */
|
413
413
|
canChangeViewersCanCopyContent?: boolean;
|
414
414
|
/** Output only. Whether the current user can comment on this file. */
|
415
415
|
canComment?: boolean;
|
416
|
-
/** Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item
|
416
|
+
/** Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder. */
|
417
417
|
canCopy?: boolean;
|
418
418
|
/** Output only. Whether the current user can delete this file. */
|
419
419
|
canDelete?: boolean;
|
420
|
-
/** Output only. Whether the current user can delete children of this folder. This is false when the item
|
420
|
+
/** Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. */
|
421
421
|
canDeleteChildren?: boolean;
|
422
422
|
/** Whether a user can disable inherited permissions. */
|
423
423
|
canDisableInheritedPermissions?: boolean;
|
@@ -427,11 +427,11 @@ declare namespace gapi.client {
|
|
427
427
|
canEdit?: boolean;
|
428
428
|
/** Whether a user can re-enable inherited permissions. */
|
429
429
|
canEnableInheritedPermissions?: boolean;
|
430
|
-
/** Output only. Whether the current user can list the children of this folder. This is always false when the item
|
430
|
+
/** Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder. */
|
431
431
|
canListChildren?: boolean;
|
432
432
|
/** Output only. Whether the current user can modify the content of this file. */
|
433
433
|
canModifyContent?: boolean;
|
434
|
-
/** Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction
|
434
|
+
/** Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`. */
|
435
435
|
canModifyContentRestriction?: boolean;
|
436
436
|
/** Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. */
|
437
437
|
canModifyEditorContentRestriction?: boolean;
|
@@ -439,21 +439,21 @@ declare namespace gapi.client {
|
|
439
439
|
canModifyLabels?: boolean;
|
440
440
|
/** Output only. Whether the current user can add or modify content restrictions which are owner restricted. */
|
441
441
|
canModifyOwnerContentRestriction?: boolean;
|
442
|
-
/** Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item
|
442
|
+
/** Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives. */
|
443
443
|
canMoveChildrenOutOfDrive?: boolean;
|
444
444
|
/** Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead. */
|
445
445
|
canMoveChildrenOutOfTeamDrive?: boolean;
|
446
|
-
/** Output only. Whether the current user can move children of this folder within this drive. This is false when the item
|
446
|
+
/** Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. */
|
447
447
|
canMoveChildrenWithinDrive?: boolean;
|
448
448
|
/** Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead. */
|
449
449
|
canMoveChildrenWithinTeamDrive?: boolean;
|
450
450
|
/** Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. */
|
451
451
|
canMoveItemIntoTeamDrive?: boolean;
|
452
|
-
/** Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that
|
452
|
+
/** Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added. */
|
453
453
|
canMoveItemOutOfDrive?: boolean;
|
454
454
|
/** Deprecated: Output only. Use `canMoveItemOutOfDrive` instead. */
|
455
455
|
canMoveItemOutOfTeamDrive?: boolean;
|
456
|
-
/** Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that
|
456
|
+
/** Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed. */
|
457
457
|
canMoveItemWithinDrive?: boolean;
|
458
458
|
/** Deprecated: Output only. Use `canMoveItemWithinDrive` instead. */
|
459
459
|
canMoveItemWithinTeamDrive?: boolean;
|
@@ -463,13 +463,13 @@ declare namespace gapi.client {
|
|
463
463
|
canReadDrive?: boolean;
|
464
464
|
/** Output only. Whether the current user can read the labels on the file. */
|
465
465
|
canReadLabels?: boolean;
|
466
|
-
/** Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item
|
466
|
+
/** Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read. */
|
467
467
|
canReadRevisions?: boolean;
|
468
468
|
/** Deprecated: Output only. Use `canReadDrive` instead. */
|
469
469
|
canReadTeamDrive?: boolean;
|
470
|
-
/** Output only. Whether the current user can remove children from this folder. This is always false when the item
|
470
|
+
/** Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. */
|
471
471
|
canRemoveChildren?: boolean;
|
472
|
-
/** Output only. Whether there
|
472
|
+
/** Output only. Whether there's a content restriction on the file that can be removed by the current user. */
|
473
473
|
canRemoveContentRestriction?: boolean;
|
474
474
|
/** Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. */
|
475
475
|
canRemoveMyDriveParent?: boolean;
|
@@ -479,18 +479,18 @@ declare namespace gapi.client {
|
|
479
479
|
canShare?: boolean;
|
480
480
|
/** Output only. Whether the current user can move this file to trash. */
|
481
481
|
canTrash?: boolean;
|
482
|
-
/** Output only. Whether the current user can trash children of this folder. This is false when the item
|
482
|
+
/** Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. */
|
483
483
|
canTrashChildren?: boolean;
|
484
484
|
/** Output only. Whether the current user can restore this file from trash. */
|
485
485
|
canUntrash?: boolean;
|
486
486
|
};
|
487
487
|
/** Additional information about the content of the file. These fields are never populated in responses. */
|
488
488
|
contentHints?: {
|
489
|
-
/** Text to be indexed for the file to improve fullText queries. This is limited to
|
489
|
+
/** Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. */
|
490
490
|
indexableText?: string;
|
491
491
|
/** A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. */
|
492
492
|
thumbnail?: {
|
493
|
-
/** The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5). */
|
493
|
+
/** The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)). */
|
494
494
|
image?: string;
|
495
495
|
/** The MIME type of the thumbnail. */
|
496
496
|
mimeType?: string;
|
@@ -498,7 +498,7 @@ declare namespace gapi.client {
|
|
498
498
|
};
|
499
499
|
/** Restrictions for accessing the content of the file. Only populated if such a restriction exists. */
|
500
500
|
contentRestrictions?: ContentRestriction[];
|
501
|
-
/** Whether the options to copy, print, or download this file
|
501
|
+
/** Whether the options to copy, print, or download this file should be disabled for readers and commenters. */
|
502
502
|
copyRequiresWriterPermission?: boolean;
|
503
503
|
/** The time at which the file was created (RFC 3339 date-time). */
|
504
504
|
createdTime?: string;
|
@@ -514,13 +514,13 @@ declare namespace gapi.client {
|
|
514
514
|
exportLinks?: {[P in string]: string};
|
515
515
|
/** Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive. */
|
516
516
|
fileExtension?: string;
|
517
|
-
/** The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the
|
517
|
+
/** The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead. */
|
518
518
|
folderColorRgb?: string;
|
519
|
-
/** Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it
|
519
|
+
/** Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension. */
|
520
520
|
fullFileExtension?: string;
|
521
521
|
/** Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. */
|
522
522
|
hasAugmentedPermissions?: boolean;
|
523
|
-
/** Output only. Whether this file has a thumbnail. This
|
523
|
+
/** Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. */
|
524
524
|
hasThumbnail?: boolean;
|
525
525
|
/** Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. */
|
526
526
|
headRevisionId?: string;
|
@@ -602,7 +602,7 @@ declare namespace gapi.client {
|
|
602
602
|
};
|
603
603
|
/** Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. */
|
604
604
|
md5Checksum?: string;
|
605
|
-
/** The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the
|
605
|
+
/** The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. */
|
606
606
|
mimeType?: string;
|
607
607
|
/** Output only. Whether the file has been modified by this user. */
|
608
608
|
modifiedByMe?: boolean;
|
@@ -610,7 +610,7 @@ declare namespace gapi.client {
|
|
610
610
|
modifiedByMeTime?: string;
|
611
611
|
/** he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. */
|
612
612
|
modifiedTime?: string;
|
613
|
-
/** The name of the file. This
|
613
|
+
/** The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant. */
|
614
614
|
name?: string;
|
615
615
|
/** The original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive. */
|
616
616
|
originalFilename?: string;
|
@@ -633,9 +633,9 @@ declare namespace gapi.client {
|
|
633
633
|
quotaBytesUsed?: string;
|
634
634
|
/** Output only. A key needed to access the item via a shared link. */
|
635
635
|
resourceKey?: string;
|
636
|
-
/** Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it
|
636
|
+
/** Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. */
|
637
637
|
sha1Checksum?: string;
|
638
|
-
/** Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it
|
638
|
+
/** Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. */
|
639
639
|
sha256Checksum?: string;
|
640
640
|
/** Output only. Whether the file has been shared. Not populated for items in shared drives. */
|
641
641
|
shared?: boolean;
|
@@ -649,18 +649,18 @@ declare namespace gapi.client {
|
|
649
649
|
targetId?: string;
|
650
650
|
/** Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. */
|
651
651
|
targetMimeType?: string;
|
652
|
-
/** Output only. The
|
652
|
+
/** Output only. The `resourceKey` for the target file. */
|
653
653
|
targetResourceKey?: string;
|
654
654
|
};
|
655
|
-
/** Output only. Size in bytes of blobs and
|
655
|
+
/** Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders. */
|
656
656
|
size?: string;
|
657
|
-
/** Output only. The list of spaces which contain the file. The currently supported values are
|
657
|
+
/** Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`. */
|
658
658
|
spaces?: string[];
|
659
659
|
/** Whether the user has starred the file. */
|
660
660
|
starred?: boolean;
|
661
661
|
/** Deprecated: Output only. Use `driveId` instead. */
|
662
662
|
teamDriveId?: string;
|
663
|
-
/** Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies
|
663
|
+
/** Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. */
|
664
664
|
thumbnailLink?: string;
|
665
665
|
/** Output only. The thumbnail version for use in thumbnail cache invalidation. */
|
666
666
|
thumbnailVersion?: string;
|
@@ -695,9 +695,9 @@ declare namespace gapi.client {
|
|
695
695
|
writersCanShare?: boolean;
|
696
696
|
}
|
697
697
|
interface FileList {
|
698
|
-
/** The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. */
|
698
|
+
/** The list of files. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched. */
|
699
699
|
files?: File[];
|
700
|
-
/** Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the
|
700
|
+
/** Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the `allDrives` corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as `user` or `drive`. */
|
701
701
|
incompleteSearch?: boolean;
|
702
702
|
/** Identifies what kind of resource this is. Value: the fixed string `"drive#fileList"`. */
|
703
703
|
kind?: string;
|
@@ -743,7 +743,7 @@ declare namespace gapi.client {
|
|
743
743
|
interface LabelFieldModification {
|
744
744
|
/** The ID of the field to be modified. */
|
745
745
|
fieldId?: string;
|
746
|
-
/** This is always drive#labelFieldModification
|
746
|
+
/** This is always `"drive#labelFieldModification"`. */
|
747
747
|
kind?: string;
|
748
748
|
/** Replaces the value of a dateString Field with these new values. The string must be in the RFC 3339 full-date format: YYYY-MM-DD. */
|
749
749
|
setDateValues?: string[];
|
@@ -753,13 +753,13 @@ declare namespace gapi.client {
|
|
753
753
|
setSelectionValues?: string[];
|
754
754
|
/** Sets the value of a `text` field. */
|
755
755
|
setTextValues?: string[];
|
756
|
-
/** Replaces a `user` field with these new values. The values must be valid email addresses. */
|
756
|
+
/** Replaces a `user` field with these new values. The values must be a valid email addresses. */
|
757
757
|
setUserValues?: string[];
|
758
758
|
/** Unsets the values for this field. */
|
759
759
|
unsetValues?: boolean;
|
760
760
|
}
|
761
761
|
interface LabelList {
|
762
|
-
/** This is always drive#labelList */
|
762
|
+
/** This is always `"drive#labelList"`. */
|
763
763
|
kind?: string;
|
764
764
|
/** The list of labels. */
|
765
765
|
labels?: Label[];
|
@@ -769,7 +769,7 @@ declare namespace gapi.client {
|
|
769
769
|
interface LabelModification {
|
770
770
|
/** The list of modifications to this label's fields. */
|
771
771
|
fieldModifications?: LabelFieldModification[];
|
772
|
-
/** This is always drive#labelModification
|
772
|
+
/** This is always `"drive#labelModification"`. */
|
773
773
|
kind?: string;
|
774
774
|
/** The ID of the label to modify. */
|
775
775
|
labelId?: string;
|
@@ -783,13 +783,13 @@ declare namespace gapi.client {
|
|
783
783
|
nextPageToken?: string;
|
784
784
|
}
|
785
785
|
interface ModifyLabelsRequest {
|
786
|
-
/** This is always drive#modifyLabelsRequest
|
786
|
+
/** This is always `"drive#modifyLabelsRequest"`. */
|
787
787
|
kind?: string;
|
788
788
|
/** The list of modifications to apply to the labels on the file. */
|
789
789
|
labelModifications?: LabelModification[];
|
790
790
|
}
|
791
791
|
interface ModifyLabelsResponse {
|
792
|
-
/** This is always drive#modifyLabelsResponse */
|
792
|
+
/** This is always `"drive#modifyLabelsResponse"`. */
|
793
793
|
kind?: string;
|
794
794
|
/** The list of labels which were added or updated by the request. */
|
795
795
|
modifiedLabels?: Label[];
|
@@ -2021,7 +2021,7 @@ declare namespace gapi.client {
|
|
2021
2021
|
): Request<Drive>;
|
2022
2022
|
}
|
2023
2023
|
interface FilesResource {
|
2024
|
-
/** Creates a copy of a file and applies any requested updates with patch semantics. */
|
2024
|
+
/** Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file). */
|
2025
2025
|
copy(request: {
|
2026
2026
|
/** V1 error format. */
|
2027
2027
|
'$.xgafv'?: string;
|
@@ -2031,7 +2031,7 @@ declare namespace gapi.client {
|
|
2031
2031
|
alt?: string;
|
2032
2032
|
/** JSONP */
|
2033
2033
|
callback?: string;
|
2034
|
-
/** Deprecated
|
2034
|
+
/** Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead. */
|
2035
2035
|
enforceSingleParent?: boolean;
|
2036
2036
|
/** Selector specifying which fields to include in a partial response. */
|
2037
2037
|
fields?: string;
|
@@ -2041,9 +2041,9 @@ declare namespace gapi.client {
|
|
2041
2041
|
ignoreDefaultVisibility?: boolean;
|
2042
2042
|
/** A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. */
|
2043
2043
|
includeLabels?: string;
|
2044
|
-
/** Specifies which additional view's permissions to include in the response. Only
|
2044
|
+
/** Specifies which additional view's permissions to include in the response. Only `published` is supported. */
|
2045
2045
|
includePermissionsForView?: string;
|
2046
|
-
/** Whether to set the
|
2046
|
+
/** Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. */
|
2047
2047
|
keepRevisionForever?: boolean;
|
2048
2048
|
/** 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. */
|
2049
2049
|
key?: string;
|
@@ -2076,7 +2076,7 @@ declare namespace gapi.client {
|
|
2076
2076
|
alt?: string;
|
2077
2077
|
/** JSONP */
|
2078
2078
|
callback?: string;
|
2079
|
-
/** Deprecated
|
2079
|
+
/** Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead. */
|
2080
2080
|
enforceSingleParent?: boolean;
|
2081
2081
|
/** Selector specifying which fields to include in a partial response. */
|
2082
2082
|
fields?: string;
|
@@ -2086,9 +2086,9 @@ declare namespace gapi.client {
|
|
2086
2086
|
ignoreDefaultVisibility?: boolean;
|
2087
2087
|
/** A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. */
|
2088
2088
|
includeLabels?: string;
|
2089
|
-
/** Specifies which additional view's permissions to include in the response. Only
|
2089
|
+
/** Specifies which additional view's permissions to include in the response. Only `published` is supported. */
|
2090
2090
|
includePermissionsForView?: string;
|
2091
|
-
/** Whether to set the
|
2091
|
+
/** Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. */
|
2092
2092
|
keepRevisionForever?: boolean;
|
2093
2093
|
/** 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. */
|
2094
2094
|
key?: string;
|
@@ -2111,7 +2111,7 @@ declare namespace gapi.client {
|
|
2111
2111
|
},
|
2112
2112
|
body: File,
|
2113
2113
|
): Request<File>;
|
2114
|
-
/** Creates a
|
2114
|
+
/** Creates a file. For more information, see [Create and manage files](/workspace/drive/api/guides/create-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:* `*/*` (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, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method 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 `name` 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 name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type. */
|
2115
2115
|
create(request: {
|
2116
2116
|
/** V1 error format. */
|
2117
2117
|
'$.xgafv'?: string;
|
@@ -2121,7 +2121,7 @@ declare namespace gapi.client {
|
|
2121
2121
|
alt?: string;
|
2122
2122
|
/** JSONP */
|
2123
2123
|
callback?: string;
|
2124
|
-
/** Deprecated
|
2124
|
+
/** Deprecated: Creating files in multiple folders is no longer supported. */
|
2125
2125
|
enforceSingleParent?: boolean;
|
2126
2126
|
/** Selector specifying which fields to include in a partial response. */
|
2127
2127
|
fields?: string;
|
@@ -2129,9 +2129,9 @@ declare namespace gapi.client {
|
|
2129
2129
|
ignoreDefaultVisibility?: boolean;
|
2130
2130
|
/** A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. */
|
2131
2131
|
includeLabels?: string;
|
2132
|
-
/** Specifies which additional view's permissions to include in the response. Only
|
2132
|
+
/** Specifies which additional view's permissions to include in the response. Only `published` is supported. */
|
2133
2133
|
includePermissionsForView?: string;
|
2134
|
-
/** Whether to set the
|
2134
|
+
/** Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. */
|
2135
2135
|
keepRevisionForever?: boolean;
|
2136
2136
|
/** 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. */
|
2137
2137
|
key?: string;
|
@@ -2166,7 +2166,7 @@ declare namespace gapi.client {
|
|
2166
2166
|
alt?: string;
|
2167
2167
|
/** JSONP */
|
2168
2168
|
callback?: string;
|
2169
|
-
/** Deprecated
|
2169
|
+
/** Deprecated: Creating files in multiple folders is no longer supported. */
|
2170
2170
|
enforceSingleParent?: boolean;
|
2171
2171
|
/** Selector specifying which fields to include in a partial response. */
|
2172
2172
|
fields?: string;
|
@@ -2174,9 +2174,9 @@ declare namespace gapi.client {
|
|
2174
2174
|
ignoreDefaultVisibility?: boolean;
|
2175
2175
|
/** A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. */
|
2176
2176
|
includeLabels?: string;
|
2177
|
-
/** Specifies which additional view's permissions to include in the response. Only
|
2177
|
+
/** Specifies which additional view's permissions to include in the response. Only `published` is supported. */
|
2178
2178
|
includePermissionsForView?: string;
|
2179
|
-
/** Whether to set the
|
2179
|
+
/** Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. */
|
2180
2180
|
keepRevisionForever?: boolean;
|
2181
2181
|
/** 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. */
|
2182
2182
|
key?: string;
|
@@ -2201,7 +2201,7 @@ declare namespace gapi.client {
|
|
2201
2201
|
},
|
2202
2202
|
body: File,
|
2203
2203
|
): Request<File>;
|
2204
|
-
/** Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted. */
|
2204
|
+
/** Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted. */
|
2205
2205
|
delete(request?: {
|
2206
2206
|
/** V1 error format. */
|
2207
2207
|
'$.xgafv'?: string;
|
@@ -2211,7 +2211,7 @@ declare namespace gapi.client {
|
|
2211
2211
|
alt?: string;
|
2212
2212
|
/** JSONP */
|
2213
2213
|
callback?: string;
|
2214
|
-
/** Deprecated: If an item
|
2214
|
+
/** Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root. */
|
2215
2215
|
enforceSingleParent?: boolean;
|
2216
2216
|
/** Selector specifying which fields to include in a partial response. */
|
2217
2217
|
fields?: string;
|
@@ -2234,7 +2234,7 @@ declare namespace gapi.client {
|
|
2234
2234
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
2235
2235
|
uploadType?: string;
|
2236
2236
|
}): Request<void>;
|
2237
|
-
/** Downloads content of a file. Operations are valid for 24 hours from the time of creation. */
|
2237
|
+
/** Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation. */
|
2238
2238
|
download(request?: {
|
2239
2239
|
/** V1 error format. */
|
2240
2240
|
'$.xgafv'?: string;
|
@@ -2250,7 +2250,7 @@ declare namespace gapi.client {
|
|
2250
2250
|
fileId: string;
|
2251
2251
|
/** 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. */
|
2252
2252
|
key?: string;
|
2253
|
-
/** Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents.
|
2253
|
+
/** Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future. */
|
2254
2254
|
mimeType?: string;
|
2255
2255
|
/** OAuth 2.0 token for the current user. */
|
2256
2256
|
oauth_token?: string;
|
@@ -2265,7 +2265,7 @@ declare namespace gapi.client {
|
|
2265
2265
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
2266
2266
|
uploadType?: string;
|
2267
2267
|
}): Request<Operation>;
|
2268
|
-
/** Permanently deletes all of the user's trashed files. */
|
2268
|
+
/** Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). */
|
2269
2269
|
emptyTrash(request?: {
|
2270
2270
|
/** V1 error format. */
|
2271
2271
|
'$.xgafv'?: string;
|
@@ -2277,7 +2277,7 @@ declare namespace gapi.client {
|
|
2277
2277
|
callback?: string;
|
2278
2278
|
/** If set, empties the trash of the provided shared drive. */
|
2279
2279
|
driveId?: string;
|
2280
|
-
/** Deprecated: If an item
|
2280
|
+
/** Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root. */
|
2281
2281
|
enforceSingleParent?: boolean;
|
2282
2282
|
/** Selector specifying which fields to include in a partial response. */
|
2283
2283
|
fields?: string;
|
@@ -2294,7 +2294,7 @@ declare namespace gapi.client {
|
|
2294
2294
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
2295
2295
|
uploadType?: string;
|
2296
2296
|
}): Request<void>;
|
2297
|
-
/** Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to
|
2297
|
+
/** Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB. */
|
2298
2298
|
export(request?: {
|
2299
2299
|
/** V1 error format. */
|
2300
2300
|
'$.xgafv'?: string;
|
@@ -2310,7 +2310,7 @@ declare namespace gapi.client {
|
|
2310
2310
|
fileId: string;
|
2311
2311
|
/** 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. */
|
2312
2312
|
key?: string;
|
2313
|
-
/** Required. The MIME type of the format requested for this export. */
|
2313
|
+
/** Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). */
|
2314
2314
|
mimeType: string;
|
2315
2315
|
/** OAuth 2.0 token for the current user. */
|
2316
2316
|
oauth_token?: string;
|
@@ -2323,7 +2323,7 @@ declare namespace gapi.client {
|
|
2323
2323
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
2324
2324
|
uploadType?: string;
|
2325
2325
|
}): Request<void>;
|
2326
|
-
/** Generates a set of file IDs which can be provided in create or copy requests. */
|
2326
|
+
/** Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file). */
|
2327
2327
|
generateIds(request?: {
|
2328
2328
|
/** V1 error format. */
|
2329
2329
|
'$.xgafv'?: string;
|
@@ -2345,16 +2345,16 @@ declare namespace gapi.client {
|
|
2345
2345
|
prettyPrint?: boolean;
|
2346
2346
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
2347
2347
|
quotaUser?: string;
|
2348
|
-
/** The space in which the IDs can be used to create
|
2348
|
+
/** The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). */
|
2349
2349
|
space?: string;
|
2350
|
-
/** The type of items which the IDs can be used for. Supported values are
|
2350
|
+
/** The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). */
|
2351
2351
|
type?: string;
|
2352
2352
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
2353
2353
|
upload_protocol?: string;
|
2354
2354
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
2355
2355
|
uploadType?: string;
|
2356
2356
|
}): Request<GeneratedIds>;
|
2357
|
-
/** 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`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download
|
2357
|
+
/** Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). 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`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads). */
|
2358
2358
|
get(request?: {
|
2359
2359
|
/** V1 error format. */
|
2360
2360
|
'$.xgafv'?: string;
|
@@ -2372,7 +2372,7 @@ declare namespace gapi.client {
|
|
2372
2372
|
fileId: string;
|
2373
2373
|
/** A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. */
|
2374
2374
|
includeLabels?: string;
|
2375
|
-
/** Specifies which additional view's permissions to include in the response. Only
|
2375
|
+
/** Specifies which additional view's permissions to include in the response. Only `published` is supported. */
|
2376
2376
|
includePermissionsForView?: string;
|
2377
2377
|
/** 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. */
|
2378
2378
|
key?: string;
|
@@ -2391,7 +2391,7 @@ declare namespace gapi.client {
|
|
2391
2391
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
2392
2392
|
uploadType?: string;
|
2393
2393
|
}): Request<File>;
|
2394
|
-
/** Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms.
|
2394
|
+
/** Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. 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. */
|
2395
2395
|
list(request?: {
|
2396
2396
|
/** V1 error format. */
|
2397
2397
|
'$.xgafv'?: string;
|
@@ -2401,9 +2401,9 @@ declare namespace gapi.client {
|
|
2401
2401
|
alt?: string;
|
2402
2402
|
/** JSONP */
|
2403
2403
|
callback?: string;
|
2404
|
-
/** Bodies of items (files
|
2404
|
+
/** Bodies of items (files or documents) to which the query applies. Supported bodies are: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). */
|
2405
2405
|
corpora?: string;
|
2406
|
-
/** Deprecated: The source of files to list. Use
|
2406
|
+
/** Deprecated: The source of files to list. Use `corpora` instead. */
|
2407
2407
|
corpus?: string;
|
2408
2408
|
/** ID of the shared drive to search. */
|
2409
2409
|
driveId?: string;
|
@@ -2413,7 +2413,7 @@ declare namespace gapi.client {
|
|
2413
2413
|
includeItemsFromAllDrives?: boolean;
|
2414
2414
|
/** A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. */
|
2415
2415
|
includeLabels?: string;
|
2416
|
-
/** Specifies which additional view's permissions to include in the response. Only
|
2416
|
+
/** Specifies which additional view's permissions to include in the response. Only `published` is supported. */
|
2417
2417
|
includePermissionsForView?: string;
|
2418
2418
|
/** Deprecated: Use `includeItemsFromAllDrives` instead. */
|
2419
2419
|
includeTeamDriveItems?: boolean;
|
@@ -2421,19 +2421,19 @@ declare namespace gapi.client {
|
|
2421
2421
|
key?: string;
|
2422
2422
|
/** OAuth 2.0 token for the current user. */
|
2423
2423
|
oauth_token?: string;
|
2424
|
-
/** A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the
|
2424
|
+
/** A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`. */
|
2425
2425
|
orderBy?: string;
|
2426
2426
|
/** The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. */
|
2427
2427
|
pageSize?: number;
|
2428
|
-
/** The token for continuing a previous list request on the next page. This should be set to the value of
|
2428
|
+
/** The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response. */
|
2429
2429
|
pageToken?: string;
|
2430
2430
|
/** Returns response with indentations and line breaks. */
|
2431
2431
|
prettyPrint?: boolean;
|
2432
|
-
/** A query for filtering the file results.
|
2432
|
+
/** A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files). */
|
2433
2433
|
q?: string;
|
2434
2434
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
2435
2435
|
quotaUser?: string;
|
2436
|
-
/** A comma-separated list of spaces to query within the corpora. Supported values are
|
2436
|
+
/** A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization). */
|
2437
2437
|
spaces?: string;
|
2438
2438
|
/** Whether the requesting application supports both My Drives and shared drives. */
|
2439
2439
|
supportsAllDrives?: boolean;
|
@@ -2446,7 +2446,7 @@ declare namespace gapi.client {
|
|
2446
2446
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
2447
2447
|
uploadType?: string;
|
2448
2448
|
}): Request<FileList>;
|
2449
|
-
/** Lists the labels on a file. */
|
2449
|
+
/** Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels). */
|
2450
2450
|
listLabels(request?: {
|
2451
2451
|
/** V1 error format. */
|
2452
2452
|
'$.xgafv'?: string;
|
@@ -2466,7 +2466,7 @@ declare namespace gapi.client {
|
|
2466
2466
|
maxResults?: number;
|
2467
2467
|
/** OAuth 2.0 token for the current user. */
|
2468
2468
|
oauth_token?: string;
|
2469
|
-
/** The token for continuing a previous list request on the next page. This should be set to the value of
|
2469
|
+
/** The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response. */
|
2470
2470
|
pageToken?: string;
|
2471
2471
|
/** Returns response with indentations and line breaks. */
|
2472
2472
|
prettyPrint?: boolean;
|
@@ -2477,7 +2477,7 @@ declare namespace gapi.client {
|
|
2477
2477
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
2478
2478
|
uploadType?: string;
|
2479
2479
|
}): Request<LabelList>;
|
2480
|
-
/** Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified. */
|
2480
|
+
/** Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified. */
|
2481
2481
|
modifyLabels(request: {
|
2482
2482
|
/** V1 error format. */
|
2483
2483
|
'$.xgafv'?: string;
|
@@ -2535,7 +2535,7 @@ declare namespace gapi.client {
|
|
2535
2535
|
},
|
2536
2536
|
body: ModifyLabelsRequest,
|
2537
2537
|
): Request<ModifyLabelsResponse>;
|
2538
|
-
/** Updates a file's metadata
|
2538
|
+
/** Updates a file's metadata, content, or both. 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:* `*/*` (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, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). */
|
2539
2539
|
update(request: {
|
2540
2540
|
/** V1 error format. */
|
2541
2541
|
'$.xgafv'?: string;
|
@@ -2555,9 +2555,9 @@ declare namespace gapi.client {
|
|
2555
2555
|
fileId: string;
|
2556
2556
|
/** A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. */
|
2557
2557
|
includeLabels?: string;
|
2558
|
-
/** Specifies which additional view's permissions to include in the response. Only
|
2558
|
+
/** Specifies which additional view's permissions to include in the response. Only `published` is supported. */
|
2559
2559
|
includePermissionsForView?: string;
|
2560
|
-
/** Whether to set the
|
2560
|
+
/** Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. */
|
2561
2561
|
keepRevisionForever?: boolean;
|
2562
2562
|
/** 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. */
|
2563
2563
|
key?: string;
|
@@ -2604,9 +2604,9 @@ declare namespace gapi.client {
|
|
2604
2604
|
fileId: string;
|
2605
2605
|
/** A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. */
|
2606
2606
|
includeLabels?: string;
|
2607
|
-
/** Specifies which additional view's permissions to include in the response. Only
|
2607
|
+
/** Specifies which additional view's permissions to include in the response. Only `published` is supported. */
|
2608
2608
|
includePermissionsForView?: string;
|
2609
|
-
/** Whether to set the
|
2609
|
+
/** Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. */
|
2610
2610
|
keepRevisionForever?: boolean;
|
2611
2611
|
/** 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. */
|
2612
2612
|
key?: string;
|
@@ -2633,7 +2633,7 @@ declare namespace gapi.client {
|
|
2633
2633
|
},
|
2634
2634
|
body: File,
|
2635
2635
|
): Request<File>;
|
2636
|
-
/** Subscribes to changes to a file. */
|
2636
|
+
/** Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push). */
|
2637
2637
|
watch(request: {
|
2638
2638
|
/** V1 error format. */
|
2639
2639
|
'$.xgafv'?: string;
|
@@ -2651,7 +2651,7 @@ declare namespace gapi.client {
|
|
2651
2651
|
fileId: string;
|
2652
2652
|
/** A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. */
|
2653
2653
|
includeLabels?: string;
|
2654
|
-
/** Specifies which additional view's permissions to include in the response. Only
|
2654
|
+
/** Specifies which additional view's permissions to include in the response. Only `published` is supported. */
|
2655
2655
|
includePermissionsForView?: string;
|
2656
2656
|
/** 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. */
|
2657
2657
|
key?: string;
|
@@ -2690,7 +2690,7 @@ declare namespace gapi.client {
|
|
2690
2690
|
fileId: string;
|
2691
2691
|
/** A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. */
|
2692
2692
|
includeLabels?: string;
|
2693
|
-
/** Specifies which additional view's permissions to include in the response. Only
|
2693
|
+
/** Specifies which additional view's permissions to include in the response. Only `published` is supported. */
|
2694
2694
|
includePermissionsForView?: string;
|
2695
2695
|
/** 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. */
|
2696
2696
|
key?: string;
|
@@ -2772,7 +2772,7 @@ declare namespace gapi.client {
|
|
2772
2772
|
prettyPrint?: boolean;
|
2773
2773
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
2774
2774
|
quotaUser?: string;
|
2775
|
-
/** Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. */
|
2775
|
+
/** Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. */
|
2776
2776
|
sendNotificationEmail?: boolean;
|
2777
2777
|
/** Whether the requesting application supports both My Drives and shared drives. */
|
2778
2778
|
supportsAllDrives?: boolean;
|
@@ -2819,7 +2819,7 @@ declare namespace gapi.client {
|
|
2819
2819
|
prettyPrint?: boolean;
|
2820
2820
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
2821
2821
|
quotaUser?: string;
|
2822
|
-
/** Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. */
|
2822
|
+
/** Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. */
|
2823
2823
|
sendNotificationEmail?: boolean;
|
2824
2824
|
/** Whether the requesting application supports both My Drives and shared drives. */
|
2825
2825
|
supportsAllDrives?: boolean;
|
package/package.json
CHANGED
package/readme.md
CHANGED
@@ -208,67 +208,67 @@ Updates the metadata for a shared drive. For more information, see [Manage share
|
|
208
208
|
await gapi.client.drive.drives.update({ driveId: "driveId", });
|
209
209
|
|
210
210
|
/*
|
211
|
-
Creates a copy of a file and applies any requested updates with patch semantics.
|
211
|
+
Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).
|
212
212
|
*/
|
213
213
|
await gapi.client.drive.files.copy({ fileId: "fileId", });
|
214
214
|
|
215
215
|
/*
|
216
|
-
Creates a
|
216
|
+
Creates a file. For more information, see [Create and manage files](/workspace/drive/api/guides/create-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:* `*/*` (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, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method 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 `name` 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 name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.
|
217
217
|
*/
|
218
218
|
await gapi.client.drive.files.create({ });
|
219
219
|
|
220
220
|
/*
|
221
|
-
Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.
|
221
|
+
Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.
|
222
222
|
*/
|
223
223
|
await gapi.client.drive.files.delete({ fileId: "fileId", });
|
224
224
|
|
225
225
|
/*
|
226
|
-
Downloads content of a file. Operations are valid for 24 hours from the time of creation.
|
226
|
+
Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation.
|
227
227
|
*/
|
228
228
|
await gapi.client.drive.files.download({ fileId: "fileId", });
|
229
229
|
|
230
230
|
/*
|
231
|
-
Permanently deletes all of the user's trashed files.
|
231
|
+
Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete).
|
232
232
|
*/
|
233
233
|
await gapi.client.drive.files.emptyTrash({ });
|
234
234
|
|
235
235
|
/*
|
236
|
-
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to
|
236
|
+
Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.
|
237
237
|
*/
|
238
238
|
await gapi.client.drive.files.export({ fileId: "fileId", mimeType: "mimeType", });
|
239
239
|
|
240
240
|
/*
|
241
|
-
Generates a set of file IDs which can be provided in create or copy requests.
|
241
|
+
Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).
|
242
242
|
*/
|
243
243
|
await gapi.client.drive.files.generateIds({ });
|
244
244
|
|
245
245
|
/*
|
246
|
-
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`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download
|
246
|
+
Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). 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`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads).
|
247
247
|
*/
|
248
248
|
await gapi.client.drive.files.get({ fileId: "fileId", });
|
249
249
|
|
250
250
|
/*
|
251
|
-
Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms.
|
251
|
+
Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. 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.
|
252
252
|
*/
|
253
253
|
await gapi.client.drive.files.list({ });
|
254
254
|
|
255
255
|
/*
|
256
|
-
Lists the labels on a file.
|
256
|
+
Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels).
|
257
257
|
*/
|
258
258
|
await gapi.client.drive.files.listLabels({ fileId: "fileId", });
|
259
259
|
|
260
260
|
/*
|
261
|
-
Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.
|
261
|
+
Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified.
|
262
262
|
*/
|
263
263
|
await gapi.client.drive.files.modifyLabels({ fileId: "fileId", });
|
264
264
|
|
265
265
|
/*
|
266
|
-
Updates a file's metadata
|
266
|
+
Updates a file's metadata, content, or both. 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:* `*/*` (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, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).
|
267
267
|
*/
|
268
268
|
await gapi.client.drive.files.update({ fileId: "fileId", });
|
269
269
|
|
270
270
|
/*
|
271
|
-
Subscribes to changes to a file.
|
271
|
+
Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).
|
272
272
|
*/
|
273
273
|
await gapi.client.drive.files.watch({ fileId: "fileId", });
|
274
274
|
|