@binance/wallet 1.0.0 → 2.0.0

package/dist/index.mjs

@@ -10,7 +10,7 @@ import { ConfigurationRestAPI as ConfigurationRestAPI7, WALLET_REST_API_PROD_URL
 
 // package.json
 var name = "@binance/wallet";
-var version = "1.0.0";
+var version = "2.0.0";
 
 // src/rest-api/index.ts
 var rest_api_exports = {};
@@ -2278,6 +2278,92 @@ import {
 } from "@binance/common";
 var TravelRuleApiAxiosParamCreator = function(configuration) {
   return {
+    /**
+     * Submit a withdrawal request for brokers of local entities that required travel rule.
+     *
+     * If `network` not send, return with default network of the coin, but if the address could not match default network, the withdraw will be rejected.
+     * You can get `network` in `networkList` of a coin in the response
+     * Questionnaire is different for each local entity, please refer to
+     * If getting error like `Questionnaire format not valid.` or `Questionnaire must not be blank`,
+     *
+     * Weight: 600
+     *
+     * @summary Broker Withdraw (for brokers of local entities that require travel rule) (USER_DATA)
+     * @param {string} subAccountId External user ID.
+     * @param {string} address
+     * @param {string} coin
+     * @param {number} amount
+     * @param {string} withdrawOrderId withdrawID defined by the client (i.e. client's internal withdrawID)
+     * @param {string} questionnaire JSON format questionnaire answers.
+     * @param {string} originatorPii JSON format originator Pii, see StandardPii section below
+     * @param {string} signature Must be the last parameter.
+     * @param {string} [addressTag] Secondary address identifier for coins like XRP,XMR etc.
+     * @param {string} [network]
+     * @param {string} [addressName] Description of the address. Address book cap is 200, space in name should be encoded into `%20`
+     * @param {boolean} [transactionFeeFlag] When making internal transfer, `true` for returning the fee to the destination account; `false` for returning the fee back to the departure account. Default `false`.
+     * @param {number} [walletType] The wallet type for withdraw，0-spot wallet ，1-funding wallet. Default walletType is the current "selected wallet" under wallet->Fiat and Spot/Funding->Deposit
+     *
+     * @throws {RequiredError}
+     */
+    brokerWithdraw: async (subAccountId, address, coin, amount, withdrawOrderId, questionnaire, originatorPii, signature, addressTag, network, addressName, transactionFeeFlag, walletType) => {
+      assertParamExists4("brokerWithdraw", "subAccountId", subAccountId);
+      assertParamExists4("brokerWithdraw", "address", address);
+      assertParamExists4("brokerWithdraw", "coin", coin);
+      assertParamExists4("brokerWithdraw", "amount", amount);
+      assertParamExists4("brokerWithdraw", "withdrawOrderId", withdrawOrderId);
+      assertParamExists4("brokerWithdraw", "questionnaire", questionnaire);
+      assertParamExists4("brokerWithdraw", "originatorPii", originatorPii);
+      assertParamExists4("brokerWithdraw", "signature", signature);
+      const localVarQueryParameter = {};
+      if (subAccountId !== void 0 && subAccountId !== null) {
+        localVarQueryParameter["subAccountId"] = subAccountId;
+      }
+      if (address !== void 0 && address !== null) {
+        localVarQueryParameter["address"] = address;
+      }
+      if (addressTag !== void 0 && addressTag !== null) {
+        localVarQueryParameter["addressTag"] = addressTag;
+      }
+      if (network !== void 0 && network !== null) {
+        localVarQueryParameter["network"] = network;
+      }
+      if (coin !== void 0 && coin !== null) {
+        localVarQueryParameter["coin"] = coin;
+      }
+      if (addressName !== void 0 && addressName !== null) {
+        localVarQueryParameter["addressName"] = addressName;
+      }
+      if (amount !== void 0 && amount !== null) {
+        localVarQueryParameter["amount"] = amount;
+      }
+      if (withdrawOrderId !== void 0 && withdrawOrderId !== null) {
+        localVarQueryParameter["withdrawOrderId"] = withdrawOrderId;
+      }
+      if (transactionFeeFlag !== void 0 && transactionFeeFlag !== null) {
+        localVarQueryParameter["transactionFeeFlag"] = transactionFeeFlag;
+      }
+      if (walletType !== void 0 && walletType !== null) {
+        localVarQueryParameter["walletType"] = walletType;
+      }
+      if (questionnaire !== void 0 && questionnaire !== null) {
+        localVarQueryParameter["questionnaire"] = questionnaire;
+      }
+      if (originatorPii !== void 0 && originatorPii !== null) {
+        localVarQueryParameter["originatorPii"] = originatorPii;
+      }
+      if (signature !== void 0 && signature !== null) {
+        localVarQueryParameter["signature"] = signature;
+      }
+      let _timeUnit;
+      if ("timeUnit" in configuration)
+        _timeUnit = configuration.timeUnit;
+      return {
+        endpoint: "/sapi/v1/localentity/broker/withdraw/apply",
+        method: "POST",
+        params: localVarQueryParameter,
+        timeUnit: _timeUnit
+      };
+    },
     /**
      * Fetch deposit history for local entities that required travel rule.
      *
@@ -2373,6 +2459,77 @@ var TravelRuleApiAxiosParamCreator = function(configuration) {
         timeUnit: _timeUnit
       };
     },
+    /**
+     * Submit questionnaire for brokers of local entities that require travel rule.
+     * The questionnaire is only applies to transactions from un-hosted wallets or VASPs that are not
+     * yet onboarded with GTR.
+     *
+     * Questionnaire is different for each local entity, please refer
+     * If getting error like `Questionnaire format not valid.` or `Questionnaire must not be blank`,
+     *
+     * Weight: 600
+     *
+     * @summary Submit Deposit Questionnaire (For local entities that require travel rule) (supporting network) (USER_DATA)
+     * @param {string} subAccountId External user ID.
+     * @param {string} depositId Wallet deposit ID.
+     * @param {string} questionnaire JSON format questionnaire answers.
+     * @param {string} beneficiaryPii JSON format beneficiary Pii.
+     * @param {string} signature Must be the last parameter.
+     * @param {string} [network]
+     * @param {string} [coin]
+     * @param {number} [amount]
+     * @param {string} [address]
+     * @param {string} [addressTag] Secondary address identifier for coins like XRP,XMR etc.
+     *
+     * @throws {RequiredError}
+     */
+    submitDepositQuestionnaire: async (subAccountId, depositId, questionnaire, beneficiaryPii, signature, network, coin, amount, address, addressTag) => {
+      assertParamExists4("submitDepositQuestionnaire", "subAccountId", subAccountId);
+      assertParamExists4("submitDepositQuestionnaire", "depositId", depositId);
+      assertParamExists4("submitDepositQuestionnaire", "questionnaire", questionnaire);
+      assertParamExists4("submitDepositQuestionnaire", "beneficiaryPii", beneficiaryPii);
+      assertParamExists4("submitDepositQuestionnaire", "signature", signature);
+      const localVarQueryParameter = {};
+      if (subAccountId !== void 0 && subAccountId !== null) {
+        localVarQueryParameter["subAccountId"] = subAccountId;
+      }
+      if (depositId !== void 0 && depositId !== null) {
+        localVarQueryParameter["depositId"] = depositId;
+      }
+      if (questionnaire !== void 0 && questionnaire !== null) {
+        localVarQueryParameter["questionnaire"] = questionnaire;
+      }
+      if (beneficiaryPii !== void 0 && beneficiaryPii !== null) {
+        localVarQueryParameter["beneficiaryPii"] = beneficiaryPii;
+      }
+      if (network !== void 0 && network !== null) {
+        localVarQueryParameter["network"] = network;
+      }
+      if (coin !== void 0 && coin !== null) {
+        localVarQueryParameter["coin"] = coin;
+      }
+      if (amount !== void 0 && amount !== null) {
+        localVarQueryParameter["amount"] = amount;
+      }
+      if (address !== void 0 && address !== null) {
+        localVarQueryParameter["address"] = address;
+      }
+      if (addressTag !== void 0 && addressTag !== null) {
+        localVarQueryParameter["addressTag"] = addressTag;
+      }
+      if (signature !== void 0 && signature !== null) {
+        localVarQueryParameter["signature"] = signature;
+      }
+      let _timeUnit;
+      if ("timeUnit" in configuration)
+        _timeUnit = configuration.timeUnit;
+      return {
+        endpoint: "/sapi/v1/localentity/broker/deposit/provide-info",
+        method: "PUT",
+        params: localVarQueryParameter,
+        timeUnit: _timeUnit
+      };
+    },
     /**
      * Submit questionnaire for local entities that require travel rule.
      * The questionnaire is only applies to transactions from unhosted wallets or VASPs that are not
@@ -2384,14 +2541,18 @@ var TravelRuleApiAxiosParamCreator = function(configuration) {
      * Weight: 600
      *
      * @summary Submit Deposit Questionnaire (For local entities that require travel rule) (supporting network) (USER_DATA)
-     * @param {number} tranId Wallet tran Id
+     * @param {number} tranId Wallet tran ID
      * @param {string} questionnaire JSON format questionnaire answers.
      *
      * @throws {RequiredError}
      */
-    submitDepositQuestionnaire: async (tranId, questionnaire) => {
-      assertParamExists4("submitDepositQuestionnaire", "tranId", tranId);
-      assertParamExists4("submitDepositQuestionnaire", "questionnaire", questionnaire);
+    submitDepositQuestionnaireTravelRule: async (tranId, questionnaire) => {
+      assertParamExists4("submitDepositQuestionnaireTravelRule", "tranId", tranId);
+      assertParamExists4(
+        "submitDepositQuestionnaireTravelRule",
+        "questionnaire",
+        questionnaire
+      );
       const localVarQueryParameter = {};
       if (tranId !== void 0 && tranId !== null) {
         localVarQueryParameter["tranId"] = tranId;
@@ -2503,7 +2664,7 @@ var TravelRuleApiAxiosParamCreator = function(configuration) {
      * 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.
      *
-     * @summary Withdraw History (for local entities that require travel rule) (supporting network) (USER_DATA)
+     * @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.
      * @param {string} [txId]
      * @param {string} [withdrawOrderId]
@@ -2644,6 +2805,48 @@ var TravelRuleApi = class {
     this.configuration = configuration;
     this.localVarAxiosParamCreator = TravelRuleApiAxiosParamCreator(configuration);
   }
+  /**
+   * Submit a withdrawal request for brokers of local entities that required travel rule.
+   *
+   * If `network` not send, return with default network of the coin, but if the address could not match default network, the withdraw will be rejected.
+   * You can get `network` in `networkList` of a coin in the response
+   * Questionnaire is different for each local entity, please refer to
+   * If getting error like `Questionnaire format not valid.` or `Questionnaire must not be blank`,
+   *
+   * Weight: 600
+   *
+   * @summary Broker Withdraw (for brokers of local entities that require travel rule) (USER_DATA)
+   * @param {BrokerWithdrawRequest} requestParameters Request parameters.
+   * @returns {Promise<RestApiResponse<BrokerWithdrawResponse>>}
+   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+   * @memberof TravelRuleApi
+   * @see {@link https://developers.binance.com/docs/wallet/travel-rule/Broker-Withdraw Binance API Documentation}
+   */
+  async brokerWithdraw(requestParameters) {
+    const localVarAxiosArgs = await this.localVarAxiosParamCreator.brokerWithdraw(
+      requestParameters?.subAccountId,
+      requestParameters?.address,
+      requestParameters?.coin,
+      requestParameters?.amount,
+      requestParameters?.withdrawOrderId,
+      requestParameters?.questionnaire,
+      requestParameters?.originatorPii,
+      requestParameters?.signature,
+      requestParameters?.addressTag,
+      requestParameters?.network,
+      requestParameters?.addressName,
+      requestParameters?.transactionFeeFlag,
+      requestParameters?.walletType
+    );
+    return sendRequest5(
+      this.configuration,
+      localVarAxiosArgs.endpoint,
+      localVarAxiosArgs.method,
+      localVarAxiosArgs.params,
+      localVarAxiosArgs?.timeUnit,
+      { isSigned: true }
+    );
+  }
   /**
    * Fetch deposit history for local entities that required travel rule.
    *
@@ -2711,8 +2914,8 @@ var TravelRuleApi = class {
     );
   }
   /**
-   * Submit questionnaire for local entities that require travel rule.
-   * The questionnaire is only applies to transactions from unhosted wallets or VASPs that are not
+   * Submit questionnaire for brokers of local entities that require travel rule.
+   * The questionnaire is only applies to transactions from un-hosted wallets or VASPs that are not
    * yet onboarded with GTR.
    *
    * Questionnaire is different for each local entity, please refer
@@ -2729,6 +2932,45 @@ var TravelRuleApi = class {
    */
   async submitDepositQuestionnaire(requestParameters) {
     const localVarAxiosArgs = await this.localVarAxiosParamCreator.submitDepositQuestionnaire(
+      requestParameters?.subAccountId,
+      requestParameters?.depositId,
+      requestParameters?.questionnaire,
+      requestParameters?.beneficiaryPii,
+      requestParameters?.signature,
+      requestParameters?.network,
+      requestParameters?.coin,
+      requestParameters?.amount,
+      requestParameters?.address,
+      requestParameters?.addressTag
+    );
+    return sendRequest5(
+      this.configuration,
+      localVarAxiosArgs.endpoint,
+      localVarAxiosArgs.method,
+      localVarAxiosArgs.params,
+      localVarAxiosArgs?.timeUnit,
+      { isSigned: true }
+    );
+  }
+  /**
+   * Submit questionnaire for local entities that require travel rule.
+   * The questionnaire is only applies to transactions from unhosted wallets or VASPs that are not
+   * yet onboarded with GTR.
+   *
+   * Questionnaire is different for each local entity, please refer
+   * If getting error like `Questionnaire format not valid.` or `Questionnaire must not be blank`,
+   *
+   * Weight: 600
+   *
+   * @summary Submit Deposit Questionnaire (For local entities that require travel rule) (supporting network) (USER_DATA)
+   * @param {SubmitDepositQuestionnaireTravelRuleRequest} requestParameters Request parameters.
+   * @returns {Promise<RestApiResponse<SubmitDepositQuestionnaireTravelRuleResponse>>}
+   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+   * @memberof TravelRuleApi
+   * @see {@link https://developers.binance.com/docs/wallet/travel-rule/deposit-provide-info Binance API Documentation}
+   */
+  async submitDepositQuestionnaireTravelRule(requestParameters) {
+    const localVarAxiosArgs = await this.localVarAxiosParamCreator.submitDepositQuestionnaireTravelRule(
       requestParameters?.tranId,
       requestParameters?.questionnaire
     );
@@ -2805,12 +3047,12 @@ var TravelRuleApi = class {
    * 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.
    *
-   * @summary Withdraw History (for local entities that require travel rule) (supporting network) (USER_DATA)
+   * @summary Withdraw History V2 (for local entities that require travel rule) (supporting network) (USER_DATA)
    * @param {WithdrawHistoryV2Request} requestParameters Request parameters.
    * @returns {Promise<RestApiResponse<WithdrawHistoryV2Response>>}
    * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
    * @memberof TravelRuleApi
-   * @see {@link https://developers.binance.com/docs/wallet/travel-rule/Withdraw-History Binance API Documentation}
+   * @see {@link https://developers.binance.com/docs/wallet/travel-rule/Withdraw-History-V2 Binance API Documentation}
    */
   async withdrawHistoryV2(requestParameters = {}) {
     const localVarAxiosArgs = await this.localVarAxiosParamCreator.withdrawHistoryV2(
@@ -3457,6 +3699,25 @@ var RestAPI = class {
   systemStatus() {
     return this.othersApi.systemStatus();
   }
+  /**
+   * Submit a withdrawal request for brokers of local entities that required travel rule.
+   *
+   * If `network` not send, return with default network of the coin, but if the address could not match default network, the withdraw will be rejected.
+   * You can get `network` in `networkList` of a coin in the response
+   * Questionnaire is different for each local entity, please refer to
+   * If getting error like `Questionnaire format not valid.` or `Questionnaire must not be blank`,
+   *
+   * Weight: 600
+   *
+   * @summary Broker Withdraw (for brokers of local entities that require travel rule) (USER_DATA)
+   * @param {BrokerWithdrawRequest} requestParameters Request parameters.
+   * @returns {Promise<RestApiResponse<BrokerWithdrawResponse>>}
+   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+   * @see {@link https://developers.binance.com/docs/wallet/travel-rule/Broker-Withdraw Binance API Documentation}
+   */
+  brokerWithdraw(requestParameters) {
+    return this.travelRuleApi.brokerWithdraw(requestParameters);
+  }
   /**
    * Fetch deposit history for local entities that required travel rule.
    *
@@ -3494,8 +3755,8 @@ var RestAPI = class {
     return this.travelRuleApi.onboardedVaspList();
   }
   /**
-   * Submit questionnaire for local entities that require travel rule.
-   * The questionnaire is only applies to transactions from unhosted wallets or VASPs that are not
+   * Submit questionnaire for brokers of local entities that require travel rule.
+   * The questionnaire is only applies to transactions from un-hosted wallets or VASPs that are not
    * yet onboarded with GTR.
    *
    * Questionnaire is different for each local entity, please refer
@@ -3512,6 +3773,25 @@ var RestAPI = class {
   submitDepositQuestionnaire(requestParameters) {
     return this.travelRuleApi.submitDepositQuestionnaire(requestParameters);
   }
+  /**
+   * Submit questionnaire for local entities that require travel rule.
+   * The questionnaire is only applies to transactions from unhosted wallets or VASPs that are not
+   * yet onboarded with GTR.
+   *
+   * Questionnaire is different for each local entity, please refer
+   * If getting error like `Questionnaire format not valid.` or `Questionnaire must not be blank`,
+   *
+   * Weight: 600
+   *
+   * @summary Submit Deposit Questionnaire (For local entities that require travel rule) (supporting network) (USER_DATA)
+   * @param {SubmitDepositQuestionnaireTravelRuleRequest} requestParameters Request parameters.
+   * @returns {Promise<RestApiResponse<SubmitDepositQuestionnaireTravelRuleResponse>>}
+   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+   * @see {@link https://developers.binance.com/docs/wallet/travel-rule/deposit-provide-info Binance API Documentation}
+   */
+  submitDepositQuestionnaireTravelRule(requestParameters) {
+    return this.travelRuleApi.submitDepositQuestionnaireTravelRule(requestParameters);
+  }
   /**
    * Fetch withdraw history for local entities that required travel rule.
    *
@@ -3555,11 +3835,11 @@ var RestAPI = class {
    * 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.
    *
-   * @summary Withdraw History (for local entities that require travel rule) (supporting network) (USER_DATA)
+   * @summary Withdraw History V2 (for local entities that require travel rule) (supporting network) (USER_DATA)
    * @param {WithdrawHistoryV2Request} requestParameters Request parameters.
    * @returns {Promise<RestApiResponse<WithdrawHistoryV2Response>>}
    * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-   * @see {@link https://developers.binance.com/docs/wallet/travel-rule/Withdraw-History Binance API Documentation}
+   * @see {@link https://developers.binance.com/docs/wallet/travel-rule/Withdraw-History-V2 Binance API Documentation}
    */
   withdrawHistoryV2(requestParameters = {}) {
     return this.travelRuleApi.withdrawHistoryV2(requestParameters);