on-demand release 4.0dev+
[moodle.git] / payment / amd / src / repository.js
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/>.
16 /**
17  * Repository for payment subsystem.
18  *
19  * @module     core_payment/repository
20  * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
24 import Ajax from 'core/ajax';
26 /**
27  * @typedef {Object} PaymentGateway A Payment Gateway
28  * @property {string} shortname
29  * @property {string} name
30  * @property {string} description
31  */
33 /**
34  * Returns the list of gateways that can process payments in the given currency.
35  *
36  * @method getAvailableGateways
37  * @param {string} component
38  * @param {string} paymentArea
39  * @param {number} itemId
40  * @returns {Promise<PaymentGateway[]>}
41  */
42 export const getAvailableGateways = (component, paymentArea, itemId) => {
43     const request = {
44         methodname: 'core_payment_get_available_gateways',
45         args: {
46             component,
47             paymentarea: paymentArea,
48             itemid: itemId,
49         }
50     };
51     return Ajax.call([request])[0];
52 };