snaptrade 2.0.56 → 2.0.58

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 962d39a6576fd86c258ba583b874280494d03415ff23f14f0f91d211e5579584
-  data.tar.gz: 55dd7b9413baf952cbaa2276f016b6593d80a0233177c3c685ac601ad95b28da
+  metadata.gz: 4b61fdc3a0f90d72042948ef95559801e393608137e2ef57d5fcec56eb5a94f7
+  data.tar.gz: d0a3a22e64a8df61f49507228ded570524e7790560b53c98ba0d752c6d34a574
 SHA512:
-  metadata.gz: 83ba257bbb94b35e2b3b98345febbeac17a00c162bbfe7fc7e036f5e655237277f61566ba37a54177c0791202b7a7cc58d502d564705589b92be9201bda1e2b0
-  data.tar.gz: c8bac13ccd529d7ea5a64057d05ded6978e36c9027380d4e0c625a6492b44e6f84f5b78f511414f2d301267bb0f3f4de2fb0bb464aa3d4fda8157758b3d271e8
+  metadata.gz: ccab986ca5a44ef5849d921e3fbe13941f3f3165e66ed2ad17227de07fb23ec0faad9970cb6a0c9787c0235f7959a2f0b18afc79c662137f912f9250a18f8c1f
+  data.tar.gz: '0092bd17c1f15c14b007412a462031ae2ae00b70d2c6b24cf22d4d7ac6d33ece3cb9ffe511a155e20c6e61c75f85311f4ce948148a65713d6449de4cf75cf66c'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.56)
+    snaptrade (2.0.58)
       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.56-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.56)
+[![npm](https://img.shields.io/badge/gem-v2.0.58-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.58)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -73,7 +73,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.56'
+gem 'snaptrade', '~> 2.0.58'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -321,6 +321,7 @@ result = snaptrade.account_information.get_user_account_recent_orders(
   user_id: "snaptrade-user-123",
   user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  only_executed: true,
 )
 p result
 ```
@@ -330,6 +331,10 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### account_id: `String`<a id="account_id-string"></a>
+##### only_executed: `Boolean`<a id="only_executed-boolean"></a>
+Defaults to true. Indicates if request should fetch only executed orders. Set to
+false to retrieve non executed orders as well
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [RecentOrdersResponse](./lib/snaptrade/models/recent_orders_response.rb)
@@ -1611,7 +1616,8 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### symbols: `String`<a id="symbols-string"></a>
-List of Universal Symbol IDs or tickers to get quotes for.
+List of Universal Symbol IDs or tickers to get quotes for. When providing
+multiple values, use a comma as separator
 
 ##### account_id: `String`<a id="account_id-string"></a>
 ##### use_ticker: `Boolean`<a id="use_ticker-boolean"></a>
@@ -1829,7 +1835,7 @@ 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.
+exercise event. - `TRANSFER` - Transfer of assets from one account to another
 
 #### 🔄 Return<a id="🔄-return"></a>
 

data/lib/snaptrade/api/account_information_api.rb

@@ -585,8 +585,10 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
+    # @param only_executed [Boolean] Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_user_account_recent_orders(user_id:, user_secret:, account_id:, extra: {})
+    def get_user_account_recent_orders(user_id:, user_secret:, account_id:, only_executed: SENTINEL, extra: {})
+      extra[:only_executed] = only_executed if only_executed != SENTINEL
       data, _status_code, _headers = get_user_account_recent_orders_with_http_info_impl(user_id, user_secret, account_id, extra)
       data
     end
@@ -601,8 +603,10 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
+    # @param only_executed [Boolean] Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_user_account_recent_orders_with_http_info(user_id:, user_secret:, account_id:, extra: {})
+    def get_user_account_recent_orders_with_http_info(user_id:, user_secret:, account_id:, only_executed: SENTINEL, extra: {})
+      extra[:only_executed] = only_executed if only_executed != SENTINEL
       get_user_account_recent_orders_with_http_info_impl(user_id, user_secret, account_id, extra)
     end
 
@@ -612,6 +616,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param account_id [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :only_executed Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
     # @return [RecentOrdersResponse]
     private def get_user_account_recent_orders_impl(user_id, user_secret, account_id, opts = {})
       data, _status_code, _headers = get_user_account_recent_orders_with_http_info(user_id, user_secret, account_id, opts)
@@ -624,6 +629,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param account_id [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :only_executed Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
     # @return [Array<(RecentOrdersResponse, Integer, Hash)>] RecentOrdersResponse data, response status code and response headers
     private def get_user_account_recent_orders_with_http_info_impl(user_id, user_secret, account_id, opts = {})
       if @api_client.config.debugging
@@ -648,6 +654,7 @@ module SnapTrade
       query_params = opts[:query_params] || {}
       query_params[:'userId'] = user_id
       query_params[:'userSecret'] = user_secret
+      query_params[:'only_executed'] = opts[:'only_executed'] if !opts[:'only_executed'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/snaptrade/api/trading_api.rb

@@ -295,7 +295,7 @@ module SnapTrade
     #
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for.
+    # @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
     # @param account_id [String] 
     # @param use_ticker [Boolean] Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -311,7 +311,7 @@ module SnapTrade
     #
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for.
+    # @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
     # @param account_id [String] 
     # @param use_ticker [Boolean] Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -324,7 +324,7 @@ module SnapTrade
     # Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for.
+    # @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
     # @param account_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :use_ticker Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.
@@ -338,7 +338,7 @@ module SnapTrade
     # Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for.
+    # @param symbols [String] List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
     # @param account_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :use_ticker Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.

data/lib/snaptrade/api/transactions_and_reporting_api.rb

@@ -31,7 +31,7 @@ module SnapTrade
     # @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 accounts [String] Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
     # @param brokerage_authorizations [String] Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
-    # @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. 
+    # @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_activities(user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, accounts: SENTINEL, brokerage_authorizations: SENTINEL, type: SENTINEL, extra: {})
       extra[:start_date] = start_date if start_date != SENTINEL
@@ -57,7 +57,7 @@ module SnapTrade
     # @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 accounts [String] Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
     # @param brokerage_authorizations [String] Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
-    # @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. 
+    # @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_activities_with_http_info(user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, accounts: SENTINEL, brokerage_authorizations: SENTINEL, type: SENTINEL, extra: {})
       extra[:start_date] = start_date if start_date != SENTINEL
@@ -77,7 +77,7 @@ module SnapTrade
     # @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] :accounts Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
     # @option opts [String] :brokerage_authorizations Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
-    # @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. 
+    # @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_activities_impl(user_id, user_secret, opts = {})
       data, _status_code, _headers = get_activities_with_http_info(user_id, user_secret, opts)
@@ -93,7 +93,7 @@ module SnapTrade
     # @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] :accounts Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
     # @option opts [String] :brokerage_authorizations Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
-    # @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. 
+    # @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_activities_with_http_info_impl(user_id, user_secret, opts = {})
       if @api_client.config.debugging

data/lib/snaptrade/version.rb

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

data/spec/api/account_information_api_spec.rb

@@ -106,6 +106,7 @@ describe 'AccountInformationApi' do
   # @param user_secret 
   # @param account_id 
   # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :only_executed Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
   # @return [RecentOrdersResponse]
   describe 'get_user_account_recent_orders test' do
     it 'should work' do

data/spec/api/trading_api_spec.rb

@@ -61,7 +61,7 @@ describe 'TradingApi' do
   # Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. This endpoint does not work for options quotes.
   # @param user_id 
   # @param user_secret 
-  # @param symbols List of Universal Symbol IDs or tickers to get quotes for.
+  # @param symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
   # @param account_id 
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :use_ticker Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.

data/spec/api/transactions_and_reporting_api_spec.rb

@@ -37,7 +37,7 @@ describe 'TransactionsAndReportingApi' do
   # @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] :accounts Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
   # @option opts [String] :brokerage_authorizations Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
-  # @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. 
+  # @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_activities test' do
     it 'should work' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.56
+  version: 2.0.58
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-15 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday