snaptrade 3.0.17 → 3.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 453e07ef22552dfcc5ba7aaf226f04c6ae70b4795f0b25c480d9e57c1c080dad
-  data.tar.gz: ea726cdd14e3e2478fa66e9339d959aa3b731cfb27f17070e597161b25b09f21
+  metadata.gz: 83b50aa122906e3335ec87cea66fd578b1051d185cb443a3fa1d4547cc169ba4
+  data.tar.gz: e75959932405d8332e0ff0792b33a822803bde99884f4d88e3bf77f2a9f266e4
 SHA512:
-  metadata.gz: 0043f1a7bf08c97e3f633740b3c7e719c849e2c583d46ed90bc44cd3da9209c22fcd5b7789e4948c664eab9c7d717a1a130ffe62a8f9039b946fb954005cbd8a
-  data.tar.gz: 82d3e842da1da873041694d85ba6629c04b7fdca1d819d0721717c39e00a4de357e1ae9f78d779845cbccb8ceaa5568951427119859f7e53eca5e7b97984a76f
+  metadata.gz: 8299becc77d8244f1d6f83f506af9cab8a03662c3b3ffd94d168dbff044cc6e9f39aa91826ab24e68c0b8f3f3a34c3a639fa3d12d3f6b03b35155bab21be5efd
+  data.tar.gz: 9ac79ae9f0c067be7822318d3a0093cafc0b06d951250165057bbe8a2e8fa7232ff96fef1ce31bfe5d710910cce62b4efe09bf5db4d4424bdd5218d4810f59f3

data/README.md

@@ -63,7 +63,7 @@ backoff with jitter rather than from the headers.
 See https://docs.snaptrade.com/docs/ratelimiting.
 
 
-[![npm](https://img.shields.io/badge/gem-v3.0.17-blue)](https://rubygems.org/gems/snaptrade/versions/3.0.17)
+[![npm](https://img.shields.io/badge/gem-v3.0.19-blue)](https://rubygems.org/gems/snaptrade/versions/3.0.19)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -139,7 +139,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 3.0.17'
+gem 'snaptrade', '~> 3.0.19'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -307,7 +307,9 @@ p result
 
 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, bonds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
+The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, bonds, crypto, futures, option positions, future option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
+
+**Beta:** future option positions (`instrument.kind: future_option`) are in beta. They are currently returned only for tastytrade and Interactive Brokers connections, and only for partners they have been enabled for — please contact the SnapTrade team to enable them. The `FutureOptionInstrument` schema may change.
 
 Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages).
 
@@ -2090,6 +2092,22 @@ Please refer to the [brokerage trading support page](https://support.snaptrade.c
 - **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.
 
+Option OCO peers must trade the same OCC option symbol with the same closing
+action and positive whole-contract quantity.
+
+On tastytrade, option OCO supports closing an existing long or short option
+position with one `Limit` order and one `Stop` or `StopLimit` order. Both
+`PEER` orders must use `SELL_TO_CLOSE` or both must use `BUY_TO_CLOSE`, with
+`Day` or `GTC` time in force. Opening option OCOs are not supported.
+
+On enabled Webull US v3 accounts, option OCO supports closing an existing long
+option position with one `Limit` take-profit order and one `Stop` stop-loss order.
+Both `PEER` orders must use `SELL_TO_CLOSE`, `Day`, the same OCC option symbol,
+and the same positive whole-contract quantity. Webull receives these as
+`STOP_PROFIT` and `STOP_LOSS` orders sharing a combo ID, without a MASTER order.
+Opening option OCOs, `BUY_TO_CLOSE`, `StopLimit`, and other option order pairs
+are not supported on Webull. Equity complex-order behavior is unchanged.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 

data/lib/snaptrade/api/account_information_api.rb

@@ -290,7 +290,9 @@ module SnapTrade
     #
     # 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, bonds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
+    # The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, bonds, crypto, futures, option positions, future option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
+    # 
+    # **Beta:** future option positions (`instrument.kind: future_option`) are in beta. They are currently returned only for tastytrade and Interactive Brokers connections, and only for partners they have been enabled for — please contact the SnapTrade team to enable them. The `FutureOptionInstrument` schema may change.
     # 
     # Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages).
     # 
@@ -309,7 +311,9 @@ module SnapTrade
     #
     # 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, bonds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
+    # The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, bonds, crypto, futures, option positions, future option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
+    # 
+    # **Beta:** future option positions (`instrument.kind: future_option`) are in beta. They are currently returned only for tastytrade and Interactive Brokers connections, and only for partners they have been enabled for — please contact the SnapTrade team to enable them. The `FutureOptionInstrument` schema may change.
     # 
     # Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages).
     # 
@@ -324,7 +328,7 @@ module SnapTrade
     end
 
     # 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, bonds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages).  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, bonds, crypto, futures, option positions, future option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  **Beta:** future option positions (`instrument.kind: future_option`) are in beta. They are currently returned only for tastytrade and Interactive Brokers connections, and only for partners they have been enabled for — please contact the SnapTrade team to enable them. The `FutureOptionInstrument` schema may change.  Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages).  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 [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -336,7 +340,7 @@ module SnapTrade
     end
 
     # 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, bonds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages).  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, bonds, crypto, futures, option positions, future option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  **Beta:** future option positions (`instrument.kind: future_option`) are in beta. They are currently returned only for tastytrade and Interactive Brokers connections, and only for partners they have been enabled for — please contact the SnapTrade team to enable them. The `FutureOptionInstrument` schema may change.  Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages).  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 [String] 
     # @param user_secret [String] 
     # @param account_id [String] 

data/lib/snaptrade/api/trading_api.rb

@@ -804,6 +804,22 @@ module SnapTrade
     # - **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.
+    # 
+    # Option OCO peers must trade the same OCC option symbol with the same closing
+    # action and positive whole-contract quantity.
+    # 
+    # On tastytrade, option OCO supports closing an existing long or short option
+    # position with one `Limit` order and one `Stop` or `StopLimit` order. Both
+    # `PEER` orders must use `SELL_TO_CLOSE` or both must use `BUY_TO_CLOSE`, with
+    # `Day` or `GTC` time in force. Opening option OCOs are not supported.
+    # 
+    # On enabled Webull US v3 accounts, option OCO supports closing an existing long
+    # option position with one `Limit` take-profit order and one `Stop` stop-loss order.
+    # Both `PEER` orders must use `SELL_TO_CLOSE`, `Day`, the same OCC option symbol,
+    # and the same positive whole-contract quantity. Webull receives these as
+    # `STOP_PROFIT` and `STOP_LOSS` orders sharing a combo ID, without a MASTER order.
+    # Opening option OCOs, `BUY_TO_CLOSE`, `StopLimit`, and other option order pairs
+    # are not supported on Webull. Equity complex-order behavior is unchanged.
     #
     # @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` 
@@ -832,6 +848,22 @@ module SnapTrade
     # - **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.
+    # 
+    # Option OCO peers must trade the same OCC option symbol with the same closing
+    # action and positive whole-contract quantity.
+    # 
+    # On tastytrade, option OCO supports closing an existing long or short option
+    # position with one `Limit` order and one `Stop` or `StopLimit` order. Both
+    # `PEER` orders must use `SELL_TO_CLOSE` or both must use `BUY_TO_CLOSE`, with
+    # `Day` or `GTC` time in force. Opening option OCOs are not supported.
+    # 
+    # On enabled Webull US v3 accounts, option OCO supports closing an existing long
+    # option position with one `Limit` take-profit order and one `Stop` stop-loss order.
+    # Both `PEER` orders must use `SELL_TO_CLOSE`, `Day`, the same OCC option symbol,
+    # and the same positive whole-contract quantity. Webull receives these as
+    # `STOP_PROFIT` and `STOP_LOSS` orders sharing a combo ID, without a MASTER order.
+    # Opening option OCOs, `BUY_TO_CLOSE`, `StopLimit`, and other option order pairs
+    # are not supported on Webull. Equity complex-order behavior is unchanged.
     #
     # @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` 
@@ -851,7 +883,7 @@ module SnapTrade
     end
 
     # Place complex order
-    # Places a complex conditional order (OCO, OTO, or OTOCO). Only supported on certain brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support.  - **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. 
+    # Places a complex conditional order (OCO, OTO, or OTOCO). Only supported on certain brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support.  - **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.  Option OCO peers must trade the same OCC option symbol with the same closing action and positive whole-contract quantity.  On tastytrade, option OCO supports closing an existing long or short option position with one `Limit` order and one `Stop` or `StopLimit` order. Both `PEER` orders must use `SELL_TO_CLOSE` or both must use `BUY_TO_CLOSE`, with `Day` or `GTC` time in force. Opening option OCOs are not supported.  On enabled Webull US v3 accounts, option OCO supports closing an existing long option position with one `Limit` take-profit order and one `Stop` stop-loss order. Both `PEER` orders must use `SELL_TO_CLOSE`, `Day`, the same OCC option symbol, and the same positive whole-contract quantity. Webull receives these as `STOP_PROFIT` and `STOP_LOSS` orders sharing a combo ID, without a MASTER order. Opening option OCOs, `BUY_TO_CLOSE`, `StopLimit`, and other option order pairs are not supported on Webull. Equity complex-order behavior is unchanged. 
     # @param account_id [String] The ID of the account to execute the trade on.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -864,7 +896,7 @@ module SnapTrade
     end
 
     # Place complex order
-    # Places a complex conditional order (OCO, OTO, or OTOCO). Only supported on certain brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support.  - **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. 
+    # Places a complex conditional order (OCO, OTO, or OTOCO). Only supported on certain brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support.  - **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.  Option OCO peers must trade the same OCC option symbol with the same closing action and positive whole-contract quantity.  On tastytrade, option OCO supports closing an existing long or short option position with one &#x60;Limit&#x60; order and one &#x60;Stop&#x60; or &#x60;StopLimit&#x60; order. Both &#x60;PEER&#x60; orders must use &#x60;SELL_TO_CLOSE&#x60; or both must use &#x60;BUY_TO_CLOSE&#x60;, with &#x60;Day&#x60; or &#x60;GTC&#x60; time in force. Opening option OCOs are not supported.  On enabled Webull US v3 accounts, option OCO supports closing an existing long option position with one &#x60;Limit&#x60; take-profit order and one &#x60;Stop&#x60; stop-loss order. Both &#x60;PEER&#x60; orders must use &#x60;SELL_TO_CLOSE&#x60;, &#x60;Day&#x60;, the same OCC option symbol, and the same positive whole-contract quantity. Webull receives these as &#x60;STOP_PROFIT&#x60; and &#x60;STOP_LOSS&#x60; orders sharing a combo ID, without a MASTER order. Opening option OCOs, &#x60;BUY_TO_CLOSE&#x60;, &#x60;StopLimit&#x60;, and other option order pairs are not supported on Webull. Equity complex-order behavior is unchanged. 
     # @param account_id [String] The ID of the account to execute the trade on.
     # @param user_id [String] 
     # @param user_secret [String] 

data/lib/snaptrade/models/future_option_instrument.rb

@@ -0,0 +1,356 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading.  ## Rate limiting  Two limits apply to requests signed with your `clientId`. The stricter one wins, and exceeding either returns `429 Too Many Requests`.  - **Customer-level** — 250 requests/minute by default, scoped to your   `clientId` and applied across all endpoints. Reported in   `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`. - **Account-level** — 10 requests/minute per account, scoped to   (`clientId`, `accountId`). All covered operations for one account draw on   the same bucket — reading balances and reading positions share it — and   enforcement does not depend on the HTTP method, so updating an account   consumes the same bucket as reading it. Only enforced for Personal users,   and only for integrations it has been rolled out to — it is not yet in   force for every Personal integration. It also does not apply on every   operation that documents a 429 below. Where it applies it is reported in   `X-RateLimit-Account-Limit`, `X-RateLimit-Account-Remaining` and   `X-RateLimit-Account-Reset`. Do not read the absence of those headers as   proof the limit is off — some configurations omit the rate limit headers   while still enforcing the limit, so header absence tells you nothing   about your allowance.  On a 429, `X-RateLimit-Remaining: 0` means you hit the customer-level limit and `X-RateLimit-Account-Remaining: 0` means the account-level one. Wait for the corresponding `*-Reset` value (seconds) before retrying, or fall back to exponential backoff with jitter.  Not every 429 is explained by those headers. A separate per-authenticated-user limit, reported in no `X-RateLimit-*` header, covers OAuth-authenticated requests and signed requests in configurations where the customer-level limit is not in effect — on the operations that use the default throttles. A few operations override those and are governed by the customer-level limit alone. The two do not stack: a signed request governed by the customer-level limit above is not additionally subject to the per-user one. If a 429 arrives with no header at zero — or with no `X-RateLimit-*` headers at all — honour `Retry-After` and back off. Treat the remaining counts as a hint, not a guarantee that the next request will succeed.  Because the customer-level limit applies everywhere, any signed request can return 429.  **OAuth-authenticated requests are an exception.** They are not subject to the customer-level limit and do not receive `X-RateLimit-Limit`, `X-RateLimit-Remaining` or `X-RateLimit-Reset` — do not wait on those headers or design around a customer-level allowance on this path. The account-level limit still applies to them on the account-data endpoints above, reported in the `X-RateLimit-Account-*` headers. On operations using the default throttles the per-user limit above applies to them as well, so an OAuth request can be rejected while the account headers still show capacity; on the few operations that override those throttles, OAuth callers have no per-user ceiling at all. Drive retries from `Retry-After` and exponential backoff with jitter rather than from the headers.  See https://docs.snaptrade.com/docs/ratelimiting. 
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'date'
+require 'time'
+
+module SnapTrade
+  # Future option (option on a futures contract) instrument metadata for a V2 position.  **Beta:** currently returned only for tastytrade and Interactive Brokers connections, and only for partners it has been enabled for. This schema may change. 
+  class FutureOptionInstrument
+    # Type of security instrument.
+    attr_accessor :kind
+
+    # Unique identifier for the future option instrument.
+    attr_accessor :id
+
+    # Display symbol for the future option contract.
+    attr_accessor :symbol
+
+    # Whether the contract is a call or put.
+    attr_accessor :option_type
+
+    # Strike price for the option contract.
+    attr_accessor :strike_price
+
+    # Expiration date of the option contract.
+    attr_accessor :expiration_date
+
+    # Notional multiplier for the option contract.
+    attr_accessor :multiplier
+
+    # Human-readable description of the option contract.
+    attr_accessor :description
+
+    # ISO-4217 currency code for the contract.
+    attr_accessor :currency
+
+    # Exchange MIC code or exchange code for the contract.
+    attr_accessor :exchange
+
+    attr_accessor :underlying
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'kind' => :'kind',
+        :'id' => :'id',
+        :'symbol' => :'symbol',
+        :'option_type' => :'option_type',
+        :'strike_price' => :'strike_price',
+        :'expiration_date' => :'expiration_date',
+        :'multiplier' => :'multiplier',
+        :'description' => :'description',
+        :'currency' => :'currency',
+        :'exchange' => :'exchange',
+        :'underlying' => :'underlying'
+      }
+    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
+      {
+        :'kind' => :'FutureOptionInstrumentKind',
+        :'id' => :'String',
+        :'symbol' => :'String',
+        :'option_type' => :'OptionType',
+        :'strike_price' => :'Float',
+        :'expiration_date' => :'Date',
+        :'multiplier' => :'Float',
+        :'description' => :'String',
+        :'currency' => :'String',
+        :'exchange' => :'String',
+        :'underlying' => :'FutureInstrument'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'multiplier',
+        :'description',
+        :'currency',
+        :'exchange',
+      ])
+    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::FutureOptionInstrument` 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::FutureOptionInstrument`. 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?(:'kind')
+        self.kind = attributes[:'kind']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'symbol')
+        self.symbol = attributes[:'symbol']
+      end
+
+      if attributes.key?(:'option_type')
+        self.option_type = attributes[:'option_type']
+      end
+
+      if attributes.key?(:'strike_price')
+        self.strike_price = attributes[:'strike_price']
+      end
+
+      if attributes.key?(:'expiration_date')
+        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
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'exchange')
+        self.exchange = attributes[:'exchange']
+      end
+
+      if attributes.key?(:'underlying')
+        self.underlying = attributes[:'underlying']
+      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
+      if @kind.nil?
+        invalid_properties.push('invalid value for "kind", kind cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @symbol.nil?
+        invalid_properties.push('invalid value for "symbol", symbol cannot be nil.')
+      end
+
+      if @option_type.nil?
+        invalid_properties.push('invalid value for "option_type", option_type cannot be nil.')
+      end
+
+      if @strike_price.nil?
+        invalid_properties.push('invalid value for "strike_price", strike_price cannot be nil.')
+      end
+
+      if @expiration_date.nil?
+        invalid_properties.push('invalid value for "expiration_date", expiration_date cannot be nil.')
+      end
+
+      if @underlying.nil?
+        invalid_properties.push('invalid value for "underlying", underlying cannot be nil.')
+      end
+
+      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?
+      return false if @kind.nil?
+      return false if @id.nil?
+      return false if @symbol.nil?
+      return false if @option_type.nil?
+      return false if @strike_price.nil?
+      return false if @expiration_date.nil?
+      return false if @underlying.nil?
+      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 &&
+          kind == o.kind &&
+          id == o.id &&
+          symbol == o.symbol &&
+          option_type == o.option_type &&
+          strike_price == o.strike_price &&
+          expiration_date == o.expiration_date &&
+          multiplier == o.multiplier &&
+          description == o.description &&
+          currency == o.currency &&
+          exchange == o.exchange &&
+          underlying == o.underlying
+    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
+      [kind, id, symbol, option_type, strike_price, expiration_date, multiplier, description, currency, exchange, underlying].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/future_option_instrument_kind.rb

@@ -0,0 +1,36 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading.  ## Rate limiting  Two limits apply to requests signed with your `clientId`. The stricter one wins, and exceeding either returns `429 Too Many Requests`.  - **Customer-level** — 250 requests/minute by default, scoped to your   `clientId` and applied across all endpoints. Reported in   `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`. - **Account-level** — 10 requests/minute per account, scoped to   (`clientId`, `accountId`). All covered operations for one account draw on   the same bucket — reading balances and reading positions share it — and   enforcement does not depend on the HTTP method, so updating an account   consumes the same bucket as reading it. Only enforced for Personal users,   and only for integrations it has been rolled out to — it is not yet in   force for every Personal integration. It also does not apply on every   operation that documents a 429 below. Where it applies it is reported in   `X-RateLimit-Account-Limit`, `X-RateLimit-Account-Remaining` and   `X-RateLimit-Account-Reset`. Do not read the absence of those headers as   proof the limit is off — some configurations omit the rate limit headers   while still enforcing the limit, so header absence tells you nothing   about your allowance.  On a 429, `X-RateLimit-Remaining: 0` means you hit the customer-level limit and `X-RateLimit-Account-Remaining: 0` means the account-level one. Wait for the corresponding `*-Reset` value (seconds) before retrying, or fall back to exponential backoff with jitter.  Not every 429 is explained by those headers. A separate per-authenticated-user limit, reported in no `X-RateLimit-*` header, covers OAuth-authenticated requests and signed requests in configurations where the customer-level limit is not in effect — on the operations that use the default throttles. A few operations override those and are governed by the customer-level limit alone. The two do not stack: a signed request governed by the customer-level limit above is not additionally subject to the per-user one. If a 429 arrives with no header at zero — or with no `X-RateLimit-*` headers at all — honour `Retry-After` and back off. Treat the remaining counts as a hint, not a guarantee that the next request will succeed.  Because the customer-level limit applies everywhere, any signed request can return 429.  **OAuth-authenticated requests are an exception.** They are not subject to the customer-level limit and do not receive `X-RateLimit-Limit`, `X-RateLimit-Remaining` or `X-RateLimit-Reset` — do not wait on those headers or design around a customer-level allowance on this path. The account-level limit still applies to them on the account-data endpoints above, reported in the `X-RateLimit-Account-*` headers. On operations using the default throttles the per-user limit above applies to them as well, so an OAuth request can be rejected while the account headers still show capacity; on the few operations that override those throttles, OAuth callers have no per-user ceiling at all. Drive retries from `Retry-After` and exponential backoff with jitter rather than from the headers.  See https://docs.snaptrade.com/docs/ratelimiting. 
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'date'
+require 'time'
+
+module SnapTrade
+  class FutureOptionInstrumentKind
+    FUTURE_OPTION = "future_option".freeze
+
+    def self.all_vars
+      @all_vars ||= [FUTURE_OPTION].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 FutureOptionInstrumentKind.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #FutureOptionInstrumentKind"
+    end
+  end
+end

data/lib/snaptrade/models/instrument.rb

@@ -23,6 +23,7 @@ module SnapTrade
           :'CryptoInstrument',
           :'EtfInstrument',
           :'FutureInstrument',
+          :'FutureOptionInstrument',
           :'MutualFundInstrument',
           :'OptionInstrument',
           :'OtherInstrument',
@@ -45,6 +46,7 @@ module SnapTrade
           :'crypto' => :'CryptoInstrument',
           :'etf' => :'EtfInstrument',
           :'future' => :'FutureInstrument',
+          :'future_option' => :'FutureOptionInstrument',
           :'mutualfund' => :'MutualFundInstrument',
           :'option' => :'OptionInstrument',
           :'other' => :'OtherInstrument',

data/lib/snaptrade/models/option_instrument.rb

@@ -65,7 +65,7 @@ module SnapTrade
         :'kind' => :'OptionInstrumentKind',
         :'id' => :'String',
         :'symbol' => :'String',
-        :'option_type' => :'OptionType',
+        :'option_type' => :'OptionInstrumentOptionType',
         :'strike_price' => :'Float',
         :'expiration_date' => :'Date',
         :'multiplier' => :'Float',

data/lib/snaptrade/models/option_instrument_option_type.rb

@@ -0,0 +1,37 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading.  ## Rate limiting  Two limits apply to requests signed with your `clientId`. The stricter one wins, and exceeding either returns `429 Too Many Requests`.  - **Customer-level** — 250 requests/minute by default, scoped to your   `clientId` and applied across all endpoints. Reported in   `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`. - **Account-level** — 10 requests/minute per account, scoped to   (`clientId`, `accountId`). All covered operations for one account draw on   the same bucket — reading balances and reading positions share it — and   enforcement does not depend on the HTTP method, so updating an account   consumes the same bucket as reading it. Only enforced for Personal users,   and only for integrations it has been rolled out to — it is not yet in   force for every Personal integration. It also does not apply on every   operation that documents a 429 below. Where it applies it is reported in   `X-RateLimit-Account-Limit`, `X-RateLimit-Account-Remaining` and   `X-RateLimit-Account-Reset`. Do not read the absence of those headers as   proof the limit is off — some configurations omit the rate limit headers   while still enforcing the limit, so header absence tells you nothing   about your allowance.  On a 429, `X-RateLimit-Remaining: 0` means you hit the customer-level limit and `X-RateLimit-Account-Remaining: 0` means the account-level one. Wait for the corresponding `*-Reset` value (seconds) before retrying, or fall back to exponential backoff with jitter.  Not every 429 is explained by those headers. A separate per-authenticated-user limit, reported in no `X-RateLimit-*` header, covers OAuth-authenticated requests and signed requests in configurations where the customer-level limit is not in effect — on the operations that use the default throttles. A few operations override those and are governed by the customer-level limit alone. The two do not stack: a signed request governed by the customer-level limit above is not additionally subject to the per-user one. If a 429 arrives with no header at zero — or with no `X-RateLimit-*` headers at all — honour `Retry-After` and back off. Treat the remaining counts as a hint, not a guarantee that the next request will succeed.  Because the customer-level limit applies everywhere, any signed request can return 429.  **OAuth-authenticated requests are an exception.** They are not subject to the customer-level limit and do not receive `X-RateLimit-Limit`, `X-RateLimit-Remaining` or `X-RateLimit-Reset` — do not wait on those headers or design around a customer-level allowance on this path. The account-level limit still applies to them on the account-data endpoints above, reported in the `X-RateLimit-Account-*` headers. On operations using the default throttles the per-user limit above applies to them as well, so an OAuth request can be rejected while the account headers still show capacity; on the few operations that override those throttles, OAuth callers have no per-user ceiling at all. Drive retries from `Retry-After` and exponential backoff with jitter rather than from the headers.  See https://docs.snaptrade.com/docs/ratelimiting. 
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'date'
+require 'time'
+
+module SnapTrade
+  class OptionInstrumentOptionType
+    CALL = "CALL".freeze
+    PUT = "PUT".freeze
+
+    def self.all_vars
+      @all_vars ||= [CALL, PUT].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 OptionInstrumentOptionType.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #OptionInstrumentOptionType"
+    end
+  end
+end