snaptrade 2.0.209 → 2.0.211

data/lib/snaptrade/models/model503_brokerage_request_response.rb

@@ -0,0 +1,238 @@
+=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
+  # Example for a response that failed because of an upstream brokerage API failure
+  class Model503BrokerageRequestResponse
+    attr_accessor :detail
+
+    attr_accessor :status_code
+
+    attr_accessor :code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'detail' => :'detail',
+        :'status_code' => :'status_code',
+        :'code' => :'code'
+      }
+    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
+      {
+        :'detail' => :'Object',
+        :'status_code' => :'Object',
+        :'code' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'detail',
+        :'status_code',
+        :'code'
+      ])
+    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::Model503BrokerageRequestResponse` 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::Model503BrokerageRequestResponse`. 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?(:'detail')
+        self.detail = attributes[:'detail']
+      end
+
+      if attributes.key?(:'status_code')
+        self.status_code = attributes[:'status_code']
+      end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      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 &&
+          detail == o.detail &&
+          status_code == o.status_code &&
+          code == o.code
+    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
+      [detail, status_code, code].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/option_instrument.rb

@@ -31,6 +31,9 @@ module SnapTrade
     # Expiration date of the option contract.
     attr_accessor :expiration_date
 
+    # Number of underlying shares per contract. Standard options are 100, mini options are 10.
+    attr_accessor :multiplier
+
     # Human-readable description of the option contract.
     attr_accessor :description
 
@@ -45,6 +48,7 @@ module SnapTrade
         :'option_type' => :'option_type',
         :'strike_price' => :'strike_price',
         :'expiration_date' => :'expiration_date',
+        :'multiplier' => :'multiplier',
         :'description' => :'description',
         :'underlying' => :'underlying'
       }
@@ -64,6 +68,7 @@ module SnapTrade
         :'option_type' => :'OptionType',
         :'strike_price' => :'Float',
         :'expiration_date' => :'Date',
+        :'multiplier' => :'Float',
         :'description' => :'String',
         :'underlying' => :'UnderlyingOptionInstrument'
       }
@@ -115,6 +120,10 @@ module SnapTrade
         self.expiration_date = attributes[:'expiration_date']
       end
 
+      if attributes.key?(:'multiplier')
+        self.multiplier = attributes[:'multiplier']
+      end
+
       if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
@@ -152,6 +161,10 @@ module SnapTrade
         invalid_properties.push('invalid value for "expiration_date", expiration_date cannot be nil.')
       end
 
+      if @multiplier.nil?
+        invalid_properties.push('invalid value for "multiplier", multiplier cannot be nil.')
+      end
+
       if @underlying.nil?
         invalid_properties.push('invalid value for "underlying", underlying cannot be nil.')
       end
@@ -168,6 +181,7 @@ module SnapTrade
       return false if @option_type.nil?
       return false if @strike_price.nil?
       return false if @expiration_date.nil?
+      return false if @multiplier.nil?
       return false if @underlying.nil?
       true
     end
@@ -183,6 +197,7 @@ module SnapTrade
           option_type == o.option_type &&
           strike_price == o.strike_price &&
           expiration_date == o.expiration_date &&
+          multiplier == o.multiplier &&
           description == o.description &&
           underlying == o.underlying
     end
@@ -196,7 +211,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [kind, id, symbol, option_type, strike_price, expiration_date, description, underlying].hash
+      [kind, id, symbol, option_type, strike_price, expiration_date, multiplier, description, underlying].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/underlying_cfd_instrument.rb

@@ -0,0 +1,63 @@
+=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 underlying instrument referenced by a CFD contract.
+  module UnderlyingCfdInstrument
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'AdrInstrument',
+          :'CefInstrument',
+          :'CryptoInstrument',
+          :'EtfInstrument',
+          :'MutualFundInstrument',
+          :'OtherInstrument',
+          :'StockInstrument'
+        ]
+      end
+
+      # Discriminator's property name (OpenAPI v3)
+      def openapi_discriminator_name
+        :'kind'
+      end
+
+      # Discriminator's mapping (OpenAPI v3)
+      def openapi_discriminator_mapping
+        {
+          :'adr' => :'AdrInstrument',
+          :'cef' => :'CefInstrument',
+          :'crypto' => :'CryptoInstrument',
+          :'etf' => :'EtfInstrument',
+          :'mutualfund' => :'MutualFundInstrument',
+          :'other' => :'OtherInstrument',
+          :'stock' => :'StockInstrument'
+        }
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        discriminator_value = data[openapi_discriminator_name]
+        return nil if discriminator_value.nil?
+
+        klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym]
+        return nil unless klass
+
+        SnapTrade.const_get(klass).build_from_hash(data)
+      end
+    end
+  end
+
+end

data/lib/snaptrade/version.rb

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

data/lib/snaptrade.rb

@@ -72,6 +72,8 @@ require 'snaptrade/models/cancel_order_response'
 require 'snaptrade/models/cash_change_direction'
 require 'snaptrade/models/cef_instrument'
 require 'snaptrade/models/cef_instrument_kind'
+require 'snaptrade/models/cfd_instrument'
+require 'snaptrade/models/cfd_instrument_kind'
 require 'snaptrade/models/child_brokerage_order_ids'
 require 'snaptrade/models/complex_order_leg'
 require 'snaptrade/models/complex_order_leg_order_role'
@@ -139,6 +141,8 @@ require 'snaptrade/models/model404_failed_request_response'
 require 'snaptrade/models/model425_failed_request_response'
 require 'snaptrade/models/model429_too_many_requests_response'
 require 'snaptrade/models/model500_unexpected_exception_response'
+require 'snaptrade/models/model501_not_implemented_response'
+require 'snaptrade/models/model503_brokerage_request_response'
 require 'snaptrade/models/monthly_dividends'
 require 'snaptrade/models/mutual_fund_instrument'
 require 'snaptrade/models/mutual_fund_instrument_kind'
@@ -221,6 +225,7 @@ require 'snaptrade/models/trailing_stop'
 require 'snaptrade/models/transactions_status'
 require 'snaptrade/models/type'
 require 'snaptrade/models/us_exchange'
+require 'snaptrade/models/underlying_cfd_instrument'
 require 'snaptrade/models/underlying_option_instrument'
 require 'snaptrade/models/underlying_symbol'
 require 'snaptrade/models/underlying_symbol_exchange'

data/spec/api/account_information_api_spec.rb

@@ -62,7 +62,7 @@ describe 'AccountInformationApi' do
 
   # unit tests for get_all_account_positions
   # List all account positions
-  # Returns a list of all positions in the specified account.  The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 
+  # Returns a list of all positions in the specified account.  The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 
   # @param user_id 
   # @param user_secret 
   # @param account_id 

data/spec/models/cfd_instrument_kind_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::CfdInstrumentKind
+describe SnapTrade::CfdInstrumentKind do
+  let(:instance) { SnapTrade::CfdInstrumentKind.new }
+
+  describe 'test an instance of CfdInstrumentKind' do
+    it 'should create an instance of CfdInstrumentKind' do
+      expect(instance).to be_instance_of(SnapTrade::CfdInstrumentKind)
+    end
+  end
+end

data/spec/models/cfd_instrument_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::CfdInstrument
+describe SnapTrade::CfdInstrument do
+  let(:instance) { SnapTrade::CfdInstrument.new }
+
+  describe 'test an instance of CfdInstrument' do
+    it 'should create an instance of CfdInstrument' do
+      expect(instance).to be_instance_of(SnapTrade::CfdInstrument)
+    end
+  end
+  describe 'test attribute "kind"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    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 "underlying_instrument"' 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/model501_not_implemented_response_spec.rb

@@ -0,0 +1,29 @@
+=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::Model501NotImplementedResponse
+describe SnapTrade::Model501NotImplementedResponse do
+  let(:instance) { SnapTrade::Model501NotImplementedResponse.new }
+
+  describe 'test an instance of Model501NotImplementedResponse' do
+    it 'should create an instance of Model501NotImplementedResponse' do
+      expect(instance).to be_instance_of(SnapTrade::Model501NotImplementedResponse)
+    end
+  end
+  describe 'test attribute "error"' 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/model503_brokerage_request_response_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::Model503BrokerageRequestResponse
+describe SnapTrade::Model503BrokerageRequestResponse do
+  let(:instance) { SnapTrade::Model503BrokerageRequestResponse.new }
+
+  describe 'test an instance of Model503BrokerageRequestResponse' do
+    it 'should create an instance of Model503BrokerageRequestResponse' do
+      expect(instance).to be_instance_of(SnapTrade::Model503BrokerageRequestResponse)
+    end
+  end
+  describe 'test attribute "detail"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "status_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 "code"' 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/option_instrument_spec.rb

@@ -56,6 +56,12 @@ describe SnapTrade::OptionInstrument do
     end
   end
 
+  describe 'test attribute "multiplier"' 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

data/spec/models/underlying_cfd_instrument_spec.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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SnapTrade::UnderlyingCfdInstrument
+describe SnapTrade::UnderlyingCfdInstrument do
+  describe '.openapi_one_of' do
+    it 'lists the items referenced in the oneOf array' do
+      expect(described_class.openapi_one_of).to_not be_empty
+    end
+  end
+
+  describe '.openapi_discriminator_name' do
+    it 'returns the value of the "discriminator" property' do
+      expect(described_class.openapi_discriminator_name).to_not be_empty
+    end
+  end
+
+  describe '.openapi_discriminator_mapping' do
+    it 'returns the key/values of the "mapping" property' do
+      expect(described_class.openapi_discriminator_mapping.values.sort).to eq(described_class.openapi_one_of.sort)
+    end
+  end
+
+  describe '.build' do
+    it 'returns the correct model' do
+    end
+  end
+end