snaptrade 2.0.13 → 2.0.15

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: cc2507038827738383521f845dbd09159a69d60f2766b5484dc154d382e8b3b6
4
- data.tar.gz: 7368b3b57fc67a3324201f3a93631bc01066ea05df3bb93ef32e041f82a12275
3
+ metadata.gz: 637abf7203f1d51cb78a3589aabb665849863b360711a1c3b3fc8d8a010506f2
4
+ data.tar.gz: fed0e30bbdf6c59ff9468490e238efd3897669c13b857774cf7941af562062b3
5
5
  SHA512:
6
- metadata.gz: 9931aa4eeac1dd06189db61d6e0b386c793da02e15eab73f93741b0c9b840cde5da3eaceb816ab196c715edf62e5757c07ac08047238bd0046e8122e59f6be39
7
- data.tar.gz: b5a236327938c1201c0d3bf56c5d96b84ae3549f729e9faa62b16570bde1d849d2abb8893deef7c8b6b7c0f0c561fbb7a78079d6ce852e0fbeb7bd45b7804169
6
+ metadata.gz: bbc70ee35f670dbe9a00990ebdfb656ef15ecb28615147bb4f07ddfa502fdc92716d95e71d17c9907ee41f40bfd1924bd63626c3346ff6445087e84469e52156
7
+ data.tar.gz: 83fa560986aad17fed2f975e38116371a550f24d886fda46390dacab5c72c007122b23e8a296a13e6c3197bc6840a3495511b3cab277a88012b7851920c773d0
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- snaptrade (2.0.13)
4
+ snaptrade (2.0.14)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
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.13-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.13)
9
+ [![npm](https://img.shields.io/badge/gem-v2.0.15-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.15)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
@@ -58,7 +58,6 @@ Connect brokerage accounts to your app for live positions and trading
58
58
  * [`snaptrade.trading.get_order_impact`](#snaptradetradingget_order_impact)
59
59
  * [`snaptrade.trading.get_user_account_quotes`](#snaptradetradingget_user_account_quotes)
60
60
  * [`snaptrade.trading.place_force_order`](#snaptradetradingplace_force_order)
61
- * [`snaptrade.trading.place_oco_order`](#snaptradetradingplace_oco_order)
62
61
  * [`snaptrade.trading.place_order`](#snaptradetradingplace_order)
63
62
  * [`snaptrade.transactions_and_reporting.get_activities`](#snaptradetransactions_and_reportingget_activities)
64
63
  * [`snaptrade.transactions_and_reporting.get_reporting_custom_range`](#snaptradetransactions_and_reportingget_reporting_custom_range)
@@ -70,7 +69,7 @@ Connect brokerage accounts to your app for live positions and trading
70
69
  Add to Gemfile:
71
70
 
72
71
  ```ruby
73
- gem 'snaptrade', '~> 2.0.13'
72
+ gem 'snaptrade', '~> 2.0.15'
74
73
  ```
75
74
 
76
75
  ## Getting Started<a id="getting-started"></a>
@@ -111,7 +110,9 @@ p.result[3] # [Faraday::Response] Raw HTTP response
111
110
 
112
111
  ### `snaptrade.account_information.get_all_user_holdings`<a id="snaptradeaccount_informationget_all_user_holdings"></a>
113
112
 
114
- List all accounts for the user, plus balances, positions, and orders for each account.
113
+ Lists balances, positions and orders for the specified account. The data returned is similar to
114
+ the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
115
+
115
116
 
116
117
  #### 🛠️ Usage<a id="🛠️-usage"></a>
117
118
 
@@ -182,7 +183,9 @@ The ID of the account to get balances.
182
183
 
183
184
  ### `snaptrade.account_information.get_user_account_details`<a id="snaptradeaccount_informationget_user_account_details"></a>
184
185
 
185
- Return details of a specific investment account
186
+ Returns an account object with details for the specified account,
187
+ including the total account market value.
188
+
186
189
 
187
190
  #### 🛠️ Usage<a id="🛠️-usage"></a>
188
191
 
@@ -261,7 +264,7 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
261
264
 
262
265
  ### `snaptrade.account_information.get_user_account_positions`<a id="snaptradeaccount_informationget_user_account_positions"></a>
263
266
 
264
- List account positions
267
+ Returns a list of positions in the the specified account.
265
268
 
266
269
  #### 🛠️ Usage<a id="🛠️-usage"></a>
267
270
 
@@ -296,7 +299,10 @@ The ID of the account to get positions.
296
299
 
297
300
  ### `snaptrade.account_information.get_user_holdings`<a id="snaptradeaccount_informationget_user_holdings"></a>
298
301
 
299
- List balances, positions and orders for the specified account
302
+ Lists balances, positions and orders for the specified account as well as
303
+ option_positions and account metadata. The data returned is similar to the
304
+ data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
305
+
300
306
 
301
307
  #### 🛠️ Usage<a id="🛠️-usage"></a>
302
308
 
@@ -331,7 +337,7 @@ The ID of the account to fetch holdings for.
331
337
 
332
338
  ### `snaptrade.account_information.list_user_accounts`<a id="snaptradeaccount_informationlist_user_accounts"></a>
333
339
 
334
- List accounts
340
+ Get a list of all Account objects for the authenticated SnapTrade user.
335
341
 
336
342
  #### 🛠️ Usage<a id="🛠️-usage"></a>
337
343
 
@@ -362,7 +368,7 @@ p result
362
368
 
363
369
  ### `snaptrade.account_information.update_user_account`<a id="snaptradeaccount_informationupdate_user_account"></a>
364
370
 
365
- Update details of an investment account
371
+ Updates various properties of a specified account.
366
372
 
367
373
  #### 🛠️ Usage<a id="🛠️-usage"></a>
368
374
 
@@ -450,7 +456,9 @@ p result
450
456
 
451
457
  ### `snaptrade.authentication.get_user_jwt`<a id="snaptradeauthenticationget_user_jwt"></a>
452
458
 
453
- Generate encrypted JWT token
459
+ This API is available to ClientIDs which have opted to use encrypted
460
+ JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
461
+
454
462
 
455
463
  #### 🛠️ Usage<a id="🛠️-usage"></a>
456
464
 
@@ -559,7 +567,9 @@ Sets the version of the connection portal to render, with a default to 'v2'
559
567
 
560
568
  ### `snaptrade.authentication.register_snap_trade_user`<a id="snaptradeauthenticationregister_snap_trade_user"></a>
561
569
 
562
- Create SnapTrade user
570
+ Registers a new SnapTrade user under your ClientID.
571
+ Most SnapTrade operations require a user to be passed as a parameter.
572
+
563
573
 
564
574
  #### 🛠️ Usage<a id="🛠️-usage"></a>
565
575
 
@@ -591,7 +601,9 @@ it's unique to a user
591
601
 
592
602
  ### `snaptrade.authentication.reset_snap_trade_user_secret`<a id="snaptradeauthenticationreset_snap_trade_user_secret"></a>
593
603
 
594
- Obtain a new user secret for a user
604
+ This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret
605
+ is comprimised or lost among other reasons.
606
+
595
607
 
596
608
  #### 🛠️ Usage<a id="🛠️-usage"></a>
597
609
 
@@ -1007,7 +1019,7 @@ A currency pair based on currency code for example, {CAD-USD}
1007
1019
 
1008
1020
  ### `snaptrade.reference_data.get_partner_info`<a id="snaptradereference_dataget_partner_info"></a>
1009
1021
 
1010
- Get metadata related to Snaptrade partner
1022
+ Returns useful data related to the specified ClientID, including allowed brokerages and data access.
1011
1023
 
1012
1024
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1013
1025
 
@@ -1242,7 +1254,10 @@ p result
1242
1254
 
1243
1255
  ### `snaptrade.reference_data.symbol_search_user_account`<a id="snaptradereference_datasymbol_search_user_account"></a>
1244
1256
 
1245
- Search for symbols available in an account
1257
+ Returns a list of universal symbols that are supported by
1258
+ the specificied account. Returned symbols are based on the
1259
+ provided search string, matching on ticker and name.
1260
+
1246
1261
 
1247
1262
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1248
1263
 
@@ -1279,7 +1294,9 @@ The ID of the account to search for symbols within.
1279
1294
 
1280
1295
  ### `snaptrade.trading.cancel_user_account_order`<a id="snaptradetradingcancel_user_account_order"></a>
1281
1296
 
1282
- Cancel open order in account
1297
+ Sends a signal to the brokerage to cancel the specified order.
1298
+ This will only work if the order has not yet been executed.
1299
+
1283
1300
 
1284
1301
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1285
1302
 
@@ -1376,7 +1393,7 @@ Canceled
1376
1393
 
1377
1394
  ### `snaptrade.trading.get_user_account_quotes`<a id="snaptradetradingget_user_account_quotes"></a>
1378
1395
 
1379
- Get symbol quotes
1396
+ Returns live quote(s) from the brokerage for the specified symbol(s).
1380
1397
 
1381
1398
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1382
1399
 
@@ -1477,45 +1494,6 @@ Canceled
1477
1494
  ---
1478
1495
 
1479
1496
 
1480
- ### `snaptrade.trading.place_oco_order`<a id="snaptradetradingplace_oco_order"></a>
1481
-
1482
- Place a OCO (One Cancels Other) order
1483
-
1484
- #### 🛠️ Usage<a id="🛠️-usage"></a>
1485
-
1486
- ```ruby
1487
- result = snaptrade.trading.place_oco_order(
1488
- user_id: "John.doe@snaptrade.com",
1489
- user_secret: "USERSECRET123",
1490
- first_trade_id: None,
1491
- second_trade_id: None,
1492
- )
1493
- p result
1494
- ```
1495
-
1496
- #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1497
-
1498
- ##### user_id: `String`<a id="user_id-string"></a>
1499
- ##### user_secret: `String`<a id="user_secret-string"></a>
1500
- ##### first_trade_id: `Object`<a id="first_trade_id-object"></a>
1501
- The ID of first trade object obtained from trade/impact endpoint
1502
-
1503
- ##### second_trade_id: `Object`<a id="second_trade_id-object"></a>
1504
- The ID of second trade object obtained from trade/impact endpoint
1505
-
1506
- #### 🔄 Return<a id="🔄-return"></a>
1507
-
1508
- [AccountOrderRecord](./lib/snaptrade/models/account_order_record.rb)
1509
-
1510
- #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1511
-
1512
- `/trade/oco` `POST`
1513
-
1514
- [🔙 **Back to Table of Contents**](#table-of-contents)
1515
-
1516
- ---
1517
-
1518
-
1519
1497
  ### `snaptrade.trading.place_order`<a id="snaptradetradingplace_order"></a>
1520
1498
 
1521
1499
  Place order
@@ -19,6 +19,9 @@ module SnapTrade
19
19
 
20
20
  # List all accounts for the user, plus balances, positions, and orders for each account.
21
21
  #
22
+ # Lists balances, positions and orders for the specified account. The data returned is similar to
23
+ # the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
24
+ #
22
25
  # @param user_id [String]
23
26
  # @param user_secret [String]
24
27
  # @param brokerage_authorizations [String] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
@@ -31,6 +34,9 @@ module SnapTrade
31
34
 
32
35
  # List all accounts for the user, plus balances, positions, and orders for each account.
33
36
  #
37
+ # Lists balances, positions and orders for the specified account. The data returned is similar to
38
+ # the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
39
+ #
34
40
  # @param user_id [String]
35
41
  # @param user_secret [String]
36
42
  # @param brokerage_authorizations [String] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
@@ -41,6 +47,7 @@ module SnapTrade
41
47
  end
42
48
 
43
49
  # List all accounts for the user, plus balances, positions, and orders for each account.
50
+ # Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
44
51
  # @param user_id [String]
45
52
  # @param user_secret [String]
46
53
  # @param [Hash] opts the optional parameters
@@ -52,6 +59,7 @@ module SnapTrade
52
59
  end
53
60
 
54
61
  # List all accounts for the user, plus balances, positions, and orders for each account.
62
+ # Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
55
63
  # @param user_id [String]
56
64
  # @param user_secret [String]
57
65
  # @param [Hash] opts the optional parameters
@@ -218,6 +226,9 @@ module SnapTrade
218
226
 
219
227
  # Return details of a specific investment account
220
228
  #
229
+ # Returns an account object with details for the specified account,
230
+ # including the total account market value.
231
+ #
221
232
  # @param user_id [String]
222
233
  # @param user_secret [String]
223
234
  # @param account_id [String] The ID of the account to get detail of.
@@ -229,6 +240,9 @@ module SnapTrade
229
240
 
230
241
  # Return details of a specific investment account
231
242
  #
243
+ # Returns an account object with details for the specified account,
244
+ # including the total account market value.
245
+ #
232
246
  # @param user_id [String]
233
247
  # @param user_secret [String]
234
248
  # @param account_id [String] The ID of the account to get detail of.
@@ -238,6 +252,7 @@ module SnapTrade
238
252
  end
239
253
 
240
254
  # Return details of a specific investment account
255
+ # Returns an account object with details for the specified account, including the total account market value.
241
256
  # @param user_id [String]
242
257
  # @param user_secret [String]
243
258
  # @param account_id [String] The ID of the account to get detail of.
@@ -249,6 +264,7 @@ module SnapTrade
249
264
  end
250
265
 
251
266
  # Return details of a specific investment account
267
+ # Returns an account object with details for the specified account, including the total account market value.
252
268
  # @param user_id [String]
253
269
  # @param user_secret [String]
254
270
  # @param account_id [String] The ID of the account to get detail of.
@@ -440,6 +456,8 @@ module SnapTrade
440
456
 
441
457
  # List account positions
442
458
  #
459
+ # Returns a list of positions in the the specified account.
460
+ #
443
461
  # @param user_id [String]
444
462
  # @param user_secret [String]
445
463
  # @param account_id [String] The ID of the account to get positions.
@@ -451,6 +469,8 @@ module SnapTrade
451
469
 
452
470
  # List account positions
453
471
  #
472
+ # Returns a list of positions in the the specified account.
473
+ #
454
474
  # @param user_id [String]
455
475
  # @param user_secret [String]
456
476
  # @param account_id [String] The ID of the account to get positions.
@@ -460,6 +480,7 @@ module SnapTrade
460
480
  end
461
481
 
462
482
  # List account positions
483
+ # Returns a list of positions in the the specified account.
463
484
  # @param user_id [String]
464
485
  # @param user_secret [String]
465
486
  # @param account_id [String] The ID of the account to get positions.
@@ -471,6 +492,7 @@ module SnapTrade
471
492
  end
472
493
 
473
494
  # List account positions
495
+ # Returns a list of positions in the the specified account.
474
496
  # @param user_id [String]
475
497
  # @param user_secret [String]
476
498
  # @param account_id [String] The ID of the account to get positions.
@@ -537,6 +559,10 @@ module SnapTrade
537
559
 
538
560
  # List balances, positions and orders for the specified account
539
561
  #
562
+ # Lists balances, positions and orders for the specified account as well as
563
+ # option_positions and account metadata. The data returned is similar to the
564
+ # data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
565
+ #
540
566
  # @param account_id [String] The ID of the account to fetch holdings for.
541
567
  # @param user_id [String]
542
568
  # @param user_secret [String]
@@ -548,6 +574,10 @@ module SnapTrade
548
574
 
549
575
  # List balances, positions and orders for the specified account
550
576
  #
577
+ # Lists balances, positions and orders for the specified account as well as
578
+ # option_positions and account metadata. The data returned is similar to the
579
+ # data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
580
+ #
551
581
  # @param account_id [String] The ID of the account to fetch holdings for.
552
582
  # @param user_id [String]
553
583
  # @param user_secret [String]
@@ -557,6 +587,7 @@ module SnapTrade
557
587
  end
558
588
 
559
589
  # List balances, positions and orders for the specified account
590
+ # Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
560
591
  # @param account_id [String] The ID of the account to fetch holdings for.
561
592
  # @param user_id [String]
562
593
  # @param user_secret [String]
@@ -568,6 +599,7 @@ module SnapTrade
568
599
  end
569
600
 
570
601
  # List balances, positions and orders for the specified account
602
+ # Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
571
603
  # @param account_id [String] The ID of the account to fetch holdings for.
572
604
  # @param user_id [String]
573
605
  # @param user_secret [String]
@@ -634,6 +666,8 @@ module SnapTrade
634
666
 
635
667
  # List accounts
636
668
  #
669
+ # Get a list of all Account objects for the authenticated SnapTrade user.
670
+ #
637
671
  # @param user_id [String]
638
672
  # @param user_secret [String]
639
673
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -644,6 +678,8 @@ module SnapTrade
644
678
 
645
679
  # List accounts
646
680
  #
681
+ # Get a list of all Account objects for the authenticated SnapTrade user.
682
+ #
647
683
  # @param user_id [String]
648
684
  # @param user_secret [String]
649
685
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -652,6 +688,7 @@ module SnapTrade
652
688
  end
653
689
 
654
690
  # List accounts
691
+ # Get a list of all Account objects for the authenticated SnapTrade user.
655
692
  # @param user_id [String]
656
693
  # @param user_secret [String]
657
694
  # @param [Hash] opts the optional parameters
@@ -662,6 +699,7 @@ module SnapTrade
662
699
  end
663
700
 
664
701
  # List accounts
702
+ # Get a list of all Account objects for the authenticated SnapTrade user.
665
703
  # @param user_id [String]
666
704
  # @param user_secret [String]
667
705
  # @param [Hash] opts the optional parameters
@@ -723,6 +761,8 @@ module SnapTrade
723
761
 
724
762
  # Update details of an investment account
725
763
  #
764
+ # Updates various properties of a specified account.
765
+ #
726
766
  # @param user_id [String]
727
767
  # @param user_secret [String]
728
768
  # @param account_id [String] The ID of the account to update.
@@ -734,6 +774,8 @@ module SnapTrade
734
774
 
735
775
  # Update details of an investment account
736
776
  #
777
+ # Updates various properties of a specified account.
778
+ #
737
779
  # @param user_id [String]
738
780
  # @param user_secret [String]
739
781
  # @param account_id [String] The ID of the account to update.
@@ -743,6 +785,7 @@ module SnapTrade
743
785
  end
744
786
 
745
787
  # Update details of an investment account
788
+ # Updates various properties of a specified account.
746
789
  # @param user_id [String]
747
790
  # @param user_secret [String]
748
791
  # @param account_id [String] The ID of the account to update.
@@ -754,6 +797,7 @@ module SnapTrade
754
797
  end
755
798
 
756
799
  # Update details of an investment account
800
+ # Updates various properties of a specified account.
757
801
  # @param user_id [String]
758
802
  # @param user_secret [String]
759
803
  # @param account_id [String] The ID of the account to update.
@@ -105,6 +105,9 @@ module SnapTrade
105
105
 
106
106
  # Generate encrypted JWT token
107
107
  #
108
+ # This API is available to ClientIDs which have opted to use encrypted
109
+ # JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
110
+ #
108
111
  # @param user_id [String]
109
112
  # @param user_secret [String]
110
113
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -115,6 +118,9 @@ module SnapTrade
115
118
 
116
119
  # Generate encrypted JWT token
117
120
  #
121
+ # This API is available to ClientIDs which have opted to use encrypted
122
+ # JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
123
+ #
118
124
  # @param user_id [String]
119
125
  # @param user_secret [String]
120
126
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -123,6 +129,7 @@ module SnapTrade
123
129
  end
124
130
 
125
131
  # Generate encrypted JWT token
132
+ # This API is available to ClientIDs which have opted to use encrypted JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
126
133
  # @param user_id [String]
127
134
  # @param user_secret [String]
128
135
  # @param [Hash] opts the optional parameters
@@ -133,6 +140,7 @@ module SnapTrade
133
140
  end
134
141
 
135
142
  # Generate encrypted JWT token
143
+ # This API is available to ClientIDs which have opted to use encrypted JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
136
144
  # @param user_id [String]
137
145
  # @param user_secret [String]
138
146
  # @param [Hash] opts the optional parameters
@@ -403,6 +411,9 @@ module SnapTrade
403
411
 
404
412
  # Create SnapTrade user
405
413
  #
414
+ # Registers a new SnapTrade user under your ClientID.
415
+ # Most SnapTrade operations require a user to be passed as a parameter.
416
+ #
406
417
  # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
407
418
  # @param body [SnapTradeRegisterUserRequestBody]
408
419
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -416,6 +427,9 @@ module SnapTrade
416
427
 
417
428
  # Create SnapTrade user
418
429
  #
430
+ # Registers a new SnapTrade user under your ClientID.
431
+ # Most SnapTrade operations require a user to be passed as a parameter.
432
+ #
419
433
  # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
420
434
  # @param body [SnapTradeRegisterUserRequestBody]
421
435
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -427,6 +441,7 @@ module SnapTrade
427
441
  end
428
442
 
429
443
  # Create SnapTrade user
444
+ # Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
430
445
  # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody]
431
446
  # @param [Hash] opts the optional parameters
432
447
  # @return [UserIDandSecret]
@@ -436,6 +451,7 @@ module SnapTrade
436
451
  end
437
452
 
438
453
  # Create SnapTrade user
454
+ # Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
439
455
  # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody]
440
456
  # @param [Hash] opts the optional parameters
441
457
  # @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers
@@ -495,6 +511,9 @@ module SnapTrade
495
511
 
496
512
  # Obtain a new user secret for a user
497
513
  #
514
+ # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret
515
+ # is comprimised or lost among other reasons.
516
+ #
498
517
  # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
499
518
  # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.
500
519
  # @param body [UserIDandSecret]
@@ -510,6 +529,9 @@ module SnapTrade
510
529
 
511
530
  # Obtain a new user secret for a user
512
531
  #
532
+ # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret
533
+ # is comprimised or lost among other reasons.
534
+ #
513
535
  # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it's unique to a user
514
536
  # @param user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This should be considered priviledged information and if compromised, you should delete and re-create this SnapTrade user.
515
537
  # @param body [UserIDandSecret]
@@ -523,6 +545,7 @@ module SnapTrade
523
545
  end
524
546
 
525
547
  # Obtain a new user secret for a user
548
+ # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret is comprimised or lost among other reasons.
526
549
  # @param user_i_dand_secret [UserIDandSecret]
527
550
  # @param [Hash] opts the optional parameters
528
551
  # @return [UserIDandSecret]
@@ -532,6 +555,7 @@ module SnapTrade
532
555
  end
533
556
 
534
557
  # Obtain a new user secret for a user
558
+ # This API is used to generate a new secret for a SnapTrade user. You might use this if a userSecret is comprimised or lost among other reasons.
535
559
  # @param user_i_dand_secret [UserIDandSecret]
536
560
  # @param [Hash] opts the optional parameters
537
561
  # @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers
@@ -98,6 +98,8 @@ module SnapTrade
98
98
 
99
99
  # Get metadata related to Snaptrade partner
100
100
  #
101
+ # Returns useful data related to the specified ClientID, including allowed brokerages and data access.
102
+ #
101
103
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
102
104
  def get_partner_info(extra: {})
103
105
  data, _status_code, _headers = get_partner_info_with_http_info_impl(extra)
@@ -106,12 +108,15 @@ module SnapTrade
106
108
 
107
109
  # Get metadata related to Snaptrade partner
108
110
  #
111
+ # Returns useful data related to the specified ClientID, including allowed brokerages and data access.
112
+ #
109
113
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
110
114
  def get_partner_info_with_http_info(extra: {})
111
115
  get_partner_info_with_http_info_impl(extra)
112
116
  end
113
117
 
114
118
  # Get metadata related to Snaptrade partner
119
+ # Returns useful data related to the specified ClientID, including allowed brokerages and data access.
115
120
  # @param [Hash] opts the optional parameters
116
121
  # @return [PartnerData]
117
122
  private def get_partner_info_impl(opts = {})
@@ -120,6 +125,7 @@ module SnapTrade
120
125
  end
121
126
 
122
127
  # Get metadata related to Snaptrade partner
128
+ # Returns useful data related to the specified ClientID, including allowed brokerages and data access.
123
129
  # @param [Hash] opts the optional parameters
124
130
  # @return [Array<(PartnerData, Integer, Hash)>] PartnerData data, response status code and response headers
125
131
  private def get_partner_info_with_http_info_impl(opts = {})
@@ -775,6 +781,10 @@ module SnapTrade
775
781
 
776
782
  # Search for symbols available in an account
777
783
  #
784
+ # Returns a list of universal symbols that are supported by
785
+ # the specificied account. Returned symbols are based on the
786
+ # provided search string, matching on ticker and name.
787
+ #
778
788
  # @param user_id [String]
779
789
  # @param user_secret [String]
780
790
  # @param account_id [String] The ID of the account to search for symbols within.
@@ -791,6 +801,10 @@ module SnapTrade
791
801
 
792
802
  # Search for symbols available in an account
793
803
  #
804
+ # Returns a list of universal symbols that are supported by
805
+ # the specificied account. Returned symbols are based on the
806
+ # provided search string, matching on ticker and name.
807
+ #
794
808
  # @param user_id [String]
795
809
  # @param user_secret [String]
796
810
  # @param account_id [String] The ID of the account to search for symbols within.
@@ -805,6 +819,7 @@ module SnapTrade
805
819
  end
806
820
 
807
821
  # Search for symbols available in an account
822
+ # Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name.
808
823
  # @param user_id [String]
809
824
  # @param user_secret [String]
810
825
  # @param account_id [String] The ID of the account to search for symbols within.
@@ -817,6 +832,7 @@ module SnapTrade
817
832
  end
818
833
 
819
834
  # Search for symbols available in an account
835
+ # Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name.
820
836
  # @param user_id [String]
821
837
  # @param user_secret [String]
822
838
  # @param account_id [String] The ID of the account to search for symbols within.