snaptrade 1.17.12 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e9789f55603bbab4757b768cf14bb1c4f49b1b6cde5c0b0f56389ba8db8eab1
-  data.tar.gz: 4edfde4d5e8e9732c83cef5417ca8d98dd4c5fafc7f13267e2c823478ca01ddb
+  metadata.gz: 54248537533cc85b7e2a236fd171c32f6e4893f8c1e99af4a1d7edd14129c450
+  data.tar.gz: 913138150b71863d9a70fcb08fe78fc18717c565e0145026e4333b410b6d300f
 SHA512:
-  metadata.gz: baaab36fde93555803ea8f3a6d6da3a8d6c357341f4509a9f2956d0cade3ea6996a802454ac60a632a81bb0e20ca26edda74093901081037a02be14c25db8fba
-  data.tar.gz: 7f1962fe3364eba460e44292ba0044b1e99587f66f63425bcb886e84a92e41a1d85ce4cea0fa983d7574baca6a392b83cfe1c869b0e3278f4b303d94788b4c2b
+  metadata.gz: 2edd6fe7cdb16b1c4605f9dacba0c0f488c11758ebfb1efe75b008957919b57c271337b3e6c6a4ed67b077f66a2388eed232a219d78c0aa05f1aae2b690bc4bb
+  data.tar.gz: a674e881bb6caf2179f55e203616049f3faf4d8309666c771e24946f75c71fd1576a6ae487ae1421d6e33bcc80f33b40a235c42106144578fbb4bcda21e570d1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (1.17.12)
+    snaptrade (1.17.13)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -9,40 +9,47 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    base64 (0.1.1)
     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.9.0)
-      faraday-net_http (>= 2.0, < 3.2)
+    faraday (2.7.11)
+      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.1.0)
-      net-http
+    faraday-net_http (3.0.2)
     io-console (0.6.0)
-    irb (1.6.4)
-      reline (>= 0.3.0)
+    irb (1.8.1)
+      rdoc
+      reline (>= 0.3.8)
     method_source (1.0.0)
     multipart-post (2.3.0)
-    net-http (0.4.1)
-      uri
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
+    psych (5.1.0)
+      stringio
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.0)
-    reline (0.3.4)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.1)
+    reline (0.3.8)
       io-console (~> 0.5)
-    rexml (3.2.5)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -52,10 +59,10 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+    rspec-support (3.12.1)
     rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -65,14 +72,15 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.28.1)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    stringio (3.0.8)
     unicode-display_width (2.4.2)
-    uri (0.13.0)
 
 PLATFORMS
-  arm64-darwin-21
+  arm64-darwin-22
 
 DEPENDENCIES
   debug (~> 1.8)
@@ -83,4 +91,4 @@ DEPENDENCIES
   snaptrade!
 
 BUNDLED WITH
-   2.3.7
+   2.4.19

data/README.md

@@ -9,7 +9,7 @@ For more information, please visit [https://snaptrade.com/](https://snaptrade.co
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 1.17.12'
+gem 'snaptrade', '~> 2.0.0'
 ```
 
 ## Getting Started
@@ -72,7 +72,7 @@ Class | Method | HTTP request | Description
 *SnapTrade::ReferenceDataApi* | [**get_security_types**](docs/ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types
 *SnapTrade::ReferenceDataApi* | [**get_stock_exchanges**](docs/ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges
 *SnapTrade::ReferenceDataApi* | [**get_symbols**](docs/ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols
-*SnapTrade::ReferenceDataApi* | [**get_symbols_by_ticker**](docs/ReferenceDataApi.md#get_symbols_by_ticker) | **GET** /symbols/{ticker} | Get details of a symbol by the ticker
+*SnapTrade::ReferenceDataApi* | [**get_symbols_by_ticker**](docs/ReferenceDataApi.md#get_symbols_by_ticker) | **GET** /symbols/{query} | Get details of a symbol by the ticker or the universal_symbol_id
 *SnapTrade::ReferenceDataApi* | [**list_all_brokerage_authorization_type**](docs/ReferenceDataApi.md#list_all_brokerage_authorization_type) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types
 *SnapTrade::ReferenceDataApi* | [**list_all_brokerages**](docs/ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List brokerages
 *SnapTrade::ReferenceDataApi* | [**list_all_currencies**](docs/ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List currencies
@@ -216,7 +216,6 @@ Class | Method | HTTP request | Description
  - [SnapTrade::UnderlyingSymbol](docs/UnderlyingSymbol.md)
  - [SnapTrade::UniversalActivity](docs/UniversalActivity.md)
  - [SnapTrade::UniversalSymbol](docs/UniversalSymbol.md)
- - [SnapTrade::UniversalSymbolTicker](docs/UniversalSymbolTicker.md)
  - [SnapTrade::UserErrorLog](docs/UserErrorLog.md)
  - [SnapTrade::UserIDandSecret](docs/UserIDandSecret.md)
  - [SnapTrade::UserSettings](docs/UserSettings.md)

data/docs/BrokerageSymbolSymbol.md

@@ -12,6 +12,7 @@
 | **exchange** | [**Exchange**](Exchange.md) |  | [optional] |
 | **type** | [**SecurityType**](SecurityType.md) |  |  |
 | **currencies** | [**Array<Currency>**](Currency.md) |  |  |
+| **figi_code** | **String** |  | [optional] |
 
 ## Example
 
@@ -26,7 +27,8 @@ instance = SnapTrade::BrokerageSymbolSymbol.new(
   currency: null,
   exchange: null,
   type: null,
-  currencies: null
+  currencies: null,
+  figi_code: BBG000B9XRY4
 )
 ```
 

data/docs/ReferenceDataApi.md

@@ -9,7 +9,7 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
 | [**get_security_types**](ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types |
 | [**get_stock_exchanges**](ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges |
 | [**get_symbols**](ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols |
-| [**get_symbols_by_ticker**](ReferenceDataApi.md#get_symbols_by_ticker) | **GET** /symbols/{ticker} | Get details of a symbol by the ticker |
+| [**get_symbols_by_ticker**](ReferenceDataApi.md#get_symbols_by_ticker) | **GET** /symbols/{query} | Get details of a symbol by the ticker or the universal_symbol_id |
 | [**list_all_brokerage_authorization_type**](ReferenceDataApi.md#list_all_brokerage_authorization_type) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types |
 | [**list_all_brokerages**](ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List brokerages |
 | [**list_all_currencies**](ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List currencies |
@@ -271,7 +271,7 @@ end
 
 ## get_symbols_by_ticker
 
-Get details of a symbol by the ticker
+Get details of a symbol by the ticker or the universal_symbol_id
 
 ### Example
 
@@ -281,14 +281,12 @@ require 'snaptrade'
 SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
-ticker = "ticker_example"
-symbol_id = "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+query = "query_example"
 
 begin
-  # Get details of a symbol by the ticker
+  # Get details of a symbol by the ticker or the universal_symbol_id
   result = SnapTrade::ReferenceData.get_symbols_by_ticker(
-                                                             ticker: ticker,
-                                                             symbol_id: symbol_id,
+                                                             query: query,
                                                            )
   p result
 rescue SnapTrade::ApiError => e
@@ -301,14 +299,12 @@ end
 This returns an Array which contains the response data, status code and headers.
 
 ```ruby
-ticker = "ticker_example"
-symbol_id = "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
+query = "query_example"
 
 begin
-  # Get details of a symbol by the ticker
+  # Get details of a symbol by the ticker or the universal_symbol_id
   data, status_code, headers, response = SnapTrade::ReferenceData.get_symbols_by_ticker_with_http_info(
-                                                                                                          ticker: ticker,
-                                                                                                          symbol_id: symbol_id,
+                                                                                                          query: query,
                                                                                                         )
   p status_code # => 2xx
   p headers # => { ... }
@@ -322,8 +318,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **ticker** | **String** | The ticker of the UniversalSymbol to get. |  |
-| **symbol_id** | **String** | OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get. | [optional] |
+| **query** | **String** | The ticker or universal_symbol_id of the UniversalSymbol to get. |  |
 
 ### Return type
 

data/docs/Symbol.md

@@ -11,6 +11,7 @@
 | **currency** | [**Currency**](Currency.md) |  | [optional] |
 | **exchange** | [**Exchange**](Exchange.md) |  | [optional] |
 | **type** | [**SecurityType**](SecurityType.md) |  | [optional] |
+| **figi_code** | **String** |  | [optional] |
 
 ## Example
 
@@ -24,7 +25,8 @@ instance = SnapTrade::Symbol.new(
   name: Vanguard Canadian Aggregate Bond Index ETF,
   currency: null,
   exchange: null,
-  type: null
+  type: null,
+  figi_code: BBG000B9XRY4
 )
 ```
 

data/docs/UnderlyingSymbol.md

@@ -11,6 +11,7 @@
 | **exchange** | [**USExchange**](USExchange.md) |  | [optional] |
 | **type** | [**SecurityType**](SecurityType.md) |  | [optional] |
 | **currencies** | [**Array<Currency>**](Currency.md) |  | [optional] |
+| **figi_code** | **String** |  | [optional] |
 
 ## Example
 
@@ -24,7 +25,8 @@ instance = SnapTrade::UnderlyingSymbol.new(
   currency: null,
   exchange: null,
   type: null,
-  currencies: null
+  currencies: null,
+  figi_code: BBG000B9XRY4
 )
 ```
 

data/docs/UniversalSymbol.md

@@ -12,6 +12,7 @@
 | **exchange** | [**Exchange**](Exchange.md) |  | [optional] |
 | **type** | [**SecurityType**](SecurityType.md) |  |  |
 | **currencies** | [**Array<Currency>**](Currency.md) |  |  |
+| **figi_code** | **String** |  | [optional] |
 
 ## Example
 
@@ -26,7 +27,8 @@ instance = SnapTrade::UniversalSymbol.new(
   currency: null,
   exchange: null,
   type: null,
-  currencies: null
+  currencies: null,
+  figi_code: BBG000B9XRY4
 )
 ```
 

data/lib/snaptrade/api/reference_data_api.rb

@@ -392,54 +392,47 @@ module SnapTrade
     end
 
 
-    # Get details of a symbol by the ticker
-    # @param ticker [String] The ticker of the UniversalSymbol to get.
-    # @param symbol_id [String] OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
+    # Get details of a symbol by the ticker or the universal_symbol_id
+    # @param query [String] The ticker or universal_symbol_id of the UniversalSymbol to get.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_symbols_by_ticker(ticker:, symbol_id: SENTINEL, extra: {})
-      extra[:symbol_id] = symbol_id if symbol_id != SENTINEL
-      data, _status_code, _headers = get_symbols_by_ticker_with_http_info_impl(ticker, extra)
+    def get_symbols_by_ticker(query:, extra: {})
+      data, _status_code, _headers = get_symbols_by_ticker_with_http_info_impl(query, extra)
       data
     end
 
-    # Get details of a symbol by the ticker
-    # @param ticker [String] The ticker of the UniversalSymbol to get.
-    # @param symbol_id [String] OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
+    # Get details of a symbol by the ticker or the universal_symbol_id
+    # @param query [String] The ticker or universal_symbol_id of the UniversalSymbol to get.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_symbols_by_ticker_with_http_info(ticker:, symbol_id: SENTINEL, extra: {})
-      extra[:symbol_id] = symbol_id if symbol_id != SENTINEL
-      get_symbols_by_ticker_with_http_info_impl(ticker, extra)
+    def get_symbols_by_ticker_with_http_info(query:, extra: {})
+      get_symbols_by_ticker_with_http_info_impl(query, extra)
     end
 
-    # Get details of a symbol by the ticker
-    # @param ticker [String] The ticker of the UniversalSymbol to get.
+    # Get details of a symbol by the ticker or the universal_symbol_id
+    # @param query [String] The ticker or universal_symbol_id of the UniversalSymbol to get.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :symbol_id OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
     # @return [UniversalSymbol]
-    def get_symbols_by_ticker_impl(ticker, opts = {})
-      data, _status_code, _headers = get_symbols_by_ticker_with_http_info(ticker, opts)
+    def get_symbols_by_ticker_impl(query, opts = {})
+      data, _status_code, _headers = get_symbols_by_ticker_with_http_info(query, opts)
       data
     end
 
-    # Get details of a symbol by the ticker
-    # @param ticker [String] The ticker of the UniversalSymbol to get.
+    # Get details of a symbol by the ticker or the universal_symbol_id
+    # @param query [String] The ticker or universal_symbol_id of the UniversalSymbol to get.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :symbol_id OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
     # @return [Array<(UniversalSymbol, Integer, Hash)>] UniversalSymbol data, response status code and response headers
-    def get_symbols_by_ticker_with_http_info_impl(ticker, opts = {})
+    def get_symbols_by_ticker_with_http_info_impl(query, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ReferenceDataApi.get_symbols_by_ticker ...'
       end
-      # verify the required parameter 'ticker' is set
-      if @api_client.config.client_side_validation && ticker.nil?
-        fail ArgumentError, "Missing the required parameter 'ticker' when calling ReferenceDataApi.get_symbols_by_ticker"
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling ReferenceDataApi.get_symbols_by_ticker"
       end
       # resource path
-      local_var_path = '/symbols/{ticker}'.sub('{' + 'ticker' + '}', CGI.escape(ticker.to_s))
+      local_var_path = '/symbols/{query}'.sub('{' + 'query' + '}', CGI.escape(query.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'symbolId'] = opts[:'symbol_id'] if !opts[:'symbol_id'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/snaptrade/models/brokerage_symbol_symbol.rb

@@ -29,6 +29,8 @@ module SnapTrade
 
     attr_accessor :currencies
 
+    attr_accessor :figi_code
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -39,7 +41,8 @@ module SnapTrade
         :'currency' => :'currency',
         :'exchange' => :'exchange',
         :'type' => :'type',
-        :'currencies' => :'currencies'
+        :'currencies' => :'currencies',
+        :'figi_code' => :'figi_code'
       }
     end
 
@@ -58,7 +61,8 @@ module SnapTrade
         :'currency' => :'Currency',
         :'exchange' => :'Exchange',
         :'type' => :'SecurityType',
-        :'currencies' => :'Array<Currency>'
+        :'currencies' => :'Array<Currency>',
+        :'figi_code' => :'String'
       }
     end
 
@@ -66,6 +70,7 @@ module SnapTrade
     def self.openapi_nullable
       Set.new([
         :'description',
+        :'figi_code'
       ])
     end
 
@@ -124,6 +129,10 @@ module SnapTrade
           self.currencies = value
         end
       end
+
+      if attributes.key?(:'figi_code')
+        self.figi_code = attributes[:'figi_code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -181,7 +190,8 @@ module SnapTrade
           currency == o.currency &&
           exchange == o.exchange &&
           type == o.type &&
-          currencies == o.currencies
+          currencies == o.currencies &&
+          figi_code == o.figi_code
     end
 
     # @see the `==` method
@@ -193,7 +203,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, symbol, raw_symbol, description, currency, exchange, type, currencies].hash
+      [id, symbol, raw_symbol, description, currency, exchange, type, currencies, figi_code].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/symbol.rb

@@ -28,6 +28,8 @@ module SnapTrade
 
     attr_accessor :type
 
+    attr_accessor :figi_code
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -37,7 +39,8 @@ module SnapTrade
         :'name' => :'name',
         :'currency' => :'currency',
         :'exchange' => :'exchange',
-        :'type' => :'type'
+        :'type' => :'type',
+        :'figi_code' => :'figi_code'
       }
     end
 
@@ -55,13 +58,15 @@ module SnapTrade
         :'name' => :'String',
         :'currency' => :'Currency',
         :'exchange' => :'Exchange',
-        :'type' => :'SecurityType'
+        :'type' => :'SecurityType',
+        :'figi_code' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'figi_code'
       ])
     end
 
@@ -107,6 +112,10 @@ module SnapTrade
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
+
+      if attributes.key?(:'figi_code')
+        self.figi_code = attributes[:'figi_code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -133,7 +142,8 @@ module SnapTrade
           name == o.name &&
           currency == o.currency &&
           exchange == o.exchange &&
-          type == o.type
+          type == o.type &&
+          figi_code == o.figi_code
     end
 
     # @see the `==` method
@@ -145,7 +155,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, symbol, raw_symbol, name, currency, exchange, type].hash
+      [id, symbol, raw_symbol, name, currency, exchange, type, figi_code].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/underlying_symbol.rb

@@ -28,6 +28,8 @@ module SnapTrade
 
     attr_accessor :currencies
 
+    attr_accessor :figi_code
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -37,7 +39,8 @@ module SnapTrade
         :'currency' => :'currency',
         :'exchange' => :'exchange',
         :'type' => :'type',
-        :'currencies' => :'currencies'
+        :'currencies' => :'currencies',
+        :'figi_code' => :'figi_code'
       }
     end
 
@@ -55,7 +58,8 @@ module SnapTrade
         :'currency' => :'Currency',
         :'exchange' => :'USExchange',
         :'type' => :'SecurityType',
-        :'currencies' => :'Array<Currency>'
+        :'currencies' => :'Array<Currency>',
+        :'figi_code' => :'String'
       }
     end
 
@@ -63,6 +67,7 @@ module SnapTrade
     def self.openapi_nullable
       Set.new([
         :'description',
+        :'figi_code'
       ])
     end
 
@@ -110,6 +115,10 @@ module SnapTrade
           self.currencies = value
         end
       end
+
+      if attributes.key?(:'figi_code')
+        self.figi_code = attributes[:'figi_code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -136,7 +145,8 @@ module SnapTrade
           currency == o.currency &&
           exchange == o.exchange &&
           type == o.type &&
-          currencies == o.currencies
+          currencies == o.currencies &&
+          figi_code == o.figi_code
     end
 
     # @see the `==` method
@@ -148,7 +158,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, description, currency, exchange, type, currencies, figi_code].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/universal_symbol.rb

@@ -30,6 +30,8 @@ module SnapTrade
 
     attr_accessor :currencies
 
+    attr_accessor :figi_code
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,7 +42,8 @@ module SnapTrade
         :'currency' => :'currency',
         :'exchange' => :'exchange',
         :'type' => :'type',
-        :'currencies' => :'currencies'
+        :'currencies' => :'currencies',
+        :'figi_code' => :'figi_code'
       }
     end
 
@@ -59,7 +62,8 @@ module SnapTrade
         :'currency' => :'Currency',
         :'exchange' => :'Exchange',
         :'type' => :'SecurityType',
-        :'currencies' => :'Array<Currency>'
+        :'currencies' => :'Array<Currency>',
+        :'figi_code' => :'String'
       }
     end
 
@@ -67,6 +71,7 @@ module SnapTrade
     def self.openapi_nullable
       Set.new([
         :'description',
+        :'figi_code'
       ])
     end
 
@@ -118,6 +123,10 @@ module SnapTrade
           self.currencies = value
         end
       end
+
+      if attributes.key?(:'figi_code')
+        self.figi_code = attributes[:'figi_code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -175,7 +184,8 @@ module SnapTrade
           currency == o.currency &&
           exchange == o.exchange &&
           type == o.type &&
-          currencies == o.currencies
+          currencies == o.currencies &&
+          figi_code == o.figi_code
     end
 
     # @see the `==` method
@@ -187,7 +197,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, symbol, raw_symbol, description, currency, exchange, type, currencies].hash
+      [id, symbol, raw_symbol, description, currency, exchange, type, currencies, figi_code].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/version.rb

@@ -9,5 +9,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '1.17.12'
+  VERSION = '2.0.0'
 end

data/lib/snaptrade.rb

@@ -143,7 +143,6 @@ require 'snaptrade/models/us_exchange'
 require 'snaptrade/models/underlying_symbol'
 require 'snaptrade/models/universal_activity'
 require 'snaptrade/models/universal_symbol'
-require 'snaptrade/models/universal_symbol_ticker'
 require 'snaptrade/models/user_error_log'
 require 'snaptrade/models/user_i_dand_secret'
 require 'snaptrade/models/user_settings'

data/spec/api/reference_data_api_spec.rb

@@ -82,10 +82,9 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for get_symbols_by_ticker
-  # Get details of a symbol by the ticker
-  # @param ticker The ticker of the UniversalSymbol to get.
+  # Get details of a symbol by the ticker or the universal_symbol_id
+  # @param query The ticker or universal_symbol_id of the UniversalSymbol to get.
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :symbol_id OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
   # @return [UniversalSymbol]
   describe 'get_symbols_by_ticker test' do
     it 'should work' do

data/spec/models/brokerage_symbol_symbol_spec.rb

@@ -69,4 +69,10 @@ describe SnapTrade::BrokerageSymbolSymbol do
     end
   end
 
+  describe 'test attribute "figi_code"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/symbol_spec.rb

@@ -63,4 +63,10 @@ describe SnapTrade::Symbol do
     end
   end
 
+  describe 'test attribute "figi_code"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/underlying_symbol_spec.rb

@@ -63,4 +63,10 @@ describe SnapTrade::UnderlyingSymbol do
     end
   end
 
+  describe 'test attribute "figi_code"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/universal_symbol_spec.rb

@@ -69,4 +69,10 @@ describe SnapTrade::UniversalSymbol do
     end
   end
 
+  describe 'test attribute "figi_code"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 1.17.12
+  version: 2.0.0
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -216,7 +216,6 @@ files:
 - docs/UnderlyingSymbol.md
 - docs/UniversalActivity.md
 - docs/UniversalSymbol.md
-- docs/UniversalSymbolTicker.md
 - docs/UserErrorLog.md
 - docs/UserIDandSecret.md
 - docs/UserSettings.md
@@ -360,7 +359,6 @@ files:
 - lib/snaptrade/models/underlying_symbol.rb
 - lib/snaptrade/models/universal_activity.rb
 - lib/snaptrade/models/universal_symbol.rb
-- lib/snaptrade/models/universal_symbol_ticker.rb
 - lib/snaptrade/models/us_exchange.rb
 - lib/snaptrade/models/user_error_log.rb
 - lib/snaptrade/models/user_i_dand_secret.rb
@@ -504,7 +502,6 @@ files:
 - spec/models/underlying_symbol_spec.rb
 - spec/models/universal_activity_spec.rb
 - spec/models/universal_symbol_spec.rb
-- spec/models/universal_symbol_ticker_spec.rb
 - spec/models/us_exchange_spec.rb
 - spec/models/user_error_log_spec.rb
 - spec/models/user_i_dand_secret_spec.rb
@@ -531,7 +528,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: SnapTrade Ruby Gem
@@ -604,7 +601,6 @@ test_files:
 - spec/models/manual_trade_balance_spec.rb
 - spec/models/session_event_spec.rb
 - spec/models/state_spec.rb
-- spec/models/universal_symbol_ticker_spec.rb
 - spec/models/strategy_order_place_orders_inner_spec.rb
 - spec/models/connection_type_spec.rb
 - spec/models/strategy_order_record_status_spec.rb

data/docs/UniversalSymbolTicker.md

@@ -1,32 +0,0 @@
-# SnapTrade::UniversalSymbolTicker
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **symbol** | **String** |  | [optional] |
-| **raw_symbol** | **String** |  | [optional] |
-| **description** | **String** |  | [optional] |
-| **currency** | [**Currency**](Currency.md) |  | [optional] |
-| **exchange** | [**Exchange**](Exchange.md) |  | [optional] |
-| **type** | [**SecurityType**](SecurityType.md) |  | [optional] |
-| **currencies** | [**Array<Currency>**](Currency.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::UniversalSymbolTicker.new(
-  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  symbol: VAB.TO,
-  raw_symbol: VAB,
-  description: VANGUARD CDN AGGREGATE BOND INDEX ETF,
-  currency: null,
-  exchange: null,
-  type: null,
-  currencies: null
-)
-```
-

data/lib/snaptrade/models/universal_symbol_ticker.rb

@@ -1,283 +0,0 @@
-=begin
-#SnapTrade
-
-#Connect brokerage accounts to your app for live positions and trading
-
-The version of the OpenAPI document: 1.0.0
-Contact: api@snaptrade.com
-
-=end
-
-require 'date'
-require 'time'
-
-module SnapTrade
-  # Universal symbol
-  class UniversalSymbolTicker
-    attr_accessor :id
-
-    attr_accessor :symbol
-
-    attr_accessor :raw_symbol
-
-    attr_accessor :description
-
-    attr_accessor :currency
-
-    attr_accessor :exchange
-
-    attr_accessor :type
-
-    attr_accessor :currencies
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'id' => :'id',
-        :'symbol' => :'symbol',
-        :'raw_symbol' => :'raw_symbol',
-        :'description' => :'description',
-        :'currency' => :'currency',
-        :'exchange' => :'exchange',
-        :'type' => :'type',
-        :'currencies' => :'currencies'
-      }
-    end
-
-    # Returns all the JSON keys this model knows about
-    def self.acceptable_attributes
-      attribute_map.values
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'id' => :'String',
-        :'symbol' => :'String',
-        :'raw_symbol' => :'String',
-        :'description' => :'String',
-        :'currency' => :'Currency',
-        :'exchange' => :'Exchange',
-        :'type' => :'SecurityType',
-        :'currencies' => :'Array<Currency>'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-      ])
-    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::UniversalSymbolTicker` 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::UniversalSymbolTicker`. 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?(:'symbol')
-        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
-
-      if attributes.key?(:'currency')
-        self.currency = attributes[:'currency']
-      end
-
-      if attributes.key?(:'exchange')
-        self.exchange = attributes[:'exchange']
-      end
-
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
-      end
-
-      if attributes.key?(:'currencies')
-        if (value = attributes[:'currencies']).is_a?(Array)
-          self.currencies = value
-        end
-      end
-    end
-
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      true
-    end
-
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      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 &&
-          currencies == o.currencies
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [id, symbol, raw_symbol, description, currency, exchange, type, currencies].hash
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end
-      end
-
-      self
-    end
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def _deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = SnapTrade.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
-        end
-
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
-  end
-
-end

data/spec/models/universal_symbol_ticker_spec.rb

@@ -1,72 +0,0 @@
-=begin
-#SnapTrade
-
-#Connect brokerage accounts to your app for live positions and trading
-
-The version of the OpenAPI document: 1.0.0
-Contact: api@snaptrade.com
-
-=end
-
-require 'spec_helper'
-require 'json'
-require 'date'
-
-# Unit tests for SnapTrade::UniversalSymbolTicker
-describe SnapTrade::UniversalSymbolTicker do
-  let(:instance) { SnapTrade::UniversalSymbolTicker.new }
-
-  describe 'test an instance of UniversalSymbolTicker' do
-    it 'should create an instance of UniversalSymbolTicker' do
-      expect(instance).to be_instance_of(SnapTrade::UniversalSymbolTicker)
-    end
-  end
-  describe 'test attribute "id"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "symbol"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "raw_symbol"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "description"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "currency"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "exchange"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "type"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "currencies"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-end