snaptrade 2.0.129 → 2.0.131

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fec778920b549791f66f45c16297693da67c706839886de97a8fbb522a81b8bf
-  data.tar.gz: 90405fd88ab9edf3b6c27409e5331e40c5722a49abc00384b487832d2240bf2d
+  metadata.gz: aa9509ec89bcf39b195b067ed454bcc1a2944e65f8676e8e2770ec1777a5578a
+  data.tar.gz: 90b79e3638a7a0e2db1b41dd5a71570a4ea360e4be5cf70dc90a6e6db9aa9d40
 SHA512:
-  metadata.gz: fd847e8941992c09c6fbea2a2817ae638aeded1ae781cfa0bddee54ccbfd8f8a5dd5a6a37b2bf1c14c27bbe41b31bd9f251bd53a030ac5da38388be4de89dcb9
-  data.tar.gz: f746f821017a9ac832b655a81f84a4878858e95ff0ea933f7485e1f849804d5a22ed14f16e1676c1f8f6e9858b3da6492f8bd73c116e404e08ce46d328871cf9
+  metadata.gz: 461ea85ac75a96dbff5bd0bcdb0758cb73821d16135c522b2e80b214de08ab1ac16bbdc8c0b5fec5dc751afe7b55cde8ee7237cc59f2b7e0f14e2be2b6400f8c
+  data.tar.gz: 9eaeeaf04bdbc868f1b04fd4f84c1d07dece87e30a51e12f0aa35a3a2961542ecc757a406ba0fe3548b39d524907b6f7c1bbea3729ba880fffe4685637d141c9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.129)
+    snaptrade (2.0.131)
       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.129-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.129)
+[![npm](https://img.shields.io/badge/gem-v2.0.131-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.131)
 [![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.129'
+gem 'snaptrade', '~> 2.0.131'
 ```
 
 ## 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.
 
@@ -747,8 +747,10 @@ left empty unless you are reconnecting a disabled connection. See the [guide on
 fixing broken connections](/docs/fix-broken-connections) for more information.
 
 ##### connectionType: [`ConnectionType`](./lib/snaptrade/models/connection_type.rb)<a id="connectiontype-connectiontypelibsnaptrademodelsconnection_typerb"></a>
-Sets whether the connection should be read-only or trade-enabled. Defaults to
-read-only if not specified.
+Determines connection permissions (default: read) - `read`: Data access only. -
+`trade`: Data and trading access. - `trade-if-available`: Attempts to establish
+a trading connection if the brokerage supports it, otherwise falls back to
+read-only access automatically.
 
 ##### connectionPortalVersion: [`ConnectionPortalVersion`](./lib/snaptrade/models/connection_portal_version.rb)<a id="connectionportalversion-connectionportalversionlibsnaptrademodelsconnection_portal_versionrb"></a>
 Sets the connection portal version to render. Currently only v4 is supported and

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/authentication_api.rb

@@ -192,7 +192,7 @@ module SnapTrade
     # @param immediate_redirect [Boolean] When set to `true`, user will be redirected back to the partner's site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](/docs/implement-connection-portal) for more information.
     # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](/docs/implement-connection-portal) for more information.
     # @param reconnect [String] The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](/docs/fix-broken-connections) for more information.
-    # @param connection_type [ConnectionType] Sets whether the connection should be read-only or trade-enabled. Defaults to read-only if not specified.
+    # @param connection_type [ConnectionType] Determines connection permissions (default: read) - `read`: Data access only. - `trade`: Data and trading access. - `trade-if-available`: Attempts to establish a trading connection if the brokerage supports it, otherwise falls back to read-only access automatically. 
     # @param connection_portal_version [ConnectionPortalVersion] Sets the connection portal version to render. Currently only v4 is supported and is the default. All other versions are deprecated and will automatically be set to v4.
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -221,7 +221,7 @@ module SnapTrade
     # @param immediate_redirect [Boolean] When set to `true`, user will be redirected back to the partner's site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](/docs/implement-connection-portal) for more information.
     # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](/docs/implement-connection-portal) for more information.
     # @param reconnect [String] The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](/docs/fix-broken-connections) for more information.
-    # @param connection_type [ConnectionType] Sets whether the connection should be read-only or trade-enabled. Defaults to read-only if not specified.
+    # @param connection_type [ConnectionType] Determines connection permissions (default: read) - `read`: Data access only. - `trade`: Data and trading access. - `trade-if-available`: Attempts to establish a trading connection if the brokerage supports it, otherwise falls back to read-only access automatically. 
     # @param connection_portal_version [ConnectionPortalVersion] Sets the connection portal version to render. Currently only v4 is supported and is the default. All other versions are deprecated and will automatically be set to v4.
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name

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/connection_type.rb

@@ -14,9 +14,10 @@ module SnapTrade
   class ConnectionType
     READ = "read".freeze
     TRADE = "trade".freeze
+    TRADE_IF_AVAILABLE = "trade-if-available".freeze
 
     def self.all_vars
-      @all_vars ||= [READ, TRADE].freeze
+      @all_vars ||= [READ, TRADE, TRADE_IF_AVAILABLE].freeze
     end
 
     # Builds the enum from string

data/lib/snaptrade/models/snap_trade_login_user_request_body.rb

@@ -25,7 +25,7 @@ module SnapTrade
     # The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](/docs/fix-broken-connections) for more information.
     attr_accessor :reconnect
 
-    # Sets whether the connection should be read-only or trade-enabled. Defaults to read-only if not specified.
+    # Determines connection permissions (default: read) - `read`: Data access only. - `trade`: Data and trading access. - `trade-if-available`: Attempts to establish a trading connection if the brokerage supports it, otherwise falls back to read-only access automatically. 
     attr_accessor :connection_type
 
     # Sets the connection portal version to render. Currently only v4 is supported and is the default. All other versions are deprecated and will automatically be set to v4.

data/lib/snaptrade/version.rb

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

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.129
+  version: 2.0.131
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-09-03 00:00:00.000000000 Z
+date: 2025-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday