snaptrade-typescript-sdk 3.0.0 → 5.0.0

package/dist/models/model404-failed-request-response.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.
+ */
+/**
+ * Example for failed request response
+ * @export
+ * @interface Model404FailedRequestResponse
+ */
+export interface Model404FailedRequestResponse {
+    [key: string]: any;
+    /**
+     *
+     * @type {any}
+     * @memberof Model404FailedRequestResponse
+     */
+    'default_detail'?: any;
+    /**
+     *
+     * @type {any}
+     * @memberof Model404FailedRequestResponse
+     */
+    'default_code'?: any;
+}

package/dist/models/model404-failed-request-response.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/monthly-dividends.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { DividendAtDate } from './dividend-at-date';
+/**
+ *
+ * @export
+ * @interface MonthlyDividends
+ */
+export interface MonthlyDividends {
+    [key: string]: any;
+    /**
+     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+     * @type {string}
+     * @memberof MonthlyDividends
+     */
+    'date'?: string;
+    /**
+     *
+     * @type {Array<DividendAtDate>}
+     * @memberof MonthlyDividends
+     */
+    'dividends'?: Array<DividendAtDate>;
+}

package/dist/models/monthly-dividends.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/net-contributions.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 NetContributions
+ */
+export interface NetContributions {
+    [key: string]: any;
+    /**
+     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+     * @type {string}
+     * @memberof NetContributions
+     */
+    'date'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof NetContributions
+     */
+    'contributions'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof NetContributions
+     */
+    'currency'?: string;
+}

package/dist/models/net-contributions.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/net-dividend.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';
+/**
+ * Object representing total dividends received during a timeframe
+ * @export
+ * @interface NetDividend
+ */
+export interface NetDividend {
+    [key: string]: any;
+    /**
+     *
+     * @type {UniversalSymbol}
+     * @memberof NetDividend
+     */
+    'symbol'?: UniversalSymbol;
+    /**
+     *
+     * @type {number}
+     * @memberof NetDividend
+     */
+    'amount'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof NetDividend
+     */
+    'currency'?: string;
+}

package/dist/models/net-dividend.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/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
+ */
+export interface OptionChainInnerChainPerRootInnerChainPerStrikePriceInner {
+    [key: string]: any;
+    /**
+     *
+     * @type {number}
+     * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
+     */
+    'strikePrice'?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
+     */
+    'callSymbolId'?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
+     */
+    'putSymbolId'?: number | null;
+}

package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.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/option-chain-inner-chain-per-root-inner.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 { OptionChainInnerChainPerRootInnerChainPerStrikePriceInner } from './option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner';
+/**
+ *
+ * @export
+ * @interface OptionChainInnerChainPerRootInner
+ */
+export interface OptionChainInnerChainPerRootInner {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionChainInnerChainPerRootInner
+     */
+    'optionRoot'?: string;
+    /**
+     *
+     * @type {Array<OptionChainInnerChainPerRootInnerChainPerStrikePriceInner>}
+     * @memberof OptionChainInnerChainPerRootInner
+     */
+    'chainPerStrikePrice'?: Array<OptionChainInnerChainPerRootInnerChainPerStrikePriceInner>;
+    /**
+     *
+     * @type {number}
+     * @memberof OptionChainInnerChainPerRootInner
+     */
+    'multiplier'?: number;
+}

package/dist/models/option-chain-inner-chain-per-root-inner.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/option-chain-inner.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 { OptionChainInnerChainPerRootInner } from './option-chain-inner-chain-per-root-inner';
+/**
+ *
+ * @export
+ * @interface OptionChainInner
+ */
+export interface OptionChainInner {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionChainInner
+     */
+    'expiryDate'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionChainInner
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionChainInner
+     */
+    'listingExchange'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionChainInner
+     */
+    'optionExerciseType'?: string;
+    /**
+     *
+     * @type {Array<OptionChainInnerChainPerRootInner>}
+     * @memberof OptionChainInner
+     */
+    'chainPerRoot'?: Array<OptionChainInnerChainPerRootInner>;
+}

