snaptrade 1.17.2 → 1.17.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cb2560186a962f93599e524293007f29c92ac375304bd228b20ee2d8d865ffe
-  data.tar.gz: 02fb0326a264c8e70dc8fde4b4928b836da876498ac29ead5851550c517ec2ca
+  metadata.gz: dc9780823d9dfda53279fb57e020586fad08fc3376e130257ff683ac8aab475d
+  data.tar.gz: 86b12bc58d21c07c1254d05f4a11dad2fc44ed891d056fad98ac04930a9f05d3
 SHA512:
-  metadata.gz: 9199a3e0a885f87e9e57433a89464d69ea5053182b1e789a7605b5523d9afe94503b1e0832ed279f5d1a5a923a6ba44d6bfc570ef7569274b6b8e0c5fef776fb
-  data.tar.gz: 3bf20e964ee5ed6b875f1be424c9a2b5293a7c74eceeb7c3443edd48fa0107003d46c7f2af9a1f63a969dd89fd0b11021301ccf7cfc61c1e1db89e469f69ab63
+  metadata.gz: ce243da503eab37607f7c4e524c610595586c2b38222f605cb040e2599a428a99640892be4e965e23789f8b75ded0415e007522094422ba40173e3194b17777e
+  data.tar.gz: f5c76b6e59d65d28bdfd6de6e2a3765ea68f8669838595f1827a9df761e0bf6529f97f1bcf1c934973843b0297475088f0dcc9f710999241d63a0e5377f71193

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (1.17.1)
+    snaptrade (1.17.2)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

data/README.md

@@ -9,7 +9,7 @@ For more information, please visit [https://snaptrade.com/](https://snaptrade.co
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 1.17.2'
+gem 'snaptrade', '~> 1.17.3'
 ```
 
 ## Getting Started
@@ -48,7 +48,7 @@ Class | Method | HTTP request | Description
 *SnapTrade::AccountInformationApi* | [**get_user_account_details**](docs/AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account
 *SnapTrade::AccountInformationApi* | [**get_user_account_orders**](docs/AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | Get history of orders placed in account
 *SnapTrade::AccountInformationApi* | [**get_user_account_positions**](docs/AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | List account positions
-*SnapTrade::AccountInformationApi* | [**get_user_holdings**](docs/AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account.
+*SnapTrade::AccountInformationApi* | [**get_user_holdings**](docs/AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account
 *SnapTrade::AccountInformationApi* | [**list_user_accounts**](docs/AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts
 *SnapTrade::AccountInformationApi* | [**update_user_account**](docs/AccountInformationApi.md#update_user_account) | **PUT** /accounts/{accountId} | Update details of an investment account
 *SnapTrade::APIStatusApi* | [**check**](docs/APIStatusApi.md#check) | **GET** / | Get API Status
@@ -69,7 +69,7 @@ Class | Method | HTTP request | Description
 *SnapTrade::OptionsApi* | [**place_option_strategy**](docs/OptionsApi.md#place_option_strategy) | **POST** /accounts/{accountId}/optionStrategy/{optionStrategyId}/execute | Place an option strategy order on the brokerage
 *SnapTrade::ReferenceDataApi* | [**get_currency_exchange_rate_pair**](docs/ReferenceDataApi.md#get_currency_exchange_rate_pair) | **GET** /currencies/rates/{currencyPair} | Return the exchange rate of a currency pair
 *SnapTrade::ReferenceDataApi* | [**get_partner_info**](docs/ReferenceDataApi.md#get_partner_info) | **GET** /snapTrade/partners | Get metadata related to Snaptrade partner
-*SnapTrade::ReferenceDataApi* | [**get_security_types**](docs/ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types.
+*SnapTrade::ReferenceDataApi* | [**get_security_types**](docs/ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types
 *SnapTrade::ReferenceDataApi* | [**get_stock_exchanges**](docs/ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges
 *SnapTrade::ReferenceDataApi* | [**get_symbols**](docs/ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols
 *SnapTrade::ReferenceDataApi* | [**get_symbols_by_ticker**](docs/ReferenceDataApi.md#get_symbols_by_ticker) | **GET** /symbols/{ticker} | Get details of a symbol by the ticker
@@ -135,6 +135,7 @@ Class | Method | HTTP request | Description
  - [SnapTrade::Model401FailedRequestResponse](docs/Model401FailedRequestResponse.md)
  - [SnapTrade::Model403FailedRequestResponse](docs/Model403FailedRequestResponse.md)
  - [SnapTrade::Model404FailedRequestResponse](docs/Model404FailedRequestResponse.md)
+ - [SnapTrade::Model500UnexpectedExceptionResponse](docs/Model500UnexpectedExceptionResponse.md)
  - [SnapTrade::ModelAssetClass](docs/ModelAssetClass.md)
  - [SnapTrade::ModelAssetClassDetails](docs/ModelAssetClassDetails.md)
  - [SnapTrade::ModelAssetClassTarget](docs/ModelAssetClassTarget.md)

data/docs/AccountInformationApi.md

@@ -9,7 +9,7 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
 | [**get_user_account_details**](AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account |
 | [**get_user_account_orders**](AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | Get history of orders placed in account |
 | [**get_user_account_positions**](AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | List account positions |
-| [**get_user_holdings**](AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account. |
+| [**get_user_holdings**](AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account |
 | [**list_user_accounts**](AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts |
 | [**update_user_account**](AccountInformationApi.md#update_user_account) | **PUT** /accounts/{accountId} | Update details of an investment account |
 
@@ -82,6 +82,8 @@ end
 
 List account balances
 
+A list of account balances for the specified account (one per currency that the account holds).
+
 ### Example
 
 ```ruby
@@ -212,6 +214,8 @@ end
 
 Get history of orders placed in account
 
+Fetch all recent orders from a user's account.
+
 ### Example
 
 ```ruby
@@ -345,7 +349,7 @@ end
 
 ## get_user_holdings
 
-List balances, positions and orders for the specified account.
+List balances, positions and orders for the specified account
 
 ### Example
 
@@ -360,7 +364,7 @@ user_id = "John.doe@snaptrade.com"
 user_secret = "USERSECRET123"
 
 begin
-  # List balances, positions and orders for the specified account.
+  # List balances, positions and orders for the specified account
   result = SnapTrade::AccountInformation.get_user_holdings(
                                                               account_id: account_id,
                                                               user_id: user_id,
@@ -382,7 +386,7 @@ user_id = "John.doe@snaptrade.com"
 user_secret = "USERSECRET123"
 
 begin
-  # List balances, positions and orders for the specified account.
+  # List balances, positions and orders for the specified account
   data, status_code, headers, response = SnapTrade::AccountInformation.get_user_holdings_with_http_info(
                                                                                                            account_id: account_id,
                                                                                                            user_id: user_id,

data/docs/AuthenticationApi.md

@@ -14,6 +14,8 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
 
 Delete SnapTrade user
 
+Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
+
 ### Example
 
 ```ruby
@@ -129,6 +131,8 @@ end
 
 List SnapTrade users
 
+Returns a list of users you've registered over the SnapTrade API.
+
 ### Example
 
 ```ruby
@@ -176,6 +180,8 @@ This endpoint does not need any parameter.
 
 Login user & generate connection link
 
+Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
+
 ### Example
 
 ```ruby
@@ -266,13 +272,11 @@ SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "snaptrade-user-123"
-rsa_public_key = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw=="
 
 begin
   # Create SnapTrade user
   result = SnapTrade::Authentication.register_snap_trade_user(
                                                                  user_id: user_id,
-                                                                 rsa_public_key: rsa_public_key,
                                                                )
   p result
 rescue SnapTrade::ApiError => e
@@ -286,13 +290,11 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 user_id = "snaptrade-user-123"
-rsa_public_key = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw=="
 
 begin
   # Create SnapTrade user
   data, status_code, headers, response = SnapTrade::Authentication.register_snap_trade_user_with_http_info(
                                                                                                               user_id: user_id,
-                                                                                                              rsa_public_key: rsa_public_key,
                                                                                                             )
   p status_code # => 2xx
   p headers # => { ... }

data/docs/Model500UnexpectedExceptionResponse.md

@@ -0,0 +1,22 @@
+# SnapTrade::Model500UnexpectedExceptionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **detail** | **Object** |  | [optional] |
+| **status_code** | **Object** |  | [optional] |
+| **code** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::Model500UnexpectedExceptionResponse.new(
+  detail: Encountered an unexpected exception.,
+  status_code: 500,
+  code: 1000
+)
+```
+

data/docs/ReferenceDataApi.md

@@ -6,7 +6,7 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
 | ------ | ------------ | ----------- |
 | [**get_currency_exchange_rate_pair**](ReferenceDataApi.md#get_currency_exchange_rate_pair) | **GET** /currencies/rates/{currencyPair} | Return the exchange rate of a currency pair |
 | [**get_partner_info**](ReferenceDataApi.md#get_partner_info) | **GET** /snapTrade/partners | Get metadata related to Snaptrade partner |
-| [**get_security_types**](ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types. |
+| [**get_security_types**](ReferenceDataApi.md#get_security_types) | **GET** /securityTypes | List of all security types |
 | [**get_stock_exchanges**](ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | List exchanges |
 | [**get_symbols**](ReferenceDataApi.md#get_symbols) | **POST** /symbols | Search for symbols |
 | [**get_symbols_by_ticker**](ReferenceDataApi.md#get_symbols_by_ticker) | **GET** /symbols/{ticker} | Get details of a symbol by the ticker |
@@ -120,7 +120,9 @@ This endpoint does not need any parameter.
 
 ## get_security_types
 
-List of all security types.
+List of all security types
+
+List security types available on SnapTrade.
 
 ### Example
 
@@ -132,7 +134,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 
 begin
-  # List of all security types.
+  # List of all security types
   result = SnapTrade::ReferenceData.get_security_types
   p result
 rescue SnapTrade::ApiError => e
@@ -147,7 +149,7 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 
 begin
-  # List of all security types.
+  # List of all security types
   data, status_code, headers, response = SnapTrade::ReferenceData.get_security_types_with_http_info
   p status_code # => 2xx
   p headers # => { ... }

data/docs/SnapTradeLoginUserRequestBody.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **broker** | **String** |  | [optional] |
-| **immediate_redirect** | **Boolean** |  | [optional] |
-| **custom_redirect** | **String** |  | [optional] |
-| **reconnect** | **String** |  | [optional] |
+| **broker** | **String** | Slug of the brokerage to connect the user to | [optional] |
+| **immediate_redirect** | **Boolean** | When set to True, user will be redirected back to the partner's site instead of the connection portal | [optional] |
+| **custom_redirect** | **String** | URL to redirect the user to after the user connects their brokerage account | [optional] |
+| **reconnect** | **String** | The UUID of the brokerage connection to be reconnected | [optional] |
 | **connection_type** | [**ConnectionType**](ConnectionType.md) |  | [optional] |
 
 ## Example

data/docs/SnapTradeRegisterUserRequestBody.md

@@ -5,7 +5,6 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **user_id** | **String** | SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user | [optional] |
-| **rsa_public_key** | **String** | Open SSH RSA public key | [optional] |
 
 ## Example
 
@@ -13,8 +12,7 @@
 require 'snaptrade'
 
 instance = SnapTrade::SnapTradeRegisterUserRequestBody.new(
-  user_id: snaptrade-user-123,
-  rsa_public_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw==
+  user_id: snaptrade-user-123
 )
 ```
 

data/docs/TransactionsAndReportingApi.md

@@ -11,7 +11,7 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
 
 Get transaction history for a user
 
-Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
 
 ### Example
 

data/lib/snaptrade/api/account_information_api.rb

@@ -113,6 +113,7 @@ module SnapTrade
 
 
     # List account balances
+    # A list of account balances for the specified account (one per currency that the account holds).
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get balances.
@@ -123,6 +124,7 @@ module SnapTrade
     end
 
     # List account balances
+    # A list of account balances for the specified account (one per currency that the account holds).
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get balances.
@@ -132,6 +134,7 @@ module SnapTrade
     end
 
     # List account balances
+    # A list of account balances for the specified account (one per currency that the account holds).
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get balances.
@@ -143,6 +146,7 @@ module SnapTrade
     end
 
     # List account balances
+    # A list of account balances for the specified account (one per currency that the account holds).
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get balances.
@@ -303,6 +307,7 @@ module SnapTrade
 
 
     # Get history of orders placed in account
+    # Fetch all recent orders from a user's account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get orders.
@@ -315,6 +320,7 @@ module SnapTrade
     end
 
     # Get history of orders placed in account
+    # Fetch all recent orders from a user's account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get orders.
@@ -326,6 +332,7 @@ module SnapTrade
     end
 
     # Get history of orders placed in account
+    # Fetch all recent orders from a user's account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get orders.
@@ -338,6 +345,7 @@ module SnapTrade
     end
 
     # Get history of orders placed in account
+    # Fetch all recent orders from a user's account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get orders.
@@ -503,7 +511,7 @@ module SnapTrade
     end
 
 
-    # List balances, positions and orders for the specified account.
+    # List balances, positions and orders for the specified account
     # @param account_id [String] The ID of the account to fetch holdings for.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -513,7 +521,7 @@ module SnapTrade
       data
     end
 
-    # List balances, positions and orders for the specified account.
+    # List balances, positions and orders for the specified account
     # @param account_id [String] The ID of the account to fetch holdings for.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -522,7 +530,7 @@ module SnapTrade
       get_user_holdings_with_http_info_impl(account_id, user_id, user_secret, extra)
     end
 
-    # List balances, positions and orders for the specified account.
+    # List balances, positions and orders for the specified account
     # @param account_id [String] The ID of the account to fetch holdings for.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -533,7 +541,7 @@ module SnapTrade
       data
     end
 
-    # List balances, positions and orders for the specified account.
+    # List balances, positions and orders for the specified account
     # @param account_id [String] The ID of the account to fetch holdings for.
     # @param user_id [String] 
     # @param user_secret [String] 

data/lib/snaptrade/api/authentication_api.rb

@@ -19,6 +19,7 @@ module SnapTrade
     end
 
     # Delete SnapTrade user
+    # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
     # @param user_id [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def delete_snap_trade_user(user_id:, extra: {})
@@ -27,6 +28,7 @@ module SnapTrade
     end
 
     # Delete SnapTrade user
+    # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
     # @param user_id [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def delete_snap_trade_user_with_http_info(user_id:, extra: {})
@@ -34,6 +36,7 @@ module SnapTrade
     end
 
     # Delete SnapTrade user
+    # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
     # @param user_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [DeleteUserResponse]
@@ -43,6 +46,7 @@ module SnapTrade
     end
 
     # Delete SnapTrade user
+    # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
     # @param user_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(DeleteUserResponse, Integer, Hash)>] DeleteUserResponse data, response status code and response headers
@@ -184,6 +188,7 @@ module SnapTrade
 
 
     # List SnapTrade users
+    # Returns a list of users you've registered over the SnapTrade API.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_snap_trade_users(extra: {})
       data, _status_code, _headers = list_snap_trade_users_with_http_info_impl(extra)
@@ -191,12 +196,14 @@ module SnapTrade
     end
 
     # List SnapTrade users
+    # Returns a list of users you've registered over the SnapTrade API.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_snap_trade_users_with_http_info(extra: {})
       list_snap_trade_users_with_http_info_impl(extra)
     end
 
     # List SnapTrade users
+    # Returns a list of users you've registered over the SnapTrade API.
     # @param [Hash] opts the optional parameters
     # @return [Array<String>]
     def list_snap_trade_users_impl(opts = {})
@@ -205,6 +212,7 @@ module SnapTrade
     end
 
     # List SnapTrade users
+    # Returns a list of users you&#39;ve registered over the SnapTrade API.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
     def list_snap_trade_users_with_http_info_impl(opts = {})
@@ -253,12 +261,13 @@ module SnapTrade
 
 
     # Login user & generate connection link
+    # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param broker [String] 
-    # @param immediate_redirect [Boolean] 
-    # @param custom_redirect [String] 
-    # @param reconnect [String] 
+    # @param broker [String] Slug of the brokerage to connect the user to
+    # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner&#39;s site instead of the connection portal
+    # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
+    # @param reconnect [String] The UUID of the brokerage connection to be reconnected
     # @param connection_type [ConnectionType] 
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -275,12 +284,13 @@ module SnapTrade
     end
 
     # Login user & generate connection link
+    # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param broker [String] 
-    # @param immediate_redirect [Boolean] 
-    # @param custom_redirect [String] 
-    # @param reconnect [String] 
+    # @param broker [String] Slug of the brokerage to connect the user to
+    # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner&#39;s site instead of the connection portal
+    # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
+    # @param reconnect [String] The UUID of the brokerage connection to be reconnected
     # @param connection_type [ConnectionType] 
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -296,6 +306,7 @@ module SnapTrade
     end
 
     # Login user & generate connection link
+    # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -307,6 +318,7 @@ module SnapTrade
     end
 
     # Login user &amp; generate connection link
+    # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -374,13 +386,11 @@ module SnapTrade
 
     # Create SnapTrade user
     # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it&#39;s unique to a user
-    # @param rsa_public_key [String] Open SSH RSA public key
     # @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, rsa_public_key: SENTINEL, extra: {})
+    def register_snap_trade_user(user_id: SENTINEL, extra: {})
       _body = {}
       _body[:userId] = user_id if user_id != SENTINEL
-      _body[:rsaPublicKey] = rsa_public_key if rsa_public_key != SENTINEL
       snap_trade_register_user_request_body = _body
       data, _status_code, _headers = register_snap_trade_user_with_http_info_impl(snap_trade_register_user_request_body, extra)
       data
@@ -388,13 +398,11 @@ module SnapTrade
 
     # Create SnapTrade user
     # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it&#39;s unique to a user
-    # @param rsa_public_key [String] Open SSH RSA public key
     # @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, rsa_public_key: SENTINEL, extra: {})
+    def register_snap_trade_user_with_http_info(user_id: SENTINEL, extra: {})
       _body = {}
       _body[:userId] = user_id if user_id != SENTINEL
-      _body[:rsaPublicKey] = rsa_public_key if rsa_public_key != SENTINEL
       snap_trade_register_user_request_body = _body
       register_snap_trade_user_with_http_info_impl(snap_trade_register_user_request_body, extra)
     end

data/lib/snaptrade/api/reference_data_api.rb

@@ -164,20 +164,23 @@ module SnapTrade
     end
 
 
-    # List of all security types.
+    # List of all security types
+    # List security types available on SnapTrade.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_security_types(extra: {})
       data, _status_code, _headers = get_security_types_with_http_info_impl(extra)
       data
     end
 
-    # List of all security types.
+    # List of all security types
+    # List security types available on SnapTrade.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_security_types_with_http_info(extra: {})
       get_security_types_with_http_info_impl(extra)
     end
 
-    # List of all security types.
+    # List of all security types
+    # List security types available on SnapTrade.
     # @param [Hash] opts the optional parameters
     # @return [Array<SecurityType>]
     def get_security_types_impl(opts = {})
@@ -185,7 +188,8 @@ module SnapTrade
       data
     end
 
-    # List of all security types.
+    # List of all security types
+    # List security types available on SnapTrade.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<SecurityType>, Integer, Hash)>] Array<SecurityType> data, response status code and response headers
     def get_security_types_with_http_info_impl(opts = {})

data/lib/snaptrade/api/transactions_and_reporting_api.rb

@@ -19,7 +19,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param start_date [Date] 
@@ -39,7 +39,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param start_date [Date] 
@@ -58,7 +58,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -74,7 +74,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters

data/lib/snaptrade/models/model500_unexpected_exception_response.rb

@@ -0,0 +1,239 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+
+=end
+
+require 'date'
+require 'time'
+
+module SnapTrade
+  # Example for a response that failed for unexpected reasons
+  class Model500UnexpectedExceptionResponse
+    attr_accessor :detail
+
+    attr_accessor :status_code
+
+    attr_accessor :code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'detail' => :'detail',
+        :'status_code' => :'status_code',
+        :'code' => :'code'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'detail' => :'Object',
+        :'status_code' => :'Object',
+        :'code' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'detail',
+        :'status_code',
+        :'code'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::Model500UnexpectedExceptionResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::Model500UnexpectedExceptionResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'detail')
+        self.detail = attributes[:'detail']
+      end
+
+      if attributes.key?(:'status_code')
+        self.status_code = attributes[:'status_code']
+      end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          detail == o.detail &&
+          status_code == o.status_code &&
+          code == o.code
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [detail, status_code, code].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = SnapTrade.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/snaptrade/models/snap_trade_login_user_request_body.rb

@@ -14,12 +14,16 @@ require 'time'
 module SnapTrade
   # Data to login a user via SnapTrade Partner
   class SnapTradeLoginUserRequestBody
+    # Slug of the brokerage to connect the user to
     attr_accessor :broker
 
+    # When set to True, user will be redirected back to the partner's site instead of the connection portal
     attr_accessor :immediate_redirect
 
+    # URL to redirect the user to after the user connects their brokerage account
     attr_accessor :custom_redirect
 
+    # The UUID of the brokerage connection to be reconnected
     attr_accessor :reconnect
 
     attr_accessor :connection_type

data/lib/snaptrade/models/snap_trade_register_user_request_body.rb

@@ -17,14 +17,10 @@ module SnapTrade
     # SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
     attr_accessor :user_id
 
-    # Open SSH RSA public key
-    attr_accessor :rsa_public_key
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'user_id' => :'userId',
-        :'rsa_public_key' => :'rsaPublicKey'
+        :'user_id' => :'userId'
       }
     end
 
@@ -36,8 +32,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'user_id' => :'String',
-        :'rsa_public_key' => :'String'
+        :'user_id' => :'String'
       }
     end
 
@@ -65,10 +60,6 @@ module SnapTrade
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
-
-      if attributes.key?(:'rsa_public_key')
-        self.rsa_public_key = attributes[:'rsa_public_key']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -89,8 +80,7 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          user_id == o.user_id &&
-          rsa_public_key == o.rsa_public_key
+          user_id == o.user_id
     end
 
     # @see the `==` method
@@ -102,7 +92,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [user_id, rsa_public_key].hash
+      [user_id].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/version.rb

@@ -9,5 +9,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '1.17.2'
+  VERSION = '1.17.3'
 end

data/lib/snaptrade.rb

@@ -62,6 +62,7 @@ require 'snaptrade/models/model400_failed_request_response'
 require 'snaptrade/models/model401_failed_request_response'
 require 'snaptrade/models/model403_failed_request_response'
 require 'snaptrade/models/model404_failed_request_response'
+require 'snaptrade/models/model500_unexpected_exception_response'
 require 'snaptrade/models/model_asset_class'
 require 'snaptrade/models/model_asset_class_details'
 require 'snaptrade/models/model_asset_class_target'

data/spec/api/account_information_api_spec.rb

@@ -43,6 +43,7 @@ describe 'AccountInformationApi' do
 
   # unit tests for get_user_account_balance
   # List account balances
+  # A list of account balances for the specified account (one per currency that the account holds).
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to get balances.
@@ -69,6 +70,7 @@ describe 'AccountInformationApi' do
 
   # unit tests for get_user_account_orders
   # Get history of orders placed in account
+  # Fetch all recent orders from a user's account.
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to get orders.
@@ -95,7 +97,7 @@ describe 'AccountInformationApi' do
   end
 
   # unit tests for get_user_holdings
-  # List balances, positions and orders for the specified account.
+  # List balances, positions and orders for the specified account
   # @param account_id The ID of the account to fetch holdings for.
   # @param user_id 
   # @param user_secret 

data/spec/api/authentication_api_spec.rb

@@ -30,6 +30,7 @@ describe 'AuthenticationApi' do
 
   # unit tests for delete_snap_trade_user
   # Delete SnapTrade user
+  # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
   # @param user_id 
   # @param [Hash] opts the optional parameters
   # @return [DeleteUserResponse]
@@ -53,6 +54,7 @@ describe 'AuthenticationApi' do
 
   # unit tests for list_snap_trade_users
   # List SnapTrade users
+  # Returns a list of users you've registered over the SnapTrade API.
   # @param [Hash] opts the optional parameters
   # @return [Array<String>]
   describe 'list_snap_trade_users test' do
@@ -63,6 +65,7 @@ describe 'AuthenticationApi' do
 
   # unit tests for login_snap_trade_user
   # Login user &amp; generate connection link
+  # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

data/spec/api/reference_data_api_spec.rb

@@ -50,7 +50,8 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for get_security_types
-  # List of all security types.
+  # List of all security types
+  # List security types available on SnapTrade.
   # @param [Hash] opts the optional parameters
   # @return [Array<SecurityType>]
   describe 'get_security_types test' do

data/spec/api/transactions_and_reporting_api_spec.rb

@@ -30,7 +30,7 @@ describe 'TransactionsAndReportingApi' do
 
   # unit tests for get_activities
   # Get transaction history for a user
-  # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+  # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

data/spec/models/model500_unexpected_exception_response_spec.rb

@@ -0,0 +1,42 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SnapTrade::Model500UnexpectedExceptionResponse
+describe SnapTrade::Model500UnexpectedExceptionResponse do
+  let(:instance) { SnapTrade::Model500UnexpectedExceptionResponse.new }
+
+  describe 'test an instance of Model500UnexpectedExceptionResponse' do
+    it 'should create an instance of Model500UnexpectedExceptionResponse' do
+      expect(instance).to be_instance_of(SnapTrade::Model500UnexpectedExceptionResponse)
+    end
+  end
+  describe 'test attribute "detail"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "status_code"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "code"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/snap_trade_register_user_request_body_spec.rb

@@ -27,10 +27,4 @@ describe SnapTrade::SnapTradeRegisterUserRequestBody do
     end
   end
 
-  describe 'test attribute "rsa_public_key"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 1.17.2
+  version: 1.17.3
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-13 00:00:00.000000000 Z
+date: 2023-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -131,6 +131,7 @@ files:
 - docs/Model401FailedRequestResponse.md
 - docs/Model403FailedRequestResponse.md
 - docs/Model404FailedRequestResponse.md
+- docs/Model500UnexpectedExceptionResponse.md
 - docs/ModelAssetClass.md
 - docs/ModelAssetClassDetails.md
 - docs/ModelAssetClassTarget.md
@@ -279,6 +280,7 @@ files:
 - lib/snaptrade/models/model401_failed_request_response.rb
 - lib/snaptrade/models/model403_failed_request_response.rb
 - lib/snaptrade/models/model404_failed_request_response.rb
+- lib/snaptrade/models/model500_unexpected_exception_response.rb
 - lib/snaptrade/models/model_asset_class.rb
 - lib/snaptrade/models/model_asset_class_details.rb
 - lib/snaptrade/models/model_asset_class_target.rb
@@ -422,6 +424,7 @@ files:
 - spec/models/model401_failed_request_response_spec.rb
 - spec/models/model403_failed_request_response_spec.rb
 - spec/models/model404_failed_request_response_spec.rb
+- spec/models/model500_unexpected_exception_response_spec.rb
 - spec/models/model_asset_class_details_spec.rb
 - spec/models/model_asset_class_spec.rb
 - spec/models/model_asset_class_target_spec.rb
@@ -576,6 +579,7 @@ test_files:
 - spec/models/strategy_quotes_spec.rb
 - spec/models/model_asset_class_details_spec.rb
 - spec/models/manual_trade_and_impact_spec.rb
+- spec/models/model500_unexpected_exception_response_spec.rb
 - spec/models/brokerage_authorization_type_read_only_type_spec.rb
 - spec/models/manual_trade_symbol_spec.rb
 - spec/models/position_spec.rb