snaptrade 2.0.37 → 2.0.39

data/lib/snaptrade/models/brokerage.rb

@@ -11,62 +11,69 @@ require 'date'
 require 'time'
 
 module SnapTrade
+  # Describes a brokerage that SnapTrade supports.
   class Brokerage
+    # Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade.
     attr_accessor :id
 
+    # A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
+    attr_accessor :slug
+
     # Full name of the brokerage.
     attr_accessor :name
 
     # A display-friendly name of the brokerage.
     attr_accessor :display_name
 
+    # A brief description of the brokerage.
     attr_accessor :description
 
+    # URL to the brokerage's logo.
     attr_accessor :aws_s3_logo_url
 
+    # URL to the brokerage's logo in square format.
     attr_accessor :aws_s3_square_logo_url
 
+    # This field is deprecated.
     attr_accessor :open_url
 
-    # A unique identifier for that brokerage. It is usually the name of the brokerage in capital letters and will never change.
-    attr_accessor :slug
-
+    # URL to the brokerage's website.
     attr_accessor :url
 
+    # Whether the brokerage is enabled in SnapTrade. A disabled brokerage will not be available for new connections.
     attr_accessor :enabled
 
+    # Whether the brokerage is currently in maintenance mode. A brokerage in maintenance mode will not be available for new connections.
     attr_accessor :maintenance_mode
 
+    # This field is deprecated. Please contact us if you have a valid use case for it.
     attr_accessor :allows_fractional_units
 
+    # Whether the brokerage allows trading through SnapTrade.
     attr_accessor :allows_trading
 
+    # This field is deprecated. Please contact us if you have a valid use case for it.
     attr_accessor :has_reporting
 
+    # This field is deprecated. Please contact us if you have a valid use case for it.
     attr_accessor :is_real_time_connection
 
-    attr_accessor :allows_trading_through_snaptrade_api
-
-    attr_accessor :is_scraping_integration
-
-    attr_accessor :default_currency
-
     attr_accessor :brokerage_type
 
-    # List of exchange ID supported by brokerage
+    # This field is deprecated. Please contact us if you have a valid use case for it.
     attr_accessor :exchanges
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
+        :'slug' => :'slug',
         :'name' => :'name',
         :'display_name' => :'display_name',
         :'description' => :'description',
         :'aws_s3_logo_url' => :'aws_s3_logo_url',
         :'aws_s3_square_logo_url' => :'aws_s3_square_logo_url',
         :'open_url' => :'open_url',
-        :'slug' => :'slug',
         :'url' => :'url',
         :'enabled' => :'enabled',
         :'maintenance_mode' => :'maintenance_mode',
@@ -74,9 +81,6 @@ module SnapTrade
         :'allows_trading' => :'allows_trading',
         :'has_reporting' => :'has_reporting',
         :'is_real_time_connection' => :'is_real_time_connection',
-        :'allows_trading_through_snaptrade_api' => :'allows_trading_through_snaptrade_api',
-        :'is_scraping_integration' => :'is_scraping_integration',
-        :'default_currency' => :'default_currency',
         :'brokerage_type' => :'brokerage_type',
         :'exchanges' => :'exchanges'
       }
@@ -91,13 +95,13 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
+        :'slug' => :'String',
         :'name' => :'String',
         :'display_name' => :'String',
         :'description' => :'String',
         :'aws_s3_logo_url' => :'String',
         :'aws_s3_square_logo_url' => :'String',
         :'open_url' => :'String',
-        :'slug' => :'String',
         :'url' => :'String',
         :'enabled' => :'Boolean',
         :'maintenance_mode' => :'Boolean',
@@ -105,9 +109,6 @@ module SnapTrade
         :'allows_trading' => :'Boolean',
         :'has_reporting' => :'Boolean',
         :'is_real_time_connection' => :'Boolean',
-        :'allows_trading_through_snaptrade_api' => :'Boolean',
-        :'is_scraping_integration' => :'Boolean',
-        :'default_currency' => :'String',
         :'brokerage_type' => :'BrokerageType',
         :'exchanges' => :'Array<Object>'
       }
@@ -121,7 +122,6 @@ module SnapTrade
         :'allows_fractional_units',
         :'allows_trading',
         :'has_reporting',
