snaptrade 2.0.197 → 2.0.198

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcbc842836424cdfc1f7b62023633b4663fc8b27e70b2d0c743e713590a8b7de
-  data.tar.gz: 5d3ea3e6598f63336d2453a61a9ad264de2c573c5b5889800d1b5b436357a036
+  metadata.gz: 549dce81d5aba7fd22eb51ae0c30a30bd265beaf349ae8e494d6f548e93d8dad
+  data.tar.gz: a848545dc765563b8f295e6fe64a440949290ebc37217b820e9c0f4397a998f3
 SHA512:
-  metadata.gz: af50e106dbade938c3f7c177dffc031be8c787c1a3b4af969ebf27aeadf335982385a4b9a0bc4f4218cb4824f8b569ee5003bbd00d27fce7dfc811c69dbf869b
-  data.tar.gz: 9739208a6b3ac13f3444edd4bc7f6ddf843805b675aa07516efa8fb333327a215325705e1e2d6d5a0c27904d3ccf4770f42428dc5b2935c3a8eb63c6cb431202
+  metadata.gz: 5cf4015c11eff238a93863fe4cb99e9441693da9b9f5d1725f5014b168478fde0060e16bd66d997bfc5cbce3d875159b69b5a7026441e2e18d9bce411469672b
+  data.tar.gz: 33af1227b4f7025da23afe774d5b6abee0792678c0e55322ce30bab5d47c8a927623c93d72e62c653d976cb13b088217577548fcadd31ef15356849e097b7af2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.197)
+    snaptrade (2.0.198)
       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.197-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.197)
+[![npm](https://img.shields.io/badge/gem-v2.0.198-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.198)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -48,6 +48,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.connections.remove_brokerage_authorization`](#snaptradeconnectionsremove_brokerage_authorization)
   * [`snaptrade.connections.return_rates`](#snaptradeconnectionsreturn_rates)
   * [`snaptrade.connections.session_events`](#snaptradeconnectionssession_events)
+  * [`snaptrade.connections.sync_brokerage_authorization_transactions`](#snaptradeconnectionssync_brokerage_authorization_transactions)
   * [`snaptrade.options.list_option_holdings`](#snaptradeoptionslist_option_holdings)
   * [`snaptrade.reference_data.get_currency_exchange_rate_pair`](#snaptradereference_dataget_currency_exchange_rate_pair)
   * [`snaptrade.reference_data.get_partner_info`](#snaptradereference_dataget_partner_info)
@@ -87,7 +88,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.197'
+gem 'snaptrade', '~> 2.0.198'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -486,7 +487,7 @@ p result
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### account_id: `String`<a id="account_id-string"></a>
 ##### state: `String`<a id="state-string"></a>
-defaults value is set to \"all\"
+defaults to \"all\"
 
 ##### days: `Integer`<a id="days-integer"></a>
 Number of days in the past to fetch the most recent orders. Defaults to the last
@@ -1299,6 +1300,40 @@ specific users
 ---
 
 
+### `snaptrade.connections.sync_brokerage_authorization_transactions`<a id="snaptradeconnectionssync_brokerage_authorization_transactions"></a>
+
+Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.connections.sync_brokerage_authorization_transactions(
+  authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
+  user_id: "snaptrade-user-123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### authorization_id: `String`<a id="authorization_id-string"></a>
+##### user_id: `String`<a id="user_id-string"></a>
+##### user_secret: `String`<a id="user_secret-string"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[BrokerageAuthorizationTransactionsSyncConfirmation](./lib/snaptrade/models/brokerage_authorization_transactions_sync_confirmation.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/authorizations/{authorizationId}/transactions/sync` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
 
 Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).

data/lib/snaptrade/api/account_information_api.rb

@@ -888,7 +888,7 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param state [String] defaults value is set to \"all\"
+    # @param state [String] defaults to \"all\"
     # @param days [Integer] Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_user_account_orders(user_id:, user_secret:, account_id:, state: SENTINEL, days: SENTINEL, extra: {})
@@ -911,7 +911,7 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param state [String] defaults value is set to \"all\"
+    # @param state [String] defaults to \"all\"
     # @param days [Integer] Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_user_account_orders_with_http_info(user_id:, user_secret:, account_id:, state: SENTINEL, days: SENTINEL, extra: {})
@@ -926,7 +926,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param account_id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :state defaults value is set to \"all\"
+    # @option opts [String] :state defaults to \"all\"
     # @option opts [Integer] :days Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
     # @return [Array<AccountOrderRecord>]
     private def get_user_account_orders_impl(user_id, user_secret, account_id, opts = {})
@@ -940,7 +940,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param account_id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :state defaults value is set to \"all\"
+    # @option opts [String] :state defaults to \"all\"
     # @option opts [Integer] :days Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
     # @return [Array<(Array<AccountOrderRecord>, Integer, Hash)>] Array<AccountOrderRecord> data, response status code and response headers
     private def get_user_account_orders_with_http_info_impl(user_id, user_secret, account_id, opts = {})

data/lib/snaptrade/api/connections_api.rb

@@ -970,6 +970,109 @@ module SnapTrade
       end
       return data, status_code, headers, response
     end
+
+
+    # Sync transactions for a connection
+    #
+    # Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
+    #
+    # @param authorization_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def sync_brokerage_authorization_transactions(authorization_id:, user_id:, user_secret:, extra: {})
+      data, _status_code, _headers = sync_brokerage_authorization_transactions_with_http_info_impl(authorization_id, user_id, user_secret, extra)
+      data
+    end
+
+    # Sync transactions for a connection
+    #
+    # Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
+    #
+    # @param authorization_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def sync_brokerage_authorization_transactions_with_http_info(authorization_id:, user_id:, user_secret:, extra: {})
+      sync_brokerage_authorization_transactions_with_http_info_impl(authorization_id, user_id, user_secret, extra)
+    end
+
+    # Sync transactions for a connection
+    # Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing 
+    # @param authorization_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [BrokerageAuthorizationTransactionsSyncConfirmation]
+    private def sync_brokerage_authorization_transactions_impl(authorization_id, user_id, user_secret, opts = {})
+      data, _status_code, _headers = sync_brokerage_authorization_transactions_with_http_info(authorization_id, user_id, user_secret, opts)
+      data
+    end
+
+    # Sync transactions for a connection
+    # Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing 
+    # @param authorization_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BrokerageAuthorizationTransactionsSyncConfirmation, Integer, Hash)>] BrokerageAuthorizationTransactionsSyncConfirmation data, response status code and response headers
+    private def sync_brokerage_authorization_transactions_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConnectionsApi.sync_brokerage_authorization_transactions ...'
+      end
+      # verify the required parameter 'authorization_id' is set
+      if @api_client.config.client_side_validation && authorization_id.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization_id' when calling ConnectionsApi.sync_brokerage_authorization_transactions"
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling ConnectionsApi.sync_brokerage_authorization_transactions"
+      end
+      # verify the required parameter 'user_secret' is set
+      if @api_client.config.client_side_validation && user_secret.nil?
+        fail ArgumentError, "Missing the required parameter 'user_secret' when calling ConnectionsApi.sync_brokerage_authorization_transactions"
+      end
+      # resource path
+      local_var_path = '/authorizations/{authorizationId}/transactions/sync'.sub('{' + 'authorizationId' + '}', CGI.escape(authorization_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'userId'] = user_id
+      query_params[:'userSecret'] = user_secret
+
+      # 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] || 'BrokerageAuthorizationTransactionsSyncConfirmation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"ConnectionsApi.sync_brokerage_authorization_transactions",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConnectionsApi#sync_brokerage_authorization_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
   end
 
   # top-level client access to avoid having the user to insantiate their own API instances

data/lib/snaptrade/models/account_value_history_item.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # The estimeated account value at a specific point in time.
+  # The estimated account value at a specific point in time.
   class AccountValueHistoryItem
     # The date of the estimated account value
     attr_accessor :date

data/lib/snaptrade/models/exchange.rb

@@ -16,7 +16,7 @@ module SnapTrade
     # Unique ID for the exchange in SnapTrade.
     attr_accessor :id
 
-    # A short name for the exchange. For standardized exchange code, please us the `mic_code` field.
+    # A short name for the exchange. For standardized exchange code, please use the `mic_code` field.
     attr_accessor :code
 
     # The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.

data/lib/snaptrade/models/performance_custom.rb

@@ -23,7 +23,7 @@ module SnapTrade
 
     attr_accessor :withdrawal_timeframe
 
-    # Current streak of cosecutive months where contributions were made
+    # Current streak of consecutive months where contributions were made
     attr_accessor :contribution_streak
 
     # Number of months in the timeframe with contributions

data/lib/snaptrade/models/symbol_exchange.rb

@@ -16,7 +16,7 @@ module SnapTrade
     # Unique ID for the exchange in SnapTrade.
     attr_accessor :id
 
-    # A short name for the exchange. For standardized exchange code, please us the `mic_code` field.
+    # A short name for the exchange. For standardized exchange code, please use the `mic_code` field.
     attr_accessor :code
 
     # The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.

data/lib/snaptrade/version.rb

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

data/spec/api/account_information_api_spec.rb

@@ -138,7 +138,7 @@ describe 'AccountInformationApi' do
   # @param user_secret 
   # @param account_id 
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :state defaults value is set to \"all\"
+  # @option opts [String] :state defaults to \"all\"
   # @option opts [Integer] :days Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
   # @return [Array<AccountOrderRecord>]
   describe 'get_user_account_orders test' do

data/spec/api/connections_api_spec.rb

@@ -153,4 +153,18 @@ describe 'ConnectionsApi' do
     end
   end
 
+  # unit tests for sync_brokerage_authorization_transactions
+  # Sync transactions for a connection
+  # Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing 
+  # @param authorization_id 
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @return [BrokerageAuthorizationTransactionsSyncConfirmation]
+  describe 'sync_brokerage_authorization_transactions test' 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.197
+  version: 2.0.198
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-05-19 00:00:00.000000000 Z
+date: 2026-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday