snaptrade 1.17.9 → 1.17.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01d2791faf8d79c80e2736f81825f3a61d0633de757bfbbc9f8b151612d2efb3
-  data.tar.gz: b4c5c2dced52d4e8fce5824d84e3b2e6771544f3dba0c7629f48f54ab5f40a03
+  metadata.gz: 89a20280d9b851518ff6cb3d0de7d9da7e10ca979110d76bde7d65ded8b3cea0
+  data.tar.gz: 8777f7b671a47885513f3e26dbe3952590e37f95dbfb2700582bf747a29926a5
 SHA512:
-  metadata.gz: 276386e7e7e23442b73b0ae0de07d312cc7f9ebcc361570e2645643c2547a50579f23738d669a14e15eb7e1f2630b1541ed2c8139e5f55280c6755b9076dda30
-  data.tar.gz: 1a81481605ab5e5eae527cc97c3c927d48ba238a850ccff718f13cc7694216d24a8650398948b845f713eed9ef1a457999a3b10ef61bc0585dd301345d77c725
+  metadata.gz: 4386f8003ff97d7572b654cab71a0fed781bd470d021e9f0fa1d5f89bcdad6fa907d22c2c03b4a21e9c05679cdc43c5f21963727073e43025fce0a0057dca059
+  data.tar.gz: d02afd9d1eccb3f8ccf03a8e6271874e7e73e50d6ce08ce7e433a8151e2abcbe23570a49b27bf6efcb5c5d09cdd25a2ffc00eb894413a4af224c351b84fedaaf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (1.17.8)
+    snaptrade (1.17.10)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

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.9'
+gem 'snaptrade', '~> 1.17.11'
 ```
 
 ## Getting Started

data/docs/AccountOrderRecord.md

@@ -10,7 +10,7 @@
 | **universal_symbol** | [**UniversalSymbol**](UniversalSymbol.md) |  | [optional] |
 | **option_symbol** | [**OptionsSymbol**](OptionsSymbol.md) |  | [optional] |
 | **action** | [**Action**](Action.md) |  | [optional] |
-| **total_quantity** | **Float** | Trade Units | [optional] |
+| **total_quantity** | **Float** | Trade Units. Cannot work with notional value. | [optional] |
 | **open_quantity** | **Float** | Trade Units | [optional] |
 | **canceled_quantity** | **Float** | Trade Units | [optional] |
 | **filled_quantity** | **Float** | Trade Units | [optional] |

data/docs/ManualTrade.md

@@ -10,7 +10,7 @@
 | **time_in_force** | [**TimeInForce**](TimeInForce.md) |  | [optional] |
 | **symbol** | [**ManualTradeSymbol**](ManualTradeSymbol.md) |  | [optional] |
 | **action** | [**Action**](Action.md) |  | [optional] |
-| **units** | **Float** | Trade Units | [optional] |
+| **units** | **Float** | Trade Units. Cannot work with notional value. | [optional] |
 | **price** | **Float** | Trade Price if limit or stop limit order | [optional] |
 
 ## Example

data/docs/ManualTradeForm.md

@@ -10,8 +10,9 @@
 | **price** | **Float** | Trade Price if limit or stop limit order | [optional] |
 | **stop** | **Float** | Stop Price. If stop loss or stop limit order, the price to trigger the stop | [optional] |
 | **time_in_force** | [**TimeInForce**](TimeInForce.md) |  | [optional] |
-| **units** | **Float** | Trade Units | [optional] |
+| **units** | **Float** | Trade Units. Cannot work with notional value. | [optional] |
 | **universal_symbol_id** | **String** |  | [optional] |
+| **notional_value** | **Float** | 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 and Alpaca Paper. Please contact support to get access to place notional trades** | [optional] |
 
 ## Example
 
@@ -26,7 +27,8 @@ instance = SnapTrade::ManualTradeForm.new(
   stop: 31.33,
   time_in_force: null,
   units: null,
-  universal_symbol_id: 2bcd7cc3-e922-4976-bce1-9858296801c3
+  universal_symbol_id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
+  notional_value: 100
 )
 ```
 

