snaptrade 1.7.0 → 1.12.0

data/lib/snaptrade/models/account_holdings.rb

@@ -50,6 +50,8 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'balances',
+        :'positions',
       ])
     end
 

data/lib/snaptrade/models/account_holdings_account.rb

@@ -54,6 +54,9 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'balances',
+        :'positions',
+        :'orders',
       ])
     end
 

data/lib/snaptrade/version.rb

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

data/lib/snaptrade.rb

@@ -150,7 +150,6 @@ require 'snaptrade/api/authentication_api'
 require 'snaptrade/api/connections_api'
 require 'snaptrade/api/error_logs_api'
 require 'snaptrade/api/options_api'
-require 'snaptrade/api/portfolio_management_api'
 require 'snaptrade/api/reference_data_api'
 require 'snaptrade/api/trading_api'
 require 'snaptrade/api/transactions_and_reporting_api'
@@ -192,7 +191,6 @@ module SnapTrade
     attr_accessor :connections
     attr_accessor :error_logs
     attr_accessor :options
-    attr_accessor :portfolio_management
     attr_accessor :reference_data
     attr_accessor :trading
     attr_accessor :transactions_and_reporting
@@ -205,7 +203,6 @@ module SnapTrade
       @connections = SnapTrade::ConnectionsApi.new(@api_client)
       @error_logs = SnapTrade::ErrorLogsApi.new(@api_client)
       @options = SnapTrade::OptionsApi.new(@api_client)
-      @portfolio_management = SnapTrade::PortfolioManagementApi.new(@api_client)
       @reference_data = SnapTrade::ReferenceDataApi.new(@api_client)
       @trading = SnapTrade::TradingApi.new(@api_client)
       @transactions_and_reporting = SnapTrade::TransactionsAndReportingApi.new(@api_client)

data/spec/api/account_information_api_spec.rb

@@ -29,7 +29,7 @@ describe 'AccountInformationApi' do
   end
 
   # unit tests for get_all_user_holdings
-  # List all accounts for the user, plus balances and positions for each account.
+  # List all accounts for the user, plus balances, positions, and orders for each account.
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -42,7 +42,7 @@ describe 'AccountInformationApi' do
   end
 
   # unit tests for get_user_account_balance
-  # Get all cash balances of an investment account
+  # List account balances
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account get positions.
@@ -60,7 +60,7 @@ describe 'AccountInformationApi' do
   # @param user_secret 
   # @param account_id The ID of the account to get detail of.
   # @param [Hash] opts the optional parameters
-  # @return [Array<Account>]
+  # @return [Account]
   describe 'get_user_account_details test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -82,7 +82,7 @@ describe 'AccountInformationApi' do
   end
 
   # unit tests for get_user_account_positions
-  # Get all positions of an investment account
+  # List account positions
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account get positions.
@@ -108,7 +108,7 @@ describe 'AccountInformationApi' do
   end
 
   # unit tests for list_user_accounts
-  # List all investment accounts for the user
+  # List accounts
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

data/spec/api/authentication_api_spec.rb

@@ -29,7 +29,7 @@ describe 'AuthenticationApi' do
   end
 
   # unit tests for delete_snap_trade_user
-  # Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+  # Delete SnapTrade user
   # @param user_id 
   # @param [Hash] opts the optional parameters
   # @return [DeleteUserResponse]
@@ -40,7 +40,7 @@ describe 'AuthenticationApi' do
   end
 
   # unit tests for get_user_jwt
-  # Obtains an encrypted JWT tokens that should be decrypted on a user's local device
+  # Generate encrypted JWT token
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -52,7 +52,7 @@ describe 'AuthenticationApi' do
   end
 
   # unit tests for list_snap_trade_users
-  # Get a list of all SnapTrade users you've registered on our platform
+  # List SnapTrade users
   # @param [Hash] opts the optional parameters
   # @return [Array<String>]
   describe 'list_snap_trade_users test' do
@@ -62,7 +62,7 @@ describe 'AuthenticationApi' do
   end
 
   # unit tests for login_snap_trade_user
-  # Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+  # Login user &amp; generate connection link
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -75,7 +75,7 @@ describe 'AuthenticationApi' do
   end
 
   # unit tests for register_snap_trade_user
-  # Register user with SnapTrade in order to create secure brokerage authorizations
+  # Create SnapTrade user
   # @param snap_trade_register_user_request_body 
   # @param [Hash] opts the optional parameters
   # @return [UserIDandSecret]

data/spec/api/options_api_spec.rb

@@ -76,7 +76,7 @@ describe 'OptionsApi' do
   # @param user_secret 
   # @param account_id The ID of the account get positions.
   # @param [Hash] opts the optional parameters
-  # @return [OptionsHoldings]
+  # @return [Array<OptionsPosition>]
   describe 'list_option_holdings test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/api/reference_data_api_spec.rb

@@ -60,7 +60,7 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for get_stock_exchanges
-  # Return list of stock exchanges on Passiv and their suffixes
+  # List exchanges
   # @param [Hash] opts the optional parameters
   # @return [Array<Exchange>]
   describe 'get_stock_exchanges test' do
@@ -104,7 +104,7 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for list_all_brokerages
-  # List of all brokerages.
+  # List brokerages
   # @param [Hash] opts the optional parameters
   # @return [Array<Brokerage>]
   describe 'list_all_brokerages test' do
@@ -114,7 +114,7 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for list_all_currencies
-  # List of all supported currencies
+  # List currencies
   # @param [Hash] opts the optional parameters
   # @return [Array<Currency>]
   describe 'list_all_currencies test' do
@@ -124,7 +124,7 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for list_all_currencies_rates
-  # Return the exchange rates of all supported currencies
+  # List currency exchange rates
   # @param [Hash] opts the optional parameters
   # @return [Array<ExchangeRatePairs>]
   describe 'list_all_currencies_rates test' do
@@ -134,7 +134,7 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for symbol_search_user_account
-  # Search for symbols that are supported by a brokerage account using a substring
+  # Search for symbols available in an account
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account get positions.

data/spec/api/trading_api_spec.rb

@@ -42,31 +42,6 @@ describe 'TradingApi' do
     end
   end
 
-  # unit tests for get_calculated_trade_impact_by_id
-  # Return details of a specific trade before it's placed
-  # @param portfolio_group_id The ID of the PortfolioGroup to perform rebalancing calculations
-  # @param calculated_trade_id The ID of calculated trade to get account impact
-  # @param trade_id The ID of trade object
-  # @param [Hash] opts the optional parameters
-  # @return [Trade]
-  describe 'get_calculated_trade_impact_by_id test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  # unit tests for get_calculated_trades_impact
-  # Return the impact of placing a series of trades on the portfolio
-  # @param portfolio_group_id The ID of the PortfolioGroup to perform rebalancing calculations
-  # @param calculated_trade_id The ID of calculated trade to get account impact
-  # @param [Hash] opts the optional parameters
-  # @return [Array<TradeImpact>]
-  describe 'get_calculated_trades_impact test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
   # unit tests for get_order_impact
   # Check impact of trades on account.
   # @param user_id 
@@ -95,32 +70,6 @@ describe 'TradingApi' do
     end
   end
 
-  # unit tests for modify_calculated_trade_by_id
-  # Modify units of a trade before it is placed
-  # @param portfolio_group_id The ID of the PortfolioGroup to perform rebalancing calculations
-  # @param calculated_trade_id The ID of calculated trade to get account impact
-  # @param trade_id The ID of trade object
-  # @param [Hash] opts the optional parameters
-  # @option opts [Trade] :trade 
-  # @return [Trade]
-  describe 'modify_calculated_trade_by_id test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  # unit tests for place_calculated_trades
-  # Place orders for the CalculatedTrades in series
-  # @param portfolio_group_id The ID of the PortfolioGroup to perform rebalancing calculations
-  # @param calculated_trade_id The ID of calculated trade to get account impact
-  # @param [Hash] opts the optional parameters
-  # @return [Array<TradeExecutionStatus>]
-  describe 'place_calculated_trades test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
   # unit tests for place_force_order
   # Place a trade with NO validation.
   # @param user_id 

data/spec/api/transactions_and_reporting_api_spec.rb

@@ -38,7 +38,7 @@ describe 'TransactionsAndReportingApi' do
   # @option opts [Date] :end_date 
   # @option opts [String] :accounts Optional comma seperated list of account IDs used to filter the request on specific accounts
   # @option opts [String] :brokerage_authorizations Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
-  # @option opts [String] :type Optional comma seperated list of types to filter activities by. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
+  # @option opts [String] :type Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
   # @return [Array<UniversalActivity>]
   describe 'get_activities test' do
     it 'should work' do

data/spec/getting_started_spec.rb

@@ -22,29 +22,6 @@ describe 'GettingStarted' do
     # run after each test
   end
 
-  describe 'non object body parameter' do
-    it 'should work' do
-      configuration = SnapTrade::Configuration.new
-      configuration.client_id = ENV["SNAPTRADE_CLIENT_ID"]
-      configuration.consumer_key = ENV["SNAPTRADE_CONSUMER_KEY"]
-      configuration.host = "http://127.0.0.1:4010"
-      snaptrade = SnapTrade::Client.new(configuration)
-
-      data = snaptrade.portfolio_management.set_portfolio_targets(
-        portfolio_group_id: SecureRandom.uuid,
-        body: [{
-          "id" => SecureRandom.uuid,
-          "symbol" => {
-            "id" => SecureRandom.uuid,
-            "symbol" => "VOO"
-          }
-        }]
-      )
-      puts data
-      expect(data).not_to be_nil
-    end
-  end
-
   describe 'optional non body parameters should be passed' do
     it 'should pass' do
       configuration = SnapTrade::Configuration.new
@@ -86,15 +63,6 @@ describe 'GettingStarted' do
       redirect_uri = SnapTrade::Authentication.login_snap_trade_user(user_id: user_id, user_secret: response.user_secret)
       puts redirect_uri
 
-      SnapTrade::PortfolioManagement.create(
-        user_id: user_id,
-        user_secret: response.user_secret,
-        id: SecureRandom.uuid,
-        name: "MyPortfolio"
-      )
-      portfolios = SnapTrade::PortfolioManagement.list(user_id: user_id, user_secret: response.user_secret)
-      puts portfolios
-
       # 5) Obtaining account holdings data
       holdings = SnapTrade::AccountInformation.get_all_user_holdings(user_id: user_id, user_secret: response.user_secret)
       puts holdings
@@ -127,10 +95,6 @@ describe 'GettingStarted' do
       redirect_uri = snaptrade.authentication.login_snap_trade_user(user_id: user_id, user_secret: response.user_secret)
       puts redirect_uri
 
-      snaptrade.portfolio_management.create(user_id: user_id, user_secret: response.user_secret, id: SecureRandom.uuid, name: "MyPortfolio")
-      portfolios = snaptrade.portfolio_management.list(user_id: user_id, user_secret: response.user_secret)
-      puts portfolios
-
       # 5) Obtaining account holdings data
       holdings = snaptrade.account_information.get_all_user_holdings(user_id: user_id, user_secret: response.user_secret)
       puts holdings

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.12.0
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-22 00:00:00.000000000 Z
+date: 2023-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -163,7 +163,6 @@ files:
 - docs/PortfolioGroupInfo.md
 - docs/PortfolioGroupPosition.md
 - docs/PortfolioGroupSettings.md
-- docs/PortfolioManagementApi.md
 - docs/Position.md
 - docs/PositionSymbol.md
 - docs/RedirectTokenandPin.md
@@ -223,7 +222,6 @@ files:
 - lib/snaptrade/api/connections_api.rb
 - lib/snaptrade/api/error_logs_api.rb
 - lib/snaptrade/api/options_api.rb
-- lib/snaptrade/api/portfolio_management_api.rb
 - lib/snaptrade/api/reference_data_api.rb
 - lib/snaptrade/api/trading_api.rb
 - lib/snaptrade/api/transactions_and_reporting_api.rb
@@ -364,7 +362,6 @@ files:
 - spec/api/connections_api_spec.rb
 - spec/api/error_logs_api_spec.rb
 - spec/api/options_api_spec.rb
-- spec/api/portfolio_management_api_spec.rb
 - spec/api/reference_data_api_spec.rb
 - spec/api/trading_api_spec.rb
 - spec/api/transactions_and_reporting_api_spec.rb
@@ -524,7 +521,6 @@ specification_version: 4
 summary: SnapTrade Ruby Gem
 test_files:
 - spec/api/transactions_and_reporting_api_spec.rb
-- spec/api/portfolio_management_api_spec.rb
 - spec/api/options_api_spec.rb
 - spec/api/authentication_api_spec.rb
 - spec/api/error_logs_api_spec.rb