@yosle/tropipayjs 0.1.6 → 0.1.8

package/LICENSE

@@ -1,10 +1,10 @@
-MIT License
-
-Copyright (c) 2022 Yosleivy Baez Acosta.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+MIT License
+
+Copyright (c) 2022 Yosleivy Baez Acosta.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,115 +1,131 @@
-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) 
-![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)
-- [Table of Contents](#table-of-contents)
-  - [About the project](#about-the-project)
-- [Getting started](#getting-started)
-  - [Setting up your app credentials](#setting-up-your-app-credentials)
-  - [Usage](#usage)
-    - [CommonJS](#commonjs)
-    - [ES6](#es6)
-    - [Initialize the Tropipay class](#initialize-the-tropipay-class)
-    - [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.
-# Getting started
-You can use npm or yarn to install this package:
-
-```npm install @yosle/tropipayjs``` 
-
-or
-
-```yarn add @yosle/tropipayjs```
-
-## Setting up your app credentials
-
-![alt]([/docs/images/app-credentials-menu.png](https://github.com/yosle/tropipayjs/blob/master/docs/images/app-credentials-menu.png))
-![alt]([/docs/images/confirmation-code-screen.png](https://github.com/yosle/tropipayjs/blob/master/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.
-
-## 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.
-
-### 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
-/*
-* Example Payload
-*/
-const payload = await tpp.createPayLink({
-        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.createPayLink(payload)
-console.log(paylink.shortUrl)
-```
-
-For more examples, please refer to the [Documentation](https://github.com/yosle/tropipayjs/blob/master/docs/)
-
-# Contributing
-If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
-
-1. Fork the Project
-2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
-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. 
-
-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.
-
-
-
-
+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) 
+![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)
+- [Table of Contents](#table-of-contents)
+  - [About the project](#about-the-project)
+- [Getting started](#getting-started)
+  - [Setting up your app credentials](#setting-up-your-app-credentials)
+  - [Usage](#usage)
+    - [CommonJS](#commonjs)
+    - [ES6](#es6)
+    - [Initialize the Tropipay class](#initialize-the-tropipay-class)
+    - [Generating a Payment Link](#generating-a-payment-link)
+- [Contributing](#contributing)
+- [License](#license)
+
+## About the project
+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:
+
+```npm install @yosle/tropipayjs``` 
+
+or
+
+```yarn add @yosle/tropipayjs```
+
+## Setting up your app credentials
+
+![alt](https://github.com/yosle/tropipayjs/blob/master/docs/images/app-credentials-menu.png?raw=true)
+![alt](https://github.com/yosle/tropipayjs/blob/master/docs/images/confirmation-code-screen.png?raw=true)
+
+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 environment](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.
+
+## 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.
+
+### CommonJS 
+```javascript
+const { Tropipay } = require('@yosle/tropipayjs')
+```
+### ES6 
+```javascript
+import { Tropipay } from '@yosle/tropipayjs'
+```
+### Initialize the Tropipay class
+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")
+```
+
+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')
+```
+### Generating a Payment Link
+```javascript
+/*
+* Example Payload
+*/
+const payload = await tpp.createPayLink({
+        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.createPayLink(payload)
+console.log(paylink.shortUrl)
+```
+
+For more examples, please refer to the [Documentation](https://github.com/yosle/tropipayjs/blob/master/docs/)
+
+# Contributing
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+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. 
+
+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/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

@@ -1,74 +1,74 @@
-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<string>,
-    updatedAt: Date<string>,
-    countryDestination: Country
-}
-
-type AccountDeposits = {
-   count: number,
-   rows:  Deposit[]
+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<string>,
+    updatedAt: Date<string>,
+    countryDestination: Country
+}
+
+type AccountDeposits = {
+   count: number,
+   rows:  Deposit[]
 }

package/index.d.ts

@@ -37,6 +37,29 @@ interface PaymentLink extends PaymentLinkPayload {
     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.
  *
@@ -44,15 +67,20 @@ interface PaymentLink extends PaymentLinkPayload {
  *
  */
 
-declare type ServerMode = 'Development' | 'Production';
+type ServerMode = 'Development' | 'Production';
+interface TropipayConfig {
+    clientId: string;
+    clientSecret: string;
+    serverMode?: ServerMode;
+}
 declare class Tropipay {
-    readonly clientId: string;
-    readonly clientSecret: string;
+    protected clientId: string;
+    protected clientSecret: string;
     protected request: Axios;
-    protected accessToken: string | undefined;
-    protected refreshToken: string | undefined;
+    protected static accessToken: string | undefined;
+    protected static refreshToken: string | undefined;
     protected serverMode: ServerMode;
-    constructor(client_id: string, client_secret: string, server_mode?: ServerMode);
+    constructor(config: TropipayConfig);
     login(): Promise<LoginResponse>;
     /**
      * Create a paymentLink with the specified options.
@@ -60,7 +88,7 @@ declare class Tropipay {
      * @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>;
+    createPaymentCard(payload: PaymentLinkPayload): Promise<PaymentLink>;
     /**
      * Get all deposits in this account.
      * @returns A Promise of an Array of AccountDeposits or throws an Exception
@@ -83,9 +111,8 @@ declare class Tropipay {
      */
     destinations(): Promise<Country[]>;
     /**
-     * Get list of all the favorites accounts. This endpoint is not documented
-     * in the official Tropipay documentation.
-     * @returns
+     * Get list of all the favorites payment links.
+     * @returns Array of account Object or throws an error
      */
     favorites(): Promise<any>;
     /**
@@ -99,9 +126,25 @@ declare class Tropipay {
      * @returns
      */
     profile(): Promise<any>;
-    rates(payload?: {
-        currencyFrom: string;
-    }): 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 };