Files
old-slucajna-televizija/backend/node_modules/googleapis/apis/drive/v3.ts
GotPPay a75ea978f9 ..
2017-10-16 20:21:19 +02:00

1933 lines
86 KiB
TypeScript

/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* jshint maxlen: false */
import createAPIRequest from '../../lib/apirequest';
/**
* Drive API
*
* Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.
*
* @example
* const google = require('googleapis');
* const drive = google.drive('v3');
*
* @namespace drive
* @type {Function}
* @version v3
* @variation v3
* @param {object=} options Options for Drive
*/
function Drive(options) { // eslint-disable-line
const self = this;
self._options = options || {};
self.about = {
/**
* drive.about.get
*
* @desc Gets information about the user, the user's Drive, and system capabilities.
*
* @alias drive.about.get
* @memberOf! drive(v3)
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/about').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: [],
pathParams: [],
context: self
};
return createAPIRequest(parameters, callback);
}
};
self.changes = {
/**
* drive.changes.getStartPageToken
*
* @desc Gets the starting pageToken for listing future changes.
*
* @alias drive.changes.getStartPageToken
* @memberOf! drive(v3)
*
* @param {object=} params Parameters for request
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {string=} params.teamDriveId The ID of the Team Drive for which the starting pageToken for listing future changes from that Team Drive will be returned.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getStartPageToken: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/changes/startPageToken').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: [],
pathParams: [],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.changes.list
*
* @desc Lists the changes for a user or Team Drive.
*
* @alias drive.changes.list
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
* @param {boolean=} params.includeRemoved Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
* @param {boolean=} params.includeTeamDriveItems Whether Team Drive files or changes should be included in results.
* @param {integer=} params.pageSize The maximum number of changes to return per page.
* @param {string} params.pageToken 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 or to the response from the getStartPageToken method.
* @param {boolean=} params.restrictToMyDrive Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
* @param {string=} params.spaces A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {string=} params.teamDriveId The Team Drive from which changes will be returned. If specified the change IDs will be reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/changes').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['pageToken'],
pathParams: [],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.changes.watch
*
* @desc Subscribes to changes for a user.
*
* @alias drive.changes.watch
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
* @param {boolean=} params.includeRemoved Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
* @param {boolean=} params.includeTeamDriveItems Whether Team Drive files or changes should be included in results.
* @param {integer=} params.pageSize The maximum number of changes to return per page.
* @param {string} params.pageToken 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 or to the response from the getStartPageToken method.
* @param {boolean=} params.restrictToMyDrive Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
* @param {string=} params.spaces A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {string=} params.teamDriveId The Team Drive from which changes will be returned. If specified the change IDs will be reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier.
* @param {drive(v3).Channel} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
watch: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/changes/watch').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['pageToken'],
pathParams: [],
context: self
};
return createAPIRequest(parameters, callback);
}
};
self.channels = {
/**
* drive.channels.stop
*
* @desc Stop watching resources through this channel
*
* @alias drive.channels.stop
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {drive(v3).Channel} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
stop: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/channels/stop').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: [],
pathParams: [],
context: self
};
return createAPIRequest(parameters, callback);
}
};
self.comments = {
/**
* drive.comments.create
*
* @desc Creates a new comment on a file.
*
* @alias drive.comments.create
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {drive(v3).Comment} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/comments').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['fileId'],
pathParams: ['fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.comments.delete
*
* @desc Deletes a comment.
*
* @alias drive.comments.delete
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/comments/{commentId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE'
}, options),
params: params,
requiredParams: ['fileId', 'commentId'],
pathParams: ['commentId', 'fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.comments.get
*
* @desc Gets a comment by ID.
*
* @alias drive.comments.get
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.includeDeleted Whether to return deleted comments. Deleted comments will not include their original content.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/comments/{commentId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['fileId', 'commentId'],
pathParams: ['commentId', 'fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.comments.list
*
* @desc Lists a file's comments.
*
* @alias drive.comments.list
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.includeDeleted Whether to include deleted comments. Deleted comments will not include their original content.
* @param {integer=} params.pageSize The maximum number of comments to return per page.
* @param {string=} params.pageToken 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.
* @param {string=} params.startModifiedTime The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/comments').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['fileId'],
pathParams: ['fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.comments.update
*
* @desc Updates a comment with patch semantics.
*
* @alias drive.comments.update
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {drive(v3).Comment} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/comments/{commentId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH'
}, options),
params: params,
requiredParams: ['fileId', 'commentId'],
pathParams: ['commentId', 'fileId'],
context: self
};
return createAPIRequest(parameters, callback);
}
};
self.files = {
/**
* drive.files.copy
*
* @desc Creates a copy of a file and applies any requested updates with patch semantics.
*
* @alias drive.files.copy
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.ignoreDefaultVisibility Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
* @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.
* @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code).
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {drive(v3).File} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
copy: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/copy').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['fileId'],
pathParams: ['fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.files.create
*
* @desc Creates a new file.
*
* @alias drive.files.create
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {boolean=} params.ignoreDefaultVisibility Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
* @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.
* @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code).
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {boolean=} params.useContentAsIndexableText Whether to use the uploaded content as indexable text.
* @param {object} params.resource Media resource metadata
* @param {object} params.media Media object
* @param {string} params.media.mimeType Media mime-type
* @param {string|object} params.media.body Media body contents
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
mediaUrl: (rootUrl + '/upload/drive/v3/files').replace(/([^:]\/)\/+/g, '$1'),
requiredParams: [],
pathParams: [],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.files.delete
*
* @desc Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a Team Drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.
*
* @alias drive.files.delete
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE'
}, options),
params: params,
requiredParams: ['fileId'],
pathParams: ['fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.files.emptyTrash
*
* @desc Permanently deletes all of the user's trashed files.
*
* @alias drive.files.emptyTrash
* @memberOf! drive(v3)
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
emptyTrash: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/trash').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE'
}, options),
params: params,
requiredParams: [],
pathParams: [],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.files.export
*
* @desc Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.
*
* @alias drive.files.export
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.mimeType The MIME type of the format requested for this export.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
export: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/export').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['fileId', 'mimeType'],
pathParams: ['fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.files.generateIds
*
* @desc Generates a set of file IDs which can be provided in create requests.
*
* @alias drive.files.generateIds
* @memberOf! drive(v3)
*
* @param {object=} params Parameters for request
* @param {integer=} params.count The number of IDs to return.
* @param {string=} params.space The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
generateIds: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/generateIds').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: [],
pathParams: [],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.files.get
*
* @desc Gets a file's metadata or content by ID.
*
* @alias drive.files.get
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {boolean=} params.acknowledgeAbuse Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['fileId'],
pathParams: ['fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.files.list
*
* @desc Lists or searches files.
*
* @alias drive.files.list
* @memberOf! drive(v3)
*
* @param {object=} params Parameters for request
* @param {string=} params.corpora Comma-separated list of bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'teamDrive' and 'allTeamDrives'. 'allTeamDrives' must be combined with 'user'; all other values must be used in isolation. Prefer 'user' or 'teamDrive' to 'allTeamDrives' for efficiency.
* @param {string=} params.corpus The source of files to list. Deprecated: use 'corpora' instead.
* @param {boolean=} params.includeTeamDriveItems Whether Team Drive items should be included in results.
* @param {string=} params.orderBy A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
* @param {integer=} params.pageSize 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.
* @param {string=} params.pageToken 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.
* @param {string=} params.q A query for filtering the file results. See the "Search for Files" guide for supported syntax.
* @param {string=} params.spaces A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {string=} params.teamDriveId ID of Team Drive to search.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: [],
pathParams: [],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.files.update
*
* @desc Updates a file's metadata and/or content with patch semantics.
*
* @alias drive.files.update
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string=} params.addParents A comma-separated list of parent IDs to add.
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.
* @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code).
* @param {string=} params.removeParents A comma-separated list of parent IDs to remove.
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {boolean=} params.useContentAsIndexableText Whether to use the uploaded content as indexable text.
* @param {object} params.resource Media resource metadata
* @param {object} params.media Media object
* @param {string} params.media.mimeType Media mime-type
* @param {string|object} params.media.body Media body contents
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH'
}, options),
params: params,
mediaUrl: (rootUrl + '/upload/drive/v3/files/{fileId}').replace(/([^:]\/)\/+/g, '$1'),
requiredParams: ['fileId'],
pathParams: ['fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.files.watch
*
* @desc Subscribes to changes to a file
*
* @alias drive.files.watch
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {boolean=} params.acknowledgeAbuse Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {drive(v3).Channel} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
watch: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/watch').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['fileId'],
pathParams: ['fileId'],
context: self
};
return createAPIRequest(parameters, callback);
}
};
self.permissions = {
/**
* drive.permissions.create
*
* @desc Creates a permission for a file or Team Drive.
*
* @alias drive.permissions.create
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string=} params.emailMessage A custom message to include in the notification email.
* @param {string} params.fileId The ID of the file or Team Drive.
* @param {boolean=} params.sendNotificationEmail 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.
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {boolean=} params.transferOwnership Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.
* @param {drive(v3).Permission} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/permissions').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['fileId'],
pathParams: ['fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.permissions.delete
*
* @desc Deletes a permission.
*
* @alias drive.permissions.delete
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file or Team Drive.
* @param {string} params.permissionId The ID of the permission.
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/permissions/{permissionId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE'
}, options),
params: params,
requiredParams: ['fileId', 'permissionId'],
pathParams: ['fileId', 'permissionId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.permissions.get
*
* @desc Gets a permission by ID.
*
* @alias drive.permissions.get
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.permissionId The ID of the permission.
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/permissions/{permissionId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['fileId', 'permissionId'],
pathParams: ['fileId', 'permissionId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.permissions.list
*
* @desc Lists a file's or Team Drive's permissions.
*
* @alias drive.permissions.list
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file or Team Drive.
* @param {integer=} params.pageSize The maximum number of permissions to return per page. When not set for files in a Team Drive, at most 100 results will be returned. When not set for files that are not in a Team Drive, the entire list will be returned.
* @param {string=} params.pageToken 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.
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/permissions').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['fileId'],
pathParams: ['fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.permissions.update
*
* @desc Updates a permission with patch semantics.
*
* @alias drive.permissions.update
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file or Team Drive.
* @param {string} params.permissionId The ID of the permission.
* @param {boolean=} params.removeExpiration Whether to remove the expiration date.
* @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives.
* @param {boolean=} params.transferOwnership Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.
* @param {drive(v3).Permission} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/permissions/{permissionId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH'
}, options),
params: params,
requiredParams: ['fileId', 'permissionId'],
pathParams: ['fileId', 'permissionId'],
context: self
};
return createAPIRequest(parameters, callback);
}
};
self.replies = {
/**
* drive.replies.create
*
* @desc Creates a new reply to a comment.
*
* @alias drive.replies.create
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {drive(v3).Reply} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/comments/{commentId}/replies').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['fileId', 'commentId'],
pathParams: ['commentId', 'fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.replies.delete
*
* @desc Deletes a reply.
*
* @alias drive.replies.delete
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {string} params.replyId The ID of the reply.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE'
}, options),
params: params,
requiredParams: ['fileId', 'commentId', 'replyId'],
pathParams: ['commentId', 'fileId', 'replyId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.replies.get
*
* @desc Gets a reply by ID.
*
* @alias drive.replies.get
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.includeDeleted Whether to return deleted replies. Deleted replies will not include their original content.
* @param {string} params.replyId The ID of the reply.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['fileId', 'commentId', 'replyId'],
pathParams: ['commentId', 'fileId', 'replyId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.replies.list
*
* @desc Lists a comment's replies.
*
* @alias drive.replies.list
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {boolean=} params.includeDeleted Whether to include deleted replies. Deleted replies will not include their original content.
* @param {integer=} params.pageSize The maximum number of replies to return per page.
* @param {string=} params.pageToken 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.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/comments/{commentId}/replies').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['fileId', 'commentId'],
pathParams: ['commentId', 'fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.replies.update
*
* @desc Updates a reply with patch semantics.
*
* @alias drive.replies.update
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.commentId The ID of the comment.
* @param {string} params.fileId The ID of the file.
* @param {string} params.replyId The ID of the reply.
* @param {drive(v3).Reply} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/comments/{commentId}/replies/{replyId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH'
}, options),
params: params,
requiredParams: ['fileId', 'commentId', 'replyId'],
pathParams: ['commentId', 'fileId', 'replyId'],
context: self
};
return createAPIRequest(parameters, callback);
}
};
self.revisions = {
/**
* drive.revisions.delete
*
* @desc Permanently deletes a revision. This method is only applicable to files with binary content in Drive.
*
* @alias drive.revisions.delete
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.revisionId The ID of the revision.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/revisions/{revisionId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE'
}, options),
params: params,
requiredParams: ['fileId', 'revisionId'],
pathParams: ['fileId', 'revisionId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.revisions.get
*
* @desc Gets a revision's metadata or content by ID.
*
* @alias drive.revisions.get
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {boolean=} params.acknowledgeAbuse Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
* @param {string} params.fileId The ID of the file.
* @param {string} params.revisionId The ID of the revision.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/revisions/{revisionId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['fileId', 'revisionId'],
pathParams: ['fileId', 'revisionId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.revisions.list
*
* @desc Lists a file's revisions.
*
* @alias drive.revisions.list
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {integer=} params.pageSize The maximum number of revisions to return per page.
* @param {string=} params.pageToken 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.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/revisions').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['fileId'],
pathParams: ['fileId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.revisions.update
*
* @desc Updates a revision with patch semantics.
*
* @alias drive.revisions.update
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the file.
* @param {string} params.revisionId The ID of the revision.
* @param {drive(v3).Revision} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/files/{fileId}/revisions/{revisionId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH'
}, options),
params: params,
requiredParams: ['fileId', 'revisionId'],
pathParams: ['fileId', 'revisionId'],
context: self
};
return createAPIRequest(parameters, callback);
}
};
self.teamdrives = {
/**
* drive.teamdrives.create
*
* @desc Creates a new Team Drive.
*
* @alias drive.teamdrives.create
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.requestId An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.
* @param {drive(v3).TeamDrive} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/teamdrives').replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
}, options),
params: params,
requiredParams: ['requestId'],
pathParams: [],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.teamdrives.delete
*
* @desc Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items.
*
* @alias drive.teamdrives.delete
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.teamDriveId The ID of the Team Drive
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/teamdrives/{teamDriveId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE'
}, options),
params: params,
requiredParams: ['teamDriveId'],
pathParams: ['teamDriveId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.teamdrives.get
*
* @desc Gets a Team Drive's metadata by ID.
*
* @alias drive.teamdrives.get
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.teamDriveId The ID of the Team Drive
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/teamdrives/{teamDriveId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: ['teamDriveId'],
pathParams: ['teamDriveId'],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.teamdrives.list
*
* @desc Lists the user's Team Drives.
*
* @alias drive.teamdrives.list
* @memberOf! drive(v3)
*
* @param {object=} params Parameters for request
* @param {integer=} params.pageSize Maximum number of Team Drives to return.
* @param {string=} params.pageToken Page token for Team Drives.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/teamdrives').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
}, options),
params: params,
requiredParams: [],
pathParams: [],
context: self
};
return createAPIRequest(parameters, callback);
},
/**
* drive.teamdrives.update
*
* @desc Updates a Team Drive's metadata
*
* @alias drive.teamdrives.update
* @memberOf! drive(v3)
*
* @param {object} params Parameters for request
* @param {string} params.teamDriveId The ID of the Team Drive
* @param {drive(v3).TeamDrive} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update: function (params, options, callback) {
if (typeof options === 'function') {
callback = options;
options = {};
}
options || (options = {});
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign({
url: (rootUrl + '/drive/v3/teamdrives/{teamDriveId}').replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH'
}, options),
params: params,
requiredParams: ['teamDriveId'],
pathParams: ['teamDriveId'],
context: self
};
return createAPIRequest(parameters, callback);
}
};
}
/**
* @typedef About
* @memberOf! drive(v3)
* @type object
* @property {boolean} appInstalled Whether the user has installed the requesting app.
* @property {object} exportFormats A map of source MIME type to possible targets for all supported exports.
* @property {string[]} folderColorPalette The currently supported folder colors as RGB hex strings.
* @property {object} importFormats A map of source MIME type to possible targets for all supported imports.
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#about".
* @property {object} maxImportSizes A map of maximum import sizes by MIME type, in bytes.
* @property {string} maxUploadSize The maximum upload size in bytes.
* @property {object} storageQuota The user's storage quota limits and usage. All fields are measured in bytes.
* @property {object[]} teamDriveThemes A list of themes that are supported for Team Drives.
* @property {drive(v3).User} user The authenticated user.
*/
/**
* @typedef Change
* @memberOf! drive(v3)
* @type object
* @property {drive(v3).File} file The updated state of the file. Present if the type is file and the file has not been removed from this list of changes.
* @property {string} fileId The ID of the file which has changed.
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#change".
* @property {boolean} removed Whether the file or Team Drive has been removed from this list of changes, for example by deletion or loss of access.
* @property {drive(v3).TeamDrive} teamDrive The updated state of the Team Drive. Present if the type is teamDrive, the user is still a member of the Team Drive, and the Team Drive has not been removed.
* @property {string} teamDriveId The ID of the Team Drive associated with this change.
* @property {string} time The time of this change (RFC 3339 date-time).
* @property {string} type The type of the change. Possible values are file and teamDrive.
*/
/**
* @typedef ChangeList
* @memberOf! drive(v3)
* @type object
* @property {drive(v3).Change[]} changes The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#changeList".
* @property {string} newStartPageToken The starting page token for future changes. This will be present only if the end of the current changes list has been reached.
* @property {string} nextPageToken The page token for the next page of changes. This will be absent if the end of the changes list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
*/
/**
* @typedef Channel
* @memberOf! drive(v3)
* @type object
* @property {string} address The address where notifications are delivered for this channel.
* @property {string} expiration Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
* @property {string} id A UUID or similar unique string that identifies this channel.
* @property {string} kind Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
* @property {object} params Additional parameters controlling delivery channel behavior. Optional.
* @property {boolean} payload A Boolean value to indicate whether payload is wanted. Optional.
* @property {string} resourceId An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
* @property {string} resourceUri A version-specific identifier for the watched resource.
* @property {string} token An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
* @property {string} type The type of delivery mechanism used for this channel.
*/
/**
* @typedef Comment
* @memberOf! drive(v3)
* @type object
* @property {string} anchor A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
* @property {drive(v3).User} author The user who created the comment.
* @property {string} content The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
* @property {string} createdTime The time at which the comment was created (RFC 3339 date-time).
* @property {boolean} deleted Whether the comment has been deleted. A deleted comment has no content.
* @property {string} htmlContent The content of the comment with HTML formatting.
* @property {string} id The ID of the comment.
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#comment".
* @property {string} modifiedTime The last time the comment or any of its replies was modified (RFC 3339 date-time).
* @property {object} quotedFileContent The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
* @property {drive(v3).Reply[]} replies The full list of replies to the comment in chronological order.
* @property {boolean} resolved Whether the comment has been resolved by one of its replies.
*/
/**
* @typedef CommentList
* @memberOf! drive(v3)
* @type object
* @property {drive(v3).Comment[]} comments The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#commentList".
* @property {string} nextPageToken The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
*/
/**
* @typedef File
* @memberOf! drive(v3)
* @type object
* @property {object} appProperties A collection of arbitrary key-value pairs which are private to the requesting app.
Entries with null values are cleared in update and copy requests.
* @property {object} capabilities Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
* @property {object} contentHints Additional information about the content of the file. These fields are never populated in responses.
* @property {string} createdTime The time at which the file was created (RFC 3339 date-time).
* @property {string} description A short description of the file.
* @property {boolean} explicitlyTrashed Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
* @property {string} fileExtension The final component of fullFileExtension. This is only available for files with binary content in Drive.
* @property {string} folderColorRgb The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
If an unsupported color is specified, the closest color in the palette will be used instead.
* @property {string} fullFileExtension 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 Drive.
This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
* @property {boolean} hasAugmentedPermissions Whether any users are granted file access directly on this file. This field is only populated for Team Drive files.
* @property {boolean} hasThumbnail Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
* @property {string} headRevisionId The ID of the file's head revision. This is currently only available for files with binary content in Drive.
* @property {string} iconLink A static, unauthenticated link to the file's icon.
* @property {string} id The ID of the file.
* @property {object} imageMediaMetadata Additional metadata about image media, if available.
* @property {boolean} isAppAuthorized Whether the file was created or opened by the requesting app.
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#file".
* @property {drive(v3).User} lastModifyingUser The last user to modify the file.
* @property {string} md5Checksum The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
* @property {string} mimeType The MIME type of the file.
Drive will attempt 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 will be imported if possible. The supported import formats are published in the About resource.
* @property {boolean} modifiedByMe Whether the file has been modified by this user.
* @property {string} modifiedByMeTime The last time the file was modified by the user (RFC 3339 date-time).
* @property {string} modifiedTime The last time the file was modified by anyone (RFC 3339 date-time).
Note that setting modifiedTime will also update modifiedByMeTime for the user.
* @property {string} name The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant.
* @property {string} originalFilename 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 Drive.
* @property {boolean} ownedByMe Whether the user owns the file. Not populated for Team Drive files.
* @property {drive(v3).User[]} owners The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for Team Drive files.
* @property {string[]} parents The IDs of the parent folders which contain the file.
If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
* @property {string[]} permissionIds List of permission IDs for users with access to this file.
* @property {drive(v3).Permission[]} permissions The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for Team Drive files.
* @property {object} properties A collection of arbitrary key-value pairs which are visible to all apps.
Entries with null values are cleared in update and copy requests.
* @property {string} quotaBytesUsed The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
* @property {boolean} shared Whether the file has been shared. Not populated for Team Drive files.
* @property {string} sharedWithMeTime The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
* @property {drive(v3).User} sharingUser The user who shared the file with the requesting user, if applicable.
* @property {string} size The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
* @property {string[]} spaces The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
* @property {boolean} starred Whether the user has starred the file.
* @property {string} teamDriveId ID of the Team Drive the file resides in.
* @property {string} thumbnailLink A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
* @property {string} thumbnailVersion The thumbnail version for use in thumbnail cache invalidation.
* @property {boolean} trashed Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
* @property {string} trashedTime The time that the item was trashed (RFC 3339 date-time). Only populated for Team Drive files.
* @property {drive(v3).User} trashingUser If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files.
* @property {string} version A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
* @property {object} videoMediaMetadata Additional metadata about video media. This may not be available immediately upon upload.
* @property {boolean} viewedByMe Whether the file has been viewed by this user.
* @property {string} viewedByMeTime The last time the file was viewed by the user (RFC 3339 date-time).
* @property {boolean} viewersCanCopyContent Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
* @property {string} webContentLink A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
* @property {string} webViewLink A link for opening the file in a relevant Google editor or viewer in a browser.
* @property {boolean} writersCanShare Whether users with only writer permission can modify the file's permissions. Not populated for Team Drive files.
*/
/**
* @typedef FileList
* @memberOf! drive(v3)
* @type object
* @property {drive(v3).File[]} files The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
* @property {boolean} incompleteSearch Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple Team Drives with the "user,allTeamDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "user" or "teamDrive".
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#fileList".
* @property {string} nextPageToken The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
*/
/**
* @typedef GeneratedIds
* @memberOf! drive(v3)
* @type object
* @property {string[]} ids The IDs generated for the requesting user in the specified space.
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#generatedIds".
* @property {string} space The type of file that can be created with these IDs.
*/
/**
* @typedef Permission
* @memberOf! drive(v3)
* @type object
* @property {boolean} allowFileDiscovery Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
* @property {boolean} deleted Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
* @property {string} displayName A displayable name for users, groups or domains.
* @property {string} domain The domain to which this permission refers.
* @property {string} emailAddress The email address of the user or group to which this permission refers.
* @property {string} expirationTime The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
- They can only be set on user and group permissions
- The time must be in the future
- The time cannot be more than a year in the future
* @property {string} id The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#permission".
* @property {string} photoLink A link to the user's profile photo, if available.
* @property {string} role The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
- organizer
- owner
- writer
- commenter
- reader
* @property {object[]} teamDrivePermissionDetails Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items.
* @property {string} type The type of the grantee. Valid values are:
- user
- group
- domain
- anyone
*/
/**
* @typedef PermissionList
* @memberOf! drive(v3)
* @type object
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#permissionList".
* @property {string} nextPageToken The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
* @property {drive(v3).Permission[]} permissions The list of permissions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
*/
/**
* @typedef Reply
* @memberOf! drive(v3)
* @type object
* @property {string} action The action the reply performed to the parent comment. Valid values are:
- resolve
- reopen
* @property {drive(v3).User} author The user who created the reply.
* @property {string} content The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
* @property {string} createdTime The time at which the reply was created (RFC 3339 date-time).
* @property {boolean} deleted Whether the reply has been deleted. A deleted reply has no content.
* @property {string} htmlContent The content of the reply with HTML formatting.
* @property {string} id The ID of the reply.
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#reply".
* @property {string} modifiedTime The last time the reply was modified (RFC 3339 date-time).
*/
/**
* @typedef ReplyList
* @memberOf! drive(v3)
* @type object
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#replyList".
* @property {string} nextPageToken The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
* @property {drive(v3).Reply[]} replies The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
*/
/**
* @typedef Revision
* @memberOf! drive(v3)
* @type object
* @property {string} id The ID of the revision.
* @property {boolean} keepForever Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
This field is only applicable to files with binary content in Drive.
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#revision".
* @property {drive(v3).User} lastModifyingUser The last user to modify this revision.
* @property {string} md5Checksum The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
* @property {string} mimeType The MIME type of the revision.
* @property {string} modifiedTime The last time the revision was modified (RFC 3339 date-time).
* @property {string} originalFilename The original filename used to create this revision. This is only applicable to files with binary content in Drive.
* @property {boolean} publishAuto Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
* @property {boolean} published Whether this revision is published. This is only applicable to Google Docs.
* @property {boolean} publishedOutsideDomain Whether this revision is published outside the domain. This is only applicable to Google Docs.
* @property {string} size The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
*/
/**
* @typedef RevisionList
* @memberOf! drive(v3)
* @type object
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#revisionList".
* @property {string} nextPageToken The page token for the next page of revisions. This will be absent if the end of the revisions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
* @property {drive(v3).Revision[]} revisions The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
*/
/**
* @typedef StartPageToken
* @memberOf! drive(v3)
* @type object
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken".
* @property {string} startPageToken The starting page token for listing changes.
*/
/**
* @typedef TeamDrive
* @memberOf! drive(v3)
* @type object
* @property {object} backgroundImageFile An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.
* @property {string} backgroundImageLink A short-lived link to this Team Drive's background image.
* @property {object} capabilities Capabilities the current user has on this Team Drive.
* @property {string} colorRgb The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId.
* @property {string} id The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive".
* @property {string} name The name of this Team Drive.
* @property {string} themeId The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.
*/
/**
* @typedef TeamDriveList
* @memberOf! drive(v3)
* @type object
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#teamDriveList".
* @property {string} nextPageToken The page token for the next page of Team Drives. This will be absent if the end of the Team Drives list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
* @property {drive(v3).TeamDrive[]} teamDrives The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
*/
/**
* @typedef User
* @memberOf! drive(v3)
* @type object
* @property {string} displayName A plain text displayable name for this user.
* @property {string} emailAddress The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
* @property {string} kind Identifies what kind of resource this is. Value: the fixed string "drive#user".
* @property {boolean} me Whether this user is the requesting user.
* @property {string} permissionId The user's ID as visible in Permission resources.
* @property {string} photoLink A link to the user's profile photo, if available.
*/
export = Drive;