@drakkar.software/octobot-protocol 0.1.0

package/models/Account.ts

@@ -0,0 +1,89 @@
+/**
+ * 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 { AccountDetails } from '../models/AccountDetails';
+import { AccountState } from '../models/AccountState';
+
+/**
+* Account
+*/
+export class Account {
+    'id': string;
+    'name': string;
+    'is_simulated': boolean;
+    'description'?: string;
+    'state'?: AccountState;
+    'created_at': Date;
+    'updated_at': Date;
+    'details'?: AccountDetails;
+
+    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": "name",
+            "baseName": "name",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "is_simulated",
+            "baseName": "is_simulated",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "state",
+            "baseName": "state",
+            "type": "AccountState",
+            "format": ""
+        },
+        {
+            "name": "created_at",
+            "baseName": "created_at",
+            "type": "Date",
+            "format": "date-time"
+        },
+        {
+            "name": "updated_at",
+            "baseName": "updated_at",
+            "type": "Date",
+            "format": "date-time"
+        },
+        {
+            "name": "details",
+            "baseName": "details",
+            "type": "AccountDetails",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Account.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}

package/models/AccountActionResult.ts

@@ -0,0 +1,63 @@
+/**
+ * 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 { AccountActionResultErrorMessage } from '../models/AccountActionResultErrorMessage';
+import { UserActionResultType } from '../models/UserActionResultType';
+
+/**
+* AccountActionResult
+*/
+export class AccountActionResult {
+    'updated_at': Date;
+    'error_message'?: AccountActionResultErrorMessage;
+    'error_details'?: string;
+    'result_type': UserActionResultType;
+
+    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": "updated_at",
+            "baseName": "updated_at",
+            "type": "Date",
+            "format": "date-time"
+        },
+        {
+            "name": "error_message",
+            "baseName": "error_message",
+            "type": "AccountActionResultErrorMessage",
+            "format": ""
+        },
+        {
+            "name": "error_details",
+            "baseName": "error_details",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "result_type",
+            "baseName": "result_type",
+            "type": "UserActionResultType",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return AccountActionResult.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/AccountActionResultErrorMessage.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+
+
+/**
+* AccountActionResultErrorMessage
+*/
+export enum AccountActionResultErrorMessage {
+    AccountNotFound = 'account_not_found',
+    InvalidConfiguration = 'invalid_configuration',
+    InternalError = 'internal_error'
+}

package/models/AccountDetails.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { BlockchainAccount } from '../models/BlockchainAccount';
+import { ExchangeAccount } from '../models/ExchangeAccount';
+import { GenericAccount } from '../models/GenericAccount';
+
+/**
+ * @type AccountDetails
+ * Type
+ * @export
+ */
+export type AccountDetails = BlockchainAccount | ExchangeAccount | GenericAccount;
+
+/**
+* @type AccountDetailsClass
+* @export
+*/
+export class AccountDetailsClass {
+    static readonly discriminator: string | undefined = "account_type";
+
+    static readonly mapping: {[index: string]: string} | undefined = {
+        "blockchain": "BlockchainAccount",
+        "exchange": "ExchangeAccount",
+        "generic": "GenericAccount",
+    };
+}
+
+

package/models/AccountReference.ts

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ */
+
+
+/**
+* AccountReference
+*/
+export class AccountReference {
+    'id': 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": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return AccountReference.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}

package/models/AccountState.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { AccountStatus } from '../models/AccountStatus';
+import { AccountStatusMessage } from '../models/AccountStatusMessage';
+
+/**
+* AccountState
+*/
+export class AccountState {
+    'status': AccountStatus;
+    'message'?: AccountStatusMessage;
+
+    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": "status",
+            "baseName": "status",
+            "type": "AccountStatus",
+            "format": ""
+        },
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "AccountStatusMessage",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return AccountState.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/AccountStatus.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+
+
+/**
+* AccountStatus
+*/
+export enum AccountStatus {
+    Valid = 'valid',
+    Invalid = 'invalid',
+    Unknown = 'unknown'
+}

package/models/AccountStatusMessage.ts

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ */
+
+
+/**
+* AccountStatusMessage
+*/
+export enum AccountStatusMessage {
+    PendingValidation = 'pending_validation',
+    Valid = 'valid',
+    InvalidApiKeys = 'invalid_api_keys',
+    MissingApiTradingRights = 'missing_api_trading_rights',
+    RevokeApiWithdrawalRights = 'revoke_api_withdrawal_rights',
+    InvalidApiIpWhitelist = 'invalid_api_ip_whitelist',
+    InternalServerError = 'internal_server_error',
+    AccountTooOld = 'account_too_old',
+    IncompatibleAccountReferral = 'incompatible_account_referral'
+}

package/models/AccountType.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+
+
+/**
+* Account category discriminator.
+*/
+export enum AccountType {
+    Generic = 'generic',
+    Exchange = 'exchange',
+    Blockchain = 'blockchain'
+}

package/models/AccountsState.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 { Account } from '../models/Account';
+
+/**
+* AccountsState
+*/
+export class AccountsState {
+    'version': string;
+    'accounts'?: Array<Account>;
+
+    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": "accounts",
+            "baseName": "accounts",
+            "type": "Array<Account>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return AccountsState.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}

package/models/Action.ts

@@ -0,0 +1,90 @@
+/**
+ * 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 { TaskStatus } from '../models/TaskStatus';
+
+/**
+* Action
+*/
+export class Action {
+    'id': string;
+    'action_type': string;
+    'status': TaskStatus;
+    'dsl'?: string;
+    'configuration'?: { [key: string]: any; };
+    'result'?: string;
+    'error'?: string;
+    'completed_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": "action_type",
+            "baseName": "action_type",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "TaskStatus",
+            "format": ""
+        },
+        {
+            "name": "dsl",
+            "baseName": "dsl",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "configuration",
+            "baseName": "configuration",
+            "type": "{ [key: string]: any; }",
+            "format": ""
+        },
+        {
+            "name": "result",
+            "baseName": "result",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "error",
+            "baseName": "error",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "completed_at",
+            "baseName": "completed_at",
+            "type": "Date",
+            "format": "date-time"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Action.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/ActionConfigurationType.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.
+ */
+
+
+/**
+* ActionConfigurationType
+*/
+export enum ActionConfigurationType {
+    MarketMaking = 'market_making',
+    Dca = 'dca',
+    Index = 'index',
+    Grid = 'grid',
+    Copy = 'copy',
+    GenericProcess = 'generic_process',
+    GenericWorkflow = 'generic_workflow'
+}

package/models/ActiveOrderSwapStrategy.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 { ActiveOrderSwapStrategyType } from '../models/ActiveOrderSwapStrategyType';
+
+/**
+* ActiveOrderSwapStrategy
+*/
+export class ActiveOrderSwapStrategy {
+    'type': ActiveOrderSwapStrategyType;
+    'trigger_price_configuration'?: any;
+    'timeout'?: number;
+
+    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": "ActiveOrderSwapStrategyType",
+            "format": ""
+        },
+        {
+            "name": "trigger_price_configuration",
+            "baseName": "trigger_price_configuration",
+            "type": "any",
+            "format": ""
+        },
+        {
+            "name": "timeout",
+            "baseName": "timeout",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return ActiveOrderSwapStrategy.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+

package/models/ActiveOrderSwapStrategyType.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.
+ */
+
+
+/**
+* Active order swap strategy class name (mirrors octobot_trading active_order_swap_strategy_factory).
+*/
+export enum ActiveOrderSwapStrategyType {
+    StopFirstActiveOrderSwapStrategy = 'StopFirstActiveOrderSwapStrategy',
+    TakeProfitFirstActiveOrderSwapStrategy = 'TakeProfitFirstActiveOrderSwapStrategy'
+}

package/models/Asset.ts

@@ -0,0 +1,66 @@
+/**
+ * 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.
+ */
+
+
+/**
+* Asset
+*/
+export class Asset {
+    'symbol': string;
+    'total': number;
+    'available': number;
+    'value'?: number;
+    'unit'?: 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": "symbol",
+            "baseName": "symbol",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "total",
+            "baseName": "total",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "available",
+            "baseName": "available",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "value",
+            "baseName": "value",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "unit",
+            "baseName": "unit",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Asset.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}