@yosle/tropipayjs 0.1.14 → 0.1.16

package/README.md

@@ -1,15 +1,13 @@
-TropipayJS - Typescript/Javascript SDK for Tropipay Payments API
-===========
+# TropipayJS - Typescript/Javascript SDK for Tropipay Payments API
 
 ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
-![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) 
+![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)
 ![RollupJS](https://img.shields.io/badge/RollupJS-ef3335?style=for-the-badge&logo=rollup.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 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 (node + express) or ES6 module system (NextJS).
 
-
 # Table of Contents
 
 - [TropipayJS - Typescript/Javascript SDK for Tropipay Payments API](#tropipayjs---typescriptjavascript-sdk-for-tropipay-payments-api)
@@ -29,7 +27,7 @@ TropiPay is an electronic wallet that allows you to execute the most common fina
 
 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. 
+**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.
 
@@ -37,11 +35,11 @@ The library is intended to simplify the integration process with Tropipay's serv
 
 You can use npm or yarn to install this package:
 
-```npm install @yosle/tropipayjs``` 
+`npm install @yosle/tropipayjs`
 
 or
 
-```yarn add @yosle/tropipayjs```
+`yarn add @yosle/tropipayjs`
 
 ## Setting up your app credentials
 
@@ -52,18 +50,18 @@ In order to use the Tropipay API you'll need a client ID and a client secret. Si
 
 ## Usage
 
-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.
+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.
 
-### CommonJS 
+### CommonJS
 
 ```javascript
-const { Tropipay } = require('@yosle/tropipayjs')
+const { Tropipay } = require("@yosle/tropipayjs");
 ```
 
-### ES6 
+### ES6
 
 ```javascript
-import { Tropipay } from '@yosle/tropipayjs'
+import { Tropipay } from "@yosle/tropipayjs";
 ```
 
 ### Initialize the Tropipay class
@@ -72,7 +70,7 @@ You can instantiate the Tropipay class passing the client Id ,client secret and
 
 ```javascript
 // test environment server tropipay-dev.herokuapp.com
-const config = {    
+const config = {
     clientId: process.env.TROPIPAY_CLIENT_ID,
     clientSecret: process.env.TROPIPAY_CLIENT_SECRET
     serverMode: 'Development' // it will be used as default if omited
@@ -84,48 +82,48 @@ To use your live credentials (real account) you must explicity set serverMode to
 
 ```javascript
 //real account credentials
-const config = {    
-    clientId: process.env.TROPIPAY_CLIENT_ID,
-    clientSecret: process.env.TROPIPAY_CLIENT_SECRET,
-    serverMode: 'Production' //live account
-}
-const tpp = new Tropipay(config)
+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
-*/
+ * Example Payload
+ */
 const payload = {
-        reference: "my-paylink-1",
-        concept: "Bicycle",
-        favorite: "true",
-        amount: 3000,
-        currency: "EUR",
-        description: "Two wheels",
-        singleUse: "true",
-        reasonId: 4,
-        expirationDays: 1,
-        lang: "es",
-        urlSuccess: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
-        urlFailed: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
-        urlNotification: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
-        serviceDate: "2021-08-20",
-        client: {
-            name: "John",
-            lastName: "McClane",
-            address: "Ave. Guadí 232, Barcelona, Barcelona",
-            phone: "+34645553333",
-            email: "client@email.com",
-            countryId: 1,
-            termsAndConditions: "true"
-        },
-        directPayment: "true"
-    }
+  reference: "my-paylink-1",
+  concept: "Bicycle",
+  favorite: "true",
+  amount: 3000,
+  currency: "EUR",
+  description: "Two wheels",
+  singleUse: "true",
+  reasonId: 4,
+  expirationDays: 1,
+  lang: "es",
+  urlSuccess: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
+  urlFailed: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
+  urlNotification: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
+  serviceDate: "2021-08-20",
+  client: {
+    name: "John",
+    lastName: "McClane",
+    address: "Ave. Guadí 232, Barcelona, Barcelona",
+    phone: "+34645553333",
+    email: "client@email.com",
+    countryId: 1,
+    termsAndConditions: "true",
+  },
+  directPayment: "true",
+};
 // Use inside an async function
-const paylink = await tpp.createPaymentCard(payload);
+const paylink = await tpp.paymentCards.create(payload);
 console.log(paylink.shortUrl);
 ```
 
@@ -140,15 +138,11 @@ If you have a suggestion that would make this better, please fork the repo and c
 3. Commit your Changes (`git commit -m 'Add some AmazingFeature`)
 4. Push to the Branch (`git push origin feature/AmazingFeature`)
 5. Open a Pull Request
-   
-Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. 
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
 You can also make a small [donation to the author](https://tppay.me/l94qaa3h) of the library.
 
 # License
 
 Distributed under the MIT License. See `LICENSE.txt` for more information.
-
-
-
-

package/api/TropipayAPI.d.ts

@@ -9,6 +9,7 @@ import { TropipayConfig, AccountBalance, Country, PaymentLink, mediationPaymentC
 type ServerMode = "Development" | "Production";
 import { TropipayHooks } from "../hooks/TropipayHooks";
 import { PaymentCard } from "../paymentcard/PaymentCard";
+import { DepositAccounts } from "../depositAccount/depositAccounts";
 export declare class Tropipay {
     readonly clientId: string;
     readonly clientSecret: string;
@@ -17,7 +18,8 @@ export declare class Tropipay {
     static refreshToken: string | undefined;
     serverMode: ServerMode;
     hooks: TropipayHooks;
-    paymentcards: PaymentCard;
+    paymentCards: PaymentCard;
+    depositAccounts: DepositAccounts;
     constructor(config: TropipayConfig);
     login(): Promise<LoginResponse>;
     /**

package/depositAccount/depositAccounts.d.ts

@@ -0,0 +1,36 @@
+import { Tropipay } from "../api/TropipayAPI";
+import { DepositAccountConfig } from "../interfaces/depositaccounts";
+export declare class DepositAccounts {
+    private tropipay;
+    constructor(tropipayInstance: Tropipay);
+    /**
+     * List od all beneficiaries of this account
+     * @returns Array of DepositAccounts
+     */
+    list(): Promise<any>;
+    /**
+     * Adds a new beneficiary to the user account.
+     * @param payload
+     * @returns
+     */
+    create(depositAccountObj: DepositAccountConfig): Promise<any>;
+    /**
+     * This returns details of a specific
+     * Deposit Account (beneficiary) specified by its ID
+     * @param id
+     * @returns
+     */
+    get(id: string): Promise<any>;
+    /**
+     * Updates certain beneficiary data.
+     * @param depositAccountObj
+     * @returns
+     */
+    update(depositAccountObj: Partial<DepositAccountConfig>): Promise<any>;
+    /**
+     * (UNTESTED) Deletes the beneficiary indicated by id
+     * @param id
+     * @returns
+     */
+    delete(id: number): Promise<any>;
+}

package/index.d.ts

@@ -217,6 +217,69 @@ declare class PaymentCard {
     get(id: string): Promise<any>;
 }
 
+interface DepositAccountConfig {
+    searchValue?: string;
+    alias: string;
+    userRelationTypeId: number;
+    beneficiaryType: BeneficiaryType;
+    searchBy?: number;
+    accountNumber?: string;
+    swift?: string;
+    type: DepositAccountType;
+    firstName?: string;
+    lastName?: string;
+    secondLastName?: string;
+    countryDestinationId?: number;
+    city?: string;
+    postalCode?: number;
+    address?: string;
+    documentNumber?: string;
+    phone?: string;
+    province?: string;
+    paymentType?: string;
+    documentTypeId?: number;
+    documentExpirationDate: string;
+}
+type INTERNAL = 1;
+type EXTERNAL = 2;
+type BeneficiaryType = INTERNAL | EXTERNAL;
+type DepositAccountType = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9 | 10 | 11;
+
+declare class DepositAccounts {
+    private tropipay;
+    constructor(tropipayInstance: Tropipay);
+    /**
+     * List od all beneficiaries of this account
+     * @returns Array of DepositAccounts
+     */
+    list(): Promise<any>;
+    /**
+     * Adds a new beneficiary to the user account.
+     * @param payload
+     * @returns
+     */
+    create(depositAccountObj: DepositAccountConfig): Promise<any>;
+    /**
+     * This returns details of a specific
+     * Deposit Account (beneficiary) specified by its ID
+     * @param id
+     * @returns
+     */
+    get(id: string): Promise<any>;
+    /**
+     * Updates certain beneficiary data.
+     * @param depositAccountObj
+     * @returns
+     */
+    update(depositAccountObj: Partial<DepositAccountConfig>): Promise<any>;
+    /**
+     * (UNTESTED) Deletes the beneficiary indicated by id
+     * @param id
+     * @returns
+     */
+    delete(id: number): Promise<any>;
+}
+
 /**
  * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
  *
@@ -234,7 +297,8 @@ declare class Tropipay {
     static refreshToken: string | undefined;
     serverMode: ServerMode;
     hooks: TropipayHooks;
-    paymentcards: PaymentCard;
+    paymentCards: PaymentCard;
+    depositAccounts: DepositAccounts;
     constructor(config: TropipayConfig);
     login(): Promise<LoginResponse>;
     /**
@@ -322,4 +386,4 @@ declare class ServerSideUtils {
 
 declare const SERVER_MODE: ServerMode$1;
 
-export { AccountBalance, AccountDeposits, ClientSideUtils, Country, Deposit, HookEventType, HookTargetType, LoginError, LoginResponse, PaymentCard, PaymentLink, PaymentLinkPayload, SERVER_MODE, ServerMode$1 as ServerMode, ServerSideUtils, Tropipay, TropipayConfig, TropipayCredentials, TropipayHooks, UserHook, UserHookSubscribed, mediationPaymentCardConfig };
+export { AccountBalance, AccountDeposits, ClientSideUtils, Country, Deposit, DepositAccounts, HookEventType, HookTargetType, LoginError, LoginResponse, PaymentCard, PaymentLink, PaymentLinkPayload, SERVER_MODE, ServerMode$1 as ServerMode, ServerSideUtils, Tropipay, TropipayConfig, TropipayCredentials, TropipayHooks, UserHook, UserHookSubscribed, mediationPaymentCardConfig };

package/index.js

@@ -28,6 +28,51 @@ function _interopNamespace(e) {
 var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
 var crypto__namespace = /*#__PURE__*/_interopNamespace(crypto);
 
+function handleExceptions(error) {
+    if (error instanceof axios.AxiosError) {
+        if (error.response) {
+            const axiosResponse = error.response;
+            const errorMessage = axiosResponse.data?.error?.message || "An error occurred";
+            switch (axiosResponse.status) {
+                case 401:
+                    return new TropipayJSException(errorMessage, axiosResponse.status, axiosResponse.data.error);
+                case 403:
+                    return new TropipayJSException(errorMessage, axiosResponse.status, axiosResponse.data.error);
+                case 404:
+                    return new TropipayJSException(errorMessage, axiosResponse.status, axiosResponse.data.error);
+                // case 429:
+                //   return new TooManyRequestsException(errorMessage);
+                default:
+                    return new TropipayJSException(errorMessage, axiosResponse.status, axiosResponse.data.error);
+            }
+        }
+        else if (error.request) {
+            // Axios request was made but no response received (e.g., network error)
+            return new TropipayJSException("Request failed: No response received", 500, null);
+        }
+        else {
+            // Something else went wrong
+            return new TropipayJSException("An error occurred", 500, null);
+        }
+    }
+    else {
+        return new TropipayJSException(`jsbfvbsfvbf`, 500, null);
+    }
+}
+class TropipayJSException extends Error {
+    code; // Status code
+    error;
+    message;
+    constructor(message, code, data) {
+        super(message);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, TropipayJSException.prototype);
+        this.code = code;
+        this.error = data;
+        this.message = message;
+    }
+}
+
 class TropipayHooks {
     tropipay;
     // ... hook-related functionality ...
@@ -69,7 +114,7 @@ class TropipayHooks {
             return hooks.data;
         }
         catch (error) {
-            throw new Error(`Could not get subscribe new hook`);
+            throw handleExceptions(error);
         }
     }
     /**
@@ -94,7 +139,7 @@ class TropipayHooks {
             return hooks.data;
         }
         catch (error) {
-            throw new Error(`Could not get subscribed hooks`);
+            throw handleExceptions(error);
         }
     }
     async update(eventType, target, value) {
@@ -116,7 +161,7 @@ class TropipayHooks {
             return hooks.data;
         }
         catch (error) {
-            throw new Error(`Could not update subscribed hooks`);
+            throw handleExceptions(error);
         }
     }
     async delete(eventType, target) {
@@ -135,7 +180,7 @@ class TropipayHooks {
         }
         catch (error) {
             console.trace(error);
-            throw new Error(`Could not delete subscribed hooks`);
+            throw handleExceptions(error);
         }
     }
     async events() {
@@ -153,7 +198,7 @@ class TropipayHooks {
             return hooks.data;
         }
         catch (error) {
-            throw new Error(`Could not get events list for hooks ${error}`);
+            throw handleExceptions(error);
         }
     }
 }
@@ -184,7 +229,7 @@ class PaymentCard {
             return paylink.data;
         }
         catch (error) {
-            throw new Error(`TropipayJS - Error creating the Payment Card.`);
+            throw handleExceptions(error);
         }
     }
     /**
@@ -225,7 +270,129 @@ class PaymentCard {
             return paymentcard.data;
         }
         catch (error) {
-            throw new Error(`Could not retrieve PaymenCards`);
+            throw handleExceptions(error);
+        }
+    }
+}
+
+class DepositAccounts {
+    tropipay;
+    constructor(tropipayInstance) {
+        this.tropipay = tropipayInstance;
+    }
+    /**
+     * List od all beneficiaries of this account
+     * @returns Array of DepositAccounts
+     */
+    async list() {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const deposit = await this.tropipay.request.get(`/api/v2/deposit_accounts`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return deposit.data;
+        }
+        catch (error) {
+            return handleExceptions(error);
+        }
+    }
+    /**
+     * Adds a new beneficiary to the user account.
+     * @param payload
+     * @returns
+     */
+    async create(depositAccountObj) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const deposit = await this.tropipay.request.post("/api/v2/deposit_accounts", depositAccountObj, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return deposit.data;
+        }
+        catch (error) {
+            return handleExceptions(error);
+        }
+    }
+    /**
+     * This returns details of a specific
+     * Deposit Account (beneficiary) specified by its ID
+     * @param id
+     * @returns
+     */
+    async get(id) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const deposit = await this.tropipay.request.get(`/api/v2/deposit_accounts/${id}`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return deposit.data;
+        }
+        catch (error) {
+            return handleExceptions(error);
+        }
+    }
+    /**
+     * Updates certain beneficiary data.
+     * @param depositAccountObj
+     * @returns
+     */
+    async update(depositAccountObj) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const deposit = await this.tropipay.request.put(`/api/v2/deposit_accounts/`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return deposit.data;
+        }
+        catch (error) {
+            return handleExceptions(error);
+        }
+    }
+    /**
+     * (UNTESTED) Deletes the beneficiary indicated by id
+     * @param id
+     * @returns
+     */
+    async delete(id) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const deposit = await this.tropipay.request.delete(`/api/v2/deposit_accounts/${id}`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return deposit.data;
+        }
+        catch (error) {
+            return handleExceptions(error);
         }
     }
 }
