snaptrade 2.0.123 → 2.0.124

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af2a719406589ce3ae88123bd403a4102432ac9fbf6d8f7ddfba1665c2d21313
-  data.tar.gz: a98763c429d28648bb302ad1cc67893b697d887872b1d515c503667ad88d8e70
+  metadata.gz: c52a939d269906ab92631ba9806d1d7a9f6fc2b06badd2260018ca5046b9e6f5
+  data.tar.gz: 1d7b5eee9b5ae12d88c244aa086c0c2a7d5e428b3defec7e64a433ded17ffb22
 SHA512:
-  metadata.gz: 128e7f1dbbdcdf568e181816945f7d618e75bb3c07a82cea4eaada86429aefceb427967e6421c900d4f7d2ea2b9feb717d4686d08cbc43f907f726a33928ce19
-  data.tar.gz: be498c45d9af927f2d95b16922622b83fadc01aff31ceab6bbbe373c29302ab8a8d357501cee2e3e12822f07c57ded8f08d448a3b91a674060884d63ea3470a1
+  metadata.gz: 406fe1174adad1ec1ad3962dae8c0c2098c9fc31ad30adbd6cbd8346a271ebf42f06285b129bd8d4f9283cdc16278125e5317aa245e9c4d36205c0b1ab5e8d3e
+  data.tar.gz: 710d59a5c10de48f22b51b9a36dd2077cdeb5a498c70e2553ae7cd8b012b6a62e2cf27854865479c289001f2dd70c780e182e45d2b5ab834f7ac261bb45e12fc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.123)
+    snaptrade (2.0.124)
       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.124-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.124)
 [![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)
@@ -83,7 +84,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.124'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -320,6 +321,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.

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.

data/lib/snaptrade/models/account_status.rb

@@ -15,9 +15,10 @@ module SnapTrade
     OPEN = "open".freeze
     CLOSED = "closed".freeze
     ARCHIVED = "archived".freeze
+    UNAVAILABLE = "unavailable".freeze
 
     def self.all_vars
-      @all_vars ||= [OPEN, CLOSED, ARCHIVED].freeze
+      @all_vars ||= [OPEN, CLOSED, ARCHIVED, UNAVAILABLE].freeze
     end
 
     # Builds the enum from string

data/lib/snaptrade/version.rb

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

data/spec/api/account_information_api_spec.rb

@@ -88,6 +88,21 @@ describe 'AccountInformationApi' do
     end
   end
 
+  # unit tests for get_user_account_order_detail
+  # 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 
+  # @param user_secret 
+  # @param account_id 
+  # @param brokerage_order_id 
+  # @param [Hash] opts the optional parameters
+  # @return [AccountOrderRecord]
+  describe 'get_user_account_order_detail test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_user_account_orders
   # List account orders
   # Returns a list of recent orders in the specified account.  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.123
+  version: 2.0.124
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-08-18 00:00:00.000000000 Z
+date: 2025-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday