snaptrade 2.0.18 → 2.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a363cc77c3f0d1064c2e6f173c15b0526b4a9e5a68bea6e38ef869c6377fd9ad
-  data.tar.gz: d2f7de1e5805be1d96d2f47d0263889abb5165576a0230d06704e9e223053afd
+  metadata.gz: 3c958613ed72d29c4acd1238bbf384d1c91a08577f00fa97f89f8644d272a0d2
+  data.tar.gz: 3ff004f0161f765c4b6016780f48dd0523fb64f1ff70295e85962fdbdb7136cf
 SHA512:
-  metadata.gz: 1711b6758368a02f9c7b247f9321aac58a7cfc0a1566da2cce4696b36887b352c63e341132395ef1f49e50432917a8ffa40eef197e4804441de448156c1fb6a0
-  data.tar.gz: d14162342db37f27e21f320f2ef837208895f274105642f13d13baf17ee2f9c87258515611a5e2d338452ae91a43e8c8a2cab18d00cb16e51f35063888abcdf2
+  metadata.gz: 0c83408740c4ed256dcf514d3fe4341e5b74118c971e565d44b916fe146a71a2291570330633e9c2cdee9ed475696f26173d03cce5c2796f9f60521590b59456
+  data.tar.gz: f428fb791c310d50595ff13b460e2dc9529a5cf87368e83cc3874f4b09537d69bfac031df88e0c4920ad15554c75d11496bb226e306085c41beef85766f8d24d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.17)
+    snaptrade (2.0.18)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

data/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/gem-v2.0.18-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.18)
+[![npm](https://img.shields.io/badge/gem-v2.0.19-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.19)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -69,7 +69,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.18'
+gem 'snaptrade', '~> 2.0.19'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -109,6 +109,7 @@ p.result[3] # [Faraday::Response] Raw HTTP response
 
 
 ### `snaptrade.account_information.get_all_user_holdings`<a id="snaptradeaccount_informationget_all_user_holdings"></a>
+![Deprecated](https://img.shields.io/badge/deprecated-yellow)
 
 Lists balances, positions and orders for the specified account. The data returned is similar to
 the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
@@ -958,7 +959,7 @@ p result
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
-##### order_type: [`OrderType`](./lib/snaptrade/models/order_type.rb)<a id="order_type-ordertypelibsnaptrademodelsorder_typerb"></a>
+##### order_type: [`OrderTypeStrict`](./lib/snaptrade/models/order_type_strict.rb)<a id="order_type-ordertypestrictlibsnaptrademodelsorder_type_strictrb"></a>
 Order Type
 
 ##### time_in_force: [`TimeInForceStrict`](./lib/snaptrade/models/time_in_force_strict.rb)<a id="time_in_force-timeinforcestrictlibsnaptrademodelstime_in_force_strictrb"></a>
@@ -1368,7 +1369,7 @@ p result
 ##### action: [`Action`](./lib/snaptrade/models/action.rb)<a id="action-actionlibsnaptrademodelsactionrb"></a>
 Trade Action
 
-##### order_type: [`OrderType`](./lib/snaptrade/models/order_type.rb)<a id="order_type-ordertypelibsnaptrademodelsorder_typerb"></a>
+##### order_type: [`OrderTypeStrict`](./lib/snaptrade/models/order_type_strict.rb)<a id="order_type-ordertypestrictlibsnaptrademodelsorder_type_strictrb"></a>
 Order Type
 
 ##### price: `Float`<a id="price-float"></a>
@@ -1471,7 +1472,7 @@ p result
 ##### action: [`Action`](./lib/snaptrade/models/action.rb)<a id="action-actionlibsnaptrademodelsactionrb"></a>
 Trade Action
 
-##### order_type: [`OrderType`](./lib/snaptrade/models/order_type.rb)<a id="order_type-ordertypelibsnaptrademodelsorder_typerb"></a>
+##### order_type: [`OrderTypeStrict`](./lib/snaptrade/models/order_type_strict.rb)<a id="order_type-ordertypestrictlibsnaptrademodelsorder_type_strictrb"></a>
 Order Type
 
 ##### price: `Float`<a id="price-float"></a>
@@ -1601,6 +1602,7 @@ FXT
 
 
 ### `snaptrade.transactions_and_reporting.get_reporting_custom_range`<a id="snaptradetransactions_and_reportingget_reporting_custom_range"></a>
+![Deprecated](https://img.shields.io/badge/deprecated-yellow)
 
 Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
 

data/lib/snaptrade/api/options_api.rb

@@ -479,7 +479,7 @@ module SnapTrade
     #
     # Places the option strategy order and returns the order record received from the brokerage.
     #
-    # @param order_type [OrderType] Order Type
+    # @param order_type [OrderTypeStrict] Order Type
     # @param time_in_force [TimeInForceStrict] Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled 
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -502,7 +502,7 @@ module SnapTrade
     #
     # Places the option strategy order and returns the order record received from the brokerage.
     #
-    # @param order_type [OrderType] Order Type
+    # @param order_type [OrderTypeStrict] Order Type
     # @param time_in_force [TimeInForceStrict] Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled 
     # @param user_id [String] 
     # @param user_secret [String] 

data/lib/snaptrade/api/trading_api.rb

@@ -151,7 +151,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param account_id [String] 
     # @param action [Action] Trade Action
-    # @param order_type [OrderType] Order Type
+    # @param order_type [OrderTypeStrict] Order Type
     # @param price [Float] Trade Price if limit or stop limit order
     # @param stop [Float] Stop Price. If stop loss or stop limit order, the price to trigger the stop
     # @param time_in_force [TimeInForceStrict] Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled 
@@ -184,7 +184,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param account_id [String] 
     # @param action [Action] Trade Action
-    # @param order_type [OrderType] Order Type
+    # @param order_type [OrderTypeStrict] Order Type
     # @param price [Float] Trade Price if limit or stop limit order
     # @param stop [Float] Stop Price. If stop loss or stop limit order, the price to trigger the stop
     # @param time_in_force [TimeInForceStrict] Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled 
@@ -418,7 +418,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param account_id [String] 
     # @param action [Action] Trade Action
-    # @param order_type [OrderType] Order Type
+    # @param order_type [OrderTypeStrict] Order Type
     # @param price [Float] Trade Price if limit or stop limit order
     # @param stop [Float] Stop Price. If stop loss or stop limit order, the price to trigger the stop
     # @param time_in_force [TimeInForceStrict] Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled 
@@ -451,7 +451,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param account_id [String] 
     # @param action [Action] Trade Action
-    # @param order_type [OrderType] Order Type
+    # @param order_type [OrderTypeStrict] Order Type
     # @param price [Float] Trade Price if limit or stop limit order
     # @param stop [Float] Stop Price. If stop loss or stop limit order, the price to trigger the stop
     # @param time_in_force [TimeInForceStrict] Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled 

data/lib/snaptrade/models/account_order_record.rb

@@ -47,7 +47,7 @@ module SnapTrade
     # Stop Price. If stop loss or stop limit order, the price to trigger the stop
     attr_accessor :stop_price
 
-    # Order Type
+    # Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - StopLoss
     attr_accessor :order_type
 
     # Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled   * GTD - Good Til Date 
@@ -109,7 +109,7 @@ module SnapTrade
         :'execution_price' => :'Float',
         :'limit_price' => :'Float',
         :'stop_price' => :'Float',
-        :'order_type' => :'OrderType',
+        :'order_type' => :'String',
         :'time_in_force' => :'String',
         :'time_placed' => :'String',
         :'time_updated' => :'String',
@@ -128,6 +128,7 @@ module SnapTrade
         :'execution_price',
         :'limit_price',
         :'stop_price',
+        :'order_type',
         :'time_updated',
         :'time_executed',
       ])

data/lib/snaptrade/models/manual_trade.rb

@@ -57,7 +57,7 @@ module SnapTrade
       {
         :'id' => :'String',
         :'account' => :'String',
-        :'order_type' => :'OrderType',
+        :'order_type' => :'OrderTypeStrict',
         :'time_in_force' => :'String',
         :'symbol' => :'ManualTradeSymbol',
         :'action' => :'Action',

data/lib/snaptrade/models/manual_trade_form.rb

@@ -61,7 +61,7 @@ module SnapTrade
       {
         :'account_id' => :'String',
         :'action' => :'Action',
-        :'order_type' => :'OrderType',
+        :'order_type' => :'OrderTypeStrict',
         :'price' => :'Float',
         :'stop' => :'Float',
         :'time_in_force' => :'TimeInForceStrict',

data/lib/snaptrade/models/options_place_option_strategy_request.rb

@@ -38,7 +38,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'order_type' => :'OrderType',
+        :'order_type' => :'OrderTypeStrict',
         :'time_in_force' => :'TimeInForceStrict',
         :'price' => :'Float'
       }

data/lib/snaptrade/models/{order_type.rb → order_type_strict.rb}

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  class OrderType
+  class OrderTypeStrict
     LIMIT = "Limit".freeze
     MARKET = "Market".freeze
     STOP_LIMIT = "StopLimit".freeze
@@ -32,8 +32,8 @@ module SnapTrade
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if OrderType.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #OrderType"
+      return value if OrderTypeStrict.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #OrderTypeStrict"
     end
   end
 end

data/lib/snaptrade/models/strategy_order_record.rb

@@ -23,7 +23,7 @@ module SnapTrade
 
     attr_accessor :closed_quantity
 
-    # Order Type
+    # Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - StopLoss
     attr_accessor :order_type
 
     # Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled   * GTD - Good Til Date 
@@ -71,7 +71,7 @@ module SnapTrade
         :'filled_quantity' => :'Float',
         :'open_quantity' => :'Float',
         :'closed_quantity' => :'Float',
-        :'order_type' => :'OrderType',
+        :'order_type' => :'String',
         :'time_in_force' => :'String',
         :'limit_price' => :'Float',
         :'execution_price' => :'Float',
@@ -83,6 +83,7 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'order_type',
         :'limit_price',
         :'execution_price',
       ])

data/lib/snaptrade/version.rb

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

data/lib/snaptrade.rb

@@ -92,7 +92,7 @@ require 'snaptrade/models/options_place_option_strategy_request'
 require 'snaptrade/models/options_position'
 require 'snaptrade/models/options_position_currency'
 require 'snaptrade/models/options_symbol'
-require 'snaptrade/models/order_type'
+require 'snaptrade/models/order_type_strict'
 require 'snaptrade/models/partner_data'
 require 'snaptrade/models/past_value'
 require 'snaptrade/models/performance_custom'

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.18
+  version: 2.0.19
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-10 00:00:00.000000000 Z
+date: 2024-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -171,7 +171,7 @@ files:
 - lib/snaptrade/models/options_position.rb
 - lib/snaptrade/models/options_position_currency.rb
 - lib/snaptrade/models/options_symbol.rb
-- lib/snaptrade/models/order_type.rb
+- lib/snaptrade/models/order_type_strict.rb
 - lib/snaptrade/models/partner_data.rb
 - lib/snaptrade/models/past_value.rb
 - lib/snaptrade/models/performance_custom.rb
@@ -315,7 +315,7 @@ files:
 - spec/models/options_position_currency_spec.rb
 - spec/models/options_position_spec.rb
 - spec/models/options_symbol_spec.rb
-- spec/models/order_type_spec.rb
+- spec/models/order_type_strict_spec.rb
 - spec/models/partner_data_spec.rb
 - spec/models/past_value_spec.rb
 - spec/models/performance_custom_spec.rb
@@ -459,7 +459,6 @@ test_files:
 - spec/models/brokerage_authorization_type_type_spec.rb
 - spec/models/portfolio_group_settings_spec.rb
 - spec/models/encrypted_response_spec.rb
-- spec/models/order_type_spec.rb
 - spec/models/time_in_force_strict_spec.rb
 - spec/models/account_simple_spec.rb
 - spec/models/manual_trade_balance_spec.rb
@@ -492,6 +491,7 @@ test_files:
 - spec/models/portfolio_group_position_spec.rb
 - spec/models/strategy_type_spec.rb
 - spec/models/figi_instrument_spec.rb
+- spec/models/order_type_strict_spec.rb
 - spec/models/option_leg_action_spec.rb
 - spec/models/trade_impact_spec.rb
 - spec/models/symbol_query_spec.rb

data/spec/models/order_type_spec.rb

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