snaptrade 2.0.38 → 2.0.40

data/spec/api/trading_api_spec.rb

@@ -28,12 +28,12 @@ describe 'TradingApi' do
   end
 
   # unit tests for cancel_user_account_order
-  # Cancel open order in account
-  # Sends a signal to the brokerage to cancel the specified order. This will only work if the order has not yet been executed. 
+  # Cancel order
+  # Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected. 
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account to cancel the order in.
-  # @param trading_cancel_user_account_order_request The Order ID to be canceled
+  # @param account_id 
+  # @param trading_cancel_user_account_order_request 
   # @param [Hash] opts the optional parameters
   # @return [AccountOrderRecord]
   describe 'cancel_user_account_order test' do
@@ -43,8 +43,8 @@ describe 'TradingApi' do
   end
 
   # unit tests for get_order_impact
-  # Check the impact of a trade on an account
-  # Return the trade object and it's impact on the account for the specified order.
+  # Check order impact
+  # Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
   # @param user_id 
   # @param user_secret 
   # @param manual_trade_form 
@@ -58,13 +58,13 @@ describe 'TradingApi' do
 
   # unit tests for get_user_account_quotes
   # Get symbol quotes
-  # Returns quote(s) from the brokerage for the specified symbol(s).
+  # Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
   # @param user_id 
   # @param user_secret 
-  # @param symbols List of universal_symbol_id or tickers to get quotes for.
-  # @param account_id The ID of the account to get quotes.
+  # @param symbols List of Universal Symbol IDs or tickers to get quotes for.
+  # @param account_id 
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :use_ticker Should be set to True if providing tickers.
+  # @option opts [Boolean] :use_ticker Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.
   # @return [Array<SymbolsQuotesInner>]
   describe 'get_user_account_quotes test' do
     it 'should work' do
@@ -73,8 +73,8 @@ describe 'TradingApi' do
   end
 
   # unit tests for place_force_order
-  # Place a trade with NO validation.
-  # Places a specified trade in the specified account.
+  # Place order
+  # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It&#39;s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. 
   # @param user_id 
   # @param user_secret 
   # @param manual_trade_form 
@@ -87,9 +87,9 @@ describe 'TradingApi' do
   end
 
   # unit tests for place_order
-  # Place order
-  # Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage. 
-  # @param trade_id The ID of trade object obtained from trade/impact endpoint
+  # Place checked order
+  # Places the previously checked order with the brokerage. The &#x60;tradeId&#x60; is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).  It&#39;s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. 
+  # @param trade_id Obtained from calling the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact)
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

data/spec/models/manual_trade_form_spec.rb

@@ -32,37 +32,37 @@ describe SnapTrade::ManualTradeForm do
     end
   end
 
-  describe 'test attribute "order_type"' do
+  describe 'test attribute "universal_symbol_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 "price"' do
+  describe 'test attribute "order_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 "stop"' do
+  describe 'test attribute "time_in_force"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "time_in_force"' do
+  describe 'test attribute "price"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "units"' do
+  describe 'test attribute "stop"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "universal_symbol_id"' do
+  describe 'test attribute "units"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/models/manual_trade_impact_spec.rb

@@ -0,0 +1,53 @@
+=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::ManualTradeImpact
+describe SnapTrade::ManualTradeImpact do
+  let(:instance) { SnapTrade::ManualTradeImpact.new }
+
+  describe 'test an instance of ManualTradeImpact' do
+    it 'should create an instance of ManualTradeImpact' do
+      expect(instance).to be_instance_of(SnapTrade::ManualTradeImpact)
+    end
+  end
+  describe 'test attribute "account"' 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 "remaining_cash"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "estimated_commission"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "forex_fees"' 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/symbols_quotes_inner_spec.rb

@@ -26,19 +26,19 @@ describe SnapTrade::SymbolsQuotesInner do
     end
   end
 
-  describe 'test attribute "bid_price"' do
+  describe 'test attribute "last_trade_price"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "ask_price"' do
+  describe 'test attribute "bid_price"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "last_trade_price"' do
+  describe 'test attribute "ask_price"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.38
+  version: 2.0.40
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-21 00:00:00.000000000 Z
+date: 2024-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,6 +136,7 @@ files:
 - lib/snaptrade/models/manual_trade_balance.rb
 - lib/snaptrade/models/manual_trade_form.rb
 - lib/snaptrade/models/manual_trade_form_notional_value.rb
+- lib/snaptrade/models/manual_trade_impact.rb
 - lib/snaptrade/models/manual_trade_symbol.rb
 - lib/snaptrade/models/model400_failed_request_response.rb
 - lib/snaptrade/models/model401_failed_request_response.rb
@@ -257,6 +258,7 @@ files:
 - spec/models/manual_trade_balance_spec.rb
 - spec/models/manual_trade_form_notional_value_spec.rb
 - spec/models/manual_trade_form_spec.rb
+- spec/models/manual_trade_impact_spec.rb
 - spec/models/manual_trade_spec.rb
 - spec/models/manual_trade_symbol_spec.rb
 - spec/models/model400_failed_request_response_spec.rb
@@ -425,6 +427,7 @@ test_files:
 - spec/models/brokerage_authorization_refresh_confirmation_spec.rb
 - spec/models/options_symbol_spec.rb
 - spec/models/exchange_rate_pairs_spec.rb
+- spec/models/manual_trade_impact_spec.rb
 - spec/models/manual_trade_and_impact_spec.rb
 - spec/models/auth_type_spec.rb
 - spec/models/model500_unexpected_exception_response_spec.rb