b5-api-client 0.0.16 → 0.0.18

package/dist/APITester.js

@@ -103,6 +103,7 @@ function testTakeOrder() {
 function testCreateUser() {
     return __awaiter(this, void 0, void 0, function* () {
         const user = {
+            id: "123",
             username: "username_test"
         };
         const response = yield client.createUser(user);

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, UsersResponse } from './types';
 declare class P2PMarketplaceAPIClient {
     private readonly client;
     private readonly defaultHeaders;
@@ -11,12 +11,14 @@ declare class P2PMarketplaceAPIClient {
     getOrderById(id: string, headers?: Record<string, string>): Promise<OrderResponse>;
     createOrder(order: CreateOrderRequest, headers?: Record<string, string>): Promise<OrderResponse>;
     takeOrder(order: TakeOrderRequest, headers?: Record<string, string>): Promise<OrderResponse>;
-    createUser(user: CreateUserRequest, headers?: Record<string, string>): Promise<Order>;
     updateOrder(updateRequest: UpdateOrderRequest, headers?: Record<string, string>): Promise<Order>;
+    createUser(user: CreateUserRequest, headers?: Record<string, string>): Promise<UsersResponse>;
+    getUser(userId: string, headers?: Record<string, string>): Promise<UsersResponse>;
     rateUser(rateUserRequest: RateUserRequest, headers?: Record<string, string>): Promise<any>;
     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

@@ -109,16 +109,22 @@ class P2PMarketplaceAPIClient {
             return this.post(url, order, headers);
         });
     }
+    updateOrder(updateRequest, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = '/api/orders/update';
+            return this.post(url, updateRequest, headers);
+        });
+    }
     createUser(user, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             const url = '/api/users';
             return this.post(url, user, headers);
         });
     }
-    updateOrder(updateRequest, headers) {
+    getUser(userId, headers) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = '/api/orders/update';
-            return this.post(url, updateRequest, headers);
+            const url = `/api/users/${userId}`;
+            return this.get(url, headers);
         });
     }
     rateUser(rateUserRequest, headers) {
@@ -145,6 +151,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

@@ -38,10 +38,14 @@ export interface Order {
     creatorRating: string;
     transactionsCount: number;
     chatId: string;
+    userMetrics?: UserMetrics[];
 }
 export interface OrderResponse {
     orders: Order[];
 }
+export interface UsersResponse {
+    users: KioscoinUser[];
+}
 export interface PaymentMethod {
     type: string;
     alias?: string;
@@ -92,6 +96,7 @@ export interface TakeBuyOrderRequest {
     hash?: string;
 }
 export interface CreateUserRequest {
+    id: string;
     username: string;
 }
 export interface UpdateOrderRequest {
@@ -147,8 +152,73 @@ 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;
 }
 export interface TestEventParams {
 }
+export interface UserMetrics {
+    userId: string;
+    avgTimeToLock: number;
+    avgTimeToRelease: number;
+    avgTimeToFiatSent: number;
+}
+export interface UserReview {
+    reviewId?: string;
+    rating?: number;
+    reviewedAt?: string;
+}
+export interface KioscoinUser {
+    id?: string;
+    username?: string;
+    lang?: string;
+    tradesCompleted?: number;
+    totalReviews?: number;
+    lastRating: string;
+    totalRating: string;
+    volumeTraded?: number;
+    admin?: boolean;
+    banned?: boolean;
+    showUsername?: boolean;
+    showVolumeTraded?: boolean;
+    lightningAddress?: string;
+    disputes?: number;
+    defaultCommunityId?: string;
+    timeToLock?: number;
+    timeToRelease?: number;
+    timeToFiatSent?: number;
+    reviews?: UserReview[];
+}

package/package.json

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

package/src/APITester.ts

@@ -85,6 +85,7 @@ async function testTakeOrder() {
 
 async function testCreateUser() {
     const user: CreateUserRequest = {
+        id: "123",
         username: "username_test"
     }
     const response = await client.createUser(user);

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, KioscoinUser, UsersResponse } from './types';
 import { isPlainObject, camelCase, snakeCase, transform } from 'lodash';
 
 class P2PMarketplaceAPIClient {
@@ -96,16 +96,21 @@ class P2PMarketplaceAPIClient {
         return this.post<OrderResponse>(url, order, headers);
     }
 
-    public async createUser(user: CreateUserRequest, headers?: Record<string, string>): Promise<Order> {
-        const url = '/api/users';
-        return this.post<Order>(url, user, headers);
-    }
-
     public async updateOrder(updateRequest: UpdateOrderRequest, headers?: Record<string, string>): Promise<Order> {
         const url = '/api/orders/update';
         return this.post<Order>(url, updateRequest, headers);
     }
 
+    public async createUser(user: CreateUserRequest, headers?: Record<string, string>): Promise<UsersResponse> {
+        const url = '/api/users';
+        return this.post<UsersResponse>(url, user, headers);
+    }
+
+    public async getUser(userId: string, headers?: Record<string, string>): Promise<UsersResponse> {
+        const url = `/api/users/${userId}`;
+        return this.get<UsersResponse>(url, headers);
+    }
+
     public async rateUser(rateUserRequest: RateUserRequest, headers?: Record<string, string>): Promise<any> {
         const url = '/api/users/rate';
         return this.post<any>(url, rateUserRequest, headers);
@@ -126,6 +131,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

@@ -58,12 +58,17 @@ export interface Order {
     creatorRating: string;
     transactionsCount: number;
     chatId: string;
+    userMetrics?: UserMetrics[];
 }
 
 export interface OrderResponse {
     orders: Order[]
 }
 
+export interface UsersResponse {
+    users: KioscoinUser[]
+}
+
 export interface PaymentMethod {
     type: string;
     alias?: string;
@@ -120,6 +125,7 @@ export interface TakeBuyOrderRequest {
 }
 
 export interface CreateUserRequest {
+    id: string;
     username: string;
 }
 
@@ -184,10 +190,85 @@ 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;
 }
 
 export interface TestEventParams {
 
+}
+
+export interface UserMetrics {
+    userId: string;
+    avgTimeToLock: number;
+    avgTimeToRelease: number;
+    avgTimeToFiatSent: number;
+}
+
+export interface UserReview {
+    reviewId?: string;
+    rating?: number;
+    reviewedAt?: string;
+}
+
+export interface KioscoinUser {
+    id?: string;
+    username?: string;
+    lang?: string;
+    tradesCompleted?: number;
+    totalReviews?: number;
+    lastRating: string;
+    totalRating: string;
+    volumeTraded?: number;
+    admin?: boolean;
+    banned?: boolean;
+    showUsername?: boolean;
+    showVolumeTraded?: boolean;
+    lightningAddress?: string;
+    disputes?: number;
+    defaultCommunityId?: string;
+    timeToLock?: number;
+    timeToRelease?: number;
+    timeToFiatSent?: number;
+    reviews?: UserReview[];
 }