snaptrade 1.17.10 → 2.0.77

data/docs/OptionType.md

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

data/docs/OptionsApi.md

@@ -1,390 +0,0 @@
-# SnapTrade::OptionsApi
-
-All URIs are relative to *https://api.snaptrade.com/api/v1*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_option_strategy**](OptionsApi.md#get_option_strategy) | **POST** /accounts/{accountId}/optionStrategy | Creates an option strategy object that will be used to place an option strategy order |
-| [**get_options_chain**](OptionsApi.md#get_options_chain) | **GET** /accounts/{accountId}/optionsChain | Get the options chain |
-| [**get_options_strategy_quote**](OptionsApi.md#get_options_strategy_quote) | **GET** /accounts/{accountId}/optionStrategy/{optionStrategyId} | Get latest market data of option strategy |
-| [**list_option_holdings**](OptionsApi.md#list_option_holdings) | **GET** /accounts/{accountId}/options | Get the options holdings in the account |
-| [**place_option_strategy**](OptionsApi.md#place_option_strategy) | **POST** /accounts/{accountId}/optionStrategy/{optionStrategyId}/execute | Place an option strategy order on the brokerage |
-
-## get_option_strategy
-
-Creates an option strategy object that will be used to place an option strategy order
-
-### Example
-
-```ruby
-require 'snaptrade'
-
-SnapTrade.client_id = "YOUR_CLIENT_ID"
-SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
-
-underlying_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-legs = [
-        {
-            "action" => "BUY_TO_OPEN",
-            "option_symbol_id" => "SPY220819P00200000",
-            "quantity" => 1,
-        }
-    ]
-strategy_type = "CUSTOM"
-user_id = "John.doe@snaptrade.com"
-user_secret = "USERSECRET123"
-account_id = "accountId_example"
-
-begin
-  # Creates an option strategy object that will be used to place an option strategy order
-  result = SnapTrade::Options.get_option_strategy(
-                                                     underlying_symbol_id: underlying_symbol_id,
-                                                     legs: legs,
-                                                     strategy_type: strategy_type,
-                                                     user_id: user_id,
-                                                     user_secret: user_secret,
-                                                     account_id: account_id,
-                                                   )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Options.get_option_strategy: #{e}"
-end
-```
-
-#### Using the get_option_strategy_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-```ruby
-underlying_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-legs = [
-        {
-            "action" => "BUY_TO_OPEN",
-            "option_symbol_id" => "SPY220819P00200000",
-            "quantity" => 1,
-        }
-    ]
-strategy_type = "CUSTOM"
-user_id = "John.doe@snaptrade.com"
-user_secret = "USERSECRET123"
-account_id = "accountId_example"
-
-begin
-  # Creates an option strategy object that will be used to place an option strategy order
-  data, status_code, headers, response = SnapTrade::Options.get_option_strategy_with_http_info(
-                                                                                                  underlying_symbol_id: underlying_symbol_id,
-                                                                                                  legs: legs,
-                                                                                                  strategy_type: strategy_type,
-                                                                                                  user_id: user_id,
-                                                                                                  user_secret: user_secret,
-                                                                                                  account_id: account_id,
-                                                                                                )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => StrategyQuotes
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Options.get_option_strategy: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account to create the option strategy object in. |  |
-| **options_get_option_strategy_request** | [**OptionsGetOptionStrategyRequest**](OptionsGetOptionStrategyRequest.md) |  |  |
-
-### Return type
-
-[**StrategyQuotes**](StrategyQuotes.md)
-
-## get_options_chain
-
-Get the options chain
-
-### 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"
-account_id = "accountId_example"
-symbol = "symbol_example"
-
-begin
-  # Get the options chain
-  result = SnapTrade::Options.get_options_chain(
-                                                   user_id: user_id,
-                                                   user_secret: user_secret,
-                                                   account_id: account_id,
-                                                   symbol: symbol,
-                                                 )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Options.get_options_chain: #{e}"
-end
-```
-
-#### Using the get_options_chain_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"
-account_id = "accountId_example"
-symbol = "symbol_example"
-
-begin
-  # Get the options chain
-  data, status_code, headers, response = SnapTrade::Options.get_options_chain_with_http_info(
-                                                                                                user_id: user_id,
-                                                                                                user_secret: user_secret,
-                                                                                                account_id: account_id,
-                                                                                                symbol: symbol,
-                                                                                              )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array<OptionChainInner>
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Options.get_options_chain: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account to get the options chain from. |  |
-| **symbol** | **String** | Universal symbol ID if symbol |  |
-
-### Return type
-
-[**Array&lt;OptionChainInner&gt;**](OptionChainInner.md)
-
-## get_options_strategy_quote
-
-Get latest market data of option strategy
-
-### 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"
-account_id = "accountId_example"
-option_strategy_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-
-begin
-  # Get latest market data of option strategy
-  result = SnapTrade::Options.get_options_strategy_quote(
-                                                            user_id: user_id,
-                                                            user_secret: user_secret,
-                                                            account_id: account_id,
-                                                            option_strategy_id: option_strategy_id,
-                                                          )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Options.get_options_strategy_quote: #{e}"
-end
-```
-
-#### Using the get_options_strategy_quote_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"
-account_id = "accountId_example"
-option_strategy_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-
-begin
-  # Get latest market data of option strategy
-  data, status_code, headers, response = SnapTrade::Options.get_options_strategy_quote_with_http_info(
-                                                                                                         user_id: user_id,
-                                                                                                         user_secret: user_secret,
-                                                                                                         account_id: account_id,
-                                                                                                         option_strategy_id: option_strategy_id,
-                                                                                                       )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => StrategyQuotes
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Options.get_options_strategy_quote: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account the strategy will be placed in. |  |
-| **option_strategy_id** | **String** | Option strategy id obtained from response when creating option strategy object |  |
-
-### Return type
-
-[**StrategyQuotes**](StrategyQuotes.md)
-
-## list_option_holdings
-
-Get the options holdings in the 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"
-account_id = "accountId_example"
-
-begin
-  # Get the options holdings in the account
-  result = SnapTrade::Options.list_option_holdings(
-                                                      user_id: user_id,
-                                                      user_secret: user_secret,
-                                                      account_id: account_id,
-                                                    )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Options.list_option_holdings: #{e}"
-end
-```
-
-#### Using the list_option_holdings_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"
-account_id = "accountId_example"
-
-begin
-  # Get the options holdings in the account
-  data, status_code, headers, response = SnapTrade::Options.list_option_holdings_with_http_info(
-                                                                                                   user_id: user_id,
-                                                                                                   user_secret: user_secret,
-                                                                                                   account_id: account_id,
-                                                                                                 )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array<OptionsPosition>
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Options.list_option_holdings: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account to fetch options holdings for. |  |
-
-### Return type
-
-[**Array&lt;OptionsPosition&gt;**](OptionsPosition.md)
-
-## place_option_strategy
-
-Place an option strategy order on the brokerage
-
-### Example
-
-```ruby
-require 'snaptrade'
-
-SnapTrade.client_id = "YOUR_CLIENT_ID"
-SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
-
-order_type = "Limit"
-time_in_force = "Day"
-user_id = "John.doe@snaptrade.com"
-user_secret = "USERSECRET123"
-account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-option_strategy_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-price = 31.33
-
-begin
-  # Place an option strategy order on the brokerage
-  result = SnapTrade::Options.place_option_strategy(
-                                                       order_type: order_type,
-                                                       time_in_force: time_in_force,
-                                                       user_id: user_id,
-                                                       user_secret: user_secret,
-                                                       account_id: account_id,
-                                                       option_strategy_id: option_strategy_id,
-                                                       price: price,
-                                                     )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Options.place_option_strategy: #{e}"
-end
-```
-
-#### Using the place_option_strategy_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-```ruby
-order_type = "Limit"
-time_in_force = "Day"
-user_id = "John.doe@snaptrade.com"
-user_secret = "USERSECRET123"
-account_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-option_strategy_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-price = 31.33
-
-begin
-  # Place an option strategy order on the brokerage
-  data, status_code, headers, response = SnapTrade::Options.place_option_strategy_with_http_info(
-                                                                                                    order_type: order_type,
-                                                                                                    time_in_force: time_in_force,
-                                                                                                    user_id: user_id,
-                                                                                                    user_secret: user_secret,
-                                                                                                    account_id: account_id,
-                                                                                                    option_strategy_id: option_strategy_id,
-                                                                                                    price: price,
-                                                                                                  )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => StrategyOrderRecord
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Options.place_option_strategy: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account to execute the strategy in. |  |
-| **option_strategy_id** | **String** | Option strategy id obtained from response when creating option strategy object |  |
-| **options_place_option_strategy_request** | [**OptionsPlaceOptionStrategyRequest**](OptionsPlaceOptionStrategyRequest.md) |  |  |
-
-### Return type
-
-[**StrategyOrderRecord**](StrategyOrderRecord.md)
-

data/docs/OptionsGetOptionStrategyRequest.md

@@ -1,22 +0,0 @@
-# SnapTrade::OptionsGetOptionStrategyRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **underlying_symbol_id** | **String** |  |  |
-| **legs** | [**Array<OptionLeg>**](OptionLeg.md) |  |  |
-| **strategy_type** | [**StrategyType**](StrategyType.md) |  |  |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::OptionsGetOptionStrategyRequest.new(
-  underlying_symbol_id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  legs: null,
-  strategy_type: null
-)
-```
-

data/docs/OptionsHoldings.md

@@ -1,28 +0,0 @@
-# SnapTrade::OptionsHoldings
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | Options information | [optional] |
-| **symbol** | **String** |  | [optional] |
-| **option_symbol** | [**OptionsSymbol**](OptionsSymbol.md) |  | [optional] |
-| **price** | **Float** | Trade Price if limit or stop limit order | [optional] |
-| **currency** | [**Currency**](Currency.md) |  | [optional] |
-| **average_purchase_price** | **Float** | Average purchase price for this position | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::OptionsHoldings.new(
-  id: 11b55fd2-dc29-42ec-ac03-97b5cd757a4d,
-  symbol: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  option_symbol: null,
-  price: 31.33,
-  currency: null,
-  average_purchase_price: 108.3353
-)
-```
-

data/docs/OptionsPlaceOptionStrategyRequest.md

@@ -1,22 +0,0 @@
-# SnapTrade::OptionsPlaceOptionStrategyRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **order_type** | [**OrderType**](OrderType.md) |  |  |
-| **time_in_force** | [**TimeInForce**](TimeInForce.md) |  |  |
-| **price** | **Float** | Trade Price if limit or stop limit order | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::OptionsPlaceOptionStrategyRequest.new(
-  order_type: null,
-  time_in_force: null,
-  price: 31.33
-)
-```
-

data/docs/OptionsPosition.md

@@ -1,26 +0,0 @@
-# SnapTrade::OptionsPosition
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **symbol** | [**BrokerageSymbol**](BrokerageSymbol.md) |  | [optional] |
-| **price** | **Float** | Trade Price if limit or stop limit order | [optional] |
-| **units** | **Float** |  | [optional] |
-| **currency** | [**OptionsPositionCurrency**](OptionsPositionCurrency.md) |  | [optional] |
-| **average_purchase_price** | **Float** | Average purchase price for this position | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::OptionsPosition.new(
-  symbol: null,
-  price: 31.33,
-  units: 10,
-  currency: null,
-  average_purchase_price: 108.3353
-)
-```
-

data/docs/OptionsPositionCurrency.md

@@ -1,22 +0,0 @@
-# SnapTrade::OptionsPositionCurrency
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **code** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::OptionsPositionCurrency.new(
-  id: 87b24961-b51e-4db8-9226-f198f6518a89,
-  code: USD,
-  name: US Dollar
-)
-```
-

data/docs/OptionsSymbol.md

@@ -1,34 +0,0 @@
-# SnapTrade::OptionsSymbol
-
-## 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::OptionsSymbol.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/OrderType.md

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

data/docs/PartnerData.md

@@ -1,40 +0,0 @@
-# SnapTrade::PartnerData
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **redirect_uri** | **String** | URI to redirect user back to after user is done adding brokerage connections | [optional] |
-| **allowed_brokerages** | [**Array<Brokerage>**](Brokerage.md) | Brokerages that can be accessed by partners | [optional] |
-| **name** | **String** | Name of Snaptrade Partner | [optional] |
-| **slug** | **String** | Slug of Snaptrade Partner | [optional] |
-| **logo_url** | **String** | URL to partner's logo | [optional] |
-| **pin_required** | **Boolean** | Shows if pin is required by users to access connection page | [optional] |
-| **can_access_trades** | **Boolean** | Shows if users of Snaptrade partners can access trade endpoints | [optional] |
-| **can_access_holdings** | **Boolean** | Shows if Snaptrade partners can get user holdings data | [optional] |
-| **can_access_account_history** | **Boolean** | Shows if Snaptrade partners can get users account history data | [optional] |
-| **can_access_reference_data** | **Boolean** | Shows if Snaptrade partners can get users holdings data | [optional] |
-| **can_access_portfolio_management** | **Boolean** | Shows if users Snaptrade partners can access portfolio group management features | [optional] |
-| **can_access_orders** | **Boolean** | Shows if Snaptrade partners can get users account order history | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::PartnerData.new(
-  redirect_uri: https://example.com/oauth/snaptrade,
-  allowed_brokerages: null,
-  name: Wealthy Chimpmunk,
-  slug: WEALTHYCHIPMUNK,
-  logo_url: https://example.com/logo.png,
-  pin_required: false,
-  can_access_trades: true,
-  can_access_holdings: true,
-  can_access_account_history: true,
-  can_access_reference_data: true,
-  can_access_portfolio_management: true,
-  can_access_orders: true
-)
-```
-

data/docs/PastValue.md

@@ -1,22 +0,0 @@
-# SnapTrade::PastValue
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **date** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
-| **value** | **Float** |  | [optional] |
-| **currency** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::PastValue.new(
-  date: Sun Jan 23 16:00:00 PST 2022,
-  value: 52.74,
-  currency: CAD
-)
-```
-