snaptrade-typescript-sdk 3.0.0 → 4.0.0

package/dist/models/underlying-symbol.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 { Currency } from './currency';
+import { SecurityType } from './security-type';
+import { USExchange } from './usexchange';
+/**
+ * Underlying Symbol
+ * @export
+ * @interface UnderlyingSymbol
+ */
+export interface UnderlyingSymbol {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof UnderlyingSymbol
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UnderlyingSymbol
+     */
+    'symbol'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UnderlyingSymbol
+     */
+    'description'?: string | null;
+    /**
+     *
+     * @type {Currency}
+     * @memberof UnderlyingSymbol
+     */
+    'currency'?: Currency;
+    /**
+     *
+     * @type {USExchange}
+     * @memberof UnderlyingSymbol
+     */
+    'exchange'?: USExchange;
+    /**
+     *
+     * @type {SecurityType}
+     * @memberof UnderlyingSymbol
+     */
+    'type'?: SecurityType;
+    /**
+     *
+     * @type {Array<Currency>}
+     * @memberof UnderlyingSymbol
+     */
+    'currencies'?: Array<Currency>;
+}

package/dist/models/underlying-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/universal-activity.d.ts

@@ -0,0 +1,134 @@
+/**
+ * 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 { AccountSimple } from './account-simple';
+import { Currency } from './currency';
+import { OptionsSymbol } from './options-symbol';
+import { Symbol } from './symbol';
+/**
+ * A transaction or activity from an institution
+ * @export
+ * @interface UniversalActivity
+ */
+export interface UniversalActivity {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalActivity
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {AccountSimple}
+     * @memberof UniversalActivity
+     */
+    'account'?: AccountSimple;
+    /**
+     *
+     * @type {number}
+     * @memberof UniversalActivity
+     */
+    'amount'?: number | null;
+    /**
+     *
+     * @type {Currency}
+     * @memberof UniversalActivity
+     */
+    'currency'?: Currency;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalActivity
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof UniversalActivity
+     */
+    'fee'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalActivity
+     */
+    'institution'?: string;
+    /**
+     * If an option transaction, then it\'s type (BUY_TO_OPEN, SELL_TO_CLOSE, etc), otherwise empty string
+     * @type {string}
+     * @memberof UniversalActivity
+     */
+    'option_type'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof UniversalActivity
+     */
+    'price'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalActivity
+     */
+    'settlement_date'?: string;
+    /**
+     *
+     * @type {Symbol}
+     * @memberof UniversalActivity
+     */
+    'symbol'?: Symbol;
+    /**
+     *
+     * @type {OptionsSymbol}
+     * @memberof UniversalActivity
+     */
+    'option_symbol'?: OptionsSymbol;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalActivity
+     */
+    'trade_date'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalActivity
+     */
+    'type'?: UniversalActivityTypeEnum;
+    /**
+     * Usually but not necessarily an integer
+     * @type {number}
+     * @memberof UniversalActivity
+     */
+    'units'?: number;
+}
+export declare const UniversalActivityTypeEnum: {
+    readonly Dividend: "DIVIDEND";
+    readonly Buy: "BUY";
+    readonly Sell: "SELL";
+    readonly Contribution: "CONTRIBUTION";
+    readonly Withdrawal: "WITHDRAWAL";
+    readonly ExternalAssetTransferIn: "EXTERNAL_ASSET_TRANSFER_IN";
+    readonly ExternalAssetTransferOut: "EXTERNAL_ASSET_TRANSFER_OUT";
+    readonly InternalCashTransferIn: "INTERNAL_CASH_TRANSFER_IN";
+    readonly InternalCashTransferOut: "INTERNAL_CASH_TRANSFER_OUT";
+    readonly InternalAssetTransferIn: "INTERNAL_ASSET_TRANSFER_IN";
+    readonly InternalAssetTransferOut: "INTERNAL_ASSET_TRANSFER_OUT";
+    readonly Interest: "INTEREST";
+    readonly Rebate: "REBATE";
+    readonly GovGrant: "GOV_GRANT";
+    readonly Tax: "TAX";
+    readonly Fee: "FEE";
+    readonly Rei: "REI";
+    readonly Fxt: "FXT";
+};
+export type UniversalActivityTypeEnum = typeof UniversalActivityTypeEnum[keyof typeof UniversalActivityTypeEnum];

package/dist/models/universal-activity.js

