snaptrade 2.0.46 → 2.0.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad410e9797ab8548703fad8a08b7e34920cc9974c00cb44ee54d8681b4e6ff2c
-  data.tar.gz: 0e64452afe9ae886bb7c7b3fa2c8a7ac1944a9ac04a732287c8482469d00ad2a
+  metadata.gz: 4480346bca60bdd984cd30d296f1771142e6ee150ee552ea2c8170c83c901190
+  data.tar.gz: 7d8fcce4f0080e3bb5d96ae58f6f3a02085303383438bf59a9ae8ce891c163cd
 SHA512:
-  metadata.gz: 06b623297535ae862a8263d04cbfff9fe75f460a795232514e9b7b0c45135100eea4587049acd077b314cfb35a6366eb5acbc6531240975bd237b835933ea3ea
-  data.tar.gz: 2d49ab16055c6ef88705a6a03c596924b3d86d2507ca22fb88de8e3c65ad0c221402a476a3307adc452d38670af6176da12393f1e1f7019b263ad7abd64cd6de
+  metadata.gz: 9dcfa495dc6502ad7cd2250e877b369121a0e6a91d2fb1335c005147f9ac52dcd1bb2d7b136d427fbc5b7785d6b457bfa6291070b5be5b49f3afb654d5e599ce
+  data.tar.gz: a654f8a16d185b35b579ff32c2b6d8a6a18603d7f14829aeee80a04721a05935d4a1070d20956b5d3331ba33bce843135289b078a5bb5e3b04799fe2dd210d0a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.46)
+    snaptrade (2.0.48)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -44,7 +44,7 @@ GEM
     regexp_parser (2.9.2)
     reline (0.5.10)
       io-console (~> 0.5)
-    rexml (3.3.7)
+    rexml (3.3.8)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -54,7 +54,7 @@ GEM
     rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)

data/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/gem-v2.0.46-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.46)
+[![npm](https://img.shields.io/badge/gem-v2.0.48-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.48)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -70,7 +70,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.46'
+gem 'snaptrade', '~> 2.0.48'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1436,7 +1436,7 @@ reference the account in SnapTrade.
 
 ##### action: [`ActionStrict`](./lib/snaptrade/models/action_strict.rb)<a id="action-actionstrictlibsnaptrademodelsaction_strictrb"></a>
 The action describes the intent or side of a trade. This is either `BUY` or
-`SELL`
+`SELL`.
 
 ##### universal_symbol_id: `String`<a id="universal_symbol_id-string"></a>
 Unique identifier for the symbol within SnapTrade. This is the ID used to
@@ -1535,11 +1535,12 @@ It's recommended to trigger a manual refresh of the account after placing an ord
 result = snaptrade.trading.place_force_order(
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   action: "BUY",
-  universal_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   order_type: "Market",
   time_in_force: "FOK",
   user_id: "snaptrade-user-123",
   user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+  universal_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+  symbol: "AAPL  131124C00240000",
   price: 31.33,
   stop: 31.33,
   units: 10.5,
@@ -1554,13 +1555,10 @@ p result
 Unique identifier for the connected brokerage account. This is the UUID used to
 reference the account in SnapTrade.
 
-##### action: [`ActionStrict`](./lib/snaptrade/models/action_strict.rb)<a id="action-actionstrictlibsnaptrademodelsaction_strictrb"></a>
+##### action: [`ActionStrictWithOptions`](./lib/snaptrade/models/action_strict_with_options.rb)<a id="action-actionstrictwithoptionslibsnaptrademodelsaction_strict_with_optionsrb"></a>
 The action describes the intent or side of a trade. This is either `BUY` or
-`SELL`
-
-##### universal_symbol_id: `String`<a id="universal_symbol_id-string"></a>
-Unique identifier for the symbol within SnapTrade. This is the ID used to
-reference the symbol in SnapTrade API calls.
+`SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or
+`SELL_TO_CLOSE` for Options.
 
 ##### order_type: [`OrderTypeStrict`](./lib/snaptrade/models/order_type_strict.rb)<a id="order_type-ordertypestrictlibsnaptrademodelsorder_type_strictrb"></a>
 The type of order to place. - For `Limit` and `StopLimit` orders, the `price`
@@ -1577,6 +1575,18 @@ immediately or be canceled completely.
 
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
+##### universal_symbol_id: [`String`](./lib/snaptrade/models/string.rb)<a id="universal_symbol_id-stringlibsnaptrademodelsstringrb"></a>
+The universal symbol ID of the security to trade. Must be 'null' if `symbol` is
+provided, otherwise must be provided.
+
+##### symbol: `String`<a id="symbol-string"></a>
+The security's trading ticker symbol. This currently only support Options
+symbols in the 21 character OCC format. For example \"AAPL 131124C00240000\"
+represents a call option on AAPL expiring on 2024-11-13 with a strike price of
+$240. For more information on the OCC format, see
+[here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format). If 'symbol' is
+provided, then 'universal_symbol_id' must be 'null'.
+
 ##### price: `Float`<a id="price-float"></a>
 The limit price for `Limit` and `StopLimit` orders.
 
@@ -1584,6 +1594,11 @@ The limit price for `Limit` and `StopLimit` orders.
 The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
 
 ##### units: [`Float`](./lib/snaptrade/models/float.rb)<a id="units-floatlibsnaptrademodelsfloatrb"></a>
+For Equity orders, this represents the number of shares for the order. This can
+be a decimal for fractional orders. Must be `null` if `notional_value` is
+provided. If placing an Option order, this field represents the number of
+contracts to buy or sell. (e.g., 1 contract = 100 shares).
+
 ##### notional_value: [`ManualTradeFormNotionalValue`](./lib/snaptrade/models/manual_trade_form_notional_value.rb)<a id="notional_value-manualtradeformnotionalvaluelibsnaptrademodelsmanual_trade_form_notional_valuerb"></a>
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -1701,7 +1716,9 @@ values. Here are some of the most popular values: - `BUY` - Asset bought. -
 `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash
 contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment.
 - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from
-the account.
+the account. - `OPTIONEXPIRATION` - Option expiration event. -
+`OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option
+exercise event.
 
 #### 🔄 Return<a id="🔄-return"></a>
 

data/lib/snaptrade/api/trading_api.rb

@@ -146,7 +146,7 @@ module SnapTrade
     # 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 account_id [String] Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
-    # @param action [ActionStrict] The action describes the intent or side of a trade. This is either `BUY` or `SELL`
+    # @param action [ActionStrict] The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
     # @param universal_symbol_id [String] Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
     # @param order_type [OrderTypeStrict] 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. 
     # @param time_in_force [TimeInForceStrict] 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. 
@@ -179,7 +179,7 @@ module SnapTrade
     # 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 account_id [String] Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
-    # @param action [ActionStrict] The action describes the intent or side of a trade. This is either `BUY` or `SELL`
+    # @param action [ActionStrict] The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
     # @param universal_symbol_id [String] Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
     # @param order_type [OrderTypeStrict] 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. 
     # @param time_in_force [TimeInForceStrict] 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. 
@@ -417,31 +417,33 @@ module SnapTrade
     # It'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 account_id [String] Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
-    # @param action [ActionStrict] The action describes the intent or side of a trade. This is either `BUY` or `SELL`
-    # @param universal_symbol_id [String] Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+    # @param action [ActionStrictWithOptions] The action describes the intent or side of a trade. This is either `BUY` or `SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or `SELL_TO_CLOSE` for Options.
     # @param order_type [OrderTypeStrict] 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. 
     # @param time_in_force [TimeInForceStrict] 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. 
     # @param user_id [String] 
     # @param user_secret [String] 
+    # @param universal_symbol_id [String] The universal symbol ID of the security to trade. Must be 'null' if `symbol` is provided, otherwise must be provided.
+    # @param symbol [String] The security's trading ticker symbol. This currently only support Options symbols in the 21 character OCC format. For example \"AAPL 131124C00240000\" represents a call option on AAPL expiring on 2024-11-13 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format). If 'symbol' is provided, then 'universal_symbol_id' must be 'null'.
     # @param price [Float] The limit price for `Limit` and `StopLimit` orders.
     # @param stop [Float] The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
-    # @param units [Float] 
+    # @param units [Float] For Equity orders, this represents the number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided. If placing an Option order, this field represents the number of contracts to buy or sell. (e.g., 1 contract = 100 shares).
     # @param notional_value [ManualTradeFormNotionalValue] 
-    # @param body [ManualTradeForm] 
+    # @param body [ManualTradeFormWithOptions] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def place_force_order(account_id:, action:, universal_symbol_id:, order_type:, time_in_force:, user_id:, user_secret:, price: SENTINEL, stop: SENTINEL, units: SENTINEL, notional_value: SENTINEL, extra: {})
+    def place_force_order(account_id:, action:, order_type:, time_in_force:, user_id:, user_secret:, universal_symbol_id: SENTINEL, symbol: SENTINEL, price: SENTINEL, stop: SENTINEL, units: SENTINEL, notional_value: SENTINEL, extra: {})
       _body = {}
       _body[:account_id] = account_id if account_id != SENTINEL
       _body[:action] = action if action != SENTINEL
       _body[:universal_symbol_id] = universal_symbol_id if universal_symbol_id != SENTINEL
+      _body[:symbol] = symbol if symbol != SENTINEL
       _body[:order_type] = order_type if order_type != SENTINEL
       _body[:time_in_force] = time_in_force if time_in_force != SENTINEL
       _body[:price] = price if price != SENTINEL
       _body[:stop] = stop if stop != SENTINEL
       _body[:units] = units if units != 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)
+      manual_trade_form_with_options = _body
+      data, _status_code, _headers = place_force_order_with_http_info_impl(user_id, user_secret, manual_trade_form_with_options, extra)
       data
     end
 
@@ -454,42 +456,44 @@ module SnapTrade
     # It'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 account_id [String] Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
-    # @param action [ActionStrict] The action describes the intent or side of a trade. This is either `BUY` or `SELL`
-    # @param universal_symbol_id [String] Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+    # @param action [ActionStrictWithOptions] The action describes the intent or side of a trade. This is either `BUY` or `SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or `SELL_TO_CLOSE` for Options.
     # @param order_type [OrderTypeStrict] 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. 
     # @param time_in_force [TimeInForceStrict] 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. 
     # @param user_id [String] 
     # @param user_secret [String] 
+    # @param universal_symbol_id [String] The universal symbol ID of the security to trade. Must be 'null' if `symbol` is provided, otherwise must be provided.
+    # @param symbol [String] The security's trading ticker symbol. This currently only support Options symbols in the 21 character OCC format. For example \"AAPL 131124C00240000\" represents a call option on AAPL expiring on 2024-11-13 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format). If 'symbol' is provided, then 'universal_symbol_id' must be 'null'.
     # @param price [Float] The limit price for `Limit` and `StopLimit` orders.
     # @param stop [Float] The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
-    # @param units [Float] 
+    # @param units [Float] For Equity orders, this represents the number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided. If placing an Option order, this field represents the number of contracts to buy or sell. (e.g., 1 contract = 100 shares).
     # @param notional_value [ManualTradeFormNotionalValue] 
-    # @param body [ManualTradeForm] 
+    # @param body [ManualTradeFormWithOptions] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def place_force_order_with_http_info(account_id:, action:, universal_symbol_id:, order_type:, time_in_force:, user_id:, user_secret:, price: SENTINEL, stop: SENTINEL, units: SENTINEL, notional_value: SENTINEL, extra: {})
+    def place_force_order_with_http_info(account_id:, action:, order_type:, time_in_force:, user_id:, user_secret:, universal_symbol_id: SENTINEL, symbol: SENTINEL, price: SENTINEL, stop: SENTINEL, units: SENTINEL, notional_value: SENTINEL, extra: {})
       _body = {}
       _body[:account_id] = account_id if account_id != SENTINEL
       _body[:action] = action if action != SENTINEL
       _body[:universal_symbol_id] = universal_symbol_id if universal_symbol_id != SENTINEL
+      _body[:symbol] = symbol if symbol != SENTINEL
       _body[:order_type] = order_type if order_type != SENTINEL
       _body[:time_in_force] = time_in_force if time_in_force != SENTINEL
       _body[:price] = price if price != SENTINEL
       _body[:stop] = stop if stop != SENTINEL
       _body[:units] = units if units != 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)
+      manual_trade_form_with_options = _body
+      place_force_order_with_http_info_impl(user_id, user_secret, manual_trade_form_with_options, extra)
     end
 
     # 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'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 [String] 
     # @param user_secret [String] 
-    # @param manual_trade_form [ManualTradeForm] 
+    # @param manual_trade_form_with_options [ManualTradeFormWithOptions] 
     # @param [Hash] opts the optional parameters
     # @return [AccountOrderRecord]
-    private def place_force_order_impl(user_id, user_secret, manual_trade_form, opts = {})
-      data, _status_code, _headers = place_force_order_with_http_info(user_id, user_secret, manual_trade_form, opts)
+    private def place_force_order_impl(user_id, user_secret, manual_trade_form_with_options, opts = {})
+      data, _status_code, _headers = place_force_order_with_http_info(user_id, user_secret, manual_trade_form_with_options, opts)
       data
     end
 
@@ -497,10 +501,10 @@ module SnapTrade
     # 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'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 [String] 
     # @param user_secret [String] 
-    # @param manual_trade_form [ManualTradeForm] 
+    # @param manual_trade_form_with_options [ManualTradeFormWithOptions] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccountOrderRecord, Integer, Hash)>] AccountOrderRecord data, response status code and response headers
-    private def place_force_order_with_http_info_impl(user_id, user_secret, manual_trade_form, opts = {})
+    private def place_force_order_with_http_info_impl(user_id, user_secret, manual_trade_form_with_options, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TradingApi.place_force_order ...'
       end
@@ -512,9 +516,9 @@ module SnapTrade
       if @api_client.config.client_side_validation && user_secret.nil?
         fail ArgumentError, "Missing the required parameter 'user_secret' when calling TradingApi.place_force_order"
       end
-      # verify the required parameter 'manual_trade_form' is set
-      if @api_client.config.client_side_validation && manual_trade_form.nil?
-        fail ArgumentError, "Missing the required parameter 'manual_trade_form' when calling TradingApi.place_force_order"
+      # verify the required parameter 'manual_trade_form_with_options' is set
+      if @api_client.config.client_side_validation && manual_trade_form_with_options.nil?
+        fail ArgumentError, "Missing the required parameter 'manual_trade_form_with_options' when calling TradingApi.place_force_order"
       end
       # resource path
       local_var_path = '/trade/place'
@@ -538,7 +542,7 @@ module SnapTrade
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(manual_trade_form)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(manual_trade_form_with_options)
 
       # return_type
       return_type = opts[:debug_return_type] || 'AccountOrderRecord'

data/lib/snaptrade/api/transactions_and_reporting_api.rb

@@ -31,7 +31,7 @@ module SnapTrade
     # @param end_date [Date] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
     # @param accounts [String] Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
     # @param brokerage_authorizations [String] Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
-    # @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. 
+    # @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_activities(user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, accounts: SENTINEL, brokerage_authorizations: SENTINEL, type: SENTINEL, extra: {})
       extra[:start_date] = start_date if start_date != SENTINEL
@@ -57,7 +57,7 @@ module SnapTrade
     # @param end_date [Date] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
     # @param accounts [String] Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
     # @param brokerage_authorizations [String] Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
-    # @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. 
+    # @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_activities_with_http_info(user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, accounts: SENTINEL, brokerage_authorizations: SENTINEL, type: SENTINEL, extra: {})
       extra[:start_date] = start_date if start_date != SENTINEL
@@ -77,7 +77,7 @@ module SnapTrade
     # @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
     # @option opts [String] :accounts Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
     # @option opts [String] :brokerage_authorizations Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
-    # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.  
+    # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event. 
     # @return [Array<UniversalActivity>]
     private def get_activities_impl(user_id, user_secret, opts = {})
       data, _status_code, _headers = get_activities_with_http_info(user_id, user_secret, opts)
@@ -93,7 +93,7 @@ module SnapTrade
     # @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
     # @option opts [String] :accounts Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
     # @option opts [String] :brokerage_authorizations Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
-    # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.  
+    # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event. 
     # @return [Array<(Array<UniversalActivity>, Integer, Hash)>] Array<UniversalActivity> data, response status code and response headers
     private def get_activities_with_http_info_impl(user_id, user_secret, opts = {})
       if @api_client.config.debugging

data/lib/snaptrade/models/account_order_record.rb

@@ -19,9 +19,6 @@ module SnapTrade
     # Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
     attr_accessor :status
 
-    # 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 :symbol
-
     attr_accessor :universal_symbol
 
     attr_accessor :option_symbol
@@ -68,12 +65,14 @@ module SnapTrade
     # The time the order expires. This value is not always available from the brokerage.
     attr_accessor :expiry_date
 
+    # 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 :symbol
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'brokerage_order_id' => :'brokerage_order_id',
         :'status' => :'status',
-        :'symbol' => :'symbol',
         :'universal_symbol' => :'universal_symbol',
         :'option_symbol' => :'option_symbol',
         :'action' => :'action',
@@ -89,7 +88,8 @@ module SnapTrade
         :'time_placed' => :'time_placed',
         :'time_updated' => :'time_updated',
         :'time_executed' => :'time_executed',
-        :'expiry_date' => :'expiry_date'
+        :'expiry_date' => :'expiry_date',
+        :'symbol' => :'symbol'
       }
     end
 
@@ -103,7 +103,6 @@ module SnapTrade
       {
         :'brokerage_order_id' => :'String',
         :'status' => :'AccountOrderRecordStatus',
-        :'symbol' => :'String',
         :'universal_symbol' => :'AccountOrderRecordUniversalSymbol',
         :'option_symbol' => :'AccountOrderRecordOptionSymbol',
         :'action' => :'String',
@@ -119,7 +118,8 @@ module SnapTrade
         :'time_placed' => :'Time',
         :'time_updated' => :'Time',
         :'time_executed' => :'Time',
-        :'expiry_date' => :'Time'
+        :'expiry_date' => :'Time',
+        :'symbol' => :'String'
       }
     end
 
@@ -136,7 +136,7 @@ module SnapTrade
         :'order_type',
         :'time_updated',
         :'time_executed',
-        :'expiry_date'
+        :'expiry_date',
       ])
     end
 
