snaptrade 2.0.16 → 2.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d202c0c9f1f0e2d382cfb023056110f08727158e34c12f5d61ccf70061d2a991
-  data.tar.gz: d6535b39985caa7570ff9a002f0284c9b2a7553ce5a8821f29db6c0e0e810836
+  metadata.gz: 3d92b0f13dc8029767eab7132f8eb60c79cabd15cd4b67d4a791eaeda3002d40
+  data.tar.gz: ea03b59315889c14157aa3b1eb287207a2464ba8829bc7bcbfce4f7b6be4facc
 SHA512:
-  metadata.gz: 6a01fca1b933ba9aecf52ad6b779cb57bd5d04360138ae87c740b3e1bf3fdd2b301e036f7159fd979f831aedbad98cdb2b8342beb24bfd87913684bbc8894809
-  data.tar.gz: fa8f2dff41a36d48337f2223245a70dc40c478da18dfede9a5fe1e0b96971cabef62664b446af834a7fdf1245fb1a803ea0815397af6ef47389795e259e5432f
+  metadata.gz: f462f87c7d23bc96049bab41e0ede58f1456b9b49c832acc87d3b085eb425992d7c001057a4be2e179a609647cbe23aa3ade7d069011e5d9a3b2d1b0a596cd40
+  data.tar.gz: 768feef57059c893141b5ee4aeb0cc57ea99145de77e733112cd6650d67449e8cffcadfe6ba18ec0af2f928e63fbd28d669d07a5784fa86d3af38314611bef20

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.15)
+    snaptrade (2.0.16)
       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.16-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.16)
+[![npm](https://img.shields.io/badge/gem-v2.0.17-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.17)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -69,7 +69,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.16'
+gem 'snaptrade', '~> 2.0.17'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -264,7 +264,7 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
 
 ### `snaptrade.account_information.get_user_account_positions`<a id="snaptradeaccount_informationget_user_account_positions"></a>
 
-Returns a list of positions in the the specified account.
+Returns a list of positions in the specified account.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -641,7 +641,7 @@ SnapTrade user.
 
 ### `snaptrade.connections.detail_brokerage_authorization`<a id="snaptradeconnectionsdetail_brokerage_authorization"></a>
 
-Get brokerage authorization details
+Returns a single brokerage authorization object for the specified ID.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -676,7 +676,7 @@ The ID of a brokerage authorization object.
 
 ### `snaptrade.connections.list_brokerage_authorizations`<a id="snaptradeconnectionslist_brokerage_authorizations"></a>
 
-List all brokerage authorizations for the user
+Returns a list of Brokerage Autherization objects for the specified userId.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -707,7 +707,7 @@ p result
 
 ### `snaptrade.connections.remove_brokerage_authorization`<a id="snaptradeconnectionsremove_brokerage_authorization"></a>
 
-Delete brokerage authorization
+Deletes a specified brokerage authorization given by the ID.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -737,7 +737,7 @@ The ID of the Authorization to delete.
 
 ### `snaptrade.connections.session_events`<a id="snaptradeconnectionssession_events"></a>
 
-List all session events for the partner
+Returns a list of session events associated with a user.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -776,7 +776,8 @@ specific users
 
 ### `snaptrade.options.get_option_strategy`<a id="snaptradeoptionsget_option_strategy"></a>
 
-Creates an option strategy object that will be used to place an option strategy order
+Creates an option strategy object that will be used to place an option strategy order.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -823,7 +824,7 @@ The ID of the account to create the option strategy object in.
 
 ### `snaptrade.options.get_options_chain`<a id="snaptradeoptionsget_options_chain"></a>
 
-Get the options chain
+Returns the option chain for the specified symbol in the specified account.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -862,7 +863,8 @@ Universal symbol ID if symbol
 
 ### `snaptrade.options.get_options_strategy_quote`<a id="snaptradeoptionsget_options_strategy_quote"></a>
 
-Get latest market data of option strategy
+Returns a Strategy Quotes object which has latest market data of the specified option strategy.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -901,7 +903,8 @@ Option strategy id obtained from response when creating option strategy object
 
 ### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
 
-Get the options holdings in the account
+Returns a list of Options Positions.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -936,7 +939,7 @@ The ID of the account to fetch options holdings for.
 
 ### `snaptrade.options.place_option_strategy`<a id="snaptradeoptionsplace_option_strategy"></a>
 
-Place an option strategy order on the brokerage
+Places the option strategy order and returns the order record received from the brokerage.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 

data/lib/snaptrade/api/account_information_api.rb

@@ -456,7 +456,7 @@ module SnapTrade
 
     # List account positions
     #
-    # Returns a list of positions in the the specified account.
+    # Returns a list of positions in the specified account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -469,7 +469,7 @@ module SnapTrade
 
     # List account positions
     #
-    # Returns a list of positions in the the specified account.
+    # Returns a list of positions in the specified account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -480,7 +480,7 @@ module SnapTrade
     end
 
     # List account positions
-    # Returns a list of positions in the the specified account.
+    # Returns a list of positions in the specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get positions.
@@ -492,7 +492,7 @@ module SnapTrade
     end
 
     # List account positions
-    # Returns a list of positions in the the specified account.
+    # Returns a list of positions in the specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get positions.

data/lib/snaptrade/api/connections_api.rb

@@ -19,6 +19,8 @@ module SnapTrade
 
     # Get brokerage authorization details
     #
+    # Returns a single brokerage authorization object for the specified ID.
+    #
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -30,6 +32,8 @@ module SnapTrade
 
     # Get brokerage authorization details
     #
+    # Returns a single brokerage authorization object for the specified ID.
+    #
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -39,6 +43,7 @@ module SnapTrade
     end
 
     # Get brokerage authorization details
+    # Returns a single brokerage authorization object for the specified ID.
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -50,6 +55,7 @@ module SnapTrade
     end
 
     # Get brokerage authorization details
+    # Returns a single brokerage authorization object for the specified ID.
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -114,7 +120,9 @@ module SnapTrade
     end
 
 
-    # List all brokerage authorizations for the user
+    # List all brokerage authorizations for the User
+    #
+    # Returns a list of Brokerage Autherization objects for the specified userId.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -124,7 +132,9 @@ module SnapTrade
       data
     end
 
-    # List all brokerage authorizations for the user
+    # List all brokerage authorizations for the User
+    #
+    # Returns a list of Brokerage Autherization objects for the specified userId.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -133,7 +143,8 @@ module SnapTrade
       list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, extra)
     end
 
-    # List all brokerage authorizations for the user
+    # List all brokerage authorizations for the User
+    # Returns a list of Brokerage Autherization objects for the specified userId.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -143,7 +154,8 @@ module SnapTrade
       data
     end
 
-    # List all brokerage authorizations for the user
+    # List all brokerage authorizations for the User
+    # Returns a list of Brokerage Autherization objects for the specified userId.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -205,6 +217,8 @@ module SnapTrade
 
     # Delete brokerage authorization
     #
+    # Deletes a specified brokerage authorization given by the ID.
+    #
     # @param authorization_id [String] The ID of the Authorization to delete.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -216,6 +230,8 @@ module SnapTrade
 
     # Delete brokerage authorization
     #
+    # Deletes a specified brokerage authorization given by the ID.
+    #
     # @param authorization_id [String] The ID of the Authorization to delete.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -225,6 +241,7 @@ module SnapTrade
     end
 
     # Delete brokerage authorization
+    # Deletes a specified brokerage authorization given by the ID.
     # @param authorization_id [String] The ID of the Authorization to delete.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -236,6 +253,7 @@ module SnapTrade
     end
 
     # Delete brokerage authorization
+    # Deletes a specified brokerage authorization given by the ID.
     # @param authorization_id [String] The ID of the Authorization to delete.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -298,7 +316,9 @@ module SnapTrade
     end
 
 
-    # List all session events for the partner
+    # Get all session events for a user
+    #
+    # Returns a list of session events associated with a user.
     #
     # @param partner_client_id [String] 
     # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
@@ -311,7 +331,9 @@ module SnapTrade
       data
     end
 
-    # List all session events for the partner
+    # Get all session events for a user
+    #
+    # Returns a list of session events associated with a user.
     #
     # @param partner_client_id [String] 
     # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
@@ -323,7 +345,8 @@ module SnapTrade
       session_events_with_http_info_impl(partner_client_id, extra)
     end
 
-    # List all session events for the partner
+    # Get all session events for a user
+    # Returns a list of session events associated with a user.
     # @param partner_client_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
@@ -334,7 +357,8 @@ module SnapTrade
       data
     end
 
-    # List all session events for the partner
+    # Get all session events for a user
+    # Returns a list of session events associated with a user.
     # @param partner_client_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users

data/lib/snaptrade/api/options_api.rb

@@ -17,7 +17,9 @@ module SnapTrade
       @api_client = api_client
     end
 
-    # Creates an option strategy object that will be used to place an option strategy order
+    # Create options strategy
+    #
+    # Creates an option strategy object that will be used to place an option strategy order.
     #
     # @param underlying_symbol_id [String] 
     # @param legs [Array<OptionLeg>] 
@@ -37,7 +39,9 @@ module SnapTrade
       data
     end
 
-    # Creates an option strategy object that will be used to place an option strategy order
+    # Create options strategy
+    #
+    # Creates an option strategy object that will be used to place an option strategy order.
     #
     # @param underlying_symbol_id [String] 
     # @param legs [Array<OptionLeg>] 
@@ -56,7 +60,8 @@ module SnapTrade
       get_option_strategy_with_http_info_impl(user_id, user_secret, account_id, options_get_option_strategy_request, extra)
     end
 
-    # Creates an option strategy object that will be used to place an option strategy order
+    # Create options strategy
+    # Creates an option strategy object that will be used to place an option strategy order. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to create the option strategy object in.
@@ -68,7 +73,8 @@ module SnapTrade
       data
     end
 
-    # Creates an option strategy object that will be used to place an option strategy order
+    # Create options strategy
+    # Creates an option strategy object that will be used to place an option strategy order. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to create the option strategy object in.
@@ -143,7 +149,9 @@ module SnapTrade
     end
 
 
-    # Get the options chain
+    # Get the options chain for a symbol
+    #
+    # Returns the option chain for the specified symbol in the specified account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -155,7 +163,9 @@ module SnapTrade
       data
     end
 
-    # Get the options chain
+    # Get the options chain for a symbol
+    #
+    # Returns the option chain for the specified symbol in the specified account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -166,7 +176,8 @@ module SnapTrade
       get_options_chain_with_http_info_impl(user_id, user_secret, account_id, symbol, extra)
     end
 
-    # Get the options chain
+    # Get the options chain for a symbol
+    # Returns the option chain for the specified symbol in the specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get the options chain from.
@@ -178,7 +189,8 @@ module SnapTrade
       data
     end
 
-    # Get the options chain
+    # Get the options chain for a symbol
+    # Returns the option chain for the specified symbol in the specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get the options chain from.
@@ -249,7 +261,9 @@ module SnapTrade
     end
 
 
-    # Get latest market data of option strategy
+    # Get options strategy quotes
+    #
+    # Returns a Strategy Quotes object which has latest market data of the specified option strategy.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -261,7 +275,9 @@ module SnapTrade
       data
     end
 
-    # Get latest market data of option strategy
+    # Get options strategy quotes
+    #
+    # Returns a Strategy Quotes object which has latest market data of the specified option strategy.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -272,7 +288,8 @@ module SnapTrade
       get_options_strategy_quote_with_http_info_impl(user_id, user_secret, account_id, option_strategy_id, extra)
     end
 
-    # Get latest market data of option strategy
+    # Get options strategy quotes
+    # Returns a Strategy Quotes object which has latest market data of the specified option strategy. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account the strategy will be placed in.
@@ -284,7 +301,8 @@ module SnapTrade
       data
     end
 
-    # Get latest market data of option strategy
+    # Get options strategy quotes
+    # Returns a Strategy Quotes object which has latest market data of the specified option strategy. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account the strategy will be placed in.
@@ -354,7 +372,9 @@ module SnapTrade
     end
 
 
-    # Get the options holdings in the account
+    # Get account option holdings
+    #
+    # Returns a list of Options Positions.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -365,7 +385,9 @@ module SnapTrade
       data
     end
 
-    # Get the options holdings in the account
+    # Get account option holdings
+    #
+    # Returns a list of Options Positions.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -375,7 +397,8 @@ module SnapTrade
       list_option_holdings_with_http_info_impl(user_id, user_secret, account_id, extra)
     end
 
-    # Get the options holdings in the account
+    # Get account option holdings
+    # Returns a list of Options Positions. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to fetch options holdings for.
@@ -386,7 +409,8 @@ module SnapTrade
       data
     end
 
-    # Get the options holdings in the account
+    # Get account option holdings
+    # Returns a list of Options Positions. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to fetch options holdings for.
@@ -451,7 +475,9 @@ module SnapTrade
     end
 
 
-    # Place an option strategy order on the brokerage
+    # Place an option strategy order
+    #
+    # Places the option strategy order and returns the order record received from the brokerage.
     #
     # @param order_type [OrderType] Order Type
     # @param time_in_force [TimeInForceStrict] Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled 
@@ -472,7 +498,9 @@ module SnapTrade
       data
     end
 
-    # Place an option strategy order on the brokerage
+    # Place an option strategy order
+    #
+    # Places the option strategy order and returns the order record received from the brokerage.
     #
     # @param order_type [OrderType] Order Type
     # @param time_in_force [TimeInForceStrict] Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled 
@@ -492,7 +520,8 @@ module SnapTrade
       place_option_strategy_with_http_info_impl(user_id, user_secret, account_id, option_strategy_id, options_place_option_strategy_request, extra)
     end
 
-    # Place an option strategy order on the brokerage
+    # Place an option strategy order
+    # Places the option strategy order and returns the order record received from the brokerage.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to execute the strategy in.
@@ -505,7 +534,8 @@ module SnapTrade
       data
     end
 
-    # Place an option strategy order on the brokerage
+    # Place an option strategy order
+    # Places the option strategy order and returns the order record received from the brokerage.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to execute the strategy in.

data/lib/snaptrade/version.rb

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

data/spec/api/account_information_api_spec.rb

@@ -87,7 +87,7 @@ describe 'AccountInformationApi' do
 
   # unit tests for get_user_account_positions
   # List account positions
-  # Returns a list of positions in the the specified account.
+  # Returns a list of positions in the specified account.
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to get positions.

data/spec/api/connections_api_spec.rb

@@ -29,6 +29,7 @@ describe 'ConnectionsApi' do
 
   # unit tests for detail_brokerage_authorization
   # Get brokerage authorization details
+  # Returns a single brokerage authorization object for the specified ID.
   # @param authorization_id The ID of a brokerage authorization object.
   # @param user_id 
   # @param user_secret 
@@ -41,7 +42,8 @@ describe 'ConnectionsApi' do
   end
 
   # unit tests for list_brokerage_authorizations
-  # List all brokerage authorizations for the user
+  # List all brokerage authorizations for the User
+  # Returns a list of Brokerage Autherization objects for the specified userId.
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -54,6 +56,7 @@ describe 'ConnectionsApi' do
 
   # unit tests for remove_brokerage_authorization
   # Delete brokerage authorization
+  # Deletes a specified brokerage authorization given by the ID.
   # @param authorization_id The ID of the Authorization to delete.
   # @param user_id 
   # @param user_secret 
@@ -66,7 +69,8 @@ describe 'ConnectionsApi' do
   end
 
   # unit tests for session_events
-  # List all session events for the partner
+  # Get all session events for a user
+  # Returns a list of session events associated with a user.
   # @param partner_client_id 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users

data/spec/api/options_api_spec.rb

@@ -28,7 +28,8 @@ describe 'OptionsApi' do
   end
 
   # unit tests for get_option_strategy
-  # Creates an option strategy object that will be used to place an option strategy order
+  # Create options strategy
+  # Creates an option strategy object that will be used to place an option strategy order. 
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to create the option strategy object in.
@@ -42,7 +43,8 @@ describe 'OptionsApi' do
   end
 
   # unit tests for get_options_chain
-  # Get the options chain
+  # Get the options chain for a symbol
+  # Returns the option chain for the specified symbol in the specified account.
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to get the options chain from.
@@ -56,7 +58,8 @@ describe 'OptionsApi' do
   end
 
   # unit tests for get_options_strategy_quote
-  # Get latest market data of option strategy
+  # Get options strategy quotes
+  # Returns a Strategy Quotes object which has latest market data of the specified option strategy. 
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account the strategy will be placed in.
@@ -70,7 +73,8 @@ describe 'OptionsApi' do
   end
 
   # unit tests for list_option_holdings
-  # Get the options holdings in the account
+  # Get account option holdings
+  # Returns a list of Options Positions. 
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to fetch options holdings for.
@@ -83,7 +87,8 @@ describe 'OptionsApi' do
   end
 
   # unit tests for place_option_strategy
-  # Place an option strategy order on the brokerage
+  # Place an option strategy order
+  # Places the option strategy order and returns the order record received from the brokerage.
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to execute the strategy in.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.16
+  version: 2.0.17
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2024-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday