@drakkar.software/octobot-protocol 0.1.0

package/models/Trade.ts

@@ -0,0 +1,99 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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 { OrderStatus } from '../models/OrderStatus';
+import { OrderType } from '../models/OrderType';
+import { Side } from '../models/Side';
+
+/**
+* Trade
+*/
+export class Trade {
+    'id': string;
+    'trade_id': string;
+    'type': OrderType;
+    'symbol': string;
+    'side': Side;
+    'quantity': number;
+    'price': number;
+    'status': OrderStatus;
+    'executed_at': Date;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "trade_id",
+            "baseName": "trade_id",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "type",
+            "baseName": "type",
+            "type": "OrderType",
+            "format": ""
+        },
+        {
+            "name": "symbol",
+            "baseName": "symbol",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "side",
+            "baseName": "side",
+            "type": "Side",
+            "format": ""
+        },
+        {
+            "name": "quantity",
+            "baseName": "quantity",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "price",
+            "baseName": "price",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "OrderStatus",
+            "format": ""
+        },
+        {
+            "name": "executed_at",
+            "baseName": "executed_at",
+            "type": "Date",
+            "format": "date-time"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Trade.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/TradeSummary.ts

@@ -0,0 +1,45 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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.
+ */
+
+
+/**
+* TradeSummary
+*/
+export class TradeSummary {
+    'id': string;
+    'symbol': string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "symbol",
+            "baseName": "symbol",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return TradeSummary.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}

package/models/TradingType.ts

@@ -0,0 +1,22 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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.
+ */
+
+
+/**
+* TradingType
+*/
+export enum TradingType {
+    Spot = 'spot',
+    Futures = 'futures',
+    Options = 'options',
+    Margin = 'margin'
+}

package/models/TrailingProfile.ts

@@ -0,0 +1,48 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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 { TrailingProfileType } from '../models/TrailingProfileType';
+
+/**
+* TrailingProfile
+*/
+export class TrailingProfile {
+    'type': TrailingProfileType;
+    'details'?: any;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "type",
+            "baseName": "type",
+            "type": "TrailingProfileType",
+            "format": ""
+        },
+        {
+            "name": "details",
+            "baseName": "details",
+            "type": "any",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return TrailingProfile.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/TrailingProfileType.ts

@@ -0,0 +1,19 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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.
+ */
+
+
+/**
+* Trailing profile discriminator (mirrors octobot_trading TrailingProfileTypes values).
+*/
+export enum TrailingProfileType {
+    FilledTakeProfit = 'filled_take_profit'
+}

package/models/UserAction.ts

@@ -0,0 +1,78 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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 { UserActionConfiguration } from '../models/UserActionConfiguration';
+import { UserActionResult } from '../models/UserActionResult';
+import { UserActionStatus } from '../models/UserActionStatus';
+
+/**
+* UserAction
+*/
+export class UserAction {
+    'id': string;
+    'status'?: UserActionStatus;
+    'created_at'?: Date;
+    'updated_at'?: Date;
+    'configuration'?: UserActionConfiguration;
+    'result'?: UserActionResult;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "UserActionStatus",
+            "format": ""
+        },
+        {
+            "name": "created_at",
+            "baseName": "created_at",
+            "type": "Date",
+            "format": "date-time"
+        },
+        {
+            "name": "updated_at",
+            "baseName": "updated_at",
+            "type": "Date",
+            "format": "date-time"
+        },
+        {
+            "name": "configuration",
+            "baseName": "configuration",
+            "type": "UserActionConfiguration",
+            "format": ""
+        },
+        {
+            "name": "result",
+            "baseName": "result",
+            "type": "UserActionResult",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UserAction.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/UserActionConfiguration.ts

@@ -0,0 +1,50 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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 { CreateAccountConfiguration } from '../models/CreateAccountConfiguration';
+import { CreateAutomationConfiguration } from '../models/CreateAutomationConfiguration';
+import { DeleteAccountConfiguration } from '../models/DeleteAccountConfiguration';
+import { EditAccountConfiguration } from '../models/EditAccountConfiguration';
+import { EditAutomationConfiguration } from '../models/EditAutomationConfiguration';
+import { RefreshAccountsConfiguration } from '../models/RefreshAccountsConfiguration';
+import { StopAutomationConfiguration } from '../models/StopAutomationConfiguration';
+
+/**
+ * @type UserActionConfiguration
+ * Type
+ * @export
+ */
+export type UserActionConfiguration = CreateAccountConfiguration | CreateAutomationConfiguration | DeleteAccountConfiguration | EditAccountConfiguration | EditAutomationConfiguration | RefreshAccountsConfiguration | StopAutomationConfiguration;
+
+/**
+* @type UserActionConfigurationClass
+* @export
+*/
+export class UserActionConfigurationClass {
+    static readonly discriminator: string | undefined = "action_type";
+
+    static readonly mapping: {[index: string]: string} | undefined = {
+        "account_create": "CreateAccountConfiguration",
+        "account_delete": "DeleteAccountConfiguration",
+        "account_edit": "EditAccountConfiguration",
+        "accounts_refresh": "RefreshAccountsConfiguration",
+        "automation_create": "CreateAutomationConfiguration",
+        "automation_edit": "EditAutomationConfiguration",
+        "automation_stop": "StopAutomationConfiguration",
+    };
+}
+
+
+
+
+
+

package/models/UserActionResult.ts

@@ -0,0 +1,35 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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 { AccountActionResult } from '../models/AccountActionResult';
+import { AutomationActionResult } from '../models/AutomationActionResult';
+
+/**
+ * @type UserActionResult
+ * Type
+ * @export
+ */
+export type UserActionResult = AccountActionResult | AutomationActionResult;
+
+/**
+* @type UserActionResultClass
+* @export
+*/
+export class UserActionResultClass {
+    static readonly discriminator: string | undefined = "result_type";
+
+    static readonly mapping: {[index: string]: string} | undefined = {
+        "account": "AccountActionResult",
+        "automation": "AutomationActionResult",
+    };
+}
+

package/models/UserActionResultType.ts

@@ -0,0 +1,20 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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.
+ */
+
+
+/**
+* UserActionResultType
+*/
+export enum UserActionResultType {
+    Automation = 'automation',
+    Account = 'account'
+}

package/models/UserActionStatus.ts

@@ -0,0 +1,22 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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.
+ */
+
+
+/**
+* UserActionStatus
+*/
+export enum UserActionStatus {
+    Pending = 'pending',
+    Running = 'running',
+    Completed = 'completed',
+    Failed = 'failed'
+}

package/models/UserActionType.ts

@@ -0,0 +1,25 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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.
+ */
+
+
+/**
+* UserActionType
+*/
+export enum UserActionType {
+    AutomationCreate = 'automation_create',
+    AutomationEdit = 'automation_edit',
+    AutomationStop = 'automation_stop',
+    AccountCreate = 'account_create',
+    AccountEdit = 'account_edit',
+    AccountDelete = 'account_delete',
+    AccountsRefresh = 'accounts_refresh'
+}

package/models/UserActionsState.ts

@@ -0,0 +1,46 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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 { UserAction } from '../models/UserAction';
+
+/**
+* UserActionsState
+*/
+export class UserActionsState {
+    'version': string;
+    'user_actions'?: Array<UserAction>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "version",
+            "baseName": "version",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "user_actions",
+            "baseName": "user_actions",
+            "type": "Array<UserAction>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UserActionsState.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}

package/models/UserDataState.ts

@@ -0,0 +1,54 @@
+/**
+ * OctoBot protocol types
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * OpenAPI spec version: 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 { AutomationState } from '../models/AutomationState';
+import { UserAction } from '../models/UserAction';
+
+/**
+* UserDataState
+*/
+export class UserDataState {
+    'version': string;
+    'automations'?: Array<AutomationState>;
+    'user_actions'?: Array<UserAction>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "version",
+            "baseName": "version",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "automations",
+            "baseName": "automations",
+            "type": "Array<AutomationState>",
+            "format": ""
+        },
+        {
+            "name": "user_actions",
+            "baseName": "user_actions",
+            "type": "Array<UserAction>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UserDataState.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}

package/models/index.ts

@@ -0,0 +1,84 @@
+export * from "./Account";
+export * from "./AccountActionResult";
+export * from "./AccountActionResultErrorMessage";
+export * from "./AccountDetails";
+export * from "./AccountReference";
+export * from "./AccountState";
+export * from "./AccountStatus";
+export * from "./AccountStatusMessage";
+export * from "./AccountType";
+export * from "./AccountsState";
+export * from "./Action";
+export * from "./ActionConfigurationType";
+export * from "./ActiveOrderSwapStrategy";
+export * from "./ActiveOrderSwapStrategyType";
+export * from "./Asset";
+export * from "./AutomationActionResult";
+export * from "./AutomationActionResultErrorMessage";
+export * from "./AutomationConfiguration";
+export * from "./AutomationMetadata";
+export * from "./AutomationState";
+export * from "./BlockchainAccount";
+export * from "./CancelPolicy";
+export * from "./CancelPolicyType";
+export * from "./CopiedAccount";
+export * from "./CopiedAsset";
+export * from "./CopyConfiguration";
+export * from "./CreateAccountConfiguration";
+export * from "./CreateAutomationConfiguration";
+export * from "./DCAConfiguration";
+export * from "./DeleteAccountConfiguration";
+export * from "./EMAMomentumEvaluatorConfiguration";
+export * from "./EditAccountConfiguration";
+export * from "./EditAutomationConfiguration";
+export * from "./EvaluatorConfiguration";
+export * from "./EvaluatorConfigurationConfiguration";
+export * from "./EvaluatorType";
+export * from "./ExchangeAccount";
+export * from "./GenericAccount";
+export * from "./GenericProcessConfiguration";
+export * from "./GenericWorkflowConfiguration";
+export * from "./GridConfiguration";
+export * from "./IndexCoin";
+export * from "./IndexConfiguration";
+export * from "./MarketMakingConfiguration";
+export * from "./MarketMakingFundsDistribution";
+export * from "./MarketMakingHedgingEngine";
+export * from "./MarketMakingOrderBookDepth";
+export * from "./MarketMakingOrdersDistribution";
+export * from "./MarketMakingReferencePair";
+export * from "./MarketMakingScheduledVolume";
+export * from "./MarketMakingStopConditions";
+export * from "./MarketMakingSymbolConfiguration";
+export * from "./Order";
+export * from "./OrderGroup";
+export * from "./OrderGroupType";
+export * from "./OrderStatus";
+export * from "./OrderSummary";
+export * from "./OrderType";
+export * from "./Position";
+export * from "./PositionStatus";
+export * from "./PositionSummary";
+export * from "./RSIMomentumEvaluatorConfiguration";
+export * from "./RefreshAccountsConfiguration";
+export * from "./Side";
+export * from "./StopAutomationConfiguration";
+export * from "./StrategiesState";
+export * from "./Strategy";
+export * from "./StrategyConfiguration";
+export * from "./StrategyReference";
+export * from "./TaskStatus";
+export * from "./TimeFrame";
+export * from "./Trade";
+export * from "./TradeSummary";
+export * from "./TradingType";
+export * from "./TrailingProfile";
+export * from "./TrailingProfileType";
+export * from "./UserAction";
+export * from "./UserActionConfiguration";
+export * from "./UserActionResult";
+export * from "./UserActionResultType";
+export * from "./UserActionStatus";
+export * from "./UserActionType";
+export * from "./UserActionsState";
+export * from "./UserDataState";

package/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@drakkar.software/octobot-protocol",
+  "version": "0.1.0",
+  "description": "TypeScript types generated from OctoBot OpenAPI schema",
+  "types": "./models/index.ts",
+  "files": ["models"],
+  "license": "GPL-3.0",
+  "sideEffects": false
+}