snaptrade-typescript-sdk 2.4.0 → 4.0.0

package/models/universal-activity.ts

@@ -0,0 +1,151 @@
+/* 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 { AccountSimple } from './account-simple';
+// May contain unused imports in some cases
+// @ts-ignore
+import { Currency } from './currency';
+// May contain unused imports in some cases
+// @ts-ignore
+import { OptionsSymbol } from './options-symbol';
+// May contain unused imports in some cases
+// @ts-ignore
+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 const 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'
+} as const;
+
+export type UniversalActivityTypeEnum = typeof UniversalActivityTypeEnum[keyof typeof UniversalActivityTypeEnum];
+
+

package/models/universal-symbol-ticker.ts

@@ -0,0 +1,82 @@
+/* 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';
+// May contain unused imports in some cases
+// @ts-ignore
+import { Exchange } from './exchange';
+// May contain unused imports in some cases
+// @ts-ignore
+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/models/universal-symbol.ts

@@ -0,0 +1,80 @@
+/* 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';
+// May contain unused imports in some cases
+// @ts-ignore
+import { Exchange } from './exchange';
+// May contain unused imports in some cases
+// @ts-ignore
+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/models/user-error-log.ts

@@ -0,0 +1,61 @@
+/* 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.
+ */
+
+
+/**
+ * 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/models/user-idand-secret.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.
+ */
+
+
+/**
+ * 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/models/user-settings.ts

@@ -0,0 +1,88 @@
+/* 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';
+
+/**
+ * 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/models/usexchange.ts

@@ -0,0 +1,79 @@
+/* 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.
+ */
+
+
+/**
+ * US Stock Exchange
+ * @export
+ * @interface USExchange
+ */
+export interface USExchange {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof USExchange
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof USExchange
+     */
+    'code'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof USExchange
+     */
+    'mic_code'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof USExchange
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof USExchange
+     */
+    'timezone'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof USExchange
+     */
+    'start_time'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof USExchange
+     */
+    'close_time'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof USExchange
+     */
+    'suffix'?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof USExchange
+     */
+    'allows_cryptocurrency_symbols'?: boolean;
+}
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "snaptrade-typescript-sdk",
-  "version": "2.4.0",
+  "version": "4.0.0",
   "description": "Client for SnapTrade",
   "author": "Konfig",
   "repository": {

package/pagination/page.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 { Pageable, PageParametersBase } from "./pageable";
+
+/**
+ * The set of parameters that appear in a paginated operation (requestBody or parameters)
+ */
+export type PageParameterProperties = {
+  [key: string]: any
+};
+
+export type PageParameters = PageParametersBase<PageParameterProperties>;
+
+/**
+ * The set of properties that appear in a paginated operation's response
+ */
+export interface PageInfo {
+  [key: string]: any
+}
+
+export class Page<
+  Data extends PageInfo,
+  Parameters extends PageParameters
+> extends Pageable<Data, Parameters> {
+  protected get previousParameters(): PageParameterProperties | null {
+    throw Error("Stub")
+  }
+
+  protected get nextParameters(): PageParameterProperties | null {
+    throw Error("Stub")
+  }
+
+  hasPrevious(): boolean {
+    throw Error("Stub")
+  }
+
+  hasNext(): boolean {
+    throw Error("Stub")
+  }
+}