@yosle/tropipayjs 0.2.0 → 0.2.1

package/accounts/accounts.d.ts

@@ -0,0 +1,52 @@
+import { Tropipay } from "../api/TropipayAPI";
+export interface PaymentMethod {
+    slug: string;
+    name: string;
+    enabled: boolean;
+    allowedCurrencies: string[];
+}
+export interface ServiceLimit {
+    value: number | null;
+    currency: string;
+}
+export interface ServiceLimits {
+    min: ServiceLimit;
+    max: ServiceLimit;
+}
+export interface Service {
+    slug: string;
+    enabled: boolean;
+    allowed_currencies: string[];
+    limits: ServiceLimits;
+}
+export interface TropiCard {
+}
+export interface Account {
+    id: number;
+    accountNumber: string;
+    userId: string;
+    alias: string;
+    balance: number;
+    pendingIn: number;
+    pendingOut: number;
+    state: number;
+    paymentEntityId: number;
+    currency: string;
+    type: number;
+    createdAt: string;
+    updatedAt: string;
+    isDefault: boolean;
+    groupId: number | null;
+    TropiCards: TropiCard[];
+    services: Service[];
+    paymentMethods: PaymentMethod[];
+}
+export default class Accounts {
+    private tropipay;
+    constructor(tropipayInstance: Tropipay);
+    /**
+     * List all accounts of the authenticated user
+     * @returns Array of Account objects
+     */
+    list(): Promise<Account[]>;
+}

package/api/TropipayAPI.d.ts

@@ -11,6 +11,7 @@ import TropipayHooks from "../hooks/TropipayHooks";
 import PaymentCard from "../paymentcard/PaymentCard";
 import MediationPaymentCard from "../mediationPaymentCard/MediationPaymentCard";
 import DepositAccounts from "../depositAccount/depositAccounts";
+import Accounts from "../accounts/accounts";
 export declare class Tropipay {
     readonly clientId: string;
     readonly clientSecret: string;
@@ -25,6 +26,7 @@ export declare class Tropipay {
     paymentCards: PaymentCard;
     depositAccounts: DepositAccounts;
     mediationPaymentCard: MediationPaymentCard;
+    accounts: Accounts;
     /**
      * Initializes a new instance of the Tropipay class.
      *

package/index.d.ts

@@ -39,37 +39,71 @@ interface UserHookSubscribed extends UserHook {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * Interface for creating payment links/cards
+ * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6ODgyNTM3OQ-create-a-new-pay-link-charge
+ */
 interface PaymentLinkPayload {
-    accountId: number;
+    /** Account ID where the funds will be received if compatible */
+    accountId?: number;
+    /** Reference code for the payment, preferred to be unique */
     reference: string;
+    /** Short description of the payment */
     concept: string;
+    /** Whether to mark this payment link as favorite */
     favorite: boolean;
+    /** Amount to charge in the specified currency */
     amount: number;
+    /** Currency code (EUR, USD, etc.) */
     currency: string;
+    /** Detailed description of the payment */
     description: string;
+    /** If true, the payment link can only be used once */
     singleUse: boolean;
+    /** Reason ID for the payment */
     reasonId: number;
+    /** Number of days until the payment link expires */
     expirationDays: number;
+    /** Language code for the payment page (en, es, etc.) */
     lang: string;
+    /** URL to redirect after successful payment */
     urlSuccess: string;
+    /** URL to redirect after failed payment */
     urlFailed: string;
+    /** Webhook URL for payment notifications */
     urlNotification: string;
+    /** Date when the service will be provided (ISO format) */
     serviceDate: string;
+    /** Client information for the payment */
     client?: {
+        /** Client's first name */
         name?: string;
+        /** Client's last name */
         lastName?: string;
+        /** Client's address */
         address?: string;
+        /** Client's phone number */
         phone?: string;
+        /** Client's email address */
         email?: string;
+        /** Client's country ID */
         countryId?: number;
+        /** Client's country ISO code */
         countryIso?: string;
+        /** Client's city */
         city: string;
+        /** Client's postal code */
         postCode: string;
+        /** Whether client accepted terms and conditions */
         termsAndConditions: boolean;
     } | null;
+    /** @deprecated If true, redirects directly to payment page */
     directPayment: boolean;
+    /** List of allowed payment methods */
     paymentMethods?: string[];
+    /** Base64 encoded image for the payment page */
     imageBase?: string;
+    /** Whether to save the payment token for future use */
     saveToken?: boolean;
 }
 interface PaymentLink extends PaymentLinkPayload {
@@ -320,6 +354,58 @@ declare class DepositAccounts {
     delete(id: number): Promise<any>;
 }
 
+interface PaymentMethod {
+    slug: string;
+    name: string;
+    enabled: boolean;
+    allowedCurrencies: string[];
+}
+interface ServiceLimit {
+    value: number | null;
+    currency: string;
+}
+interface ServiceLimits {
+    min: ServiceLimit;
+    max: ServiceLimit;
+}
+interface Service {
+    slug: string;
+    enabled: boolean;
+    allowed_currencies: string[];
+    limits: ServiceLimits;
+}
+interface TropiCard {
+}
+interface Account {
+    id: number;
+    accountNumber: string;
+    userId: string;
+    alias: string;
+    balance: number;
+    pendingIn: number;
+    pendingOut: number;
+    state: number;
+    paymentEntityId: number;
+    currency: string;
+    type: number;
+    createdAt: string;
+    updatedAt: string;
+    isDefault: boolean;
+    groupId: number | null;
+    TropiCards: TropiCard[];
+    services: Service[];
+    paymentMethods: PaymentMethod[];
+}
+declare class Accounts {
+    private tropipay;
+    constructor(tropipayInstance: Tropipay);
+    /**
+     * List all accounts of the authenticated user
+     * @returns Array of Account objects
+     */
+    list(): Promise<Account[]>;
+}
+
 /**
  * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
  *
@@ -343,6 +429,7 @@ declare class Tropipay {
     paymentCards: PaymentCard;
     depositAccounts: DepositAccounts;
     mediationPaymentCard: MediationPaymentCard;
+    accounts: Accounts;
     /**
      * Initializes a new instance of the Tropipay class.
      *

package/index.js

@@ -468,6 +468,35 @@ class DepositAccounts {
     }
 }
 
+class Accounts {
+    tropipay;
+    constructor(tropipayInstance) {
+        this.tropipay = tropipayInstance;
+    }
+    /**
+     * List all accounts of the authenticated user
+     * @returns Array of Account objects
+     */
+    async list() {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const accounts = await this.tropipay.request.get(`/api/v3/accounts/`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return accounts.data;
+        }
+        catch (error) {
+            throw handleExceptions(error);
+        }
+    }
+}
+
 /**
  * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
  *
@@ -488,6 +517,7 @@ class Tropipay {
     paymentCards;
     depositAccounts;
     mediationPaymentCard;
+    accounts;
     /**
      * Initializes a new instance of the Tropipay class.
      *
@@ -558,6 +588,7 @@ class Tropipay {
         this.paymentCards = new PaymentCard(this);
         this.mediationPaymentCard = new MediationPaymentCard(this);
         this.depositAccounts = new DepositAccounts(this);
+        this.accounts = new Accounts(this);
     }
     async login() {
         try {

package/interfaces/index.d.ts

@@ -35,37 +35,71 @@ export interface UserHookSubscribed extends UserHook {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * Interface for creating payment links/cards
+ * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6ODgyNTM3OQ-create-a-new-pay-link-charge
+ */
 export interface PaymentLinkPayload {
-    accountId: number;
+    /** Account ID where the funds will be received if compatible */
+    accountId?: number;
+    /** Reference code for the payment, preferred to be unique */
     reference: string;
+    /** Short description of the payment */
     concept: string;
+    /** Whether to mark this payment link as favorite */
     favorite: boolean;
+    /** Amount to charge in the specified currency */
     amount: number;
+    /** Currency code (EUR, USD, etc.) */
     currency: string;
+    /** Detailed description of the payment */
     description: string;
+    /** If true, the payment link can only be used once */
     singleUse: boolean;
+    /** Reason ID for the payment */
     reasonId: number;
+    /** Number of days until the payment link expires */
     expirationDays: number;
+    /** Language code for the payment page (en, es, etc.) */
     lang: string;
+    /** URL to redirect after successful payment */
     urlSuccess: string;
+    /** URL to redirect after failed payment */
     urlFailed: string;
+    /** Webhook URL for payment notifications */
     urlNotification: string;
+    /** Date when the service will be provided (ISO format) */
     serviceDate: string;
+    /** Client information for the payment */
     client?: {
+        /** Client's first name */
         name?: string;
+        /** Client's last name */
         lastName?: string;
+        /** Client's address */
         address?: string;
+        /** Client's phone number */
         phone?: string;
+        /** Client's email address */
         email?: string;
+        /** Client's country ID */
         countryId?: number;
+        /** Client's country ISO code */
         countryIso?: string;
+        /** Client's city */
         city: string;
+        /** Client's postal code */
         postCode: string;
+        /** Whether client accepted terms and conditions */
         termsAndConditions: boolean;
     } | null;
+    /** @deprecated If true, redirects directly to payment page */
     directPayment: boolean;
+    /** List of allowed payment methods */
     paymentMethods?: string[];
+    /** Base64 encoded image for the payment page */
     imageBase?: string;
+    /** Whether to save the payment token for future use */
     saveToken?: boolean;
 }
 export interface PaymentLink extends PaymentLinkPayload {

package/package.json

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

package/src/accounts/accounts.ts

@@ -0,0 +1,86 @@
+import { Tropipay } from "../api/TropipayAPI";
+import { handleExceptions } from "../utils/errors";
+
+// Account interfaces
+export interface PaymentMethod {
+  slug: string;
+  name: string;
+  enabled: boolean;
+  allowedCurrencies: string[];
+}
+
+export interface ServiceLimit {
+  value: number | null;
+  currency: string;
+}
+
+export interface ServiceLimits {
+  min: ServiceLimit;
+  max: ServiceLimit;
+}
+
+export interface Service {
+  slug: string;
+  enabled: boolean;
+  allowed_currencies: string[];
+  limits: ServiceLimits;
+}
+
+export interface TropiCard {
+  // TropiCard properties can be added here as needed
+}
+
+export interface Account {
+  id: number;
+  accountNumber: string;
+  userId: string;
+  alias: string;
+  balance: number;
+  pendingIn: number;
+  pendingOut: number;
+  state: number;
+  paymentEntityId: number;
+  currency: string;
+  type: number;
+  createdAt: string;
+  updatedAt: string;
+  isDefault: boolean;
+  groupId: number | null;
+  TropiCards: TropiCard[];
+  services: Service[];
+  paymentMethods: PaymentMethod[];
+}
+
+export default class Accounts {
+  private tropipay: Tropipay;
+  
+  constructor(tropipayInstance: Tropipay) {
+    this.tropipay = tropipayInstance;
+  }
+
+  /**
+   * List all accounts of the authenticated user
+   * @returns Array of Account objects
+   */
+  public async list(): Promise<Account[]> {
+    if (!Tropipay.accessToken) {
+      await this.tropipay.login();
+    }
+    
+    try {
+      const accounts = await this.tropipay.request.get(
+        `/api/v3/accounts/`,
+        {
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bearer ${Tropipay.accessToken}`,
+            Accept: "application/json",
+          },
+        }
+      );
+      return accounts.data;
+    } catch (error) {
+      throw handleExceptions(error as unknown as any);
+    }
+  }
+}

package/src/api/TropipayAPI.ts

@@ -22,6 +22,7 @@ import PaymentCard from "../paymentcard/PaymentCard";
 import MediationPaymentCard from "../mediationPaymentCard/MediationPaymentCard";
 import DepositAccounts from "../depositAccount/depositAccounts";
 import { TropipayJSException, handleExceptions } from "../utils/errors";
+import Accounts from "../accounts/accounts";
 export class Tropipay {
   readonly clientId: string;
   readonly clientSecret: string;
@@ -36,6 +37,7 @@ export class Tropipay {
   public paymentCards: PaymentCard;
   public depositAccounts: DepositAccounts;
   public mediationPaymentCard: MediationPaymentCard;
+  public accounts: Accounts;
 
   /**
    * Initializes a new instance of the Tropipay class.
@@ -122,6 +124,7 @@ export class Tropipay {
     this.mediationPaymentCard = new MediationPaymentCard(this);
 
     this.depositAccounts = new DepositAccounts(this);
+    this.accounts = new Accounts(this)
   }
 
   public async login() {

package/src/interfaces/index.ts

@@ -1,202 +1,264 @@
-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 {
-  accountId: number;
-  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[];
-};
+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;
+}
+
+/**
+ * Interface for creating payment links/cards
+ * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6ODgyNTM3OQ-create-a-new-pay-link-charge
+ */
+export interface PaymentLinkPayload {
+  /** Account ID where the funds will be received if compatible */
+  accountId?: number;
+  
+  /** Reference code for the payment, preferred to be unique */
+  reference: string;
+  
+  /** Short description of the payment */
+  concept: string;
+  
+  /** Whether to mark this payment link as favorite */
+  favorite: boolean;
+  
+  /** Amount to charge in the specified currency */
+  amount: number;
+  
+  /** Currency code (EUR, USD, etc.) */
+  currency: string;
+  
+  /** Detailed description of the payment */
+  description: string;
+  
+  /** If true, the payment link can only be used once */
+  singleUse: boolean;
+  
+  /** Reason ID for the payment */
+  reasonId: number;
+  
+  /** Number of days until the payment link expires */
+  expirationDays: number;
+  
+  /** Language code for the payment page (en, es, etc.) */
+  lang: string;
+  
+  /** URL to redirect after successful payment */
+  urlSuccess: string;
+  
+  /** URL to redirect after failed payment */
+  urlFailed: string;
+  
+  /** Webhook URL for payment notifications */
+  urlNotification: string;
+  
+  /** Date when the service will be provided (ISO format) */
+  serviceDate: string;
+  
+  /** Client information for the payment */
+  client?: {
+    /** Client's first name */
+    name?: string;
+    
+    /** Client's last name */
+    lastName?: string;
+    
+    /** Client's address */
+    address?: string;
+    
+    /** Client's phone number */
+    phone?: string;
+    
+    /** Client's email address */
+    email?: string;
+    
+    /** Client's country ID */
+    countryId?: number;
+    
+    /** Client's country ISO code */
+    countryIso?: string;
+    
+    /** Client's city */
+    city: string;
+    
+    /** Client's postal code */
+    postCode: string;
+    
+    /** Whether client accepted terms and conditions */
+    termsAndConditions: boolean;
+  } | null;
+  
+  /** @deprecated If true, redirects directly to payment page */
+  directPayment: boolean;
+  
+  /** List of allowed payment methods */
+  paymentMethods?: string[];
+  
+  /** Base64 encoded image for the payment page */
+  imageBase?: string;
+  
+  /** Whether to save the payment token for future use */
+  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[];
+};