snaptrade 3.0.33 → 3.0.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -239,129 +239,6 @@ module SnapTrade
239
239
  end
240
240
 
241
241
 
242
- # Get account details
243
- #
244
- # Experimental and subject to change without notice.
245
- #
246
- # Returns the specified account for the authenticated user, using the `kind`-discriminated account shape. Use the `kind` discriminator to determine the shape of the account, which can be an investment, deposit, or line of credit account.
247
- #
248
- # On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
249
- #
250
- # On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
251
- #
252
- # Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
253
- #
254
- # If the connection has become disabled, it can no longer access the latest data from the institution, 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.
255
- #
256
- # @param user_id [String]
257
- # @param user_secret [String]
258
- # @param account_id [String]
259
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
260
- def get_account_details(user_id:, user_secret:, account_id:, extra: {})
261
- data, _status_code, _headers = get_account_details_with_http_info_impl(user_id, user_secret, account_id, extra)
262
- data
263
- end
264
-
265
- # Get account details
266
- #
267
- # Experimental and subject to change without notice.
268
- #
269
- # Returns the specified account for the authenticated user, using the `kind`-discriminated account shape. Use the `kind` discriminator to determine the shape of the account, which can be an investment, deposit, or line of credit account.
270
- #
271
- # On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
272
- #
273
- # On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
274
- #
275
- # Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
276
- #
277
- # If the connection has become disabled, it can no longer access the latest data from the institution, 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.
278
- #
279
- # @param user_id [String]
280
- # @param user_secret [String]
281
- # @param account_id [String]
282
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
283
- def get_account_details_with_http_info(user_id:, user_secret:, account_id:, extra: {})
284
- get_account_details_with_http_info_impl(user_id, user_secret, account_id, extra)
285
- end
286
-
287
- # Get account details
288
- # Experimental and subject to change without notice. Returns the specified account for the authenticated user, using the `kind`-discriminated account shape. Use the `kind` discriminator to determine the shape of the account, which can be an investment, deposit, or line of credit account. On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. If the connection has become disabled, it can no longer access the latest data from the institution, 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.
289
- # @param user_id [String]
290
- # @param user_secret [String]
291
- # @param account_id [String]
292
- # @param [Hash] opts the optional parameters
293
- # @return [ConnectionAccount]
294
- private def get_account_details_impl(user_id, user_secret, account_id, opts = {})
295
- data, _status_code, _headers = get_account_details_with_http_info(user_id, user_secret, account_id, opts)
296
- data
297
- end
298
-
299
- # Get account details
300
- # Experimental and subject to change without notice. Returns the specified account for the authenticated user, using the `kind`-discriminated account shape. Use the `kind` discriminator to determine the shape of the account, which can be an investment, deposit, or line of credit account. On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. If the connection has become disabled, it can no longer access the latest data from the institution, 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.
301
- # @param user_id [String]
302
- # @param user_secret [String]
303
- # @param account_id [String]
304
- # @param [Hash] opts the optional parameters
305
- # @return [Array<(ConnectionAccount, Integer, Hash)>] ConnectionAccount data, response status code and response headers
306
- private def get_account_details_with_http_info_impl(user_id, user_secret, account_id, opts = {})
307
- if @api_client.config.debugging
308
- @api_client.config.logger.debug 'Calling API: ExperimentalEndpointsApi.get_account_details ...'
309
- end
310
- # verify the required parameter 'user_id' is set
311
- if @api_client.config.client_side_validation && user_id.nil?
312
- fail ArgumentError, "Missing the required parameter 'user_id' when calling ExperimentalEndpointsApi.get_account_details"
313
- end
314
- # verify the required parameter 'user_secret' is set
315
- if @api_client.config.client_side_validation && user_secret.nil?
316
- fail ArgumentError, "Missing the required parameter 'user_secret' when calling ExperimentalEndpointsApi.get_account_details"
317
- end
318
- # verify the required parameter 'account_id' is set
319
- if @api_client.config.client_side_validation && account_id.nil?
320
- fail ArgumentError, "Missing the required parameter 'account_id' when calling ExperimentalEndpointsApi.get_account_details"
321
- end
322
- # resource path
323
- local_var_path = '/accounts/{accountId}/details'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
324
-
325
- # query parameters
326
- query_params = opts[:query_params] || {}
327
- query_params[:'userId'] = user_id
328
- query_params[:'userSecret'] = user_secret
329
-
330
- # header parameters
331
- header_params = opts[:header_params] || {}
332
- # HTTP header 'Accept' (if needed)
333
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
334
-
335
- # form parameters
336
- form_params = opts[:form_params] || {}
337
-
338
- # http body (model)
339
- post_body = opts[:debug_body]
340
-
341
- # return_type
342
- return_type = opts[:debug_return_type] || 'ConnectionAccount'
343
-
344
- # auth_names
345
- auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
346
-
347
- new_options = opts.merge(
348
- :operation => :"ExperimentalEndpointsApi.get_account_details",
349
- :header_params => header_params,
350
- :query_params => query_params,
351
- :form_params => form_params,
352
- :body => post_body,
353
- :auth_names => auth_names,
354
- :return_type => return_type
355
- )
356
-
357
- data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
358
- if @api_client.config.debugging
359
- @api_client.config.logger.debug "API called: ExperimentalEndpointsApi#get_account_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
360
- end
361
- return data, status_code, headers, response
362
- end
363
-
364
-
365
242
  # Get account order detail (V2)
366
243
  #
367
244
  # Returns the detail of a single order using the brokerage order ID provided as a path parameter.
@@ -742,113 +619,6 @@ module SnapTrade
742
619
  end
743
620
 
744
621
 
745
- # List all user accounts
746
- #
747
- # Experimental and subject to change without notice.
748
- #
749
- # Returns all accounts across all connections known to SnapTrade for the authenticated user.
750
- #
751
- # The `results` list can contain multiple account kinds in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the shape for each account.
752
- #
753
- # This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
754
- #
755
- # @param user_id [String]
756
- # @param user_secret [String]
757
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
758
- def list_all_user_accounts(user_id:, user_secret:, extra: {})
759
- data, _status_code, _headers = list_all_user_accounts_with_http_info_impl(user_id, user_secret, extra)
760
- data
761
- end
762
-
763
- # List all user accounts
764
- #
765
- # Experimental and subject to change without notice.
766
- #
767
- # Returns all accounts across all connections known to SnapTrade for the authenticated user.
768
- #
769
- # The `results` list can contain multiple account kinds in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the shape for each account.
770
- #
771
- # This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
772
- #
773
- # @param user_id [String]
774
- # @param user_secret [String]
775
- # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
776
- def list_all_user_accounts_with_http_info(user_id:, user_secret:, extra: {})
777
- list_all_user_accounts_with_http_info_impl(user_id, user_secret, extra)
778
- end
779
-
780
- # List all user accounts
781
- # Experimental and subject to change without notice. Returns all accounts across all connections known to SnapTrade for the authenticated user. The `results` list can contain multiple account kinds in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the shape for each account. This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
782
- # @param user_id [String]
783
- # @param user_secret [String]
784
- # @param [Hash] opts the optional parameters
785
- # @return [AllUserAccountsResponse]
786
- private def list_all_user_accounts_impl(user_id, user_secret, opts = {})
787
- data, _status_code, _headers = list_all_user_accounts_with_http_info(user_id, user_secret, opts)
788
- data
789
- end
790
-
791
- # List all user accounts
792
- # Experimental and subject to change without notice. Returns all accounts across all connections known to SnapTrade for the authenticated user. The &#x60;results&#x60; list can contain multiple account kinds in the same response, including investment, deposit, and line of credit accounts. Use the &#x60;kind&#x60; discriminator to determine the shape for each account. This endpoint returns Daily data regardless of the customer&#39;s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user&#39;s connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
793
- # @param user_id [String]
794
- # @param user_secret [String]
795
- # @param [Hash] opts the optional parameters
796
- # @return [Array<(AllUserAccountsResponse, Integer, Hash)>] AllUserAccountsResponse data, response status code and response headers
797
- private def list_all_user_accounts_with_http_info_impl(user_id, user_secret, opts = {})
798
- if @api_client.config.debugging
799
- @api_client.config.logger.debug 'Calling API: ExperimentalEndpointsApi.list_all_user_accounts ...'
800
- end
801
- # verify the required parameter 'user_id' is set
802
- if @api_client.config.client_side_validation && user_id.nil?
803
- fail ArgumentError, "Missing the required parameter 'user_id' when calling ExperimentalEndpointsApi.list_all_user_accounts"
804
- end
805
- # verify the required parameter 'user_secret' is set
806
- if @api_client.config.client_side_validation && user_secret.nil?
807
- fail ArgumentError, "Missing the required parameter 'user_secret' when calling ExperimentalEndpointsApi.list_all_user_accounts"
808
- end
809
- # resource path
810
- local_var_path = '/accounts/all'
811
-
812
- # query parameters
813
- query_params = opts[:query_params] || {}
814
- query_params[:'userId'] = user_id
815
- query_params[:'userSecret'] = user_secret
816
-
817
- # header parameters
818
- header_params = opts[:header_params] || {}
819
- # HTTP header 'Accept' (if needed)
820
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
821
-
822
- # form parameters
823
- form_params = opts[:form_params] || {}
824
-
825
- # http body (model)
826
- post_body = opts[:debug_body]
827
-
828
- # return_type
829
- return_type = opts[:debug_return_type] || 'AllUserAccountsResponse'
830
-
831
- # auth_names
832
- auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
833
-
834
- new_options = opts.merge(
835
- :operation => :"ExperimentalEndpointsApi.list_all_user_accounts",
836
- :header_params => header_params,
837
- :query_params => query_params,
838
- :form_params => form_params,
839
- :body => post_body,
840
- :auth_names => auth_names,
841
- :return_type => return_type
842
- )
843
-
844
- data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
845
- if @api_client.config.debugging
846
- @api_client.config.logger.debug "API called: ExperimentalEndpointsApi#list_all_user_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
847
- end
848
- return data, status_code, headers, response
849
- end
850
-
851
-
852
622
  # List active Trade Detection subscriptions
853
623
  #
854
624
  # Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
@@ -31,7 +31,7 @@ module SnapTrade
31
31
  # ISO-4217 currency code for the security listing.
32
32
  attr_accessor :currency
33
33
 
34
- # Exchange MIC code or exchange code for the security.
34
+ # Deprecated. Crypto instruments are not tied to a listing exchange, so this field is no longer populated and is omitted from responses. It will be removed in a future version.
35
35
  attr_accessor :exchange
36
36
 
37
37
  attr_accessor :figi_instrument
@@ -37,6 +37,9 @@ module SnapTrade
37
37
  # How mature the integration is. - `GENERALLY_AVAILABLE`: fully supported and validated for production use. - `BETA`: production-ready, with ongoing validation and improvements. - `ALPHA`: early access with limited validation. Expect issues and incomplete functionality.
38
38
  attr_accessor :release_stage
39
39
 
40
+ # Whether this is a paper-trading, practice or simulated-trading variant of a brokerage rather than real accounts. Filter these out to list real brokerages only.
41
+ attr_accessor :is_paper
42
+
40
43
  # Regions where end users can connect to this institution. - `US`: United States - `CA`: Canada - `EUROPE`: Europe, including the United Kingdom - `AU`: Australia - `IN`: India
41
44
  attr_accessor :regions
42
45
 
@@ -75,6 +78,7 @@ module SnapTrade
75
78
  :'logo_url' => :'logo_url',
76
79
  :'square_logo_url' => :'square_logo_url',
77
80
  :'release_stage' => :'release_stage',
81
+ :'is_paper' => :'is_paper',
78
82
  :'regions' => :'regions',
79
83
  :'connection' => :'connection'
80
84
  }
@@ -96,6 +100,7 @@ module SnapTrade
96
100
  :'logo_url' => :'String',
97
101
  :'square_logo_url' => :'String',
98
102
  :'release_stage' => :'ReleaseStage',
103
+ :'is_paper' => :'Boolean',
99
104
  :'regions' => :'Array<String>',
100
105
  :'connection' => :'InstitutionConnection'
101
106
  }
@@ -159,6 +164,10 @@ module SnapTrade
159
164
  self.release_stage = attributes[:'release_stage']
160
165
  end
161
166
 
167
+ if attributes.key?(:'is_paper')
168
+ self.is_paper = attributes[:'is_paper']
169
+ end
170
+
162
171
  if attributes.key?(:'regions')
163
172
  if (value = attributes[:'regions']).is_a?(Array)
164
173
  self.regions = value
@@ -194,6 +203,10 @@ module SnapTrade
194
203
  invalid_properties.push('invalid value for "release_stage", release_stage cannot be nil.')
195
204
  end
196
205
 
