snaptrade 2.0.32 → 2.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 887242914b86d8378fc839b462051ccc0489d1e2a1ba0b37bc6bff2ad458003a
-  data.tar.gz: bd3892448dcca278db8625b0df2f88bc81cd53011ee7b93db4823909f2d273c7
+  metadata.gz: 5850595b939dd6002902054531b756f0355f067082c8f22428ef8d2ed0fe8cca
+  data.tar.gz: 1558b337647677cc79abda65377e9bdca6a70caae86ec26742d37eb4d33d578f
 SHA512:
-  metadata.gz: 9f9941bbba13715288cfe8a284dd215fb0d43a89760285651ff7f7f114def7ab938cc79dbdbcd554134017fd448be5944236098aa0831c05304397509dc57cd1
-  data.tar.gz: a1f13e4ff3b7d3faf8702b6f4c8fda8f82ce5ca4bd78811b2180011f31f8f88d21362a19685c3e245acdfe2c8818a07e1d1ae31e414a1c03b6e38dd81edf98a9
+  metadata.gz: 7db59e62afd2e024cf15723d2385a7374ac2660561eea3e30fa46ca0acdabc7bc563060776e44e9291b6b5f0755f50764b44f24151e023c5f4f216b757a163de
+  data.tar.gz: 8d373f45a9e72438a8de270fa118c399b8e8dbce9d63e11136c22eccf0d0226f7c2b739325be1d3ed4c8803a3a0efaeb47d0e9af6b76c588f39cf9dfdfe62e08

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.32)
+    snaptrade (2.0.33)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

data/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/gem-v2.0.32-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.32)
+[![npm](https://img.shields.io/badge/gem-v2.0.33-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.33)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -70,7 +70,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.32'
+gem 'snaptrade', '~> 2.0.33'
 ```
 
 ## Getting Started<a id="getting-started"></a>

data/lib/snaptrade/models/account.rb

@@ -29,6 +29,7 @@ module SnapTrade
 
     attr_accessor :meta
 
+    # This field is deprecated.
     attr_accessor :cash_restrictions
 
     attr_accessor :sync_status
@@ -68,7 +69,7 @@ module SnapTrade
         :'institution_name' => :'String',
         :'created_date' => :'String',
         :'meta' => :'Hash<String, Object>',
-        :'cash_restrictions' => :'Array<CashRestriction>',
+        :'cash_restrictions' => :'Array<String>',
         :'sync_status' => :'AccountSyncStatus',
         :'balance' => :'AccountBalance'
       }

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

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/{cash_restriction.rb → account_order_record_option_symbol.rb}

@@ -11,26 +11,38 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Cash restriction rules that apply to this account when undergoing portfolio rebalance calculations.
-  class CashRestriction
+  # 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
 
-    attr_accessor :account
+    # The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
+    attr_accessor :ticker
 
-    attr_accessor :currency
+    # The type of option. Either \"CALL\" or \"PUT\".
+    attr_accessor :option_type
 
-    attr_accessor :type
+    # The option strike price.
+    attr_accessor :strike_price
 
-    attr_accessor :amount
+    # 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
       {
         :'id' => :'id',
-        :'account' => :'account',
-        :'currency' => :'currency',
-        :'type' => :'type',
-        :'amount' => :'amount'
+        :'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
 
@@ -43,10 +55,12 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
-        :'account' => :'String',
-        :'currency' => :'String',
-        :'type' => :'Type',
-        :'amount' => :'Float'
+        :'ticker' => :'String',
+        :'option_type' => :'OptionType',
+        :'strike_price' => :'Float',
+        :'expiration_date' => :'Date',
+        :'is_mini_option' => :'Boolean',
+        :'underlying_symbol' => :'UnderlyingSymbol'
       }
     end
 
@@ -56,17 +70,24 @@ module SnapTrade
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'OptionsSymbol'
+      ]
+    end
+
     # Initializes the object
     # @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::CashRestriction` 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::CashRestriction`. 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
       }
@@ -75,20 +96,28 @@ module SnapTrade
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'account')
-        self.account = attributes[:'account']
+      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?(:'currency')
-        self.currency = attributes[:'currency']
+      if attributes.key?(:'expiration_date')
+        self.expiration_date = attributes[:'expiration_date']
       end
 
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
+      if attributes.key?(:'is_mini_option')
+        self.is_mini_option = attributes[:'is_mini_option']
       end
 
-      if attributes.key?(:'amount')
-        self.amount = attributes[:'amount']
+      if attributes.key?(:'underlying_symbol')
+        self.underlying_symbol = attributes[:'underlying_symbol']
       end
     end
 
@@ -96,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
 
@@ -111,10 +170,12 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          account == o.account &&
-          currency == o.currency &&
-          type == o.type &&
-          amount == o.amount
+          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
@@ -126,7 +187,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, account, currency, type, amount].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_universal_symbol.rb

@@ -0,0 +1,346 @@
+=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 'date'
+require 'time'
+
+module SnapTrade
+  # 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
+
+    attr_accessor :exchange
+
+    attr_accessor :type
+
+    # 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
+
+    # 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
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'symbol' => :'symbol',
+        :'raw_symbol' => :'raw_symbol',
+        :'description' => :'description',
+        :'currency' => :'currency',
+        :'exchange' => :'exchange',
+        :'type' => :'type',
+        :'currencies' => :'currencies',
+        :'figi_code' => :'figi_code',
+        :'figi_instrument' => :'figi_instrument'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'symbol' => :'String',
+        :'raw_symbol' => :'String',
+        :'description' => :'String',
+        :'currency' => :'UniversalSymbolCurrency',
+        :'exchange' => :'UniversalSymbolExchange',
+        :'type' => :'SecurityType',
+        :'currencies' => :'Array<Currency>',
+        :'figi_code' => :'String',
+        :'figi_instrument' => :'SymbolFigiInstrument'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'description',
+        :'figi_code',
+        :'figi_instrument'
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'UniversalSymbol'
+      ]
+    end
+
+    # Initializes the object
+    # @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::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::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
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'symbol')
+        self.symbol = attributes[:'symbol']
+      end
+
+      if attributes.key?(:'raw_symbol')
+        self.raw_symbol = attributes[:'raw_symbol']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'exchange')
+        self.exchange = attributes[:'exchange']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'currencies')
+        if (value = attributes[:'currencies']).is_a?(Array)
+          self.currencies = value
+        end
+      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
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @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 @symbol.nil?
+        invalid_properties.push('invalid value for "symbol", symbol cannot be nil.')
+      end
+
+      if @raw_symbol.nil?
+        invalid_properties.push('invalid value for "raw_symbol", raw_symbol cannot be nil.')
+      end
+
+      if @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @currencies.nil?
+        invalid_properties.push('invalid value for "currencies", currencies 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 @symbol.nil?
+      return false if @raw_symbol.nil?
+      return false if @currency.nil?
+      return false if @type.nil?
+      return false if @currencies.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          symbol == o.symbol &&
+          raw_symbol == o.raw_symbol &&
+          description == o.description &&
+          currency == o.currency &&
+          exchange == o.exchange &&
+          type == o.type &&
+          currencies == o.currencies &&
+          figi_code == o.figi_code &&
+          figi_instrument == o.figi_instrument
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, symbol, raw_symbol, description, currency, exchange, type, currencies, figi_code, figi_instrument].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = SnapTrade.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb

@@ -39,7 +39,7 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
-        :'type' => :'BrokerageAuthorizationTypeReadOnlyType',
+        :'type' => :'Type',
         :'auth_type' => :'AuthType',
         :'brokerage' => :'BrokerageAuthorizationTypeReadOnlyBrokerage'
       }

data/lib/snaptrade/models/monthly_dividends.rb

@@ -12,7 +12,7 @@ require 'time'
 
 module SnapTrade
   class MonthlyDividends
-    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
     attr_accessor :date
 
     attr_accessor :dividends

data/lib/snaptrade/models/net_contributions.rb

@@ -12,7 +12,7 @@ require 'time'
 
 module SnapTrade
   class NetContributions
-    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
     attr_accessor :date
 
     attr_accessor :contributions

data/lib/snaptrade/models/order_type_strict.rb

@@ -15,10 +15,10 @@ module SnapTrade
     LIMIT = "Limit".freeze
     MARKET = "Market".freeze
     STOP_LIMIT = "StopLimit".freeze
-    STOP_LOSS = "StopLoss".freeze
+    STOP = "Stop".freeze
 
     def self.all_vars
-      @all_vars ||= [LIMIT, MARKET, STOP_LIMIT, STOP_LOSS].freeze
+      @all_vars ||= [LIMIT, MARKET, STOP_LIMIT, STOP].freeze
     end
 
     # Builds the enum from string

data/lib/snaptrade/models/past_value.rb

@@ -12,7 +12,7 @@ require 'time'
 
 module SnapTrade
   class PastValue
-    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
     attr_accessor :date
 
     attr_accessor :value

data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb

@@ -74,7 +74,7 @@ module SnapTrade
         :'institution_name' => :'String',
         :'balance' => :'SnapTradeHoldingsAccountAccountIdBalance',
         :'meta' => :'Hash<String, Object>',
-        :'cash_restrictions' => :'Array<CashRestriction>',
+        :'cash_restrictions' => :'Array<String>',
         :'created_date' => :'Time'
       }
     end

data/lib/snaptrade/models/strategy_order_record.rb

@@ -23,7 +23,7 @@ module SnapTrade
 
     attr_accessor :closed_quantity
 
-    # Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - StopLoss
+    # Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - Stop
     attr_accessor :order_type
 
     # Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled   * GTD - Good Til Date 

data/lib/snaptrade/models/sub_period_return_rate.rb

@@ -12,10 +12,10 @@ require 'time'
 
 module SnapTrade
   class SubPeriodReturnRate
-    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
     attr_accessor :period_start
 
-    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)
+    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
     attr_accessor :period_end
 
     # The return rate for the given period

data/lib/snaptrade/models/type.rb

@@ -12,11 +12,11 @@ require 'time'
 
 module SnapTrade
   class Type
-    ALLOCATE_MAX = "ALLOCATE_MAX".freeze
-    RETAIN_MIN = "RETAIN_MIN".freeze
+    READ = "read".freeze
+    TRADE = "trade".freeze
 
     def self.all_vars
-      @all_vars ||= [ALLOCATE_MAX, RETAIN_MIN].freeze
+      @all_vars ||= [READ, TRADE].freeze
     end
 
     # Builds the enum from string

data/lib/snaptrade/version.rb

@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '2.0.32'
+  VERSION = '2.0.33'
 end

data/lib/snaptrade.rb

@@ -22,7 +22,9 @@ require 'snaptrade/models/account_balance_total'
 require 'snaptrade/models/account_holdings'
 require 'snaptrade/models/account_holdings_account'
 require 'snaptrade/models/account_order_record'
+require 'snaptrade/models/account_order_record_option_symbol'
 require 'snaptrade/models/account_order_record_status'
+require 'snaptrade/models/account_order_record_universal_symbol'
 require 'snaptrade/models/account_simple'
 require 'snaptrade/models/account_sync_status'
 require 'snaptrade/models/action_strict'
@@ -36,9 +38,7 @@ require 'snaptrade/models/brokerage_authorization_disabled_confirmation'
 require 'snaptrade/models/brokerage_authorization_refresh_confirmation'
 require 'snaptrade/models/brokerage_authorization_type_read_only'
 require 'snaptrade/models/brokerage_authorization_type_read_only_brokerage'
-require 'snaptrade/models/brokerage_authorization_type_read_only_type'
 require 'snaptrade/models/brokerage_type'
-require 'snaptrade/models/cash_restriction'
 require 'snaptrade/models/connection_portal_version'
 require 'snaptrade/models/connection_type'
 require 'snaptrade/models/connections_session_events200_response_inner'

data/spec/models/{cash_restriction_spec.rb → account_order_record_option_symbol_spec.rb}

@@ -11,13 +11,13 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for SnapTrade::CashRestriction
-describe SnapTrade::CashRestriction do
-  let(:instance) { SnapTrade::CashRestriction.new }
+# Unit tests for SnapTrade::AccountOrderRecordOptionSymbol
+describe SnapTrade::AccountOrderRecordOptionSymbol do
+  let(:instance) { SnapTrade::AccountOrderRecordOptionSymbol.new }
 
-  describe 'test an instance of CashRestriction' do
-    it 'should create an instance of CashRestriction' do
-      expect(instance).to be_instance_of(SnapTrade::CashRestriction)
+  describe 'test an instance of AccountOrderRecordOptionSymbol' do
+    it 'should create an instance of AccountOrderRecordOptionSymbol' do
+      expect(instance).to be_instance_of(SnapTrade::AccountOrderRecordOptionSymbol)
     end
   end
   describe 'test attribute "id"' do
@@ -26,25 +26,37 @@ describe SnapTrade::CashRestriction do
     end
   end
 
-  describe 'test attribute "account"' do
+  describe 'test attribute "ticker"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "currency"' do
+  describe 'test attribute "option_type"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "type"' do
+  describe 'test attribute "strike_price"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "amount"' do
+  describe 'test attribute "expiration_date"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "is_mini_option"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "underlying_symbol"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/models/account_order_record_universal_symbol_spec.rb

@@ -0,0 +1,83 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SnapTrade::AccountOrderRecordUniversalSymbol
+describe SnapTrade::AccountOrderRecordUniversalSymbol do
+  let(:instance) { SnapTrade::AccountOrderRecordUniversalSymbol.new }
+
+  describe 'test an instance of AccountOrderRecordUniversalSymbol' do
+    it 'should create an instance of AccountOrderRecordUniversalSymbol' do
+      expect(instance).to be_instance_of(SnapTrade::AccountOrderRecordUniversalSymbol)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "symbol"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "raw_symbol"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "description"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "currency"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "exchange"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "currencies"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "figi_code"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "figi_instrument"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.32
+  version: 2.0.33
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-14 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -101,7 +101,9 @@ files:
 - lib/snaptrade/models/account_holdings.rb
 - lib/snaptrade/models/account_holdings_account.rb
 - lib/snaptrade/models/account_order_record.rb
+- lib/snaptrade/models/account_order_record_option_symbol.rb
 - lib/snaptrade/models/account_order_record_status.rb
+- lib/snaptrade/models/account_order_record_universal_symbol.rb
 - lib/snaptrade/models/account_simple.rb
 - lib/snaptrade/models/account_sync_status.rb
 - lib/snaptrade/models/action_strict.rb
@@ -115,9 +117,7 @@ files:
 - lib/snaptrade/models/brokerage_authorization_refresh_confirmation.rb
 - lib/snaptrade/models/brokerage_authorization_type_read_only.rb
 - lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb
-- lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb
 - lib/snaptrade/models/brokerage_type.rb
-- lib/snaptrade/models/cash_restriction.rb
 - lib/snaptrade/models/connection_portal_version.rb
 - lib/snaptrade/models/connection_type.rb
 - lib/snaptrade/models/connections_session_events200_response_inner.rb
@@ -220,8 +220,10 @@ files:
 - spec/models/account_balance_total_spec.rb
 - spec/models/account_holdings_account_spec.rb
 - spec/models/account_holdings_spec.rb
+- spec/models/account_order_record_option_symbol_spec.rb
 - spec/models/account_order_record_spec.rb
 - spec/models/account_order_record_status_spec.rb
+- spec/models/account_order_record_universal_symbol_spec.rb
 - spec/models/account_simple_spec.rb
 - spec/models/account_spec.rb
 - spec/models/account_sync_status_spec.rb
@@ -235,10 +237,8 @@ files:
 - spec/models/brokerage_authorization_spec.rb
 - spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
 - spec/models/brokerage_authorization_type_read_only_spec.rb
-- spec/models/brokerage_authorization_type_read_only_type_spec.rb
 - spec/models/brokerage_spec.rb
 - spec/models/brokerage_type_spec.rb
-- spec/models/cash_restriction_spec.rb
 - spec/models/connection_portal_version_spec.rb
 - spec/models/connection_type_spec.rb
 - spec/models/connections_session_events200_response_inner_spec.rb
@@ -377,7 +377,6 @@ test_files:
 - spec/models/snap_trade_login_user_request_body_spec.rb
 - spec/models/manual_trade_form_spec.rb
 - spec/models/option_strategy_legs_inner_spec.rb
-- spec/models/brokerage_authorization_type_read_only_type_spec.rb
 - spec/models/session_event_type_spec.rb
 - spec/models/account_holdings_spec.rb
 - spec/models/exchange_spec.rb
@@ -418,7 +417,7 @@ test_files:
 - spec/models/underlying_symbol_type_spec.rb
 - spec/models/security_type_spec.rb
 - spec/models/amount_spec.rb
-- spec/models/cash_restriction_spec.rb
+- spec/models/account_order_record_option_symbol_spec.rb
 - spec/models/account_simple_spec.rb
 - spec/models/symbols_quotes_inner_spec.rb
 - spec/models/account_balance_spec.rb
@@ -452,6 +451,7 @@ test_files:
 - spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
 - spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb
 - spec/models/option_chain_inner_spec.rb
+- spec/models/account_order_record_universal_symbol_spec.rb
 - spec/models/connections_session_events200_response_inner_spec.rb
 - spec/models/figi_instrument_spec.rb
 - spec/models/encrypted_response_encrypted_message_data_spec.rb

data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb

@@ -1,37 +0,0 @@
-=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 'date'
-require 'time'
-
-module SnapTrade
-  class BrokerageAuthorizationTypeReadOnlyType
-    READ = "read".freeze
-    TRADE = "trade".freeze
-
-    def self.all_vars
-      @all_vars ||= [READ, TRADE].freeze
-    end
-
-    # Builds the enum from string
-    # @param [String] The enum value in the form of the string
-    # @return [String] The enum value
-    def self.build_from_hash(value)
-      new.build_from_hash(value)
-    end
-
-    # Builds the enum from string
-    # @param [String] The enum value in the form of the string
-    # @return [String] The enum value
-    def build_from_hash(value)
-      return value if BrokerageAuthorizationTypeReadOnlyType.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #BrokerageAuthorizationTypeReadOnlyType"
-    end
-  end
-end

data/spec/models/brokerage_authorization_type_read_only_type_spec.rb

@@ -1,23 +0,0 @@
-=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 'spec_helper'
-require 'json'
-require 'date'
-
-# Unit tests for SnapTrade::BrokerageAuthorizationTypeReadOnlyType
-describe SnapTrade::BrokerageAuthorizationTypeReadOnlyType do
-  let(:instance) { SnapTrade::BrokerageAuthorizationTypeReadOnlyType.new }
-
-  describe 'test an instance of BrokerageAuthorizationTypeReadOnlyType' do
-    it 'should create an instance of BrokerageAuthorizationTypeReadOnlyType' do
-      expect(instance).to be_instance_of(SnapTrade::BrokerageAuthorizationTypeReadOnlyType)
-    end
-  end
-end