@yosle/tropipayjs 0.1.9 → 0.1.11

package/index.d.ts

@@ -1,5 +1,41 @@
 import { Axios } from 'axios';
 
+type ServerMode$1 = "Development" | "Production";
+
+type AccountBalance = {
+    balance: number;
+    pendingIn: number;
+    pendingOut: number;
+};
+interface TropipayConfig {
+    clientId: string;
+    clientSecret: string;
+    serverMode?: ServerMode$1;
+}
+type TropipayCredentials = {
+    clientId: string;
+    clientSecret: string;
+};
+type HookEventType = "transaction_completed" | "transaction_charged" | "transaction_guarded" | "user_signup" | "user_kyc" | "payment_in_state_change" | "payment_out_state_change" | "beneficiary_added" | "beneficiary_updated" | "beneficiary_deleted" | "transaction_new" | "transaction_preauthorized" | "transaction_pendingin" | "transaction_processing" | "transaction_error" | "transaction_bloqued" | "transaction_guarded_send" | "transaction_guarded_mediation" | "user_after_update" | "user_after_create" | "userDetail_after_create" | "userDetail_after_update" | "tpv_callback_ok" | "fraud_state_on_change";
+type HookTargetType = "web" | "email";
+interface UserHook {
+    event: HookEventType;
+    target: string;
+    value: string;
+}
+interface UserHook {
+    event: HookEventType;
+    target: string;
+    value: string;
+}
+interface UserHookSubscribed extends UserHook {
+    createdAt: string;
+    updatedAt: string;
+}
+interface UserHookSubscribed extends UserHook {
+    createdAt: string;
+    updatedAt: string;
+}
 interface PaymentLinkPayload {
     reference: string;
     concept: string;
@@ -36,10 +72,6 @@ interface PaymentLink extends PaymentLinkPayload {
     shortUrl: string;
     paymentUrl: string;
 }
-
-/**
- *
- */
 interface mediationPaymentCardConfig {
     amount: number;
     currency: "EUR" | "USD";
@@ -59,6 +91,112 @@ interface mediationPaymentCardConfig {
     feeFixed?: number;
     sendMail: boolean;
 }
+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;
+    updatedAt: Date;
+    countryDestination: Country;
+};
+type AccountDeposits = {
+    count: number;
+    rows: Deposit[];
+};
+
+declare class TropipayHooks {
+    private tropipay;
+    constructor(tropipayInstance: Tropipay);
+    /**
+     * Subscribe a new hook
+     * @param event String that represents the name of the event,
+     * you must select from the list of available events, otherwise
+     * it will not produce an error but it will not be executed.
+     * For get full list of available events see endpoint
+     * GET /api/v2/hook/events.
+     * @param target String representing the type of event supported.
+     * It is currently available: 'web' (allows to receive information in a url),
+     * 'email' (allows to receive information in an email address).
+     * @param value if the selected 'target' is email the value would be an
+     *  email address, likewise if the selected 'target' is 'web' the expected
+     *  value corresponds to a url that receives information through the
+     * HTTP POST method.
+     * @returns
+     */
+    subscribe({ eventType, target, value, }: {
+        eventType: HookEventType;
+        target: "email" | "web";
+        value: string;
+    }): Promise<any>;
+    /**
+     * Get the sucbcribed hook info by his event type.
+     * If no event type is passed, it will return
+     * all subscribed hooks or empty Array if none exist.
+     * @param eventType or no params for retrieving all hooks
+     * @returns All subscribed hooks or empty Array if none exist.
+     */
+    list(eventType?: HookEventType): Promise<UserHookSubscribed[]>;
+    update(eventType: string, target: "web" | "email", value: string): Promise<any>;
+    delete(eventType: HookEventType, target: string): Promise<any>;
+    events(): Promise<any>;
+}
 
 /**
  * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
@@ -67,24 +205,16 @@ interface mediationPaymentCardConfig {
  *
  */
 
-type ServerMode = 'Development' | 'Production';
-interface TropipayConfig {
-    clientId: string;
-    clientSecret: string;
-    serverMode?: ServerMode;
-}
-type AccountBalance = {
-    balance: number;
-    pendingIn: number;
-    pendingOut: number;
-};
+type ServerMode = "Development" | "Production";
+
 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;
+    readonly clientId: string;
+    readonly clientSecret: string;
+    request: Axios;
+    static accessToken: string | undefined;
+    static refreshToken: string | undefined;
+    serverMode: ServerMode;
+    hooks: TropipayHooks;
     constructor(config: TropipayConfig);
     login(): Promise<LoginResponse>;
     /**
@@ -108,7 +238,7 @@ declare class Tropipay {
     countries(): Promise<Country[]>;
     /**
      * Get user balance
-     * @returns balance object
+     * @returns balance Object { balance: number, pendingIn: number, pendingOut: number }
      */
     getBalance(): Promise<AccountBalance>;
     /**
@@ -132,8 +262,8 @@ declare class Tropipay {
      */
     movements(offset?: number, limit?: number): Promise<any>;
     /**
-     * Return profile data for this account.
-     * @returns
+     * Return profile data for current Tropipay account.
+     * @returns account object
      */
     profile(): Promise<any>;
     /**
@@ -156,5 +286,27 @@ declare class Tropipay {
      */
     createMediationPaymentCard(config: mediationPaymentCardConfig): Promise<PaymentLink>;
 }
+declare class ClientSideUtils {
+    constructor(tropipayInstance: Tropipay);
+}
+
+declare class ServerSideUtils {
+    private tropipay;
+    constructor(tropipayInstance: Tropipay);
+    /**
+     * Verify Topipay's signature on webhooks.
+     * @param credentials Credential object or Tropipay instance
+     * @param {String} originalCurrencyAmount
+     * @param bankOrderCode
+     * @param signature
+     * @returns {Boolean}
+     */
+    static verifySignature(credentials: {
+        clientId: string;
+        clientSecret: string;
+    } | Tropipay, originalCurrencyAmount: string, bankOrderCode: string, signature: string): boolean;
+}
+
+declare const SERVER_MODE: ServerMode$1;
 
-export { Tropipay };
+export { AccountBalance, AccountDeposits, ClientSideUtils, Country, Deposit, HookEventType, HookTargetType, LoginError, LoginResponse, PaymentLink, PaymentLinkPayload, SERVER_MODE, ServerMode$1 as ServerMode, ServerSideUtils, Tropipay, TropipayConfig, TropipayCredentials, TropipayHooks, UserHook, UserHookSubscribed, mediationPaymentCardConfig };

package/index.js

@@ -3,10 +3,160 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var axios = require('axios');
+var crypto = require('crypto');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n["default"] = e;
+    return Object.freeze(n);
+}
+
 var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
+var crypto__namespace = /*#__PURE__*/_interopNamespace(crypto);
+
+class TropipayHooks {
+    tropipay;
+    // ... hook-related functionality ...
+    constructor(tropipayInstance) {
+        this.tropipay = tropipayInstance;
+    }
+    /**
+     * Subscribe a new hook
+     * @param event String that represents the name of the event,
+     * you must select from the list of available events, otherwise
+     * it will not produce an error but it will not be executed.
+     * For get full list of available events see endpoint
+     * GET /api/v2/hook/events.
+     * @param target String representing the type of event supported.
+     * It is currently available: 'web' (allows to receive information in a url),
+     * 'email' (allows to receive information in an email address).
+     * @param value if the selected 'target' is email the value would be an
+     *  email address, likewise if the selected 'target' is 'web' the expected
+     *  value corresponds to a url that receives information through the
+     * HTTP POST method.
+     * @returns
+     */
+    async subscribe({ eventType, target, value, }) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const hooks = await this.tropipay.request.post(`/api/v2/hooks`, {
+                event: eventType,
+                target: target,
+                value: value,
+            }, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return hooks.data;
+        }
+        catch (error) {
+            throw new Error(`Could not get subscribe new hook`);
+        }
+    }
+    /**
+     * Get the sucbcribed hook info by his event type.
+     * If no event type is passed, it will return
+     * all subscribed hooks or empty Array if none exist.
+     * @param eventType or no params for retrieving all hooks
+     * @returns All subscribed hooks or empty Array if none exist.
+     */
+    async list(eventType) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const hooks = await this.tropipay.request.get(`/api/v2/hooks/${eventType || ""}`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return hooks.data;
+        }
+        catch (error) {
+            throw new Error(`Could not get subscribed hooks`);
+        }
+    }
+    async update(eventType, target, value) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const hooks = await this.tropipay.request.put(`/api/v2/hooks`, {
+                event: eventType,
+                target: target,
+                value: value,
+            }, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return hooks.data;
+        }
+        catch (error) {
+            throw new Error(`Could not update subscribed hooks`);
+        }
+    }
+    async delete(eventType, target) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const hooks = await this.tropipay.request.delete(`/api/v2/hooks/${eventType}/${target}`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return hooks.data;
+        }
+        catch (error) {
+            console.trace(error);
+            throw new Error(`Could not delete subscribed hooks`);
+        }
+    }
+    async events() {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const hooks = await this.tropipay.request.get(`/api/v2/hooks/events`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return hooks.data;
+        }
+        catch (error) {
+            throw new Error(`Could not get events list for hooks ${error}`);
+        }
+    }
+}
 
 /**
  * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
@@ -21,33 +171,35 @@ class Tropipay {
     static accessToken;
     static refreshToken;
     serverMode;
+    hooks;
     constructor(config) {
         this.clientId = config.clientId;
         this.clientSecret = config.clientSecret;
-        this.serverMode = config.serverMode || 'Development';
+        this.serverMode = config.serverMode || "Development";
         this.request = axios__default["default"].create({
-            baseURL: this.serverMode === 'Production'
-                ? 'https://www.tropipay.com'
-                : 'https://tropipay-dev.herokuapp.com',
+            baseURL: this.serverMode === "Production"
+                ? "https://www.tropipay.com"
+                : "https://tropipay-dev.herokuapp.com",
             headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
+                "Content-Type": "application/json",
+                Accept: "application/json",
                 Authorization: `Bearer ${Tropipay.accessToken}`,
-            }
+            },
         });
+        this.hooks = new TropipayHooks(this);
     }
     async login() {
         try {
-            const { data } = await this.request.post('/api/v2/access/token', {
+            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"
+                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',
-                }
+                    "Content-Type": "application/json",
+                    Accept: "application/json",
+                },
             });
             Tropipay.accessToken = data.access_token;
             Tropipay.refreshToken = data.refresh_token;
@@ -71,17 +223,17 @@ class Tropipay {
             await this.login();
         }
         try {
-            const paylink = await this.request.post('/api/v2/paymentcards', payload, {
+            const paylink = await this.request.post("/api/v2/paymentcards", payload, {
                 headers: {
-                    'Content-Type': 'application/json',
+                    "Content-Type": "application/json",
                     Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: 'application/json'
-                }
+                    Accept: "application/json",
+                },
             });
             return paylink.data;
         }
         catch (error) {
-            throw new Error(`Could not obtain the access token with the given credentials.`);
+            throw new Error(`TropipayJS - Error creating the Payment Card.`);
         }
     }
     /**
@@ -94,12 +246,12 @@ class Tropipay {
             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',
+                    "Content-Type": "application/json",
                     Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: 'application/json'
-                }
+                    Accept: "application/json",
+                },
             });
             return deposits.data;
         }
@@ -114,33 +266,32 @@ class Tropipay {
      */
     async countries() {
         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(`TropipayJS Error - Could not retrieve the countries list`);
+            throw new Error(`Could not retrieve the countries list`);
         }
     }
     /**
      * Get user balance
-     * @returns balance object
+     * @returns balance Object { balance: number, pendingIn: number, pendingOut: number }
      */
     async getBalance() {
         if (!Tropipay.accessToken) {
             await this.login();
         }
         try {
-            const balance = await this.request.get('/api/v2/users/balance', {
+            const balance = await this.request.get("/api/v2/users/balance", {
                 headers: {
-                    'Content-Type': 'application/json',
+                    "Content-Type": "application/json",
                     Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: 'application/json'
-                }
+                    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`);
         }
     }
@@ -154,7 +305,7 @@ class Tropipay {
      */
     async destinations() {
         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) {
@@ -170,12 +321,12 @@ class Tropipay {
             await this.login();
         }
         try {
-            const favoritesList = await this.request.get('/api/v2/paymentcards/favorites', {
+            const favoritesList = await this.request.get("/api/v2/paymentcards/favorites", {
                 headers: {
-                    'Content-Type': 'application/json',
+                    "Content-Type": "application/json",
                     Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: 'application/json'
-                }
+                    Accept: "application/json",
+                },
             });
             return favoritesList?.data?.rows;
         }
@@ -192,13 +343,13 @@ class Tropipay {
         if (!Tropipay.accessToken)
             await this.login();
         try {
-            const movements = await this.request.get('/api/v2/movements', {
+            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}`
-                }
+                    "Content-Type": "application/json",
+                    Accept: "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                },
             });
             return movements.data;
         }
@@ -207,14 +358,14 @@ class Tropipay {
         }
     }
     /**
-     * Return profile data for this account.
-     * @returns
+     * Return profile data for current Tropipay account.
+     * @returns account object
      */
     async profile() {
         if (!Tropipay.accessToken)
             await this.login();
         try {
-            const profile = await this.request.get('/api/users/profile');
+            const profile = await this.request.get("/api/users/profile");
             return profile.data;
         }
         catch (error) {
@@ -229,20 +380,20 @@ class Tropipay {
      * @returns Conversion rate (number)
      * @see https://tpp.stoplight.io/docs/tropipay-api-doc/85163f6f28b23-get-rate
      */
-    async rates(originCurrency, targetCurrency = 'EUR') {
+    async rates(originCurrency, targetCurrency = "EUR") {
         if (!Tropipay.accessToken) {
             await this.login();
         }
         try {
-            const rates = await this.request.post('/api/v2/movements/get_rate', {
+            const rates = await this.request.post("/api/v2/movements/get_rate", {
                 currencyFrom: originCurrency,
-                currencyTo: targetCurrency
+                currencyTo: targetCurrency,
             }, {
                 headers: {
-                    'Content-Type': 'application/json',
-                    Accept: 'application/json',
+                    "Content-Type": "application/json",
+                    Accept: "application/json",
                     Authorization: `Bearer ${Tropipay.accessToken}`,
-                }
+                },
             });
             return rates.data.rate;
         }
@@ -263,20 +414,57 @@ class Tropipay {
         if (!Tropipay.accessToken)
             await this.login();
         try {
-            const mediation = await this.request.post('/api/v2/paymentcards/mediation', config, {
+            const mediation = await this.request.post("/api/v2/paymentcards/mediation", config, {
                 headers: {
-                    'Content-Type': 'application/json',
+                    "Content-Type": "application/json",
                     Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: 'application/json'
-                }
+                    Accept: "application/json",
+                },
             });
             return mediation.data;
         }
         catch (error) {
-            throw new Error(`Could not generate mediation paymentCard ${error}`);
+            throw new Error(`Could not create mediation payment card`);
         }
     }
 }
+class ClientSideUtils {
+    constructor(tropipayInstance) { }
+}
+
+class ServerSideUtils {
+    tropipay;
+    constructor(tropipayInstance) {
+        this.tropipay = tropipayInstance;
+    }
+    /**
+     * Verify Topipay's signature on webhooks.
+     * @param credentials Credential object or Tropipay instance
+     * @param {String} originalCurrencyAmount
+     * @param bankOrderCode
+     * @param signature
+     * @returns {Boolean}
+     */
+    static verifySignature(credentials, originalCurrencyAmount, bankOrderCode, signature) {
+        const localSignature = crypto__namespace
+            .createHash("sha256")
+            .update(bankOrderCode +
+            credentials.clientId +
+            crypto__namespace
+                .createHash("sha1")
+                .update(credentials.clientSecret)
+                .digest("hex") +
+            originalCurrencyAmount)
+            .digest("hex");
+        return localSignature === signature;
+    }
+}
+
+const SERVER_MODE = "Development"; // Move the constant here
 
+exports.ClientSideUtils = ClientSideUtils;
+exports.SERVER_MODE = SERVER_MODE;
+exports.ServerSideUtils = ServerSideUtils;
 exports.Tropipay = Tropipay;
+exports.TropipayHooks = TropipayHooks;
 //# sourceMappingURL=index.js.map