@yosle/tropipayjs 0.2.3 → 0.3.0

package/src/hooks/TropipayHooks.ts

@@ -1,154 +0,0 @@
-import { HookEventType, UserHookSubscribed } from "../interfaces";
-import { Tropipay } from "../api/TropipayAPI";
-import { handleExceptions } from "../utils/errors";
-export default class TropipayHooks {
-  private tropipay: Tropipay;
-  // ... hook-related functionality ...
-  constructor(tropipayInstance: Tropipay) {
-    this.tropipay = tropipayInstance;
-  }
-  /**
-   * 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 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 handleExceptions(error as unknown as any);
-    }
-  }
-  /**
-   * Get the subscribed 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();
-    }
-    try {
-      const hooks = await this.tropipay.request.get(
-        `/api/v2/hooks/${eventType || ""}`,
-        {
-          headers: {
-            "Content-Type": "application/json",
-            Authorization: `Bearer ${Tropipay.accessToken}`,
-            Accept: "application/json",
-          },
-        }
-      );
-      return hooks.data;
-    } catch (error) {
-      throw handleExceptions(error as unknown as any);
-    }
-  }
-  public async update(
-    eventType: HookEventType,
-    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 handleExceptions(error as unknown as any);
-    }
-  }
-  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 handleExceptions(error as unknown as any);
-    }
-  }
-
-  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 handleExceptions(error as unknown as any);
-    }
-  }
-}

package/src/index.ts

@@ -1,29 +0,0 @@
-/**
- * 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") {
-  const err_msg = `⚠️ **Warning:** The Tropipay SDK should only be instantiated server-side for security reasons. Using it client-side may lead to unexpected behavior and security vulnerabilities. YOUR CREDENTIALS COULD BE EXPOSED. Check https://yosle.github.io/tropipayjs-docs/guides/installation/ for more details.`;
-  console.error(err_msg);
-  throw new Error(err_msg);
-}
-
-export { Tropipay } from "./api/TropipayAPI";
-export { ClientSideUtils } from "./api/TropipayAPI";
-export { ServerSideUtils } from "./utils/TropipayUtils";
-export * from "./hooks/TropipayHooks";
-export * from "./paymentcard/PaymentCard";
-export * from "./mediationPaymentCard/MediationPaymentCard";
-export * from "./depositAccount/depositAccounts";
-export * from "./interfaces/index";
-export { SERVER_MODE } from "./config/TropipayConfig";
-export * from "./constants/TropipayConstants";
-export type { RefundResponse } from "./interfaces/index";

package/src/interfaces/depositaccounts/index.ts

@@ -1,70 +0,0 @@
-export interface DepositAccountConfig {
-  searchValue?: string;
-  alias: string;
-  userRelationTypeId: number;
-  beneficiaryType: BeneficiaryType;
-  searchBy?: number;
-  accountNumber?: string;
-  swift?: string;
-  type: DepositAccountType;
-  firstName?: string;
-  lastName?: string;
-  secondLastName?: string;
-  countryDestinationId?: number;
-  city?: string;
-  postalCode?: number;
-  address?: string;
-  documentNumber?: string;
-  phone?: string;
-  province?: string;
-  paymentType?: string;
-  documentTypeId?: number;
-  documentExpirationDate: string;
-}
-type INTERNAL = 1;
-type EXTERNAL = 2;
-
-export type BeneficiaryType = INTERNAL | EXTERNAL;
-
-export const DepositAccountTypesList = {
-  /**
-   * Banco Metropolitano (Cuba) Bank Account
-   */
-  BANMET_BANK_ACCOUNT: 0,
-  /**
-   * Banco Popular de Ahorro
-   */
-  BPA_BANK_ACCOUNT: 1,
-  /**
-   * Banco de Credito y Comercio (Cuba) Bank Account
-   */
-  BANDEC_BANK_ACCOUNT: 2,
-  /**
-   * Banco Metropilitano (Cuba) card
-   */
-  BANMET_CARD: 3,
-  /**
-   * Banco Popular de Ahorro (Cuba) card
-   */
-  BPA_CARD: 4,
-  /**
-   * Not available anymore
-   * @deprecated
-   */
-  AIS_CUC_CARD: 5,
-  /**
-   * Not available
-   * @deprecated
-   */
-  AIS_USD_CARD: 6,
-  /**
-   * For international bank accounts
-   */
-  OTHER: 7,
-  /**
-   * Banco de Credito y comercio card
-   */
-  BANDEC_CARD: 8,
-} as const;
-
-export type DepositAccountType = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9 | 10 | 11;

package/src/interfaces/index.js

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

package/src/interfaces/index.ts

@@ -1,212 +0,0 @@
-import { ServerMode } from "../constants/TropipayConstants";
-
-export type AccountBalance = {
-  balance: number;
-  pendingIn: number;
-  pendingOut: number;
-};
-
-export interface TropipayConfig {
-  clientId: string;
-  clientSecret: string;
-  scopes?: string[];
-  serverMode?: ServerMode;
-  // Custom tropipay environment for testing
-  customTropipayUrl?: string;
-}
-
-export type TropipayCredentials = { clientId: string; clientSecret: string };
-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;
-  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;
-    countryIso?: string;
-    city: string;
-    postCode: string;
-    termsAndConditions: boolean;
-  } | null;
-  directPayment: boolean;
-  paymentMethods?: string[];
-  imageBase?: string;
-  saveToken?: boolean;
-}
-
-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[];
-};
-
-export type RefundResponse = {
-  id: number;
-  orderCode: string;
-  amount: number;
-  currency: string;
-  state: string;
-  type: string;
-  createdAt: string;
-  completedAt: string;
-};

package/src/interfaces/mediation/index.ts

@@ -1,23 +0,0 @@
-
-/**
- * 
- */
-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 +0,0 @@
-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 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=index.js.map

package/src/interfaces/paymentlink/index.ts

@@ -1,91 +0,0 @@
-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

@@ -1,42 +0,0 @@
-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);
-    }
-  }
-}