snaptrade 2.0.127 → 2.0.129

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f76bd21456b85ad4893f2ac6ee26379500e230cd8cf14389daf785b684c7648a
-  data.tar.gz: 271b4ef9ad2f6c0857653d9377402e20984c9f5cc593a9f3d9e189b5b475feaa
+  metadata.gz: fec778920b549791f66f45c16297693da67c706839886de97a8fbb522a81b8bf
+  data.tar.gz: 90405fd88ab9edf3b6c27409e5331e40c5722a49abc00384b487832d2240bf2d
 SHA512:
-  metadata.gz: 97793f804b00d4f34f9cb6678a8f8543a75da9d40bff5db57f84f21c498d12cf02c399052e40b2a31949d25a40ede9edba30aa8b5a7acf697ada34f7a0743867
-  data.tar.gz: a1b77ba592b1e45528054b8ef217c62f1b5f18a32eba99921e7f65a17bb194ba515b62b1cd95078cb46042f7844d08e869cbb4dbd834c83e2ffb03008dc4f13c
+  metadata.gz: fd847e8941992c09c6fbea2a2817ae638aeded1ae781cfa0bddee54ccbfd8f8a5dd5a6a37b2bf1c14c27bbe41b31bd9f251bd53a030ac5da38388be4de89dcb9
+  data.tar.gz: f746f821017a9ac832b655a81f84a4878858e95ff0ea933f7485e1f849804d5a22ed14f16e1676c1f8f6e9858b3da6492f8bd73c116e404e08ce46d328871cf9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.127)
+    snaptrade (2.0.129)
       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.127-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.127)
+[![npm](https://img.shields.io/badge/gem-v2.0.129-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.129)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -81,7 +81,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.127'
+gem 'snaptrade', '~> 2.0.129'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -320,7 +320,7 @@ 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.
+Returns the detail of a single order using the external order ID provided in the request body.
 
 This endpoint is always realtime and does not rely on cached data.
 
@@ -331,27 +331,30 @@ This endpoint only returns orders placed through SnapTrade. In other words, orde
 
 ```ruby
 result = snaptrade.account_information.get_user_account_order_detail(
+  external_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
+  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   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>
 
+##### external_order_id: `String`<a id="external_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>
 ##### 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`
+`/accounts/{accountId}/orders/details` `POST`
 
 [🔙 **Back to Table of Contents**](#table-of-contents)
 
@@ -1367,21 +1370,24 @@ Returns a list of all brokerage instruments available for a given brokerage. Not
 
 ```ruby
 result = snaptrade.reference_data.list_all_brokerage_instruments(
-  brokerage_id: "87b24961-b51e-4db8-9226-f198f6518a89",
+  slug: "QUESTRADE",
 )
 p result
 ```
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
-##### brokerage_id: `String`<a id="brokerage_id-string"></a>
+##### slug: `String`<a id="slug-string"></a>
+A short, unique identifier for the brokerage. It is usually the name of the
+brokerage in capital letters and will never change.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [BrokerageInstrumentsResponse](./lib/snaptrade/models/brokerage_instruments_response.rb)
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
-`/brokerages/{brokerageId}/instruments` `GET`
+`/brokerages/{slug}/instruments` `GET`
 
 [🔙 **Back to Table of Contents**](#table-of-contents)
 

data/lib/snaptrade/api/account_information_api.rb

@@ -499,64 +499,76 @@ module SnapTrade
 
     # Get account order detail
     #
-    # Returns the detail of a single order in the specified account.
+    # Returns the detail of a single order using the external order ID provided in the request body.
     # 
     # 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 external_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 user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] 
-    # @param brokerage_order_id [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(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)
+    def get_user_account_order_detail(external_order_id:, account_id:, user_id:, user_secret:, extra: {})
+      _body = {}
+      _body[:external_order_id] = external_order_id if external_order_id != SENTINEL
+      account_information_get_user_account_order_detail_request = _body
+      data, _status_code, _headers = get_user_account_order_detail_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, extra)
       data
     end
 
     # Get account order detail
     #
-    # Returns the detail of a single order in the specified account.
+    # Returns the detail of a single order using the external order ID provided in the request body.
     # 
     # 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 external_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 user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] 
-    # @param brokerage_order_id [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_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)
+    def get_user_account_order_detail_with_http_info(external_order_id:, account_id:, user_id:, user_secret:, extra: {})
+      _body = {}
+      _body[:external_order_id] = external_order_id if external_order_id != SENTINEL
+      account_information_get_user_account_order_detail_request = _body
+      get_user_account_order_detail_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, 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.  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 external order ID provided in the request body.  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 user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] 
-    # @param brokerage_order_id [String] 
+    # @param account_information_get_user_account_order_detail_request [AccountInformationGetUserAccountOrderDetailRequest] 
     # @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)
+    private def get_user_account_order_detail_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_with_http_info(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, 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.  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 external order ID provided in the request body.  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 user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] 
-    # @param brokerage_order_id [String] 
+    # @param account_information_get_user_account_order_detail_request [AccountInformationGetUserAccountOrderDetailRequest] 
     # @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 = {})
+    private def get_user_account_order_detail_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: 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 '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"
@@ -565,16 +577,12 @@ module SnapTrade
       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"
+      # 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 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))
+      local_var_path = '/accounts/{accountId}/orders/details'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -585,12 +593,17 @@ 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]
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(account_information_get_user_account_order_detail_request)
 
       # return_type
       return_type = opts[:debug_return_type] || 'AccountOrderRecord'
@@ -608,7 +621,7 @@ module SnapTrade
         :return_type => return_type
       )
 
-      data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
+      data, status_code, headers, response = @api_client.call_api(:POST, 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

data/lib/snaptrade/api/reference_data_api.rb

@@ -600,10 +600,10 @@ module SnapTrade
     #
     # Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list.
     #
-    # @param brokerage_id [String] 
+    # @param slug [String] A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def list_all_brokerage_instruments(brokerage_id:, extra: {})
-      data, _status_code, _headers = list_all_brokerage_instruments_with_http_info_impl(brokerage_id, extra)
+    def list_all_brokerage_instruments(slug:, extra: {})
+      data, _status_code, _headers = list_all_brokerage_instruments_with_http_info_impl(slug, extra)
       data
     end
 
@@ -611,37 +611,37 @@ module SnapTrade
     #
     # Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list.
     #
-    # @param brokerage_id [String] 
+    # @param slug [String] A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def list_all_brokerage_instruments_with_http_info(brokerage_id:, extra: {})
-      list_all_brokerage_instruments_with_http_info_impl(brokerage_id, extra)
+    def list_all_brokerage_instruments_with_http_info(slug:, extra: {})
+      list_all_brokerage_instruments_with_http_info_impl(slug, extra)
     end
 
     # Get brokerage instruments
     # Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list.
-    # @param brokerage_id [String] 
+    # @param slug [String] A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
     # @param [Hash] opts the optional parameters
     # @return [BrokerageInstrumentsResponse]
-    private def list_all_brokerage_instruments_impl(brokerage_id, opts = {})
-      data, _status_code, _headers = list_all_brokerage_instruments_with_http_info(brokerage_id, opts)
+    private def list_all_brokerage_instruments_impl(slug, opts = {})
+      data, _status_code, _headers = list_all_brokerage_instruments_with_http_info(slug, opts)
       data
     end
 
     # Get brokerage instruments
     # Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list.
-    # @param brokerage_id [String] 
+    # @param slug [String] A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
     # @param [Hash] opts the optional parameters
     # @return [Array<(BrokerageInstrumentsResponse, Integer, Hash)>] BrokerageInstrumentsResponse data, response status code and response headers
-    private def list_all_brokerage_instruments_with_http_info_impl(brokerage_id, opts = {})
+    private def list_all_brokerage_instruments_with_http_info_impl(slug, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ReferenceDataApi.list_all_brokerage_instruments ...'
       end
-      # verify the required parameter 'brokerage_id' is set
-      if @api_client.config.client_side_validation && brokerage_id.nil?
-        fail ArgumentError, "Missing the required parameter 'brokerage_id' when calling ReferenceDataApi.list_all_brokerage_instruments"
+      # verify the required parameter 'slug' is set
+      if @api_client.config.client_side_validation && slug.nil?
+        fail ArgumentError, "Missing the required parameter 'slug' when calling ReferenceDataApi.list_all_brokerage_instruments"
       end
       # resource path
-      local_var_path = '/brokerages/{brokerageId}/instruments'.sub('{' + 'brokerageId' + '}', CGI.escape(brokerage_id.to_s))
+      local_var_path = '/brokerages/{slug}/instruments'.sub('{' + 'slug' + '}', CGI.escape(slug.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}

data/lib/snaptrade/models/account_information_get_user_account_order_detail_request.rb

@@ -0,0 +1,222 @@
+=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 AccountInformationGetUserAccountOrderDetailRequest
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    attr_accessor :external_order_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'external_order_id' => :'external_order_id'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'external_order_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::AccountInformationGetUserAccountOrderDetailRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::AccountInformationGetUserAccountOrderDetailRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'external_order_id')
+        self.external_order_id = attributes[:'external_order_id']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @external_order_id.nil?
+        invalid_properties.push('invalid value for "external_order_id", external_order_id cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @external_order_id.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          external_order_id == o.external_order_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [external_order_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = SnapTrade.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/snaptrade/models/brokerage_instrument.rb

@@ -104,12 +104,17 @@ module SnapTrade
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @symbol.nil?
+        invalid_properties.push('invalid value for "symbol", symbol cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @symbol.nil?
       true
     end
 

data/lib/snaptrade/version.rb

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

data/lib/snaptrade.rb

@@ -21,6 +21,7 @@ require 'snaptrade/models/account_balance'
 require 'snaptrade/models/account_balance_total'
 require 'snaptrade/models/account_holdings'
 require 'snaptrade/models/account_holdings_account'
+require 'snaptrade/models/account_information_get_user_account_order_detail_request'
 require 'snaptrade/models/account_order_record'
 require 'snaptrade/models/account_order_record_child_brokerage_order_ids'
 require 'snaptrade/models/account_order_record_option_symbol'

data/spec/api/account_information_api_spec.rb

@@ -90,11 +90,11 @@ describe 'AccountInformationApi' do
 
   # 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.  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 external order ID provided in the request body.  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 user_id 
   # @param user_secret 
-  # @param account_id 
-  # @param brokerage_order_id 
+  # @param account_information_get_user_account_order_detail_request 
   # @param [Hash] opts the optional parameters
   # @return [AccountOrderRecord]
   describe 'get_user_account_order_detail test' do

data/spec/api/reference_data_api_spec.rb

@@ -111,7 +111,7 @@ describe 'ReferenceDataApi' do
   # unit tests for list_all_brokerage_instruments
   # Get brokerage instruments
   # Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list.
-  # @param brokerage_id 
+  # @param slug A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
   # @param [Hash] opts the optional parameters
   # @return [BrokerageInstrumentsResponse]
   describe 'list_all_brokerage_instruments test' do

data/spec/models/account_information_get_user_account_order_detail_request_spec.rb

@@ -0,0 +1,29 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SnapTrade::AccountInformationGetUserAccountOrderDetailRequest
+describe SnapTrade::AccountInformationGetUserAccountOrderDetailRequest do
+  let(:instance) { SnapTrade::AccountInformationGetUserAccountOrderDetailRequest.new }
+
+  describe 'test an instance of AccountInformationGetUserAccountOrderDetailRequest' do
+    it 'should create an instance of AccountInformationGetUserAccountOrderDetailRequest' do
+      expect(instance).to be_instance_of(SnapTrade::AccountInformationGetUserAccountOrderDetailRequest)
+    end
+  end
+  describe 'test attribute "external_order_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.127
+  version: 2.0.129
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-08-27 00:00:00.000000000 Z
+date: 2025-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -100,6 +100,7 @@ files:
 - lib/snaptrade/models/account_balance_total.rb
 - lib/snaptrade/models/account_holdings.rb
 - lib/snaptrade/models/account_holdings_account.rb
+- lib/snaptrade/models/account_information_get_user_account_order_detail_request.rb
 - lib/snaptrade/models/account_order_record.rb
 - lib/snaptrade/models/account_order_record_child_brokerage_order_ids.rb
 - lib/snaptrade/models/account_order_record_option_symbol.rb
@@ -267,6 +268,7 @@ files:
 - spec/models/account_balance_total_spec.rb
 - spec/models/account_holdings_account_spec.rb
 - spec/models/account_holdings_spec.rb
+- spec/models/account_information_get_user_account_order_detail_request_spec.rb
 - spec/models/account_order_record_child_brokerage_order_ids_spec.rb
 - spec/models/account_order_record_option_symbol_spec.rb
 - spec/models/account_order_record_quote_currency_spec.rb
@@ -445,170 +447,171 @@ signing_key:
 specification_version: 4
 summary: SnapTrade Ruby Gem
 test_files:
+- spec/api/options_api_spec.rb
 - spec/api/trading_api_spec.rb
-- spec/api/connections_api_spec.rb
-- spec/api/reference_data_api_spec.rb
 - spec/api/transactions_and_reporting_api_spec.rb
-- spec/api/account_information_api_spec.rb
 - spec/api/api_status_api_spec.rb
+- spec/api/connections_api_spec.rb
+- spec/api/account_information_api_spec.rb
 - spec/api/authentication_api_spec.rb
-- spec/api/options_api_spec.rb
+- spec/api/reference_data_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/getting_started_spec.rb
-- spec/models/option_brokerage_symbol_spec.rb
-- spec/models/trading_instrument_spec.rb
-- spec/models/session_event_type_spec.rb
-- spec/models/account_order_record_status_spec.rb
-- spec/models/time_in_force_strict_spec.rb
-- spec/models/account_universal_activity_spec.rb
-- spec/models/mleg_order_type_strict_spec.rb
-- spec/models/type_spec.rb
-- spec/models/trading_search_cryptocurrency_pair_instruments200_response_spec.rb
-- spec/models/transactions_status_spec.rb
-- spec/models/encrypted_response_encrypted_message_data_spec.rb
-- spec/models/mleg_trade_form_spec.rb
-- spec/models/crypto_trading_instrument_spec.rb
+- spec/models/brokerage_type_spec.rb
 - spec/models/sub_period_return_rate_spec.rb
-- spec/models/validated_trade_body_spec.rb
+- spec/models/time_in_force_strict_spec.rb
 - spec/models/manual_trade_form_with_options_spec.rb
-- spec/models/mleg_instrument_type_spec.rb
+- spec/models/simple_order_form_spec.rb
+- spec/models/option_brokerage_symbol_spec.rb
+- spec/models/model402_brokerage_auth_disabled_response_spec.rb
 - spec/models/net_contributions_spec.rb
-- spec/models/symbols_quotes_inner_spec.rb
-- spec/models/account_spec.rb
-- spec/models/account_order_record_option_symbol_spec.rb
-- spec/models/position_symbol_spec.rb
-- spec/models/account_balance_total_spec.rb
-- spec/models/status_spec.rb
-- spec/models/us_exchange_spec.rb
-- spec/models/underlying_symbol_spec.rb
+- spec/models/delete_user_response_spec.rb
 - spec/models/snap_trade_login_user_request_body_spec.rb
-- spec/models/manual_trade_replace_form_spec.rb
-- spec/models/brokerage_authorization_refresh_confirmation_spec.rb
+- spec/models/order_updated_response_spec.rb
+- spec/models/symbol_query_spec.rb
+- spec/models/action_strict_with_options_spec.rb
+- spec/models/account_balance_spec.rb
 - spec/models/performance_custom_spec.rb
-- spec/models/cryptocurrency_pair_quote_spec.rb
-- spec/models/dividend_at_date_spec.rb
-- spec/models/mleg_leg_spec.rb
-- spec/models/auth_type_spec.rb
-- spec/models/option_chain_inner_spec.rb
-- spec/models/model404_failed_request_response_spec.rb
-- spec/models/crypto_order_form_spec.rb
-- spec/models/currency_spec.rb
-- spec/models/manual_trade_form_bracket_spec.rb
-- spec/models/crypto_order_preview_estimated_fee_spec.rb
-- spec/models/manual_trade_balance_spec.rb
-- spec/models/strategy_order_record_status_spec.rb
-- spec/models/model401_failed_request_response_spec.rb
-- spec/models/cryptocurrency_pair_spec.rb
-- spec/models/symbol_currency_spec.rb
-- spec/models/underlying_symbol_exchange_spec.rb
-- spec/models/account_holdings_account_spec.rb
-- spec/models/stop_loss_spec.rb
 - spec/models/take_profit_spec.rb
-- spec/models/login_redirect_uri_spec.rb
-- spec/models/snap_trade_holdings_total_value_spec.rb
-- spec/models/snap_trade_holdings_account_spec.rb
-- spec/models/manual_trade_spec.rb
-- spec/models/account_universal_activity_symbol_spec.rb
-- spec/models/balance_spec.rb
-- spec/models/holdings_status_spec.rb
-- spec/models/brokerage_instrument_spec.rb
-- spec/models/manual_trade_impact_spec.rb
-- spec/models/options_position_spec.rb
-- spec/models/model500_unexpected_exception_response_spec.rb
-- spec/models/balance_currency_spec.rb
-- spec/models/crypto_order_form_time_in_force_spec.rb
-- spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
-- spec/models/snap_trade_register_user_request_body_spec.rb
-- spec/models/options_symbol_spec.rb
-- spec/models/account_order_record_child_brokerage_order_ids_spec.rb
-- spec/models/authentication_login_snap_trade_user200_response_spec.rb
-- spec/models/encrypted_response_spec.rb
-- spec/models/strategy_quotes_greek_spec.rb
-- spec/models/brokerage_instruments_response_spec.rb
 - spec/models/account_order_record_spec.rb
-- spec/models/exchange_spec.rb
-- spec/models/security_type_spec.rb
-- spec/models/option_strategy_legs_inner_spec.rb
-- spec/models/account_balance_spec.rb
 - spec/models/rate_of_return_response_spec.rb
 - spec/models/manual_trade_and_impact_spec.rb
-- spec/models/session_event_spec.rb
-- spec/models/child_brokerage_order_ids_spec.rb
-- spec/models/underlying_symbol_type_spec.rb
-- spec/models/brokerage_authorization_type_read_only_spec.rb
-- spec/models/crypto_order_form_type_spec.rb
-- spec/models/model400_failed_request_response_spec.rb
-- spec/models/action_strict_spec.rb
-- spec/models/account_order_record_quote_universal_symbol_spec.rb
+- spec/models/manual_trade_spec.rb
+- spec/models/account_universal_activity_spec.rb
+- spec/models/symbols_quotes_inner_spec.rb
+- spec/models/past_value_spec.rb
 - spec/models/recent_orders_response_spec.rb
-- spec/models/brokerage_type_spec.rb
-- spec/models/paginated_universal_activity_spec.rb
-- spec/models/trading_cancel_user_account_order_request_spec.rb
-- spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
-- spec/models/account_status_spec.rb
-- spec/models/connections_session_events200_response_inner_spec.rb
-- spec/models/trading_instrument_type_spec.rb
-- spec/models/manual_trade_form_spec.rb
-- spec/models/rate_of_return_object_spec.rb
-- spec/models/monthly_dividends_spec.rb
-- spec/models/account_universal_activity_currency_spec.rb
-- spec/models/account_simple_spec.rb
-- spec/models/mleg_action_strict_spec.rb
-- spec/models/net_dividend_spec.rb
-- spec/models/simple_order_form_time_in_force_spec.rb
-- spec/models/brokerage_spec.rb
-- spec/models/symbol_query_spec.rb
-- spec/models/order_type_strict_spec.rb
+- spec/models/cryptocurrency_pair_spec.rb
+- spec/models/account_information_get_user_account_order_detail_request_spec.rb
+- spec/models/model404_failed_request_response_spec.rb
+- spec/models/strategy_type_spec.rb
+- spec/models/figi_instrument_spec.rb
+- spec/models/authentication_login_snap_trade_user200_response_spec.rb
+- spec/models/symbol_spec.rb
+- spec/models/options_position_currency_spec.rb
+- spec/models/snap_trade_holdings_account_spec.rb
+- spec/models/cryptocurrency_pair_quote_spec.rb
+- spec/models/position_symbol_spec.rb
+- spec/models/balance_spec.rb
+- spec/models/login_redirect_uri_spec.rb
+- spec/models/option_chain_inner_chain_per_root_inner_spec.rb
+- spec/models/encrypted_response_spec.rb
+- spec/models/model400_failed_request_response_spec.rb
+- spec/models/strategy_order_record_status_spec.rb
 - spec/models/universal_activity_spec.rb
-- spec/models/position_currency_spec.rb
-- spec/models/mleg_trading_instrument_spec.rb
+- spec/models/manual_trade_replace_form_spec.rb
+- spec/models/model403_failed_request_response_spec.rb
+- spec/models/mleg_trade_form_spec.rb
+- spec/models/account_order_record_child_brokerage_order_ids_spec.rb
+- spec/models/simple_order_form_type_spec.rb
+- spec/models/model425_failed_request_response_spec.rb
 - spec/models/timeframe_spec.rb
-- spec/models/cancel_order_response_spec.rb
-- spec/models/account_order_record_universal_symbol_spec.rb
-- spec/models/crypto_trading_instrument_type_spec.rb
-- spec/models/crypto_order_preview_spec.rb
-- spec/models/strategy_order_record_spec.rb
-- spec/models/action_strict_with_options_spec.rb
-- spec/models/symbol_exchange_spec.rb
-- spec/models/partner_data_spec.rb
-- spec/models/simple_order_form_spec.rb
-- spec/models/mleg_price_effect_strict_spec.rb
-- spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb
+- spec/models/balance_currency_spec.rb
+- spec/models/transactions_status_spec.rb
+- spec/models/manual_trade_symbol_spec.rb
+- spec/models/symbol_currency_spec.rb
+- spec/models/connection_portal_version_spec.rb
 - spec/models/model403_feature_not_enabled_response_spec.rb
-- spec/models/figi_instrument_spec.rb
+- spec/models/monthly_dividends_spec.rb
+- spec/models/account_order_record_universal_symbol_spec.rb
 - spec/models/brokerage_authorization_disabled_confirmation_spec.rb
-- spec/models/model425_failed_request_response_spec.rb
-- spec/models/pagination_details_spec.rb
-- spec/models/account_holdings_spec.rb
+- spec/models/trading_instrument_type_spec.rb
+- spec/models/crypto_order_form_time_in_force_spec.rb
+- spec/models/session_event_spec.rb
+- spec/models/account_order_record_quote_currency_spec.rb
+- spec/models/user_i_dand_secret_spec.rb
+- spec/models/mleg_trading_instrument_spec.rb
+- spec/models/stop_loss_spec.rb
 - spec/models/exchange_rate_pairs_spec.rb
-- spec/models/manual_trade_symbol_spec.rb
+- spec/models/crypto_order_preview_estimated_fee_spec.rb
+- spec/models/trading_search_cryptocurrency_pair_instruments200_response_spec.rb
+- spec/models/order_type_strict_spec.rb
 - spec/models/account_universal_activity_option_symbol_spec.rb
-- spec/models/strategy_quotes_spec.rb
-- spec/models/symbol_spec.rb
-- spec/models/account_order_record_quote_currency_spec.rb
-- spec/models/simple_order_form_type_spec.rb
-- spec/models/strategy_type_spec.rb
-- spec/models/account_sync_status_spec.rb
-- spec/models/model403_failed_request_response_spec.rb
-- spec/models/mleg_order_response_spec.rb
-- spec/models/option_strategy_spec.rb
+- spec/models/paginated_universal_activity_spec.rb
+- spec/models/account_holdings_account_spec.rb
+- spec/models/manual_trade_impact_spec.rb
 - spec/models/brokerage_authorization_spec.rb
-- spec/models/delete_user_response_spec.rb
-- spec/models/model402_brokerage_auth_disabled_response_spec.rb
-- spec/models/connection_portal_version_spec.rb
+- spec/models/crypto_order_preview_spec.rb
+- spec/models/account_order_record_quote_universal_symbol_spec.rb
+- spec/models/brokerage_authorization_refresh_confirmation_spec.rb
+- spec/models/crypto_order_form_spec.rb
+- spec/models/status_spec.rb
+- spec/models/snap_trade_holdings_total_value_spec.rb
+- spec/models/currency_spec.rb
 - spec/models/universal_symbol_spec.rb
-- spec/models/symbol_figi_instrument_spec.rb
-- spec/models/option_chain_inner_chain_per_root_inner_spec.rb
-- spec/models/option_leg_action_spec.rb
-- spec/models/position_spec.rb
+- spec/models/options_symbol_spec.rb
+- spec/models/account_status_spec.rb
+- spec/models/rate_of_return_object_spec.rb
 - spec/models/notional_value_spec.rb
-- spec/models/past_value_spec.rb
+- spec/models/mleg_instrument_type_spec.rb
+- spec/models/connections_session_events200_response_inner_spec.rb
+- spec/models/account_universal_activity_currency_spec.rb
+- spec/models/strategy_order_record_spec.rb
+- spec/models/option_strategy_spec.rb
+- spec/models/brokerage_authorization_type_read_only_spec.rb
+- spec/models/mleg_order_response_spec.rb
+- spec/models/account_order_record_option_symbol_spec.rb
+- spec/models/options_position_spec.rb
+- spec/models/action_strict_spec.rb
+- spec/models/mleg_action_strict_spec.rb
+- spec/models/mleg_leg_spec.rb
+- spec/models/model500_unexpected_exception_response_spec.rb
 - spec/models/manual_trade_form_notional_value_spec.rb
-- spec/models/options_position_currency_spec.rb
-- spec/models/connection_type_spec.rb
+- spec/models/mleg_price_effect_strict_spec.rb
+- spec/models/type_spec.rb
+- spec/models/trading_instrument_spec.rb
+- spec/models/brokerage_instruments_response_spec.rb
+- spec/models/account_universal_activity_symbol_spec.rb
+- spec/models/option_leg_action_spec.rb
+- spec/models/account_holdings_spec.rb
 - spec/models/option_leg_spec.rb
-- spec/models/user_i_dand_secret_spec.rb
-- spec/models/order_updated_response_spec.rb
+- spec/models/brokerage_instrument_spec.rb
+- spec/models/holdings_status_spec.rb
+- spec/models/mleg_order_type_strict_spec.rb
+- spec/models/encrypted_response_encrypted_message_data_spec.rb
+- spec/models/strategy_quotes_spec.rb
+- spec/models/crypto_trading_instrument_spec.rb
+- spec/models/model401_failed_request_response_spec.rb
+- spec/models/account_simple_spec.rb
+- spec/models/connection_type_spec.rb
+- spec/models/brokerage_spec.rb
+- spec/models/underlying_symbol_exchange_spec.rb
+- spec/models/manual_trade_form_spec.rb
+- spec/models/symbol_figi_instrument_spec.rb
+- spec/models/dividend_at_date_spec.rb
+- spec/models/snap_trade_register_user_request_body_spec.rb
+- spec/models/child_brokerage_order_ids_spec.rb
+- spec/models/option_strategy_legs_inner_spec.rb
+- spec/models/crypto_order_form_type_spec.rb
+- spec/models/us_exchange_spec.rb
+- spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb
+- spec/models/cancel_order_response_spec.rb
+- spec/models/account_spec.rb
+- spec/models/manual_trade_form_bracket_spec.rb
+- spec/models/auth_type_spec.rb
+- spec/models/simple_order_form_time_in_force_spec.rb
+- spec/models/account_order_record_status_spec.rb
 - spec/models/option_type_spec.rb
+- spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
+- spec/models/validated_trade_body_spec.rb
+- spec/models/trading_cancel_user_account_order_request_spec.rb
+- spec/models/underlying_symbol_spec.rb
+- spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
+- spec/models/partner_data_spec.rb
+- spec/models/underlying_symbol_type_spec.rb
+- spec/models/exchange_spec.rb
+- spec/models/pagination_details_spec.rb
+- spec/models/session_event_type_spec.rb
+- spec/models/account_sync_status_spec.rb
+- spec/models/option_chain_inner_spec.rb
+- spec/models/position_currency_spec.rb
+- spec/models/net_dividend_spec.rb
+- spec/models/symbol_exchange_spec.rb
+- spec/models/strategy_quotes_greek_spec.rb
+- spec/models/crypto_trading_instrument_type_spec.rb
+- spec/models/account_balance_total_spec.rb
+- spec/models/manual_trade_balance_spec.rb
+- spec/models/security_type_spec.rb
+- spec/models/position_spec.rb
 - spec/spec_helper.rb