snaptrade 1.16.0 → 1.16.1

data/docs/AuthenticationApi.md

@@ -19,7 +19,7 @@ Delete SnapTrade user
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -74,7 +74,7 @@ Generate encrypted JWT token
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -134,7 +134,7 @@ List SnapTrade users
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 
@@ -181,7 +181,7 @@ Login user & generate connection link
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -262,7 +262,7 @@ Create SnapTrade user
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "snaptrade-user-123"

data/docs/ConnectionsApi.md

@@ -18,7 +18,7 @@ Get brokerage authorization details
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
@@ -83,7 +83,7 @@ List all brokerage authorizations for the user
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -143,7 +143,7 @@ Delete brokerage authorization
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 authorization_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
@@ -207,7 +207,7 @@ List all session events for the partner
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 partner_client_id = "SNAPTRADETEST"

data/docs/ErrorLogsApi.md

@@ -15,7 +15,7 @@ Retrieve error logs on behalf of your SnapTrade users
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"

data/docs/MonthlyDividends.md

@@ -1,20 +1,20 @@
-# SnapTrade::MonthlyDividends
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **date** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
-| **dividends** | [**Array<DividendAtDate>**](DividendAtDate.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::MonthlyDividends.new(
-  date: Sun Jan 23 16:00:00 PST 2022,
-  dividends: null
-)
-```
-
+# SnapTrade::MonthlyDividends
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
+| **dividends** | [**Array<DividendAtDate>**](DividendAtDate.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::MonthlyDividends.new(
+  date: Mon Jan 24 00:00:00 UTC 2022,
+  dividends: null
+)
+```
+

data/docs/NetContributions.md

@@ -1,22 +1,22 @@
-# SnapTrade::NetContributions
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **date** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
-| **contributions** | **Float** |  | [optional] |
-| **currency** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::NetContributions.new(
-  date: Sun Jan 23 16:00:00 PST 2022,
-  contributions: 524.74,
-  currency: CAD
-)
-```
-
+# SnapTrade::NetContributions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
+| **contributions** | **Float** |  | [optional] |
+| **currency** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::NetContributions.new(
+  date: Mon Jan 24 00:00:00 UTC 2022,
+  contributions: 524.74,
+  currency: CAD
+)
+```
+

data/docs/OptionsApi.md

@@ -19,7 +19,7 @@ Creates an option strategy object that will be used to place an option strategy
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 underlying_symbol_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
@@ -109,7 +109,7 @@ Get the options chain
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -179,7 +179,7 @@ Get latest market data of option strategy
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -249,7 +249,7 @@ Get the options holdings in the account
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -314,7 +314,7 @@ Place an option strategy order on the brokerage
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 order_type = "Limit"

data/docs/PastValue.md

@@ -1,22 +1,22 @@
-# SnapTrade::PastValue
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **date** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
-| **value** | **Float** |  | [optional] |
-| **currency** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::PastValue.new(
-  date: Sun Jan 23 16:00:00 PST 2022,
-  value: 52.74,
-  currency: CAD
-)
-```
-
+# SnapTrade::PastValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
+| **value** | **Float** |  | [optional] |
+| **currency** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::PastValue.new(
+  date: Mon Jan 24 00:00:00 UTC 2022,
+  value: 52.74,
+  currency: CAD
+)
+```
+

data/docs/ReferenceDataApi.md

@@ -25,7 +25,7 @@ Return the exchange rate of a currency pair
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 currency_pair = "currencyPair_example"
@@ -80,7 +80,7 @@ Get metadata related to Snaptrade partner
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 
@@ -127,7 +127,7 @@ List of all security types.
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 
@@ -174,7 +174,7 @@ List exchanges
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 
@@ -221,7 +221,7 @@ Search for symbols
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 substring = "apple"
@@ -276,7 +276,7 @@ Get details of a symbol by the ticker
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 ticker = "ticker_example"
@@ -336,7 +336,7 @@ List of all brokerage authorization types
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 brokerage = "QUESTRADE,ALPACA"
@@ -391,7 +391,7 @@ List brokerages
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 
@@ -438,7 +438,7 @@ List currencies
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 
@@ -485,7 +485,7 @@ List currency exchange rates
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 
@@ -532,7 +532,7 @@ Search for symbols available in an account
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"

data/docs/SubPeriodReturnRate.md

@@ -1,22 +1,22 @@
-# SnapTrade::SubPeriodReturnRate
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **period_start** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
-| **period_end** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
-| **rate_of_return** | **Float** | The return rate for the given period | [optional] |
-
-## Example
-
-```ruby
-require 'snaptrade'
-
-instance = SnapTrade::SubPeriodReturnRate.new(
-  period_start: Sun Jan 23 16:00:00 PST 2022,
-  period_end: Sun Jan 23 16:00:00 PST 2022,
-  rate_of_return: 0.012312367452
-)
-```
-
+# SnapTrade::SubPeriodReturnRate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **period_start** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
+| **period_end** | **Date** | Date used to specify timeframe for a reporting call (in YYYY-MM-DD format) | [optional] |
+| **rate_of_return** | **Float** | The return rate for the given period | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::SubPeriodReturnRate.new(
+  period_start: Mon Jan 24 00:00:00 UTC 2022,
+  period_end: Mon Jan 24 00:00:00 UTC 2022,
+  rate_of_return: 0.012312367452
+)
+```
+

data/docs/TradingApi.md

@@ -20,7 +20,7 @@ Cancel open order in account
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -90,7 +90,7 @@ Check impact of trades on account.
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -183,7 +183,7 @@ Get symbol quotes
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -258,7 +258,7 @@ Place a trade with NO validation.
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -351,7 +351,7 @@ Place a OCO (One Cancels Other) order
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -420,7 +420,7 @@ Place order
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 trade_id = "tradeId_example"

data/docs/TransactionsAndReportingApi.md

@@ -18,7 +18,7 @@ Returns activities (transactions) for a user. Specifing start and end date is hi
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 user_id = "John.doe@snaptrade.com"
@@ -105,7 +105,7 @@ Returns performance information (contributions, dividends, rate of return, etc)
 ```ruby
 require 'snaptrade'
 
-SnapTrade.client_id = "YOUR_CLIENT_ID"
+SnapTrade.client_id = "YOUR_CLIENT_ID"
 SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 
 start_date = "2022-01-24"

data/docs/TransactionsStatus.md

@@ -1,20 +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
-)
-```
-
+# 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: Mon Jan 24 00:00:00 UTC 2022
+)
+```
+

data/lib/snaptrade/api_client_custom.rb

@@ -1,32 +1,32 @@
-
-=begin
-#SnapTrade
-
-#Connect brokerage accounts to your app for live positions and trading
-
-The version of the OpenAPI document: 1.0.0
-Contact: api@snaptrade.com
-
-=end
-
-require 'base64'
-require 'openssl'
-
-module SnapTrade
-  class ApiClientCustom
-    def self.request_hook(request, configuration)
-      request.params[:timestamp] = Time.now.to_i
-      path = request.path[request.path.index('/api/v1/')..-1]
-      query = Faraday::Utils.build_query(request.params)
-      sig_object = {
-        "content" => request.body.nil? || request.body.empty? ? nil : JSON.parse(request.body),
-        "path" => path,
-        "query" => query
-      }
-      sig_content = JSON.generate(sig_object, sort_by: :to_s)
-      sig_digest = OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, configuration.consumer_key, sig_content)
-      signature = Base64.encode64(sig_digest).strip()
-      request.headers[:Signature] = signature
-    end
-  end
-end
+
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+
+=end
+
+require 'base64'
+require 'openssl'
+
+module SnapTrade
+  class ApiClientCustom
+    def self.request_hook(request, configuration)
+      request.params[:timestamp] = Time.now.to_i
+      path = request.path[request.path.index('/api/v1/')..-1]
+      query = Faraday::Utils.build_query(request.params)
+      sig_object = {
+        "content" => request.body.nil? || request.body.empty? ? nil : JSON.parse(request.body),
+        "path" => path,
+        "query" => query
+      }
+      sig_content = JSON.generate(sig_object, sort_by: :to_s)
+      sig_digest = OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, configuration.consumer_key, sig_content)
+      signature = Base64.encode64(sig_digest).strip()
+      request.headers[:Signature] = signature
+    end
+  end
+end