snaptrade 2.0.31 → 2.0.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4473f0d7f5cc9ca2466287af5c01b2d7eb3a32f20bb08407b5192c4f43d1bde5
-  data.tar.gz: 95e42f51f88e79ccc23e880f96075ff27904bacaf355b31ab2ed656d7a3c11b7
+  metadata.gz: 887242914b86d8378fc839b462051ccc0489d1e2a1ba0b37bc6bff2ad458003a
+  data.tar.gz: bd3892448dcca278db8625b0df2f88bc81cd53011ee7b93db4823909f2d273c7
 SHA512:
-  metadata.gz: 4a9684055202d8e628a2411cb281e854e54ee10a129b382eccccce0319357b8df46240646466406d57a2e9d0704406f177b453e85f2d416b3a63c1ee84b76fbe
-  data.tar.gz: a8f50d47809964ba63c21f15ce16f5265495973ceced0c85fb1fae94a85c8b6605ed7b86f5df5b370e76f7b77a57c54606e354e53058a21a9293d0ff227eb55c
+  metadata.gz: 9f9941bbba13715288cfe8a284dd215fb0d43a89760285651ff7f7f114def7ab938cc79dbdbcd554134017fd448be5944236098aa0831c05304397509dc57cd1
+  data.tar.gz: a1f13e4ff3b7d3faf8702b6f4c8fda8f82ce5ca4bd78811b2180011f31f8f88d21362a19685c3e245acdfe2c8818a07e1d1ae31e414a1c03b6e38dd81edf98a9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.30)
+    snaptrade (2.0.32)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -9,27 +9,27 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    base64 (0.1.1)
+    base64 (0.2.0)
     byebug (11.1.3)
     coderay (1.1.3)
     debug (1.8.0)
       irb (>= 1.5.0)
       reline (>= 0.3.1)
-    diff-lcs (1.5.0)
-    faraday (2.7.11)
+    diff-lcs (1.5.1)
+    faraday (2.8.1)
       base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
     faraday-net_http (3.0.2)
-    io-console (0.6.0)
+    io-console (0.7.2)
     irb (1.6.4)
       reline (>= 0.3.0)
-    method_source (1.0.0)
-    multipart-post (2.3.0)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    method_source (1.1.0)
+    multipart-post (2.4.1)
+    parallel (1.26.2)
+    parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -38,26 +38,27 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    racc (1.7.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.1)
-    reline (0.3.8)
+    regexp_parser (2.9.2)
+    reline (0.5.9)
       io-console (~> 0.5)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rexml (3.3.5)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -67,14 +68,15 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.32.0)
+      parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    unicode-display_width (2.4.2)
+    strscan (3.1.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
-  arm64-darwin-22
+  x86_64-linux
 
 DEPENDENCIES
   debug (~> 1.8)
@@ -86,4 +88,4 @@ DEPENDENCIES
   snaptrade!
 
 BUNDLED WITH
-   2.4.19
+   2.4.22

data/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/gem-v2.0.31-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.31)
+[![npm](https://img.shields.io/badge/gem-v2.0.32-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.32)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -70,7 +70,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.31'
+gem 'snaptrade', '~> 2.0.32'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -305,6 +305,8 @@ The ID of the account to get positions.
 
 Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
 
+The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 

data/lib/snaptrade/api/account_information_api.rb

@@ -564,6 +564,8 @@ module SnapTrade
     # List account holdings
     #
     # Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
+    # 
+    # The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
     #
     # @param account_id [String] 
     # @param user_id [String] 
@@ -577,6 +579,8 @@ module SnapTrade
     # List account holdings
     #
     # Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
+    # 
+    # The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
     #
     # @param account_id [String] 
     # @param user_id [String] 
@@ -587,7 +591,7 @@ module SnapTrade
     end
 
     # List account holdings
-    # Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ 
+    # Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 
     # @param account_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -599,7 +603,7 @@ module SnapTrade
     end
 
     # List account holdings
-    # Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ 
+    # Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 
     # @param account_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 

data/lib/snaptrade/models/account_holdings_account.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # A wrapper object containing holdings information for a single account
+  # A wrapper object containing holdings information for a single account.
   class AccountHoldingsAccount
     attr_accessor :account
 

data/lib/snaptrade/models/account_order_record.rb

@@ -11,13 +11,15 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Record of order in brokerageaccount
+  # Describes a single recent order in an account.
   class AccountOrderRecord
-    # Order id returned by brokerage
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
     attr_accessor :brokerage_order_id
 
+    # Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
     attr_accessor :status
 
+    # 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 :symbol
 
     attr_accessor :universal_symbol

data/lib/snaptrade/models/exchange.rb

@@ -11,22 +11,30 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Stock Exchange
+  # Describes a single stock or crypto exchange.
   class Exchange
+    # Unique ID for the exchange in SnapTrade.
     attr_accessor :id
 
+    # A short name for the exchange. For standardized exchange code, please us the `mic_code` field.
     attr_accessor :code
 
+    # The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.
     attr_accessor :mic_code
 
+    # The full name of the exchange.
     attr_accessor :name
 
+    # The timezone for the trading hours (`start_time` and `close_time`) of the exchange.
     attr_accessor :timezone
 
+    # The time when the exchange opens for trading.
     attr_accessor :start_time
 
+    # The time when the exchange closes for trading.
     attr_accessor :close_time
 
+    # The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail.
     attr_accessor :suffix
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/figi_instrument.rb

@@ -11,10 +11,12 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Open FIGI Identifiers
+  # Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information.
   class FigiInstrument
+    # 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/option_brokerage_symbol.rb

@@ -11,10 +11,12 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Option Brokerage symbol
+  # Uniquely describes a security for the option position within an account. The distinction between this and the `option_symbol` child property is that this object is specific to a position within an account, while the `option_symbol` child property is universal across all brokerage accounts. The caller should rely on the `option_symbol` child property for most use cases.
   class OptionBrokerageSymbol
+    # 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 `option_symbol` child property's `description` instead.
     attr_accessor :description
 
     attr_accessor :option_symbol

data/lib/snaptrade/models/options_position.rb

@@ -18,7 +18,7 @@ module SnapTrade
     # Last known market price for the option contract. 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 number of contracts for this option position.
+    # The number of contracts for this option position. A positive number indicates a long position, while a negative number indicates a short position.
     attr_accessor :units
 
     attr_accessor :currency

data/lib/snaptrade/models/options_position_currency.rb

@@ -11,6 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
+  # The currency of the price. This field is deprecated and will be removed in a future version. The currency of the price is determined by the currency of the underlying security.
   class OptionsPositionCurrency
     # Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
     attr_accessor :id

data/lib/snaptrade/models/options_symbol.rb

@@ -11,26 +11,28 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Options Symbol
+  # Uniquely describes an option security + exchange combination across all brokerages.
   class OptionsSymbol
+    # Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
     attr_accessor :id
 
+    # The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
     attr_accessor :ticker
 
+    # The type of option. Either \"CALL\" or \"PUT\".
     attr_accessor :option_type
 
+    # The option strike price.
     attr_accessor :strike_price
 
+    # The option expiration date.
     attr_accessor :expiration_date
 
+    # Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
     attr_accessor :is_mini_option
 
     attr_accessor :underlying_symbol
 
-    attr_accessor :local_id
-
-    attr_accessor :exchange_id
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,9 +42,7 @@ module SnapTrade
         :'strike_price' => :'strike_price',
         :'expiration_date' => :'expiration_date',
         :'is_mini_option' => :'is_mini_option',
-        :'underlying_symbol' => :'underlying_symbol',
-        :'local_id' => :'local_id',
-        :'exchange_id' => :'exchange_id'
+        :'underlying_symbol' => :'underlying_symbol'
       }
     end
 
@@ -58,11 +58,9 @@ module SnapTrade
         :'ticker' => :'String',
         :'option_type' => :'OptionType',
         :'strike_price' => :'Float',
-        :'expiration_date' => :'String',
+        :'expiration_date' => :'Date',
         :'is_mini_option' => :'Boolean',
-        :'underlying_symbol' => :'UnderlyingSymbol',
-        :'local_id' => :'String',
-        :'exchange_id' => :'String'
+        :'underlying_symbol' => :'UnderlyingSymbol'
       }
     end
 
@@ -114,14 +112,6 @@ module SnapTrade
       if attributes.key?(:'underlying_symbol')
         self.underlying_symbol = attributes[:'underlying_symbol']
       end
-
-      if attributes.key?(:'local_id')
-        self.local_id = attributes[:'local_id']
-      end
-
-      if attributes.key?(:'exchange_id')
-        self.exchange_id = attributes[:'exchange_id']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -178,9 +168,7 @@ module SnapTrade
           strike_price == o.strike_price &&
           expiration_date == o.expiration_date &&
           is_mini_option == o.is_mini_option &&
-          underlying_symbol == o.underlying_symbol &&
-          local_id == o.local_id &&
-          exchange_id == o.exchange_id
+          underlying_symbol == o.underlying_symbol
     end
 
     # @see the `==` method
@@ -192,7 +180,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, ticker, option_type, strike_price, expiration_date, is_mini_option, underlying_symbol, local_id, exchange_id].hash
+      [id, ticker, option_type, strike_price, expiration_date, is_mini_option, underlying_symbol].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/position_symbol.rb

@@ -11,18 +11,23 @@ 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
+    # 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.

data/lib/snaptrade/models/security_type.rb

@@ -11,14 +11,18 @@ 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   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/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