@binance/giftcard 4.1.17 → 5.0.0

package/dist/index.js

@@ -14,14 +14,14 @@ let __binance_common = require("@binance/common");
 
 //#region package.json
 var name = "@binance/giftcard";
-var version = "4.1.17";
+var version = "5.0.0";
 
 //#endregion
 //#region src/rest-api/modules/market-data-api.ts
 /**
-* Binance Gift Card REST API
+* Gift Card REST API
 *
-* OpenAPI Specification for the Binance Gift Card REST API
+* Create, redeem, and check the value of Binance crypto gift cards.
 *
 * The version of the OpenAPI document: 1.0.0
 *
@@ -160,24 +160,29 @@ var MarketDataApi = class {
 		this.localVarAxiosParamCreator = MarketDataApiAxiosParamCreator(configuration);
 	}
 	/**
-	* * This API is for creating a dual-token ( stablecoin-denominated) Binance Gift Card. You may create a gift card using USDT as baseToken, that is redeemable to another designated token (faceToken). For example, you can create a fixed-value BTC gift card and pay with 100 USDT plus minting fee. This gift card can keep the value fixed at 100 USDT before redemption, and will be redeemable to BTC equivalent to 100 USDT upon redemption.
-	* Once successfully created, the amount of baseToken (e.g. USDT) in the fixed-value gift card along with the fee would be deducted from your funding wallet.
-	*
+	* * This API is for creating a dual-token ( stablecoin-denominated) Binance Gift Card. You may create a gift card
+	* using USDT as baseToken, that is redeemable to another designated token (faceToken). For example, you can create
+	* a fixed-value BTC gift card and pay with 100 USDT plus minting fee. This gift card can keep the value fixed at
+	* 100 USDT before redemption, and will be redeemable to BTC equivalent to 100 USDT upon redemption.
 	*
+	* Once successfully created, the amount of baseToken (e.g. USDT) in the fixed-value gift card along with the fee
+	* would be deducted from your funding wallet.
 	* To get started with, please make sure:
 	* You have a Binance account
 	* You have passed KYB
 	* You have a sufficient balance(Gift Card amount and fee amount) in your Binance funding wallet
 	* You need Enable Withdrawals for the API Key which requests this endpoint.
 	*
-	* Weight: 1
+	* Weight(IP): 1
+	*
+	* Security Type: TRADE
 	*
-	* @summary Create a dual-token gift card(fixed value, discount feature)(TRADE)
+	* @summary Create a dual-token gift card (fixed value, discount feature) (TRADE)
 	* @param {CreateADualTokenGiftCardRequest} requestParameters Request parameters.
 	* @returns {Promise<RestApiResponse<CreateADualTokenGiftCardResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
 	* @memberof MarketDataApi
-	* @see {@link https://developers.binance.com/docs/gift_card/market-data/Create-a-dual-token-gift-card Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-gift-card/api/rest-api/market-data#create-adual-token-gift-card Binance API Documentation}
 	*/
 	async createADualTokenGiftCard(requestParameters) {
 		const localVarAxiosArgs = await this.localVarAxiosParamCreator.createADualTokenGiftCard(requestParameters?.baseToken, requestParameters?.faceToken, requestParameters?.baseTokenAmount, requestParameters?.recvWindow);
@@ -187,20 +192,21 @@ var MarketDataApi = class {
 	* This API is for creating a Binance Gift Card.
 	*
 	* To get started with, please make sure:
-	*
 	* You have a Binance account
 	* You have passed KYB
 	* You have a sufficient balance(Gift Card amount and fee amount) in your Binance funding wallet
 	* You need `Enable Withdrawals` for the API Key which requests this endpoint.
 	*
-	* Weight: 1
+	* Weight(IP): 1
+	*
+	* Security Type: USER_DATA
 	*
 	* @summary Create a single-token gift card (USER_DATA)
 	* @param {CreateASingleTokenGiftCardRequest} requestParameters Request parameters.
 	* @returns {Promise<RestApiResponse<CreateASingleTokenGiftCardResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
 	* @memberof MarketDataApi
-	* @see {@link https://developers.binance.com/docs/gift_card/market-data/Create-a-single-token-gift-card Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-gift-card/api/rest-api/market-data#create-asingle-token-gift-card Binance API Documentation}
 	*/
 	async createASingleTokenGiftCard(requestParameters) {
 		const localVarAxiosArgs = await this.localVarAxiosParamCreator.createASingleTokenGiftCard(requestParameters?.token, requestParameters?.amount, requestParameters?.recvWindow);
@@ -212,56 +218,61 @@ var MarketDataApi = class {
 	*
 	**Please note that the RSA Public key fetched is valid only for the current day.**
 	*
-	* Weight: 1
+	* Weight(IP): 1
 	*
-	* @summary Fetch RSA Public Key(USER_DATA)
+	* Security Type: USER_DATA
+	*
+	* @summary Fetch RSA Public Key (USER_DATA)
 	* @param {FetchRsaPublicKeyRequest} requestParameters Request parameters.
 	* @returns {Promise<RestApiResponse<FetchRsaPublicKeyResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
 	* @memberof MarketDataApi
-	* @see {@link https://developers.binance.com/docs/gift_card/market-data/Fetch-RSA-Public-Key Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-gift-card/api/rest-api/market-data#fetch-rsa-public-key Binance API Documentation}
 	*/
 	async fetchRsaPublicKey(requestParameters = {}) {
 		const localVarAxiosArgs = await this.localVarAxiosParamCreator.fetchRsaPublicKey(requestParameters?.recvWindow);
 		return (0, __binance_common.sendRequest)(this.configuration, localVarAxiosArgs.endpoint, localVarAxiosArgs.method, localVarAxiosArgs.queryParams, localVarAxiosArgs.bodyParams, localVarAxiosArgs.headerParams, localVarAxiosArgs?.timeUnit, { isSigned: true });
 	}
 	/**
-	* This API is to help you verify which tokens are available for you to create Stablecoin-Denominated gift cards as mentioned in section 2 and its’ limitation.
+	* This API is to help you verify which tokens are available for you to create Stablecoin-Denominated gift cards as
+	* mentioned in section 2 and its’ limitation.
+	*
+	* Weight(IP): 1
 	*
-	* Weight: 1
+	* Security Type: USER_DATA
 	*
-	* @summary Fetch Token Limit(USER_DATA)
+	* @summary Fetch Token Limit (USER_DATA)
 	* @param {FetchTokenLimitRequest} requestParameters Request parameters.
 	* @returns {Promise<RestApiResponse<FetchTokenLimitResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
 	* @memberof MarketDataApi
-	* @see {@link https://developers.binance.com/docs/gift_card/market-data/Fetch-Token-Limit Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-gift-card/api/rest-api/market-data#fetch-token-limit Binance API Documentation}
 	*/
 	async fetchTokenLimit(requestParameters) {
 		const localVarAxiosArgs = await this.localVarAxiosParamCreator.fetchTokenLimit(requestParameters?.baseToken, requestParameters?.recvWindow);
 		return (0, __binance_common.sendRequest)(this.configuration, localVarAxiosArgs.endpoint, localVarAxiosArgs.method, localVarAxiosArgs.queryParams, localVarAxiosArgs.bodyParams, localVarAxiosArgs.headerParams, localVarAxiosArgs?.timeUnit, { isSigned: true });
 	}
 	/**
-	* This API is for redeeming a Binance Gift Card
-	* Once redeemed, the coins will be deposited in your funding wallet.
+	* This API is for redeeming a Binance Gift Card. Once redeemed, the coins will be deposited in your funding wallet.
 	*
-	* Parameter code can be sent in two formats:
-	* Plaintext
-	* Encrypted
+	* Weight(IP): 1
 	*
-	* Sending code in Encrypted format provides more security than sending it as a plaintext. To send card code in encrypted format the following steps must be followed:
-	* Fetch RSA public key from api stated below.
-	* Use the below algorithm to encrypt the card code using the RSA public key fetched above: `RSA/ECB/OAEPWithSHA-256AndMGF1Padding`
-	**A sample code snippet (JAVA) is stated below for reference, the same approach can be used for different languages like C#, PERL, PYTHON, SHELL etc.:**
+	* Security Type: USER_DATA
 	*
-	* Weight: 1
+	* Notes:
+	* - Parameter `code` can be sent in two formats: `Plaintext` and `Encrypted`.
+	* - Sending `code` in encrypted format is more secure than plaintext.
+	* - To send encrypted `code`:
+	* - Fetch RSA public key from `GET /sapi/v1/giftcard/cryptography/rsa-public-key`.
+	* - Encrypt card code using `RSA/ECB/OAEPWithSHA-256AndMGF1Padding`.
+	* - If you enter the wrong redemption code 5 times within 24 hours, you will no longer be able to redeem any Binance Gift Cards that day.
 	*
-	* @summary Redeem a Binance Gift Card(USER_DATA)
+	* @summary Redeem a Binance Gift Card (USER_DATA)
 	* @param {RedeemABinanceGiftCardRequest} requestParameters Request parameters.
 	* @returns {Promise<RestApiResponse<RedeemABinanceGiftCardResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
 	* @memberof MarketDataApi
-	* @see {@link https://developers.binance.com/docs/gift_card/market-data/Redeem-a-Binance-Gift-Card Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-gift-card/api/rest-api/market-data#redeem-abinance-gift-card Binance API Documentation}
 	*/
 	async redeemABinanceGiftCard(requestParameters) {
 		const localVarAxiosArgs = await this.localVarAxiosParamCreator.redeemABinanceGiftCard(requestParameters?.code, requestParameters?.externalUid, requestParameters?.recvWindow);
@@ -270,16 +281,19 @@ var MarketDataApi = class {
 	/**
 	* This API is for verifying whether the Binance Gift Card is valid or not by entering Gift Card Number.
 	*
-	**Please note that if you enter the wrong Gift Card Number 5 times within an hour, you will no longer be able to verify any Gift Card Number for that hour.**
+	**Please note that if you enter the wrong Gift Card Number 5 times within an hour, you will no longer be able to
+	* verify any Gift Card Number for that hour.**
+	*
+	* Weight(IP): 1
 	*
-	* Weight: 1
+	* Security Type: USER_DATA
 	*
-	* @summary Verify Binance Gift Card by Gift Card Number(USER_DATA)
+	* @summary Verify Binance Gift Card by Gift Card Number (USER_DATA)
 	* @param {VerifyBinanceGiftCardByGiftCardNumberRequest} requestParameters Request parameters.
 	* @returns {Promise<RestApiResponse<VerifyBinanceGiftCardByGiftCardNumberResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
 	* @memberof MarketDataApi
-	* @see {@link https://developers.binance.com/docs/gift_card/market-data/Verify-Binance-Gift-Card-by-Gift-Card-Number Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-gift-card/api/rest-api/market-data#verify-binance-gift-card-by-gift-card-number Binance API Documentation}
 	*/
 	async verifyBinanceGiftCardByGiftCardNumber(requestParameters) {
 		const localVarAxiosArgs = await this.localVarAxiosParamCreator.verifyBinanceGiftCardByGiftCardNumber(requestParameters?.referenceNo, requestParameters?.recvWindow);
@@ -290,9 +304,9 @@ var MarketDataApi = class {
 //#endregion
 //#region src/rest-api/rest-api.ts
 /**
-* Binance Gift Card REST API
+* Gift Card REST API
 *
-* OpenAPI Specification for the Binance Gift Card REST API
+* Create, redeem, and check the value of Binance crypto gift cards.
 *
 * The version of the OpenAPI document: 1.0.0
 *
@@ -331,24 +345,29 @@ var RestAPI = class {
 		return (0, __binance_common.sendRequest)(this.configuration, endpoint, method, queryParams, bodyParams, void 0, void 0, { isSigned: true });
 	}
 	/**
-	* * This API is for creating a dual-token ( stablecoin-denominated) Binance Gift Card. You may create a gift card using USDT as baseToken, that is redeemable to another designated token (faceToken). For example, you can create a fixed-value BTC gift card and pay with 100 USDT plus minting fee. This gift card can keep the value fixed at 100 USDT before redemption, and will be redeemable to BTC equivalent to 100 USDT upon redemption.
-	* Once successfully created, the amount of baseToken (e.g. USDT) in the fixed-value gift card along with the fee would be deducted from your funding wallet.
-	*
+	* * This API is for creating a dual-token ( stablecoin-denominated) Binance Gift Card. You may create a gift card
+	* using USDT as baseToken, that is redeemable to another designated token (faceToken). For example, you can create
+	* a fixed-value BTC gift card and pay with 100 USDT plus minting fee. This gift card can keep the value fixed at
+	* 100 USDT before redemption, and will be redeemable to BTC equivalent to 100 USDT upon redemption.
 	*
+	* Once successfully created, the amount of baseToken (e.g. USDT) in the fixed-value gift card along with the fee
+	* would be deducted from your funding wallet.
 	* To get started with, please make sure:
 	* You have a Binance account
 	* You have passed KYB
 	* You have a sufficient balance(Gift Card amount and fee amount) in your Binance funding wallet
 	* You need Enable Withdrawals for the API Key which requests this endpoint.
 	*
-	* Weight: 1
+	* Weight(IP): 1
+	*
+	* Security Type: TRADE
 	*
-	* @summary Create a dual-token gift card(fixed value, discount feature)(TRADE)
+	* @summary Create a dual-token gift card (fixed value, discount feature) (TRADE)
 	* @param {CreateADualTokenGiftCardRequest} requestParameters Request parameters.
 	*
 	* @returns {Promise<RestApiResponse<CreateADualTokenGiftCardResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @see {@link https://developers.binance.com/docs/gift_card/market-data/Create-a-dual-token-gift-card Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-gift-card/api/rest-api/market-data#create-adual-token-gift-card Binance API Documentation}
 	*/
 	createADualTokenGiftCard(requestParameters) {
 		return this.marketDataApi.createADualTokenGiftCard(requestParameters);
@@ -357,20 +376,21 @@ var RestAPI = class {
 	* This API is for creating a Binance Gift Card.
 	*
 	* To get started with, please make sure:
-	*
 	* You have a Binance account
 	* You have passed KYB
 	* You have a sufficient balance(Gift Card amount and fee amount) in your Binance funding wallet
 	* You need `Enable Withdrawals` for the API Key which requests this endpoint.
 	*
-	* Weight: 1
+	* Weight(IP): 1
+	*
+	* Security Type: USER_DATA
 	*
 	* @summary Create a single-token gift card (USER_DATA)
 	* @param {CreateASingleTokenGiftCardRequest} requestParameters Request parameters.
 	*
 	* @returns {Promise<RestApiResponse<CreateASingleTokenGiftCardResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @see {@link https://developers.binance.com/docs/gift_card/market-data/Create-a-single-token-gift-card Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-gift-card/api/rest-api/market-data#create-asingle-token-gift-card Binance API Documentation}
 	*/
 	createASingleTokenGiftCard(requestParameters) {
 		return this.marketDataApi.createASingleTokenGiftCard(requestParameters);
@@ -381,54 +401,59 @@ var RestAPI = class {
 	*
 	**Please note that the RSA Public key fetched is valid only for the current day.**
 	*
-	* Weight: 1
+	* Weight(IP): 1
 	*
-	* @summary Fetch RSA Public Key(USER_DATA)
+	* Security Type: USER_DATA
+	*
+	* @summary Fetch RSA Public Key (USER_DATA)
 	* @param {FetchRsaPublicKeyRequest} requestParameters Request parameters.
 	*
 	* @returns {Promise<RestApiResponse<FetchRsaPublicKeyResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @see {@link https://developers.binance.com/docs/gift_card/market-data/Fetch-RSA-Public-Key Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-gift-card/api/rest-api/market-data#fetch-rsa-public-key Binance API Documentation}
 	*/
 	fetchRsaPublicKey(requestParameters = {}) {
 		return this.marketDataApi.fetchRsaPublicKey(requestParameters);
 	}
 	/**
-	* This API is to help you verify which tokens are available for you to create Stablecoin-Denominated gift cards as mentioned in section 2 and its’ limitation.
+	* This API is to help you verify which tokens are available for you to create Stablecoin-Denominated gift cards as
+	* mentioned in section 2 and its’ limitation.
+	*
+	* Weight(IP): 1
 	*
-	* Weight: 1
+	* Security Type: USER_DATA
 	*
-	* @summary Fetch Token Limit(USER_DATA)
+	* @summary Fetch Token Limit (USER_DATA)
 	* @param {FetchTokenLimitRequest} requestParameters Request parameters.
 	*
 	* @returns {Promise<RestApiResponse<FetchTokenLimitResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @see {@link https://developers.binance.com/docs/gift_card/market-data/Fetch-Token-Limit Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-gift-card/api/rest-api/market-data#fetch-token-limit Binance API Documentation}
 	*/
 	fetchTokenLimit(requestParameters) {
 		return this.marketDataApi.fetchTokenLimit(requestParameters);
 	}
 	/**
-	* This API is for redeeming a Binance Gift Card
-	* Once redeemed, the coins will be deposited in your funding wallet.
+	* This API is for redeeming a Binance Gift Card. Once redeemed, the coins will be deposited in your funding wallet.
 	*
-	* Parameter code can be sent in two formats:
-	* Plaintext
-	* Encrypted
+	* Weight(IP): 1
 	*
-	* Sending code in Encrypted format provides more security than sending it as a plaintext. To send card code in encrypted format the following steps must be followed:
-	* Fetch RSA public key from api stated below.
-	* Use the below algorithm to encrypt the card code using the RSA public key fetched above: `RSA/ECB/OAEPWithSHA-256AndMGF1Padding`
-	**A sample code snippet (JAVA) is stated below for reference, the same approach can be used for different languages like C#, PERL, PYTHON, SHELL etc.:**
+	* Security Type: USER_DATA
 	*
-	* Weight: 1
+	* Notes:
+	* - Parameter `code` can be sent in two formats: `Plaintext` and `Encrypted`.
+	* - Sending `code` in encrypted format is more secure than plaintext.
+	* - To send encrypted `code`:
+	* - Fetch RSA public key from `GET /sapi/v1/giftcard/cryptography/rsa-public-key`.
+	* - Encrypt card code using `RSA/ECB/OAEPWithSHA-256AndMGF1Padding`.
+	* - If you enter the wrong redemption code 5 times within 24 hours, you will no longer be able to redeem any Binance Gift Cards that day.
 	*
-	* @summary Redeem a Binance Gift Card(USER_DATA)
+	* @summary Redeem a Binance Gift Card (USER_DATA)
 	* @param {RedeemABinanceGiftCardRequest} requestParameters Request parameters.
 	*
 	* @returns {Promise<RestApiResponse<RedeemABinanceGiftCardResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @see {@link https://developers.binance.com/docs/gift_card/market-data/Redeem-a-Binance-Gift-Card Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-gift-card/api/rest-api/market-data#redeem-abinance-gift-card Binance API Documentation}
 	*/
 	redeemABinanceGiftCard(requestParameters) {
 		return this.marketDataApi.redeemABinanceGiftCard(requestParameters);
@@ -436,16 +461,19 @@ var RestAPI = class {
 	/**
 	* This API is for verifying whether the Binance Gift Card is valid or not by entering Gift Card Number.
 	*
-	**Please note that if you enter the wrong Gift Card Number 5 times within an hour, you will no longer be able to verify any Gift Card Number for that hour.**
+	**Please note that if you enter the wrong Gift Card Number 5 times within an hour, you will no longer be able to
+	* verify any Gift Card Number for that hour.**
+	*
+	* Weight(IP): 1
 	*
-	* Weight: 1
+	* Security Type: USER_DATA
 	*
-	* @summary Verify Binance Gift Card by Gift Card Number(USER_DATA)
+	* @summary Verify Binance Gift Card by Gift Card Number (USER_DATA)
 	* @param {VerifyBinanceGiftCardByGiftCardNumberRequest} requestParameters Request parameters.
 	*
 	* @returns {Promise<RestApiResponse<VerifyBinanceGiftCardByGiftCardNumberResponse>>}
 	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
-	* @see {@link https://developers.binance.com/docs/gift_card/market-data/Verify-Binance-Gift-Card-by-Gift-Card-Number Binance API Documentation}
+	* @see {@link https://developers.binance.com/en/docs/catalog/investment-and-services-gift-card/api/rest-api/market-data#verify-binance-gift-card-by-gift-card-number Binance API Documentation}
 	*/
 	verifyBinanceGiftCardByGiftCardNumber(requestParameters) {
 		return this.marketDataApi.verifyBinanceGiftCardByGiftCardNumber(requestParameters);