snaptrade 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 960ed0a9a06ef7a17b797263559cc067ec57028a8ec6f86a0fc836189f5b9894
-  data.tar.gz: e753abdf3ab73d400de212b6cbc661b6cac4a99a9c427d1fdc6900bf5375eec8
+  metadata.gz: ba4c97143d9a30a5a3e879d49c4e5f4d74c5c99df7e0ae8c30253dc35ef7e470
+  data.tar.gz: aed56338d5c6e95d07c24028ddcc65ffe37ce3f6d1998c7b11b600eed6487f8a
 SHA512:
-  metadata.gz: 7905038f3e54940df96bd2cf71494d41a3b371af8a097b58963a47887737f9e57ba85a424c68858fc176faaf55ce351561fbe20ad7770221fe91e947fd4f1f40
-  data.tar.gz: 133a0a19bfeb1e3a5cdd20919ebfc19f3060a2cc89ad8e37581a5d79dab8819cd0f0b10b03d4139755a483b91f67bd8d1288717392776a74ac83fb7d8de70bc4
+  metadata.gz: a7174f4c1299e4388d4927725221014d866065b850ee68463df70b85ff89d2b083aa2f70e3537cafff574856958fc9b78a1ebae1931701b380c23a07275406a8
+  data.tar.gz: e12a6d85144b6392487076de00b1bbfbd3db0d55ec22973edcbed1694270725e211218719dab3a60bea7069d081aac1f246dfa5d56b33849f2395659b33c320b

data/README.md

@@ -9,7 +9,7 @@ For more information, please visit [https://snaptrade.com/](https://snaptrade.co
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.4'
+gem 'snaptrade', '~> 2.0.5'
 ```
 
 ## Getting Started
@@ -220,4 +220,5 @@ Class | Method | HTTP request | Description
  - [SnapTrade::UserErrorLog](docs/UserErrorLog.md)
  - [SnapTrade::UserIDandSecret](docs/UserIDandSecret.md)
  - [SnapTrade::UserSettings](docs/UserSettings.md)
+ - [SnapTrade::ValidatedTradeBody](docs/ValidatedTradeBody.md)
 

data/docs/TradingApi.md

@@ -434,6 +434,7 @@ SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
 trade_id = "tradeId_example"
 user_id = "John.doe@snaptrade.com"
 user_secret = "USERSECRET123"
+wait_to_confirm = True
 
 begin
   # Place order
@@ -441,6 +442,7 @@ begin
                                              trade_id: trade_id,
                                              user_id: user_id,
                                              user_secret: user_secret,
+                                             wait_to_confirm: wait_to_confirm,
                                            )
   p result
 rescue SnapTrade::ApiError => e
@@ -456,6 +458,7 @@ This returns an Array which contains the response data, status code and headers.
 trade_id = "tradeId_example"
 user_id = "John.doe@snaptrade.com"
 user_secret = "USERSECRET123"
+wait_to_confirm = True
 
 begin
   # Place order
@@ -463,6 +466,7 @@ begin
                                                                                           trade_id: trade_id,
                                                                                           user_id: user_id,
                                                                                           user_secret: user_secret,
+                                                                                          wait_to_confirm: wait_to_confirm,
                                                                                         )
   p status_code # => 2xx
   p headers # => { ... }
@@ -479,6 +483,7 @@ end
 | **trade_id** | **String** | The ID of trade object obtained from trade/impact endpoint |  |
 | **user_id** | **String** |  |  |
 | **user_secret** | **String** |  |  |
+| **validated_trade_body** | [**ValidatedTradeBody**](ValidatedTradeBody.md) |  | [optional] |
 
 ### Return type
 

data/docs/ValidatedTradeBody.md

@@ -0,0 +1,18 @@
+# SnapTrade::ValidatedTradeBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **wait_to_confirm** | **Boolean** | Optional, defaults to true. Determines if a wait is performed to check on order status. If false, latency will be reduced but orders returned will be more likely to be of status PENDING as we will not wait to check on the status before responding to the request | [optional] |
+
+## Example
+
+```ruby
+require 'snaptrade'
+
+instance = SnapTrade::ValidatedTradeBody.new(
+  wait_to_confirm: true
+)
+```
+

data/lib/snaptrade/api/trading_api.rb

@@ -641,8 +641,13 @@ module SnapTrade
     # @param trade_id [String] The ID of trade object obtained from trade/impact endpoint
     # @param user_id [String] 
     # @param user_secret [String] 
+    # @param wait_to_confirm [Boolean] Optional, defaults to true. Determines if a wait is performed to check on order status. If false, latency will be reduced but orders returned will be more likely to be of status PENDING as we will not wait to check on the status before responding to the request
+    # @param body [ValidatedTradeBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def place_order(trade_id:, user_id:, user_secret:, extra: {})
+    def place_order(trade_id:, user_id:, user_secret:, wait_to_confirm: SENTINEL, extra: {})
+      _body = {}
+      _body[:wait_to_confirm] = wait_to_confirm if wait_to_confirm != SENTINEL
+      extra[:validated_trade_body] = _body if !_body.empty?
       data, _status_code, _headers = place_order_with_http_info_impl(trade_id, user_id, user_secret, extra)
       data
     end
@@ -651,8 +656,13 @@ module SnapTrade
     # @param trade_id [String] The ID of trade object obtained from trade/impact endpoint
     # @param user_id [String] 
     # @param user_secret [String] 
+    # @param wait_to_confirm [Boolean] Optional, defaults to true. Determines if a wait is performed to check on order status. If false, latency will be reduced but orders returned will be more likely to be of status PENDING as we will not wait to check on the status before responding to the request
+    # @param body [ValidatedTradeBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def place_order_with_http_info(trade_id:, user_id:, user_secret:, extra: {})
+    def place_order_with_http_info(trade_id:, user_id:, user_secret:, wait_to_confirm: SENTINEL, extra: {})
+      _body = {}
+      _body[:wait_to_confirm] = wait_to_confirm if wait_to_confirm != SENTINEL
+      extra[:validated_trade_body] = _body if !_body.empty?
       place_order_with_http_info_impl(trade_id, user_id, user_secret, extra)
     end
 
@@ -661,6 +671,7 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [ValidatedTradeBody] :validated_trade_body 
     # @return [AccountOrderRecord]
     def place_order_impl(trade_id, user_id, user_secret, opts = {})
       data, _status_code, _headers = place_order_with_http_info(trade_id, user_id, user_secret, opts)
@@ -672,6 +683,7 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [ValidatedTradeBody] :validated_trade_body 
     # @return [Array<(AccountOrderRecord, Integer, Hash)>] AccountOrderRecord data, response status code and response headers
     def place_order_with_http_info_impl(trade_id, user_id, user_secret, opts = {})
       if @api_client.config.debugging
@@ -701,12 +713,17 @@ module SnapTrade
       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]
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'validated_trade_body'])
 
       # return_type
       return_type = opts[:debug_return_type] || 'AccountOrderRecord'

data/lib/snaptrade/models/validated_trade_body.rb

@@ -0,0 +1,220 @@
+=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
+  # Validated Trade Form
+  class ValidatedTradeBody
+    # Optional, defaults to true. Determines if a wait is performed to check on order status. If false, latency will be reduced but orders returned will be more likely to be of status PENDING as we will not wait to check on the status before responding to the request
+    attr_accessor :wait_to_confirm
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'wait_to_confirm' => :'wait_to_confirm'
+      }
+    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
+      {
+        :'wait_to_confirm' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'wait_to_confirm'
+      ])
+    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::ValidatedTradeBody` 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::ValidatedTradeBody`. 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?(:'wait_to_confirm')
+        self.wait_to_confirm = attributes[:'wait_to_confirm']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          wait_to_confirm == o.wait_to_confirm
+    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
+      [wait_to_confirm].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/version.rb

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

data/lib/snaptrade.rb

@@ -146,6 +146,7 @@ require 'snaptrade/models/universal_symbol'
 require 'snaptrade/models/user_error_log'
 require 'snaptrade/models/user_i_dand_secret'
 require 'snaptrade/models/user_settings'
+require 'snaptrade/models/validated_trade_body'
 
 # APIs
 require 'snaptrade/api/account_information_api'

data/spec/api/trading_api_spec.rb

@@ -102,6 +102,7 @@ describe 'TradingApi' do
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
+  # @option opts [ValidatedTradeBody] :validated_trade_body 
   # @return [AccountOrderRecord]
   describe 'place_order test' do
     it 'should work' do

data/spec/models/validated_trade_body_spec.rb

@@ -0,0 +1,30 @@
+=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::ValidatedTradeBody
+describe SnapTrade::ValidatedTradeBody do
+  let(:instance) { SnapTrade::ValidatedTradeBody.new }
+
+  describe 'test an instance of ValidatedTradeBody' do
+    it 'should create an instance of ValidatedTradeBody' do
+      expect(instance).to be_instance_of(SnapTrade::ValidatedTradeBody)
+    end
+  end
+  describe 'test attribute "wait_to_confirm"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-09 00:00:00.000000000 Z
+date: 2024-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -219,6 +219,7 @@ files:
 - docs/UserErrorLog.md
 - docs/UserIDandSecret.md
 - docs/UserSettings.md
+- docs/ValidatedTradeBody.md
 - header.png
 - lib/snaptrade.rb
 - lib/snaptrade/api/account_information_api.rb
@@ -363,6 +364,7 @@ files:
 - lib/snaptrade/models/user_error_log.rb
 - lib/snaptrade/models/user_i_dand_secret.rb
 - lib/snaptrade/models/user_settings.rb
+- lib/snaptrade/models/validated_trade_body.rb
 - lib/snaptrade/version.rb
 - snaptrade.gemspec
 - spec/api/account_information_api_spec.rb
@@ -506,6 +508,7 @@ files:
 - spec/models/user_error_log_spec.rb
 - spec/models/user_i_dand_secret_spec.rb
 - spec/models/user_settings_spec.rb
+- spec/models/validated_trade_body_spec.rb
 - spec/spec_helper.rb
 homepage: https://snaptrade.com/
 licenses:
@@ -572,6 +575,7 @@ test_files:
 - spec/models/account_balance_total_spec.rb
 - spec/models/strategy_order_place_spec.rb
 - spec/models/model_asset_class_target_spec.rb
+- spec/models/validated_trade_body_spec.rb
 - spec/models/option_strategy_spec.rb
 - spec/models/strategy_quotes_spec.rb
 - spec/models/model_asset_class_details_spec.rb