snaptrade 1.2.0

data/docs/TradingCancelUserAccountOrderRequest.md

@@ -0,0 +1,18 @@
+# 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

@@ -0,0 +1,20 @@
+# 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
+)
+```
+

data/docs/TransactionsAndReportingApi.md

@@ -0,0 +1,183 @@
+# SnapTrade::TransactionsAndReportingApi
+
+All URIs are relative to *https://api.snaptrade.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_activities**](TransactionsAndReportingApi.md#get_activities) | **GET** /activities | Get transaction history for a user |
+| [**get_reporting_custom_range**](TransactionsAndReportingApi.md#get_reporting_custom_range) | **GET** /performance/custom | Get performance information for a specific timeframe |
+
+## get_activities
+
+Get transaction history for a user
+
+Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+
+### 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"
+start_date = "2022-01-24"
+end_date = "2022-01-24"
+accounts = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
+brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
+type = "DIVIDEND"
+
+begin
+  # Get transaction history for a user
+  result = SnapTrade::TransactionsAndReporting.get_activities(
+    user_id: user_id,
+    user_secret: user_secret,
+    start_date: start_date,
+    end_date: end_date,
+    accounts: accounts,
+    brokerage_authorizations: brokerage_authorizations,
+    type: type,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::TransactionsAndReporting.get_activities: #{e}"
+end
+```
+
+#### Using the get_activities_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"
+start_date = "2022-01-24"
+end_date = "2022-01-24"
+accounts = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
+brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
+type = "DIVIDEND"
+
+begin
+  # Get transaction history for a user
+  data, status_code, headers, response = SnapTrade::TransactionsAndReporting.get_activities_with_http_info(
+    user_id: user_id,
+    user_secret: user_secret,
+    start_date: start_date,
+    end_date: end_date,
+    accounts: accounts,
+    brokerage_authorizations: brokerage_authorizations,
+    type: type,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array<UniversalActivity>
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::TransactionsAndReporting.get_activities: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+| **start_date** | **Date** |  | [optional] |
+| **end_date** | **Date** |  | [optional] |
+| **accounts** | **String** | Optional comma seperated list of account IDs used to filter the request on specific accounts | [optional] |
+| **brokerage_authorizations** | **String** | Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations | [optional] |
+| **type** | **String** | Optional comma seperated list of types to filter activities by. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT | [optional] |
+
+### Return type
+
+[**Array&lt;UniversalActivity&gt;**](UniversalActivity.md)
+
+## get_reporting_custom_range
+
+Get performance information for a specific timeframe
+
+Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+
+### Example
+
+```ruby
+require 'snaptrade'
+
+SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
+
+start_date = "2022-01-24"
+end_date = "2022-01-24"
+user_id = "John.doe@snaptrade.com"
+user_secret = "USERSECRET123"
+accounts = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
+detailed = True
+frequency = "monthly"
+
+begin
+  # Get performance information for a specific timeframe
+  result = SnapTrade::TransactionsAndReporting.get_reporting_custom_range(
+    start_date: start_date,
+    end_date: end_date,
+    user_id: user_id,
+    user_secret: user_secret,
+    accounts: accounts,
+    detailed: detailed,
+    frequency: frequency,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::TransactionsAndReporting.get_reporting_custom_range: #{e}"
+end
+```
+
+#### Using the get_reporting_custom_range_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+```ruby
+start_date = "2022-01-24"
+end_date = "2022-01-24"
+user_id = "John.doe@snaptrade.com"
+user_secret = "USERSECRET123"
+accounts = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
+detailed = True
+frequency = "monthly"
+
+begin
+  # Get performance information for a specific timeframe
+  data, status_code, headers, response = SnapTrade::TransactionsAndReporting.get_reporting_custom_range_with_http_info(
+    start_date: start_date,
+    end_date: end_date,
+    user_id: user_id,
+    user_secret: user_secret,
+    accounts: accounts,
+    detailed: detailed,
+    frequency: frequency,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => PerformanceCustom
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::TransactionsAndReporting.get_reporting_custom_range: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **Date** |  |  |
+| **end_date** | **Date** |  |  |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+| **accounts** | **String** | Optional comma seperated list of account IDs used to filter the request on specific accounts | [optional] |
+| **detailed** | **Boolean** | Optional, increases frequency of data points for the total value and contribution charts if set to true | [optional] |
+| **frequency** | **String** | Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly. | [optional] |
+
+### Return type
+
+[**PerformanceCustom**](PerformanceCustom.md)
+

data/docs/TransactionsStatus.md

@@ -0,0 +1,20 @@
+# SnapTrade::TransactionsStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **initial_sync_completed** | **Boolean** |  | [optional] |
+| **last_successful_sync** | **Date** | Date in YYYY-MM-DD format or null | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::TransactionsStatus.new(
+  initial_sync_completed: null,
+  last_successful_sync: Sun Jan 23 16:00:00 PST 2022
+)
+```
+

data/docs/Type.md

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

data/docs/USExchange.md

@@ -0,0 +1,34 @@
+# SnapTrade::USExchange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **code** | **String** |  | [optional] |
+| **mic_code** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **timezone** | **String** |  | [optional] |
+| **start_time** | **String** |  | [optional] |
+| **close_time** | **String** |  | [optional] |
+| **suffix** | **String** |  | [optional] |
+| **allows_cryptocurrency_symbols** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::USExchange.new(
+  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
+  code: ARCX,
+  mic_code: ARCA,
+  name: NYSE ARCA,
+  timezone: America/New_York,
+  start_time: 09:30:00,
+  close_time: 57600,
+  suffix: None,
+  allows_cryptocurrency_symbols: false
+)
+```
+

data/docs/UnderlyingSymbol.md

@@ -0,0 +1,30 @@
+# SnapTrade::UnderlyingSymbol
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **symbol** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **exchange** | [**USExchange**](USExchange.md) |  | [optional] |
+| **type** | [**SecurityType**](SecurityType.md) |  | [optional] |
+| **currencies** | [**Array<Currency>**](Currency.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::UnderlyingSymbol.new(
+  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
+  symbol: SPY,
+  description: SPDR S&P 500 ETF Trust,
+  currency: null,
+  exchange: null,
+  type: null,
+  currencies: null
+)
+```
+

data/docs/UniversalActivity.md

@@ -0,0 +1,46 @@
+# SnapTrade::UniversalActivity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **account** | [**AccountSimple**](AccountSimple.md) |  | [optional] |
+| **amount** | **Float** |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **fee** | **Float** |  | [optional] |
+| **institution** | **String** |  | [optional] |
+| **option_type** | **String** | If an option transaction, then it's type (BUY_TO_OPEN, SELL_TO_CLOSE, etc), otherwise empty string | [optional] |
+| **price** | **Float** |  | [optional] |
+| **settlement_date** | **String** |  | [optional] |
+| **symbol** | [**Symbol**](Symbol.md) |  | [optional] |
+| **option_symbol** | [**OptionsSymbol**](OptionsSymbol.md) |  | [optional] |
+| **trade_date** | **String** |  | [optional] |
+| **type** | **String** | Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT | [optional] |
+| **units** | **Float** | Usually but not necessarily an integer | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::UniversalActivity.new(
+  id: 2f7dc9b3-5c33-4668-3440-2b31e056ebe6,
+  account: null,
+  amount: 263.82,
+  currency: null,
+  description: WALT DISNEY UNIT DIST ON 21 SHS REC 12/31/21 PAY 01/06/22,
+  fee: 0,
+  institution: Passiv Investr,
+  option_type: BUY_TO_OPEN,
+  price: 0.4,
+  settlement_date: 2022-01-06T05:00:00.000Z,
+  symbol: null,
+  option_symbol: null,
+  trade_date: 2022-01-06T05:00:00.000Z,
+  type: null,
+  units: 5
+)
+```
+

data/docs/UniversalSymbol.md

@@ -0,0 +1,32 @@
+# SnapTrade::UniversalSymbol
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **symbol** | **String** |  | [optional] |
+| **raw_symbol** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **exchange** | [**Exchange**](Exchange.md) |  | [optional] |
+| **type** | [**SecurityType**](SecurityType.md) |  | [optional] |
+| **currencies** | [**Array<Currency>**](Currency.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::UniversalSymbol.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
+)
+```
+

data/docs/UniversalSymbolTicker.md

@@ -0,0 +1,32 @@
+# SnapTrade::UniversalSymbolTicker
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **symbol** | **String** |  | [optional] |
+| **raw_symbol** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **currency** | [**Currency**](Currency.md) |  | [optional] |
+| **exchange** | [**Exchange**](Exchange.md) |  | [optional] |
+| **type** | [**SecurityType**](SecurityType.md) |  | [optional] |
+| **currencies** | [**Array<Currency>**](Currency.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::UniversalSymbolTicker.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
+)
+```
+

data/docs/UserErrorLog.md

@@ -0,0 +1,28 @@
+# SnapTrade::UserErrorLog
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **requested_at** | **String** |  | [optional] |
+| **response** | **String** |  | [optional] |
+| **status_code** | **Float** |  | [optional] |
+| **_query_params** | **String** |  | [optional] |
+| **http_method** | **String** |  | [optional] |
+| **endpoint** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::UserErrorLog.new(
+  requested_at: 2022-01-21T20:11:19.217Z,
+  response: null,
+  status_code: 200,
+  _query_params: null,
+  http_method: POST,
+  endpoint: api/v1/snapTrade
+)
+```
+

data/docs/UserIDandSecret.md

@@ -0,0 +1,20 @@
+# SnapTrade::UserIDandSecret
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user | [optional] |
+| **user_secret** | **String** | SnapTrade User Secret randomly generated by Passiv. | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::UserIDandSecret.new(
+  user_id: snaptrade-user-123,
+  user_secret: h81@cx1lkalablakwjaltkejraj11=
+)
+```
+

data/docs/UserSettings.md

@@ -0,0 +1,36 @@
+# SnapTrade::UserSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **receive_cash_notification** | **Boolean** |  | [optional] |
+| **receive_drift_notification** | **Boolean** |  | [optional] |
+| **user_trial_activated** | **Boolean** |  | [optional] |
+| **activated_trial_date** | **String** |  | [optional] |
+| **demo** | **Boolean** |  | [optional] |
+| **api_enabled** | **Boolean** |  | [optional] |
+| **drift_threshold** | **Float** |  | [optional] |
+| **preferred_currency** | [**Currency**](Currency.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::UserSettings.new(
+  email: ops@getpassiv.com,
+  name: James Bond,
+  receive_cash_notification: true,
+  receive_drift_notification: true,
+  user_trial_activated: true,
+  activated_trial_date: 2017-07-17T15:13:07.177712+00:00,
+  demo: false,
+  api_enabled: false,
+  drift_threshold: 95,
+  preferred_currency: null
+)
+```
+