@yosle/tropipayjs 0.1.8 → 0.1.9

package/README.md

@@ -60,24 +60,32 @@ import { Tropipay } from '@yosle/tropipayjs'
 You can instantiate the Tropipay class passing the client Id ,client secret and optionally the serverMode parameter, if no serverMode is provided, `Development` will be used as default. Make sure you use the [test environment](https://tropipay-dev.herokuapp.com) credentials when serverMode is on `Development`.
 
 ```javascript
-// test environment server
-const tpp = new Tropipay("yourclientidhere",
-    "yourclientsecrethere")
+// test environment server tropipay-dev.herokuapp.com
+const config = {    
+    clientId: process.env.TROPIPAY_CLIENT_ID,
+    clientSecret: process.env.TROPIPAY_CLIENT_SECRET
+    serverMode: 'Development' // it will be used as default if omited
+}
+const tpp = new Tropipay(config)
 ```
 
 To use your live credentials (real account) you must explicity set serverMode to `Production`.
 
 ```javascript
 //real account credentials
-const tpp = new Tropipay("yourclientidhere",
-    "yourclientsecrethere",'Production')
+const config = {    
+    clientId: process.env.TROPIPAY_CLIENT_ID,
+    clientSecret: process.env.TROPIPAY_CLIENT_SECRET,
+    serverMode: 'Production' //live account
+}
+const tpp = new Tropipay(config)
 ```
 ### Generating a Payment Link
 ```javascript
 /*
 * Example Payload
 */
-const payload = await tpp.createPayLink({
+const payload = {
         reference: "my-paylink-1",
         concept: "Bicycle",
         favorite: "true",
@@ -102,11 +110,10 @@ const payload = await tpp.createPayLink({
             termsAndConditions: "true"
         },
         directPayment: "true"
-    })
-    
+    }
 // Use inside an async function
-const paylink = await tpp.createPayLink(payload)
-console.log(paylink.shortUrl)
+const paylink = await tpp.createPaymentCard(payload);
+console.log(paylink.shortUrl);
 ```
 
 For more examples, please refer to the [Documentation](https://github.com/yosle/tropipayjs/blob/master/docs/)

package/globals.d.ts

@@ -11,20 +11,20 @@ type LoginError = {
 }
 
 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
+    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
 
 }
 
@@ -69,6 +69,7 @@ type Deposit = {
 }
 
 type AccountDeposits = {
-   count: number,
-   rows:  Deposit[]
-}
+    count: number,
+    rows: Deposit[]
+}
+

package/index.d.ts

@@ -73,6 +73,11 @@ interface TropipayConfig {
     clientSecret: string;
     serverMode?: ServerMode;
 }
+type AccountBalance = {
+    balance: number;
+    pendingIn: number;
+    pendingOut: number;
+};
 declare class Tropipay {
     protected clientId: string;
     protected clientSecret: string;
@@ -101,6 +106,11 @@ declare class Tropipay {
      * @see https://tpp.stoplight.io/docs/tropipay-api-doc/bfac21259e2ff-getting-users-countries-list
      */
     countries(): Promise<Country[]>;
+    /**
+     * Get user balance
+     * @returns balance object
+     */
+    getBalance(): Promise<AccountBalance>;
     /**
      * Get the list of all detination countries supported by Tropipay.
      * Obtaining the list of valid countries to send funds to. Useful

package/index.js

@@ -121,6 +121,29 @@ class Tropipay {
             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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yosle/tropipayjs",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "Javascript / Typescript SDK for the Tropipay API",
   "main": "index.js",
   "scripts": {

package/src/index.ts

@@ -17,6 +17,12 @@ interface TropipayConfig {
     serverMode?: ServerMode;
 }
 
+type AccountBalance = {
+    balance: number,
+    pendingIn: number,
+    pendingOut: number
+}
+
 export class Tropipay {
     protected clientId: string;
     protected clientSecret: string;
@@ -128,6 +134,27 @@ export class Tropipay {
             throw new Error(`TropipayJS Error - Could not retrieve the countries list`);
         }
     }
+    /**
+     * Get user balance
+     * @returns balance Object { balance: number, pendingIn: number, pendingOut: number }
+     */
+    async getBalance(): Promise<AccountBalance> {
+        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) {
+            throw new Error(`TropipayJS Error - Could not retrieve the user's balance`);
+        }
+    }
 
     /**
      * Get the list of all detination countries supported by Tropipay.