snaptrade 2.0.36 → 2.0.37

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7e8a3e30ce711edef7835ce59691c2709524f4d40add0b1913146ac04a56efaf
4
- data.tar.gz: 1ceed48b23a0c73555e2f13804dbeb51b819d2c39dca6edef6314674aae99ca2
3
+ metadata.gz: 88f22af63ef634b29b544f5bbc26cf9b13e9308b6f4ef33dfb560661fd5634f8
4
+ data.tar.gz: 86ff19da7e1921510e08601478baf357a1185d3c2637dcc1652844ec538d5a95
5
5
  SHA512:
6
- metadata.gz: 35df36a5be0fd0f2885229ee237b7938073703d7eb9878a4b77092a9dc6964afbeed9da5454434e02a3e45af466bff57ad9f8e25fe11c254cb6c2cc9ac17c8f7
7
- data.tar.gz: c3e1f881f4509c8a8617e32c7cd25d583cba44c0e11b4633464867af8fed1ac592183645d6faf6594c671d6c1d5618afee35deb8ab92ba8e728b4a3c4af43f8b
6
+ metadata.gz: 58e865b388be36ed872dffde28d4e52ecf65b9ac0432438c3ac3882856d6cda10414360a7a1f86b58a8473097ce978525f254a4461fb8f89e15d820def612fd6
7
+ data.tar.gz: 40803cf194c7788f5e695f4cb72bb9db2af3afa69a6f98bcec8268ff2af8ce1c008d4414f142f63452658b83b53f6954a831a715572849b69f2697e287ff28a8
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- snaptrade (2.0.36)
4
+ snaptrade (2.0.37)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
@@ -52,7 +52,7 @@ GEM
52
52
  rspec-mocks (~> 3.13.0)
53
53
  rspec-core (3.13.0)
54
54
  rspec-support (~> 3.13.0)
55
- rspec-expectations (3.13.1)
55
+ rspec-expectations (3.13.2)
56
56
  diff-lcs (>= 1.2.0, < 2.0)
57
57
  rspec-support (~> 3.13.0)
58
58
  rspec-mocks (3.13.1)
data/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Connect brokerage accounts to your app for live positions and trading
8
8
 
