snaptrade-typescript-sdk 2.4.0 → 4.0.0

package/models/apidisclaimer-accept-request.ts

@@ -0,0 +1,29 @@
+/* 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 APIDisclaimerAcceptRequest
+ */
+export interface APIDisclaimerAcceptRequest {
+    /**
+     * A boolean that indicates whether this user has accepted the disclaimer or not.
+     * @type {boolean}
+     * @memberof APIDisclaimerAcceptRequest
+     */
+    'accepted'?: boolean;
+}
+

package/models/authentication-login-snap-trade-user200-response.ts

@@ -0,0 +1,31 @@
+/* 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 { EncryptedResponse } from './encrypted-response';
+// May contain unused imports in some cases
+// @ts-ignore
+import { EncryptedResponseEncryptedMessageData } from './encrypted-response-encrypted-message-data';
+// May contain unused imports in some cases
+// @ts-ignore
+import { LoginRedirectURI } from './login-redirect-uri';
+
+/**
+ * @type AuthenticationLoginSnapTradeUser200Response
+ * @export
+ */
+export type AuthenticationLoginSnapTradeUser200Response = EncryptedResponse | LoginRedirectURI;
+
+

package/models/balance.ts

@@ -0,0 +1,40 @@
+/* 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';
+
+/**
+ * Account Balance
+ * @export
+ * @interface Balance
+ */
+export interface Balance {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {Currency}
+     * @memberof Balance
+     */
+    'currency'?: Currency;
+    /**
+     * 
+     * @type {number}
+     * @memberof Balance
+     */
+    'cash'?: number | null;
+}
+

package/models/brokerage-authorization-type-read-only-brokerage.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 BrokerageAuthorizationTypeReadOnlyBrokerage
+ */
+export interface BrokerageAuthorizationTypeReadOnlyBrokerage {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof BrokerageAuthorizationTypeReadOnlyBrokerage
+     */
+    'id'?: string;
+    /**
+     * Name of Brokerage
+     * @type {string}
+     * @memberof BrokerageAuthorizationTypeReadOnlyBrokerage
+     */
+    'name'?: string;
+    /**
+     * Slug of Brokerage. It is usually the name of the brokerage in capital letters
+     * @type {string}
+     * @memberof BrokerageAuthorizationTypeReadOnlyBrokerage
+     */
+    'slug'?: string;
+}
+

package/models/brokerage-authorization-type-read-only.ts

@@ -0,0 +1,68 @@
+/* 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 { BrokerageAuthorizationTypeReadOnlyBrokerage } from './brokerage-authorization-type-read-only-brokerage';
+
+/**
+ * 
+ * @export
+ * @interface BrokerageAuthorizationTypeReadOnly
+ */
+export interface BrokerageAuthorizationTypeReadOnly {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof BrokerageAuthorizationTypeReadOnly
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof BrokerageAuthorizationTypeReadOnly
+     */
+    'type'?: BrokerageAuthorizationTypeReadOnlyTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof BrokerageAuthorizationTypeReadOnly
+     */
+    'auth_type'?: BrokerageAuthorizationTypeReadOnlyAuthTypeEnum;
+    /**
+     * 
+     * @type {BrokerageAuthorizationTypeReadOnlyBrokerage}
+     * @memberof BrokerageAuthorizationTypeReadOnly
+     */
+    'brokerage'?: BrokerageAuthorizationTypeReadOnlyBrokerage;
+}
+
+export const BrokerageAuthorizationTypeReadOnlyTypeEnum = {
+    Read: 'read',
+    Trade: 'trade'
+} as const;
+
+export type BrokerageAuthorizationTypeReadOnlyTypeEnum = typeof BrokerageAuthorizationTypeReadOnlyTypeEnum[keyof typeof BrokerageAuthorizationTypeReadOnlyTypeEnum];
+export const BrokerageAuthorizationTypeReadOnlyAuthTypeEnum = {
+    Oauth: 'OAUTH',
+    Scrape: 'SCRAPE',
+    UnofficialApi: 'UNOFFICIAL_API',
+    Token: 'TOKEN'
+} as const;
+
+export type BrokerageAuthorizationTypeReadOnlyAuthTypeEnum = typeof BrokerageAuthorizationTypeReadOnlyAuthTypeEnum[keyof typeof BrokerageAuthorizationTypeReadOnlyAuthTypeEnum];
+
+

package/models/brokerage-authorization-type.ts

@@ -0,0 +1,39 @@
+/* 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 BrokerageAuthorizationType
+ */
+export interface BrokerageAuthorizationType {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof BrokerageAuthorizationType
+     */
+    'type'?: BrokerageAuthorizationTypeTypeEnum;
+}
+
+export const BrokerageAuthorizationTypeTypeEnum = {
+    Read: 'read',
+    Trade: 'trade'
+} as const;
+
+export type BrokerageAuthorizationTypeTypeEnum = typeof BrokerageAuthorizationTypeTypeEnum[keyof typeof BrokerageAuthorizationTypeTypeEnum];
+
+

package/models/brokerage-authorization.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 { Brokerage } from './brokerage';
+
+/**
+ * 
+ * @export
+ * @interface BrokerageAuthorization
+ */
+export interface BrokerageAuthorization {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof BrokerageAuthorization
+     */
+    'id'?: string;
+    /**
+     * Time
+     * @type {string}
+     * @memberof BrokerageAuthorization
+     */
+    'created_date'?: string;
+    /**
+     * Time
+     * @type {string}
+     * @memberof BrokerageAuthorization
+     */
+    'updated_date'?: string;
+    /**
+     * 
+     * @type {Brokerage}
+     * @memberof BrokerageAuthorization
+     */
+    'brokerage'?: Brokerage;
+    /**
+     * Connection Name
+     * @type {string}
+     * @memberof BrokerageAuthorization
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof BrokerageAuthorization
+     */
+    'type'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof BrokerageAuthorization
+     */
+    'disabled'?: boolean;
+    /**
+     * Disabled date
+     * @type {string}
+     * @memberof BrokerageAuthorization
+     */
+    'disabled_date'?: string | null;
+    /**
+     * Additional data about brokerage authorization
+     * @type {{ [key: string]: any; }}
+     * @memberof BrokerageAuthorization
+     */
+    'meta'?: { [key: string]: any; };
+}
+

package/models/brokerage-symbol.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.
+ */
+
+// May contain unused imports in some cases
+// @ts-ignore
+import { BrokerageAuthorization } from './brokerage-authorization';
+// May contain unused imports in some cases
+// @ts-ignore
+import { UniversalSymbol } from './universal-symbol';
+
+/**
+ * Brokerage symbol
+ * @export
+ * @interface BrokerageSymbol
+ */
+export interface BrokerageSymbol {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof BrokerageSymbol
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {UniversalSymbol}
+     * @memberof BrokerageSymbol
+     */
+    'symbol'?: UniversalSymbol;
+    /**
+     * 
+     * @type {BrokerageAuthorization}
+     * @memberof BrokerageSymbol
+     */
+    'brokerage_authorization'?: BrokerageAuthorization;
+    /**
+     * 
+     * @type {string}
+     * @memberof BrokerageSymbol
+     */
+    'description'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof BrokerageSymbol
+     */
+    'allows_fractional_units'?: boolean | null;
+}
+

package/models/brokerage-type.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.
+ */
+
+
+/**
+ * Type of brokerage
+ * @export
+ * @interface BrokerageType
+ */
+export interface BrokerageType {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof BrokerageType
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof BrokerageType
+     */
+    'name'?: string;
+}
+

package/models/brokerage.ts

@@ -0,0 +1,136 @@
+/* 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 { BrokerageType } from './brokerage-type';
+
+/**
+ * 
+ * @export
+ * @interface Brokerage
+ */
+export interface Brokerage {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof Brokerage
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Brokerage
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Brokerage
+     */
+    'display_name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Brokerage
+     */
+    'description'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Brokerage
+     */
+    'aws_s3_logo_url'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Brokerage
+     */
+    'slug'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Brokerage
+     */
+    'url'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Brokerage
+     */
+    'enabled'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Brokerage
+     */
+    'maintenance_mode'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Brokerage
+     */
+    'allows_fractional_units'?: boolean | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Brokerage
+     */
+    'allows_trading'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Brokerage
+     */
+    'has_reporting'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Brokerage
+     */
+    'is_real_time_connection'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Brokerage
+     */
+    'allows_trading_through_snaptrade_api'?: boolean | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Brokerage
+     */
+    'is_scraping_integration'?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof Brokerage
+     */
+    'default_currency'?: string;
+    /**
+     * 
+     * @type {BrokerageType}
+     * @memberof Brokerage
+     */
+    'brokerage_type'?: BrokerageType;
+    /**
+     * List of exchange ID supported by brokerage
+     * @type {Array<any>}
+     * @memberof Brokerage
+     */
+    'exchanges'?: Array<any>;
+}
+

package/models/calculated-trade.ts

@@ -0,0 +1,40 @@
+/* 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 { Trade } from './trade';
+
+/**
+ * Array of trades to make to rebalance portfolio
+ * @export
+ * @interface CalculatedTrade
+ */
+export interface CalculatedTrade {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof CalculatedTrade
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {Array<Trade>}
+     * @memberof CalculatedTrade
+     */
+    'trades'?: Array<Trade>;
+}
+

package/models/cash-restriction.ts

@@ -0,0 +1,63 @@
+/* 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.
+ */
+
+
+/**
+ * Cash restriction rules that apply to this account when undergoing portfolio rebalance calculations.
+ * @export
+ * @interface CashRestriction
+ */
+export interface CashRestriction {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof CashRestriction
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CashRestriction
+     */
+    'account'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CashRestriction
+     */
+    'currency'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CashRestriction
+     */
+    'type'?: CashRestrictionTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof CashRestriction
+     */
+    'amount'?: number;
+}
+
+export const CashRestrictionTypeEnum = {
+    AllocateMax: 'ALLOCATE_MAX',
+    RetainMin: 'RETAIN_MIN'
+} as const;
+
+export type CashRestrictionTypeEnum = typeof CashRestrictionTypeEnum[keyof typeof CashRestrictionTypeEnum];
+
+