data/docs/TradingApi.md

@@ -103,6 +103,7 @@ stop = 31.33
 time_in_force = "Day"
 units = 3.14
 universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
+notional_value = 100
 
 begin
   # Check impact of trades on account.
@@ -117,6 +118,7 @@ begin
                                                   time_in_force: time_in_force,
                                                   units: units,
                                                   universal_symbol_id: universal_symbol_id,
+                                                  notional_value: notional_value,
                                                 )
   p result
 rescue SnapTrade::ApiError => e
@@ -139,6 +141,7 @@ stop = 31.33
 time_in_force = "Day"
 units = 3.14
 universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
+notional_value = 100
 
 begin
   # Check impact of trades on account.
@@ -153,6 +156,7 @@ begin
                                                                                                time_in_force: time_in_force,
                                                                                                units: units,
                                                                                                universal_symbol_id: universal_symbol_id,
+                                                                                               notional_value: notional_value,
                                                                                              )
   p status_code # => 2xx
   p headers # => { ... }
@@ -271,6 +275,7 @@ stop = 31.33
 time_in_force = "Day"
 units = 3.14
 universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
+notional_value = 100
 
 begin
   # Place a trade with NO validation.
@@ -285,6 +290,7 @@ begin
                                                    time_in_force: time_in_force,
                                                    units: units,
                                                    universal_symbol_id: universal_symbol_id,
+                                                   notional_value: notional_value,
                                                  )
   p result
 rescue SnapTrade::ApiError => e
@@ -307,6 +313,7 @@ stop = 31.33
 time_in_force = "Day"
 units = 3.14
 universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
+notional_value = 100
 
 begin
   # Place a trade with NO validation.
@@ -321,6 +328,7 @@ begin
                                                                                                 time_in_force: time_in_force,
                                                                                                 units: units,
                                                                                                 universal_symbol_id: universal_symbol_id,
+                                                                                                notional_value: notional_value,
                                                                                               )
   p status_code # => 2xx
   p headers # => { ... }

data/lib/snaptrade/api/trading_api.rb

@@ -143,11 +143,12 @@ module SnapTrade
     # @param price [Float] Trade Price if limit or stop limit order
     # @param stop [Float] Stop Price. If stop loss or stop limit order, the price to trigger the stop
     # @param time_in_force [TimeInForce] 
-    # @param units [Float] Trade Units
+    # @param units [Float] Trade Units. Cannot work with notional value.
     # @param universal_symbol_id [String] 
+    # @param notional_value [Float] 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 and Alpaca Paper. Please contact support to get access to place notional trades**
     # @param body [ManualTradeForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_order_impact(user_id:, user_secret:, account_id: SENTINEL, action: SENTINEL, order_type: SENTINEL, price: SENTINEL, stop: SENTINEL, time_in_force: SENTINEL, units: SENTINEL, universal_symbol_id: SENTINEL, extra: {})
+    def get_order_impact(user_id:, user_secret:, account_id: SENTINEL, action: SENTINEL, order_type: SENTINEL, price: SENTINEL, stop: SENTINEL, time_in_force: SENTINEL, units: SENTINEL, universal_symbol_id: SENTINEL, notional_value: SENTINEL, extra: {})
       _body = {}
       _body[:account_id] = account_id if account_id != SENTINEL
       _body[:action] = action if action != SENTINEL
@@ -157,6 +158,7 @@ module SnapTrade
       _body[:time_in_force] = time_in_force if time_in_force != SENTINEL
       _body[:units] = units if units != SENTINEL
       _body[:universal_symbol_id] = universal_symbol_id if universal_symbol_id != SENTINEL
+      _body[:notional_value] = notional_value if notional_value != SENTINEL
       manual_trade_form = _body
       data, _status_code, _headers = get_order_impact_with_http_info_impl(user_id, user_secret, manual_trade_form, extra)
       data
