snaptrade 1.17.10 → 2.0.77

data/lib/snaptrade/models/brokerage.rb

@@ -5,72 +5,84 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 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
 
-    attr_accessor :slug
+    # URL to the brokerage's logo in square format.
+    attr_accessor :aws_s3_square_logo_url
 
+    # 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
 
-    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 :allows_fractional_units
+
+    # 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
 
+    # This field is deprecated.
+    attr_accessor :open_url
+
     # 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',
-        :'slug' => :'slug',
+        :'aws_s3_square_logo_url' => :'aws_s3_square_logo_url',
         :'url' => :'url',
         :'enabled' => :'enabled',
         :'maintenance_mode' => :'maintenance_mode',
-        :'allows_fractional_units' => :'allows_fractional_units',
         :'allows_trading' => :'allows_trading',
+        :'allows_fractional_units' => :'allows_fractional_units',
         :'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'
+        :'exchanges' => :'exchanges',
+        :'open_url' => :'open_url'
       }
     end
 
@@ -83,33 +95,33 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
+        :'slug' => :'String',
         :'name' => :'String',
         :'display_name' => :'String',
         :'description' => :'String',
         :'aws_s3_logo_url' => :'String',
-        :'slug' => :'String',
+        :'aws_s3_square_logo_url' => :'String',
         :'url' => :'String',
         :'enabled' => :'Boolean',
         :'maintenance_mode' => :'Boolean',
-        :'allows_fractional_units' => :'Boolean',
         :'allows_trading' => :'Boolean',
+        :'allows_fractional_units' => :'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>'
+        :'exchanges' => :'Array<Object>',
+        :'open_url' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'allows_fractional_units',
+        :'aws_s3_square_logo_url',
         :'allows_trading',
+        :'allows_fractional_units',
         :'has_reporting',
-        :'allows_trading_through_snaptrade_api',
+        :'open_url'
       ])
     end
 
@@ -132,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
@@ -148,8 +164,8 @@ module SnapTrade
         self.aws_s3_logo_url = attributes[:'aws_s3_logo_url']
       end
 
-      if attributes.key?(:'slug')
-        self.slug = attributes[:'slug']
+      if attributes.key?(:'aws_s3_square_logo_url')
+        self.aws_s3_square_logo_url = attributes[:'aws_s3_square_logo_url']
       end
 
       if attributes.key?(:'url')
@@ -164,14 +180,14 @@ module SnapTrade
         self.maintenance_mode = attributes[:'maintenance_mode']
       end
 
-      if attributes.key?(:'allows_fractional_units')
-        self.allows_fractional_units = attributes[:'allows_fractional_units']
-      end
-
       if attributes.key?(:'allows_trading')
         self.allows_trading = attributes[:'allows_trading']
       end
 
+      if attributes.key?(:'allows_fractional_units')
+        self.allows_fractional_units = attributes[:'allows_fractional_units']
+      end
+
       if attributes.key?(:'has_reporting')
         self.has_reporting = attributes[:'has_reporting']
       end
@@ -180,18 +196,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
@@ -201,6 +205,10 @@ module SnapTrade
           self.exchanges = value
         end
       end
+
+      if attributes.key?(:'open_url')
+        self.open_url = attributes[:'open_url']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -222,23 +230,22 @@ 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 &&
-          slug == o.slug &&
+          aws_s3_square_logo_url == o.aws_s3_square_logo_url &&
           url == o.url &&
           enabled == o.enabled &&
           maintenance_mode == o.maintenance_mode &&
-          allows_fractional_units == o.allows_fractional_units &&
           allows_trading == o.allows_trading &&
+          allows_fractional_units == o.allows_fractional_units &&
           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
+          exchanges == o.exchanges &&
+          open_url == o.open_url
     end
 
     # @see the `==` method
@@ -250,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, 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, url, enabled, maintenance_mode, allows_trading, allows_fractional_units, has_reporting, is_real_time_connection, brokerage_type, exchanges, open_url].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/brokerage_authorization.rb

@@ -5,49 +5,52 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 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
-    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](/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
 
+    # 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
         :'created_date' => :'created_date',
-        :'updated_date' => :'updated_date',
         :'brokerage' => :'brokerage',
         :'name' => :'name',
         :'type' => :'type',
         :'disabled' => :'disabled',
         :'disabled_date' => :'disabled_date',
-        :'meta' => :'meta'
+        :'meta' => :'meta',
+        :'updated_date' => :'updated_date'
       }
     end
 
@@ -60,14 +63,14 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
-        :'created_date' => :'String',
-        :'updated_date' => :'String',
+        :'created_date' => :'Time',
         :'brokerage' => :'Brokerage',
         :'name' => :'String',
         :'type' => :'String',
         :'disabled' => :'Boolean',
-        :'disabled_date' => :'String',
-        :'meta' => :'Hash<String, Object>'
+        :'disabled_date' => :'Time',
+        :'meta' => :'Hash<String, Object>',
+        :'updated_date' => :'Time'
       }
     end
 
@@ -101,10 +104,6 @@ module SnapTrade
         self.created_date = attributes[:'created_date']
       end
 
-      if attributes.key?(:'updated_date')
-        self.updated_date = attributes[:'updated_date']
-      end
-
       if attributes.key?(:'brokerage')
         self.brokerage = attributes[:'brokerage']
       end
@@ -130,6 +129,10 @@ module SnapTrade
           self.meta = value
         end
       end
+
+      if attributes.key?(:'updated_date')
+        self.updated_date = attributes[:'updated_date']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -152,13 +155,13 @@ module SnapTrade
       self.class == o.class &&
           id == o.id &&
           created_date == o.created_date &&
-          updated_date == o.updated_date &&
           brokerage == o.brokerage &&
           name == o.name &&
           type == o.type &&
           disabled == o.disabled &&
           disabled_date == o.disabled_date &&
-          meta == o.meta
+          meta == o.meta &&
+          updated_date == o.updated_date
     end
 
     # @see the `==` method
@@ -170,7 +173,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created_date, updated_date, brokerage, name, type, disabled, disabled_date, meta].hash
+      [id, created_date, brokerage, name, type, disabled, disabled_date, meta, updated_date].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{model_asset_class.rb → brokerage_authorization_disabled_confirmation.rb}

@@ -5,23 +5,21 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class ModelAssetClass
-    attr_accessor :id
-
-    attr_accessor :name
+  # Confirmation that the connection has been disabled.
+  class BrokerageAuthorizationDisabledConfirmation
+    # Connection disabled confirmation
+    attr_accessor :detail
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'name' => :'name'
+        :'detail' => :'detail'
       }
     end
 
@@ -33,8 +31,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'name' => :'String'
+        :'detail' => :'String'
       }
     end
 
@@ -48,23 +45,19 @@ 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::ModelAssetClass` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::BrokerageAuthorizationDisabledConfirmation` 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::ModelAssetClass`. 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::BrokerageAuthorizationDisabledConfirmation`. 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?(:'id')
-        self.id = attributes[:'id']
-      end
-
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'detail')
+        self.detail = attributes[:'detail']
       end
     end
 
@@ -86,8 +79,7 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          name == o.name
+          detail == o.detail
     end
 
     # @see the `==` method
@@ -99,7 +91,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name].hash
+      [detail].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{jwt.rb → brokerage_authorization_refresh_confirmation.rb}

@@ -5,21 +5,21 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # JWT Token. Used to acess resources in private endpoints available only through the Passiv app
-  class JWT
-    attr_accessor :token
+  # Confirmation that the syncs have been scheduled.
+  class BrokerageAuthorizationRefreshConfirmation
+    # Refresh confirmation details
+    attr_accessor :detail
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'token' => :'token'
+        :'detail' => :'detail'
       }
     end
 
@@ -31,7 +31,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'token' => :'String'
+        :'detail' => :'String'
       }
     end
 
@@ -45,19 +45,19 @@ 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::JWT` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::BrokerageAuthorizationRefreshConfirmation` 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::JWT`. 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::BrokerageAuthorizationRefreshConfirmation`. 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?(:'token')
-        self.token = attributes[:'token']
+      if attributes.key?(:'detail')
+        self.detail = attributes[:'detail']
       end
     end
 
@@ -79,7 +79,7 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          token == o.token
+          detail == o.detail
     end
 
     # @see the `==` method
@@ -91,7 +91,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [token].hash
+      [detail].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -40,7 +39,7 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
-        :'type' => :'BrokerageAuthorizationTypeReadOnlyType',
+        :'type' => :'Type',
         :'auth_type' => :'AuthType',
         :'brokerage' => :'BrokerageAuthorizationTypeReadOnlyBrokerage'
       }

data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -15,10 +14,10 @@ module SnapTrade
   class BrokerageAuthorizationTypeReadOnlyBrokerage
     attr_accessor :id
 
-    # Name of Brokerage
+    # Full name of the brokerage.
     attr_accessor :name
 
-    # Slug of Brokerage. It is usually the name of the brokerage in capital letters
+    # A unique identifier for that brokerage. It is usually the name of the brokerage in capital letters and will never change.
     attr_accessor :slug
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/brokerage_type.rb

@@ -5,14 +5,13 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 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/connection_portal_version.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -13,11 +12,12 @@ require 'time'
 
 module SnapTrade
   class ConnectionPortalVersion
-    V2 = "v2".freeze
+    V4 = "v4".freeze
     V3 = "v3".freeze
+    V2 = "v2".freeze
 
     def self.all_vars
-      @all_vars ||= [V2, V3].freeze
+      @all_vars ||= [V4, V3, V2].freeze
     end
 
     # Builds the enum from string

data/lib/snaptrade/models/connection_type.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/connections_session_events200_response_inner.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/currency.rb

@@ -5,19 +5,21 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Currency
+  # Describes a currency object.
   class Currency
+    # Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
     attr_accessor :id
 
+    # The ISO-4217 currency code for the currency.
     attr_accessor :code
 
+    # A human-friendly name of the currency.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.