snaptrade 2.0.183 → 2.0.185

data/lib/snaptrade/models/manual_trade_form_complex.rb

@@ -0,0 +1,251 @@
+=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
+  # Request body for placing a complex conditional order (OCO, OTO, or OTOCO).
+  class ManualTradeFormComplex
+    # The complex order type. - `OCO`: One Cancels the Other — two peer orders. - `OTO`: One Triggers the Other — a trigger order and a conditional order. - `OTOCO`: One Triggers a One Cancels the Other — a trigger order and two peer orders. 
+    attr_accessor :type
+
+    # 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.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'orders' => :'orders',
+        :'client_order_id' => :'client_order_id'
+      }
+    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
+      {
+        :'type' => :'ManualTradeFormComplexType',
+        :'orders' => :'Array<ComplexOrderLeg>',
+        :'client_order_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'client_order_id'
+      ])
+    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::ManualTradeFormComplex` 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::ManualTradeFormComplex`. 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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'orders')
+        if (value = attributes[:'orders']).is_a?(Array)
+          self.orders = value
+        end
+      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?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @orders.nil?
+        invalid_properties.push('invalid value for "orders", orders 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 @type.nil?
+      return false if @orders.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 &&
+          type == o.type &&
+          orders == o.orders &&
+          client_order_id == o.client_order_id
+    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
+      [type, orders, client_order_id].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/manual_trade_form_complex_type.rb

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

data/lib/snaptrade/models/order_role.rb

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

data/lib/snaptrade/version.rb

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

data/lib/snaptrade.rb

@@ -19,6 +19,7 @@ require 'snaptrade/configuration'
 require 'snaptrade/models/account'
 require 'snaptrade/models/account_balance'
 require 'snaptrade/models/account_balance_total'
+require 'snaptrade/models/account_category'
 require 'snaptrade/models/account_holdings'
 require 'snaptrade/models/account_holdings_account'
 require 'snaptrade/models/account_information_get_user_account_order_detail_request'
@@ -64,6 +65,9 @@ require 'snaptrade/models/brokerage_type'
 require 'snaptrade/models/cancel_order_response'
 require 'snaptrade/models/cash_change_direction'
 require 'snaptrade/models/child_brokerage_order_ids'
+require 'snaptrade/models/complex_order_leg'
+require 'snaptrade/models/complex_order_response'
+require 'snaptrade/models/complex_order_response_type'
 require 'snaptrade/models/connection_portal_version'
 require 'snaptrade/models/connection_type'
 require 'snaptrade/models/connections_session_events200_response_inner'
@@ -92,6 +96,8 @@ require 'snaptrade/models/manual_trade_and_impact'
 require 'snaptrade/models/manual_trade_balance'
 require 'snaptrade/models/manual_trade_form'
 require 'snaptrade/models/manual_trade_form_bracket'
+require 'snaptrade/models/manual_trade_form_complex'
+require 'snaptrade/models/manual_trade_form_complex_type'
 require 'snaptrade/models/manual_trade_form_notional_value'
 require 'snaptrade/models/manual_trade_form_with_options'
 require 'snaptrade/models/manual_trade_impact'
@@ -133,6 +139,7 @@ require 'snaptrade/models/option_type'
 require 'snaptrade/models/options_position'
 require 'snaptrade/models/options_position_currency'
 require 'snaptrade/models/options_symbol'
+require 'snaptrade/models/order_role'
 require 'snaptrade/models/order_type_strict'
 require 'snaptrade/models/order_updated_response'
 require 'snaptrade/models/order_updated_response_order'

data/spec/api/trading_api_spec.rb

@@ -147,6 +147,21 @@ describe 'TradingApi' do
     end
   end
 
+  # unit tests for place_complex_order
+  # Place complex order
+  # Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages.  - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders. 
+  # @param account_id The ID of the account to execute the trade on.
+  # @param user_id 
+  # @param user_secret 
+  # @param manual_trade_form_complex 
+  # @param [Hash] opts the optional parameters
+  # @return [ComplexOrderResponse]
+  describe 'place_complex_order test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for place_crypto_order
   # Place crypto order
   # Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order. 

data/spec/models/account_category_spec.rb

@@ -0,0 +1,23 @@
+=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::AccountCategory
+describe SnapTrade::AccountCategory do
+  let(:instance) { SnapTrade::AccountCategory.new }
+
+  describe 'test an instance of AccountCategory' do
+    it 'should create an instance of AccountCategory' do
+      expect(instance).to be_instance_of(SnapTrade::AccountCategory)
+    end
+  end
+end

data/spec/models/account_spec.rb

@@ -98,6 +98,12 @@ describe SnapTrade::Account do
     end
   end
 
+  describe 'test attribute "account_category"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "meta"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/complex_order_leg_spec.rb

@@ -0,0 +1,71 @@
+=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::ComplexOrderLeg
+describe SnapTrade::ComplexOrderLeg do
+  let(:instance) { SnapTrade::ComplexOrderLeg.new }
+
+  describe 'test an instance of ComplexOrderLeg' do
+    it 'should create an instance of ComplexOrderLeg' do
+      expect(instance).to be_instance_of(SnapTrade::ComplexOrderLeg)
+    end
+  end
+  describe 'test attribute "order_role"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "action"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "instrument"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "order_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 "units"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "time_in_force"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "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 "stop"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/complex_order_response_spec.rb

@@ -0,0 +1,35 @@
+=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::ComplexOrderResponse
+describe SnapTrade::ComplexOrderResponse do
+  let(:instance) { SnapTrade::ComplexOrderResponse.new }
+
+  describe 'test an instance of ComplexOrderResponse' do
+    it 'should create an instance of ComplexOrderResponse' do
+      expect(instance).to be_instance_of(SnapTrade::ComplexOrderResponse)
+    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 "brokerage_group_order_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/complex_order_response_type_spec.rb

@@ -0,0 +1,23 @@
+=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::ComplexOrderResponseType
+describe SnapTrade::ComplexOrderResponseType do
+  let(:instance) { SnapTrade::ComplexOrderResponseType.new }
+
+  describe 'test an instance of ComplexOrderResponseType' do
+    it 'should create an instance of ComplexOrderResponseType' do
+      expect(instance).to be_instance_of(SnapTrade::ComplexOrderResponseType)
+    end
+  end
+end

data/spec/models/manual_trade_form_complex_spec.rb

@@ -0,0 +1,41 @@
+=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::ManualTradeFormComplex
+describe SnapTrade::ManualTradeFormComplex do
+  let(:instance) { SnapTrade::ManualTradeFormComplex.new }
+
+  describe 'test an instance of ManualTradeFormComplex' do
+    it 'should create an instance of ManualTradeFormComplex' do
+      expect(instance).to be_instance_of(SnapTrade::ManualTradeFormComplex)
+    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 "orders"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "client_order_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/manual_trade_form_complex_type_spec.rb

@@ -0,0 +1,23 @@
+=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::ManualTradeFormComplexType
+describe SnapTrade::ManualTradeFormComplexType do
+  let(:instance) { SnapTrade::ManualTradeFormComplexType.new }
+
+  describe 'test an instance of ManualTradeFormComplexType' do
+    it 'should create an instance of ManualTradeFormComplexType' do
+      expect(instance).to be_instance_of(SnapTrade::ManualTradeFormComplexType)
+    end
+  end
+end

data/spec/models/order_role_spec.rb

@@ -0,0 +1,23 @@
+=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::OrderRole
+describe SnapTrade::OrderRole do
+  let(:instance) { SnapTrade::OrderRole.new }
+
+  describe 'test an instance of OrderRole' do
+    it 'should create an instance of OrderRole' do
+      expect(instance).to be_instance_of(SnapTrade::OrderRole)
+    end
+  end
+end