snaptrade 2.0.183 → 2.0.185

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6044ea642fe201ec74afdaae8b90e08138098c8b826812434bbcf63641b3c8e
-  data.tar.gz: 52abfeed0137df479dfcdab2f83d010a7cc149e9ef439a6043feec2d6be4c124
+  metadata.gz: c6e6686611e26579a7f5b299263c6f9473fc12564d388730380a0b14f992d01e
+  data.tar.gz: 72ccb9a03f1230f0de97978d4d09c549ee38c45b120990ecb3df75ed6874da93
 SHA512:
-  metadata.gz: '0973d9fecbc6ca4cb1ebec7767ba3be33bbc502470f136624755455a6e2f78a1034fadcefbbe61d97b2b6ce20833ce688b427fe6a1ce31e384809ef05d5e3c65'
-  data.tar.gz: d6caf7f0481d8a5c21e7d68232d535d3dc5dc5bc37237b6c7d09b0b1a11dc4c78146de07247d78d543d88818c74943a86b53e91fe2de4ab3f7eb959f347fc748
+  metadata.gz: cd9ec841ef44d08d5e4d2315937a3cd13dd99c49a7da6ee2a470e6151f684c20d78c47f21e79083f270c3e8b95ce17a9d076b97074a8055780f9085b195681ea
+  data.tar.gz: a8fb0e2f6ef2feb2369036a668643fcc0c11a208bbd604649e2687ced70a4a3db0e67f92f4ed5412246f46fa08dd95ca01fa52406a3bc8fe5f4ac7b8859b9d7f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.183)
+    snaptrade (2.0.185)
       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.183-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.183)
+[![npm](https://img.shields.io/badge/gem-v2.0.185-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.185)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -71,6 +71,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.trading.get_user_account_option_quotes`](#snaptradetradingget_user_account_option_quotes)
   * [`snaptrade.trading.get_user_account_quotes`](#snaptradetradingget_user_account_quotes)
   * [`snaptrade.trading.place_bracket_order`](#snaptradetradingplace_bracket_order)
+  * [`snaptrade.trading.place_complex_order`](#snaptradetradingplace_complex_order)
   * [`snaptrade.trading.place_crypto_order`](#snaptradetradingplace_crypto_order)
   * [`snaptrade.trading.place_force_order`](#snaptradetradingplace_force_order)
   * [`snaptrade.trading.place_mleg_order`](#snaptradetradingplace_mleg_order)
@@ -88,7 +89,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.183'
+gem 'snaptrade', '~> 2.0.185'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -2205,6 +2206,79 @@ Must be `null` if `notional_value` is provided.
 ---
 
 
+### `snaptrade.trading.place_complex_order`<a id="snaptradetradingplace_complex_order"></a>
+
+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.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.trading.place_complex_order(
+  type: "OTO",
+  orders: [
+        {
+            "order_role" => "TRIGGER",
+            "action" => "BUY",
+            "instrument" => {
+                "symbol" => "AAPL",
+                "type" => "EQUITY",
+            },
+            "order_type" => "Market",
+            "units" => 10.5,
+            "time_in_force" => "Day",
+            "price" => 31.33,
+            "stop" => 29.5,
+        }
+    ],
+  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  user_id: "snaptrade-user-123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+  client_order_id: "my-order-123",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### type: [`ManualTradeFormComplexType`](./lib/snaptrade/models/manual_trade_form_complex_type.rb)<a id="type-manualtradeformcomplextypelibsnaptrademodelsmanual_trade_form_complex_typerb"></a>
+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.
+
+##### orders: Array<[`ComplexOrderLeg`](./lib/snaptrade/models/complex_order_leg.rb)><a id="orders-array"></a>
+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`
+
+##### account_id: `String`<a id="account_id-string"></a>
+The ID of the account to execute the trade on.
+
+##### user_id: `String`<a id="user_id-string"></a>
+##### user_secret: `String`<a id="user_secret-string"></a>
+##### client_order_id: `String`<a id="client_order_id-string"></a>
+An optional client-provided identifier for this complex order. Passed through to
+the brokerage and returned in the response.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[ComplexOrderResponse](./lib/snaptrade/models/complex_order_response.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/complex` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.trading.place_crypto_order`<a id="snaptradetradingplace_crypto_order"></a>
 
 Places an order in the specified account.

data/lib/snaptrade/api/trading_api.rb

@@ -1079,6 +1079,148 @@ module SnapTrade
     end
 
 
+    # 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 type [ManualTradeFormComplexType] 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. 
+    # @param orders [Array<ComplexOrderLeg>] 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` 
+    # @param account_id [String] The ID of the account to execute the trade on.
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param client_order_id [String] An optional client-provided identifier for this complex order. Passed through to the brokerage and returned in the response.
+    # @param body [ManualTradeFormComplex] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def place_complex_order(type:, orders:, account_id:, user_id:, user_secret:, client_order_id: SENTINEL, extra: {})
+      _body = {}
+      _body[:type] = type if type != SENTINEL
+      _body[:orders] = orders if orders != SENTINEL
+      _body[:client_order_id] = client_order_id if client_order_id != SENTINEL
+      manual_trade_form_complex = _body
+      data, _status_code, _headers = place_complex_order_with_http_info_impl(account_id, user_id, user_secret, manual_trade_form_complex, extra)
+      data
+    end
+
+    # 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 type [ManualTradeFormComplexType] 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. 
+    # @param orders [Array<ComplexOrderLeg>] 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` 
+    # @param account_id [String] The ID of the account to execute the trade on.
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param client_order_id [String] An optional client-provided identifier for this complex order. Passed through to the brokerage and returned in the response.
+    # @param body [ManualTradeFormComplex] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def place_complex_order_with_http_info(type:, orders:, account_id:, user_id:, user_secret:, client_order_id: SENTINEL, extra: {})
+      _body = {}
+      _body[:type] = type if type != SENTINEL
+      _body[:orders] = orders if orders != SENTINEL
+      _body[:client_order_id] = client_order_id if client_order_id != SENTINEL
+      manual_trade_form_complex = _body
+      place_complex_order_with_http_info_impl(account_id, user_id, user_secret, manual_trade_form_complex, extra)
+    end
+
+    # 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 [String] The ID of the account to execute the trade on.
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param manual_trade_form_complex [ManualTradeFormComplex] 
+    # @param [Hash] opts the optional parameters
+    # @return [ComplexOrderResponse]
+    private def place_complex_order_impl(account_id, user_id, user_secret, manual_trade_form_complex, opts = {})
+      data, _status_code, _headers = place_complex_order_with_http_info(account_id, user_id, user_secret, manual_trade_form_complex, opts)
+      data
+    end
+
+    # 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 [String] The ID of the account to execute the trade on.
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param manual_trade_form_complex [ManualTradeFormComplex] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ComplexOrderResponse, Integer, Hash)>] ComplexOrderResponse data, response status code and response headers
+    private def place_complex_order_with_http_info_impl(account_id, user_id, user_secret, manual_trade_form_complex, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TradingApi.place_complex_order ...'
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling TradingApi.place_complex_order"
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling TradingApi.place_complex_order"
+      end
+      # verify the required parameter 'user_secret' is set
+      if @api_client.config.client_side_validation && user_secret.nil?
+        fail ArgumentError, "Missing the required parameter 'user_secret' when calling TradingApi.place_complex_order"
+      end
+      # verify the required parameter 'manual_trade_form_complex' is set
+      if @api_client.config.client_side_validation && manual_trade_form_complex.nil?
+        fail ArgumentError, "Missing the required parameter 'manual_trade_form_complex' when calling TradingApi.place_complex_order"
+      end
+      # resource path
+      local_var_path = '/accounts/{accountId}/trading/complex'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'userId'] = user_id
+      query_params[:'userSecret'] = user_secret
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(manual_trade_form_complex)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ComplexOrderResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"TradingApi.place_complex_order",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TradingApi#place_complex_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
     # Place crypto order
     #
     # Places an order in the specified account.

data/lib/snaptrade/models/account.rb

@@ -50,6 +50,9 @@ module SnapTrade
     # The account type as provided by the brokerage
     attr_accessor :raw_type
 
+    # The category of the account, normalized across institutions. Returns `null` if the category could not be determined. Use this field to filter out non-investment accounts if your integration only supports trading / holdings flows. See [Filtering Accounts by Category](https://docs.snaptrade.com/docs/filtering-accounts-by-category) for more information. - `INVESTMENT`: A brokerage / investment account (equities, options, crypto, etc.). - `DEPOSIT`: A bank deposit account (checking, savings). - `LOC`: A line of credit account. 
+    attr_accessor :account_category
+
     # Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version.
     attr_accessor :meta
 
@@ -78,6 +81,7 @@ module SnapTrade
         :'balance' => :'balance',
         :'status' => :'status',
         :'raw_type' => :'raw_type',
+        :'account_category' => :'account_category',
         :'meta' => :'meta',
         :'portfolio_group' => :'portfolio_group',
         :'cash_restrictions' => :'cash_restrictions',
@@ -106,6 +110,7 @@ module SnapTrade
         :'balance' => :'AccountBalance',
         :'status' => :'AccountStatus',
         :'raw_type' => :'String',
+        :'account_category' => :'AccountCategory',
         :'meta' => :'Hash<String, Object>',
         :'portfolio_group' => :'String',
         :'cash_restrictions' => :'Array<String>',
@@ -122,6 +127,7 @@ module SnapTrade
         :'opening_date',
         :'status',
         :'raw_type',
+        :'account_category',
       ])
     end
 
@@ -192,6 +198,10 @@ module SnapTrade
         self.raw_type = attributes[:'raw_type']
       end
 
+      if attributes.key?(:'account_category')
+        self.account_category = attributes[:'account_category']
+      end
+
       if attributes.key?(:'meta')
         if (value = attributes[:'meta']).is_a?(Hash)
           self.meta = value
@@ -284,6 +294,7 @@ module SnapTrade
           balance == o.balance &&
           status == o.status &&
           raw_type == o.raw_type &&
+          account_category == o.account_category &&
           meta == o.meta &&
           portfolio_group == o.portfolio_group &&
           cash_restrictions == o.cash_restrictions &&
@@ -299,7 +310,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, brokerage_authorization, name, number, institution_account_id, institution_name, created_date, funding_date, opening_date, sync_status, balance, status, raw_type, meta, portfolio_group, cash_restrictions, is_paper].hash
+      [id, brokerage_authorization, name, number, institution_account_id, institution_name, created_date, funding_date, opening_date, sync_status, balance, status, raw_type, account_category, meta, portfolio_group, cash_restrictions, is_paper].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/account_category.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 AccountCategory
+    INVESTMENT = "INVESTMENT".freeze
+    DEPOSIT = "DEPOSIT".freeze
+    LOC = "LOC".freeze
+
+    def self.all_vars
+      @all_vars ||= [INVESTMENT, DEPOSIT, LOC].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 AccountCategory.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #AccountCategory"
+    end
+  end
+end