9
- [![npm](https://img.shields.io/badge/gem-v2.0.36-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.36)
9
+ [![npm](https://img.shields.io/badge/gem-v2.0.37-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.37)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
@@ -70,7 +70,7 @@ Connect brokerage accounts to your app for live positions and trading
70
70
  Add to Gemfile:
71
71
 
72
72
  ```ruby
73
- gem 'snaptrade', '~> 2.0.36'
73
+ gem 'snaptrade', '~> 2.0.37'
74
74
  ```
75
75
 
76
76
  ## Getting Started<a id="getting-started"></a>
@@ -84,7 +84,7 @@ configuration.consumer_key = ENV["SNAPTRADE_CONSUMER_KEY"]
84
84
  snaptrade = SnapTrade::Client.new(configuration)
85
85
  result = snaptrade.account_information.get_all_user_holdings(
86
86
  user_id: "snaptrade-user-123",
87
- user_secret: "USERSECRET123",
87
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
88
88
  brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
89
89
  )
90
90
  p result
@@ -97,7 +97,7 @@ To access the raw HTTP response, suffix any method with `_with_http_info`.
97
97
  ```ruby
98
98
  result = snaptrade.account_information.get_all_user_holdings_with_http_info(
99
99
  user_id: "snaptrade-user-123",
100
- user_secret: "USERSECRET123",
100
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
101
101
  brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
102
102
  )
103
103
  p result[0] # [Array<AccountHoldings>] Deserialized data
@@ -123,7 +123,7 @@ account.
123
123
  ```ruby
124
124
  result = snaptrade.account_information.get_all_user_holdings(
125
125
  user_id: "snaptrade-user-123",
126
- user_secret: "USERSECRET123",
126
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
127
127
  brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
128
128
  )
129
129
  p result
@@ -162,7 +162,7 @@ The data returned here is cached. How long the data is cached for varies by brok
162
162
  ```ruby
163
163
  result = snaptrade.account_information.get_user_account_balance(
164
164
  user_id: "snaptrade-user-123",
165
- user_secret: "USERSECRET123",
165
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
166
166
  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
167
167
  )
168
168
  p result
@@ -198,7 +198,7 @@ The data returned here is always cached and refreshed once a day. **If you need
198
198
  ```ruby
199
199
  result = snaptrade.account_information.get_user_account_details(
200
200
  user_id: "snaptrade-user-123",
201
- user_secret: "USERSECRET123",
201
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
202
202
  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
203
203
  )
204
204
  p result
@@ -234,7 +234,7 @@ The data returned here is cached. How long the data is cached for varies by brok
234
234
  ```ruby
235
235
  result = snaptrade.account_information.get_user_account_orders(
236
236
  user_id: "snaptrade-user-123",
237
- user_secret: "USERSECRET123",
237
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
238
238
  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
239
239
  state: "all",
240
240
  days: 30,
@@ -279,7 +279,7 @@ The data returned here is cached. How long the data is cached for varies by brok
279
279
  ```ruby
280
280
  result = snaptrade.account_information.get_user_account_positions(
281
281
  user_id: "snaptrade-user-123",
282
- user_secret: "USERSECRET123",
282
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
283
283
  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
284
284
  )
285
285
  p result
@@ -316,7 +316,7 @@ The data returned here is cached. How long the data is cached for varies by brok
316
316
  result = snaptrade.account_information.get_user_holdings(
317
317
  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
318
318
  user_id: "snaptrade-user-123",
319
- user_secret: "USERSECRET123",
319
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
320
320
  )
321
321
  p result
322
322
  ```
@@ -351,7 +351,7 @@ The data returned here is always cached and refreshed once a day. **If you need
351
351
  ```ruby
352
352
  result = snaptrade.account_information.list_user_accounts(
353
353
  user_id: "snaptrade-user-123",
354
- user_secret: "USERSECRET123",
354
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
355
355
  )
356
356
  p result
357
357
  ```
@@ -382,7 +382,7 @@ Updates various properties of a specified account.
382
382
  ```ruby
383
383
  result = snaptrade.account_information.update_user_account(
384
384
  user_id: "snaptrade-user-123",
385
- user_secret: "USERSECRET123",
385
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
386
386
  account_id: "accountId_example",
387
387
  )
388
388
  p result
@@ -490,7 +490,7 @@ Logs in a SnapTrade user and returns an authenticated connection portal URL for
490
490
  ```ruby
491
491
  result = snaptrade.authentication.login_snap_trade_user(
492
492
  user_id: "snaptrade-user-123",
493
- user_secret: "USERSECRET123",
493
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
494
494
  broker: "ALPACA",
495
495
  immediate_redirect: true,
496
496
  custom_redirect: "https://snaptrade.com",
@@ -552,8 +552,8 @@ Sets the version of the connection portal to render.
552
552
 
553
553
  ### `snaptrade.authentication.register_snap_trade_user`<a id="snaptradeauthenticationregister_snap_trade_user"></a>
554
554
 
555
- Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database.
556
- Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
555
+ Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system.
556
+ Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
557
557
 
558
558
 
559
559
  #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -596,7 +596,7 @@ Rotates the secret for a SnapTrade user. You might use this if `userSecret` is c
596
596
  ```ruby
597
597
  result = snaptrade.authentication.reset_snap_trade_user_secret(
598
598
  user_id: "snaptrade-user-123",
599
- user_secret: "h81@cx1lkalablakwjaltkejraj11=",
599
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
600
600
  )
601
601
  p result
602
602
  ```
@@ -610,9 +610,9 @@ NOT use email addresses for this property because they are usually not
610
610
  immutable.
611
611
 
612
612
  ##### userSecret: `String`<a id="usersecret-string"></a>
613
- SnapTrade User Secret randomly generated by SnapTrade. This is privileged
614
- information and if compromised, should be rotated via the [rotate user secret
615
- endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
613
+ SnapTrade User Secret. This is a randomly generated string and should be stored
614
+ securely. If compromised, please rotate it via the [rotate user secret
615
+ endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
616
616
 
617
617
  #### 🔄 Return<a id="🔄-return"></a>
618
618
 
@@ -637,7 +637,7 @@ Returns a single brokerage authorization object for the specified ID.
637
637
  result = snaptrade.connections.detail_brokerage_authorization(
638
638
  authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
639
639
  user_id: "snaptrade-user-123",
640
- user_secret: "USERSECRET123",
640
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
641
641
  )
642
642
  p result
643
643
  ```
@@ -672,7 +672,7 @@ Manually disable a connection. This should only be used for testing a reconnect
672
672
  result = snaptrade.connections.disable_brokerage_authorization(
673
673
  authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
674
674
  user_id: "snaptrade-user-123",
675
- user_secret: "USERSECRET123",
675
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
676
676
  )
677
677
  p result
678
678
  ```
@@ -706,7 +706,7 @@ Returns a list of Brokerage Authorization objects for the user
706
706
  ```ruby
707
707
  result = snaptrade.connections.list_brokerage_authorizations(
708
708
  user_id: "snaptrade-user-123",
709
- user_secret: "USERSECRET123",
709
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
710
710
  )
711
711
  p result
712
712
  ```
@@ -738,7 +738,7 @@ Trigger a holdings update for all accounts under this authorization. Updates wil
738
738
  result = snaptrade.connections.refresh_brokerage_authorization(
739
739
  authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
740
740
  user_id: "snaptrade-user-123",
741
- user_secret: "USERSECRET123",
741
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
742
742
  )
743
743
  p result
744
744
  ```
@@ -773,7 +773,7 @@ Deletes a specified brokerage authorization given by the ID.
773
773
  snaptrade.connections.remove_brokerage_authorization(
774
774
  authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
775
775
  user_id: "snaptrade-user-123",
776
- user_secret: "USERSECRET123",
776
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
777
777
  )
778
778
  ```
779
779
 
@@ -851,7 +851,7 @@ result = snaptrade.options.get_option_strategy(
851
851
  ],
852
852
  strategy_type: "CUSTOM",
853
853
  user_id: "snaptrade-user-123",
854
- user_secret: "USERSECRET123",
854
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
855
855
  account_id: "accountId_example",
856
856
  )
857
857
  p result
@@ -889,7 +889,7 @@ Returns the option chain for the specified symbol in the specified account.
889
889
  ```ruby
890
890
  result = snaptrade.options.get_options_chain(
891
891
  user_id: "snaptrade-user-123",
892
- user_secret: "USERSECRET123",
892
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
893
893
  account_id: "accountId_example",
894
894
  symbol: "symbol_example",
895
895
  )
@@ -929,7 +929,7 @@ Returns a Strategy Quotes object which has latest market data of the specified o
929
929
  ```ruby
930
930
  result = snaptrade.options.get_options_strategy_quote(
931
931
  user_id: "snaptrade-user-123",
932
- user_secret: "USERSECRET123",
932
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
933
933
  account_id: "accountId_example",
934
934
  option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
935
935
  )
@@ -971,7 +971,7 @@ The data returned here is cached. How long the data is cached for varies by brok
971
971
  ```ruby
972
972
  result = snaptrade.options.list_option_holdings(
973
973
  user_id: "snaptrade-user-123",
974
- user_secret: "USERSECRET123",
974
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
975
975
  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
976
976
  )
977
977
  p result
@@ -1006,7 +1006,7 @@ result = snaptrade.options.place_option_strategy(
1006
1006
  order_type: "Limit",
1007
1007
  time_in_force: "FOK",
1008
1008
  user_id: "snaptrade-user-123",
1009
- user_secret: "USERSECRET123",
1009
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1010
1010
  account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
1011
1011
  option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
1012
1012
  price: 31.33,
@@ -1328,7 +1328,7 @@ provided search string, matching on ticker and name.
1328
1328
  ```ruby
1329
1329
  result = snaptrade.reference_data.symbol_search_user_account(
1330
1330
  user_id: "snaptrade-user-123",
1331
- user_secret: "USERSECRET123",
1331
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1332
1332
  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1333
1333
  substring: "apple",
1334
1334
  )
@@ -1367,7 +1367,7 @@ This will only work if the order has not yet been executed.
1367
1367
  ```ruby
1368
1368
  result = snaptrade.trading.cancel_user_account_order(
1369
1369
  user_id: "snaptrade-user-123",
1370
- user_secret: "USERSECRET123",
1370
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1371
1371
  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1372
1372
  brokerage_order_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
1373
1373
  )
@@ -1404,7 +1404,7 @@ Return the trade object and it's impact on the account for the specified order.
1404
1404
  ```ruby
1405
1405
  result = snaptrade.trading.get_order_impact(
1406
1406
  user_id: "snaptrade-user-123",
1407
- user_secret: "USERSECRET123",
1407
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1408
1408
  account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
1409
1409
  action: "BUY",
1410
1410
  order_type: "Limit",
@@ -1464,7 +1464,7 @@ Returns quote(s) from the brokerage for the specified symbol(s).
1464
1464
  ```ruby
1465
1465
  result = snaptrade.trading.get_user_account_quotes(
1466
1466
  user_id: "snaptrade-user-123",
1467
- user_secret: "USERSECRET123",
1467
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1468
1468
  symbols: "symbols_example",
1469
1469
  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1470
1470
  use_ticker: true,
@@ -1507,7 +1507,7 @@ Places a specified trade in the specified account.
1507
1507
  ```ruby
1508
1508
  result = snaptrade.trading.place_force_order(
1509
1509
  user_id: "snaptrade-user-123",
1510
- user_secret: "USERSECRET123",
1510
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1511
1511
  account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
1512
1512
  action: "BUY",
1513
1513
  order_type: "Limit",
@@ -1570,7 +1570,7 @@ returns the status of the order from the brokerage.
1570
1570
  result = snaptrade.trading.place_order(
1571
1571
  trade_id: "tradeId_example",
1572
1572
  user_id: "snaptrade-user-123",
1573
- user_secret: "USERSECRET123",
1573
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1574
1574
  wait_to_confirm: true,
1575
1575
  )
1576
1576
  p result
@@ -1616,7 +1616,7 @@ The data returned here is always cached and refreshed once a day. **If you need
1616
1616
  ```ruby
1617
1617
  result = snaptrade.transactions_and_reporting.get_activities(
1618
1618
  user_id: "snaptrade-user-123",
1619
- user_secret: "USERSECRET123",
1619
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1620
1620
  start_date: "2022-01-24",
1621
1621
  end_date: "2022-01-24",
1622
1622
  accounts: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
@@ -1683,7 +1683,7 @@ result = snaptrade.transactions_and_reporting.get_reporting_custom_range(
1683
1683
  start_date: "2022-01-24",
1684
1684
  end_date: "2022-01-24",
1685
1685
  user_id: "snaptrade-user-123",
1686
- user_secret: "USERSECRET123",
1686
+ user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1687
1687
  accounts: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
1688
1688
  detailed: true,
1689
1689
  frequency: "monthly",
@@ -314,8 +314,8 @@ module SnapTrade
314
314
 
315
315
  # Register user
316
316
  #
317
- # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database.
318
- # Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
317
+ # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system.
318
+ # Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
319
319
  #
320
320
  # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
321
321
  # @param body [SnapTradeRegisterUserRequestBody]
@@ -330,8 +330,8 @@ module SnapTrade
330
330
 
331
331
  # Register user
332
332
  #
333
- # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database.
334
- # Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
333
+ # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system.
334
+ # Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
335
335
  #
336
336
  # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
337
337
  # @param body [SnapTradeRegisterUserRequestBody]
@@ -344,7 +344,7 @@ module SnapTrade
344
344
  end
345
345
 
346
346
  # Register user
347
- # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
347
+ # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
348
348
  # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody]
349
349
  # @param [Hash] opts the optional parameters
350
350
  # @return [UserIDandSecret]
@@ -354,7 +354,7 @@ module SnapTrade
354
354
  end
355
355
 
356
356
  # Register user
357
- # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
357
+ # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
358
358
  # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody]
359
359
  # @param [Hash] opts the optional parameters
360
360
  # @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers
@@ -417,7 +417,7 @@ module SnapTrade
417
417
  # Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
418
418
  #
419
419
  # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
420
- # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
420
+ # @param user_secret [String] SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
421
421
  # @param body [UserIDandSecret]
422
422
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
423
423
  def reset_snap_trade_user_secret(user_id: SENTINEL, user_secret: SENTINEL, extra: {})
@@ -434,7 +434,7 @@ module SnapTrade
434
434
  # Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
435
435
  #
436
436
  # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
437
- # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
437
+ # @param user_secret [String] SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
438
438
  # @param body [UserIDandSecret]
439
439
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
440
440
  def reset_snap_trade_user_secret_with_http_info(user_id: SENTINEL, user_secret: SENTINEL, extra: {})
@@ -11,12 +11,11 @@ require 'date'
11
11
  require 'time'
12
12
 
13
13
  module SnapTrade
14
- # Response when register user is successful
15
14
  class UserIDandSecret
16
15
  # SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
17
16
  attr_accessor :user_id
18
17
 
19
- # SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
18
+ # SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
20
19
  attr_accessor :user_secret
21
20
 
22
21
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
8
8
  =end
9
9
 
10
10
  module SnapTrade
11
- VERSION = '2.0.36'
11
+ VERSION = '2.0.37'
12
12
  end
@@ -66,7 +66,7 @@ describe 'AuthenticationApi' do
66
66
 
67
67
  # unit tests for register_snap_trade_user
68
68
  # Register user
69
- # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
69
+ # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
70
70
  # @param snap_trade_register_user_request_body
71
71
  # @param [Hash] opts the optional parameters
72
72
  # @return [UserIDandSecret]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: snaptrade
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.36
4
+ version: 2.0.37
5
5
  platform: ruby
6
6
  authors:
7
7
  - SnapTrade
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-08-20 00:00:00.000000000 Z
11
+ date: 2024-08-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday