snaptrade 2.0.165 → 2.0.166

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c43da3d7462a69a3748073633401c27d86966de0a9ad26d08df6a0d9e6a67629
-  data.tar.gz: f53b10e5602aff84b922f3d037a164a10dd2a626a97429cb02038886bf69c4f3
+  metadata.gz: 8aa143629fa26cbb52541f1cd1a31499067e0e6fedae392961eacee812eb08ef
+  data.tar.gz: b25bc59d48c3d7792c9dcd05056ba29d1446c305d99ec20935ae497418cb174b
 SHA512:
-  metadata.gz: efcc1995284cbb50446a316a393cb0ec3fd080326ff25a0a07dd3eea5e88c0ab83cac919f4e80dc2e7b5c805d2bc839e6ea8a83d35e7c8daeae7843a5e24ed69
-  data.tar.gz: e7c8cfe1df4d635bfc5839cc37044a8ff61199d4b69828a9758c8a9ed29ff4151fa80e9fcc5093162b66e7c00d5b3960e67d3504581c16b7e1fca8f149115a1e
+  metadata.gz: 45bb7b21ad3c1406712b949aad0908d2948d64703f6c27559e15ac189daafbed8b622260969962fc5793617304362d221d211cc875f84816048eae319a863b54
+  data.tar.gz: 1bd606a59657cdf5e6b0a5c6d6693c94fa66805c4bb3d33e948dfa90d6178151daaf99ca594c58d2d285158cb060ecd62498c4c42edcab8facb297f2c72c3278

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.165)
+    snaptrade (2.0.166)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -55,7 +55,7 @@ GEM
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.7)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)

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.165-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.165)
+[![npm](https://img.shields.io/badge/gem-v2.0.166-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.166)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -37,6 +37,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.authentication.login_snap_trade_user`](#snaptradeauthenticationlogin_snap_trade_user)
   * [`snaptrade.authentication.register_snap_trade_user`](#snaptradeauthenticationregister_snap_trade_user)
   * [`snaptrade.authentication.reset_snap_trade_user_secret`](#snaptradeauthenticationreset_snap_trade_user_secret)
+  * [`snaptrade.connections.delete_connection`](#snaptradeconnectionsdelete_connection)
   * [`snaptrade.connections.detail_brokerage_authorization`](#snaptradeconnectionsdetail_brokerage_authorization)
   * [`snaptrade.connections.disable_brokerage_authorization`](#snaptradeconnectionsdisable_brokerage_authorization)
   * [`snaptrade.connections.list_brokerage_authorizations`](#snaptradeconnectionslist_brokerage_authorizations)
@@ -86,7 +87,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.165'
+gem 'snaptrade', '~> 2.0.166'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -889,6 +890,39 @@ endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
 ---
 
 
+### `snaptrade.connections.delete_connection`<a id="snaptradeconnectionsdelete_connection"></a>
+
+Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.connections.delete_connection(
+  connection_id: "87b24961-b51e-4db8-9226-f198f6518a89",
+  user_id: "snaptrade-user-123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### connection_id: `String`<a id="connection_id-string"></a>
+##### user_id: `String`<a id="user_id-string"></a>
+##### user_secret: `String`<a id="user_secret-string"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[DeleteConnectionConfirmation](./lib/snaptrade/models/delete_connection_confirmation.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/connection/{connectionId}` `DELETE`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.connections.detail_brokerage_authorization`<a id="snaptradeconnectionsdetail_brokerage_authorization"></a>
 
 Returns a single connection for the specified ID.

data/lib/snaptrade/api/connections_api.rb

@@ -17,6 +17,109 @@ module SnapTrade
       @api_client = api_client
     end
 
+    # Delete connection
+    #
+    # Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+    #
+    # @param connection_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def delete_connection(connection_id:, user_id:, user_secret:, extra: {})
+      data, _status_code, _headers = delete_connection_with_http_info_impl(connection_id, user_id, user_secret, extra)
+      data
+    end
+
+    # Delete connection
+    #
+    # Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+    #
+    # @param connection_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def delete_connection_with_http_info(connection_id:, user_id:, user_secret:, extra: {})
+      delete_connection_with_http_info_impl(connection_id, user_id, user_secret, extra)
+    end
+
+    # Delete connection
+    # Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+    # @param connection_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [DeleteConnectionConfirmation]
+    private def delete_connection_impl(connection_id, user_id, user_secret, opts = {})
+      data, _status_code, _headers = delete_connection_with_http_info(connection_id, user_id, user_secret, opts)
+      data
+    end
+
+    # Delete connection
+    # Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+    # @param connection_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DeleteConnectionConfirmation, Integer, Hash)>] DeleteConnectionConfirmation data, response status code and response headers
+    private def delete_connection_with_http_info_impl(connection_id, user_id, user_secret, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConnectionsApi.delete_connection ...'
+      end
+      # verify the required parameter 'connection_id' is set
+      if @api_client.config.client_side_validation && connection_id.nil?
+        fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.delete_connection"
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling ConnectionsApi.delete_connection"
+      end
+      # verify the required parameter 'user_secret' is set
+      if @api_client.config.client_side_validation && user_secret.nil?
+        fail ArgumentError, "Missing the required parameter 'user_secret' when calling ConnectionsApi.delete_connection"
+      end
+      # resource path
+      local_var_path = '/connection/{connectionId}'.sub('{' + 'connectionId' + '}', CGI.escape(connection_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'userId'] = user_id
+      query_params[:'userSecret'] = user_secret
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DeleteConnectionConfirmation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"ConnectionsApi.delete_connection",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers, response = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConnectionsApi#delete_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
     # Get connection detail
     #
     # Returns a single connection for the specified ID.

data/lib/snaptrade/models/delete_connection_confirmation.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
+  # Confirmation that a task has been scheduled to delete the connection.
+  class DeleteConnectionConfirmation
+    # Connection queued for deletion; please wait for webhook for confirmation.
+    attr_accessor :detail
+
+    # The ID of the connection (brokerage authorization) that was scheduled for deletion.
+    attr_accessor :connection_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'detail' => :'detail',
+        :'connection_id' => :'connection_id'
+      }
+    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
+      {
+        :'detail' => :'String',
+        :'connection_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::DeleteConnectionConfirmation` 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::DeleteConnectionConfirmation`. 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?(:'detail')
+        self.detail = attributes[:'detail']
+      end
+
+      if attributes.key?(:'connection_id')
+        self.connection_id = attributes[:'connection_id']
+      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 &&
+          detail == o.detail &&
+          connection_id == o.connection_id
+    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
+      [detail, connection_id].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.165'
+  VERSION = '2.0.166'
 end

data/lib/snaptrade.rb

@@ -71,6 +71,7 @@ require 'snaptrade/models/crypto_trading_instrument_type'
 require 'snaptrade/models/cryptocurrency_pair'
 require 'snaptrade/models/cryptocurrency_pair_quote'
 require 'snaptrade/models/currency'
+require 'snaptrade/models/delete_connection_confirmation'
 require 'snaptrade/models/delete_user_response'
 require 'snaptrade/models/dividend_at_date'
 require 'snaptrade/models/encrypted_response'

data/spec/api/connections_api_spec.rb

@@ -27,6 +27,20 @@ describe 'ConnectionsApi' do
     end
   end
 
+  # unit tests for delete_connection
+  # Delete connection
+  # Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+  # @param connection_id 
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteConnectionConfirmation]
+  describe 'delete_connection 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 detail_brokerage_authorization
   # Get connection detail
   # Returns a single connection for the specified ID.

data/spec/models/delete_connection_confirmation_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::DeleteConnectionConfirmation
+describe SnapTrade::DeleteConnectionConfirmation do
+  let(:instance) { SnapTrade::DeleteConnectionConfirmation.new }
+
+  describe 'test an instance of DeleteConnectionConfirmation' do
+    it 'should create an instance of DeleteConnectionConfirmation' do
+      expect(instance).to be_instance_of(SnapTrade::DeleteConnectionConfirmation)
+    end
+  end
+  describe 'test attribute "detail"' 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_id"' 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.165
+  version: 2.0.166
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-02-27 00:00:00.000000000 Z
+date: 2026-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -151,6 +151,7 @@ files:
 - lib/snaptrade/models/cryptocurrency_pair.rb
 - lib/snaptrade/models/cryptocurrency_pair_quote.rb
 - lib/snaptrade/models/currency.rb
+- lib/snaptrade/models/delete_connection_confirmation.rb
 - lib/snaptrade/models/delete_user_response.rb
 - lib/snaptrade/models/dividend_at_date.rb
 - lib/snaptrade/models/encrypted_response.rb
@@ -329,6 +330,7 @@ files:
 - spec/models/cryptocurrency_pair_quote_spec.rb
 - spec/models/cryptocurrency_pair_spec.rb
 - spec/models/currency_spec.rb
+- spec/models/delete_connection_confirmation_spec.rb
 - spec/models/delete_user_response_spec.rb
 - spec/models/dividend_at_date_spec.rb
 - spec/models/encrypted_response_encrypted_message_data_spec.rb
@@ -630,6 +632,7 @@ test_files:
 - spec/models/crypto_trading_instrument_spec.rb
 - spec/models/symbol_query_spec.rb
 - spec/models/account_order_record_status_spec.rb
+- spec/models/delete_connection_confirmation_spec.rb
 - spec/models/account_spec.rb
 - spec/models/crypto_trading_instrument_type_spec.rb
 - spec/models/session_event_type_spec.rb