b5-api-client 0.0.16 → 0.0.17

package/dist/P2PMarketplaceAPIClient.d.ts

@@ -1,4 +1,4 @@
-import { CreateOrderRequest, CreateUserRequest, GetOrdersParams, Order, OrderResponse, TakeOrderRequest, TestEventParams, UpdateOrderRequest, TransactionStatusResponse, RateUserRequest, OrderEventsResponse, PushNotificationsRegisterRequest, ConfigResponse } from './types';
+import { CreateOrderRequest, CreateUserRequest, GetOrdersParams, Order, OrderResponse, TakeOrderRequest, TestEventParams, UpdateOrderRequest, TransactionStatusResponse, RateUserRequest, OrderEventsResponse, PushNotificationsRegisterRequest, ConfigResponse, DashboardMetricsResponse } from './types';
 declare class P2PMarketplaceAPIClient {
     private readonly client;
     private readonly defaultHeaders;
@@ -17,6 +17,7 @@ declare class P2PMarketplaceAPIClient {
     registerPushToken(registerRequest: PushNotificationsRegisterRequest, headers?: Record<string, string>): Promise<any>;
     getConfig<T>(): Promise<ConfigResponse<T>>;
     getOrderEvents(id: string, headers?: Record<string, string>): Promise<OrderEventsResponse>;
+    getDashboardMetrics(headers?: Record<string, string>): Promise<DashboardMetricsResponse>;
     testLockFunds(order: Order, testParams?: TestEventParams, headers?: Record<string, string>): Promise<void>;
     testReleaseFunds(order: Order, testParams?: TestEventParams, headers?: Record<string, string>): Promise<void>;
     releaseFunds(order: Order, testParams?: TestEventParams, headers?: Record<string, string>): Promise<string>;

package/dist/P2PMarketplaceAPIClient.js

@@ -145,6 +145,12 @@ class P2PMarketplaceAPIClient {
             return this.get(url, headers);
         });
     }
+    getDashboardMetrics(headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = '/api/dashboard/metrics';
+            return this.get(url, headers);
+        });
+    }
     testLockFunds(order, testParams, headers) {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {

package/dist/types.d.ts

@@ -147,6 +147,39 @@ export interface PushNotificationsRegisterRequest {
     token: string;
     userId: string;
 }
+export interface DashboardMetricsResponse {
+    dashboardMetrics: DashboardMetrics;
+}
+export interface DashboardMetrics {
+    volumeTx: BlockchainVolumes[];
+    ordersPerBlockchain: OrdersPerBlockchain[];
+    ordersCompletedTx: number;
+    feesCollected: FeeCollected[];
+    durationInEscrowPerOrder: ReleasedOrderDuration[];
+}
+export interface BlockchainVolumes {
+    blockchainName: string;
+    volumes: TokenAmount;
+}
+export interface TokenAmount {
+    tokenCode: string;
+    amount: string;
+}
+export interface OrdersPerBlockchain {
+    blockchainName: string;
+    completedOrders: number;
+}
+export interface FeeCollected {
+    blockchainName: string;
+    fees: TokenAmount[];
+}
+export interface ReleasedOrderDuration {
+    orderId: string;
+    blockchain: string;
+    lockedAt: string;
+    releasedAt: string;
+    duration: number;
+}
 export interface ConfigResponse<T = any> {
     config: T;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "b5-api-client",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "Escrow Backend API client",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/P2PMarketplaceAPIClient.ts

@@ -1,5 +1,5 @@
 import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import { CreateOrderRequest, CreateUserRequest, GetOrdersParams, Order, OrderLockedEvent, OrderResponse, ReleaseOrderEvent as OrderReleasedEvent, TakeOrderRequest, TestEventParams, UpdateOrderRequest, TransactionStatusResponse, RateUserRequest, OrderEventsResponse, PushNotificationsRegisterRequest, ConfigResponse } from './types';
+import { CreateOrderRequest, CreateUserRequest, GetOrdersParams, Order, OrderLockedEvent, OrderResponse, ReleaseOrderEvent as OrderReleasedEvent, TakeOrderRequest, TestEventParams, UpdateOrderRequest, TransactionStatusResponse, RateUserRequest, OrderEventsResponse, PushNotificationsRegisterRequest, ConfigResponse, DashboardMetricsResponse } from './types';
 import { isPlainObject, camelCase, snakeCase, transform } from 'lodash';
 
 class P2PMarketplaceAPIClient {
@@ -126,6 +126,11 @@ class P2PMarketplaceAPIClient {
         return this.get<OrderEventsResponse>(url, headers);
     }
 
+    public async getDashboardMetrics(headers?: Record<string, string>): Promise<DashboardMetricsResponse> {
+        const url = '/api/dashboard/metrics';
+        return this.get<DashboardMetricsResponse>(url, headers);
+    }
+
     public async testLockFunds(order: Order, testParams?: TestEventParams, headers?: Record<string, string>) {
         const orderEvent: OrderLockedEvent = {
             type: "LOCKED",

package/src/types.ts

@@ -184,6 +184,46 @@ export interface PushNotificationsRegisterRequest {
     userId: string;
 }
 
+export interface DashboardMetricsResponse {
+    dashboardMetrics: DashboardMetrics;
+}
+
+export interface DashboardMetrics {
+    volumeTx: BlockchainVolumes[];
+    ordersPerBlockchain: OrdersPerBlockchain[];
+    ordersCompletedTx: number; // Total number of completed orders
+    feesCollected: FeeCollected[]; // Assuming this is defined elsewhere
+    durationInEscrowPerOrder: ReleasedOrderDuration[]; // Assuming this is defined elsewhere
+}
+
+export interface BlockchainVolumes {
+    blockchainName: string;
+    volumes: TokenAmount;
+}
+
+export interface TokenAmount {
+    tokenCode: string;
+    amount: string; // Assuming Amount is defined elsewhere
+}
+
+export interface OrdersPerBlockchain {
+    blockchainName: string;
+    completedOrders: number;
+}
+
+export interface FeeCollected {
+    blockchainName: string;
+    fees: TokenAmount[]
+}
+
+export interface ReleasedOrderDuration {
+    orderId: string
+    blockchain: string
+    lockedAt: string
+    releasedAt: string
+    duration: number
+}
+
 export interface ConfigResponse<T = any> {
     config: T;
 }