snaptrade 2.0.186 → 2.0.188

data/lib/snaptrade/models/account_order_record_v2.rb

@@ -16,6 +16,12 @@ module SnapTrade
     # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
     attr_accessor :brokerage_order_id
 
+    # The brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier. 
+    attr_accessor :brokerage_group_order_id
+
+    # The role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders. 
+    attr_accessor :order_role
+
     # Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include:   - NONE   - PENDING   - ACCEPTED   - FAILED   - REJECTED   - CANCELED   - PARTIAL_CANCELED   - CANCEL_PENDING   - EXECUTED   - PARTIAL   - REPLACE_PENDING   - REPLACED   - EXPIRED   - QUEUED   - TRIGGERED   - ACTIVATED 
     attr_accessor :status
 
@@ -48,10 +54,34 @@ module SnapTrade
     # List of legs that make up the order.
     attr_accessor :legs
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'brokerage_order_id' => :'brokerage_order_id',
+        :'brokerage_group_order_id' => :'brokerage_group_order_id',
+        :'order_role' => :'order_role',
         :'status' => :'status',
         :'order_type' => :'order_type',
         :'time_in_force' => :'time_in_force',
@@ -75,6 +105,8 @@ module SnapTrade
     def self.openapi_types
       {
         :'brokerage_order_id' => :'String',
+        :'brokerage_group_order_id' => :'String',
+        :'order_role' => :'String',
         :'status' => :'AccountOrderRecordStatus',
         :'order_type' => :'String',
         :'time_in_force' => :'String',
@@ -92,6 +124,8 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'brokerage_group_order_id',
+        :'order_role',
         :'order_type',
         :'time_executed',
         :'execution_price',
@@ -120,6 +154,14 @@ module SnapTrade
         self.brokerage_order_id = attributes[:'brokerage_order_id']
       end
 
+      if attributes.key?(:'brokerage_group_order_id')
+        self.brokerage_group_order_id = attributes[:'brokerage_group_order_id']
+      end
+
+      if attributes.key?(:'order_role')
+        self.order_role = attributes[:'order_role']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -177,15 +219,29 @@ module SnapTrade
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      order_role_validator = EnumAttributeValidator.new('String', ["TRIGGER", "CONDITIONAL", "PEER"])
+      return false unless order_role_validator.valid?(@order_role)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] order_role Object to be assigned
+    def order_role=(order_role)
+      validator = EnumAttributeValidator.new('String', ["TRIGGER", "CONDITIONAL", "PEER"])
+      unless validator.valid?(order_role)
+        fail ArgumentError, "invalid value for \"order_role\", must be one of #{validator.allowable_values}."
+      end
+      @order_role = order_role
+    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 &&
           brokerage_order_id == o.brokerage_order_id &&
+          brokerage_group_order_id == o.brokerage_group_order_id &&
+          order_role == o.order_role &&
           status == o.status &&
           order_type == o.order_type &&
           time_in_force == o.time_in_force &&
@@ -208,7 +264,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [brokerage_order_id, status, order_type, time_in_force, time_placed, time_executed, quote_currency, execution_price, limit_price, stop_price, trailing_stop, legs].hash
+      [brokerage_order_id, brokerage_group_order_id, order_role, status, order_type, time_in_force, time_placed, time_executed, quote_currency, execution_price, limit_price, stop_price, trailing_stop, legs].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/adr_instrument.rb

@@ -0,0 +1,311 @@
+=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
+  # Security instrument metadata for ADR positions.
+  class AdrInstrument
+    # Type of security instrument.
+    attr_accessor :kind
+
+    # Unique identifier for the instrument.
+    attr_accessor :id
+
+    # The formatted trading symbol for the security.
+    attr_accessor :symbol
+
+    # The raw symbol without any exchange suffix.
+    attr_accessor :raw_symbol
+
+    # Human-readable description of the security.
+    attr_accessor :description
+
+    # ISO-4217 currency code for the security listing.
+    attr_accessor :currency
+
+    # Exchange MIC code or exchange code for the security.
+    attr_accessor :exchange
+
+    attr_accessor :figi_instrument
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'kind' => :'kind',
+        :'id' => :'id',
+        :'symbol' => :'symbol',
+        :'raw_symbol' => :'raw_symbol',
+        :'description' => :'description',
+        :'currency' => :'currency',
+        :'exchange' => :'exchange',
+        :'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
+      {
+        :'kind' => :'AdrInstrumentKind',
+        :'id' => :'String',
+        :'symbol' => :'String',
+        :'raw_symbol' => :'String',
+        :'description' => :'String',
+        :'currency' => :'String',
+        :'exchange' => :'String',
+        :'figi_instrument' => :'StockInstrumentFigiInstrument'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'description',
+        :'currency',
+        :'exchange',
+        :'figi_instrument'
+      ])
+    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::AdrInstrument` 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::AdrInstrument`. 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?(:'kind')
+        self.kind = attributes[:'kind']
+      end
+
+      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?(:'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 @kind.nil?
+        invalid_properties.push('invalid value for "kind", kind cannot be nil.')
+      end
+
+      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
+
+      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 @kind.nil?
+      return false if @id.nil?
+      return false if @symbol.nil?
+      return false if @raw_symbol.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 &&
+          kind == o.kind &&
+          id == o.id &&
+          symbol == o.symbol &&
+          raw_symbol == o.raw_symbol &&
+          description == o.description &&
+          currency == o.currency &&
+          exchange == o.exchange &&
+          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
+      [kind, id, symbol, raw_symbol, description, currency, exchange, 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/adr_instrument_kind.rb

@@ -0,0 +1,36 @@
+=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 AdrInstrumentKind
+    ADR = "adr".freeze
+
+    def self.all_vars
+      @all_vars ||= [ADR].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 AdrInstrumentKind.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #AdrInstrumentKind"
+    end
+  end
+end

data/lib/snaptrade/models/all_account_positions_response.rb

@@ -11,26 +11,14 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # A paginated list of all account positions.
+  # Information about all account positions.
   class AllAccountPositionsResponse
-    # The total number of positions available across all pages.
-    attr_accessor :count
-
-    # The URL for the next page of results, or `null` if there is no next page.
-    attr_accessor :_next
-
-    # The URL for the previous page of results, or `null` if there is no previous page.
-    attr_accessor :previous
-
-    # Positions returned for the current page.
+    # Positions returned for the request.
     attr_accessor :results
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'count' => :'count',
-        :'_next' => :'next',
-        :'previous' => :'previous',
         :'results' => :'results'
       }
     end
@@ -43,9 +31,6 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'count' => :'Integer',
-        :'_next' => :'String',
-        :'previous' => :'String',
         :'results' => :'Array<AccountPosition>'
       }
     end
@@ -53,8 +38,6 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'_next',
-        :'previous',
       ])
     end
 
@@ -73,18 +56,6 @@ module SnapTrade
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'count')
-        self.count = attributes[:'count']
-      end
-
-      if attributes.key?(:'_next')
-        self._next = attributes[:'_next']
-      end
-
-      if attributes.key?(:'previous')
-        self.previous = attributes[:'previous']
-      end
-
       if attributes.key?(:'results')
         if (value = attributes[:'results']).is_a?(Array)
           self.results = value
@@ -96,10 +67,6 @@ module SnapTrade
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @count.nil?
-        invalid_properties.push('invalid value for "count", count cannot be nil.')
-      end
-
       if @results.nil?
         invalid_properties.push('invalid value for "results", results cannot be nil.')
       end
@@ -110,7 +77,6 @@ module SnapTrade
     # 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 @count.nil?
       return false if @results.nil?
       true
     end
@@ -120,9 +86,6 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          count == o.count &&
-          _next == o._next &&
-          previous == o.previous &&
           results == o.results
     end
 
@@ -135,7 +98,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [count, _next, previous, results].hash
+      [results].hash
     end
 
     # Builds the object from hash