snaptrade 2.0.121 → 2.0.123

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c6d68c3bef6d28351d54a9f45678a5cfefc9b9391e9ab251e2a1fde13a1932d
-  data.tar.gz: d6a23c0e07e552ec7a3164b9726b4c9a17519e25adcc6b6cd3fb141ec1ae6c68
+  metadata.gz: af2a719406589ce3ae88123bd403a4102432ac9fbf6d8f7ddfba1665c2d21313
+  data.tar.gz: a98763c429d28648bb302ad1cc67893b697d887872b1d515c503667ad88d8e70
 SHA512:
-  metadata.gz: 70c0c65c30a04eacf60727973d3b3090b28cfac3746b964c9884f64271705e304762d280b7fda101db556548e94a34e8262d17d83a0dc56ea6cc66688f6330b6
-  data.tar.gz: fd1a0091ab72a9e0ee4955fe64d8ae8cc96edc7a03fa2ffdaddf516cf043a901142980dca741929703522ea7ebdc44f4a3bab494819b630a65df65f8136f895c
+  metadata.gz: 128e7f1dbbdcdf568e181816945f7d618e75bb3c07a82cea4eaada86429aefceb427967e6421c900d4f7d2ea2b9feb717d4686d08cbc43f907f726a33928ce19
+  data.tar.gz: be498c45d9af927f2d95b16922622b83fadc01aff31ceab6bbbe373c29302ab8a8d357501cee2e3e12822f07c57ded8f08d448a3b91a674060884d63ea3470a1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.121)
+    snaptrade (2.0.123)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -42,7 +42,7 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.11.0)
+    regexp_parser (2.11.2)
     reline (0.6.2)
       io-console (~> 0.5)
     rexml (3.4.1)
@@ -58,7 +58,7 @@ GEM
     rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.4)
+    rspec-support (3.13.5)
     rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)

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

data/lib/snaptrade/api/trading_api.rb

@@ -965,7 +965,7 @@ module SnapTrade
     end
 
 
-    # Place equity order
+    # Place order
     #
     # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.
     # 
@@ -1004,7 +1004,7 @@ module SnapTrade
       data
     end
 
-    # Place equity order
+    # Place order
     #
     # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.
     # 
@@ -1042,7 +1042,7 @@ module SnapTrade
       place_force_order_with_http_info_impl(user_id, user_secret, manual_trade_form_with_options, extra)
     end
 
-    # Place equity order
+    # Place order
     # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. 
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -1054,7 +1054,7 @@ module SnapTrade
       data
     end
 
-    # Place equity order
+    # Place order
     # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. 
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -1549,7 +1549,7 @@ module SnapTrade
     end
 
 
-    # Replace equity order
+    # Replace order
     #
     # Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling
     # the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one
@@ -1583,7 +1583,7 @@ module SnapTrade
       data
     end
 
-    # Replace equity order
+    # Replace order
     #
     # Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling
     # the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one
@@ -1616,7 +1616,7 @@ module SnapTrade
       replace_order_with_http_info_impl(account_id, user_id, user_secret, manual_trade_replace_form, extra)
     end
 
-    # Replace equity order
+    # Replace order
     # Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages 
     # @param account_id [String] The ID of the account to execute the trade on.
     # @param user_id [String] 
@@ -1629,7 +1629,7 @@ module SnapTrade
       data
     end
 
-    # Replace equity order
+    # Replace order
     # Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages 
     # @param account_id [String] The ID of the account to execute the trade on.
     # @param user_id [String] 

data/lib/snaptrade/models/position.rb

@@ -30,6 +30,8 @@ module SnapTrade
     # Deprecated, use the `units` field for both fractional and integer units going forward
     attr_accessor :fractional_units
 
+    attr_accessor :currency
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -38,7 +40,8 @@ module SnapTrade
         :'price' => :'price',
         :'open_pnl' => :'open_pnl',
         :'average_purchase_price' => :'average_purchase_price',
-        :'fractional_units' => :'fractional_units'
+        :'fractional_units' => :'fractional_units',
+        :'currency' => :'currency'
       }
     end
 
@@ -55,7 +58,8 @@ module SnapTrade
         :'price' => :'Float',
         :'open_pnl' => :'Float',
         :'average_purchase_price' => :'Float',
-        :'fractional_units' => :'Float'
+        :'fractional_units' => :'Float',
+        :'currency' => :'PositionCurrency'
       }
     end
 
@@ -66,7 +70,7 @@ module SnapTrade
         :'price',
         :'open_pnl',
         :'average_purchase_price',
-        :'fractional_units'
+        :'fractional_units',
       ])
     end
 
@@ -108,6 +112,10 @@ module SnapTrade
       if attributes.key?(:'fractional_units')
         self.fractional_units = attributes[:'fractional_units']
       end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -133,7 +141,8 @@ module SnapTrade
           price == o.price &&
           open_pnl == o.open_pnl &&
           average_purchase_price == o.average_purchase_price &&
-          fractional_units == o.fractional_units
+          fractional_units == o.fractional_units &&
+          currency == o.currency
     end
 
     # @see the `==` method
@@ -145,7 +154,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, units, price, open_pnl, average_purchase_price, fractional_units].hash
+      [symbol, units, price, open_pnl, average_purchase_price, fractional_units, currency].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/position_currency.rb

@@ -0,0 +1,245 @@
+=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
+  # The 'position currency' (`price` and `average_purchase_price`). This currency can potentially be different from the 'listing currency' of the security. The 'listing currency' is what's quoted on the listing exchange, while the 'position currency' is what the brokerage uses to hold and value your position. 
+  class PositionCurrency
+    # Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
+    attr_accessor :id
+
+    # The ISO-4217 currency code for the currency.
+    attr_accessor :code
+
+    # A human-friendly name of the currency.
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'code' => :'code',
+        :'name' => :'name'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'code' => :'String',
+        :'name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'Currency'
+      ]
+    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::PositionCurrency` 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::PositionCurrency`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      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 &&
+          id == o.id &&
+          code == o.code &&
+          name == o.name
+    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
+      [id, code, name].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

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

data/lib/snaptrade.rb

@@ -127,6 +127,7 @@ require 'snaptrade/models/partner_data'
 require 'snaptrade/models/past_value'
 require 'snaptrade/models/performance_custom'
 require 'snaptrade/models/position'
+require 'snaptrade/models/position_currency'
 require 'snaptrade/models/position_symbol'
 require 'snaptrade/models/rate_of_return_object'
 require 'snaptrade/models/rate_of_return_response'

data/spec/api/trading_api_spec.rb

@@ -133,7 +133,7 @@ describe 'TradingApi' do
   end
 
   # unit tests for place_force_order
-  # Place equity order
+  # Place order
   # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. 
   # @param user_id 
   # @param user_secret 
@@ -192,7 +192,7 @@ describe 'TradingApi' do
   end
 
   # unit tests for replace_order
-  # Replace equity order
+  # Replace order
   # Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages 
   # @param account_id The ID of the account to execute the trade on.
   # @param user_id 

data/spec/models/position_currency_spec.rb

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

data/spec/models/position_spec.rb

@@ -56,4 +56,10 @@ describe SnapTrade::Position do
     end
   end
 
+  describe 'test attribute "currency"' 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.121
+  version: 2.0.123
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-08-08 00:00:00.000000000 Z
+date: 2025-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -206,6 +206,7 @@ files:
 - lib/snaptrade/models/past_value.rb
 - lib/snaptrade/models/performance_custom.rb
 - lib/snaptrade/models/position.rb
+- lib/snaptrade/models/position_currency.rb
 - lib/snaptrade/models/position_symbol.rb
 - lib/snaptrade/models/rate_of_return_object.rb
 - lib/snaptrade/models/rate_of_return_response.rb
@@ -374,6 +375,7 @@ files:
 - spec/models/partner_data_spec.rb
 - spec/models/past_value_spec.rb
 - spec/models/performance_custom_spec.rb
+- spec/models/position_currency_spec.rb
 - spec/models/position_spec.rb
 - spec/models/position_symbol_spec.rb
 - spec/models/rate_of_return_object_spec.rb
@@ -565,6 +567,7 @@ test_files:
 - spec/models/symbol_query_spec.rb
 - spec/models/order_type_strict_spec.rb
 - spec/models/universal_activity_spec.rb
+- spec/models/position_currency_spec.rb
 - spec/models/mleg_trading_instrument_spec.rb
 - spec/models/timeframe_spec.rb
 - spec/models/cancel_order_response_spec.rb