-        :'allows_trading_through_snaptrade_api',
       ])
     end
 
@@ -144,6 +144,10 @@ module SnapTrade
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'slug')
+        self.slug = attributes[:'slug']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -168,10 +172,6 @@ module SnapTrade
         self.open_url = attributes[:'open_url']
       end
 
-      if attributes.key?(:'slug')
-        self.slug = attributes[:'slug']
-      end
-
       if attributes.key?(:'url')
         self.url = attributes[:'url']
       end
@@ -200,18 +200,6 @@ module SnapTrade
         self.is_real_time_connection = attributes[:'is_real_time_connection']
       end
 
-      if attributes.key?(:'allows_trading_through_snaptrade_api')
-        self.allows_trading_through_snaptrade_api = attributes[:'allows_trading_through_snaptrade_api']
-      end
-
-      if attributes.key?(:'is_scraping_integration')
-        self.is_scraping_integration = attributes[:'is_scraping_integration']
-      end
-
-      if attributes.key?(:'default_currency')
-        self.default_currency = attributes[:'default_currency']
-      end
-
       if attributes.key?(:'brokerage_type')
         self.brokerage_type = attributes[:'brokerage_type']
       end
@@ -242,13 +230,13 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          slug == o.slug &&
           name == o.name &&
           display_name == o.display_name &&
           description == o.description &&
           aws_s3_logo_url == o.aws_s3_logo_url &&
           aws_s3_square_logo_url == o.aws_s3_square_logo_url &&
           open_url == o.open_url &&
-          slug == o.slug &&
           url == o.url &&
           enabled == o.enabled &&
           maintenance_mode == o.maintenance_mode &&
@@ -256,9 +244,6 @@ module SnapTrade
           allows_trading == o.allows_trading &&
           has_reporting == o.has_reporting &&
           is_real_time_connection == o.is_real_time_connection &&
-          allows_trading_through_snaptrade_api == o.allows_trading_through_snaptrade_api &&
-          is_scraping_integration == o.is_scraping_integration &&
-          default_currency == o.default_currency &&
           brokerage_type == o.brokerage_type &&
           exchanges == o.exchanges
     end
@@ -272,7 +257,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, display_name, description, aws_s3_logo_url, aws_s3_square_logo_url, open_url, slug, url, enabled, maintenance_mode, allows_fractional_units, allows_trading, has_reporting, is_real_time_connection, allows_trading_through_snaptrade_api, is_scraping_integration, default_currency, brokerage_type, exchanges].hash
+      [id, slug, name, display_name, description, aws_s3_logo_url, aws_s3_square_logo_url, open_url, url, enabled, maintenance_mode, allows_fractional_units, allows_trading, has_reporting, is_real_time_connection, brokerage_type, exchanges].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/brokerage_authorization.rb

@@ -11,28 +11,32 @@ require 'date'
 require 'time'
 
 module SnapTrade
+  # A single connection with a brokerage. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one. 
   class BrokerageAuthorization
+    # Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
     attr_accessor :id
 
-    # Time
+    # Timestamp of when the connection was established in SnapTrade.
     attr_accessor :created_date
 
-    # Time
+    # Timestamp of when the connection was last updated in SnapTrade. This field is deprecated. Please let us know if you have a valid use case for this field.
     attr_accessor :updated_date
 
     attr_accessor :brokerage
 
-    # Connection Name
+    # A short, human-readable name for the connection.
     attr_accessor :name
 
+    # Whether the connection is read-only or trade-enabled. A read-only connection can only be used to fetch data, while a trade-enabled connection can be used to place trades. Valid values are `read` and `trade`.
     attr_accessor :type
 
+    # Whether the connection is disabled. A disabled connection can no longer access the latest data from the brokerage, but will continue to return the last cached state. A connection can become disabled for many reasons and differs by brokerage. Here are some common scenarios:  - The user has changed their username or password at the brokerage. - The user has explicitly removed the access grant at the brokerage. - The session has expired at the brokerage and now requires explicit user re-authentication.  Please see [this guide](https://docs.snaptrade.com/docs/fix-broken-connections) on how to fix a disabled connection. 
     attr_accessor :disabled
 
-    # Disabled date
+    # Timestamp of when the connection was disabled in SnapTrade.
     attr_accessor :disabled_date
 
-    # Additional data about brokerage authorization
+    # Additional data about the connection. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version.
     attr_accessor :meta
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -59,13 +63,13 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
-        :'created_date' => :'String',
-        :'updated_date' => :'String',
+        :'created_date' => :'Time',
+        :'updated_date' => :'Time',
         :'brokerage' => :'Brokerage',
         :'name' => :'String',
         :'type' => :'String',
         :'disabled' => :'Boolean',
-        :'disabled_date' => :'String',
+        :'disabled_date' => :'Time',
         :'meta' => :'Hash<String, Object>'
       }
     end

data/lib/snaptrade/models/brokerage_authorization_disabled_confirmation.rb

@@ -11,6 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
+  # Confirmation that the connection has been disabled.
   class BrokerageAuthorizationDisabledConfirmation
     # Connection disabled confirmation
     attr_accessor :detail

data/lib/snaptrade/models/brokerage_authorization_refresh_confirmation.rb

@@ -11,6 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
+  # Confirmation that the syncs have been scheduled.
   class BrokerageAuthorizationRefreshConfirmation
     # Refresh confirmation details
     attr_accessor :detail

data/lib/snaptrade/models/brokerage_type.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Type of brokerage
+  # Type of brokerage. Currently supports traditional brokerages and crypto exchanges.
   class BrokerageType
     attr_accessor :id
 

data/lib/snaptrade/models/manual_trade.rb

@@ -11,21 +11,23 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # A manual trade object
+  # Contains the details of a submitted order.
   class ManualTrade
+    # Unique identifier for the submitted order through SnapTrade.
     attr_accessor :id
 
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
     attr_accessor :account
 
-    # Order Type
+    # The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required. 
     attr_accessor :order_type
 
-    # Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled   * GTD - Good Til Date 
+    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. 
     attr_accessor :time_in_force
 
     attr_accessor :symbol
 
-    # Trade Action
+    # The action describes the intent or side of a trade. This is either `BUY` or `SELL`
     attr_accessor :action
 
     attr_accessor :units
@@ -58,7 +60,7 @@ module SnapTrade
         :'id' => :'String',
         :'account' => :'String',
         :'order_type' => :'OrderTypeStrict',
-        :'time_in_force' => :'String',
+        :'time_in_force' => :'TimeInForceStrict',
         :'symbol' => :'ManualTradeSymbol',
         :'action' => :'ActionStrict',
         :'units' => :'Float',

data/lib/snaptrade/models/manual_trade_and_impact.rb

@@ -11,10 +11,10 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Manual Trade and Impact object
   class ManualTradeAndImpact
     attr_accessor :trade
 
+    # List of impacts of the trade on the account. The list always contains one value at the moment.
     attr_accessor :trade_impacts
 
     attr_accessor :combined_remaining_balance
@@ -37,7 +37,7 @@ module SnapTrade
     def self.openapi_types
       {
         :'trade' => :'ManualTrade',
-        :'trade_impacts' => :'Array<ManualTrade>',
+        :'trade_impacts' => :'Array<ManualTradeImpact>',
         :'combined_remaining_balance' => :'ManualTradeBalance'
       }
     end

data/lib/snaptrade/models/manual_trade_balance.rb

@@ -11,13 +11,13 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Balance
+  # Estimated remaining balance of the account after the trade is executed.
   class ManualTradeBalance
     attr_accessor :account
 
     attr_accessor :currency
 
-    # Cash
+    # Estimated amount of cash remaining in the account after the trade. At the moment this is the same as `remaining_cash` under `trade_impacts`.
     attr_accessor :cash
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -37,7 +37,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'account' => :'Account',
+        :'account' => :'AccountSimple',
         :'currency' => :'Currency',
         :'cash' => :'Float'
       }

data/lib/snaptrade/models/manual_trade_form.rb

@@ -11,29 +11,31 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Manual Trade Form
+  # Inputs for placing an order with the brokerage.
   class ManualTradeForm
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
     attr_accessor :account_id
 
-    # Trade Action
+    # The action describes the intent or side of a trade. This is either `BUY` or `SELL`
     attr_accessor :action
 
-    # Order Type
+    # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+    attr_accessor :universal_symbol_id
+
+    # The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required. 
     attr_accessor :order_type
 
