snaptrade 1.13.0 → 1.14.0

data/docs/BrokerageSymbolOptionSymbol.md

@@ -1,38 +1,32 @@
-# SnapTrade::BrokerageSymbolOptionSymbol
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **ticker** | **String** |  | [optional] |
-| **strike_price** | **Float** |  | [optional] |
-| **expiration_date** | **String** |  | [optional] |
-| **is_mini_option** | **Boolean** |  | [optional] |
-| **underlying_symbol** | [**UnderlyingSymbol**](UnderlyingSymbol.md) |  | [optional] |
-| **local_id** | **String** |  | [optional] |
-| **security_type** | **Object** |  | [optional] |
-| **listing_exchange** | **Object** |  | [optional] |
-| **is_quotable** | **Boolean** |  | [optional] |
-| **is_tradable** | **Boolean** |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::BrokerageSymbolOptionSymbol.new(
-  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
-  ticker: SPY 220819P00200000,
-  strike_price: 200,
-  expiration_date: 2022-08-19T00:00:00.000Z,
-  is_mini_option: false,
-  underlying_symbol: null,
-  local_id: 40817960,
-  security_type: {},
-  listing_exchange: {},
-  is_quotable: true,
-  is_tradable: true
-)
-```
-
+# SnapTrade::BrokerageSymbolOptionSymbol
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **ticker** | **String** |  | [optional] |
+| **strike_price** | **Float** |  | [optional] |
+| **expiration_date** | **String** |  | [optional] |
+| **is_mini_option** | **Boolean** |  | [optional] |
+| **underlying_symbol** | [**UnderlyingSymbol**](UnderlyingSymbol.md) |  | [optional] |
+| **local_id** | **String** |  | [optional] |
+| **exchange_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::BrokerageSymbolOptionSymbol.new(
+  id: 2bcd7cc3-e922-4976-bce1-9858296801c3,
+  ticker: SPY 220819P00200000,
+  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/BrokerageSymbolSymbol.md

@@ -1,32 +1,32 @@
-# SnapTrade::BrokerageSymbolSymbol
-
-## 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::BrokerageSymbolSymbol.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
-)
-```
-
+# SnapTrade::BrokerageSymbolSymbol
+
+## 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::BrokerageSymbolSymbol.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/ConnectionsApi.md

@@ -1,265 +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)
-
+# 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)
+