MDL-71113 js: Add jsdoc configuration and Grunt
[moodle.git] / payment / amd / src / repository.js
CommitLineData
e9de4309
SR
1// This file is part of Moodle - http://moodle.org/
2//
3// Moodle is free software: you can redistribute it and/or modify
4// it under the terms of the GNU General Public License as published by
5// the Free Software Foundation, either version 3 of the License, or
6// (at your option) any later version.
7//
8// Moodle is distributed in the hope that it will be useful,
9// but WITHOUT ANY WARRANTY; without even the implied warranty of
10// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11// GNU General Public License for more details.
12//
13// You should have received a copy of the GNU General Public License
14// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
15
16/**
17 * Repository for payment subsystem.
18 *
19 * @module core_payment/repository
20 * @package core_payment
21 * @copyright 2020 Shamim Rezaie <shamim@moodle.com>
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25import Ajax from 'core/ajax';
26
27/**
28 * Returns the list of gateways that can process payments in the given currency.
29 *
61766b3d
SR
30 * @param {string} component
31 * @param {string} paymentArea
d5a9d6e5 32 * @param {number} itemId
e9de4309
SR
33 * @returns {Promise<{shortname: string, name: string, description: String}[]>}
34 */
d5a9d6e5 35export const getAvailableGateways = (component, paymentArea, itemId) => {
e9de4309 36 const request = {
71ccaf20 37 methodname: 'core_payment_get_available_gateways',
e9de4309 38 args: {
1d479dc0 39 component,
61766b3d 40 paymentarea: paymentArea,
d5a9d6e5 41 itemid: itemId,
e9de4309
SR
42 }
43 };
44 return Ajax.call([request])[0];
45};