snaptrade 1.17.10 → 2.0.77

data/lib/snaptrade/models/account_holdings_account.rb

@@ -5,21 +5,26 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Account Holdings with Account ID
+  # A wrapper object containing holdings information for a single account.
   class AccountHoldingsAccount
     attr_accessor :account
 
+    # List of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).
     attr_accessor :balances
 
+    # List of stock/ETF/crypto/mutual fund positions in the account.
     attr_accessor :positions
 
+    # List of option positions in the account.
+    attr_accessor :option_positions
+
+    # List of recent orders in the account, including both pending and executed orders. Note that option orders are included in this list. Option orders will have a null `universal_symbol` field and a non-null `option_symbol` field.
     attr_accessor :orders
 
     attr_accessor :total_value
@@ -30,6 +35,7 @@ module SnapTrade
         :'account' => :'account',
         :'balances' => :'balances',
         :'positions' => :'positions',
+        :'option_positions' => :'option_positions',
         :'orders' => :'orders',
         :'total_value' => :'total_value'
       }
@@ -43,9 +49,10 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'account' => :'SnapTradeHoldingsAccountAccountId',
+        :'account' => :'Account',
         :'balances' => :'Array<Balance>',
         :'positions' => :'Array<Position>',
+        :'option_positions' => :'Array<OptionsPosition>',
         :'orders' => :'Array<AccountOrderRecord>',
         :'total_value' => :'SnapTradeHoldingsTotalValue'
       }
@@ -56,6 +63,7 @@ module SnapTrade
       Set.new([
         :'balances',
         :'positions',
+        :'option_positions',
         :'orders',
       ])
     end
@@ -91,6 +99,12 @@ module SnapTrade
         end
       end
 
+      if attributes.key?(:'option_positions')
+        if (value = attributes[:'option_positions']).is_a?(Array)
+          self.option_positions = value
+        end
+      end
+
       if attributes.key?(:'orders')
         if (value = attributes[:'orders']).is_a?(Array)
           self.orders = value
@@ -123,6 +137,7 @@ module SnapTrade
           account == o.account &&
           balances == o.balances &&
           positions == o.positions &&
+          option_positions == o.option_positions &&
           orders == o.orders &&
           total_value == o.total_value
     end
@@ -136,7 +151,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account, balances, positions, orders, total_value].hash
+      [account, balances, positions, option_positions, orders, total_value].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/account_order_record.rb

@@ -5,68 +5,74 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Record of order in brokerageaccount
+  # Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records.
   class AccountOrderRecord
-    # Order id returned by brokerage
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
     attr_accessor :brokerage_order_id
 
+    # Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
     attr_accessor :status
 
-    attr_accessor :symbol
-
     attr_accessor :universal_symbol
 
     attr_accessor :option_symbol
 
+    # The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage.   - BUY   - SELL   - BUY_COVER   - SELL_SHORT   - BUY_OPEN   - BUY_CLOSE   - SELL_OPEN   - SELL_CLOSE 
     attr_accessor :action
 
-    # Trade Units. Cannot work with notional value.
+    # The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares.
     attr_accessor :total_quantity
 
-    # Trade Units
+    # The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
     attr_accessor :open_quantity
 
-    # Trade Units
+    # The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
     attr_accessor :canceled_quantity
 
-    # Trade Units
+    # The number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
     attr_accessor :filled_quantity
 
-    # Trade Price if limit or stop limit order
+    # The price at which the order was executed.
     attr_accessor :execution_price
 
-    # Trade Price if limit or stop limit order
+    # The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders.
     attr_accessor :limit_price
 
-    # Stop Price. If stop loss or stop limit order, the price to trigger the stop
+    # The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders.
     attr_accessor :stop_price
 
+    # The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value.
     attr_accessor :order_type
 
+    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value.   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date.   - `MOO` - Market On Open. The order is to be executed at the day's opening price.   - `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. 
     attr_accessor :time_in_force
 
-    # Time
+    # The time the order was placed. This is the time the order was submitted to the brokerage.
     attr_accessor :time_placed
 
-    # Time
+    # The time the order was last updated in the brokerage system. This value is not always available from the brokerage.
     attr_accessor :time_updated
 
-    # Time
+    # The time the order was executed in the brokerage system. This value is not always available from the brokerage.
+    attr_accessor :time_executed
+
+    # The time the order expires. This value is not always available from the brokerage.
     attr_accessor :expiry_date
 
+    # A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
+    attr_accessor :symbol
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'brokerage_order_id' => :'brokerage_order_id',
         :'status' => :'status',
-        :'symbol' => :'symbol',
         :'universal_symbol' => :'universal_symbol',
         :'option_symbol' => :'option_symbol',
         :'action' => :'action',
@@ -81,7 +87,9 @@ module SnapTrade
         :'time_in_force' => :'time_in_force',
         :'time_placed' => :'time_placed',
         :'time_updated' => :'time_updated',
-        :'expiry_date' => :'expiry_date'
+        :'time_executed' => :'time_executed',
+        :'expiry_date' => :'expiry_date',
+        :'symbol' => :'symbol'
       }
     end
 
@@ -95,10 +103,9 @@ module SnapTrade
       {
         :'brokerage_order_id' => :'String',
         :'status' => :'AccountOrderRecordStatus',
-        :'symbol' => :'String',
-        :'universal_symbol' => :'UniversalSymbol',
-        :'option_symbol' => :'OptionsSymbol',
-        :'action' => :'Action',
+        :'universal_symbol' => :'AccountOrderRecordUniversalSymbol',
+        :'option_symbol' => :'AccountOrderRecordOptionSymbol',
+        :'action' => :'String',
         :'total_quantity' => :'Float',
         :'open_quantity' => :'Float',
         :'canceled_quantity' => :'Float',
@@ -106,23 +113,30 @@ module SnapTrade
         :'execution_price' => :'Float',
         :'limit_price' => :'Float',
         :'stop_price' => :'Float',
-        :'order_type' => :'OrderType',
-        :'time_in_force' => :'TimeInForce',
-        :'time_placed' => :'String',
-        :'time_updated' => :'String',
-        :'expiry_date' => :'String'
+        :'order_type' => :'String',
+        :'time_in_force' => :'String',
+        :'time_placed' => :'Time',
+        :'time_updated' => :'Time',
+        :'time_executed' => :'Time',
+        :'expiry_date' => :'Time',
+        :'symbol' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'total_quantity',
         :'open_quantity',
         :'canceled_quantity',
         :'filled_quantity',
         :'execution_price',
         :'limit_price',
         :'stop_price',
+        :'order_type',
+        :'time_updated',
+        :'time_executed',
+        :'expiry_date',
       ])
     end
 
@@ -149,10 +163,6 @@ module SnapTrade
         self.status = attributes[:'status']
       end
 
-      if attributes.key?(:'symbol')
-        self.symbol = attributes[:'symbol']
-      end
-
       if attributes.key?(:'universal_symbol')
         self.universal_symbol = attributes[:'universal_symbol']
       end
@@ -209,9 +219,17 @@ module SnapTrade
         self.time_updated = attributes[:'time_updated']
       end
 
+      if attributes.key?(:'time_executed')
+        self.time_executed = attributes[:'time_executed']
+      end
+
       if attributes.key?(:'expiry_date')
         self.expiry_date = attributes[:'expiry_date']
       end
+
+      if attributes.key?(:'symbol')
+        self.symbol = attributes[:'symbol']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -234,7 +252,6 @@ module SnapTrade
       self.class == o.class &&
           brokerage_order_id == o.brokerage_order_id &&
           status == o.status &&
-          symbol == o.symbol &&
           universal_symbol == o.universal_symbol &&
           option_symbol == o.option_symbol &&
           action == o.action &&
@@ -249,7 +266,9 @@ module SnapTrade
           time_in_force == o.time_in_force &&
           time_placed == o.time_placed &&
           time_updated == o.time_updated &&
-          expiry_date == o.expiry_date
+          time_executed == o.time_executed &&
+          expiry_date == o.expiry_date &&
+          symbol == o.symbol
     end
 
     # @see the `==` method
