RubyGems - snaptrade - Versions diffs - 1.9.0 → 1.11.0 - Mend

snaptrade 1.9.0 → 1.11.0

Files changed (17) hide show

checksums.yaml +4 -4
data/Gemfile.lock +1 -1
data/README.md +16 -16
data/docs/AccountInformationApi.md +16 -16
data/docs/AuthenticationApi.md +20 -20
data/docs/OptionsApi.md +2 -2
data/docs/ReferenceDataApi.md +20 -20
data/lib/snaptrade/api/account_information_api.rb +16 -16
data/lib/snaptrade/api/authentication_api.rb +20 -20
data/lib/snaptrade/api/options_api.rb +3 -3
data/lib/snaptrade/api/reference_data_api.rb +20 -20
data/lib/snaptrade/version.rb +1 -1
data/spec/api/account_information_api_spec.rb +4 -4
data/spec/api/authentication_api_spec.rb +5 -5
data/spec/api/options_api_spec.rb +1 -1
data/spec/api/reference_data_api_spec.rb +5 -5
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0c86a14ebff544a61cd5f4a0ab54ebbf1e20d6f9e572f56c71cc33f9c25234e
-  data.tar.gz: dc5aaea89b2ba568a1213debc1c91e3f90590226c6acbb92a79b5c89af7ed2c5
+  metadata.gz: cedcc631a644ed26cc5bec004b166d8619bc18c35af5aa8d7cd847cc0a29bf60
+  data.tar.gz: c3747bef1d74929e1ca263aa6e935542019e4dea159541813a7e6b312f3c4d0b
 SHA512:
-  metadata.gz: 8bb453c0df3ef145f20bfdebfb3e4c984a73721dc257378443fea6bd7f31cd89875e620bfd184340af509c270b7131d92e1506dcbe140b896b3d1e8b279a2a03
-  data.tar.gz: abf01a016a2e67a194bccd4d8faa74a7fe33e9f8be213e0c77906a4902fe73d91762acba81ba966c549c30d740273c73b7c219f6cc5c7843276071a02dea365d
+  metadata.gz: 6e2ac1f322b9b0b2296711cbea419ebe4b4e61e34e884a623a71c50d3a903761a52bd8c666e09100725bb4bb59768d358edfabd12f979130dc0a5947edf09bbc
+  data.tar.gz: 709f8c2e95ea81a0d50c097ed9aa2f72fd61ccba913ffb0c7d3f850fc087d46314b678037094602a4808e29f10fa244a8a2c5d2fa69987959b2f6575a6e573ce

data/Gemfile.lock CHANGED Viewed

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

data/README.md CHANGED Viewed

