snaptrade-typescript-sdk 3.0.0 → 4.0.0

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'
+};

package/dist/models/options-holdings.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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';
+import { OptionsSymbol } from './options-symbol';
+/**
+ * Option Holdings
+ * @export
+ * @interface OptionsHoldings
+ */
+export interface OptionsHoldings {
+    [key: string]: any;
+    /**
+     * Options information
+     * @type {string}
+     * @memberof OptionsHoldings
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionsHoldings
+     */
+    'symbol'?: string;
+    /**
+     *
+     * @type {OptionsSymbol}
+     * @memberof OptionsHoldings
+     */
+    'option_symbol'?: OptionsSymbol;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof OptionsHoldings
+     */
+    'price'?: number;
+    /**
+     *
+     * @type {Currency}
+     * @memberof OptionsHoldings
+     */
+    'currency'?: Currency;
+    /**
+     * Average purchase price for this position
+     * @type {number}
+     * @memberof OptionsHoldings
+     */
+    'average_purchase_price'?: number;
+}

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

@@ -0,0 +1,48 @@
+/**
+ * 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 OptionsPlaceOptionStrategyRequest
+ */
+export interface OptionsPlaceOptionStrategyRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof OptionsPlaceOptionStrategyRequest
+     */
+    'order_type': OptionsPlaceOptionStrategyRequestOrderTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionsPlaceOptionStrategyRequest
+     */
+    'time_in_force': OptionsPlaceOptionStrategyRequestTimeInForceEnum;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof OptionsPlaceOptionStrategyRequest
+     */
+    'price': number;
+}
+export declare const OptionsPlaceOptionStrategyRequestOrderTypeEnum: {
+    readonly Limit: "Limit";
+    readonly Market: "Market";
+    readonly NetDebit: "NetDebit";
+    readonly NetCredit: "NetCredit";
+};
+export type OptionsPlaceOptionStrategyRequestOrderTypeEnum = typeof OptionsPlaceOptionStrategyRequestOrderTypeEnum[keyof typeof OptionsPlaceOptionStrategyRequestOrderTypeEnum];
+export declare const OptionsPlaceOptionStrategyRequestTimeInForceEnum: {
+    readonly Day: "DAY";
+    readonly Gtc: "GTC";
+};
+export type OptionsPlaceOptionStrategyRequestTimeInForceEnum = typeof OptionsPlaceOptionStrategyRequestTimeInForceEnum[keyof typeof OptionsPlaceOptionStrategyRequestTimeInForceEnum];

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

@@ -0,0 +1,26 @@
+"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.OptionsPlaceOptionStrategyRequestTimeInForceEnum = exports.OptionsPlaceOptionStrategyRequestOrderTypeEnum = void 0;
+exports.OptionsPlaceOptionStrategyRequestOrderTypeEnum = {
+    Limit: 'Limit',
+    Market: 'Market',
+    NetDebit: 'NetDebit',
+    NetCredit: 'NetCredit'
+};
+exports.OptionsPlaceOptionStrategyRequestTimeInForceEnum = {
+    Day: 'DAY',
+    Gtc: 'GTC'
+};

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

@@ -0,0 +1,63 @@
+/**
+ * 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';
+import { OptionsSymbol } from './options-symbol';
+/**
+ * Option Holdings
+ * @export
+ * @interface OptionsPosition
+ */
+export interface OptionsPosition {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionsPosition
+     */
+    'symbol'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OptionsPosition
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {OptionsSymbol}
+     * @memberof OptionsPosition
+     */
+    'option_symbol'?: OptionsSymbol;
+    /**
+     * Trade Price if limit or stop limit order
+     * @type {number}
+     * @memberof OptionsPosition
+     */
+    'price'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof OptionsPosition
+     */
+    'units'?: number;
+    /**
+     *
+     * @type {Currency}
+     * @memberof OptionsPosition
+     */
+    'currency'?: Currency;
+    /**
+     * Average purchase price for this position
+     * @type {number}
+     * @memberof OptionsPosition
+     */
+    'average_purchase_price'?: number;
+}

package/dist/models/options-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/options-symbol.d.ts

@@ -0,0 +1,86 @@
+/**
+ * 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 { 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/dist/models/options-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/order-type.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 declare const OrderType: {
+    readonly Limit: "Limit";
+    readonly Market: "Market";
+    readonly StopLimit: "StopLimit";
+    readonly StopLoss: "StopLoss";
+};
+export type OrderType = typeof OrderType[keyof typeof OrderType];

package/dist/models/order-type.js

@@ -0,0 +1,27 @@
+"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.OrderType = void 0;
+/**
+ * Order Type
+ * @export
+ * @enum {string}
+ */
+exports.OrderType = {
+    Limit: 'Limit',
+    Market: 'Market',
+    StopLimit: 'StopLimit',
+    StopLoss: 'StopLoss'
+};

package/dist/models/partner-data.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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 { 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/dist/models/partner-data.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/past-value.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 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/dist/models/past-value.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 });