@bluefin-exchange/pro-sdk 0.1.49 → 0.1.51

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 CHANGED
@@ -246,12 +246,24 @@ export interface AccountCommandFailureUpdate {
246
246
  * @memberof AccountCommandFailureUpdate
247
247
  */
248
248
  'reason': string;
249
+ /**
250
+ *
251
+ * @type {CommandFailureReasonCode}
252
+ * @memberof AccountCommandFailureUpdate
253
+ */
254
+ 'reasonCode'?: CommandFailureReasonCode;
249
255
  /**
250
256
  * The type of command that failed.
251
257
  * @type {string}
252
258
  * @memberof AccountCommandFailureUpdate
253
259
  */
254
260
  'failedCommandType': string;
261
+ /**
262
+ *
263
+ * @type {FailedCommandType}
264
+ * @memberof AccountCommandFailureUpdate
265
+ */
266
+ 'failedCommandTypeCode'?: FailedCommandType;
255
267
  /**
256
268
  * The timestamp when the command failed in milliseconds.
257
269
  * @type {number}
@@ -303,7 +315,7 @@ export declare const AccountEventType: {
303
315
  readonly AccountOrderUpdate: "AccountOrderUpdate";
304
316
  readonly AccountPositionUpdate: "AccountPositionUpdate";
305
317
  readonly AccountTransactionUpdate: "AccountTransactionUpdate";
306
- readonly AccountLeverageFailureUpdate: "AccountLeverageFailureUpdate";
318
+ readonly AccountCommandFailureUpdate: "AccountCommandFailureUpdate";
307
319
  };
308
320
  export type AccountEventType = typeof AccountEventType[keyof typeof AccountEventType];
309
321
  /**
@@ -1701,6 +1713,23 @@ export interface CandlestickUpdate {
1701
1713
  */
1702
1714
  'numTrades': number;
1703
1715
  }
1716
+ /**
1717
+ *
1718
+ * @export
1719
+ * @enum {string}
1720
+ */
1721
+ export declare const CommandFailureReasonCode: {
1722
+ readonly Unspecified: "UNSPECIFIED";
1723
+ readonly UnknownAddress: "UNKNOWN_ADDRESS";
1724
+ readonly UnknownSymbol: "UNKNOWN_SYMBOL";
1725
+ readonly NoPosition: "NO_POSITION";
1726
+ readonly InsufficientBalance: "INSUFFICIENT_BALANCE";
1727
+ readonly DuplicateCommandHash: "DUPLICATE_COMMAND_HASH";
1728
+ readonly InvalidLeverage: "INVALID_LEVERAGE";
1729
+ readonly UnknownMarket: "UNKNOWN_MARKET";
1730
+ readonly Unexpected: "UNEXPECTED";
1731
+ };
1732
+ export type CommandFailureReasonCode = typeof CommandFailureReasonCode[keyof typeof CommandFailureReasonCode];
1704
1733
  /**
1705
1734
  * Contract configuration for the exchange.
1706
1735
  * @export
@@ -2035,6 +2064,17 @@ export interface ExchangeInfoResponse {
2035
2064
  */
2036
2065
  'timezone': string;
2037
2066
  }
2067
+ /**
2068
+ *
2069
+ * @export
2070
+ * @enum {string}
2071
+ */
2072
+ export declare const FailedCommandType: {
2073
+ readonly PositionIsolatedMarginUpdate: "POSITION_ISOLATED_MARGIN_UPDATE";
2074
+ readonly PositionLeverageUpdate: "POSITION_LEVERAGE_UPDATE";
2075
+ readonly Withdraw: "WITHDRAW";
2076
+ };
2077
+ export type FailedCommandType = typeof FailedCommandType[keyof typeof FailedCommandType];
2038
2078
  /**
2039
2079
  * Map of various fee-related configurations
2040
2080
  * @export
@@ -5352,10 +5392,11 @@ export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration
5352
5392
  * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
5353
5393
  * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
5354
5394
  * @param {string} [search] The name/address of the user to filter by
5395
+ * @param {string} [minEarningsE9] The minimum earnings to filter by
5355
5396
  * @param {*} [options] Override http request option.
5356
5397
  * @throws {RequiredError}
5357
5398
  */
5358
- getAffiliateOverview: (userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5399
+ getAffiliateOverview: (userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, minEarningsE9?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5359
5400
  /**
5360
5401
  * Returns performance summary for an affiliate including total referrals, earnings, and rankings
5361
5402
  * @summary Get affiliate performance summary
@@ -5491,10 +5532,11 @@ export declare const RewardsApiFp: (configuration?: Configuration) => {
5491
5532
  * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
5492
5533
  * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
5493
5534
  * @param {string} [search] The name/address of the user to filter by
5535
+ * @param {string} [minEarningsE9] The minimum earnings to filter by
5494
5536
  * @param {*} [options] Override http request option.
5495
5537
  * @throws {RequiredError}
5496
5538
  */
5497
- getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAffiliateOverview200Response>>;
5539
+ getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, minEarningsE9?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAffiliateOverview200Response>>;
5498
5540
  /**
5499
5541
  * Returns performance summary for an affiliate including total referrals, earnings, and rankings
5500
5542
  * @summary Get affiliate performance summary
@@ -5630,10 +5672,11 @@ export declare const RewardsApiFactory: (configuration?: Configuration, basePath
5630
5672
  * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
5631
5673
  * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
5632
5674
  * @param {string} [search] The name/address of the user to filter by
5675
+ * @param {string} [minEarningsE9] The minimum earnings to filter by
5633
5676
  * @param {*} [options] Override http request option.
5634
5677
  * @throws {RequiredError}
5635
5678
  */
5636
- getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAffiliateOverview200Response>;
5679
+ getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, minEarningsE9?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAffiliateOverview200Response>;
5637
5680
  /**
5638
5681
  * Returns performance summary for an affiliate including total referrals, earnings, and rankings
5639
5682
  * @summary Get affiliate performance summary
@@ -5774,11 +5817,12 @@ export declare class RewardsApi extends BaseAPI {
5774
5817
  * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
5775
5818
  * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
5776
5819
  * @param {string} [search] The name/address of the user to filter by
5820
+ * @param {string} [minEarningsE9] The minimum earnings to filter by
5777
5821
  * @param {*} [options] Override http request option.
5778
5822
  * @throws {RequiredError}
5779
5823
  * @memberof RewardsApi
5780
5824
  */
5781
- getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAffiliateOverview200Response, any>>;
5825
+ getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, minEarningsE9?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAffiliateOverview200Response, any>>;
5782
5826
  /**
5783
5827
  * Returns performance summary for an affiliate including total referrals, earnings, and rankings
5784
5828
  * @summary Get affiliate performance summary
package/dist/src/api.js CHANGED
@@ -22,8 +22,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.RewardsApiFp = exports.RewardsApiAxiosParamCreator = exports.GetRecentTradesTradeTypeEnum = exports.ExchangeApi = exports.ExchangeApiFactory = exports.ExchangeApiFp = exports.ExchangeApiAxiosParamCreator = exports.AuthApi = exports.AuthApiFactory = exports.AuthApiFp = exports.AuthApiAxiosParamCreator = exports.AccountDataApi = exports.AccountDataApiFactory = exports.AccountDataApiFp = exports.AccountDataApiAxiosParamCreator = exports.UserCampaignRewardsStatusEnum = exports.TransactionType = exports.TradeType = exports.TradeSide = exports.SubscriptionType = exports.SelfTradePreventionType = exports.PositionSide = exports.OrderbookPartialDepthUpdateDepthLevelEnum = exports.OrderType = exports.OrderTimeInForce = exports.OrderStatus = exports.OrderSide = exports.OrderCancellationFailureReason = exports.OrderCancelReason = exports.OraclePriceUpdateSourceEnum = exports.MarketStatus = exports.MarketPriceUpdateSourceEnum = exports.MarketEventType = exports.MarketDataStreamName = exports.MarkPriceUpdateSourceEnum = exports.MarginType = exports.KlineInterval = exports.IntervalRewardsStatusEnum = exports.IntervalMetadataStatusEnum = exports.EpochMetadataStatusEnum = exports.ContractsConfigNetworkEnum = exports.CandlePriceType = exports.CampaignMetadataStatusEnum = exports.AffiliateOnboardResponseStatusEnum = exports.AffiliateMetadataTierEnum = exports.AffiliateMetadataStatusEnum = exports.AdjustMarginOperation = exports.AccountEventType = exports.AccountEventReason = exports.AccountDataStream = void 0;
26
- exports.TradeApi = exports.TradeApiFactory = exports.TradeApiFp = exports.TradeApiAxiosParamCreator = exports.WebSocketMarketDataSecWebSocketVersionEnum = exports.WebSocketMarketDataUpgradeEnum = exports.WebSocketAccountDataSecWebSocketVersionEnum = exports.WebSocketAccountDataUpgradeEnum = exports.StreamsApi = exports.StreamsApiFactory = exports.StreamsApiFp = exports.StreamsApiAxiosParamCreator = exports.GetRewardsEpochMetadataEpochEnum = exports.GetRewardsCampaignMetadataStatusEnum = exports.GetAffiliateOverviewSortOrderEnum = exports.GetAffiliateOverviewSortByEnum = exports.GetAffiliateLeaderDashboardSortOrderEnum = exports.GetAffiliateLeaderDashboardSortByEnum = exports.RewardsApi = exports.RewardsApiFactory = void 0;
25
+ exports.GetRecentTradesTradeTypeEnum = exports.ExchangeApi = exports.ExchangeApiFactory = exports.ExchangeApiFp = exports.ExchangeApiAxiosParamCreator = exports.AuthApi = exports.AuthApiFactory = exports.AuthApiFp = exports.AuthApiAxiosParamCreator = exports.AccountDataApi = exports.AccountDataApiFactory = exports.AccountDataApiFp = exports.AccountDataApiAxiosParamCreator = exports.UserCampaignRewardsStatusEnum = exports.TransactionType = exports.TradeType = exports.TradeSide = exports.SubscriptionType = exports.SelfTradePreventionType = exports.PositionSide = exports.OrderbookPartialDepthUpdateDepthLevelEnum = exports.OrderType = exports.OrderTimeInForce = exports.OrderStatus = exports.OrderSide = exports.OrderCancellationFailureReason = exports.OrderCancelReason = exports.OraclePriceUpdateSourceEnum = exports.MarketStatus = exports.MarketPriceUpdateSourceEnum = exports.MarketEventType = exports.MarketDataStreamName = exports.MarkPriceUpdateSourceEnum = exports.MarginType = exports.KlineInterval = exports.IntervalRewardsStatusEnum = exports.IntervalMetadataStatusEnum = exports.FailedCommandType = exports.EpochMetadataStatusEnum = exports.ContractsConfigNetworkEnum = exports.CommandFailureReasonCode = exports.CandlePriceType = exports.CampaignMetadataStatusEnum = exports.AffiliateOnboardResponseStatusEnum = exports.AffiliateMetadataTierEnum = exports.AffiliateMetadataStatusEnum = exports.AdjustMarginOperation = exports.AccountEventType = exports.AccountEventReason = exports.AccountDataStream = void 0;
26
+ exports.TradeApi = exports.TradeApiFactory = exports.TradeApiFp = exports.TradeApiAxiosParamCreator = exports.WebSocketMarketDataSecWebSocketVersionEnum = exports.WebSocketMarketDataUpgradeEnum = exports.WebSocketAccountDataSecWebSocketVersionEnum = exports.WebSocketAccountDataUpgradeEnum = exports.StreamsApi = exports.StreamsApiFactory = exports.StreamsApiFp = exports.StreamsApiAxiosParamCreator = exports.GetRewardsEpochMetadataEpochEnum = exports.GetRewardsCampaignMetadataStatusEnum = exports.GetAffiliateOverviewSortOrderEnum = exports.GetAffiliateOverviewSortByEnum = exports.GetAffiliateLeaderDashboardSortOrderEnum = exports.GetAffiliateLeaderDashboardSortByEnum = exports.RewardsApi = exports.RewardsApiFactory = exports.RewardsApiFp = exports.RewardsApiAxiosParamCreator = void 0;
27
27
  const axios_1 = require("axios");
28
28
  // Some imports not used depending on template conditions
29
29
  // @ts-ignore
@@ -72,7 +72,7 @@ exports.AccountEventType = {
72
72
  AccountOrderUpdate: 'AccountOrderUpdate',
73
73
  AccountPositionUpdate: 'AccountPositionUpdate',
74
74
  AccountTransactionUpdate: 'AccountTransactionUpdate',
75
- AccountLeverageFailureUpdate: 'AccountLeverageFailureUpdate'
75
+ AccountCommandFailureUpdate: 'AccountCommandFailureUpdate'
76
76
  };
77
77
  /**
78
78
  * The operation to perform on the margin
@@ -114,6 +114,22 @@ exports.CandlePriceType = {
114
114
  Oracle: 'Oracle',
115
115
  Unspecified: 'UNSPECIFIED'
116
116
  };
117
+ /**
118
+ *
119
+ * @export
120
+ * @enum {string}
121
+ */
122
+ exports.CommandFailureReasonCode = {
123
+ Unspecified: 'UNSPECIFIED',
124
+ UnknownAddress: 'UNKNOWN_ADDRESS',
125
+ UnknownSymbol: 'UNKNOWN_SYMBOL',
126
+ NoPosition: 'NO_POSITION',
127
+ InsufficientBalance: 'INSUFFICIENT_BALANCE',
128
+ DuplicateCommandHash: 'DUPLICATE_COMMAND_HASH',
129
+ InvalidLeverage: 'INVALID_LEVERAGE',
130
+ UnknownMarket: 'UNKNOWN_MARKET',
131
+ Unexpected: 'UNEXPECTED'
132
+ };
117
133
  exports.ContractsConfigNetworkEnum = {
118
134
  Mainnet: 'mainnet',
119
135
  Testnet: 'testnet',
@@ -125,6 +141,16 @@ exports.EpochMetadataStatusEnum = {
125
141
  Finalized: 'FINALIZED',
126
142
  Cooldown: 'COOLDOWN'
127
143
  };
144
+ /**
145
+ *
146
+ * @export
147
+ * @enum {string}
148
+ */
149
+ exports.FailedCommandType = {
150
+ PositionIsolatedMarginUpdate: 'POSITION_ISOLATED_MARGIN_UPDATE',
151
+ PositionLeverageUpdate: 'POSITION_LEVERAGE_UPDATE',
152
+ Withdraw: 'WITHDRAW'
153
+ };
128
154
  exports.IntervalMetadataStatusEnum = {
129
155
  Active: 'ACTIVE',
130
156
  NotStarted: 'NOT_STARTED',
@@ -2067,10 +2093,11 @@ const RewardsApiAxiosParamCreator = function (configuration) {
2067
2093
  * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
2068
2094
  * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
2069
2095
  * @param {string} [search] The name/address of the user to filter by
2096
+ * @param {string} [minEarningsE9] The minimum earnings to filter by
2070
2097
  * @param {*} [options] Override http request option.
2071
2098
  * @throws {RequiredError}
2072
2099
  */
2073
- getAffiliateOverview: (userAddress_1, page_1, limit_1, sortBy_1, sortOrder_1, search_1, ...args_1) => __awaiter(this, [userAddress_1, page_1, limit_1, sortBy_1, sortOrder_1, search_1, ...args_1], void 0, function* (userAddress, page, limit, sortBy, sortOrder, search, options = {}) {
2100
+ getAffiliateOverview: (userAddress_1, page_1, limit_1, sortBy_1, sortOrder_1, search_1, minEarningsE9_1, ...args_1) => __awaiter(this, [userAddress_1, page_1, limit_1, sortBy_1, sortOrder_1, search_1, minEarningsE9_1, ...args_1], void 0, function* (userAddress, page, limit, sortBy, sortOrder, search, minEarningsE9, options = {}) {
2074
2101
  // verify required parameter 'userAddress' is not null or undefined
2075
2102
  (0, common_1.assertParamExists)('getAffiliateOverview', 'userAddress', userAddress);
2076
2103
  const localVarPath = `/v1/rewards/affiliate/overview`;
@@ -2101,6 +2128,9 @@ const RewardsApiAxiosParamCreator = function (configuration) {
2101
2128
  if (userAddress !== undefined) {
2102
2129
  localVarQueryParameter['userAddress'] = userAddress;
2103
2130
  }
2131
+ if (minEarningsE9 !== undefined) {
2132
+ localVarQueryParameter['minEarningsE9'] = minEarningsE9;
2133
+ }
2104
2134
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2105
2135
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2106
2136
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -2533,13 +2563,14 @@ const RewardsApiFp = function (configuration) {
2533
2563
  * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
2534
2564
  * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
2535
2565
  * @param {string} [search] The name/address of the user to filter by
2566
+ * @param {string} [minEarningsE9] The minimum earnings to filter by
2536
2567
  * @param {*} [options] Override http request option.
2537
2568
  * @throws {RequiredError}
2538
2569
  */
2539
- getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, options) {
2570
+ getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, minEarningsE9, options) {
2540
2571
  return __awaiter(this, void 0, void 0, function* () {
2541
2572
  var _a, _b, _c;
2542
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, options);
2573
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, minEarningsE9, options);
2543
2574
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2544
2575
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RewardsApi.getAffiliateOverview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2545
2576
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2778,11 +2809,12 @@ const RewardsApiFactory = function (configuration, basePath, axios) {
2778
2809
  * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
2779
2810
  * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
2780
2811
  * @param {string} [search] The name/address of the user to filter by
2812
+ * @param {string} [minEarningsE9] The minimum earnings to filter by
2781
2813
  * @param {*} [options] Override http request option.
2782
2814
  * @throws {RequiredError}
2783
2815
  */
2784
- getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, options) {
2785
- return localVarFp.getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, options).then((request) => request(axios, basePath));
2816
+ getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, minEarningsE9, options) {
2817
+ return localVarFp.getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, minEarningsE9, options).then((request) => request(axios, basePath));
2786
2818
  },
2787
2819
  /**
2788
2820
  * Returns performance summary for an affiliate including total referrals, earnings, and rankings
@@ -2954,12 +2986,13 @@ class RewardsApi extends base_1.BaseAPI {
2954
2986
  * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
2955
2987
  * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
2956
2988
  * @param {string} [search] The name/address of the user to filter by
2989
+ * @param {string} [minEarningsE9] The minimum earnings to filter by
2957
2990
  * @param {*} [options] Override http request option.
2958
2991
  * @throws {RequiredError}
2959
2992
  * @memberof RewardsApi
2960
2993
  */
2961
- getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, options) {
2962
- return (0, exports.RewardsApiFp)(this.configuration).getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, options).then((request) => request(this.axios, this.basePath));
2994
+ getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, minEarningsE9, options) {
2995
+ return (0, exports.RewardsApiFp)(this.configuration).getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, minEarningsE9, options).then((request) => request(this.axios, this.basePath));
2963
2996
  }
2964
2997
  /**
2965
2998
  * Returns performance summary for an affiliate including total referrals, earnings, and rankings
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bluefin-exchange/pro-sdk",
3
- "version": "0.1.49",
3
+ "version": "0.1.51",
4
4
  "description": "OpenAPI client for @bluefin-exchange/pro-sdk",
5
5
  "author": "Bluefin",
6
6
  "repository": {
@@ -46,6 +46,7 @@ docs/CancelOrdersRequest.md
46
46
  docs/CancelOrdersResponse.md
47
47
  docs/CandlePriceType.md
48
48
  docs/CandlestickUpdate.md
49
+ docs/CommandFailureReasonCode.md
49
50
  docs/ContractsConfig.md
50
51
  docs/CreateOrderRequest.md
51
52
  docs/CreateOrderRequestSignedFields.md
@@ -55,6 +56,7 @@ docs/EpochMetadata.md
55
56
  docs/Error.md
56
57
  docs/ExchangeApi.md
57
58
  docs/ExchangeInfoResponse.md
59
+ docs/FailedCommandType.md
58
60
  docs/FeeConfigs.md
59
61
  docs/FundingRateEntry.md
60
62
  docs/GetAffiliateIntervalOverview200Response.md
package/src/api.ts CHANGED
@@ -256,12 +256,24 @@ export interface AccountCommandFailureUpdate {
256
256
  * @memberof AccountCommandFailureUpdate
257
257
  */
258
258
  'reason': string;
259
+ /**
260
+ *
261
+ * @type {CommandFailureReasonCode}
262
+ * @memberof AccountCommandFailureUpdate
263
+ */
264
+ 'reasonCode'?: CommandFailureReasonCode;
259
265
  /**
260
266
  * The type of command that failed.
261
267
  * @type {string}
262
268
  * @memberof AccountCommandFailureUpdate
263
269
  */
264
270
  'failedCommandType': string;
271
+ /**
272
+ *
273
+ * @type {FailedCommandType}
274
+ * @memberof AccountCommandFailureUpdate
275
+ */
276
+ 'failedCommandTypeCode'?: FailedCommandType;
265
277
  /**
266
278
  * The timestamp when the command failed in milliseconds.
267
279
  * @type {number}
@@ -269,6 +281,8 @@ export interface AccountCommandFailureUpdate {
269
281
  */
270
282
  'failedAtMillis': number;
271
283
  }
284
+
285
+
272
286
  /**
273
287
  * Represents the type of account data stream.
274
288
  * @export
@@ -322,7 +336,7 @@ export const AccountEventType = {
322
336
  AccountOrderUpdate: 'AccountOrderUpdate',
323
337
  AccountPositionUpdate: 'AccountPositionUpdate',
324
338
  AccountTransactionUpdate: 'AccountTransactionUpdate',
325
- AccountLeverageFailureUpdate: 'AccountLeverageFailureUpdate'
339
+ AccountCommandFailureUpdate: 'AccountCommandFailureUpdate'
326
340
  } as const;
327
341
 
328
342
  export type AccountEventType = typeof AccountEventType[keyof typeof AccountEventType];
@@ -1760,6 +1774,27 @@ export interface CandlestickUpdate {
1760
1774
  */
1761
1775
  'numTrades': number;
1762
1776
  }
1777
+ /**
1778
+ *
1779
+ * @export
1780
+ * @enum {string}
1781
+ */
1782
+
1783
+ export const CommandFailureReasonCode = {
1784
+ Unspecified: 'UNSPECIFIED',
1785
+ UnknownAddress: 'UNKNOWN_ADDRESS',
1786
+ UnknownSymbol: 'UNKNOWN_SYMBOL',
1787
+ NoPosition: 'NO_POSITION',
1788
+ InsufficientBalance: 'INSUFFICIENT_BALANCE',
1789
+ DuplicateCommandHash: 'DUPLICATE_COMMAND_HASH',
1790
+ InvalidLeverage: 'INVALID_LEVERAGE',
1791
+ UnknownMarket: 'UNKNOWN_MARKET',
1792
+ Unexpected: 'UNEXPECTED'
1793
+ } as const;
1794
+
1795
+ export type CommandFailureReasonCode = typeof CommandFailureReasonCode[keyof typeof CommandFailureReasonCode];
1796
+
1797
+
1763
1798
  /**
1764
1799
  * Contract configuration for the exchange.
1765
1800
  * @export
@@ -2102,6 +2137,21 @@ export interface ExchangeInfoResponse {
2102
2137
  */
2103
2138
  'timezone': string;
2104
2139
  }
2140
+ /**
2141
+ *
2142
+ * @export
2143
+ * @enum {string}
2144
+ */
2145
+
2146
+ export const FailedCommandType = {
2147
+ PositionIsolatedMarginUpdate: 'POSITION_ISOLATED_MARGIN_UPDATE',
2148
+ PositionLeverageUpdate: 'POSITION_LEVERAGE_UPDATE',
2149
+ Withdraw: 'WITHDRAW'
2150
+ } as const;
2151
+
2152
+ export type FailedCommandType = typeof FailedCommandType[keyof typeof FailedCommandType];
2153
+
2154
+
2105
2155
  /**
2106
2156
  * Map of various fee-related configurations
2107
2157
  * @export
@@ -6459,10 +6509,11 @@ export const RewardsApiAxiosParamCreator = function (configuration?: Configurati
6459
6509
  * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
6460
6510
  * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
6461
6511
  * @param {string} [search] The name/address of the user to filter by
6512
+ * @param {string} [minEarningsE9] The minimum earnings to filter by
6462
6513
  * @param {*} [options] Override http request option.
6463
6514
  * @throws {RequiredError}
6464
6515
  */
6465
- getAffiliateOverview: async (userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6516
+ getAffiliateOverview: async (userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, minEarningsE9?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
6466
6517
  // verify required parameter 'userAddress' is not null or undefined
6467
6518
  assertParamExists('getAffiliateOverview', 'userAddress', userAddress)
6468
6519
  const localVarPath = `/v1/rewards/affiliate/overview`;
@@ -6501,6 +6552,10 @@ export const RewardsApiAxiosParamCreator = function (configuration?: Configurati
6501
6552
  localVarQueryParameter['userAddress'] = userAddress;
6502
6553
  }
6503
6554
 
6555
+ if (minEarningsE9 !== undefined) {
6556
+ localVarQueryParameter['minEarningsE9'] = minEarningsE9;
6557
+ }
6558
+
6504
6559
 
6505
6560
 
6506
6561
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -7000,11 +7055,12 @@ export const RewardsApiFp = function(configuration?: Configuration) {
7000
7055
  * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
7001
7056
  * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
7002
7057
  * @param {string} [search] The name/address of the user to filter by
7058
+ * @param {string} [minEarningsE9] The minimum earnings to filter by
7003
7059
  * @param {*} [options] Override http request option.
7004
7060
  * @throws {RequiredError}
7005
7061
  */
7006
- async getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAffiliateOverview200Response>> {
7007
- const localVarAxiosArgs = await localVarAxiosParamCreator.getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, options);
7062
+ async getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, minEarningsE9?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAffiliateOverview200Response>> {
7063
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, minEarningsE9, options);
7008
7064
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7009
7065
  const localVarOperationServerBasePath = operationServerMap['RewardsApi.getAffiliateOverview']?.[localVarOperationServerIndex]?.url;
7010
7066
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -7209,11 +7265,12 @@ export const RewardsApiFactory = function (configuration?: Configuration, basePa
7209
7265
  * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
7210
7266
  * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
7211
7267
  * @param {string} [search] The name/address of the user to filter by
7268
+ * @param {string} [minEarningsE9] The minimum earnings to filter by
7212
7269
  * @param {*} [options] Override http request option.
7213
7270
  * @throws {RequiredError}
7214
7271
  */
7215
- getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAffiliateOverview200Response> {
7216
- return localVarFp.getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, options).then((request) => request(axios, basePath));
7272
+ getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, minEarningsE9?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAffiliateOverview200Response> {
7273
+ return localVarFp.getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, minEarningsE9, options).then((request) => request(axios, basePath));
7217
7274
  },
7218
7275
  /**
7219
7276
  * Returns performance summary for an affiliate including total referrals, earnings, and rankings
@@ -7388,12 +7445,13 @@ export class RewardsApi extends BaseAPI {
7388
7445
  * @param {GetAffiliateOverviewSortByEnum} [sortBy] The category to sort earnings by
7389
7446
  * @param {GetAffiliateOverviewSortOrderEnum} [sortOrder] The order to sort earnings by
7390
7447
  * @param {string} [search] The name/address of the user to filter by
7448
+ * @param {string} [minEarningsE9] The minimum earnings to filter by
7391
7449
  * @param {*} [options] Override http request option.
7392
7450
  * @throws {RequiredError}
7393
7451
  * @memberof RewardsApi
7394
7452
  */
7395
- public getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, options?: RawAxiosRequestConfig) {
7396
- return RewardsApiFp(this.configuration).getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, options).then((request) => request(this.axios, this.basePath));
7453
+ public getAffiliateOverview(userAddress: string, page?: number, limit?: number, sortBy?: GetAffiliateOverviewSortByEnum, sortOrder?: GetAffiliateOverviewSortOrderEnum, search?: string, minEarningsE9?: string, options?: RawAxiosRequestConfig) {
7454
+ return RewardsApiFp(this.configuration).getAffiliateOverview(userAddress, page, limit, sortBy, sortOrder, search, minEarningsE9, options).then((request) => request(this.axios, this.basePath));
7397
7455
  }
7398
7456
 
7399
7457
  /**
@@ -7,7 +7,9 @@ Details about a failure during an account command execution.
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **reason** | **string** | The reason for the failure. | [default to undefined]
10
+ **reasonCode** | [**CommandFailureReasonCode**](CommandFailureReasonCode.md) | | [optional] [default to undefined]
10
11
  **failedCommandType** | **string** | The type of command that failed. | [default to undefined]
12
+ **failedCommandTypeCode** | [**FailedCommandType**](FailedCommandType.md) | | [optional] [default to undefined]
11
13
  **failedAtMillis** | **number** | The timestamp when the command failed in milliseconds. | [default to undefined]
12
14
 
13
15
  ## Example
@@ -17,7 +19,9 @@ import { AccountCommandFailureUpdate } from '@bluefin/api-client';
17
19
 
18
20
  const instance: AccountCommandFailureUpdate = {
19
21
  reason,
22
+ reasonCode,
20
23
  failedCommandType,
24
+ failedCommandTypeCode,
21
25
  failedAtMillis,
22
26
  };
23
27
  ```
@@ -16,6 +16,6 @@ The type of account-related event.
16
16
 
17
17
  * `AccountTransactionUpdate` (value: `'AccountTransactionUpdate'`)
18
18
 
19
- * `AccountLeverageFailureUpdate` (value: `'AccountLeverageFailureUpdate'`)
19
+ * `AccountCommandFailureUpdate` (value: `'AccountCommandFailureUpdate'`)
20
20
 
21
21
  [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -68,7 +68,9 @@ Name | Type | Description | Notes
68
68
  **maintenanceMarginE9** | **string** | The maintenance margin required for the position. | [default to undefined]
69
69
  **isolatedMarginE9** | **string** | The isolated margin applied to the position. | [default to undefined]
70
70
  **reason** | **string** | The reason for the failure. | [default to undefined]
71
+ **reasonCode** | [**CommandFailureReasonCode**](CommandFailureReasonCode.md) | | [optional] [default to undefined]
71
72
  **failedCommandType** | **string** | The type of command that failed. | [default to undefined]
73
+ **failedCommandTypeCode** | [**FailedCommandType**](FailedCommandType.md) | | [optional] [default to undefined]
72
74
  **failedAtMillis** | **number** | The timestamp when the command failed in milliseconds. | [default to undefined]
73
75
 
74
76
  ## Example
@@ -139,7 +141,9 @@ const instance: AccountStreamMessagePayload = {
139
141
  maintenanceMarginE9,
140
142
  isolatedMarginE9,
141
143
  reason,
144
+ reasonCode,
142
145
  failedCommandType,
146
+ failedCommandTypeCode,
143
147
  failedAtMillis,
144
148
  };
145
149
  ```
@@ -0,0 +1,24 @@
1
+ # CommandFailureReasonCode
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Unspecified` (value: `'UNSPECIFIED'`)
7
+
8
+ * `UnknownAddress` (value: `'UNKNOWN_ADDRESS'`)
9
+
10
+ * `UnknownSymbol` (value: `'UNKNOWN_SYMBOL'`)
11
+
12
+ * `NoPosition` (value: `'NO_POSITION'`)
13
+
14
+ * `InsufficientBalance` (value: `'INSUFFICIENT_BALANCE'`)
15
+
16
+ * `DuplicateCommandHash` (value: `'DUPLICATE_COMMAND_HASH'`)
17
+
18
+ * `InvalidLeverage` (value: `'INVALID_LEVERAGE'`)
19
+
20
+ * `UnknownMarket` (value: `'UNKNOWN_MARKET'`)
21
+
22
+ * `Unexpected` (value: `'UNEXPECTED'`)
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,12 @@
1
+ # FailedCommandType
2
+
3
+
4
+ ## Enum
5
+
6
+ * `PositionIsolatedMarginUpdate` (value: `'POSITION_ISOLATED_MARGIN_UPDATE'`)
7
+
8
+ * `PositionLeverageUpdate` (value: `'POSITION_LEVERAGE_UPDATE'`)
9
+
10
+ * `Withdraw` (value: `'WITHDRAW'`)
11
+
12
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -222,6 +222,7 @@ let limit: number; //The page size for pagination (optional) (default to 500)
222
222
  let sortBy: 'refreeEarnings' | 'referralEarnings' | 'totalEarnings'; //The category to sort earnings by (optional) (default to 'totalEarnings')
223
223
  let sortOrder: 'asc' | 'desc'; //The order to sort earnings by (optional) (default to undefined)
224
224
  let search: string; //The name/address of the user to filter by (optional) (default to undefined)
225
+ let minEarningsE9: string; //The minimum earnings to filter by (optional) (default to '0')
225
226
 
226
227
  const { status, data } = await apiInstance.getAffiliateOverview(
227
228
  userAddress,
@@ -229,7 +230,8 @@ const { status, data } = await apiInstance.getAffiliateOverview(
229
230
  limit,
230
231
  sortBy,
231
232
  sortOrder,
232
- search
233
+ search,
234
+ minEarningsE9
233
235
  );
234
236
  ```
235
237
 
@@ -243,6 +245,7 @@ const { status, data } = await apiInstance.getAffiliateOverview(
243
245
  | **sortBy** | [**&#39;refreeEarnings&#39; | &#39;referralEarnings&#39; | &#39;totalEarnings&#39;**]**Array<&#39;refreeEarnings&#39; &#124; &#39;referralEarnings&#39; &#124; &#39;totalEarnings&#39;>** | The category to sort earnings by | (optional) defaults to 'totalEarnings'|
244
246
  | **sortOrder** | [**&#39;asc&#39; | &#39;desc&#39;**]**Array<&#39;asc&#39; &#124; &#39;desc&#39;>** | The order to sort earnings by | (optional) defaults to undefined|
245
247
  | **search** | [**string**] | The name/address of the user to filter by | (optional) defaults to undefined|
248
+ | **minEarningsE9** | [**string**] | The minimum earnings to filter by | (optional) defaults to '0'|
246
249
 
247
250
 
248
251
  ### Return type
@@ -377,6 +380,7 @@ No authorization required
377
380
  | Status code | Description | Response headers |
378
381
  |-------------|-------------|------------------|
379
382
  |**200** | Successful response | - |
383
+ |**400** | request missing required parameters | - |
380
384
 
381
385
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
382
386
 
@@ -353,6 +353,7 @@ void (empty response body)
353
353
  |**401** | Unauthorized. Authentication is required or invalid. Signature is invalid | - |
354
354
  |**403** | Forbidden. | - |
355
355
  |**404** | Not Found. The requested resource was not found. | - |
356
+ |**429** | Too Many Requests. The request was rate limited. | - |
356
357
  |**500** | Internal Server Error. An unexpected error occurred on the server. | - |
357
358
  |**503** | Service Unavailable. The service is currently unavailable. | - |
358
359