<?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/>.
/**
 * Chat external functions and service definitions.
 *
 * @package    tool_dataprivacy
 * @category   external
 * @copyright  2018 Jun Pataleta <jun@moodle.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
defined('MOODLE_INTERNAL') || die;
$functions = [
    'tool_dataprivacy_cancel_data_request' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'cancel_data_request',
        'classpath'     => '',
        'description'   => 'Cancel the data request made by the user',
        'type'          => 'write',
        'capabilities'  => '',
        'ajax'          => true,
        'loginrequired' => true,
        'services'      => [MOODLE_OFFICIAL_MOBILE_SERVICE],
    ],
    'tool_dataprivacy_contact_dpo' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'contact_dpo',
        'classpath'     => '',
        'description'   => 'Contact the site Data Protection Officer(s)',
        'type'          => 'write',
        'capabilities'  => '',
        'ajax'          => true,
        'loginrequired' => true,
        'services'      => [MOODLE_OFFICIAL_MOBILE_SERVICE],
    ],
    'tool_dataprivacy_mark_complete' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'mark_complete',
        'classpath'     => '',
        'description'   => 'Mark a user\'s general enquiry as complete',
        'type'          => 'write',
        'capabilities'  => 'tool/dataprivacy:managedatarequests',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_get_data_request' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'get_data_request',
        'classpath'     => '',
        'description'   => 'Fetch the details of a user\'s data request',
        'type'          => 'read',
        'capabilities'  => 'tool/dataprivacy:managedatarequests',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_approve_data_request' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'approve_data_request',
        'classpath'     => '',
        'description'   => 'Approve a data request',
        'type'          => 'write',
        'capabilities'  => 'tool/dataprivacy:managedatarequests',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_submit_selected_courses_form' => [
        'classname'     => 'tool_dataprivacy\external\submit_selected_courses_form',
        'description'   => 'Save list of selected courses for export',
        'type'          => 'write',
        'capabilities'  => 'tool/dataprivacy:managedatarequests',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_bulk_approve_data_requests' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'bulk_approve_data_requests',
        'classpath'     => '',
        'description'   => 'Bulk approve data requests',
        'type'          => 'write',
        'capabilities'  => 'tool/dataprivacy:managedatarequests',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_deny_data_request' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'deny_data_request',
        'classpath'     => '',
        'description'   => 'Deny a data request',
        'type'          => 'write',
        'capabilities'  => 'tool/dataprivacy:managedatarequests',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_bulk_deny_data_requests' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'bulk_deny_data_requests',
        'classpath'     => '',
        'description'   => 'Bulk deny data requests',
        'type'          => 'write',
        'capabilities'  => 'tool/dataprivacy:managedatarequests',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_get_users' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'get_users',
        'classpath'     => '',
        'description'   => 'Fetches a list of users',
        'type'          => 'read',
        'capabilities'  => 'tool/dataprivacy:managedatarequests',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_create_purpose_form' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'create_purpose_form',
        'classpath'     => '',
        'description'   => 'Adds a data purpose',
        'type'          => 'write',
        'capabilities'  => '',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_create_category_form' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'create_category_form',
        'classpath'     => '',
        'description'   => 'Adds a data category',
        'type'          => 'write',
        'capabilities'  => '',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_delete_purpose' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'delete_purpose',
        'classpath'     => '',
        'description'   => 'Deletes an existing data purpose',
        'type'          => 'write',
        'capabilities'  => '',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_delete_category' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'delete_category',
        'classpath'     => '',
        'description'   => 'Deletes an existing data category',
        'type'          => 'write',
        'capabilities'  => '',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_set_contextlevel_form' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'set_contextlevel_form',
        'classpath'     => '',
        'description'   => 'Sets purpose and category across a context level',
        'type'          => 'write',
        'capabilities'  => '',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_set_context_form' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'set_context_form',
        'classpath'     => '',
        'description'   => 'Sets purpose and category for a specific context',
        'type'          => 'write',
        'capabilities'  => '',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_tree_extra_branches' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'tree_extra_branches',
        'classpath'     => '',
        'description'   => 'Return branches for the context tree',
        'type'          => 'write',
        'capabilities'  => '',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_confirm_contexts_for_deletion' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'confirm_contexts_for_deletion',
        'classpath'     => '',
        'description'   => 'Mark the selected expired contexts as confirmed for deletion',
        'type'          => 'write',
        'capabilities'  => '',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_set_context_defaults' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'set_context_defaults',
        'classpath'     => '',
        'description'   => 'Updates the default category and purpose for a given context level (and optionally, a plugin)',
        'type'          => 'write',
        'capabilities'  => 'tool/dataprivacy:managedataregistry',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_get_category_options' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'get_category_options',
        'classpath'     => '',
        'description'   => 'Fetches a list of data category options',
        'type'          => 'read',
        'capabilities'  => 'tool/dataprivacy:managedataregistry',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_get_purpose_options' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'get_purpose_options',
        'classpath'     => '',
        'description'   => 'Fetches a list of data storage purpose options',
        'type'          => 'read',
        'capabilities'  => 'tool/dataprivacy:managedataregistry',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_get_activity_options' => [
        'classname'     => 'tool_dataprivacy\external',
        'methodname'    => 'get_activity_options',
        'classpath'     => '',
        'description'   => 'Fetches a list of activity options',
        'type'          => 'read',
        'capabilities'  => 'tool/dataprivacy:managedataregistry',
        'ajax'          => true,
        'loginrequired' => true,
    ],
    'tool_dataprivacy_get_access_information' => [
        'classname'     => '\tool_dataprivacy\external\get_access_information',
        'description'   => 'Retrieving privacy API access (permissions) information for the current user.',
        'type'          => 'read',
        'services'      => [MOODLE_OFFICIAL_MOBILE_SERVICE],
    ],
    'tool_dataprivacy_create_data_request' => [
        'classname'     => '\tool_dataprivacy\external\create_data_request',
        'description'   => 'Creates a data request.',
        'type'          => 'write',
        'services'      => [MOODLE_OFFICIAL_MOBILE_SERVICE],
    ],
    'tool_dataprivacy_get_data_requests' => [
        'classname'     => '\tool_dataprivacy\external\get_data_requests',
        'description'   => 'Gets data request.',
        'type'          => 'read',
        'services'      => [MOODLE_OFFICIAL_MOBILE_SERVICE],
    ],
];