@binance/wallet 8.0.0 → 10.0.0

package/dist/index.js

@@ -41,7 +41,7 @@ var import_common7 = require("@binance/common");
 
 // package.json
 var name = "@binance/wallet";
-var version = "8.0.0";
+var version = "10.0.0";
 
 // src/rest-api/index.ts
 var rest_api_exports = {};
@@ -842,9 +842,6 @@ var AssetApiAxiosParamCreator = function(configuration) {
     /**
      * Query User Wallet Balance
      *
-     *
-     * You need to open Permits Universal Transfer permission for the API Key which requests this endpoint.
-     *
      * Weight: 60
      *
      * @summary Query User Wallet Balance (USER_DATA)
@@ -1362,9 +1359,6 @@ var AssetApi = class {
   /**
    * Query User Wallet Balance
    *
-   *
-   * You need to open Permits Universal Transfer permission for the API Key which requests this endpoint.
-   *
    * Weight: 60
    *
    * @summary Query User Wallet Balance (USER_DATA)
@@ -1786,6 +1780,7 @@ var CapitalApiAxiosParamCreator = function(configuration) {
      *
      * If `network` not send, return with default network of the coin.
      * You can get `network` and `isDefault` in `networkList` of a coin in the response of `Get /sapi/v1/capital/config/getall (HMAC SHA256)`.
+     * To check if travel rule is required, by using  `GET /sapi/v1/localentity/questionnaire-requirements` and if it returns anything other than `NIL` you will need update SAPI to `POST /sapi/v1/localentity/withdraw/apply` else you can continue `POST /sapi/v1/capital/withdraw/apply`. Please note that if you are required to comply to travel rule please refer to the Travel Rule SAPI.
      *
      * Weight: 900
      *
@@ -2122,6 +2117,7 @@ var CapitalApi = class {
    *
    * If `network` not send, return with default network of the coin.
    * You can get `network` and `isDefault` in `networkList` of a coin in the response of `Get /sapi/v1/capital/config/getall (HMAC SHA256)`.
+   * To check if travel rule is required, by using  `GET /sapi/v1/localentity/questionnaire-requirements` and if it returns anything other than `NIL` you will need update SAPI to `POST /sapi/v1/localentity/withdraw/apply` else you can continue `POST /sapi/v1/capital/withdraw/apply`. Please note that if you are required to comply to travel rule please refer to the Travel Rule SAPI.
    *
    * Weight: 900
    *
@@ -2388,13 +2384,7 @@ var TravelRuleApiAxiosParamCreator = function(configuration) {
     /**
      * This API will return user-specific Travel Rule questionnaire requirement information in reference to the current API key.
      *
-     * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-     *
-     * Weight: 18000
-     * Request limit: 10 requests per second
-     * > * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-     * limit is 180000/second. Response from the endpoint contains header
-     * key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.
+     * Weight: 1
      *
      * @summary Check Questionnaire Requirements (for local entities that require travel rule) (supporting network) (USER_DATA)
      * @param {number} [recvWindow]
@@ -2483,9 +2473,68 @@ var TravelRuleApiAxiosParamCreator = function(configuration) {
       };
     },
     /**
-     * Fetch address verification list
+     * Fetch deposit history for local entities that with required travel rule information.
      *
-     * Weight: 10
+     * Please notice the default `startTime` and `endTime` to make sure that time interval is within
+     * If both ``startTime`` and ``endTime`` are sent, time between ``startTime`` and ``endTime`` must
+     *
+     * Weight: 1
+     *
+     * @summary Deposit History V2 (for local entities that required travel rule) (supporting network) (USER_DATA)
+     * @param {string} [depositId] Comma(,) separated list of wallet tran Ids.
+     * @param {string} [txId]
+     * @param {string} [network]
+     * @param {string} [coin]
+     * @param {boolean} [retrieveQuestionnaire] true: return `questionnaire` within response.
+     * @param {number} [startTime]
+     * @param {number} [endTime]
+     * @param {number} [offset] Default: 0
+     * @param {number} [limit] min 7, max 30, default 7
+     *
+     * @throws {RequiredError}
+     */
+    depositHistoryV2: async (depositId, txId, network, coin, retrieveQuestionnaire, startTime, endTime, offset, limit) => {
+      const localVarQueryParameter = {};
+      if (depositId !== void 0 && depositId !== null) {
+        localVarQueryParameter["depositId"] = depositId;
+      }
+      if (txId !== void 0 && txId !== null) {
+        localVarQueryParameter["txId"] = txId;
+      }
+      if (network !== void 0 && network !== null) {
+        localVarQueryParameter["network"] = network;
+      }
+      if (coin !== void 0 && coin !== null) {
+        localVarQueryParameter["coin"] = coin;
+      }
+      if (retrieveQuestionnaire !== void 0 && retrieveQuestionnaire !== null) {
+        localVarQueryParameter["retrieveQuestionnaire"] = retrieveQuestionnaire;
+      }
+      if (startTime !== void 0 && startTime !== null) {
+        localVarQueryParameter["startTime"] = startTime;
+      }
+      if (endTime !== void 0 && endTime !== null) {
+        localVarQueryParameter["endTime"] = endTime;
+      }
+      if (offset !== void 0 && offset !== null) {
+        localVarQueryParameter["offset"] = offset;
+      }
+      if (limit !== void 0 && limit !== null) {
+        localVarQueryParameter["limit"] = limit;
+      }
+      let _timeUnit;
+      if ("timeUnit" in configuration) _timeUnit = configuration.timeUnit;
+      return {
+        endpoint: "/sapi/v2/localentity/deposit/history",
+        method: "GET",
+        params: localVarQueryParameter,
+        timeUnit: _timeUnit
+      };
+    },
+    /**
+     * Fetch address verification list for user to check on status and other details for the addresses stored in Address Book.
+     *
+     * Weight: 1
      *
      * @summary Fetch address verification list (USER_DATA)
      * @param {number} [recvWindow]
@@ -2618,13 +2667,7 @@ var TravelRuleApiAxiosParamCreator = function(configuration) {
     /**
      * Fetch the VASP list for local entities.
      *
-     * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-     *
-     * Weight: 18000
-     * Request limit: 10 requests per second
-     * > * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-     * limit is 180000/second. Response from the endpoint contains header
-     * key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.
+     * Weight: 1
      *
      * @summary VASP list (for local entities that require travel rule) (supporting network) (USER_DATA)
      * @param {number} [recvWindow]
@@ -2648,16 +2691,11 @@ var TravelRuleApiAxiosParamCreator = function(configuration) {
     /**
      * Fetch withdraw history for local entities that required travel rule.
      *
-     * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
      * `network` may not be in the response for old withdraw.
      * Please notice the default `startTime` and `endTime` to make sure that time interval is within
      * If both `startTime` and `endTime`are sent, time between `startTime`and `endTime`must be less
      *
-     * Weight: 18000
-     * Request limit: 10 requests per second
-     * > * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-     * limit is 180000/second. Response from the endpoint contains header
-     * key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.
+     * Weight: 1
      *
      * @summary Withdraw History (for local entities that require travel rule) (supporting network) (USER_DATA)
      * @param {string} [trId] Comma(,) separated list of travel rule record Ids.
@@ -2721,7 +2759,6 @@ var TravelRuleApiAxiosParamCreator = function(configuration) {
     /**
      * Fetch withdraw history for local entities that required travel rule.
      *
-     * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
      * `network` may not be in the response for old withdraw.
      * Withdrawal made through /sapi/v1/capital/withdraw/apply may not be in the response.
      * Please notice the default `startTime` and `endTime` to make sure that time interval is within
@@ -2732,11 +2769,7 @@ var TravelRuleApiAxiosParamCreator = function(configuration) {
      * WithdrawOrderId only support 1.
      * If responsible does not include withdrawalStatus, please input trId or txId retrieve the data.
      *
-     * Weight: 18000
-     * Request limit: 10 requests per second
-     * > * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-     * limit is 180000/second. Response from the endpoint contains header
-     * key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.
+     * Weight: 1
      *
      * @summary Withdraw History V2 (for local entities that require travel rule) (supporting network) (USER_DATA)
      * @param {string} [trId] Comma(,) separated list of travel rule record Ids.
@@ -2921,13 +2954,7 @@ var TravelRuleApi = class {
   /**
    * This API will return user-specific Travel Rule questionnaire requirement information in reference to the current API key.
    *
-   * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-   *
-   * Weight: 18000
-   * Request limit: 10 requests per second
-   * > * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-   * limit is 180000/second. Response from the endpoint contains header
-   * key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.
+   * Weight: 1
    *
    * @summary Check Questionnaire Requirements (for local entities that require travel rule) (supporting network) (USER_DATA)
    * @param {CheckQuestionnaireRequirementsRequest} requestParameters Request parameters.
@@ -2988,9 +3015,45 @@ var TravelRuleApi = class {
     );
   }
   /**
-   * Fetch address verification list
+   * Fetch deposit history for local entities that with required travel rule information.
    *
-   * Weight: 10
+   * Please notice the default `startTime` and `endTime` to make sure that time interval is within
+   * If both ``startTime`` and ``endTime`` are sent, time between ``startTime`` and ``endTime`` must
+   *
+   * Weight: 1
+   *
+   * @summary Deposit History V2 (for local entities that required travel rule) (supporting network) (USER_DATA)
+   * @param {DepositHistoryV2Request} requestParameters Request parameters.
+   * @returns {Promise<RestApiResponse<DepositHistoryV2Response>>}
+   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+   * @memberof TravelRuleApi
+   * @see {@link https://developers.binance.com/docs/wallet/travel-rule/Deposit-History-V2 Binance API Documentation}
+   */
+  async depositHistoryV2(requestParameters = {}) {
+    const localVarAxiosArgs = await this.localVarAxiosParamCreator.depositHistoryV2(
+      requestParameters?.depositId,
+      requestParameters?.txId,
+      requestParameters?.network,
+      requestParameters?.coin,
+      requestParameters?.retrieveQuestionnaire,
+      requestParameters?.startTime,
+      requestParameters?.endTime,
+      requestParameters?.offset,
+      requestParameters?.limit
+    );
+    return (0, import_common5.sendRequest)(
+      this.configuration,
+      localVarAxiosArgs.endpoint,
+      localVarAxiosArgs.method,
+      localVarAxiosArgs.params,
+      localVarAxiosArgs?.timeUnit,
+      { isSigned: true }
+    );
+  }
+  /**
+   * Fetch address verification list for user to check on status and other details for the addresses stored in Address Book.
+   *
+   * Weight: 1
    *
    * @summary Fetch address verification list (USER_DATA)
    * @param {FetchAddressVerificationListRequest} requestParameters Request parameters.
@@ -3085,13 +3148,7 @@ var TravelRuleApi = class {
   /**
    * Fetch the VASP list for local entities.
    *
-   * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-   *
-   * Weight: 18000
-   * Request limit: 10 requests per second
-   * > * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-   * limit is 180000/second. Response from the endpoint contains header
-   * key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.
+   * Weight: 1
    *
    * @summary VASP list (for local entities that require travel rule) (supporting network) (USER_DATA)
    * @param {VaspListRequest} requestParameters Request parameters.
@@ -3116,16 +3173,11 @@ var TravelRuleApi = class {
   /**
    * Fetch withdraw history for local entities that required travel rule.
    *
-   * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
    * `network` may not be in the response for old withdraw.
    * Please notice the default `startTime` and `endTime` to make sure that time interval is within
    * If both `startTime` and `endTime`are sent, time between `startTime`and `endTime`must be less
    *
-   * Weight: 18000
-   * Request limit: 10 requests per second
-   * > * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-   * limit is 180000/second. Response from the endpoint contains header
-   * key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.
+   * Weight: 1
    *
    * @summary Withdraw History (for local entities that require travel rule) (supporting network) (USER_DATA)
    * @param {WithdrawHistoryV1Request} requestParameters Request parameters.
@@ -3160,7 +3212,6 @@ var TravelRuleApi = class {
   /**
    * Fetch withdraw history for local entities that required travel rule.
    *
-   * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
    * `network` may not be in the response for old withdraw.
    * Withdrawal made through /sapi/v1/capital/withdraw/apply may not be in the response.
    * Please notice the default `startTime` and `endTime` to make sure that time interval is within
@@ -3171,11 +3222,7 @@ var TravelRuleApi = class {
    * WithdrawOrderId only support 1.
    * If responsible does not include withdrawalStatus, please input trId or txId retrieve the data.
    *
-   * Weight: 18000
-   * Request limit: 10 requests per second
-   * > * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-   * limit is 180000/second. Response from the endpoint contains header
-   * key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.
+   * Weight: 1
    *
    * @summary Withdraw History V2 (for local entities that require travel rule) (supporting network) (USER_DATA)
    * @param {WithdrawHistoryV2Request} requestParameters Request parameters.
@@ -3555,9 +3602,6 @@ var RestAPI = class {
   /**
    * Query User Wallet Balance
    *
-   *
-   * You need to open Permits Universal Transfer permission for the API Key which requests this endpoint.
-   *
    * Weight: 60
    *
    * @summary Query User Wallet Balance (USER_DATA)
@@ -3781,6 +3825,7 @@ var RestAPI = class {
    *
    * If `network` not send, return with default network of the coin.
    * You can get `network` and `isDefault` in `networkList` of a coin in the response of `Get /sapi/v1/capital/config/getall (HMAC SHA256)`.
+   * To check if travel rule is required, by using  `GET /sapi/v1/localentity/questionnaire-requirements` and if it returns anything other than `NIL` you will need update SAPI to `POST /sapi/v1/localentity/withdraw/apply` else you can continue `POST /sapi/v1/capital/withdraw/apply`. Please note that if you are required to comply to travel rule please refer to the Travel Rule SAPI.
    *
    * Weight: 900
    *
@@ -3864,13 +3909,7 @@ var RestAPI = class {
   /**
    * This API will return user-specific Travel Rule questionnaire requirement information in reference to the current API key.
    *
-   * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-   *
-   * Weight: 18000
-   * Request limit: 10 requests per second
-   * > * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-   * limit is 180000/second. Response from the endpoint contains header
-   * key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.
+   * Weight: 1
    *
    * @summary Check Questionnaire Requirements (for local entities that require travel rule) (supporting network) (USER_DATA)
    * @param {CheckQuestionnaireRequirementsRequest} requestParameters Request parameters.
@@ -3899,9 +3938,26 @@ var RestAPI = class {
     return this.travelRuleApi.depositHistoryTravelRule(requestParameters);
   }
   /**
-   * Fetch address verification list
+   * Fetch deposit history for local entities that with required travel rule information.
    *
-   * Weight: 10
+   * Please notice the default `startTime` and `endTime` to make sure that time interval is within
+   * If both ``startTime`` and ``endTime`` are sent, time between ``startTime`` and ``endTime`` must
+   *
+   * Weight: 1
+   *
+   * @summary Deposit History V2 (for local entities that required travel rule) (supporting network) (USER_DATA)
+   * @param {DepositHistoryV2Request} requestParameters Request parameters.
+   * @returns {Promise<RestApiResponse<DepositHistoryV2Response>>}
+   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+   * @see {@link https://developers.binance.com/docs/wallet/travel-rule/Deposit-History-V2 Binance API Documentation}
+   */
+  depositHistoryV2(requestParameters = {}) {
+    return this.travelRuleApi.depositHistoryV2(requestParameters);
+  }
+  /**
+   * Fetch address verification list for user to check on status and other details for the addresses stored in Address Book.
+   *
+   * Weight: 1
    *
    * @summary Fetch address verification list (USER_DATA)
    * @param {FetchAddressVerificationListRequest} requestParameters Request parameters.
@@ -3953,13 +4009,7 @@ var RestAPI = class {
   /**
    * Fetch the VASP list for local entities.
    *
-   * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-   *
-   * Weight: 18000
-   * Request limit: 10 requests per second
-   * > * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-   * limit is 180000/second. Response from the endpoint contains header
-   * key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.
+   * Weight: 1
    *
    * @summary VASP list (for local entities that require travel rule) (supporting network) (USER_DATA)
    * @param {VaspListRequest} requestParameters Request parameters.
@@ -3973,16 +4023,11 @@ var RestAPI = class {
   /**
    * Fetch withdraw history for local entities that required travel rule.
    *
-   * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
    * `network` may not be in the response for old withdraw.
    * Please notice the default `startTime` and `endTime` to make sure that time interval is within
    * If both `startTime` and `endTime`are sent, time between `startTime`and `endTime`must be less
    *
-   * Weight: 18000
-   * Request limit: 10 requests per second
-   * > * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-   * limit is 180000/second. Response from the endpoint contains header
-   * key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.
+   * Weight: 1
    *
    * @summary Withdraw History (for local entities that require travel rule) (supporting network) (USER_DATA)
    * @param {WithdrawHistoryV1Request} requestParameters Request parameters.
@@ -3996,7 +4041,6 @@ var RestAPI = class {
   /**
    * Fetch withdraw history for local entities that required travel rule.
    *
-   * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
    * `network` may not be in the response for old withdraw.
    * Withdrawal made through /sapi/v1/capital/withdraw/apply may not be in the response.
    * Please notice the default `startTime` and `endTime` to make sure that time interval is within
@@ -4007,11 +4051,7 @@ var RestAPI = class {
    * WithdrawOrderId only support 1.
    * If responsible does not include withdrawalStatus, please input trId or txId retrieve the data.
    *
-   * Weight: 18000
-   * Request limit: 10 requests per second
-   * > * This endpoint specifically uses per second IP rate limit, user's total second level IP rate
-   * limit is 180000/second. Response from the endpoint contains header
-   * key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.
+   * Weight: 1
    *
    * @summary Withdraw History V2 (for local entities that require travel rule) (supporting network) (USER_DATA)
    * @param {WithdrawHistoryV2Request} requestParameters Request parameters.