snaptrade 1.17.13 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 975d402b0d373fe2299950d7e6939d1d0a01465ec71fc60c96542394c6214d98
-  data.tar.gz: 25f83be291930f060708ddab5753080eefe30736e701d71a06c08d0e46381761
+  metadata.gz: 54248537533cc85b7e2a236fd171c32f6e4893f8c1e99af4a1d7edd14129c450
+  data.tar.gz: 913138150b71863d9a70fcb08fe78fc18717c565e0145026e4333b410b6d300f
 SHA512:
-  metadata.gz: b7247b98a43069a678782e0f99945607ea6ffe06f43990a1b68ab5edb70b7525b8ceca24e465701c93b8b89235c5a649980af2ed7b959f5538b7d68dc01c7907
-  data.tar.gz: a4e2fc6e5d6296f87bbf525d01e165f1316a9fc15cf7169dd52ae976d887bf6a90f39555b494fe6e9649061df97af13ef9970cbc55b0059b36048818803d92bc
+  metadata.gz: 2edd6fe7cdb16b1c4605f9dacba0c0f488c11758ebfb1efe75b008957919b57c271337b3e6c6a4ed67b077f66a2388eed232a219d78c0aa05f1aae2b690bc4bb
+  data.tar.gz: a674e881bb6caf2179f55e203616049f3faf4d8309666c771e24946f75c71fd1576a6ae487ae1421d6e33bcc80f33b40a235c42106144578fbb4bcda21e570d1

data/Gemfile.lock

@@ -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.13'
+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

data/docs/MonthlyDividends.md

@@ -13,7 +13,7 @@
 require 'snaptrade'
 
 instance = SnapTrade::MonthlyDividends.new(
-  date: Mon Jan 24 00:00:00 UTC 2022,
+  date: Sun Jan 23 16:00:00 PST 2022,
   dividends: null
 )
 ```

data/docs/NetContributions.md

@@ -14,7 +14,7 @@
 require 'snaptrade'
 
 instance = SnapTrade::NetContributions.new(
-  date: Mon Jan 24 00:00:00 UTC 2022,
+  date: Sun Jan 23 16:00:00 PST 2022,
   contributions: 524.74,
   currency: CAD
 )

data/docs/PastValue.md

@@ -14,7 +14,7 @@
 require 'snaptrade'
 
 instance = SnapTrade::PastValue.new(
-  date: Mon Jan 24 00:00:00 UTC 2022,
+  date: Sun Jan 23 16:00:00 PST 2022,
   value: 52.74,
   currency: CAD
 )

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/SubPeriodReturnRate.md

@@ -14,8 +14,8 @@
 require 'snaptrade'
 
 instance = SnapTrade::SubPeriodReturnRate.new(
-  period_start: Mon Jan 24 00:00:00 UTC 2022,
-  period_end: Mon Jan 24 00:00:00 UTC 2022,
+  period_start: Sun Jan 23 16:00:00 PST 2022,
+  period_end: Sun Jan 23 16:00:00 PST 2022,
   rate_of_return: 0.012312367452
 )
 ```

data/docs/TransactionsStatus.md

@@ -14,7 +14,7 @@ require 'snaptrade'
 
 instance = SnapTrade::TransactionsStatus.new(
   initial_sync_completed: null,
-  last_successful_sync: Mon Jan 24 00:00:00 UTC 2022
+  last_successful_sync: Sun Jan 23 16:00:00 PST 2022
 )
 ```
 

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/version.rb

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 1.17.13
+  version: 2.0.0
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-17 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -528,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