package/dist/models/option-chain-inner.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/option-leg.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ * Option Leg
+ * @export
+ * @interface OptionLeg
+ */
+export interface OptionLeg {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionLeg
+     */
+    'action'?: OptionLegActionEnum;
+    /**
+     * Obtained from calling options chain endpoint (option_id)
+     * @type {string}
+     * @memberof OptionLeg
+     */
+    'option_symbol_id'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof OptionLeg
+     */
+    'quantity'?: number;
+}
+export declare const OptionLegActionEnum: {
+    readonly BuyToOpen: "BUY_TO_OPEN";
+    readonly BuyToClose: "BUY_TO_CLOSE";
+    readonly SellToOpen: "SELL_TO_OPEN";
+    readonly SellToClose: "SELL_TO_CLOSE";
+};
+export type OptionLegActionEnum = typeof OptionLegActionEnum[keyof typeof OptionLegActionEnum];

package/dist/models/option-leg.js

@@ -0,0 +1,22 @@
+"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 });
+exports.OptionLegActionEnum = void 0;
+exports.OptionLegActionEnum = {
+    BuyToOpen: 'BUY_TO_OPEN',
+    BuyToClose: 'BUY_TO_CLOSE',
+    SellToOpen: 'SELL_TO_OPEN',
+    SellToClose: 'SELL_TO_CLOSE'
+};

package/dist/models/option-strategy-legs-inner.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 OptionStrategyLegsInner
+ */
+export interface OptionStrategyLegsInner {
+    /**
+     *
+     * @type {string}
+     * @memberof OptionStrategyLegsInner
+     */
+    'option_symbol_id'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof OptionStrategyLegsInner
+     */
+    'index'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionStrategyLegsInner
+     */
+    'action'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof OptionStrategyLegsInner
+     */
+    'quantity'?: number;
+}

package/dist/models/option-strategy-legs-inner.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/option-strategy.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { OptionStrategyLegsInner } from './option-strategy-legs-inner';
+import { UniversalSymbol } from './universal-symbol';
+/**
+ *
+ * @export
+ * @interface OptionStrategy
+ */
+export interface OptionStrategy {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionStrategy
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {UniversalSymbol}
+     * @memberof OptionStrategy
+     */
+    'underlying_symbol_id'?: UniversalSymbol;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionStrategy
+     */
+    'strategy_type'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof OptionStrategy
+     */
+    'number_of_legs'?: number;
+    /**
+     *
+     * @type {Array<OptionStrategyLegsInner>}
+     * @memberof OptionStrategy
+     */
+    'legs'?: Array<OptionStrategyLegsInner>;
+}

package/dist/models/option-strategy.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/options-get-option-strategy-request.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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 { OptionLeg } from './option-leg';
+/**
+ *
+ * @export
+ * @interface OptionsGetOptionStrategyRequest
+ */
+export interface OptionsGetOptionStrategyRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof OptionsGetOptionStrategyRequest
+     */
+    'underlying_symbol_id': string;
+    /**
+     *
+     * @type {Array<OptionLeg>}
+     * @memberof OptionsGetOptionStrategyRequest
+     */
+    'legs': Array<OptionLeg>;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionsGetOptionStrategyRequest
+     */
+    'strategy_type': OptionsGetOptionStrategyRequestStrategyTypeEnum;
+}
+export declare const OptionsGetOptionStrategyRequestStrategyTypeEnum: {
+    readonly Custom: "CUSTOM";
+};
+export type OptionsGetOptionStrategyRequestStrategyTypeEnum = typeof OptionsGetOptionStrategyRequestStrategyTypeEnum[keyof typeof OptionsGetOptionStrategyRequestStrategyTypeEnum];

package/dist/models/options-get-option-strategy-request.js

@@ -0,0 +1,19 @@
+"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 });
+exports.OptionsGetOptionStrategyRequestStrategyTypeEnum = void 0;
+exports.OptionsGetOptionStrategyRequestStrategyTypeEnum = {
+    Custom: 'CUSTOM'
+};