snaptrade-typescript-sdk 3.0.0 → 5.0.0

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

package/models/delete-user-response.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 delete user is successful
+ * @export
+ * @interface DeleteUserResponse
+ */
+export interface DeleteUserResponse {
+    [key: string]: any;
+
+    /**
+     * Delete status
+     * @type {string}
+     * @memberof DeleteUserResponse
+     */
+    'status'?: string;
+    /**
+     * SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it\'s unique to a user
+     * @type {string}
+     * @memberof DeleteUserResponse
+     */
+    'userId'?: string;
+}
+

package/models/dividend-at-date.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 DividendAtDate
+ */
+export interface DividendAtDate {
+    [key: string]: any;
+
+    /**
+     * The ticker of the symbol that the dividend came from
+     * @type {string}
+     * @memberof DividendAtDate
+     */
+    'symbol'?: string | null;
+    /**
+     * The amount received from the dividend
+     * @type {number}
+     * @memberof DividendAtDate
+     */
+    'amount'?: number | null;
+    /**
+     * The currency of the amount
+     * @type {string}
+     * @memberof DividendAtDate
+     */
+    'currency'?: string;
+}
+

package/models/encrypted-response-encrypted-message-data.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 EncryptedResponseEncryptedMessageData
+ */
+export interface EncryptedResponseEncryptedMessageData {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof EncryptedResponseEncryptedMessageData
+     */
+    'encryptedMessage'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EncryptedResponseEncryptedMessageData
+     */
+    'tag'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EncryptedResponseEncryptedMessageData
+     */
+    'nonce'?: string;
+}
+

package/models/encrypted-response.ts

@@ -0,0 +1,38 @@
+/* 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 { EncryptedResponseEncryptedMessageData } from './encrypted-response-encrypted-message-data';
+
+/**
+ * This response consists of 2 different components that must be decrypted to obtain the decrypted message  * Decrypting the encryptedSharedKey    The encrypted shared key is a shared key that was randomly generated by SnapTrade and encrypted using the users SSH public key provided when registering the user   It is needed to decrypt the message in step 2.    To decrypt the shared key, the user should have access to their SSH private key stored locally in their device    An example Python code on how to decrypt the shared key is shown below    ```   def decrypt_rsa_message(self, encrypted_message):       from Crypto.Cipher import PKCS1_OAEP       from Crypto.PublicKey import RSA       from base64 import b64decode        f = open(\'private.pem\', \'r\')       private_key = RSA.import_key(f.read())       cipher = PKCS1_OAEP.new(private_key)        return cipher.decrypt(b64decode(encrypted_message.encode())).decode()   ```  * Decrypting the encryptedMessageData     The data meant to be returned by an endpoint can be obtained by decrypting the encrypted message     An encrypted message is a message that is encrypted using AES - MODE OCB with the shared key obtained in step one    An example code to decrypt the encrypted message is shown below    ```   def decrypt_aes_message(self, shared_key, encrypted_message):       from Crypto.Cipher import AES       from base64 import b64decode        encrypted_msg = b64decode(encrypted_message[\"encryptedMessage\"].encode())       tag = b64decode(encrypted_message[\"tag\"].encode())       nonce = b64decode(encrypted_message[\"nonce\"].encode())       cipher = AES.new(shared_key.encode(), AES.MODE_OCB, nonce=nonce)        return cipher.decrypt_and_verify(encrypted_msg, tag).decode()   ``` 
+ * @export
+ * @interface EncryptedResponse
+ */
+export interface EncryptedResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof EncryptedResponse
+     */
+    'encryptedSharedKey'?: string;
+    /**
+     * 
+     * @type {EncryptedResponseEncryptedMessageData}
+     * @memberof EncryptedResponse
+     */
+    'encryptedMessageData'?: EncryptedResponseEncryptedMessageData;
+}
+

package/models/exchange-rate-pairs.ts

@@ -0,0 +1,46 @@
+/* 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';
+
+/**
+ * The exchange rate of a pair of currencies
+ * @export
+ * @interface ExchangeRatePairs
+ */
+export interface ExchangeRatePairs {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {Currency}
+     * @memberof ExchangeRatePairs
+     */
+    'src'?: Currency;
+    /**
+     * 
+     * @type {Currency}
+     * @memberof ExchangeRatePairs
+     */
+    'dst'?: Currency;
+    /**
+     * 
+     * @type {number}
+     * @memberof ExchangeRatePairs
+     */
+    'exchange_rate'?: number;
+}
+

package/models/exchange.ts

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

package/models/excluded-asset.ts

@@ -0,0 +1,34 @@
+/* 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 { UniversalSymbol } from './universal-symbol';
+
+/**
+ * An excluded asset in a portfolio group
+ * @export
+ * @interface ExcludedAsset
+ */
+export interface ExcludedAsset {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {UniversalSymbol}
+     * @memberof ExcludedAsset
+     */
+    'symbol'?: UniversalSymbol;
+}
+

package/models/index.ts

@@ -0,0 +1,102 @@
+export * from './apidisclaimer-accept-request';
+export * from './account';
+export * from './account-holdings';
+export * from './account-order-record';
+export * from './account-order-record-status';
+export * from './account-simple';
+export * from './action';
+export * from './authentication-login-snap-trade-user200-response';
+export * from './balance';
+export * from './brokerage';
+export * from './brokerage-authorization';
+export * from './brokerage-authorization-type';
+export * from './brokerage-authorization-type-read-only';
+export * from './brokerage-authorization-type-read-only-brokerage';
+export * from './brokerage-symbol';
+export * from './brokerage-type';
+export * from './calculated-trade';
+export * from './cash-restriction';
+export * from './currency';
+export * from './delete-user-response';
+export * from './dividend-at-date';
+export * from './encrypted-response';
+export * from './encrypted-response-encrypted-message-data';
+export * from './exchange';
+export * from './exchange-rate-pairs';
+export * from './excluded-asset';
+export * from './jwt';
+export * from './login-redirect-uri';
+export * from './manual-trade';
+export * from './manual-trade-and-impact';
+export * from './manual-trade-balance';
+export * from './manual-trade-form';
+export * from './manual-trade-symbol';
+export * from './model400-failed-request-response';
+export * from './model401-failed-request-response';
+export * from './model403-failed-request-response';
+export * from './model404-failed-request-response';
+export * from './model-asset-class';
+export * from './model-asset-class-details';
+export * from './model-asset-class-target';
+export * from './model-portfolio';
+export * from './model-portfolio-asset-class';
+export * from './model-portfolio-details';
+export * from './model-portfolio-security';
+export * from './monthly-dividends';
+export * from './net-contributions';
+export * from './net-dividend';
+export * from './option-chain-inner';
+export * from './option-chain-inner-chain-per-root-inner';
+export * from './option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner';
+export * from './option-leg';
+export * from './option-strategy';
+export * from './option-strategy-legs-inner';
+export * from './options-get-option-strategy-request';
+export * from './options-holdings';
+export * from './options-place-option-strategy-request';
+export * from './options-position';
+export * from './options-symbol';
+export * from './order-type';
+export * from './partner-data';
+export * from './past-value';
+export * from './performance-custom';
+export * from './portfolio-group';
+export * from './portfolio-group-info';
+export * from './portfolio-group-position';
+export * from './portfolio-group-settings';
+export * from './position';
+export * from './position-symbol';
+export * from './redirect-tokenand-pin';
+export * from './security-type';
+export * from './snap-trade-apidisclaimer-accept-status';
+export * from './snap-trade-holdings-account';
+export * from './snap-trade-holdings-total-value';
+export * from './snap-trade-login-user-request-body';
+export * from './snap-trade-register-user-request-body';
+export * from './status';
+export * from './strategy-impact';
+export * from './strategy-impact-legs-inner';
+export * from './strategy-order-place';
+export * from './strategy-order-place-orders-inner';
+export * from './strategy-order-place-orders-inner-legs-inner';
+export * from './strategy-order-record';
+export * from './strategy-quotes';
+export * from './strategy-quotes-greek';
+export * from './sub-period-return-rate';
+export * from './symbol';
+export * from './symbol-query';
+export * from './symbols-quotes';
+export * from './target-asset';
+export * from './time-in-force';
+export * from './trade';
+export * from './trade-execution-status';
+export * from './trade-impact';
+export * from './trading-place-ocoorder-request';
+export * from './usexchange';
+export * from './underlying-symbol';
+export * from './universal-activity';
+export * from './universal-symbol';
+export * from './universal-symbol-ticker';
+export * from './user-error-log';
+export * from './user-idand-secret';
+export * from './user-settings';

package/models/jwt.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.
+ */
+
+
+/**
+ * JWT Token. Used to acess resources in private endpoints available only through the Passiv app
+ * @export
+ * @interface JWT
+ */
+export interface JWT {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof JWT
+     */
+    'token'?: string;
+}
+

package/models/login-redirect-uri.ts

@@ -0,0 +1,35 @@
+/* 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.
+ */
+
+
+/**
+ * Redirect uri upon successful login
+ * @export
+ * @interface LoginRedirectURI
+ */
+export interface LoginRedirectURI {
+    /**
+     * 
+     * @type {any}
+     * @memberof LoginRedirectURI
+     */
+    'redirectURI'?: any;
+    /**
+     * 
+     * @type {string}
+     * @memberof LoginRedirectURI
+     */
+    'sessionId'?: string;
+}
+

package/models/manual-trade-and-impact.ts

@@ -0,0 +1,49 @@
+/* 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 { ManualTrade } from './manual-trade';
+// May contain unused imports in some cases
+// @ts-ignore
+import { ManualTradeBalance } from './manual-trade-balance';
+
+/**
+ * Manual Trade and Impact object
+ * @export
+ * @interface ManualTradeAndImpact
+ */
+export interface ManualTradeAndImpact {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {ManualTrade}
+     * @memberof ManualTradeAndImpact
+     */
+    'trade'?: ManualTrade;
+    /**
+     * 
+     * @type {Array<ManualTrade>}
+     * @memberof ManualTradeAndImpact
+     */
+    'trade_impacts'?: Array<ManualTrade>;
+    /**
+     * 
+     * @type {ManualTradeBalance}
+     * @memberof ManualTradeAndImpact
+     */
+    'combined_remaining_balance'?: ManualTradeBalance;
+}
+

package/models/manual-trade-balance.ts

@@ -0,0 +1,49 @@
+/* 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 { Account } from './account';
+// May contain unused imports in some cases
+// @ts-ignore
+import { Currency } from './currency';
+
+/**
+ * Balance
+ * @export
+ * @interface ManualTradeBalance
+ */
+export interface ManualTradeBalance {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {Account}
+     * @memberof ManualTradeBalance
+     */
+    'account'?: Account;
+    /**
+     * 
+     * @type {Currency}
+     * @memberof ManualTradeBalance
+     */
+    'currency'?: Currency;
+    /**
+     * Cash
+     * @type {number}
+     * @memberof ManualTradeBalance
+     */
+    'cash'?: number | null;
+}
+