@yosle/tropipayjs 0.1.4 → 0.1.5

package/README.md

@@ -1,28 +1,68 @@
-TropipayJS - A typed SDK for Tropipay Payments API
+TropipayJS -Typescript/Javascript SDK for Tropipay Payments API
 ===========
+![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) 
+![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
+![Next JS](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white)
+![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
 
-TropiPay is an electronic wallet that allows you to execute the most common financial operations of the day to day. This is a SDK for Typescript and Javacript that helps you build integrations with the Tropipay platform in a easier way. Can save you a lot of time and effort implementing all the API features. You can use this library with your prefered framework like Express or Nextjs.
+TropiPay is an electronic wallet that allows you to execute the most common financial operations of the day to day. This is an SDK for Typescript and Javacript that helps you build integrations with the Tropipay platform in an easier way. Can save you a lot of time and effort implementing all the API features. You can use this library with CommonJS system (like node + express) or ES6 module system (NextJS).
 
-# Instalation
+## Project status
+This library is still under development so using it in the live (real account) isn't recommended yet.
+
+# Table of Contents
+* [Getting started](#getting-started)
+* [Setting up your credentials](#setting-up-your-app-credentials)
+* [Documentation](#documentation)
+* [Examples](#examples)
+* [Contribute and Help](#contributing-and-help)
+
+# Getting started
 You can use npm or yarn to install this package:
 
-`npm install tropipayjs` or
-`yarn add tropipayjs`
+```npm install @yosle/tropipayjs``` 
 
-# How to use
-The Tropipay instance, allows you to access all the method available in the API. This Object is meant to be used *only in server side*. Do not use the Tropipay object on the client side (browser). This would expose your app credentials (the client secret of your account). You can create an endpoint at your back-end using express and consume it in your front-end, or use SSR if you're using NextJS.
+or
 
-## Setting up your credentials
-In order to use the Tropipay API you need to signup in a live (production) or the test enviroment. Create an app and configure the client id an client secret for the app.
+```yarn add @yosle/tropipayjs```
+
+## Setting up your app credentials
+![alt](/docs/images/app-credentials-menu.png)
+![alt](/docs/images/confirmation-code-screen.png)
+In order to use the Tropipay API you'll need a client ID and a client secret. Sign up with your [Tropipay](www.tropipay.com) account, go to the App Menu->Applications and credentials. You'll be asked to enter a confirmation code (use 123456 in the test enviroment). _Make sure you test everything in the [test enviroment](https://tropipay-dev.herokuapp.com) first before using your real account._ Create an app and configure the client id an client secret for the app.
+
+## How to use
+The Tropipay instance, allows you to access all the method available in the API. This Object is meant to be used *only in server side*. Do not use the Tropipay object on the client side (browser). This would expose your app credentials (the client secret of your account). You can create an endpoint at your back-end using express and consume it in your front-end, or use SSR if you're using NextJS.
 
-# Examples
+### CommonJS 
+```javascript
+const { Tropipay } = require('@yosle/tropipayjs')
+```
+### ES6 
+```javascript
+import { Tropipay } from '@yosle/tropipayjs'
+```
+### Initialize the Tropipay class
+```javascript
+const tpp = new Tropipay("yourclientidhere",
+    "yourclientsecrethere")
+```
+## Generating a Payment Link
+```javascript
+const paylink = await tpp.createPayLink(payload)
+```
 
-# Using Typescript
+# Documentation
+Examples using express + nodejs and NextJS will be added soon.
 
-# Contributing and Help
-Having problems? want to contribute? join our community slack.
+# Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
+Please make sure to update tests as appropriate.
 
+You can also make a small [donation to the author](https://tppay.me/l94qaa3h).
+## License
+[MIT License](https://choosealicense.com/licenses/mit/)
 
 
 

package/index.d.ts

@@ -38,26 +38,26 @@ interface PaymentLink extends PaymentLinkPayload {
 }
 
 /**
- * Tropipayjs is a wrapper for the Tropipay API. It was made in
- * typescript but you can use Javascript.
- * @author Yosleivy baez Acosta
+ * Tropipayjs is a Typescript/Javascript library for the Tropipay API. CommonJs and
+ * ES6 modules are supported.
+ * @author Yosleivy Baez Acosta
  *
  */
 
 declare type ServerMode = 'Development' | 'Production';
 declare class Tropipay {
-    readonly client_id: string;
-    readonly client_secret: string;
-    request: Axios;
-    access_token: string | undefined;
-    refresh_token: string | undefined;
-    server_mode: ServerMode;
+    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 width the specifued payload
-     * @param payload Object of PaymentLinkPayload type with paylink payload
-     * @returns Promise<PaymentLink> or 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
      */
     createPayLink(payload: PaymentLinkPayload): Promise<PaymentLink>;
@@ -69,19 +69,28 @@ declare class Tropipay {
     getDepositAccounts(): Promise<AccountDeposits[] | Error>;
     /**
      * Get the list of all supported countries by Tropipay.
-     * @returns Array of Countries
-     * @see
+     * @returns Array of Countries Data
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/bfac21259e2ff-getting-users-countries-list
      */
-    countries(): Promise<Country[] | Error>;
+    countries(): Promise<Country[]>;
     /**
-     * Get list of all the favorites accounts.
+     * 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
-     * @see
      */
     favorites(): Promise<any>;
     /**
-     * List all movements in current account. You can optionaly specify
-     *  offset and limit params for pagination.
+     * List all account movements. You can optionaly specify
+     * offset and limit params for pagination.
      * @returns
      */
     movements(offset?: number, limit?: number): Promise<any>;

package/index.js

@@ -9,38 +9,38 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
 
 /**
- * Tropipayjs is a wrapper for the Tropipay API. It was made in
- * typescript but you can use Javascript.
- * @author Yosleivy baez Acosta
+ * Tropipayjs is a Typescript/Javascript library for the Tropipay API. CommonJs and
+ * ES6 modules are supported.
+ * @author Yosleivy Baez Acosta
  *
  */
 class Tropipay {
-    client_id;
-    client_secret;
+    clientId;
+    clientSecret;
     request;
-    access_token;
-    refresh_token;
-    server_mode;
+    accessToken;
+    refreshToken;
+    serverMode;
     constructor(client_id, client_secret, server_mode = 'Development') {
-        this.client_id = client_id;
-        this.client_secret = client_secret;
-        this.server_mode = server_mode;
+        this.clientId = client_id;
+        this.clientSecret = client_secret;
+        this.serverMode = server_mode;
         this.request = axios__default["default"].create({
-            baseURL: this.server_mode === 'Production'
+            baseURL: this.serverMode === 'Production'
                 ? 'https://www.tropipay.com'
                 : 'https://tropipay-dev.herokuapp.com',
             headers: {
                 'Content-Type': 'application/json',
                 Accept: 'application/json',
-                Authorization: `Bearer ${this.access_token}`,
+                Authorization: `Bearer ${this.accessToken}`,
             }
         });
     }
     async login() {
         try {
             const { data } = await this.request.post('/api/v2/access/token', {
-                client_id: this.client_id,
-                client_secret: this.client_secret,
+                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 "
             }, {
@@ -49,8 +49,8 @@ class Tropipay {
             //     Accept: 'application/json',
             // }
             });
-            this.access_token = data.access_token;
-            this.refresh_token = data.refresh_token;
+            this.accessToken = data.access_token;
+            this.refreshToken = data.refresh_token;
             return data;
         }
         catch (error) {
@@ -62,27 +62,27 @@ class Tropipay {
         }
     }
     /**
-     * Create a paymentLink width the specifued payload
-     * @param payload Object of PaymentLinkPayload type with paylink payload
-     * @returns Promise<PaymentLink> or 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.access_token) {
+        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.access_token}`,
+                    Authorization: `Bearer ${this.accessToken}`,
                     // Accept: 'application/json'
                 }
             });
             return paylink.data;
         }
         catch (error) {
-            throw new Error(`Error tryng to get the access token`);
+            throw new Error(`Could not obtain the access tokemn with the given credentials.`);
         }
     }
     /**
@@ -91,7 +91,7 @@ class Tropipay {
      * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6OTgyOTQ1Mg-get-deposit-accounts-list
      */
     async getDepositAccounts() {
-        if (!this.access_token) {
+        if (!this.accessToken) {
             await this.login();
         }
         try {
@@ -104,15 +104,12 @@ class Tropipay {
     }
     /**
      * Get the list of all supported countries by Tropipay.
-     * @returns Array of Countries
-     * @see
+     * @returns Array of Countries Data
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/bfac21259e2ff-getting-users-countries-list
      */
     async countries() {
-        if (!this.access_token) {
-            await this.login();
-        }
         try {
-            const countries = await this.request.get('/api/countries');
+            const countries = await this.request.get('/api/v2/countries');
             return countries.data;
         }
         catch (error) {
@@ -120,29 +117,47 @@ class Tropipay {
         }
     }
     /**
-     * Get list of all the favorites accounts.
+     * 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
-     * @see
      */
     async favorites() {
-        if (!this.access_token) {
+        if (!this.accessToken) {
             await this.login();
         }
         try {
-            const favorites = await this.request.get('/api/v2/paymentcards/favorites');
-            return favorites.data;
+            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`);
+            throw new Error(`Could not retrieve favorites list ${error}`);
         }
     }
     /**
-     * List all movements in current account. You can optionaly specify
-     *  offset and limit params for pagination.
+     * List all account movements. You can optionaly specify
+     * offset and limit params for pagination.
      * @returns
      */
     async movements(offset = 0, limit = 10) {
-        if (!this.access_token) {
+        if (!this.accessToken) {
             await this.login();
         }
         try {
@@ -150,7 +165,7 @@ class Tropipay {
                 headers: {
                     'Content-Type': 'application/json',
                     Accept: 'application/json',
-                    Authorization: `Bearer ${this.access_token}`,
+                    Authorization: `Bearer ${this.accessToken}`,
                 } });
             return movements.data;
         }
@@ -163,7 +178,7 @@ class Tropipay {
      * @returns
      */
     async profile() {
-        if (!this.access_token) {
+        if (!this.accessToken) {
             await this.login();
         }
         try {
@@ -176,7 +191,7 @@ class Tropipay {
     }
     async getRates(payload = { currencyFrom: "EUR" }) {
         console.log(payload);
-        if (!this.access_token) {
+        if (!this.accessToken) {
             await this.login();
         }
         try {
@@ -184,7 +199,7 @@ class Tropipay {
                 headers: {
                     'Content-Type': 'application/json',
                     Accept: 'application/json',
-                    Authorization: `Bearer ${this.access_token}`,
+                    Authorization: `Bearer ${this.accessToken}`,
                 } });
             return rates.data;
         }

package/index.ts

@@ -1,7 +1,7 @@
 /**
- * Tropipayjs is a wrapper for the Tropipay API. It was made in
- * typescript but you can use Javascript.
- * @author Yosleivy baez Acosta
+ * Tropipayjs is a Typescript/Javascript library for the Tropipay API. CommonJs and 
+ * ES6 modules are supported.
+ * @author Yosleivy Baez Acosta
  * 
  */
 
@@ -13,29 +13,29 @@ type ServerMode = 'Development' | 'Production'
 
 
 export class Tropipay {
-    readonly client_id: string;
-    readonly client_secret: string;
-    public request: Axios;
-    public access_token: string | undefined;
-    public refresh_token: string | undefined;
-    public server_mode: ServerMode;
+    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 = 'Development') {
-        this.client_id = client_id;
-        this.client_secret = client_secret
-        this.server_mode = server_mode
+        this.clientId = client_id;
+        this.clientSecret = client_secret
+        this.serverMode = server_mode
 
         this.request = axios.create({
-            baseURL: this.server_mode === 'Production'
+            baseURL: this.serverMode === 'Production'
                 ? 'https://www.tropipay.com'
                 : 'https://tropipay-dev.herokuapp.com',
             headers: {
                 'Content-Type': 'application/json',
                 Accept: 'application/json',
-                Authorization: `Bearer ${this.access_token}`,
+                Authorization: `Bearer ${this.accessToken}`,
 
             }   
         })
@@ -45,8 +45,8 @@ export class Tropipay {
     async login() {
         try {
             const { data } = await this.request.post<LoginResponse>('/api/v2/access/token', {
-                client_id: this.client_id,
-                client_secret: this.client_secret,
+                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 "
             }, {
@@ -56,8 +56,8 @@ export class Tropipay {
                 // }
             })
 
-            this.access_token = data.access_token
-            this.refresh_token = data.refresh_token
+            this.accessToken = data.access_token
+            this.refreshToken = data.refresh_token
             return data
         } catch (error) {
             if (axios.isAxiosError(error)) {
@@ -70,26 +70,26 @@ export class Tropipay {
     }
 
     /**
-     * Create a paymentLink width the specifued payload
-     * @param payload Object of PaymentLinkPayload type with paylink payload
-     * @returns Promise<PaymentLink> or 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: PaymentLinkPayload): Promise<PaymentLink> {
-        if (!this.access_token) {
+        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.access_token}`,
+                    Authorization: `Bearer ${this.accessToken}`,
                     // Accept: 'application/json'
                 }
             })
             return paylink.data as PaymentLink
         } catch (error) {
-            throw new Error(`Error tryng to get the access token`);
+            throw new Error(`Could not obtain the access tokemn with the given credentials.`);
 
         }
     }
@@ -100,7 +100,7 @@ export class Tropipay {
      * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6OTgyOTQ1Mg-get-deposit-accounts-list
      */
     async getDepositAccounts(): Promise<AccountDeposits[] | Error>{
-        if (!this.access_token) {
+        if (!this.accessToken) {
             await this.login()
         }
         try {
@@ -113,45 +113,62 @@ export class Tropipay {
 
     /**
      * Get the list of all supported countries by Tropipay.
-     * @returns Array of Countries
-     * @see 
+     * @returns Array of Countries Data
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/bfac21259e2ff-getting-users-countries-list
      */
-    async countries(): Promise<Country[] | Error>{
-        if (!this.access_token) {
-            await this.login()
-        }
+    async countries(): Promise<Country[] > {
+        
         try {
-            const countries  = await this.request.get('/api/countries') 
-            return countries.data 
+            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(): Promise<Country[]> {
+        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. 
+     * Get list of all the favorites accounts. This endpoint is not documented
+     * in the official Tropipay documentation.
      * @returns 
-     * @see
      */
     async favorites(){
-        if (!this.access_token) {
+        if (!this.accessToken) {
             await this.login()
         }
         try {
-            const favorites  = await this.request.get('/api/v2/paymentcards/favorites') 
-            return favorites.data 
-        } catch (error) {
-            throw new Error(`Could not retrieve favorites list`);    
+            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 movements in current account. You can optionaly specify
-     *  offset and limit params for pagination.
+     * List all account movements. You can optionaly specify
+     * offset and limit params for pagination.
      * @returns 
      */
     async movements(offset = 0 , limit = 10){
-        if (!this.access_token) {
+        if (!this.accessToken) {
             await this.login()
         }
         try {
@@ -160,7 +177,7 @@ export class Tropipay {
             headers: {
                 'Content-Type': 'application/json',
                 Accept: 'application/json',
-                Authorization: `Bearer ${this.access_token}`,
+                Authorization: `Bearer ${this.accessToken}`,
 
             } }) 
             return movements.data 
@@ -175,7 +192,7 @@ export class Tropipay {
      * @returns 
      */
     async profile(){
-        if (!this.access_token) {
+        if (!this.accessToken) {
             await this.login()
         }
         try {
@@ -188,7 +205,7 @@ export class Tropipay {
 
     async getRates(payload = {currencyFrom: "EUR"}) {
         console.log(payload)
-        if (!this.access_token) {
+        if (!this.accessToken) {
             await this.login()
         }
     try {
@@ -196,7 +213,7 @@ export class Tropipay {
         headers: {
             'Content-Type': 'application/json',
             Accept: 'application/json',
-            Authorization: `Bearer ${this.access_token}`,
+            Authorization: `Bearer ${this.accessToken}`,
 
         } }) 
         return rates.data 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yosle/tropipayjs",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Javascript / Typescript SDK for the Tropipay API",
   "main": "index.js",
   "scripts": {
@@ -34,5 +34,9 @@
     "rollup": "^2.79.1",
     "rollup-plugin-dts": "^4.2.2",
     "run-s": "^0.0.0"
+  },
+  "funding": {
+    "type": "individual",
+    "url": "https://tppay.me/l94qaa3h"
   }
 }

package/dist/index.d.ts

@@ -1,59 +0,0 @@
-/**
- * Tropipayjs is a wrapper for the Tropipay API. It was made in
- * typescript but you can use Javascript.
- * @author Yosleivy baez Acosta
- *
- */
-import { Axios } from "axios";
-import { PaymentLink, PaymentLinkPayload } from './interfaces/paymentlink';
-declare type ServerMode = 'Development' | 'Production';
-export declare class Tropipay {
-    readonly client_id: string;
-    readonly client_secret: string;
-    request: Axios;
-    access_token: string | undefined;
-    refresh_token: string | undefined;
-    server_mode: ServerMode;
-    constructor(client_id: string, client_secret: string, server_mode?: ServerMode);
-    login(): Promise<LoginResponse>;
-    /**
-     * Create a paymentLink width the specifued payload
-     * @param payload Object of PaymentLinkPayload type with paylink payload
-     * @returns Promise<PaymentLink> or Error
-     * @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
-     * @see
-     */
-    countries(): Promise<Country[] | Error>;
-    /**
-     * Get list of all the favorites accounts.
-     * @returns
-     * @see
-     */
-    favorites(): Promise<any>;
-    /**
-     * List all movements in current account. 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>;
-    getRates(payload?: {
-        currencyFrom: string;
-    }): Promise<any>;
-}
-export {};

package/dist/index.js

@@ -1,187 +0,0 @@
-/**
- * Tropipayjs is a wrapper for the Tropipay API. It was made in
- * typescript but you can use Javascript.
- * @author Yosleivy baez Acosta
- *
- */
-import axios from "axios";
-export class Tropipay {
-    client_id;
-    client_secret;
-    request;
-    access_token;
-    refresh_token;
-    server_mode;
-    constructor(client_id, client_secret, server_mode = 'Development') {
-        this.client_id = client_id;
-        this.client_secret = client_secret;
-        this.server_mode = server_mode;
-        this.request = axios.create({
-            baseURL: this.server_mode === 'Production'
-                ? 'https://www.tropipay.com'
-                : 'https://tropipay-dev.herokuapp.com',
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-                Authorization: `Bearer ${this.access_token}`,
-            }
-        });
-    }
-    async login() {
-        try {
-            const { data } = await this.request.post('/api/v2/access/token', {
-                client_id: this.client_id,
-                client_secret: this.client_secret,
-                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.access_token = data.access_token;
-            this.refresh_token = data.refresh_token;
-            return data;
-        }
-        catch (error) {
-            if (axios.isAxiosError(error)) {
-                // 👇️ error: AxiosError<any, any>
-                throw new Error("Conection error: " + error.message);
-            }
-            throw new Error("Could not obtain the access token from credentials ");
-        }
-    }
-    /**
-     * Create a paymentLink width the specifued payload
-     * @param payload Object of PaymentLinkPayload type with paylink payload
-     * @returns Promise<PaymentLink> or Error
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6ODgyNTM3OQ-create-a-new-pay-link-charge
-     */
-    async createPayLink(payload) {
-        if (!this.access_token) {
-            await this.login();
-        }
-        try {
-            const paylink = await this.request.post('/api/v2/paymentcards', payload, {
-                headers: {
-                    // 'Content-Type': 'application/json',
-                    Authorization: `Bearer ${this.access_token}`,
-                    // Accept: 'application/json'
-                }
-            });
-            return paylink.data;
-        }
-        catch (error) {
-            throw new Error(`Error tryng to get the access token`);
-        }
-    }
-    /**
-     * 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.access_token) {
-            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
-     * @see
-     */
-    async countries() {
-        if (!this.access_token) {
-            await this.login();
-        }
-        try {
-            const countries = await this.request.get('/api/countries');
-            return countries.data;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve the countries list`);
-        }
-    }
-    /**
-     * Get list of all the favorites accounts.
-     * @returns
-     * @see
-     */
-    async favorites() {
-        if (!this.access_token) {
-            await this.login();
-        }
-        try {
-            const favorites = await this.request.get('/api/v2/paymentcards/favorites');
-            return favorites.data;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve favorites list`);
-        }
-    }
-    /**
-     * List all movements in current account. You can optionaly specify
-     *  offset and limit params for pagination.
-     * @returns
-     */
-    async movements(offset = 0, limit = 10) {
-        if (!this.access_token) {
-            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.access_token}`,
-                } });
-            return movements.data;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve movements list`);
-        }
-    }
-    /**
-     * Return profile data for this account.
-     * @returns
-     */
-    async profile() {
-        if (!this.access_token) {
-            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}`);
-        }
-    }
-    async getRates(payload = { currencyFrom: "EUR" }) {
-        console.log(payload);
-        if (!this.access_token) {
-            await this.login();
-        }
-        try {
-            const rates = await this.request.post('/api/v2/movements/get_rate', { payload,
-                headers: {
-                    'Content-Type': 'application/json',
-                    Accept: 'application/json',
-                    Authorization: `Bearer ${this.access_token}`,
-                } });
-            return rates.data;
-        }
-        catch (error) {
-            throw new Error(`Could not retrieve rates ${error}`);
-        }
-    }
-}
-//# sourceMappingURL=index.js.map

package/dist/interfaces/countries/index.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=index.js.map

package/dist/interfaces/index.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=index.js.map

package/dist/interfaces/paymentlink/index.d.ts

@@ -1,36 +0,0 @@
-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/dist/interfaces/paymentlink/index.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.js.map