-    # Trade Price if limit or stop limit order
+    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. 
+    attr_accessor :time_in_force
+
+    # The limit price for `Limit` and `StopLimit` orders.
     attr_accessor :price
 
-    # Stop Price. If stop loss or stop limit order, the price to trigger the stop
+    # The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
     attr_accessor :stop
 
-    # Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled 
-    attr_accessor :time_in_force
-
     attr_accessor :units
 
-    attr_accessor :universal_symbol_id
-
     attr_accessor :notional_value
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -41,12 +43,12 @@ module SnapTrade
       {
         :'account_id' => :'account_id',
         :'action' => :'action',
+        :'universal_symbol_id' => :'universal_symbol_id',
         :'order_type' => :'order_type',
+        :'time_in_force' => :'time_in_force',
         :'price' => :'price',
         :'stop' => :'stop',
-        :'time_in_force' => :'time_in_force',
         :'units' => :'units',
-        :'universal_symbol_id' => :'universal_symbol_id',
         :'notional_value' => :'notional_value'
       }
     end
@@ -61,12 +63,12 @@ module SnapTrade
       {
         :'account_id' => :'String',
         :'action' => :'ActionStrict',
+        :'universal_symbol_id' => :'String',
         :'order_type' => :'OrderTypeStrict',
+        :'time_in_force' => :'TimeInForceStrict',
         :'price' => :'Float',
         :'stop' => :'Float',
-        :'time_in_force' => :'TimeInForceStrict',
         :'units' => :'Float',
-        :'universal_symbol_id' => :'String',
         :'notional_value' => :'ManualTradeFormNotionalValue'
       }
     end
@@ -104,10 +106,18 @@ module SnapTrade
         self.action = attributes[:'action']
       end
 
+      if attributes.key?(:'universal_symbol_id')
+        self.universal_symbol_id = attributes[:'universal_symbol_id']
+      end
+
       if attributes.key?(:'order_type')
         self.order_type = attributes[:'order_type']
       end
 
+      if attributes.key?(:'time_in_force')
+        self.time_in_force = attributes[:'time_in_force']
+      end
+
       if attributes.key?(:'price')
         self.price = attributes[:'price']
       end
@@ -116,18 +126,10 @@ module SnapTrade
         self.stop = attributes[:'stop']
       end
 
-      if attributes.key?(:'time_in_force')
-        self.time_in_force = attributes[:'time_in_force']
-      end
-
       if attributes.key?(:'units')
         self.units = attributes[:'units']
       end
 
-      if attributes.key?(:'universal_symbol_id')
-        self.universal_symbol_id = attributes[:'universal_symbol_id']
-      end
-
       if attributes.key?(:'notional_value')
         self.notional_value = attributes[:'notional_value']
       end
@@ -137,12 +139,37 @@ module SnapTrade
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @action.nil?
+        invalid_properties.push('invalid value for "action", action cannot be nil.')
+      end
+
+      if @universal_symbol_id.nil?
+        invalid_properties.push('invalid value for "universal_symbol_id", universal_symbol_id cannot be nil.')
+      end
+
+      if @order_type.nil?
+        invalid_properties.push('invalid value for "order_type", order_type cannot be nil.')
+      end
+
+      if @time_in_force.nil?
+        invalid_properties.push('invalid value for "time_in_force", time_in_force cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @account_id.nil?
+      return false if @action.nil?
+      return false if @universal_symbol_id.nil?
+      return false if @order_type.nil?
+      return false if @time_in_force.nil?
       true
     end
 
@@ -153,12 +180,12 @@ module SnapTrade
       self.class == o.class &&
           account_id == o.account_id &&
           action == o.action &&
+          universal_symbol_id == o.universal_symbol_id &&
           order_type == o.order_type &&
+          time_in_force == o.time_in_force &&
           price == o.price &&
           stop == o.stop &&
-          time_in_force == o.time_in_force &&
           units == o.units &&
-          universal_symbol_id == o.universal_symbol_id &&
           notional_value == o.notional_value
     end
 
@@ -171,7 +198,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, action, order_type, price, stop, time_in_force, units, universal_symbol_id, notional_value].hash
+      [account_id, action, universal_symbol_id, order_type, time_in_force, price, stop, units, notional_value].hash
     end
 
     # Builds the object from hash