@yosle/tropipayjs 0.1.6 → 0.1.8

package/index.js

@@ -18,13 +18,13 @@ class Tropipay {
     clientId;
     clientSecret;
     request;
-    accessToken;
-    refreshToken;
+    static accessToken;
+    static refreshToken;
     serverMode;
-    constructor(client_id, client_secret, server_mode = 'Development') {
-        this.clientId = client_id;
-        this.clientSecret = client_secret;
-        this.serverMode = server_mode;
+    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'
@@ -32,7 +32,7 @@ class Tropipay {
             headers: {
                 'Content-Type': 'application/json',
                 Accept: 'application/json',
-                Authorization: `Bearer ${this.accessToken}`,
+                Authorization: `Bearer ${Tropipay.accessToken}`,
             }
         });
     }
@@ -44,20 +44,20 @@ 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__default["default"].isAxiosError(error)) {
-                throw new Error("Conection error: " + error.message);
+                throw new Error(`Could not obtain the access token from credentials  ${error}`);
             }
-            throw new Error("Could not obtain the access token from credentials ");
+            throw new Error(`Could not obtain the access token from credentials  ${error}`);
         }
     }
     /**
@@ -66,16 +66,16 @@ 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) {
-        if (!this.accessToken) {
+    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 ${this.accessToken}`,
-                    // Accept: 'application/json'
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: 'application/json'
                 }
             });
             return paylink.data;
@@ -90,11 +90,17 @@ class Tropipay {
      * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6OTgyOTQ1Mg-get-deposit-accounts-list
      */
     async getDepositAccounts() {
-        if (!this.accessToken) {
+        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) {
@@ -112,7 +118,7 @@ class Tropipay {
             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`);
         }
     }
     /**
@@ -133,18 +139,22 @@ class Tropipay {
         }
     }
     /**
-     * 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) {
+        if (!Tropipay.accessToken) {
             await this.login();
         }
         try {
-            const favoritesList = await this.request.get('/api/v2/paymentcards/favorites');
-            console.log(favoritesList);
-            return favoritesList.data;
+            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}`);
@@ -156,20 +166,21 @@ class Tropipay {
      * @returns
      */
     async movements(offset = 0, limit = 10) {
-        if (!this.accessToken) {
+        if (!Tropipay.accessToken)
             await this.login();
-        }
         try {
-            const movements = await this.request.get('/api/v2/movements', { params: { limit: limit, offset: offset },
+            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}`,
-                } });
+                    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}`);
         }
     }
     /**
@@ -177,9 +188,8 @@ class Tropipay {
      * @returns
      */
     async profile() {
-        if (!this.accessToken) {
+        if (!Tropipay.accessToken)
             await this.login();
-        }
         try {
             const profile = await this.request.get('/api/users/profile');
             return profile.data;
@@ -188,24 +198,61 @@ class Tropipay {
             throw new Error(`Could not retrieve movements list ${error}`);
         }
     }
-    async rates(payload = { currencyFrom: "EUR" }) {
-        console.log(payload);
-        if (!this.accessToken) {
+    /**
+     * 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', { payload,
+            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;
+                    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;

package/interfaces/countries/index.d.ts

@@ -0,0 +1 @@
+export type TropipayCountry = {};

package/interfaces/index.d.ts

@@ -0,0 +1,2 @@
+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/package.json

@@ -1,42 +1,43 @@
-{
-  "name": "@yosle/tropipayjs",
-  "version": "0.1.6",
-  "description": "Javascript / Typescript SDK for the Tropipay API",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "_clear": "rimraf src/dist/*",
-    "_tsc": "tsc",
-    "_make-bundle": "rollup --config",
-    "build": "run-s _clear _tsc _make-bundle"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/yosle/tropipayjs"
-  },
-  "keywords": [
-    "Javascript",
-    "Typescript",
-    "Tropipay",
-    "payments",
-    "gateway",
-    "API"
-  ],
-  "author": "Yosleivy Baez Acosta <yosle007@gmail.com>",
-  "license": "MIT",
-  "dependencies": {
-    "axios": "^0.27.2",
-    "tslib": "^2.4.0"
-  },
-  "devDependencies": {
-    "@rollup/plugin-typescript": "^8.5.0",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.79.1",
-    "rollup-plugin-dts": "^4.2.2",
-    "run-s": "^0.0.0"
-  },
-  "funding": {
-    "type": "individual",
-    "url": "https://tppay.me/l94qaa3h"
-  }
+{
+  "name": "@yosle/tropipayjs",
+  "version": "0.1.8",
+  "description": "Javascript / Typescript SDK for the Tropipay API",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "_clear": "rimraf src/dist/*",
+    "_tsc": "tsc",
+    "_make-bundle": "rollup --config",
+    "build": "yarn _clear && yarn _tsc && yarn _make-bundle"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yosle/tropipayjs"
+  },
+  "keywords": [
+    "Javascript",
+    "Typescript",
+    "Tropipay",
+    "payments",
+    "gateway",
+    "API"
+  ],
+  "author": "Yosleivy Baez Acosta <yosle007@gmail.com>",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^0.27.2",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^8.5.0",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.79.1",
+    "rollup-plugin-dts": "^4.2.2",
+    "run-s": "^0.0.0",
+    "typescript": "^5.0.4"
+  },
+  "funding": {
+    "type": "individual",
+    "url": "https://tppay.me/l94qaa3h"
+  }
 }

package/rollup.config.js

@@ -1,23 +1,23 @@
-// Contents of the file /rollup.config.js
-import typescript from '@rollup/plugin-typescript';
-import dts from "rollup-plugin-dts";
-const config = [
-    {
-        input: 'dist/index.js',
-        output: {
-            file: 'index.js',
-            format: 'cjs',
-            sourcemap: true,
-        },
-        external: ['axios'],
-        plugins: [typescript()]
-    }, {
-        input: 'dist/index.d.ts',
-        output: {
-            file: 'index.d.ts',
-            format: 'es'
-        },
-        plugins: [dts()]
-    }
-];
+// Contents of the file /rollup.config.js
+import typescript from '@rollup/plugin-typescript';
+import dts from "rollup-plugin-dts";
+const config = [
+    {
+        input: 'dist/index.js',
+        output: {
+            file: 'index.js',
+            format: 'cjs',
+            sourcemap: true,
+        },
+        external: ['axios'],
+        plugins: [typescript()]
+    }, {
+        input: 'dist/index.d.ts',
+        output: {
+            file: 'index.d.ts',
+            format: 'es'
+        },
+        plugins: [dts()]
+    }
+];
 export default config;

package/src/globals.d.ts

@@ -1,74 +1,74 @@
-type LoginResponse = {
-    access_token: string,
-    refresh_token: string
-    token_type: "Bearer",
-    expires_in: number,
-    scope: string
-}
-
-type LoginError = {
-    error: string
-}
-
-type Country = {
-        id: number,
-        name: string,
-        sepaZone: boolean,
-        state: number,
-        slug: string,
-        slugn: number,
-        callingCode: number,
-        isDestination: boolean,
-        isRisky: boolean,
-        currentCurrency: string | null,
-        createdAt: string,
-        updatedAt: string,
-        isFavorite: boolean,
-        position: any
-
-}
-
-type Deposit = {
-    id: number,
-    accountNumber: string,
-    alias: string,
-    swift: string,
-    type: number,
-    country: number | null,
-    firstName: string,
-    default: null,
-    state: number,
-    userId: string,
-    countryDestinationId: number,
-    lastName: string,
-    documentNumber: number,
-    userRelationTypeId: number,
-    city: string,
-    postalCode: string,
-    address: string,
-    phone: string,
-    checked: boolean,
-    province: string,
-    beneficiaryType: number,
-    relatedUserId: null | string,
-    currency: string,
-    correspondent?: any,
-    location: any,
-    office: any,
-    officeValue: any,
-    paymentType: number,
-    paymentEntityBeneficiaryId: number,
-    paymentEntityAccountId: number,
-    verified: any,
-    paymentEntityInfo: any,
-    documentTypeId: any,
-    documentExpirationDate: Date,
-    createdAt: Date<string>,
-    updatedAt: Date<string>,
-    countryDestination: Country
-}
-
-type AccountDeposits = {
-   count: number,
-   rows:  Deposit[]
+type LoginResponse = {
+    access_token: string,
+    refresh_token: string
+    token_type: "Bearer",
+    expires_in: number,
+    scope: string
+}
+
+type LoginError = {
+    error: string
+}
+
+type Country = {
+        id: number,
+        name: string,
+        sepaZone: boolean,
+        state: number,
+        slug: string,
+        slugn: number,
+        callingCode: number,
+        isDestination: boolean,
+        isRisky: boolean,
+        currentCurrency: string | null,
+        createdAt: string,
+        updatedAt: string,
+        isFavorite: boolean,
+        position: any
+
+}
+
+type Deposit = {
+    id: number,
+    accountNumber: string,
+    alias: string,
+    swift: string,
+    type: number,
+    country: number | null,
+    firstName: string,
+    default: null,
+    state: number,
+    userId: string,
+    countryDestinationId: number,
+    lastName: string,
+    documentNumber: number,
+    userRelationTypeId: number,
+    city: string,
+    postalCode: string,
+    address: string,
+    phone: string,
+    checked: boolean,
+    province: string,
+    beneficiaryType: number,
+    relatedUserId: null | string,
+    currency: string,
+    correspondent?: any,
+    location: any,
+    office: any,
+    officeValue: any,
+    paymentType: number,
+    paymentEntityBeneficiaryId: number,
+    paymentEntityAccountId: number,
+    verified: any,
+    paymentEntityInfo: any,
+    documentTypeId: any,
+    documentExpirationDate: Date,
+    createdAt: Date<string>,
+    updatedAt: Date<string>,
+    countryDestination: Country
+}
+
+type AccountDeposits = {
+   count: number,
+   rows:  Deposit[]
 }