@bluefin-exchange/pro-sdk 0.1.41 → 0.1.45
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 +86 -34
- package/dist/src/api.js +69 -55
- package/dist/src/sdk.d.ts +10 -3
- package/dist/src/sdk.js +16 -3
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +1 -0
- package/src/api.ts +118 -58
- 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 +10 -14
- package/src/docs/TradeApi.md +17 -0
- package/src/docs/UserCampaignRewards.md +2 -0
- package/src/sdk.ts +23 -3
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
|
|
@@ -5270,12 +5330,11 @@ export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
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: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number,
|
|
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
|
|
@@ -5290,12 +5349,11 @@ export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5290
5349
|
* @param {number} [limit] The page size for pagination
|
|
5291
5350
|
* @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
|
|
5292
5351
|
* @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
|
|
5293
|
-
* @param {string} [
|
|
5294
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5352
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5295
5353
|
* @param {*} [options] Override http request option.
|
|
5296
5354
|
* @throws {RequiredError}
|
|
5297
5355
|
*/
|
|
5298
|
-
getAffiliateOverview: (page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum,
|
|
5356
|
+
getAffiliateOverview: (page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5299
5357
|
/**
|
|
5300
5358
|
* Returns performance summary for an affiliate including total referrals, earnings, and rankings
|
|
5301
5359
|
* @summary Get affiliate performance summary
|
|
@@ -5407,12 +5465,11 @@ export declare const RewardsApiFp: (configuration?: Configuration) => {
|
|
|
5407
5465
|
* @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by
|
|
5408
5466
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5409
5467
|
* @param {number} [limit] The page size for pagination
|
|
5410
|
-
* @param {string} [
|
|
5411
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5468
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5412
5469
|
* @param {*} [options] Override http request option.
|
|
5413
5470
|
* @throws {RequiredError}
|
|
5414
5471
|
*/
|
|
5415
|
-
getAffiliateLeaderDashboard(sortBy: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number,
|
|
5472
|
+
getAffiliateLeaderDashboard(sortBy: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAffiliateLeaderDashboard200Response>>;
|
|
5416
5473
|
/**
|
|
5417
5474
|
* Returns the affiliate metadata
|
|
5418
5475
|
* @summary Get affiliate metadata
|
|
@@ -5427,12 +5484,11 @@ export declare const RewardsApiFp: (configuration?: Configuration) => {
|
|
|
5427
5484
|
* @param {number} [limit] The page size for pagination
|
|
5428
5485
|
* @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
|
|
5429
5486
|
* @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
|
|
5430
|
-
* @param {string} [
|
|
5431
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5487
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5432
5488
|
* @param {*} [options] Override http request option.
|
|
5433
5489
|
* @throws {RequiredError}
|
|
5434
5490
|
*/
|
|
5435
|
-
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum,
|
|
5491
|
+
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAffiliateOverview200Response>>;
|
|
5436
5492
|
/**
|
|
5437
5493
|
* Returns performance summary for an affiliate including total referrals, earnings, and rankings
|
|
5438
5494
|
* @summary Get affiliate performance summary
|
|
@@ -5544,12 +5600,11 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
5544
5600
|
* @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by
|
|
5545
5601
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5546
5602
|
* @param {number} [limit] The page size for pagination
|
|
5547
|
-
* @param {string} [
|
|
5548
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5603
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5549
5604
|
* @param {*} [options] Override http request option.
|
|
5550
5605
|
* @throws {RequiredError}
|
|
5551
5606
|
*/
|
|
5552
|
-
getAffiliateLeaderDashboard(sortBy: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number,
|
|
5607
|
+
getAffiliateLeaderDashboard(sortBy: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAffiliateLeaderDashboard200Response>;
|
|
5553
5608
|
/**
|
|
5554
5609
|
* Returns the affiliate metadata
|
|
5555
5610
|
* @summary Get affiliate metadata
|
|
@@ -5564,12 +5619,11 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
|
|
|
5564
5619
|
* @param {number} [limit] The page size for pagination
|
|
5565
5620
|
* @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
|
|
5566
5621
|
* @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
|
|
5567
|
-
* @param {string} [
|
|
5568
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5622
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5569
5623
|
* @param {*} [options] Override http request option.
|
|
5570
5624
|
* @throws {RequiredError}
|
|
5571
5625
|
*/
|
|
5572
|
-
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum,
|
|
5626
|
+
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAffiliateOverview200Response>;
|
|
5573
5627
|
/**
|
|
5574
5628
|
* Returns performance summary for an affiliate including total referrals, earnings, and rankings
|
|
5575
5629
|
* @summary Get affiliate performance summary
|
|
@@ -5684,13 +5738,12 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
5684
5738
|
* @param {GetAffiliateLeaderDashboardSortOrderEnum} [sortOrder] The order to sort rankings by
|
|
5685
5739
|
* @param {number} [page] The page number to retrieve in a paginated response
|
|
5686
5740
|
* @param {number} [limit] The page size for pagination
|
|
5687
|
-
* @param {string} [
|
|
5688
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5741
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5689
5742
|
* @param {*} [options] Override http request option.
|
|
5690
5743
|
* @throws {RequiredError}
|
|
5691
5744
|
* @memberof RewardsApi
|
|
5692
5745
|
*/
|
|
5693
|
-
getAffiliateLeaderDashboard(sortBy: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number,
|
|
5746
|
+
getAffiliateLeaderDashboard(sortBy: GetAffiliateLeaderDashboardSortByEnum, sortOrder?: GetAffiliateLeaderDashboardSortOrderEnum, page?: number, limit?: number, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAffiliateLeaderDashboard200Response, any>>;
|
|
5694
5747
|
/**
|
|
5695
5748
|
* Returns the affiliate metadata
|
|
5696
5749
|
* @summary Get affiliate metadata
|
|
@@ -5706,13 +5759,12 @@ export declare class RewardsApi extends BaseAPI {
|
|
|
5706
5759
|
* @param {number} [limit] The page size for pagination
|
|
5707
5760
|
* @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
|
|
5708
5761
|
* @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
|
|
5709
|
-
* @param {string} [
|
|
5710
|
-
* @param {string} [userAddress] The user address to filter by
|
|
5762
|
+
* @param {string} [search] The name/address of the user to filter by
|
|
5711
5763
|
* @param {*} [options] Override http request option.
|
|
5712
5764
|
* @throws {RequiredError}
|
|
5713
5765
|
* @memberof RewardsApi
|
|
5714
5766
|
*/
|
|
5715
|
-
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum,
|
|
5767
|
+
getAffiliateOverview(page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAffiliateOverview200Response, any>>;
|
|
5716
5768
|
/**
|
|
5717
5769
|
* Returns performance summary for an affiliate including total referrals, earnings, and rankings
|
|
5718
5770
|
* @summary Get affiliate performance summary
|