snaptrade 2.0.159 → 2.0.161

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fa83bbe1d67bcd1156377fbb945969cae929351a7a62071d2a984b8d8e92b1c
-  data.tar.gz: '08ec226e7f82a264662215fe06a4801f5aa21967f38adad0baaa851cb73e94a3'
+  metadata.gz: cff757123d9aa13d82660e1f9a83796b057c847966a741d7379bfd15853cdb83
+  data.tar.gz: c695a68f78e095c6a3914a9ee8d1fd966f5ebe74893ab046be3be0585d2824a7
 SHA512:
-  metadata.gz: 04e30804f136b31435b4ccc4d40311212c6f893eb5c693477010f99759d810f5d4bac3e9ba0924b341d5372cdb1a042ad21f2b00fef9ccbcd92b5fe247ad3e92
-  data.tar.gz: 51b23e6298dd0a2b50a96e26c39f477a26032064ef10abe3b7b4d04dfcd9f67229184c761045ed9842feca14c3fecee05c155081847c3eaf902586de52aa6fe5
+  metadata.gz: 5a1f93f3f4c0d2ce32547538fab648f1e004780f06311c1a24182a3b31d08aeb27f030f737a26799153d364d9c31a854983641fc9b406ff1a504edc55ca8316a
+  data.tar.gz: af48d20033afb2dde33ca48c7ca46e74d5c652125bd91d23f78b54ff6723c9b00f7bec88e364f8bb057ac3dfdcf1e54fe52ad4acfd7d25efc19910ecbc604eee

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.159)
+    snaptrade (2.0.161)
       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.159-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.159)
+[![npm](https://img.shields.io/badge/gem-v2.0.161-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.161)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -84,7 +84,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.159'
+gem 'snaptrade', '~> 2.0.161'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -468,9 +468,9 @@ p result
 
 ### `snaptrade.account_information.get_user_account_recent_orders`<a id="snaptradeaccount_informationget_user_account_recent_orders"></a>
 
-A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account.
+A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders.
 This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders
-Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days
+Differs from /orders in that it is always realtime, and only checks the last 24 hours
 By default only returns executed orders, but that can be changed by setting *only_executed* to false
 
 
@@ -1131,7 +1131,7 @@ specific users
 
 ### `snaptrade.experimental_endpoints.get_user_account_order_detail_v2`<a id="snaptradeexperimental_endpointsget_user_account_order_detail_v2"></a>
 
-Returns the detail of a single order using the external order ID provided in the request body.
+Returns the detail of a single order using the brokerage order ID provided as a path parameter.
 
 The V2 order response format includes all legs of the order in the `legs` list field.
 If the order is single legged, `legs` will be a list of one leg.
@@ -1145,8 +1145,8 @@ This endpoint only returns orders placed through SnapTrade. In other words, orde
 
 ```ruby
 result = snaptrade.experimental_endpoints.get_user_account_order_detail_v2(
-  brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
   user_id: "snaptrade-user-123",
   user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
@@ -1155,11 +1155,8 @@ p result
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
-##### brokerage_order_id: `String`<a id="brokerage_order_id-string"></a>
-Order ID returned by brokerage. This is the unique identifier for the order in
-the brokerage system.
-
 ##### account_id: `String`<a id="account_id-string"></a>
+##### brokerage_order_id: `String`<a id="brokerage_order_id-string"></a>
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 #### 🔄 Return<a id="🔄-return"></a>
@@ -1168,7 +1165,7 @@ the brokerage system.
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
-`/accounts/{accountId}/orders/details/v2` `POST`
+`/accounts/{accountId}/orders/details/v2/{brokerageOrderId}` `GET`
 
 [🔙 **Back to Table of Contents**](#table-of-contents)
 

data/lib/snaptrade/api/account_information_api.rb

@@ -907,9 +907,9 @@ module SnapTrade
 
     # List account recent orders (last 24 hours only)
     #
-    # A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account.
+    # A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders.
     # This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders
-    # Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days
+    # Differs from /orders in that it is always realtime, and only checks the last 24 hours
     # By default only returns executed orders, but that can be changed by setting *only_executed* to false
     #
     # @param user_id [String] 
@@ -925,9 +925,9 @@ module SnapTrade
 
     # List account recent orders (last 24 hours only)
     #
-    # A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account.
+    # A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders.
     # This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders
-    # Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days
+    # Differs from /orders in that it is always realtime, and only checks the last 24 hours
     # By default only returns executed orders, but that can be changed by setting *only_executed* to false
     #
     # @param user_id [String] 
@@ -941,7 +941,7 @@ module SnapTrade
     end
 
     # List account recent orders (last 24 hours only)
-    # A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days By default only returns executed orders, but that can be changed by setting *only_executed* to false 
+    # A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -954,7 +954,7 @@ module SnapTrade
     end
 
     # List account recent orders (last 24 hours only)
-    # A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days By default only returns executed orders, but that can be changed by setting *only_executed* to false 
+    # A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 

data/lib/snaptrade/api/experimental_endpoints_api.rb

@@ -19,7 +19,7 @@ module SnapTrade
 
     # Get account order detail (V2)
     #
-    # Returns the detail of a single order using the external order ID provided in the request body.
+    # Returns the detail of a single order using the brokerage order ID provided as a path parameter.
     # 
     # The V2 order response format includes all legs of the order in the `legs` list field.
     # If the order is single legged, `legs` will be a list of one leg.
@@ -28,23 +28,19 @@ module SnapTrade
     # 
     # This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
     #
-    # @param brokerage_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
     # @param account_id [String] 
+    # @param brokerage_order_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param body [AccountInformationGetUserAccountOrderDetailRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_user_account_order_detail_v2(brokerage_order_id:, account_id:, user_id:, user_secret:, extra: {})
-      _body = {}
-      _body[:brokerage_order_id] = brokerage_order_id if brokerage_order_id != SENTINEL
-      account_information_get_user_account_order_detail_request = _body
-      data, _status_code, _headers = get_user_account_order_detail_v2_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, extra)
+    def get_user_account_order_detail_v2(account_id:, brokerage_order_id:, user_id:, user_secret:, extra: {})
+      data, _status_code, _headers = get_user_account_order_detail_v2_with_http_info_impl(account_id, brokerage_order_id, user_id, user_secret, extra)
       data
     end
 
     # Get account order detail (V2)
     #
-    # Returns the detail of a single order using the external order ID provided in the request body.
+    # Returns the detail of a single order using the brokerage order ID provided as a path parameter.
     # 
     # The V2 order response format includes all legs of the order in the `legs` list field.
     # If the order is single legged, `legs` will be a list of one leg.
@@ -53,41 +49,37 @@ module SnapTrade
     # 
     # This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
     #
-    # @param brokerage_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
     # @param account_id [String] 
+    # @param brokerage_order_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param body [AccountInformationGetUserAccountOrderDetailRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_user_account_order_detail_v2_with_http_info(brokerage_order_id:, account_id:, user_id:, user_secret:, extra: {})
-      _body = {}
-      _body[:brokerage_order_id] = brokerage_order_id if brokerage_order_id != SENTINEL
-      account_information_get_user_account_order_detail_request = _body
-      get_user_account_order_detail_v2_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, extra)
+    def get_user_account_order_detail_v2_with_http_info(account_id:, brokerage_order_id:, user_id:, user_secret:, extra: {})
+      get_user_account_order_detail_v2_with_http_info_impl(account_id, brokerage_order_id, user_id, user_secret, extra)
     end
 
     # Get account order detail (V2)
-    # Returns the detail of a single order using the external order ID provided in the request body.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 
+    # Returns the detail of a single order using the brokerage order ID provided as a path parameter.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 
     # @param account_id [String] 
+    # @param brokerage_order_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_information_get_user_account_order_detail_request [AccountInformationGetUserAccountOrderDetailRequest] 
     # @param [Hash] opts the optional parameters
     # @return [AccountOrderRecordV2]
-    private def get_user_account_order_detail_v2_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, opts = {})
-      data, _status_code, _headers = get_user_account_order_detail_v2_with_http_info(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, opts)
+    private def get_user_account_order_detail_v2_impl(account_id, brokerage_order_id, user_id, user_secret, opts = {})
+      data, _status_code, _headers = get_user_account_order_detail_v2_with_http_info(account_id, brokerage_order_id, user_id, user_secret, opts)
       data
     end
 
     # Get account order detail (V2)
-    # Returns the detail of a single order using the external order ID provided in the request body.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 
+    # Returns the detail of a single order using the brokerage order ID provided as a path parameter.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 
     # @param account_id [String] 
+    # @param brokerage_order_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_information_get_user_account_order_detail_request [AccountInformationGetUserAccountOrderDetailRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccountOrderRecordV2, Integer, Hash)>] AccountOrderRecordV2 data, response status code and response headers
-    private def get_user_account_order_detail_v2_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, opts = {})
+    private def get_user_account_order_detail_v2_with_http_info_impl(account_id, brokerage_order_id, user_id, user_secret, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ExperimentalEndpointsApi.get_user_account_order_detail_v2 ...'
       end
@@ -95,6 +87,10 @@ module SnapTrade
       if @api_client.config.client_side_validation && account_id.nil?
         fail ArgumentError, "Missing the required parameter 'account_id' when calling ExperimentalEndpointsApi.get_user_account_order_detail_v2"
       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 ExperimentalEndpointsApi.get_user_account_order_detail_v2"
+      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 ExperimentalEndpointsApi.get_user_account_order_detail_v2"
@@ -103,12 +99,8 @@ module SnapTrade
       if @api_client.config.client_side_validation && user_secret.nil?
         fail ArgumentError, "Missing the required parameter 'user_secret' when calling ExperimentalEndpointsApi.get_user_account_order_detail_v2"
       end
-      # verify the required parameter 'account_information_get_user_account_order_detail_request' is set
-      if @api_client.config.client_side_validation && account_information_get_user_account_order_detail_request.nil?
-        fail ArgumentError, "Missing the required parameter 'account_information_get_user_account_order_detail_request' when calling ExperimentalEndpointsApi.get_user_account_order_detail_v2"
-      end
       # resource path
-      local_var_path = '/accounts/{accountId}/orders/details/v2'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
+      local_var_path = '/accounts/{accountId}/orders/details/v2/{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] || {}
@@ -119,17 +111,12 @@ module SnapTrade
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      content_type = @api_client.select_header_content_type(['application/json'])
-      if !content_type.nil?
-        header_params['Content-Type'] = content_type
-      end
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(account_information_get_user_account_order_detail_request)
+      post_body = opts[:debug_body]
 
       # return_type
       return_type = opts[:debug_return_type] || 'AccountOrderRecordV2'
@@ -147,7 +134,7 @@ module SnapTrade
         :return_type => return_type
       )
 
-      data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
+      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: ExperimentalEndpointsApi#get_user_account_order_detail_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/snaptrade/version.rb

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

data/spec/api/account_information_api_spec.rb

@@ -135,7 +135,7 @@ describe 'AccountInformationApi' do
 
   # unit tests for get_user_account_recent_orders
   # List account recent orders (last 24 hours only)
-  # A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days By default only returns executed orders, but that can be changed by setting *only_executed* to false 
+  # A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false 
   # @param user_id 
   # @param user_secret 
   # @param account_id 

data/spec/api/experimental_endpoints_api_spec.rb

@@ -29,11 +29,11 @@ describe 'ExperimentalEndpointsApi' do
 
   # unit tests for get_user_account_order_detail_v2
   # Get account order detail (V2)
-  # Returns the detail of a single order using the external order ID provided in the request body.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 
+  # Returns the detail of a single order using the brokerage order ID provided as a path parameter.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint. 
   # @param account_id 
+  # @param brokerage_order_id 
   # @param user_id 
   # @param user_secret 
-  # @param account_information_get_user_account_order_detail_request 
   # @param [Hash] opts the optional parameters
   # @return [AccountOrderRecordV2]
   describe 'get_user_account_order_detail_v2 test' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.159
+  version: 2.0.161
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-02-03 00:00:00.000000000 Z
+date: 2026-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday