v3.9.6: feat(#322) add nextPageCursor type via generic

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "bybit-api",
-  "version": "3.9.5",
+  "version": "3.9.6",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "bybit-api",
-      "version": "3.9.5",
+      "version": "3.9.6",
       "license": "MIT",
       "dependencies": {
         "axios": "^1.6.6",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bybit-api",
-  "version": "3.9.5",
+  "version": "3.9.6",
   "description": "Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

src/rest-client-v5.ts

@@ -38,6 +38,7 @@ import {
   CreateSubMemberParamsV5,
   CreateSubMemberResultV5,
   CursorListV5,
+  CursorRowsV5,
   DeleteSubMemberParamsV5,
   DeliveryPriceV5,
   DeliveryRecordV5,
@@ -1206,7 +1207,7 @@ export class RestClientV5 extends BaseRestClient {
    */
   getWithdrawalRecords(
     params?: GetWithdrawalRecordsParamsV5,
-  ): Promise<APIResponseV3<{ rows: WithdrawalRecordV5[] }>> {
+  ): Promise<CursorRowsV5<WithdrawalRecordV5[]>> {
     return this.getPrivate('/v5/asset/withdraw/query-record', params);
   }
 

src/types/v5-shared.ts

@@ -200,6 +200,16 @@ export interface CursorListV5<T extends unknown[]> {
   list: T;
 }
 
+/**
+ * A wrapper type for any responses that have a "nextPageCursor" property, and a "rows" property with an array of elements
+ *
+ * ```{ nextPageCursor: "something", rows: someData[] }```
+ */
+export interface CursorRowsV5<T extends unknown[]> {
+  nextPageCursor: string;
+  rows: T;
+}
+
 export interface CategoryListV5<
   T extends unknown[],
   TCategory extends CategoryV5,