@yosle/tropipayjs 0.1.7 → 0.1.9

package/index.js

@@ -1,223 +1,282 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var axios = require('axios');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
-
-/**
- * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
- *
- * @author Yosleivy Baez Acosta
- *
- */
-class Tropipay {
-    clientId;
-    clientSecret;
-    request;
-    accessToken;
-    refreshToken;
-    serverMode;
-    constructor(client_id, client_secret, server_mode = 'Development') {
-        this.clientId = client_id;
-        this.clientSecret = client_secret;
-        this.serverMode = server_mode;
-        this.request = axios__default["default"].create({
-            baseURL: this.serverMode === 'Production'
-                ? 'https://www.tropipay.com'
-                : 'https://tropipay-dev.herokuapp.com',
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-                Authorization: `Bearer ${this.accessToken}`,
-            }
-        });
-    }
-    async login() {
-        try {
-            const { data } = await this.request.post('/api/v2/access/token', {
-                client_id: this.clientId,
-                client_secret: this.clientSecret,
-                grant_type: "client_credentials",
-                scope: "ALLOW_GET_PROFILE_DATA ALLOW_PAYMENT_IN ALLOW_EXTERNAL_CHARGE KYC3_FULL_ALLOW ALLOW_PAYMENT_OUT ALLOW_MARKET_PURCHASES ALLOW_GET_BALANCE ALLOW_GET_MOVEMENT_LIST ALLOW_GET_CREDENTIAL"
-            }, {
-            // headers: {
-            //     'Content-Type': 'application/json',
-            //     Accept: 'application/json',
-            // }
-            });
-            this.accessToken = data.access_token;
-            this.refreshToken = data.refresh_token;
-            return data;
-        }
-        catch (error) {
-            if (axios__default["default"].isAxiosError(error)) {
-                throw new Error(`Could not obtain the access token from credentials  ${error}`);
-            }
-            throw new Error(`Could not obtain the access token from credentials  ${error}`);
-        }
-    }
-    /**
-     * Create a paymentLink with the specified options.
-     * @param payload PaymentLinkPayload Object.
-     * @returns Promise<PaymentLink> or throws an Exception.
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6ODgyNTM3OQ-create-a-new-pay-link-charge
-     */
-    async createPayLink(payload) {
-        if (!this.accessToken) {
-            await this.login();
-        }
-        try {
-            const paylink = await this.request.post('/api/v2/paymentcards', payload, {
-                headers: {
-                    // 'Content-Type': 'application/json',
-                    Authorization: `Bearer ${this.accessToken}`,
-                    // Accept: 'application/json'
-                }
-            });
-            return paylink.data;
-        }
-        catch (error) {
-            throw new Error(`Could not obtain the access token with the given credentials.`);
-        }
-    }
-    /**
-     * Get all deposits in this account.
-     * @returns A Promise of an Array of AccountDeposits or throws an Exception
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6OTgyOTQ1Mg-get-deposit-accounts-list
-     */
-    async getDepositAccounts() {
-        if (!this.accessToken) {
-            await this.login();
-        }
-        try {
-            const deposits = await this.request.get('/api/v2/deposit_accounts', {});
-            return deposits.data;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve the account deposits ${error}`);
-        }
-    }
-    /**
-     * Get the list of all supported countries by Tropipay.
-     * @returns Array of Countries Data
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/bfac21259e2ff-getting-users-countries-list
-     */
-    async countries() {
-        try {
-            const countries = await this.request.get('/api/v2/countries');
-            return countries.data;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve the countries list`);
-        }
-    }
-    /**
-     * Get the list of all detination countries supported by Tropipay.
-     * Obtaining the list of valid countries to send funds to. Useful
-     * when adding new beneficiaries to some user.
-     *
-     * @returns Array of Country Objects
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/3cfe5504f0524-getting-list-of-beneficiary-countries
-     */
-    async destinations() {
-        try {
-            const countries = await this.request.get('/api/v2/countries/destinations');
-            return countries.data;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve the destination countries list`);
-        }
-    }
-    /**
-     * Get list of all the favorites accounts. This endpoint is not documented
-     * in the official Tropipay documentation.
-     * @returns
-     */
-    async favorites() {
-        if (!this.accessToken) {
-            await this.login();
-        }
-        try {
-            const favoritesList = await this.request.get('/api/v2/paymentcards/favorites');
-            console.log(favoritesList);
-            return favoritesList.data;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve favorites list ${error}`);
-        }
-    }
-    /**
-     * List all account movements. You can optionaly specify
-     * offset and limit params for pagination.
-     * @returns
-     */
-    async movements(offset = 0, limit = 10) {
-        if (!this.accessToken) {
-            await this.login();
-        }
-        try {
-            const movements = await this.request.get('/api/v2/movements', { params: { limit: limit, offset: offset },
-                headers: {
-                    'Content-Type': 'application/json',
-                    Accept: 'application/json',
-                    Authorization: `Bearer ${this.accessToken}`,
-                } });
-            return movements.data;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve movements list`);
-        }
-    }
-    /**
-     * Return profile data for this account.
-     * @returns
-     */
-    async profile() {
-        if (!this.accessToken) {
-            await this.login();
-        }
-        try {
-            const profile = await this.request.get('/api/users/profile');
-            return profile.data;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve movements list ${error}`);
-        }
-    }
-    /**
-     * Obtain current Tropipay conversion rate. For example USD to EUR
-     * targetCurrency must be 'EUR'
-     * @param originCurrency Target currency code supported by Tropipay.
-     * @param targetCurrency Must be 'EUR'? (not documented by Tropipay)
-     * @returns Conversion rate (number)
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/85163f6f28b23-get-rate
-     */
-    async rates(originCurrency, targetCurrency = 'EUR') {
-        if (!this.accessToken) {
-            await this.login();
-        }
-        try {
-            const rates = await this.request.post('/api/v2/movements/get_rate', {
-                currencyFrom: originCurrency,
-                currencyTo: targetCurrency
-            }, {
-                headers: {
-                    'Content-Type': 'application/json',
-                    Accept: 'application/json',
-                    Authorization: `Bearer ${this.accessToken}`,
-                }
-            });
-            return rates.data.rate;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve rates ${error}`);
-        }
-    }
-}
-
-exports.Tropipay = Tropipay;
-//# sourceMappingURL=index.js.map
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var axios = require('axios');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
+
+/**
+ * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
+ *
+ * @author Yosleivy Baez Acosta
+ *
+ */
+class Tropipay {
+    clientId;
+    clientSecret;
+    request;
+    static accessToken;
+    static refreshToken;
+    serverMode;
+    constructor(config) {
+        this.clientId = config.clientId;
+        this.clientSecret = config.clientSecret;
+        this.serverMode = config.serverMode || 'Development';
+        this.request = axios__default["default"].create({
+            baseURL: this.serverMode === 'Production'
+                ? 'https://www.tropipay.com'
+                : 'https://tropipay-dev.herokuapp.com',
+            headers: {
+                'Content-Type': 'application/json',
+                Accept: 'application/json',
+                Authorization: `Bearer ${Tropipay.accessToken}`,
+            }
+        });
+    }
+    async login() {
+        try {
+            const { data } = await this.request.post('/api/v2/access/token', {
+                client_id: this.clientId,
+                client_secret: this.clientSecret,
+                grant_type: "client_credentials",
+                scope: "ALLOW_GET_PROFILE_DATA ALLOW_PAYMENT_IN ALLOW_EXTERNAL_CHARGE KYC3_FULL_ALLOW ALLOW_PAYMENT_OUT ALLOW_MARKET_PURCHASES ALLOW_GET_BALANCE ALLOW_GET_MOVEMENT_LIST ALLOW_GET_CREDENTIAL"
+            }, {
+                headers: {
+                    'Content-Type': 'application/json',
+                    Accept: 'application/json',
+                }
+            });
+            Tropipay.accessToken = data.access_token;
+            Tropipay.refreshToken = data.refresh_token;
+            return data;
+        }
+        catch (error) {
+            if (axios__default["default"].isAxiosError(error)) {
+                throw new Error(`Could not obtain the access token from credentials  ${error}`);
+            }
+            throw new Error(`Could not obtain the access token from credentials  ${error}`);
+        }
+    }
+    /**
+     * Create a paymentLink with the specified options.
+     * @param payload PaymentLinkPayload Object.
+     * @returns Promise<PaymentLink> or throws an Exception.
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6ODgyNTM3OQ-create-a-new-pay-link-charge
+     */
+    async createPaymentCard(payload) {
+        if (!Tropipay.accessToken) {
+            await this.login();
+        }
+        try {
+            const paylink = await this.request.post('/api/v2/paymentcards', payload, {
+                headers: {
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: 'application/json'
+                }
+            });
+            return paylink.data;
+        }
+        catch (error) {
+            throw new Error(`Could not obtain the access token with the given credentials.`);
+        }
+    }
+    /**
+     * Get all deposits in this account.
+     * @returns A Promise of an Array of AccountDeposits or throws an Exception
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6OTgyOTQ1Mg-get-deposit-accounts-list
+     */
+    async getDepositAccounts() {
+        if (!Tropipay.accessToken) {
+            await this.login();
+        }
+        try {
+            const deposits = await this.request.get('/api/v2/deposit_accounts', {
+                headers: {
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: 'application/json'
+                }
+            });
+            return deposits.data;
+        }
+        catch (error) {
+            throw new Error(`Could not retrieve the account deposits ${error}`);
+        }
+    }
+    /**
+     * Get the list of all supported countries by Tropipay.
+     * @returns Array of Countries Data
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/bfac21259e2ff-getting-users-countries-list
+     */
+    async countries() {
+        try {
+            const countries = await this.request.get('/api/v2/countries');
+            return countries.data;
+        }
+        catch (error) {
+            throw new Error(`TropipayJS Error - Could not retrieve the countries list`);
+        }
+    }
+    /**
+     * Get user balance
+     * @returns balance object
+     */
+    async getBalance() {
+        if (!Tropipay.accessToken) {
+            await this.login();
+        }
+        try {
+            const balance = await this.request.get('/api/v2/users/balance', {
+                headers: {
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: 'application/json'
+                }
+            });
+            return balance.data;
+        }
+        catch (error) {
+            console.log("el error es ", error);
+            throw new Error(`TropipayJS Error - Could not retrieve the user's balance`);
+        }
+    }
+    /**
+     * Get the list of all detination countries supported by Tropipay.
+     * Obtaining the list of valid countries to send funds to. Useful
+     * when adding new beneficiaries to some user.
+     *
+     * @returns Array of Country Objects
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/3cfe5504f0524-getting-list-of-beneficiary-countries
+     */
+    async destinations() {
+        try {
+            const countries = await this.request.get('/api/v2/countries/destinations');
+            return countries.data;
+        }
+        catch (error) {
+            throw new Error(`Could not retrieve the destination countries list`);
+        }
+    }
+    /**
+     * Get list of all the favorites payment links.
+     * @returns Array of account Object or throws an error
+     */
+    async favorites() {
+        if (!Tropipay.accessToken) {
+            await this.login();
+        }
+        try {
+            const favoritesList = await this.request.get('/api/v2/paymentcards/favorites', {
+                headers: {
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: 'application/json'
+                }
+            });
+            return favoritesList?.data?.rows;
+        }
+        catch (error) {
+            throw new Error(`Could not retrieve favorites list ${error}`);
+        }
+    }
+    /**
+     * List all account movements. You can optionaly specify
+     * offset and limit params for pagination.
+     * @returns
+     */
+    async movements(offset = 0, limit = 10) {
+        if (!Tropipay.accessToken)
+            await this.login();
+        try {
+            const movements = await this.request.get('/api/v2/movements', {
+                params: { limit: limit, offset: offset },
+                headers: {
+                    'Content-Type': 'application/json',
+                    Accept: 'application/json',
+                    Authorization: `Bearer ${Tropipay.accessToken}`
+                }
+            });
+            return movements.data;
+        }
+        catch (error) {
+            throw new Error(`Could not retrieve movements list ${error}`);
+        }
+    }
+    /**
+     * Return profile data for this account.
+     * @returns
+     */
+    async profile() {
+        if (!Tropipay.accessToken)
+            await this.login();
+        try {
+            const profile = await this.request.get('/api/users/profile');
+            return profile.data;
+        }
+        catch (error) {
+            throw new Error(`Could not retrieve movements list ${error}`);
+        }
+    }
+    /**
+     * Obtain current Tropipay conversion rate. For example USD to EUR
+     * targetCurrency must be 'EUR'
+     * @param originCurrency Target currency code supported by Tropipay.
+     * @param targetCurrency Must be 'EUR'? (not documented by Tropipay)
+     * @returns Conversion rate (number)
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/85163f6f28b23-get-rate
+     */
+    async rates(originCurrency, targetCurrency = 'EUR') {
+        if (!Tropipay.accessToken) {
+            await this.login();
+        }
+        try {
+            const rates = await this.request.post('/api/v2/movements/get_rate', {
+                currencyFrom: originCurrency,
+                currencyTo: targetCurrency
+            }, {
+                headers: {
+                    'Content-Type': 'application/json',
+                    Accept: 'application/json',
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                }
+            });
+            return rates.data.rate;
+        }
+        catch (error) {
+            throw new Error(`Could not retrieve rates ${error}`);
+        }
+    }
+    /**
+     * (ONLY in Bussiness Accounts)
+     * An escrow payment link. This allows a payment to be made to persons
+     * belonging or not to the TropiPay platform with the particularity
+     * that the payment will be held in custody or retained until it is
+     * released with the approval of the payer.
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/12a128ff971e4-creating-a-mediation-payment-card
+     * @param config Payload with the payment details
+     */
+    async createMediationPaymentCard(config) {
+        if (!Tropipay.accessToken)
+            await this.login();
+        try {
+            const mediation = await this.request.post('/api/v2/paymentcards/mediation', config, {
+                headers: {
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: 'application/json'
+                }
+            });
+            return mediation.data;
+        }
+        catch (error) {
+            throw new Error(`Could not generate mediation paymentCard ${error}`);
+        }
+    }
+}
+
+exports.Tropipay = Tropipay;
+//# sourceMappingURL=index.js.map

