snaptrade 3.0.34 → 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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4fa76d76d1b8a2bdc85341bbb650a293bb9549539a9ec10522a242d5e46a03b4
4
- data.tar.gz: 54c8f5ff9540fb23beb19dfcb1f6f7e70973d5a7a409489582d92055e95f32e0
3
+ metadata.gz: cacace4a3f8b3d41672fa6b45dc058dbf18b30a2daac55a0892b76846e15d036
4
+ data.tar.gz: e3b17c2104a9e906cab04f79adc0689c5bc7193c801a5b81cb4dbf53c9bd1a81
5
5
  SHA512:
6
- metadata.gz: 7979935d26d714feb65f5ea2d444c4f95ab293b5b39c7baeb47a00575a92c10f437cb2058964d9b2a7ffcedbe0bf028452dd8207741f6753bdf17536df533320
7
- data.tar.gz: b7b53c1d1b9669a3ae9720a40ebd578b87ceda54477f3805573dd0dbc0ba21ad231a3c6c6139b3f67b202f21751228dae7ec2a59733d622e1a13e038e7d0f091
6
+ metadata.gz: 3f185a4d8373d4a44268990774dcc76e89295d5a24130e41e5e0cf58438a623d7ffcb891d4246efe43bf24d3c41e1f94469f7fe41ef76b0ab6ba75b7e8e1d8d3
7
+ data.tar.gz: 417f127dca4bade1b061b9772a1537cd6a51e2b9ae53df63a64a7ab74269a9b4c52514264ca4ad7fbc418c26ad0655185de31f7fc7fbf5f7e3a4961f97df5e98
data/README.md CHANGED
@@ -63,7 +63,7 @@ backoff with jitter rather than from the headers.
63
63
  See https://docs.snaptrade.com/docs/ratelimiting.
64
64
 
65
65
 
66
- [![npm](https://img.shields.io/badge/gem-v3.0.34-blue)](https://rubygems.org/gems/snaptrade/versions/3.0.34)
66
+ [![npm](https://img.shields.io/badge/gem-v3.0.35-blue)](https://rubygems.org/gems/snaptrade/versions/3.0.35)
67
67
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
68
68
 
69
69
  </div>
@@ -78,6 +78,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
78
78
  - [Reference](#reference)
79
79
  * [`snaptrade.account_information.get_account_activities`](#snaptradeaccount_informationget_account_activities)
80
80
  * [`snaptrade.account_information.get_account_balance_history`](#snaptradeaccount_informationget_account_balance_history)
81
+ * [`snaptrade.account_information.get_account_details`](#snaptradeaccount_informationget_account_details)
81
82
  * [`snaptrade.account_information.get_all_account_positions`](#snaptradeaccount_informationget_all_account_positions)
82
83
  * [`snaptrade.account_information.get_user_account_balance`](#snaptradeaccount_informationget_user_account_balance)
83
84
  * [`snaptrade.account_information.get_user_account_details`](#snaptradeaccount_informationget_user_account_details)
@@ -86,6 +87,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
86
87
  * [`snaptrade.account_information.get_user_account_recent_orders`](#snaptradeaccount_informationget_user_account_recent_orders)
87
88
  * [`snaptrade.account_information.get_user_account_return_rates`](#snaptradeaccount_informationget_user_account_return_rates)
88
89
  * [`snaptrade.account_information.get_user_holdings`](#snaptradeaccount_informationget_user_holdings)
90
+ * [`snaptrade.account_information.list_all_user_accounts`](#snaptradeaccount_informationlist_all_user_accounts)
89
91
  * [`snaptrade.account_information.list_user_accounts`](#snaptradeaccount_informationlist_user_accounts)
90
92
  * [`snaptrade.account_information.update_user_account`](#snaptradeaccount_informationupdate_user_account)
91
93
  * [`snaptrade.api_status.check`](#snaptradeapi_statuscheck)
@@ -105,11 +107,9 @@ See https://docs.snaptrade.com/docs/ratelimiting.
105
107
  * [`snaptrade.connections.sync_brokerage_authorization_transactions`](#snaptradeconnectionssync_brokerage_authorization_transactions)
106
108
  * [`snaptrade.experimental_endpoints.add_subscription`](#snaptradeexperimental_endpointsadd_subscription)
107
109
  * [`snaptrade.experimental_endpoints.cancel_subscription`](#snaptradeexperimental_endpointscancel_subscription)
108
- * [`snaptrade.experimental_endpoints.get_account_details`](#snaptradeexperimental_endpointsget_account_details)
109
110
  * [`snaptrade.experimental_endpoints.get_user_account_order_detail_v2`](#snaptradeexperimental_endpointsget_user_account_order_detail_v2)
110
111
  * [`snaptrade.experimental_endpoints.get_user_account_orders_v2`](#snaptradeexperimental_endpointsget_user_account_orders_v2)
111
112
  * [`snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`](#snaptradeexperimental_endpointsget_user_account_recent_orders_v2)
112
- * [`snaptrade.experimental_endpoints.list_all_user_accounts`](#snaptradeexperimental_endpointslist_all_user_accounts)
113
113
  * [`snaptrade.experimental_endpoints.list_subscriptions`](#snaptradeexperimental_endpointslist_subscriptions)
114
114
  * [`snaptrade.experimental_endpoints.place_simple_order`](#snaptradeexperimental_endpointsplace_simple_order)
115
115
  * [`snaptrade.reference_data.get_partner_info`](#snaptradereference_dataget_partner_info)
@@ -143,7 +143,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
143
143
  Add to Gemfile:
144
144
 
145
145
  ```ruby
146
- gem 'snaptrade', '~> 3.0.34'
146
+ gem 'snaptrade', '~> 3.0.35'
147
147
  ```
148
148
 
149
149
  ## Getting Started<a id="getting-started"></a>
@@ -309,6 +309,48 @@ p result
309
309
  ---
310
310
 
311
311
 
312
+ ### `snaptrade.account_information.get_account_details`<a id="snaptradeaccount_informationget_account_details"></a>
313
+
314
+ Returns the specified account for the authenticated user. The account can be an investment, deposit, or line of credit account. Use the `kind` discriminator to determine the schema for the account.
315
+
316
+ 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.
317
+
318
+ 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).
319
+
320
+ 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.
321
+
322
+ 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.
323
+
324
+
325
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
326
+
327
+ ```ruby
328
+ result = snaptrade.account_information.get_account_details(
329
+ user_id: "snaptrade-user-123",
330
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
331
+ account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
332
+ )
333
+ p result
334
+ ```
335
+
336
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
337
+
338
+ ##### user_id: `String`<a id="user_id-string"></a>
339
+ ##### user_secret: `String`<a id="user_secret-string"></a>
340
+ ##### account_id: `String`<a id="account_id-string"></a>
341
+ #### 🔄 Return<a id="🔄-return"></a>
342
+
343
+ [ConnectionAccount](./lib/snaptrade/models/connection_account.rb)
344
+
345
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
346
+
347
+ `/accounts/{accountId}/details` `GET`
348
+
349
+ [🔙 **Back to Table of Contents**](#table-of-contents)
350
+
351
+ ---
352
+
353
+
312
354
  ### `snaptrade.account_information.get_all_account_positions`<a id="snaptradeaccount_informationget_all_account_positions"></a>
313
355
 
314
356
  Returns a list of all positions in the specified account.
@@ -392,6 +434,9 @@ p result
392
434
 
393
435
 
394
436
  ### `snaptrade.account_information.get_user_account_details`<a id="snaptradeaccount_informationget_user_account_details"></a>
437
+ ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
438
+
439
+ **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.
395
440
 
396
441
  Returns account detail known to SnapTrade for the specified account.
397
442
 
@@ -654,7 +699,46 @@ p result
654
699
  ---
655
700
 
656
701
 
702
+ ### `snaptrade.account_information.list_all_user_accounts`<a id="snaptradeaccount_informationlist_all_user_accounts"></a>
703
+
704
+ Returns all accounts across all connections known to SnapTrade for the authenticated user.
705
+
706
+ The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account.
707
+
708
+ 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).
709
+
710
+
711
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
712
+
713
+ ```ruby
714
+ result = snaptrade.account_information.list_all_user_accounts(
715
+ user_id: "snaptrade-user-123",
716
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
717
+ )
718
+ p result
719
+ ```
720
+
721
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
722
+
723
+ ##### user_id: `String`<a id="user_id-string"></a>
724
+ ##### user_secret: `String`<a id="user_secret-string"></a>
725
+ #### 🔄 Return<a id="🔄-return"></a>
726
+
727
+ [AllUserAccountsResponse](./lib/snaptrade/models/all_user_accounts_response.rb)
728
+
729
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
730
+
731
+ `/accounts/all` `GET`
732
+
733
+ [🔙 **Back to Table of Contents**](#table-of-contents)
734
+
735
+ ---
736
+
737
+
657
738
  ### `snaptrade.account_information.list_user_accounts`<a id="snaptradeaccount_informationlist_user_accounts"></a>
739
+ ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
740
+
741
+ **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.
658
742
 
659
743
  Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
660
744
 
@@ -1149,7 +1233,7 @@ p result
1149
1233
 
1150
1234
  Returns all accounts that belong to the specified connection for the authenticated user.
1151
1235
 
1152
- 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.
1236
+ The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account.
1153
1237
 
1154
1238
  On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
1155
1239
 
@@ -1376,50 +1460,6 @@ reference the account in SnapTrade.
1376
1460
  ---
1377
1461
 
1378
1462
 
1379
- ### `snaptrade.experimental_endpoints.get_account_details`<a id="snaptradeexperimental_endpointsget_account_details"></a>
1380
-
1381
- Experimental and subject to change without notice.
1382
-
1383
- 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.
1384
-
1385
- 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.
1386
-
1387
- 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).
1388
-
1389
- 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.
1390
-
1391
- 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.
1392
-
1393
-
1394
- #### 🛠️ Usage<a id="🛠️-usage"></a>
1395
-
1396
- ```ruby
1397
- result = snaptrade.experimental_endpoints.get_account_details(
1398
- user_id: "snaptrade-user-123",
1399
- user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1400
- account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1401
- )
1402
- p result
1403
- ```
1404
-
1405
- #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1406
-
1407
- ##### user_id: `String`<a id="user_id-string"></a>
1408
- ##### user_secret: `String`<a id="user_secret-string"></a>
1409
- ##### account_id: `String`<a id="account_id-string"></a>
1410
- #### 🔄 Return<a id="🔄-return"></a>
1411
-
1412
- [ConnectionAccount](./lib/snaptrade/models/connection_account.rb)
1413
-
1414
- #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1415
-
1416
- `/accounts/{accountId}/details` `GET`
1417
-
1418
- [🔙 **Back to Table of Contents**](#table-of-contents)
1419
-
1420
- ---
1421
-
1422
-
1423
1463
  ### `snaptrade.experimental_endpoints.get_user_account_order_detail_v2`<a id="snaptradeexperimental_endpointsget_user_account_order_detail_v2"></a>
1424
1464
 
1425
1465
  Returns the detail of a single order using the brokerage order ID provided as a path parameter.
@@ -1553,44 +1593,6 @@ false to retrieve non executed orders as well
1553
1593
  ---
1554
1594
 
1555
1595
 
1556
- ### `snaptrade.experimental_endpoints.list_all_user_accounts`<a id="snaptradeexperimental_endpointslist_all_user_accounts"></a>
1557
-
1558
- Experimental and subject to change without notice.
1559
-
1560
- Returns all accounts across all connections known to SnapTrade for the authenticated user.
1561
-
1562
- 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.
1563
-
1564
- 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).
1565
-
1566
-
1567
- #### 🛠️ Usage<a id="🛠️-usage"></a>
1568
-
1569
- ```ruby
1570
- result = snaptrade.experimental_endpoints.list_all_user_accounts(
1571
- user_id: "snaptrade-user-123",
1572
- user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1573
- )
1574
- p result
1575
- ```
1576
-
1577
- #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1578
-
1579
- ##### user_id: `String`<a id="user_id-string"></a>
1580
- ##### user_secret: `String`<a id="user_secret-string"></a>
1581
- #### 🔄 Return<a id="🔄-return"></a>
1582
-
1583
- [AllUserAccountsResponse](./lib/snaptrade/models/all_user_accounts_response.rb)
1584
-
1585
- #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1586
-
1587
- `/accounts/all` `GET`
1588
-
1589
- [🔙 **Back to Table of Contents**](#table-of-contents)
1590
-
1591
- ---
1592
-
1593
-
1594
1596
  ### `snaptrade.experimental_endpoints.list_subscriptions`<a id="snaptradeexperimental_endpointslist_subscriptions"></a>
1595
1597
 
1596
1598
  Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
@@ -290,6 +290,125 @@ module SnapTrade
290
290
  end
291
291
 
292
292
 
293
+ # Get account details
294
+ #
295
+ # Returns the specified account for the authenticated user. The account can be an investment, deposit, or line of credit account. Use the `kind` discriminator to determine the schema for the account.
296
+ #
297
+ # 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.
298
+ #
299
+ # 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).
300
+ #
301
+ # 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.
302
+ #
303
+ # 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.
304
+ #
305
+ # @param user_id [String]
306
+ # @param user_secret [String]
307
+ # @param account_id [String]
308
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
309
+ def get_account_details(user_id:, user_secret:, account_id:, extra: {})
310
+ data, _status_code, _headers = get_account_details_with_http_info_impl(user_id, user_secret, account_id, extra)
311
+ data
312
+ end
313
+
314
+ # Get account details
315
+ #
316
+ # Returns the specified account for the authenticated user. The account can be an investment, deposit, or line of credit account. Use the `kind` discriminator to determine the schema for the account.
317
+ #
318
+ # 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.
319
+ #
320
+ # 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).
321
+ #
322
+ # 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.
323
+ #
324
+ # 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.
325
+ #
326
+ # @param user_id [String]
327
+ # @param user_secret [String]
328
+ # @param account_id [String]
329
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
330
+ def get_account_details_with_http_info(user_id:, user_secret:, account_id:, extra: {})
331
+ get_account_details_with_http_info_impl(user_id, user_secret, account_id, extra)
332
+ end
333
+
334
+ # Get account details
335
+ # Returns the specified account for the authenticated user. The account can be an investment, deposit, or line of credit account. Use the `kind` discriminator to determine the schema for the 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.
336
+ # @param user_id [String]
337
+ # @param user_secret [String]
338
+ # @param account_id [String]
339
+ # @param [Hash] opts the optional parameters
340
+ # @return [ConnectionAccount]
341
+ private def get_account_details_impl(user_id, user_secret, account_id, opts = {})
342
+ data, _status_code, _headers = get_account_details_with_http_info(user_id, user_secret, account_id, opts)
343
+ data
344
+ end
345
+
346
+ # Get account details
347
+ # 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.
348
+ # @param user_id [String]
349
+ # @param user_secret [String]
350
+ # @param account_id [String]
351
+ # @param [Hash] opts the optional parameters
352
+ # @return [Array<(ConnectionAccount, Integer, Hash)>] ConnectionAccount data, response status code and response headers
353
+ private def get_account_details_with_http_info_impl(user_id, user_secret, account_id, opts = {})
354
+ if @api_client.config.debugging
355
+ @api_client.config.logger.debug 'Calling API: AccountInformationApi.get_account_details ...'
356
+ end
357
+ # verify the required parameter 'user_id' is set
358
+ if @api_client.config.client_side_validation && user_id.nil?
359
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountInformationApi.get_account_details"
360
+ end
361
+ # verify the required parameter 'user_secret' is set
362
+ if @api_client.config.client_side_validation && user_secret.nil?
363
+ fail ArgumentError, "Missing the required parameter 'user_secret' when calling AccountInformationApi.get_account_details"
364
+ end
365
+ # verify the required parameter 'account_id' is set
366
+ if @api_client.config.client_side_validation && account_id.nil?
367
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountInformationApi.get_account_details"
368
+ end
369
+ # resource path
370
+ local_var_path = '/accounts/{accountId}/details'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
371
+
372
+ # query parameters
373
+ query_params = opts[:query_params] || {}
374
+ query_params[:'userId'] = user_id
375
+ query_params[:'userSecret'] = user_secret
376
+
377
+ # header parameters
378
+ header_params = opts[:header_params] || {}
379
+ # HTTP header 'Accept' (if needed)
380
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
381
+
382
+ # form parameters
383
+ form_params = opts[:form_params] || {}
384
+
385
+ # http body (model)
386
+ post_body = opts[:debug_body]
387
+
388
+ # return_type
389
+ return_type = opts[:debug_return_type] || 'ConnectionAccount'
390
+
391
+ # auth_names
392
+ auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
393
+
394
+ new_options = opts.merge(
395
+ :operation => :"AccountInformationApi.get_account_details",
396
+ :header_params => header_params,
397
+ :query_params => query_params,
398
+ :form_params => form_params,
399
+ :body => post_body,
400
+ :auth_names => auth_names,
401
+ :return_type => return_type
402
+ )
403
+
404
+ data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
405
+ if @api_client.config.debugging
406
+ @api_client.config.logger.debug "API called: AccountInformationApi#get_account_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
407
+ end
408
+ return data, status_code, headers, response
409
+ end
410
+
411
+
293
412
  # List all account positions
294
413
  #
295
414
  # Returns a list of all positions in the specified account.
@@ -526,6 +645,8 @@ module SnapTrade
526
645
 
527
646
  # Get account detail
528
647
  #
648
+ # **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.
649
+ #
529
650
  # Returns account detail known to SnapTrade for the specified account.
530
651
  #
531
652
  # 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:
@@ -545,6 +666,8 @@ module SnapTrade
545
666
 
546
667
  # Get account detail
547
668
  #
669
+ # **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.
670
+ #
548
671
  # Returns account detail known to SnapTrade for the specified account.
549
672
  #
550
673
  # 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:
@@ -562,7 +685,7 @@ module SnapTrade
562
685
  end
563
686
 
564
687
  # Get account detail
565
- # 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'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.
688
+ # **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'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.
566
689
  # @param user_id [String]
567
690
  # @param user_secret [String]
568
691
  # @param account_id [String]
@@ -574,7 +697,7 @@ module SnapTrade
574
697
  end
575
698
 
576
699
  # Get account detail
577
- # 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.
700
+ # **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.
578
701
  # @param user_id [String]
579
702
  # @param user_secret [String]
580
703
  # @param account_id [String]
@@ -1269,8 +1392,113 @@ module SnapTrade
1269
1392
  end
1270
1393
 
1271
1394
 
1395
+ # List all user accounts
1396
+ #
1397
+ # Returns all accounts across all connections known to SnapTrade for the authenticated user.
1398
+ #
1399
+ # The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account.
1400
+ #
1401
+ # 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).
1402
+ #
1403
+ # @param user_id [String]
1404
+ # @param user_secret [String]
1405
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1406
+ def list_all_user_accounts(user_id:, user_secret:, extra: {})
1407
+ data, _status_code, _headers = list_all_user_accounts_with_http_info_impl(user_id, user_secret, extra)
1408
+ data
1409
+ end
1410
+
1411
+ # List all user accounts
1412
+ #
1413
+ # Returns all accounts across all connections known to SnapTrade for the authenticated user.
1414
+ #
1415
+ # The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account.
1416
+ #
1417
+ # 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).
1418
+ #
1419
+ # @param user_id [String]
1420
+ # @param user_secret [String]
1421
+ # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1422
+ def list_all_user_accounts_with_http_info(user_id:, user_secret:, extra: {})
1423
+ list_all_user_accounts_with_http_info_impl(user_id, user_secret, extra)
1424
+ end
1425
+
1426
+ # List all user accounts
1427
+ # Returns all accounts across all connections known to SnapTrade for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema 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).
1428
+ # @param user_id [String]
1429
+ # @param user_secret [String]
1430
+ # @param [Hash] opts the optional parameters
1431
+ # @return [AllUserAccountsResponse]
1432
+ private def list_all_user_accounts_impl(user_id, user_secret, opts = {})
1433
+ data, _status_code, _headers = list_all_user_accounts_with_http_info(user_id, user_secret, opts)
1434
+ data
1435
+ end
1436
+
1437
+ # List all user accounts
1438
+ # 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).
1439
+ # @param user_id [String]
1440
+ # @param user_secret [String]
1441
+ # @param [Hash] opts the optional parameters
1442
+ # @return [Array<(AllUserAccountsResponse, Integer, Hash)>] AllUserAccountsResponse data, response status code and response headers
1443
+ private def list_all_user_accounts_with_http_info_impl(user_id, user_secret, opts = {})
1444
+ if @api_client.config.debugging
1445
+ @api_client.config.logger.debug 'Calling API: AccountInformationApi.list_all_user_accounts ...'
1446
+ end
1447
+ # verify the required parameter 'user_id' is set
1448
+ if @api_client.config.client_side_validation && user_id.nil?
1449
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountInformationApi.list_all_user_accounts"
1450
+ end
1451
+ # verify the required parameter 'user_secret' is set
1452
+ if @api_client.config.client_side_validation && user_secret.nil?
1453
+ fail ArgumentError, "Missing the required parameter 'user_secret' when calling AccountInformationApi.list_all_user_accounts"
1454
+ end
1455
+ # resource path
1456
+ local_var_path = '/accounts/all'
1457
+
1458
+ # query parameters
1459
+ query_params = opts[:query_params] || {}
1460
+ query_params[:'userId'] = user_id
1461
+ query_params[:'userSecret'] = user_secret
1462
+
1463
+ # header parameters
1464
+ header_params = opts[:header_params] || {}
1465
+ # HTTP header 'Accept' (if needed)
1466
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1467
+
1468
+ # form parameters
1469
+ form_params = opts[:form_params] || {}
1470
+
1471
+ # http body (model)
1472
+ post_body = opts[:debug_body]
1473
+
1474
+ # return_type
1475
+ return_type = opts[:debug_return_type] || 'AllUserAccountsResponse'
1476
+
1477
+ # auth_names
1478
+ auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
1479
+
1480
+ new_options = opts.merge(
1481
+ :operation => :"AccountInformationApi.list_all_user_accounts",
1482
+ :header_params => header_params,
1483
+ :query_params => query_params,
1484
+ :form_params => form_params,
1485
+ :body => post_body,
1486
+ :auth_names => auth_names,
1487
+ :return_type => return_type
1488
+ )
1489
+
1490
+ data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
1491
+ if @api_client.config.debugging
1492
+ @api_client.config.logger.debug "API called: AccountInformationApi#list_all_user_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1493
+ end
1494
+ return data, status_code, headers, response
1495
+ end
1496
+
1497
+
1272
1498
  # List user accounts
1273
1499
  #
1500
+ # **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.
1501
+ #
1274
1502
  # Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
1275
1503
  #
1276
1504
  # 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 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).
@@ -1285,6 +1513,8 @@ module SnapTrade
1285
1513
 
1286
1514
  # List user accounts
1287
1515
  #
1516
+ # **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.
1517
+ #
1288
1518
  # Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
1289
1519
  #
1290
1520
  # 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 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).
@@ -1297,7 +1527,7 @@ module SnapTrade
1297
1527
  end
1298
1528
 
1299
1529
  # List user accounts
1300
- # Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. 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 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).
1530
+ # **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'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 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).
1301
1531
  # @param user_id [String]
1302
1532
  # @param user_secret [String]
1303
1533
  # @param [Hash] opts the optional parameters
@@ -1308,7 +1538,7 @@ module SnapTrade
1308
1538
  end
1309
1539
 
1310
1540
  # List user accounts
1311
- # 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).
1541
+ # **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).
1312
1542
  # @param user_id [String]
1313
1543
  # @param user_secret [String]
1314
1544
  # @param [Hash] opts the optional parameters
@@ -554,7 +554,7 @@ module SnapTrade
554
554
  #
555
555
  # Returns all accounts that belong to the specified connection for the authenticated user.
556
556
  #
557
- # 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.
557
+ # The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account.
558
558
  #
559
559
  # On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
560
560
  #
@@ -575,7 +575,7 @@ module SnapTrade
575
575
  #
576
576
  # Returns all accounts that belong to the specified connection for the authenticated user.
577
577
  #
578
- # 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.
578
+ # The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account.
579
579
  #
580
580
  # On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
581
581
  #
@@ -592,7 +592,7 @@ module SnapTrade
592
592
  end
593
593
 
594
594
  # List accounts
595
- # Returns all accounts that belong to the specified connection 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. On Pay as you Go / Real-time, this endpoint refreshes each 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.
595
+ # Returns all accounts that belong to the specified connection for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account. On Pay as you Go / Real-time, this endpoint refreshes each 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.
596
596
  # @param connection_id [String]
597
597
  # @param user_id [String]
598
598
  # @param user_secret [String]
@@ -604,7 +604,7 @@ module SnapTrade
604
604
  end
605
605
 
606
606
  # List accounts
607
- # 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.
607
+ # 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.
608
608
  # @param connection_id [String]
609
609
  # @param user_id [String]
610
610
  # @param user_secret [String]