snaptrade 2.0.89 → 2.0.91

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3576aa4c476648b0c5c665897f8f421557a9e130f8926ba44c85a477d10e1a19
-  data.tar.gz: dc796c3d61f25d85dd3513cb734dbd6949f4aa82cc4b9d4a271a0935cd1a2a05
+  metadata.gz: 96a36a98aeb1fb6c97d243813734decf01f1ce9ea45c28c42ca570e19487e799
+  data.tar.gz: '0346728bf405a16ba477eb478daba50e79c478f2e99a025b87a0b75429e0e848'
 SHA512:
-  metadata.gz: fee5927ebd2bc599b69f22096d156b5deeac92f60e5e32d9e792f676359b8785b80dc06171688adf53d98acb06646a9d248d5ce6a9e8d53332d53d3dd3cc1fb1
-  data.tar.gz: f6423adbcc685f9c91e05874d210499ac10167038c9eb294bb4c6a15c72e04aa123e8073449bf730c63025f0c91c52074972674a8688a6af292e040f94190f7d
+  metadata.gz: e72cd583e3751f9ac6353208835835c7202f2fc4cbf58ddedc4b5ce95f7c147441bb412419f883db2826bb72393037cd0359fc6efd754850b5b3d834f6e2d332
+  data.tar.gz: 626060577c3f93fc74cc948420bc085223d40ce1b8f8aa68160fff700ec89928984c95fc61c0c7fc8268990a51e641d6331a7a17735aba8e86f053bdd178b92c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.89)
+    snaptrade (2.0.91)
       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.26.3)
-    parser (3.3.7.3)
+    parser (3.3.7.4)
       ast (~> 2.4.1)
       racc
     prism (1.4.0)
@@ -43,7 +43,7 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.10.0)
-    reline (0.6.0)
+    reline (0.6.1)
       io-console (~> 0.5)
     rexml (3.4.1)
     rspec (3.13.0)
@@ -68,7 +68,7 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.43.0)
+    rubocop-ast (1.44.0)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     ruby-progressbar (1.13.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.89-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.89)
+[![npm](https://img.shields.io/badge/gem-v2.0.91-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.91)
 [![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.89'
+gem 'snaptrade', '~> 2.0.91'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -840,7 +840,7 @@ p result
 Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections.
 Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.
 
-*Please contact us in order to use this endpoint as it is disabled by default.*
+This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -911,9 +911,9 @@ p result
 ### `snaptrade.connections.refresh_brokerage_authorization`<a id="snaptradeconnectionsrefresh_brokerage_authorization"></a>
 
 Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
-This endpoint will also trigger a transaction sync for the past day if one has not yet occured.
+This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
 
-*Please contact support for access as this endpoint is not enabled by default.*
+**Please contact support before use. Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge of $0.05**
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>

data/lib/snaptrade/api/account_information_api.rb

@@ -497,7 +497,7 @@ module SnapTrade
     end
 
 
-    # List account recent orders
+    # List account orders
     #
     # Returns a list of recent orders in the specified account.
     # 
@@ -516,7 +516,7 @@ module SnapTrade
       data
     end
 
-    # List account recent orders
+    # List account orders
     #
     # Returns a list of recent orders in the specified account.
     # 
@@ -534,7 +534,7 @@ module SnapTrade
       get_user_account_orders_with_http_info_impl(user_id, user_secret, account_id, extra)
     end
 
-    # List account recent orders
+    # List account orders
     # Returns a list of recent orders in the specified account.  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -548,7 +548,7 @@ module SnapTrade
       data
     end
 
-    # List account recent orders
+    # List account orders
     # Returns a list of recent orders in the specified account.  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 
     # @param user_id [String] 
     # @param user_secret [String] 

data/lib/snaptrade/api/authentication_api.rb

@@ -324,7 +324,7 @@ module SnapTrade
     # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     # @param body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def register_snap_trade_user(user_id: SENTINEL, extra: {})
+    def register_snap_trade_user(user_id:, extra: {})
       _body = {}
       _body[:userId] = user_id if user_id != SENTINEL
       snap_trade_register_user_request_body = _body
@@ -340,7 +340,7 @@ module SnapTrade
     # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     # @param body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def register_snap_trade_user_with_http_info(user_id: SENTINEL, extra: {})
+    def register_snap_trade_user_with_http_info(user_id:, extra: {})
       _body = {}
       _body[:userId] = user_id if user_id != SENTINEL
       snap_trade_register_user_request_body = _body

data/lib/snaptrade/api/connections_api.rb

@@ -125,7 +125,7 @@ module SnapTrade
     # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections.
     # Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.
     # 
-    # *Please contact us in order to use this endpoint as it is disabled by default.*
+    # This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default.
     #
     # @param authorization_id [String] 
     # @param user_id [String] 
@@ -141,7 +141,7 @@ module SnapTrade
     # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections.
     # Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.
     # 
-    # *Please contact us in order to use this endpoint as it is disabled by default.*
+    # This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default.
     #
     # @param authorization_id [String] 
     # @param user_id [String] 
@@ -152,7 +152,7 @@ module SnapTrade
     end
 
     # Force disable connection
-    # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.* 
+    # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.  This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default. 
     # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -164,7 +164,7 @@ module SnapTrade
     end
 
     # Force disable connection
-    # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.* 
+    # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.  This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default. 
     # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -335,9 +335,9 @@ module SnapTrade
     # Refresh holdings for a connection
     #
     # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
-    # This endpoint will also trigger a transaction sync for the past day if one has not yet occured.
+    # This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
     # 
-    # *Please contact support for access as this endpoint is not enabled by default.*
+    # **Please contact support before use. Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge of $0.05**
     #
     # @param authorization_id [String] 
     # @param user_id [String] 
@@ -351,9 +351,9 @@ module SnapTrade
     # Refresh holdings for a connection
     #
     # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
-    # This endpoint will also trigger a transaction sync for the past day if one has not yet occured.
+    # This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
     # 
-    # *Please contact support for access as this endpoint is not enabled by default.*
+    # **Please contact support before use. Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge of $0.05**
     #
     # @param authorization_id [String] 
     # @param user_id [String] 
@@ -364,7 +364,7 @@ module SnapTrade
     end
 
     # Refresh holdings for a connection
-    # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured.  *Please contact support for access as this endpoint is not enabled by default.* 
+    # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.  **Please contact support before use. Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge of $0.05** 
     # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -376,7 +376,7 @@ module SnapTrade
     end
 
     # Refresh holdings for a connection
-    # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured.  *Please contact support for access as this endpoint is not enabled by default.* 
+    # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.  **Please contact support before use. Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge of $0.05** 
     # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 

data/lib/snaptrade/models/account.rb

@@ -35,6 +35,9 @@ module SnapTrade
 
     attr_accessor :balance
 
+    # The account type as provided by the brokerage
+    attr_accessor :raw_type
+
     # Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version.
     attr_accessor :meta
 
@@ -44,9 +47,6 @@ module SnapTrade
     # This field is deprecated.
     attr_accessor :cash_restrictions
 
-    # The account type as provided by the brokerage
-    attr_accessor :raw_type
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -58,10 +58,10 @@ module SnapTrade
         :'created_date' => :'created_date',
         :'sync_status' => :'sync_status',
         :'balance' => :'balance',
+        :'raw_type' => :'raw_type',
         :'meta' => :'meta',
         :'portfolio_group' => :'portfolio_group',
-        :'cash_restrictions' => :'cash_restrictions',
-        :'raw_type' => :'raw_type'
+        :'cash_restrictions' => :'cash_restrictions'
       }
     end
 
@@ -81,10 +81,10 @@ module SnapTrade
         :'created_date' => :'Time',
         :'sync_status' => :'AccountSyncStatus',
         :'balance' => :'AccountBalance',
+        :'raw_type' => :'String',
         :'meta' => :'Hash<String, Object>',
         :'portfolio_group' => :'String',
-        :'cash_restrictions' => :'Array<String>',
-        :'raw_type' => :'String'
+        :'cash_restrictions' => :'Array<String>'
       }
     end
 
@@ -92,7 +92,7 @@ module SnapTrade
     def self.openapi_nullable
       Set.new([
         :'name',
-        :'raw_type'
+        :'raw_type',
       ])
     end
 
@@ -143,6 +143,10 @@ module SnapTrade
         self.balance = attributes[:'balance']
       end
 
+      if attributes.key?(:'raw_type')
+        self.raw_type = attributes[:'raw_type']
+      end
+
       if attributes.key?(:'meta')
         if (value = attributes[:'meta']).is_a?(Hash)
           self.meta = value
@@ -158,10 +162,6 @@ module SnapTrade
           self.cash_restrictions = value
         end
       end
-
-      if attributes.key?(:'raw_type')
-        self.raw_type = attributes[:'raw_type']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -225,10 +225,10 @@ module SnapTrade
           created_date == o.created_date &&
           sync_status == o.sync_status &&
           balance == o.balance &&
+          raw_type == o.raw_type &&
           meta == o.meta &&
           portfolio_group == o.portfolio_group &&
-          cash_restrictions == o.cash_restrictions &&
-          raw_type == o.raw_type
+          cash_restrictions == o.cash_restrictions
     end
 
     # @see the `==` method
@@ -240,7 +240,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, brokerage_authorization, name, number, institution_name, created_date, sync_status, balance, meta, portfolio_group, cash_restrictions, raw_type].hash
+      [id, brokerage_authorization, name, number, institution_name, created_date, sync_status, balance, raw_type, meta, portfolio_group, cash_restrictions].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/snap_trade_register_user_request_body.rb

@@ -65,12 +65,17 @@ module SnapTrade
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @user_id.nil?
+        invalid_properties.push('invalid value for "user_id", user_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 @user_id.nil?
       true
     end
 

data/lib/snaptrade/models/trading_instrument.rb

@@ -15,7 +15,7 @@ module SnapTrade
     # The instrument's trading ticker symbol
     attr_accessor :symbol
 
-    # The type of the instrument
+    # The instrument's type
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/version.rb

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

data/spec/api/account_information_api_spec.rb

@@ -89,7 +89,7 @@ describe 'AccountInformationApi' do
   end
 
   # unit tests for get_user_account_orders
-  # List account recent orders
+  # List account orders
   # Returns a list of recent orders in the specified account.  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 
   # @param user_id 
   # @param user_secret 

data/spec/api/connections_api_spec.rb

@@ -43,7 +43,7 @@ describe 'ConnectionsApi' do
 
   # unit tests for disable_brokerage_authorization
   # Force disable connection
-  # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.* 
+  # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.  This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default. 
   # @param authorization_id 
   # @param user_id 
   # @param user_secret 
@@ -70,7 +70,7 @@ describe 'ConnectionsApi' do
 
   # unit tests for refresh_brokerage_authorization
   # Refresh holdings for a connection
-  # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured.  *Please contact support for access as this endpoint is not enabled by default.* 
+  # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.  **Please contact support before use. Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge of $0.05** 
   # @param authorization_id 
   # @param user_id 
   # @param user_secret 

data/spec/models/account_spec.rb

@@ -68,25 +68,25 @@ describe SnapTrade::Account do
     end
   end
 
-  describe 'test attribute "meta"' do
+  describe 'test attribute "raw_type"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "portfolio_group"' do
+  describe 'test attribute "meta"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "cash_restrictions"' do
+  describe 'test attribute "portfolio_group"' 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_type"' do
+  describe 'test attribute "cash_restrictions"' 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.89
+  version: 2.0.91
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-29 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday