chore(): Cleaned up naming and types

This commit is contained in:
Jerko J
2024-06-19 12:16:07 +02:00
parent 7a4ca13944
commit 6ecc0bd34d
5 changed files with 70 additions and 75 deletions

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{
"name": "bybit-api",
"version": "3.10.6",
"version": "3.10.7",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "bybit-api",
"version": "3.10.6",
"version": "3.10.7",
"license": "MIT",
"dependencies": {
"axios": "^1.6.6",

View File

@@ -89,7 +89,6 @@ import {
GetSubAccountAllApiKeysParamsV5,
GetSubAccountDepositRecordParamsV5,
GetTickersParamsV5,
GetTransactionLogParamsClassicV5,
GetTransactionLogParamsV5,
GetUniversalTransferRecordsParamsV5,
GetVIPMarginDataParamsV5,
@@ -156,15 +155,16 @@ import {
WalletBalanceV5,
WithdrawParamsV5,
WithdrawalRecordV5,
getClassicTransactionLogsParamsV5,
} from './types';
import {
GetExchangeBrokerEarningParamsV5,
getBrokerSubAccountDepositRecords,
GetBrokerSubAccountDepositsV5,
GetExchangeBrokerEarningsParamsV5,
} from './types/request/v5-broker';
import {
ExchangeBrokerAccountInfoV5,
ExchangeBrokerEarningResultV5,
SubAccountDepositRecordV5,
ExchangeBrokerSubAccountDepositRecordV5,
} from './types/response/v5-broker';
import { REST_CLIENT_TYPE_ENUM } from './util';
@@ -937,8 +937,8 @@ export class RestClientV5 extends BaseRestClient {
*
* API key permission: "Contract - Position"
*/
getTransactionLogClassic(
params?: GetTransactionLogParamsClassicV5,
getClassicTransactionLogs(
params?: getClassicTransactionLogsParamsV5,
): Promise<
APIResponseV3WithTime<{ list: TransactionLogV5[]; nextPageCursor: string }>
> {
@@ -1359,7 +1359,7 @@ export class RestClientV5 extends BaseRestClient {
*
* This endpoint is particularly used for kyc=KOR users. When withdraw funds, you need to fill entity id.
*/
getExchangeEntityList(): Promise<
getExchangeEntities(): Promise<
APIResponseV3WithTime<{ vasp: VaspEntityV5[] }>
> {
return this.getPrivate('/v5/asset/withdraw/vasp/list');
@@ -1930,8 +1930,8 @@ export class RestClientV5 extends BaseRestClient {
* begin & end are either entered at the same time or not entered, and latest 7 days data are returned by default
* API rate limit: 10 req / sec
*/
getExchangeBrokerEarning(
params?: GetExchangeBrokerEarningParamsV5,
getExchangeBrokerEarnings(
params?: GetExchangeBrokerEarningsParamsV5,
): Promise<APIResponseV3WithTime<ExchangeBrokerEarningResultV5>> {
return this.getPrivate('/v5/broker/earnings-info', params);
}
@@ -1959,11 +1959,9 @@ export class RestClientV5 extends BaseRestClient {
* TIP
* endTime - startTime should be less than 30 days. Queries for the last 30 days worth of records by default.
*/
getBrokerSubAccountDepositRecords(
params?: getBrokerSubAccountDepositRecords,
): Promise<
getBrokerSubAccountDeposits(params?: GetBrokerSubAccountDepositsV5): Promise<
APIResponseV3WithTime<{
rows: SubAccountDepositRecordV5[];
rows: ExchangeBrokerSubAccountDepositRecordV5[];
nextPageCursor: string;
}>
> {

View File

@@ -48,7 +48,7 @@ export interface SetCollateralCoinParamsV5 {
collateralSwitch: 'ON' | 'OFF';
}
export interface GetTransactionLogParamsClassicV5 {
export interface getClassicTransactionLogsParamsV5 {
currency?: string;
baseCoin?: string;
type?: string;

View File

@@ -1,4 +1,4 @@
export interface GetExchangeBrokerEarningParamsV5 {
export interface GetExchangeBrokerEarningsParamsV5 {
bizType?: 'SPOT' | 'DERIVATIVES' | 'OPTIONS';
begin?: string;
end?: string;
@@ -7,7 +7,7 @@ export interface GetExchangeBrokerEarningParamsV5 {
cursor?: string;
}
export interface getBrokerSubAccountDepositRecords {
export interface GetBrokerSubAccountDepositsV5 {
subMemberId?: string;
coin?: string;
startTime?: number;

View File

@@ -26,8 +26,6 @@ interface EarningDetailV5 {
nextPageCursor: string;
}
export interface ExchangeBrokerAccountInfoV5 {
subAcctQty: string;
maxSubAcctQty: string;
@@ -42,7 +40,7 @@ interface EarningDetailV5 {
ts: string;
}
export interface SubAccountDepositRecordV5 {
export interface ExchangeBrokerSubAccountDepositRecordV5 {
subMemberId: string;
coin: string;
chain: string;
@@ -59,4 +57,3 @@ interface EarningDetailV5 {
batchReleaseLimit: string;
depositType: string;
}