@bluefin-exchange/pro-sdk 0.1.39 → 0.1.41
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/src/api.d.ts +120 -96
- package/dist/src/api.js +46 -15
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +1 -1
- package/src/api.ts +138 -102
- package/src/docs/AffiliateIntervalOverview.md +24 -24
- package/src/docs/AffiliateLeaderDashboard.md +6 -6
- package/src/docs/AffiliateMetadata.md +1 -1
- package/src/docs/AffiliateOverview.md +24 -24
- package/src/docs/AffiliateSummary.md +2 -2
- package/src/docs/EpochConfigs.md +6 -6
- package/src/docs/FeeConfigs.md +31 -0
- package/src/docs/IntervalRewards.md +6 -6
- package/src/docs/RewardsApi.md +8 -1
- package/src/docs/RewardsSummary.md +6 -6
- package/src/docs/UpdateAffiliateFeeConfigRequest.md +1 -1
- package/src/docs/UserCampaignRewards.md +6 -6
package/dist/src/api.d.ts
CHANGED
|
@@ -1062,73 +1062,73 @@ export interface AffiliateIntervalOverview {
|
|
|
1062
1062
|
* @type {string}
|
|
1063
1063
|
* @memberof AffiliateIntervalOverview
|
|
1064
1064
|
*/
|
|
1065
|
-
'
|
|
1065
|
+
'perpsRefereeEarningsE9': string;
|
|
1066
1066
|
/**
|
|
1067
1067
|
* Referee earnings from spot LP (e9 format)
|
|
1068
1068
|
* @type {string}
|
|
1069
1069
|
* @memberof AffiliateIntervalOverview
|
|
1070
1070
|
*/
|
|
1071
|
-
'
|
|
1071
|
+
'spotLPRefereeEarningsE9': string;
|
|
1072
1072
|
/**
|
|
1073
1073
|
* Referee earnings from lending (e9 format)
|
|
1074
1074
|
* @type {string}
|
|
1075
1075
|
* @memberof AffiliateIntervalOverview
|
|
1076
1076
|
*/
|
|
1077
|
-
'
|
|
1077
|
+
'lendingRefereeEarningsE9': string;
|
|
1078
1078
|
/**
|
|
1079
1079
|
* Referral earnings from perps trading (e9 format)
|
|
1080
1080
|
* @type {string}
|
|
1081
1081
|
* @memberof AffiliateIntervalOverview
|
|
1082
1082
|
*/
|
|
1083
|
-
'
|
|
1083
|
+
'perpsReferralEarningsE9': string;
|
|
1084
1084
|
/**
|
|
1085
1085
|
* Referral earnings from spot LP (e9 format)
|
|
1086
1086
|
* @type {string}
|
|
1087
1087
|
* @memberof AffiliateIntervalOverview
|
|
1088
1088
|
*/
|
|
1089
|
-
'
|
|
1089
|
+
'spotLPReferralEarningsE9': string;
|
|
1090
1090
|
/**
|
|
1091
1091
|
* Referral earnings from lending (e9 format)
|
|
1092
1092
|
* @type {string}
|
|
1093
1093
|
* @memberof AffiliateIntervalOverview
|
|
1094
1094
|
*/
|
|
1095
|
-
'
|
|
1095
|
+
'lendingReferralEarningsE9': string;
|
|
1096
1096
|
/**
|
|
1097
1097
|
* Total earnings from perps trading (e9 format)
|
|
1098
1098
|
* @type {string}
|
|
1099
1099
|
* @memberof AffiliateIntervalOverview
|
|
1100
1100
|
*/
|
|
1101
|
-
'
|
|
1101
|
+
'perpsTotalEarningsE9': string;
|
|
1102
1102
|
/**
|
|
1103
1103
|
* Total earnings from spot LP (e9 format)
|
|
1104
1104
|
* @type {string}
|
|
1105
1105
|
* @memberof AffiliateIntervalOverview
|
|
1106
1106
|
*/
|
|
1107
|
-
'
|
|
1107
|
+
'spotLPTotalEarningsE9': string;
|
|
1108
1108
|
/**
|
|
1109
1109
|
* Total earnings from lending (e9 format)
|
|
1110
1110
|
* @type {string}
|
|
1111
1111
|
* @memberof AffiliateIntervalOverview
|
|
1112
1112
|
*/
|
|
1113
|
-
'
|
|
1113
|
+
'lendingTotalEarningsE9': string;
|
|
1114
1114
|
/**
|
|
1115
1115
|
* Total earnings from referrals (e9 format)
|
|
1116
1116
|
* @type {string}
|
|
1117
1117
|
* @memberof AffiliateIntervalOverview
|
|
1118
1118
|
*/
|
|
1119
|
-
'
|
|
1119
|
+
'totalReferralEarningsE9': string;
|
|
1120
1120
|
/**
|
|
1121
1121
|
* Total earnings from referee activities (e9 format)
|
|
1122
1122
|
* @type {string}
|
|
1123
1123
|
* @memberof AffiliateIntervalOverview
|
|
1124
1124
|
*/
|
|
1125
|
-
'
|
|
1125
|
+
'totalRefereeEarningsE9': string;
|
|
1126
1126
|
/**
|
|
1127
1127
|
* Total earnings combining referrals and referee activities (e9 format)
|
|
1128
1128
|
* @type {string}
|
|
1129
1129
|
* @memberof AffiliateIntervalOverview
|
|
1130
1130
|
*/
|
|
1131
|
-
'
|
|
1131
|
+
'totalEarningsE9': string;
|
|
1132
1132
|
}
|
|
1133
1133
|
/**
|
|
1134
1134
|
*
|
|
@@ -1183,19 +1183,19 @@ export interface AffiliateLeaderDashboard {
|
|
|
1183
1183
|
* @type {string}
|
|
1184
1184
|
* @memberof AffiliateLeaderDashboard
|
|
1185
1185
|
*/
|
|
1186
|
-
'
|
|
1186
|
+
'perpsTotalEarningsE9': string;
|
|
1187
1187
|
/**
|
|
1188
1188
|
* Total earnings from spot trading (e9 format)
|
|
1189
1189
|
* @type {string}
|
|
1190
1190
|
* @memberof AffiliateLeaderDashboard
|
|
1191
1191
|
*/
|
|
1192
|
-
'
|
|
1192
|
+
'spotTotalEarningsE9': string;
|
|
1193
1193
|
/**
|
|
1194
1194
|
* Total earnings from lending (e9 format)
|
|
1195
1195
|
* @type {string}
|
|
1196
1196
|
* @memberof AffiliateLeaderDashboard
|
|
1197
1197
|
*/
|
|
1198
|
-
'
|
|
1198
|
+
'lendingTotalEarningsE9': string;
|
|
1199
1199
|
}
|
|
1200
1200
|
/**
|
|
1201
1201
|
*
|
|
@@ -1235,10 +1235,10 @@ export interface AffiliateMetadata {
|
|
|
1235
1235
|
'parentName'?: string | null;
|
|
1236
1236
|
/**
|
|
1237
1237
|
*
|
|
1238
|
-
* @type {
|
|
1238
|
+
* @type {FeeConfigs}
|
|
1239
1239
|
* @memberof AffiliateMetadata
|
|
1240
1240
|
*/
|
|
1241
|
-
'fees'?:
|
|
1241
|
+
'fees'?: FeeConfigs;
|
|
1242
1242
|
/**
|
|
1243
1243
|
* Status of the affiliate application
|
|
1244
1244
|
* @type {string}
|
|
@@ -1271,49 +1271,6 @@ export declare const AffiliateMetadataTierEnum: {
|
|
|
1271
1271
|
readonly U: "U";
|
|
1272
1272
|
};
|
|
1273
1273
|
export type AffiliateMetadataTierEnum = typeof AffiliateMetadataTierEnum[keyof typeof AffiliateMetadataTierEnum];
|
|
1274
|
-
/**
|
|
1275
|
-
* Map of various fee-related configurations
|
|
1276
|
-
* @export
|
|
1277
|
-
* @interface AffiliateMetadataFees
|
|
1278
|
-
*/
|
|
1279
|
-
export interface AffiliateMetadataFees {
|
|
1280
|
-
/**
|
|
1281
|
-
* Earnings from referral perps fees (e9 format)
|
|
1282
|
-
* @type {string}
|
|
1283
|
-
* @memberof AffiliateMetadataFees
|
|
1284
|
-
*/
|
|
1285
|
-
'referralPerpsFee'?: string;
|
|
1286
|
-
/**
|
|
1287
|
-
* Earnings from subaffiliate perps (e9 format)
|
|
1288
|
-
* @type {string}
|
|
1289
|
-
* @memberof AffiliateMetadataFees
|
|
1290
|
-
*/
|
|
1291
|
-
'subaffiliatePerpsEarnings'?: string;
|
|
1292
|
-
/**
|
|
1293
|
-
* Earnings from spot LP fees (e9 format)
|
|
1294
|
-
* @type {string}
|
|
1295
|
-
* @memberof AffiliateMetadataFees
|
|
1296
|
-
*/
|
|
1297
|
-
'spotLPFee'?: string;
|
|
1298
|
-
/**
|
|
1299
|
-
* Earnings from referral spot LP fees (e9 format)
|
|
1300
|
-
* @type {string}
|
|
1301
|
-
* @memberof AffiliateMetadataFees
|
|
1302
|
-
*/
|
|
1303
|
-
'referralSpotLPFee'?: string;
|
|
1304
|
-
/**
|
|
1305
|
-
* Earnings from referral lending rewards (e9 format)
|
|
1306
|
-
* @type {string}
|
|
1307
|
-
* @memberof AffiliateMetadataFees
|
|
1308
|
-
*/
|
|
1309
|
-
'referralLendingRewards'?: string;
|
|
1310
|
-
/**
|
|
1311
|
-
* Cashback from perps fees (e9 format)
|
|
1312
|
-
* @type {string}
|
|
1313
|
-
* @memberof AffiliateMetadataFees
|
|
1314
|
-
*/
|
|
1315
|
-
'perpsFeeCashback'?: string;
|
|
1316
|
-
}
|
|
1317
1274
|
/**
|
|
1318
1275
|
*
|
|
1319
1276
|
* @export
|
|
@@ -1362,73 +1319,73 @@ export interface AffiliateOverview {
|
|
|
1362
1319
|
* @type {string}
|
|
1363
1320
|
* @memberof AffiliateOverview
|
|
1364
1321
|
*/
|
|
1365
|
-
'
|
|
1322
|
+
'perpsRefereeEarningsE9': string;
|
|
1366
1323
|
/**
|
|
1367
1324
|
* Referee earnings from spot LP (e9 format)
|
|
1368
1325
|
* @type {string}
|
|
1369
1326
|
* @memberof AffiliateOverview
|
|
1370
1327
|
*/
|
|
1371
|
-
'
|
|
1328
|
+
'spotLPRefereeEarningsE9': string;
|
|
1372
1329
|
/**
|
|
1373
1330
|
* Referee earnings from lending (e9 format)
|
|
1374
1331
|
* @type {string}
|
|
1375
1332
|
* @memberof AffiliateOverview
|
|
1376
1333
|
*/
|
|
1377
|
-
'
|
|
1334
|
+
'lendingRefereeEarningsE9': string;
|
|
1378
1335
|
/**
|
|
1379
1336
|
* Referral earnings from perps trading (e9 format)
|
|
1380
1337
|
* @type {string}
|
|
1381
1338
|
* @memberof AffiliateOverview
|
|
1382
1339
|
*/
|
|
1383
|
-
'
|
|
1340
|
+
'perpsReferralEarningsE9': string;
|
|
1384
1341
|
/**
|
|
1385
1342
|
* Referral earnings from spot LP (e9 format)
|
|
1386
1343
|
* @type {string}
|
|
1387
1344
|
* @memberof AffiliateOverview
|
|
1388
1345
|
*/
|
|
1389
|
-
'
|
|
1346
|
+
'spotLPReferralEarningsE9': string;
|
|
1390
1347
|
/**
|
|
1391
1348
|
* Referral earnings from lending (e9 format)
|
|
1392
1349
|
* @type {string}
|
|
1393
1350
|
* @memberof AffiliateOverview
|
|
1394
1351
|
*/
|
|
1395
|
-
'
|
|
1352
|
+
'lendingReferralEarningsE9': string;
|
|
1396
1353
|
/**
|
|
1397
1354
|
* Total earnings from perps trading (e9 format)
|
|
1398
1355
|
* @type {string}
|
|
1399
1356
|
* @memberof AffiliateOverview
|
|
1400
1357
|
*/
|
|
1401
|
-
'
|
|
1358
|
+
'perpsTotalEarningsE9': string;
|
|
1402
1359
|
/**
|
|
1403
1360
|
* Total earnings from spot LP (e9 format)
|
|
1404
1361
|
* @type {string}
|
|
1405
1362
|
* @memberof AffiliateOverview
|
|
1406
1363
|
*/
|
|
1407
|
-
'
|
|
1364
|
+
'spotLPTotalEarningsE9': string;
|
|
1408
1365
|
/**
|
|
1409
1366
|
* Total earnings from lending (e9 format)
|
|
1410
1367
|
* @type {string}
|
|
1411
1368
|
* @memberof AffiliateOverview
|
|
1412
1369
|
*/
|
|
1413
|
-
'
|
|
1370
|
+
'lendingTotalEarningsE9': string;
|
|
1414
1371
|
/**
|
|
1415
1372
|
* Total earnings from referrals (e9 format)
|
|
1416
1373
|
* @type {string}
|
|
1417
1374
|
* @memberof AffiliateOverview
|
|
1418
1375
|
*/
|
|
1419
|
-
'
|
|
1376
|
+
'totalReferralEarningsE9': string;
|
|
1420
1377
|
/**
|
|
1421
1378
|
* Total earnings from referee activities (e9 format)
|
|
1422
1379
|
* @type {string}
|
|
1423
1380
|
* @memberof AffiliateOverview
|
|
1424
1381
|
*/
|
|
1425
|
-
'
|
|
1382
|
+
'totalRefereeEarningsE9': string;
|
|
1426
1383
|
/**
|
|
1427
1384
|
* Total earnings combining referrals and referee activities (e9 format)
|
|
1428
1385
|
* @type {string}
|
|
1429
1386
|
* @memberof AffiliateOverview
|
|
1430
1387
|
*/
|
|
1431
|
-
'
|
|
1388
|
+
'totalEarningsE9': string;
|
|
1432
1389
|
}
|
|
1433
1390
|
/**
|
|
1434
1391
|
*
|
|
@@ -1453,7 +1410,7 @@ export interface AffiliateSummary {
|
|
|
1453
1410
|
* @type {string}
|
|
1454
1411
|
* @memberof AffiliateSummary
|
|
1455
1412
|
*/
|
|
1456
|
-
'
|
|
1413
|
+
'totalEarningsE9': string;
|
|
1457
1414
|
/**
|
|
1458
1415
|
* Ranking in perps trading category
|
|
1459
1416
|
* @type {number}
|
|
@@ -1925,19 +1882,19 @@ export interface EpochConfigs {
|
|
|
1925
1882
|
* @type {string}
|
|
1926
1883
|
* @memberof EpochConfigs
|
|
1927
1884
|
*/
|
|
1928
|
-
'
|
|
1885
|
+
'suiRewardsAllocationE9': string;
|
|
1929
1886
|
/**
|
|
1930
1887
|
* Allocation of Blue token rewards in the epoch (e9 format).
|
|
1931
1888
|
* @type {string}
|
|
1932
1889
|
* @memberof EpochConfigs
|
|
1933
1890
|
*/
|
|
1934
|
-
'
|
|
1891
|
+
'blueRewardsAllocationE9': string;
|
|
1935
1892
|
/**
|
|
1936
1893
|
* Allocation of wal token rewards in the epoch (e9 format)
|
|
1937
1894
|
* @type {string}
|
|
1938
1895
|
* @memberof EpochConfigs
|
|
1939
1896
|
*/
|
|
1940
|
-
'
|
|
1897
|
+
'walRewardsAllocationE9': string;
|
|
1941
1898
|
/**
|
|
1942
1899
|
* Object to add custom configurations for campaigns.
|
|
1943
1900
|
* @type {{ [key: string]: any | undefined; }}
|
|
@@ -2040,6 +1997,49 @@ export interface ExchangeInfoResponse {
|
|
|
2040
1997
|
*/
|
|
2041
1998
|
'timezone': string;
|
|
2042
1999
|
}
|
|
2000
|
+
/**
|
|
2001
|
+
* Map of various fee-related configurations
|
|
2002
|
+
* @export
|
|
2003
|
+
* @interface FeeConfigs
|
|
2004
|
+
*/
|
|
2005
|
+
export interface FeeConfigs {
|
|
2006
|
+
/**
|
|
2007
|
+
* Earnings from referral perps fees
|
|
2008
|
+
* @type {string}
|
|
2009
|
+
* @memberof FeeConfigs
|
|
2010
|
+
*/
|
|
2011
|
+
'referralPerpsFee'?: string;
|
|
2012
|
+
/**
|
|
2013
|
+
* Earnings from subaffiliate perps
|
|
2014
|
+
* @type {string}
|
|
2015
|
+
* @memberof FeeConfigs
|
|
2016
|
+
*/
|
|
2017
|
+
'subaffiliatePerpsEarnings'?: string;
|
|
2018
|
+
/**
|
|
2019
|
+
* Earnings from spot LP fees
|
|
2020
|
+
* @type {string}
|
|
2021
|
+
* @memberof FeeConfigs
|
|
2022
|
+
*/
|
|
2023
|
+
'spotLPFee'?: string;
|
|
2024
|
+
/**
|
|
2025
|
+
* Earnings from referral spot LP fees
|
|
2026
|
+
* @type {string}
|
|
2027
|
+
* @memberof FeeConfigs
|
|
2028
|
+
*/
|
|
2029
|
+
'referralSpotLPFee'?: string;
|
|
2030
|
+
/**
|
|
2031
|
+
* Earnings from referral lending rewards
|
|
2032
|
+
* @type {string}
|
|
2033
|
+
* @memberof FeeConfigs
|
|
2034
|
+
*/
|
|
2035
|
+
'referralLendingRewards'?: string;
|
|
2036
|
+
/**
|
|
2037
|
+
* Cashback from perps fees
|
|
2038
|
+
* @type {string}
|
|
2039
|
+
* @memberof FeeConfigs
|
|
2040
|
+
*/
|
|
2041
|
+
'perpsFeeCashback'?: string;
|
|
2042
|
+
}
|
|
2043
2043
|
/**
|
|
2044
2044
|
*
|
|
2045
2045
|
* @export
|
|
@@ -2225,19 +2225,19 @@ export interface IntervalRewards {
|
|
|
2225
2225
|
* @type {string}
|
|
2226
2226
|
* @memberof IntervalRewards
|
|
2227
2227
|
*/
|
|
2228
|
-
'
|
|
2228
|
+
'BlueRewardsE9': string;
|
|
2229
2229
|
/**
|
|
2230
2230
|
* Total Sui token rewards earned in the interval (e9 format).
|
|
2231
2231
|
* @type {string}
|
|
2232
2232
|
* @memberof IntervalRewards
|
|
2233
2233
|
*/
|
|
2234
|
-
'
|
|
2234
|
+
'SuiRewardsE9': string;
|
|
2235
2235
|
/**
|
|
2236
2236
|
* Total wal rewards earned in the interval (e9 format).
|
|
2237
2237
|
* @type {string}
|
|
2238
2238
|
* @memberof IntervalRewards
|
|
2239
2239
|
*/
|
|
2240
|
-
'
|
|
2240
|
+
'WalRewardsE9': string;
|
|
2241
2241
|
/**
|
|
2242
2242
|
* Interval Id of the interval for the rewards earned data.
|
|
2243
2243
|
* @type {number}
|
|
@@ -3623,19 +3623,19 @@ export interface RewardsSummary {
|
|
|
3623
3623
|
* @type {string}
|
|
3624
3624
|
* @memberof RewardsSummary
|
|
3625
3625
|
*/
|
|
3626
|
-
'
|
|
3626
|
+
'BlueRewardsE9': string;
|
|
3627
3627
|
/**
|
|
3628
3628
|
* Total Sui token rewards earned by the user (e9 format).
|
|
3629
3629
|
* @type {string}
|
|
3630
3630
|
* @memberof RewardsSummary
|
|
3631
3631
|
*/
|
|
3632
|
-
'
|
|
3632
|
+
'SuiRewardsE9': string;
|
|
3633
3633
|
/**
|
|
3634
3634
|
* Total wal rewards earned by the user (e9 format).
|
|
3635
3635
|
* @type {string}
|
|
3636
3636
|
* @memberof RewardsSummary
|
|
3637
3637
|
*/
|
|
3638
|
-
'
|
|
3638
|
+
'WalRewardsE9': string;
|
|
3639
3639
|
}
|
|
3640
3640
|
/**
|
|
3641
3641
|
* The strategy used to resolve self trades. TAKER: On a self trade, the taker order will be cancelled MAKER: On a self trade, the maker order will be cancelled BOTH: On a self trade, both the taker and the maker order will be cancelled UNSPECIFIED: set to default value
|
|
@@ -4357,11 +4357,11 @@ export interface UpdateAccountPreferenceRequest {
|
|
|
4357
4357
|
*/
|
|
4358
4358
|
export interface UpdateAffiliateFeeConfigRequest {
|
|
4359
4359
|
/**
|
|
4360
|
-
* Cashback amount
|
|
4361
|
-
* @type {
|
|
4360
|
+
* Cashback amount to give to the referees
|
|
4361
|
+
* @type {number}
|
|
4362
4362
|
* @memberof UpdateAffiliateFeeConfigRequest
|
|
4363
4363
|
*/
|
|
4364
|
-
'cashback':
|
|
4364
|
+
'cashback': number;
|
|
4365
4365
|
}
|
|
4366
4366
|
/**
|
|
4367
4367
|
*
|
|
@@ -4410,19 +4410,19 @@ export interface UserCampaignRewards {
|
|
|
4410
4410
|
* @type {string}
|
|
4411
4411
|
* @memberof UserCampaignRewards
|
|
4412
4412
|
*/
|
|
4413
|
-
'
|
|
4413
|
+
'BlueRewardsE9': string;
|
|
4414
4414
|
/**
|
|
4415
4415
|
* Total sui-perp token rewards earned in the epoch (e9 format).
|
|
4416
4416
|
* @type {string}
|
|
4417
4417
|
* @memberof UserCampaignRewards
|
|
4418
4418
|
*/
|
|
4419
|
-
'
|
|
4419
|
+
'SuiRewardsE9': string;
|
|
4420
4420
|
/**
|
|
4421
4421
|
* Total wal-perp rewards earned in the epoch (e9 format).
|
|
4422
4422
|
* @type {string}
|
|
4423
4423
|
* @memberof UserCampaignRewards
|
|
4424
4424
|
*/
|
|
4425
|
-
'
|
|
4425
|
+
'WalRewardsE9': string;
|
|
4426
4426
|
/**
|
|
4427
4427
|
* Time in milliseconds for interval start date.
|
|
4428
4428
|
* @type {number}
|
|
@@ -5267,6 +5267,7 @@ export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5267
5267
|
* Returns rankings and earnings for affiliates, sorted by the specified category
|
|
5268
5268
|
* @summary Get affiliate rankings and earnings
|
|
5269
5269
|
* @param {GetAffiliateLeaderDashboardSortByEnum} sortBy The category to sort rankings by
|
|
5270
|
+
* @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by
|
|
5270
5271
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5271
5272
|
* @param {number} [limit] The page size for pagination
|
|
5272
5273
|
* @param {string} [name] The name of the user to filter by
|
|
@@ -5274,7 +5275,7 @@ export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5274
5275
|
* @param {*} [options] Override http request option.
|
|
5275
5276
|
* @throws {RequiredError}
|
|
5276
5277
|
*/
|
|
5277
|
-
getAffiliateLeaderDashboard: (sortBy: GetAffiliateLeaderDashboardSortByEnum, page?: number, limit?: number, name?: string, userAddress?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5278
|
+
getAffiliateLeaderDashboard: (sortBy: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, name?: string, userAddress?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5278
5279
|
/**
|
|
5279
5280
|
* Returns the affiliate metadata
|
|
5280
5281
|
* @summary Get affiliate metadata
|
|
@@ -5288,12 +5289,13 @@ export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5288
5289
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5289
5290
|
* @param {number} [limit] The page size for pagination
|
|
5290
5291
|
* @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
|
|
5292
|
+
* @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
|
|
5291
5293
|
* @param {string} [name] The name of the user to filter by
|
|
5292
5294
|
* @param {string} [userAddress] The user address to filter by
|
|
5293
5295
|
* @param {*} [options] Override http request option.
|
|
5294
5296
|
* @throws {RequiredError}
|
|
5295
5297
|
*/
|
|
5296
|
-
getAffiliateOverview: (page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, name?: string, userAddress?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5298
|
+
getAffiliateOverview: (page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, name?: string, userAddress?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5297
5299
|
/**
|
|
5298
5300
|
* Returns performance summary for an affiliate including total referrals, earnings, and rankings
|
|
5299
5301
|
* @summary Get affiliate performance summary
|
|
@@ -5402,6 +5404,7 @@ export declare const RewardsApiFp: (configuration?: Configuration) => {
|
|
|
5402
5404
|
* Returns rankings and earnings for affiliates, sorted by the specified category
|
|
5403
5405
|
* @summary Get affiliate rankings and earnings
|
|
5404
5406
|
* @param {GetAffiliateLeaderDashboardSortByEnum} sortBy The category to sort rankings by
|
|
5407
|
+
* @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by
|
|
5405
5408
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5406
5409
|
* @param {number} [limit] The page size for pagination
|
|
5407
5410
|
* @param {string} [name] The name of the user to filter by
|
|
@@ -5409,7 +5412,7 @@ export declare const RewardsApiFp: (configuration?: Configuration) => {
|
|
|
5409
5412
|
* @param {*} [options] Override http request option.
|
|
5410
5413
|
* @throws {RequiredError}
|
|
5411
5414
|
*/
|
|
5412
|
-
getAffiliateLeaderDashboard(sortBy: GetAffiliateLeaderDashboardSortByEnum, page?: number, limit?: number, name?: string, userAddress?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAffiliateLeaderDashboard200Response>>;
|
|
5415
|
+
getAffiliateLeaderDashboard(sortBy: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, name?: string, userAddress?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAffiliateLeaderDashboard200Response>>;
|
|
5413
5416
|
/**
|
|
5414
5417
|
* Returns the affiliate metadata
|
|
5415
5418
|
* @summary Get affiliate metadata
|
|
@@ -5423,12 +5426,13 @@ export declare const RewardsApiFp: (configuration?: Configuration) => {
|
|
|
5423
5426
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5424
5427
|
* @param {number} [limit] The page size for pagination
|
|
5425
5428
|
* @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
|
|
5429
|
+
* @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
|
|
5426
5430
|
* @param {string} [name] The name of the user to filter by
|
|
5427
5431
|
* @param {string} [userAddress] The user address to filter by
|
|
5428
5432
|
* @param {*} [options] Override http request option.
|
|
5429
5433
|
* @throws {RequiredError}
|
|
5430
5434
|
*/
|
|
5431
|
-
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, name?: string, userAddress?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAffiliateOverview200Response>>;
|
|
5435
|
+
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, name?: string, userAddress?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAffiliateOverview200Response>>;
|
|
5432
5436
|
/**
|
|
5433
5437
|
* Returns performance summary for an affiliate including total referrals, earnings, and rankings
|
|
5434
5438
|
* @summary Get affiliate performance summary
|
|
@@ -5537,6 +5541,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
5537
5541
|
* Returns rankings and earnings for affiliates, sorted by the specified category
|
|
5538
5542
|
* @summary Get affiliate rankings and earnings
|
|
5539
5543
|
* @param {GetAffiliateLeaderDashboardSortByEnum} sortBy The category to sort rankings by
|
|
5544
|
+
* @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by
|
|
5540
5545
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5541
5546
|
* @param {number} [limit] The page size for pagination
|
|
5542
5547
|
* @param {string} [name] The name of the user to filter by
|
|
@@ -5544,7 +5549,7 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
5544
5549
|
* @param {*} [options] Override http request option.
|
|
5545
5550
|
* @throws {RequiredError}
|
|
5546
5551
|
*/
|
|
5547
|
-
getAffiliateLeaderDashboard(sortBy: GetAffiliateLeaderDashboardSortByEnum, page?: number, limit?: number, name?: string, userAddress?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAffiliateLeaderDashboard200Response>;
|
|
5552
|
+
getAffiliateLeaderDashboard(sortBy: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, name?: string, userAddress?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAffiliateLeaderDashboard200Response>;
|
|
5548
5553
|
/**
|
|
5549
5554
|
* Returns the affiliate metadata
|
|
5550
5555
|
* @summary Get affiliate metadata
|
|
@@ -5558,12 +5563,13 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
5558
5563
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5559
5564
|
* @param {number} [limit] The page size for pagination
|
|
5560
5565
|
* @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
|
|
5566
|
+
* @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
|
|
5561
5567
|
* @param {string} [name] The name of the user to filter by
|
|
5562
5568
|
* @param {string} [userAddress] The user address to filter by
|
|
5563
5569
|
* @param {*} [options] Override http request option.
|
|
5564
5570
|
* @throws {RequiredError}
|
|
5565
5571
|
*/
|
|
5566
|
-
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, name?: string, userAddress?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAffiliateOverview200Response>;
|
|
5572
|
+
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, name?: string, userAddress?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAffiliateOverview200Response>;
|
|
5567
5573
|
/**
|
|
5568
5574
|
* Returns performance summary for an affiliate including total referrals, earnings, and rankings
|
|
5569
5575
|
* @summary Get affiliate performance summary
|
|
@@ -5675,6 +5681,7 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
5675
5681
|
* Returns rankings and earnings for affiliates, sorted by the specified category
|
|
5676
5682
|
* @summary Get affiliate rankings and earnings
|
|
5677
5683
|
* @param {GetAffiliateLeaderDashboardSortByEnum} sortBy The category to sort rankings by
|
|
5684
|
+
* @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by
|
|
5678
5685
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5679
5686
|
* @param {number} [limit] The page size for pagination
|
|
5680
5687
|
* @param {string} [name] The name of the user to filter by
|
|
@@ -5683,7 +5690,7 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
5683
5690
|
* @throws {RequiredError}
|
|
5684
5691
|
* @memberof RewardsApi
|
|
5685
5692
|
*/
|
|
5686
|
-
getAffiliateLeaderDashboard(sortBy: GetAffiliateLeaderDashboardSortByEnum, page?: number, limit?: number, name?: string, userAddress?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAffiliateLeaderDashboard200Response, any>>;
|
|
5693
|
+
getAffiliateLeaderDashboard(sortBy: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, name?: string, userAddress?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAffiliateLeaderDashboard200Response, any>>;
|
|
5687
5694
|
/**
|
|
5688
5695
|
* Returns the affiliate metadata
|
|
5689
5696
|
* @summary Get affiliate metadata
|
|
@@ -5698,13 +5705,14 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
5698
5705
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5699
5706
|
* @param {number} [limit] The page size for pagination
|
|
5700
5707
|
* @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
|
|
5708
|
+
* @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
|
|
5701
5709
|
* @param {string} [name] The name of the user to filter by
|
|
5702
5710
|
* @param {string} [userAddress] The user address to filter by
|
|
5703
5711
|
* @param {*} [options] Override http request option.
|
|
5704
5712
|
* @throws {RequiredError}
|
|
5705
5713
|
* @memberof RewardsApi
|
|
5706
5714
|
*/
|
|
5707
|
-
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, name?: string, userAddress?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAffiliateOverview200Response, any>>;
|
|
5715
|
+
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, name?: string, userAddress?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAffiliateOverview200Response, any>>;
|
|
5708
5716
|
/**
|
|
5709
5717
|
* Returns performance summary for an affiliate including total referrals, earnings, and rankings
|
|
5710
5718
|
* @summary Get affiliate performance summary
|
|
@@ -5814,6 +5822,14 @@ export declare const GetAffiliateLeaderDashboardSortByEnum: {
|
|
|
5814
5822
|
readonly SpotRank: "spotRank";
|
|
5815
5823
|
};
|
|
5816
5824
|
export type GetAffiliateLeaderDashboardSortByEnum = typeof GetAffiliateLeaderDashboardSortByEnum[keyof typeof GetAffiliateLeaderDashboardSortByEnum];
|
|
5825
|
+
/**
|
|
5826
|
+
* @export
|
|
5827
|
+
*/
|
|
5828
|
+
export declare const GetAffiliateLeaderDashboardSortOrderEnum: {
|
|
5829
|
+
readonly Asc: "asc";
|
|
5830
|
+
readonly Desc: "desc";
|
|
5831
|
+
};
|
|
5832
|
+
export type GetAffiliateLeaderDashboardSortOrderEnum = typeof GetAffiliateLeaderDashboardSortOrderEnum[keyof typeof GetAffiliateLeaderDashboardSortOrderEnum];
|
|
5817
5833
|
/**
|
|
5818
5834
|
* @export
|
|
5819
5835
|
*/
|
|
@@ -5823,6 +5839,14 @@ export declare const GetAffiliateOverviewSortByEnum: {
|
|
|
5823
5839
|
readonly TotalEarnings: "totalEarnings";
|
|
5824
5840
|
};
|
|
5825
5841
|
export type GetAffiliateOverviewSortByEnum = typeof GetAffiliateOverviewSortByEnum[keyof typeof GetAffiliateOverviewSortByEnum];
|
|
5842
|
+
/**
|
|
5843
|
+
* @export
|
|
5844
|
+
*/
|
|
5845
|
+
export declare const GetAffiliateOverviewSortOrderEnum: {
|
|
5846
|
+
readonly Asc: "asc";
|
|
5847
|
+
readonly Desc: "desc";
|
|
5848
|
+
};
|
|
5849
|
+
export type GetAffiliateOverviewSortOrderEnum = typeof GetAffiliateOverviewSortOrderEnum[keyof typeof GetAffiliateOverviewSortOrderEnum];
|
|
5826
5850
|
/**
|
|
5827
5851
|
* @export
|
|
5828
5852
|
*/
|