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

package/src/base.ts

@@ -1,86 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Bluefin API
- * Bluefin API
- *
- * The version of the OpenAPI document: 1.0.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-import type { Configuration } from './configuration';
-// Some imports not used depending on template conditions
-// @ts-ignore
-import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
-import globalAxios from 'axios';
-
-export const BASE_PATH = "https://api.sui-staging.bluefin.io".replace(/\/+$/, "");
-
-/**
- *
- * @export
- */
-export const COLLECTION_FORMATS = {
-    csv: ",",
-    ssv: " ",
-    tsv: "\t",
-    pipes: "|",
-};
-
-/**
- *
- * @export
- * @interface RequestArgs
- */
-export interface RequestArgs {
-    url: string;
-    options: RawAxiosRequestConfig;
-}
-
-/**
- *
- * @export
- * @class BaseAPI
- */
-export class BaseAPI {
-    protected configuration: Configuration | undefined;
-
-    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
-        if (configuration) {
-            this.configuration = configuration;
-            this.basePath = configuration.basePath ?? basePath;
-        }
-    }
-};
-
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-export class RequiredError extends Error {
-    constructor(public field: string, msg?: string) {
-        super(msg);
-        this.name = "RequiredError"
-    }
-}
-
-interface ServerMap {
-    [key: string]: {
-        url: string,
-        description: string,
-    }[];
-}
-
-/**
- *
- * @export
- */
-export const operationServerMap: ServerMap = {
-}

package/src/common.ts

@@ -1,150 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Bluefin API
- * Bluefin API
- *
- * The version of the OpenAPI document: 1.0.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-import type { Configuration } from "./configuration";
-import type { RequestArgs } from "./base";
-import type { AxiosInstance, AxiosResponse } from 'axios';
-import { RequiredError } from "./base";
-
-/**
- *
- * @export
- */
-export const DUMMY_BASE_URL = 'https://example.com'
-
-/**
- *
- * @throws {RequiredError}
- * @export
- */
-export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
-    if (paramValue === null || paramValue === undefined) {
-        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
-    }
-}
-
-/**
- *
- * @export
- */
-export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
-    if (configuration && configuration.apiKey) {
-        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
-            ? await configuration.apiKey(keyParamName)
-            : await configuration.apiKey;
-        object[keyParamName] = localVarApiKeyValue;
-    }
-}
-
-/**
- *
- * @export
- */
-export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
-    if (configuration && (configuration.username || configuration.password)) {
-        object["auth"] = { username: configuration.username, password: configuration.password };
-    }
-}
-
-/**
- *
- * @export
- */
-export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
-    if (configuration && configuration.accessToken) {
-        const accessToken = typeof configuration.accessToken === 'function'
-            ? await configuration.accessToken()
-            : await configuration.accessToken;
-        object["Authorization"] = "Bearer " + accessToken;
-    }
-}
-
-/**
- *
- * @export
- */
-export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
-    if (configuration && configuration.accessToken) {
-        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
-            ? await configuration.accessToken(name, scopes)
-            : await configuration.accessToken;
-        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
-    }
-}
-
-function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
-    if (parameter == null) return;
-    if (typeof parameter === "object") {
-        if (Array.isArray(parameter)) {
-            (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
-        } 
-        else {
-            Object.keys(parameter).forEach(currentKey => 
-                setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
-            );
-        }
-    } 
-    else {
-        if (urlSearchParams.has(key)) {
-            urlSearchParams.append(key, parameter);
-        } 
-        else {
-            urlSearchParams.set(key, parameter);
-        }
-    }
-}
-
-/**
- *
- * @export
- */
-export const setSearchParams = function (url: URL, ...objects: any[]) {
-    const searchParams = new URLSearchParams(url.search);
-    setFlattenedQueryParams(searchParams, objects);
-    url.search = searchParams.toString();
-}
-
-/**
- *
- * @export
- */
-export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
-    const nonString = typeof value !== 'string';
-    const needsSerialization = nonString && configuration && configuration.isJsonMime
-        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
-        : nonString;
-    return needsSerialization
-        ? JSON.stringify(value !== undefined ? value : {})
-        : (value || "");
-}
-
-/**
- *
- * @export
- */
-export const toPathString = function (url: URL) {
-    return url.pathname + url.search + url.hash
-}
-
-/**
- *
- * @export
- */
-export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
-    return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
-        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
-        return axios.request<T, R>(axiosRequestArgs);
-    };
-}

package/src/configuration.ts

@@ -1,115 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Bluefin API
- * Bluefin API
- *
- * The version of the OpenAPI document: 1.0.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-export interface ConfigurationParameters {
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    username?: string;
-    password?: string;
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    basePath?: string;
-    serverIndex?: number;
-    baseOptions?: any;
-    formDataCtor?: new () => any;
-}
-
-export class Configuration {
-    /**
-     * parameter for apiKey security
-     * @param name security name
-     * @memberof Configuration
-     */
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    username?: string;
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    password?: string;
-    /**
-     * parameter for oauth2 security
-     * @param name security name
-     * @param scopes oauth2 scope
-     * @memberof Configuration
-     */
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    /**
-     * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    basePath?: string;
-    /**
-     * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
-     */
-    serverIndex?: number;
-    /**
-     * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
-     */
-    baseOptions?: any;
-    /**
-     * The FormData constructor that will be used to create multipart form data
-     * requests. You can inject this here so that execution environments that
-     * do not support the FormData class can still run the generated client.
-     *
-     * @type {new () => FormData}
-     */
-    formDataCtor?: new () => any;
-
-    constructor(param: ConfigurationParameters = {}) {
-        this.apiKey = param.apiKey;
-        this.username = param.username;
-        this.password = param.password;
-        this.accessToken = param.accessToken;
-        this.basePath = param.basePath;
-        this.serverIndex = param.serverIndex;
-        this.baseOptions = {
-            ...param.baseOptions,
-            headers: {
-                ...param.baseOptions?.headers,
-            },
-        };
-        this.formDataCtor = param.formDataCtor;
-    }
-
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    public isJsonMime(mime: string): boolean {
-        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
-        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
-    }
-}

package/src/docs/Account.md

@@ -1,64 +0,0 @@
-# Account
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tradingFees** | [**TradingFees**](TradingFees.md) |  | [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]
-**positions** | [**Array<Position>**](Position.md) |  | [default to undefined]
-**authorizedAccounts** | **Array<string>** | Deprecated: Replaced with authorizedWallets. | [default to undefined]
-**accountAddress** | **string** | The address of the account. | [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 { Account } from '@bluefin/api-client';
-
-const instance: Account = {
-    tradingFees,
-    canTrade,
-    canDeposit,
-    canWithdraw,
-    crossEffectiveBalanceE9,
-    crossMarginRequiredE9,
-    totalOrderMarginRequiredE9,
-    marginAvailableE9,
-    crossMaintenanceMarginRequiredE9,
-    crossMaintenanceMarginAvailableE9,
-    crossMaintenanceMarginRatioE9,
-    crossLeverageE9,
-    totalUnrealizedPnlE9,
-    crossUnrealizedPnlE9,
-    crossUnrealizedLossE9,
-    crossAccountValueE9,
-    totalAccountValueE9,
-    updatedAtMillis,
-    assets,
-    positions,
-    authorizedAccounts,
-    accountAddress,
-    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/AccountAggregatedTradeUpdate.md

@@ -1,21 +0,0 @@
-# AccountAggregatedTradeUpdate
-
-Aggregated details about a trade in the account.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**trade** | [**Trade**](Trade.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountAggregatedTradeUpdate } from '@bluefin/api-client';
-
-const instance: AccountAggregatedTradeUpdate = {
-    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/AccountAuthorizationRequest.md

@@ -1,24 +0,0 @@
-# AccountAuthorizationRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**signedFields** | [**AccountAuthorizationRequestSignedFields**](AccountAuthorizationRequestSignedFields.md) |  | [default to undefined]
-**signature** | **string** | The signature of the request, encoded from the signedFields | [default to undefined]
-**alias** | **string** | The (optional) alias of the account that is being authorized or deauthorized | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AccountAuthorizationRequest } from '@bluefin/api-client';
-
-const instance: AccountAuthorizationRequest = {
-    signedFields,
-    signature,
-    alias,
-};
-```
-
-[[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/AccountAuthorizationRequestSignedFields.md

@@ -1,28 +0,0 @@
-# AccountAuthorizationRequestSignedFields
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**accountAddress** | **string** | The account address of the parent account that is authorizing/deauthorizing this account | [default to undefined]
-**authorizedAccountAddress** | **string** | The address of the account that should be authorized/deauthorized | [default to undefined]
-**salt** | **string** | The random generated salt. Should always be a number | [default to undefined]
-**idsId** | **string** | the ID of the internal datastore for the target network | [default to undefined]
-**signedAtMillis** | **number** | The timestamp when the request was signed | [default to undefined]
-
-## Example
-
-```typescript
-import { AccountAuthorizationRequestSignedFields } from '@bluefin/api-client';
-
-const instance: AccountAuthorizationRequestSignedFields = {
-    accountAddress,
-    authorizedAccountAddress,
-    salt,
-    idsId,
-    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/AccountCommandFailureUpdate.md

@@ -1,29 +0,0 @@
-# AccountCommandFailureUpdate
-
-Details about a failure during an account command execution.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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 { AccountCommandFailureUpdate } from '@bluefin/api-client';
-
-const instance: AccountCommandFailureUpdate = {
-    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)