@bytexbyte/berify-analytics-api 1.4.8 → 1.5.0

package/lib/ScanChart/index.d.ts

@@ -1,5 +1,5 @@
 import BxBApi from '@bytexbyte/bxb-api';
-import { ScanReportRequest, ScanReportResponse, UserReportRequest, UserReportResponse, ScanRateResponse, ScanRateByTimeRequest, ScanRateByTimeResponse, User, BatchScanDataRequest, BatchScanDataResponse } from './type';
+import { ScanReportRequest, ScanReportResponse, UserReportRequest, UserReportResponse, ScanRateResponse, ScanRateByTimeRequest, ScanRateByTimeResponse, User, BatchScanDataRequest, BatchScanDataResponse, LeaderBoardResponse, LeaderBoardRequest } from './type';
 declare class BerifyScanChartApi extends BxBApi {
     constructor({ host, secretKey, secret }: {
         host: string;
@@ -11,6 +11,6 @@ declare class BerifyScanChartApi extends BxBApi {
     getScanRateAll(user: User, form: UserReportRequest): Promise<ScanRateResponse>;
     getScanRateByTime(user: User, form: ScanRateByTimeRequest): Promise<ScanRateByTimeResponse>;
     getBatchScanData(form: BatchScanDataRequest): Promise<BatchScanDataResponse>;
-    getLeaderBoard(user: User, form: BatchScanDataRequest): Promise<BatchScanDataResponse>;
+    getLeaderBoard(user: User, form: LeaderBoardRequest): Promise<LeaderBoardResponse>;
 }
 export default BerifyScanChartApi;

package/lib/ScanChart/index.js

@@ -169,7 +169,7 @@ var BerifyScanChartApi = /** @class */ (function (_super) {
                                 'Content-Type': 'application/json'
                             },
                             body: JSON.stringify({ user: user, form: form })
-                        }, 'leader-board')];
+                        }, 'leaderBoard')];
                     case 1:
                         response = _a.sent();
                         return [2 /*return*/, response.json()];

package/lib/ScanChart/type.d.ts

@@ -120,3 +120,24 @@ export type BatchScanDataResponse = {
     pageSize: number;
     totalItems: number;
 };
+export type LeaderBoardRequest = {
+    tagTokenId?: string;
+    batchId?: string;
+    companyId?: number;
+    page?: number;
+    pageSize?: number;
+};
+export type LeaderBoardResult = {
+    position: number;
+    batchId: string;
+    batchName: string;
+    totalScans: number;
+}[];
+export type LeaderBoardResponse = {
+    status: 'ok' | 'error';
+    data?: {
+        data: LeaderBoardResult;
+        totalDatasNumber: number;
+    };
+    error?: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytexbyte/berify-analytics-api",
-  "version": "1.4.8",
+  "version": "1.5.0",
   "description": "api",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",