snaptrade 2.0.128 → 2.0.130

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 626f5e2f3f2e1e9f8cf98974bb11e98c090f783971fd7451165cb8e649643d55
-  data.tar.gz: aed8e71c69da4adf9d749c04fda93f547a7d1cd81068308f5bf75652a4ab6cd4
+  metadata.gz: 0dc49b67f90f5e9a28d2b8c590d8514f89457beff1df9b9cd1a75b649294fbe0
+  data.tar.gz: ced33e858713edc3708556e07018652933215d1baf8718135fdb67726de5b66e
 SHA512:
-  metadata.gz: 0c1e9ceb5f4d8ee854293d281a4056fe9fa003d70e798c4f33e31535e9448d515887cc4d4e053c660203ded61189dc79972cd880e38e61883a17d209ef0fc826
-  data.tar.gz: e76261a8ffe0b401b56f296d5f9bf905b0a2c991e7f81e22aefaf81c94461e503dec0e8b1e5854e4d3ebca277d561dab01b5cb5550ebee3b1c0e29365fcbf58f
+  metadata.gz: 046bb0f9a485c00ea461ee3376aacaf49e9c711cd2f55283e8cae36ad1b15e3e87de95f131c3714717c14fd3c62f60fc25a01503131c6c8d1380042bf7a86d3d
+  data.tar.gz: f671bc8309b6787954e9a58702109c23bcbbcbafa14b2afadb6e330ba0ee5c2b13e87b81da4f76906daba8afd785c1e81f16be1bb36c5217ded91d503a898224

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.128)
+    snaptrade (2.0.130)
       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.128-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.128)
+[![npm](https://img.shields.io/badge/gem-v2.0.130-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.130)
 [![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.128'
+gem 'snaptrade', '~> 2.0.130'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -331,7 +331,7 @@ 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",
+  brokerage_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",
@@ -341,7 +341,7 @@ p result
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
-##### external_order_id: `String`<a id="external_order_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.
 
@@ -1370,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

@@ -505,15 +505,15 @@ module SnapTrade
     # 
     # This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
     #
-    # @param external_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    # @param brokerage_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
     # @param account_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param body [AccountInformationGetUserAccountOrderDetailRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_user_account_order_detail(external_order_id:, account_id:, user_id:, user_secret:, extra: {})
+    def get_user_account_order_detail(brokerage_order_id:, account_id:, user_id:, user_secret:, extra: {})
       _body = {}
-      _body[:external_order_id] = external_order_id if external_order_id != SENTINEL
+      _body[:brokerage_order_id] = brokerage_order_id if brokerage_order_id != SENTINEL
       account_information_get_user_account_order_detail_request = _body
       data, _status_code, _headers = get_user_account_order_detail_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, extra)
       data
@@ -527,15 +527,15 @@ module SnapTrade
     # 
     # This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
     #
-    # @param external_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    # @param brokerage_order_id [String] Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
     # @param account_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param body [AccountInformationGetUserAccountOrderDetailRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_user_account_order_detail_with_http_info(external_order_id:, account_id:, user_id:, user_secret:, extra: {})
+    def get_user_account_order_detail_with_http_info(brokerage_order_id:, account_id:, user_id:, user_secret:, extra: {})
       _body = {}
-      _body[:external_order_id] = external_order_id if external_order_id != SENTINEL
+      _body[:brokerage_order_id] = brokerage_order_id if brokerage_order_id != SENTINEL
       account_information_get_user_account_order_detail_request = _body
       get_user_account_order_detail_with_http_info_impl(account_id, user_id, user_secret, account_information_get_user_account_order_detail_request, extra)
     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

@@ -13,12 +13,12 @@ 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
+    attr_accessor :brokerage_order_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'external_order_id' => :'external_order_id'
+        :'brokerage_order_id' => :'brokerage_order_id'
       }
     end
 
@@ -30,7 +30,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'external_order_id' => :'String'
+        :'brokerage_order_id' => :'String'
       }
     end
 
@@ -55,8 +55,8 @@ module SnapTrade
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'external_order_id')
-        self.external_order_id = attributes[:'external_order_id']
+      if attributes.key?(:'brokerage_order_id')
+        self.brokerage_order_id = attributes[:'brokerage_order_id']
       end
     end
 
@@ -64,8 +64,8 @@ module SnapTrade
     # @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.')
+      if @brokerage_order_id.nil?
+        invalid_properties.push('invalid value for "brokerage_order_id", brokerage_order_id cannot be nil.')
       end
 
       invalid_properties
@@ -74,7 +74,7 @@ module SnapTrade
     # 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?
+      return false if @brokerage_order_id.nil?
       true
     end
 
@@ -83,7 +83,7 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          external_order_id == o.external_order_id
+          brokerage_order_id == o.brokerage_order_id
     end
 
     # @see the `==` method
@@ -95,7 +95,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [external_order_id].hash
+      [brokerage_order_id].hash
     end
 
     # Builds the object from hash

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.128'
+  VERSION = '2.0.130'
 end

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

@@ -20,7 +20,7 @@ describe SnapTrade::AccountInformationGetUserAccountOrderDetailRequest do
       expect(instance).to be_instance_of(SnapTrade::AccountInformationGetUserAccountOrderDetailRequest)
     end
   end
-  describe 'test attribute "external_order_id"' do
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.128
+  version: 2.0.130
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-09-02 00:00:00.000000000 Z
+date: 2025-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday