Merge pull request #53 from sx-bet/47-support-pagination-in-relayer-c…

…alls

47 support pagination in relayer calls

README.md

@@ -105,12 +105,24 @@ As a foreword the wrapper throws errors if parameters are bad, mismatched, or th
 
 ### Get all the active markets
 
+This function uses pagination to retrieve active market data. The response will contain two values: **markets** and **nextKey**. For the next set of markets, the paginationKey must be provided.
+
+Field Notes: 
+- paginationKey (optional) - needed to iterate over all markets
+- pageSize (optional) - the default AND max pageSize value is 50
+
 ```typescript
-const activeMarkets = await sportX.getActiveMarkets();
-console.log(activeMarkets);
+const data = await sportX.getActiveMarkets({
+  paginationKey: "<myPaginationKey>",
+  pageSize: 10
+});
+
+console.log(`active markets: ${data.markets}`);
+console.log(`next pagination key: ${data.nextKey}`);
 ```
+The above produces an object that contains two values: 
 
-Which produces an **array** of objects with the following schema:
+1) markets: Which produces an **array** of objects with the following schema:
 
 ```typescript
 interface IMarket {
@@ -140,6 +152,8 @@ interface IMarket {
 }
 ```
 
+2) nextKey: Which provides a string value of the next **paginationKey**.
+
 The `sportId` and `leagueId`'s actual names can be found by fetching the leagues and sports. See below.
 
 `line` will either be a spread or a total. You can figure out which team the spread is attributed to by looking at `outcomeOneName` and `outcomeTwoName`.

package.json

@@ -68,5 +68,5 @@
     "test": "rm -rf dist/ && tsc && mocha \"dist/test/*.js\" --timeout 120000 --exit --bail",
     "format": "tslint --fix -c tslint.json 'test/**/*.ts' 'src/**/*.ts' && prettier --write 'test/**/*.ts' 'src/**/*.ts'"
   },
-  "version": "13.0.0"
+  "version": "13.0.1"
 }

src/sportx.ts

@@ -41,6 +41,7 @@ import {
   ICancelEventOrdersRequest,
   ICancelOrderRequest,
   IDetailedRelayerMakerOrder,
+  IGetActiveMarketsRequest,
   IGetActiveMarketsResponse,
   IGetTradesRequest,
   ILeague,
@@ -86,14 +87,8 @@ export interface ISportX {
   getSports(): Promise<ISport[]>;
   getActiveLeagues(): Promise<ILeague[]>;
   getActiveMarkets(
-    mainLinesOnly?: boolean,
-    eventId?: number,
-    leagueId?: string,
-    liveOnly?: boolean,
-    betGroup?: string,
-    paginationKey? :string,
-    pageSize? : number
-  ): Promise<IGetActiveMarketsResponse>;
+    activeMarketsRequest: IGetActiveMarketsRequest
+    ): Promise<IGetActiveMarketsResponse>;
   getPopularMarkets(): Promise<IMarket[]>;
   marketLookup(marketHashes: string[]): Promise<IMarket[]>;
   newOrder(orders: INewOrder[]): Promise<IRelayerResponse>;
@@ -439,15 +434,18 @@ class SportX implements ISportX {
   }
 
   public async getActiveMarkets(
-    mainLinesOnly?: boolean,
-    eventId?: number,
-    leagueId?: string,
-    liveOnly?: boolean,
-    betGroup?: string,
-    paginationKey?: string,
-    pageSize?: number
+    activeMarketsRequest: IGetActiveMarketsRequest
   ): Promise<IGetActiveMarketsResponse> {
     this.debug("getActiveMarkets");
+    const {
+      mainLinesOnly,
+      leagueId,
+      eventId,
+      liveOnly,
+      betGroup,
+      paginationKey,
+      pageSize
+    } = activeMarketsRequest;
     const qs = queryString.stringify({
       ...(mainLinesOnly !== undefined && { onlyMainLine: mainLinesOnly }),
       ...(leagueId !== undefined && { leagueId }),

src/types/relayer.ts

@@ -29,6 +29,16 @@ export interface IRelayerHistoricalMarketRequest {
   marketHashes: string[];
 }
 
+export interface IGetActiveMarketsRequest {
+  mainLinesOnly?: boolean;
+  eventId?: number;
+  leagueId?: string;
+  liveOnly?: boolean;
+  betGroup?: string;
+  paginationKey? :string;
+  pageSize? : number;
+}
+
 export interface IGetTradesRequest {
   startDate?: number;
   endDate?: number;