snaptrade 1.17.5 → 1.17.7

data/docs/Position.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **symbol** | **PositionSymbol** |  | [optional] |
+| **symbol** | [**PositionSymbol**](PositionSymbol.md) |  | [optional] |
 | **units** | **Float** |  | [optional] |
 | **price** | **Float** | Last known market price for the symbol | [optional] |
 | **open_pnl** | **Float** |  | [optional] |

data/docs/PositionSymbol.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional] |
 | **description** | **String** |  | [optional] |
-| **symbol** | **UniversalSymbol** |  | [optional] |
+| **symbol** | [**UniversalSymbol**](UniversalSymbol.md) |  | [optional] |
 | **local_id** | **String** |  | [optional] |
 | **is_quotable** | **Boolean** |  | [optional] |
 | **is_tradable** | **Boolean** |  | [optional] |

data/docs/SnapTradeHoldingsAccount.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional] |
-| **brokerage_authorization** | **BrokerageAuthorization** |  | [optional] |
+| **brokerage_authorization** | [**BrokerageAuthorization**](BrokerageAuthorization.md) |  | [optional] |
 | **portfolio_group** | **String** |  | [optional] |
 | **name** | **String** |  | [optional] |
 | **number** | **String** |  | [optional] |

data/docs/SnapTradeLoginUserRequestBody.md

@@ -7,8 +7,9 @@
 | **broker** | **String** | Slug of the brokerage to connect the user to | [optional] |
 | **immediate_redirect** | **Boolean** | When set to True, user will be redirected back to the partner's site instead of the connection portal | [optional] |
 | **custom_redirect** | **String** | URL to redirect the user to after the user connects their brokerage account | [optional] |
-| **reconnect** | **String** | The UUID of the brokerage connection to be reconnected | [optional] |
+| **reconnect** | **String** | The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information. | [optional] |
 | **connection_type** | [**ConnectionType**](ConnectionType.md) |  | [optional] |
+| **connection_portal_version** | [**ConnectionPortalVersion**](ConnectionPortalVersion.md) |  | [optional] |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = SnapTrade::SnapTradeLoginUserRequestBody.new(
   immediate_redirect: true,
   custom_redirect: https://snaptrade.com,
   reconnect: 8b5f262d-4bb9-365d-888a-202bd3b15fa1,
-  connection_type: null
+  connection_type: null,
+  connection_portal_version: null
 )
 ```
 

data/docs/StrategyOrderRecord.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **strategy** | **OptionStrategy** |  | [optional] |
+| **strategy** | [**OptionStrategy**](OptionStrategy.md) |  | [optional] |
 | **status** | [**StrategyOrderRecordStatus**](StrategyOrderRecordStatus.md) |  | [optional] |
 | **filled_quantity** | **Float** |  | [optional] |
 | **open_quantity** | **Float** |  | [optional] |

data/docs/StrategyQuotes.md

@@ -4,12 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **strategy** | **OptionStrategy** |  | [optional] |
+| **strategy** | [**OptionStrategy**](OptionStrategy.md) |  | [optional] |
 | **open_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
 | **bid_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
 | **ask_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
 | **volatility** | **Float** |  | [optional] |
-| **greek** | **StrategyQuotesGreek** |  | [optional] |
+| **greek** | [**StrategyQuotesGreek**](StrategyQuotesGreek.md) |  | [optional] |
 
 ## Example
 

data/docs/SubPeriodReturnRate.md

@@ -14,8 +14,8 @@
 require 'snaptrade'
 
 instance = SnapTrade::SubPeriodReturnRate.new(
-  period_start: Mon Jan 24 00:00:00 UTC 2022,
-  period_end: Mon Jan 24 00:00:00 UTC 2022,
+  period_start: Sun Jan 23 16:00:00 PST 2022,
+  period_end: Sun Jan 23 16:00:00 PST 2022,
   rate_of_return: 0.012312367452
 )
 ```

data/docs/Symbol.md

@@ -8,9 +8,9 @@
 | **symbol** | **String** |  | [optional] |
 | **raw_symbol** | **String** |  | [optional] |
 | **name** | **String** |  | [optional] |
-| **currency** | **Currency** |  | [optional] |
-| **exchange** | **Exchange** |  | [optional] |
-| **type** | **SecurityType** |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **exchange** | [**Exchange**](Exchange.md) |  | [optional] |
+| **type** | [**SecurityType**](SecurityType.md) |  | [optional] |
 
 ## Example
 