package/interfaces/countries/index.d.ts

@@ -1 +1 @@
-export declare type TropipayCountry = {};
+export type TropipayCountry = {};

package/interfaces/index.d.ts

@@ -1,2 +1,2 @@
-import * as countries from './countries';
-export { countries };
+import * as countries from './countries';
+export { countries };

package/interfaces/mediation/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ *
+ */
+export interface mediationPaymentCardConfig {
+    amount: number;
+    currency: "EUR" | "USD";
+    concept: string;
+    description: string;
+    reference: string;
+    singleUse: boolean;
+    lang: string;
+    productUrl?: string;
+    buyer: null | any;
+    seller: {
+        sellerId?: number;
+        type?: number;
+        email?: string;
+    };
+    feePercent?: number;
+    feeFixed?: number;
+    sendMail: boolean;
+}

package/interfaces/paymentlink/index.d.ts

@@ -1,36 +1,36 @@
-export interface PaymentLinkPayload {
-    reference: string;
-    concept: string;
-    favorite: boolean;
-    amount: number;
-    currency: string;
-    description: string;
-    singleUse: boolean;
-    reasonId: number;
-    expirationDays: number;
-    lang: string;
-    urlSuccess: string;
-    urlFailed: string;
-    urlNotification: string;
-    serviceDate: string;
-    client: {
-        name: string;
-        lastName: string;
-        address: string;
-        phone: string;
-        email: string;
-        countryId: number;
-        termsAndConditions: boolean;
-    };
-    directPayment: boolean;
-    paymentMethods?: string[];
-}
-export interface PaymentLink extends PaymentLinkPayload {
-    expirationDate: string;
-    hasClient: boolean;
-    updatedAt: string;
-    createdAt: string;
-    qrImage: string;
-    shortUrl: string;
-    paymentUrl: string;
-}
+export interface PaymentLinkPayload {
+    reference: string;
+    concept: string;
+    favorite: boolean;
+    amount: number;
+    currency: string;
+    description: string;
+    singleUse: boolean;
+    reasonId: number;
+    expirationDays: number;
+    lang: string;
+    urlSuccess: string;
+    urlFailed: string;
+    urlNotification: string;
+    serviceDate: string;
+    client: {
+        name: string;
+        lastName: string;
+        address: string;
+        phone: string;
+        email: string;
+        countryId: number;
+        termsAndConditions: boolean;
+    };
+    directPayment: boolean;
+    paymentMethods?: string[];
+}
+export interface PaymentLink extends PaymentLinkPayload {
+    expirationDate: string;
+    hasClient: boolean;
+    updatedAt: string;
+    createdAt: string;
+    qrImage: string;
+    shortUrl: string;
+    paymentUrl: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yosle/tropipayjs",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "Javascript / Typescript SDK for the Tropipay API",
   "main": "index.js",
   "scripts": {
@@ -8,7 +8,7 @@
     "_clear": "rimraf src/dist/*",
     "_tsc": "tsc",
     "_make-bundle": "rollup --config",
-    "build": "run-s _clear _tsc _make-bundle"
+    "build": "yarn _clear && yarn _tsc && yarn _make-bundle"
   },
   "repository": {
     "type": "git",
@@ -33,7 +33,8 @@
     "rimraf": "^3.0.2",
     "rollup": "^2.79.1",
     "rollup-plugin-dts": "^4.2.2",
-    "run-s": "^0.0.0"
+    "run-s": "^0.0.0",
+    "typescript": "^5.0.4"
   },
   "funding": {
     "type": "individual",