snaptrade 1.2.0

data/docs/ConnectionsApi.md

@@ -0,0 +1,265 @@
+# SnapTrade::ConnectionsApi
+
+All URIs are relative to *https://api.snaptrade.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**detail_brokerage_authorization**](ConnectionsApi.md#detail_brokerage_authorization) | **GET** /authorizations/{authorizationId} | Get detail of a specific brokerage authorizations for the user |
+| [**list_brokerage_authorizations**](ConnectionsApi.md#list_brokerage_authorizations) | **GET** /authorizations | List all brokerage authorizations for the user |
+| [**remove_brokerage_authorization**](ConnectionsApi.md#remove_brokerage_authorization) | **DELETE** /authorizations/{authorizationId} | Remove a brokerage authorization. |
+| [**session_events**](ConnectionsApi.md#session_events) | **GET** /sessionEvents | List all session events for the partner |
+
+## detail_brokerage_authorization
+
+Get detail of a specific brokerage authorizations for the user
+
+### Example
+
+```ruby
+require 'snaptrade'
+
+SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
+
+authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
+user_id = "John.doe@snaptrade.com"
+user_secret = "USERSECRET123"
+
+begin
+  # Get detail of a specific brokerage authorizations for the user
+  result = SnapTrade::Connections.detail_brokerage_authorization(
+    authorization_id: authorization_id,
+    user_id: user_id,
+    user_secret: user_secret,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::Connections.detail_brokerage_authorization: #{e}"
+end
+```
+
+#### Using the detail_brokerage_authorization_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+```ruby
+authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
+user_id = "John.doe@snaptrade.com"
+user_secret = "USERSECRET123"
+
+begin
+  # Get detail of a specific brokerage authorizations for the user
+  data, status_code, headers, response = SnapTrade::Connections.detail_brokerage_authorization_with_http_info(
+    authorization_id: authorization_id,
+    user_id: user_id,
+    user_secret: user_secret,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => BrokerageAuthorization
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::Connections.detail_brokerage_authorization: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_id** | **String** | The ID of a brokerage authorization object. |  |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+
+### Return type
+
+[**BrokerageAuthorization**](BrokerageAuthorization.md)
+
+## list_brokerage_authorizations
+
+List all brokerage authorizations 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 brokerage authorizations for the user
+  result = SnapTrade::Connections.list_brokerage_authorizations(
+    user_id: user_id,
+    user_secret: user_secret,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::Connections.list_brokerage_authorizations: #{e}"
+end
+```
+
+#### Using the list_brokerage_authorizations_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 brokerage authorizations for the user
+  data, status_code, headers, response = SnapTrade::Connections.list_brokerage_authorizations_with_http_info(
+    user_id: user_id,
+    user_secret: user_secret,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array<BrokerageAuthorization>
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::Connections.list_brokerage_authorizations: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;BrokerageAuthorization&gt;**](BrokerageAuthorization.md)
+
+## remove_brokerage_authorization
+
+Remove a brokerage authorization.
+
+### Example
+
+```ruby
+require 'snaptrade'
+
+SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
+
+authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
+user_id = "John.doe@snaptrade.com"
+user_secret = "USERSECRET123"
+
+begin
+  # Remove a brokerage authorization.
+  SnapTrade::Connections.remove_brokerage_authorization(
+    authorization_id: authorization_id,
+    user_id: user_id,
+    user_secret: user_secret,
+  )
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::Connections.remove_brokerage_authorization: #{e}"
+end
+```
+
+#### Using the remove_brokerage_authorization_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+```ruby
+authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
+user_id = "John.doe@snaptrade.com"
+user_secret = "USERSECRET123"
+
+begin
+  # Remove a brokerage authorization.
+  data, status_code, headers, response = SnapTrade::Connections.remove_brokerage_authorization_with_http_info(
+    authorization_id: authorization_id,
+    user_id: user_id,
+    user_secret: user_secret,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::Connections.remove_brokerage_authorization: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_id** | **String** | The ID of the Authorization to delete. |  |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+## session_events
+
+List all session events for the partner
+
+### Example
+
+```ruby
+require 'snaptrade'
+
+SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
+
+partner_client_id = "PASSIVTEST"
+user_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
+session_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
+
+begin
+  # List all session events for the partner
+  result = SnapTrade::Connections.session_events(
+    partner_client_id: partner_client_id,
+    user_id: user_id,
+    session_id: session_id,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::Connections.session_events: #{e}"
+end
+```
+
+#### Using the session_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+```ruby
+partner_client_id = "PASSIVTEST"
+user_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
+session_id = "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2"
+
+begin
+  # List all session events for the partner
+  data, status_code, headers, response = SnapTrade::Connections.session_events_with_http_info(
+    partner_client_id: partner_client_id,
+    user_id: user_id,
+    session_id: session_id,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array<ConnectionsSessionEvents200ResponseInner>
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::Connections.session_events: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **partner_client_id** | **String** |  |  |
+| **user_id** | **String** | Optional comma seperated list of user IDs used to filter the request on specific users | [optional] |
+| **session_id** | **String** | Optional comma seperated list of session IDs used to filter the request on specific users | [optional] |
+
+### Return type
+
+[**Array&lt;ConnectionsSessionEvents200ResponseInner&gt;**](ConnectionsSessionEvents200ResponseInner.md)
+

data/docs/ConnectionsSessionEvents200ResponseInner.md

@@ -0,0 +1,30 @@
+# SnapTrade::ConnectionsSessionEvents200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **session_event_type** | [**SessionEventType**](SessionEventType.md) |  | [optional] |
+| **session_id** | **String** |  | [optional] |
+| **user_id** | **String** | SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user | [optional] |
+| **created_date** | **String** | Time | [optional] |
+| **brokerage_status_code** | **Integer** |  | [optional] |
+| **brokerage_authorization_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::ConnectionsSessionEvents200ResponseInner.new(
+  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
+  session_event_type: null,
+  session_id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
+  user_id: snaptrade-user-123,
+  created_date: 2022-01-21T20:11:19.217Z,
+  brokerage_status_code: 400,
+  brokerage_authorization_id: 2bcd7cc3-e922-4976-bce1-9858296801c3
+)
+```
+

data/docs/Currency.md

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

data/docs/DeleteUserResponse.md

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

data/docs/DividendAtDate.md

@@ -0,0 +1,22 @@
+# SnapTrade::DividendAtDate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | The ticker of the symbol that the dividend came from | [optional] |
+| **amount** | **Float** | The amount received from the dividend | [optional] |
+| **currency** | **String** | The currency of the amount | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::DividendAtDate.new(
+  symbol: AAPL,
+  amount: 6.82,
+  currency: CAD
+)
+```
+

data/docs/EncryptedResponse.md

@@ -0,0 +1,20 @@
+# SnapTrade::EncryptedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **encrypted_shared_key** | **String** |  | [optional] |
+| **encrypted_message_data** | [**EncryptedResponseEncryptedMessageData**](EncryptedResponseEncryptedMessageData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::EncryptedResponse.new(
+  encrypted_shared_key: 5UEaY9QGzcNTr8y2jGDUI79jY1OdfK9x,
+  encrypted_message_data: null
+)
+```
+

data/docs/EncryptedResponseEncryptedMessageData.md

@@ -0,0 +1,22 @@
+# SnapTrade::EncryptedResponseEncryptedMessageData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **encrypted_message** | **String** |  | [optional] |
+| **tag** | **String** |  | [optional] |
+| **nonce** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::EncryptedResponseEncryptedMessageData.new(
+  encrypted_message: 9Xy05vqZOfp0OpW5fLAaDw==,
+  tag: mWZPkpQh5ktbcz6N7cTRmQ==,
+  nonce: None
+)
+```
+

data/docs/ErrorLogsApi.md

@@ -0,0 +1,68 @@
+# SnapTrade::ErrorLogsApi
+
+All URIs are relative to *https://api.snaptrade.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_user_errors**](ErrorLogsApi.md#list_user_errors) | **GET** /snapTrade/listUserErrors | Retrieve error logs on behalf of your SnapTrade users |
+
+## list_user_errors
+
+Retrieve error logs on behalf of your SnapTrade users
+
+### 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
+  # Retrieve error logs on behalf of your SnapTrade users
+  result = SnapTrade::ErrorLogs.list_user_errors(
+    user_id: user_id,
+    user_secret: user_secret,
+  )
+  p result
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::ErrorLogs.list_user_errors: #{e}"
+end
+```
+
+#### Using the list_user_errors_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
+  # Retrieve error logs on behalf of your SnapTrade users
+  data, status_code, headers, response = SnapTrade::ErrorLogs.list_user_errors_with_http_info(
+    user_id: user_id,
+    user_secret: user_secret,
+  )
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array<UserErrorLog>
+rescue SnapTrade::ApiError => e
+  puts "Exception when calling SnapTrade::ErrorLogs.list_user_errors: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  |  |
+| **user_secret** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;UserErrorLog&gt;**](UserErrorLog.md)
+

data/docs/Exchange.md

@@ -0,0 +1,32 @@
+# SnapTrade::Exchange
+
+## 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] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::Exchange.new(
+  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
+  code: TSX,
+  mic_code: XTSE,
+  name: Toronto Stock Exchange,
+  timezone: America/New_York,
+  start_time: 09:30:00,
+  close_time: 57600,
+  suffix: .TO
+)
+```
+

data/docs/ExchangeRatePairs.md

@@ -0,0 +1,22 @@
+# SnapTrade::ExchangeRatePairs
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **src** | [**Currency**](Currency.md) |  | [optional] |
+| **dst** | [**Currency**](Currency.md) |  | [optional] |
+| **exchange_rate** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::ExchangeRatePairs.new(
+  src: null,
+  dst: null,
+  exchange_rate: 1.32
+)
+```
+

data/docs/ExcludedAsset.md

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

data/docs/JWT.md

@@ -0,0 +1,18 @@
+# SnapTrade::JWT
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::JWT.new(
+  token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VybmFtZSI6ImZSbUdsbWFyU1dtZDY5RDkyeGZWbVdCWUxCS0x0QiIsImV4cCI6MTU0MDA1NTMxOSwiZW1haWwiOiJ3b29kQHN5bmNocm92ZXJnZS5jb20iLCJvcmlnX2lhdCI6MTUzNzM3NjkxOX0.ZSn85i3kSBvEP5wuhWOE8_w903N1G1AfiVlD3fmri78
+)
+```
+

data/docs/LoginRedirectURI.md

@@ -0,0 +1,20 @@
+# SnapTrade::LoginRedirectURI
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **redirect_uri** | **Object** |  | [optional] |
+| **session_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::LoginRedirectURI.new(
+  redirect_uri: https://app.passiv.com/snapTrade/redeemToken?token=this$token1does2ntactu4allyexist==&clientId=example,
+  session_id: null
+)
+```
+

data/docs/ManualTrade.md

@@ -0,0 +1,32 @@
+# SnapTrade::ManualTrade
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **account** | [**Account**](Account.md) |  | [optional] |
+| **order_type** | [**OrderType**](OrderType.md) |  | [optional] |
+| **time_in_force** | [**TimeInForce**](TimeInForce.md) |  | [optional] |
+| **symbol** | [**ManualTradeSymbol**](ManualTradeSymbol.md) |  | [optional] |
+| **action** | [**Action**](Action.md) |  | [optional] |
+| **units** | **Float** | Trade Units | [optional] |
+| **price** | **Float** | Trade Price if limit or stop limit order | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::ManualTrade.new(
+  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
+  account: null,
+  order_type: null,
+  time_in_force: null,
+  symbol: null,
+  action: null,
+  units: null,
+  price: 31.33
+)
+```
+

data/docs/ManualTradeAndImpact.md

@@ -0,0 +1,22 @@
+# SnapTrade::ManualTradeAndImpact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **trade** | [**ManualTrade**](ManualTrade.md) |  | [optional] |
+| **trade_impacts** | [**Array<ManualTrade>**](ManualTrade.md) |  | [optional] |
+| **combined_remaining_balance** | [**ManualTradeBalance**](ManualTradeBalance.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::ManualTradeAndImpact.new(
+  trade: null,
+  trade_impacts: null,
+  combined_remaining_balance: null
+)
+```
+

data/docs/ManualTradeBalance.md

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