@@ -163,10 +163,6 @@ module SnapTrade
         self.status = attributes[:'status']
       end
 
-      if attributes.key?(:'symbol')
-        self.symbol = attributes[:'symbol']
-      end
-
       if attributes.key?(:'universal_symbol')
         self.universal_symbol = attributes[:'universal_symbol']
       end
@@ -230,6 +226,10 @@ module SnapTrade
       if attributes.key?(:'expiry_date')
         self.expiry_date = attributes[:'expiry_date']
       end
+
+      if attributes.key?(:'symbol')
+        self.symbol = attributes[:'symbol']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -252,7 +252,6 @@ module SnapTrade
       self.class == o.class &&
           brokerage_order_id == o.brokerage_order_id &&
           status == o.status &&
-          symbol == o.symbol &&
           universal_symbol == o.universal_symbol &&
           option_symbol == o.option_symbol &&
           action == o.action &&
@@ -268,7 +267,8 @@ module SnapTrade
           time_placed == o.time_placed &&
           time_updated == o.time_updated &&
           time_executed == o.time_executed &&
-          expiry_date == o.expiry_date
+          expiry_date == o.expiry_date &&
+          symbol == o.symbol
     end
 
     # @see the `==` method
@@ -280,7 +280,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [brokerage_order_id, status, symbol, universal_symbol, option_symbol, action, total_quantity, open_quantity, canceled_quantity, filled_quantity, execution_price, limit_price, stop_price, order_type, time_in_force, time_placed, time_updated, time_executed, expiry_date].hash
+      [brokerage_order_id, status, universal_symbol, option_symbol, action, total_quantity, open_quantity, canceled_quantity, filled_quantity, execution_price, limit_price, stop_price, order_type, time_in_force, time_placed, time_updated, time_executed, expiry_date, symbol].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/account_order_record_universal_symbol.rb

@@ -31,14 +31,14 @@ module SnapTrade
 
     attr_accessor :type
 
-    # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
-    attr_accessor :currencies
-
     # This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. This value should be the same as the `figi_code` in the `figi_instrument` child property.
     attr_accessor :figi_code
 
     attr_accessor :figi_instrument
 
+    # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
+    attr_accessor :currencies
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -49,9 +49,9 @@ module SnapTrade
         :'currency' => :'currency',
         :'exchange' => :'exchange',
         :'type' => :'type',
-        :'currencies' => :'currencies',
         :'figi_code' => :'figi_code',
-        :'figi_instrument' => :'figi_instrument'
+        :'figi_instrument' => :'figi_instrument',
+        :'currencies' => :'currencies'
       }
     end
 
@@ -70,9 +70,9 @@ module SnapTrade
         :'currency' => :'SymbolCurrency',
         :'exchange' => :'SymbolExchange',
         :'type' => :'SecurityType',
-        :'currencies' => :'Array<Currency>',
         :'figi_code' => :'String',
-        :'figi_instrument' => :'SymbolFigiInstrument'
+        :'figi_instrument' => :'SymbolFigiInstrument',
+        :'currencies' => :'Array<Currency>'
       }
     end
 
@@ -81,7 +81,7 @@ module SnapTrade
       Set.new([
         :'description',
         :'figi_code',
-        :'figi_instrument'
+        :'figi_instrument',
       ])
     end
 
@@ -135,12 +135,6 @@ module SnapTrade
         self.type = attributes[:'type']
       end
 
-      if attributes.key?(:'currencies')
-        if (value = attributes[:'currencies']).is_a?(Array)
-          self.currencies = value
-        end
-      end
-
       if attributes.key?(:'figi_code')
         self.figi_code = attributes[:'figi_code']
       end
@@ -148,6 +142,12 @@ module SnapTrade
       if attributes.key?(:'figi_instrument')
         self.figi_instrument = attributes[:'figi_instrument']
       end
+
+      if attributes.key?(:'currencies')
+        if (value = attributes[:'currencies']).is_a?(Array)
+          self.currencies = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -205,9 +205,9 @@ module SnapTrade
           currency == o.currency &&
           exchange == o.exchange &&
           type == o.type &&
-          currencies == o.currencies &&
           figi_code == o.figi_code &&
-          figi_instrument == o.figi_instrument
+          figi_instrument == o.figi_instrument &&
+          currencies == o.currencies
     end
 
     # @see the `==` method
@@ -219,7 +219,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, symbol, raw_symbol, description, currency, exchange, type, currencies, figi_code, figi_instrument].hash
+      [id, symbol, raw_symbol, description, currency, exchange, type, figi_code, figi_instrument, currencies].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/action_strict_with_options.rb

@@ -0,0 +1,41 @@
+=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 ActionStrictWithOptions
+    BUY = "BUY".freeze
+    SELL = "SELL".freeze
+    BUY_TO_OPEN = "BUY_TO_OPEN".freeze
+    BUY_TO_CLOSE = "BUY_TO_CLOSE".freeze
+    SELL_TO_OPEN = "SELL_TO_OPEN".freeze
+    SELL_TO_CLOSE = "SELL_TO_CLOSE".freeze
+
+    def self.all_vars
+      @all_vars ||= [BUY, SELL, BUY_TO_OPEN, BUY_TO_CLOSE, SELL_TO_OPEN, SELL_TO_CLOSE].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if ActionStrictWithOptions.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ActionStrictWithOptions"
+    end
+  end
+end