@@ -171,11 +173,12 @@ module SnapTrade
     # @param price [Float] Trade Price if limit or stop limit order
     # @param stop [Float] Stop Price. If stop loss or stop limit order, the price to trigger the stop
     # @param time_in_force [TimeInForce] 
-    # @param units [Float] Trade Units
+    # @param units [Float] Trade Units. Cannot work with notional value.
     # @param universal_symbol_id [String] 
+    # @param notional_value [Float] 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 and Alpaca Paper. Please contact support to get access to place notional trades**
     # @param body [ManualTradeForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_order_impact_with_http_info(user_id:, user_secret:, account_id: SENTINEL, action: SENTINEL, order_type: SENTINEL, price: SENTINEL, stop: SENTINEL, time_in_force: SENTINEL, units: SENTINEL, universal_symbol_id: SENTINEL, extra: {})
+    def get_order_impact_with_http_info(user_id:, user_secret:, account_id: SENTINEL, action: SENTINEL, order_type: SENTINEL, price: SENTINEL, stop: SENTINEL, time_in_force: SENTINEL, units: SENTINEL, universal_symbol_id: SENTINEL, notional_value: SENTINEL, extra: {})
       _body = {}
       _body[:account_id] = account_id if account_id != SENTINEL
       _body[:action] = action if action != SENTINEL
@@ -185,6 +188,7 @@ module SnapTrade
       _body[:time_in_force] = time_in_force if time_in_force != SENTINEL
       _body[:units] = units if units != SENTINEL
       _body[:universal_symbol_id] = universal_symbol_id if universal_symbol_id != SENTINEL
+      _body[:notional_value] = notional_value if notional_value != SENTINEL
       manual_trade_form = _body
       get_order_impact_with_http_info_impl(user_id, user_secret, manual_trade_form, extra)
     end
@@ -390,11 +394,12 @@ module SnapTrade
     # @param price [Float] Trade Price if limit or stop limit order
     # @param stop [Float] Stop Price. If stop loss or stop limit order, the price to trigger the stop
     # @param time_in_force [TimeInForce] 
-    # @param units [Float] Trade Units
+    # @param units [Float] Trade Units. Cannot work with notional value.
     # @param universal_symbol_id [String] 
+    # @param notional_value [Float] 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 and Alpaca Paper. Please contact support to get access to place notional trades**
     # @param body [ManualTradeForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def place_force_order(user_id:, user_secret:, account_id: SENTINEL, action: SENTINEL, order_type: SENTINEL, price: SENTINEL, stop: SENTINEL, time_in_force: SENTINEL, units: SENTINEL, universal_symbol_id: SENTINEL, extra: {})
+    def place_force_order(user_id:, user_secret:, account_id: SENTINEL, action: SENTINEL, order_type: SENTINEL, price: SENTINEL, stop: SENTINEL, time_in_force: SENTINEL, units: SENTINEL, universal_symbol_id: SENTINEL, notional_value: SENTINEL, extra: {})
       _body = {}
       _body[:account_id] = account_id if account_id != SENTINEL
       _body[:action] = action if action != SENTINEL
@@ -404,6 +409,7 @@ module SnapTrade
       _body[:time_in_force] = time_in_force if time_in_force != SENTINEL
       _body[:units] = units if units != SENTINEL
       _body[:universal_symbol_id] = universal_symbol_id if universal_symbol_id != SENTINEL
+      _body[:notional_value] = notional_value if notional_value != SENTINEL
       manual_trade_form = _body
       data, _status_code, _headers = place_force_order_with_http_info_impl(user_id, user_secret, manual_trade_form, extra)
       data
@@ -418,11 +424,12 @@ module SnapTrade
     # @param price [Float] Trade Price if limit or stop limit order
     # @param stop [Float] Stop Price. If stop loss or stop limit order, the price to trigger the stop
     # @param time_in_force [TimeInForce] 
-    # @param units [Float] Trade Units
+    # @param units [Float] Trade Units. Cannot work with notional value.
     # @param universal_symbol_id [String] 
+    # @param notional_value [Float] 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 and Alpaca Paper. Please contact support to get access to place notional trades**
     # @param body [ManualTradeForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def place_force_order_with_http_info(user_id:, user_secret:, account_id: SENTINEL, action: SENTINEL, order_type: SENTINEL, price: SENTINEL, stop: SENTINEL, time_in_force: SENTINEL, units: SENTINEL, universal_symbol_id: SENTINEL, extra: {})
+    def place_force_order_with_http_info(user_id:, user_secret:, account_id: SENTINEL, action: SENTINEL, order_type: SENTINEL, price: SENTINEL, stop: SENTINEL, time_in_force: SENTINEL, units: SENTINEL, universal_symbol_id: SENTINEL, notional_value: SENTINEL, extra: {})
       _body = {}
       _body[:account_id] = account_id if account_id != SENTINEL
       _body[:action] = action if action != SENTINEL
@@ -432,6 +439,7 @@ module SnapTrade
       _body[:time_in_force] = time_in_force if time_in_force != SENTINEL
       _body[:units] = units if units != SENTINEL
       _body[:universal_symbol_id] = universal_symbol_id if universal_symbol_id != SENTINEL
+      _body[:notional_value] = notional_value if notional_value != SENTINEL
       manual_trade_form = _body
       place_force_order_with_http_info_impl(user_id, user_secret, manual_trade_form, extra)
     end

data/lib/snaptrade/models/account_order_record.rb

@@ -27,7 +27,7 @@ module SnapTrade
 
     attr_accessor :action
 
-    # Trade Units
+    # Trade Units. Cannot work with notional value.
     attr_accessor :total_quantity
 
     # Trade Units

data/lib/snaptrade/models/manual_trade.rb

@@ -26,7 +26,7 @@ module SnapTrade
 
     attr_accessor :action
 
-    # Trade Units
+    # Trade Units. Cannot work with notional value.
     attr_accessor :units
 
     # Trade Price if limit or stop limit order

data/lib/snaptrade/models/manual_trade_form.rb

@@ -28,11 +28,14 @@ module SnapTrade
 
     attr_accessor :time_in_force
 
-    # Trade Units
+    # Trade Units. Cannot work with notional value.
     attr_accessor :units
 
     attr_accessor :universal_symbol_id
 
+    # 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 and Alpaca Paper. Please contact support to get access to place notional trades**
+    attr_accessor :notional_value
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -43,7 +46,8 @@ module SnapTrade
         :'stop' => :'stop',
         :'time_in_force' => :'time_in_force',
         :'units' => :'units',
-        :'universal_symbol_id' => :'universal_symbol_id'
+        :'universal_symbol_id' => :'universal_symbol_id',
+        :'notional_value' => :'notional_value'
       }
     end
 
@@ -62,7 +66,8 @@ module SnapTrade
         :'stop' => :'Float',
         :'time_in_force' => :'TimeInForce',
         :'units' => :'Float',
-        :'universal_symbol_id' => :'String'
+        :'universal_symbol_id' => :'String',
+        :'notional_value' => :'Float'
       }
     end
 
@@ -71,6 +76,7 @@ module SnapTrade
       Set.new([
         :'price',
         :'stop',
+        :'notional_value'
       ])
     end
 
@@ -120,6 +126,10 @@ module SnapTrade
       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
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -147,7 +157,8 @@ module SnapTrade
           stop == o.stop &&
           time_in_force == o.time_in_force &&
           units == o.units &&
-          universal_symbol_id == o.universal_symbol_id
+          universal_symbol_id == o.universal_symbol_id &&
+          notional_value == o.notional_value
     end
 
     # @see the `==` method
@@ -159,7 +170,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].hash
+      [account_id, action, order_type, price, stop, time_in_force, units, universal_symbol_id, notional_value].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.9'
+  VERSION = '1.17.11'
 end

data/spec/models/manual_trade_form_spec.rb

@@ -69,4 +69,10 @@ describe SnapTrade::ManualTradeForm do
     end
   end
 
+  describe 'test attribute "notional_value"' 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.9
+  version: 1.17.11
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday