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

package/src/docs/AffiliateMetadataFees.md

@@ -1,31 +0,0 @@
-# AffiliateMetadataFees
-
-Map of various fee-related configurations
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**referralPerpsFee** | **string** | Earnings from referral perps fees (e9 format) | [optional] [default to undefined]
-**subaffiliatePerpsEarnings** | **string** | Earnings from subaffiliate perps (e9 format) | [optional] [default to undefined]
-**spotLPFee** | **string** | Earnings from spot LP fees (e9 format) | [optional] [default to undefined]
-**referralSpotLPFee** | **string** | Earnings from referral spot LP fees (e9 format) | [optional] [default to undefined]
-**referralLendingRewards** | **string** | Earnings from referral lending rewards (e9 format) | [optional] [default to undefined]
-**perpsFeeCashback** | **string** | Cashback from perps fees (e9 format) | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AffiliateMetadataFees } from '@bluefin/api-client';
-
-const instance: AffiliateMetadataFees = {
-    referralPerpsFee,
-    subaffiliatePerpsEarnings,
-    spotLPFee,
-    referralSpotLPFee,
-    referralLendingRewards,
-    perpsFeeCashback,
-};
-```
-
-[[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/AffiliateOnboardResponse.md

@@ -1,22 +0,0 @@
-# AffiliateOnboardResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **string** | Status of the application | [default to undefined]
-**message** | **string** | Response message including rejection reason if application was rejected | [default to undefined]
-
-## Example
-
-```typescript
-import { AffiliateOnboardResponse } from '@bluefin/api-client';
-
-const instance: AffiliateOnboardResponse = {
-    status,
-    message,
-};
-```
-
-[[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/AffiliateOverview.md

@@ -1,46 +0,0 @@
-# AffiliateOverview
-
-
-## 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]
-**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 { AffiliateOverview } from '@bluefin/api-client';
-
-const instance: AffiliateOverview = {
-    userAddress,
-    name,
-    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/AffiliateSummary.md

@@ -1,30 +0,0 @@
-# AffiliateSummary
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**userAddress** | **string** | The user\'s wallet address | [default to undefined]
-**totalReferredUsers** | **number** | Total number of referees | [default to undefined]
-**totalEarningsE9** | **string** | Total earnings in e9 format | [default to undefined]
-**perpsRanking** | **number** | Ranking in perps trading category | [default to undefined]
-**spotRanking** | **number** | Ranking in spot trading category | [default to undefined]
-**lendRanking** | **number** | Ranking in lending category | [default to undefined]
-
-## Example
-
-```typescript
-import { AffiliateSummary } from '@bluefin/api-client';
-
-const instance: AffiliateSummary = {
-    userAddress,
-    totalReferredUsers,
-    totalEarningsE9,
-    perpsRanking,
-    spotRanking,
-    lendRanking,
-};
-```
-
-[[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/Asset.md

@@ -1,29 +0,0 @@
-# Asset
-
-Details about an asset in the account.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **string** | The symbol of the asset. | [default to undefined]
-**quantityE9** | **string** | The quantity of the asset. | [default to undefined]
-**effectiveBalanceE9** | **string** | The effective balance of the asset. | [default to undefined]
-**maxWithdrawQuantityE9** | **string** | The maximum quantity that can be withdrawn. | [default to undefined]
-**updatedAtMillis** | **number** | The timestamp of the last update in milliseconds. | [default to undefined]
-
-## Example
-
-```typescript
-import { Asset } from '@bluefin/api-client';
-
-const instance: Asset = {
-    symbol,
-    quantityE9,
-    effectiveBalanceE9,
-    maxWithdrawQuantityE9,
-    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/AssetConfig.md

@@ -1,28 +0,0 @@
-# AssetConfig
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**assetType** | **string** | The bank address of the asset. | [default to undefined]
-**symbol** | **string** | Asset symbol. | [default to undefined]
-**decimals** | **number** | Default precision for rendering this asset. | [default to undefined]
-**weight** | **string** | Weight applied to asset to use as margin in Multi-Assets mode. | [default to undefined]
-**marginAvailable** | **boolean** | Indicates if the asset can be used as margin in Multi-Assets mode. | [default to undefined]
-
-## Example
-
-```typescript
-import { AssetConfig } from '@bluefin/api-client';
-
-const instance: AssetConfig = {
-    assetType,
-    symbol,
-    decimals,
-    weight,
-    marginAvailable,
-};
-```
-
-[[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/AuthApi.md

@@ -1,243 +0,0 @@
-# AuthApi
-
-All URIs are relative to *https://api.sui-staging.bluefin.io*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**authJwksGet**](#authjwksget) | **GET** /auth/jwks | |
-|[**authTokenPost**](#authtokenpost) | **POST** /auth/token | |
-|[**authTokenRefreshPut**](#authtokenrefreshput) | **PUT** /auth/token/refresh | |
-|[**authV2TokenPost**](#authv2tokenpost) | **POST** /auth/v2/token | |
-
-# **authJwksGet**
-> { [key: string]: any | undefined; } authJwksGet()
-
-
-### Example
-
-```typescript
-import {
-    AuthApi,
-    Configuration
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new AuthApi(configuration);
-
-const { status, data } = await apiInstance.authJwksGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**{ [key: string]: any | undefined; }**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**0** | Unexpected error |  -  |
-
-[[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)
-
-# **authTokenPost**
-> LoginResponse authTokenPost(loginRequest)
-
-login with token
-
-### Example
-
-```typescript
-import {
-    AuthApi,
-    Configuration,
-    LoginRequest
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new AuthApi(configuration);
-
-let payloadSignature: string; // (default to undefined)
-let loginRequest: LoginRequest; //
-let refreshTokenValidForSeconds: number; //The number of seconds the refresh token is valid for. If not provided, the default is 30 days. (optional) (default to 2592000)
-let readOnly: boolean; // (optional) (default to false)
-
-const { status, data } = await apiInstance.authTokenPost(
-    payloadSignature,
-    loginRequest,
-    refreshTokenValidForSeconds,
-    readOnly
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **loginRequest** | **LoginRequest**|  | |
-| **payloadSignature** | [**string**] |  | defaults to undefined|
-| **refreshTokenValidForSeconds** | [**number**] | The number of seconds the refresh token is valid for. If not provided, the default is 30 days. | (optional) defaults to 2592000|
-| **readOnly** | [**boolean**] |  | (optional) defaults to false|
-
-
-### Return type
-
-**LoginResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**400** | bad signature |  -  |
-|**401** | invalid signature |  -  |
-|**403** | invalid audience |  -  |
-|**500** | internal server error |  -  |
-|**0** | Unexpected error |  -  |
-
-[[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)
-
-# **authTokenRefreshPut**
-> RefreshTokenResponse authTokenRefreshPut(refreshTokenRequest)
-
-Retrieves a new auth token for an account. Expiry is set to 5 min
-
-### Example
-
-```typescript
-import {
-    AuthApi,
-    Configuration,
-    RefreshTokenRequest
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new AuthApi(configuration);
-
-let refreshTokenRequest: RefreshTokenRequest; //
-
-const { status, data } = await apiInstance.authTokenRefreshPut(
-    refreshTokenRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **refreshTokenRequest** | **RefreshTokenRequest**|  | |
-
-
-### Return type
-
-**RefreshTokenResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**401** | invalid signature |  -  |
-|**400** | missing refresh token in request |  -  |
-|**500** | internal server error |  -  |
-|**0** | Unexpected error |  -  |
-
-[[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)
-
-# **authV2TokenPost**
-> LoginResponse authV2TokenPost(loginRequest)
-
-login compatible with BCS payload with intent bytes
-
-### Example
-
-```typescript
-import {
-    AuthApi,
-    Configuration,
-    LoginRequest
-} from '@bluefin/api-client';
-
-const configuration = new Configuration();
-const apiInstance = new AuthApi(configuration);
-
-let payloadSignature: string; // (default to undefined)
-let loginRequest: LoginRequest; //
-let refreshTokenValidForSeconds: number; //The number of seconds the refresh token is valid for. If not provided, the default is 30 days. (optional) (default to 2592000)
-let readOnly: boolean; // (optional) (default to false)
-
-const { status, data } = await apiInstance.authV2TokenPost(
-    payloadSignature,
-    loginRequest,
-    refreshTokenValidForSeconds,
-    readOnly
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **loginRequest** | **LoginRequest**|  | |
-| **payloadSignature** | [**string**] |  | defaults to undefined|
-| **refreshTokenValidForSeconds** | [**number**] | The number of seconds the refresh token is valid for. If not provided, the default is 30 days. | (optional) defaults to 2592000|
-| **readOnly** | [**boolean**] |  | (optional) defaults to false|
-
-
-### Return type
-
-**LoginResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | OK |  -  |
-|**400** | bad signature |  -  |
-|**401** | invalid signature |  -  |
-|**403** | invalid audience |  -  |
-|**500** | internal server error |  -  |
-|**0** | Unexpected error |  -  |
-
-[[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)
-

package/src/docs/AuthorizedWallet.md

@@ -1,24 +0,0 @@
-# AuthorizedWallet
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**address** | **string** | The address of the authorized wallet. | [default to undefined]
-**alias** | **string** | The alias of the authorized wallet. | [optional] [default to undefined]
-**authorizedAtMillis** | **number** | The timestamp in milliseconds when the wallet was authorized. | [default to undefined]
-
-## Example
-
-```typescript
-import { AuthorizedWallet } from '@bluefin/api-client';
-
-const instance: AuthorizedWallet = {
-    address,
-    alias,
-    authorizedAtMillis,
-};
-```
-
-[[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/CampaignMetadata.md

@@ -1,28 +0,0 @@
-# CampaignMetadata
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **string** |  | [default to undefined]
-**campaignName** | **string** | Name of the campaign. | [default to undefined]
-**parentCampaignName** | **string** | Name of the parent campaign. | [default to undefined]
-**startDate** | **number** | Time in seconds for campaign start date. | [default to undefined]
-**endDate** | **number** | Time in seconds for campaign end date. | [default to undefined]
-
-## Example
-
-```typescript
-import { CampaignMetadata } from '@bluefin/api-client';
-
-const instance: CampaignMetadata = {
-    status,
-    campaignName,
-    parentCampaignName,
-    startDate,
-    endDate,
-};
-```
-
-[[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/CampaignRewards.md

@@ -1,18 +0,0 @@
-# CampaignRewards
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Example
-
-```typescript
-import { CampaignRewards } from '@bluefin/api-client';
-
-const instance: CampaignRewards = {
-};
-```
-
-[[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/CancelOrdersRequest.md

@@ -1,23 +0,0 @@
-# CancelOrdersRequest
-
-Cancelling Orders for a specific symbol. If order hashes are not specified, all orders are canceled for this symbol
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **string** | The symbol of the perpetual for which to cancel orders. | [default to undefined]
-**orderHashes** | **Array<string>** | List of order hashes of the orders to be cancelled. All orders must belong to accountAddress. Max 10 order hashes | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CancelOrdersRequest } from '@bluefin/api-client';
-
-const instance: CancelOrdersRequest = {
-    symbol,
-    orderHashes,
-};
-```
-
-[[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/CancelOrdersResponse.md

@@ -1,21 +0,0 @@
-# CancelOrdersResponse
-
-Response to a request to cancel orders.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**orderHashes** | **Array<string>** | The order hashes of the cancelled orders. | [default to undefined]
-
-## Example
-
-```typescript
-import { CancelOrdersResponse } from '@bluefin/api-client';
-
-const instance: CancelOrdersResponse = {
-    orderHashes,
-};
-```
-
-[[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/CandlePriceType.md

@@ -1,14 +0,0 @@
-# CandlePriceType
-
-
-## Enum
-
-* `Last` (value: `'Last'`)
-
-* `Market` (value: `'Market'`)
-
-* `Oracle` (value: `'Oracle'`)
-
-* `Unspecified` (value: `'UNSPECIFIED'`)
-
-[[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/CandlestickUpdate.md

@@ -1,41 +0,0 @@
-# CandlestickUpdate
-
-Represents a candlestick for a specific market and interval.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**symbol** | **string** | The symbol of the market for this candlestick. | [default to undefined]
-**startTime** | **number** | The start time of the candlestick in milliseconds since epoch. | [default to undefined]
-**endTime** | **number** | The end time of the candlestick in milliseconds since epoch. | [default to undefined]
-**interval** | **string** | The interval of the candlestick (e.g., 1m, 5m, 1h). | [default to undefined]
-**openPriceE9** | **string** | The opening price of the candlestick. | [default to undefined]
-**closePriceE9** | **string** | The closing price of the candlestick. | [default to undefined]
-**highPriceE9** | **string** | The highest price during the candlestick interval. | [default to undefined]
-**lowPriceE9** | **string** | The lowest price during the candlestick interval. | [default to undefined]
-**volumeE9** | **string** | The total trading volume during the candlestick interval. | [default to undefined]
-**quoteVolumeE9** | **string** | The total quote volume traded during the candlestick interval. | [default to undefined]
-**numTrades** | **number** | The number of trades that occurred during the candlestick interval. | [default to undefined]
-
-## Example
-
-```typescript
-import { CandlestickUpdate } from '@bluefin/api-client';
-
-const instance: CandlestickUpdate = {
-    symbol,
-    startTime,
-    endTime,
-    interval,
-    openPriceE9,
-    closePriceE9,
-    highPriceE9,
-    lowPriceE9,
-    volumeE9,
-    quoteVolumeE9,
-    numTrades,
-};
-```
-
-[[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/CommandFailureReasonCode.md

@@ -1,24 +0,0 @@
-# CommandFailureReasonCode
-
-
-## Enum
-
-* `Unspecified` (value: `'UNSPECIFIED'`)
-
-* `UnknownAddress` (value: `'UNKNOWN_ADDRESS'`)
-
-* `UnknownSymbol` (value: `'UNKNOWN_SYMBOL'`)
-
-* `NoPosition` (value: `'NO_POSITION'`)
-
-* `InsufficientBalance` (value: `'INSUFFICIENT_BALANCE'`)
-
-* `DuplicateCommandHash` (value: `'DUPLICATE_COMMAND_HASH'`)
-
-* `InvalidLeverage` (value: `'INVALID_LEVERAGE'`)
-
-* `UnknownMarket` (value: `'UNKNOWN_MARKET'`)
-
-* `Unexpected` (value: `'UNEXPECTED'`)
-
-[[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/ContractsConfig.md

@@ -1,31 +0,0 @@
-# ContractsConfig
-
-Contract configuration for the exchange.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**edsId** | **string** | External Data Store Address | [default to undefined]
-**idsId** | **string** | External Data Store Address | [default to undefined]
-**network** | **string** | Network environment | [default to undefined]
-**baseContractAddress** | **string** | Base contract address | [default to undefined]
-**currentContractAddress** | **string** | Current contract address | [default to undefined]
-**operators** | [**Operators**](Operators.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ContractsConfig } from '@bluefin/api-client';
-
-const instance: ContractsConfig = {
-    edsId,
-    idsId,
-    network,
-    baseContractAddress,
-    currentContractAddress,
-    operators,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)