snaptrade 1.17.1 → 1.17.3

data/lib/snaptrade/models/model500_unexpected_exception_response.rb

@@ -0,0 +1,239 @@
+=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 for unexpected reasons
+  class Model500UnexpectedExceptionResponse
+    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::Model500UnexpectedExceptionResponse` 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::Model500UnexpectedExceptionResponse`. 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/options_position.rb

@@ -26,11 +26,6 @@ module SnapTrade
     # Average purchase price for this position
     attr_accessor :average_purchase_price
 
-    attr_accessor :open_pnl
-
-    # Deprecated, use the units field for both fractional and integer units going forward
-    attr_accessor :fractional_units
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -38,9 +33,7 @@ module SnapTrade
         :'price' => :'price',
         :'units' => :'units',
         :'currency' => :'currency',
-        :'average_purchase_price' => :'average_purchase_price',
-        :'open_pnl' => :'open_pnl',
-        :'fractional_units' => :'fractional_units'
+        :'average_purchase_price' => :'average_purchase_price'
       }
     end
 
@@ -56,9 +49,7 @@ module SnapTrade
         :'price' => :'Float',
         :'units' => :'Float',
         :'currency' => :'OptionsPositionCurrency',
-        :'average_purchase_price' => :'Float',
-        :'open_pnl' => :'Float',
-        :'fractional_units' => :'Float'
+        :'average_purchase_price' => :'Float'
       }
     end
 
@@ -67,9 +58,7 @@ module SnapTrade
       Set.new([
         :'price',
         :'currency',
-        :'average_purchase_price',
-        :'open_pnl',
-        :'fractional_units'
+        :'average_purchase_price'
       ])
     end
 
@@ -107,14 +96,6 @@ module SnapTrade
       if attributes.key?(:'average_purchase_price')
         self.average_purchase_price = attributes[:'average_purchase_price']
       end
-
-      if attributes.key?(:'open_pnl')
-        self.open_pnl = attributes[:'open_pnl']
-      end
-
-      if attributes.key?(:'fractional_units')
-        self.fractional_units = attributes[:'fractional_units']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -139,9 +120,7 @@ module SnapTrade
           price == o.price &&
           units == o.units &&
           currency == o.currency &&
-          average_purchase_price == o.average_purchase_price &&
-          open_pnl == o.open_pnl &&
-          fractional_units == o.fractional_units
+          average_purchase_price == o.average_purchase_price
     end
 
     # @see the `==` method
@@ -153,7 +132,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, price, units, currency, average_purchase_price, open_pnl, fractional_units].hash
+      [symbol, price, units, currency, average_purchase_price].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/snap_trade_login_user_request_body.rb

@@ -14,12 +14,16 @@ require 'time'
 module SnapTrade
   # Data to login a user via SnapTrade Partner
   class SnapTradeLoginUserRequestBody
+    # Slug of the brokerage to connect the user to
     attr_accessor :broker
 
+    # When set to True, user will be redirected back to the partner's site instead of the connection portal
     attr_accessor :immediate_redirect
 
+    # URL to redirect the user to after the user connects their brokerage account
     attr_accessor :custom_redirect
 
+    # The UUID of the brokerage connection to be reconnected
     attr_accessor :reconnect
 
     attr_accessor :connection_type

data/lib/snaptrade/models/snap_trade_register_user_request_body.rb

@@ -17,14 +17,10 @@ module SnapTrade
     # SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
     attr_accessor :user_id
 
-    # Open SSH RSA public key
-    attr_accessor :rsa_public_key
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'user_id' => :'userId',
-        :'rsa_public_key' => :'rsaPublicKey'
+        :'user_id' => :'userId'
       }
     end
 
@@ -36,8 +32,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'user_id' => :'String',
-        :'rsa_public_key' => :'String'
+        :'user_id' => :'String'
       }
     end
 
@@ -65,10 +60,6 @@ module SnapTrade
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
-
-      if attributes.key?(:'rsa_public_key')
-        self.rsa_public_key = attributes[:'rsa_public_key']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -89,8 +80,7 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          user_id == o.user_id &&
-          rsa_public_key == o.rsa_public_key
+          user_id == o.user_id
     end
 
     # @see the `==` method
@@ -102,7 +92,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [user_id, rsa_public_key].hash
+      [user_id].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/version.rb

@@ -9,5 +9,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '1.17.1'
+  VERSION = '1.17.3'
 end

data/lib/snaptrade.rb

@@ -62,6 +62,7 @@ require 'snaptrade/models/model400_failed_request_response'
 require 'snaptrade/models/model401_failed_request_response'
 require 'snaptrade/models/model403_failed_request_response'
 require 'snaptrade/models/model404_failed_request_response'
+require 'snaptrade/models/model500_unexpected_exception_response'
 require 'snaptrade/models/model_asset_class'
 require 'snaptrade/models/model_asset_class_details'
 require 'snaptrade/models/model_asset_class_target'

data/spec/api/account_information_api_spec.rb

@@ -43,9 +43,10 @@ describe 'AccountInformationApi' do
 
   # unit tests for get_user_account_balance
   # List account balances
+  # A list of account balances for the specified account (one per currency that the account holds).
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to get balances.
   # @param [Hash] opts the optional parameters
   # @return [Array<Balance>]
   describe 'get_user_account_balance test' do
@@ -69,9 +70,10 @@ describe 'AccountInformationApi' do
 
   # unit tests for get_user_account_orders
   # Get history of orders placed in account
+  # Fetch all recent orders from a user&#39;s account.
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to get orders.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :state defaults value is set to \&quot;all\&quot;
   # @return [Array<AccountOrderRecord>]
@@ -85,7 +87,7 @@ describe 'AccountInformationApi' do
   # List account positions
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to get positions.
   # @param [Hash] opts the optional parameters
   # @return [Array<Position>]
   describe 'get_user_account_positions test' do
@@ -95,7 +97,7 @@ describe 'AccountInformationApi' do
   end
 
   # unit tests for get_user_holdings
-  # List balances, positions and orders for the specified account.
+  # List balances, positions and orders for the specified account
   # @param account_id The ID of the account to fetch holdings for.
   # @param user_id 
   # @param user_secret 

data/spec/api/authentication_api_spec.rb

@@ -30,6 +30,7 @@ describe 'AuthenticationApi' do
 
   # unit tests for delete_snap_trade_user
   # Delete SnapTrade user
+  # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
   # @param user_id 
   # @param [Hash] opts the optional parameters
   # @return [DeleteUserResponse]
@@ -53,6 +54,7 @@ describe 'AuthenticationApi' do
 
   # unit tests for list_snap_trade_users
   # List SnapTrade users
+  # Returns a list of users you've registered over the SnapTrade API.
   # @param [Hash] opts the optional parameters
   # @return [Array<String>]
   describe 'list_snap_trade_users test' do
@@ -63,6 +65,7 @@ describe 'AuthenticationApi' do
 
   # unit tests for login_snap_trade_user
   # Login user &amp; generate connection link
+  # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

data/spec/api/options_api_spec.rb

@@ -32,7 +32,7 @@ describe 'OptionsApi' do
   # Creates an option strategy object that will be used to place an option strategy order
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to create the option strategy object in.
   # @param options_get_option_strategy_request 
   # @param [Hash] opts the optional parameters
   # @return [StrategyQuotes]
@@ -46,7 +46,7 @@ describe 'OptionsApi' do
   # Get the options chain
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to get the options chain from.
   # @param symbol Universal symbol ID if symbol
   # @param [Hash] opts the optional parameters
   # @return [Array<OptionChainInner>]
@@ -60,7 +60,7 @@ describe 'OptionsApi' do
   # Get latest market data of option strategy
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account the strategy will be placed in.
   # @param option_strategy_id Option strategy id obtained from response when creating option strategy object
   # @param [Hash] opts the optional parameters
   # @return [StrategyQuotes]
@@ -74,7 +74,7 @@ describe 'OptionsApi' do
   # Get the options holdings in the account
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to fetch options holdings for.
   # @param [Hash] opts the optional parameters
   # @return [Array<OptionsPosition>]
   describe 'list_option_holdings test' do
@@ -87,7 +87,7 @@ describe 'OptionsApi' do
   # Place an option strategy order on the brokerage
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to execute the strategy in.
   # @param option_strategy_id Option strategy id obtained from response when creating option strategy object
   # @param options_place_option_strategy_request 
   # @param [Hash] opts the optional parameters

data/spec/api/reference_data_api_spec.rb

@@ -50,7 +50,8 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for get_security_types
-  # List of all security types.
+  # List of all security types
+  # List security types available on SnapTrade.
   # @param [Hash] opts the optional parameters
   # @return [Array<SecurityType>]
   describe 'get_security_types test' do
@@ -137,7 +138,7 @@ describe 'ReferenceDataApi' do
   # Search for symbols available in an account
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to search for symbols within.
   # @param [Hash] opts the optional parameters
   # @option opts [SymbolQuery] :symbol_query 
   # @return [Array<UniversalSymbol>]

data/spec/api/trading_api_spec.rb

@@ -32,7 +32,7 @@ describe 'TradingApi' do
   # Cancel open order in account
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to cancel the order in.
   # @param trading_cancel_user_account_order_request The Order ID to be canceled
   # @param [Hash] opts the optional parameters
   # @return [AccountOrderRecord]

data/spec/api/transactions_and_reporting_api_spec.rb

@@ -30,7 +30,7 @@ describe 'TransactionsAndReportingApi' do
 
   # unit tests for get_activities
   # Get transaction history for a user
-  # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+  # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

data/spec/models/model500_unexpected_exception_response_spec.rb

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

@@ -51,16 +51,4 @@ describe SnapTrade::OptionsPosition do
     end
   end
 
-  describe 'test attribute "open_pnl"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "fractional_units"' 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/snap_trade_register_user_request_body_spec.rb

@@ -27,10 +27,4 @@ describe SnapTrade::SnapTradeRegisterUserRequestBody do
     end
   end
 
-  describe 'test attribute "rsa_public_key"' 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: 1.17.1
+  version: 1.17.3
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2023-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -131,6 +131,7 @@ files:
 - docs/Model401FailedRequestResponse.md
 - docs/Model403FailedRequestResponse.md
 - docs/Model404FailedRequestResponse.md
+- docs/Model500UnexpectedExceptionResponse.md
 - docs/ModelAssetClass.md
 - docs/ModelAssetClassDetails.md
 - docs/ModelAssetClassTarget.md
@@ -279,6 +280,7 @@ files:
 - lib/snaptrade/models/model401_failed_request_response.rb
 - lib/snaptrade/models/model403_failed_request_response.rb
 - lib/snaptrade/models/model404_failed_request_response.rb
+- lib/snaptrade/models/model500_unexpected_exception_response.rb
 - lib/snaptrade/models/model_asset_class.rb
 - lib/snaptrade/models/model_asset_class_details.rb
 - lib/snaptrade/models/model_asset_class_target.rb
@@ -422,6 +424,7 @@ files:
 - spec/models/model401_failed_request_response_spec.rb
 - spec/models/model403_failed_request_response_spec.rb
 - spec/models/model404_failed_request_response_spec.rb
+- spec/models/model500_unexpected_exception_response_spec.rb
 - spec/models/model_asset_class_details_spec.rb
 - spec/models/model_asset_class_spec.rb
 - spec/models/model_asset_class_target_spec.rb
@@ -576,6 +579,7 @@ test_files:
 - spec/models/strategy_quotes_spec.rb
 - spec/models/model_asset_class_details_spec.rb
 - spec/models/manual_trade_and_impact_spec.rb
+- spec/models/model500_unexpected_exception_response_spec.rb
 - spec/models/brokerage_authorization_type_read_only_type_spec.rb
 - spec/models/manual_trade_symbol_spec.rb
 - spec/models/position_spec.rb