@@ -244,7 +411,8 @@ class Tropipay {
     static refreshToken;
     serverMode;
     hooks;
-    paymentcards;
+    paymentCards;
+    depositAccounts;
     constructor(config) {
         this.clientId = config.clientId;
         this.clientSecret = config.clientSecret;
@@ -260,7 +428,8 @@ class Tropipay {
             },
         });
         this.hooks = new TropipayHooks(this);
-        this.paymentcards = new PaymentCard(this);
+        this.paymentCards = new PaymentCard(this);
+        this.depositAccounts = new DepositAccounts(this);
     }
     async login() {
         try {
@@ -280,10 +449,7 @@ class Tropipay {
             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}`);
+            throw handleExceptions(error);
         }
     }
     /**
@@ -306,7 +472,7 @@ class Tropipay {
             return deposits.data;
         }
         catch (error) {
-            throw new Error(`Could not retrieve the account deposits ${error}`);
+            throw handleExceptions(error);
         }
     }
     /**
@@ -320,7 +486,7 @@ class Tropipay {
             return countries.data;
         }
         catch (error) {
-            throw new Error(`Could not retrieve the countries list`);
+            throw handleExceptions(error);
         }
     }
     /**
@@ -342,7 +508,7 @@ class Tropipay {
             return balance.data;
         }
         catch (error) {
-            throw new Error(`TropipayJS Error - Could not retrieve the user's balance`);
+            throw handleExceptions(error);
         }
     }
     /**
@@ -381,7 +547,7 @@ class Tropipay {
             return favoritesList?.data?.rows;
         }
         catch (error) {
-            throw new Error(`Could not retrieve favorites list ${error}`);
+            throw handleExceptions(error);
         }
     }
     /**
@@ -404,7 +570,7 @@ class Tropipay {
             return movements.data;
         }
         catch (error) {
-            throw new Error(`Could not retrieve movements list ${error}`);
+            throw handleExceptions(error);
         }
     }
     /**
@@ -419,7 +585,7 @@ class Tropipay {
             return profile.data;
         }
         catch (error) {
-            throw new Error(`Could not retrieve movements list ${error}`);
+            throw handleExceptions(error);
         }
     }
     /**
@@ -448,7 +614,7 @@ class Tropipay {
             return rates.data.rate;
         }
         catch (error) {
-            throw new Error(`Could not retrieve rates ${error}`);
+            throw handleExceptions(error);
         }
     }
     /**
@@ -474,12 +640,14 @@ class Tropipay {
             return mediation.data;
         }
         catch (error) {
-            throw new Error(`Could not create mediation payment card`);
+            throw handleExceptions(error);
         }
     }
 }
 class ClientSideUtils {
-    constructor(tropipayInstance) { }
+    constructor(tropipayInstance) {
+        throw Error(`Not implemented yet`);
+    }
 }
 
 class ServerSideUtils {
@@ -528,6 +696,7 @@ if (typeof window !== "undefined") {
 }
 
 exports.ClientSideUtils = ClientSideUtils;
+exports.DepositAccounts = DepositAccounts;
 exports.PaymentCard = PaymentCard;
 exports.SERVER_MODE = SERVER_MODE;
 exports.ServerSideUtils = ServerSideUtils;

package/interfaces/depositaccounts/index.d.ts

@@ -0,0 +1,68 @@
+export interface DepositAccountConfig {
+    searchValue?: string;
+    alias: string;
+    userRelationTypeId: number;
+    beneficiaryType: BeneficiaryType;
+    searchBy?: number;
+    accountNumber?: string;
+    swift?: string;
+    type: DepositAccountType;
+    firstName?: string;
+    lastName?: string;
+    secondLastName?: string;
+    countryDestinationId?: number;
+    city?: string;
+    postalCode?: number;
+    address?: string;
+    documentNumber?: string;
+    phone?: string;
+    province?: string;
+    paymentType?: string;
+    documentTypeId?: number;
+    documentExpirationDate: string;
+}
+type INTERNAL = 1;
+type EXTERNAL = 2;
+export type BeneficiaryType = INTERNAL | EXTERNAL;
+export declare const DepositAccountTypesList: {
+    /**
+     * Banco Metropolitano (Cuba) Bank Account
+     */
+    readonly BANMET_BANK_ACCOUNT: 0;
+    /**
+     * Banco Popular de Ahorro
+     */
+    readonly BPA_BANK_ACCOUNT: 1;
+    /**
+     * Banco de Credito y Comercio (Cuba) Bank Account
+     */
+    readonly BANDEC_BANK_ACCOUNT: 2;
+    /**
+     * Banco Metropilitano (Cuba) card
+     */
+    readonly BANMET_CARD: 3;
+    /**
+     * Banco Popular de Ahorro (Cuba) card
+     */
+    readonly BPA_CARD: 4;
+    /**
+     * Not available anymore
+     * @deprecated
+     */
+    readonly AIS_CUC_CARD: 5;
+    /**
+     * Not available
+     * @deprecated
+     */
+    readonly AIS_USD_CARD: 6;
+    /**
+     * For international bank accounts
+     */
+    readonly OTHER: 7;
+    /**
+     * Banco de Credito y comercio card
+     */
+    readonly BANDEC_CARD: 8;
+};
+export type DepositAccountType = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9 | 10 | 11;
+export {};

package/package.json

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

package/src/api/TropipayAPI.ts

@@ -19,6 +19,8 @@ import {
 type ServerMode = "Development" | "Production";
 import { TropipayHooks } from "../hooks/TropipayHooks";
 import { PaymentCard } from "../paymentcard/PaymentCard";
+import { DepositAccounts } from "../depositAccount/depositAccounts";
+import { handleExceptions } from "../utils/errors";
 export class Tropipay {
   readonly clientId: string;
   readonly clientSecret: string;
@@ -27,7 +29,8 @@ export class Tropipay {
   public static refreshToken: string | undefined;
   public serverMode: ServerMode;
   public hooks: TropipayHooks;
-  public paymentcards: PaymentCard;
+  public paymentCards: PaymentCard;
+  public depositAccounts: DepositAccounts;
 
   constructor(config: TropipayConfig) {
     this.clientId = config.clientId;
@@ -45,7 +48,8 @@ export class Tropipay {
       },
     });
     this.hooks = new TropipayHooks(this);
-    this.paymentcards = new PaymentCard(this);
+    this.paymentCards = new PaymentCard(this);
+    this.depositAccounts = new DepositAccounts(this);
   }
 
   public async login() {
@@ -71,14 +75,7 @@ export class Tropipay {
       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 handleExceptions(error as any);
     }
   }
 
@@ -101,7 +98,7 @@ export class Tropipay {
       });
       return deposits.data;
     } catch (error) {
-      throw new Error(`Could not retrieve the account deposits ${error}`);
+      throw handleExceptions(error as any);
     }
   }
 
@@ -115,7 +112,7 @@ export class Tropipay {
       const countries = await this.request.get("/api/v2/countries");
       return countries.data;
     } catch (error) {
-      throw new Error(`Could not retrieve the countries list`);
+      throw handleExceptions(error as any);
     }
   }
   /**
@@ -136,9 +133,7 @@ export class Tropipay {
       });
       return balance.data;
     } catch (error) {
-      throw new Error(
-        `TropipayJS Error - Could not retrieve the user's balance`
-      );
+      throw handleExceptions(error as any);
     }
   }
 
@@ -182,7 +177,7 @@ export class Tropipay {
       );
       return favoritesList?.data?.rows;
     } catch (error) {
-      throw new Error(`Could not retrieve favorites list ${error}`);
+      throw handleExceptions(error as any);
     }
   }
 
@@ -205,7 +200,7 @@ export class Tropipay {
       });
       return movements.data;
     } catch (error) {
-      throw new Error(`Could not retrieve movements list ${error}`);
+      throw handleExceptions(error as any);
     }
   }
 
@@ -219,7 +214,7 @@ export class Tropipay {
       const profile = await this.request.get("/api/users/profile");
       return profile.data;
     } catch (error) {
-      throw new Error(`Could not retrieve movements list ${error}`);
+      throw handleExceptions(error as any);
     }
   }
 
@@ -255,7 +250,7 @@ export class Tropipay {
       );
       return rates.data.rate;
     } catch (error) {
-      throw new Error(`Could not retrieve rates ${error}`);
+      throw handleExceptions(error as any);
     }
   }
 
@@ -286,11 +281,13 @@ export class Tropipay {
       );
       return mediation.data as PaymentLink;
     } catch (error) {
-      throw new Error(`Could not create mediation payment card`);
+      throw handleExceptions(error as any);
     }
   }
 }
 
 export class ClientSideUtils {
-  constructor(tropipayInstance: Tropipay) {}
+  constructor(tropipayInstance: Tropipay) {
+    throw Error(`Not implemented yet`);
+  }
 }

package/src/depositAccount/depositAccounts.ts

@@ -0,0 +1,139 @@
+import { AxiosError } from "axios";
+import { Tropipay } from "../api/TropipayAPI";
+import { DepositAccountConfig } from "../interfaces/depositaccounts";
+import { handleExceptions } from "../utils/errors";
+export class DepositAccounts {
+  private tropipay: Tropipay;
+  constructor(tropipayInstance: Tropipay) {
+    this.tropipay = tropipayInstance;
+  }
+
+  /**
+   * List od all beneficiaries of this account
+   * @returns Array of DepositAccounts
+   */
+  public async list() {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.get(
+        `/api/v2/deposit_accounts`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      return handleExceptions(error as unknown as any);
+    }
+  }
+  /**
+   * Adds a new beneficiary to the user account.
+   * @param payload
+   * @returns
+   */
+  public async create(depositAccountObj: DepositAccountConfig) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.post(
+        "/api/v2/deposit_accounts",
+        depositAccountObj,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      return handleExceptions(error as unknown as any);
+    }
+  }
+  /**
+   * This returns details of a specific
+   * Deposit Account (beneficiary) specified by its ID
+   * @param id
+   * @returns
+   */
+  public async get(id: string) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.get(
+        `/api/v2/deposit_accounts/${id}`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      return handleExceptions(error as unknown as any);
+    }
+  }
+
+  /**
+   * Updates certain beneficiary data.
+   * @param depositAccountObj
+   * @returns
+   */
+  public async update(depositAccountObj: Partial<DepositAccountConfig>) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.put(
+        `/api/v2/deposit_accounts/`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      return handleExceptions(error as unknown as any);
+    }
+  }
+
+  /**
+   * (UNTESTED) Deletes the beneficiary indicated by id
+   * @param id
+   * @returns
+   */
+  public async delete(id: number) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.delete(
+        `/api/v2/deposit_accounts/${id}`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      return handleExceptions(error as unknown as any);
+    }
+  }
+}

package/src/hooks/TropipayHooks.ts

@@ -1,5 +1,6 @@
 import { HookEventType, UserHookSubscribed } from "../interfaces";
 import { Tropipay } from "../api/TropipayAPI";
+import { handleExceptions } from "../utils/errors";
 export class TropipayHooks {
   private tropipay: Tropipay;
   // ... hook-related functionality ...
@@ -52,7 +53,7 @@ export class TropipayHooks {
       );
       return hooks.data;
     } catch (error) {
-      throw new Error(`Could not get subscribe new hook`);
+      throw handleExceptions(error as unknown as any);
     }
   }
   /**
@@ -79,7 +80,7 @@ export class TropipayHooks {
       );
       return hooks.data;
     } catch (error) {
-      throw new Error(`Could not get subscribed hooks`);
+      throw handleExceptions(error as unknown as any);
     }
   }
   public async update(
@@ -108,7 +109,7 @@ export class TropipayHooks {
       );
       return hooks.data;
     } catch (error) {
-      throw new Error(`Could not update subscribed hooks`);
+      throw handleExceptions(error as unknown as any);
     }
   }
   async delete(eventType: HookEventType, target: string) {
@@ -129,7 +130,7 @@ export class TropipayHooks {
       return hooks.data;
     } catch (error) {
       console.trace(error);
-      throw new Error(`Could not delete subscribed hooks`);
+      throw handleExceptions(error as unknown as any);
     }
   }
 
@@ -147,7 +148,7 @@ export class TropipayHooks {
       });
       return hooks.data;
     } catch (error) {
-      throw new Error(`Could not get events list for hooks ${error}`);
+      throw handleExceptions(error as unknown as any);
     }
   }
 }

package/src/index.ts

@@ -10,6 +10,8 @@
  * @license MIT
  */
 
+import { DepositAccounts } from "./depositAccount/depositAccounts";
+
 if (typeof window !== "undefined") {
   console.warn(
     "DANGER This library should not be used client side, your credentials could be exposed"
@@ -21,6 +23,7 @@ export { ClientSideUtils } from "./api/TropipayAPI";
 export { ServerSideUtils } from "./utils/TropipayUtils";
 export { TropipayHooks } from "./hooks/TropipayHooks";
 export { PaymentCard } from "./paymentcard/PaymentCard";
+export { DepositAccounts } from "./depositAccount/depositAccounts";
 export * from "./interfaces/index";
 export { SERVER_MODE } from "./config/TropipayConfig";
 export * from "./constants/TropipayConstants";

package/src/interfaces/depositaccounts/index.ts

@@ -0,0 +1,70 @@
+export interface DepositAccountConfig {
+  searchValue?: string;
+  alias: string;
+  userRelationTypeId: number;
+  beneficiaryType: BeneficiaryType;
+  searchBy?: number;
+  accountNumber?: string;
+  swift?: string;
+  type: DepositAccountType;
+  firstName?: string;
+  lastName?: string;
+  secondLastName?: string;
+  countryDestinationId?: number;
+  city?: string;
+  postalCode?: number;
+  address?: string;
+  documentNumber?: string;
+  phone?: string;
+  province?: string;
+  paymentType?: string;
+  documentTypeId?: number;
+  documentExpirationDate: string;
+}
+type INTERNAL = 1;
+type EXTERNAL = 2;
+
+export type BeneficiaryType = INTERNAL | EXTERNAL;
+
+export const DepositAccountTypesList = {
+  /**
+   * Banco Metropolitano (Cuba) Bank Account
+   */
+  BANMET_BANK_ACCOUNT: 0,
+  /**
+   * Banco Popular de Ahorro
+   */
+  BPA_BANK_ACCOUNT: 1,
+  /**
+   * Banco de Credito y Comercio (Cuba) Bank Account
+   */
+  BANDEC_BANK_ACCOUNT: 2,
+  /**
+   * Banco Metropilitano (Cuba) card
+   */
+  BANMET_CARD: 3,
+  /**
+   * Banco Popular de Ahorro (Cuba) card
+   */
+  BPA_CARD: 4,
+  /**
+   * Not available anymore
+   * @deprecated
+   */
+  AIS_CUC_CARD: 5,
+  /**
+   * Not available
+   * @deprecated
+   */
+  AIS_USD_CARD: 6,
+  /**
+   * For international bank accounts
+   */
+  OTHER: 7,
+  /**
+   * Banco de Credito y comercio card
+   */
+  BANDEC_CARD: 8,
+} as const;
+
+export type DepositAccountType = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9 | 10 | 11;

package/src/paymentcard/PaymentCard.ts

@@ -1,9 +1,9 @@
 import { Tropipay } from "../api/TropipayAPI";
 import { PaymentLink } from "../interfaces";
 import { PaymentLinkPayload } from "../interfaces";
+import { handleExceptions } from "../utils/errors";
 export class PaymentCard {
   private tropipay: Tropipay;
-
   constructor(tropipayInstance: Tropipay) {
     this.tropipay = tropipayInstance;
   }
@@ -32,7 +32,7 @@ export class PaymentCard {
       );
       return paylink.data as PaymentLink;
     } catch (error) {
-      throw new Error(`TropipayJS - Error creating the Payment Card.`);
+      throw handleExceptions(error as unknown as any);
     }
   }
   /**
@@ -78,7 +78,7 @@ export class PaymentCard {
       );
       return paymentcard.data;
     } catch (error) {
-      throw new Error(`Could not retrieve PaymenCards`);
+      throw handleExceptions(error as unknown as any);
     }
   }
 }

package/src/utils/TropipayUtils.ts

@@ -1,5 +1,8 @@
 import * as crypto from "crypto";
 import { Tropipay } from "../api/TropipayAPI";
+import { AxiosError, AxiosResponse } from "axios";
+
+
 export class ServerSideUtils {
   private tropipay: Tropipay;
   constructor(tropipayInstance: Tropipay) {

package/src/utils/errors.ts

@@ -0,0 +1,97 @@
+import { AxiosError, AxiosResponse } from "axios";
+
+const ErrorType = {
+  VALIDATION_ERROR: "VALIDATION_ERROR", // 400
+  UNAUTHORIZED_ERROR: "UNAUTHORIZED_ERROR", // 401 (Not valid credentials)
+  FORBIDDEN_ERROR: "FORBIDDEN_ERROR", // 403 (Valid credentials but insufficient to grant access)
+  NOT_FOUND: "NOT_FOUND", // 404
+  RATE_LIMIT_ERROR: "RATE_LIMIT_ERROR", // 429 (Used only in cloudflare for now)
+  OPERATION_ERROR: "OPERATION_ERROR", // 500
+} as const;
+
+const ErrorCode = {
+  VALIDATION_ERROR: "VALIDATION_ERROR",
+  UNAUTHORIZED_ERROR: "UNAUTHORIZED_ERROR",
+  FORBIDDEN_ERROR: "FORBIDDEN_ERROR",
+  NOT_FOUND: "NOT_FOUND",
+  RATE_LIMIT_ERROR: "RATE_LIMIT_ERROR",
+  OPERATION_ERROR: "OPERATION_ERROR",
+  SYNTAX_ERROR: "SYNTAX_ERROR",
+  INVALID_PARAM: "INVALID_PARAM",
+  UNHANDLED_ERROR: "SERVER_ERROR",
+} as const;
+
+export interface ErrorDetail {
+  param: string;
+  value: string | number | null;
+  msg: string;
+  code: string;
+  location: string | null;
+  meta: unknown;
+}
+export function handleExceptions(
+  error: AxiosError | Error
+): TropipayJSException {
+  if (error instanceof AxiosError) {
+    if (error.response) {
+      const axiosResponse: AxiosResponse = error.response;
+      const errorMessage =
+        axiosResponse.data?.error?.message || "An error occurred";
+
+      switch (axiosResponse.status) {
+        case 401:
+          return new TropipayJSException(
+            errorMessage,
+            axiosResponse.status,
+            axiosResponse.data.error
+          );
+        case 403:
+          return new TropipayJSException(
+            errorMessage,
+            axiosResponse.status,
+            axiosResponse.data.error
+          );
+        case 404:
+          return new TropipayJSException(
+            errorMessage,
+            axiosResponse.status,
+            axiosResponse.data.error
+          );
+        // case 429:
+        //   return new TooManyRequestsException(errorMessage);
+        default:
+          return new TropipayJSException(
+            errorMessage,
+            axiosResponse.status,
+            axiosResponse.data.error
+          );
+      }
+    } else if (error.request) {
+      // Axios request was made but no response received (e.g., network error)
+      return new TropipayJSException(
+        "Request failed: No response received",
+        500,
+        null
+      );
+    } else {
+      // Something else went wrong
+      return new TropipayJSException("An error occurred", 500, null);
+    }
+  } else {
+    return new TropipayJSException(`jsbfvbsfvbf`, 500, null);
+  }
+}
+
+class TropipayJSException extends Error {
+  code: number; // Status code
+  error: unknown;
+  message: string;
+  constructor(message: string, code: number, data: unknown) {
+    super(message);
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, TropipayJSException.prototype);
+    this.code = code;
+    this.error = data;
+    this.message = message;
+  }
+}

package/utils/errors.d.ts

@@ -0,0 +1,17 @@
+import { AxiosError } from "axios";
+export interface ErrorDetail {
+    param: string;
+    value: string | number | null;
+    msg: string;
+    code: string;
+    location: string | null;
+    meta: unknown;
+}
+export declare function handleExceptions(error: AxiosError | Error): TropipayJSException;
+declare class TropipayJSException extends Error {
+    code: number;
+    error: unknown;
+    message: string;
+    constructor(message: string, code: number, data: unknown);
+}
+export {};