snaptrade 2.0.32 → 2.0.34

data/lib/snaptrade/models/account.rb

@@ -11,24 +11,33 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # SnapTradeUser Investment Account
+  # A single brokerage account at a financial institution.
   class Account
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated. If you want a stable identifier for the account, use the `number` field.
     attr_accessor :id
 
+    # Unique identifier for the connection (brokerage authorization). This is the UUID used to reference the connection in SnapTrade.
     attr_accessor :brokerage_authorization
 
+    # Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it.
     attr_accessor :portfolio_group
 
+    # A display name for the account. Either assigned by the user or by the financial institution itself. For certain institutions, SnapTrade appends the institution name to the account name for clarity.
     attr_accessor :name
 
+    # The account number assigned by the financial institution.
     attr_accessor :number
 
+    # The name of the financial institution that holds the account.
     attr_accessor :institution_name
 
+    # Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the financial institution.
     attr_accessor :created_date
 
+    # Additional information about the account, such as account type, status, etc. This information is specific to the financial institution and there's no standard format for this data. Please use at your own risk.
     attr_accessor :meta
 
+    # This field is deprecated.
     attr_accessor :cash_restrictions
 
     attr_accessor :sync_status
@@ -66,9 +75,9 @@ module SnapTrade
         :'name' => :'String',
         :'number' => :'String',
         :'institution_name' => :'String',
-        :'created_date' => :'String',
+        :'created_date' => :'Time',
         :'meta' => :'Hash<String, Object>',
-        :'cash_restrictions' => :'Array<CashRestriction>',
+        :'cash_restrictions' => :'Array<String>',
         :'sync_status' => :'AccountSyncStatus',
         :'balance' => :'AccountBalance'
       }
@@ -77,6 +86,7 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'name',
       ])
     end
 

data/lib/snaptrade/models/account_balance_total.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Total value of this account (includes cash, equity, fixed income, etc)
+  # Total market value of this account (includes cash, equity, fixed income, etc). This value is directly obtained from the brokerage and should reflect the most accurate value of the account.
   class AccountBalanceTotal
     # Total value denominated in the currency of the `currency` field.
     attr_accessor :amount
@@ -46,13 +46,6 @@ module SnapTrade
       ])
     end
 
-    # List of class defined in allOf (OpenAPI v3)
-    def self.openapi_all_of
-      [
-      :'Amount'
-      ]
-    end
-
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})

data/lib/snaptrade/models/account_holdings_account.rb

@@ -24,7 +24,7 @@ module SnapTrade
     # List of option positions in the account.
     attr_accessor :option_positions
 
-    # List of recent orders in the account, including both pending and executed orders.
+    # 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
@@ -49,7 +49,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'account' => :'SnapTradeHoldingsAccountAccountId',
+        :'account' => :'Account',
         :'balances' => :'Array<Balance>',
         :'positions' => :'Array<Position>',
         :'option_positions' => :'Array<OptionsPosition>',

data/lib/snaptrade/models/account_order_record.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Describes a single recent order in an account.
+  # 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. This is the unique identifier for the order in the brokerage system.
     attr_accessor :brokerage_order_id
@@ -26,43 +26,46 @@ module SnapTrade
 
     attr_accessor :option_symbol
 
-    # Trade Action potential values include (but are not limited to) - BUY - SELL - BUY_COVER - SELL_SHORT - BUY_OPEN - BUY_CLOSE - SELL_OPEN - SELL_CLOSE
+    # 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
 
+    # 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
 
-    # Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - StopLoss
+    # 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
 
-    # Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled   * GTD - Good Til Date 
+    # 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. 
     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
 
+    # The time the order was last updated in the brokerage system. This value is not always available from the brokerage.
     attr_accessor :time_updated
 
+    # The time the order was executed in the brokerage system. This value is not always available from the brokerage.
     attr_accessor :time_executed
 
-    # Time
+    # The time the order expires. This value is not always available from the brokerage.
     attr_accessor :expiry_date
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -101,8 +104,8 @@ module SnapTrade
         :'brokerage_order_id' => :'String',
         :'status' => :'AccountOrderRecordStatus',
         :'symbol' => :'String',
-        :'universal_symbol' => :'UniversalSymbol',
-        :'option_symbol' => :'OptionsSymbol',
+        :'universal_symbol' => :'AccountOrderRecordUniversalSymbol',
+        :'option_symbol' => :'AccountOrderRecordOptionSymbol',
         :'action' => :'String',
         :'total_quantity' => :'Float',
         :'open_quantity' => :'Float',
@@ -113,10 +116,10 @@ module SnapTrade
         :'stop_price' => :'Float',
         :'order_type' => :'String',
         :'time_in_force' => :'String',
-        :'time_placed' => :'String',
-        :'time_updated' => :'String',
-        :'time_executed' => :'String',
-        :'expiry_date' => :'String'
+        :'time_placed' => :'Time',
+        :'time_updated' => :'Time',
+        :'time_executed' => :'Time',
+        :'expiry_date' => :'Time'
       }
     end
 
@@ -133,6 +136,7 @@ module SnapTrade
         :'order_type',
         :'time_updated',
         :'time_executed',
+        :'expiry_date'
       ])
     end
 

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

@@ -11,13 +11,38 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  class SnapTradeHoldingsAccountAccountIdBalance
-    attr_accessor :total
+  # 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
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'total' => :'total'
+        :'id' => :'id',
+        :'ticker' => :'ticker',
+        :'option_type' => :'option_type',
+        :'strike_price' => :'strike_price',
+        :'expiration_date' => :'expiration_date',
+        :'is_mini_option' => :'is_mini_option',
+        :'underlying_symbol' => :'underlying_symbol'
       }
     end
 
@@ -29,21 +54,26 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'total' => :'AccountBalanceTotal'
+        :'id' => :'String',
+        :'ticker' => :'String',
+        :'option_type' => :'OptionType',
+        :'strike_price' => :'Float',
+        :'expiration_date' => :'Date',
+        :'is_mini_option' => :'Boolean',
+        :'underlying_symbol' => :'UnderlyingSymbol'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'total'
       ])
     end
 
     # List of class defined in allOf (OpenAPI v3)
     def self.openapi_all_of
       [
-      :'AccountBalance'
+      :'OptionsSymbol'
       ]
     end
 
@@ -51,19 +81,43 @@ 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::SnapTradeHoldingsAccountAccountIdBalance` 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::SnapTradeHoldingsAccountAccountIdBalance`. 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
       }
 
-      if attributes.key?(:'total')
-        self.total = attributes[:'total']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'ticker')
+        self.ticker = attributes[:'ticker']
+      end
+
+      if attributes.key?(:'option_type')
+        self.option_type = attributes[:'option_type']
+      end
+
+      if attributes.key?(:'strike_price')
+        self.strike_price = attributes[:'strike_price']
+      end
+
+      if attributes.key?(:'expiration_date')
+        self.expiration_date = attributes[:'expiration_date']
+      end
+
+      if attributes.key?(:'is_mini_option')
+        self.is_mini_option = attributes[:'is_mini_option']
+      end
+
+      if attributes.key?(:'underlying_symbol')
+        self.underlying_symbol = attributes[:'underlying_symbol']
       end
     end
 
@@ -71,12 +125,42 @@ module SnapTrade
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @ticker.nil?
+        invalid_properties.push('invalid value for "ticker", ticker cannot be nil.')
+      end
+
+      if @option_type.nil?
+        invalid_properties.push('invalid value for "option_type", option_type cannot be nil.')
+      end
+
+      if @strike_price.nil?
+        invalid_properties.push('invalid value for "strike_price", strike_price cannot be nil.')
+      end
+
+      if @expiration_date.nil?
+        invalid_properties.push('invalid value for "expiration_date", expiration_date cannot be nil.')
+      end
+
+      if @underlying_symbol.nil?
+        invalid_properties.push('invalid value for "underlying_symbol", underlying_symbol cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @id.nil?
+      return false if @ticker.nil?
+      return false if @option_type.nil?
+      return false if @strike_price.nil?
+      return false if @expiration_date.nil?
+      return false if @underlying_symbol.nil?
       true
     end
 
@@ -85,7 +169,13 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          total == o.total
+          id == o.id &&
+          ticker == o.ticker &&
+          option_type == o.option_type &&
+          strike_price == o.strike_price &&
+          expiration_date == o.expiration_date &&
+          is_mini_option == o.is_mini_option &&
+          underlying_symbol == o.underlying_symbol
     end
 
     # @see the `==` method
@@ -97,7 +187,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [total].hash
+      [id, ticker, option_type, strike_price, expiration_date, is_mini_option, underlying_symbol].hash
     end
 
     # Builds the object from hash