@yosle/tropipayjs 0.1.22 → 0.1.24

package/src/config/TropipayConfig.ts

@@ -1,2 +1,2 @@
-import { ServerMode } from "../constants/TropipayConstants";
-export const SERVER_MODE: ServerMode = "Development"; // Move the constant here
+import { ServerMode } from "../constants/TropipayConstants";
+export const SERVER_MODE: ServerMode = "Development"; // Move the constant here

package/src/constants/TropipayConstants.ts

@@ -1,2 +1,2 @@
-export type ServerMode = "Development" | "Production";
-export const MAX_IMAGE_SIZE_MB = 1;
+export type ServerMode = "Development" | "Production";
+export const MAX_IMAGE_SIZE_MB = 1;

package/src/depositAccount/depositAccounts.ts

@@ -1,139 +1,139 @@
-import { AxiosError } from "axios";
-import { Tropipay } from "../api/TropipayAPI";
-import { DepositAccountConfig } from "../interfaces/depositaccounts";
-import { handleExceptions } from "../utils/errors";
-export default class DepositAccounts {
-  private tropipay: Tropipay;
-  constructor(tropipayInstance: Tropipay) {
-    this.tropipay = tropipayInstance;
-  }
-
-  /**
-   * List od all beneficiaries of this account
-   * @returns Array of DepositAccounts
-   */
-  public async list() {
-    if (!Tropipay.accessToken) {
-      await this.tropipay.login();
-    }
-    try {
-      const deposit = await this.tropipay.request.get(
-        `/api/v2/deposit_accounts`,
-        {
-          headers: {
-            "Content-Type": "application/json",
-            Authorization: `Bearer ${Tropipay.accessToken}`,
-            Accept: "application/json",
-          },
-        }
-      );
-      return deposit.data;
-    } catch (error) {
-      return handleExceptions(error as unknown as any);
-    }
-  }
-  /**
-   * Adds a new beneficiary to the user account.
-   * @param payload
-   * @returns
-   */
-  public async create(depositAccountObj: DepositAccountConfig) {
-    if (!Tropipay.accessToken) {
-      await this.tropipay.login();
-    }
-    try {
-      const deposit = await this.tropipay.request.post(
-        "/api/v2/deposit_accounts",
-        depositAccountObj,
-        {
-          headers: {
-            "Content-Type": "application/json",
-            Authorization: `Bearer ${Tropipay.accessToken}`,
-            Accept: "application/json",
-          },
-        }
-      );
-      return deposit.data;
-    } catch (error) {
-      return handleExceptions(error as unknown as any);
-    }
-  }
-  /**
-   * This returns details of a specific
-   * Deposit Account (beneficiary) specified by its ID
-   * @param id
-   * @returns
-   */
-  public async get(id: string) {
-    if (!Tropipay.accessToken) {
-      await this.tropipay.login();
-    }
-    try {
-      const deposit = await this.tropipay.request.get(
-        `/api/v2/deposit_accounts/${id}`,
-        {
-          headers: {
-            "Content-Type": "application/json",
-            Authorization: `Bearer ${Tropipay.accessToken}`,
-            Accept: "application/json",
-          },
-        }
-      );
-      return deposit.data;
-    } catch (error) {
-      return handleExceptions(error as unknown as any);
-    }
-  }
-
-  /**
-   * Updates certain beneficiary data.
-   * @param depositAccountObj
-   * @returns
-   */
-  public async update(depositAccountObj: Partial<DepositAccountConfig>) {
-    if (!Tropipay.accessToken) {
-      await this.tropipay.login();
-    }
-    try {
-      const deposit = await this.tropipay.request.put(
-        `/api/v2/deposit_accounts/`,
-        {
-          headers: {
-            "Content-Type": "application/json",
-            Authorization: `Bearer ${Tropipay.accessToken}`,
-            Accept: "application/json",
-          },
-        }
-      );
-      return deposit.data;
-    } catch (error) {
-      return handleExceptions(error as unknown as any);
-    }
-  }
-
-  /**
-   * (UNTESTED) Deletes the beneficiary indicated by id
-   * @param id
-   * @returns
-   */
-  public async delete(id: number) {
-    if (!Tropipay.accessToken) {
-      await this.tropipay.login();
-    }
-    try {
-      const deposit = await this.tropipay.request.delete(
-        `/api/v2/deposit_accounts/${id}`,
-        {
-          headers: {
-            "Content-Type": "application/json",
-            Authorization: `Bearer ${Tropipay.accessToken}`,
-            Accept: "application/json",
-          },
-        }
-      );
-      return deposit.data;
-    } catch (error) {
-      return handleExceptions(error as unknown as any);
-    }
-  }
-}
+import { AxiosError } from "axios";
+import { Tropipay } from "../api/TropipayAPI";
+import { DepositAccountConfig } from "../interfaces/depositaccounts";
+import { handleExceptions } from "../utils/errors";
+export default class DepositAccounts {
+  private tropipay: Tropipay;
+  constructor(tropipayInstance: Tropipay) {
+    this.tropipay = tropipayInstance;
+  }
+
+  /**
+   * List od all beneficiaries of this account
+   * @returns Array of DepositAccounts
+   */
+  public async list() {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.get(
+        `/api/v2/deposit_accounts`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      return handleExceptions(error as unknown as any);
+    }
+  }
+  /**
+   * Adds a new beneficiary to the user account.
+   * @param payload
+   * @returns
+   */
+  public async create(depositAccountObj: DepositAccountConfig) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.post(
+        "/api/v2/deposit_accounts",
+        depositAccountObj,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      return handleExceptions(error as unknown as any);
+    }
+  }
+  /**
+   * This returns details of a specific
+   * Deposit Account (beneficiary) specified by its ID
+   * @param id
+   * @returns
+   */
+  public async get(id: string) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.get(
+        `/api/v2/deposit_accounts/${id}`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      return handleExceptions(error as unknown as any);
+    }
+  }
+
+  /**
+   * Updates certain beneficiary data.
+   * @param depositAccountObj
+   * @returns
+   */
+  public async update(depositAccountObj: Partial<DepositAccountConfig>) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.put(
+        `/api/v2/deposit_accounts/`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      return handleExceptions(error as unknown as any);
+    }
+  }
+
+  /**
+   * (UNTESTED) Deletes the beneficiary indicated by id
+   * @param id
+   * @returns
+   */
+  public async delete(id: number) {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    try {
+      const deposit = await this.tropipay.request.delete(
+        `/api/v2/deposit_accounts/${id}`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return deposit.data;
+    } catch (error) {
+      return handleExceptions(error as unknown as any);
+    }
+  }
+}

package/src/hooks/TropipayHooks.ts

@@ -1,154 +1,154 @@
-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);
-    }
-  }
-}
+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,28 +1,28 @@
-/**
- * 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";
+/**
+ * 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";