@yosle/tropipayjs 0.1.7 → 0.1.9

package/README.md

@@ -22,8 +22,13 @@ TropiPay is an electronic wallet that allows you to execute the most common fina
     - [Generating a Payment Link](#generating-a-payment-link)
 - [Contributing](#contributing)
 - [License](#license)
+
 ## About the project
-This library is a community effort still under development so use caution if you're planing to use it in production. Tropipay may make some changes on the API Specification in the future. Use the [test environment](https://tropipay-dev.herokuapp.com) to make sure everything is working as expected.
+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. 
+
+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.
 # Getting started
 You can use npm or yarn to install this package:
 
@@ -55,24 +60,32 @@ import { Tropipay } from '@yosle/tropipayjs'
 You can instantiate the Tropipay class passing the client Id ,client secret and optionally the serverMode parameter, if no serverMode is provided, `Development` will be used as default. Make sure you use the [test environment](https://tropipay-dev.herokuapp.com) credentials when serverMode is on `Development`.
 
 ```javascript
-// test environment server
-const tpp = new Tropipay("yourclientidhere",
-    "yourclientsecrethere")
+// test environment server tropipay-dev.herokuapp.com
+const config = {    
+    clientId: process.env.TROPIPAY_CLIENT_ID,
+    clientSecret: process.env.TROPIPAY_CLIENT_SECRET
+    serverMode: 'Development' // it will be used as default if omited
+}
+const tpp = new Tropipay(config)
 ```
 
 To use your live credentials (real account) you must explicity set serverMode to `Production`.
 
 ```javascript
 //real account credentials
-const tpp = new Tropipay("yourclientidhere",
-    "yourclientsecrethere",'Production')
+const config = {    
+    clientId: process.env.TROPIPAY_CLIENT_ID,
+    clientSecret: process.env.TROPIPAY_CLIENT_SECRET,
+    serverMode: 'Production' //live account
+}
+const tpp = new Tropipay(config)
 ```
 ### Generating a Payment Link
 ```javascript
 /*
 * Example Payload
 */
-const payload = await tpp.createPayLink({
+const payload = {
         reference: "my-paylink-1",
         concept: "Bicycle",
         favorite: "true",
@@ -97,11 +110,10 @@ const payload = await tpp.createPayLink({
             termsAndConditions: "true"
         },
         directPayment: "true"
-    })
-    
+    }
 // Use inside an async function
-const paylink = await tpp.createPayLink(payload)
-console.log(paylink.shortUrl)
+const paylink = await tpp.createPaymentCard(payload);
+console.log(paylink.shortUrl);
 ```
 
 For more examples, please refer to the [Documentation](https://github.com/yosle/tropipayjs/blob/master/docs/)

package/docs/index.MD

@@ -0,0 +1,19 @@
+# Tropipayjs
+
+Tropipayjs is a TypeScript/JavaScript library for the Tropipay API.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [API Reference](#api-reference)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+To use Tropipayjs in your project, you need to install it via npm. Run the following command:
+
+```npm install tropipayjs```
+or
+```yarn add tropipayjs```

package/globals.d.ts

@@ -11,20 +11,20 @@ type LoginError = {
 }
 
 type Country = {
-        id: number,
-        name: string,
-        sepaZone: boolean,
-        state: number,
-        slug: string,
-        slugn: number,
-        callingCode: number,
-        isDestination: boolean,
-        isRisky: boolean,
-        currentCurrency: string | null,
-        createdAt: string,
-        updatedAt: string,
-        isFavorite: boolean,
-        position: any
+    id: number,
+    name: string,
+    sepaZone: boolean,
+    state: number,
+    slug: string,
+    slugn: number,
+    callingCode: number,
+    isDestination: boolean,
+    isRisky: boolean,
+    currentCurrency: string | null,
+    createdAt: string,
+    updatedAt: string,
+    isFavorite: boolean,
+    position: any
 
 }
 
@@ -69,6 +69,7 @@ type Deposit = {
 }
 
 type AccountDeposits = {
-   count: number,
-   rows:  Deposit[]
-}
+    count: number,
+    rows: Deposit[]
+}
+

package/index.d.ts

@@ -1,113 +1,160 @@
-import { Axios } from 'axios';
-
-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[];
-}
-interface PaymentLink extends PaymentLinkPayload {
-    expirationDate: string;
-    hasClient: boolean;
-    updatedAt: string;
-    createdAt: string;
-    qrImage: string;
-    shortUrl: string;
-    paymentUrl: string;
-}
-
-/**
- * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
- *
- * @author Yosleivy Baez Acosta
- *
- */
-
-declare type ServerMode = 'Development' | 'Production';
-declare class Tropipay {
-    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 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>;
-    /**
-     * 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 Data
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/bfac21259e2ff-getting-users-countries-list
-     */
-    countries(): Promise<Country[]>;
-    /**
-     * 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
-     */
-    favorites(): Promise<any>;
-    /**
-     * List all account movements. 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>;
-    /**
-     * Obtain current Tropipay conversion rate. For example USD to EUR
-     * targetCurrency must be 'EUR'
-     * @param originCurrency Target currency code supported by Tropipay.
-     * @param targetCurrency Must be 'EUR'? (not documented by Tropipay)
-     * @returns Conversion rate (number)
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/85163f6f28b23-get-rate
-     */
-    rates(originCurrency: string, targetCurrency?: string): Promise<number | Error>;
-}
-
-export { Tropipay };
+import { Axios } from 'axios';
+
+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[];
+}
+interface PaymentLink extends PaymentLinkPayload {
+    expirationDate: string;
+    hasClient: boolean;
+    updatedAt: string;
+    createdAt: string;
+    qrImage: string;
+    shortUrl: string;
+    paymentUrl: string;
+}
+
+/**
+ *
+ */
+interface mediationPaymentCardConfig {
+    amount: number;
+    currency: "EUR" | "USD";
+    concept: string;
+    description: string;
+    reference: string;
+    singleUse: boolean;
+    lang: string;
+    productUrl?: string;
+    buyer: null | any;
+    seller: {
+        sellerId?: number;
+        type?: number;
+        email?: string;
+    };
+    feePercent?: number;
+    feeFixed?: number;
+    sendMail: boolean;
+}
+
+/**
+ * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
+ *
+ * @author Yosleivy Baez Acosta
+ *
+ */
+
+type ServerMode = 'Development' | 'Production';
+interface TropipayConfig {
+    clientId: string;
+    clientSecret: string;
+    serverMode?: ServerMode;
+}
+type AccountBalance = {
+    balance: number;
+    pendingIn: number;
+    pendingOut: number;
+};
+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;
+    constructor(config: TropipayConfig);
+    login(): Promise<LoginResponse>;
+    /**
+     * 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
+     */
+    createPaymentCard(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 Data
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/bfac21259e2ff-getting-users-countries-list
+     */
+    countries(): Promise<Country[]>;
+    /**
+     * Get user balance
+     * @returns balance object
+     */
+    getBalance(): Promise<AccountBalance>;
+    /**
+     * Get the list of all detination countries supported by Tropipay.
+     * Obtaining the list of valid countries to send funds to. Useful
+     * 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 payment links.
+     * @returns Array of account Object or throws an error
+     */
+    favorites(): Promise<any>;
+    /**
+     * List all account movements. 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>;
+    /**
+     * Obtain current Tropipay conversion rate. For example USD to EUR
+     * targetCurrency must be 'EUR'
+     * @param originCurrency Target currency code supported by Tropipay.
+     * @param targetCurrency Must be 'EUR'? (not documented by Tropipay)
+     * @returns Conversion rate (number)
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/85163f6f28b23-get-rate
+     */
+    rates(originCurrency: string, targetCurrency?: string): Promise<number | Error>;
+    /**
+     * (ONLY in Bussiness Accounts)
+     * An escrow payment link. This allows a payment to be made to persons
+     * belonging or not to the TropiPay platform with the particularity
+     * that the payment will be held in custody or retained until it is
+     * released with the approval of the payer.
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/12a128ff971e4-creating-a-mediation-payment-card
+     * @param config Payload with the payment details
+     */
+    createMediationPaymentCard(config: mediationPaymentCardConfig): Promise<PaymentLink>;
+}
+
+export { Tropipay };