snaptrade 2.0.203 → 2.0.205

data/lib/snaptrade/models/account_universal_activity_currency_universal_symbol.rb

@@ -0,0 +1,304 @@
+=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
+  # The quote security for the transaction when `price`, `amount`, and `fee` are denominated in a security instead of a fiat currency. This is most common for cryptocurrency trades. The field is `null` when the transaction is denominated in `currency`.
+  class AccountUniversalActivityCurrencyUniversalSymbol
+    # 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 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',
+        :'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' => :'SymbolCurrency',
+        :'exchange' => :'SymbolExchange',
+        :'type' => :'SecurityType',
+        :'figi_code' => :'String',
+        :'figi_instrument' => :'StockInstrumentFigiInstrument'
+      }
+    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
+      [
+      :'Symbol'
+      ]
+    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::AccountUniversalActivityCurrencyUniversalSymbol` 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::AccountUniversalActivityCurrencyUniversalSymbol`. 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?(:'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
+      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?
+      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 &&
+          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, 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.rb

@@ -42,6 +42,9 @@ module SnapTrade
     # Whether the connection is eligible for a payout. This is an experimental field that is NOT generally available for all partners. Do not use in production without speaking to the SnapTrade team.
     attr_accessor :is_eligible_for_payout
 
+    # Possible values include: - realtime - delayed Indicates whether SnapTrade will provide delayed or realtime data for this connection. `delayed` means SnapTrade uses cached data for the connection because of the customer's plan, or because of brokerage limitations. `realtime` means SnapTrade retrieves current data from the brokerage during API calls. 
+    attr_accessor :data_freshness_mode
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -54,7 +57,8 @@ module SnapTrade
         :'disabled_date' => :'disabled_date',
         :'meta' => :'meta',
         :'updated_date' => :'updated_date',
-        :'is_eligible_for_payout' => :'is_eligible_for_payout'
+        :'is_eligible_for_payout' => :'is_eligible_for_payout',
+        :'data_freshness_mode' => :'data_freshness_mode'
       }
     end
 
@@ -75,7 +79,8 @@ module SnapTrade
         :'disabled_date' => :'Time',
         :'meta' => :'Hash<String, Object>',
         :'updated_date' => :'Time',
-        :'is_eligible_for_payout' => :'Boolean'
+        :'is_eligible_for_payout' => :'Boolean',
+        :'data_freshness_mode' => :'String'
       }
     end
 
@@ -142,6 +147,10 @@ module SnapTrade
       if attributes.key?(:'is_eligible_for_payout')
         self.is_eligible_for_payout = attributes[:'is_eligible_for_payout']
       end
+
+      if attributes.key?(:'data_freshness_mode')
+        self.data_freshness_mode = attributes[:'data_freshness_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -171,7 +180,8 @@ module SnapTrade
           disabled_date == o.disabled_date &&
           meta == o.meta &&
           updated_date == o.updated_date &&
-          is_eligible_for_payout == o.is_eligible_for_payout
+          is_eligible_for_payout == o.is_eligible_for_payout &&
+          data_freshness_mode == o.data_freshness_mode
     end
 
     # @see the `==` method
@@ -183,7 +193,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created_date, brokerage, name, type, disabled, disabled_date, meta, updated_date, is_eligible_for_payout].hash
+      [id, created_date, brokerage, name, type, disabled, disabled_date, meta, updated_date, is_eligible_for_payout, data_freshness_mode].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/manual_trade_form_complex.rb

@@ -19,7 +19,6 @@ module SnapTrade
     # The orders that make up the complex order. Required counts and roles per type: - `OCO`: exactly 2 orders, both `PEER` - `OTO`: exactly 2 orders, one `TRIGGER` and one `CONDITIONAL` - `OTOCO`: exactly 3 orders, one `TRIGGER` and two `PEER` 
     attr_accessor :orders
 
-    # An optional client-provided identifier for this complex order. Passed through to the brokerage and returned in the response.
     attr_accessor :client_order_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/manual_trade_form_with_options.rb

@@ -28,12 +28,15 @@ module SnapTrade
     # The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required. 
     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. Here are the supported values:   - `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. 
+    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `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 `expiry_date`, which is required. Not available for market orders. GTD orders are only available on certain brokerages. Visit https://support.snaptrade.com/brokerages for brokerage support. 
     attr_accessor :time_in_force
 
     # The trading session for the order. This field indicates which market session the order will be placed in. This is only available for certain brokerages. Defaults to REGULAR. Here are the supported values:   - `REGULAR` - Regular trading hours.   - `EXTENDED` - Extended trading hours. 
     attr_accessor :trading_session
 
+    # Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the order expires. Required when `time_in_force` is `GTD`. Include a timezone offset or `Z` for UTC; if no timezone is provided, UTC is assumed. GTD orders are only available on certain brokerages. Visit https://support.snaptrade.com/brokerages for brokerage support.
+    attr_accessor :expiry_date
+
     # The limit price for `Limit` and `StopLimit` orders.
     attr_accessor :price
 
@@ -45,6 +48,8 @@ module SnapTrade
 
     attr_accessor :notional_value
 
+    attr_accessor :client_order_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -55,10 +60,12 @@ module SnapTrade
         :'order_type' => :'order_type',
         :'time_in_force' => :'time_in_force',
         :'trading_session' => :'trading_session',
+        :'expiry_date' => :'expiry_date',
         :'price' => :'price',
         :'stop' => :'stop',
         :'units' => :'units',
-        :'notional_value' => :'notional_value'
+        :'notional_value' => :'notional_value',
+        :'client_order_id' => :'client_order_id'
       }
     end
 
@@ -75,12 +82,14 @@ module SnapTrade
         :'universal_symbol_id' => :'String',
         :'symbol' => :'String',
         :'order_type' => :'OrderTypeStrict',
-        :'time_in_force' => :'TimeInForceStrict',
+        :'time_in_force' => :'ManualTradePlaceTimeInForceStrict',
         :'trading_session' => :'TradingSession',
+        :'expiry_date' => :'Time',
         :'price' => :'Float',
         :'stop' => :'Float',
         :'units' => :'Float',
-        :'notional_value' => :'ManualTradeFormNotionalValue'
+        :'notional_value' => :'ManualTradeFormNotionalValue',
+        :'client_order_id' => :'String'
       }
     end
 
@@ -89,10 +98,12 @@ module SnapTrade
       Set.new([
         :'universal_symbol_id',
         :'symbol',
+        :'expiry_date',
         :'price',
         :'stop',
         :'units',
-        :'notional_value'
+        :'notional_value',
+        :'client_order_id'
       ])
     end
 
@@ -141,6 +152,10 @@ module SnapTrade
         self.trading_session = 'REGULAR'
       end
 
+      if attributes.key?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
+      end
+
       if attributes.key?(:'price')
         self.price = attributes[:'price']
       end
@@ -156,6 +171,10 @@ module SnapTrade
       if attributes.key?(:'notional_value')
         self.notional_value = attributes[:'notional_value']
       end
+
+      if attributes.key?(:'client_order_id')
+        self.client_order_id = attributes[:'client_order_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -203,10 +222,12 @@ module SnapTrade
           order_type == o.order_type &&
           time_in_force == o.time_in_force &&
           trading_session == o.trading_session &&
+          expiry_date == o.expiry_date &&
           price == o.price &&
           stop == o.stop &&
           units == o.units &&
-          notional_value == o.notional_value
+          notional_value == o.notional_value &&
+          client_order_id == o.client_order_id
     end
 
     # @see the `==` method
@@ -218,7 +239,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, action, universal_symbol_id, symbol, order_type, time_in_force, trading_session, price, stop, units, notional_value].hash
+      [account_id, action, universal_symbol_id, symbol, order_type, time_in_force, trading_session, expiry_date, price, stop, units, notional_value, client_order_id].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/manual_trade_place_time_in_force_strict.rb

@@ -0,0 +1,40 @@
+=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 ManualTradePlaceTimeInForceStrict
+    FOK = "FOK".freeze
+    DAY = "Day".freeze
+    GTC = "GTC".freeze
+    IOC = "IOC".freeze
+    GTD = "GTD".freeze
+
+    def self.all_vars
+      @all_vars ||= [FOK, DAY, GTC, IOC, GTD].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 ManualTradePlaceTimeInForceStrict.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ManualTradePlaceTimeInForceStrict"
+    end
+  end
+end