snaptrade 2.0.98 → 2.0.99

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbb3a7c6a8a254744c5fb4b9dab60bb4f04727f08bf1e9ce9a7e4e2310d22da2
-  data.tar.gz: 8b2aad12663cfa9dc10ef26017c0493851b3fa683cf0c9f4cab1efecbda7eebe
+  metadata.gz: c48bd0756faff5c29b1642adbf405f37f66338645c30b1ddfd598271ea449284
+  data.tar.gz: 1c33444711aa6be4af2627f32d9678921d11392baa7f5af6c2978bf562d6e362
 SHA512:
-  metadata.gz: b9e5056402e94e440cf0db0f25eaf40864d5574c85453341b0015d18c68df5dff9fc6f4664169b307019c9c390707b9a9af538b0c1ec544e673c3791ebc67332
-  data.tar.gz: 16f1a44e855952124afa548a2ea4a92a74e40d32484d22cb3c00807b8c9321d02d418729b345a7f1ca41246b12bc685372704f6f30386515d2011d2b7e0e7ae1
+  metadata.gz: 5495bc4bf0b6b179e96de1440fef9fe142c1d54bfab486de895abbd4a95d8cf4c1e444e801733f6cf35e9f8df035db8ac61dea3e57f32f65cd5ce30b147074bb
+  data.tar.gz: 0a6ae06dc8e9aeb0bc787d73ff1d1332b3713aab687e3b1ee9e3e21193efaa262a1c6d0ac665501ad6ec2ab1fa038d140b6125a2f685f8dd22e6d72206c6c969

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.98)
+    snaptrade (2.0.99)
       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.98-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.98)
+[![npm](https://img.shields.io/badge/gem-v2.0.99-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.99)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -82,7 +82,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.98'
+gem 'snaptrade', '~> 2.0.99'
 ```
 
 ## Getting Started<a id="getting-started"></a>

data/lib/snaptrade/api/trading_api.rb

@@ -964,7 +964,7 @@ module SnapTrade
     # @param account_id [String] 
     # @param limit_price [Float] The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
     # @param stop_price [Float] The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
-    # @param body [TradingPlaceMlegOrderRequest] 
+    # @param body [MlegTradeForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def place_mleg_order(order_type:, time_in_force:, legs:, user_id:, user_secret:, account_id:, limit_price: SENTINEL, stop_price: SENTINEL, extra: {})
       _body = {}
@@ -973,8 +973,8 @@ module SnapTrade
       _body[:limit_price] = limit_price if limit_price != SENTINEL
       _body[:stop_price] = stop_price if stop_price != SENTINEL
       _body[:legs] = legs if legs != SENTINEL
-      trading_place_mleg_order_request = _body
-      data, _status_code, _headers = place_mleg_order_with_http_info_impl(user_id, user_secret, account_id, trading_place_mleg_order_request, extra)
+      mleg_trade_form = _body
+      data, _status_code, _headers = place_mleg_order_with_http_info_impl(user_id, user_secret, account_id, mleg_trade_form, extra)
       data
     end
 
@@ -990,7 +990,7 @@ module SnapTrade
     # @param account_id [String] 
     # @param limit_price [Float] The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
     # @param stop_price [Float] The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
-    # @param body [TradingPlaceMlegOrderRequest] 
+    # @param body [MlegTradeForm] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def place_mleg_order_with_http_info(order_type:, time_in_force:, legs:, user_id:, user_secret:, account_id:, limit_price: SENTINEL, stop_price: SENTINEL, extra: {})
       _body = {}
@@ -999,8 +999,8 @@ module SnapTrade
       _body[:limit_price] = limit_price if limit_price != SENTINEL
       _body[:stop_price] = stop_price if stop_price != SENTINEL
       _body[:legs] = legs if legs != SENTINEL
-      trading_place_mleg_order_request = _body
-      place_mleg_order_with_http_info_impl(user_id, user_secret, account_id, trading_place_mleg_order_request, extra)
+      mleg_trade_form = _body
+      place_mleg_order_with_http_info_impl(user_id, user_secret, account_id, mleg_trade_form, extra)
     end
 
     # Place multi-leg option order
@@ -1008,11 +1008,11 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param trading_place_mleg_order_request [TradingPlaceMlegOrderRequest] 
+    # @param mleg_trade_form [MlegTradeForm] 
     # @param [Hash] opts the optional parameters
     # @return [MlegOrderResponse]
-    private def place_mleg_order_impl(user_id, user_secret, account_id, trading_place_mleg_order_request, opts = {})
-      data, _status_code, _headers = place_mleg_order_with_http_info(user_id, user_secret, account_id, trading_place_mleg_order_request, opts)
+    private def place_mleg_order_impl(user_id, user_secret, account_id, mleg_trade_form, opts = {})
+      data, _status_code, _headers = place_mleg_order_with_http_info(user_id, user_secret, account_id, mleg_trade_form, opts)
       data
     end
 
@@ -1021,10 +1021,10 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
-    # @param trading_place_mleg_order_request [TradingPlaceMlegOrderRequest] 
+    # @param mleg_trade_form [MlegTradeForm] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(MlegOrderResponse, Integer, Hash)>] MlegOrderResponse data, response status code and response headers
-    private def place_mleg_order_with_http_info_impl(user_id, user_secret, account_id, trading_place_mleg_order_request, opts = {})
+    private def place_mleg_order_with_http_info_impl(user_id, user_secret, account_id, mleg_trade_form, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TradingApi.place_mleg_order ...'
       end
@@ -1040,9 +1040,9 @@ module SnapTrade
       if @api_client.config.client_side_validation && account_id.nil?
         fail ArgumentError, "Missing the required parameter 'account_id' when calling TradingApi.place_mleg_order"
       end
-      # verify the required parameter 'trading_place_mleg_order_request' is set
-      if @api_client.config.client_side_validation && trading_place_mleg_order_request.nil?
-        fail ArgumentError, "Missing the required parameter 'trading_place_mleg_order_request' when calling TradingApi.place_mleg_order"
+      # verify the required parameter 'mleg_trade_form' is set
+      if @api_client.config.client_side_validation && mleg_trade_form.nil?
+        fail ArgumentError, "Missing the required parameter 'mleg_trade_form' when calling TradingApi.place_mleg_order"
       end
       # resource path
       local_var_path = '/accounts/{accountId}/trading/options'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
@@ -1066,7 +1066,7 @@ module SnapTrade
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(trading_place_mleg_order_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(mleg_trade_form)
 
       # return_type
       return_type = opts[:debug_return_type] || 'MlegOrderResponse'

data/lib/snaptrade/models/{trading_place_mleg_order_request.rb → mleg_trade_form.rb}

@@ -11,7 +11,8 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  class TradingPlaceMlegOrderRequest
+  # Inputs for placing a multi-leg order with the brokerage.
+  class MlegTradeForm
     # The type of order to place.
     attr_accessor :order_type
 
@@ -65,13 +66,13 @@ module SnapTrade
     # @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::TradingPlaceMlegOrderRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::MlegTradeForm` 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::TradingPlaceMlegOrderRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::MlegTradeForm`. 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
       }

data/lib/snaptrade/version.rb

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

data/lib/snaptrade.rb

@@ -79,6 +79,7 @@ require 'snaptrade/models/mleg_instrument_type'
 require 'snaptrade/models/mleg_leg'
 require 'snaptrade/models/mleg_order_response'
 require 'snaptrade/models/mleg_order_type_strict'
+require 'snaptrade/models/mleg_trade_form'
 require 'snaptrade/models/mleg_trading_instrument'
 require 'snaptrade/models/model400_failed_request_response'
 require 'snaptrade/models/model401_failed_request_response'
@@ -149,7 +150,6 @@ require 'snaptrade/models/timeframe'
 require 'snaptrade/models/trading_cancel_user_account_order_request'
 require 'snaptrade/models/trading_instrument'
 require 'snaptrade/models/trading_instrument_type'
-require 'snaptrade/models/trading_place_mleg_order_request'
 require 'snaptrade/models/trading_place_simple_order_request'
 require 'snaptrade/models/trading_search_cryptocurrency_pair_instruments200_response'
 require 'snaptrade/models/transactions_status'

data/spec/api/trading_api_spec.rb

@@ -137,7 +137,7 @@ describe 'TradingApi' do
   # @param user_id 
   # @param user_secret 
   # @param account_id 
-  # @param trading_place_mleg_order_request 
+  # @param mleg_trade_form 
   # @param [Hash] opts the optional parameters
   # @return [MlegOrderResponse]
   describe 'place_mleg_order test' do

data/spec/models/{trading_place_mleg_order_request_spec.rb → mleg_trade_form_spec.rb}

@@ -11,13 +11,13 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for SnapTrade::TradingPlaceMlegOrderRequest
-describe SnapTrade::TradingPlaceMlegOrderRequest do
-  let(:instance) { SnapTrade::TradingPlaceMlegOrderRequest.new }
+# Unit tests for SnapTrade::MlegTradeForm
+describe SnapTrade::MlegTradeForm do
+  let(:instance) { SnapTrade::MlegTradeForm.new }
 
-  describe 'test an instance of TradingPlaceMlegOrderRequest' do
-    it 'should create an instance of TradingPlaceMlegOrderRequest' do
-      expect(instance).to be_instance_of(SnapTrade::TradingPlaceMlegOrderRequest)
+  describe 'test an instance of MlegTradeForm' do
+    it 'should create an instance of MlegTradeForm' do
+      expect(instance).to be_instance_of(SnapTrade::MlegTradeForm)
     end
   end
   describe 'test attribute "order_type"' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.98
+  version: 2.0.99
 platform: ruby
 authors:
 - SnapTrade
@@ -158,6 +158,7 @@ files:
 - lib/snaptrade/models/mleg_leg.rb
 - lib/snaptrade/models/mleg_order_response.rb
 - lib/snaptrade/models/mleg_order_type_strict.rb
+- lib/snaptrade/models/mleg_trade_form.rb
 - lib/snaptrade/models/mleg_trading_instrument.rb
 - lib/snaptrade/models/model400_failed_request_response.rb
 - lib/snaptrade/models/model401_failed_request_response.rb
@@ -228,7 +229,6 @@ files:
 - lib/snaptrade/models/trading_cancel_user_account_order_request.rb
 - lib/snaptrade/models/trading_instrument.rb
 - lib/snaptrade/models/trading_instrument_type.rb
-- lib/snaptrade/models/trading_place_mleg_order_request.rb
 - lib/snaptrade/models/trading_place_simple_order_request.rb
 - lib/snaptrade/models/trading_search_cryptocurrency_pair_instruments200_response.rb
 - lib/snaptrade/models/transactions_status.rb
@@ -317,6 +317,7 @@ files:
 - spec/models/mleg_leg_spec.rb
 - spec/models/mleg_order_response_spec.rb
 - spec/models/mleg_order_type_strict_spec.rb
+- spec/models/mleg_trade_form_spec.rb
 - spec/models/mleg_trading_instrument_spec.rb
 - spec/models/model400_failed_request_response_spec.rb
 - spec/models/model401_failed_request_response_spec.rb
@@ -387,7 +388,6 @@ files:
 - spec/models/trading_cancel_user_account_order_request_spec.rb
 - spec/models/trading_instrument_spec.rb
 - spec/models/trading_instrument_type_spec.rb
-- spec/models/trading_place_mleg_order_request_spec.rb
 - spec/models/trading_place_simple_order_request_spec.rb
 - spec/models/trading_search_cryptocurrency_pair_instruments200_response_spec.rb
 - spec/models/transactions_status_spec.rb
@@ -458,6 +458,7 @@ test_files:
 - spec/models/brokerage_type_spec.rb
 - spec/models/account_order_record_quote_currency_spec.rb
 - spec/models/child_brokerage_order_ids_spec.rb
+- spec/models/mleg_trade_form_spec.rb
 - spec/models/sub_period_return_rate_spec.rb
 - spec/models/option_strategy_legs_inner_spec.rb
 - spec/models/account_spec.rb
@@ -566,7 +567,6 @@ test_files:
 - spec/models/account_order_record_status_spec.rb
 - spec/models/manual_trade_symbol_spec.rb
 - spec/models/symbol_figi_instrument_spec.rb
-- spec/models/trading_place_mleg_order_request_spec.rb
 - spec/models/account_holdings_account_spec.rb
 - spec/models/option_brokerage_symbol_spec.rb
 - spec/models/mleg_trading_instrument_spec.rb