paj_ramp 1.3.0 → 1.3.2

package/README.md

@@ -28,8 +28,13 @@ initializeSDK('staging'); // or production
 ```typescript
 import { initiate } from 'paj_ramp';
 
-const initiated = await initiate('your_email@gmail.com', 'business_api_key');
-// Response: { email: string }
+// You can get otp by either adding your phone number or email address
+// Phone number must start with a country code
+const initiated = await initiate(
+  'your_email@gmail.com' // +2349053231563
+  'business_api_key'
+  );
+// Response: { email?: string, phone?: string}
 ```
 
 ### Verify Session
@@ -37,8 +42,10 @@ const initiated = await initiate('your_email@gmail.com', 'business_api_key');
 ```typescript
 import { verify } from 'paj_ramp';
 
+// You can get otp by either adding your phone number or email address
+// Phone number must start with a country code
 const verified = await verify(
-  'your_email@gmail.com',
+  'your_email@gmail.com', // or +2349053231563
   'otp',
   {
     uuid: string,
@@ -50,7 +57,13 @@ const verified = await verify(
   },
   'business_api_key'
 );
-// Response: { email: string, isActive: string, expiresAt: string, token: string }
+/* Response: {
+email?: string,
+phone?: string,
+isActive: string,
+expiresAt: string,
+token: string 
+} */
 ```
 
 ## Utility Endpoints
@@ -316,7 +329,7 @@ const order = await createOrder({
 ```typescript
 import {
   // Chain, // SOLANA, etc
-  TransactionStatus, // INIT<, etc
+  TransactionStatus, // INIT, etc
   TransactionType, // ON_RAMP, etc
   Currency, // NGN
 } from 'paj_ramp';

package/dist/lib/{core → utility/bank}/addBankAccount.js

@@ -1,4 +1,4 @@
-import { post } from "../../utils/api.js";
+import { post } from '../../../utils/api.js';
 /**
  * Adds a new bank account by sending the provided token, bank ID, and account number to the public API.
  * Returns the added bank account details or throws an error if the request fails.
@@ -24,7 +24,7 @@ export const addBankAccount = async (token, bankId, accountNumber) => {
         });
     }
     catch (err) {
-        console.error("Error adding bank account:", err);
+        console.error('Error adding bank account:', err);
         throw err;
     }
 };

package/dist/lib/{core → utility/bank}/getBankAccounts.js

@@ -1,4 +1,4 @@
-import { get } from "../../utils/api.js";
+import { get } from '../../../utils/api.js';
 /**
  * Fetches a list of added bank accounts from the public API endpoint.
  * Returns an array of bank account objects or throws an error if the request fails.
@@ -16,7 +16,7 @@ export const getBankAccounts = async (apiKey) => {
         });
     }
     catch (err) {
-        console.error("Error fetching bank accounts:", err);
+        console.error('Error fetching bank accounts:', err);
         throw err;
     }
 };

package/dist/lib/{off_ramp → utility/bank}/getBanks.js

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 /**
  * Fetches a list of banks from the public API endpoint.
  * Returns an array of bank objects or throws an error if the request fails.

package/dist/lib/{off_ramp → utility/bank}/resolveBankAccount.js

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 /**
  * Resolves and fetches bank account details for a given bank ID and account number from the public API.
  * Returns the account name, account number, and bank details or throws an error if the request fails.

package/dist/lib/{off_ramp → utility/deprecated}/addWallet.js

@@ -1,5 +1,5 @@
-import { post } from "../../utils/api.js";
-import { getWalletBody } from "../../utils/getWalletBody.js";
+import { post } from "../../../utils/api.js";
+import { getWalletBody } from "../../../utils/getWalletBody.js";
 /**
  * Adds a new wallet for the user.
  * Returns the added wallet object or throws an error if the request fails.

package/dist/lib/{core → utility/deprecated}/getTXPoolAddress.js

@@ -1,4 +1,4 @@
-import { get } from "../../utils/api.js";
+import { get } from "../../../utils/api.js";
 /**
  * Fetches the transaction pool address from the public API endpoint.
  * Returns the address as a string or throws an error if the request fails.

package/dist/lib/{core → utility/deprecated}/getWallet.js

@@ -1,4 +1,4 @@
-import { get } from "../../utils/api.js";
+import { get } from "../../../utils/api.js";
 /**
  * Fetches wallet details for a given public key from the public API endpoint.
  * Returns the wallet information including bank account details or throws an error if the request fails.

package/dist/lib/{core → utility/deprecated}/switchWalletBankAccount.js

@@ -1,5 +1,5 @@
-import { patch } from "../../utils/api.js";
-import { getWalletBody } from "../../utils/getWalletBody.js";
+import { patch } from "../../../utils/api.js";
+import { getWalletBody } from "../../../utils/getWalletBody.js";
 export const switchWalletBankAccount = async (apiKey, accountId, walletId, secretKey) => {
     try {
         const body = await getWalletBody(accountId, secretKey);

package/dist/lib/{core → utility/rate}/getAllRate.js

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 /**
  * This TypeScript function asynchronously fetches all rates from a specified URL and handles any
  * errors that may occur.

package/dist/lib/{core → utility/rate}/getRateByAmount.js

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 /**
  * The function `getRateByAmount` fetches a rate based on a specified amount asynchronously.
  * @param {number} amount - The `amount` parameter in the `getRateByAmount` function is a number

package/dist/lib/{core → utility/rate}/getRateByType.d.ts

@@ -1,4 +1,4 @@
-import { RateType } from '../../utils/enums.js';
+import { RateType } from '../../../utils/enums.js';
 type RateByType = {
     baseCurrency: string;
     targetCurrency: string;

package/dist/lib/{core → utility/rate}/getRateByType.js

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 /**
  * This function fetches a rate based on a specified rate type asynchronously.
  * @param {RateType} rateType - RateType is a type that specifies the type of rate being requested,

package/dist/lib/{core → utility/rate}/getTokenValue.js

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 /**
  * The function `getTokenValue` asynchronously fetches the value of a token based on the specified
  * amount and token mint.

package/dist/lib/utility/session/initiate.d.ts

@@ -0,0 +1,5 @@
+type InitiateResponse = {
+    recipient: string;
+};
+export declare const initiate: (recipient: string, apiKey: string) => Promise<InitiateResponse>;
+export {};

package/dist/lib/utility/session/initiate.js

@@ -0,0 +1,18 @@
+import { post } from '../../../utils/api.js';
+export const initiate = async (recipient, apiKey) => {
+    let body;
+    try {
+        if (isNaN(+recipient))
+            body = { email: recipient };
+        else
+            body = { phone: recipient };
+        return await post('/pub/initiate', body, {
+            'x-api-key': apiKey,
+            'Content-Type': 'application/json',
+        });
+    }
+    catch (err) {
+        console.error('Error initiating:', err);
+        throw err;
+    }
+};

package/dist/lib/utility/session/verify.d.ts

@@ -0,0 +1,15 @@
+type VerifyType = {
+    recipient: string;
+    isActive: string;
+    expiresAt: string;
+    token: string;
+};
+type deviceSignatureType = {
+    uuid: string;
+    device: string;
+    os?: string;
+    browser?: string;
+    ip?: string;
+};
+export declare const verify: (recipient: string, otp: string, device: deviceSignatureType, apiKey: string) => Promise<VerifyType>;
+export {};

package/dist/lib/utility/session/verify.js

@@ -0,0 +1,15 @@
+import { post } from '../../../utils/api.js';
+export const verify = async (recipient, otp, device, apiKey) => {
+    let body;
+    try {
+        if (isNaN(+recipient))
+            body = { email: recipient, otp, device };
+        else
+            body = { phone: recipient, otp, device };
+        return await post('/pub/verify', body, { 'x-api-key': apiKey });
+    }
+    catch (err) {
+        console.error('Error verifying:', err);
+        throw err;
+    }
+};

package/dist/lib/{core → utility/transaction}/getAllTransactions.js

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 /**
  * The function getAllTransactions fetches all transactions from a specified endpoint and handles any
  * errors that occur.

package/dist/lib/{core → utility/transaction}/getTransaction.d.ts

@@ -1,4 +1,4 @@
-import { Currency, TransactionStatus, TransactionType } from '../../utils/enums.js';
+import { Currency, TransactionStatus, TransactionType } from '../../../utils/enums.js';
 export type TransactionResponse = {
     id: string;
     address: string;

package/dist/lib/{core → utility/transaction}/getTransaction.js

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 /**
  * The function `getTransaction` asynchronously fetches a transaction with a specified ID and handles
  * any errors that may occur.

package/dist/sdk.d.ts

@@ -1,16 +1,16 @@
 export declare const initializeSDK: (env: "staging" | "production") => void;
-export { initiate } from './lib/core/initiate.js';
-export { verify } from './lib/core/verify.js';
-export { getAllRate } from './lib/core/getAllRate.js';
-export { getRateByAmount } from './lib/core/getRateByAmount.js';
-export { getRateByType } from './lib/core/getRateByType.js';
-export { getTokenValue } from './lib/core/getTokenValue.js';
-export { getBanks } from './lib/core/getBanks.js';
-export { resolveBankAccount } from './lib/core/resolveBankAccount.js';
-export { addBankAccount } from './lib/core/addBankAccount.js';
-export { getBankAccounts } from './lib/core/getBankAccounts.js';
-export { getAllTransactions } from './lib/core/getAllTransactions.js';
-export { getTransaction } from './lib/core/getTransaction.js';
+export { initiate } from './lib/utility/session/initiate.js';
+export { verify } from './lib/utility/session/verify.js';
+export { getAllRate } from './lib/utility/rate/getAllRate.js';
+export { getRateByAmount } from './lib/utility/rate/getRateByAmount.js';
+export { getRateByType } from './lib/utility/rate/getRateByType.js';
+export { getTokenValue } from './lib/utility/rate/getTokenValue.js';
+export { getBanks } from './lib/utility/bank/getBanks.js';
+export { resolveBankAccount } from './lib/utility/bank/resolveBankAccount.js';
+export { addBankAccount } from './lib/utility/bank/addBankAccount.js';
+export { getBankAccounts } from './lib/utility/bank/getBankAccounts.js';
+export { getAllTransactions } from './lib/utility/transaction/getAllTransactions.js';
+export { getTransaction } from './lib/utility/transaction/getTransaction.js';
 export { offRampCreateOrder } from './lib/off_ramp/directCreateOrder.js';
 export { createOrder } from './lib/on_ramp/createOrder.js';
 export { RateType, Currency, TransactionType, TransactionStatus, } from './utils/enums.js';

package/dist/sdk.js

@@ -9,23 +9,23 @@ export const initializeSDK = (env) => {
         setBaseUrl('https://api.paj.cash');
     }
 };
-// UTILS || CORE
+// UTILITY ENDPOINTS
 // Session Management
-export { initiate } from './lib/core/initiate.js';
-export { verify } from './lib/core/verify.js';
+export { initiate } from './lib/utility/session/initiate.js';
+export { verify } from './lib/utility/session/verify.js';
 // Rate Operations
-export { getAllRate } from './lib/core/getAllRate.js';
-export { getRateByAmount } from './lib/core/getRateByAmount.js';
-export { getRateByType } from './lib/core/getRateByType.js';
-export { getTokenValue } from './lib/core/getTokenValue.js';
+export { getAllRate } from './lib/utility/rate/getAllRate.js';
+export { getRateByAmount } from './lib/utility/rate/getRateByAmount.js';
+export { getRateByType } from './lib/utility/rate/getRateByType.js';
+export { getTokenValue } from './lib/utility/rate/getTokenValue.js';
 // Banking Operations
-export { getBanks } from './lib/core/getBanks.js';
-export { resolveBankAccount } from './lib/core/resolveBankAccount.js';
-export { addBankAccount } from './lib/core/addBankAccount.js';
-export { getBankAccounts } from './lib/core/getBankAccounts.js';
+export { getBanks } from './lib/utility/bank/getBanks.js';
+export { resolveBankAccount } from './lib/utility/bank/resolveBankAccount.js';
+export { addBankAccount } from './lib/utility/bank/addBankAccount.js';
+export { getBankAccounts } from './lib/utility/bank/getBankAccounts.js';
 // Transaction History
-export { getAllTransactions } from './lib/core/getAllTransactions.js';
-export { getTransaction } from './lib/core/getTransaction.js';
+export { getAllTransactions } from './lib/utility/transaction/getAllTransactions.js';
+export { getTransaction } from './lib/utility/transaction/getTransaction.js';
 // OFF RAMP
 // DIRECT OFF RAMP
 export { offRampCreateOrder } from './lib/off_ramp/directCreateOrder.js';

package/lib/utility/{addBankAccount.ts → bank/addBankAccount.ts}

@@ -1,4 +1,4 @@
-import { post } from "../../utils/api.js";
+import { post } from '../../../utils/api.js';
 
 type AddBankAccountType = {
   id: string;
@@ -39,7 +39,7 @@ export const addBankAccount = async (
       }
     );
   } catch (err) {
-    console.error("Error adding bank account:", err);
+    console.error('Error adding bank account:', err);
     throw err;
   }
 };

package/lib/utility/{getBankAccounts.ts → bank/getBankAccounts.ts}

@@ -1,4 +1,4 @@
-import { get } from "../../utils/api.js";
+import { get } from '../../../utils/api.js';
 
 type GetBankAccountsType = {
   id: string;
@@ -27,7 +27,7 @@ export const getBankAccounts = async (apiKey: string) => {
       }
     );
   } catch (err) {
-    console.error("Error fetching bank accounts:", err);
+    console.error('Error fetching bank accounts:', err);
     throw err;
   }
 };

package/lib/utility/{getBanks.ts → bank/getBanks.ts}

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 
 type BankType = {
   id: string;

package/lib/utility/{resolveBankAccount.ts → bank/resolveBankAccount.ts}

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 
 type ResolveBankAccountType = {
   accountName: string;

package/lib/utility/{addWallet.ts → deprecated/addWallet.ts}

@@ -1,5 +1,5 @@
-import { post } from "../../utils/api.js";
-import { getWalletBody } from "../../utils/getWalletBody.js";
+import { post } from "../../../utils/api.js";
+import { getWalletBody } from "../../../utils/getWalletBody.js";
 import { WalletType } from "./getWallet.js";
 
 /**

package/lib/utility/{getTXPoolAddress.ts → deprecated/getTXPoolAddress.ts}

@@ -1,4 +1,4 @@
-import { get } from "../../utils/api.js";
+import { get } from "../../../utils/api.js";
 
 /**
  * Fetches the transaction pool address from the public API endpoint.

package/lib/utility/{getWallet.ts → deprecated/getWallet.ts}

@@ -1,4 +1,4 @@
-import { get } from "../../utils/api.js";
+import { get } from "../../../utils/api.js";
 
 export type WalletType = {
   id: string;

package/lib/utility/{switchWalletBankAccount.ts → deprecated/switchWalletBankAccount.ts}

@@ -1,5 +1,5 @@
-import { patch } from "../../utils/api.js";
-import { getWalletBody } from "../../utils/getWalletBody.js";
+import { patch } from "../../../utils/api.js";
+import { getWalletBody } from "../../../utils/getWalletBody.js";
 import { WalletType } from "./getWallet.js";
 
 export const switchWalletBankAccount = async (

package/lib/utility/{getAllRate.ts → rate/getAllRate.ts}

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 
 type AllRateResponseType = {
   onRampRate: {
@@ -17,7 +17,6 @@ type AllRateResponseType = {
   };
 };
 
-
 /**
  * This TypeScript function asynchronously fetches all rates from a specified URL and handles any
  * errors that may occur.

package/lib/utility/{getRateByAmount.ts → rate/getRateByAmount.ts}

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 
 type RateByAmountType = {
   rate: {

package/lib/utility/{getRateByType.ts → rate/getRateByType.ts}

@@ -1,5 +1,5 @@
-import { get } from '../../utils/api.js';
-import { RateType } from '../../utils/enums.js';
+import { get } from '../../../utils/api.js';
+import { RateType } from '../../../utils/enums.js';
 
 type RateByType = {
   baseCurrency: string;

package/lib/utility/{getTokenValue.ts → rate/getTokenValue.ts}

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 
 type TokenValueType = {
   amount: number;
@@ -19,10 +19,7 @@ type TokenValueType = {
  * making an HTTP request to fetch the token value based on the provided amount and mint token. If
  * successful, the function will return the token value. If there is an error during
  */
-export const getTokenValue = async (
-  amount: number,
-  mint_token: string
-) => {
+export const getTokenValue = async (amount: number, mint_token: string) => {
   const url: string = '/pub/rate';
 
   try {

package/lib/utility/session/initiate.ts

@@ -0,0 +1,22 @@
+import { post } from '../../../utils/api.js';
+
+type InitiateResponse = {
+  recipient: string;
+};
+
+export const initiate = async (recipient: string, apiKey: string) => {
+  let body;
+
+  try {
+    if (isNaN(+recipient)) body = { email: recipient };
+    else body = { phone: recipient };
+
+    return await post<InitiateResponse>('/pub/initiate', body, {
+      'x-api-key': apiKey,
+      'Content-Type': 'application/json',
+    });
+  } catch (err) {
+    console.error('Error initiating:', err);
+    throw err;
+  }
+};

package/lib/utility/session/verify.ts

@@ -0,0 +1,35 @@
+import { post } from '../../../utils/api.js';
+
+type VerifyType = {
+  recipient: string;
+  isActive: string;
+  expiresAt: string;
+  token: string;
+};
+
+type deviceSignatureType = {
+  uuid: string;
+  device: string;
+  os?: string;
+  browser?: string;
+  ip?: string;
+};
+
+export const verify = async (
+  recipient: string,
+  otp: string,
+  device: deviceSignatureType,
+  apiKey: string
+) => {
+  let body;
+
+  try {
+    if (isNaN(+recipient)) body = { email: recipient, otp, device };
+    else body = { phone: recipient, otp, device };
+
+    return await post<VerifyType>('/pub/verify', body, { 'x-api-key': apiKey });
+  } catch (err) {
+    console.error('Error verifying:', err);
+    throw err;
+  }
+};

package/lib/utility/{getAllTransactions.ts → transaction/getAllTransactions.ts}

@@ -1,4 +1,4 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 import { TransactionResponse } from './getTransaction.js';
 
 type TransactionsResponse = TransactionResponse[];

package/lib/utility/{getTransaction.ts → transaction/getTransaction.ts}

@@ -1,9 +1,9 @@
-import { get } from '../../utils/api.js';
+import { get } from '../../../utils/api.js';
 import {
   Currency,
   TransactionStatus,
   TransactionType,
-} from '../../utils/enums.js';
+} from '../../../utils/enums.js';
 
 export type TransactionResponse = {
   id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paj_ramp",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "paj offramp/onramp service",
   "main": "dist/sdk.js",
   "types": "dist/sdk.d.ts",

package/sdk.ts

@@ -14,24 +14,24 @@ export const initializeSDK = (env: 'staging' | 'production') => {
 // UTILITY ENDPOINTS
 
 // Session Management
-export { initiate } from './lib/utility/initiate.js';
-export { verify } from './lib/utility/verify.js';
+export { initiate } from './lib/utility/session/initiate.js';
+export { verify } from './lib/utility/session/verify.js';
 
 // Rate Operations
-export { getAllRate } from './lib/utility/getAllRate.js';
-export { getRateByAmount } from './lib/utility/getRateByAmount.js';
-export { getRateByType } from './lib/utility/getRateByType.js';
-export { getTokenValue } from './lib/utility/getTokenValue.js';
+export { getAllRate } from './lib/utility/rate/getAllRate.js';
+export { getRateByAmount } from './lib/utility/rate/getRateByAmount.js';
+export { getRateByType } from './lib/utility/rate/getRateByType.js';
+export { getTokenValue } from './lib/utility/rate/getTokenValue.js';
 
 // Banking Operations
-export { getBanks } from './lib/utility/getBanks.js';
-export { resolveBankAccount } from './lib/utility/resolveBankAccount.js';
-export { addBankAccount } from './lib/utility/addBankAccount.js';
-export { getBankAccounts } from './lib/utility/getBankAccounts.js';
+export { getBanks } from './lib/utility/bank/getBanks.js';
+export { resolveBankAccount } from './lib/utility/bank/resolveBankAccount.js';
+export { addBankAccount } from './lib/utility/bank/addBankAccount.js';
+export { getBankAccounts } from './lib/utility/bank/getBankAccounts.js';
 
 // Transaction History
-export { getAllTransactions } from './lib/utility/getAllTransactions.js';
-export { getTransaction } from './lib/utility/getTransaction.js';
+export { getAllTransactions } from './lib/utility/transaction/getAllTransactions.js';
+export { getTransaction } from './lib/utility/transaction/getTransaction.js';
 
 // OFF RAMP
 // DIRECT OFF RAMP

package/dist/lib/core/addWallet.js

@@ -1,27 +0,0 @@
-import { post } from "../../utils/api.js";
-import { getWalletBody } from "../../utils/getWalletBody.js";
-/**
- * Adds a new wallet for the user.
- * Returns the added wallet object or throws an error if the request fails.
- *
- * Returns:
- *   An object containing id, accountName, accountNumber, and bank of the bank account.
- *
- * Raises:
- *   Throws an error if the wallet file is not found or if the secret key is invalid.
- */
-export const addWallet = async (apiKey, accountId, secretKey) => {
-    try {
-        const body = await getWalletBody(accountId, secretKey);
-        if (!body) {
-            throw new Error("Failed to get wallet body");
-        }
-        return await post("/pub/wallet", body, {
-            Authorization: `Bearer ${apiKey}`,
-        });
-    }
-    catch (err) {
-        console.error("Error adding wallet:", err);
-        throw err;
-    }
-};

package/dist/lib/core/getAllTranstions.d.ts

@@ -1,12 +0,0 @@
-import { TransactionResponse } from './getTransaction.js';
-type TransactionsResponse = TransactionResponse[];
-/**
- * The function getAllTransactions fetches all transactions from a specified endpoint and handles any
- * errors that occur.
- * @returns The `getAllTransactions` function is returning the result of the `get` function called with
- * the '/pub/transactions' endpoint. The result is expected to be of type `TransactionsResponse`. If
- * successful, the function will return the transactions data. If an error occurs during the API call,
- * it will be caught, logged to the console, and rethrown.
- */
-export declare const getAllTransactions: () => Promise<TransactionsResponse>;
-export {};

package/dist/lib/core/getAllTranstions.js

@@ -1,18 +0,0 @@
-import { get } from '../../utils/api.js';
-/**
- * The function getAllTransactions fetches all transactions from a specified endpoint and handles any
- * errors that occur.
- * @returns The `getAllTransactions` function is returning the result of the `get` function called with
- * the '/pub/transactions' endpoint. The result is expected to be of type `TransactionsResponse`. If
- * successful, the function will return the transactions data. If an error occurs during the API call,
- * it will be caught, logged to the console, and rethrown.
- */
-export const getAllTransactions = async () => {
-    try {
-        return await get('/pub/transactions');
-    }
-    catch (err) {
-        console.error('Error fetching Transactions:', err);
-        throw err;
-    }
-};