snaptrade 2.0.70 → 2.0.72

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da123b4dad2c9f58ab7798b61dbb8ef30a91d460b07812d6b543379566060604
-  data.tar.gz: 6d6cc15423db03518ce7f72bcc41c2b7c9b83480031dcaf00e93ea61088868a4
+  metadata.gz: dfac5c0b832ed3b82a4a588a6ebf80fb8dd87bae877c007bd2d9f71f5b8db0cf
+  data.tar.gz: e49ed67099dc4d91be78b45547246d5062e8a01d4903d04b886211bdc9c6ab65
 SHA512:
-  metadata.gz: 7b86acfca1bba55bb392ac96f1a0af69832463a8a58c4d91e667e4249e20d408d901e4011884c93742f2922e0673a84319810d6f2690f3cb447b4aa10266ee8e
-  data.tar.gz: 11a7c70a57fabbbe2ebce450c78e1bf0e24c7a5742444ae539deee0e5f6f0ed80e446dbe3918ba04a89288b163deb6badc71dde655c01da6e04732bfaabd732b
+  metadata.gz: fa76df59baf8c9f7386587aea312185dc8195ee41281e8067cba6c9fde440872b9fd55e1ab797b1924d652ddcd56be82f370a492d5104e4e3242c32f8ba60f59
+  data.tar.gz: 5ab41c271ea235b05f51ac8071247b75ca8ee3aaa671f1c1790064435d5d1b57e5b91ab8f89671bb6e24eda5395a0a7be1e9a87e0ae088736fdfc3fd6e59e9b0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.70)
+    snaptrade (2.0.72)
       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.6.0)
+    parser (3.3.7.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -67,7 +67,7 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.37.0)
+    rubocop-ast (1.38.0)
       parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)

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.70-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.70)
+[![npm](https://img.shields.io/badge/gem-v2.0.72-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.72)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -19,6 +19,7 @@ Connect brokerage accounts to your app for live positions and trading
 - [Getting Started](#getting-started)
 - [Raw HTTP Response](#raw-http-response)
 - [Reference](#reference)
+  * [`snaptrade.account_information.get_account_activities`](#snaptradeaccount_informationget_account_activities)
   * [`snaptrade.account_information.get_all_user_holdings`](#snaptradeaccount_informationget_all_user_holdings)
   * [`snaptrade.account_information.get_user_account_balance`](#snaptradeaccount_informationget_user_account_balance)
   * [`snaptrade.account_information.get_user_account_details`](#snaptradeaccount_informationget_user_account_details)
@@ -73,7 +74,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.70'
+gem 'snaptrade', '~> 2.0.72'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -85,10 +86,13 @@ configuration = SnapTrade::Configuration.new
 configuration.client_id = ENV["SNAPTRADE_CLIENT_ID"]
 configuration.consumer_key = ENV["SNAPTRADE_CONSUMER_KEY"]
 snaptrade = SnapTrade::Client.new(configuration)
-result = snaptrade.account_information.get_all_user_holdings(
+result = snaptrade.account_information.get_account_activities(
+  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   user_id: "snaptrade-user-123",
   user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
-  brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  start_date: "2022-01-24",
+  end_date: "2022-01-24",
+  type: "BUY,SELL,DIVIDEND",
 )
 p result
 ```
@@ -98,12 +102,15 @@ p result
 To access the raw HTTP response, suffix any method with `_with_http_info`.
 
 ```ruby
-result = snaptrade.account_information.get_all_user_holdings_with_http_info(
+result = snaptrade.account_information.get_account_activities_with_http_info(
+  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   user_id: "snaptrade-user-123",
   user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
-  brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  start_date: "2022-01-24",
+  end_date: "2022-01-24",
+  type: "BUY,SELL,DIVIDEND",
 )
-p result[0] # [Array<AccountHoldings>] Deserialized data
+p result[0] # [Array<UniversalActivity>] Deserialized data
 p.result[1] # [Integer] HTTP status code
 p.result[2] # [Hash] HTTP headers
 p.result[3] # [Faraday::Response] Raw HTTP response
@@ -112,6 +119,68 @@ p.result[3] # [Faraday::Response] Raw HTTP response
 ## Reference<a id="reference"></a>
 
 
+### `snaptrade.account_information.get_account_activities`<a id="snaptradeaccount_informationget_account_activities"></a>
+
+Returns all historical transactions for the specified account. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.
+
+There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
+
+The data returned here is always cached and refreshed once a day.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.account_information.get_account_activities(
+  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  user_id: "snaptrade-user-123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+  start_date: "2022-01-24",
+  end_date: "2022-01-24",
+  type: "BUY,SELL,DIVIDEND",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `String`<a id="account_id-string"></a>
+##### user_id: `String`<a id="user_id-string"></a>
+##### user_secret: `String`<a id="user_secret-string"></a>
+##### start_date: `Date`<a id="start_date-date"></a>
+The start date (inclusive) of the transaction history to retrieve. If not
+provided, the default is the first transaction known to SnapTrade based on
+`trade_date`.
+
+##### end_date: `Date`<a id="end_date-date"></a>
+The end date (inclusive) of the transaction history to retrieve. If not
+provided, the default is the last transaction known to SnapTrade based on
+`trade_date`.
+
+##### type: `String`<a id="type-string"></a>
+Optional comma separated list of transaction types to filter by. SnapTrade does
+a best effort to categorize brokerage transaction types into a common set of
+values. Here are some of the most popular values: - `BUY` - Asset bought. -
+`SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash
+contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment.
+- `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from
+the account. - `OPTIONEXPIRATION` - Option expiration event. -
+`OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option
+exercise event. - `TRANSFER` - Transfer of assets from one account to another
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[UniversalActivity](./lib/snaptrade/models/universal_activity.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/activities` `GET`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.account_information.get_all_user_holdings`<a id="snaptradeaccount_informationget_all_user_holdings"></a>
 ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
 
@@ -818,6 +887,7 @@ 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.
 
 *Please contact support for access as this endpoint is not enabled by default.*
 
@@ -1800,7 +1870,7 @@ Returns all historical transactions for the specified user and filtering criteri
 
 There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
 
-The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+The data returned here is always cached and refreshed once a day.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>

data/lib/snaptrade/api/account_information_api.rb

@@ -17,6 +17,138 @@ module SnapTrade
       @api_client = api_client
     end
 
+    # List account activities
+    #
+    # Returns all historical transactions for the specified account. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.
+    # 
+    # There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
+    # 
+    # The data returned here is always cached and refreshed once a day.
+    #
+    # @param account_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param start_date [Date] The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
+    # @param end_date [Date] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+    # @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def get_account_activities(account_id:, user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, type: SENTINEL, extra: {})
+      extra[:start_date] = start_date if start_date != SENTINEL
+      extra[:end_date] = end_date if end_date != SENTINEL
+      extra[:type] = type if type != SENTINEL
+      data, _status_code, _headers = get_account_activities_with_http_info_impl(account_id, user_id, user_secret, extra)
+      data
+    end
+
+    # List account activities
+    #
+    # Returns all historical transactions for the specified account. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.
+    # 
+    # There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
+    # 
+    # The data returned here is always cached and refreshed once a day.
+    #
+    # @param account_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param start_date [Date] The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
+    # @param end_date [Date] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+    # @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def get_account_activities_with_http_info(account_id:, user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, type: SENTINEL, extra: {})
+      extra[:start_date] = start_date if start_date != SENTINEL
+      extra[:end_date] = end_date if end_date != SENTINEL
+      extra[:type] = type if type != SENTINEL
+      get_account_activities_with_http_info_impl(account_id, user_id, user_secret, extra)
+    end
+
+    # List account activities
+    # Returns all historical transactions for the specified account. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day. 
+    # @param account_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Date] :start_date The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
+    # @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+    # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of assets from one account to another 
+    # @return [Array<UniversalActivity>]
+    private def get_account_activities_impl(account_id, user_id, user_secret, opts = {})
+      data, _status_code, _headers = get_account_activities_with_http_info(account_id, user_id, user_secret, opts)
+      data
+    end
+
+    # List account activities
+    # Returns all historical transactions for the specified account. It&#39;s recommended to use &#x60;startDate&#x60; and &#x60;endDate&#x60; to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There&#39;s a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the &#x60;trade_date&#x60; field if you need them in a specific order.  The data returned here is always cached and refreshed once a day. 
+    # @param account_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Date] :start_date The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
+    # @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+    # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of assets from one account to another 
+    # @return [Array<(Array<UniversalActivity>, Integer, Hash)>] Array<UniversalActivity> data, response status code and response headers
+    private def get_account_activities_with_http_info_impl(account_id, user_id, user_secret, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountInformationApi.get_account_activities ...'
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountInformationApi.get_account_activities"
+      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 AccountInformationApi.get_account_activities"
+      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 AccountInformationApi.get_account_activities"
+      end
+      # resource path
+      local_var_path = '/accounts/{accountId}/activities'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'userId'] = user_id
+      query_params[:'userSecret'] = user_secret
+      query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+
+      # 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] || 'Array<UniversalActivity>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"AccountInformationApi.get_account_activities",
+        :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: AccountInformationApi#get_account_activities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
     # List all accounts for the user, plus balances, positions, and orders for each account.
     #
     # **Deprecated, please use the account-specific holdings endpoint instead.**

data/lib/snaptrade/api/connections_api.rb

@@ -335,6 +335,7 @@ 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.
     # 
     # *Please contact support for access as this endpoint is not enabled by default.*
     #
@@ -350,6 +351,7 @@ 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.
     # 
     # *Please contact support for access as this endpoint is not enabled by default.*
     #
@@ -362,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.  *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 occured.  *Please contact support for access as this endpoint is not enabled by default.* 
     # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -374,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.  *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 occured.  *Please contact support for access as this endpoint is not enabled by default.* 
     # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 

data/lib/snaptrade/api/transactions_and_reporting_api.rb

@@ -23,7 +23,7 @@ module SnapTrade
     # 
     # There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
     # 
-    # The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+    # The data returned here is always cached and refreshed once a day.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -49,7 +49,7 @@ module SnapTrade
     # 
     # There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
     # 
-    # The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+    # The data returned here is always cached and refreshed once a day.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -69,7 +69,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 
+    # Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -85,7 +85,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 
+    # Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters

data/lib/snaptrade/version.rb

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

data/spec/api/account_information_api_spec.rb

@@ -27,6 +27,23 @@ describe 'AccountInformationApi' do
     end
   end
 
+  # unit tests for get_account_activities
+  # List account activities
+  # Returns all historical transactions for the specified account. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day. 
+  # @param account_id 
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Date] :start_date The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
+  # @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+  # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of assets from one account to another 
+  # @return [Array<UniversalActivity>]
+  describe 'get_account_activities 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 get_all_user_holdings
   # List all accounts for the user, plus balances, positions, and orders for each account.
   # **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account. 

data/spec/api/connections_api_spec.rb

@@ -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.  *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 occured.  *Please contact support for access as this endpoint is not enabled by default.* 
   # @param authorization_id 
   # @param user_id 
   # @param user_secret 

data/spec/api/transactions_and_reporting_api_spec.rb

@@ -29,7 +29,7 @@ describe 'TransactionsAndReportingApi' do
 
   # unit tests for get_activities
   # Get transaction history for a user
-  # Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 
+  # Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day. 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.70
+  version: 2.0.72
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-14 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -379,137 +379,137 @@ signing_key:
 specification_version: 4
 summary: SnapTrade Ruby Gem
 test_files:
-- spec/api/options_api_spec.rb
+- spec/api/transactions_and_reporting_api_spec.rb
+- spec/api/connections_api_spec.rb
 - spec/api/trading_api_spec.rb
+- spec/api/api_status_api_spec.rb
 - spec/api/reference_data_api_spec.rb
 - spec/api/authentication_api_spec.rb
 - spec/api/account_information_api_spec.rb
-- spec/api/api_status_api_spec.rb
-- spec/api/connections_api_spec.rb
-- spec/api/transactions_and_reporting_api_spec.rb
+- spec/api/options_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/getting_started_spec.rb
-- spec/models/authentication_login_snap_trade_user200_response_spec.rb
-- spec/models/strategy_order_record_status_spec.rb
-- spec/models/trading_cancel_user_account_order_request_spec.rb
-- spec/models/take_profit_spec.rb
-- spec/models/exchange_spec.rb
-- spec/models/manual_trade_form_with_options_stop_loss_spec.rb
-- spec/models/manual_trade_spec.rb
-- spec/models/login_redirect_uri_spec.rb
-- spec/models/encrypted_response_encrypted_message_data_spec.rb
-- spec/models/strategy_quotes_spec.rb
-- spec/models/rate_of_return_object_spec.rb
-- spec/models/account_sync_status_spec.rb
-- spec/models/options_place_option_strategy_request_spec.rb
-- spec/models/account_order_record_spec.rb
-- spec/models/brokerage_spec.rb
-- spec/models/time_in_force_strict_spec.rb
-- spec/models/action_strict_with_options_spec.rb
-- spec/models/exchange_rate_pairs_spec.rb
-- spec/models/account_holdings_account_spec.rb
+- spec/models/option_leg_spec.rb
+- spec/models/symbols_quotes_inner_spec.rb
+- spec/models/session_event_spec.rb
 - spec/models/model403_failed_request_response_spec.rb
-- spec/models/account_simple_spec.rb
-- spec/models/monthly_dividends_spec.rb
-- spec/models/snap_trade_register_user_request_body_spec.rb
-- spec/models/options_position_spec.rb
+- spec/models/account_order_record_option_symbol_spec.rb
+- spec/models/options_place_option_strategy_request_spec.rb
+- spec/models/strategy_quotes_spec.rb
+- spec/models/encrypted_response_spec.rb
+- spec/models/model404_failed_request_response_spec.rb
+- spec/models/option_strategy_legs_inner_spec.rb
+- spec/models/universal_activity_currency_spec.rb
 - spec/models/position_symbol_spec.rb
-- spec/models/model425_failed_request_response_spec.rb
-- spec/models/account_balance_spec.rb
-- spec/models/underlying_symbol_exchange_spec.rb
-- spec/models/manual_trade_symbol_spec.rb
+- spec/models/option_chain_inner_spec.rb
+- spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
+- spec/models/notional_value_spec.rb
+- spec/models/manual_trade_form_with_options_take_profit_spec.rb
+- spec/models/position_spec.rb
+- spec/models/timeframe_spec.rb
+- spec/models/option_type_spec.rb
+- spec/models/snap_trade_holdings_account_spec.rb
+- spec/models/sub_period_return_rate_spec.rb
 - spec/models/universal_activity_spec.rb
+- spec/models/past_value_spec.rb
+- spec/models/holdings_status_spec.rb
+- spec/models/net_contributions_spec.rb
+- spec/models/brokerage_spec.rb
 - spec/models/dividend_at_date_spec.rb
-- spec/models/option_brokerage_symbol_spec.rb
-- spec/models/account_holdings_spec.rb
-- spec/models/underlying_symbol_type_spec.rb
-- spec/models/model400_failed_request_response_spec.rb
-- spec/models/session_event_spec.rb
+- spec/models/account_balance_spec.rb
 - spec/models/model403_feature_not_enabled_response_spec.rb
-- spec/models/manual_trade_balance_spec.rb
-- spec/models/symbol_currency_spec.rb
-- spec/models/model402_brokerage_auth_disabled_response_spec.rb
-- spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb
-- spec/models/security_type_spec.rb
-- spec/models/option_strategy_spec.rb
-- spec/models/order_type_strict_spec.rb
-- spec/models/rate_of_return_response_spec.rb
-- spec/models/net_dividend_spec.rb
-- spec/models/symbol_figi_instrument_spec.rb
+- spec/models/exchange_spec.rb
+- spec/models/snap_trade_holdings_total_value_spec.rb
+- spec/models/time_in_force_strict_spec.rb
 - spec/models/options_position_currency_spec.rb
-- spec/models/option_type_spec.rb
-- spec/models/brokerage_authorization_spec.rb
-- spec/models/brokerage_authorization_type_read_only_spec.rb
-- spec/models/manual_trade_form_with_options_take_profit_spec.rb
-- spec/models/brokerage_authorization_refresh_confirmation_spec.rb
-- spec/models/option_strategy_legs_inner_spec.rb
-- spec/models/snap_trade_holdings_account_spec.rb
-- spec/models/holdings_status_spec.rb
-- spec/models/type_spec.rb
-- spec/models/encrypted_response_spec.rb
-- spec/models/option_chain_inner_spec.rb
-- spec/models/balance_spec.rb
-- spec/models/us_exchange_spec.rb
-- spec/models/delete_user_response_spec.rb
-- spec/models/symbol_exchange_spec.rb
-- spec/models/account_order_record_option_symbol_spec.rb
-- spec/models/universal_activity_currency_spec.rb
-- spec/models/timeframe_spec.rb
-- spec/models/sub_period_return_rate_spec.rb
-- spec/models/universal_activity_symbol_spec.rb
-- spec/models/position_spec.rb
-- spec/models/recent_orders_response_spec.rb
 - spec/models/symbol_spec.rb
-- spec/models/option_leg_spec.rb
-- spec/models/brokerage_authorization_disabled_confirmation_spec.rb
 - spec/models/options_symbol_spec.rb
-- spec/models/transactions_status_spec.rb
-- spec/models/account_order_record_status_spec.rb
-- spec/models/manual_trade_form_spec.rb
+- spec/models/order_class_spec.rb
+- spec/models/trading_cancel_user_account_order_request_spec.rb
+- spec/models/partner_data_spec.rb
+- spec/models/manual_trade_impact_spec.rb
+- spec/models/session_event_type_spec.rb
+- spec/models/option_chain_inner_chain_per_root_inner_spec.rb
+- spec/models/recent_orders_response_spec.rb
+- spec/models/universal_symbol_spec.rb
+- spec/models/manual_trade_form_with_options_spec.rb
+- spec/models/delete_user_response_spec.rb
 - spec/models/currency_spec.rb
+- spec/models/brokerage_type_spec.rb
+- spec/models/type_spec.rb
+- spec/models/rate_of_return_object_spec.rb
+- spec/models/manual_trade_balance_spec.rb
+- spec/models/validated_trade_body_spec.rb
+- spec/models/balance_spec.rb
+- spec/models/manual_trade_form_spec.rb
+- spec/models/security_type_spec.rb
 - spec/models/figi_instrument_spec.rb
-- spec/models/universal_activity_option_symbol_spec.rb
+- spec/models/encrypted_response_encrypted_message_data_spec.rb
+- spec/models/underlying_symbol_type_spec.rb
 - spec/models/performance_custom_spec.rb
+- spec/models/auth_type_spec.rb
+- spec/models/model402_brokerage_auth_disabled_response_spec.rb
+- spec/models/symbol_currency_spec.rb
+- spec/models/account_sync_status_spec.rb
+- spec/models/account_order_record_universal_symbol_spec.rb
+- spec/models/symbol_query_spec.rb
+- spec/models/universal_activity_option_symbol_spec.rb
 - spec/models/account_spec.rb
-- spec/models/connection_type_spec.rb
-- spec/models/manual_trade_impact_spec.rb
-- spec/models/action_strict_spec.rb
+- spec/models/model425_failed_request_response_spec.rb
+- spec/models/strategy_type_spec.rb
+- spec/models/action_strict_with_options_spec.rb
+- spec/models/strategy_order_record_status_spec.rb
+- spec/models/manual_trade_symbol_spec.rb
+- spec/models/options_position_spec.rb
 - spec/models/model401_failed_request_response_spec.rb
-- spec/models/manual_trade_form_with_options_spec.rb
-- spec/models/validated_trade_body_spec.rb
+- spec/models/account_holdings_account_spec.rb
+- spec/models/symbol_exchange_spec.rb
+- spec/models/underlying_symbol_spec.rb
+- spec/models/symbol_figi_instrument_spec.rb
+- spec/models/balance_currency_spec.rb
+- spec/models/option_strategy_spec.rb
+- spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb
+- spec/models/stop_loss_spec.rb
+- spec/models/status_spec.rb
+- spec/models/connection_portal_version_spec.rb
+- spec/models/model500_unexpected_exception_response_spec.rb
+- spec/models/snap_trade_register_user_request_body_spec.rb
+- spec/models/option_brokerage_symbol_spec.rb
+- spec/models/manual_trade_form_notional_value_spec.rb
+- spec/models/universal_activity_symbol_spec.rb
+- spec/models/manual_trade_spec.rb
+- spec/models/take_profit_spec.rb
+- spec/models/brokerage_authorization_refresh_confirmation_spec.rb
+- spec/models/net_dividend_spec.rb
+- spec/models/account_order_record_spec.rb
+- spec/models/user_i_dand_secret_spec.rb
+- spec/models/authentication_login_snap_trade_user200_response_spec.rb
 - spec/models/account_balance_total_spec.rb
-- spec/models/brokerage_type_spec.rb
+- spec/models/exchange_rate_pairs_spec.rb
+- spec/models/brokerage_authorization_type_read_only_spec.rb
 - spec/models/options_get_option_strategy_request_spec.rb
-- spec/models/model500_unexpected_exception_response_spec.rb
-- spec/models/strategy_type_spec.rb
 - spec/models/strategy_quotes_greek_spec.rb
-- spec/models/connection_portal_version_spec.rb
+- spec/models/monthly_dividends_spec.rb
+- spec/models/model400_failed_request_response_spec.rb
+- spec/models/account_holdings_spec.rb
+- spec/models/brokerage_authorization_disabled_confirmation_spec.rb
 - spec/models/connections_session_events200_response_inner_spec.rb
-- spec/models/snap_trade_holdings_total_value_spec.rb
-- spec/models/auth_type_spec.rb
-- spec/models/stop_loss_spec.rb
-- spec/models/snap_trade_login_user_request_body_spec.rb
-- spec/models/user_i_dand_secret_spec.rb
-- spec/models/status_spec.rb
-- spec/models/session_event_type_spec.rb
-- spec/models/manual_trade_form_notional_value_spec.rb
+- spec/models/order_type_strict_spec.rb
+- spec/models/connection_type_spec.rb
+- spec/models/account_order_record_status_spec.rb
+- spec/models/us_exchange_spec.rb
+- spec/models/option_leg_action_spec.rb
+- spec/models/transactions_status_spec.rb
+- spec/models/account_simple_spec.rb
+- spec/models/rate_of_return_response_spec.rb
+- spec/models/manual_trade_and_impact_spec.rb
 - spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
-- spec/models/option_chain_inner_chain_per_root_inner_spec.rb
-- spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
-- spec/models/net_contributions_spec.rb
-- spec/models/underlying_symbol_spec.rb
-- spec/models/symbols_quotes_inner_spec.rb
-- spec/models/account_order_record_universal_symbol_spec.rb
 - spec/models/strategy_order_record_spec.rb
-- spec/models/order_class_spec.rb
-- spec/models/manual_trade_and_impact_spec.rb
-- spec/models/notional_value_spec.rb
-- spec/models/past_value_spec.rb
-- spec/models/partner_data_spec.rb
-- spec/models/symbol_query_spec.rb
-- spec/models/universal_symbol_spec.rb
-- spec/models/balance_currency_spec.rb
-- spec/models/model404_failed_request_response_spec.rb
-- spec/models/option_leg_action_spec.rb
+- spec/models/manual_trade_form_with_options_stop_loss_spec.rb
+- spec/models/login_redirect_uri_spec.rb
+- spec/models/brokerage_authorization_spec.rb
+- spec/models/underlying_symbol_exchange_spec.rb
+- spec/models/action_strict_spec.rb
+- spec/models/snap_trade_login_user_request_body_spec.rb
 - spec/spec_helper.rb