@binance/fiat 1.0.0

package/dist/index.mjs

@@ -0,0 +1,325 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name2 in all)
+    __defProp(target, name2, { get: all[name2], enumerable: true });
+};
+
+// src/fiat.ts
+import { platform, arch } from "os";
+import { ConfigurationRestAPI as ConfigurationRestAPI3, FIAT_REST_API_PROD_URL } from "@binance/common";
+
+// package.json
+var name = "@binance/fiat";
+var version = "1.0.0";
+
+// src/rest-api/index.ts
+var rest_api_exports = {};
+__export(rest_api_exports, {
+  FiatApi: () => FiatApi,
+  RestAPI: () => RestAPI
+});
+
+// src/rest-api/modules/fiat-api.ts
+import {
+  assertParamExists,
+  sendRequest
+} from "@binance/common";
+var FiatApiAxiosParamCreator = function(configuration) {
+  return {
+    /**
+     * Get Fiat Deposit/Withdraw History
+     *
+     * If beginTime and endTime are not sent, the recent 30-day data will be returned.
+     *
+     * Weight: 90000
+     *
+     * @summary Get Fiat Deposit/Withdraw History (USER_DATA)
+     * @param {string} transactionType 0-buy,1-sell
+     * @param {number} [beginTime]
+     * @param {number} [endTime]
+     * @param {number} [page] default 1
+     * @param {number} [rows] default 100, max 500
+     * @param {number} [recvWindow]
+     *
+     * @throws {RequiredError}
+     */
+    getFiatDepositWithdrawHistory: async (transactionType, beginTime, endTime, page, rows, recvWindow) => {
+      assertParamExists("getFiatDepositWithdrawHistory", "transactionType", transactionType);
+      const localVarQueryParameter = {};
+      if (transactionType !== void 0 && transactionType !== null) {
+        localVarQueryParameter["transactionType"] = transactionType;
+      }
+      if (beginTime !== void 0 && beginTime !== null) {
+        localVarQueryParameter["beginTime"] = beginTime;
+      }
+      if (endTime !== void 0 && endTime !== null) {
+        localVarQueryParameter["endTime"] = endTime;
+      }
+      if (page !== void 0 && page !== null) {
+        localVarQueryParameter["page"] = page;
+      }
+      if (rows !== void 0 && rows !== null) {
+        localVarQueryParameter["rows"] = rows;
+      }
+      if (recvWindow !== void 0 && recvWindow !== null) {
+        localVarQueryParameter["recvWindow"] = recvWindow;
+      }
+      let _timeUnit;
+      if ("timeUnit" in configuration)
+        _timeUnit = configuration.timeUnit;
+      return {
+        endpoint: "/sapi/v1/fiat/orders",
+        method: "GET",
+        params: localVarQueryParameter,
+        timeUnit: _timeUnit
+      };
+    },
+    /**
+     * Get Fiat Deposit/Withdraw History
+     *
+     * 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
+     *
+     * Weight: 1
+     *
+     * @summary Get Fiat Payments History (USER_DATA)
+     * @param {string} transactionType 0-buy,1-sell
+     * @param {number} [beginTime]
+     * @param {number} [endTime]
+     * @param {number} [page] default 1
+     * @param {number} [rows] default 100, max 500
+     * @param {number} [recvWindow]
+     *
+     * @throws {RequiredError}
+     */
+    getFiatPaymentsHistory: async (transactionType, beginTime, endTime, page, rows, recvWindow) => {
+      assertParamExists("getFiatPaymentsHistory", "transactionType", transactionType);
+      const localVarQueryParameter = {};
+      if (transactionType !== void 0 && transactionType !== null) {
+        localVarQueryParameter["transactionType"] = transactionType;
+      }
+      if (beginTime !== void 0 && beginTime !== null) {
+        localVarQueryParameter["beginTime"] = beginTime;
+      }
+      if (endTime !== void 0 && endTime !== null) {
+        localVarQueryParameter["endTime"] = endTime;
+      }
+      if (page !== void 0 && page !== null) {
+        localVarQueryParameter["page"] = page;
+      }
+      if (rows !== void 0 && rows !== null) {
+        localVarQueryParameter["rows"] = rows;
+      }
+      if (recvWindow !== void 0 && recvWindow !== null) {
+        localVarQueryParameter["recvWindow"] = recvWindow;
+      }
+      let _timeUnit;
+      if ("timeUnit" in configuration)
+        _timeUnit = configuration.timeUnit;
+      return {
+        endpoint: "/sapi/v1/fiat/payments",
+        method: "GET",
+        params: localVarQueryParameter,
+        timeUnit: _timeUnit
+      };
+    }
+  };
+};
+var FiatApi = class {
+  constructor(configuration) {
+    this.configuration = configuration;
+    this.localVarAxiosParamCreator = FiatApiAxiosParamCreator(configuration);
+  }
+  /**
+   * Get Fiat Deposit/Withdraw History
+   *
+   * If beginTime and endTime are not sent, the recent 30-day data will be returned.
+   *
+   * Weight: 90000
+   *
+   * @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}
+   */
+  async getFiatDepositWithdrawHistory(requestParameters) {
+    const localVarAxiosArgs = await this.localVarAxiosParamCreator.getFiatDepositWithdrawHistory(
+      requestParameters?.transactionType,
+      requestParameters?.beginTime,
+      requestParameters?.endTime,
+      requestParameters?.page,
+      requestParameters?.rows,
+      requestParameters?.recvWindow
+    );
+    return sendRequest(
+      this.configuration,
+      localVarAxiosArgs.endpoint,
+      localVarAxiosArgs.method,
+      localVarAxiosArgs.params,
+      localVarAxiosArgs?.timeUnit,
+      { isSigned: true }
+    );
+  }
+  /**
+   * Get Fiat Deposit/Withdraw History
+   *
+   * 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
+   *
+   * Weight: 1
+   *
+   * @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}
+   */
+  async getFiatPaymentsHistory(requestParameters) {
+    const localVarAxiosArgs = await this.localVarAxiosParamCreator.getFiatPaymentsHistory(
+      requestParameters?.transactionType,
+      requestParameters?.beginTime,
+      requestParameters?.endTime,
+      requestParameters?.page,
+      requestParameters?.rows,
+      requestParameters?.recvWindow
+    );
+    return sendRequest(
+      this.configuration,
+      localVarAxiosArgs.endpoint,
+      localVarAxiosArgs.method,
+      localVarAxiosArgs.params,
+      localVarAxiosArgs?.timeUnit,
+      { isSigned: true }
+    );
+  }
+};
+
+// src/rest-api/rest-api.ts
+import { sendRequest as sendRequest2 } from "@binance/common";
+var RestAPI = class {
+  constructor(configuration) {
+    this.configuration = configuration;
+    this.fiatApi = new FiatApi(configuration);
+  }
+  /**
+   * 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(endpoint, method, params = {}) {
+    return sendRequest2(this.configuration, endpoint, method, params, void 0);
+  }
+  /**
+   * 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(endpoint, method, params = {}) {
+    return sendRequest2(this.configuration, endpoint, method, params, void 0, {
+      isSigned: true
+    });
+  }
+  /**
+   * Get Fiat Deposit/Withdraw History
+   *
+   * If beginTime and endTime are not sent, the recent 30-day data will be returned.
+   *
+   * Weight: 90000
+   *
+   * @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}
+   */
+  getFiatDepositWithdrawHistory(requestParameters) {
+    return this.fiatApi.getFiatDepositWithdrawHistory(requestParameters);
+  }
+  /**
+   * Get Fiat Deposit/Withdraw History
+   *
+   * 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
+   *
+   * Weight: 1
+   *
+   * @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}
+   */
+  getFiatPaymentsHistory(requestParameters) {
+    return this.fiatApi.getFiatPaymentsHistory(requestParameters);
+  }
+};
+
+// src/fiat.ts
+var Fiat = class {
+  constructor(config) {
+    if (config?.configurationRestAPI) {
+      const configRestAPI = new ConfigurationRestAPI3(config.configurationRestAPI);
+      configRestAPI.basePath = configRestAPI.basePath || FIAT_REST_API_PROD_URL;
+      configRestAPI.baseOptions = configRestAPI.baseOptions || {};
+      configRestAPI.baseOptions.headers = {
+        ...configRestAPI.baseOptions.headers || {},
+        "User-Agent": `${name}/${version} (Node.js/${process.version}; ${platform()}; ${arch()})`
+      };
+      this.restAPI = new RestAPI(configRestAPI);
+    }
+  }
+};
+
+// src/index.ts
+import {
+  FIAT_REST_API_PROD_URL as FIAT_REST_API_PROD_URL2,
+  FIAT_REST_API_TESTNET_URL,
+  ConnectorClientError,
+  RequiredError,
+  UnauthorizedError,
+  ForbiddenError,
+  TooManyRequestsError,
+  RateLimitBanError,
+  ServerError,
+  NetworkError,
+  NotFoundError,
+  BadRequestError
+} from "@binance/common";
+export {
+  BadRequestError,
+  ConnectorClientError,
+  FIAT_REST_API_PROD_URL2 as FIAT_REST_API_PROD_URL,
+  FIAT_REST_API_TESTNET_URL,
+  Fiat,
+  rest_api_exports as FiatRestAPI,
+  ForbiddenError,
+  NetworkError,
+  NotFoundError,
+  RateLimitBanError,
+  RequiredError,
+  ServerError,
+  TooManyRequestsError,
+  UnauthorizedError
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/fiat.ts","../package.json","../src/rest-api/index.ts","../src/rest-api/modules/fiat-api.ts","../src/rest-api/rest-api.ts","../src/index.ts"],"sourcesContent":["import { platform, arch } from 'os';\nimport { ConfigurationRestAPI, FIAT_REST_API_PROD_URL } from '@binance/common';\nimport { name, version } from '../package.json';\nimport { RestAPI } from './rest-api';\n\nexport interface ConfigurationFiat {\n    configurationRestAPI?: ConfigurationRestAPI;\n}\n\nexport class Fiat {\n    public restAPI!: RestAPI;\n\n    constructor(config: ConfigurationFiat) {\n        if (config?.configurationRestAPI) {\n            const configRestAPI = new ConfigurationRestAPI(config.configurationRestAPI);\n            configRestAPI.basePath = configRestAPI.basePath || FIAT_REST_API_PROD_URL;\n            configRestAPI.baseOptions = configRestAPI.baseOptions || {};\n            configRestAPI.baseOptions.headers = {\n                ...(configRestAPI.baseOptions.headers || {}),\n                'User-Agent': `${name}/${version} (Node.js/${process.version}; ${platform()}; ${arch()})`,\n            };\n            this.restAPI = new RestAPI(configRestAPI);\n        }\n    }\n}\n","{\n    \"name\": \"@binance/fiat\",\n    \"description\": \"Official Binance Fiat Connector - A lightweight library that provides a convenient interface to Binance's Fiat REST API.\",\n    \"version\": \"1.0.0\",\n    \"main\": \"./dist/index.js\",\n    \"module\": \"./dist/index.mjs\",\n    \"types\": \"./dist/index.d.ts\",\n    \"scripts\": {\n        \"prepublishOnly\": \"npm run build\",\n        \"build\": \"tsup\",\n        \"typecheck\": \"tsc --noEmit\",\n        \"clean\": \"rm -rf dist\",\n        \"test\": \"npx jest --maxWorkers=4 --bail\",\n        \"test:watch\": \"npx jest --watch\",\n        \"format\": \"npx prettier --ignore-path .prettierignore --write .\",\n        \"lint\": \"npx eslint '**/*.ts' --fix\"\n    },\n    \"keywords\": [\n        \"Binance\",\n        \"API\",\n        \"Fiat\",\n        \"Connector\",\n        \"REST\",\n        \"Trading\"\n    ],\n    \"author\": \"Binance\",\n    \"license\": \"MIT\",\n    \"repository\": {\n        \"type\": \"git\",\n        \"url\": \"https://github.com/binance/binance-connector-js.git\"\n    },\n    \"bugs\": {\n        \"url\": \"https://github.com/binance/binance-connector-js/issues\"\n    },\n    \"homepage\": \"https://github.com/binance/binance-connector-js#readme\",\n    \"files\": [\n        \"dist\"\n    ],\n    \"devDependencies\": {\n        \"@types/jest\": \"^29.5.4\",\n        \"@types/node\": \"^20.17.24\",\n        \"eslint\": \"8.57.0\",\n        \"jest\": \"^29.6.4\",\n        \"prettier\": \"^3.3.3\",\n        \"ts-jest\": \"^29.1.1\",\n        \"ts-node\": \"^10.9.1\",\n        \"tsup\": \"^7.2.0\",\n        \"typescript\": \"^5.7.2\",\n        \"typescript-eslint\": \"^8.24.0\"\n    },\n    \"dependencies\": {\n        \"@binance/common\": \"1.0.0\",\n        \"axios\": \"^1.7.4\"\n    }\n}\n","/**\n * Binance Public Fiat REST API\n *\n * OpenAPI Specification for the Binance Public Fiat REST API\n *\n * The version of the OpenAPI document: 1.0.0\n *\n *\n * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).\n * https://openapi-generator.tech\n * Do not edit the class manually.\n */\n\nexport * from './types';\nexport * from './modules';\nexport * from './rest-api';\n","/**\n * Binance Public Fiat REST API\n *\n * OpenAPI Specification for the Binance Public Fiat REST API\n *\n * The version of the OpenAPI document: 1.0.0\n *\n *\n * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).\n * https://openapi-generator.tech\n * Do not edit the class manually.\n */\n\nimport {\n    ConfigurationRestAPI,\n    TimeUnit,\n    RestApiResponse,\n    assertParamExists,\n    sendRequest,\n    type RequestArgs,\n} from '@binance/common';\nimport type {\n    GetFiatDepositWithdrawHistoryResponse,\n    GetFiatPaymentsHistoryResponse,\n} from '../types';\n\n/**\n * FiatApi - axios parameter creator\n */\nconst FiatApiAxiosParamCreator = function (configuration: ConfigurationRestAPI) {\n    return {\n        /**\n         * Get Fiat Deposit/Withdraw History\n         *\n         * If beginTime and endTime are not sent, the recent 30-day data will be returned.\n         *\n         * Weight: 90000\n         *\n         * @summary Get Fiat Deposit/Withdraw History (USER_DATA)\n         * @param {string} transactionType 0-buy,1-sell\n         * @param {number} [beginTime]\n         * @param {number} [endTime]\n         * @param {number} [page] default 1\n         * @param {number} [rows] default 100, max 500\n         * @param {number} [recvWindow]\n         *\n         * @throws {RequiredError}\n         */\n        getFiatDepositWithdrawHistory: async (\n            transactionType: string,\n            beginTime?: number,\n            endTime?: number,\n            page?: number,\n            rows?: number,\n            recvWindow?: number\n        ): Promise<RequestArgs> => {\n            // verify required parameter 'transactionType' is not null or undefined\n            assertParamExists('getFiatDepositWithdrawHistory', 'transactionType', transactionType);\n\n            const localVarQueryParameter: Record<string, unknown> = {};\n\n            if (transactionType !== undefined && transactionType !== null) {\n                localVarQueryParameter['transactionType'] = transactionType;\n            }\n\n            if (beginTime !== undefined && beginTime !== null) {\n                localVarQueryParameter['beginTime'] = beginTime;\n            }\n\n            if (endTime !== undefined && endTime !== null) {\n                localVarQueryParameter['endTime'] = endTime;\n            }\n\n            if (page !== undefined && page !== null) {\n                localVarQueryParameter['page'] = page;\n            }\n\n            if (rows !== undefined && rows !== null) {\n                localVarQueryParameter['rows'] = rows;\n            }\n\n            if (recvWindow !== undefined && recvWindow !== null) {\n                localVarQueryParameter['recvWindow'] = recvWindow;\n            }\n\n            let _timeUnit: TimeUnit | undefined;\n            if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n            return {\n                endpoint: '/sapi/v1/fiat/orders',\n                method: 'GET',\n                params: localVarQueryParameter,\n                timeUnit: _timeUnit,\n            };\n        },\n        /**\n         * Get Fiat Deposit/Withdraw History\n         *\n         * If beginTime and endTime are not sent, the recent 30-day data will be returned.\n         * paymentMethod: Only when requesting payments history for buy (transactionType=0), response contains paymentMethod representing the way of purchase. Now we have:\n         * Cash Balance\n         * Credit Card\n         * Online Banking\n         * Bank Transfer\n         *\n         * Weight: 1\n         *\n         * @summary Get Fiat Payments History (USER_DATA)\n         * @param {string} transactionType 0-buy,1-sell\n         * @param {number} [beginTime]\n         * @param {number} [endTime]\n         * @param {number} [page] default 1\n         * @param {number} [rows] default 100, max 500\n         * @param {number} [recvWindow]\n         *\n         * @throws {RequiredError}\n         */\n        getFiatPaymentsHistory: async (\n            transactionType: string,\n            beginTime?: number,\n            endTime?: number,\n            page?: number,\n            rows?: number,\n            recvWindow?: number\n        ): Promise<RequestArgs> => {\n            // verify required parameter 'transactionType' is not null or undefined\n            assertParamExists('getFiatPaymentsHistory', 'transactionType', transactionType);\n\n            const localVarQueryParameter: Record<string, unknown> = {};\n\n            if (transactionType !== undefined && transactionType !== null) {\n                localVarQueryParameter['transactionType'] = transactionType;\n            }\n\n            if (beginTime !== undefined && beginTime !== null) {\n                localVarQueryParameter['beginTime'] = beginTime;\n            }\n\n            if (endTime !== undefined && endTime !== null) {\n                localVarQueryParameter['endTime'] = endTime;\n            }\n\n            if (page !== undefined && page !== null) {\n                localVarQueryParameter['page'] = page;\n            }\n\n            if (rows !== undefined && rows !== null) {\n                localVarQueryParameter['rows'] = rows;\n            }\n\n            if (recvWindow !== undefined && recvWindow !== null) {\n                localVarQueryParameter['recvWindow'] = recvWindow;\n            }\n\n            let _timeUnit: TimeUnit | undefined;\n            if ('timeUnit' in configuration) _timeUnit = configuration.timeUnit as TimeUnit;\n\n            return {\n                endpoint: '/sapi/v1/fiat/payments',\n                method: 'GET',\n                params: localVarQueryParameter,\n                timeUnit: _timeUnit,\n            };\n        },\n    };\n};\n\n/**\n * FiatApi - interface\n * @interface FiatApi\n */\nexport interface FiatApiInterface {\n    /**\n     * Get Fiat Deposit/Withdraw History\n     *\n     * If beginTime and endTime are not sent, the recent 30-day data will be returned.\n     *\n     * Weight: 90000\n     *\n     * @summary Get Fiat Deposit/Withdraw History (USER_DATA)\n     * @param {GetFiatDepositWithdrawHistoryRequest} requestParameters Request parameters.\n     *\n     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}\n     * @memberof FiatApiInterface\n     */\n    getFiatDepositWithdrawHistory(\n        requestParameters: GetFiatDepositWithdrawHistoryRequest\n    ): Promise<RestApiResponse<GetFiatDepositWithdrawHistoryResponse>>;\n    /**\n     * Get Fiat Deposit/Withdraw History\n     *\n     * If beginTime and endTime are not sent, the recent 30-day data will be returned.\n     * paymentMethod: Only when requesting payments history for buy (transactionType=0), response contains paymentMethod representing the way of purchase. Now we have:\n     * Cash Balance\n     * Credit Card\n     * Online Banking\n     * Bank Transfer\n     *\n     * Weight: 1\n     *\n     * @summary Get Fiat Payments History (USER_DATA)\n     * @param {GetFiatPaymentsHistoryRequest} requestParameters Request parameters.\n     *\n     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}\n     * @memberof FiatApiInterface\n     */\n    getFiatPaymentsHistory(\n        requestParameters: GetFiatPaymentsHistoryRequest\n    ): Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>;\n}\n\n/**\n * Request parameters for getFiatDepositWithdrawHistory operation in FiatApi.\n * @interface GetFiatDepositWithdrawHistoryRequest\n */\nexport interface GetFiatDepositWithdrawHistoryRequest {\n    /**\n     * 0-buy,1-sell\n     * @type {string}\n     * @memberof FiatApiGetFiatDepositWithdrawHistory\n     */\n    readonly transactionType: string;\n\n    /**\n     *\n     * @type {number}\n     * @memberof FiatApiGetFiatDepositWithdrawHistory\n     */\n    readonly beginTime?: number;\n\n    /**\n     *\n     * @type {number}\n     * @memberof FiatApiGetFiatDepositWithdrawHistory\n     */\n    readonly endTime?: number;\n\n    /**\n     * default 1\n     * @type {number}\n     * @memberof FiatApiGetFiatDepositWithdrawHistory\n     */\n    readonly page?: number;\n\n    /**\n     * default 100, max 500\n     * @type {number}\n     * @memberof FiatApiGetFiatDepositWithdrawHistory\n     */\n    readonly rows?: number;\n\n    /**\n     *\n     * @type {number}\n     * @memberof FiatApiGetFiatDepositWithdrawHistory\n     */\n    readonly recvWindow?: number;\n}\n\n/**\n * Request parameters for getFiatPaymentsHistory operation in FiatApi.\n * @interface GetFiatPaymentsHistoryRequest\n */\nexport interface GetFiatPaymentsHistoryRequest {\n    /**\n     * 0-buy,1-sell\n     * @type {string}\n     * @memberof FiatApiGetFiatPaymentsHistory\n     */\n    readonly transactionType: string;\n\n    /**\n     *\n     * @type {number}\n     * @memberof FiatApiGetFiatPaymentsHistory\n     */\n    readonly beginTime?: number;\n\n    /**\n     *\n     * @type {number}\n     * @memberof FiatApiGetFiatPaymentsHistory\n     */\n    readonly endTime?: number;\n\n    /**\n     * default 1\n     * @type {number}\n     * @memberof FiatApiGetFiatPaymentsHistory\n     */\n    readonly page?: number;\n\n    /**\n     * default 100, max 500\n     * @type {number}\n     * @memberof FiatApiGetFiatPaymentsHistory\n     */\n    readonly rows?: number;\n\n    /**\n     *\n     * @type {number}\n     * @memberof FiatApiGetFiatPaymentsHistory\n     */\n    readonly recvWindow?: number;\n}\n\n/**\n * FiatApi - object-oriented interface\n * @class FiatApi\n */\nexport class FiatApi implements FiatApiInterface {\n    private readonly configuration: ConfigurationRestAPI;\n    private localVarAxiosParamCreator;\n\n    constructor(configuration: ConfigurationRestAPI) {\n        this.configuration = configuration;\n        this.localVarAxiosParamCreator = FiatApiAxiosParamCreator(configuration);\n    }\n\n    /**\n     * Get Fiat Deposit/Withdraw History\n     *\n     * If beginTime and endTime are not sent, the recent 30-day data will be returned.\n     *\n     * Weight: 90000\n     *\n     * @summary Get Fiat Deposit/Withdraw History (USER_DATA)\n     * @param {GetFiatDepositWithdrawHistoryRequest} requestParameters Request parameters.\n     * @returns {Promise<RestApiResponse<GetFiatDepositWithdrawHistoryResponse>>}\n     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}\n     * @memberof FiatApi\n     * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Deposit-Withdraw-History Binance API Documentation}\n     */\n    public async getFiatDepositWithdrawHistory(\n        requestParameters: GetFiatDepositWithdrawHistoryRequest\n    ): Promise<RestApiResponse<GetFiatDepositWithdrawHistoryResponse>> {\n        const localVarAxiosArgs =\n            await this.localVarAxiosParamCreator.getFiatDepositWithdrawHistory(\n                requestParameters?.transactionType,\n                requestParameters?.beginTime,\n                requestParameters?.endTime,\n                requestParameters?.page,\n                requestParameters?.rows,\n                requestParameters?.recvWindow\n            );\n        return sendRequest<GetFiatDepositWithdrawHistoryResponse>(\n            this.configuration,\n            localVarAxiosArgs.endpoint,\n            localVarAxiosArgs.method,\n            localVarAxiosArgs.params,\n            localVarAxiosArgs?.timeUnit,\n            { isSigned: true }\n        );\n    }\n\n    /**\n     * Get Fiat Deposit/Withdraw History\n     *\n     * If beginTime and endTime are not sent, the recent 30-day data will be returned.\n     * paymentMethod: Only when requesting payments history for buy (transactionType=0), response contains paymentMethod representing the way of purchase. Now we have:\n     * Cash Balance\n     * Credit Card\n     * Online Banking\n     * Bank Transfer\n     *\n     * Weight: 1\n     *\n     * @summary Get Fiat Payments History (USER_DATA)\n     * @param {GetFiatPaymentsHistoryRequest} requestParameters Request parameters.\n     * @returns {Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>}\n     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}\n     * @memberof FiatApi\n     * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Payments-History Binance API Documentation}\n     */\n    public async getFiatPaymentsHistory(\n        requestParameters: GetFiatPaymentsHistoryRequest\n    ): Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>> {\n        const localVarAxiosArgs = await this.localVarAxiosParamCreator.getFiatPaymentsHistory(\n            requestParameters?.transactionType,\n            requestParameters?.beginTime,\n            requestParameters?.endTime,\n            requestParameters?.page,\n            requestParameters?.rows,\n            requestParameters?.recvWindow\n        );\n        return sendRequest<GetFiatPaymentsHistoryResponse>(\n            this.configuration,\n            localVarAxiosArgs.endpoint,\n            localVarAxiosArgs.method,\n            localVarAxiosArgs.params,\n            localVarAxiosArgs?.timeUnit,\n            { isSigned: true }\n        );\n    }\n}\n","/**\n * Binance Public Fiat REST API\n *\n * OpenAPI Specification for the Binance Public Fiat REST API\n *\n * The version of the OpenAPI document: 1.0.0\n *\n *\n * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).\n * https://openapi-generator.tech\n * Do not edit the class manually.\n */\n\nimport { ConfigurationRestAPI, RestApiResponse, sendRequest } from '@binance/common';\nimport { FiatApi } from './modules/fiat-api';\n\nimport type {\n    GetFiatDepositWithdrawHistoryRequest,\n    GetFiatPaymentsHistoryRequest,\n} from './modules/fiat-api';\n\nimport type {\n    GetFiatDepositWithdrawHistoryResponse,\n    GetFiatPaymentsHistoryResponse,\n} from './types';\n\nexport class RestAPI {\n    private configuration: ConfigurationRestAPI;\n    private fiatApi: FiatApi;\n\n    constructor(configuration: ConfigurationRestAPI) {\n        this.configuration = configuration;\n        this.fiatApi = new FiatApi(configuration);\n    }\n\n    /**\n     * Generic function to send a request.\n     * @param endpoint - The API endpoint to call.\n     * @param method - HTTP method to use (GET, POST, DELETE, etc.).\n     * @param params - Query parameters for the request.\n     *\n     * @returns A promise resolving to the response data object.\n     */\n    sendRequest<T>(\n        endpoint: string,\n        method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH',\n        params: Record<string, unknown> = {}\n    ): Promise<RestApiResponse<T>> {\n        return sendRequest<T>(this.configuration, endpoint, method, params, undefined);\n    }\n\n    /**\n     * Generic function to send a signed request.\n     * @param endpoint - The API endpoint to call.\n     * @param method - HTTP method to use (GET, POST, DELETE, etc.).\n     * @param params - Query parameters for the request.\n     *\n     * @returns A promise resolving to the response data object.\n     */\n    sendSignedRequest<T>(\n        endpoint: string,\n        method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH',\n        params: Record<string, unknown> = {}\n    ): Promise<RestApiResponse<T>> {\n        return sendRequest<T>(this.configuration, endpoint, method, params, undefined, {\n            isSigned: true,\n        });\n    }\n\n    /**\n     * Get Fiat Deposit/Withdraw History\n     *\n     * If beginTime and endTime are not sent, the recent 30-day data will be returned.\n     *\n     * Weight: 90000\n     *\n     * @summary Get Fiat Deposit/Withdraw History (USER_DATA)\n     * @param {GetFiatDepositWithdrawHistoryRequest} requestParameters Request parameters.\n     * @returns {Promise<RestApiResponse<GetFiatDepositWithdrawHistoryResponse>>}\n     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}\n     * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Deposit-Withdraw-History Binance API Documentation}\n     */\n    getFiatDepositWithdrawHistory(\n        requestParameters: GetFiatDepositWithdrawHistoryRequest\n    ): Promise<RestApiResponse<GetFiatDepositWithdrawHistoryResponse>> {\n        return this.fiatApi.getFiatDepositWithdrawHistory(requestParameters);\n    }\n\n    /**\n     * Get Fiat Deposit/Withdraw History\n     *\n     * If beginTime and endTime are not sent, the recent 30-day data will be returned.\n     * paymentMethod: Only when requesting payments history for buy (transactionType=0), response contains paymentMethod representing the way of purchase. Now we have:\n     * Cash Balance\n     * Credit Card\n     * Online Banking\n     * Bank Transfer\n     *\n     * Weight: 1\n     *\n     * @summary Get Fiat Payments History (USER_DATA)\n     * @param {GetFiatPaymentsHistoryRequest} requestParameters Request parameters.\n     * @returns {Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>>}\n     * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}\n     * @see {@link https://developers.binance.com/docs/fiat/rest-api/Get-Fiat-Payments-History Binance API Documentation}\n     */\n    getFiatPaymentsHistory(\n        requestParameters: GetFiatPaymentsHistoryRequest\n    ): Promise<RestApiResponse<GetFiatPaymentsHistoryResponse>> {\n        return this.fiatApi.getFiatPaymentsHistory(requestParameters);\n    }\n}\n","export { Fiat, ConfigurationFiat } from './fiat';\nexport * as FiatRestAPI from './rest-api';\n\nexport {\n    FIAT_REST_API_PROD_URL,\n    FIAT_REST_API_TESTNET_URL,\n    ConnectorClientError,\n    RequiredError,\n    UnauthorizedError,\n    ForbiddenError,\n    TooManyRequestsError,\n    RateLimitBanError,\n    ServerError,\n    NetworkError,\n    NotFoundError,\n    BadRequestError,\n} from '@binance/common';\n"],"mappings":";;;;;;;AAAA,SAAS,UAAU,YAAY;AAC/B,SAAS,wBAAAA,uBAAsB,8BAA8B;;;ACAzD,WAAQ;AAER,cAAW;;;ACHf;AAAA;AAAA;AAAA;AAAA;;;ACaA;AAAA,EAII;AAAA,EACA;AAAA,OAEG;AASP,IAAM,2BAA2B,SAAU,eAAqC;AAC5E,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAkBH,+BAA+B,OAC3B,iBACA,WACA,SACA,MACA,MACA,eACuB;AAEvB,wBAAkB,iCAAiC,mBAAmB,eAAe;AAErF,YAAM,yBAAkD,CAAC;AAEzD,UAAI,oBAAoB,UAAa,oBAAoB,MAAM;AAC3D,+BAAuB,iBAAiB,IAAI;AAAA,MAChD;AAEA,UAAI,cAAc,UAAa,cAAc,MAAM;AAC/C,+BAAuB,WAAW,IAAI;AAAA,MAC1C;AAEA,UAAI,YAAY,UAAa,YAAY,MAAM;AAC3C,+BAAuB,SAAS,IAAI;AAAA,MACxC;AAEA,UAAI,SAAS,UAAa,SAAS,MAAM;AACrC,+BAAuB,MAAM,IAAI;AAAA,MACrC;AAEA,UAAI,SAAS,UAAa,SAAS,MAAM;AACrC,+BAAuB,MAAM,IAAI;AAAA,MACrC;AAEA,UAAI,eAAe,UAAa,eAAe,MAAM;AACjD,+BAAuB,YAAY,IAAI;AAAA,MAC3C;AAEA,UAAI;AACJ,UAAI,cAAc;AAAe,oBAAY,cAAc;AAE3D,aAAO;AAAA,QACH,UAAU;AAAA,QACV,QAAQ;AAAA,QACR,QAAQ;AAAA,QACR,UAAU;AAAA,MACd;AAAA,IACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAuBA,wBAAwB,OACpB,iBACA,WACA,SACA,MACA,MACA,eACuB;AAEvB,wBAAkB,0BAA0B,mBAAmB,eAAe;AAE9E,YAAM,yBAAkD,CAAC;AAEzD,UAAI,oBAAoB,UAAa,oBAAoB,MAAM;AAC3D,+BAAuB,iBAAiB,IAAI;AAAA,MAChD;AAEA,UAAI,cAAc,UAAa,cAAc,MAAM;AAC/C,+BAAuB,WAAW,IAAI;AAAA,MAC1C;AAEA,UAAI,YAAY,UAAa,YAAY,MAAM;AAC3C,+BAAuB,SAAS,IAAI;AAAA,MACxC;AAEA,UAAI,SAAS,UAAa,SAAS,MAAM;AACrC,+BAAuB,MAAM,IAAI;AAAA,MACrC;AAEA,UAAI,SAAS,UAAa,SAAS,MAAM;AACrC,+BAAuB,MAAM,IAAI;AAAA,MACrC;AAEA,UAAI,eAAe,UAAa,eAAe,MAAM;AACjD,+BAAuB,YAAY,IAAI;AAAA,MAC3C;AAEA,UAAI;AACJ,UAAI,cAAc;AAAe,oBAAY,cAAc;AAE3D,aAAO;AAAA,QACH,UAAU;AAAA,QACV,QAAQ;AAAA,QACR,QAAQ;AAAA,QACR,UAAU;AAAA,MACd;AAAA,IACJ;AAAA,EACJ;AACJ;AAkJO,IAAM,UAAN,MAA0C;AAAA,EAI7C,YAAY,eAAqC;AAC7C,SAAK,gBAAgB;AACrB,SAAK,4BAA4B,yBAAyB,aAAa;AAAA,EAC3E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,MAAa,8BACT,mBAC+D;AAC/D,UAAM,oBACF,MAAM,KAAK,0BAA0B;AAAA,MACjC,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,IACvB;AACJ,WAAO;AAAA,MACH,KAAK;AAAA,MACL,kBAAkB;AAAA,MAClB,kBAAkB;AAAA,MAClB,kBAAkB;AAAA,MAClB,mBAAmB;AAAA,MACnB,EAAE,UAAU,KAAK;AAAA,IACrB;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBA,MAAa,uBACT,mBACwD;AACxD,UAAM,oBAAoB,MAAM,KAAK,0BAA0B;AAAA,MAC3D,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,MACnB,mBAAmB;AAAA,IACvB;AACA,WAAO;AAAA,MACH,KAAK;AAAA,MACL,kBAAkB;AAAA,MAClB,kBAAkB;AAAA,MAClB,kBAAkB;AAAA,MAClB,mBAAmB;AAAA,MACnB,EAAE,UAAU,KAAK;AAAA,IACrB;AAAA,EACJ;AACJ;;;AC9XA,SAAgD,eAAAC,oBAAmB;AAa5D,IAAM,UAAN,MAAc;AAAA,EAIjB,YAAY,eAAqC;AAC7C,SAAK,gBAAgB;AACrB,SAAK,UAAU,IAAI,QAAQ,aAAa;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,YACI,UACA,QACA,SAAkC,CAAC,GACR;AAC3B,WAAOC,aAAe,KAAK,eAAe,UAAU,QAAQ,QAAQ,MAAS;AAAA,EACjF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,kBACI,UACA,QACA,SAAkC,CAAC,GACR;AAC3B,WAAOA,aAAe,KAAK,eAAe,UAAU,QAAQ,QAAQ,QAAW;AAAA,MAC3E,UAAU;AAAA,IACd,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,8BACI,mBAC+D;AAC/D,WAAO,KAAK,QAAQ,8BAA8B,iBAAiB;AAAA,EACvE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBA,uBACI,mBACwD;AACxD,WAAO,KAAK,QAAQ,uBAAuB,iBAAiB;AAAA,EAChE;AACJ;;;AJtGO,IAAM,OAAN,MAAW;AAAA,EAGd,YAAY,QAA2B;AACnC,QAAI,QAAQ,sBAAsB;AAC9B,YAAM,gBAAgB,IAAIC,sBAAqB,OAAO,oBAAoB;AAC1E,oBAAc,WAAW,cAAc,YAAY;AACnD,oBAAc,cAAc,cAAc,eAAe,CAAC;AAC1D,oBAAc,YAAY,UAAU;AAAA,QAChC,GAAI,cAAc,YAAY,WAAW,CAAC;AAAA,QAC1C,cAAc,GAAG,IAAI,IAAI,OAAO,aAAa,QAAQ,OAAO,KAAK,SAAS,CAAC,KAAK,KAAK,CAAC;AAAA,MAC1F;AACA,WAAK,UAAU,IAAI,QAAQ,aAAa;AAAA,IAC5C;AAAA,EACJ;AACJ;;;AKrBA;AAAA,EACI,0BAAAC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;","names":["ConfigurationRestAPI","sendRequest","sendRequest","ConfigurationRestAPI","FIAT_REST_API_PROD_URL"]}

package/package.json

@@ -0,0 +1,55 @@
+{
+    "name": "@binance/fiat",
+    "description": "Official Binance Fiat Connector - A lightweight library that provides a convenient interface to Binance's Fiat REST API.",
+    "version": "1.0.0",
+    "main": "./dist/index.js",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts",
+    "scripts": {
+        "prepublishOnly": "npm run build",
+        "build": "tsup",
+        "typecheck": "tsc --noEmit",
+        "clean": "rm -rf dist",
+        "test": "npx jest --maxWorkers=4 --bail",
+        "test:watch": "npx jest --watch",
+        "format": "npx prettier --ignore-path .prettierignore --write .",
+        "lint": "npx eslint '**/*.ts' --fix"
+    },
+    "keywords": [
+        "Binance",
+        "API",
+        "Fiat",
+        "Connector",
+        "REST",
+        "Trading"
+    ],
+    "author": "Binance",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/binance/binance-connector-js.git"
+    },
+    "bugs": {
+        "url": "https://github.com/binance/binance-connector-js/issues"
+    },
+    "homepage": "https://github.com/binance/binance-connector-js#readme",
+    "files": [
+        "dist"
+    ],
+    "devDependencies": {
+        "@types/jest": "^29.5.4",
+        "@types/node": "^20.17.24",
+        "eslint": "8.57.0",
+        "jest": "^29.6.4",
+        "prettier": "^3.3.3",
+        "ts-jest": "^29.1.1",
+        "ts-node": "^10.9.1",
+        "tsup": "^7.2.0",
+        "typescript": "^5.7.2",
+        "typescript-eslint": "^8.24.0"
+    },
+    "dependencies": {
+        "@binance/common": "1.0.0",
+        "axios": "^1.7.4"
+    }
+}