snaptrade 1.2.0

data/docs/AccountInformationApi.md

@@ -0,0 +1,535 @@
+# SnapTrade::AccountInformationApi
+
+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_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_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 |
+| [**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.
+
+### 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"
+brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
+
+begin
+  # List all accounts for the user, plus balances and positions for each account.
+  result = SnapTrade::AccountInformation.get_all_user_holdings(
+    user_id: user_id,
+    user_secret: user_secret,
+    brokerage_authorizations: brokerage_authorizations,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.get_all_user_holdings: #{e}"
+end
+```
+
+#### Using the get_all_user_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"
+brokerage_authorizations = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
+
+begin
+  # List all accounts for the user, plus balances and positions 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,
+    brokerage_authorizations: brokerage_authorizations,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array<AccountHoldings>
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.get_all_user_holdings: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+| **brokerage_authorizations** | **String** | Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations). | [optional] |
+
+### Return type
+
+[**Array&lt;AccountHoldings&gt;**](AccountHoldings.md)
+
+## get_user_account_balance
+
+Get all cash balances of an investment 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 all cash balances of an investment account
+  result = SnapTrade::AccountInformation.get_user_account_balance(
+    user_id: user_id,
+    user_secret: user_secret,
+    account_id: account_id,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.get_user_account_balance: #{e}"
+end
+```
+
+#### Using the get_user_account_balance_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 all cash balances of an investment account
+  data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_balance_with_http_info(
+    user_id: user_id,
+    user_secret: user_secret,
+    account_id: account_id,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array<Balance>
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.get_user_account_balance: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+| **account_id** | **String** | The ID of the account get positions. |  |
+
+### Return type
+
+[**Array&lt;Balance&gt;**](Balance.md)
+
+## get_user_account_details
+
+Return details of a specific investment 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
+  # Return details of a specific investment account
+  result = SnapTrade::AccountInformation.get_user_account_details(
+    user_id: user_id,
+    user_secret: user_secret,
+    account_id: account_id,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.get_user_account_details: #{e}"
+end
+```
+
+#### Using the get_user_account_details_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
+  # Return details of a specific investment account
+  data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_details_with_http_info(
+    user_id: user_id,
+    user_secret: user_secret,
+    account_id: account_id,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array<Account>
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.get_user_account_details: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+| **account_id** | **String** | The ID of the account to get detail of. |  |
+
+### Return type
+
+[**Array&lt;Account&gt;**](Account.md)
+
+## get_user_account_orders
+
+Get all history of orders placed 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"
+state = "all"
+
+begin
+  # Get all history of orders placed in account
+  result = SnapTrade::AccountInformation.get_user_account_orders(
+    user_id: user_id,
+    user_secret: user_secret,
+    account_id: account_id,
+    state: state,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.get_user_account_orders: #{e}"
+end
+```
+
+#### Using the get_user_account_orders_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"
+state = "all"
+
+begin
+  # Get all history of orders placed in account
+  data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_orders_with_http_info(
+    user_id: user_id,
+    user_secret: user_secret,
+    account_id: account_id,
+    state: state,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array<AccountOrderRecord>
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.get_user_account_orders: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+| **account_id** | **String** | The ID of the account get positions. |  |
+| **state** | **String** | defaults value is set to \&quot;all\&quot; | [optional] |
+
+### Return type
+
+[**Array&lt;AccountOrderRecord&gt;**](AccountOrderRecord.md)
+
+## get_user_account_positions
+
+Get all positions of an investment 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 all positions of an investment account
+  result = SnapTrade::AccountInformation.get_user_account_positions(
+    user_id: user_id,
+    user_secret: user_secret,
+    account_id: account_id,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.get_user_account_positions: #{e}"
+end
+```
+
+#### Using the get_user_account_positions_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 all positions of an investment account
+  data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_positions_with_http_info(
+    user_id: user_id,
+    user_secret: user_secret,
+    account_id: account_id,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array<Position>
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.get_user_account_positions: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+| **account_id** | **String** | The ID of the account get positions. |  |
+
+### Return type
+
+[**Array&lt;Position&gt;**](Position.md)
+
+## get_user_holdings
+
+List balances, positions and orders for the specified account.
+
+### Example
+
+```ruby
+require 'snaptrade'
+
+SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
+
+account_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
+user_id = "John.doe@snaptrade.com"
+user_secret = "USERSECRET123"
+
+begin
+  # List balances, positions and orders for the specified account.
+  result = SnapTrade::AccountInformation.get_user_holdings(
+    account_id: account_id,
+    user_id: user_id,
+    user_secret: user_secret,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.get_user_holdings: #{e}"
+end
+```
+
+#### Using the get_user_holdings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+```ruby
+account_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631"
+user_id = "John.doe@snaptrade.com"
+user_secret = "USERSECRET123"
+
+begin
+  # List balances, positions and orders for the specified account.
+  data, status_code, headers, response = SnapTrade::AccountInformation.get_user_holdings_with_http_info(
+    account_id: account_id,
+    user_id: user_id,
+    user_secret: user_secret,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => AccountHoldingsAccount
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.get_user_holdings: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The ID of the account to fetch holdings for. |  |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+
+### Return type
+
+[**AccountHoldingsAccount**](AccountHoldingsAccount.md)
+
+## list_user_accounts
+
+List all investment accounts for the user
+
+### 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
+  # List all investment accounts for the user
+  result = SnapTrade::AccountInformation.list_user_accounts(
+    user_id: user_id,
+    user_secret: user_secret,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.list_user_accounts: #{e}"
+end
+```
+
+#### Using the list_user_accounts_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
+  # List all investment accounts for the user
+  data, status_code, headers, response = SnapTrade::AccountInformation.list_user_accounts_with_http_info(
+    user_id: user_id,
+    user_secret: user_secret,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array<Account>
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.list_user_accounts: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;Account&gt;**](Account.md)
+
+## update_user_account
+
+Update details of an investment 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
+  # Update details of an investment account
+  result = SnapTrade::AccountInformation.update_user_account(
+    user_id: user_id,
+    user_secret: user_secret,
+    account_id: account_id,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.update_user_account: #{e}"
+end
+```
+
+#### Using the update_user_account_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
+  # Update details of an investment account
+  data, status_code, headers, response = SnapTrade::AccountInformation.update_user_account_with_http_info(
+    user_id: user_id,
+    user_secret: user_secret,
+    account_id: account_id,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array<Account>
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::AccountInformation.update_user_account: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+| **account_id** | **String** | The ID of the account to update. |  |
+
+### Return type
+
+[**Array&lt;Account&gt;**](Account.md)
+

data/docs/AccountOrderRecord.md

@@ -0,0 +1,52 @@
+# SnapTrade::AccountOrderRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **brokerage_order_id** | **String** | Order id returned by brokerage | [optional] |
+| **status** | [**AccountOrderRecordStatus**](AccountOrderRecordStatus.md) |  | [optional] |
+| **symbol** | **String** |  | [optional] |
+| **universal_symbol** | [**UniversalSymbol**](UniversalSymbol.md) |  | [optional] |
+| **option_symbol** | [**OptionsSymbol**](OptionsSymbol.md) |  | [optional] |
+| **action** | [**Action**](Action.md) |  | [optional] |
+| **total_quantity** | **Float** | Trade Units | [optional] |
+| **open_quantity** | **Float** | Trade Units | [optional] |
+| **canceled_quantity** | **Float** | Trade Units | [optional] |
+| **filled_quantity** | **Float** | Trade Units | [optional] |
+| **execution_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
+| **limit_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
+| **stop_price** | **Float** | Trade Price if limit or stop limit order | [optional] |
+| **order_type** | [**OrderType**](OrderType.md) |  | [optional] |
+| **time_in_force** | [**TimeInForce**](TimeInForce.md) |  | [optional] |
+| **time_placed** | **String** | Time | [optional] |
+| **time_updated** | **String** | Time | [optional] |
+| **expiry_date** | **String** | Time | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::AccountOrderRecord.new(
+  brokerage_order_id: null,
+  status: null,
+  symbol: 2bcd7cc3-e922-4976-bce1-9858296801c3,
+  universal_symbol: null,
+  option_symbol: null,
+  action: null,
+  total_quantity: null,
+  open_quantity: null,
+  canceled_quantity: null,
+  filled_quantity: null,
+  execution_price: 31.33,
+  limit_price: 31.33,
+  stop_price: 31.33,
+  order_type: null,
+  time_in_force: null,
+  time_placed: 2022-01-21T20:11:19.217Z,
+  time_updated: 2022-01-21T20:11:19.217Z,
+  expiry_date: 2022-01-21T20:11:19.217Z
+)
+```
+

data/docs/AccountOrderRecordStatus.md

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

data/docs/AccountSimple.md

@@ -0,0 +1,24 @@
+# SnapTrade::AccountSimple
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **number** | **String** |  | [optional] |
+| **sync_status** | [**AccountSyncStatus**](AccountSyncStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::AccountSimple.new(
+  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
+  name: Registered Retirement Savings Account,
+  number: Q6542138443,
+  sync_status: null
+)
+```
+

data/docs/AccountSyncStatus.md

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

data/docs/Action.md

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

data/docs/AuthType.md

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