@@ -9,7 +9,7 @@ For more information, please visit [https://snaptrade.com/](https://snaptrade.co
 Add to Gemfile:
 ```ruby
-gem 'snaptrade', '~> 1.9.0'
+gem 'snaptrade', '~> 1.11.0'
 ```
 ## Getting Started
@@ -25,7 +25,7 @@ user_secret = "USERSECRET123"
 brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
 begin
-  # List all accounts for the user, plus balances and positions for each account.
+  # List all accounts for the user, plus balances, positions, and orders for each account.
   result = SnapTrade::AccountInformation.get_all_user_holdings(
     user_id: user_id,
     user_secret: user_secret,
@@ -43,20 +43,20 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*SnapTrade::AccountInformationApi* | [**get_all_user_holdings**](docs/AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances and positions for each account.
-*SnapTrade::AccountInformationApi* | [**get_user_account_balance**](docs/AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | Get all cash balances of an investment account
+*SnapTrade::AccountInformationApi* | [**get_all_user_holdings**](docs/AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances, positions, and orders for each account.
+*SnapTrade::AccountInformationApi* | [**get_user_account_balance**](docs/AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | List account balances
 *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 all history of orders placed in account
-*SnapTrade::AccountInformationApi* | [**get_user_account_positions**](docs/AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | Get all positions of an investment 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* | [**list_user_accounts**](docs/AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List all investment accounts for the user
+*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
-*SnapTrade::AuthenticationApi* | [**delete_snap_trade_user**](docs/AuthenticationApi.md#delete_snap_trade_user) | **DELETE** /snapTrade/deleteUser | Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
-*SnapTrade::AuthenticationApi* | [**get_user_jwt**](docs/AuthenticationApi.md#get_user_jwt) | **GET** /snapTrade/encryptedJWT | Obtains an encrypted JWT tokens that should be decrypted on a user's local device
-*SnapTrade::AuthenticationApi* | [**list_snap_trade_users**](docs/AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | Get a list of all SnapTrade users you've registered on our platform
-*SnapTrade::AuthenticationApi* | [**login_snap_trade_user**](docs/AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
-*SnapTrade::AuthenticationApi* | [**register_snap_trade_user**](docs/AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Register user with SnapTrade in order to create secure brokerage authorizations
+*SnapTrade::AuthenticationApi* | [**delete_snap_trade_user**](docs/AuthenticationApi.md#delete_snap_trade_user) | **DELETE** /snapTrade/deleteUser | Delete SnapTrade user
+*SnapTrade::AuthenticationApi* | [**get_user_jwt**](docs/AuthenticationApi.md#get_user_jwt) | **GET** /snapTrade/encryptedJWT | Generate encrypted JWT token
+*SnapTrade::AuthenticationApi* | [**list_snap_trade_users**](docs/AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | List SnapTrade users
+*SnapTrade::AuthenticationApi* | [**login_snap_trade_user**](docs/AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Login user & generate connection link
+*SnapTrade::AuthenticationApi* | [**register_snap_trade_user**](docs/AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Create SnapTrade user
 *SnapTrade::ConnectionsApi* | [**detail_brokerage_authorization**](docs/ConnectionsApi.md#detail_brokerage_authorization) | **GET** /authorizations/{authorizationId} | Get detail of a specific brokerage authorizations for the user
 *SnapTrade::ConnectionsApi* | [**list_brokerage_authorizations**](docs/ConnectionsApi.md#list_brokerage_authorizations) | **GET** /authorizations | List all brokerage authorizations for the user
 *SnapTrade::ConnectionsApi* | [**remove_brokerage_authorization**](docs/ConnectionsApi.md#remove_brokerage_authorization) | **DELETE** /authorizations/{authorizationId} | Remove a brokerage authorization.
@@ -70,14 +70,14 @@ Class | Method | HTTP request | Description
 *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_stock_exchanges**](docs/ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | Return list of stock exchanges on Passiv and their suffixes
+*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
 *SnapTrade::ReferenceDataApi* | [**list_all_brokerage_authorization_type**](docs/ReferenceDataApi.md#list_all_brokerage_authorization_type) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types
-*SnapTrade::ReferenceDataApi* | [**list_all_brokerages**](docs/ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List of all brokerages.
-*SnapTrade::ReferenceDataApi* | [**list_all_currencies**](docs/ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List of all supported currencies
-*SnapTrade::ReferenceDataApi* | [**list_all_currencies_rates**](docs/ReferenceDataApi.md#list_all_currencies_rates) | **GET** /currencies/rates | Return the exchange rates of all supported currencies
-*SnapTrade::ReferenceDataApi* | [**symbol_search_user_account**](docs/ReferenceDataApi.md#symbol_search_user_account) | **POST** /accounts/{accountId}/symbols | Search for symbols that are supported by a brokerage account using a substring
+*SnapTrade::ReferenceDataApi* | [**list_all_brokerages**](docs/ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List brokerages
+*SnapTrade::ReferenceDataApi* | [**list_all_currencies**](docs/ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List currencies
+*SnapTrade::ReferenceDataApi* | [**list_all_currencies_rates**](docs/ReferenceDataApi.md#list_all_currencies_rates) | **GET** /currencies/rates | List currency exchange rates
+*SnapTrade::ReferenceDataApi* | [**symbol_search_user_account**](docs/ReferenceDataApi.md#symbol_search_user_account) | **POST** /accounts/{accountId}/symbols | Search for symbols available in an account
 *SnapTrade::TradingApi* | [**cancel_user_account_order**](docs/TradingApi.md#cancel_user_account_order) | **POST** /accounts/{accountId}/orders/cancel | Cancel open order in account
 *SnapTrade::TradingApi* | [**get_order_impact**](docs/TradingApi.md#get_order_impact) | **POST** /trade/impact | Check impact of trades on account.
 *SnapTrade::TradingApi* | [**get_user_account_quotes**](docs/TradingApi.md#get_user_account_quotes) | **GET** /accounts/{accountId}/quotes | Get symbol quotes

data/docs/AccountInformationApi.md CHANGED Viewed

@@ -4,18 +4,18 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**get_all_user_holdings**](AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances and positions for each account. |
-| [**get_user_account_balance**](AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | Get all cash balances of an investment account |
+| [**get_all_user_holdings**](AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances, positions, and orders for each account. |
+| [**get_user_account_balance**](AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | List account balances |
 | [**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 all history of orders placed in account |
-| [**get_user_account_positions**](AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | Get all positions of an investment 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. |
-| [**list_user_accounts**](AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List all investment accounts for the user |
+| [**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 |
 ## get_all_user_holdings
-List all accounts for the user, plus balances and positions for each account.
+List all accounts for the user, plus balances, positions, and orders for each account.
 ### Example
@@ -30,7 +30,7 @@ user_secret = "USERSECRET123"
 brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
 begin
-  # List all accounts for the user, plus balances and positions for each account.
+  # List all accounts for the user, plus balances, positions, and orders for each account.
   result = SnapTrade::AccountInformation.get_all_user_holdings(
     user_id: user_id,
     user_secret: user_secret,
@@ -52,7 +52,7 @@ user_secret = "USERSECRET123"
 brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
 begin
-  # List all accounts for the user, plus balances and positions for each account.
+  # List all accounts for the user, plus balances, positions, and orders for each account.
   data, status_code, headers, response = SnapTrade::AccountInformation.get_all_user_holdings_with_http_info(
     user_id: user_id,
     user_secret: user_secret,
@@ -80,7 +80,7 @@ end
 ## get_user_account_balance
-Get all cash balances of an investment account
+List account balances
 ### Example
@@ -95,7 +95,7 @@ user_secret = "USERSECRET123"
 account_id = "accountId_example"
 begin
-  # Get all cash balances of an investment account
+  # List account balances
   result = SnapTrade::AccountInformation.get_user_account_balance(
     user_id: user_id,
     user_secret: user_secret,
@@ -117,7 +117,7 @@ user_secret = "USERSECRET123"
 account_id = "accountId_example"
 begin
-  # Get all cash balances of an investment account
+  # List account balances
   data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_balance_with_http_info(
     user_id: user_id,
     user_secret: user_secret,
@@ -280,7 +280,7 @@ end
 ## get_user_account_positions
-Get all positions of an investment account
+List account positions
 ### Example
@@ -295,7 +295,7 @@ user_secret = "USERSECRET123"
 account_id = "accountId_example"
 begin
-  # Get all positions of an investment account
+  # List account positions
   result = SnapTrade::AccountInformation.get_user_account_positions(
     user_id: user_id,
     user_secret: user_secret,
@@ -317,7 +317,7 @@ user_secret = "USERSECRET123"
 account_id = "accountId_example"
 begin
-  # Get all positions of an investment account
+  # List account positions
   data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_positions_with_http_info(
     user_id: user_id,
     user_secret: user_secret,
@@ -410,7 +410,7 @@ end
 ## list_user_accounts
-List all investment accounts for the user
+List accounts
 ### Example
@@ -424,7 +424,7 @@ user_id = "John.doe@snaptrade.com"
 user_secret = "USERSECRET123"
 begin
-  # List all investment accounts for the user
+  # List accounts
   result = SnapTrade::AccountInformation.list_user_accounts(
     user_id: user_id,
     user_secret: user_secret,
@@ -444,7 +444,7 @@ user_id = "John.doe@snaptrade.com"
 user_secret = "USERSECRET123"
 begin
-  # List all investment accounts for the user
+  # List accounts
   data, status_code, headers, response = SnapTrade::AccountInformation.list_user_accounts_with_http_info(
     user_id: user_id,
     user_secret: user_secret,

data/docs/AuthenticationApi.md CHANGED Viewed

@@ -4,15 +4,15 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**delete_snap_trade_user**](AuthenticationApi.md#delete_snap_trade_user) | **DELETE** /snapTrade/deleteUser | Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user |
-| [**get_user_jwt**](AuthenticationApi.md#get_user_jwt) | **GET** /snapTrade/encryptedJWT | Obtains an encrypted JWT tokens that should be decrypted on a user&#39;s local device |
-| [**list_snap_trade_users**](AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | Get a list of all SnapTrade users you&#39;ve registered on our platform |
-| [**login_snap_trade_user**](AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Generate a redirect URI to securely login a user to the SnapTrade Connection Portal |
-| [**register_snap_trade_user**](AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Register user with SnapTrade in order to create secure brokerage authorizations |
+| [**delete_snap_trade_user**](AuthenticationApi.md#delete_snap_trade_user) | **DELETE** /snapTrade/deleteUser | Delete SnapTrade user |
+| [**get_user_jwt**](AuthenticationApi.md#get_user_jwt) | **GET** /snapTrade/encryptedJWT | Generate encrypted JWT token |
+| [**list_snap_trade_users**](AuthenticationApi.md#list_snap_trade_users) | **GET** /snapTrade/listUsers | List SnapTrade users |
+| [**login_snap_trade_user**](AuthenticationApi.md#login_snap_trade_user) | **POST** /snapTrade/login | Login user &amp; generate connection link |
+| [**register_snap_trade_user**](AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Create SnapTrade user |
 ## delete_snap_trade_user
-Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+Delete SnapTrade user
 ### Example
@@ -25,7 +25,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 user_id = "John.doe@snaptrade.com"
 begin
-  # Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+  # Delete SnapTrade user
   result = SnapTrade::Authentication.delete_snap_trade_user(
     user_id: user_id,
   )
@@ -43,7 +43,7 @@ This returns an Array which contains the response data, status code and headers.
 user_id = "John.doe@snaptrade.com"
 begin
-  # Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+  # Delete SnapTrade user
   data, status_code, headers, response = SnapTrade::Authentication.delete_snap_trade_user_with_http_info(
     user_id: user_id,
   )
@@ -67,7 +67,7 @@ end
 ## get_user_jwt
-Obtains an encrypted JWT tokens that should be decrypted on a user's local device
+Generate encrypted JWT token
 ### Example
@@ -81,7 +81,7 @@ user_id = "John.doe@snaptrade.com"
 user_secret = "USERSECRET123"
 begin
-  # Obtains an encrypted JWT tokens that should be decrypted on a user's local device
+  # Generate encrypted JWT token
   result = SnapTrade::Authentication.get_user_jwt(
     user_id: user_id,
     user_secret: user_secret,
@@ -101,7 +101,7 @@ user_id = "John.doe@snaptrade.com"
 user_secret = "USERSECRET123"
 begin
-  # Obtains an encrypted JWT tokens that should be decrypted on a user's local device
+  # Generate encrypted JWT token
   data, status_code, headers, response = SnapTrade::Authentication.get_user_jwt_with_http_info(
     user_id: user_id,
     user_secret: user_secret,
@@ -127,7 +127,7 @@ end
 ## list_snap_trade_users
-Get a list of all SnapTrade users you've registered on our platform
+List SnapTrade users
 ### Example
@@ -139,7 +139,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 begin
-  # Get a list of all SnapTrade users you've registered on our platform
+  # List SnapTrade users
   result = SnapTrade::Authentication.list_snap_trade_users
   p result
 rescue SnapTrade::ApiError => e
@@ -154,7 +154,7 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
-  # Get a list of all SnapTrade users you've registered on our platform
+  # List SnapTrade users
   data, status_code, headers, response = SnapTrade::Authentication.list_snap_trade_users_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -174,7 +174,7 @@ This endpoint does not need any parameter.
 ## login_snap_trade_user
-Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+Login user & generate connection link
 ### Example
@@ -193,7 +193,7 @@ reconnect = "8b5f262d-4bb9-365d-888a-202bd3b15fa1"
 connection_type = "read"
 begin
-  # Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+  # Login user & generate connection link
   result = SnapTrade::Authentication.login_snap_trade_user(
     user_id: user_id,
     user_secret: user_secret,
@@ -223,7 +223,7 @@ reconnect = "8b5f262d-4bb9-365d-888a-202bd3b15fa1"
 connection_type = "read"
 begin
-  # Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+  # Login user & generate connection link
   data, status_code, headers, response = SnapTrade::Authentication.login_snap_trade_user_with_http_info(
     user_id: user_id,
     user_secret: user_secret,
@@ -255,7 +255,7 @@ end
 ## register_snap_trade_user
-Register user with SnapTrade in order to create secure brokerage authorizations
+Create SnapTrade user
 ### Example
@@ -269,7 +269,7 @@ user_id = "snaptrade-user-123"
 rsa_public_key = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw=="
 begin
-  # Register user with SnapTrade in order to create secure brokerage authorizations
+  # Create SnapTrade user
   result = SnapTrade::Authentication.register_snap_trade_user(
     user_id: user_id,
     rsa_public_key: rsa_public_key,
@@ -289,7 +289,7 @@ user_id = "snaptrade-user-123"
 rsa_public_key = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw=="
 begin
-  # Register user with SnapTrade in order to create secure brokerage authorizations
+  # 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,

data/docs/OptionsApi.md CHANGED Viewed

@@ -287,7 +287,7 @@ begin
   )
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Array<OptionsHoldings>
+  p data # => Array<OptionsPosition>
 rescue SnapTrade::ApiError => e
   puts "Exception when calling SnapTrade::Options.list_option_holdings: #{e}"
 end
@@ -303,7 +303,7 @@ end
 ### Return type
-[**Array&lt;OptionsHoldings&gt;**](OptionsHoldings.md)
+[**Array&lt;OptionsPosition&gt;**](OptionsPosition.md)
 ## place_option_strategy

data/docs/ReferenceDataApi.md CHANGED Viewed

@@ -7,14 +7,14 @@ 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_stock_exchanges**](ReferenceDataApi.md#get_stock_exchanges) | **GET** /exchanges | Return list of stock exchanges on Passiv and their suffixes |
+| [**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 |
 | [**list_all_brokerage_authorization_type**](ReferenceDataApi.md#list_all_brokerage_authorization_type) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types |
-| [**list_all_brokerages**](ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List of all brokerages. |
-| [**list_all_currencies**](ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List of all supported currencies |
-| [**list_all_currencies_rates**](ReferenceDataApi.md#list_all_currencies_rates) | **GET** /currencies/rates | Return the exchange rates of all supported currencies |
-| [**symbol_search_user_account**](ReferenceDataApi.md#symbol_search_user_account) | **POST** /accounts/{accountId}/symbols | Search for symbols that are supported by a brokerage account using a substring |
+| [**list_all_brokerages**](ReferenceDataApi.md#list_all_brokerages) | **GET** /brokerages | List brokerages |
+| [**list_all_currencies**](ReferenceDataApi.md#list_all_currencies) | **GET** /currencies | List currencies |
+| [**list_all_currencies_rates**](ReferenceDataApi.md#list_all_currencies_rates) | **GET** /currencies/rates | List currency exchange rates |
+| [**symbol_search_user_account**](ReferenceDataApi.md#symbol_search_user_account) | **POST** /accounts/{accountId}/symbols | Search for symbols available in an account |
 ## get_currency_exchange_rate_pair
@@ -167,7 +167,7 @@ This endpoint does not need any parameter.
 ## get_stock_exchanges
-Return list of stock exchanges on Passiv and their suffixes
+List exchanges
 ### Example
@@ -179,7 +179,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 begin
-  # Return list of stock exchanges on Passiv and their suffixes
+  # List exchanges
   result = SnapTrade::ReferenceData.get_stock_exchanges
   p result
 rescue SnapTrade::ApiError => e
@@ -194,7 +194,7 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
-  # Return list of stock exchanges on Passiv and their suffixes
+  # List exchanges
   data, status_code, headers, response = SnapTrade::ReferenceData.get_stock_exchanges_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -384,7 +384,7 @@ end
 ## list_all_brokerages
-List of all brokerages.
+List brokerages
 ### Example
@@ -396,7 +396,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 begin
-  # List of all brokerages.
+  # List brokerages
   result = SnapTrade::ReferenceData.list_all_brokerages
   p result
 rescue SnapTrade::ApiError => e
@@ -411,7 +411,7 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
-  # List of all brokerages.
+  # List brokerages
   data, status_code, headers, response = SnapTrade::ReferenceData.list_all_brokerages_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -431,7 +431,7 @@ This endpoint does not need any parameter.
 ## list_all_currencies
-List of all supported currencies
+List currencies
 ### Example
@@ -443,7 +443,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 begin
-  # List of all supported currencies
+  # List currencies
   result = SnapTrade::ReferenceData.list_all_currencies
   p result
 rescue SnapTrade::ApiError => e
@@ -458,7 +458,7 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
-  # List of all supported currencies
+  # List currencies
   data, status_code, headers, response = SnapTrade::ReferenceData.list_all_currencies_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -478,7 +478,7 @@ This endpoint does not need any parameter.
 ## list_all_currencies_rates
-Return the exchange rates of all supported currencies
+List currency exchange rates
 ### Example
@@ -490,7 +490,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 begin
-  # Return the exchange rates of all supported currencies
+  # List currency exchange rates
   result = SnapTrade::ReferenceData.list_all_currencies_rates
   p result
 rescue SnapTrade::ApiError => e
@@ -505,7 +505,7 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
-  # Return the exchange rates of all supported currencies
+  # List currency exchange rates
   data, status_code, headers, response = SnapTrade::ReferenceData.list_all_currencies_rates_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -525,7 +525,7 @@ This endpoint does not need any parameter.
 ## symbol_search_user_account
-Search for symbols that are supported by a brokerage account using a substring
+Search for symbols available in an account
 ### Example
@@ -541,7 +541,7 @@ account_id = "accountId_example"
 substring = "apple"
 begin
-  # Search for symbols that are supported by a brokerage account using a substring
+  # Search for symbols available in an account
   result = SnapTrade::ReferenceData.symbol_search_user_account(
     user_id: user_id,
     user_secret: user_secret,
@@ -565,7 +565,7 @@ account_id = "accountId_example"
 substring = "apple"
 begin
-  # Search for symbols that are supported by a brokerage account using a substring
+  # Search for symbols available in an account
   data, status_code, headers, response = SnapTrade::ReferenceData.symbol_search_user_account_with_http_info(
     user_id: user_id,
     user_secret: user_secret,

data/lib/snaptrade/api/account_information_api.rb CHANGED Viewed

@@ -18,7 +18,7 @@ module SnapTrade
       @api_client = api_client
     end
-    # List all accounts for the user, plus balances and positions for each account.
+    # List all accounts for the user, plus balances, positions, and orders for each account.
     # @param user_id [String]
     # @param user_secret [String]
     # @param brokerage_authorizations [String] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
@@ -30,7 +30,7 @@ module SnapTrade
       data
     end
-    # List all accounts for the user, plus balances and positions for each account.
+    # List all accounts for the user, plus balances, positions, and orders for each account.
     # @param user_id [String]
     # @param user_secret [String]
     # @param brokerage_authorizations [String] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
@@ -41,7 +41,7 @@ module SnapTrade
       get_all_user_holdings_with_http_info_impl(user_id, user_secret, extra)
     end
-    # List all accounts for the user, plus balances and positions for each account.
+    # List all accounts for the user, plus balances, positions, and orders for each account.
     # @param user_id [String]
     # @param user_secret [String]
     # @param [Hash] opts the optional parameters
@@ -52,7 +52,7 @@ module SnapTrade
       data
     end
-    # List all accounts for the user, plus balances and positions for each account.
+    # List all accounts for the user, plus balances, positions, and orders for each account.
     # @param user_id [String]
     # @param user_secret [String]
     # @param [Hash] opts the optional parameters
@@ -114,7 +114,7 @@ module SnapTrade
     end
-    # Get all cash balances of an investment account
+    # List account balances
     # @param user_id [String]
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
@@ -125,7 +125,7 @@ module SnapTrade
       data
     end
-    # Get all cash balances of an investment account
+    # List account balances
     # @param user_id [String]
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
@@ -135,7 +135,7 @@ module SnapTrade
       get_user_account_balance_with_http_info_impl(user_id, user_secret, account_id, extra)
     end
-    # Get all cash balances of an investment account
+    # List account balances
     # @param user_id [String]
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
@@ -146,7 +146,7 @@ module SnapTrade
       data
     end
-    # Get all cash balances of an investment account
+    # List account balances
     # @param user_id [String]
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
@@ -416,7 +416,7 @@ module SnapTrade
     end
-    # Get all positions of an investment account
+    # List account positions
     # @param user_id [String]
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
@@ -427,7 +427,7 @@ module SnapTrade
       data
     end
-    # Get all positions of an investment account
+    # List account positions
     # @param user_id [String]
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
@@ -437,7 +437,7 @@ module SnapTrade
       get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, extra)
     end
-    # Get all positions of an investment account
+    # List account positions
     # @param user_id [String]
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
@@ -448,7 +448,7 @@ module SnapTrade
       data
     end
-    # Get all positions of an investment account
+    # List account positions
     # @param user_id [String]
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
@@ -610,7 +610,7 @@ module SnapTrade
     end
-    # List all investment accounts for the user
+    # List accounts
     # @param user_id [String]
     # @param user_secret [String]
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -620,7 +620,7 @@ module SnapTrade
       data
     end
-    # List all investment accounts for the user
+    # List accounts
     # @param user_id [String]
     # @param user_secret [String]
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -629,7 +629,7 @@ module SnapTrade
       list_user_accounts_with_http_info_impl(user_id, user_secret, extra)
     end
-    # List all investment accounts for the user
+    # List accounts
     # @param user_id [String]
     # @param user_secret [String]
     # @param [Hash] opts the optional parameters
@@ -639,7 +639,7 @@ module SnapTrade
       data
     end
-    # List all investment accounts for the user
+    # List accounts
     # @param user_id [String]
     # @param user_secret [String]
     # @param [Hash] opts the optional parameters

data/lib/snaptrade/api/authentication_api.rb CHANGED Viewed

@@ -18,7 +18,7 @@ module SnapTrade
       @api_client = api_client
     end
-    # Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+    # Delete SnapTrade user
     # @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,7 +27,7 @@ module SnapTrade
       data
     end
-    # Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+    # Delete SnapTrade user
     # @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: {})
@@ -35,7 +35,7 @@ module SnapTrade
       delete_snap_trade_user_with_http_info_impl(user_id, extra)
     end
-    # Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+    # Delete SnapTrade user
     # @param user_id [String]
     # @param [Hash] opts the optional parameters
     # @return [DeleteUserResponse]
@@ -44,7 +44,7 @@ module SnapTrade
       data
     end
-    # Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+    # Delete SnapTrade user
     # @param user_id [String]
     # @param [Hash] opts the optional parameters
     # @return [Array<(DeleteUserResponse, Integer, Hash)>] DeleteUserResponse data, response status code and response headers
@@ -98,7 +98,7 @@ module SnapTrade
     end
-    # Obtains an encrypted JWT tokens that should be decrypted on a user's local device
+    # Generate encrypted JWT token
     # @param user_id [String]
     # @param user_secret [String]
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -108,7 +108,7 @@ module SnapTrade
       data
     end
-    # Obtains an encrypted JWT tokens that should be decrypted on a user's local device
+    # Generate encrypted JWT token
     # @param user_id [String]
     # @param user_secret [String]
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -117,7 +117,7 @@ module SnapTrade
       get_user_jwt_with_http_info_impl(user_id, user_secret, extra)
     end
-    # Obtains an encrypted JWT tokens that should be decrypted on a user's local device
+    # Generate encrypted JWT token
     # @param user_id [String]
     # @param user_secret [String]
     # @param [Hash] opts the optional parameters
@@ -127,7 +127,7 @@ module SnapTrade
       data
     end
-    # Obtains an encrypted JWT tokens that should be decrypted on a user&#39;s local device
+    # Generate encrypted JWT token
     # @param user_id [String]
     # @param user_secret [String]
     # @param [Hash] opts the optional parameters
@@ -187,7 +187,7 @@ module SnapTrade
     end
-    # Get a list of all SnapTrade users you've registered on our platform
+    # List SnapTrade users
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_snap_trade_users(extra: {})
@@ -195,14 +195,14 @@ module SnapTrade
       data
     end
-    # Get a list of all SnapTrade users you've registered on our platform
+    # List SnapTrade users
     # @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
-    # Get a list of all SnapTrade users you've registered on our platform
+    # List SnapTrade users
     # @param [Hash] opts the optional parameters
     # @return [Array<String>]
     def list_snap_trade_users_impl(opts = {})
@@ -210,7 +210,7 @@ module SnapTrade
       data
     end
-    # Get a list of all SnapTrade users you&#39;ve registered on our platform
+    # List SnapTrade users
     # @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 = {})
@@ -258,7 +258,7 @@ module SnapTrade
     end
-    # Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+    # Login user & generate connection link
     # @param user_id [String]
     # @param user_secret [String]
     # @param broker [String]
@@ -281,7 +281,7 @@ module SnapTrade
       data
     end
-    # Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+    # Login user & generate connection link
     # @param user_id [String]
     # @param user_secret [String]
     # @param broker [String]
@@ -303,7 +303,7 @@ module SnapTrade
       login_snap_trade_user_with_http_info_impl(user_id, user_secret, extra)
     end
-    # Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+    # Login user & generate connection link
     # @param user_id [String]
     # @param user_secret [String]
     # @param [Hash] opts the optional parameters
@@ -314,7 +314,7 @@ module SnapTrade
       data
     end
-    # Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+    # Login user &amp; generate connection link
     # @param user_id [String]
     # @param user_secret [String]
     # @param [Hash] opts the optional parameters
@@ -380,7 +380,7 @@ module SnapTrade
     end
-    # Register user with SnapTrade in order to create secure brokerage authorizations
+    # 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]
@@ -395,7 +395,7 @@ module SnapTrade
       data
     end
-    # Register user with SnapTrade in order to create secure brokerage authorizations
+    # 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]
@@ -409,7 +409,7 @@ module SnapTrade
       register_snap_trade_user_with_http_info_impl(snap_trade_register_user_request_body, extra)
     end
-    # Register user with SnapTrade in order to create secure brokerage authorizations
+    # Create SnapTrade user
     # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody]
     # @param [Hash] opts the optional parameters
     # @return [UserIDandSecret]
@@ -418,7 +418,7 @@ module SnapTrade
       data
     end
-    # Register user with SnapTrade in order to create secure brokerage authorizations
+    # Create SnapTrade user
     # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody]
     # @param [Hash] opts the optional parameters
     # @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers

data/lib/snaptrade/api/options_api.rb CHANGED Viewed

@@ -381,7 +381,7 @@ module SnapTrade
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
     # @param [Hash] opts the optional parameters
-    # @return [Array<OptionsHoldings>]
+    # @return [Array<OptionsPosition>]
     def list_option_holdings_impl(user_id, user_secret, account_id, opts = {})
       data, _status_code, _headers = list_option_holdings_with_http_info(user_id, user_secret, account_id, opts)
       data
@@ -392,7 +392,7 @@ module SnapTrade
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Array<OptionsHoldings>, Integer, Hash)>] Array<OptionsHoldings> data, response status code and response headers
+    # @return [Array<(Array<OptionsPosition>, Integer, Hash)>] Array<OptionsPosition> data, response status code and response headers
     def list_option_holdings_with_http_info_impl(user_id, user_secret, account_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: OptionsApi.list_option_holdings ...'
@@ -429,7 +429,7 @@ module SnapTrade
       post_body = opts[:debug_body]
       # return_type
-      return_type = opts[:debug_return_type] || 'Array<OptionsHoldings>'
+      return_type = opts[:debug_return_type] || 'Array<OptionsPosition>'
       # auth_names
       auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']

data/lib/snaptrade/api/reference_data_api.rb CHANGED Viewed

@@ -239,7 +239,7 @@ module SnapTrade
     end
-    # Return list of stock exchanges on Passiv and their suffixes
+    # List exchanges
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_stock_exchanges(extra: {})
@@ -247,14 +247,14 @@ module SnapTrade
       data
     end
-    # Return list of stock exchanges on Passiv and their suffixes
+    # List exchanges
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_stock_exchanges_with_http_info(extra: {})
       get_stock_exchanges_with_http_info_impl(extra)
     end
-    # Return list of stock exchanges on Passiv and their suffixes
+    # List exchanges
     # @param [Hash] opts the optional parameters
     # @return [Array<Exchange>]
     def get_stock_exchanges_impl(opts = {})
@@ -262,7 +262,7 @@ module SnapTrade
       data
     end
-    # Return list of stock exchanges on Passiv and their suffixes
+    # List exchanges
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<Exchange>, Integer, Hash)>] Array<Exchange> data, response status code and response headers
     def get_stock_exchanges_with_http_info_impl(opts = {})
@@ -562,7 +562,7 @@ module SnapTrade
     end
-    # List of all brokerages.
+    # List brokerages
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_all_brokerages(extra: {})
@@ -570,14 +570,14 @@ module SnapTrade
       data
     end
-    # List of all brokerages.
+    # List brokerages
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_all_brokerages_with_http_info(extra: {})
       list_all_brokerages_with_http_info_impl(extra)
     end
-    # List of all brokerages.
+    # List brokerages
     # @param [Hash] opts the optional parameters
     # @return [Array<Brokerage>]
     def list_all_brokerages_impl(opts = {})
@@ -585,7 +585,7 @@ module SnapTrade
       data
     end
-    # List of all brokerages.
+    # List brokerages
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<Brokerage>, Integer, Hash)>] Array<Brokerage> data, response status code and response headers
     def list_all_brokerages_with_http_info_impl(opts = {})
@@ -633,7 +633,7 @@ module SnapTrade
     end
-    # List of all supported currencies
+    # List currencies
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_all_currencies(extra: {})
@@ -641,14 +641,14 @@ module SnapTrade
       data
     end
-    # List of all supported currencies
+    # List currencies
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_all_currencies_with_http_info(extra: {})
       list_all_currencies_with_http_info_impl(extra)
     end
-    # List of all supported currencies
+    # List currencies
     # @param [Hash] opts the optional parameters
     # @return [Array<Currency>]
     def list_all_currencies_impl(opts = {})
@@ -656,7 +656,7 @@ module SnapTrade
       data
     end
-    # List of all supported currencies
+    # List currencies
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<Currency>, Integer, Hash)>] Array<Currency> data, response status code and response headers
     def list_all_currencies_with_http_info_impl(opts = {})
@@ -704,7 +704,7 @@ module SnapTrade
     end
-    # Return the exchange rates of all supported currencies
+    # List currency exchange rates
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_all_currencies_rates(extra: {})
@@ -712,14 +712,14 @@ module SnapTrade
       data
     end
-    # Return the exchange rates of all supported currencies
+    # List currency exchange rates
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_all_currencies_rates_with_http_info(extra: {})
       list_all_currencies_rates_with_http_info_impl(extra)
     end
-    # Return the exchange rates of all supported currencies
+    # List currency exchange rates
     # @param [Hash] opts the optional parameters
     # @return [Array<ExchangeRatePairs>]
     def list_all_currencies_rates_impl(opts = {})
@@ -727,7 +727,7 @@ module SnapTrade
       data
     end
-    # Return the exchange rates of all supported currencies
+    # List currency exchange rates
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<ExchangeRatePairs>, Integer, Hash)>] Array<ExchangeRatePairs> data, response status code and response headers
     def list_all_currencies_rates_with_http_info_impl(opts = {})
@@ -775,7 +775,7 @@ module SnapTrade
     end
-    # Search for symbols that are supported by a brokerage account using a substring
+    # Search for symbols available in an account
     # @param user_id [String]
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
@@ -791,7 +791,7 @@ module SnapTrade
       data
     end
-    # Search for symbols that are supported by a brokerage account using a substring
+    # Search for symbols available in an account
     # @param user_id [String]
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
@@ -806,7 +806,7 @@ module SnapTrade
       symbol_search_user_account_with_http_info_impl(user_id, user_secret, account_id, extra)
     end
-    # Search for symbols that are supported by a brokerage account using a substring
+    # Search for symbols available in an account
     # @param user_id [String]
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.
@@ -818,7 +818,7 @@ module SnapTrade
       data
     end
-    # Search for symbols that are supported by a brokerage account using a substring
+    # Search for symbols available in an account
     # @param user_id [String]
     # @param user_secret [String]
     # @param account_id [String] The ID of the account get positions.

data/lib/snaptrade/version.rb CHANGED Viewed

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

data/spec/api/account_information_api_spec.rb CHANGED Viewed

@@ -29,7 +29,7 @@ describe 'AccountInformationApi' do
   end
   # unit tests for get_all_user_holdings
-  # List all accounts for the user, plus balances and positions for each account.
+  # List all accounts for the user, plus balances, positions, and orders for each account.
   # @param user_id
   # @param user_secret
   # @param [Hash] opts the optional parameters
@@ -42,7 +42,7 @@ describe 'AccountInformationApi' do
   end
   # unit tests for get_user_account_balance
-  # Get all cash balances of an investment account
+  # List account balances
   # @param user_id
   # @param user_secret
   # @param account_id The ID of the account get positions.
@@ -82,7 +82,7 @@ describe 'AccountInformationApi' do
   end
   # unit tests for get_user_account_positions
-  # Get all positions of an investment account
+  # List account positions
   # @param user_id
   # @param user_secret
   # @param account_id The ID of the account get positions.
@@ -108,7 +108,7 @@ describe 'AccountInformationApi' do
   end
   # unit tests for list_user_accounts
-  # List all investment accounts for the user
+  # List accounts
   # @param user_id
   # @param user_secret
   # @param [Hash] opts the optional parameters

data/spec/api/authentication_api_spec.rb CHANGED Viewed

@@ -29,7 +29,7 @@ describe 'AuthenticationApi' do
   end
   # unit tests for delete_snap_trade_user
-  # Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+  # Delete SnapTrade user
   # @param user_id
   # @param [Hash] opts the optional parameters
   # @return [DeleteUserResponse]
@@ -40,7 +40,7 @@ describe 'AuthenticationApi' do
   end
   # unit tests for get_user_jwt
-  # Obtains an encrypted JWT tokens that should be decrypted on a user&#39;s local device
+  # Generate encrypted JWT token
   # @param user_id
   # @param user_secret
   # @param [Hash] opts the optional parameters
@@ -52,7 +52,7 @@ describe 'AuthenticationApi' do
   end
   # unit tests for list_snap_trade_users
-  # Get a list of all SnapTrade users you&#39;ve registered on our platform
+  # List SnapTrade users
   # @param [Hash] opts the optional parameters
   # @return [Array<String>]
   describe 'list_snap_trade_users test' do
@@ -62,7 +62,7 @@ describe 'AuthenticationApi' do
   end
   # unit tests for login_snap_trade_user
-  # Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+  # Login user &amp; generate connection link
   # @param user_id
   # @param user_secret
   # @param [Hash] opts the optional parameters
@@ -75,7 +75,7 @@ describe 'AuthenticationApi' do
   end
   # unit tests for register_snap_trade_user
-  # Register user with SnapTrade in order to create secure brokerage authorizations
+  # Create SnapTrade user
   # @param snap_trade_register_user_request_body
   # @param [Hash] opts the optional parameters
   # @return [UserIDandSecret]

data/spec/api/options_api_spec.rb CHANGED Viewed

@@ -76,7 +76,7 @@ describe 'OptionsApi' do
   # @param user_secret
   # @param account_id The ID of the account get positions.
   # @param [Hash] opts the optional parameters
-  # @return [Array<OptionsHoldings>]
+  # @return [Array<OptionsPosition>]
   describe 'list_option_holdings test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/api/reference_data_api_spec.rb CHANGED Viewed

@@ -60,7 +60,7 @@ describe 'ReferenceDataApi' do
   end
   # unit tests for get_stock_exchanges
-  # Return list of stock exchanges on Passiv and their suffixes
+  # List exchanges
   # @param [Hash] opts the optional parameters
   # @return [Array<Exchange>]
   describe 'get_stock_exchanges test' do
@@ -104,7 +104,7 @@ describe 'ReferenceDataApi' do
   end
   # unit tests for list_all_brokerages
-  # List of all brokerages.
+  # List brokerages
   # @param [Hash] opts the optional parameters
   # @return [Array<Brokerage>]
   describe 'list_all_brokerages test' do
@@ -114,7 +114,7 @@ describe 'ReferenceDataApi' do
   end
   # unit tests for list_all_currencies
-  # List of all supported currencies
+  # List currencies
   # @param [Hash] opts the optional parameters
   # @return [Array<Currency>]
   describe 'list_all_currencies test' do
@@ -124,7 +124,7 @@ describe 'ReferenceDataApi' do
   end
   # unit tests for list_all_currencies_rates
-  # Return the exchange rates of all supported currencies
+  # List currency exchange rates
   # @param [Hash] opts the optional parameters
   # @return [Array<ExchangeRatePairs>]
   describe 'list_all_currencies_rates test' do
@@ -134,7 +134,7 @@ describe 'ReferenceDataApi' do
   end
   # unit tests for symbol_search_user_account
-  # Search for symbols that are supported by a brokerage account using a substring
+  # Search for symbols available in an account
   # @param user_id
   # @param user_secret
   # @param account_id The ID of the account get positions.

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.11.0
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-27 00:00:00.000000000 Z
+date: 2023-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday