snaptrade-typescript-sdk 3.0.0 → 4.0.0

package/models/position-symbol.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+// May contain unused imports in some cases
+// @ts-ignore
+import { UniversalSymbol } from './universal-symbol';
+
+/**
+ * Symbol returned in position object
+ * @export
+ * @interface PositionSymbol
+ */
+export interface PositionSymbol {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof PositionSymbol
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PositionSymbol
+     */
+    'description'?: string;
+    /**
+     * 
+     * @type {UniversalSymbol}
+     * @memberof PositionSymbol
+     */
+    'symbol'?: UniversalSymbol;
+    /**
+     * 
+     * @type {string}
+     * @memberof PositionSymbol
+     */
+    'local_id'?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PositionSymbol
+     */
+    'is_quotable'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PositionSymbol
+     */
+    'is_tradable'?: boolean;
+}
+

package/models/position.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+// May contain unused imports in some cases
+// @ts-ignore
+import { PositionSymbol } from './position-symbol';
+
+/**
+ * Account Position
+ * @export
+ * @interface Position
+ */
+export interface Position {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {PositionSymbol}
+     * @memberof Position
+     */
+    'symbol'?: PositionSymbol;
+    /**
+     * 
+     * @type {number}
+     * @memberof Position
+     */
+    'units'?: number | null;
+    /**
+     * Last known market price for the symbol
+     * @type {number}
+     * @memberof Position
+     */
+    'price'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof Position
+     */
+    'open_pnl'?: number | null;
+    /**
+     * Deprecated, use the units field for both fractional and integer units going forward
+     * @type {number}
+     * @memberof Position
+     */
+    'fractional_units'?: number | null;
+    /**
+     * Average purchase price for this position. Either returned by the underlying broker or calculated using historical transactions.
+     * @type {number}
+     * @memberof Position
+     */
+    'average_purchase_price'?: number;
+}
+

package/models/redirect-tokenand-pin.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Response when register user is successful
+ * @export
+ * @interface RedirectTokenandPin
+ */
+export interface RedirectTokenandPin {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof RedirectTokenandPin
+     */
+    'token'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedirectTokenandPin
+     */
+    'pin'?: string;
+}
+

package/models/security-type.ts

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Security Type
+ * @export
+ * @interface SecurityType
+ */
+export interface SecurityType {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof SecurityType
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SecurityType
+     */
+    'code'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SecurityType
+     */
+    'description'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SecurityType
+     */
+    'is_supported'?: boolean;
+}
+

package/models/snap-trade-apidisclaimer-accept-status.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Status of user acceptance of SnapTrade API disclaimer
+ * @export
+ * @interface SnapTradeAPIDisclaimerAcceptStatus
+ */
+export interface SnapTradeAPIDisclaimerAcceptStatus {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SnapTradeAPIDisclaimerAcceptStatus
+     */
+    'accepted'?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapTradeAPIDisclaimerAcceptStatus
+     */
+    'timestamp'?: string;
+}
+

package/models/snap-trade-holdings-account.ts

@@ -0,0 +1,70 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+// May contain unused imports in some cases
+// @ts-ignore
+import { BrokerageAuthorization } from './brokerage-authorization';
+
+/**
+ * SnapTradeUser Investment Account
+ * @export
+ * @interface SnapTradeHoldingsAccount
+ */
+export interface SnapTradeHoldingsAccount {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapTradeHoldingsAccount
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {BrokerageAuthorization}
+     * @memberof SnapTradeHoldingsAccount
+     */
+    'brokerage_authorization'?: BrokerageAuthorization;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapTradeHoldingsAccount
+     */
+    'portfolio_group'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapTradeHoldingsAccount
+     */
+    'name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapTradeHoldingsAccount
+     */
+    'number'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapTradeHoldingsAccount
+     */
+    'institution_name'?: string;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof SnapTradeHoldingsAccount
+     */
+    'meta'?: { [key: string]: any; };
+}
+

