<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Google Drive Rest API.
*
* @package repository_googledocs
* @copyright 2017 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace repository_googledocs;
defined('MOODLE_INTERNAL') || die();
/**
* Google Drive Rest API.
*
* @copyright 2017 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class rest extends \core\oauth2\rest {
/**
* Define the functions of the rest API.
*
* @return array Example:
* [ 'listFiles' => [ 'method' => 'get', 'endpoint' => 'http://...', 'args' => [ 'folder' => PARAM_STRING ] ] ]
*/
public function get_api_functions() {
return [
'list' => [
'endpoint' => 'https://www.googleapis.com/drive/v3/files',
'method' => 'get',
'args' => [
'corpus' => PARAM_RAW,
'orderBy' => PARAM_RAW,
'fields' => PARAM_RAW,
'pageSize' => PARAM_INT,
'pageToken' => PARAM_RAW,
'q' => PARAM_RAW,
< 'spaces' => PARAM_RAW
> 'spaces' => PARAM_RAW,
> 'supportsAllDrives' => PARAM_RAW,
> 'includeItemsFromAllDrives' => PARAM_RAW,
> 'corpora' => PARAM_RAW
],
'response' => 'json'
],
'get' => [
'endpoint' => 'https://www.googleapis.com/drive/v3/files/{fileid}',
'method' => 'get',
'args' => [
'fields' => PARAM_RAW,
'fileid' => PARAM_RAW
],
'response' => 'json'
],
'copy' => [
'endpoint' => 'https://www.googleapis.com/drive/v3/files/{fileid}/copy',
'method' => 'post',
'args' => [
'fields' => PARAM_RAW,
'fileid' => PARAM_RAW
],
'response' => 'json'
],
'delete' => [
'endpoint' => 'https://www.googleapis.com/drive/v3/files/{fileid}',
'method' => 'delete',
'args' => [
'fileid' => PARAM_RAW
],
'response' => 'json'
],
'create' => [
'endpoint' => 'https://www.googleapis.com/drive/v3/files',
'method' => 'post',
'args' => [
'fields' => PARAM_RAW
],
'response' => 'json'
],
'update' => [
'endpoint' => 'https://www.googleapis.com/drive/v3/files/{fileid}',
'method' => 'patch',
'args' => [
'fileid' => PARAM_RAW,
'fields' => PARAM_RAW,
'addParents' => PARAM_RAW,
'removeParents' => PARAM_RAW
],
'response' => 'json'
],
'create_permission' => [
'endpoint' => 'https://www.googleapis.com/drive/v3/files/{fileid}/permissions',
'method' => 'post',
'args' => [
'fileid' => PARAM_RAW,
'emailMessage' => PARAM_RAW,
'sendNotificationEmail' => PARAM_RAW,
'transferOwnership' => PARAM_RAW,
],
'response' => 'json'
],
'update_permission' => [
'endpoint' => 'https://www.googleapis.com/drive/v3/files/{fileid}/permissions/{permissionid}',
'method' => 'patch',
'args' => [
'fileid' => PARAM_RAW,
'permissionid' => PARAM_RAW,
'emailMessage' => PARAM_RAW,
'sendNotificationEmail' => PARAM_RAW,
'transferOwnership' => PARAM_RAW,
],
'response' => 'json'
> ],
],
> 'shared_drives_list' => [
];
> 'endpoint' => 'https://www.googleapis.com/drive/v3/drives',
}
> 'method' => 'get',
}
> 'args' => [
> 'pageSize' => PARAM_INT,
> 'pageToken' => PARAM_RAW,
> 'q' => PARAM_RAW,
> 'useDomainAdminAccess' => PARAM_RAW,
> ],
> 'response' => 'json',