snaptrade 2.0.123 → 2.0.125

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af2a719406589ce3ae88123bd403a4102432ac9fbf6d8f7ddfba1665c2d21313
-  data.tar.gz: a98763c429d28648bb302ad1cc67893b697d887872b1d515c503667ad88d8e70
+  metadata.gz: 11b241c94a730790636f70715fa1d45ac5d7df7557c49bcc901de21599d320e3
+  data.tar.gz: 38cf98011e50e074187dd245424da594e8258f21f133ecc3f9fd1878d16a20a4
 SHA512:
-  metadata.gz: 128e7f1dbbdcdf568e181816945f7d618e75bb3c07a82cea4eaada86429aefceb427967e6421c900d4f7d2ea2b9feb717d4686d08cbc43f907f726a33928ce19
-  data.tar.gz: be498c45d9af927f2d95b16922622b83fadc01aff31ceab6bbbe373c29302ab8a8d357501cee2e3e12822f07c57ded8f08d448a3b91a674060884d63ea3470a1
+  metadata.gz: 4020c52948f0d1d9e2840dc0426863a2dfb303ff2480e826389b6d6ff4e53a0a067da4497b861fc2960ee59c3dab1e68b9e976623bd238640e58ce2ecff7c8d8
+  data.tar.gz: aa02784c328165731ee75bd5c626441ba2903a5b31cbeb472ed55a070bd47f83645e52d1518311c6b2847e8359f2fc9d30713129877b868c8ff92b1903052bbc

data/Gemfile.lock

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

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.123-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.123)
+[![npm](https://img.shields.io/badge/gem-v2.0.125-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.125)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -23,6 +23,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.account_information.get_all_user_holdings`](#snaptradeaccount_informationget_all_user_holdings)
   * [`snaptrade.account_information.get_user_account_balance`](#snaptradeaccount_informationget_user_account_balance)
   * [`snaptrade.account_information.get_user_account_details`](#snaptradeaccount_informationget_user_account_details)
+  * [`snaptrade.account_information.get_user_account_order_detail`](#snaptradeaccount_informationget_user_account_order_detail)
   * [`snaptrade.account_information.get_user_account_orders`](#snaptradeaccount_informationget_user_account_orders)
   * [`snaptrade.account_information.get_user_account_positions`](#snaptradeaccount_informationget_user_account_positions)
   * [`snaptrade.account_information.get_user_account_recent_orders`](#snaptradeaccount_informationget_user_account_recent_orders)
@@ -43,11 +44,8 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.connections.remove_brokerage_authorization`](#snaptradeconnectionsremove_brokerage_authorization)
   * [`snaptrade.connections.return_rates`](#snaptradeconnectionsreturn_rates)
   * [`snaptrade.connections.session_events`](#snaptradeconnectionssession_events)
-  * [`snaptrade.options.get_option_strategy`](#snaptradeoptionsget_option_strategy)
   * [`snaptrade.options.get_options_chain`](#snaptradeoptionsget_options_chain)
-  * [`snaptrade.options.get_options_strategy_quote`](#snaptradeoptionsget_options_strategy_quote)
   * [`snaptrade.options.list_option_holdings`](#snaptradeoptionslist_option_holdings)
-  * [`snaptrade.options.place_option_strategy`](#snaptradeoptionsplace_option_strategy)
   * [`snaptrade.reference_data.get_currency_exchange_rate_pair`](#snaptradereference_dataget_currency_exchange_rate_pair)
   * [`snaptrade.reference_data.get_partner_info`](#snaptradereference_dataget_partner_info)
   * [`snaptrade.reference_data.get_security_types`](#snaptradereference_dataget_security_types)
@@ -83,7 +81,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.123'
+gem 'snaptrade', '~> 2.0.125'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -320,6 +318,42 @@ p result
 ---
 
 
+### `snaptrade.account_information.get_user_account_order_detail`<a id="snaptradeaccount_informationget_user_account_order_detail"></a>
+
+Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.account_information.get_user_account_order_detail(
+  user_id: "snaptrade-user-123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### user_id: `String`<a id="user_id-string"></a>
+##### user_secret: `String`<a id="user_secret-string"></a>
+##### account_id: `String`<a id="account_id-string"></a>
+##### brokerage_order_id: `String`<a id="brokerage_order_id-string"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[AccountOrderRecord](./lib/snaptrade/models/account_order_record.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/{brokerageOrderId}` `GET`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.account_information.get_user_account_orders`<a id="snaptradeaccount_informationget_user_account_orders"></a>
 
 Returns a list of recent orders in the specified account.
@@ -1048,54 +1082,6 @@ specific users
 ---
 
 
-### `snaptrade.options.get_option_strategy`<a id="snaptradeoptionsget_option_strategy"></a>
-
-Creates an option strategy object that will be used to place an option strategy order.
-
-
-#### 🛠️ Usage<a id="🛠️-usage"></a>
-
-```ruby
-result = snaptrade.options.get_option_strategy(
-  underlying_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-  legs: [
-        {
-            "action" => "BUY_TO_OPEN",
-            "option_symbol_id" => "SPY220819P00200000",
-            "quantity" => 1,
-        }
-    ],
-  strategy_type: "CUSTOM",
-  user_id: "snaptrade-user-123",
-  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
-  account_id: "accountId_example",
-)
-p result
-```
-
-#### ⚙️ Parameters<a id="⚙️-parameters"></a>
-
-##### underlying_symbol_id: `String`<a id="underlying_symbol_id-string"></a>
-##### legs: Array<[`OptionLeg`](./lib/snaptrade/models/option_leg.rb)><a id="legs-array"></a>
-##### strategy_type: [`StrategyType`](./lib/snaptrade/models/strategy_type.rb)<a id="strategy_type-strategytypelibsnaptrademodelsstrategy_typerb"></a>
-##### user_id: `String`<a id="user_id-string"></a>
-##### user_secret: `String`<a id="user_secret-string"></a>
-##### account_id: `String`<a id="account_id-string"></a>
-The ID of the account to create the option strategy object in.
-
-#### 🔄 Return<a id="🔄-return"></a>
-
-[StrategyQuotes](./lib/snaptrade/models/strategy_quotes.rb)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/accounts/{accountId}/optionStrategy` `POST`
-
-[🔙 **Back to Table of Contents**](#table-of-contents)
-
----
-
-
 ### `snaptrade.options.get_options_chain`<a id="snaptradeoptionsget_options_chain"></a>
 
 Returns the option chain for the specified symbol in the specified account.
@@ -1135,46 +1121,6 @@ Universal symbol ID if symbol
 ---
 
 
-### `snaptrade.options.get_options_strategy_quote`<a id="snaptradeoptionsget_options_strategy_quote"></a>
-
-Returns a Strategy Quotes object which has latest market data of the specified option strategy.
-
-
-#### 🛠️ Usage<a id="🛠️-usage"></a>
-
-```ruby
-result = snaptrade.options.get_options_strategy_quote(
-  user_id: "snaptrade-user-123",
-  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
-  account_id: "accountId_example",
-  option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-)
-p result
-```
-
-#### ⚙️ Parameters<a id="⚙️-parameters"></a>
-
-##### user_id: `String`<a id="user_id-string"></a>
-##### user_secret: `String`<a id="user_secret-string"></a>
-##### account_id: `String`<a id="account_id-string"></a>
-The ID of the account the strategy will be placed in.
-
-##### option_strategy_id: `String`<a id="option_strategy_id-string"></a>
-Option strategy id obtained from response when creating option strategy object
-
-#### 🔄 Return<a id="🔄-return"></a>
-
-[StrategyQuotes](./lib/snaptrade/models/strategy_quotes.rb)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/accounts/{accountId}/optionStrategy/{optionStrategyId}` `GET`
-
-[🔙 **Back to Table of Contents**](#table-of-contents)
-
----
-
-
 ### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
 
 Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
@@ -1211,66 +1157,6 @@ p result
 ---
 
 
-### `snaptrade.options.place_option_strategy`<a id="snaptradeoptionsplace_option_strategy"></a>
-
-Places the option strategy order and returns the order record received from the brokerage.
-
-#### 🛠️ Usage<a id="🛠️-usage"></a>
-
-```ruby
-result = snaptrade.options.place_option_strategy(
-  order_type: "Market",
-  time_in_force: "Day",
-  user_id: "snaptrade-user-123",
-  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
-  account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-  option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-  price: 31.33,
-)
-p result
-```
-
-#### ⚙️ Parameters<a id="⚙️-parameters"></a>
-
-##### 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`
-field is required. - For `Stop` and `StopLimit` orders, the `stop` field is
-required.
-
-##### time_in_force: [`TimeInForceStrict`](./lib/snaptrade/models/time_in_force_strict.rb)<a id="time_in_force-timeinforcestrictlibsnaptrademodelstime_in_force_strictrb"></a>
-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. - `IOC` - Immediate Or Cancel. The order
-must be executed immediately. Any portion of the order that cannot be filled
-immediately will be canceled.
-
-##### user_id: `String`<a id="user_id-string"></a>
-##### user_secret: `String`<a id="user_secret-string"></a>
-##### account_id: `String`<a id="account_id-string"></a>
-The ID of the account to execute the strategy in.
-
-##### option_strategy_id: `String`<a id="option_strategy_id-string"></a>
-Option strategy id obtained from response when creating option strategy object
-
-##### price: `Float`<a id="price-float"></a>
-Trade Price if limit or stop limit order
-
-#### 🔄 Return<a id="🔄-return"></a>
-
-[StrategyOrderRecord](./lib/snaptrade/models/strategy_order_record.rb)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/accounts/{accountId}/optionStrategy/{optionStrategyId}/execute` `POST`
-
-[🔙 **Back to Table of Contents**](#table-of-contents)
-
----
-
-
 ### `snaptrade.reference_data.get_currency_exchange_rate_pair`<a id="snaptradereference_dataget_currency_exchange_rate_pair"></a>
 
 Returns an Exchange Rate Pair object for the specified Currency Pair.

data/lib/snaptrade/api/account_information_api.rb

@@ -497,6 +497,117 @@ module SnapTrade
     end
 
 
+    # Get account order detail
+    #
+    # Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
+    #
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_id [String] 
+    # @param brokerage_order_id [String] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def get_user_account_order_detail(user_id:, user_secret:, account_id:, brokerage_order_id:, extra: {})
+      data, _status_code, _headers = get_user_account_order_detail_with_http_info_impl(user_id, user_secret, account_id, brokerage_order_id, extra)
+      data
+    end
+
+    # Get account order detail
+    #
+    # Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
+    #
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_id [String] 
+    # @param brokerage_order_id [String] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def get_user_account_order_detail_with_http_info(user_id:, user_secret:, account_id:, brokerage_order_id:, extra: {})
+      get_user_account_order_detail_with_http_info_impl(user_id, user_secret, account_id, brokerage_order_id, extra)
+    end
+
+    # Get account order detail
+    # Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data. 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_id [String] 
+    # @param brokerage_order_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountOrderRecord]
+    private def get_user_account_order_detail_impl(user_id, user_secret, account_id, brokerage_order_id, opts = {})
+      data, _status_code, _headers = get_user_account_order_detail_with_http_info(user_id, user_secret, account_id, brokerage_order_id, opts)
+      data
+    end
+
+    # Get account order detail
+    # Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data. 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_id [String] 
+    # @param brokerage_order_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountOrderRecord, Integer, Hash)>] AccountOrderRecord data, response status code and response headers
+    private def get_user_account_order_detail_with_http_info_impl(user_id, user_secret, account_id, brokerage_order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountInformationApi.get_user_account_order_detail ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountInformationApi.get_user_account_order_detail"
+      end
+      # verify the required parameter 'user_secret' is set
+      if @api_client.config.client_side_validation && user_secret.nil?
+        fail ArgumentError, "Missing the required parameter 'user_secret' when calling AccountInformationApi.get_user_account_order_detail"
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountInformationApi.get_user_account_order_detail"
+      end
+      # verify the required parameter 'brokerage_order_id' is set
+      if @api_client.config.client_side_validation && brokerage_order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'brokerage_order_id' when calling AccountInformationApi.get_user_account_order_detail"
+      end
+      # resource path
+      local_var_path = '/accounts/{accountId}/orders/{brokerageOrderId}'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'brokerageOrderId' + '}', CGI.escape(brokerage_order_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'userId'] = user_id
+      query_params[:'userSecret'] = user_secret
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountOrderRecord'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"AccountInformationApi.get_user_account_order_detail",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountInformationApi#get_user_account_order_detail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
     # List account orders
     #
     # Returns a list of recent orders in the specified account.