Merge pull request #41 from JJ-Cro/update10122024

v1.1.2 feat(): added new transfer endpoint, updated response types

Author: tiagosiebler

docs/endpointFunctionList.md

@@ -0,0 +1,20 @@
+const { RestClient } = require('gateio-api');
+
+  // This example shows how to call this Gate.io API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "gateio-api" for Gate.io exchange
+  // This Gate.io API SDK is available on npm via "npm install gateio-api"
+  // ENDPOINT: /wallet/order_status
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new RestClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.getTransferStatus(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/getTransferStatus.js

@@ -1,6 +1,6 @@
 {
   "name": "gateio-api",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Complete & robust Node.js SDK for Gate.io's REST APIs, WebSockets & WebSocket APIs, with TypeScript declarations.",
   "scripts": {
     "clean": "rm -rf dist/*",

package-lock.json

@@ -570,6 +570,25 @@ export class RestClient extends BaseRestClient {
     });
   }
 
+  /**
+   * Query transfer status based on client_order_id or tx_id
+   *
+   * @param params Parameters for querying transfer status
+   * @returns Promise<{
+   *   tx_id: string;
+   *   status: 'PENDING' | 'SUCCESS' | 'FAIL' | 'PARTIAL_SUCCESS';
+   * }>
+   */
+  getTransferStatus(params: {
+    client_order_id?: string;
+    tx_id?: string;
+  }): Promise<{
+    tx_id: string;
+    status: 'PENDING' | 'SUCCESS' | 'FAIL' | 'PARTIAL_SUCCESS';
+  }> {
+    return this.getPrivate('/wallet/order_status', params);
+  }
+
   /**
    * Retrieve withdrawal status
    *

package.json

@@ -224,6 +224,7 @@ export interface FuturesPosition {
   mode?: 'single' | 'dual_long' | 'dual_short';
   cross_leverage_limit?: string;
   update_time?: number;
+  update_id?: number;
   open_time?: number;
 }