206
+ if @is_paper.nil?
207
+ invalid_properties.push('invalid value for "is_paper", is_paper cannot be nil.')
208
+ end
209
+
197
210
  invalid_properties
198
211
  end
199
212
 
@@ -205,6 +218,7 @@ module SnapTrade
205
218
  return false if @display_name.nil?
206
219
  return false if @logo_url.nil?
207
220
  return false if @release_stage.nil?
221
+ return false if @is_paper.nil?
208
222
  true
209
223
  end
210
224
 
@@ -221,6 +235,7 @@ module SnapTrade
221
235
  logo_url == o.logo_url &&
222
236
  square_logo_url == o.square_logo_url &&
223
237
  release_stage == o.release_stage &&
238
+ is_paper == o.is_paper &&
224
239
  regions == o.regions &&
225
240
  connection == o.connection
226
241
  end
@@ -234,7 +249,7 @@ module SnapTrade
234
249
  # Calculates hash code according to all attributes.
235
250
  # @return [Integer] Hash code
236
251
  def hash
237
- [slug, name, display_name, description, website, logo_url, square_logo_url, release_stage, regions, connection].hash
252
+ [slug, name, display_name, description, website, logo_url, square_logo_url, release_stage, is_paper, regions, connection].hash
238
253
  end
239
254
 
240
255
  # Builds the object from hash
@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
8
8
  =end
9
9
 
10
10
  module SnapTrade
11
- VERSION = '3.0.33'
11
+ VERSION = '3.0.35'
12
12
  end
@@ -60,6 +60,20 @@ describe 'AccountInformationApi' do
60
60
  end
61
61
  end
62
62
 
63
+ # unit tests for get_account_details
64
+ # Get account details
65
+ # Returns the specified account for the authenticated user. The account can be an investment, deposit, or line of credit account. Use the &#x60;kind&#x60; discriminator to determine the schema for the account. On Pay as you Go / Real-time, this endpoint refreshes the account&#39;s opening date and total net value (&#x60;net_value&#x60;) live from the institution on each call, along with funding date for &#x60;investment&#x60; accounts. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. If the connection has become disabled, it can no longer access the latest data from the institution, 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.
66
+ # @param user_id
67
+ # @param user_secret
68
+ # @param account_id
69
+ # @param [Hash] opts the optional parameters
70
+ # @return [ConnectionAccount]
71
+ describe 'get_account_details test' do
72
+ it 'should work' do
73
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
74
+ end
75
+ end
76
+
63
77
  # unit tests for get_all_account_positions
64
78
  # List all account positions
65
79
  # Returns a list of all positions in the specified account. The &#x60;results&#x60; list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, bonds, crypto, futures, option positions, future option positions, CFD positions, and tokenized asset positions. Use the &#x60;instrument.kind&#x60; discriminator to determine the schema for each position&#39;s &#x60;instrument&#x60;. **Beta:** future option positions (&#x60;instrument.kind: future_option&#x60;) are in beta. They are currently returned only for tastytrade and Interactive Brokers connections, and only for partners they have been enabled for — please contact the SnapTrade team to enable them. The &#x60;FutureOptionInstrument&#x60; schema may change. Positions counted in account cash balance or buying power include &#x60;cash_equivalent: true&#x60;. &#x60;stock&#x60;, &#x60;adr&#x60;, &#x60;etf&#x60;, &#x60;mutualfund&#x60;, and &#x60;crypto&#x60; positions may include &#x60;tax_lots&#x60; when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
@@ -90,7 +104,7 @@ describe 'AccountInformationApi' do
90
104
 
91
105
  # unit tests for get_user_account_details
92
106
  # Get account detail
93
- # Returns account detail known to SnapTrade 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&#39;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.
107
+ # **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, and line of credit accounts. Returns account detail known to SnapTrade 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&#39;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.
94
108
  # @param user_id
95
109
  # @param user_secret
96
110
  # @param account_id
@@ -177,9 +191,22 @@ describe 'AccountInformationApi' do
177
191
  end
178
192
  end
179
193
 
194
+ # unit tests for list_all_user_accounts
195
+ # List all user accounts
196
+ # Returns all accounts across all connections known to SnapTrade for the authenticated user. The &#x60;results&#x60; list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the &#x60;kind&#x60; discriminator to determine the schema for each account. This endpoint returns Daily data regardless of the customer&#39;s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user&#39;s connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
197
+ # @param user_id
198
+ # @param user_secret
199
+ # @param [Hash] opts the optional parameters
200
+ # @return [AllUserAccountsResponse]
201
+ describe 'list_all_user_accounts test' do
202
+ it 'should work' do
203
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
204
+ end
205
+ end
206
+
180
207
  # unit tests for list_user_accounts
181
208
  # List user accounts
182
- # Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer&#39;s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user&#39;s connections in a single call. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
209
+ # **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, and line of credit accounts. Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer&#39;s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user&#39;s connections in a single call. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
183
210
  # @param user_id
184
211
  # @param user_secret
185
212
  # @param [Hash] opts the optional parameters
@@ -98,7 +98,7 @@ describe 'ConnectionsApi' do
98
98
 
99
99
  # unit tests for list_connection_accounts
100
100
  # List accounts
101
- # Returns all accounts that belong to the specified connection for the authenticated user. The &#x60;results&#x60; list can contain multiple account kinds in the same response, including investment, deposit, and line of credit accounts. Use the &#x60;kind&#x60; discriminator to determine the shape for each account. On Pay as you Go / Real-time, this endpoint refreshes each account&#39;s opening date and total net value (&#x60;net_value&#x60;) live from the institution on each call, along with funding date for &#x60;investment&#x60; accounts. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
101
+ # Returns all accounts that belong to the specified connection for the authenticated user. The &#x60;results&#x60; list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the &#x60;kind&#x60; discriminator to determine the schema for each account. On Pay as you Go / Real-time, this endpoint refreshes each account&#39;s opening date and total net value (&#x60;net_value&#x60;) live from the institution on each call, along with funding date for &#x60;investment&#x60; accounts. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
102
102
  # @param connection_id
103
103
  # @param user_id
104
104
  # @param user_secret
@@ -53,20 +53,6 @@ describe 'ExperimentalEndpointsApi' do
53
53
  end
54
54
  end
55
55
 
56
- # unit tests for get_account_details
57
- # Get account details
58
- # Experimental and subject to change without notice. Returns the specified account for the authenticated user, using the &#x60;kind&#x60;-discriminated account shape. Use the &#x60;kind&#x60; discriminator to determine the shape of the account, which can be an investment, deposit, or line of credit account. On Pay as you Go / Real-time, this endpoint refreshes the account&#39;s opening date and total net value (&#x60;net_value&#x60;) live from the institution on each call, along with funding date for &#x60;investment&#x60; accounts. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data. If the connection has become disabled, it can no longer access the latest data from the institution, 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.
59
- # @param user_id
60
- # @param user_secret
61
- # @param account_id
62
- # @param [Hash] opts the optional parameters
63
- # @return [ConnectionAccount]
64
- describe 'get_account_details test' do
65
- it 'should work' do
66
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
67
- end
68
- end
69
-
70
56
  # unit tests for get_user_account_order_detail_v2
71
57
  # Get account order detail (V2)
72
58
  # Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the &#x60;legs&#x60; list field. If the order is single legged, &#x60;legs&#x60; will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
@@ -113,19 +99,6 @@ describe 'ExperimentalEndpointsApi' do
113
99
  end
114
100
  end
115
101
 
116
- # unit tests for list_all_user_accounts
117
- # List all user accounts
118
- # Experimental and subject to change without notice. Returns all accounts across all connections known to SnapTrade for the authenticated user. The &#x60;results&#x60; list can contain multiple account kinds in the same response, including investment, deposit, and line of credit accounts. Use the &#x60;kind&#x60; discriminator to determine the shape for each account. This endpoint returns Daily data regardless of the customer&#39;s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user&#39;s connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
119
- # @param user_id
120
- # @param user_secret
121
- # @param [Hash] opts the optional parameters
122
- # @return [AllUserAccountsResponse]
123
- describe 'list_all_user_accounts test' do
124
- it 'should work' do
125
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
126
- end
127
- end
128
-
129
102
  # unit tests for list_subscriptions
130
103
  # List active Trade Detection subscriptions
131
104
  # Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
@@ -68,6 +68,12 @@ describe SnapTrade::Institution do
68
68
  end
69
69
  end
70
70
 
71
+ describe 'test attribute "is_paper"' do
72
+ it 'should work' do
73
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
74
+ end
75
+ end
76
+
71
77
  describe 'test attribute "regions"' do
72
78
  it 'should work' do
73
79
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers