@yosle/tropipayjs 0.1.10 → 0.1.12

package/index.js

@@ -34,15 +34,52 @@ class TropipayHooks {
     constructor(tropipayInstance) {
         this.tropipay = tropipayInstance;
     }
-    static async subscribeHook(eventType, target, value) { }
     /**
-     * Get hook the sucbcribed hook info by his eventType.
-     * If no eventType is passed it will return
-     * all subscribed hooks or empty Array if none hooks exist.
-     * @param eventType or no params for retrieving all hooks
+     * Subscribe a new hook
+     * @param event String that represents the name of the event,
+     * you must select from the list of available events, otherwise
+     * it will not produce an error but it will not be executed.
+     * For get full list of available events see endpoint
+     * GET /api/v2/hook/events.
+     * @param target String representing the type of event supported.
+     * It is currently available: 'web' (allows to receive information in a url),
+     * 'email' (allows to receive information in an email address).
+     * @param value if the selected 'target' is email the value would be an
+     *  email address, likewise if the selected 'target' is 'web' the expected
+     *  value corresponds to a url that receives information through the
+     * HTTP POST method.
      * @returns
      */
-    async getSubscribedHook(eventType) {
+    async subscribe({ eventType, target, value, }) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const hooks = await this.tropipay.request.post(`/api/v2/hooks`, {
+                event: eventType,
+                target: target,
+                value: value,
+            }, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return hooks.data;
+        }
+        catch (error) {
+            throw new Error(`Could not get subscribe new hook`);
+        }
+    }
+    /**
+     * Get the sucbcribed hook info by his event type.
+     * If no event type is passed, it will return
+     * all subscribed hooks or empty Array if none exist.
+     * @param eventType or no params for retrieving all hooks
+     * @returns All subscribed hooks or empty Array if none exist.
+     */
+    async list(eventType) {
         if (!Tropipay.accessToken) {
             await this.tropipay.login();
         }
@@ -57,16 +94,67 @@ class TropipayHooks {
             return hooks.data;
         }
         catch (error) {
-            throw new Error(`Could not get subscribed hooks ${error}`);
+            throw new Error(`Could not get subscribed hooks`);
         }
     }
-    async updateSubscribedHook(eventType) {
-        //TODO
-        throw new Error("Not implementet yet");
+    async update(eventType, target, value) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const hooks = await this.tropipay.request.put(`/api/v2/hooks`, {
+                event: eventType,
+                target: target,
+                value: value,
+            }, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return hooks.data;
+        }
+        catch (error) {
+            throw new Error(`Could not update subscribed hooks`);
+        }
     }
-    async deleteSubscribedHook(eventType) {
-        //TODO
-        throw new Error("Not implementet yet");
+    async delete(eventType, target) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const hooks = await this.tropipay.request.delete(`/api/v2/hooks/${eventType}/${target}`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return hooks.data;
+        }
+        catch (error) {
+            console.trace(error);
+            throw new Error(`Could not delete subscribed hooks`);
+        }
+    }
+    async events() {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const hooks = await this.tropipay.request.get(`/api/v2/hooks/events`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return hooks.data;
+        }
+        catch (error) {
+            throw new Error(`Could not get events list for hooks ${error}`);
+        }
     }
 }
 
@@ -124,30 +212,6 @@ class Tropipay {
             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) {
-        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;
-        }
-        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
@@ -270,8 +334,8 @@ class Tropipay {
         }
     }
     /**
-     * Return profile data for this account.
-     * @returns
+     * Return profile data for current Tropipay account.
+     * @returns account object
      */
     async profile() {
         if (!Tropipay.accessToken)
@@ -336,7 +400,7 @@ class Tropipay {
             return mediation.data;
         }
         catch (error) {
-            throw new Error(`Could not generate mediation paymentCard ${error}`);
+            throw new Error(`Could not create mediation payment card`);
         }
     }
 }
@@ -374,6 +438,21 @@ class ServerSideUtils {
 
 const SERVER_MODE = "Development"; // Move the constant here
 
+/**
+ * TropipayJS is a powerful TypeScript/JavaScript library designed to provide seamless interaction
+ * with the Tropipay API. It simplifies the process of integrating Tropipay's functionality into
+ * your applications.
+ *
+ * Developed by Yosleivy Baez Acosta
+ * GitHub: https://github.com/yosle/tropipayjs
+ *
+ * @version 0.1.11
+ * @license MIT
+ */
+if (typeof window !== "undefined") {
+    console.warn("DANGER This library should not be used client side, your credentials could be exposed");
+}
+
 exports.ClientSideUtils = ClientSideUtils;
 exports.SERVER_MODE = SERVER_MODE;
 exports.ServerSideUtils = ServerSideUtils;

package/interfaces/index.d.ts

@@ -13,7 +13,7 @@ export type TropipayCredentials = {
     clientId: string;
     clientSecret: string;
 };
-export type HookEventType = "transaction_completed" | "transaction_charged" | "transaction_guarded";
+export type HookEventType = "transaction_completed" | "transaction_charged" | "transaction_guarded" | "user_signup" | "user_kyc" | "payment_in_state_change" | "payment_out_state_change" | "beneficiary_added" | "beneficiary_updated" | "beneficiary_deleted" | "transaction_new" | "transaction_preauthorized" | "transaction_pendingin" | "transaction_processing" | "transaction_error" | "transaction_bloqued" | "transaction_guarded_send" | "transaction_guarded_mediation" | "user_after_update" | "user_after_create" | "userDetail_after_create" | "userDetail_after_update" | "tpv_callback_ok" | "fraud_state_on_change";
 export type HookTargetType = "web" | "email";
 export interface UserHook {
     event: HookEventType;

package/interfaces/paymentlink/index.d.ts

@@ -1,3 +1,50 @@
+type PaymentMethodElement = "EXT" | "TPP";
+export type PaymentMethods = Element | [PaymentMethodElement, PaymentMethodElement];
+declare enum Reasons {
+    HOUSING_ARRANGEMENT = 1,
+    FINANCIAL_AID = 2,
+    FAMILY_SUPPORT = 3,
+    TRAVEL_FUND = 4,
+    REAL_ESTATE_PURCHASE = 5,
+    FURNITURE_PURCHASE = 6,
+    EDUCATION = 7,
+    MEDICAL_EXPENSES = 8,
+    OTHER = 9,
+    DEBT_PAYMENT = 10,
+    TOURISM = 11,
+    SELF_SHIPPING = 12,
+    ACCOUNT_ACTIVATION = 13,
+    SPORTS_ACTIVITIES = 14,
+    DONATION = 15,
+    AFFILIATE_COMMISSION = 16,
+    SALARY = 17,
+    SAVINGS = 18,
+    RENT_AND_LEASING = 19,
+    SHARED_EXPENSES = 20,
+    SERVICE_PAYMENT = 21,
+    GIFT = 22,
+    CRYPTOCURRENCY_PURCHASE = 23,
+    OPERATING_EXPENSES = 24,
+    CURRENCY_EXCHANGE = 25,
+    ACCOMMODATION = 26,
+    EQUIPMENT_PURCHASE = 27,
+    CONSULTING = 28,
+    SOFTWARE_DEVELOPMENT = 29,
+    REFUND = 30,
+    PACKAGE_DELIVERY = 31,
+    PERSONAL_EXPENSES = 32,
+    INVESTMENT = 33,
+    BILL_PAYMENT = 34,
+    HOST_PAYMENT = 35,
+    TRANSPORTATION = 36,
+    LOAN = 37,
+    BONUS = 38,
+    HALLOWEEN_REMITTANCE = 39,
+    PLINK_REMITTANCE = 41,
+    R1_2023 = 78,
+    HAPPYWEEK = 79,
+    SENDING_YOU_A_KISS = 80
+}
 export interface PaymentLinkPayload {
     reference: string;
     concept: string;
@@ -6,14 +53,17 @@ export interface PaymentLinkPayload {
     currency: string;
     description: string;
     singleUse: boolean;
-    reasonId: number;
+    reasonId: Reasons;
     expirationDays: number;
     lang: string;
     urlSuccess: string;
     urlFailed: string;
     urlNotification: string;
     serviceDate: string;
-    client: {
+    /**
+     * fgfsgdfgdfgd
+     */
+    client?: {
         name: string;
         lastName: string;
         address: string;
@@ -21,9 +71,9 @@ export interface PaymentLinkPayload {
         email: string;
         countryId: number;
         termsAndConditions: boolean;
-    };
-    directPayment: boolean;
-    paymentMethods?: string[];
+    } | null;
+    directPayment?: boolean;
+    paymentMethods?: PaymentMethods;
 }
 export interface PaymentLink extends PaymentLinkPayload {
     expirationDate: string;
@@ -34,3 +84,4 @@ export interface PaymentLink extends PaymentLinkPayload {
     shortUrl: string;
     paymentUrl: string;
 }
+export {};

package/package.json

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

package/paymentcard/PaymentCard.d.ts

@@ -0,0 +1,21 @@
+import { Tropipay } from "../api/TropipayAPI";
+import { PaymentLink } from "../interfaces";
+import { PaymentLinkPayload } from "../interfaces";
+export declare class PaymentCard {
+    private tropipay;
+    constructor(tropipayInstance: Tropipay);
+    /**
+     * 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
+     */
+    create(payload: PaymentLinkPayload): Promise<PaymentLink>;
+    /**
+     * Shows a list of stored paymentcards created by user.
+     * This list includes active and closed paylinks
+     * @returns Array of paymentlinks
+     */
+    list(): Promise<any>;
+    get(id: string): Promise<any>;
+}

package/src/api/TropipayAPI.ts

@@ -79,32 +79,6 @@ export class Tropipay {
     }
   }
 
-  /**
-   * 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
@@ -233,8 +207,8 @@ export class Tropipay {
   }
 
   /**
-   * Return profile data for this account.
-   * @returns
+   * Return profile data for current Tropipay account.
+   * @returns account object
    */
   async profile() {
     if (!Tropipay.accessToken) await this.login();
@@ -309,7 +283,7 @@ export class Tropipay {
       );
       return mediation.data as PaymentLink;
     } catch (error) {
-      throw new Error(`Could not generate mediation paymentCard ${error}`);
+      throw new Error(`Could not create mediation payment card`);
     }
   }
 }

package/src/hooks/TropipayHooks.ts

@@ -6,22 +6,63 @@ export class TropipayHooks {
   constructor(tropipayInstance: Tropipay) {
     this.tropipay = tropipayInstance;
   }
-
-  public static async subscribeHook(
-    eventType: HookEventType,
-    target: string,
-    value: string
-  ) {}
   /**
-   * Get hook the sucbcribed hook info by his eventType.
-   * If no eventType is passed it will return
-   * all subscribed hooks or empty Array if none hooks exist.
-   * @param eventType or no params for retrieving all hooks
+   * Subscribe a new hook
+   * @param event String that represents the name of the event,
+   * you must select from the list of available events, otherwise
+   * it will not produce an error but it will not be executed.
+   * For get full list of available events see endpoint
+   * GET /api/v2/hook/events.
+   * @param target String representing the type of event supported.
+   * It is currently available: 'web' (allows to receive information in a url),
+   * 'email' (allows to receive information in an email address).
+   * @param value if the selected 'target' is email the value would be an
+   *  email address, likewise if the selected 'target' is 'web' the expected
+   *  value corresponds to a url that receives information through the
+   * HTTP POST method.
    * @returns
    */
-  public async getSubscribedHook(
-    eventType?: HookEventType
-  ): Promise<UserHookSubscribed[]> {
+  public async subscribe({
+    eventType,
+    target,
+    value,
+  }: {
+    eventType: HookEventType;
+    target: "email" | "web";
+    value: string;
+  }) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const hooks = await this.tropipay.request.post(
+        `/api/v2/hooks`,
+        {
+          event: eventType,
+          target: target,
+          value: value,
+        },
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return hooks.data;
+    } catch (error) {
+      throw new Error(`Could not get subscribe new hook`);
+    }
+  }
+  /**
+   * Get the sucbcribed hook info by his event type.
+   * If no event type is passed, it will return
+   * all subscribed hooks or empty Array if none exist.
+   * @param eventType or no params for retrieving all hooks
+   * @returns All subscribed hooks or empty Array if none exist.
+   */
+  public async list(eventType?: HookEventType): Promise<UserHookSubscribed[]> {
     if (!Tropipay.accessToken) {
       await this.tropipay.login();
     }
@@ -38,15 +79,75 @@ export class TropipayHooks {
       );
       return hooks.data;
     } catch (error) {
-      throw new Error(`Could not get subscribed hooks ${error}`);
+      throw new Error(`Could not get subscribed hooks`);
+    }
+  }
+  public async update(
+    eventType: string,
+    target: "web" | "email",
+    value: string
+  ) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const hooks = await this.tropipay.request.put(
+        `/api/v2/hooks`,
+        {
+          event: eventType,
+          target: target,
+          value: value,
+        },
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return hooks.data;
+    } catch (error) {
+      throw new Error(`Could not update subscribed hooks`);
     }
   }
-  public async updateSubscribedHook(eventType?: string) {
-    //TODO
-    throw new Error("Not implementet yet");
+  async delete(eventType: HookEventType, target: string) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const hooks = await this.tropipay.request.delete(
+        `/api/v2/hooks/${eventType}/${target}`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return hooks.data;
+    } catch (error) {
+      console.trace(error);
+      throw new Error(`Could not delete subscribed hooks`);
+    }
   }
-  async deleteSubscribedHook(eventType?: string) {
-    //TODO
-    throw new Error("Not implementet yet");
+
+  async events() {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const hooks = await this.tropipay.request.get(`/api/v2/hooks/events`, {
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bearer ${Tropipay.accessToken}`,
+          Accept: "application/json",
+        },
+      });
+      return hooks.data;
+    } catch (error) {
+      throw new Error(`Could not get events list for hooks ${error}`);
+    }
   }
 }

package/src/index.ts

@@ -1,9 +1,21 @@
 /**
- * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
+ * TropipayJS is a powerful TypeScript/JavaScript library designed to provide seamless interaction
+ * with the Tropipay API. It simplifies the process of integrating Tropipay's functionality into
+ * your applications.
  *
- * @author Yosleivy Baez Acosta
+ * Developed by Yosleivy Baez Acosta
+ * GitHub: https://github.com/yosle/tropipayjs
  *
+ * @version 0.1.11
+ * @license MIT
  */
+
+if (typeof window !== "undefined") {
+  console.warn(
+    "DANGER This library should not be used client side, your credentials could be exposed"
+  );
+}
+
 export { Tropipay } from "./api/TropipayAPI";
 export { ClientSideUtils } from "./api/TropipayAPI";
 export { ServerSideUtils } from "./utils/TropipayUtils";

package/src/interfaces/index.ts

@@ -16,7 +16,28 @@ export type TropipayCredentials = { clientId: string; clientSecret: string };
 export type HookEventType =
   | "transaction_completed"
   | "transaction_charged"
-  | "transaction_guarded";
+  | "transaction_guarded"
+  | "user_signup"
+  | "user_kyc"
+  | "payment_in_state_change"
+  | "payment_out_state_change"
+  | "beneficiary_added"
+  | "beneficiary_updated"
+  | "beneficiary_deleted"
+  | "transaction_new"
+  | "transaction_preauthorized"
+  | "transaction_pendingin"
+  | "transaction_processing"
+  | "transaction_error"
+  | "transaction_bloqued"
+  | "transaction_guarded_send"
+  | "transaction_guarded_mediation"
+  | "user_after_update"
+  | "user_after_create"
+  | "userDetail_after_create"
+  | "userDetail_after_update"
+  | "tpv_callback_ok"
+  | "fraud_state_on_change";
 
 export type HookTargetType = "web" | "email";
 export interface UserHook {