snaptrade 1.17.10 → 2.0.77

data/lib/snaptrade/models/past_value.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -13,7 +12,7 @@ require 'time'
 
 module SnapTrade
   class PastValue
-    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
     attr_accessor :date
 
     attr_accessor :value

data/lib/snaptrade/models/performance_custom.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/position.rb

@@ -5,30 +5,31 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Account Position
+  # Describes a single stock/ETF/crypto/mutual fund position in an account.
   class Position
     attr_accessor :symbol
 
+    # The number of shares of the position. This can be fractional or integer units.
     attr_accessor :units
 
-    # Last known market price for the symbol
+    # Last known market price for the symbol. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
     attr_accessor :price
 
+    # The profit or loss on the position since it was opened. This is calculated as the difference between the current market value of the position and the total cost of the position. It is recommended to calculate this value using the average purchase price and the current market price yourself, instead of relying on this field.
     attr_accessor :open_pnl
 
-    # Deprecated, use the units field for both fractional and integer units going forward
-    attr_accessor :fractional_units
-
-    # Average purchase price for this position. Either returned by the underlying broker or calculated using historical transactions.
+    # Cost basis _per share_ of this position.
     attr_accessor :average_purchase_price
 
+    # Deprecated, use the `units` field for both fractional and integer units going forward
+    attr_accessor :fractional_units
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -36,8 +37,8 @@ module SnapTrade
         :'units' => :'units',
         :'price' => :'price',
         :'open_pnl' => :'open_pnl',
-        :'fractional_units' => :'fractional_units',
-        :'average_purchase_price' => :'average_purchase_price'
+        :'average_purchase_price' => :'average_purchase_price',
+        :'fractional_units' => :'fractional_units'
       }
     end
 
@@ -53,8 +54,8 @@ module SnapTrade
         :'units' => :'Float',
         :'price' => :'Float',
         :'open_pnl' => :'Float',
-        :'fractional_units' => :'Float',
-        :'average_purchase_price' => :'Float'
+        :'average_purchase_price' => :'Float',
+        :'fractional_units' => :'Float'
       }
     end
 
@@ -64,8 +65,8 @@ module SnapTrade
         :'units',
         :'price',
         :'open_pnl',
-        :'fractional_units',
-        :'average_purchase_price'
+        :'average_purchase_price',
+        :'fractional_units'
       ])
     end
 
@@ -100,13 +101,13 @@ module SnapTrade
         self.open_pnl = attributes[:'open_pnl']
       end
 
-      if attributes.key?(:'fractional_units')
-        self.fractional_units = attributes[:'fractional_units']
-      end
-
       if attributes.key?(:'average_purchase_price')
         self.average_purchase_price = attributes[:'average_purchase_price']
       end
+
+      if attributes.key?(:'fractional_units')
+        self.fractional_units = attributes[:'fractional_units']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -131,8 +132,8 @@ module SnapTrade
           units == o.units &&
           price == o.price &&
           open_pnl == o.open_pnl &&
-          fractional_units == o.fractional_units &&
-          average_purchase_price == o.average_purchase_price
+          average_purchase_price == o.average_purchase_price &&
+          fractional_units == o.fractional_units
     end
 
     # @see the `==` method
@@ -144,7 +145,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, units, price, open_pnl, fractional_units, average_purchase_price].hash
+      [symbol, units, price, open_pnl, average_purchase_price, fractional_units].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/position_symbol.rb

@@ -5,33 +5,37 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Symbol returned in position object
+  # Uniquely describes a security for the position within an account. The distinction between this and the `symbol` child property is that this object is specific to a position within an account, while the `symbol` child property is universal across all brokerage accounts. The caller should rely on the `symbol` child property for most use cases.
   class PositionSymbol
+    attr_accessor :symbol
+
+    # A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
     attr_accessor :id
 
+    # This field is deprecated and the caller should use the `symbol` child property's `description` instead.
     attr_accessor :description
 
-    attr_accessor :symbol
-
+    # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
     attr_accessor :local_id
 
+    # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
     attr_accessor :is_quotable
 
+    # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
     attr_accessor :is_tradable
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'symbol' => :'symbol',
         :'id' => :'id',
         :'description' => :'description',
-        :'symbol' => :'symbol',
         :'local_id' => :'local_id',
         :'is_quotable' => :'is_quotable',
         :'is_tradable' => :'is_tradable'
@@ -46,9 +50,9 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'symbol' => :'UniversalSymbol',
         :'id' => :'String',
         :'description' => :'String',
-        :'symbol' => :'UniversalSymbol',
         :'local_id' => :'String',
         :'is_quotable' => :'Boolean',
         :'is_tradable' => :'Boolean'
@@ -77,6 +81,10 @@ module SnapTrade
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'symbol')
+        self.symbol = attributes[:'symbol']
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -85,10 +93,6 @@ module SnapTrade
         self.description = attributes[:'description']
       end
 
-      if attributes.key?(:'symbol')
-        self.symbol = attributes[:'symbol']
-      end
-
       if attributes.key?(:'local_id')
         self.local_id = attributes[:'local_id']
       end
@@ -120,9 +124,9 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          symbol == o.symbol &&
           id == o.id &&
           description == o.description &&
-          symbol == o.symbol &&
           local_id == o.local_id &&
           is_quotable == o.is_quotable &&
           is_tradable == o.is_tradable
@@ -137,7 +141,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, description, symbol, local_id, is_quotable, is_tradable].hash
+      [symbol, id, description, local_id, is_quotable, is_tradable].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{portfolio_group_position.rb → rate_of_return_object.rb}

@@ -5,28 +5,29 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Details of a security held
-  class PortfolioGroupPosition
-    attr_accessor :symbol
+  # Individual rate of return object with return percent and timeframe
+  class RateOfReturnObject
+    # The timeframe this return percent is reflecting
+    attr_accessor :timeframe
 
-    # Last known market price for the symbol
-    attr_accessor :price
+    # The percent return of the portfolio, directly from the brokerage. 5.97 indicates a 5.97% return over the timeframe
+    attr_accessor :return_percent
 
-    attr_accessor :units
+    # The date this was fetched
+    attr_accessor :created_date
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'symbol' => :'symbol',
-        :'price' => :'price',
-        :'units' => :'units'
+        :'timeframe' => :'timeframe',
+        :'return_percent' => :'return_percent',
+        :'created_date' => :'created_date'
       }
     end
 
@@ -38,16 +39,15 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'symbol' => :'UniversalSymbol',
-        :'price' => :'Float',
-        :'units' => :'Integer'
+        :'timeframe' => :'Timeframe',
+        :'return_percent' => :'Float',
+        :'created_date' => :'Time'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'price',
       ])
     end
 
@@ -55,27 +55,27 @@ module SnapTrade
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::PortfolioGroupPosition` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::RateOfReturnObject` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::PortfolioGroupPosition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::RateOfReturnObject`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'symbol')
-        self.symbol = attributes[:'symbol']
+      if attributes.key?(:'timeframe')
+        self.timeframe = attributes[:'timeframe']
       end
 
-      if attributes.key?(:'price')
-        self.price = attributes[:'price']
+      if attributes.key?(:'return_percent')
+        self.return_percent = attributes[:'return_percent']
       end
 
-      if attributes.key?(:'units')
-        self.units = attributes[:'units']
+      if attributes.key?(:'created_date')
+        self.created_date = attributes[:'created_date']
       end
     end
 
@@ -97,9 +97,9 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          symbol == o.symbol &&
-          price == o.price &&
-          units == o.units
+          timeframe == o.timeframe &&
+          return_percent == o.return_percent &&
+          created_date == o.created_date
     end
 
     # @see the `==` method
@@ -111,7 +111,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, price, units].hash
+      [timeframe, return_percent, created_date].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{brokerage_authorization_type.rb → rate_of_return_response.rb}

@@ -5,20 +5,21 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class BrokerageAuthorizationType
-    attr_accessor :type
+  # List of return rates with their timeframe
+  class RateOfReturnResponse
+    # List of return percentages
+    attr_accessor :data
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'type' => :'type'
+        :'data' => :'data'
       }
     end
 
@@ -30,7 +31,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'type' => :'BrokerageAuthorizationTypeType'
+        :'data' => :'Array<RateOfReturnObject>'
       }
     end
 
@@ -44,19 +45,21 @@ module SnapTrade
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::BrokerageAuthorizationType` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::RateOfReturnResponse` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::BrokerageAuthorizationType`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::RateOfReturnResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
       end
     end
 
@@ -78,7 +81,7 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          type == o.type
+          data == o.data
     end
 
     # @see the `==` method
@@ -90,7 +93,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type].hash
+      [data].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{strategy_order_place.rb → recent_orders_response.rb}

@@ -5,23 +5,20 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # The reponse for a correctly placed order
-  class StrategyOrderPlace
-    attr_accessor :order_id
-
+  # List of orders executed within the last 24 hours
+  class RecentOrdersResponse
+    # List of orders executed in the last 24 hours
     attr_accessor :orders
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'order_id' => :'orderId',
         :'orders' => :'orders'
       }
     end
@@ -34,8 +31,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'order_id' => :'Integer',
-        :'orders' => :'Array<StrategyOrderPlaceOrdersInner>'
+        :'orders' => :'Array<AccountOrderRecord>'
       }
     end
 
@@ -49,21 +45,17 @@ module SnapTrade
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::StrategyOrderPlace` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::RecentOrdersResponse` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::StrategyOrderPlace`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::RecentOrdersResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'order_id')
-        self.order_id = attributes[:'order_id']
-      end
-
       if attributes.key?(:'orders')
         if (value = attributes[:'orders']).is_a?(Array)
           self.orders = value
@@ -89,7 +81,6 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          order_id == o.order_id &&
           orders == o.orders
     end
 
@@ -102,7 +93,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [order_id, orders].hash
+      [orders].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/security_type.rb

@@ -5,21 +5,24 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Security Type
+  # The type of security. For example, \"Common Stock\" or \"ETF\".
   class SecurityType
+    # Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
     attr_accessor :id
 
+    # A short code representing the security type. For example, \"cs\" for Common Stock. Here are some common values:   - `ad` - ADR   - `bnd` - Bond   - `cs` - Common Stock   - `cef` - Closed End Fund   - `crypto` - Cryptocurrency   - `et` - ETF   - `oef` - Open Ended Fund   - `ps` - Preferred Stock   - `rt` - Right   - `struct` - Structured Product   - `ut` - Unit   - `wi` - When Issued   - `wt` - Warrant 
     attr_accessor :code
 
+    # A human-readable description of the security type. For example, \"Common Stock\" or \"ETF\".
     attr_accessor :description
 
+    # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
     attr_accessor :is_supported
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/session_event.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -19,7 +18,7 @@ module SnapTrade
 
     attr_accessor :session_id
 
-    # SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
+    # SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     attr_accessor :user_id
 
     # Time

data/lib/snaptrade/models/session_event_type.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -13,16 +12,24 @@ require 'time'
 
 module SnapTrade
   class SessionEventType
-    CONNECTION_FAILED = "CONNECTION_FAILED".freeze
+    OAUTH_REDIRECT = "OAUTH_REDIRECT".freeze
     DISCLAIMER_ACCEPTED = "DISCLAIMER_ACCEPTED".freeze
     BROKERAGE_CONNECTION_INITIATED = "BROKERAGE_CONNECTION_INITIATED".freeze
+    BROKERAGE_RECONNECT_INITIATED = "BROKERAGE_RECONNECT_INITIATED".freeze
     BROKERAGE_AUTHENTICATION = "BROKERAGE_AUTHENTICATION".freeze
-    MFA_AUTHORIZATION = "MFA_AUTHORIZATION".freeze
+    OAUTH_BROKERAGE_AUTHENTICATION = "OAUTH_BROKERAGE_AUTHENTICATION".freeze
+    MFA_REQUESTED = "MFA_REQUESTED".freeze
+    MFA_SUBMITTED = "MFA_SUBMITTED".freeze
+    MFA_CHOICE_REQUESTED = "MFA_CHOICE_REQUESTED".freeze
+    MFA_CHOICE_SUBMITTED = "MFA_CHOICE_SUBMITTED".freeze
     CONNECTION_SUCCESSFUL = "CONNECTION_SUCCESSFUL".freeze
+    CONNECTION_FAILED = "CONNECTION_FAILED".freeze
     PARTNER_REDIRECT = "PARTNER_REDIRECT".freeze
+    CONNECTION_ABORTED = "CONNECTION_ABORTED".freeze
+    SESSION_STARTED = "SESSION_STARTED".freeze
 
     def self.all_vars
-      @all_vars ||= [CONNECTION_FAILED, DISCLAIMER_ACCEPTED, BROKERAGE_CONNECTION_INITIATED, BROKERAGE_AUTHENTICATION, MFA_AUTHORIZATION, CONNECTION_SUCCESSFUL, PARTNER_REDIRECT].freeze
+      @all_vars ||= [OAUTH_REDIRECT, DISCLAIMER_ACCEPTED, BROKERAGE_CONNECTION_INITIATED, BROKERAGE_RECONNECT_INITIATED, BROKERAGE_AUTHENTICATION, OAUTH_BROKERAGE_AUTHENTICATION, MFA_REQUESTED, MFA_SUBMITTED, MFA_CHOICE_REQUESTED, MFA_CHOICE_SUBMITTED, CONNECTION_SUCCESSFUL, CONNECTION_FAILED, PARTNER_REDIRECT, CONNECTION_ABORTED, SESSION_STARTED].freeze
     end
 
     # Builds the enum from string

data/lib/snaptrade/models/snap_trade_holdings_account.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/snap_trade_holdings_total_value.rb

@@ -5,17 +5,18 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Summed value of account positions and cash balances
+  # This field is deprecated. To get the brokerage reported total market value of the account, please refer to `account.balance.total`.  The total market value of the account. Note that this field is calculated based on the sum of the values of account positions and cash balances known to SnapTrade. It may not be accurate if the brokerage account has holdings that SnapTrade is not aware of. For example, if the brokerage account holds assets that SnapTrade does not support, the total value may be underreported. In certain cases, this value may also be double-counting cash-equivalent assets if those assets are represented as both cash and positions in the account. 
   class SnapTradeHoldingsTotalValue
+    # Total value denominated in the currency of the `currency` field.
     attr_accessor :value
 
+    # The ISO-4217 currency code for the amount.
     attr_accessor :currency
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/snap_trade_login_user_request_body.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -14,20 +13,22 @@ require 'time'
 module SnapTrade
   # Data to login a user via SnapTrade Partner
   class SnapTradeLoginUserRequestBody
-    # Slug of the brokerage to connect the user to
+    # Slug of the brokerage to connect the user to. See [the integrations page](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=3cfea70ef4254afc89704e47275a7a9a&pvs=4) for a list of supported brokerages and their slugs.
     attr_accessor :broker
 
-    # When set to True, user will be redirected back to the partner's site instead of the connection portal
+    # When set to `true`, user will be redirected back to the partner's site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](/docs/implement-connection-portal) for more information.
     attr_accessor :immediate_redirect
 
-    # URL to redirect the user to after the user connects their brokerage account
+    # URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](/docs/implement-connection-portal) for more information.
     attr_accessor :custom_redirect
 
-    # 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.
+    # The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](/docs/fix-broken-connections) for more information.
     attr_accessor :reconnect
 
+    # Sets whether the connection should be read-only or trade-enabled. Defaults to read-only if not specified.
     attr_accessor :connection_type
 
+    # Sets the connection portal version to render. Currently only v4 is supported and is the default. All other versions are deprecated and will automatically be set to v4.
     attr_accessor :connection_portal_version
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -98,10 +99,14 @@ module SnapTrade
 
       if attributes.key?(:'connection_type')
         self.connection_type = attributes[:'connection_type']
+      else
+        self.connection_type = 'read'
       end
 
       if attributes.key?(:'connection_portal_version')
         self.connection_portal_version = attributes[:'connection_portal_version']
+      else
+        self.connection_portal_version = 'v4'
       end
     end