@@ -0,0 +1,36 @@
+"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.UniversalActivityTypeEnum = void 0;
+exports.UniversalActivityTypeEnum = {
+    Dividend: 'DIVIDEND',
+    Buy: 'BUY',
+    Sell: 'SELL',
+    Contribution: 'CONTRIBUTION',
+    Withdrawal: 'WITHDRAWAL',
+    ExternalAssetTransferIn: 'EXTERNAL_ASSET_TRANSFER_IN',
+    ExternalAssetTransferOut: 'EXTERNAL_ASSET_TRANSFER_OUT',
+    InternalCashTransferIn: 'INTERNAL_CASH_TRANSFER_IN',
+    InternalCashTransferOut: 'INTERNAL_CASH_TRANSFER_OUT',
+    InternalAssetTransferIn: 'INTERNAL_ASSET_TRANSFER_IN',
+    InternalAssetTransferOut: 'INTERNAL_ASSET_TRANSFER_OUT',
+    Interest: 'INTEREST',
+    Rebate: 'REBATE',
+    GovGrant: 'GOV_GRANT',
+    Tax: 'TAX',
+    Fee: 'FEE',
+    Rei: 'REI',
+    Fxt: 'FXT'
+};

package/dist/models/universal-symbol-ticker.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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 { Exchange } from './exchange';
+import { SecurityType } from './security-type';
+/**
+ * Universal symbol
+ * @export
+ * @interface UniversalSymbolTicker
+ */
+export interface UniversalSymbolTicker {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalSymbolTicker
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalSymbolTicker
+     */
+    'symbol'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalSymbolTicker
+     */
+    'raw_symbol'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalSymbolTicker
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof UniversalSymbolTicker
+     */
+    'currency'?: Currency;
+    /**
+     *
+     * @type {Exchange}
+     * @memberof UniversalSymbolTicker
+     */
+    'exchange'?: Exchange;
+    /**
+     *
+     * @type {SecurityType}
+     * @memberof UniversalSymbolTicker
+     */
+    'type'?: SecurityType;
+    /**
+     *
+     * @type {Array<Currency>}
+     * @memberof UniversalSymbolTicker
+     */
+    'currencies'?: Array<Currency>;
+}

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

@@ -0,0 +1,69 @@
+/**
+ * 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 { Exchange } from './exchange';
+import { SecurityType } from './security-type';
+/**
+ * Universal symbol
+ * @export
+ * @interface UniversalSymbol
+ */
+export interface UniversalSymbol {
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalSymbol
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalSymbol
+     */
+    'symbol'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalSymbol
+     */
+    'raw_symbol'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UniversalSymbol
+     */
+    'description'?: string | null;
+    /**
+     *
+     * @type {Currency}
+     * @memberof UniversalSymbol
+     */
+    'currency'?: Currency;
+    /**
+     *
+     * @type {Exchange}
+     * @memberof UniversalSymbol
+     */
+    'exchange'?: Exchange;
+    /**
+     *
+     * @type {SecurityType}
+     * @memberof UniversalSymbol
+     */
+    'type'?: SecurityType;
+    /**
+     *
+     * @type {Array<Currency>}
+     * @memberof UniversalSymbol
+     */
+    'currencies'?: Array<Currency>;
+}

package/dist/models/universal-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/user-error-log.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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.
+ */
+/**
+ * An API error log for a specific SnapTrade user.
+ * @export
+ * @interface UserErrorLog
+ */
+export interface UserErrorLog {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof UserErrorLog
+     */
+    'requestedAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserErrorLog
+     */
+    'response'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof UserErrorLog
+     */
+    'statusCode'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof UserErrorLog
+     */
+    'queryParams'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserErrorLog
+     */
+    'httpMethod'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserErrorLog
+     */
+    'endpoint'?: string;
+}

package/dist/models/user-error-log.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/user-idand-secret.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 UserIDandSecret
+ */
+export interface UserIDandSecret {
+    [key: string]: any;
+    /**
+     * SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it\'s unique to a user
+     * @type {string}
+     * @memberof UserIDandSecret
+     */
+    'userId'?: string;
+    /**
+     * SnapTrade User Secret randomly generated by Passiv.
+     * @type {string}
+     * @memberof UserIDandSecret
+     */
+    'userSecret'?: string;
+}

package/dist/models/user-idand-secret.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/user-settings.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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';
+/**
+ * Passiv user account settings
+ * @export
+ * @interface UserSettings
+ */
+export interface UserSettings {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof UserSettings
+     */
+    'email'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserSettings
+     */
+    'name'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserSettings
+     */
+    'receive_cash_notification'?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserSettings
+     */
+    'receive_drift_notification'?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserSettings
+     */
+    'user_trial_activated'?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof UserSettings
+     */
+    'activated_trial_date'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserSettings
+     */
+    'demo'?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserSettings
+     */
+    'api_enabled'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof UserSettings
+     */
+    'drift_threshold'?: number;
+    /**
+     *
+     * @type {Currency}
+     * @memberof UserSettings
+     */
+    'preferred_currency'?: Currency;
+}

package/dist/models/user-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 });