snaptrade 1.17.10 → 2.0.77

data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -13,6 +12,7 @@ require 'time'
 
 module SnapTrade
   class TradingCancelUserAccountOrderRequest
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
     attr_accessor :brokerage_order_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/transactions_status.rb

@@ -5,25 +5,29 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Status of account transaction sync
+  # Status of account transaction sync. SnapTrade syncs transactions from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all transactions from the brokerage account as far back as the brokerage allows. Check [our integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=6fab8012ade6441fa0c6d9af9c55ce3a) for details on how far back we sync for each brokerage. 2. Daily sync - Once a day SnapTrade syncs new transactions from the brokerage. 3. Manual sync - You can retrigger an incremental sync of transactions with the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. 
   class TransactionsStatus
+    # Indicates if the initial sync of transactions has been completed. For accounts with a large number of transactions, the initial sync may take a while to complete.
     attr_accessor :initial_sync_completed
 
-    # Date in YYYY-MM-DD format or null
+    # All transactions up to this date have been successfully synced. Please note that this is not the date of the last transaction, nor the last time SnapTrade attempted to sync transactions.
     attr_accessor :last_successful_sync
 
+    # The date of the first transaction in the account known to SnapTrade. It's possible that the account has transactions before this date, but they are not known to SnapTrade.
+    attr_accessor :first_transaction_date
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'initial_sync_completed' => :'initial_sync_completed',
-        :'last_successful_sync' => :'last_successful_sync'
+        :'last_successful_sync' => :'last_successful_sync',
+        :'first_transaction_date' => :'first_transaction_date'
       }
     end
 
@@ -36,14 +40,16 @@ module SnapTrade
     def self.openapi_types
       {
         :'initial_sync_completed' => :'Boolean',
-        :'last_successful_sync' => :'Date'
+        :'last_successful_sync' => :'Date',
+        :'first_transaction_date' => :'Date'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'last_successful_sync'
+        :'last_successful_sync',
+        :'first_transaction_date'
       ])
     end
 
@@ -69,6 +75,10 @@ module SnapTrade
       if attributes.key?(:'last_successful_sync')
         self.last_successful_sync = attributes[:'last_successful_sync']
       end
+
+      if attributes.key?(:'first_transaction_date')
+        self.first_transaction_date = attributes[:'first_transaction_date']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -90,7 +100,8 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           initial_sync_completed == o.initial_sync_completed &&
-          last_successful_sync == o.last_successful_sync
+          last_successful_sync == o.last_successful_sync &&
+          first_transaction_date == o.first_transaction_date
     end
 
     # @see the `==` method
@@ -102,7 +113,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [initial_sync_completed, last_successful_sync].hash
+      [initial_sync_completed, last_successful_sync, first_transaction_date].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/type.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -13,11 +12,11 @@ require 'time'
 
 module SnapTrade
   class Type
-    ALLOCATE_MAX = "ALLOCATE_MAX".freeze
-    RETAIN_MIN = "RETAIN_MIN".freeze
+    READ = "read".freeze
+    TRADE = "trade".freeze
 
     def self.all_vars
-      @all_vars ||= [ALLOCATE_MAX, RETAIN_MIN].freeze
+      @all_vars ||= [READ, TRADE].freeze
     end
 
     # Builds the enum from string

data/lib/snaptrade/models/underlying_symbol.rb

@@ -5,19 +5,24 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 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
@@ -26,6 +31,12 @@ module SnapTrade
 
     attr_accessor :type
 
+    # 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
+
+    # 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
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -33,10 +44,13 @@ module SnapTrade
       {
         :'id' => :'id',
         :'symbol' => :'symbol',
+        :'raw_symbol' => :'raw_symbol',
         :'description' => :'description',
         :'currency' => :'currency',
         :'exchange' => :'exchange',
         :'type' => :'type',
+        :'figi_code' => :'figi_code',
+        :'figi_instrument' => :'figi_instrument',
         :'currencies' => :'currencies'
       }
     end
@@ -51,10 +65,13 @@ module SnapTrade
       {
         :'id' => :'String',
         :'symbol' => :'String',
+        :'raw_symbol' => :'String',
         :'description' => :'String',
-        :'currency' => :'Currency',
-        :'exchange' => :'USExchange',
-        :'type' => :'SecurityType',
+        :'currency' => :'SymbolCurrency',
+        :'exchange' => :'UnderlyingSymbolExchange',
+        :'type' => :'UnderlyingSymbolType',
+        :'figi_code' => :'String',
+        :'figi_instrument' => :'SymbolFigiInstrument',
         :'currencies' => :'Array<Currency>'
       }
     end
@@ -63,6 +80,8 @@ module SnapTrade
     def self.openapi_nullable
       Set.new([
         :'description',
+        :'figi_code',
+        :'figi_instrument',
       ])
     end
 
@@ -89,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
@@ -105,6 +128,14 @@ module SnapTrade
         self.type = attributes[:'type']
       end
 
+      if attributes.key?(:'figi_code')
+        self.figi_code = attributes[:'figi_code']
+      end
+
+      if attributes.key?(:'figi_instrument')
+        self.figi_instrument = attributes[:'figi_instrument']
+      end
+
       if attributes.key?(:'currencies')
         if (value = attributes[:'currencies']).is_a?(Array)
           self.currencies = value
@@ -132,10 +163,13 @@ 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 &&
           type == o.type &&
+          figi_code == o.figi_code &&
+          figi_instrument == o.figi_instrument &&
           currencies == o.currencies
     end
 
@@ -148,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].hash
+      [id, symbol, raw_symbol, description, currency, exchange, type, figi_code, figi_instrument, currencies].hash
     end
 
     # Builds the object from hash

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

@@ -5,46 +5,44 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Holdings with account ID
-  class SnapTradeHoldingsAccountAccountId
+  # The exchange on which the security is listed and traded.
+  class UnderlyingSymbolExchange
     attr_accessor :id
 
-    attr_accessor :brokerage_authorization
+    attr_accessor :code
 
-    attr_accessor :portfolio_group
+    attr_accessor :mic_code
 
     attr_accessor :name
 
-    attr_accessor :number
+    attr_accessor :timezone
 
-    attr_accessor :institution_name
+    attr_accessor :start_time
 
-    attr_accessor :meta
+    attr_accessor :close_time
 
-    attr_accessor :cash_restrictions
+    attr_accessor :suffix
 
-    # Time
-    attr_accessor :created_date
+    attr_accessor :allows_cryptocurrency_symbols
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'brokerage_authorization' => :'brokerage_authorization',
-        :'portfolio_group' => :'portfolio_group',
+        :'code' => :'code',
+        :'mic_code' => :'mic_code',
         :'name' => :'name',
-        :'number' => :'number',
-        :'institution_name' => :'institution_name',
-        :'meta' => :'meta',
-        :'cash_restrictions' => :'cash_restrictions',
-        :'created_date' => :'created_date'
+        :'timezone' => :'timezone',
+        :'start_time' => :'start_time',
+        :'close_time' => :'close_time',
+        :'suffix' => :'suffix',
+        :'allows_cryptocurrency_symbols' => :'allows_cryptocurrency_symbols'
       }
     end
 
@@ -57,35 +55,42 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
-        :'brokerage_authorization' => :'String',
-        :'portfolio_group' => :'String',
+        :'code' => :'String',
+        :'mic_code' => :'String',
         :'name' => :'String',
-        :'number' => :'String',
-        :'institution_name' => :'String',
-        :'meta' => :'Hash<String, Object>',
-        :'cash_restrictions' => :'Array<CashRestriction>',
-        :'created_date' => :'String'
+        :'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([
-        :'name',
+        :'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::SnapTradeHoldingsAccountAccountId` 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::SnapTradeHoldingsAccountAccountId`. 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
       }
@@ -94,40 +99,36 @@ module SnapTrade
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'brokerage_authorization')
-        self.brokerage_authorization = attributes[:'brokerage_authorization']
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
       end
 
-      if attributes.key?(:'portfolio_group')
-        self.portfolio_group = attributes[:'portfolio_group']
+      if attributes.key?(:'mic_code')
+        self.mic_code = attributes[:'mic_code']
       end
 
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
 
-      if attributes.key?(:'number')
-        self.number = attributes[:'number']
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
       end
 
-      if attributes.key?(:'institution_name')
-        self.institution_name = attributes[:'institution_name']
+      if attributes.key?(:'start_time')
+        self.start_time = attributes[:'start_time']
       end
 
-      if attributes.key?(:'meta')
-        if (value = attributes[:'meta']).is_a?(Hash)
-          self.meta = value
-        end
+      if attributes.key?(:'close_time')
+        self.close_time = attributes[:'close_time']
       end
 
-      if attributes.key?(:'cash_restrictions')
-        if (value = attributes[:'cash_restrictions']).is_a?(Array)
-          self.cash_restrictions = value
-        end
+      if attributes.key?(:'suffix')
+        self.suffix = attributes[:'suffix']
       end
 
-      if attributes.key?(:'created_date')
-        self.created_date = attributes[:'created_date']
+      if attributes.key?(:'allows_cryptocurrency_symbols')
+        self.allows_cryptocurrency_symbols = attributes[:'allows_cryptocurrency_symbols']
       end
     end
 
@@ -150,14 +151,14 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          brokerage_authorization == o.brokerage_authorization &&
-          portfolio_group == o.portfolio_group &&
+          code == o.code &&
+          mic_code == o.mic_code &&
           name == o.name &&
-          number == o.number &&
-          institution_name == o.institution_name &&
-          meta == o.meta &&
-          cash_restrictions == o.cash_restrictions &&
-          created_date == o.created_date
+          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
@@ -169,7 +170,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, brokerage_authorization, portfolio_group, name, number, institution_name, meta, cash_restrictions, created_date].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}

@@ -5,36 +5,33 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 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   - `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
 
-    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
 
@@ -47,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
       }
@@ -83,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
 
@@ -123,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
@@ -139,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