snaptrade-typescript-sdk 3.0.0 → 5.0.0

package/dist/models/brokerage-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/brokerage-type.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.
+ */
+/**
+ * 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/dist/models/brokerage-type.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/brokerage.d.ts

@@ -0,0 +1,128 @@
+/**
+ * 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 { 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/dist/models/brokerage.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/calculated-trade.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { 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/dist/models/calculated-trade.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/cash-restriction.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 declare const CashRestrictionTypeEnum: {
+    readonly AllocateMax: "ALLOCATE_MAX";
+    readonly RetainMin: "RETAIN_MIN";
+};
+export type CashRestrictionTypeEnum = typeof CashRestrictionTypeEnum[keyof typeof CashRestrictionTypeEnum];

package/dist/models/cash-restriction.js

@@ -0,0 +1,20 @@
+"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.CashRestrictionTypeEnum = void 0;
+exports.CashRestrictionTypeEnum = {
+    AllocateMax: 'ALLOCATE_MAX',
+    RetainMin: 'RETAIN_MIN'
+};

package/dist/models/currency.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.
+ */
+/**
+ * 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/dist/models/currency.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/delete-user-response.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 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/dist/models/delete-user-response.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/dividend-at-date.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 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/dist/models/dividend-at-date.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/encrypted-response-encrypted-message-data.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 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/dist/models/encrypted-response-encrypted-message-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/encrypted-response.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.
+ */
+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/dist/models/encrypted-response.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/exchange-rate-pairs.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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';
+/**
+ * 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/dist/models/exchange-rate-pairs.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 });