paj_ramp 1.2.6 → 1.2.8

package/dist/lib/off_ramp/getRate.d.ts

@@ -1,17 +1,17 @@
 type AllRateResponseType = {
     onRampRate: {
-        baseCurrency: 'USD';
-        targetCurrency: 'NGN';
-        isActive: true;
-        rate: 1510;
-        type: 'onRamp';
+        baseCurrency: string;
+        targetCurrency: string;
+        isActive: boolean;
+        rate: number;
+        type: string;
     };
     offRampRate: {
-        baseCurrency: 'USD';
-        targetCurrency: 'NGN';
-        isActive: true;
-        rate: 1525;
-        type: 'offRamp';
+        baseCurrency: string;
+        targetCurrency: string;
+        isActive: boolean;
+        rate: number;
+        type: string;
     };
 };
 type RateByAmountType = {
@@ -28,11 +28,11 @@ type RateByAmountType = {
     };
 };
 type RateByRateTypeType = {
-    baseCurrency: 'USD';
-    targetCurrency: 'NGN';
+    baseCurrency: string;
+    targetCurrency: string;
     isActive: true;
-    rate: 1525;
-    type: 'offRamp';
+    rate: number;
+    type: string;
 };
 type TokenValueType = {
     amount: number;
@@ -54,7 +54,10 @@ export declare enum RateType {
  * @returns The `getRate` function returns different values based on the conditions inside the
  * function:
  */
-export declare const getRate: (param: number | RateType, mint_token?: string) => Promise<AllRateResponseType | RateByAmountType | RateByRateTypeType | TokenValueType | undefined>;
+export declare function getRate(): Promise<AllRateResponseType>;
+export declare function getRate(param: number, mint_token: string): Promise<TokenValueType>;
+export declare function getRate(param: number): Promise<RateByAmountType>;
+export declare function getRate(param: RateType): Promise<RateByRateTypeType>;
 /**
  * The function `getAllRate` fetches all rates from a specified URL and handles any errors that occur
  * during the process.

package/dist/lib/off_ramp/getRate.js

@@ -4,18 +4,7 @@ export var RateType;
     RateType["onRamp"] = "onRamp";
     RateType["offRamp"] = "offRamp";
 })(RateType || (RateType = {}));
-/**
- * The function `getRate` in TypeScript is an asynchronous function that retrieves rate information
- * based on different parameters such as amount, rate type, and mint token.
- * @param {number | RateType} param - The `param` parameter in the `getRate` function can be either a
- * number or a `RateType`.
- * @param {string} [mint_token] - The `mint_token` parameter is an optional string parameter that
- * represents a token used for minting. It is used in the `getRate` function to calculate the rate
- * based on the specified token value.
- * @returns The `getRate` function returns different values based on the conditions inside the
- * function:
- */
-export const getRate = async (param, mint_token) => {
+export async function getRate(param, mint_token) {
     try {
         const url = '/pub/rate';
         if (!param) {
@@ -34,7 +23,7 @@ export const getRate = async (param, mint_token) => {
         console.error('Error fetching Rate:', err);
         throw err;
     }
-};
+}
 /**
  * The function `getAllRate` fetches all rates from a specified URL and handles any errors that occur
  * during the process.

package/dist/lib/on_ramp/createOrder.d.ts

@@ -7,5 +7,12 @@ type CreateOrderType = {
     webhookURL: string;
     token?: string;
 };
-export declare const createOrder: (options: CreateOrderType) => Promise<CreateOrderType>;
+type CreateOrderResponseType = {
+    id: string;
+    accountNumber: string;
+    accountName: string;
+    amount: number;
+    bank: string;
+};
+export declare const createOrder: (options: CreateOrderType) => Promise<CreateOrderResponseType>;
 export {};

package/dist/lib/on_ramp/createOrder.js

@@ -1,20 +1,20 @@
-import { post } from "../../utils/api.js";
+import { post } from '../../utils/api.js';
 export const createOrder = async (options) => {
     const { fiatAmount, currency, recipient, mint, chain, webhookURL, token } = options;
     try {
-        return await post("/pub/onramp", {
+        return await post('/pub/onramp', {
             fiatAmount,
             currency,
             recipient,
             mint,
             chain,
-            webhookURL
+            webhookURL,
         }, {
             Authorization: `Bearer ${token}`,
         });
     }
     catch (err) {
-        console.error("Error creating order:", err);
+        console.error('Error creating order:', err);
         throw err;
     }
 };

package/dist/sdk.d.ts

@@ -2,11 +2,10 @@ export declare const initializeSDK: (env: "staging" | "production") => void;
 export { getRate } from './lib/off_ramp/getRate.js';
 export { initiate } from './lib/off_ramp/initiate.js';
 export { verify } from './lib/off_ramp/verify.js';
-export { getBanks } from "./lib/off_ramp/getBanks.js";
-export { resolveBankAccount } from "./lib/off_ramp/resolveBankAccount.js";
-export { addBankAccount } from "./lib/off_ramp/addBankAccount.js";
-export { getBankAccounts } from "./lib/off_ramp/getBankAccounts.js";
+export { getBanks } from './lib/off_ramp/getBanks.js';
+export { resolveBankAccount } from './lib/off_ramp/resolveBankAccount.js';
+export { addBankAccount } from './lib/off_ramp/addBankAccount.js';
+export { getBankAccounts } from './lib/off_ramp/getBankAccounts.js';
 export { offRampCreateOrder } from './lib/direct_off_ramp/directCreateOrder.js';
 export { createOrder } from './lib/on_ramp/createOrder.js';
-export { observeOrder } from './lib/on_ramp/observeOrder.js';
 export { RateType } from './lib/off_ramp/getRate.js';

package/dist/sdk.js

@@ -17,10 +17,10 @@ export { getRate } from './lib/off_ramp/getRate.js';
 export { initiate } from './lib/off_ramp/initiate.js';
 export { verify } from './lib/off_ramp/verify.js';
 //  // Banking Operations
-export { getBanks } from "./lib/off_ramp/getBanks.js";
-export { resolveBankAccount } from "./lib/off_ramp/resolveBankAccount.js";
-export { addBankAccount } from "./lib/off_ramp/addBankAccount.js";
-export { getBankAccounts } from "./lib/off_ramp/getBankAccounts.js";
+export { getBanks } from './lib/off_ramp/getBanks.js';
+export { resolveBankAccount } from './lib/off_ramp/resolveBankAccount.js';
+export { addBankAccount } from './lib/off_ramp/addBankAccount.js';
+export { getBankAccounts } from './lib/off_ramp/getBankAccounts.js';
 // Wallet Operations
 // export { getWallet } from './lib/off_ramp/getWallet.js';
 // export { addWallet } from './lib/off_ramp/addWallet.js';
@@ -31,6 +31,6 @@ export { offRampCreateOrder } from './lib/direct_off_ramp/directCreateOrder.js';
 // Create Order
 export { createOrder } from './lib/on_ramp/createOrder.js';
 // Observe Order Socket.IO
-export { observeOrder } from './lib/on_ramp/observeOrder.js';
+// export { observeOrder } from './lib/on_ramp/observeOrder.js';
 // Types
 export { RateType } from './lib/off_ramp/getRate.js';

package/lib/off_ramp/getRate.ts

@@ -2,18 +2,18 @@ import { get } from '../../utils/api.js';
 
 type AllRateResponseType = {
   onRampRate: {
-    baseCurrency: 'USD';
-    targetCurrency: 'NGN';
-    isActive: true;
-    rate: 1510;
-    type: 'onRamp';
+    baseCurrency: string;
+    targetCurrency: string;
+    isActive: boolean;
+    rate: number;
+    type: string;
   };
   offRampRate: {
-    baseCurrency: 'USD';
-    targetCurrency: 'NGN';
-    isActive: true;
-    rate: 1525;
-    type: 'offRamp';
+    baseCurrency: string;
+    targetCurrency: string;
+    isActive: boolean;
+    rate: number;
+    type: string;
   };
 };
 
@@ -32,11 +32,11 @@ type RateByAmountType = {
 };
 
 type RateByRateTypeType = {
-  baseCurrency: 'USD';
-  targetCurrency: 'NGN';
+  baseCurrency: string;
+  targetCurrency: string;
   isActive: true;
-  rate: 1525;
-  type: 'offRamp';
+  rate: number;
+  type: string;
 };
 
 type TokenValueType = {
@@ -61,10 +61,14 @@ export enum RateType {
  * @returns The `getRate` function returns different values based on the conditions inside the
  * function:
  */
-export const getRate = async (
-  param: number | RateType,
-  mint_token?: string
-) => {
+export function getRate(): Promise<AllRateResponseType>;
+export function getRate(
+  param: number,
+  mint_token: string
+): Promise<TokenValueType>;
+export function getRate(param: number): Promise<RateByAmountType>;
+export function getRate(param: RateType): Promise<RateByRateTypeType>;
+export async function getRate(param?: number | RateType, mint_token?: string) {
   try {
     const url = '/pub/rate';
 
@@ -80,7 +84,7 @@ export const getRate = async (
     console.error('Error fetching Rate:', err);
     throw err;
   }
-};
+}
 
 /**
  * The function `getAllRate` fetches all rates from a specified URL and handles any errors that occur
@@ -120,7 +124,6 @@ export const getRateByAmount = async (url: string, amount: number) => {
   }
 };
 
-
 /**
  * The function `getRateByRateType` fetches a rate based on a specified rate type from a given URL.
  * @param {string} url - The `url` parameter is a string representing the base URL used to fetch data.

package/lib/on_ramp/createOrder.ts

@@ -1,4 +1,4 @@
-import { post } from "../../utils/api.js";
+import { post } from '../../utils/api.js';
 
 type CreateOrderType = {
   fiatAmount: number;
@@ -10,25 +10,34 @@ type CreateOrderType = {
   token?: string;
 };
 
+type CreateOrderResponseType = {
+  id: string;
+  accountNumber: string;
+  accountName: string;
+  amount: number;
+  bank: string;
+};
+
 export const createOrder = async (options: CreateOrderType) => {
-  const { fiatAmount, currency, recipient, mint, chain, webhookURL, token } = options;
+  const { fiatAmount, currency, recipient, mint, chain, webhookURL, token } =
+    options;
   try {
-    return await post<CreateOrderType>(
-      "/pub/onramp",
+    return await post<CreateOrderResponseType>(
+      '/pub/onramp',
       {
         fiatAmount,
         currency,
         recipient,
         mint,
         chain,
-        webhookURL
+        webhookURL,
       },
       {
         Authorization: `Bearer ${token}`,
       }
     );
   } catch (err) {
-    console.error("Error creating order:", err);
+    console.error('Error creating order:', err);
     throw err;
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paj_ramp",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "description": "paj offramp/onramp service",
   "main": "dist/sdk.js",
   "types": "dist/sdk.d.ts",
@@ -15,7 +15,10 @@
     "url": "git+https://github.com/paj-cash/paj_ramp.git"
   },
   "keywords": [
-    "PAJ"
+    "PAJ",
+    "paj",
+    "paj_ramp",
+    "Paj"
   ],
   "author": "Ebube",
   "license": "ISC",

package/sdk.ts

@@ -22,10 +22,10 @@ export { initiate } from './lib/off_ramp/initiate.js';
 export { verify } from './lib/off_ramp/verify.js';
 
 //  // Banking Operations
-export { getBanks } from "./lib/off_ramp/getBanks.js";
-export { resolveBankAccount } from "./lib/off_ramp/resolveBankAccount.js";
-export { addBankAccount } from "./lib/off_ramp/addBankAccount.js";
-export { getBankAccounts } from "./lib/off_ramp/getBankAccounts.js";
+export { getBanks } from './lib/off_ramp/getBanks.js';
+export { resolveBankAccount } from './lib/off_ramp/resolveBankAccount.js';
+export { addBankAccount } from './lib/off_ramp/addBankAccount.js';
+export { getBankAccounts } from './lib/off_ramp/getBankAccounts.js';
 
 // Wallet Operations
 // export { getWallet } from './lib/off_ramp/getWallet.js';
@@ -35,14 +35,13 @@ export { getBankAccounts } from "./lib/off_ramp/getBankAccounts.js";
 // DIRECT OFF RAMP
 export { offRampCreateOrder } from './lib/direct_off_ramp/directCreateOrder.js';
 
-
 // ON RAMP
 
 // Create Order
 export { createOrder } from './lib/on_ramp/createOrder.js';
 
 // Observe Order Socket.IO
-export { observeOrder } from './lib/on_ramp/observeOrder.js';
+// export { observeOrder } from './lib/on_ramp/observeOrder.js';
 
 // Types
-export { RateType } from './lib/off_ramp/getRate.js';
+export { RateType } from './lib/off_ramp/getRate.js';