snaptrade 1.17.10 → 2.0.77

data/lib/snaptrade/api/connections_api.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'cgi'
@@ -18,8 +17,11 @@ module SnapTrade
       @api_client = api_client
     end
 
-    # Get brokerage authorization details
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # Get connection detail
+    #
+    # Returns a single connection for the specified ID.
+    #
+    # @param authorization_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
@@ -28,8 +30,11 @@ module SnapTrade
       data
     end
 
-    # Get brokerage authorization details
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # Get connection detail
+    #
+    # Returns a single connection for the specified ID.
+    #
+    # @param authorization_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
@@ -37,24 +42,26 @@ module SnapTrade
       detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
     end
 
-    # Get brokerage authorization details
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # Get connection detail
+    # Returns a single connection for the specified ID.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [BrokerageAuthorization]
-    def detail_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
+    private def detail_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
       data, _status_code, _headers = detail_brokerage_authorization_with_http_info(authorization_id, user_id, user_secret, opts)
       data
     end
 
-    # Get brokerage authorization details
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # Get connection detail
+    # Returns a single connection for the specified ID.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(BrokerageAuthorization, Integer, Hash)>] BrokerageAuthorization data, response status code and response headers
-    def detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
+    private def detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConnectionsApi.detail_brokerage_authorization ...'
       end
@@ -113,7 +120,123 @@ module SnapTrade
     end
 
 
-    # List all brokerage authorizations for the user
+    # Force disable connection
+    #
+    # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections.
+    # Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.
+    # 
+    # *Please contact us in order to use this endpoint as it is disabled by default.*
+    #
+    # @param authorization_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 disable_brokerage_authorization(authorization_id:, user_id:, user_secret:, extra: {})
+      data, _status_code, _headers = disable_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
+      data
+    end
+
+    # Force disable connection
+    #
+    # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections.
+    # Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.
+    # 
+    # *Please contact us in order to use this endpoint as it is disabled by default.*
+    #
+    # @param authorization_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 disable_brokerage_authorization_with_http_info(authorization_id:, user_id:, user_secret:, extra: {})
+      disable_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
+    end
+
+    # Force disable connection
+    # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.* 
+    # @param authorization_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [BrokerageAuthorizationDisabledConfirmation]
+    private def disable_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
+      data, _status_code, _headers = disable_brokerage_authorization_with_http_info(authorization_id, user_id, user_secret, opts)
+      data
+    end
+
+    # Force disable connection
+    # Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [&#x60;CONNECTION_BROKEN&#x60; webhook](/docs/webhooks#webhooks-connection_broken) for the connection.  *Please contact us in order to use this endpoint as it is disabled by default.* 
+    # @param authorization_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BrokerageAuthorizationDisabledConfirmation, Integer, Hash)>] BrokerageAuthorizationDisabledConfirmation data, response status code and response headers
+    private def disable_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConnectionsApi.disable_brokerage_authorization ...'
+      end
+      # verify the required parameter 'authorization_id' is set
+      if @api_client.config.client_side_validation && authorization_id.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization_id' when calling ConnectionsApi.disable_brokerage_authorization"
+      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.disable_brokerage_authorization"
+      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.disable_brokerage_authorization"
+      end
+      # resource path
+      local_var_path = '/authorizations/{authorizationId}/disable'.sub('{' + 'authorizationId' + '}', CGI.escape(authorization_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] || 'BrokerageAuthorizationDisabledConfirmation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"ConnectionsApi.disable_brokerage_authorization",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConnectionsApi#disable_brokerage_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
+    # List all connections
+    #
+    # Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.
+    # 
+    # A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.
+    # 
+    # SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -122,7 +245,14 @@ module SnapTrade
       data
     end
 
-    # List all brokerage authorizations for the user
+    # List all connections
+    #
+    # Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.
+    # 
+    # A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.
+    # 
+    # SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -130,22 +260,24 @@ module SnapTrade
       list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, extra)
     end
 
-    # List all brokerage authorizations for the user
+    # List all connections
+    # Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<BrokerageAuthorization>]
-    def list_brokerage_authorizations_impl(user_id, user_secret, opts = {})
+    private def list_brokerage_authorizations_impl(user_id, user_secret, opts = {})
       data, _status_code, _headers = list_brokerage_authorizations_with_http_info(user_id, user_secret, opts)
       data
     end
 
-    # List all brokerage authorizations for the user
+    # List all connections
+    # Returns a list of all connections for the specified user. Note that &#x60;Connection&#x60; and &#x60;Brokerage Authorization&#x60; are interchangeable, but the term &#x60;Connection&#x60; is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<BrokerageAuthorization>, Integer, Hash)>] Array<BrokerageAuthorization> data, response status code and response headers
-    def list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, opts = {})
+    private def list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConnectionsApi.list_brokerage_authorizations ...'
       end
@@ -200,8 +332,120 @@ module SnapTrade
     end
 
 
-    # Delete brokerage authorization
-    # @param authorization_id [String] The ID of the Authorization to delete.
+    # Refresh holdings for a connection
+    #
+    # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
+    # This endpoint will also trigger a transaction sync for the past day if one has not yet occured.
+    # 
+    # *Please contact support for access as this endpoint is not enabled by default.*
+    #
+    # @param authorization_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 refresh_brokerage_authorization(authorization_id:, user_id:, user_secret:, extra: {})
+      data, _status_code, _headers = refresh_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
+      data
+    end
+
+    # Refresh holdings for a connection
+    #
+    # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
+    # This endpoint will also trigger a transaction sync for the past day if one has not yet occured.
+    # 
+    # *Please contact support for access as this endpoint is not enabled by default.*
+    #
+    # @param authorization_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 refresh_brokerage_authorization_with_http_info(authorization_id:, user_id:, user_secret:, extra: {})
+      refresh_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
+    end
+
+    # Refresh holdings for a connection
+    # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured.  *Please contact support for access as this endpoint is not enabled by default.* 
+    # @param authorization_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [BrokerageAuthorizationRefreshConfirmation]
+    private def refresh_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
+      data, _status_code, _headers = refresh_brokerage_authorization_with_http_info(authorization_id, user_id, user_secret, opts)
+      data
+    end
+
+    # Refresh holdings for a connection
+    # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [&#x60;ACCOUNT_HOLDINGS_UPDATED&#x60; webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured.  *Please contact support for access as this endpoint is not enabled by default.* 
+    # @param authorization_id [String] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BrokerageAuthorizationRefreshConfirmation, Integer, Hash)>] BrokerageAuthorizationRefreshConfirmation data, response status code and response headers
+    private def refresh_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConnectionsApi.refresh_brokerage_authorization ...'
+      end
+      # verify the required parameter 'authorization_id' is set
+      if @api_client.config.client_side_validation && authorization_id.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization_id' when calling ConnectionsApi.refresh_brokerage_authorization"
+      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.refresh_brokerage_authorization"
+      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.refresh_brokerage_authorization"
+      end
+      # resource path
+      local_var_path = '/authorizations/{authorizationId}/refresh'.sub('{' + 'authorizationId' + '}', CGI.escape(authorization_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] || 'BrokerageAuthorizationRefreshConfirmation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"ConnectionsApi.refresh_brokerage_authorization",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConnectionsApi#refresh_brokerage_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
+    # Delete connection
+    #
+    # Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+    #
+    # @param authorization_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
@@ -210,8 +454,11 @@ module SnapTrade
       nil
     end
 
-    # Delete brokerage authorization
-    # @param authorization_id [String] The ID of the Authorization to delete.
+    # Delete connection
+    #
+    # Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+    #
+    # @param authorization_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
@@ -219,24 +466,26 @@ module SnapTrade
       remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
     end
 
-    # Delete brokerage authorization
-    # @param authorization_id [String] The ID of the Authorization to delete.
+    # Delete connection
+    # Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def remove_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
+    private def remove_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
       remove_brokerage_authorization_with_http_info(authorization_id, user_id, user_secret, opts)
       nil
     end
 
-    # Delete brokerage authorization
-    # @param authorization_id [String] The ID of the Authorization to delete.
+    # Delete connection
+    # Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
+    private def remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConnectionsApi.remove_brokerage_authorization ...'
       end
@@ -293,10 +542,116 @@ module SnapTrade
     end
 
 
-    # List all session events for the partner
+    # List connection rate of returns
+    #
+    # Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example "ALL", "1Y", "6M", "3M", "1M"
+    #
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param authorization_id [String] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def return_rates(user_id:, user_secret:, authorization_id:, extra: {})
+      data, _status_code, _headers = return_rates_with_http_info_impl(user_id, user_secret, authorization_id, extra)
+      data
+    end
+
+    # List connection rate of returns
+    #
+    # Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example "ALL", "1Y", "6M", "3M", "1M"
+    #
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param authorization_id [String] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def return_rates_with_http_info(user_id:, user_secret:, authorization_id:, extra: {})
+      return_rates_with_http_info_impl(user_id, user_secret, authorization_id, extra)
+    end
+
+    # List connection rate of returns
+    # Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example \"ALL\", \"1Y\", \"6M\", \"3M\", \"1M\" 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param authorization_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [RateOfReturnResponse]
+    private def return_rates_impl(user_id, user_secret, authorization_id, opts = {})
+      data, _status_code, _headers = return_rates_with_http_info(user_id, user_secret, authorization_id, opts)
+      data
+    end
+
+    # List connection rate of returns
+    # Returns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example \&quot;ALL\&quot;, \&quot;1Y\&quot;, \&quot;6M\&quot;, \&quot;3M\&quot;, \&quot;1M\&quot; 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param authorization_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RateOfReturnResponse, Integer, Hash)>] RateOfReturnResponse data, response status code and response headers
+    private def return_rates_with_http_info_impl(user_id, user_secret, authorization_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConnectionsApi.return_rates ...'
+      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.return_rates"
+      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.return_rates"
+      end
+      # verify the required parameter 'authorization_id' is set
+      if @api_client.config.client_side_validation && authorization_id.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization_id' when calling ConnectionsApi.return_rates"
+      end
+      # resource path
+      local_var_path = '/authorizations/{authorizationId}/returnRates'.sub('{' + 'authorizationId' + '}', CGI.escape(authorization_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] || 'RateOfReturnResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"ConnectionsApi.return_rates",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConnectionsApi#return_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
+    # Get all session events for a user
+    #
+    # Returns a list of session events associated with a user.
+    #
     # @param partner_client_id [String] 
-    # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
-    # @param session_id [String] Optional comma seperated list of session IDs used to filter the request on specific users
+    # @param user_id [String] Optional comma separated list of user IDs used to filter the request on specific users
+    # @param session_id [String] Optional comma separated list of session IDs used to filter the request on specific users
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def session_events(partner_client_id:, user_id: SENTINEL, session_id: SENTINEL, extra: {})
       extra[:user_id] = user_id if user_id != SENTINEL
@@ -305,10 +660,13 @@ module SnapTrade
       data
     end
 
-    # List all session events for the partner
+    # Get all session events for a user
+    #
+    # Returns a list of session events associated with a user.
+    #
     # @param partner_client_id [String] 
-    # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
-    # @param session_id [String] Optional comma seperated list of session IDs used to filter the request on specific users
+    # @param user_id [String] Optional comma separated list of user IDs used to filter the request on specific users
+    # @param session_id [String] Optional comma separated list of session IDs used to filter the request on specific users
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def session_events_with_http_info(partner_client_id:, user_id: SENTINEL, session_id: SENTINEL, extra: {})
       extra[:user_id] = user_id if user_id != SENTINEL
@@ -316,24 +674,26 @@ module SnapTrade
       session_events_with_http_info_impl(partner_client_id, extra)
     end
 
-    # List all session events for the partner
+    # Get all session events for a user
+    # Returns a list of session events associated with a user.
     # @param partner_client_id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
-    # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
+    # @option opts [String] :user_id Optional comma separated list of user IDs used to filter the request on specific users
+    # @option opts [String] :session_id Optional comma separated list of session IDs used to filter the request on specific users
     # @return [Array<ConnectionsSessionEvents200ResponseInner>]
-    def session_events_impl(partner_client_id, opts = {})
+    private def session_events_impl(partner_client_id, opts = {})
       data, _status_code, _headers = session_events_with_http_info(partner_client_id, opts)
       data
     end
 
-    # List all session events for the partner
+    # Get all session events for a user
+    # Returns a list of session events associated with a user.
     # @param partner_client_id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
-    # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
+    # @option opts [String] :user_id Optional comma separated list of user IDs used to filter the request on specific users
+    # @option opts [String] :session_id Optional comma separated list of session IDs used to filter the request on specific users
     # @return [Array<(Array<ConnectionsSessionEvents200ResponseInner>, Integer, Hash)>] Array<ConnectionsSessionEvents200ResponseInner> data, response status code and response headers
-    def session_events_with_http_info_impl(partner_client_id, opts = {})
+    private def session_events_with_http_info_impl(partner_client_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConnectionsApi.session_events ...'
       end