data/docs/SymbolsQuotesInner.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **symbol** | **UniversalSymbol** |  | [optional] |
+| **symbol** | [**UniversalSymbol**](UniversalSymbol.md) |  | [optional] |
 | **bid_price** | **Float** |  | [optional] |
 | **ask_price** | **Float** |  | [optional] |
 | **last_trade_price** | **Float** |  | [optional] |

data/docs/TargetAsset.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional] |
-| **symbol** | **UniversalSymbol** |  | [optional] |
+| **symbol** | [**UniversalSymbol**](UniversalSymbol.md) |  | [optional] |
 | **percent** | **Float** |  | [optional] |
 | **is_supported** | **Boolean** |  | [optional] |
 | **is_excluded** | **Boolean** |  | [optional] |

data/docs/Trade.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional] |
-| **account** | **Account** |  | [optional] |
-| **symbol** | **BrokerageSymbol** |  | [optional] |
-| **universal_symbol** | **UniversalSymbol** |  | [optional] |
+| **account** | [**Account**](Account.md) |  | [optional] |
+| **symbol** | [**BrokerageSymbol**](BrokerageSymbol.md) |  | [optional] |
+| **universal_symbol** | [**UniversalSymbol**](UniversalSymbol.md) |  | [optional] |
 | **action** | [**TradeAction**](TradeAction.md) |  | [optional] |
 | **units** | **Integer** |  | [optional] |
 | **price** | **Float** |  | [optional] |

data/docs/TradeExecutionStatus.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **symbol** | **BrokerageSymbol** |  | [optional] |
-| **universal_symbol** | **UniversalSymbol** |  | [optional] |
-| **trade** | **Trade** |  | [optional] |
+| **symbol** | [**BrokerageSymbol**](BrokerageSymbol.md) |  | [optional] |
+| **universal_symbol** | [**UniversalSymbol**](UniversalSymbol.md) |  | [optional] |
+| **trade** | [**Trade**](Trade.md) |  | [optional] |
 | **state** | [**State**](State.md) |  | [optional] |
 | **filled_units** | **Integer** | Number of filled units | [optional] |
 | **action** | [**TradeExecutionStatusAction**](TradeExecutionStatusAction.md) |  | [optional] |

data/docs/TradeImpact.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **account** | **Account** |  | [optional] |
-| **currency** | **Currency** |  | [optional] |
+| **account** | [**Account**](Account.md) |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
 | **remaining_cash** | **Float** | Remaining balance after executing all trades | [optional] |
 | **estimated_commissions** | **Float** | Total estimated commissions across all trades to make | [optional] |
 | **forex_fees** | **Float** | Estimated forex fees to pay to excute trades | [optional] |

data/docs/TransactionsAndReportingApi.md

@@ -11,7 +11,7 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
 
 Get transaction history for a user
 
-Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
 
 ### Example
 
@@ -98,7 +98,7 @@ end
 
 Get performance information for a specific timeframe
 
-Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
 
 ### Example
 

data/docs/TransactionsStatus.md

@@ -14,7 +14,7 @@ require 'snaptrade'
 
 instance = SnapTrade::TransactionsStatus.new(
   initial_sync_completed: null,
-  last_successful_sync: Mon Jan 24 00:00:00 UTC 2022
+  last_successful_sync: Sun Jan 23 16:00:00 PST 2022
 )
 ```
 

data/docs/UnderlyingSymbol.md

@@ -7,9 +7,9 @@
 | **id** | **String** |  | [optional] |
 | **symbol** | **String** |  | [optional] |
 | **description** | **String** |  | [optional] |
-| **currency** | **Currency** |  | [optional] |
-| **exchange** | **USExchange** |  | [optional] |
-| **type** | **SecurityType** |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **exchange** | [**USExchange**](USExchange.md) |  | [optional] |
+| **type** | [**SecurityType**](SecurityType.md) |  | [optional] |
 | **currencies** | [**Array<Currency>**](Currency.md) |  | [optional] |
 
 ## Example

data/docs/UniversalActivity.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  | [optional] |
-| **account** | **AccountSimple** |  | [optional] |
+| **account** | [**AccountSimple**](AccountSimple.md) |  | [optional] |
 | **amount** | **Float** |  | [optional] |
-| **currency** | **Currency** |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
 | **description** | **String** |  | [optional] |
 | **fee** | **Float** |  | [optional] |
 | **fx_rate** | **Float** | The forex conversion rate involved in the transaction if provided by the brokerage. Used in cases where securities of one currency are purchased in a different currency, and the forex conversion is automatic. In those cases, price, amount and fee will be in the top level currency (activity -> currency) | [optional] |
@@ -16,8 +16,8 @@
 | **price** | **Float** |  | [optional] |
 | **settlement_date** | **String** |  | [optional] |
 | **external_reference_id** | **String** | Reference ID from brokerage used to identify related transactions. For example if an order comprises of several transactions (buy, fee, fx), they can be grouped if they share the same external_reference_id | [optional] |
-| **symbol** | **Symbol** |  | [optional] |
-| **option_symbol** | **OptionsSymbol** |  | [optional] |
+| **symbol** | [**Symbol**](Symbol.md) |  | [optional] |
+| **option_symbol** | [**OptionsSymbol**](OptionsSymbol.md) |  | [optional] |
 | **trade_date** | **String** |  | [optional] |
 | **type** | **String** | Potential values include (but are not limited to) - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT | [optional] |
 | **units** | **Float** | Usually but not necessarily an integer | [optional] |

data/docs/UniversalSymbol.md

@@ -8,9 +8,9 @@
 | **symbol** | **String** |  |  |
 | **raw_symbol** | **String** |  |  |
 | **description** | **String** |  | [optional] |
-| **currency** | **Currency** |  |  |
-| **exchange** | **Exchange** |  | [optional] |
-| **type** | **SecurityType** |  |  |
+| **currency** | [**Currency**](Currency.md) |  |  |
+| **exchange** | [**Exchange**](Exchange.md) |  | [optional] |
+| **type** | [**SecurityType**](SecurityType.md) |  |  |
 | **currencies** | [**Array<Currency>**](Currency.md) |  |  |
 
 ## Example

data/docs/UniversalSymbolTicker.md

@@ -8,9 +8,9 @@
 | **symbol** | **String** |  | [optional] |
 | **raw_symbol** | **String** |  | [optional] |
 | **description** | **String** |  | [optional] |
-| **currency** | **Currency** |  | [optional] |
-| **exchange** | **Exchange** |  | [optional] |
-| **type** | **SecurityType** |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **exchange** | [**Exchange**](Exchange.md) |  | [optional] |
+| **type** | [**SecurityType**](SecurityType.md) |  | [optional] |
 | **currencies** | [**Array<Currency>**](Currency.md) |  | [optional] |
 
 ## Example

data/docs/UserSettings.md

@@ -13,7 +13,7 @@
 | **demo** | **Boolean** |  | [optional] |
 | **api_enabled** | **Boolean** |  | [optional] |
 | **drift_threshold** | **Float** |  | [optional] |
-| **preferred_currency** | **Currency** |  | [optional] |
+| **preferred_currency** | [**Currency**](Currency.md) |  | [optional] |
 
 ## Example
 

data/lib/snaptrade/api/authentication_api.rb

@@ -267,17 +267,19 @@ module SnapTrade
     # @param broker [String] Slug of the brokerage to connect the user to
     # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner's site instead of the connection portal
     # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
-    # @param reconnect [String] The UUID of the brokerage connection to be reconnected
+    # @param reconnect [String] The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
     # @param connection_type [ConnectionType] 
+    # @param connection_portal_version [ConnectionPortalVersion] 
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def login_snap_trade_user(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, extra: {})
+    def login_snap_trade_user(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, connection_portal_version: SENTINEL, extra: {})
       _body = {}
       _body[:broker] = broker if broker != SENTINEL
       _body[:immediateRedirect] = immediate_redirect if immediate_redirect != SENTINEL
       _body[:customRedirect] = custom_redirect if custom_redirect != SENTINEL
       _body[:reconnect] = reconnect if reconnect != SENTINEL
       _body[:connectionType] = connection_type if connection_type != SENTINEL
+      _body[:connectionPortalVersion] = connection_portal_version if connection_portal_version != SENTINEL
       extra[:snap_trade_login_user_request_body] = _body if !_body.empty?
       data, _status_code, _headers = login_snap_trade_user_with_http_info_impl(user_id, user_secret, extra)
       data
@@ -290,17 +292,19 @@ module SnapTrade
     # @param broker [String] Slug of the brokerage to connect the user to
     # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner's site instead of the connection portal
     # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
-    # @param reconnect [String] The UUID of the brokerage connection to be reconnected
+    # @param reconnect [String] The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
     # @param connection_type [ConnectionType] 
+    # @param connection_portal_version [ConnectionPortalVersion] 
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def login_snap_trade_user_with_http_info(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, extra: {})
+    def login_snap_trade_user_with_http_info(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, connection_portal_version: SENTINEL, extra: {})
       _body = {}
       _body[:broker] = broker if broker != SENTINEL
       _body[:immediateRedirect] = immediate_redirect if immediate_redirect != SENTINEL
       _body[:customRedirect] = custom_redirect if custom_redirect != SENTINEL
       _body[:reconnect] = reconnect if reconnect != SENTINEL
       _body[:connectionType] = connection_type if connection_type != SENTINEL
+      _body[:connectionPortalVersion] = connection_portal_version if connection_portal_version != SENTINEL
       extra[:snap_trade_login_user_request_body] = _body if !_body.empty?
       login_snap_trade_user_with_http_info_impl(user_id, user_secret, extra)
     end

data/lib/snaptrade/api/transactions_and_reporting_api.rb

@@ -19,7 +19,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+    # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param start_date [Date] 
@@ -39,7 +39,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+    # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param start_date [Date] 
@@ -58,7 +58,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+    # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -74,7 +74,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+    # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -145,7 +145,7 @@ module SnapTrade
 
 
     # Get performance information for a specific timeframe
-    # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+    # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
     # @param start_date [Date] 
     # @param end_date [Date] 
     # @param user_id [String] 
@@ -163,7 +163,7 @@ module SnapTrade
     end
 
     # Get performance information for a specific timeframe
-    # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+    # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
     # @param start_date [Date] 
     # @param end_date [Date] 
     # @param user_id [String] 
@@ -180,7 +180,7 @@ module SnapTrade
     end
 
     # Get performance information for a specific timeframe
-    # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+    # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
     # @param start_date [Date] 
     # @param end_date [Date] 
     # @param user_id [String] 
@@ -196,7 +196,7 @@ module SnapTrade
     end
 
     # Get performance information for a specific timeframe
-    # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+    # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
     # @param start_date [Date] 
     # @param end_date [Date] 
     # @param user_id [String] 

data/lib/snaptrade/models/account.rb

@@ -34,6 +34,8 @@ module SnapTrade
 
     attr_accessor :sync_status
 
+    attr_accessor :balance
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,7 +48,8 @@ module SnapTrade
         :'created_date' => :'created_date',
         :'meta' => :'meta',
         :'cash_restrictions' => :'cash_restrictions',
-        :'sync_status' => :'sync_status'
+        :'sync_status' => :'sync_status',
+        :'balance' => :'balance'
       }
     end
 
@@ -67,7 +70,8 @@ module SnapTrade
         :'created_date' => :'String',
         :'meta' => :'Hash<String, Object>',
         :'cash_restrictions' => :'Array<CashRestriction>',
-        :'sync_status' => :'AccountSyncStatus'
+        :'sync_status' => :'AccountSyncStatus',
+        :'balance' => :'AccountBalance'
       }
     end
 
@@ -135,6 +139,10 @@ module SnapTrade
       if attributes.key?(:'sync_status')
         self.sync_status = attributes[:'sync_status']
       end
+
+      if attributes.key?(:'balance')
+        self.balance = attributes[:'balance']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -164,7 +172,8 @@ module SnapTrade
           created_date == o.created_date &&
           meta == o.meta &&
           cash_restrictions == o.cash_restrictions &&
-          sync_status == o.sync_status
+          sync_status == o.sync_status &&
+          balance == o.balance
     end
 
     # @see the `==` method
@@ -176,7 +185,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, brokerage_authorization, portfolio_group, name, number, institution_name, created_date, meta, cash_restrictions, sync_status].hash
+      [id, brokerage_authorization, portfolio_group, name, number, institution_name, created_date, meta, cash_restrictions, sync_status, balance].hash
     end
 
     # Builds the object from hash