snaptrade 2.0.116 → 2.0.118

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 286bc72cce7d1cedbfdbb66011245dfdca9ad4d1639aeb1fccd7321bfbc991a3
-  data.tar.gz: 3f3cd48fa580c1045df50c4a9cfef7375d023bcdc6dbf1da7d5d0886c58ed03b
+  metadata.gz: 5eaa8a192b22fd8c36cafd97fdd0d530e53bc4c31808c01b6c8a5e521071fcba
+  data.tar.gz: 4ca620e1bed260b1b60e550156952bb1178c8db2c8d6496b871873c61e0e62e5
 SHA512:
-  metadata.gz: f64fb103fde2f463dce48793529c00452040b1f4b5d204c27e6687b0823a12b998a4b0fc4896d9506036b99a7e02fc58b4ad5095a6c540194a679aa901ff5e86
-  data.tar.gz: e171eb9563c35a6006e90d1579e2b10c51c520957151ab524aa8b19b6d2230406849f73a60730ea5db35b717233e3ce040b969b8f746fa9a3d9842713306093c
+  metadata.gz: 8a6ace54ffd9ed8996699d93fb408ad083b0269bf879a9ddb961b76b6da8191f7d8873b3f98f85fb4b14a28948d4b99468e65f709200b3ef17464c82ac08ac67
+  data.tar.gz: f747e4e76c31eb3bdbe9548a404ec3a28818a09cabd00d558274d605c87e02e42764f63f3243d0bf581e92f9c293ae0806696eb138b6eb6f088dc245889ed732

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.116)
+    snaptrade (2.0.118)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -29,7 +29,7 @@ GEM
     method_source (1.1.0)
     multipart-post (2.4.1)
     parallel (1.27.0)
-    parser (3.3.8.0)
+    parser (3.3.9.0)
       ast (~> 2.4.1)
       racc
     prism (1.4.0)

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.116-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.116)
+[![npm](https://img.shields.io/badge/gem-v2.0.118-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.118)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -55,6 +55,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.reference_data.get_symbols`](#snaptradereference_dataget_symbols)
   * [`snaptrade.reference_data.get_symbols_by_ticker`](#snaptradereference_dataget_symbols_by_ticker)
   * [`snaptrade.reference_data.list_all_brokerage_authorization_type`](#snaptradereference_datalist_all_brokerage_authorization_type)
+  * [`snaptrade.reference_data.list_all_brokerage_instruments`](#snaptradereference_datalist_all_brokerage_instruments)
   * [`snaptrade.reference_data.list_all_brokerages`](#snaptradereference_datalist_all_brokerages)
   * [`snaptrade.reference_data.list_all_currencies`](#snaptradereference_datalist_all_currencies)
   * [`snaptrade.reference_data.list_all_currencies_rates`](#snaptradereference_datalist_all_currencies_rates)
@@ -82,7 +83,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.116'
+gem 'snaptrade', '~> 2.0.118'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1468,6 +1469,35 @@ Comma separated value of brokerage slugs
 ---
 
 
+### `snaptrade.reference_data.list_all_brokerage_instruments`<a id="snaptradereference_datalist_all_brokerage_instruments"></a>
+
+Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.reference_data.list_all_brokerage_instruments(
+  brokerage_id: "87b24961-b51e-4db8-9226-f198f6518a89",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### brokerage_id: `String`<a id="brokerage_id-string"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[BrokerageInstrumentsResponse](./lib/snaptrade/models/brokerage_instruments_response.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/brokerages/{brokerageId}/instruments` `GET`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.reference_data.list_all_brokerages`<a id="snaptradereference_datalist_all_brokerages"></a>
 
 Returns a list of all defined Brokerage objects.
@@ -1603,13 +1633,16 @@ p result
 ##### 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>
+Order ID returned by brokerage. This is the unique identifier for the order in
+the brokerage system.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
-[OrderUpdatedResponse](./lib/snaptrade/models/order_updated_response.rb)
+[CancelOrderResponse](./lib/snaptrade/models/cancel_order_response.rb)
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
-`/accounts/{accountId}/trading/simple/{brokerageOrderId}/cancel` `POST`
+`/accounts/{accountId}/trading/cancel` `POST`
 
 [🔙 **Back to Table of Contents**](#table-of-contents)
 

data/lib/snaptrade/api/reference_data_api.rb

@@ -596,6 +596,91 @@ module SnapTrade
     end
 
 
+    # Get a list of instruments available on the brokerage.
+    #
+    # Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list.
+    #
+    # @param brokerage_id [String] 
+    # @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)
+      data
+    end
+
+    # Get a list of instruments available on the brokerage.
+    #
+    # Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list.
+    #
+    # @param brokerage_id [String] 
+    # @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)
+    end
+
+    # Get a list of instruments available on the brokerage.
+    # Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list.
+    # @param brokerage_id [String] 
+    # @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)
+      data
+    end
+
+    # Get a list of instruments available on the brokerage.
+    # Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list.
+    # @param brokerage_id [String] 
+    # @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 = {})
+      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"
+      end
+      # resource path
+      local_var_path = '/brokerages/{brokerageId}/instruments'.sub('{' + 'brokerageId' + '}', CGI.escape(brokerage_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || 'BrokerageInstrumentsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"ReferenceDataApi.list_all_brokerage_instruments",
+        :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: ReferenceDataApi#list_all_brokerage_instruments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
     # Get brokerages
     #
     # Returns a list of all defined Brokerage objects.

data/lib/snaptrade/api/trading_api.rb

@@ -17,55 +17,63 @@ module SnapTrade
       @api_client = api_client
     end
 
-    # Cancel crypto order
+    # Cancel order
     #
     # Cancels an order in the specified account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param brokerage_order_id [String] 
+    # @param brokerage_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    # @param body [TradingCancelUserAccountOrderRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def cancel_order(user_id:, user_secret:, account_id:, brokerage_order_id:, extra: {})
-      data, _status_code, _headers = cancel_order_with_http_info_impl(user_id, user_secret, account_id, brokerage_order_id, extra)
+    def cancel_order(user_id:, user_secret:, account_id:, brokerage_order_id: SENTINEL, extra: {})
+      _body = {}
+      _body[:brokerage_order_id] = brokerage_order_id if brokerage_order_id != SENTINEL
+      trading_cancel_user_account_order_request = _body
+      data, _status_code, _headers = cancel_order_with_http_info_impl(user_id, user_secret, account_id, trading_cancel_user_account_order_request, extra)
       data
     end
 
-    # Cancel crypto order
+    # Cancel order
     #
     # Cancels an order in the specified account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param brokerage_order_id [String] 
+    # @param brokerage_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    # @param body [TradingCancelUserAccountOrderRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def cancel_order_with_http_info(user_id:, user_secret:, account_id:, brokerage_order_id:, extra: {})
-      cancel_order_with_http_info_impl(user_id, user_secret, account_id, brokerage_order_id, extra)
+    def cancel_order_with_http_info(user_id:, user_secret:, account_id:, brokerage_order_id: SENTINEL, extra: {})
+      _body = {}
+      _body[:brokerage_order_id] = brokerage_order_id if brokerage_order_id != SENTINEL
+      trading_cancel_user_account_order_request = _body
+      cancel_order_with_http_info_impl(user_id, user_secret, account_id, trading_cancel_user_account_order_request, extra)
     end
 
-    # Cancel crypto order
+    # Cancel order
     # Cancels an order in the specified account. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param brokerage_order_id [String] 
+    # @param trading_cancel_user_account_order_request [TradingCancelUserAccountOrderRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [OrderUpdatedResponse]
-    private def cancel_order_impl(user_id, user_secret, account_id, brokerage_order_id, opts = {})
-      data, _status_code, _headers = cancel_order_with_http_info(user_id, user_secret, account_id, brokerage_order_id, opts)
+    # @return [CancelOrderResponse]
+    private def cancel_order_impl(user_id, user_secret, account_id, trading_cancel_user_account_order_request, opts = {})
+      data, _status_code, _headers = cancel_order_with_http_info(user_id, user_secret, account_id, trading_cancel_user_account_order_request, opts)
       data
     end
 
-    # Cancel crypto order
+    # Cancel order
     # Cancels an order in the specified account. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param brokerage_order_id [String] 
+    # @param trading_cancel_user_account_order_request [TradingCancelUserAccountOrderRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(OrderUpdatedResponse, Integer, Hash)>] OrderUpdatedResponse data, response status code and response headers
-    private def cancel_order_with_http_info_impl(user_id, user_secret, account_id, brokerage_order_id, opts = {})
+    # @return [Array<(CancelOrderResponse, Integer, Hash)>] CancelOrderResponse data, response status code and response headers
+    private def cancel_order_with_http_info_impl(user_id, user_secret, account_id, trading_cancel_user_account_order_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TradingApi.cancel_order ...'
       end
@@ -81,12 +89,12 @@ module SnapTrade
       if @api_client.config.client_side_validation && account_id.nil?
         fail ArgumentError, "Missing the required parameter 'account_id' when calling TradingApi.cancel_order"
       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 TradingApi.cancel_order"
+      # verify the required parameter 'trading_cancel_user_account_order_request' is set
+      if @api_client.config.client_side_validation && trading_cancel_user_account_order_request.nil?
+        fail ArgumentError, "Missing the required parameter 'trading_cancel_user_account_order_request' when calling TradingApi.cancel_order"
       end
       # resource path
-      local_var_path = '/accounts/{accountId}/trading/simple/{brokerageOrderId}/cancel'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'brokerageOrderId' + '}', CGI.escape(brokerage_order_id.to_s))
+      local_var_path = '/accounts/{accountId}/trading/cancel'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -97,15 +105,20 @@ 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(trading_cancel_user_account_order_request)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'OrderUpdatedResponse'
+      return_type = opts[:debug_return_type] || 'CancelOrderResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']

data/lib/snaptrade/models/brokerage_instrument.rb

@@ -0,0 +1,261 @@
+=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 BrokerageInstrument
+    # The instrument's trading symbol / ticker.
+    attr_accessor :symbol
+
+    # The MIC code of the exchange where the instrument is traded.
+    attr_accessor :exchange_mic
+
+    # Whether the instrument is tradeable through the brokerage. `null` if the tradeability is unknown.
+    attr_accessor :tradeable
+
+    # Whether the instrument allows fractional units. `null` if the fractionability is unknown.
+    attr_accessor :fractionable
+
+    # The universal symbol ID of the instrument. This is the ID used to reference the instrument in SnapTrade API calls.
+    attr_accessor :universal_symbol_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'symbol' => :'symbol',
+        :'exchange_mic' => :'exchange_mic',
+        :'tradeable' => :'tradeable',
+        :'fractionable' => :'fractionable',
+        :'universal_symbol_id' => :'universal_symbol_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
+      {
+        :'symbol' => :'String',
+        :'exchange_mic' => :'String',
+        :'tradeable' => :'Boolean',
+        :'fractionable' => :'Boolean',
+        :'universal_symbol_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'exchange_mic',
+        :'tradeable',
+        :'fractionable',
+        :'universal_symbol_id'
+      ])
+    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::BrokerageInstrument` 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::BrokerageInstrument`. 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?(:'symbol')
+        self.symbol = attributes[:'symbol']
+      end
+
+      if attributes.key?(:'exchange_mic')
+        self.exchange_mic = attributes[:'exchange_mic']
+      end
+
+      if attributes.key?(:'tradeable')
+        self.tradeable = attributes[:'tradeable']
+      end
+
+      if attributes.key?(:'fractionable')
+        self.fractionable = attributes[:'fractionable']
+      end
+
+      if attributes.key?(:'universal_symbol_id')
+        self.universal_symbol_id = attributes[:'universal_symbol_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
+      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?
+      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 &&
+          symbol == o.symbol &&
+          exchange_mic == o.exchange_mic &&
+          tradeable == o.tradeable &&
+          fractionable == o.fractionable &&
+          universal_symbol_id == o.universal_symbol_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
+      [symbol, exchange_mic, tradeable, fractionable, universal_symbol_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_instruments_response.rb

@@ -0,0 +1,218 @@
+=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 BrokerageInstrumentsResponse
+    attr_accessor :instruments
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'instruments' => :'instruments'
+      }
+    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
+      {
+        :'instruments' => :'Array<BrokerageInstrument>'
+      }
+    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::BrokerageInstrumentsResponse` 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::BrokerageInstrumentsResponse`. 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?(:'instruments')
+        if (value = attributes[:'instruments']).is_a?(Array)
+          self.instruments = value
+        end
+      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
+      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?
+      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 &&
+          instruments == o.instruments
+    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
+      [instruments].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/cancel_order_response.rb

@@ -0,0 +1,235 @@
+=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 CancelOrderResponse
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    attr_accessor :brokerage_order_id
+
+    # The raw response from the brokerage.
+    attr_accessor :raw_response
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'brokerage_order_id' => :'brokerage_order_id',
+        :'raw_response' => :'raw_response'
+      }
+    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
+      {
+        :'brokerage_order_id' => :'String',
+        :'raw_response' => :'Hash<String, Object>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'raw_response'
+      ])
+    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::CancelOrderResponse` 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::CancelOrderResponse`. 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?(:'brokerage_order_id')
+        self.brokerage_order_id = attributes[:'brokerage_order_id']
+      end
+
+      if attributes.key?(:'raw_response')
+        if (value = attributes[:'raw_response']).is_a?(Hash)
+          self.raw_response = value
+        end
+      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 @brokerage_order_id.nil?
+        invalid_properties.push('invalid value for "brokerage_order_id", brokerage_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 @brokerage_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 &&
+          brokerage_order_id == o.brokerage_order_id &&
+          raw_response == o.raw_response
+    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
+      [brokerage_order_id, raw_response].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/version.rb

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

data/lib/snaptrade.rb

@@ -47,7 +47,10 @@ require 'snaptrade/models/brokerage_authorization_disabled_confirmation'
 require 'snaptrade/models/brokerage_authorization_refresh_confirmation'
 require 'snaptrade/models/brokerage_authorization_type_read_only'
 require 'snaptrade/models/brokerage_authorization_type_read_only_brokerage'
+require 'snaptrade/models/brokerage_instrument'
+require 'snaptrade/models/brokerage_instruments_response'
 require 'snaptrade/models/brokerage_type'
+require 'snaptrade/models/cancel_order_response'
 require 'snaptrade/models/child_brokerage_order_ids'
 require 'snaptrade/models/connection_portal_version'
 require 'snaptrade/models/connection_type'

data/spec/api/reference_data_api_spec.rb

@@ -108,6 +108,18 @@ describe 'ReferenceDataApi' do
     end
   end
 
+  # unit tests for list_all_brokerage_instruments
+  # Get a list of instruments available on the brokerage.
+  # Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list.
+  # @param brokerage_id 
+  # @param [Hash] opts the optional parameters
+  # @return [BrokerageInstrumentsResponse]
+  describe 'list_all_brokerage_instruments 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 list_all_brokerages
   # Get brokerages
   # Returns a list of all defined Brokerage objects.

data/spec/api/trading_api_spec.rb

@@ -28,14 +28,14 @@ describe 'TradingApi' do
   end
 
   # unit tests for cancel_order
-  # Cancel crypto order
+  # Cancel order
   # Cancels an order in the specified account. 
   # @param user_id 
   # @param user_secret 
   # @param account_id 
-  # @param brokerage_order_id 
+  # @param trading_cancel_user_account_order_request 
   # @param [Hash] opts the optional parameters
-  # @return [OrderUpdatedResponse]
+  # @return [CancelOrderResponse]
   describe 'cancel_order test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/brokerage_instrument_spec.rb

@@ -0,0 +1,53 @@
+=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::BrokerageInstrument
+describe SnapTrade::BrokerageInstrument do
+  let(:instance) { SnapTrade::BrokerageInstrument.new }
+
+  describe 'test an instance of BrokerageInstrument' do
+    it 'should create an instance of BrokerageInstrument' do
+      expect(instance).to be_instance_of(SnapTrade::BrokerageInstrument)
+    end
+  end
+  describe 'test attribute "symbol"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "exchange_mic"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "tradeable"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "fractionable"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "universal_symbol_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/brokerage_instruments_response_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::BrokerageInstrumentsResponse
+describe SnapTrade::BrokerageInstrumentsResponse do
+  let(:instance) { SnapTrade::BrokerageInstrumentsResponse.new }
+
+  describe 'test an instance of BrokerageInstrumentsResponse' do
+    it 'should create an instance of BrokerageInstrumentsResponse' do
+      expect(instance).to be_instance_of(SnapTrade::BrokerageInstrumentsResponse)
+    end
+  end
+  describe 'test attribute "instruments"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/cancel_order_response_spec.rb

@@ -0,0 +1,35 @@
+=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::CancelOrderResponse
+describe SnapTrade::CancelOrderResponse do
+  let(:instance) { SnapTrade::CancelOrderResponse.new }
+
+  describe 'test an instance of CancelOrderResponse' do
+    it 'should create an instance of CancelOrderResponse' do
+      expect(instance).to be_instance_of(SnapTrade::CancelOrderResponse)
+    end
+  end
+  describe 'test attribute "brokerage_order_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "raw_response"' 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.116
+  version: 2.0.118
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-07-23 00:00:00.000000000 Z
+date: 2025-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -126,7 +126,10 @@ files:
 - lib/snaptrade/models/brokerage_authorization_refresh_confirmation.rb
 - lib/snaptrade/models/brokerage_authorization_type_read_only.rb
 - lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb
+- lib/snaptrade/models/brokerage_instrument.rb
+- lib/snaptrade/models/brokerage_instruments_response.rb
 - lib/snaptrade/models/brokerage_type.rb
+- lib/snaptrade/models/cancel_order_response.rb
 - lib/snaptrade/models/child_brokerage_order_ids.rb
 - lib/snaptrade/models/connection_portal_version.rb
 - lib/snaptrade/models/connection_type.rb
@@ -286,8 +289,11 @@ files:
 - spec/models/brokerage_authorization_spec.rb
 - spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
 - spec/models/brokerage_authorization_type_read_only_spec.rb
+- spec/models/brokerage_instrument_spec.rb
+- spec/models/brokerage_instruments_response_spec.rb
 - spec/models/brokerage_spec.rb
 - spec/models/brokerage_type_spec.rb
+- spec/models/cancel_order_response_spec.rb
 - spec/models/child_brokerage_order_ids_spec.rb
 - spec/models/connection_portal_version_spec.rb
 - spec/models/connection_type_spec.rb
@@ -442,6 +448,7 @@ test_files:
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/getting_started_spec.rb
+- spec/models/brokerage_instruments_response_spec.rb
 - spec/models/underlying_symbol_type_spec.rb
 - spec/models/action_strict_spec.rb
 - spec/models/order_updated_response_spec.rb
@@ -449,6 +456,7 @@ test_files:
 - spec/models/trading_search_cryptocurrency_pair_instruments200_response_spec.rb
 - spec/models/account_order_record_quote_universal_symbol_spec.rb
 - spec/models/session_event_spec.rb
+- spec/models/cancel_order_response_spec.rb
 - spec/models/manual_trade_impact_spec.rb
 - spec/models/manual_trade_form_notional_value_spec.rb
 - spec/models/symbol_query_spec.rb
@@ -491,6 +499,7 @@ test_files:
 - spec/models/universal_symbol_spec.rb
 - spec/models/model404_failed_request_response_spec.rb
 - spec/models/model425_failed_request_response_spec.rb
+- spec/models/brokerage_instrument_spec.rb
 - spec/models/validated_trade_body_spec.rb
 - spec/models/option_brokerage_symbol_spec.rb
 - spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb