Cursor based pagination

src/api-client.ts

@@ -5,17 +5,29 @@ import { RequestOptions } from "./types";
 export class ApiClient {
     constructor(private authProvider: IAuthProvider, private apiBaseUrl: string) { }
 
-    public async issueGetRequest(path: string) {
+    public async issueGetRequest(path: string, pageMode: boolean = false) {
         const token = this.authProvider.signJwt(path);
-
-        return await requestPromise.get({
+        const res = await requestPromise.get({
             uri: this.apiBaseUrl + path,
             headers: {
                 "X-API-Key": this.authProvider.getApiKey(),
                 "Authorization": `Bearer ${token}`
             },
-            json: true
+            json: true,
+            resolveWithFullResponse: true
         });
+
+        if (pageMode) {
+            return {
+                transactions: res.body,
+                pageDetails: {
+                    previous: res.headers["previous"] ? res.headers["previous"].toString() :  "",
+                    next:  res.headers["next"] ? res.headers["next"].toString() :  "",
+                }
+            };
+        }
+
+        return res.body;
     }
 
     public async issuePostRequest(path: string, body: any, requestOptions?: RequestOptions) {

src/fireblocks-sdk.ts

@@ -32,7 +32,8 @@ import {
     VaultBalancesFilter,
     ValidateAddressResponse,
     CreateVaultAssetResponse,
-    RequestOptions, AllocateFundsRequest, DeallocateFundsRequest, AssetTypeResponse
+    RequestOptions, AllocateFundsRequest, DeallocateFundsRequest, AssetTypeResponse,
+    TransactionPageResponse
 } from "./types";
 
 export * from "./types";
@@ -272,7 +273,29 @@ export class FireblocksSDK {
      * @param filter.orderBy Determines the order of the results
      */
     public async getTransactions(filter: TransactionFilter): Promise<TransactionResponse[]> {
-        return await this.apiClient.issueGetRequest(`/v1/transactions?${queryString.stringify(filter)}`);
+        return await this.apiClient.issueGetRequest(`/v1/transactions?${queryString.stringify(filter)}`) as TransactionResponse[];
+    }
+
+    /**
+     * Gets a list of transactions per page matching the given filter, `orderBy` field not allowed
+     * @param filter.before Only gets transactions created before a given timestamp (in milliseconds)
+     * @param filter.after Only gets transactions created after a given timestamp (in milliseconds)
+     * @param filter.status Only gets transactions with the spcified status
+     * @param filter.limit Limit the amount of returned results. If not specified, a limit of 200 results will be used
+     */
+    public async getTransactionsWithPageInfo(filter: TransactionFilter): Promise<TransactionPageResponse> {
+        filter.orderBy = undefined;
+        return await this.apiClient.issueGetRequest(`/v1/transactions?${queryString.stringify(filter)}`, true) as TransactionPageResponse;
+    }
+
+    /**
+     * Get next or previous page of transactions matching a given path
+     * @param nextOrPreviousPath Each of path from pageDetails `getTransactionsWithPageInfo` response
+     */
+    public async getTransactionsByPagePath(nextOrPreviousPath: string): Promise<TransactionPageResponse> {
+        const index = nextOrPreviousPath.indexOf("/v1/");
+        const path = nextOrPreviousPath.substring(index, nextOrPreviousPath.length);
+        return await this.apiClient.issueGetRequest(path, true) as TransactionPageResponse;
     }
 
     /**

src/types.ts

@@ -203,6 +203,16 @@ export interface FiatAccountResponse {
     assets: AssetResponse[];
 }
 
+export interface TransactionPageResponse {
+    transactions: TransactionResponse[];
+    pageDetails: PageDetails;
+}
+
+export interface PageDetails {
+    previous: string;
+    next: string;
+}
+
 export interface TransactionResponse {
     id: string;
     assetId: string;