snaptrade 2.0.38 → 2.0.39

data/lib/snaptrade/models/manual_trade_form.rb

@@ -11,29 +11,31 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Manual Trade Form
+  # Inputs for placing an order with the brokerage.
   class ManualTradeForm
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
     attr_accessor :account_id
 
-    # Trade Action
+    # The action describes the intent or side of a trade. This is either `BUY` or `SELL`
     attr_accessor :action
 
-    # Order Type
+    # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+    attr_accessor :universal_symbol_id
+
+    # The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required. 
     attr_accessor :order_type
 
-    # Trade Price if limit or stop limit order
+    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. 
+    attr_accessor :time_in_force
+
+    # The limit price for `Limit` and `StopLimit` orders.
     attr_accessor :price
 
-    # Stop Price. If stop loss or stop limit order, the price to trigger the stop
+    # The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
     attr_accessor :stop
 
-    # Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled 
-    attr_accessor :time_in_force
-
     attr_accessor :units
 
-    attr_accessor :universal_symbol_id
-
     attr_accessor :notional_value
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -41,12 +43,12 @@ module SnapTrade
       {
         :'account_id' => :'account_id',
         :'action' => :'action',
+        :'universal_symbol_id' => :'universal_symbol_id',
         :'order_type' => :'order_type',
+        :'time_in_force' => :'time_in_force',
         :'price' => :'price',
         :'stop' => :'stop',
-        :'time_in_force' => :'time_in_force',
         :'units' => :'units',
-        :'universal_symbol_id' => :'universal_symbol_id',
         :'notional_value' => :'notional_value'
       }
     end
@@ -61,12 +63,12 @@ module SnapTrade
       {
         :'account_id' => :'String',
         :'action' => :'ActionStrict',
+        :'universal_symbol_id' => :'String',
         :'order_type' => :'OrderTypeStrict',
+        :'time_in_force' => :'TimeInForceStrict',
         :'price' => :'Float',
         :'stop' => :'Float',
-        :'time_in_force' => :'TimeInForceStrict',
         :'units' => :'Float',
-        :'universal_symbol_id' => :'String',
         :'notional_value' => :'ManualTradeFormNotionalValue'
       }
     end
@@ -104,10 +106,18 @@ module SnapTrade
         self.action = attributes[:'action']
       end
 
+      if attributes.key?(:'universal_symbol_id')
+        self.universal_symbol_id = attributes[:'universal_symbol_id']
+      end
+
       if attributes.key?(:'order_type')
         self.order_type = attributes[:'order_type']
       end
 
+      if attributes.key?(:'time_in_force')
+        self.time_in_force = attributes[:'time_in_force']
+      end
+
       if attributes.key?(:'price')
         self.price = attributes[:'price']
       end
@@ -116,18 +126,10 @@ module SnapTrade
         self.stop = attributes[:'stop']
       end
 
-      if attributes.key?(:'time_in_force')
-        self.time_in_force = attributes[:'time_in_force']
-      end
-
       if attributes.key?(:'units')
         self.units = attributes[:'units']
       end
 
-      if attributes.key?(:'universal_symbol_id')
-        self.universal_symbol_id = attributes[:'universal_symbol_id']
-      end
-
       if attributes.key?(:'notional_value')
         self.notional_value = attributes[:'notional_value']
       end
@@ -137,12 +139,37 @@ module SnapTrade
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @action.nil?
+        invalid_properties.push('invalid value for "action", action cannot be nil.')
+      end
+
+      if @universal_symbol_id.nil?
+        invalid_properties.push('invalid value for "universal_symbol_id", universal_symbol_id cannot be nil.')
+      end
+
+      if @order_type.nil?
+        invalid_properties.push('invalid value for "order_type", order_type cannot be nil.')
+      end
+
+      if @time_in_force.nil?
+        invalid_properties.push('invalid value for "time_in_force", time_in_force cannot be nil.')
+      end
+
       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?
+      return false if @account_id.nil?
+      return false if @action.nil?
+      return false if @universal_symbol_id.nil?
+      return false if @order_type.nil?
+      return false if @time_in_force.nil?
       true
     end
 
@@ -153,12 +180,12 @@ module SnapTrade
       self.class == o.class &&
           account_id == o.account_id &&
           action == o.action &&
+          universal_symbol_id == o.universal_symbol_id &&
           order_type == o.order_type &&
+          time_in_force == o.time_in_force &&
           price == o.price &&
           stop == o.stop &&
-          time_in_force == o.time_in_force &&
           units == o.units &&
-          universal_symbol_id == o.universal_symbol_id &&
           notional_value == o.notional_value
     end
 
@@ -171,7 +198,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, action, order_type, price, stop, time_in_force, units, universal_symbol_id, notional_value].hash
+      [account_id, action, universal_symbol_id, order_type, time_in_force, price, stop, units, notional_value].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/manual_trade_impact.rb

@@ -0,0 +1,260 @@
+=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
+  class ManualTradeImpact
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
+    attr_accessor :account
+
+    # Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
+    attr_accessor :currency
+
+    # Estimated amount of cash remaining in the account after the trade.
+    attr_accessor :remaining_cash
+
+    # Estimated commission for the trade.
+    attr_accessor :estimated_commission
+
+    # Estimated foreign transaction fees for the trade.
+    attr_accessor :forex_fees
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account' => :'account',
+        :'currency' => :'currency',
+        :'remaining_cash' => :'remaining_cash',
+        :'estimated_commission' => :'estimated_commission',
+        :'forex_fees' => :'forex_fees'
+      }
+    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
+      {
+        :'account' => :'String',
+        :'currency' => :'String',
+        :'remaining_cash' => :'Float',
+        :'estimated_commission' => :'Float',
+        :'forex_fees' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'remaining_cash',
+        :'estimated_commission',
+        :'forex_fees'
+      ])
+    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::ManualTradeImpact` 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::ManualTradeImpact`. 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?(:'account')
+        self.account = attributes[:'account']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'remaining_cash')
+        self.remaining_cash = attributes[:'remaining_cash']
+      end
+
+      if attributes.key?(:'estimated_commission')
+        self.estimated_commission = attributes[:'estimated_commission']
+      end
+
+      if attributes.key?(:'forex_fees')
+        self.forex_fees = attributes[:'forex_fees']
+      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 &&
+          account == o.account &&
+          currency == o.currency &&
+          remaining_cash == o.remaining_cash &&
+          estimated_commission == o.estimated_commission &&
+          forex_fees == o.forex_fees
+    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
+      [account, currency, remaining_cash, estimated_commission, forex_fees].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/lib/snaptrade/models/manual_trade_symbol.rb

@@ -11,18 +11,23 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Manual trade symbol object
+  # Information about the security for the order.
   class ManualTradeSymbol
+    # 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 :brokerage_symbol_id
 
+    # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
     attr_accessor :universal_symbol_id
 
     attr_accessor :currency
 
+    # This field is deprecated and should not be used.
     attr_accessor :local_id
 
+    # This field is deprecated and should not be used.
     attr_accessor :description
 
+    # This field is deprecated and should not be used.
     attr_accessor :symbol
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/notional_value.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Dollar amount to trade. Cannot work with units. Can only work for market order types and day for time in force. **Only available for Alpaca, Alpaca Paper, and Robinhood.**
+  # Total notional amount for the order. Must be `null` if `units` is provided. Can only work with `Market` for `order_type` and `Day` for `time_in_force`. This is only available for certain brokerages. Please check the [integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=e7bbcbf9f272441593f93decde660687) for more information.
   module NotionalValue
     class << self
       # List of class defined in oneOf (OpenAPI v3)

data/lib/snaptrade/models/options_place_option_strategy_request.rb

@@ -12,10 +12,10 @@ require 'time'
 
 module SnapTrade
   class OptionsPlaceOptionStrategyRequest
-    # Order Type
+    # The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required. 
     attr_accessor :order_type
 
-    # Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled 
+    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. 
     attr_accessor :time_in_force
 
     # Trade Price if limit or stop limit order

data/lib/snaptrade/models/symbols_quotes_inner.rb

@@ -14,23 +14,28 @@ module SnapTrade
   class SymbolsQuotesInner
     attr_accessor :symbol
 
+    # The most recent trade price from the brokerage.
+    attr_accessor :last_trade_price
+
+    # The most recent bid price from the brokerage.
     attr_accessor :bid_price
 
+    # The most recent price from the brokerage.
     attr_accessor :ask_price
 
-    attr_accessor :last_trade_price
-
+    # The most recent bid size from the brokerage.
     attr_accessor :bid_size
 
+    # The most recent ask size from the brokerage.
     attr_accessor :ask_size
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'symbol' => :'symbol',
+        :'last_trade_price' => :'last_trade_price',
         :'bid_price' => :'bid_price',
         :'ask_price' => :'ask_price',
-        :'last_trade_price' => :'last_trade_price',
         :'bid_size' => :'bid_size',
         :'ask_size' => :'ask_size'
       }
@@ -45,9 +50,9 @@ module SnapTrade
     def self.openapi_types
       {
         :'symbol' => :'UniversalSymbol',
+        :'last_trade_price' => :'Float',
         :'bid_price' => :'Float',
         :'ask_price' => :'Float',
-        :'last_trade_price' => :'Float',
         :'bid_size' => :'Float',
         :'ask_size' => :'Float'
       }
@@ -78,6 +83,10 @@ module SnapTrade
         self.symbol = attributes[:'symbol']
       end
 
+      if attributes.key?(:'last_trade_price')
+        self.last_trade_price = attributes[:'last_trade_price']
+      end
+
       if attributes.key?(:'bid_price')
         self.bid_price = attributes[:'bid_price']
       end
@@ -86,10 +95,6 @@ module SnapTrade
         self.ask_price = attributes[:'ask_price']
       end
 
-      if attributes.key?(:'last_trade_price')
-        self.last_trade_price = attributes[:'last_trade_price']
-      end
-
       if attributes.key?(:'bid_size')
         self.bid_size = attributes[:'bid_size']
       end
@@ -118,9 +123,9 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           symbol == o.symbol &&
+          last_trade_price == o.last_trade_price &&
           bid_price == o.bid_price &&
           ask_price == o.ask_price &&
-          last_trade_price == o.last_trade_price &&
           bid_size == o.bid_size &&
           ask_size == o.ask_size
     end
@@ -134,7 +139,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, bid_price, ask_price, last_trade_price, bid_size, ask_size].hash
+      [symbol, last_trade_price, bid_price, ask_price, bid_size, ask_size].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/trading_cancel_user_account_order_request.rb

@@ -12,6 +12,7 @@ require 'time'
 
 module SnapTrade
   class TradingCancelUserAccountOrderRequest
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
     attr_accessor :brokerage_order_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/validated_trade_body.rb

@@ -11,9 +11,8 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Validated Trade Form
   class ValidatedTradeBody
-    # Optional, defaults to true. Determines if a wait is performed to check on order status. If false, latency will be reduced but orders returned will be more likely to be of status PENDING as we will not wait to check on the status before responding to the request
+    # Optional, defaults to true. Determines if a wait is performed to check on order status. If false, latency will be reduced but orders returned will be more likely to be of status `PENDING` as we will not wait to check on the status before responding to the request.
     attr_accessor :wait_to_confirm
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/version.rb

@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '2.0.38'
+  VERSION = '2.0.39'
 end

data/lib/snaptrade.rb

@@ -57,6 +57,7 @@ require 'snaptrade/models/manual_trade_and_impact'
 require 'snaptrade/models/manual_trade_balance'
 require 'snaptrade/models/manual_trade_form'
 require 'snaptrade/models/manual_trade_form_notional_value'
+require 'snaptrade/models/manual_trade_impact'
 require 'snaptrade/models/manual_trade_symbol'
 require 'snaptrade/models/model400_failed_request_response'
 require 'snaptrade/models/model401_failed_request_response'

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). 
   # @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). 
+  # @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