@yosle/tropipayjs 0.1.8 → 0.1.10

package/src/index.ts

@@ -1,272 +1,13 @@
-/**
- * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
- * 
- * @author Yosleivy Baez Acosta
- * 
- */
-
-import axios, { Axios } from "axios";
-import { PaymentLink, PaymentLinkPayload } from './interfaces/paymentlink'
-import { mediationPaymentCardConfig } from "./interfaces/mediation";
-
-type ServerMode = 'Development' | 'Production'
-
-interface TropipayConfig {
-    clientId: string;
-    clientSecret: string;
-    serverMode?: ServerMode;
-}
-
-export 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) {
-        this.clientId = config.clientId;
-        this.clientSecret = config.clientSecret;
-        this.serverMode = config.serverMode || 'Development';
-        this.request = axios.create({
-            baseURL: this.serverMode === 'Production'
-                ? 'https://www.tropipay.com'
-                : 'https://tropipay-dev.herokuapp.com',
-            headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json',
-                Authorization: `Bearer ${Tropipay.accessToken}`,
-            }
-        });
-    }
-
-
-    async login() {
-        try {
-            const { data } = await this.request.post<LoginResponse>('/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"
-            }, {
-                headers: {
-                    'Content-Type': 'application/json',
-                    Accept: 'application/json',
-                }
-            });
-
-            Tropipay.accessToken = data.access_token
-            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}`);
-
-        }
-    }
-
-    /**
-     * Create a paymentLink with the specified options.
-     * @param payload PaymentLinkPayload Object.
-     * @returns Promise<PaymentLink> or throws an Exception.
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6ODgyNTM3OQ-create-a-new-pay-link-charge
-     */
-    async createPaymentCard(payload: PaymentLinkPayload): Promise<PaymentLink> {
-        if (!Tropipay.accessToken) {
-            await this.login()
-        }
-        try {
-            const paylink = await this.request.post('/api/v2/paymentcards', payload, {
-                headers: {
-                    'Content-Type': 'application/json',
-                    Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: 'application/json'
-                }
-            })
-            return paylink.data as PaymentLink
-        } catch (error) {
-            throw new Error(`Could not obtain the access token with the given credentials.`);
-        }
-    }
-
-    /**
-     * Get all deposits in this account.
-     * @returns A Promise of an Array of AccountDeposits or throws an Exception
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6OTgyOTQ1Mg-get-deposit-accounts-list
-     */
-    async getDepositAccounts(): Promise<AccountDeposits[] | Error> {
-        if (!Tropipay.accessToken) {
-            await this.login()
-        }
-        try {
-            const deposits = await this.request.get('/api/v2/deposit_accounts', {
-                headers: {
-                    'Content-Type': 'application/json',
-                    Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: 'application/json'
-                }
-            })
-            return deposits.data
-        } catch (error) {
-            throw new Error(`Could not retrieve the account deposits ${error}`);
-        }
-    }
-
-    /**
-     * Get the list of all supported countries by Tropipay.
-     * @returns Array of Countries Data
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/bfac21259e2ff-getting-users-countries-list
-     */
-    async countries(): Promise<Country[]> {
-        try {
-            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`);
-        }
-    }
-
-    /**
-     * Get the list of all detination countries supported by Tropipay. 
-     * Obtaining the list of valid countries to send funds to. Useful
-     * when adding new beneficiaries to some user.
-     * 
-     * @returns Array of Country Objects
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/3cfe5504f0524-getting-list-of-beneficiary-countries
-     */
-    async destinations(): Promise<Country[]> {
-        try {
-            const countries = await this.request.get('/api/v2/countries/destinations')
-            return countries.data
-        } catch (error) {
-            throw new Error(`Could not retrieve the destination countries list`);
-        }
-    }
-
-    /**
-     * Get list of all the favorites payment links. 
-     * @returns Array of account Object or throws an error
-     */
-    async favorites() {
-        if (!Tropipay.accessToken) {
-            await this.login()
-        }
-        try {
-            const favoritesList = await this.request.get('/api/v2/paymentcards/favorites', {
-                headers: {
-                    'Content-Type': 'application/json',
-                    Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: 'application/json'
-                }
-            });
-            return favoritesList?.data?.rows
-        } catch (error) {
-            throw new Error(`Could not retrieve favorites list ${error}`);
-        }
-    }
-
-    /**
-     * List all account movements. You can optionaly specify
-     * offset and limit params for pagination.
-     * @returns 
-     */
-    async movements(offset = 0, limit = 10) {
-        if (!Tropipay.accessToken) await this.login()
-
-        try {
-            const movements = await this.request.get('/api/v2/movements',
-                {
-                    params: { limit: limit, offset: offset },
-                    headers: {
-                        'Content-Type': 'application/json',
-                        Accept: 'application/json',
-                        Authorization: `Bearer ${Tropipay.accessToken}`
-                    }
-                })
-            return movements.data
-        } catch (error) {
-            throw new Error(`Could not retrieve movements list ${error}`);
-        }
-    }
-
-    /**
-     * Return profile data for this account.
-     * @returns 
-     */
-    async profile() {
-        if (!Tropipay.accessToken) await this.login();
-        try {
-            const profile = await this.request.get('/api/users/profile')
-            return profile.data
-        } catch (error) {
-            throw new Error(`Could not retrieve movements list ${error}`);
-        }
-    }
-
-    /**
-     * 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
-     */
-    async rates(originCurrency: string, targetCurrency: string = 'EUR'): Promise<number | Error> {
-        if (!Tropipay.accessToken) {
-            await this.login()
-        }
-        try {
-            const rates = await this.request.post('/api/v2/movements/get_rate',
-                {
-                    currencyFrom: originCurrency,
-                    currencyTo: targetCurrency
-                }, {
-                headers: {
-                    'Content-Type': 'application/json',
-                    Accept: 'application/json',
-                    Authorization: `Bearer ${Tropipay.accessToken}`,
-
-                }
-            })
-            return rates.data.rate
-        } catch (error) {
-            throw new Error(`Could not retrieve rates ${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
-     */
-    async createMediationPaymentCard(config: mediationPaymentCardConfig): Promise<PaymentLink> {
-        if (!Tropipay.accessToken) await this.login();
-        try {
-            const mediation = await this.request.post('/api/v2/paymentcards/mediation', config, {
-                headers: {
-                    'Content-Type': 'application/json',
-                    Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: 'application/json'
-                }
-            })
-            return mediation.data as PaymentLink;
-        } catch (error) {
-            throw new Error(`Could not generate mediation paymentCard ${error}`);
-        }
-
-
-    }
-
-}
-
-
-
-
+/**
+ * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
+ *
+ * @author Yosleivy Baez Acosta
+ *
+ */
+export { Tropipay } from "./api/TropipayAPI";
+export { ClientSideUtils } from "./api/TropipayAPI";
+export { ServerSideUtils } from "./utils/TropipayUtils";
+export { TropipayHooks } from "./hooks/TropipayHooks";
+export * from "./interfaces/index";
+export { SERVER_MODE } from "./config/TropipayConfig";
+export * from "./constants/TropipayConstants";

package/src/interfaces/index.js

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

package/src/interfaces/index.ts

@@ -1,4 +1,172 @@
-import * as countries from './countries'
-
-
-export {countries}
+import { ServerMode } from "../constants/TropipayConstants";
+
+export type AccountBalance = {
+  balance: number;
+  pendingIn: number;
+  pendingOut: number;
+};
+
+export interface TropipayConfig {
+  clientId: string;
+  clientSecret: string;
+  serverMode?: ServerMode;
+}
+
+export type TropipayCredentials = { clientId: string; clientSecret: string };
+export type HookEventType =
+  | "transaction_completed"
+  | "transaction_charged"
+  | "transaction_guarded";
+
+export type HookTargetType = "web" | "email";
+export interface UserHook {
+  event: HookEventType;
+  target: string;
+  value: string;
+}
+export interface UserHookSubscribed extends UserHook {
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface UserHook {
+  event: HookEventType;
+  target: string;
+  value: string;
+}
+export interface UserHookSubscribed extends UserHook {
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface PaymentLinkPayload {
+  reference: string;
+  concept: string;
+  favorite: boolean;
+  amount: number;
+  currency: string;
+  description: string;
+  singleUse: boolean;
+  reasonId: number;
+  expirationDays: number;
+  lang: string;
+  urlSuccess: string;
+  urlFailed: string;
+  urlNotification: string;
+  serviceDate: string;
+  client: {
+    name: string;
+    lastName: string;
+    address: string;
+    phone: string;
+    email: string;
+    countryId: number;
+    termsAndConditions: boolean;
+  };
+  directPayment: boolean;
+  paymentMethods?: string[];
+}
+
+export interface PaymentLink extends PaymentLinkPayload {
+  expirationDate: string;
+  hasClient: boolean;
+  updatedAt: string;
+  createdAt: string;
+  qrImage: string;
+  shortUrl: string;
+  paymentUrl: string;
+}
+
+export 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;
+}
+
+export type LoginResponse = {
+  access_token: string;
+  refresh_token: string;
+  token_type: "Bearer";
+  expires_in: number;
+  scope: string;
+};
+
+export type LoginError = {
+  error: string;
+};
+
+export 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;
+};
+
+export 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;
+};
+
+export type AccountDeposits = {
+  count: number;
+  rows: Deposit[];
+};

package/src/interfaces/mediation/index.ts

@@ -1,23 +1,23 @@
-
-/**
- * 
- */
-export interface mediationPaymentCardConfig {
-    amount: number //5000,
-    currency: "EUR" | "USD",
-    concept: string //Celular,
-    description: string,
-    reference: string, //458424548,
-    singleUse: boolean,
-    lang: string// es,
-    productUrl?: string,
-    buyer: null | any //null,
-    seller: {
-        sellerId?: number,
-        type?: number,
-        email?: string
-    },
-    feePercent?: number,//in cents
-    feeFixed?: number,
-    sendMail: boolean
+
+/**
+ * 
+ */
+export interface mediationPaymentCardConfig {
+    amount: number //5000,
+    currency: "EUR" | "USD",
+    concept: string //Celular,
+    description: string,
+    reference: string, //458424548,
+    singleUse: boolean,
+    lang: string// es,
+    productUrl?: string,
+    buyer: null | any //null,
+    seller: {
+        sellerId?: number,
+        type?: number,
+        email?: string
+    },
+    feePercent?: number,//in cents
+    feeFixed?: number,
+    sendMail: boolean
 }

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

@@ -1,36 +1,36 @@
-export interface PaymentLinkPayload {
-    reference: string;
-    concept: string;
-    favorite: boolean;
-    amount: number;
-    currency: string;
-    description: string;
-    singleUse: boolean;
-    reasonId: number;
-    expirationDays: number;
-    lang: string;
-    urlSuccess: string;
-    urlFailed: string;
-    urlNotification: string;
-    serviceDate: string;
-    client: {
-        name: string;
-        lastName: string;
-        address: string;
-        phone: string;
-        email: string;
-        countryId: number;
-        termsAndConditions: boolean;
-    };
-    directPayment: boolean;
-    paymentMethods?: string[];
-}
-export interface PaymentLink extends PaymentLinkPayload {
-    expirationDate: string;
-    hasClient: boolean;
-    updatedAt: string;
-    createdAt: string;
-    qrImage: string;
-    shortUrl: string;
-    paymentUrl: string;
-}
+export interface PaymentLinkPayload {
+    reference: string;
+    concept: string;
+    favorite: boolean;
+    amount: number;
+    currency: string;
+    description: string;
+    singleUse: boolean;
+    reasonId: number;
+    expirationDays: number;
+    lang: string;
+    urlSuccess: string;
+    urlFailed: string;
+    urlNotification: string;
+    serviceDate: string;
+    client: {
+        name: string;
+        lastName: string;
+        address: string;
+        phone: string;
+        email: string;
+        countryId: number;
+        termsAndConditions: boolean;
+    };
+    directPayment: boolean;
+    paymentMethods?: string[];
+}
+export interface PaymentLink extends PaymentLinkPayload {
+    expirationDate: string;
+    hasClient: boolean;
+    updatedAt: string;
+    createdAt: string;
+    qrImage: string;
+    shortUrl: string;
+    paymentUrl: string;
+}

package/src/interfaces/paymentlink/index.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=index.js.map

package/src/interfaces/paymentlink/index.ts

@@ -1,40 +1,40 @@
-
-export interface PaymentLinkPayload {    
-    reference: string,
-    concept: string,
-    favorite: boolean,
-    amount: number,
-    currency: string,
-    description : string,
-    singleUse: boolean,
-    reasonId: number,
-    expirationDays: number,
-    lang:string,
-    urlSuccess: string,
-    urlFailed: string,
-    urlNotification: string,
-    serviceDate: string,
-    client: {
-        name: string,
-        lastName: string,
-        address: string,
-        phone: string,
-        email:string,
-        countryId: number,
-        termsAndConditions: boolean
-    },
-    directPayment: boolean
-    paymentMethods?:string[]
-
-}
-
-export interface PaymentLink extends PaymentLinkPayload {
-expirationDate: string,
-hasClient:boolean,
-updatedAt:string,
-createdAt: string,
-qrImage: string,
-shortUrl: string,
-paymentUrl: string
-
+
+export interface PaymentLinkPayload {    
+    reference: string,
+    concept: string,
+    favorite: boolean,
+    amount: number,
+    currency: string,
+    description : string,
+    singleUse: boolean,
+    reasonId: number,
+    expirationDays: number,
+    lang:string,
+    urlSuccess: string,
+    urlFailed: string,
+    urlNotification: string,
+    serviceDate: string,
+    client: {
+        name: string,
+        lastName: string,
+        address: string,
+        phone: string,
+        email:string,
+        countryId: number,
+        termsAndConditions: boolean
+    },
+    directPayment: boolean
+    paymentMethods?:string[]
+
+}
+
+export interface PaymentLink extends PaymentLinkPayload {
+expirationDate: string,
+hasClient:boolean,
+updatedAt:string,
+createdAt: string,
+qrImage: string,
+shortUrl: string,
+paymentUrl: string
+
 }