snaptrade-typescript-sdk 3.0.0 → 5.0.0

package/models/options-symbol.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 { UnderlyingSymbol } from './underlying-symbol';
+
+/**
+ * Options Symbol
+ * @export
+ * @interface OptionsSymbol
+ */
+export interface OptionsSymbol {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionsSymbol
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionsSymbol
+     */
+    'ticker'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof OptionsSymbol
+     */
+    'strike_price'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionsSymbol
+     */
+    'expiration_date'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OptionsSymbol
+     */
+    'is_mini_option'?: boolean;
+    /**
+     * 
+     * @type {UnderlyingSymbol}
+     * @memberof OptionsSymbol
+     */
+    'underlying_symbol'?: UnderlyingSymbol;
+    /**
+     * 
+     * @type {string}
+     * @memberof OptionsSymbol
+     */
+    'local_id'?: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof OptionsSymbol
+     */
+    'security_type'?: any;
+    /**
+     * 
+     * @type {any}
+     * @memberof OptionsSymbol
+     */
+    'listing_exchange'?: any;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OptionsSymbol
+     */
+    'is_quotable'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OptionsSymbol
+     */
+    'is_tradable'?: boolean;
+}
+

package/models/order-type.ts

@@ -0,0 +1,32 @@
+/* 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.
+ */
+
+
+/**
+ * Order Type
+ * @export
+ * @enum {string}
+ */
+
+export const OrderType = {
+    Limit: 'Limit',
+    Market: 'Market',
+    StopLimit: 'StopLimit',
+    StopLoss: 'StopLoss'
+} as const;
+
+export type OrderType = typeof OrderType[keyof typeof OrderType];
+
+
+

package/models/partner-data.ts

@@ -0,0 +1,100 @@
+/* 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 { Brokerage } from './brokerage';
+
+/**
+ * SnapTrade Partner metadata
+ * @export
+ * @interface PartnerData
+ */
+export interface PartnerData {
+    [key: string]: any;
+
+    /**
+     * URI to redirect user back to after user is done adding brokerage connections
+     * @type {string}
+     * @memberof PartnerData
+     */
+    'redirect_uri'?: string;
+    /**
+     * Brokerages that can be accessed by partners
+     * @type {Array<Brokerage>}
+     * @memberof PartnerData
+     */
+    'allowed_brokerages'?: Array<Brokerage>;
+    /**
+     * Name of Snaptrade Partner
+     * @type {string}
+     * @memberof PartnerData
+     */
+    'name'?: string;
+    /**
+     * Slug of Snaptrade Partner
+     * @type {string}
+     * @memberof PartnerData
+     */
+    'slug'?: string;
+    /**
+     * URL to partner\'s logo
+     * @type {string}
+     * @memberof PartnerData
+     */
+    'logo_url'?: string;
+    /**
+     * Shows if pin is required by users to access connection page
+     * @type {boolean}
+     * @memberof PartnerData
+     */
+    'pin_required'?: boolean;
+    /**
+     * Shows if users of Snaptrade partners can access trade endpoints
+     * @type {boolean}
+     * @memberof PartnerData
+     */
+    'can_access_trades'?: boolean;
+    /**
+     * Shows if Snaptrade partners can get user holdings data
+     * @type {boolean}
+     * @memberof PartnerData
+     */
+    'can_access_holdings'?: boolean;
+    /**
+     * Shows if Snaptrade partners can get users account history data
+     * @type {boolean}
+     * @memberof PartnerData
+     */
+    'can_access_account_history'?: boolean;
+    /**
+     * Shows if Snaptrade partners can get users holdings data
+     * @type {boolean}
+     * @memberof PartnerData
+     */
+    'can_access_reference_data'?: boolean;
+    /**
+     * Shows if users Snaptrade partners can access portfolio group management features
+     * @type {boolean}
+     * @memberof PartnerData
+     */
+    'can_access_portfolio_management'?: boolean;
+    /**
+     * Shows if Snaptrade partners can get users account order history
+     * @type {boolean}
+     * @memberof PartnerData
+     */
+    'can_access_orders'?: boolean;
+}
+

package/models/past-value.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.
+ */
+
+
+/**
+ * 
+ * @export
+ * @interface PastValue
+ */
+export interface PastValue {
+    [key: string]: any;
+
+    /**
+     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+     * @type {string}
+     * @memberof PastValue
+     */
+    'date'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PastValue
+     */
+    'value'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PastValue
+     */
+    'currency'?: string;
+}
+

package/models/performance-custom.ts

@@ -0,0 +1,154 @@
+/* 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 { MonthlyDividends } from './monthly-dividends';
+// May contain unused imports in some cases
+// @ts-ignore
+import { NetContributions } from './net-contributions';
+// May contain unused imports in some cases
+// @ts-ignore
+import { NetDividend } from './net-dividend';
+// May contain unused imports in some cases
+// @ts-ignore
+import { PastValue } from './past-value';
+// May contain unused imports in some cases
+// @ts-ignore
+import { SubPeriodReturnRate } from './sub-period-return-rate';
+
+/**
+ * Performance Custom Response Object
+ * @export
+ * @interface PerformanceCustom
+ */
+export interface PerformanceCustom {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {Array<PastValue>}
+     * @memberof PerformanceCustom
+     */
+    'totalEquityTimeframe'?: Array<PastValue>;
+    /**
+     * 
+     * @type {NetContributions}
+     * @memberof PerformanceCustom
+     */
+    'contributions'?: NetContributions;
+    /**
+     * 
+     * @type {Array<PastValue>}
+     * @memberof PerformanceCustom
+     */
+    'contributionTimeframe'?: Array<PastValue>;
+    /**
+     * 
+     * @type {Array<PastValue>}
+     * @memberof PerformanceCustom
+     */
+    'contributionTimeframeCumulative'?: Array<PastValue>;
+    /**
+     * 
+     * @type {Array<PastValue>}
+     * @memberof PerformanceCustom
+     */
+    'withdrawalTimeframe'?: Array<PastValue>;
+    /**
+     * Current streak of cosecutive months where contributions were made
+     * @type {number}
+     * @memberof PerformanceCustom
+     */
+    'contributionStreak'?: number | null;
+    /**
+     * Number of months in the timeframe with contributions
+     * @type {number}
+     * @memberof PerformanceCustom
+     */
+    'contributionMonthsContributed'?: number | null;
+    /**
+     * Total months in timeframe
+     * @type {number}
+     * @memberof PerformanceCustom
+     */
+    'contributionTotalMonths'?: number | null;
+    /**
+     * 
+     * @type {Array<NetDividend>}
+     * @memberof PerformanceCustom
+     */
+    'dividends'?: Array<NetDividend>;
+    /**
+     * Total dividends received over the timeframe
+     * @type {number}
+     * @memberof PerformanceCustom
+     */
+    'dividendIncome'?: number | null;
+    /**
+     * Average dividends received per month over the timeframe
+     * @type {number}
+     * @memberof PerformanceCustom
+     */
+    'monthlyDividends'?: number | null;
+    /**
+     * list of tickers which may not be supported or may not have accurate price data
+     * @type {Array<string>}
+     * @memberof PerformanceCustom
+     */
+    'badTickers'?: Array<string>;
+    /**
+     * 
+     * @type {Array<MonthlyDividends>}
+     * @memberof PerformanceCustom
+     */
+    'dividendTimeline'?: Array<MonthlyDividends>;
+    /**
+     * commissions incurred during the timeframe
+     * @type {number}
+     * @memberof PerformanceCustom
+     */
+    'commissions'?: number | null;
+    /**
+     * forex fees incurred during the timeframe
+     * @type {number}
+     * @memberof PerformanceCustom
+     */
+    'forexFees'?: number | null;
+    /**
+     * other fees incurred during the timeframe
+     * @type {number}
+     * @memberof PerformanceCustom
+     */
+    'fees'?: number | null;
+    /**
+     * The return rate over the timeframe. Annualized if timeframe is longer than 1 year
+     * @type {number}
+     * @memberof PerformanceCustom
+     */
+    'rateOfReturn'?: number | null;
+    /**
+     * 
+     * @type {Array<SubPeriodReturnRate>}
+     * @memberof PerformanceCustom
+     */
+    'returnRateTimeframe'?: Array<SubPeriodReturnRate>;
+    /**
+     * Whether the user has detailed mode enabled (more frequent data points for totalEquity and contribution timeframes)
+     * @type {boolean}
+     * @memberof PerformanceCustom
+     */
+    'detailedMode'?: boolean;
+}
+

package/models/portfolio-group-info.ts

@@ -0,0 +1,115 @@
+/* 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 { Balance } from './balance';
+// May contain unused imports in some cases
+// @ts-ignore
+import { BrokerageAuthorization } from './brokerage-authorization';
+// May contain unused imports in some cases
+// @ts-ignore
+import { CalculatedTrade } from './calculated-trade';
+// May contain unused imports in some cases
+// @ts-ignore
+import { ExcludedAsset } from './excluded-asset';
+// May contain unused imports in some cases
+// @ts-ignore
+import { PortfolioGroupSettings } from './portfolio-group-settings';
+// May contain unused imports in some cases
+// @ts-ignore
+import { Position } from './position';
+// May contain unused imports in some cases
+// @ts-ignore
+import { TargetAsset } from './target-asset';
+// May contain unused imports in some cases
+// @ts-ignore
+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/models/portfolio-group-position.ts

@@ -0,0 +1,46 @@
+/* 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';
+
+/**
+ * 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/models/portfolio-group-settings.ts

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