@bluefin-exchange/pro-sdk 0.1.41 → 0.1.48
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/example.js +1 -1
- package/dist/src/api.d.ts +118 -50
- package/dist/src/api.js +127 -97
- package/dist/src/sdk.d.ts +10 -3
- package/dist/src/sdk.js +16 -3
- package/example.ts +6 -2
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +1 -0
- package/src/api.ts +177 -103
- package/src/docs/Account.md +3 -1
- package/src/docs/AccountAuthorizationRequest.md +2 -0
- package/src/docs/AccountDataApi.md +1 -0
- package/src/docs/AuthApi.md +14 -2
- package/src/docs/AuthorizedWallet.md +24 -0
- package/src/docs/OrderType.md +1 -1
- package/src/docs/RewardsApi.md +42 -26
- package/src/docs/TradeApi.md +17 -0
- package/src/docs/UserCampaignRewards.md +2 -0
- package/src/sdk.ts +23 -3
package/dist/example.js
CHANGED
|
@@ -105,7 +105,7 @@ function main() {
|
|
|
105
105
|
// Get market data
|
|
106
106
|
const candleStick = (yield client.exchangeDataApi.getCandlestickData(symbol, index_1.KlineInterval._1m, index_1.CandlePriceType.Oracle)).data;
|
|
107
107
|
logger.info(`Candle stick: ${JSON.stringify(candleStick)}`);
|
|
108
|
-
const rewards = (yield client.rewardsDataApi.getCampaignRewards("TRADE_AND_EARN")).data;
|
|
108
|
+
const rewards = (yield client.rewardsDataApi.getCampaignRewards("TRADE_AND_EARN", suiWallet.toSuiAddress())).data;
|
|
109
109
|
logger.info(`Rewards: ${JSON.stringify(rewards)}`);
|
|
110
110
|
const depth = (yield client.exchangeDataApi.getOrderbookDepth(symbol)).data;
|
|
111
111
|
logger.info(`Depth: ${JSON.stringify(depth)}`);
|
package/dist/src/api.d.ts
CHANGED
|
@@ -140,9 +140,10 @@ export interface Account {
|
|
|
140
140
|
*/
|
|
141
141
|
'positions': Array<Position>;
|
|
142
142
|
/**
|
|
143
|
-
*
|
|
143
|
+
* Deprecated: Replaced with authorizedWallets.
|
|
144
144
|
* @type {Array<string>}
|
|
145
145
|
* @memberof Account
|
|
146
|
+
* @deprecated
|
|
146
147
|
*/
|
|
147
148
|
'authorizedAccounts': Array<string>;
|
|
148
149
|
/**
|
|
@@ -151,6 +152,12 @@ export interface Account {
|
|
|
151
152
|
* @memberof Account
|
|
152
153
|
*/
|
|
153
154
|
'accountAddress': string;
|
|
155
|
+
/**
|
|
156
|
+
* The wallets that are authorized to trade on behalf of the current account.
|
|
157
|
+
* @type {Array<AuthorizedWallet>}
|
|
158
|
+
* @memberof Account
|
|
159
|
+
*/
|
|
160
|
+
'authorizedWallets': Array<AuthorizedWallet>;
|
|
154
161
|
}
|
|
155
162
|
/**
|
|
156
163
|
* Aggregated details about a trade in the account.
|
|
@@ -183,6 +190,12 @@ export interface AccountAuthorizationRequest {
|
|
|
183
190
|
* @memberof AccountAuthorizationRequest
|
|
184
191
|
*/
|
|
185
192
|
'signature': string;
|
|
193
|
+
/**
|
|
194
|
+
* The (optional) alias of the account that is being authorized or deauthorized
|
|
195
|
+
* @type {string}
|
|
196
|
+
* @memberof AccountAuthorizationRequest
|
|
197
|
+
*/
|
|
198
|
+
'alias'?: string;
|
|
186
199
|
}
|
|
187
200
|
/**
|
|
188
201
|
*
|
|
@@ -1504,6 +1517,31 @@ export interface AssetConfig {
|
|
|
1504
1517
|
*/
|
|
1505
1518
|
'marginAvailable': boolean;
|
|
1506
1519
|
}
|
|
1520
|
+
/**
|
|
1521
|
+
*
|
|
1522
|
+
* @export
|
|
1523
|
+
* @interface AuthorizedWallet
|
|
1524
|
+
*/
|
|
1525
|
+
export interface AuthorizedWallet {
|
|
1526
|
+
/**
|
|
1527
|
+
* The address of the authorized wallet.
|
|
1528
|
+
* @type {string}
|
|
1529
|
+
* @memberof AuthorizedWallet
|
|
1530
|
+
*/
|
|
1531
|
+
'address': string;
|
|
1532
|
+
/**
|
|
1533
|
+
* The alias of the authorized wallet.
|
|
1534
|
+
* @type {string}
|
|
1535
|
+
* @memberof AuthorizedWallet
|
|
1536
|
+
*/
|
|
1537
|
+
'alias'?: string;
|
|
1538
|
+
/**
|
|
1539
|
+
* The timestamp in milliseconds when the wallet was authorized.
|
|
1540
|
+
* @type {number}
|
|
1541
|
+
* @memberof AuthorizedWallet
|
|
1542
|
+
*/
|
|
1543
|
+
'authorizedAtMillis': number;
|
|
1544
|
+
}
|
|
1507
1545
|
/**
|
|
1508
1546
|
*
|
|
1509
1547
|
* @export
|
|
@@ -3239,7 +3277,7 @@ export declare const OrderTimeInForce: {
|
|
|
3239
3277
|
};
|
|
3240
3278
|
export type OrderTimeInForce = typeof OrderTimeInForce[keyof typeof OrderTimeInForce];
|
|
3241
3279
|
/**
|
|
3242
|
-
* The type of order.
|
|
3280
|
+
* The type of order. (BANKRUPTCY_LIQUIDATION is deprecated)
|
|
3243
3281
|
* @export
|
|
3244
3282
|
* @enum {string}
|
|
3245
3283
|
*/
|
|
@@ -4423,6 +4461,12 @@ export interface UserCampaignRewards {
|
|
|
4423
4461
|
* @memberof UserCampaignRewards
|
|
4424
4462
|
*/
|
|
4425
4463
|
'WalRewardsE9': string;
|
|
4464
|
+
/**
|
|
4465
|
+
* Total cash rewards earned in the epoch (e9 format).
|
|
4466
|
+
* @type {string}
|
|
4467
|
+
* @memberof UserCampaignRewards
|
|
4468
|
+
*/
|
|
4469
|
+
'CashRewardsE9': string;
|
|
4426
4470
|
/**
|
|
4427
4471
|
* Time in milliseconds for interval start date.
|
|
4428
4472
|
* @type {number}
|
|
@@ -4788,10 +4832,12 @@ export declare const AuthApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
4788
4832
|
* login with token
|
|
4789
4833
|
* @param {string} payloadSignature
|
|
4790
4834
|
* @param {LoginRequest} loginRequest
|
|
4835
|
+
* @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days.
|
|
4836
|
+
* @param {boolean} [readOnly]
|
|
4791
4837
|
* @param {*} [options] Override http request option.
|
|
4792
4838
|
* @throws {RequiredError}
|
|
4793
4839
|
*/
|
|
4794
|
-
authTokenPost: (payloadSignature: string, loginRequest: LoginRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4840
|
+
authTokenPost: (payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4795
4841
|
/**
|
|
4796
4842
|
*
|
|
4797
4843
|
* @param {RefreshTokenRequest} refreshTokenRequest
|
|
@@ -4803,10 +4849,12 @@ export declare const AuthApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
4803
4849
|
* login compatible with BCS payload with intent bytes
|
|
4804
4850
|
* @param {string} payloadSignature
|
|
4805
4851
|
* @param {LoginRequest} loginRequest
|
|
4852
|
+
* @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days.
|
|
4853
|
+
* @param {boolean} [readOnly]
|
|
4806
4854
|
* @param {*} [options] Override http request option.
|
|
4807
4855
|
* @throws {RequiredError}
|
|
4808
4856
|
*/
|
|
4809
|
-
authV2TokenPost: (payloadSignature: string, loginRequest: LoginRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4857
|
+
authV2TokenPost: (payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4810
4858
|
};
|
|
4811
4859
|
/**
|
|
4812
4860
|
* AuthApi - functional programming interface
|
|
@@ -4825,10 +4873,12 @@ export declare const AuthApiFp: (configuration?: Configuration) => {
|
|
|
4825
4873
|
* login with token
|
|
4826
4874
|
* @param {string} payloadSignature
|
|
4827
4875
|
* @param {LoginRequest} loginRequest
|
|
4876
|
+
* @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days.
|
|
4877
|
+
* @param {boolean} [readOnly]
|
|
4828
4878
|
* @param {*} [options] Override http request option.
|
|
4829
4879
|
* @throws {RequiredError}
|
|
4830
4880
|
*/
|
|
4831
|
-
authTokenPost(payloadSignature: string, loginRequest: LoginRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginResponse>>;
|
|
4881
|
+
authTokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginResponse>>;
|
|
4832
4882
|
/**
|
|
4833
4883
|
*
|
|
4834
4884
|
* @param {RefreshTokenRequest} refreshTokenRequest
|
|
@@ -4840,10 +4890,12 @@ export declare const AuthApiFp: (configuration?: Configuration) => {
|
|
|
4840
4890
|
* login compatible with BCS payload with intent bytes
|
|
4841
4891
|
* @param {string} payloadSignature
|
|
4842
4892
|
* @param {LoginRequest} loginRequest
|
|
4893
|
+
* @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days.
|
|
4894
|
+
* @param {boolean} [readOnly]
|
|
4843
4895
|
* @param {*} [options] Override http request option.
|
|
4844
4896
|
* @throws {RequiredError}
|
|
4845
4897
|
*/
|
|
4846
|
-
authV2TokenPost(payloadSignature: string, loginRequest: LoginRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginResponse>>;
|
|
4898
|
+
authV2TokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginResponse>>;
|
|
4847
4899
|
};
|
|
4848
4900
|
/**
|
|
4849
4901
|
* AuthApi - factory interface
|
|
@@ -4862,10 +4914,12 @@ export declare const AuthApiFactory: (configuration?: Configuration, basePath?:
|
|
|
4862
4914
|
* login with token
|
|
4863
4915
|
* @param {string} payloadSignature
|
|
4864
4916
|
* @param {LoginRequest} loginRequest
|
|
4917
|
+
* @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days.
|
|
4918
|
+
* @param {boolean} [readOnly]
|
|
4865
4919
|
* @param {*} [options] Override http request option.
|
|
4866
4920
|
* @throws {RequiredError}
|
|
4867
4921
|
*/
|
|
4868
|
-
authTokenPost(payloadSignature: string, loginRequest: LoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<LoginResponse>;
|
|
4922
|
+
authTokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<LoginResponse>;
|
|
4869
4923
|
/**
|
|
4870
4924
|
*
|
|
4871
4925
|
* @param {RefreshTokenRequest} refreshTokenRequest
|
|
@@ -4877,10 +4931,12 @@ export declare const AuthApiFactory: (configuration?: Configuration, basePath?:
|
|
|
4877
4931
|
* login compatible with BCS payload with intent bytes
|
|
4878
4932
|
* @param {string} payloadSignature
|
|
4879
4933
|
* @param {LoginRequest} loginRequest
|
|
4934
|
+
* @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days.
|
|
4935
|
+
* @param {boolean} [readOnly]
|
|
4880
4936
|
* @param {*} [options] Override http request option.
|
|
4881
4937
|
* @throws {RequiredError}
|
|
4882
4938
|
*/
|
|
4883
|
-
authV2TokenPost(payloadSignature: string, loginRequest: LoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<LoginResponse>;
|
|
4939
|
+
authV2TokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<LoginResponse>;
|
|
4884
4940
|
};
|
|
4885
4941
|
/**
|
|
4886
4942
|
* AuthApi - object-oriented interface
|
|
@@ -4902,11 +4958,13 @@ export declare class AuthApi extends BaseAPI {
|
|
|
4902
4958
|
* login with token
|
|
4903
4959
|
* @param {string} payloadSignature
|
|
4904
4960
|
* @param {LoginRequest} loginRequest
|
|
4961
|
+
* @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days.
|
|
4962
|
+
* @param {boolean} [readOnly]
|
|
4905
4963
|
* @param {*} [options] Override http request option.
|
|
4906
4964
|
* @throws {RequiredError}
|
|
4907
4965
|
* @memberof AuthApi
|
|
4908
4966
|
*/
|
|
4909
|
-
authTokenPost(payloadSignature: string, loginRequest: LoginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LoginResponse, any>>;
|
|
4967
|
+
authTokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LoginResponse, any>>;
|
|
4910
4968
|
/**
|
|
4911
4969
|
*
|
|
4912
4970
|
* @param {RefreshTokenRequest} refreshTokenRequest
|
|
@@ -4919,11 +4977,13 @@ export declare class AuthApi extends BaseAPI {
|
|
|
4919
4977
|
* login compatible with BCS payload with intent bytes
|
|
4920
4978
|
* @param {string} payloadSignature
|
|
4921
4979
|
* @param {LoginRequest} loginRequest
|
|
4980
|
+
* @param {number} [refreshTokenValidForSeconds] The number of seconds the refresh token is valid for. If not provided, the default is 30 days.
|
|
4981
|
+
* @param {boolean} [readOnly]
|
|
4922
4982
|
* @param {*} [options] Override http request option.
|
|
4923
4983
|
* @throws {RequiredError}
|
|
4924
4984
|
* @memberof AuthApi
|
|
4925
4985
|
*/
|
|
4926
|
-
authV2TokenPost(payloadSignature: string, loginRequest: LoginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LoginResponse, any>>;
|
|
4986
|
+
authV2TokenPost(payloadSignature: string, loginRequest: LoginRequest, refreshTokenValidForSeconds?: number, readOnly?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LoginResponse, any>>;
|
|
4927
4987
|
}
|
|
4928
4988
|
/**
|
|
4929
4989
|
* ExchangeApi - axios parameter creator
|
|
@@ -5266,52 +5326,54 @@ export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5266
5326
|
/**
|
|
5267
5327
|
* Returns rankings and earnings for affiliates, sorted by the specified category
|
|
5268
5328
|
* @summary Get affiliate rankings and earnings
|
|
5269
|
-
* @param {GetAffiliateLeaderDashboardSortByEnum} sortBy The category to sort rankings by
|
|
5329
|
+
* @param {GetAffiliateLeaderDashboardSortByEnum} [sortBy] The category to sort rankings by
|
|
5270
5330
|
* @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by
|
|
5271
5331
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5272
5332
|
* @param {number} [limit] The page size for pagination
|
|
5273
|
-
* @param {string} [
|
|
5274
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5333
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5275
5334
|
* @param {*} [options] Override http request option.
|
|
5276
5335
|
* @throws {RequiredError}
|
|
5277
5336
|
*/
|
|
5278
|
-
getAffiliateLeaderDashboard: (sortBy
|
|
5337
|
+
getAffiliateLeaderDashboard: (sortBy?: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5279
5338
|
/**
|
|
5280
5339
|
* Returns the affiliate metadata
|
|
5281
5340
|
* @summary Get affiliate metadata
|
|
5341
|
+
* @param {string} userAddress Specify wallet address.
|
|
5282
5342
|
* @param {*} [options] Override http request option.
|
|
5283
5343
|
* @throws {RequiredError}
|
|
5284
5344
|
*/
|
|
5285
|
-
getAffiliateMetadata: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5345
|
+
getAffiliateMetadata: (userAddress: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5286
5346
|
/**
|
|
5287
5347
|
* Returns detailed earnings breakdown for an affiliate users earnings (including perps, spot LP, lending), referral earnings, and total earnings
|
|
5288
5348
|
* @summary Get detailed affiliate earnings overview
|
|
5349
|
+
* @param {string} userAddress Specify wallet address.
|
|
5289
5350
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5290
5351
|
* @param {number} [limit] The page size for pagination
|
|
5291
5352
|
* @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
|
|
5292
5353
|
* @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
|
|
5293
|
-
* @param {string} [
|
|
5294
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5354
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5295
5355
|
* @param {*} [options] Override http request option.
|
|
5296
5356
|
* @throws {RequiredError}
|
|
5297
5357
|
*/
|
|
5298
|
-
getAffiliateOverview: (page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum,
|
|
5358
|
+
getAffiliateOverview: (userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5299
5359
|
/**
|
|
5300
5360
|
* Returns performance summary for an affiliate including total referrals, earnings, and rankings
|
|
5301
5361
|
* @summary Get affiliate performance summary
|
|
5362
|
+
* @param {string} userAddress Specify wallet address.
|
|
5302
5363
|
* @param {*} [options] Override http request option.
|
|
5303
5364
|
* @throws {RequiredError}
|
|
5304
5365
|
*/
|
|
5305
|
-
getAffiliateSummary: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5366
|
+
getAffiliateSummary: (userAddress: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5306
5367
|
/**
|
|
5307
5368
|
* Returns the rewards earned by users for a specific campaign
|
|
5308
5369
|
* @summary Get rewards information for a specific campaign
|
|
5309
5370
|
* @param {string} campaignName Specify the campaign name
|
|
5371
|
+
* @param {string} userAddress Specify wallet address.
|
|
5310
5372
|
* @param {number} [epochNumber] Optionally specify epoch number.
|
|
5311
5373
|
* @param {*} [options] Override http request option.
|
|
5312
5374
|
* @throws {RequiredError}
|
|
5313
5375
|
*/
|
|
5314
|
-
getCampaignRewards: (campaignName: string, epochNumber?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5376
|
+
getCampaignRewards: (campaignName: string, userAddress: string, epochNumber?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5315
5377
|
/**
|
|
5316
5378
|
* Returns the rewards earned by users for the intervals .
|
|
5317
5379
|
* @summary Get rewards information for the intervals
|
|
@@ -5403,52 +5465,54 @@ export declare const RewardsApiFp: (configuration?: Configuration) => {
|
|
|
5403
5465
|
/**
|
|
5404
5466
|
* Returns rankings and earnings for affiliates, sorted by the specified category
|
|
5405
5467
|
* @summary Get affiliate rankings and earnings
|
|
5406
|
-
* @param {GetAffiliateLeaderDashboardSortByEnum} sortBy The category to sort rankings by
|
|
5468
|
+
* @param {GetAffiliateLeaderDashboardSortByEnum} [sortBy] The category to sort rankings by
|
|
5407
5469
|
* @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by
|
|
5408
5470
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5409
5471
|
* @param {number} [limit] The page size for pagination
|
|
5410
|
-
* @param {string} [
|
|
5411
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5472
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5412
5473
|
* @param {*} [options] Override http request option.
|
|
5413
5474
|
* @throws {RequiredError}
|
|
5414
5475
|
*/
|
|
5415
|
-
getAffiliateLeaderDashboard(sortBy
|
|
5476
|
+
getAffiliateLeaderDashboard(sortBy?: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAffiliateLeaderDashboard200Response>>;
|
|
5416
5477
|
/**
|
|
5417
5478
|
* Returns the affiliate metadata
|
|
5418
5479
|
* @summary Get affiliate metadata
|
|
5480
|
+
* @param {string} userAddress Specify wallet address.
|
|
5419
5481
|
* @param {*} [options] Override http request option.
|
|
5420
5482
|
* @throws {RequiredError}
|
|
5421
5483
|
*/
|
|
5422
|
-
getAffiliateMetadata(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AffiliateMetadata>>;
|
|
5484
|
+
getAffiliateMetadata(userAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AffiliateMetadata>>;
|
|
5423
5485
|
/**
|
|
5424
5486
|
* Returns detailed earnings breakdown for an affiliate users earnings (including perps, spot LP, lending), referral earnings, and total earnings
|
|
5425
5487
|
* @summary Get detailed affiliate earnings overview
|
|
5488
|
+
* @param {string} userAddress Specify wallet address.
|
|
5426
5489
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5427
5490
|
* @param {number} [limit] The page size for pagination
|
|
5428
5491
|
* @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
|
|
5429
5492
|
* @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
|
|
5430
|
-
* @param {string} [
|
|
5431
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5493
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5432
5494
|
* @param {*} [options] Override http request option.
|
|
5433
5495
|
* @throws {RequiredError}
|
|
5434
5496
|
*/
|
|
5435
|
-
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum,
|
|
5497
|
+
getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAffiliateOverview200Response>>;
|
|
5436
5498
|
/**
|
|
5437
5499
|
* Returns performance summary for an affiliate including total referrals, earnings, and rankings
|
|
5438
5500
|
* @summary Get affiliate performance summary
|
|
5501
|
+
* @param {string} userAddress Specify wallet address.
|
|
5439
5502
|
* @param {*} [options] Override http request option.
|
|
5440
5503
|
* @throws {RequiredError}
|
|
5441
5504
|
*/
|
|
5442
|
-
getAffiliateSummary(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AffiliateSummary>>;
|
|
5505
|
+
getAffiliateSummary(userAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AffiliateSummary>>;
|
|
5443
5506
|
/**
|
|
5444
5507
|
* Returns the rewards earned by users for a specific campaign
|
|
5445
5508
|
* @summary Get rewards information for a specific campaign
|
|
5446
5509
|
* @param {string} campaignName Specify the campaign name
|
|
5510
|
+
* @param {string} userAddress Specify wallet address.
|
|
5447
5511
|
* @param {number} [epochNumber] Optionally specify epoch number.
|
|
5448
5512
|
* @param {*} [options] Override http request option.
|
|
5449
5513
|
* @throws {RequiredError}
|
|
5450
5514
|
*/
|
|
5451
|
-
getCampaignRewards(campaignName: string, epochNumber?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserCampaignRewards>>>;
|
|
5515
|
+
getCampaignRewards(campaignName: string, userAddress: string, epochNumber?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserCampaignRewards>>>;
|
|
5452
5516
|
/**
|
|
5453
5517
|
* Returns the rewards earned by users for the intervals .
|
|
5454
5518
|
* @summary Get rewards information for the intervals
|
|
@@ -5540,52 +5604,54 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
5540
5604
|
/**
|
|
5541
5605
|
* Returns rankings and earnings for affiliates, sorted by the specified category
|
|
5542
5606
|
* @summary Get affiliate rankings and earnings
|
|
5543
|
-
* @param {GetAffiliateLeaderDashboardSortByEnum} sortBy The category to sort rankings by
|
|
5607
|
+
* @param {GetAffiliateLeaderDashboardSortByEnum} [sortBy] The category to sort rankings by
|
|
5544
5608
|
* @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by
|
|
5545
5609
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5546
5610
|
* @param {number} [limit] The page size for pagination
|
|
5547
|
-
* @param {string} [
|
|
5548
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5611
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5549
5612
|
* @param {*} [options] Override http request option.
|
|
5550
5613
|
* @throws {RequiredError}
|
|
5551
5614
|
*/
|
|
5552
|
-
getAffiliateLeaderDashboard(sortBy
|
|
5615
|
+
getAffiliateLeaderDashboard(sortBy?: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAffiliateLeaderDashboard200Response>;
|
|
5553
5616
|
/**
|
|
5554
5617
|
* Returns the affiliate metadata
|
|
5555
5618
|
* @summary Get affiliate metadata
|
|
5619
|
+
* @param {string} userAddress Specify wallet address.
|
|
5556
5620
|
* @param {*} [options] Override http request option.
|
|
5557
5621
|
* @throws {RequiredError}
|
|
5558
5622
|
*/
|
|
5559
|
-
getAffiliateMetadata(options?: RawAxiosRequestConfig): AxiosPromise<AffiliateMetadata>;
|
|
5623
|
+
getAffiliateMetadata(userAddress: string, options?: RawAxiosRequestConfig): AxiosPromise<AffiliateMetadata>;
|
|
5560
5624
|
/**
|
|
5561
5625
|
* Returns detailed earnings breakdown for an affiliate users earnings (including perps, spot LP, lending), referral earnings, and total earnings
|
|
5562
5626
|
* @summary Get detailed affiliate earnings overview
|
|
5627
|
+
* @param {string} userAddress Specify wallet address.
|
|
5563
5628
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5564
5629
|
* @param {number} [limit] The page size for pagination
|
|
5565
5630
|
* @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
|
|
5566
5631
|
* @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
|
|
5567
|
-
* @param {string} [
|
|
5568
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5632
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5569
5633
|
* @param {*} [options] Override http request option.
|
|
5570
5634
|
* @throws {RequiredError}
|
|
5571
5635
|
*/
|
|
5572
|
-
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum,
|
|
5636
|
+
getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAffiliateOverview200Response>;
|
|
5573
5637
|
/**
|
|
5574
5638
|
* Returns performance summary for an affiliate including total referrals, earnings, and rankings
|
|
5575
5639
|
* @summary Get affiliate performance summary
|
|
5640
|
+
* @param {string} userAddress Specify wallet address.
|
|
5576
5641
|
* @param {*} [options] Override http request option.
|
|
5577
5642
|
* @throws {RequiredError}
|
|
5578
5643
|
*/
|
|
5579
|
-
getAffiliateSummary(options?: RawAxiosRequestConfig): AxiosPromise<AffiliateSummary>;
|
|
5644
|
+
getAffiliateSummary(userAddress: string, options?: RawAxiosRequestConfig): AxiosPromise<AffiliateSummary>;
|
|
5580
5645
|
/**
|
|
5581
5646
|
* Returns the rewards earned by users for a specific campaign
|
|
5582
5647
|
* @summary Get rewards information for a specific campaign
|
|
5583
5648
|
* @param {string} campaignName Specify the campaign name
|
|
5649
|
+
* @param {string} userAddress Specify wallet address.
|
|
5584
5650
|
* @param {number} [epochNumber] Optionally specify epoch number.
|
|
5585
5651
|
* @param {*} [options] Override http request option.
|
|
5586
5652
|
* @throws {RequiredError}
|
|
5587
5653
|
*/
|
|
5588
|
-
getCampaignRewards(campaignName: string, epochNumber?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserCampaignRewards>>;
|
|
5654
|
+
getCampaignRewards(campaignName: string, userAddress: string, epochNumber?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserCampaignRewards>>;
|
|
5589
5655
|
/**
|
|
5590
5656
|
* Returns the rewards earned by users for the intervals .
|
|
5591
5657
|
* @summary Get rewards information for the intervals
|
|
@@ -5680,57 +5746,59 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
5680
5746
|
/**
|
|
5681
5747
|
* Returns rankings and earnings for affiliates, sorted by the specified category
|
|
5682
5748
|
* @summary Get affiliate rankings and earnings
|
|
5683
|
-
* @param {GetAffiliateLeaderDashboardSortByEnum} sortBy The category to sort rankings by
|
|
5749
|
+
* @param {GetAffiliateLeaderDashboardSortByEnum} [sortBy] The category to sort rankings by
|
|
5684
5750
|
* @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by
|
|
5685
5751
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5686
5752
|
* @param {number} [limit] The page size for pagination
|
|
5687
|
-
* @param {string} [
|
|
5688
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5753
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5689
5754
|
* @param {*} [options] Override http request option.
|
|
5690
5755
|
* @throws {RequiredError}
|
|
5691
5756
|
* @memberof RewardsApi
|
|
5692
5757
|
*/
|
|
5693
|
-
getAffiliateLeaderDashboard(sortBy
|
|
5758
|
+
getAffiliateLeaderDashboard(sortBy?: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAffiliateLeaderDashboard200Response, any>>;
|
|
5694
5759
|
/**
|
|
5695
5760
|
* Returns the affiliate metadata
|
|
5696
5761
|
* @summary Get affiliate metadata
|
|
5762
|
+
* @param {string} userAddress Specify wallet address.
|
|
5697
5763
|
* @param {*} [options] Override http request option.
|
|
5698
5764
|
* @throws {RequiredError}
|
|
5699
5765
|
* @memberof RewardsApi
|
|
5700
5766
|
*/
|
|
5701
|
-
getAffiliateMetadata(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AffiliateMetadata, any>>;
|
|
5767
|
+
getAffiliateMetadata(userAddress: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AffiliateMetadata, any>>;
|
|
5702
5768
|
/**
|
|
5703
5769
|
* Returns detailed earnings breakdown for an affiliate users earnings (including perps, spot LP, lending), referral earnings, and total earnings
|
|
5704
5770
|
* @summary Get detailed affiliate earnings overview
|
|
5771
|
+
* @param {string} userAddress Specify wallet address.
|
|
5705
5772
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5706
5773
|
* @param {number} [limit] The page size for pagination
|
|
5707
5774
|
* @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
|
|
5708
5775
|
* @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
|
|
5709
|
-
* @param {string} [
|
|
5710
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5776
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5711
5777
|
* @param {*} [options] Override http request option.
|
|
5712
5778
|
* @throws {RequiredError}
|
|
5713
5779
|
* @memberof RewardsApi
|
|
5714
5780
|
*/
|
|
5715
|
-
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum,
|
|
5781
|
+
getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAffiliateOverview200Response, any>>;
|
|
5716
5782
|
/**
|
|
5717
5783
|
* Returns performance summary for an affiliate including total referrals, earnings, and rankings
|
|
5718
5784
|
* @summary Get affiliate performance summary
|
|
5785
|
+
* @param {string} userAddress Specify wallet address.
|
|
5719
5786
|
* @param {*} [options] Override http request option.
|
|
5720
5787
|
* @throws {RequiredError}
|
|
5721
5788
|
* @memberof RewardsApi
|
|
5722
5789
|
*/
|
|
5723
|
-
getAffiliateSummary(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AffiliateSummary, any>>;
|
|
5790
|
+
getAffiliateSummary(userAddress: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AffiliateSummary, any>>;
|
|
5724
5791
|
/**
|
|
5725
5792
|
* Returns the rewards earned by users for a specific campaign
|
|
5726
5793
|
* @summary Get rewards information for a specific campaign
|
|
5727
5794
|
* @param {string} campaignName Specify the campaign name
|
|
5795
|
+
* @param {string} userAddress Specify wallet address.
|
|
5728
5796
|
* @param {number} [epochNumber] Optionally specify epoch number.
|
|
5729
5797
|
* @param {*} [options] Override http request option.
|
|
5730
5798
|
* @throws {RequiredError}
|
|
5731
5799
|
* @memberof RewardsApi
|
|
5732
5800
|
*/
|
|
5733
|
-
getCampaignRewards(campaignName: string, epochNumber?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserCampaignRewards[], any>>;
|
|
5801
|
+
getCampaignRewards(campaignName: string, userAddress: string, epochNumber?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserCampaignRewards[], any>>;
|
|
5734
5802
|
/**
|
|
5735
5803
|
* Returns the rewards earned by users for the intervals .
|
|
5736
5804
|
* @summary Get rewards information for the intervals
|