@bluefin-exchange/pro-sdk 0.1.61 → 0.2.0-pre-release.1

package/src/docs/AccountPositionUpdate.md

@@ -1,47 +0,0 @@
-# AccountPositionUpdate
-
-Details about an account position update.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **string** | The symbol of the market. | [default to undefined]
-**avgEntryPriceE9** | **string** | The average entry price for the position. | [default to undefined]
-**clientSetLeverageE9** | **string** | The leverage applied to the position. | [default to undefined]
-**liquidationPriceE9** | **string** | The liquidation price of the position. | [default to undefined]
-**markPriceE9** | **string** | The current mark price of the position. | [default to undefined]
-**notionalValueE9** | **string** | The notional value of the position. | [default to undefined]
-**sizeE9** | **string** | The size of the position. | [default to undefined]
-**unrealizedPnlE9** | **string** | The unrealized profit and loss for the position. | [default to undefined]
-**side** | [**PositionSide**](PositionSide.md) |  | [default to undefined]
-**marginRequiredE9** | **string** | The margin required for the position. | [default to undefined]
-**maintenanceMarginE9** | **string** | The maintenance margin required for the position. | [default to undefined]
-**isIsolated** | **boolean** | Indicates if the position is isolated. | [default to undefined]
-**isolatedMarginE9** | **string** | The isolated margin applied to the position. | [default to undefined]
-**updatedAtMillis** | **number** | The last update time for the position in milliseconds. | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountPositionUpdate } from '@bluefin/api-client';
-
-const instance: AccountPositionUpdate = {
-    symbol,
-    avgEntryPriceE9,
-    clientSetLeverageE9,
-    liquidationPriceE9,
-    markPriceE9,
-    notionalValueE9,
-    sizeE9,
-    unrealizedPnlE9,
-    side,
-    marginRequiredE9,
-    maintenanceMarginE9,
-    isIsolated,
-    isolatedMarginE9,
-    updatedAtMillis,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AccountPreference.md

@@ -1,24 +0,0 @@
-# AccountPreference
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**language** | **string** | User preferred language. | [optional] [default to undefined]
-**theme** | **string** | User preferred theme. | [optional] [default to undefined]
-**market** | [**Array<AccountMarketPreference>**](AccountMarketPreference.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AccountPreference } from '@bluefin/api-client';
-
-const instance: AccountPreference = {
-    language,
-    theme,
-    market,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AccountStreamMessage.md

@@ -1,25 +0,0 @@
-# AccountStreamMessage
-
-Account stream message for account-related events. The payload depends on the event type. 
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**event** | [**AccountEventType**](AccountEventType.md) |  | [default to undefined]
-**reason** | [**AccountEventReason**](AccountEventReason.md) |  | [default to undefined]
-**payload** | [**AccountStreamMessagePayload**](AccountStreamMessagePayload.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountStreamMessage } from '@bluefin/api-client';
-
-const instance: AccountStreamMessage = {
-    event,
-    reason,
-    payload,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AccountStreamMessagePayload.md

@@ -1,153 +0,0 @@
-# AccountStreamMessagePayload
-
-The payload of the message, which varies based on the event type.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tradingFees** | [**TradingFees**](TradingFees.md) |  | [optional] [default to undefined]
-**canTrade** | **boolean** | If the user can trade. | [default to undefined]
-**canDeposit** | **boolean** | If the current user can deposit to the account. | [default to undefined]
-**canWithdraw** | **boolean** | If the current user can withdraw from the account. | [default to undefined]
-**crossEffectiveBalanceE9** | **string** | Total effective balance in USD (e9 format). | [default to undefined]
-**crossMarginRequiredE9** | **string** | The sum of initial margin required across all cross positions (e9 format). | [default to undefined]
-**totalOrderMarginRequiredE9** | **string** | The sum of initial margin required across all open orders (e9 format). | [default to undefined]
-**marginAvailableE9** | **string** | The amount of margin available to open new positions and orders (e9 format). | [default to undefined]
-**crossMaintenanceMarginRequiredE9** | **string** | The sum of maintenance margin required across all cross positions (e9 format). | [default to undefined]
-**crossMaintenanceMarginAvailableE9** | **string** | The amount of margin available before liquidation (e9 format). | [default to undefined]
-**crossMaintenanceMarginRatioE9** | **string** | The ratio of the maintenance margin required to the account value (e9 format). | [default to undefined]
-**crossLeverageE9** | **string** | The leverage of the account (e9 format). | [default to undefined]
-**totalUnrealizedPnlE9** | **string** | Total unrealized profit (e9 format). | [default to undefined]
-**crossUnrealizedPnlE9** | **string** | Unrealized profit of cross positions (e9 format). | [default to undefined]
-**crossUnrealizedLossE9** | **string** | An implicitly negative number that sums only the losses of all cross positions. | [default to undefined]
-**crossAccountValueE9** | **string** | The total value of the cross account, combining the cross effective balance and unrealized PnL across all cross positions, and subtracting any pending funding payments on any cross position.  | [default to undefined]
-**totalAccountValueE9** | **string** | The total value of the account, combining the total effective balance and unrealized PnL across all positions, and subtracting any pending funding payments on any position.  | [default to undefined]
-**updatedAtMillis** | **number** | The last update time for the position in milliseconds. | [default to undefined]
-**assets** | [**Array<Asset>**](Asset.md) |  | [default to undefined]
-**authorizedAccounts** | **Array<string>** | Deprecated: Replaced with authorizedWallets. | [default to undefined]
-**authorizedWallets** | [**Array<AuthorizedWallet>**](AuthorizedWallet.md) | The wallets that are authorized to trade on behalf of the current account. | [default to undefined]
-**trade** | [**Trade**](Trade.md) |  | [default to undefined]
-**orderHash** | **string** | The unique hash of the order. | [default to undefined]
-**clientOrderId** | **string** | The client-provided order ID. | [optional] [default to undefined]
-**symbol** | **string** | The symbol of the market. | [default to undefined]
-**accountAddress** | **string** | The address of the account. | [default to undefined]
-**priceE9** | **string** | The price of the order in scientific notation with 9 decimal places. | [default to undefined]
-**quantityE9** | **string** | The quantity of the order in scientific notation with 9 decimal places. | [default to undefined]
-**filledQuantityE9** | **string** | The filled quantity of the order in scientific notation with 9 decimal places. | [default to undefined]
-**side** | [**PositionSide**](PositionSide.md) |  | [default to undefined]
-**leverageE9** | **string** | The leverage of the order in scientific notation with 9 decimal places. | [default to undefined]
-**isIsolated** | **boolean** | Indicates if the position is isolated. | [default to undefined]
-**salt** | **string** | A unique salt for the order. | [default to undefined]
-**expiresAtMillis** | **number** | The expiration timestamp of the order in milliseconds. | [default to undefined]
-**signedAtMillis** | **number** | The signing timestamp of the order in milliseconds. | [default to undefined]
-**signerAddress** | **string** | The address of the signer of the order request. | [default to undefined]
-**type** | [**OrderType**](OrderType.md) |  | [default to undefined]
-**reduceOnly** | **boolean** | Indicates if the order is reduce-only. | [default to undefined]
-**postOnly** | **boolean** | Indicates if the order is post-only. | [default to undefined]
-**timeInForce** | [**OrderTimeInForce**](OrderTimeInForce.md) |  | [default to undefined]
-**triggerPriceE9** | **string** | The trigger price for stop-limit or stop-market orders. | [optional] [default to undefined]
-**status** | [**OrderStatus**](OrderStatus.md) |  | [default to undefined]
-**selfTradePreventionType** | [**SelfTradePreventionType**](SelfTradePreventionType.md) |  | [default to undefined]
-**createdAtMillis** | **number** | The timestamp of the order creation in milliseconds. | [default to undefined]
-**cancellationReason** | [**OrderCancelReason**](OrderCancelReason.md) |  | [default to undefined]
-**failureToCancelReason** | [**OrderCancellationFailureReason**](OrderCancellationFailureReason.md) |  | [optional] [default to undefined]
-**remainingQuantityE9** | **string** | The remaining quantity of the order. | [default to undefined]
-**transactionType** | [**TransactionType**](TransactionType.md) |  | [default to undefined]
-**amountE9** | **string** | The amount of the transaction in scientific notation with 9 decimal places. | [default to undefined]
-**assetSymbol** | **string** | The symbol of the asset. | [optional] [default to undefined]
-**tradeId** | **string** | The trade ID associated with the transaction. | [optional] [default to undefined]
-**executedAtMillis** | **number** | The timestamp when the transaction was executed in milliseconds. | [default to undefined]
-**avgEntryPriceE9** | **string** | The average entry price for the position. | [default to undefined]
-**clientSetLeverageE9** | **string** | The leverage applied to the position. | [default to undefined]
-**liquidationPriceE9** | **string** | The liquidation price of the position. | [default to undefined]
-**markPriceE9** | **string** | The current mark price of the position. | [default to undefined]
-**notionalValueE9** | **string** | The notional value of the position. | [default to undefined]
-**sizeE9** | **string** | The size of the position. | [default to undefined]
-**unrealizedPnlE9** | **string** | The unrealized profit and loss for the position. | [default to undefined]
-**marginRequiredE9** | **string** | The margin required for the position. | [default to undefined]
-**maintenanceMarginE9** | **string** | The maintenance margin required for the position. | [default to undefined]
-**isolatedMarginE9** | **string** | The isolated margin applied to the position. | [default to undefined]
-**reason** | **string** | The reason for the failure. | [default to undefined]
-**reasonCode** | [**CommandFailureReasonCode**](CommandFailureReasonCode.md) |  | [optional] [default to undefined]
-**failedCommandType** | **string** | The type of command that failed. | [default to undefined]
-**failedCommandTypeCode** | [**FailedCommandType**](FailedCommandType.md) |  | [optional] [default to undefined]
-**failedAtMillis** | **number** | The timestamp when the command failed in milliseconds. | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountStreamMessagePayload } from '@bluefin/api-client';
-
-const instance: AccountStreamMessagePayload = {
-    tradingFees,
-    canTrade,
-    canDeposit,
-    canWithdraw,
-    crossEffectiveBalanceE9,
-    crossMarginRequiredE9,
-    totalOrderMarginRequiredE9,
-    marginAvailableE9,
-    crossMaintenanceMarginRequiredE9,
-    crossMaintenanceMarginAvailableE9,
-    crossMaintenanceMarginRatioE9,
-    crossLeverageE9,
-    totalUnrealizedPnlE9,
-    crossUnrealizedPnlE9,
-    crossUnrealizedLossE9,
-    crossAccountValueE9,
-    totalAccountValueE9,
-    updatedAtMillis,
-    assets,
-    authorizedAccounts,
-    authorizedWallets,
-    trade,
-    orderHash,
-    clientOrderId,
-    symbol,
-    accountAddress,
-    priceE9,
-    quantityE9,
-    filledQuantityE9,
-    side,
-    leverageE9,
-    isIsolated,
-    salt,
-    expiresAtMillis,
-    signedAtMillis,
-    signerAddress,
-    type,
-    reduceOnly,
-    postOnly,
-    timeInForce,
-    triggerPriceE9,
-    status,
-    selfTradePreventionType,
-    createdAtMillis,
-    cancellationReason,
-    failureToCancelReason,
-    remainingQuantityE9,
-    transactionType,
-    amountE9,
-    assetSymbol,
-    tradeId,
-    executedAtMillis,
-    avgEntryPriceE9,
-    clientSetLeverageE9,
-    liquidationPriceE9,
-    markPriceE9,
-    notionalValueE9,
-    sizeE9,
-    unrealizedPnlE9,
-    marginRequiredE9,
-    maintenanceMarginE9,
-    isolatedMarginE9,
-    reason,
-    reasonCode,
-    failedCommandType,
-    failedCommandTypeCode,
-    failedAtMillis,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AccountSubscriptionMessage.md

@@ -1,25 +0,0 @@
-# AccountSubscriptionMessage
-
-Subscription message for account data streams.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**authToken** | **string** | The authentication token for the account. | [optional] [default to undefined]
-**method** | [**SubscriptionType**](SubscriptionType.md) |  | [default to undefined]
-**dataStreams** | [**Array<AccountDataStream>**](AccountDataStream.md) | List of account data streams to subscribe or unsubscribe from. | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountSubscriptionMessage } from '@bluefin/api-client';
-
-const instance: AccountSubscriptionMessage = {
-    authToken,
-    method,
-    dataStreams,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AccountTradeUpdate.md

@@ -1,21 +0,0 @@
-# AccountTradeUpdate
-
-Details about a trade in the account.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**trade** | [**Trade**](Trade.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountTradeUpdate } from '@bluefin/api-client';
-
-const instance: AccountTradeUpdate = {
-    trade,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AccountTransactionUpdate.md

@@ -1,31 +0,0 @@
-# AccountTransactionUpdate
-
-Details about a transaction in the account.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **string** | The symbol of the market. | [optional] [default to undefined]
-**transactionType** | [**TransactionType**](TransactionType.md) |  | [default to undefined]
-**amountE9** | **string** | The amount of the transaction in scientific notation with 9 decimal places. | [default to undefined]
-**assetSymbol** | **string** | The symbol of the asset. | [optional] [default to undefined]
-**tradeId** | **string** | The trade ID associated with the transaction. | [optional] [default to undefined]
-**executedAtMillis** | **number** | The timestamp when the transaction was executed in milliseconds. | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountTransactionUpdate } from '@bluefin/api-client';
-
-const instance: AccountTransactionUpdate = {
-    symbol,
-    transactionType,
-    amountE9,
-    assetSymbol,
-    tradeId,
-    executedAtMillis,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AccountUpdate.md

@@ -1,61 +0,0 @@
-# AccountUpdate
-
-Account information for the data stream.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tradingFees** | [**TradingFees**](TradingFees.md) |  | [optional] [default to undefined]
-**canTrade** | **boolean** | If the user can trade. | [default to undefined]
-**canDeposit** | **boolean** | If the current user can deposit to the account. | [default to undefined]
-**canWithdraw** | **boolean** | If the current user can withdraw from the account. | [default to undefined]
-**crossEffectiveBalanceE9** | **string** | Total effective balance in USD (e9 format). | [default to undefined]
-**crossMarginRequiredE9** | **string** | The sum of initial margin required across all cross positions (e9 format). | [default to undefined]
-**totalOrderMarginRequiredE9** | **string** | The sum of initial margin required across all open orders (e9 format). | [default to undefined]
-**marginAvailableE9** | **string** | The amount of margin available to open new positions and orders (e9 format). | [default to undefined]
-**crossMaintenanceMarginRequiredE9** | **string** | The sum of maintenance margin required across all cross positions (e9 format). | [default to undefined]
-**crossMaintenanceMarginAvailableE9** | **string** | The amount of margin available before liquidation (e9 format). | [default to undefined]
-**crossMaintenanceMarginRatioE9** | **string** | The ratio of the maintenance margin required to the account value (e9 format). | [default to undefined]
-**crossLeverageE9** | **string** | The leverage of the account (e9 format). | [default to undefined]
-**totalUnrealizedPnlE9** | **string** | Total unrealized profit (e9 format). | [default to undefined]
-**crossUnrealizedPnlE9** | **string** | Unrealized profit of cross positions (e9 format). | [default to undefined]
-**crossUnrealizedLossE9** | **string** | An implicitly negative number that sums only the losses of all cross positions. | [default to undefined]
-**crossAccountValueE9** | **string** | The total value of the cross account, combining the cross effective balance and unrealized PnL across all cross positions, and subtracting any pending funding payments on any cross position.  | [default to undefined]
-**totalAccountValueE9** | **string** | The total value of the account, combining the total effective balance and unrealized PnL across all positions, and subtracting any pending funding payments on any position.  | [default to undefined]
-**updatedAtMillis** | **number** | Last update time in milliseconds since Unix epoch. | [default to undefined]
-**assets** | [**Array<Asset>**](Asset.md) |  | [default to undefined]
-**authorizedAccounts** | **Array<string>** | Deprecated: Replaced with authorizedWallets. | [default to undefined]
-**authorizedWallets** | [**Array<AuthorizedWallet>**](AuthorizedWallet.md) | The wallets that are authorized to trade on behalf of the current account. | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountUpdate } from '@bluefin/api-client';
-
-const instance: AccountUpdate = {
-    tradingFees,
-    canTrade,
-    canDeposit,
-    canWithdraw,
-    crossEffectiveBalanceE9,
-    crossMarginRequiredE9,
-    totalOrderMarginRequiredE9,
-    marginAvailableE9,
-    crossMaintenanceMarginRequiredE9,
-    crossMaintenanceMarginAvailableE9,
-    crossMaintenanceMarginRatioE9,
-    crossLeverageE9,
-    totalUnrealizedPnlE9,
-    crossUnrealizedPnlE9,
-    crossUnrealizedLossE9,
-    crossAccountValueE9,
-    totalAccountValueE9,
-    updatedAtMillis,
-    assets,
-    authorizedAccounts,
-    authorizedWallets,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/ActiveOrderUpdate.md

@@ -1,65 +0,0 @@
-# ActiveOrderUpdate
-
-Information about an order update.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**orderHash** | **string** | The unique hash of the order. | [default to undefined]
-**clientOrderId** | **string** | The client-provided order ID. | [optional] [default to undefined]
-**symbol** | **string** | The symbol of the market. | [default to undefined]
-**accountAddress** | **string** | The address of the account. | [default to undefined]
-**priceE9** | **string** | The price of the order in scientific notation with 9 decimal places. | [default to undefined]
-**quantityE9** | **string** | The quantity of the order in scientific notation with 9 decimal places. | [default to undefined]
-**filledQuantityE9** | **string** | The filled quantity of the order in scientific notation with 9 decimal places. | [default to undefined]
-**side** | [**TradeSide**](TradeSide.md) |  | [default to undefined]
-**leverageE9** | **string** | The leverage of the order in scientific notation with 9 decimal places. | [default to undefined]
-**isIsolated** | **boolean** | Indicates if the order is isolated. | [default to undefined]
-**salt** | **string** | A unique salt for the order. | [default to undefined]
-**expiresAtMillis** | **number** | The expiration timestamp of the order in milliseconds. | [default to undefined]
-**signedAtMillis** | **number** | The signing timestamp of the order in milliseconds. | [default to undefined]
-**signerAddress** | **string** | The address of the signer of the order request. | [default to undefined]
-**type** | [**OrderType**](OrderType.md) |  | [default to undefined]
-**reduceOnly** | **boolean** | Indicates if the order is reduce-only. | [default to undefined]
-**postOnly** | **boolean** | Indicates if the order is post-only. | [default to undefined]
-**timeInForce** | [**OrderTimeInForce**](OrderTimeInForce.md) |  | [default to undefined]
-**triggerPriceE9** | **string** | The trigger price for stop-limit or stop-market orders. | [optional] [default to undefined]
-**status** | [**OrderStatus**](OrderStatus.md) |  | [default to undefined]
-**selfTradePreventionType** | [**SelfTradePreventionType**](SelfTradePreventionType.md) |  | [default to undefined]
-**createdAtMillis** | **number** | The timestamp when the order was placed, in milliseconds. | [default to undefined]
-**updatedAtMillis** | **number** | The timestamp of the last update of the order in milliseconds. | [default to undefined]
-
-## Example
-
-```typescript
-import { ActiveOrderUpdate } from '@bluefin/api-client';
-
-const instance: ActiveOrderUpdate = {
-    orderHash,
-    clientOrderId,
-    symbol,
-    accountAddress,
-    priceE9,
-    quantityE9,
-    filledQuantityE9,
-    side,
-    leverageE9,
-    isIsolated,
-    salt,
-    expiresAtMillis,
-    signedAtMillis,
-    signerAddress,
-    type,
-    reduceOnly,
-    postOnly,
-    timeInForce,
-    triggerPriceE9,
-    status,
-    selfTradePreventionType,
-    createdAtMillis,
-    updatedAtMillis,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AdjustIsolatedMarginRequest.md

@@ -1,22 +0,0 @@
-# AdjustIsolatedMarginRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**signedFields** | [**AdjustIsolatedMarginRequestSignedFields**](AdjustIsolatedMarginRequestSignedFields.md) |  | [default to undefined]
-**signature** | **string** | The signature of the request, encoded from the signedFields | [default to undefined]
-
-## Example
-
-```typescript
-import { AdjustIsolatedMarginRequest } from '@bluefin/api-client';
-
-const instance: AdjustIsolatedMarginRequest = {
-    signedFields,
-    signature,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AdjustIsolatedMarginRequestSignedFields.md

@@ -1,32 +0,0 @@
-# AdjustIsolatedMarginRequestSignedFields
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**idsId** | **string** | the ID of the internal datastore for the target network | [default to undefined]
-**accountAddress** | **string** | The account address of the account for which to adjust margin | [default to undefined]
-**symbol** | **string** | The symbol of the isolated position for which to adjust margin | [default to undefined]
-**operation** | [**AdjustMarginOperation**](AdjustMarginOperation.md) |  | [default to undefined]
-**quantityE9** | **string** | The quantity of margin to adjust for the isolated position | [default to undefined]
-**salt** | **string** | The random generated SALT. Should always be a number | [default to undefined]
-**signedAtMillis** | **number** | The timestamp in millis at which the request was signed | [default to undefined]
-
-## Example
-
-```typescript
-import { AdjustIsolatedMarginRequestSignedFields } from '@bluefin/api-client';
-
-const instance: AdjustIsolatedMarginRequestSignedFields = {
-    idsId,
-    accountAddress,
-    symbol,
-    operation,
-    quantityE9,
-    salt,
-    signedAtMillis,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AdjustMarginOperation.md

@@ -1,11 +0,0 @@
-# AdjustMarginOperation
-
-The operation to perform on the margin
-
-## Enum
-
-* `Add` (value: `'ADD'`)
-
-* `Subtract` (value: `'SUBTRACT'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AffiliateIntervalOverview.md

@@ -1,56 +0,0 @@
-# AffiliateIntervalOverview
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**userAddress** | **string** | The user\'s wallet address | [default to undefined]
-**name** | **string** | Name of the affiliate | [optional] [default to undefined]
-**intervalNumber** | **number** | The interval number for the affiliate\'s earnings data | [default to undefined]
-**intervalStartDate** | **number** | Start date of the interval in seconds | [default to undefined]
-**intervalEndDate** | **number** | End date of the interval in seconds | [default to undefined]
-**status** | **string** | Status of the interval | [default to undefined]
-**referredSince** | **string** | Date when the user was referred | [default to undefined]
-**perpsRefereeEarningsE9** | **string** | Referee earnings from perps trading (e9 format) | [default to undefined]
-**spotLPRefereeEarningsE9** | **string** | Referee earnings from spot LP (e9 format) | [default to undefined]
-**lendingRefereeEarningsE9** | **string** | Referee earnings from lending (e9 format) | [default to undefined]
-**perpsReferralEarningsE9** | **string** | Referral earnings from perps trading (e9 format) | [default to undefined]
-**spotLPReferralEarningsE9** | **string** | Referral earnings from spot LP (e9 format) | [default to undefined]
-**lendingReferralEarningsE9** | **string** | Referral earnings from lending (e9 format) | [default to undefined]
-**perpsTotalEarningsE9** | **string** | Total earnings from perps trading (e9 format) | [default to undefined]
-**spotLPTotalEarningsE9** | **string** | Total earnings from spot LP (e9 format) | [default to undefined]
-**lendingTotalEarningsE9** | **string** | Total earnings from lending (e9 format) | [default to undefined]
-**totalReferralEarningsE9** | **string** | Total earnings from referrals (e9 format) | [default to undefined]
-**totalRefereeEarningsE9** | **string** | Total earnings from referee activities (e9 format) | [default to undefined]
-**totalEarningsE9** | **string** | Total earnings combining referrals and referee activities (e9 format) | [default to undefined]
-
-## Example
-
-```typescript
-import { AffiliateIntervalOverview } from '@bluefin/api-client';
-
-const instance: AffiliateIntervalOverview = {
-    userAddress,
-    name,
-    intervalNumber,
-    intervalStartDate,
-    intervalEndDate,
-    status,
-    referredSince,
-    perpsRefereeEarningsE9,
-    spotLPRefereeEarningsE9,
-    lendingRefereeEarningsE9,
-    perpsReferralEarningsE9,
-    spotLPReferralEarningsE9,
-    lendingReferralEarningsE9,
-    perpsTotalEarningsE9,
-    spotLPTotalEarningsE9,
-    lendingTotalEarningsE9,
-    totalReferralEarningsE9,
-    totalRefereeEarningsE9,
-    totalEarningsE9,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AffiliateLeaderDashboard.md

@@ -1,38 +0,0 @@
-# AffiliateLeaderDashboard
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**userAddress** | **string** | The user\'s wallet address | [default to undefined]
-**name** | **string** | Name of the affiliate | [optional] [default to undefined]
-**parentAddress** | **string** | The parent affiliate\'s wallet address | [default to undefined]
-**parentName** | **string** | Name of the parent affiliate | [optional] [default to undefined]
-**perpsRank** | **number** | Ranking in perps trading category | [default to undefined]
-**spotRank** | **number** | Ranking in spot trading category | [default to undefined]
-**lendingRank** | **number** | Ranking in lending category | [default to undefined]
-**perpsTotalEarningsE9** | **string** | Total earnings from perps trading (e9 format) | [default to undefined]
-**spotTotalEarningsE9** | **string** | Total earnings from spot trading (e9 format) | [default to undefined]
-**lendingTotalEarningsE9** | **string** | Total earnings from lending (e9 format) | [default to undefined]
-
-## Example
-
-```typescript
-import { AffiliateLeaderDashboard } from '@bluefin/api-client';
-
-const instance: AffiliateLeaderDashboard = {
-    userAddress,
-    name,
-    parentAddress,
-    parentName,
-    perpsRank,
-    spotRank,
-    lendingRank,
-    perpsTotalEarningsE9,
-    spotTotalEarningsE9,
-    lendingTotalEarningsE9,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/src/docs/AffiliateMetadata.md

@@ -1,36 +0,0 @@
-# AffiliateMetadata
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**userAddress** | **string** | The user\'s wallet address | [default to undefined]
-**parentReferralCode** | **string** | The referral code of the parent affiliate | [optional] [default to undefined]
-**referralCode** | **string** | The user\'s referral code if approved as an affiliate | [optional] [default to undefined]
-**name** | **string** | The name of the affiliate | [optional] [default to undefined]
-**parentName** | **string** | The name of the parent affiliate | [optional] [default to undefined]
-**fees** | [**FeeConfigs**](.md) |  | [optional] [default to undefined]
-**status** | **string** | Status of the affiliate application | [optional] [default to undefined]
-**hasTraded** | **boolean** | Indicates whether the user has traded or not | [default to undefined]
-**tier** | **string** | Tier of the affiliate | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AffiliateMetadata } from '@bluefin/api-client';
-
-const instance: AffiliateMetadata = {
-    userAddress,
-    parentReferralCode,
-    referralCode,
-    name,
-    parentName,
-    fees,
-    status,
-    hasTraded,
-    tier,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)