package/models/snap-trade-holdings-total-value.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Total Value of the account
+ * @export
+ * @interface SnapTradeHoldingsTotalValue
+ */
+export interface SnapTradeHoldingsTotalValue {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {number}
+     * @memberof SnapTradeHoldingsTotalValue
+     */
+    'value'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapTradeHoldingsTotalValue
+     */
+    'currency'?: string;
+}
+

package/models/snap-trade-login-user-request-body.ts

@@ -0,0 +1,61 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Data to login a user via SnapTrade Partner
+ * @export
+ * @interface SnapTradeLoginUserRequestBody
+ */
+export interface SnapTradeLoginUserRequestBody {
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapTradeLoginUserRequestBody
+     */
+    'broker'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SnapTradeLoginUserRequestBody
+     */
+    'immediateRedirect'?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapTradeLoginUserRequestBody
+     */
+    'customRedirect'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapTradeLoginUserRequestBody
+     */
+    'reconnect'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SnapTradeLoginUserRequestBody
+     */
+    'connectionType'?: SnapTradeLoginUserRequestBodyConnectionTypeEnum;
+}
+
+export const SnapTradeLoginUserRequestBodyConnectionTypeEnum = {
+    Read: 'read',
+    Trade: 'trade'
+} as const;
+
+export type SnapTradeLoginUserRequestBodyConnectionTypeEnum = typeof SnapTradeLoginUserRequestBodyConnectionTypeEnum[keyof typeof SnapTradeLoginUserRequestBodyConnectionTypeEnum];
+
+

package/models/snap-trade-register-user-request-body.ts

@@ -0,0 +1,35 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Data required to register a user via SnapTrade Partner
+ * @export
+ * @interface SnapTradeRegisterUserRequestBody
+ */
+export interface SnapTradeRegisterUserRequestBody {
+    /**
+     * SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it\'s unique to a user
+     * @type {string}
+     * @memberof SnapTradeRegisterUserRequestBody
+     */
+    'userId'?: string;
+    /**
+     * Open SSH RSA public key
+     * @type {string}
+     * @memberof SnapTradeRegisterUserRequestBody
+     */
+    'rsaPublicKey'?: string;
+}
+

package/models/status.ts

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Status of API
+ * @export
+ * @interface Status
+ */
+export interface Status {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {number}
+     * @memberof Status
+     */
+    'version'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Status
+     */
+    'timestamp'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Status
+     */
+    'online'?: boolean;
+}
+

package/models/strategy-impact-legs-inner.ts

@@ -0,0 +1,67 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * 
+ * @export
+ * @interface StrategyImpactLegsInner
+ */
+export interface StrategyImpactLegsInner {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyImpactLegsInner
+     */
+    'legId'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyImpactLegsInner
+     */
+    'symbol'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyImpactLegsInner
+     */
+    'symbolId'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyImpactLegsInner
+     */
+    'legRatioQuantity'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyImpactLegsInner
+     */
+    'side'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyImpactLegsInner
+     */
+    'avgExecPrice'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyImpactLegsInner
+     */
+    'lastExecPrice'?: string;
+}
+

package/models/strategy-impact.ts

@@ -0,0 +1,94 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+// May contain unused imports in some cases
+// @ts-ignore
+import { StrategyImpactLegsInner } from './strategy-impact-legs-inner';
+
+/**
+ * The strategy impact
+ * @export
+ * @interface StrategyImpact
+ */
+export interface StrategyImpact {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyImpact
+     */
+    'estimatedCommissions'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyImpact
+     */
+    'buyingPowerEffect'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyImpact
+     */
+    'buyingPowerResult'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyImpact
+     */
+    'maintExcessEffect'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyImpact
+     */
+    'maintExcessResult'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyImpact
+     */
+    'tradeValueCalculation'?: string;
+    /**
+     * 
+     * @type {Array<StrategyImpactLegsInner>}
+     * @memberof StrategyImpact
+     */
+    'legs'?: Array<StrategyImpactLegsInner>;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyImpact
+     */
+    'side'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyImpact
+     */
+    'effect'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StrategyImpact
+     */
+    'price'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StrategyImpact
+     */
+    'strategy'?: string;
+}
+