@@ -261,7 +280,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [brokerage_order_id, status, symbol, universal_symbol, option_symbol, action, total_quantity, open_quantity, canceled_quantity, filled_quantity, execution_price, limit_price, stop_price, order_type, time_in_force, time_placed, time_updated, expiry_date].hash
+      [brokerage_order_id, status, universal_symbol, option_symbol, action, total_quantity, open_quantity, canceled_quantity, filled_quantity, execution_price, limit_price, stop_price, order_type, time_in_force, time_placed, time_updated, time_executed, expiry_date, symbol].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/{brokerage_symbol_option_symbol.rb → account_order_record_option_symbol.rb}

@@ -5,32 +5,34 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class BrokerageSymbolOptionSymbol
+  # Contains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the `universal_symbol` field will be populated.
+  class AccountOrderRecordOptionSymbol
+    # Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
     attr_accessor :id
 
+    # The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
     attr_accessor :ticker
 
+    # The type of option. Either \"CALL\" or \"PUT\".
     attr_accessor :option_type
 
+    # The option strike price.
     attr_accessor :strike_price
 
+    # The option expiration date.
     attr_accessor :expiration_date
 
+    # Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
     attr_accessor :is_mini_option
 
     attr_accessor :underlying_symbol
 
-    attr_accessor :local_id
-
-    attr_accessor :exchange_id
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,9 +42,7 @@ module SnapTrade
         :'strike_price' => :'strike_price',
         :'expiration_date' => :'expiration_date',
         :'is_mini_option' => :'is_mini_option',
-        :'underlying_symbol' => :'underlying_symbol',
-        :'local_id' => :'local_id',
-        :'exchange_id' => :'exchange_id'
+        :'underlying_symbol' => :'underlying_symbol'
       }
     end
 
@@ -58,11 +58,9 @@ module SnapTrade
         :'ticker' => :'String',
         :'option_type' => :'OptionType',
         :'strike_price' => :'Float',
-        :'expiration_date' => :'String',
+        :'expiration_date' => :'Date',
         :'is_mini_option' => :'Boolean',
-        :'underlying_symbol' => :'UnderlyingSymbol',
-        :'local_id' => :'String',
-        :'exchange_id' => :'String'
+        :'underlying_symbol' => :'UnderlyingSymbol'
       }
     end
 
@@ -83,13 +81,13 @@ module SnapTrade
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::BrokerageSymbolOptionSymbol` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::AccountOrderRecordOptionSymbol` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::BrokerageSymbolOptionSymbol`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::AccountOrderRecordOptionSymbol`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -121,14 +119,6 @@ module SnapTrade
       if attributes.key?(:'underlying_symbol')
         self.underlying_symbol = attributes[:'underlying_symbol']
       end
-
-      if attributes.key?(:'local_id')
-        self.local_id = attributes[:'local_id']
-      end
-
-      if attributes.key?(:'exchange_id')
-        self.exchange_id = attributes[:'exchange_id']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -185,9 +175,7 @@ module SnapTrade
           strike_price == o.strike_price &&
           expiration_date == o.expiration_date &&
           is_mini_option == o.is_mini_option &&
-          underlying_symbol == o.underlying_symbol &&
-          local_id == o.local_id &&
-          exchange_id == o.exchange_id
+          underlying_symbol == o.underlying_symbol
     end
 
     # @see the `==` method
@@ -199,7 +187,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, ticker, option_type, strike_price, expiration_date, is_mini_option, underlying_symbol, local_id, exchange_id].hash
+      [id, ticker, option_type, strike_price, expiration_date, is_mini_option, underlying_symbol].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/account_order_record_status.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/{brokerage_symbol_symbol.rb → account_order_record_universal_symbol.rb}

@@ -5,20 +5,24 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  class BrokerageSymbolSymbol
+  # Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated.
+  class AccountOrderRecordUniversalSymbol
+    # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
     attr_accessor :id
 
+    # The security's trading ticker symbol. For example \"AAPL\" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
     attr_accessor :symbol
 
+    # The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
     attr_accessor :raw_symbol
 
+    # A human-readable description of the security. This is usually the company name or ETF name.
     attr_accessor :description
 
     attr_accessor :currency
@@ -27,6 +31,12 @@ module SnapTrade
 
     attr_accessor :type
 
+    # This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. This value should be the same as the `figi_code` in the `figi_instrument` child property.
+    attr_accessor :figi_code
+
+    attr_accessor :figi_instrument
+
+    # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
     attr_accessor :currencies
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -39,6 +49,8 @@ module SnapTrade
         :'currency' => :'currency',
         :'exchange' => :'exchange',
         :'type' => :'type',
+        :'figi_code' => :'figi_code',
+        :'figi_instrument' => :'figi_instrument',
         :'currencies' => :'currencies'
       }
     end
@@ -55,9 +67,11 @@ module SnapTrade
         :'symbol' => :'String',
         :'raw_symbol' => :'String',
         :'description' => :'String',
-        :'currency' => :'Currency',
-        :'exchange' => :'Exchange',
+        :'currency' => :'SymbolCurrency',
+        :'exchange' => :'SymbolExchange',
         :'type' => :'SecurityType',
+        :'figi_code' => :'String',
+        :'figi_instrument' => :'SymbolFigiInstrument',
         :'currencies' => :'Array<Currency>'
       }
     end
@@ -66,6 +80,8 @@ module SnapTrade
     def self.openapi_nullable
       Set.new([
         :'description',
+        :'figi_code',
+        :'figi_instrument',
       ])
     end
 
@@ -80,13 +96,13 @@ module SnapTrade
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::BrokerageSymbolSymbol` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::AccountOrderRecordUniversalSymbol` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::BrokerageSymbolSymbol`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::AccountOrderRecordUniversalSymbol`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -119,6 +135,14 @@ module SnapTrade
         self.type = attributes[:'type']
       end
 
+      if attributes.key?(:'figi_code')
+        self.figi_code = attributes[:'figi_code']
+      end
+
+      if attributes.key?(:'figi_instrument')
+        self.figi_instrument = attributes[:'figi_instrument']
+      end
+
       if attributes.key?(:'currencies')
         if (value = attributes[:'currencies']).is_a?(Array)
           self.currencies = value
@@ -181,6 +205,8 @@ module SnapTrade
           currency == o.currency &&
           exchange == o.exchange &&
           type == o.type &&
+          figi_code == o.figi_code &&
+          figi_instrument == o.figi_instrument &&
           currencies == o.currencies
     end
 
@@ -193,7 +219,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, symbol, raw_symbol, description, currency, exchange, type, currencies].hash
+      [id, symbol, raw_symbol, description, currency, exchange, type, figi_code, figi_instrument, currencies].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/account_simple.rb

@@ -5,19 +5,21 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # SnapTradeUser Investment Account
+  # A single account at a brokerage.
   class AccountSimple
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
     attr_accessor :id
 
+    # A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.
     attr_accessor :name
 
+    # The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
     attr_accessor :number
 
     attr_accessor :sync_status

data/lib/snaptrade/models/account_sync_status.rb

@@ -5,21 +5,23 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # Status of account
+  # Contains status update for the account sync process between SnapTrade and the brokerage.
   class AccountSyncStatus
     attr_accessor :transactions
 
+    attr_accessor :holdings
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'transactions' => :'transactions'
+        :'transactions' => :'transactions',
+        :'holdings' => :'holdings'
       }
     end
 
@@ -31,7 +33,8 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'transactions' => :'TransactionsStatus'
+        :'transactions' => :'TransactionsStatus',
+        :'holdings' => :'HoldingsStatus'
       }
     end
 
@@ -59,6 +62,10 @@ module SnapTrade
       if attributes.key?(:'transactions')
         self.transactions = attributes[:'transactions']
       end
+
+      if attributes.key?(:'holdings')
+        self.holdings = attributes[:'holdings']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -79,7 +86,8 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          transactions == o.transactions
+          transactions == o.transactions &&
+          holdings == o.holdings
     end
 
     # @see the `==` method
@@ -91,7 +99,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [transactions].hash
+      [transactions, holdings].hash
     end
 
     # Builds the object from hash