snaptrade-typescript-sdk 3.0.0 → 5.0.0

package/dist/models/performance-custom.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/portfolio-group-info.d.ts

@@ -0,0 +1,93 @@
+/**
+ * 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.
+ */
+import { Balance } from './balance';
+import { BrokerageAuthorization } from './brokerage-authorization';
+import { CalculatedTrade } from './calculated-trade';
+import { ExcludedAsset } from './excluded-asset';
+import { PortfolioGroupSettings } from './portfolio-group-settings';
+import { Position } from './position';
+import { TargetAsset } from './target-asset';
+import { UniversalSymbol } from './universal-symbol';
+/**
+ * Summary of all relevant information about a portfolio group.
+ * @export
+ * @interface PortfolioGroupInfo
+ */
+export interface PortfolioGroupInfo {
+    [key: string]: any;
+    /**
+     *
+     * @type {Array<UniversalSymbol>}
+     * @memberof PortfolioGroupInfo
+     */
+    'symbols'?: Array<UniversalSymbol>;
+    /**
+     *
+     * @type {Array<UniversalSymbol>}
+     * @memberof PortfolioGroupInfo
+     */
+    'quotable_symbols'?: Array<UniversalSymbol>;
+    /**
+     *
+     * @type {Array<Balance>}
+     * @memberof PortfolioGroupInfo
+     */
+    'balances'?: Array<Balance>;
+    /**
+     *
+     * @type {Array<Position>}
+     * @memberof PortfolioGroupInfo
+     */
+    'positions'?: Array<Position>;
+    /**
+     *
+     * @type {Array<TargetAsset>}
+     * @memberof PortfolioGroupInfo
+     */
+    'target_positions'?: Array<TargetAsset>;
+    /**
+     *
+     * @type {Array<Position>}
+     * @memberof PortfolioGroupInfo
+     */
+    'ideal_positions'?: Array<Position>;
+    /**
+     *
+     * @type {Array<ExcludedAsset>}
+     * @memberof PortfolioGroupInfo
+     */
+    'excluded_positions'?: Array<ExcludedAsset>;
+    /**
+     *
+     * @type {Array<CalculatedTrade>}
+     * @memberof PortfolioGroupInfo
+     */
+    'calculated_trades'?: Array<CalculatedTrade>;
+    /**
+     *
+     * @type {Array<BrokerageAuthorization>}
+     * @memberof PortfolioGroupInfo
+     */
+    'brokerage_authorizations'?: Array<BrokerageAuthorization>;
+    /**
+     *
+     * @type {number}
+     * @memberof PortfolioGroupInfo
+     */
+    'accuracy'?: number;
+    /**
+     *
+     * @type {PortfolioGroupSettings}
+     * @memberof PortfolioGroupInfo
+     */
+    'settings'?: PortfolioGroupSettings;
+}

package/dist/models/portfolio-group-info.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/portfolio-group-position.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ */
+import { UniversalSymbol } from './universal-symbol';
+/**
+ * Details of a security held
+ * @export
+ * @interface PortfolioGroupPosition
+ */
+export interface PortfolioGroupPosition {
+    [key: string]: any;
+    /**
+     *
+     * @type {UniversalSymbol}
+     * @memberof PortfolioGroupPosition
+     */
+    'symbol'?: UniversalSymbol;
+    /**
+     * Last known market price for the symbol
+     * @type {number}
+     * @memberof PortfolioGroupPosition
+     */
+    'price'?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof PortfolioGroupPosition
+     */
+    'units'?: number;
+}

package/dist/models/portfolio-group-position.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/portfolio-group-settings.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+import { Currency } from './currency';
+/**
+ *
+ * @export
+ * @interface PortfolioGroupSettings
+ */
+export interface PortfolioGroupSettings {
+    [key: string]: any;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PortfolioGroupSettings
+     */
+    'buyOnly'?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PortfolioGroupSettings
+     */
+    'cash_optimizer'?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof PortfolioGroupSettings
+     */
+    'notifyFrequency'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof PortfolioGroupSettings
+     */
+    'driftThreshold'?: number;
+    /**
+     *
+     * @type {Currency}
+     * @memberof PortfolioGroupSettings
+     */
+    'preferred_currency'?: Currency;
+}

package/dist/models/portfolio-group-settings.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/portfolio-group.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 PortfolioGroup
+ */
+export interface PortfolioGroup {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof PortfolioGroup
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortfolioGroup
+     */
+    'name'?: string;
+}

package/dist/models/portfolio-group.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/position-symbol.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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.
+ */
+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/dist/models/position-symbol.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/position.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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.
+ */
+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/dist/models/position.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/redirect-tokenand-pin.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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/dist/models/redirect-tokenand-pin.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/security-type.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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/dist/models/security-type.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,31 @@
+/**
+ * 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/dist/models/snap-trade-apidisclaimer-accept-status.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,64 @@
+/**
+ * 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.
+ */
+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/dist/models/snap-trade-holdings-account.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });