snaptrade 2.0.30 → 2.0.32

data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb

@@ -11,27 +11,35 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Holdings with account ID
+  # A single brokerage account at a financial institution.
   class SnapTradeHoldingsAccountAccountId
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
     attr_accessor :id
 
+    # Unique identifier for the connection (brokerage authorization). This is the UUID used to reference the connection in SnapTrade.
     attr_accessor :brokerage_authorization
 
+    # Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it.
     attr_accessor :portfolio_group
 
+    # A display name for the account. Either assigned by the user or by the financial institution itself. For certain institutions, SnapTrade appends the institution name to the account name for clarity.
     attr_accessor :name
 
+    # The account number assigned by the financial institution.
     attr_accessor :number
 
+    # The name of the financial institution that holds the account.
     attr_accessor :institution_name
 
     attr_accessor :balance
 
+    # Additional information about the account, such as account type, status, etc. This information is specific to the financial institution and there's no standard format for this data. Please use at your own risk.
     attr_accessor :meta
 
+    # This field is deprecated.
     attr_accessor :cash_restrictions
 
-    # Time
+    # Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the financial institution.
     attr_accessor :created_date
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -67,7 +75,7 @@ module SnapTrade
         :'balance' => :'SnapTradeHoldingsAccountAccountIdBalance',
         :'meta' => :'Hash<String, Object>',
         :'cash_restrictions' => :'Array<CashRestriction>',
-        :'created_date' => :'String'
+        :'created_date' => :'Time'
       }
     end
 

data/lib/snaptrade/models/snap_trade_holdings_total_value.rb

@@ -11,10 +11,12 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Calculated based on the sum of the values of account positions and cash balances
+  # 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. To get the brokerage reported total market value of the account, refer to `account.balance.total`.
   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/symbol_figi_instrument.rb

@@ -12,8 +12,10 @@ require 'time'
 
 module SnapTrade
   class SymbolFigiInstrument
+    # This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
     attr_accessor :figi_code
 
+    # This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
     attr_accessor :figi_share_class
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/underlying_symbol.rb

@@ -11,12 +11,18 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Underlying Symbol
+  # Symbol object for the underlying security of an option.
   class UnderlyingSymbol
+    # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
     attr_accessor :id
 
+    # The security's trading ticker symbol. For example \"AAPL\" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
     attr_accessor :symbol
 
+    # The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
+    attr_accessor :raw_symbol
+
+    # A human-readable description of the security. This is usually the company name or ETF name.
     attr_accessor :description
 
     attr_accessor :currency
@@ -25,8 +31,10 @@ module SnapTrade
 
     attr_accessor :type
 
+    # 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 :currencies
 
+    # This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. This value should be the same as the `figi_code` in the `figi_instrument` child property.
     attr_accessor :figi_code
 
     attr_accessor :figi_instrument
@@ -36,6 +44,7 @@ module SnapTrade
       {
         :'id' => :'id',
         :'symbol' => :'symbol',
+        :'raw_symbol' => :'raw_symbol',
         :'description' => :'description',
         :'currency' => :'currency',
         :'exchange' => :'exchange',
@@ -56,10 +65,11 @@ module SnapTrade
       {
         :'id' => :'String',
         :'symbol' => :'String',
+        :'raw_symbol' => :'String',
         :'description' => :'String',
-        :'currency' => :'Currency',
-        :'exchange' => :'USExchange',
-        :'type' => :'SecurityType',
+        :'currency' => :'UniversalSymbolCurrency',
+        :'exchange' => :'UnderlyingSymbolExchange',
+        :'type' => :'UnderlyingSymbolType',
         :'currencies' => :'Array<Currency>',
         :'figi_code' => :'String',
         :'figi_instrument' => :'SymbolFigiInstrument'
@@ -98,6 +108,10 @@ module SnapTrade
         self.symbol = attributes[:'symbol']
       end
 
+      if attributes.key?(:'raw_symbol')
+        self.raw_symbol = attributes[:'raw_symbol']
+      end
+
       if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
@@ -149,6 +163,7 @@ module SnapTrade
       self.class == o.class &&
           id == o.id &&
           symbol == o.symbol &&
+          raw_symbol == o.raw_symbol &&
           description == o.description &&
           currency == o.currency &&
           exchange == o.exchange &&
@@ -167,7 +182,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, symbol, description, currency, exchange, type, currencies, figi_code, figi_instrument].hash
+      [id, symbol, raw_symbol, description, currency, exchange, type, currencies, figi_code, figi_instrument].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{model_portfolio.rb → underlying_symbol_exchange.rb}

@@ -11,19 +11,38 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  class ModelPortfolio
+  # The exchange on which the security is listed and traded.
+  class UnderlyingSymbolExchange
     attr_accessor :id
 
+    attr_accessor :code
+
+    attr_accessor :mic_code
+
     attr_accessor :name
 
-    attr_accessor :model_type
+    attr_accessor :timezone
+
+    attr_accessor :start_time
+
+    attr_accessor :close_time
+
+    attr_accessor :suffix
+
+    attr_accessor :allows_cryptocurrency_symbols
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
+        :'code' => :'code',
+        :'mic_code' => :'mic_code',
         :'name' => :'name',
-        :'model_type' => :'model_type'
+        :'timezone' => :'timezone',
+        :'start_time' => :'start_time',
+        :'close_time' => :'close_time',
+        :'suffix' => :'suffix',
+        :'allows_cryptocurrency_symbols' => :'allows_cryptocurrency_symbols'
       }
     end
 
@@ -36,28 +55,42 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
+        :'code' => :'String',
+        :'mic_code' => :'String',
         :'name' => :'String',
-        :'model_type' => :'ModelType'
+        :'timezone' => :'String',
+        :'start_time' => :'String',
+        :'close_time' => :'String',
+        :'suffix' => :'String',
+        :'allows_cryptocurrency_symbols' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'suffix',
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'USExchange'
+      ]
+    end
+
     # Initializes the object
     # @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::ModelPortfolio` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::UnderlyingSymbolExchange` 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::ModelPortfolio`. 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::UnderlyingSymbolExchange`. 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
       }
@@ -66,14 +99,36 @@ module SnapTrade
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'mic_code')
+        self.mic_code = attributes[:'mic_code']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
 
-      if attributes.key?(:'model_type')
-        self.model_type = attributes[:'model_type']
-      else
-        self.model_type = ModelType::NMINUS_1
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      end
+
+      if attributes.key?(:'start_time')
+        self.start_time = attributes[:'start_time']
+      end
+
+      if attributes.key?(:'close_time')
+        self.close_time = attributes[:'close_time']
+      end
+
+      if attributes.key?(:'suffix')
+        self.suffix = attributes[:'suffix']
+      end
+
+      if attributes.key?(:'allows_cryptocurrency_symbols')
+        self.allows_cryptocurrency_symbols = attributes[:'allows_cryptocurrency_symbols']
       end
     end
 
@@ -96,8 +151,14 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          code == o.code &&
+          mic_code == o.mic_code &&
           name == o.name &&
-          model_type == o.model_type
+          timezone == o.timezone &&
+          start_time == o.start_time &&
+          close_time == o.close_time &&
+          suffix == o.suffix &&
+          allows_cryptocurrency_symbols == o.allows_cryptocurrency_symbols
     end
 
     # @see the `==` method
@@ -109,7 +170,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, model_type].hash
+      [id, code, mic_code, name, timezone, start_time, close_time, suffix, allows_cryptocurrency_symbols].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{brokerage_symbol.rb → underlying_symbol_type.rb}

@@ -11,29 +11,27 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Brokerage symbol
-  class BrokerageSymbol
+  # The type of security. For example, \"Common Stock\" or \"ETF\".
+  class UnderlyingSymbolType
+    # 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
 
-    attr_accessor :symbol
-
-    attr_accessor :brokerage_authorization
+    # 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   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
 
-    attr_accessor :allows_fractional_units
-
-    attr_accessor :option_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 :is_supported
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'symbol' => :'symbol',
-        :'brokerage_authorization' => :'brokerage_authorization',
+        :'code' => :'code',
         :'description' => :'description',
-        :'allows_fractional_units' => :'allows_fractional_units',
-        :'option_symbol' => :'option_symbol'
+        :'is_supported' => :'is_supported'
       }
     end
 
@@ -46,34 +44,36 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
-        :'symbol' => :'BrokerageSymbolSymbol',
-        :'brokerage_authorization' => :'BrokerageAuthorization',
+        :'code' => :'String',
         :'description' => :'String',
-        :'allows_fractional_units' => :'Boolean',
-        :'option_symbol' => :'BrokerageSymbolOptionSymbol'
+        :'is_supported' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'symbol',
-        :'allows_fractional_units',
-        :'option_symbol'
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'SecurityType'
+      ]
+    end
+
     # Initializes the object
     # @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::BrokerageSymbol` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::UnderlyingSymbolType` 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::BrokerageSymbol`. 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::UnderlyingSymbolType`. 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
       }
@@ -82,24 +82,16 @@ module SnapTrade
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'symbol')
-        self.symbol = attributes[:'symbol']
-      end
-
-      if attributes.key?(:'brokerage_authorization')
-        self.brokerage_authorization = attributes[:'brokerage_authorization']
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
       end
 
       if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
 
-      if attributes.key?(:'allows_fractional_units')
-        self.allows_fractional_units = attributes[:'allows_fractional_units']
-      end
-
-      if attributes.key?(:'option_symbol')
-        self.option_symbol = attributes[:'option_symbol']
+      if attributes.key?(:'is_supported')
+        self.is_supported = attributes[:'is_supported']
       end
     end
 
@@ -122,11 +114,9 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          symbol == o.symbol &&
-          brokerage_authorization == o.brokerage_authorization &&
+          code == o.code &&
           description == o.description &&
-          allows_fractional_units == o.allows_fractional_units &&
-          option_symbol == o.option_symbol
+          is_supported == o.is_supported
     end
 
     # @see the `==` method
@@ -138,7 +128,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, symbol, brokerage_authorization, description, allows_fractional_units, option_symbol].hash
+      [id, code, description, is_supported].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/universal_symbol.rb

@@ -11,14 +11,18 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Universal symbol
+  # Uniquely describes a single security + exchange combination across all brokerages.
   class UniversalSymbol
+    # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
     attr_accessor :id
 
+    # The security's trading ticker symbol. For example \"AAPL\" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
     attr_accessor :symbol
 
+    # The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
     attr_accessor :raw_symbol
 
+    # A human-readable description of the security. This is usually the company name or ETF name.
     attr_accessor :description
 
     attr_accessor :currency
@@ -27,8 +31,10 @@ module SnapTrade
 
     attr_accessor :type
 
+    # 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 :currencies
 
+    # This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. This value should be the same as the `figi_code` in the `figi_instrument` child property.
     attr_accessor :figi_code
 
     attr_accessor :figi_instrument
@@ -61,8 +67,8 @@ module SnapTrade
         :'symbol' => :'String',
         :'raw_symbol' => :'String',
         :'description' => :'String',
-        :'currency' => :'Currency',
-        :'exchange' => :'Exchange',
+        :'currency' => :'UniversalSymbolCurrency',
+        :'exchange' => :'UniversalSymbolExchange',
         :'type' => :'SecurityType',
         :'currencies' => :'Array<Currency>',
         :'figi_code' => :'String',

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

@@ -11,15 +11,22 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  class ModelAssetClass
+  # The currency in which the security is traded.
+  class UniversalSymbolCurrency
+    # 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.
     def self.attribute_map
       {
         :'id' => :'id',
+        :'code' => :'code',
         :'name' => :'name'
       }
     end
@@ -33,6 +40,7 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
+        :'code' => :'String',
         :'name' => :'String'
       }
     end
@@ -43,17 +51,24 @@ module SnapTrade
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'Currency'
+      ]
+    end
+
     # Initializes the object
     # @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::UniversalSymbolCurrency` 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::UniversalSymbolCurrency`. 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
       }
@@ -62,6 +77,10 @@ module SnapTrade
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -86,6 +105,7 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          code == o.code &&
           name == o.name
     end
 
@@ -98,7 +118,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name].hash
+      [id, code, name].hash
     end
 
     # Builds the object from hash