@yosle/tropipayjs 0.1.7 → 0.1.8

package/README.md

@@ -22,8 +22,13 @@ TropiPay is an electronic wallet that allows you to execute the most common fina
     - [Generating a Payment Link](#generating-a-payment-link)
 - [Contributing](#contributing)
 - [License](#license)
+
 ## About the project
-This library is a community effort still under development so use caution if you're planing to use it in production. Tropipay may make some changes on the API Specification in the future. Use the [test environment](https://tropipay-dev.herokuapp.com) to make sure everything is working as expected.
+This library is a community effort. Tropipay may make some changes on the API specification. Use the [test environment](https://tropipay-dev.herokuapp.com) to make sure everything is working as expected.
+
+**Note:** This library is provided as-is and serves as a client for the Tropipay API. While every effort has been made to ensure the accuracy and reliability of the library, Tropipay is solely responsible for maintaining and updating the API documentation. 
+
+The library is intended to simplify the integration process with Tropipay's services, but it is essential to consult the official documentation to ensure that you are using the API correctly and taking into account any recent changes or updates made by Tropipay.
 # Getting started
 You can use npm or yarn to install this package:
 

package/docs/index.MD

@@ -0,0 +1,19 @@
+# Tropipayjs
+
+Tropipayjs is a TypeScript/JavaScript library for the Tropipay API.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [API Reference](#api-reference)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+To use Tropipayjs in your project, you need to install it via npm. Run the following command:
+
+```npm install tropipayjs```
+or
+```yarn add tropipayjs```

package/index.d.ts

@@ -1,113 +1,150 @@
-import { Axios } from 'axios';
-
-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[];
-}
-interface PaymentLink extends PaymentLinkPayload {
-    expirationDate: string;
-    hasClient: boolean;
-    updatedAt: string;
-    createdAt: string;
-    qrImage: string;
-    shortUrl: string;
-    paymentUrl: string;
-}
-
-/**
- * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
- *
- * @author Yosleivy Baez Acosta
- *
- */
-
-declare type ServerMode = 'Development' | 'Production';
-declare class Tropipay {
-    readonly clientId: string;
-    readonly clientSecret: string;
-    protected request: Axios;
-    protected accessToken: string | undefined;
-    protected refreshToken: string | undefined;
-    protected serverMode: ServerMode;
-    constructor(client_id: string, client_secret: string, server_mode?: ServerMode);
-    login(): Promise<LoginResponse>;
-    /**
-     * 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
-     */
-    createPayLink(payload: PaymentLinkPayload): Promise<PaymentLink>;
-    /**
-     * 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
-     */
-    getDepositAccounts(): Promise<AccountDeposits[] | 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
-     */
-    countries(): Promise<Country[]>;
-    /**
-     * 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
-     */
-    destinations(): Promise<Country[]>;
-    /**
-     * Get list of all the favorites accounts. This endpoint is not documented
-     * in the official Tropipay documentation.
-     * @returns
-     */
-    favorites(): Promise<any>;
-    /**
-     * List all account movements. You can optionaly specify
-     * offset and limit params for pagination.
-     * @returns
-     */
-    movements(offset?: number, limit?: number): Promise<any>;
-    /**
-     * Return profile data for this account.
-     * @returns
-     */
-    profile(): Promise<any>;
-    /**
-     * 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
-     */
-    rates(originCurrency: string, targetCurrency?: string): Promise<number | Error>;
-}
-
-export { Tropipay };
+import { Axios } from 'axios';
+
+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[];
+}
+interface PaymentLink extends PaymentLinkPayload {
+    expirationDate: string;
+    hasClient: boolean;
+    updatedAt: string;
+    createdAt: string;
+    qrImage: string;
+    shortUrl: string;
+    paymentUrl: string;
+}
+
+/**
+ *
+ */
+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;
+}
+
+/**
+ * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
+ *
+ * @author Yosleivy Baez Acosta
+ *
+ */
+
+type ServerMode = 'Development' | 'Production';
+interface TropipayConfig {
+    clientId: string;
+    clientSecret: string;
+    serverMode?: ServerMode;
+}
+declare class Tropipay {
+    protected clientId: string;
+    protected clientSecret: string;
+    protected request: Axios;
+    protected static accessToken: string | undefined;
+    protected static refreshToken: string | undefined;
+    protected serverMode: ServerMode;
+    constructor(config: TropipayConfig);
+    login(): Promise<LoginResponse>;
+    /**
+     * 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
+     */
+    createPaymentCard(payload: PaymentLinkPayload): Promise<PaymentLink>;
+    /**
+     * 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
+     */
+    getDepositAccounts(): Promise<AccountDeposits[] | 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
+     */
+    countries(): Promise<Country[]>;
+    /**
+     * 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
+     */
+    destinations(): Promise<Country[]>;
+    /**
+     * Get list of all the favorites payment links.
+     * @returns Array of account Object or throws an error
+     */
+    favorites(): Promise<any>;
+    /**
+     * List all account movements. You can optionaly specify
+     * offset and limit params for pagination.
+     * @returns
+     */
+    movements(offset?: number, limit?: number): Promise<any>;
+    /**
+     * Return profile data for this account.
+     * @returns
+     */
+    profile(): Promise<any>;
+    /**
+     * 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
+     */
+    rates(originCurrency: string, targetCurrency?: string): Promise<number | 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
+     */
+    createMediationPaymentCard(config: mediationPaymentCardConfig): Promise<PaymentLink>;
+}
+
+export { Tropipay };

package/index.js

@@ -1,223 +1,259 @@
-'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 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.8",
   "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",

package/src/index.ts

@@ -7,27 +7,28 @@
 
 import axios, { Axios } from "axios";
 import { PaymentLink, PaymentLinkPayload } from './interfaces/paymentlink'
-
+import { mediationPaymentCardConfig } from "./interfaces/mediation";
 
 type ServerMode = 'Development' | 'Production'
 
+interface TropipayConfig {
+    clientId: string;
+    clientSecret: string;
+    serverMode?: ServerMode;
+}
 
 export class Tropipay {
-    readonly clientId: string;
-    readonly clientSecret: string;
+    protected clientId: string;
+    protected clientSecret: string;
     protected request: Axios;
-    protected accessToken: string | undefined;
-    protected refreshToken: string | undefined;
+    protected static accessToken: string | undefined;
+    protected static refreshToken: string | undefined;
     protected serverMode: ServerMode;
 
-    constructor(
-        client_id: string,
-        client_secret: string,
-        server_mode: ServerMode = 'Development') {
-        this.clientId = client_id;
-        this.clientSecret = client_secret
-        this.serverMode = server_mode
-
+    constructor(config: TropipayConfig) {
+        this.clientId = config.clientId;
+        this.clientSecret = config.clientSecret;
+        this.serverMode = config.serverMode || 'Development';
         this.request = axios.create({
             baseURL: this.serverMode === 'Production'
                 ? 'https://www.tropipay.com'
@@ -35,10 +36,9 @@ export class Tropipay {
             headers: {
                 'Content-Type': 'application/json',
                 Accept: 'application/json',
-                Authorization: `Bearer ${this.accessToken}`,
-
-            }   
-        })
+                Authorization: `Bearer ${Tropipay.accessToken}`,
+            }
+        });
     }
 
 
@@ -50,20 +50,20 @@ export class Tropipay {
                 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',
-                // }
-            })
+                headers: {
+                    'Content-Type': 'application/json',
+                    Accept: 'application/json',
+                }
+            });
 
-            this.accessToken = data.access_token
-            this.refreshToken = data.refresh_token
+            Tropipay.accessToken = data.access_token
+            Tropipay.refreshToken = data.refresh_token
             return data
         } catch (error) {
             if (axios.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}`);
+            }
+            throw new Error(`Could not obtain the access token from credentials  ${error}`);
 
         }
     }
@@ -74,22 +74,21 @@ export class Tropipay {
      * @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: PaymentLinkPayload): Promise<PaymentLink> {
-        if (!this.accessToken) {
+    async createPaymentCard(payload: PaymentLinkPayload): Promise<PaymentLink> {
+        if (!Tropipay.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'
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: 'application/json'
                 }
             })
             return paylink.data as PaymentLink
         } catch (error) {
             throw new Error(`Could not obtain the access token with the given credentials.`);
-
         }
     }
 
@@ -98,15 +97,21 @@ export class Tropipay {
      * @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(): Promise<AccountDeposits[] | Error>{
-        if (!this.accessToken) {
+    async getDepositAccounts(): Promise<AccountDeposits[] | Error> {
+        if (!Tropipay.accessToken) {
             await this.login()
         }
         try {
-            const deposits  = await this.request.get('/api/v2/deposit_accounts',{            }) 
+            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}`);    
+            throw new Error(`Could not retrieve the account deposits ${error}`);
         }
     }
 
@@ -115,17 +120,15 @@ export class Tropipay {
      * @returns Array of Countries Data
      * @see https://tpp.stoplight.io/docs/tropipay-api-doc/bfac21259e2ff-getting-users-countries-list
      */
-    async countries(): Promise<Country[] > {
-        
+    async countries(): Promise<Country[]> {
         try {
-            const countries  = await this.request.get('/api/v2/countries') 
+            const countries = await this.request.get('/api/v2/countries')
             return countries.data
         } catch (error) {
-            throw new Error(`Could not retrieve the countries list`);    
+            throw new Error(`TropipayJS 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
@@ -136,28 +139,32 @@ export class Tropipay {
      */
     async destinations(): Promise<Country[]> {
         try {
-            const countries  = await this.request.get('/api/v2/countries/destinations') 
+            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`);    
+            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 
+     * Get list of all the favorites payment links. 
+     * @returns Array of account Object or throws an error
      */
-    async favorites(){
-        if (!this.accessToken) {
+    async favorites() {
+        if (!Tropipay.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}`);    
+            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}`);
         }
     }
 
@@ -166,41 +173,39 @@ export class Tropipay {
      * 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}`,
+    async movements(offset = 0, limit = 10) {
+        if (!Tropipay.accessToken) await this.login()
 
-            } }) 
-            return movements.data 
+        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`);    
+            throw new Error(`Could not retrieve movements list ${error}`);
         }
-   
     }
 
     /**
      * Return profile data for this account.
      * @returns 
      */
-    async profile(){
-        if (!this.accessToken) {
-            await this.login()
-        }
+    async profile() {
+        if (!Tropipay.accessToken) await this.login();
         try {
-            const profile  = await this.request.get('/api/users/profile') 
-            return profile.data 
+            const profile = await this.request.get('/api/users/profile')
+            return profile.data
         } catch (error) {
-            throw new Error(`Could not retrieve movements list ${error}`);    
+            throw new Error(`Could not retrieve movements list ${error}`);
         }
     }
+
     /**
      * Obtain current Tropipay conversion rate. For example USD to EUR
      * targetCurrency must be 'EUR'
@@ -209,28 +214,56 @@ export class Tropipay {
      * @returns Conversion rate (number)
      * @see https://tpp.stoplight.io/docs/tropipay-api-doc/85163f6f28b23-get-rate
      */
-    async rates(originCurrency: string , targetCurrency: string = 'EUR'): Promise<number | Error> {
-        if (!this.accessToken) {
+    async rates(originCurrency: string, targetCurrency: string = 'EUR'): Promise<number | Error> {
+        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 ${this.accessToken}`,
-
-        } })  
-        return rates.data.rate 
-    } catch (error) {
-        throw new Error(`Could not retrieve rates ${error}`);    
+        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: mediationPaymentCardConfig): Promise<PaymentLink> {
+        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 as PaymentLink;
+        } catch (error) {
+            throw new Error(`Could not generate mediation paymentCard ${error}`);
+        }
+
+
     }
-        
-    } 
 
 }
 

package/src/interfaces/mediation/index.ts

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

package/docs/README.MD

@@ -1,4 +0,0 @@
-Documentation
-=============
-
-This will be added eventually.