MDL-69166 core_payment: Use promises instead of callbacks
[moodle.git] / payment / gateway / paypal / 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  * PayPal repository module to encapsulate all of the AJAX requests that can be sent for PayPal.
18  *
19  * @module     paygw_paypal/repository
20  * @package    paygw_paypal
21  * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 import Ajax from 'core/ajax';
27 /**
28  * Return the PayPal JavaScript SDK URL.
29  *
30  * @param {string} component Name of the component that the itemId belongs to
31  * @param {string} paymentArea The area of the component that the itemId belongs to
32  * @param {number} itemId An internal identifier that is used by the component
33  * @returns {Promise<{clientid: string, brandname: string, cost: number, currency: string}>}
34  */
35 export const getConfigForJs = (component, paymentArea, itemId) => {
36     const request = {
37         methodname: 'paygw_paypal_get_config_for_js',
38         args: {
39             component,
40             paymentarea: paymentArea,
41             itemid: itemId,
42         },
43     };
45     return Ajax.call([request])[0];
46 };
48 /**
49  * Call server to validate and capture payment for order.
50  *
51  * @param {string} component Name of the component that the itemId belongs to
52  * @param {string} paymentArea The area of the component that the itemId belongs to
53  * @param {number} itemId An internal identifier that is used by the component
54  * @param {string} orderId The order id coming back from PayPal
55  * @returns {*}
56  */
57 export const markTransactionComplete = (component, paymentArea, itemId, orderId) => {
58     const request = {
59         methodname: 'paygw_paypal_create_transaction_complete',
60         args: {
61             component,
62             paymentarea: paymentArea,
63             itemid: itemId,
64             orderid: orderId,
65         },
66     };
68     return Ajax.call([request])[0];
69 };