snaptrade 2.0.20 → 2.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40178dd356fa3c53ef0a09c17cfeccc3ac900992803129689f3df8d605c0aae5
-  data.tar.gz: 9a1f4f13933f789bb1cf6d69b86195353ad9557c56f5db8ca18b34301aa6a024
+  metadata.gz: acd08ff642c28a4f723b0b5e860f88cd83a5ee7e899da6bf8f3ce56baee065fb
+  data.tar.gz: 0032e58d20662cbca08a153dad8bd1a1f0e6deab65f50f1329bf31544063fd1a
 SHA512:
-  metadata.gz: 52650a4f991bed16a72ead70654b6f58a8b1d774ce567b45363362f446e60b17696b98d217d366c67d056febf28bb6f9db0a0f503f2f088e9423b5ab33fb65fd
-  data.tar.gz: 9e40c527f3b8b9c7c5e7b0d442544ac89d348583aed99a81ea8dc71c3050278e1ed00db14a79293ffc16a34dae3d5854dd617d440e122ac394008bd7a0bc43ba
+  metadata.gz: 950bbd3e6c291bd7d51d057b1916f499fa5050501b4b170756ac4db7403c0117990cde8027b842ef0626af26daac611f5f91ecf494f8314933a14b62e4e8d77b
+  data.tar.gz: cab64b4ced9708b773afee7e22b5a3235fc116c620d98e9fd3db57f00b25366484b905a9440a919abe34f6c241e39e3bcd3e6a8a9181c17195d4d44cf3b75042

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.20)
+    snaptrade (2.0.21)
       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.20-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.20)
+[![npm](https://img.shields.io/badge/gem-v2.0.21-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.21)
 [![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.20'
+gem 'snaptrade', '~> 2.0.21'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -82,7 +82,7 @@ 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(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
@@ -95,7 +95,7 @@ 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(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
@@ -119,7 +119,7 @@ the data returned over the more fine-grained **positions**, **orders** and **bal
 
 ```ruby
 result = snaptrade.account_information.get_all_user_holdings(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
@@ -155,7 +155,7 @@ A list of account balances for the specified account (one per currency that the
 
 ```ruby
 result = snaptrade.account_information.get_user_account_balance(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
@@ -192,7 +192,7 @@ including the total account market value.
 
 ```ruby
 result = snaptrade.account_information.get_user_account_details(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
@@ -227,7 +227,7 @@ Fetch all recent orders from a user's account.
 
 ```ruby
 result = snaptrade.account_information.get_user_account_orders(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   state: "all",
@@ -271,7 +271,7 @@ Returns a list of positions in the specified account.
 
 ```ruby
 result = snaptrade.account_information.get_user_account_positions(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
@@ -310,7 +310,7 @@ data returned over the more fine-grained **positions**, **orders** and **balance
 ```ruby
 result = snaptrade.account_information.get_user_holdings(
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
 )
 p result
@@ -344,7 +344,7 @@ Get a list of all Account objects for the authenticated SnapTrade user.
 
 ```ruby
 result = snaptrade.account_information.list_user_accounts(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
 )
 p result
@@ -375,7 +375,7 @@ Updates various properties of a specified account.
 
 ```ruby
 result = snaptrade.account_information.update_user_account(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "accountId_example",
 )
@@ -434,7 +434,7 @@ Deletes a user you've registered over the SnapTrade API, and any data associated
 
 ```ruby
 result = snaptrade.authentication.delete_snap_trade_user(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
 )
 p result
 ```
@@ -465,7 +465,7 @@ JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
 
 ```ruby
 result = snaptrade.authentication.get_user_jwt(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
 )
 p result
@@ -516,7 +516,7 @@ Logs in a SnapTrade user and returns an authenticated connection portal URL for
 
 ```ruby
 result = snaptrade.authentication.login_snap_trade_user(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   broker: "ALPACA",
   immediate_redirect: true,
@@ -584,8 +584,10 @@ p result
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
 ##### userId: `String`<a id="userid-string"></a>
-SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as
-it's unique to a user
+SnapTrade User ID. This is chosen by the API partner and can be any string that
+is a) unique to the user, and b) immutable for the user. It is recommended to
+NOT use email addresses for this property because they are usually not
+immutable.
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -619,8 +621,10 @@ p result
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
 ##### userId: `String`<a id="userid-string"></a>
-SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as
-it's unique to a user
+SnapTrade User ID. This is chosen by the API partner and can be any string that
+is a) unique to the user, and b) immutable for the user. It is recommended to
+NOT use email addresses for this property because they are usually not
+immutable.
 
 ##### userSecret: `String`<a id="usersecret-string"></a>
 SnapTrade User Secret randomly generated by SnapTrade. This should be considered
@@ -649,7 +653,7 @@ Returns a single brokerage authorization object for the specified ID.
 ```ruby
 result = snaptrade.connections.detail_brokerage_authorization(
   authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
 )
 p result
@@ -683,7 +687,7 @@ Returns a list of Brokerage Authorization objects for the user
 
 ```ruby
 result = snaptrade.connections.list_brokerage_authorizations(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
 )
 p result
@@ -715,7 +719,7 @@ Deletes a specified brokerage authorization given by the ID.
 ```ruby
 snaptrade.connections.remove_brokerage_authorization(
   authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
 )
 ```
@@ -793,7 +797,7 @@ result = snaptrade.options.get_option_strategy(
         }
     ],
   strategy_type: "CUSTOM",
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "accountId_example",
 )
@@ -831,7 +835,7 @@ Returns the option chain for the specified symbol in the specified account.
 
 ```ruby
 result = snaptrade.options.get_options_chain(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "accountId_example",
   symbol: "symbol_example",
@@ -871,7 +875,7 @@ Returns a Strategy Quotes object which has latest market data of the specified o
 
 ```ruby
 result = snaptrade.options.get_options_strategy_quote(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "accountId_example",
   option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
@@ -911,7 +915,7 @@ Returns a list of Options Positions.
 
 ```ruby
 result = snaptrade.options.list_option_holdings(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "accountId_example",
 )
@@ -948,7 +952,7 @@ Places the option strategy order and returns the order record received from the
 result = snaptrade.options.place_option_strategy(
   order_type: "Limit",
   time_in_force: "FOK",
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
@@ -1270,7 +1274,7 @@ provided search string, matching on ticker and name.
 
 ```ruby
 result = snaptrade.reference_data.symbol_search_user_account(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   substring: "apple",
@@ -1309,7 +1313,7 @@ This will only work if the order has not yet been executed.
 
 ```ruby
 result = snaptrade.trading.cancel_user_account_order(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   brokerage_order_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
@@ -1346,7 +1350,7 @@ Return the trade object and it's impact on the account for the specified order.
 
 ```ruby
 result = snaptrade.trading.get_order_impact(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   action: "BUY",
@@ -1406,7 +1410,7 @@ Returns live quote(s) from the brokerage for the specified symbol(s).
 
 ```ruby
 result = snaptrade.trading.get_user_account_quotes(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   symbols: "symbols_example",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
@@ -1449,7 +1453,7 @@ Places a specified trade in the specified account.
 
 ```ruby
 result = snaptrade.trading.place_force_order(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   action: "BUY",
@@ -1512,7 +1516,7 @@ returns the status of the order from the brokerage.
 ```ruby
 result = snaptrade.trading.place_order(
   trade_id: "tradeId_example",
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   wait_to_confirm: true,
 )
@@ -1553,7 +1557,7 @@ Returns activities (transactions) for a user. Specifying start and end date is h
 
 ```ruby
 result = snaptrade.transactions_and_reporting.get_activities(
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   start_date: "2022-01-24",
   end_date: "2022-01-24",
@@ -1612,7 +1616,7 @@ Returns performance information (contributions, dividends, rate of return, etc)
 result = snaptrade.transactions_and_reporting.get_reporting_custom_range(
   start_date: "2022-01-24",
   end_date: "2022-01-24",
-  user_id: "John.doe@snaptrade.com",
+  user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
   accounts: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
   detailed: true,

data/lib/snaptrade/api/authentication_api.rb

@@ -414,7 +414,7 @@ module SnapTrade
     # Registers a new SnapTrade user under your ClientID.
     # Most SnapTrade operations require a user to be passed as a parameter.
     #
-    # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
+    # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     # @param body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def register_snap_trade_user(user_id: SENTINEL, extra: {})
@@ -430,7 +430,7 @@ module SnapTrade
     # Registers a new SnapTrade user under your ClientID.
     # Most SnapTrade operations require a user to be passed as a parameter.
     #
-    # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
+    # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     # @param body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def register_snap_trade_user_with_http_info(user_id: SENTINEL, extra: {})
@@ -514,7 +514,7 @@ module SnapTrade
     # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret
     # is comprimised or lost among other reasons.
     #
-    # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
+    # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.
     # @param body [UserIDandSecret] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -532,7 +532,7 @@ module SnapTrade
     # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret
     # is comprimised or lost among other reasons.
     #
-    # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
+    # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.
     # @param body [UserIDandSecret] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name

data/lib/snaptrade/models/connections_session_events200_response_inner.rb

@@ -18,7 +18,7 @@ module SnapTrade
 
     attr_accessor :session_id
 
-    # SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
+    # SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     attr_accessor :user_id
 
     # Time

data/lib/snaptrade/models/delete_user_response.rb

@@ -16,7 +16,7 @@ module SnapTrade
     # Delete status
     attr_accessor :status
 
-    # SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
+    # SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     attr_accessor :user_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/session_event.rb

@@ -18,7 +18,7 @@ module SnapTrade
 
     attr_accessor :session_id
 
-    # SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
+    # SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     attr_accessor :user_id
 
     # Time

data/lib/snaptrade/models/snap_trade_register_user_request_body.rb

@@ -13,7 +13,7 @@ require 'time'
 module SnapTrade
   # Data required to register a user via SnapTrade Partner
   class SnapTradeRegisterUserRequestBody
-    # SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
+    # SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     attr_accessor :user_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/user_i_dand_secret.rb

@@ -13,7 +13,7 @@ require 'time'
 module SnapTrade
   # Response when register user is successful
   class UserIDandSecret
-    # SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
+    # SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     attr_accessor :user_id
 
     # SnapTrade User Secret randomly generated by SnapTrade. This should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.

data/lib/snaptrade/version.rb

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

metadata

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