@binance/giftcard 4.0.0

package/dist/index.d.mts

@@ -0,0 +1,877 @@
+import { BadRequestError, ConfigurationRestAPI, ConnectorClientError, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, NetworkError, NotFoundError, RateLimitBanError, RequiredError, RestApiResponse, ServerError, TooManyRequestsError, UnauthorizedError } from "@binance/common";
+
+//#region src/rest-api/types/create-adual-token-gift-card-response-data.d.ts
+
+/**
+ * Binance Gift Card REST API
+ *
+ * OpenAPI Specification for the Binance Gift Card REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateADualTokenGiftCardResponseData
+ */
+interface CreateADualTokenGiftCardResponseData {
+  /**
+   *
+   * @type {string}
+   * @memberof CreateADualTokenGiftCardResponseData
+   */
+  referenceNo?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CreateADualTokenGiftCardResponseData
+   */
+  code?: string;
+  /**
+   *
+   * @type {number | bigint}
+   * @memberof CreateADualTokenGiftCardResponseData
+   */
+  expiredTime?: number | bigint;
+}
+//#endregion
+//#region src/rest-api/types/create-adual-token-gift-card-response.d.ts
+
+/**
+ *
+ * @export
+ * @interface CreateADualTokenGiftCardResponse
+ */
+interface CreateADualTokenGiftCardResponse {
+  /**
+   *
+   * @type {string}
+   * @memberof CreateADualTokenGiftCardResponse
+   */
+  code?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CreateADualTokenGiftCardResponse
+   */
+  message?: string;
+  /**
+   *
+   * @type {CreateADualTokenGiftCardResponseData}
+   * @memberof CreateADualTokenGiftCardResponse
+   */
+  data?: CreateADualTokenGiftCardResponseData;
+  /**
+   *
+   * @type {boolean}
+   * @memberof CreateADualTokenGiftCardResponse
+   */
+  success?: boolean;
+}
+//#endregion
+//#region src/rest-api/types/create-asingle-token-gift-card-response.d.ts
+
+/**
+ *
+ * @export
+ * @interface CreateASingleTokenGiftCardResponse
+ */
+interface CreateASingleTokenGiftCardResponse {
+  /**
+   *
+   * @type {string}
+   * @memberof CreateASingleTokenGiftCardResponse
+   */
+  code?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CreateASingleTokenGiftCardResponse
+   */
+  message?: string;
+  /**
+   *
+   * @type {CreateADualTokenGiftCardResponseData}
+   * @memberof CreateASingleTokenGiftCardResponse
+   */
+  data?: CreateADualTokenGiftCardResponseData;
+  /**
+   *
+   * @type {boolean}
+   * @memberof CreateASingleTokenGiftCardResponse
+   */
+  success?: boolean;
+}
+//#endregion
+//#region src/rest-api/types/fetch-rsa-public-key-response.d.ts
+/**
+ * Binance Gift Card REST API
+ *
+ * OpenAPI Specification for the Binance Gift Card REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface FetchRsaPublicKeyResponse
+ */
+interface FetchRsaPublicKeyResponse {
+  /**
+   *
+   * @type {string}
+   * @memberof FetchRsaPublicKeyResponse
+   */
+  code?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof FetchRsaPublicKeyResponse
+   */
+  message?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof FetchRsaPublicKeyResponse
+   */
+  data?: string;
+  /**
+   *
+   * @type {boolean}
+   * @memberof FetchRsaPublicKeyResponse
+   */
+  success?: boolean;
+}
+//#endregion
+//#region src/rest-api/types/fetch-token-limit-response-data-inner.d.ts
+/**
+ * Binance Gift Card REST API
+ *
+ * OpenAPI Specification for the Binance Gift Card REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface FetchTokenLimitResponseDataInner
+ */
+interface FetchTokenLimitResponseDataInner {
+  /**
+   *
+   * @type {string}
+   * @memberof FetchTokenLimitResponseDataInner
+   */
+  coin?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof FetchTokenLimitResponseDataInner
+   */
+  fromMin?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof FetchTokenLimitResponseDataInner
+   */
+  fromMax?: string;
+}
+//#endregion
+//#region src/rest-api/types/fetch-token-limit-response.d.ts
+/**
+ *
+ * @export
+ * @interface FetchTokenLimitResponse
+ */
+interface FetchTokenLimitResponse {
+  /**
+   *
+   * @type {string}
+   * @memberof FetchTokenLimitResponse
+   */
+  code?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof FetchTokenLimitResponse
+   */
+  message?: string;
+  /**
+   *
+   * @type {Array<FetchTokenLimitResponseDataInner>}
+   * @memberof FetchTokenLimitResponse
+   */
+  data?: Array<FetchTokenLimitResponseDataInner>;
+  /**
+   *
+   * @type {boolean}
+   * @memberof FetchTokenLimitResponse
+   */
+  success?: boolean;
+}
+//#endregion
+//#region src/rest-api/types/redeem-abinance-gift-card-response-data.d.ts
+/**
+ * Binance Gift Card REST API
+ *
+ * OpenAPI Specification for the Binance Gift Card REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface RedeemABinanceGiftCardResponseData
+ */
+interface RedeemABinanceGiftCardResponseData {
+  /**
+   *
+   * @type {string}
+   * @memberof RedeemABinanceGiftCardResponseData
+   */
+  referenceNo?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof RedeemABinanceGiftCardResponseData
+   */
+  identityNo?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof RedeemABinanceGiftCardResponseData
+   */
+  token?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof RedeemABinanceGiftCardResponseData
+   */
+  amount?: string;
+}
+//#endregion
+//#region src/rest-api/types/redeem-abinance-gift-card-response.d.ts
+/**
+ *
+ * @export
+ * @interface RedeemABinanceGiftCardResponse
+ */
+interface RedeemABinanceGiftCardResponse {
+  /**
+   *
+   * @type {string}
+   * @memberof RedeemABinanceGiftCardResponse
+   */
+  code?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof RedeemABinanceGiftCardResponse
+   */
+  message?: string;
+  /**
+   *
+   * @type {RedeemABinanceGiftCardResponseData}
+   * @memberof RedeemABinanceGiftCardResponse
+   */
+  data?: RedeemABinanceGiftCardResponseData;
+  /**
+   *
+   * @type {boolean}
+   * @memberof RedeemABinanceGiftCardResponse
+   */
+  success?: boolean;
+}
+//#endregion
+//#region src/rest-api/types/verify-binance-gift-card-by-gift-card-number-response-data.d.ts
+/**
+ * Binance Gift Card REST API
+ *
+ * OpenAPI Specification for the Binance Gift Card REST API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface VerifyBinanceGiftCardByGiftCardNumberResponseData
+ */
+interface VerifyBinanceGiftCardByGiftCardNumberResponseData {
+  /**
+   *
+   * @type {boolean}
+   * @memberof VerifyBinanceGiftCardByGiftCardNumberResponseData
+   */
+  valid?: boolean;
+  /**
+   *
+   * @type {string}
+   * @memberof VerifyBinanceGiftCardByGiftCardNumberResponseData
+   */
+  token?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof VerifyBinanceGiftCardByGiftCardNumberResponseData
+   */
+  amount?: string;
+}
+//#endregion
+//#region src/rest-api/types/verify-binance-gift-card-by-gift-card-number-response.d.ts
+/**
+ *
+ * @export
+ * @interface VerifyBinanceGiftCardByGiftCardNumberResponse
+ */
+interface VerifyBinanceGiftCardByGiftCardNumberResponse {
+  /**
+   *
+   * @type {string}
+   * @memberof VerifyBinanceGiftCardByGiftCardNumberResponse
+   */
+  code?: string;
+  /**
+   *
+   * @type {string}
+   * @memberof VerifyBinanceGiftCardByGiftCardNumberResponse
+   */
+  message?: string;
+  /**
+   *
+   * @type {VerifyBinanceGiftCardByGiftCardNumberResponseData}
+   * @memberof VerifyBinanceGiftCardByGiftCardNumberResponse
+   */
+  data?: VerifyBinanceGiftCardByGiftCardNumberResponseData;
+  /**
+   *
+   * @type {boolean}
+   * @memberof VerifyBinanceGiftCardByGiftCardNumberResponse
+   */
+  success?: boolean;
+}
+//#endregion
+//#region src/rest-api/modules/market-data-api.d.ts
+/**
+ * MarketDataApi - interface
+ * @interface MarketDataApi
+ */
+interface MarketDataApiInterface {
+  /**
+   * * 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
+   *
+   * @summary Create a dual-token gift card(fixed value, discount feature)(TRADE)
+   * @param {CreateADualTokenGiftCardRequest} requestParameters Request parameters.
+   *
+   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+   * @memberof MarketDataApiInterface
+   */
+  createADualTokenGiftCard(requestParameters: CreateADualTokenGiftCardRequest): Promise<RestApiResponse<CreateADualTokenGiftCardResponse>>;
+  /**
+   * 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
+   *
+   * @summary Create a single-token gift card (USER_DATA)
+   * @param {CreateASingleTokenGiftCardRequest} requestParameters Request parameters.
+   *
+   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+   * @memberof MarketDataApiInterface
+   */
+  createASingleTokenGiftCard(requestParameters: CreateASingleTokenGiftCardRequest): Promise<RestApiResponse<CreateASingleTokenGiftCardResponse>>;
+  /**
+   * This API is for fetching the RSA Public Key.
+   * This RSA Public key will be used to encrypt the card code.
+   *
+   **Please note that the RSA Public key fetched is valid only for the current day.**
+   *
+   * Weight: 1
+   *
+   * @summary Fetch RSA Public Key(USER_DATA)
+   * @param {FetchRsaPublicKeyRequest} requestParameters Request parameters.
+   *
+   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+   * @memberof MarketDataApiInterface
+   */
+  fetchRsaPublicKey(requestParameters?: FetchRsaPublicKeyRequest): Promise<RestApiResponse<FetchRsaPublicKeyResponse>>;
+  /**
+   * 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: 1
+   *
+   * @summary Fetch Token Limit(USER_DATA)
+   * @param {FetchTokenLimitRequest} requestParameters Request parameters.
+   *
+   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+   * @memberof MarketDataApiInterface
+   */
+  fetchTokenLimit(requestParameters: FetchTokenLimitRequest): Promise<RestApiResponse<FetchTokenLimitResponse>>;
+  /**
+   * 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
+   *
+   * 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.:**
+   *
+   * Weight: 1
+   *
+   * @summary Redeem a Binance Gift Card(USER_DATA)
+   * @param {RedeemABinanceGiftCardRequest} requestParameters Request parameters.
+   *
+   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+   * @memberof MarketDataApiInterface
+   */
+  redeemABinanceGiftCard(requestParameters: RedeemABinanceGiftCardRequest): Promise<RestApiResponse<RedeemABinanceGiftCardResponse>>;
+  /**
+   * 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.**
+   *
+   * Weight: 1
+   *
+   * @summary Verify Binance Gift Card by Gift Card Number(USER_DATA)
+   * @param {VerifyBinanceGiftCardByGiftCardNumberRequest} requestParameters Request parameters.
+   *
+   * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+   * @memberof MarketDataApiInterface
+   */
+  verifyBinanceGiftCardByGiftCardNumber(requestParameters: VerifyBinanceGiftCardByGiftCardNumberRequest): Promise<RestApiResponse<VerifyBinanceGiftCardByGiftCardNumberResponse>>;
+}
+/**
+ * Request parameters for createADualTokenGiftCard operation in MarketDataApi.
+ * @interface CreateADualTokenGiftCardRequest
+ */
+interface CreateADualTokenGiftCardRequest {
+  /**
+   * The token you want to pay, example: BUSD
+   * @type {string}
+   * @memberof MarketDataApiCreateADualTokenGiftCard
+   */
+  readonly baseToken: string;
+  /**
+   * The token you want to buy, example: BNB. If faceToken = baseToken, it's the same as createCode endpoint.
+   * @type {string}
+   * @memberof MarketDataApiCreateADualTokenGiftCard
+   */
+  readonly faceToken: string;
+  /**
+   * The base token asset quantity, example : 1.002
+   * @type {number}
+   * @memberof MarketDataApiCreateADualTokenGiftCard
+   */
+  readonly baseTokenAmount: number;
+  /**
+   *
+   * @type {number | bigint}
+   * @memberof MarketDataApiCreateADualTokenGiftCard
+   */
+  readonly recvWindow?: number | bigint;
+}
+/**
+ * Request parameters for createASingleTokenGiftCard operation in MarketDataApi.
+ * @interface CreateASingleTokenGiftCardRequest
+ */
+interface CreateASingleTokenGiftCardRequest {
+  /**
+   * The token type contained in the Binance Gift Card
+   * @type {string}
+   * @memberof MarketDataApiCreateASingleTokenGiftCard
+   */
+  readonly token: string;
+  /**
+   * The amount of the token contained in the Binance Gift Card
+   * @type {number}
+   * @memberof MarketDataApiCreateASingleTokenGiftCard
+   */
+  readonly amount: number;
+  /**
+   *
+   * @type {number | bigint}
+   * @memberof MarketDataApiCreateASingleTokenGiftCard
+   */
+  readonly recvWindow?: number | bigint;
+}
+/**
+ * Request parameters for fetchRsaPublicKey operation in MarketDataApi.
+ * @interface FetchRsaPublicKeyRequest
+ */
+interface FetchRsaPublicKeyRequest {
+  /**
+   *
+   * @type {number | bigint}
+   * @memberof MarketDataApiFetchRsaPublicKey
+   */
+  readonly recvWindow?: number | bigint;
+}
+/**
+ * Request parameters for fetchTokenLimit operation in MarketDataApi.
+ * @interface FetchTokenLimitRequest
+ */
+interface FetchTokenLimitRequest {
+  /**
+   * The token you want to pay, example: BUSD
+   * @type {string}
+   * @memberof MarketDataApiFetchTokenLimit
+   */
+  readonly baseToken: string;
+  /**
+   *
+   * @type {number | bigint}
+   * @memberof MarketDataApiFetchTokenLimit
+   */
+  readonly recvWindow?: number | bigint;
+}
+/**
+ * Request parameters for redeemABinanceGiftCard operation in MarketDataApi.
+ * @interface RedeemABinanceGiftCardRequest
+ */
+interface RedeemABinanceGiftCardRequest {
+  /**
+   * Redemption code of Binance Gift Card to be redeemed, supports both Plaintext & Encrypted code.
+   * @type {string}
+   * @memberof MarketDataApiRedeemABinanceGiftCard
+   */
+  readonly code: string;
+  /**
+   * Each external unique ID represents a unique user on the partner platform. The function helps you to identify the redemption behavior of different users, such as redemption frequency and amount. It also helps risk and limit control of a single account, such as daily limit on redemption volume, frequency, and incorrect number of entries. This will also prevent a single user account reach the partner's daily redemption limits. We strongly recommend you to use this feature and transfer us the User ID of your users if you have different users redeeming Binance Gift Cards on your platform. To protect user data privacy, you may choose to transfer the user id in any desired format (max. 400 characters).
+   * @type {string}
+   * @memberof MarketDataApiRedeemABinanceGiftCard
+   */
+  readonly externalUid?: string;
+  /**
+   *
+   * @type {number | bigint}
+   * @memberof MarketDataApiRedeemABinanceGiftCard
+   */
+  readonly recvWindow?: number | bigint;
+}
+/**
+ * Request parameters for verifyBinanceGiftCardByGiftCardNumber operation in MarketDataApi.
+ * @interface VerifyBinanceGiftCardByGiftCardNumberRequest
+ */
+interface VerifyBinanceGiftCardByGiftCardNumberRequest {
+  /**
+   * Enter the Gift Card Number
+   * @type {string}
+   * @memberof MarketDataApiVerifyBinanceGiftCardByGiftCardNumber
+   */
+  readonly referenceNo: string;
+  /**
+   *
+   * @type {number | bigint}
+   * @memberof MarketDataApiVerifyBinanceGiftCardByGiftCardNumber
+   */
+  readonly recvWindow?: number | bigint;
+}
+/**
+ * MarketDataApi - object-oriented interface
+ * @class MarketDataApi
+ */
+declare class MarketDataApi implements MarketDataApiInterface {
+  private readonly configuration;
+  private localVarAxiosParamCreator;
+  constructor(configuration: ConfigurationRestAPI);
+  /**
+   * * 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
+   *
+   * @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}
+   */
+  createADualTokenGiftCard(requestParameters: CreateADualTokenGiftCardRequest): Promise<RestApiResponse<CreateADualTokenGiftCardResponse>>;
+  /**
+   * 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
+   *
+   * @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}
+   */
+  createASingleTokenGiftCard(requestParameters: CreateASingleTokenGiftCardRequest): Promise<RestApiResponse<CreateASingleTokenGiftCardResponse>>;
+  /**
+   * This API is for fetching the RSA Public Key.
+   * This RSA Public key will be used to encrypt the card code.
+   *
+   **Please note that the RSA Public key fetched is valid only for the current day.**
+   *
+   * Weight: 1
+   *
+   * @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}
+   */
+  fetchRsaPublicKey(requestParameters?: FetchRsaPublicKeyRequest): Promise<RestApiResponse<FetchRsaPublicKeyResponse>>;
+  /**
+   * 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: 1
+   *
+   * @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}
+   */
+  fetchTokenLimit(requestParameters: FetchTokenLimitRequest): Promise<RestApiResponse<FetchTokenLimitResponse>>;
+  /**
+   * 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
+   *
+   * 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.:**
+   *
+   * Weight: 1
+   *
+   * @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}
+   */
+  redeemABinanceGiftCard(requestParameters: RedeemABinanceGiftCardRequest): Promise<RestApiResponse<RedeemABinanceGiftCardResponse>>;
+  /**
+   * 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.**
+   *
+   * Weight: 1
+   *
+   * @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}
+   */
+  verifyBinanceGiftCardByGiftCardNumber(requestParameters: VerifyBinanceGiftCardByGiftCardNumberRequest): Promise<RestApiResponse<VerifyBinanceGiftCardByGiftCardNumberResponse>>;
+}
+//#endregion
+//#region src/rest-api/rest-api.d.ts
+declare class RestAPI {
+  private configuration;
+  private marketDataApi;
+  constructor(configuration: ConfigurationRestAPI);
+  /**
+   * Generic function to send a request.
+   * @param endpoint - The API endpoint to call.
+   * @param method - HTTP method to use (GET, POST, DELETE, etc.).
+   * @param params - Query parameters for the request.
+   *
+   * @returns A promise resolving to the response data object.
+   */
+  sendRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
+  /**
+   * Generic function to send a signed request.
+   * @param endpoint - The API endpoint to call.
+   * @param method - HTTP method to use (GET, POST, DELETE, etc.).
+   * @param params - Query parameters for the request.
+   *
+   * @returns A promise resolving to the response data object.
+   */
+  sendSignedRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
+  /**
+   * * 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
+   *
+   * @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}
+   */
+  createADualTokenGiftCard(requestParameters: CreateADualTokenGiftCardRequest): Promise<RestApiResponse<CreateADualTokenGiftCardResponse>>;
+  /**
+   * 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
+   *
+   * @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}
+   */
+  createASingleTokenGiftCard(requestParameters: CreateASingleTokenGiftCardRequest): Promise<RestApiResponse<CreateASingleTokenGiftCardResponse>>;
+  /**
+   * This API is for fetching the RSA Public Key.
+   * This RSA Public key will be used to encrypt the card code.
+   *
+   **Please note that the RSA Public key fetched is valid only for the current day.**
+   *
+   * Weight: 1
+   *
+   * @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}
+   */
+  fetchRsaPublicKey(requestParameters?: FetchRsaPublicKeyRequest): Promise<RestApiResponse<FetchRsaPublicKeyResponse>>;
+  /**
+   * 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: 1
+   *
+   * @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}
+   */
+  fetchTokenLimit(requestParameters: FetchTokenLimitRequest): Promise<RestApiResponse<FetchTokenLimitResponse>>;
+  /**
+   * 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
+   *
+   * 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.:**
+   *
+   * Weight: 1
+   *
+   * @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}
+   */
+  redeemABinanceGiftCard(requestParameters: RedeemABinanceGiftCardRequest): Promise<RestApiResponse<RedeemABinanceGiftCardResponse>>;
+  /**
+   * 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.**
+   *
+   * Weight: 1
+   *
+   * @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}
+   */
+  verifyBinanceGiftCardByGiftCardNumber(requestParameters: VerifyBinanceGiftCardByGiftCardNumberRequest): Promise<RestApiResponse<VerifyBinanceGiftCardByGiftCardNumberResponse>>;
+}
+declare namespace index_d_exports {
+  export { CreateADualTokenGiftCardRequest, CreateADualTokenGiftCardResponse, CreateADualTokenGiftCardResponseData, CreateASingleTokenGiftCardRequest, CreateASingleTokenGiftCardResponse, FetchRsaPublicKeyRequest, FetchRsaPublicKeyResponse, FetchTokenLimitRequest, FetchTokenLimitResponse, FetchTokenLimitResponseDataInner, MarketDataApi, MarketDataApiInterface, RedeemABinanceGiftCardRequest, RedeemABinanceGiftCardResponse, RedeemABinanceGiftCardResponseData, RestAPI, VerifyBinanceGiftCardByGiftCardNumberRequest, VerifyBinanceGiftCardByGiftCardNumberResponse, VerifyBinanceGiftCardByGiftCardNumberResponseData };
+}
+//#endregion
+//#region src/gift-card.d.ts
+interface ConfigurationGiftCard {
+  configurationRestAPI?: ConfigurationRestAPI;
+}
+declare class GiftCard {
+  restAPI: RestAPI;
+  constructor(config: ConfigurationGiftCard);
+}
+//#endregion
+export { BadRequestError, ConfigurationGiftCard, ConnectorClientError, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, GiftCard, index_d_exports as GiftCardRestAPI, NetworkError, NotFoundError, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError };
+//# sourceMappingURL=index.d.mts.map