@binance/fiat 7.0.1 → 8.0.1

package/dist/index.js

@@ -14,14 +14,14 @@ let __binance_common = require("@binance/common");
 
 //#region package.json
 var name = "@binance/fiat";
-var version = "7.0.1";
+var version = "8.0.1";
 
 //#endregion
-//#region src/rest-api/modules/fiat-api.ts
+//#region src/rest-api/modules/api.ts
 /**
-* Binance Fiat REST API
+* Fiat REST API
 *
-* OpenAPI Specification for the Binance Fiat REST API
+* Query Binance fiat deposit and withdrawal history.
 *
 * The version of the OpenAPI document: 1.0.0
 *
@@ -31,9 +31,9 @@ var version = "7.0.1";
 * Do not edit the class manually.
 */
 /**
-* FiatApi - axios parameter creator
+* Api - axios parameter creator
 */
-const FiatApiAxiosParamCreator = function(configuration) {
+const ApiAxiosParamCreator = function(configuration) {
 	return {
 		deposit: async (currency, apiPaymentMethod, amount, recvWindow, ext) => {
 			(0, __binance_common.assertParamExists)("deposit", "currency", currency);
@@ -148,33 +148,35 @@ const FiatApiAxiosParamCreator = function(configuration) {
 	};
 };
 /**
-* FiatApi - object-oriented interface
-* @class FiatApi
+* Api - object-oriented interface
+* @class Api
 */
-var FiatApi = class {
+var Api = class {
 	constructor(configuration) {
 		this.configuration = configuration;
-		this.localVarAxiosParamCreator = FiatApiAxiosParamCreator(configuration);
+		this.localVarAxiosParamCreator = ApiAxiosParamCreator(configuration);
 	}
 	/**
 	* Submit deposit request, in this version, we only support BRL deposit via pix.
 	*
-	*
-	*
 	* For BRL deposit via pix, you need to place an order before making a transfer from your bank.
 	*
-	* Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
+	* Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
+	* fiat service on our website.
 	*
-	* `timestamp`, `signature` and `recvWindow` are sent as query-string parameters, while the business fields (`currency`, `apiPaymentMethod`, `amount`, `ext`) are sent in the JSON request body with `Content-Type: application/json`.
+	* Weight(UID): 45000
 	*
-	* Weight: 45000
+	* Security Type: TRADE
 	*
-	* @summary Deposit(TRADE)
+	* Notes:
+	* - `timestamp`, `signature` and `recvWindow` are sent as query-string parameters, while the business fields (`currency`, `apiPaymentMethod`, `amount`, `ext`) are sent in the JSON request body with `Content-Type: application/json`.
+	*
+	* @summary Deposit (TRADE)
 	* @param {DepositRequest} requestParameters Request parameters.
 	* @returns {Promise<RestApiResponse<DepositResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @memberof FiatApi
-	* @see {@link https://developers.binance.com/docs/fiat/rest-api/Fiat-Deposit Binance API Documentation}
+	* @memberof Api
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#deposit Binance API Documentation}
 	*/
 	async deposit(requestParameters) {
 		const localVarAxiosArgs = await this.localVarAxiosParamCreator.deposit(requestParameters?.currency, requestParameters?.apiPaymentMethod, requestParameters?.amount, requestParameters?.recvWindow, requestParameters?.ext);
@@ -183,20 +185,22 @@ var FiatApi = class {
 	/**
 	* Submit withdraw request, in this version, we support BRL,ARS,MXN withdrawal via bank_transfer.
 	*
-	* You need to call this api first, and call query order detail api in a loop to get the status of the order until this order is successful.
+	* You need to call this api first, and call query order detail api in a loop to get the status of the order until
+	* this order is successful.
 	*
-	* Before calling this API, please ensure you have completed your KYC or KYB, activated your fiat service, and verified your destination bank account on our website.
+	* Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
+	* fiat service on our website.
 	*
-	* you need to bind your bank account on web/app before using the corresponding account number
+	* Weight(UID): 45000
 	*
-	* Weight: 45000
+	* Security Type: TRADE
 	*
-	* @summary Fiat Withdraw(WITHDRAW)
+	* @summary Fiat Withdraw (TRADE)
 	* @param {FiatWithdrawRequest} requestParameters Request parameters.
 	* @returns {Promise<RestApiResponse<FiatWithdrawResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @memberof FiatApi
-	* @see {@link https://developers.binance.com/docs/fiat/rest-api/Fiat-Withdraw Binance API Documentation}
+	* @memberof Api
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#fiat-withdraw Binance API Documentation}
 	*/
 	async fiatWithdraw(requestParameters) {
 		const localVarAxiosArgs = await this.localVarAxiosParamCreator.fiatWithdraw(requestParameters?.currency, requestParameters?.apiPaymentMethod, requestParameters?.amount, requestParameters?.accountInfo, requestParameters?.recvWindow, requestParameters?.ext);
@@ -205,39 +209,42 @@ var FiatApi = class {
 	/**
 	* Get Fiat Deposit/Withdraw History
 	*
-	* If beginTime and endTime are not sent, the recent 30-day data will be returned.
+	* Weight(UID): 45000
+	*
+	* Security Type: USER_DATA
 	*
-	* Weight: 45000
+	* Notes:
+	* - If `beginTime` and `endTime` are not sent, recent 30-day data is returned.
 	*
 	* @summary Get Fiat Deposit/Withdraw History (USER_DATA)
 	* @param {GetFiatDepositWithdrawHistoryRequest} requestParameters Request parameters.
 	* @returns {Promise<RestApiResponse<GetFiatDepositWithdrawHistoryResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @memberof FiatApi
-	* @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Deposit-Withdraw-History Binance API Documentation}
+	* @memberof Api
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#get-fiat-deposit-withdraw-history Binance API Documentation}
 	*/
 	async getFiatDepositWithdrawHistory(requestParameters) {
 		const localVarAxiosArgs = await this.localVarAxiosParamCreator.getFiatDepositWithdrawHistory(requestParameters?.transactionType, requestParameters?.beginTime, requestParameters?.endTime, requestParameters?.page, requestParameters?.rows, requestParameters?.recvWindow);
 		return (0, __binance_common.sendRequest)(this.configuration, localVarAxiosArgs.endpoint, localVarAxiosArgs.method, localVarAxiosArgs.queryParams, localVarAxiosArgs.bodyParams, localVarAxiosArgs.headerParams, localVarAxiosArgs?.timeUnit, { isSigned: true });
 	}
 	/**
-	* Get Fiat Deposit/Withdraw History
+	* Get Fiat Payments History
+	*
+	* Weight(IP): 1
 	*
-	* If beginTime and endTime are not sent, the recent 30-day data will be returned.
-	* paymentMethod: Only when requesting payments history for buy (transactionType=0), response contains paymentMethod representing the way of purchase. Now we have:
-	* Cash Balance
-	* Credit Card
-	* Online Banking
-	* Bank Transfer
+	* Security Type: USER_DATA
 	*
-	* Weight: 1
+	* Notes:
+	* - If `beginTime` and `endTime` are not sent, recent 30-day data is returned.
+	* - `paymentMethod` is returned only when querying buy history (`transactionType=0`).
+	* - Supported payment methods: `Cash Balance`, `Credit Card`, `Online Banking`, `Bank Transfer`.
 	*
 	* @summary Get Fiat Payments History (USER_DATA)
 	* @param {GetFiatPaymentsHistoryRequest} requestParameters Request parameters.
 	* @returns {Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @memberof FiatApi
-	* @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Payments-History Binance API Documentation}
+	* @memberof Api
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#get-fiat-payments-history Binance API Documentation}
 	*/
 	async getFiatPaymentsHistory(requestParameters) {
 		const localVarAxiosArgs = await this.localVarAxiosParamCreator.getFiatPaymentsHistory(requestParameters?.transactionType, requestParameters?.beginTime, requestParameters?.endTime, requestParameters?.page, requestParameters?.rows, requestParameters?.recvWindow);
@@ -246,29 +253,40 @@ var FiatApi = class {
 	/**
 	* Get Order Detail
 	*
-	* Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
+	* Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
+	* fiat service on our website.
+	*
+	* Weight(IP): 1
 	*
-	* Weight: 1
+	* Security Type: USER_DATA
 	*
-	* @summary Get Order Detail(USER_DATA)
+	* @summary Get Order Detail (USER_DATA)
 	* @param {GetOrderDetailRequest} requestParameters Request parameters.
 	* @returns {Promise<RestApiResponse<GetOrderDetailResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @memberof FiatApi
-	* @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Order-Detail Binance API Documentation}
+	* @memberof Api
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#get-order-detail Binance API Documentation}
 	*/
 	async getOrderDetail(requestParameters) {
 		const localVarAxiosArgs = await this.localVarAxiosParamCreator.getOrderDetail(requestParameters?.orderNo, requestParameters?.recvWindow);
 		return (0, __binance_common.sendRequest)(this.configuration, localVarAxiosArgs.endpoint, localVarAxiosArgs.method, localVarAxiosArgs.queryParams, localVarAxiosArgs.bodyParams, localVarAxiosArgs.headerParams, localVarAxiosArgs?.timeUnit, { isSigned: true });
 	}
 };
+let DepositApiPaymentMethodEnum = /* @__PURE__ */ function(DepositApiPaymentMethodEnum$1) {
+	DepositApiPaymentMethodEnum$1["pix"] = "pix";
+	return DepositApiPaymentMethodEnum$1;
+}({});
+let FiatWithdrawApiPaymentMethodEnum = /* @__PURE__ */ function(FiatWithdrawApiPaymentMethodEnum$1) {
+	FiatWithdrawApiPaymentMethodEnum$1["bank_transfer"] = "bank_transfer";
+	return FiatWithdrawApiPaymentMethodEnum$1;
+}({});
 
 //#endregion
 //#region src/rest-api/rest-api.ts
 /**
-* Binance Fiat REST API
+* Fiat REST API
 *
-* OpenAPI Specification for the Binance Fiat REST API
+* Query Binance fiat deposit and withdrawal history.
 *
 * The version of the OpenAPI document: 1.0.0
 *
@@ -280,7 +298,7 @@ var FiatApi = class {
 var RestAPI = class {
 	constructor(configuration) {
 		this.configuration = configuration;
-		this.fiatApi = new FiatApi(configuration);
+		this.api = new Api(configuration);
 	}
 	/**
 	* Generic function to send a request.
@@ -309,109 +327,121 @@ var RestAPI = class {
 	/**
 	* Submit deposit request, in this version, we only support BRL deposit via pix.
 	*
-	*
-	*
 	* For BRL deposit via pix, you need to place an order before making a transfer from your bank.
 	*
-	* Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
+	* Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
+	* fiat service on our website.
 	*
-	* `timestamp`, `signature` and `recvWindow` are sent as query-string parameters, while the business fields (`currency`, `apiPaymentMethod`, `amount`, `ext`) are sent in the JSON request body with `Content-Type: application/json`.
+	* Weight(UID): 45000
 	*
-	* Weight: 45000
+	* Security Type: TRADE
 	*
-	* @summary Deposit(TRADE)
+	* Notes:
+	* - `timestamp`, `signature` and `recvWindow` are sent as query-string parameters, while the business fields (`currency`, `apiPaymentMethod`, `amount`, `ext`) are sent in the JSON request body with `Content-Type: application/json`.
+	*
+	* @summary Deposit (TRADE)
 	* @param {DepositRequest} requestParameters Request parameters.
 	*
 	* @returns {Promise<RestApiResponse<DepositResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @see {@link https://developers.binance.com/docs/fiat/rest-api/Fiat-Deposit Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#deposit Binance API Documentation}
 	*/
 	deposit(requestParameters) {
-		return this.fiatApi.deposit(requestParameters);
+		return this.api.deposit(requestParameters);
 	}
 	/**
 	* Submit withdraw request, in this version, we support BRL,ARS,MXN withdrawal via bank_transfer.
 	*
-	* You need to call this api first, and call query order detail api in a loop to get the status of the order until this order is successful.
+	* You need to call this api first, and call query order detail api in a loop to get the status of the order until
+	* this order is successful.
 	*
-	* Before calling this API, please ensure you have completed your KYC or KYB, activated your fiat service, and verified your destination bank account on our website.
+	* Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
+	* fiat service on our website.
 	*
-	* you need to bind your bank account on web/app before using the corresponding account number
+	* Weight(UID): 45000
 	*
-	* Weight: 45000
+	* Security Type: TRADE
 	*
-	* @summary Fiat Withdraw(WITHDRAW)
+	* @summary Fiat Withdraw (TRADE)
 	* @param {FiatWithdrawRequest} requestParameters Request parameters.
 	*
 	* @returns {Promise<RestApiResponse<FiatWithdrawResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @see {@link https://developers.binance.com/docs/fiat/rest-api/Fiat-Withdraw Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#fiat-withdraw Binance API Documentation}
 	*/
 	fiatWithdraw(requestParameters) {
-		return this.fiatApi.fiatWithdraw(requestParameters);
+		return this.api.fiatWithdraw(requestParameters);
 	}
 	/**
 	* Get Fiat Deposit/Withdraw History
 	*
-	* If beginTime and endTime are not sent, the recent 30-day data will be returned.
+	* Weight(UID): 45000
+	*
+	* Security Type: USER_DATA
 	*
-	* Weight: 45000
+	* Notes:
+	* - If `beginTime` and `endTime` are not sent, recent 30-day data is returned.
 	*
 	* @summary Get Fiat Deposit/Withdraw History (USER_DATA)
 	* @param {GetFiatDepositWithdrawHistoryRequest} requestParameters Request parameters.
 	*
 	* @returns {Promise<RestApiResponse<GetFiatDepositWithdrawHistoryResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Deposit-Withdraw-History Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#get-fiat-deposit-withdraw-history Binance API Documentation}
 	*/
 	getFiatDepositWithdrawHistory(requestParameters) {
-		return this.fiatApi.getFiatDepositWithdrawHistory(requestParameters);
+		return this.api.getFiatDepositWithdrawHistory(requestParameters);
 	}
 	/**
-	* Get Fiat Deposit/Withdraw History
+	* Get Fiat Payments History
+	*
+	* Weight(IP): 1
 	*
-	* If beginTime and endTime are not sent, the recent 30-day data will be returned.
-	* paymentMethod: Only when requesting payments history for buy (transactionType=0), response contains paymentMethod representing the way of purchase. Now we have:
-	* Cash Balance
-	* Credit Card
-	* Online Banking
-	* Bank Transfer
+	* Security Type: USER_DATA
 	*
-	* Weight: 1
+	* Notes:
+	* - If `beginTime` and `endTime` are not sent, recent 30-day data is returned.
+	* - `paymentMethod` is returned only when querying buy history (`transactionType=0`).
+	* - Supported payment methods: `Cash Balance`, `Credit Card`, `Online Banking`, `Bank Transfer`.
 	*
 	* @summary Get Fiat Payments History (USER_DATA)
 	* @param {GetFiatPaymentsHistoryRequest} requestParameters Request parameters.
 	*
 	* @returns {Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Payments-History Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#get-fiat-payments-history Binance API Documentation}
 	*/
 	getFiatPaymentsHistory(requestParameters) {
-		return this.fiatApi.getFiatPaymentsHistory(requestParameters);
+		return this.api.getFiatPaymentsHistory(requestParameters);
 	}
 	/**
 	* Get Order Detail
 	*
-	* Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your fiat service on our website.
+	* Before calling this api, please make sure you have already completed your KYC or KYB, and already activated your
+	* fiat service on our website.
+	*
+	* Weight(IP): 1
 	*
-	* Weight: 1
+	* Security Type: USER_DATA
 	*
-	* @summary Get Order Detail(USER_DATA)
+	* @summary Get Order Detail (USER_DATA)
 	* @param {GetOrderDetailRequest} requestParameters Request parameters.
 	*
 	* @returns {Promise<RestApiResponse<GetOrderDetailResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Order-Detail Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-fiat/api/rest-api/~#get-order-detail Binance API Documentation}
 	*/
 	getOrderDetail(requestParameters) {
-		return this.fiatApi.getOrderDetail(requestParameters);
+		return this.api.getOrderDetail(requestParameters);
 	}
 };
 
 //#endregion
 //#region src/rest-api/index.ts
 var rest_api_exports = /* @__PURE__ */ __export({
-	FiatApi: () => FiatApi,
+	Api: () => Api,
+	DepositApiPaymentMethodEnum: () => DepositApiPaymentMethodEnum,
+	FiatWithdrawApiPaymentMethodEnum: () => FiatWithdrawApiPaymentMethodEnum,
 	RestAPI: () => RestAPI
 });