snaptrade 2.0.55 → 2.0.57

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94eee44f6564f4e2b0f344fcbb97c338db8e9c0d81eb7b36cade1ddbcbf50de6
-  data.tar.gz: d612e500e00019da2862e9e3836244d6fd0f2e777787e00c7d115f605df29244
+  metadata.gz: 76c1cd624eec441a3fb89eb4382af3cf43a0efbc378884a9df5aa68351b72add
+  data.tar.gz: 80973f12d1aee7f1b676a45339a14e17ce4014952cdfbae9476a3e7332ad79e8
 SHA512:
-  metadata.gz: 3a1071497224bbaa98f85100c1f4eade117f0c1e729d4ae035c96eda3b44cfdebea58995510a55b729e4f54d2bc52f685615a1fd31bbb2b476455eeae3ab5379
-  data.tar.gz: 35b0d624b6d4e803b93aa342f0c96d7f9fef32f17f23d40103de298e38eaa4edc3f64c7fe877a682ff956899294fb54ef06c7e8be37c9075c6054826cc7b4a1b
+  metadata.gz: 772dc621ec9d75a3e630252a26725205ff30e1fe6df202b7ff75fadac8ed4e9b2e0a86d93b421777701b617671bee9b4bec01b9477a882b69e7665fdb98f09e1
+  data.tar.gz: 7379dbbb8e5f1c3f54f14d42c370ed06a67871ac15a811f118f7c8173872bfc2aba856ba1044c1ab6df8e46125acf19fec3c9ab6d6fc89f8e506e96cbf212d1a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.55)
+    snaptrade (2.0.57)
       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.55-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.55)
+[![npm](https://img.shields.io/badge/gem-v2.0.57-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.57)
 [![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.55'
+gem 'snaptrade', '~> 2.0.57'
 ```
 
 ## 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>

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/models/security_type.rb

@@ -16,7 +16,7 @@ module SnapTrade
     # Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
     attr_accessor :id
 
-    # A short code representing the security type. For example, \"cs\" for Common Stock. Here are some common values:   ad - ADR   bnd - Bond   cs - Common Stock   cef - Closed End Fund   et - ETF   oef - Open Ended Fund   ps - Preferred Stock   rt - Right   struct - Structured Product   ut - Unit   wi - When Issued   wt - Warrant 
+    # A short code representing the security type. For example, \"cs\" for Common Stock. Here are some common values:   - `ad` - ADR   - `bnd` - Bond   - `cs` - Common Stock   - `cef` - Closed End Fund   - `et` - ETF   - `oef` - Open Ended Fund   - `ps` - Preferred Stock   - `rt` - Right   - `struct` - Structured Product   - `ut` - Unit   - `wi` - When Issued   - `wt` - Warrant 
     attr_accessor :code
 
     # A human-readable description of the security type. For example, \"Common Stock\" or \"ETF\".

data/lib/snaptrade/models/underlying_symbol_type.rb

@@ -16,7 +16,7 @@ module SnapTrade
     # Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
     attr_accessor :id
 
-    # A short code representing the security type. For example, \"cs\" for Common Stock. Here are some common values:   ad - ADR   bnd - Bond   cs - Common Stock   cef - Closed End Fund   et - ETF   oef - Open Ended Fund   ps - Preferred Stock   rt - Right   struct - Structured Product   ut - Unit   wi - When Issued   wt - Warrant 
+    # A short code representing the security type. For example, \"cs\" for Common Stock. Here are some common values:   - `ad` - ADR   - `bnd` - Bond   - `cs` - Common Stock   - `cef` - Closed End Fund   - `et` - ETF   - `oef` - Open Ended Fund   - `ps` - Preferred Stock   - `rt` - Right   - `struct` - Structured Product   - `ut` - Unit   - `wi` - When Issued   - `wt` - Warrant 
     attr_accessor :code
 
     # A human-readable description of the security type. For example, \"Common Stock\" or \"ETF\".

data/lib/snaptrade/version.rb

@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '2.0.55'
+  VERSION = '2.0.57'
 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.

metadata

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