snaptrade 3.0.2 → 3.0.4

data/lib/snaptrade/models/user_aum_percentile_response_data.rb

@@ -0,0 +1,288 @@
+=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 UserAumPercentileResponseData
+    # The band the user falls into. Deliberately coarse: the underlying totals are only as current as each brokerage's last sync, so an exact percentile would imply more precision than the data supports. 
+    attr_accessor :bucket
+
+    # The percent of the cohort the user's assets are strictly above, 0-100. Integer by design: the distribution is stored as 101 interpolated cutoffs, so a fractional percentile would not mean anything.  Prefer `bucket` for anything you display prominently. The distribution is recomputed monthly, so a user's percentile can move a few points on its own as other users' holdings refresh, while their bucket stays put. Users tied on the same total all receive the lowest percentile that total spans. 
+    attr_accessor :percentile
+
+    # Number of your users the distribution was computed from.
+    attr_accessor :cohort_size
+
+    # The month whose distribution produced this placement.
+    attr_accessor :as_of
+
+    # The currency the distribution was computed in.
+    attr_accessor :currency
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'bucket' => :'bucket',
+        :'percentile' => :'percentile',
+        :'cohort_size' => :'cohort_size',
+        :'as_of' => :'as_of',
+        :'currency' => :'currency'
+      }
+    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
+      {
+        :'bucket' => :'Bucket',
+        :'percentile' => :'Integer',
+        :'cohort_size' => :'Integer',
+        :'as_of' => :'Date',
+        :'currency' => :'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
+      [
+      :'UserAumPercentileObject'
+      ]
+    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::UserAumPercentileResponseData` 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::UserAumPercentileResponseData`. 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?(:'bucket')
+        self.bucket = attributes[:'bucket']
+      end
+
+      if attributes.key?(:'percentile')
+        self.percentile = attributes[:'percentile']
+      end
+
+      if attributes.key?(:'cohort_size')
+        self.cohort_size = attributes[:'cohort_size']
+      end
+
+      if attributes.key?(:'as_of')
+        self.as_of = attributes[:'as_of']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      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 !@percentile.nil? && @percentile > 100
+        invalid_properties.push('invalid value for "percentile", must be smaller than or equal to 100.')
+      end
+
+      if !@percentile.nil? && @percentile < 0
+        invalid_properties.push('invalid value for "percentile", must be greater than or equal to 0.')
+      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 !@percentile.nil? && @percentile > 100
+      return false if !@percentile.nil? && @percentile < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] percentile Value to be assigned
+    def percentile=(percentile)
+      if !percentile.nil? && percentile > 100
+        fail ArgumentError, 'invalid value for "percentile", must be smaller than or equal to 100.'
+      end
+
+      if !percentile.nil? && percentile < 0
+        fail ArgumentError, 'invalid value for "percentile", must be greater than or equal to 0.'
+      end
+
+      @percentile = percentile
+    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 &&
+          bucket == o.bucket &&
+          percentile == o.percentile &&
+          cohort_size == o.cohort_size &&
+          as_of == o.as_of &&
+          currency == o.currency
+    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
+      [bucket, percentile, cohort_size, as_of, currency].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 = '3.0.2'
+  VERSION = '3.0.4'
 end

data/lib/snaptrade.rb

@@ -68,6 +68,7 @@ require 'snaptrade/models/brokerage_authorization_type_read_only_type'
 require 'snaptrade/models/brokerage_instrument'
 require 'snaptrade/models/brokerage_instruments_response'
 require 'snaptrade/models/brokerage_type'
+require 'snaptrade/models/bucket'
 require 'snaptrade/models/cancel_order_response'
 require 'snaptrade/models/cash_change_direction'
 require 'snaptrade/models/cef_instrument'
@@ -236,6 +237,9 @@ require 'snaptrade/models/underlying_symbol_exchange'
 require 'snaptrade/models/underlying_symbol_type'
 require 'snaptrade/models/universal_activity'
 require 'snaptrade/models/universal_symbol'
+require 'snaptrade/models/user_aum_percentile_object'
+require 'snaptrade/models/user_aum_percentile_response'
+require 'snaptrade/models/user_aum_percentile_response_data'
 require 'snaptrade/models/user_i_dand_secret'
 require 'snaptrade/models/validated_trade_body'
 

data/spec/api/account_information_api_spec.rb

@@ -163,6 +163,19 @@ describe 'AccountInformationApi' do
     end
   end
 
+  # unit tests for get_user_aum_percentile
+  # Get the user's AUM percentile
+  # Returns where the user's total assets sit within the distribution of a cohort of comparable users, as a coarse bucket plus an integer percentile.  The cohort is scoped to your own book: a user is only ever compared against your other users, never across SnapTrade customers. (Users on personal-use keys are the exception — they are compared against all other personal-use users, since a personal key has a single user and cannot form a distribution of its own.) The distribution is recomputed monthly, and `as_of` reports which month's distribution the placement came from.  `data` is `null` — a 200, not an error — when SnapTrade declines to place the user. That happens when the cohort is too small to publish a distribution, or when the user's own holdings are incomplete or stale (for example they hold a disabled connection). A placement computed from a partial view of a user's assets would understate them, so none is returned. 
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @return [UserAumPercentileResponse]
+  describe 'get_user_aum_percentile test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_user_holdings
   # List account holdings
   # **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).  This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.  Returns a list of balances, positions, and recent orders for the specified account.  Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:   - If you do, this endpoint returns real-time data.   - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.  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. 

data/spec/models/bucket_spec.rb

@@ -0,0 +1,23 @@
+=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::Bucket
+describe SnapTrade::Bucket do
+  let(:instance) { SnapTrade::Bucket.new }
+
+  describe 'test an instance of Bucket' do
+    it 'should create an instance of Bucket' do
+      expect(instance).to be_instance_of(SnapTrade::Bucket)
+    end
+  end
+end

data/spec/models/snap_trade_login_user_request_body_spec.rb

@@ -62,6 +62,12 @@ describe SnapTrade::SnapTradeLoginUserRequestBody do
     end
   end
 
+  describe 'test attribute "locale"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "connection_portal_version"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/user_aum_percentile_object_spec.rb

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

data/spec/models/user_aum_percentile_response_data_spec.rb

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

data/spec/models/user_aum_percentile_response_spec.rb

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