snaptrade 2.0.26 → 2.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f02b2217951a3d74e760540092af444a44f291d8318004701f0c6599b8035c9
-  data.tar.gz: d3d184ef83654c23e494d33f5a9e4117a8894acc3d169221917beee56e418305
+  metadata.gz: 2fe92620a58d056da38b520075900fca5e87dba39e7672055d1dc2c3b4397615
+  data.tar.gz: ca4859a220b98ede43621daaa2fe68d957abe9c082b13c08b69d1b208e86382b
 SHA512:
-  metadata.gz: 79bf35d54c567ac3d10cc5976fb1e59d446ea9e7c589f3a613abdb486605544feca1d22ab769cd9253eac9cde711f20d3943ba007ad5b0582e8515f49499fe67
-  data.tar.gz: d2d863e7c308480c36c0dfe5b1801c85e39a6a967ed1f0221fd2e485fdc52a94bb1dbc8705e03fa921ebe417035ff8d77a9288cc5a636908687e83342db28045
+  metadata.gz: 34e441cc2e218a54300ccbce4e4c4259f75fe4d134cc2f3b0cd7f4bdb8d5ab507ca1c6886fcb248883cbd8d6e321efb78d900099056279747c2a11a35e0e6bab
+  data.tar.gz: 5197c3ad9f01759083ae79c142a96383dfa3e20dbcd052efea58c260e9e7f5797436576c86dcf784e20d9668c02ff203c9896e03509152abdda192f46dd72987

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.25)
+    snaptrade (2.0.27)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

data/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/gem-v2.0.26-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.26)
+[![npm](https://img.shields.io/badge/gem-v2.0.28-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.28)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -71,7 +71,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.26'
+gem 'snaptrade', '~> 2.0.28'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -606,8 +606,8 @@ immutable.
 
 ### `snaptrade.authentication.reset_snap_trade_user_secret`<a id="snaptradeauthenticationreset_snap_trade_user_secret"></a>
 
-This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret
-is comprimised or lost among other reasons.
+This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret
+is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -629,9 +629,8 @@ NOT use email addresses for this property because they are usually not
 immutable.
 
 ##### userSecret: `String`<a id="usersecret-string"></a>
-SnapTrade User Secret randomly generated by SnapTrade. This should be considered
-priviledged information and if compromised, you should delete and re-create this
-SnapTrade user.
+SnapTrade User Secret randomly generated by SnapTrade. This is privileged
+information and if compromised, should be rotated via the SnapTrade API.
 
 #### 🔄 Return<a id="🔄-return"></a>
 

data/lib/snaptrade/api/authentication_api.rb

@@ -511,11 +511,11 @@ module SnapTrade
 
     # Obtain a new user secret for a user
     #
-    # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret
-    # is comprimised or lost among other reasons.
+    # This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret
+    # is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
     #
     # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
-    # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.
+    # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the SnapTrade API.
     # @param body [UserIDandSecret] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def reset_snap_trade_user_secret(user_id: SENTINEL, user_secret: SENTINEL, extra: {})
@@ -529,11 +529,11 @@ module SnapTrade
 
     # Obtain a new user secret for a user
     #
-    # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret
-    # is comprimised or lost among other reasons.
+    # This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret
+    # is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
     #
     # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
-    # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.
+    # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the SnapTrade API.
     # @param body [UserIDandSecret] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def reset_snap_trade_user_secret_with_http_info(user_id: SENTINEL, user_secret: SENTINEL, extra: {})
@@ -545,7 +545,7 @@ module SnapTrade
     end
 
     # Obtain a new user secret for a user
-    # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret is comprimised or lost among other reasons. 
+    # This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect. 
     # @param user_i_dand_secret [UserIDandSecret] 
     # @param [Hash] opts the optional parameters
     # @return [UserIDandSecret]
@@ -555,7 +555,7 @@ module SnapTrade
     end
 
     # Obtain a new user secret for a user
-    # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret is comprimised or lost among other reasons. 
+    # This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect. 
     # @param user_i_dand_secret [UserIDandSecret] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers

data/lib/snaptrade/models/account_sync_status.rb

@@ -15,10 +15,13 @@ module SnapTrade
   class AccountSyncStatus
     attr_accessor :transactions
 
+    attr_accessor :holdings
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'transactions' => :'transactions'
+        :'transactions' => :'transactions',
+        :'holdings' => :'holdings'
       }
     end
 
@@ -30,7 +33,8 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'transactions' => :'TransactionsStatus'
+        :'transactions' => :'TransactionsStatus',
+        :'holdings' => :'HoldingsStatus'
       }
     end
 
@@ -58,6 +62,10 @@ module SnapTrade
       if attributes.key?(:'transactions')
         self.transactions = attributes[:'transactions']
       end
+
+      if attributes.key?(:'holdings')
+        self.holdings = attributes[:'holdings']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -78,7 +86,8 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          transactions == o.transactions
+          transactions == o.transactions &&
+          holdings == o.holdings
     end
 
     # @see the `==` method
@@ -90,7 +99,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [transactions].hash
+      [transactions, holdings].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/holdings_status.rb

@@ -0,0 +1,228 @@
+=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
+  # Status of account holdings sync
+  class HoldingsStatus
+    attr_accessor :initial_sync_completed
+
+    # Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
+    attr_accessor :last_successful_sync
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'initial_sync_completed' => :'initial_sync_completed',
+        :'last_successful_sync' => :'last_successful_sync'
+      }
+    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
+      {
+        :'initial_sync_completed' => :'Boolean',
+        :'last_successful_sync' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'last_successful_sync'
+      ])
+    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::HoldingsStatus` 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::HoldingsStatus`. 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?(:'initial_sync_completed')
+        self.initial_sync_completed = attributes[:'initial_sync_completed']
+      end
+
+      if attributes.key?(:'last_successful_sync')
+        self.last_successful_sync = attributes[:'last_successful_sync']
+      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 &&
+          initial_sync_completed == o.initial_sync_completed &&
+          last_successful_sync == o.last_successful_sync
+    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
+      [initial_sync_completed, last_successful_sync].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/transactions_status.rb

@@ -18,11 +18,15 @@ module SnapTrade
     # Date in YYYY-MM-DD format or null
     attr_accessor :last_successful_sync
 
+    # Date in YYYY-MM-DD format or null
+    attr_accessor :first_transaction_date
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'initial_sync_completed' => :'initial_sync_completed',
-        :'last_successful_sync' => :'last_successful_sync'
+        :'last_successful_sync' => :'last_successful_sync',
+        :'first_transaction_date' => :'first_transaction_date'
       }
     end
 
@@ -35,14 +39,16 @@ module SnapTrade
     def self.openapi_types
       {
         :'initial_sync_completed' => :'Boolean',
-        :'last_successful_sync' => :'Date'
+        :'last_successful_sync' => :'Date',
+        :'first_transaction_date' => :'Date'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'last_successful_sync'
+        :'last_successful_sync',
+        :'first_transaction_date'
       ])
     end
 
@@ -68,6 +74,10 @@ module SnapTrade
       if attributes.key?(:'last_successful_sync')
         self.last_successful_sync = attributes[:'last_successful_sync']
       end
+
+      if attributes.key?(:'first_transaction_date')
+        self.first_transaction_date = attributes[:'first_transaction_date']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -89,7 +99,8 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           initial_sync_completed == o.initial_sync_completed &&
-          last_successful_sync == o.last_successful_sync
+          last_successful_sync == o.last_successful_sync &&
+          first_transaction_date == o.first_transaction_date
     end
 
     # @see the `==` method
@@ -101,7 +112,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [initial_sync_completed, last_successful_sync].hash
+      [initial_sync_completed, last_successful_sync, first_transaction_date].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/user_i_dand_secret.rb

@@ -16,7 +16,7 @@ module SnapTrade
     # SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     attr_accessor :user_id
 
-    # SnapTrade User Secret randomly generated by SnapTrade. This should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.
+    # SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the SnapTrade API.
     attr_accessor :user_secret
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/version.rb

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

data/lib/snaptrade.rb

@@ -57,6 +57,7 @@ require 'snaptrade/models/exchange'
 require 'snaptrade/models/exchange_rate_pairs'
 require 'snaptrade/models/excluded_asset'
 require 'snaptrade/models/figi_instrument'
+require 'snaptrade/models/holdings_status'
 require 'snaptrade/models/jwt'
 require 'snaptrade/models/login_redirect_uri'
 require 'snaptrade/models/manual_trade'

data/spec/api/authentication_api_spec.rb

@@ -91,7 +91,7 @@ describe 'AuthenticationApi' do
 
   # unit tests for reset_snap_trade_user_secret
   # Obtain a new user secret for a user
-  # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret is comprimised or lost among other reasons. 
+  # This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect. 
   # @param user_i_dand_secret 
   # @param [Hash] opts the optional parameters
   # @return [UserIDandSecret]

data/spec/models/account_sync_status_spec.rb

@@ -26,4 +26,10 @@ describe SnapTrade::AccountSyncStatus do
     end
   end
 
+  describe 'test attribute "holdings"' 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/holdings_status_spec.rb

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

@@ -32,4 +32,10 @@ describe SnapTrade::TransactionsStatus do
     end
   end
 
+  describe 'test attribute "first_transaction_date"' 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.26
+  version: 2.0.28
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-27 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,6 +136,7 @@ files:
 - lib/snaptrade/models/exchange_rate_pairs.rb
 - lib/snaptrade/models/excluded_asset.rb
 - lib/snaptrade/models/figi_instrument.rb
+- lib/snaptrade/models/holdings_status.rb
 - lib/snaptrade/models/jwt.rb
 - lib/snaptrade/models/login_redirect_uri.rb
 - lib/snaptrade/models/manual_trade.rb
@@ -289,6 +290,7 @@ files:
 - spec/models/exchange_spec.rb
 - spec/models/excluded_asset_spec.rb
 - spec/models/figi_instrument_spec.rb
+- spec/models/holdings_status_spec.rb
 - spec/models/jwt_spec.rb
 - spec/models/login_redirect_uri_spec.rb
 - spec/models/manual_trade_and_impact_spec.rb
@@ -464,6 +466,7 @@ test_files:
 - spec/models/model500_unexpected_exception_response_spec.rb
 - spec/models/brokerage_authorization_type_read_only_type_spec.rb
 - spec/models/manual_trade_symbol_spec.rb
+- spec/models/holdings_status_spec.rb
 - spec/models/position_spec.rb
 - spec/models/notional_value_spec.rb
 - spec/models/trade_action_spec.rb