snaptrade 2.0.7 → 2.0.8

data/docs/Trade.md

@@ -1,32 +0,0 @@
-# SnapTrade::Trade
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **account** | [**Account**](Account.md) |  | [optional] |
-| **symbol** | [**BrokerageSymbol**](BrokerageSymbol.md) |  | [optional] |
-| **universal_symbol** | [**UniversalSymbol**](UniversalSymbol.md) |  | [optional] |
-| **action** | [**TradeAction**](TradeAction.md) |  | [optional] |
-| **units** | **Integer** |  | [optional] |
-| **price** | **Float** |  | [optional] |
-| **sequence** | **Integer** |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::Trade.new(
-  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  account: null,
-  symbol: null,
-  universal_symbol: null,
-  action: null,
-  units: 6,
-  price: 24.81,
-  sequence: 1
-)
-```
-

data/docs/TradeAction.md

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

data/docs/TradeExecutionStatus.md

@@ -1,34 +0,0 @@
-# SnapTrade::TradeExecutionStatus
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **symbol** | [**BrokerageSymbol**](BrokerageSymbol.md) |  | [optional] |
-| **universal_symbol** | [**UniversalSymbol**](UniversalSymbol.md) |  | [optional] |
-| **trade** | [**Trade**](Trade.md) |  | [optional] |
-| **state** | [**State**](State.md) |  | [optional] |
-| **filled_units** | **Integer** | Number of filled units | [optional] |
-| **action** | [**TradeExecutionStatusAction**](TradeExecutionStatusAction.md) |  | [optional] |
-| **price** | **Float** | Price of execution | [optional] |
-| **commissions** | **Float** | Fees paid from executing trade | [optional] |
-| **meta** | **Hash<String, Object>** | Other misc. data | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::TradeExecutionStatus.new(
-  symbol: null,
-  universal_symbol: null,
-  trade: null,
-  state: null,
-  filled_units: 3,
-  action: null,
-  price: 23.44,
-  commissions: 23.44,
-  meta: {"canceledUnits":2}
-)
-```
-

data/docs/TradeExecutionStatusAction.md

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

data/docs/TradeImpact.md

@@ -1,26 +0,0 @@
-# SnapTrade::TradeImpact
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account** | [**Account**](Account.md) |  | [optional] |
-| **currency** | [**Currency**](Currency.md) |  | [optional] |
-| **remaining_cash** | **Float** | Remaining balance after executing all trades | [optional] |
-| **estimated_commissions** | **Float** | Total estimated commissions across all trades to make | [optional] |
-| **forex_fees** | **Float** | Estimated forex fees to pay to excute trades | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::TradeImpact.new(
-  account: null,
-  currency: null,
-  remaining_cash: 1.01,
-  estimated_commissions: 10.05,
-  forex_fees: 2.01
-)
-```
-

data/docs/TradingApi.md

@@ -1,491 +0,0 @@
-# SnapTrade::TradingApi
-
-All URIs are relative to *https://api.snaptrade.com/api/v1*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**cancel_user_account_order**](TradingApi.md#cancel_user_account_order) | **POST** /accounts/{accountId}/orders/cancel | Cancel open order in account |
-| [**get_order_impact**](TradingApi.md#get_order_impact) | **POST** /trade/impact | Check impact of trades on account. |
-| [**get_user_account_quotes**](TradingApi.md#get_user_account_quotes) | **GET** /accounts/{accountId}/quotes | Get symbol quotes |
-| [**place_force_order**](TradingApi.md#place_force_order) | **POST** /trade/place | Place a trade with NO validation. |
-| [**place_oco_order**](TradingApi.md#place_oco_order) | **POST** /trade/oco | Place a OCO (One Cancels Other) order |
-| [**place_order**](TradingApi.md#place_order) | **POST** /trade/{tradeId} | Place order |
-
-## cancel_user_account_order
-
-Cancel open order in 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"
-brokerage_order_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-
-begin
-  # Cancel open order in account
-  result = SnapTrade::Trading.cancel_user_account_order(
-                                                           user_id: user_id,
-                                                           user_secret: user_secret,
-                                                           account_id: account_id,
-                                                           brokerage_order_id: brokerage_order_id,
-                                                         )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Trading.cancel_user_account_order: #{e}"
-end
-```
-
-#### Using the cancel_user_account_order_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"
-brokerage_order_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-
-begin
-  # Cancel open order in account
-  data, status_code, headers, response = SnapTrade::Trading.cancel_user_account_order_with_http_info(
-                                                                                                        user_id: user_id,
-                                                                                                        user_secret: user_secret,
-                                                                                                        account_id: account_id,
-                                                                                                        brokerage_order_id: brokerage_order_id,
-                                                                                                      )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => AccountOrderRecord
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Trading.cancel_user_account_order: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account to cancel the order in. |  |
-| **trading_cancel_user_account_order_request** | [**TradingCancelUserAccountOrderRequest**](TradingCancelUserAccountOrderRequest.md) | The Order ID to be canceled |  |
-
-### Return type
-
-[**AccountOrderRecord**](AccountOrderRecord.md)
-
-## get_order_impact
-
-Check impact of trades on 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 = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-action = "BUY"
-order_type = "Limit"
-price = 31.33
-stop = 31.33
-time_in_force = "FOK"
-units = 3.14
-universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-notional_value = 3.14
-
-begin
-  # Check impact of trades on account.
-  result = SnapTrade::Trading.get_order_impact(
-                                                  user_id: user_id,
-                                                  user_secret: user_secret,
-                                                  account_id: account_id,
-                                                  action: action,
-                                                  order_type: order_type,
-                                                  price: price,
-                                                  stop: stop,
-                                                  time_in_force: time_in_force,
-                                                  units: units,
-                                                  universal_symbol_id: universal_symbol_id,
-                                                  notional_value: notional_value,
-                                                )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Trading.get_order_impact: #{e}"
-end
-```
-
-#### Using the get_order_impact_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 = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-action = "BUY"
-order_type = "Limit"
-price = 31.33
-stop = 31.33
-time_in_force = "FOK"
-units = 3.14
-universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-notional_value = 3.14
-
-begin
-  # Check impact of trades on account.
-  data, status_code, headers, response = SnapTrade::Trading.get_order_impact_with_http_info(
-                                                                                               user_id: user_id,
-                                                                                               user_secret: user_secret,
-                                                                                               account_id: account_id,
-                                                                                               action: action,
-                                                                                               order_type: order_type,
-                                                                                               price: price,
-                                                                                               stop: stop,
-                                                                                               time_in_force: time_in_force,
-                                                                                               units: units,
-                                                                                               universal_symbol_id: universal_symbol_id,
-                                                                                               notional_value: notional_value,
-                                                                                             )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => ManualTradeAndImpact
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Trading.get_order_impact: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-| **manual_trade_form** | [**ManualTradeForm**](ManualTradeForm.md) |  |  |
-
-### Return type
-
-[**ManualTradeAndImpact**](ManualTradeAndImpact.md)
-
-## get_user_account_quotes
-
-Get symbol quotes
-
-### 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"
-symbols = "symbols_example"
-account_id = "accountId_example"
-use_ticker = True
-
-begin
-  # Get symbol quotes
-  result = SnapTrade::Trading.get_user_account_quotes(
-                                                         user_id: user_id,
-                                                         user_secret: user_secret,
-                                                         symbols: symbols,
-                                                         account_id: account_id,
-                                                         use_ticker: use_ticker,
-                                                       )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Trading.get_user_account_quotes: #{e}"
-end
-```
-
-#### Using the get_user_account_quotes_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"
-symbols = "symbols_example"
-account_id = "accountId_example"
-use_ticker = True
-
-begin
-  # Get symbol quotes
-  data, status_code, headers, response = SnapTrade::Trading.get_user_account_quotes_with_http_info(
-                                                                                                      user_id: user_id,
-                                                                                                      user_secret: user_secret,
-                                                                                                      symbols: symbols,
-                                                                                                      account_id: account_id,
-                                                                                                      use_ticker: use_ticker,
-                                                                                                    )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Array<SymbolsQuotesInner>
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Trading.get_user_account_quotes: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-| **symbols** | **String** | List of universal_symbol_id or tickers to get quotes for. |  |
-| **account_id** | **String** | The ID of the account to get quotes. |  |
-| **use_ticker** | **Boolean** | Should be set to True if providing tickers. | [optional] |
-
-### Return type
-
-[**Array&lt;SymbolsQuotesInner&gt;**](SymbolsQuotesInner.md)
-
-## place_force_order
-
-Place a trade with NO validation.
-
-### 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 = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-action = "BUY"
-order_type = "Limit"
-price = 31.33
-stop = 31.33
-time_in_force = "FOK"
-units = 3.14
-universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-notional_value = 3.14
-
-begin
-  # Place a trade with NO validation.
-  result = SnapTrade::Trading.place_force_order(
-                                                   user_id: user_id,
-                                                   user_secret: user_secret,
-                                                   account_id: account_id,
-                                                   action: action,
-                                                   order_type: order_type,
-                                                   price: price,
-                                                   stop: stop,
-                                                   time_in_force: time_in_force,
-                                                   units: units,
-                                                   universal_symbol_id: universal_symbol_id,
-                                                   notional_value: notional_value,
-                                                 )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Trading.place_force_order: #{e}"
-end
-```
-
-#### Using the place_force_order_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 = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-action = "BUY"
-order_type = "Limit"
-price = 31.33
-stop = 31.33
-time_in_force = "FOK"
-units = 3.14
-universal_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
-notional_value = 3.14
-
-begin
-  # Place a trade with NO validation.
-  data, status_code, headers, response = SnapTrade::Trading.place_force_order_with_http_info(
-                                                                                                user_id: user_id,
-                                                                                                user_secret: user_secret,
-                                                                                                account_id: account_id,
-                                                                                                action: action,
-                                                                                                order_type: order_type,
-                                                                                                price: price,
-                                                                                                stop: stop,
-                                                                                                time_in_force: time_in_force,
-                                                                                                units: units,
-                                                                                                universal_symbol_id: universal_symbol_id,
-                                                                                                notional_value: notional_value,
-                                                                                              )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => AccountOrderRecord
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Trading.place_force_order: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-| **manual_trade_form** | [**ManualTradeForm**](ManualTradeForm.md) |  |  |
-
-### Return type
-
-[**AccountOrderRecord**](AccountOrderRecord.md)
-
-## place_oco_order
-
-Place a OCO (One Cancels Other) order
-
-### 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"
-first_trade_id = None
-second_trade_id = None
-
-begin
-  # Place a OCO (One Cancels Other) order
-  result = SnapTrade::Trading.place_oco_order(
-                                                 user_id: user_id,
-                                                 user_secret: user_secret,
-                                                 first_trade_id: first_trade_id,
-                                                 second_trade_id: second_trade_id,
-                                               )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Trading.place_oco_order: #{e}"
-end
-```
-
-#### Using the place_oco_order_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"
-first_trade_id = None
-second_trade_id = None
-
-begin
-  # Place a OCO (One Cancels Other) order
-  data, status_code, headers, response = SnapTrade::Trading.place_oco_order_with_http_info(
-                                                                                              user_id: user_id,
-                                                                                              user_secret: user_secret,
-                                                                                              first_trade_id: first_trade_id,
-                                                                                              second_trade_id: second_trade_id,
-                                                                                            )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => AccountOrderRecord
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Trading.place_oco_order: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-| **trading_place_oco_order_request** | [**TradingPlaceOCOOrderRequest**](TradingPlaceOCOOrderRequest.md) |  |  |
-
-### Return type
-
-[**AccountOrderRecord**](AccountOrderRecord.md)
-
-## place_order
-
-Place order
-
-### Example
-
-```ruby
-require 'snaptrade'
-
-SnapTrade.client_id = "YOUR_CLIENT_ID"
-SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
-
-trade_id = "tradeId_example"
-user_id = "John.doe@snaptrade.com"
-user_secret = "USERSECRET123"
-wait_to_confirm = True
-
-begin
-  # Place order
-  result = SnapTrade::Trading.place_order(
-                                             trade_id: trade_id,
-                                             user_id: user_id,
-                                             user_secret: user_secret,
-                                             wait_to_confirm: wait_to_confirm,
-                                           )
-  p result
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Trading.place_order: #{e}"
-end
-```
-
-#### Using the place_order_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-```ruby
-trade_id = "tradeId_example"
-user_id = "John.doe@snaptrade.com"
-user_secret = "USERSECRET123"
-wait_to_confirm = True
-
-begin
-  # Place order
-  data, status_code, headers, response = SnapTrade::Trading.place_order_with_http_info(
-                                                                                          trade_id: trade_id,
-                                                                                          user_id: user_id,
-                                                                                          user_secret: user_secret,
-                                                                                          wait_to_confirm: wait_to_confirm,
-                                                                                        )
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => AccountOrderRecord
-rescue SnapTrade::ApiError => e
-  puts "Exception when calling SnapTrade::Trading.place_order: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **trade_id** | **String** | The ID of trade object obtained from trade/impact endpoint |  |
-| **user_id** | **String** |  |  |
-| **user_secret** | **String** |  |  |
-| **validated_trade_body** | [**ValidatedTradeBody**](ValidatedTradeBody.md) |  | [optional] |
-
-### Return type
-
-[**AccountOrderRecord**](AccountOrderRecord.md)
-

data/docs/TradingCancelUserAccountOrderRequest.md

@@ -1,18 +0,0 @@
-# SnapTrade::TradingCancelUserAccountOrderRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **brokerage_order_id** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::TradingCancelUserAccountOrderRequest.new(
-  brokerage_order_id: 2bcd7cc3-e922-4976-bce1-9858296801c3
-)
-```
-

data/docs/TradingPlaceOCOOrderRequest.md

@@ -1,20 +0,0 @@
-# SnapTrade::TradingPlaceOCOOrderRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **first_trade_id** | **Object** | The ID of first trade object obtained from trade/impact endpoint | [optional] |
-| **second_trade_id** | **Object** | The ID of second trade object obtained from trade/impact endpoint | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::TradingPlaceOCOOrderRequest.new(
-  first_trade_id: null,
-  second_trade_id: null
-)
-```
-