@yosle/tropipayjs 0.1.21 → 0.1.23

package/src/interfaces/paymentlink/index.ts

@@ -1,91 +1,91 @@
-type PaymentMethodElement = "EXT" | "TPP";
-export type PaymentMethods =
-  | Element
-  | [PaymentMethodElement, PaymentMethodElement];
-
-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;
-  favorite: boolean;
-  amount: number;
-  currency: string;
-  description: string;
-  singleUse: boolean;
-  reasonId: Reasons;
-  expirationDays: number;
-  lang: string;
-  urlSuccess: string;
-  urlFailed: string;
-  urlNotification: string;
-  serviceDate: string;
-  /**
-   * fgfsgdfgdfgd
-   */
-  client?: {
-    name: string;
-    lastName: string;
-    address: string;
-    phone: string;
-    email: string;
-    countryId: number;
-    termsAndConditions: boolean;
-  } | null;
-  directPayment?: boolean;
-  paymentMethods?: PaymentMethods;
-}
-
-export interface PaymentLink extends PaymentLinkPayload {
-  expirationDate: string;
-  hasClient: boolean;
-  updatedAt: string;
-  createdAt: string;
-  qrImage: string;
-  shortUrl: string;
-  paymentUrl: string;
-}
+type PaymentMethodElement = "EXT" | "TPP";
+export type PaymentMethods =
+  | Element
+  | [PaymentMethodElement, PaymentMethodElement];
+
+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;
+  favorite: boolean;
+  amount: number;
+  currency: string;
+  description: string;
+  singleUse: boolean;
+  reasonId: Reasons;
+  expirationDays: number;
+  lang: string;
+  urlSuccess: string;
+  urlFailed: string;
+  urlNotification: string;
+  serviceDate: string;
+  /**
+   * fgfsgdfgdfgd
+   */
+  client?: {
+    name: string;
+    lastName: string;
+    address: string;
+    phone: string;
+    email: string;
+    countryId: number;
+    termsAndConditions: boolean;
+  } | null;
+  directPayment?: boolean;
+  paymentMethods?: PaymentMethods;
+}
+
+export interface PaymentLink extends PaymentLinkPayload {
+  expirationDate: string;
+  hasClient: boolean;
+  updatedAt: string;
+  createdAt: string;
+  qrImage: string;
+  shortUrl: string;
+  paymentUrl: string;
+}

package/src/mediationPaymentCard/MediationPaymentCard.ts

@@ -0,0 +1,42 @@
+import { Tropipay } from "../api/TropipayAPI";
+import { PaymentLink } from "../interfaces";
+import { MediationPaymentCardConfig } from "../interfaces";
+import { handleExceptions } from "../utils/errors";
+
+export default class MediationPaymentCard {
+  private tropipay: Tropipay;
+  constructor(tropipayInstance: Tropipay) {
+    this.tropipay = tropipayInstance;
+  }
+
+  /**
+   * (ONLY FOR BUSINESS ACCOUNTS) Create a mediation paymentcard (an escrow payment link) with the specified options.
+   * 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.
+   * @param payload PaymentLinkPayload Object.
+   * @returns Promise<PaymentLink> or throws an Exception.
+   * @see https://tpp.stoplight.io/docs/tropipay-api-doc/12a128ff971e4-creating-a-mediation-payment-card
+   */
+  async create(payload: MediationPaymentCardConfig): Promise<PaymentLink> {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const paylink = await this.tropipay.request.post(
+        "/api/v2/paymentcards/mediation",
+        payload,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return paylink.data as PaymentLink;
+    } catch (error) {
+      throw handleExceptions(error as unknown as any);
+    }
+  }
+}

package/src/paymentcard/PaymentCard.ts

@@ -1,84 +1,123 @@
-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;
-  }
-
-  /**
-   * 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 create(payload: PaymentLinkPayload): Promise<PaymentLink> {
-    if (!Tropipay.accessToken) {
-      await this.tropipay.login();
-    }
-    try {
-      const paylink = await this.tropipay.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 handleExceptions(error as unknown as any);
-    }
-  }
-  /**
-   * Shows a list of stored paymentcards created by user.
-   * This list includes active and closed paylinks
-   * @returns Array of paymentlinks
-   */
-  public async list() {
-    if (!Tropipay.accessToken) {
-      await this.tropipay.login();
-    }
-    try {
-      const paymentcards = await this.tropipay.request.get(
-        `/api/v2/paymentcards`,
-        {
-          headers: {
-            "Content-Type": "application/json",
-            Authorization: `Bearer ${Tropipay.accessToken}`,
-            Accept: "application/json",
-          },
-        }
-      );
-      return paymentcards.data;
-    } catch (error) {
-      throw new Error(`Could not retrieve PaymenCards list`);
-    }
-  }
-
-  public async get(id: string) {
-    if (!Tropipay.accessToken) {
-      await this.tropipay.login();
-    }
-    try {
-      const paymentcard = await this.tropipay.request.get(
-        `/api/v2/paymentcards/${id}`,
-        {
-          headers: {
-            "Content-Type": "application/json",
-            Authorization: `Bearer ${Tropipay.accessToken}`,
-            Accept: "application/json",
-          },
-        }
-      );
-      return paymentcard.data;
-    } catch (error) {
-      throw handleExceptions(error as unknown as any);
-    }
-  }
-}
+import { Tropipay } from "../api/TropipayAPI";
+import { PaymentLink } from "../interfaces";
+import { PaymentLinkPayload } from "../interfaces";
+import { handleExceptions } from "../utils/errors";
+export default class PaymentCard {
+  private tropipay: Tropipay;
+  constructor(tropipayInstance: Tropipay) {
+    this.tropipay = tropipayInstance;
+  }
+
+  /**
+   * 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 create(payload: PaymentLinkPayload): Promise<PaymentLink> {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const paylink = await this.tropipay.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 handleExceptions(error as unknown as any);
+    }
+  }
+  /**
+   * Shows a list of stored paymentcards created by user.
+   * This list includes active and closed paylinks
+   * @returns Array of paymentlinks
+   */
+  public async list() {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const paymentcards = await this.tropipay.request.get(
+        `/api/v2/paymentcards`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return paymentcards.data;
+    } catch (error) {
+      throw new Error(`Could not retrieve PaymenCards list`);
+    }
+  }
+
+  /**
+   * Retrieves a payment card with the specified ID.
+   *
+   * @param {string} id - The ID of the payment card to retrieve.
+   * @return {Promise<any>} A Promise that resolves to the payment card data.
+   * @throws {Error} If an error occurs while retrieving the payment card.
+   */
+  public async get(id: string) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const paymentcard = await this.tropipay.request.get(
+        `/api/v2/paymentcards/${id}`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return paymentcard.data;
+    } catch (error) {
+      throw handleExceptions(error as unknown as any);
+    }
+  }
+
+  /**
+   * Deletes a payment card with the specified ID. Its a LOGIC delete
+   * so this will delete the paymentcard from paymentcard list and
+   * disable shortUrl but not paymentUrl
+   * @param {string} id - The ID of the payment card to delete.
+   * @return {Promise<any>} A Promise that resolves to the deleted payment card data.
+   * @throws {Error} If an error occurs while deleting the payment card.
+   */
+  public async delete(id: string) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const paymentcard = await this.tropipay.request.delete(
+        `/api/v2/paymentcards/`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+          data: {
+            cardId: id,
+          },
+        }
+      );
+      return paymentcard.data;
+    } catch (error) {
+      throw handleExceptions(error as unknown as any);
+    }
+  }
+}

package/src/paymentcard/paymentcard.spec.ts

@@ -1,10 +1,79 @@
-import { describe, expect, it } from "vitest";
-
-function sum(a: number, b: number) {
-  return a + b;
-}
-describe("dummy test", () => {
-  it("dummy test", () => {
-    expect(sum(1, 2)).toBe(3);
-  });
-});
+import { Tropipay } from "../../src/api/TropipayAPI";
+import { PaymentLinkPayload } from "../interfaces";
+import { TropipayJSException } from "../utils/errors";
+import PaymentCard from "./PaymentCard";
+
+jest.mock("axios");
+jest.mock("../../src/api/TropipayAPI");
+
+describe("Create PaymentCard", () => {
+  describe("create", () => {
+    it("should create a payment link", async () => {
+      const payload: PaymentLinkPayload = {
+        amount: 200,
+        client: null,
+        concept: "Concept",
+        currency: "EUR",
+        description: "Description",
+        directPayment: true,
+        expirationDays: 30,
+        favorite: false,
+        reasonId: 45,
+        reference: "Reference",
+        serviceDate: "2022-01-01",
+        urlFailed: "urlFailed",
+        urlNotification: "urlNotification",
+        urlSuccess: "urlSuccess",
+        singleUse: false,
+        paymentMethods: ["EXT"],
+        lang: "es",
+      };
+      const expectedPaymentLink = {
+        id: "1f8b0600-0b62-11ef-b879-9d16dab40e58",
+        reference: "08025834659",
+        concept: "NFT Purchase",
+        description: "Golden Monkey NFT character",
+        amount: 500,
+        currency: "EUR",
+        singleUse: true,
+        favorite: false,
+        reasonId: 4,
+        reasonDes: null,
+        expirationDays: 0,
+        userId: "a9546500-65c0-11ed-97e6-2ffd2c53074d",
+        lang: "es",
+        imageBase: null,
+        state: 1,
+        urlSuccess: null,
+        urlFailed: null,
+        urlNotification: null,
+        expirationDate: null,
+        serviceDate: null,
+        hasClient: false,
+        credentialId: 129710,
+        force3ds: false,
+        saveToken: true,
+        origin: 2,
+        paymentcardType: 1,
+        updatedAt: "2024-05-06T04:35:54.352Z",
+        createdAt: "2024-05-06T04:35:53.568Z",
+        qrImage:
+          "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKQAAACkCAYAAAAZtYVBAAAAAklEQVR4AewaftIAAAcPSURBVO3B0ald3QqA0S+yexKsxfKsRbCq3LxdnyZM1ton5scxfv3+g7WGENYaRFhrEGGtQYS1BhHWGkRYaxBhrUGEtQYR1hpEWGsQYa1BhLUGEdYaRFhrEGGtQT48ZOr8pKzgxNQ5yQqeMHVuZAVvMnVOsoLO1PlJWcETwlqDCGsNIqw1yIeXZQVvMnXeZOp0WcGJqfOEqdNlBZ2p02UFnalzkhXcyAreZOq8SVhrEGGtQYS1BvnwZabOjazgiazgCVOnywpumDpdVtCZOl1WcJIVdKbOm0ydG1nBNwlrDSKsNYiw1iAf/mNMnS4rODF1uqzgxNTpsoJvMnVOTJ0uK/iXCWsNIqw1iLDWIB/+cabODVPnhqlzYurcyAo6U6fLCrqsoDN1/suEtQYR1hpEWGuQD1+WFXxTVvAmU6fLCk5MnRumTpcVnJg6J1nBE1nBJMJagwhrDSKsNciHl5k6P8nU6bKCztTpsoLO1Omygs7U6bKCk6ygM3W6rKAzdbqs4CQr6EydLis4MXUmE9YaRFhrEGGtQT48lBX8S0ydE1PnRlZwkhV0pk6XFZxkBU9kBf8SYa1BhLUGEdYa5MOXmTonWcGJqXPD1Omygs7U6bKCG6ZOlxW8ydTpsoLO1DkxdU6ygs7U6bKCv0lYaxBhrUGEtQb58JCp02UFXVbQmTqdqXOSFXyTqdNlBZ2pc8PUuWHq/E1ZQWfqdFlBZ+qcZAVPCGsNIqw1iLDWIB8eygpuZAU3TJ0uKzgxdW5kBSdZwRNZwYmp02UFN7KCE1PnXyKsNYiw1iDCWoN8eMjUuZEV3MgKTkydN5k6XVbQmTonWcGNrOBGVnAjK+hMnTdlBW8S1hpEWGsQYa1BPjyUFXSmTpcV3DB1bmQFnalzkhWcZAVPmDonWcGJqdNlBZ2pcyMr6LKCE1PnbxLWGkRYaxBhrUF+/f6DH2Tq3MgKOlPnTVnBianTZQU3TJ2TrKAzdU6ygs7UOckKbpg6XVbwk4S1BhHWGkRYa5APD5k6XVbQmTonWUFn6nSmzhNZwYmpc5IVPJEVdKbOjazgJCu4YepMJqw1iLDWIMJag3x4KCvoTJ0uK3giK+hMnS4rODF1uqygywpumDpdVtCZOm8ydU6ygs7UuZEVnJg6J1nBm4S1BhHWGkRYa5APP8zUuWHq3DB1uqygM3XeZOqcZAUnps5JVnBi6tzICjpTp8sKuqzgJwlrDSKsNYiw1iAfvszUOckKbpg6nanzRFbQmTpvMnW6rOAkK+hMnZOs4MTU6UydG6bOSVbwJmGtQYS1BhHWGuTDX2bqdFlBZ+p0WcGJqXOSFXSmzpuyghtZQWfqnGQFJ6bOSVbwJlOnywqeENYaRFhrEGGtQX79/oMHTJ2TrKAzdW5kBSemTpcVnJg6XVZww9T5pqygM3W6rOAJU6fLCiYR1hpEWGsQYa1BPrwsKzjJCjpTp8sKOlPnJCvoTJ2TrKAzdbqsoDN1uqygM3W6rKAzdU6ygs7UuWHqdFlBZ+p0WcGJqXOSFXSmTpcVPCGsNYiw1iDCWoN8+DJTp8sKTkydLivoTJ0nTJ0TU+dGVnCSFZyYOl1W8Kas4EZW0Jk6P0lYaxBhrUGEtQb58FBWcJIV3MgKOlOnywo6U+eJrKAzdbqsoDN1nsgKuqzghqlzw9TpsoITU6fLCjpT55uEtQYR1hpEWGuQDy8zdU6yghNTp8sKOlOnywpOTJ0uK+hMnRNT55tMnS4rOMkKTkydLis4MXVuZAWdqfMmYa1BhLUGEdYa5MNDpk6XFZyYOjdMnRNTp8sK3pQVdKZOlxWcmDonWUFn6nRZwYmpc2LqvMnU+SZhrUGEtQYR1hrkw0NZwY2s4E2mzhNZwZtMnRumzpuyghumTpcV3MgK3iSsNYiw1iDCWoN8eMjU+UlZwYmp8yZTp8sKTrKCbzJ1bpg6XVZww9TpsoJvEtYaRFhrEGGtQT68LCt4k6lzkhV0ps4Tpk6XFbzJ1DnJCk6ygs7UOckKbpg6J6bOSVbwhLDWIMJagwhrDfLhy0ydG1nBE1lBZ+p0pk6XFdwwdX6SqXPD1HkiK+hMnZOs4E3CWoMIaw0irDXIh3+cqXMjK/ibsoITU+dGVnDD1Omygs7UOckKvklYaxBhrUGEtQb58B+XFXSmTpcVdFlBZ+o8kRV0pk6XFdzICk5MnZOs4CQr+JuEtQYR1hpEWGuQD1+WFXxTVtCZOidZwYmp02UFJ6bOialzYup0WcGJqXOSFbzJ1Omygs7U6bKCJ4S1BhHWGkRYa5APLzN11v9lBZ2pc8PU6bKCJ0ydk6ygywpOsoI3CWsNIqw1iLDWIL9+/8FaQwhrDSKsNYiw1iDCWoMIaw0irDWIsNYgwlqDCGsNIqw1iLDWIMJagwhrDSKsNYiw1iD/Ayc0u8My6tdVAAAAAElFTkSuQmCC",
+        shortUrl: "https://tppay.me/lvugy80i",
+        paymentUrl: null,
+        rawUrlPayment: null,
+        giftcard: null,
+      };
+
+      const tropipayInstance = new Tropipay({
+        clientId: "clientId",
+        clientSecret: "clientSecret",
+      });
+
+      const result = await tropipayInstance.paymentCards.create(payload);
+
+      // expect(result).toEqual(expectedPaymentLink);
+      expect(true).toBeDefined();
+    });
+  });
+});