snaptrade 1.17.10 → 2.0.77

data/docs/AuthType.md

@@ -1,15 +0,0 @@
-# SnapTrade::AuthType
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::AuthType.new()
-```
-

data/docs/AuthenticationApi.md

@@ -1,320 +0,0 @@
-# SnapTrade::AuthenticationApi
-
-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 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 & generate connection link |
-| [**register_snap_trade_user**](AuthenticationApi.md#register_snap_trade_user) | **POST** /snapTrade/registerUser | Create SnapTrade user |
-
-## 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.
-
-### Example
-
-```ruby
-require 'snaptrade'
-
-SnapTrade.client_id = "YOUR_CLIENT_ID"
-SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
-
-user_id = "John.doe@snaptrade.com"
-
-begin
-  # Delete SnapTrade user
-  result = SnapTrade::Authentication.delete_snap_trade_user(
-                                                               user_id: user_id,
-                                                             )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Authentication.delete_snap_trade_user: #{e}"
-end
-```
-
-#### Using the delete_snap_trade_user_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-```ruby
-user_id = "John.doe@snaptrade.com"
-
-begin
-  # Delete SnapTrade user
-  data, status_code, headers, response = SnapTrade::Authentication.delete_snap_trade_user_with_http_info(
-                                                                                                            user_id: user_id,
-                                                                                                          )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => DeleteUserResponse
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Authentication.delete_snap_trade_user: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-
-### Return type
-
-[**DeleteUserResponse**](DeleteUserResponse.md)
-
-## get_user_jwt
-
-Generate encrypted JWT token
-
-### Example
-
-```ruby
-require 'snaptrade'
-
-SnapTrade.client_id = "YOUR_CLIENT_ID"
-SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
-
-user_id = "John.doe@snaptrade.com"
-user_secret = "USERSECRET123"
-
-begin
-  # Generate encrypted JWT token
-  result = SnapTrade::Authentication.get_user_jwt(
-                                                     user_id: user_id,
-                                                     user_secret: user_secret,
-                                                   )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Authentication.get_user_jwt: #{e}"
-end
-```
-
-#### Using the get_user_jwt_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-```ruby
-user_id = "John.doe@snaptrade.com"
-user_secret = "USERSECRET123"
-
-begin
-  # 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,
-                                                                                                )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => EncryptedResponse
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Authentication.get_user_jwt: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-
-### Return type
-
-[**EncryptedResponse**](EncryptedResponse.md)
-
-## list_snap_trade_users
-
-List SnapTrade users
-
-Returns a list of users you've registered over the SnapTrade API.
-
-### Example
-
-```ruby
-require 'snaptrade'
-
-SnapTrade.client_id = "YOUR_CLIENT_ID"
-SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
-
-
-begin
-  # List SnapTrade users
-  result = SnapTrade::Authentication.list_snap_trade_users
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Authentication.list_snap_trade_users: #{e}"
-end
-```
-
-#### Using the list_snap_trade_users_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-```ruby
-
-begin
-  # List SnapTrade users
-  data, status_code, headers, response = SnapTrade::Authentication.list_snap_trade_users_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array<String>
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Authentication.list_snap_trade_users: #{e}"
-end
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-**Array<String>**
-
-## login_snap_trade_user
-
-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
-require 'snaptrade'
-
-SnapTrade.client_id = "YOUR_CLIENT_ID"
-SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
-
-user_id = "John.doe@snaptrade.com"
-user_secret = "USERSECRET123"
-broker = "ALPACA"
-immediate_redirect = True
-custom_redirect = "https://snaptrade.com"
-reconnect = "8b5f262d-4bb9-365d-888a-202bd3b15fa1"
-connection_type = "read"
-connection_portal_version = "v2"
-
-begin
-  # Login user & generate connection link
-  result = SnapTrade::Authentication.login_snap_trade_user(
-                                                              user_id: user_id,
-                                                              user_secret: user_secret,
-                                                              broker: broker,
-                                                              immediate_redirect: immediate_redirect,
-                                                              custom_redirect: custom_redirect,
-                                                              reconnect: reconnect,
-                                                              connection_type: connection_type,
-                                                              connection_portal_version: connection_portal_version,
-                                                            )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Authentication.login_snap_trade_user: #{e}"
-end
-```
-
-#### Using the login_snap_trade_user_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-```ruby
-user_id = "John.doe@snaptrade.com"
-user_secret = "USERSECRET123"
-broker = "ALPACA"
-immediate_redirect = True
-custom_redirect = "https://snaptrade.com"
-reconnect = "8b5f262d-4bb9-365d-888a-202bd3b15fa1"
-connection_type = "read"
-connection_portal_version = "v2"
-
-begin
-  # 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,
-                                                                                                           broker: broker,
-                                                                                                           immediate_redirect: immediate_redirect,
-                                                                                                           custom_redirect: custom_redirect,
-                                                                                                           reconnect: reconnect,
-                                                                                                           connection_type: connection_type,
-                                                                                                           connection_portal_version: connection_portal_version,
-                                                                                                         )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => AuthenticationLoginSnapTradeUser200Response
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Authentication.login_snap_trade_user: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-| **snap_trade_login_user_request_body** | [**SnapTradeLoginUserRequestBody**](SnapTradeLoginUserRequestBody.md) |  | [optional] |
-
-### Return type
-
-[**AuthenticationLoginSnapTradeUser200Response**](AuthenticationLoginSnapTradeUser200Response.md)
-
-## register_snap_trade_user
-
-Create SnapTrade user
-
-### Example
-
-```ruby
-require 'snaptrade'
-
-SnapTrade.client_id = "YOUR_CLIENT_ID"
-SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
-
-user_id = "snaptrade-user-123"
-
-begin
-  # Create SnapTrade user
-  result = SnapTrade::Authentication.register_snap_trade_user(
-                                                                 user_id: user_id,
-                                                               )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Authentication.register_snap_trade_user: #{e}"
-end
-```
-
-#### Using the register_snap_trade_user_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-```ruby
-user_id = "snaptrade-user-123"
-
-begin
-  # Create SnapTrade user
-  data, status_code, headers, response = SnapTrade::Authentication.register_snap_trade_user_with_http_info(
-                                                                                                              user_id: user_id,
-                                                                                                            )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => UserIDandSecret
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Authentication.register_snap_trade_user: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **snap_trade_register_user_request_body** | [**SnapTradeRegisterUserRequestBody**](SnapTradeRegisterUserRequestBody.md) |  |  |
-
-### Return type
-
-[**UserIDandSecret**](UserIDandSecret.md)
-

data/docs/AuthenticationLoginSnapTradeUser200Response.md

@@ -1,49 +0,0 @@
-# SnapTrade::AuthenticationLoginSnapTradeUser200Response
-
-## Class instance methods
-
-### `openapi_one_of`
-
-Returns the list of classes defined in oneOf.
-
-#### Example
-
-```ruby
-require 'snaptrade'
-
-SnapTrade::AuthenticationLoginSnapTradeUser200Response.openapi_one_of
-# =>
-# [
-#   :'EncryptedResponse',
-#   :'LoginRedirectURI'
-# ]
-```
-
-### build
-
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-
-#### Example
-
-```ruby
-require 'snaptrade'
-
-SnapTrade::AuthenticationLoginSnapTradeUser200Response.build(data)
-# => #<EncryptedResponse:0x00007fdd4aab02a0>
-
-SnapTrade::AuthenticationLoginSnapTradeUser200Response.build(data_that_doesnt_match)
-# => nil
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| **data** | **Mixed** | data to be matched against the list of oneOf items |
-
-#### Return type
-
-- `EncryptedResponse`
-- `LoginRedirectURI`
-- `nil` (if no type matches)
-

data/docs/Balance.md

@@ -1,20 +0,0 @@
-# SnapTrade::Balance
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **currency** | [**Currency**](Currency.md) |  | [optional] |
-| **cash** | **Float** |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::Balance.new(
-  currency: null,
-  cash: 300.71
-)
-```
-

data/docs/Brokerage.md

@@ -1,52 +0,0 @@
-# SnapTrade::Brokerage
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **display_name** | **String** |  | [optional] |
-| **description** | **String** |  | [optional] |
-| **aws_s3_logo_url** | **String** |  | [optional] |
-| **slug** | **String** |  | [optional] |
-| **url** | **String** |  | [optional] |
-| **enabled** | **Boolean** |  | [optional] |
-| **maintenance_mode** | **Boolean** |  | [optional] |
-| **allows_fractional_units** | **Boolean** |  | [optional] |
-| **allows_trading** | **Boolean** |  | [optional] |
-| **has_reporting** | **Boolean** |  | [optional] |
-| **is_real_time_connection** | **Boolean** |  | [optional] |
-| **allows_trading_through_snaptrade_api** | **Boolean** |  | [optional] |
-| **is_scraping_integration** | **Boolean** |  | [optional] |
-| **default_currency** | **String** |  | [optional] |
-| **brokerage_type** | [**BrokerageType**](BrokerageType.md) |  | [optional] |
-| **exchanges** | **Array<Object>** | List of exchange ID supported by brokerage | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::Brokerage.new(
-  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  name: Questrade,
-  display_name: Questrade,
-  description: Questrade is an online brokerage firm and wealth management firm based in Canada. It is Canada's largest discount broker.,
-  aws_s3_logo_url: https://www.snaptrade.com/questrade.logo,
-  slug: QUESTRADE,
-  url: https://www.questrade.com/,
-  enabled: true,
-  maintenance_mode: true,
-  allows_fractional_units: true,
-  allows_trading: true,
-  has_reporting: true,
-  is_real_time_connection: true,
-  allows_trading_through_snaptrade_api: true,
-  is_scraping_integration: true,
-  default_currency: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  brokerage_type: null,
-  exchanges: ["2bcd7cc3-e922-4976-bce1-9858296801c3","4bcd8cc3-c122-4974-dc21-1858296801f4"]
-)
-```
-

data/docs/BrokerageAuthorization.md

@@ -1,34 +0,0 @@
-# SnapTrade::BrokerageAuthorization
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **created_date** | **String** | Time | [optional] |
-| **updated_date** | **String** | Time | [optional] |
-| **brokerage** | [**Brokerage**](Brokerage.md) |  | [optional] |
-| **name** | **String** | Connection Name | [optional] |
-| **type** | **String** |  | [optional] |
-| **disabled** | **Boolean** |  | [optional] |
-| **disabled_date** | **String** | Disabled date | [optional] |
-| **meta** | **Hash<String, Object>** | Additional data about brokerage authorization | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::BrokerageAuthorization.new(
-  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  created_date: 2022-01-21T20:11:19.217Z,
-  updated_date: 2022-01-21T20:11:19.217Z,
-  brokerage: null,
-  name: Connection-1,
-  type: trade,
-  disabled: false,
-  disabled_date: 2022-01-21T20:11:19.217Z,
-  meta: {"identifier":123456}
-)
-```
-

data/docs/BrokerageAuthorizationType.md

@@ -1,18 +0,0 @@
-# SnapTrade::BrokerageAuthorizationType
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | [**BrokerageAuthorizationTypeType**](BrokerageAuthorizationTypeType.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::BrokerageAuthorizationType.new(
-  type: null
-)
-```
-

data/docs/BrokerageAuthorizationTypeReadOnly.md

@@ -1,24 +0,0 @@
-# SnapTrade::BrokerageAuthorizationTypeReadOnly
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **type** | [**BrokerageAuthorizationTypeReadOnlyType**](BrokerageAuthorizationTypeReadOnlyType.md) |  | [optional] |
-| **auth_type** | [**AuthType**](AuthType.md) |  | [optional] |
-| **brokerage** | [**BrokerageAuthorizationTypeReadOnlyBrokerage**](BrokerageAuthorizationTypeReadOnlyBrokerage.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::BrokerageAuthorizationTypeReadOnly.new(
-  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  type: null,
-  auth_type: null,
-  brokerage: null
-)
-```
-

data/docs/BrokerageAuthorizationTypeReadOnlyBrokerage.md

@@ -1,22 +0,0 @@
-# SnapTrade::BrokerageAuthorizationTypeReadOnlyBrokerage
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **name** | **String** | Name of Brokerage | [optional] |
-| **slug** | **String** | Slug of Brokerage. It is usually the name of the brokerage in capital letters | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::BrokerageAuthorizationTypeReadOnlyBrokerage.new(
-  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  name: Questrade,
-  slug: QUESTRADE
-)
-```
-

data/docs/BrokerageAuthorizationTypeReadOnlyType.md

@@ -1,15 +0,0 @@
-# SnapTrade::BrokerageAuthorizationTypeReadOnlyType
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::BrokerageAuthorizationTypeReadOnlyType.new()
-```
-

data/docs/BrokerageAuthorizationTypeType.md

@@ -1,15 +0,0 @@
-# SnapTrade::BrokerageAuthorizationTypeType
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::BrokerageAuthorizationTypeType.new()
-```
-

data/docs/BrokerageSymbol.md

@@ -1,28 +0,0 @@
-# SnapTrade::BrokerageSymbol
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **symbol** | [**BrokerageSymbolSymbol**](BrokerageSymbolSymbol.md) |  | [optional] |
-| **brokerage_authorization** | [**BrokerageAuthorization**](BrokerageAuthorization.md) |  | [optional] |
-| **description** | **String** |  | [optional] |
-| **allows_fractional_units** | **Boolean** |  | [optional] |
-| **option_symbol** | [**BrokerageSymbolOptionSymbol**](BrokerageSymbolOptionSymbol.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::BrokerageSymbol.new(
-  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  symbol: null,
-  brokerage_authorization: null,
-  description: VANGUARD CDN AGGREGATE BOND INDEX ETF,
-  allows_fractional_units: true,
-  option_symbol: null
-)
-```
-

data/docs/BrokerageSymbolOptionSymbol.md

@@ -1,34 +0,0 @@
-# SnapTrade::BrokerageSymbolOptionSymbol
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **ticker** | **String** |  |  |
-| **option_type** | [**OptionType**](OptionType.md) |  |  |
-| **strike_price** | **Float** |  |  |
-| **expiration_date** | **String** |  |  |
-| **is_mini_option** | **Boolean** |  | [optional] |
-| **underlying_symbol** | [**UnderlyingSymbol**](UnderlyingSymbol.md) |  |  |
-| **local_id** | **String** |  | [optional] |
-| **exchange_id** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::BrokerageSymbolOptionSymbol.new(
-  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  ticker: SPY 220819P00200000,
-  option_type: null,
-  strike_price: 200,
-  expiration_date: 2017-07-17T15:13:07.177712+00:00,
-  is_mini_option: false,
-  underlying_symbol: null,
-  local_id: 40817960,
-  exchange_id: null
-)
-```
-

data/docs/BrokerageSymbolSymbol.md

@@ -1,32 +0,0 @@
-# SnapTrade::BrokerageSymbolSymbol
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **symbol** | **String** |  |  |
-| **raw_symbol** | **String** |  |  |
-| **description** | **String** |  | [optional] |
-| **currency** | [**Currency**](Currency.md) |  |  |
-| **exchange** | [**Exchange**](Exchange.md) |  | [optional] |
-| **type** | [**SecurityType**](SecurityType.md) |  |  |
-| **currencies** | [**Array<Currency>**](Currency.md) |  |  |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::BrokerageSymbolSymbol.new(
-  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  symbol: VAB.TO,
-  raw_symbol: VAB,
-  description: VANGUARD CDN AGGREGATE BOND INDEX ETF,
-  currency: null,
-  exchange: null,
-  type: null,
-  currencies: null
-)
-```
-