snaptrade 1.5.0 → 1.6.0

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: cfbb41c300acc1d64e3c9fea3cc1310822074a131d642ae216325f4eee44d074
4
- data.tar.gz: 5308f919f05089da3f5312ad996ebecf4e15e0702a3c08e38d4f9b5914c34ecc
3
+ metadata.gz: 14075a4d12a4c260869173b2e8192facd70bf9447f4ff4c40b1731b0cb1164d2
4
+ data.tar.gz: 501d4d74ea5f545afb73d283258ba9887c281f154081133176c576d4579b2c98
5
5
  SHA512:
6
- metadata.gz: 75a9403db777dbb546c91da68706a7b78abaa07fcadea441ff434c3480097cb4f42710a07843c771ad1b7058a2f57f4f49edcec1d8d59fb8cfbed55d97c989d2
7
- data.tar.gz: f69564daf8529b3b8f6e7884aede1d42d8dd58ea963fa8a03aae991779ce8721e564222940edaf1462a0b6af8e564b1ac11ab99ad280b890bf242f8325df63c3
6
+ metadata.gz: 201c1932753bad106179cba4a7caffec2b31d5f51149d24f650c09bec64a303d91aa555549e465278f0f34533de6fb0c9c59cdbeae8732de8873c3f86227e36d
7
+ data.tar.gz: bc4347bdeba124ad9cb39b911783de86f936e3e8660ae7cea4683fa455618a3d09ad92c8a1c5b23e54ee401fee55f90f1fc8402c9fb5ac574e9545c8f3476c12
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- snaptrade (1.5.0)
4
+ snaptrade (1.6.0)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
data/README.md CHANGED
@@ -9,7 +9,7 @@ For more information, please visit [https://snaptrade.com/](https://snaptrade.co
9
9
  Add to Gemfile:
10
10
 
11
11
  ```ruby
12
- gem 'snaptrade', '~> 1.5.0'
12
+ gem 'snaptrade', '~> 1.6.0'
13
13
  ```
14
14
 
15
15
  ## Getting Started
@@ -231,7 +231,7 @@ Class | Method | HTTP request | Description
231
231
  - [SnapTrade::SubPeriodReturnRate](docs/SubPeriodReturnRate.md)
232
232
  - [SnapTrade::Symbol](docs/Symbol.md)
233
233
  - [SnapTrade::SymbolQuery](docs/SymbolQuery.md)
234
- - [SnapTrade::SymbolsQuotes](docs/SymbolsQuotes.md)
234
+ - [SnapTrade::SymbolsQuotesInner](docs/SymbolsQuotesInner.md)
235
235
  - [SnapTrade::TargetAsset](docs/TargetAsset.md)
236
236
  - [SnapTrade::TimeInForce](docs/TimeInForce.md)
237
237
  - [SnapTrade::Trade](docs/Trade.md)
@@ -254,10 +254,15 @@ require 'snaptrade'
254
254
  SnapTrade.client_id = "YOUR_CLIENT_ID"
255
255
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
256
256
 
257
+ user_id = "John.doe@snaptrade.com"
258
+ user_secret = "USERSECRET123"
257
259
 
258
260
  begin
259
261
  # Create a new model asset class
260
- result = SnapTrade::PortfolioManagement.create_asset_class
262
+ result = SnapTrade::PortfolioManagement.create_asset_class(
263
+ user_id: user_id,
264
+ user_secret: user_secret,
265
+ )
261
266
  p result
262
267
  rescue SnapTrade::ApiError => e
263
268
  puts "Exception when calling SnapTrade::PortfolioManagement.create_asset_class: #{e}"
@@ -269,10 +274,15 @@ end
269
274
  This returns an Array which contains the response data, status code and headers.
270
275
 
271
276
  ```ruby
277
+ user_id = "John.doe@snaptrade.com"
278
+ user_secret = "USERSECRET123"
272
279
 
273
280
  begin
274
281
  # Create a new model asset class
275
- data, status_code, headers, response = SnapTrade::PortfolioManagement.create_asset_class_with_http_info
282
+ data, status_code, headers, response = SnapTrade::PortfolioManagement.create_asset_class_with_http_info(
283
+ user_id: user_id,
284
+ user_secret: user_secret,
285
+ )
276
286
  p status_code # => 2xx
277
287
  p headers # => { ... }
278
288
  p data # => ModelAssetClassDetails
@@ -283,7 +293,10 @@ end
283
293
 
284
294
  ### Parameters
285
295
 
286
- This endpoint does not need any parameter.
296
+ | Name | Type | Description | Notes |
297
+ | ---- | ---- | ----------- | ----- |
298
+ | **user_id** | **String** | | |
299
+ | **user_secret** | **String** | | |
287
300
 
288
301
  ### Return type
289
302
 
@@ -631,11 +644,15 @@ SnapTrade.client_id = "YOUR_CLIENT_ID"
631
644
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
632
645
 
633
646
  model_asset_class_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
647
+ user_id = "John.doe@snaptrade.com"
648
+ user_secret = "USERSECRET123"
634
649
 
635
650
  begin
636
651
  # Get details of a model asset class
637
652
  result = SnapTrade::PortfolioManagement.detail_asset_class(
638
653
  model_asset_class_id: model_asset_class_id,
654
+ user_id: user_id,
655
+ user_secret: user_secret,
639
656
  )
640
657
  p result
641
658
  rescue SnapTrade::ApiError => e
@@ -649,11 +666,15 @@ This returns an Array which contains the response data, status code and headers.
649
666
 
650
667
  ```ruby
651
668
  model_asset_class_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
669
+ user_id = "John.doe@snaptrade.com"
670
+ user_secret = "USERSECRET123"
652
671
 
653
672
  begin
654
673
  # Get details of a model asset class
655
674
  data, status_code, headers, response = SnapTrade::PortfolioManagement.detail_asset_class_with_http_info(
656
675
  model_asset_class_id: model_asset_class_id,
676
+ user_id: user_id,
677
+ user_secret: user_secret,
657
678
  )
658
679
  p status_code # => 2xx
659
680
  p headers # => { ... }
@@ -668,6 +689,8 @@ end
668
689
  | Name | Type | Description | Notes |
669
690
  | ---- | ---- | ----------- | ----- |
670
691
  | **model_asset_class_id** | **String** | The ID of the model asset class to get. | |
692
+ | **user_id** | **String** | | |
693
+ | **user_secret** | **String** | | |
671
694
 
672
695
  ### Return type
673
696
 
@@ -1310,10 +1333,15 @@ require 'snaptrade'
1310
1333
  SnapTrade.client_id = "YOUR_CLIENT_ID"
1311
1334
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
1312
1335
 
1336
+ user_id = "John.doe@snaptrade.com"
1337
+ user_secret = "USERSECRET123"
1313
1338
 
1314
1339
  begin
1315
1340
  # List of model asset class
1316
- result = SnapTrade::PortfolioManagement.list_asset_classes
1341
+ result = SnapTrade::PortfolioManagement.list_asset_classes(
1342
+ user_id: user_id,
1343
+ user_secret: user_secret,
1344
+ )
1317
1345
  p result
1318
1346
  rescue SnapTrade::ApiError => e
1319
1347
  puts "Exception when calling SnapTrade::PortfolioManagement.list_asset_classes: #{e}"
@@ -1325,10 +1353,15 @@ end
1325
1353
  This returns an Array which contains the response data, status code and headers.
1326
1354
 
1327
1355
  ```ruby
1356
+ user_id = "John.doe@snaptrade.com"
1357
+ user_secret = "USERSECRET123"
1328
1358
 
1329
1359
  begin
1330
1360
  # List of model asset class
1331
- data, status_code, headers, response = SnapTrade::PortfolioManagement.list_asset_classes_with_http_info
1361
+ data, status_code, headers, response = SnapTrade::PortfolioManagement.list_asset_classes_with_http_info(
1362
+ user_id: user_id,
1363
+ user_secret: user_secret,
1364
+ )
1332
1365
  p status_code # => 2xx
1333
1366
  p headers # => { ... }
1334
1367
  p data # => Array<ModelAssetClassDetails>
@@ -1339,7 +1372,10 @@ end
1339
1372
 
1340
1373
  ### Parameters
1341
1374
 
1342
- This endpoint does not need any parameter.
1375
+ | Name | Type | Description | Notes |
1376
+ | ---- | ---- | ----------- | ----- |
1377
+ | **user_id** | **String** | | |
1378
+ | **user_secret** | **String** | | |
1343
1379
 
1344
1380
  ### Return type
1345
1381
 
@@ -1804,6 +1840,8 @@ SnapTrade.client_id = "YOUR_CLIENT_ID"
1804
1840
  SnapTrade.consumer_key = "YOUR_CONSUMER_KEY"
1805
1841
 
1806
1842
  model_asset_class_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
1843
+ user_id = "John.doe@snaptrade.com"
1844
+ user_secret = "USERSECRET123"
1807
1845
  model_asset_class = {
1808
1846
  "id" => "2bcd7cc3-e922-4976-bce1-9858296801c3",
1809
1847
  "name" => "Bonds",
@@ -1817,6 +1855,8 @@ begin
1817
1855
  # Updates model asset class objects
1818
1856
  SnapTrade::PortfolioManagement.update_asset_class(
1819
1857
  model_asset_class_id: model_asset_class_id,
1858
+ user_id: user_id,
1859
+ user_secret: user_secret,
1820
1860
  model_asset_class: model_asset_class,
1821
1861
  model_asset_class_target: model_asset_class_target,
1822
1862
  )
@@ -1831,6 +1871,8 @@ This returns an Array which contains the response data (`nil` in this case), sta
1831
1871
 
1832
1872
  ```ruby
1833
1873
  model_asset_class_id = "2bcd7cc3-e922-4976-bce1-9858296801c3"
1874
+ user_id = "John.doe@snaptrade.com"
1875
+ user_secret = "USERSECRET123"
1834
1876
  model_asset_class = {
1835
1877
  "id" => "2bcd7cc3-e922-4976-bce1-9858296801c3",
1836
1878
  "name" => "Bonds",
@@ -1844,6 +1886,8 @@ begin
1844
1886
  # Updates model asset class objects
1845
1887
  data, status_code, headers, response = SnapTrade::PortfolioManagement.update_asset_class_with_http_info(
1846
1888
  model_asset_class_id: model_asset_class_id,
1889
+ user_id: user_id,
1890
+ user_secret: user_secret,
1847
1891
  model_asset_class: model_asset_class,
1848
1892
  model_asset_class_target: model_asset_class_target,
1849
1893
  )
@@ -1860,6 +1904,8 @@ end
1860
1904
  | Name | Type | Description | Notes |
1861
1905
  | ---- | ---- | ----------- | ----- |
1862
1906
  | **model_asset_class_id** | **String** | The ID of the model asset class to update. | |
1907
+ | **user_id** | **String** | | |
1908
+ | **user_secret** | **String** | | |
1863
1909
  | **model_asset_class_details** | [**ModelAssetClassDetails**](ModelAssetClassDetails.md) | Use this endpoint change model asset class name and to add or remove a model asset class target. &lt;br /&gt;&lt;br /&gt; * Only the model asset class name is required for the model asset class object. &lt;br /&gt; * Only the symbol id is required for the symbol object in the model asset class target object. &lt;br /&gt; * To remove all model asset class targets, set the model asset class target as an empty array | |
1864
1910
 
1865
1911
  ### Return type
@@ -1,4 +1,4 @@
1
- # SnapTrade::SymbolsQuotes
1
+ # SnapTrade::SymbolsQuotesInner
2
2
 
3
3
  ## Properties
4
4
 
@@ -16,7 +16,7 @@
16
16
  ```ruby
17
17
  require 'snaptrade'
18
18
 
19
- instance = SnapTrade::SymbolsQuotes.new(
19
+ instance = SnapTrade::SymbolsQuotesInner.new(
20
20
  symbol: null,
21
21
  bid_price: 8.43,
22
22
  ask_price: 8.43,
data/docs/TradingApi.md CHANGED
@@ -358,7 +358,7 @@ begin
358
358
  )
359
359
  p status_code # => 2xx
360
360
  p headers # => { ... }
361
- p data # => SymbolsQuotes
361
+ p data # => Array<SymbolsQuotesInner>
362
362
  rescue SnapTrade::ApiError => e
363
363
  puts "Exception when calling SnapTrade::Trading.get_user_account_quotes: #{e}"
364
364
  end
@@ -376,7 +376,7 @@ end
376
376
 
377
377
  ### Return type
378
378
 
379
- [**SymbolsQuotes**](SymbolsQuotes.md)
379
+ [**Array&lt;SymbolsQuotesInner&gt;**](SymbolsQuotesInner.md)
380
380
 
381
381
  ## modify_calculated_trade_by_id
382
382
 
@@ -257,40 +257,58 @@ module SnapTrade
257
257
 
258
258
 
259
259
  # Create a new model asset class
260
+ # @param user_id [String]
261
+ # @param user_secret [String]
260
262
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
261
- def create_asset_class(extra: {})
263
+ def create_asset_class(user_id:, user_secret:, extra: {})
262
264
 
263
- data, _status_code, _headers = create_asset_class_with_http_info_impl(extra)
265
+ data, _status_code, _headers = create_asset_class_with_http_info_impl(user_id, user_secret, extra)
264
266
  data
265
267
  end
266
268
 
267
269
  # Create a new model asset class
270
+ # @param user_id [String]
271
+ # @param user_secret [String]
268
272
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
269
- def create_asset_class_with_http_info(extra: {})
273
+ def create_asset_class_with_http_info(user_id:, user_secret:, extra: {})
270
274
 
271
- create_asset_class_with_http_info_impl(extra)
275
+ create_asset_class_with_http_info_impl(user_id, user_secret, extra)
272
276
  end
273
277
 
274
278
  # Create a new model asset class
279
+ # @param user_id [String]
280
+ # @param user_secret [String]
275
281
  # @param [Hash] opts the optional parameters
276
282
  # @return [ModelAssetClassDetails]
277
- def create_asset_class_impl(opts = {})
278
- data, _status_code, _headers = create_asset_class_with_http_info(opts)
283
+ def create_asset_class_impl(user_id, user_secret, opts = {})
284
+ data, _status_code, _headers = create_asset_class_with_http_info(user_id, user_secret, opts)
279
285
  data
280
286
  end
281
287
 
282
288
  # Create a new model asset class
289
+ # @param user_id [String]
290
+ # @param user_secret [String]
283
291
  # @param [Hash] opts the optional parameters
284
292
  # @return [Array<(ModelAssetClassDetails, Integer, Hash)>] ModelAssetClassDetails data, response status code and response headers
285
- def create_asset_class_with_http_info_impl(opts = {})
293
+ def create_asset_class_with_http_info_impl(user_id, user_secret, opts = {})
286
294
  if @api_client.config.debugging
287
295
  @api_client.config.logger.debug 'Calling API: PortfolioManagementApi.create_asset_class ...'
288
296
  end
297
+ # verify the required parameter 'user_id' is set
298
+ if @api_client.config.client_side_validation && user_id.nil?
299
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling PortfolioManagementApi.create_asset_class"
300
+ end
301
+ # verify the required parameter 'user_secret' is set
302
+ if @api_client.config.client_side_validation && user_secret.nil?
303
+ fail ArgumentError, "Missing the required parameter 'user_secret' when calling PortfolioManagementApi.create_asset_class"
304
+ end
289
305
  # resource path
290
306
  local_var_path = '/modelAssetClass'
291
307
 
292
308
  # query parameters
293
309
  query_params = opts[:query_params] || {}
310
+ query_params[:'userId'] = user_id
311
+ query_params[:'userSecret'] = user_secret
294
312
 
295
313
  # header parameters
296
314
  header_params = opts[:header_params] || {}
@@ -805,35 +823,43 @@ module SnapTrade
805
823
 
806
824
  # Get details of a model asset class
807
825
  # @param model_asset_class_id [String] The ID of the model asset class to get.
826
+ # @param user_id [String]
827
+ # @param user_secret [String]
808
828
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
809
- def detail_asset_class(model_asset_class_id:, extra: {})
829
+ def detail_asset_class(model_asset_class_id:, user_id:, user_secret:, extra: {})
810
830
 
811
- data, _status_code, _headers = detail_asset_class_with_http_info_impl(model_asset_class_id, extra)
831
+ data, _status_code, _headers = detail_asset_class_with_http_info_impl(model_asset_class_id, user_id, user_secret, extra)
812
832
  data
813
833
  end
814
834
 
815
835
  # Get details of a model asset class
816
836
  # @param model_asset_class_id [String] The ID of the model asset class to get.
837
+ # @param user_id [String]
838
+ # @param user_secret [String]
817
839
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
818
- def detail_asset_class_with_http_info(model_asset_class_id:, extra: {})
840
+ def detail_asset_class_with_http_info(model_asset_class_id:, user_id:, user_secret:, extra: {})
819
841
 
820
- detail_asset_class_with_http_info_impl(model_asset_class_id, extra)
842
+ detail_asset_class_with_http_info_impl(model_asset_class_id, user_id, user_secret, extra)
821
843
  end
822
844
 
823
845
  # Get details of a model asset class
824
846
  # @param model_asset_class_id [String] The ID of the model asset class to get.
847
+ # @param user_id [String]
848
+ # @param user_secret [String]
825
849
  # @param [Hash] opts the optional parameters
826
850
  # @return [ModelAssetClassDetails]
827
- def detail_asset_class_impl(model_asset_class_id, opts = {})
828
- data, _status_code, _headers = detail_asset_class_with_http_info(model_asset_class_id, opts)
851
+ def detail_asset_class_impl(model_asset_class_id, user_id, user_secret, opts = {})
852
+ data, _status_code, _headers = detail_asset_class_with_http_info(model_asset_class_id, user_id, user_secret, opts)
829
853
  data
830
854
  end
831
855
 
832
856
  # Get details of a model asset class
833
857
  # @param model_asset_class_id [String] The ID of the model asset class to get.
858
+ # @param user_id [String]
859
+ # @param user_secret [String]
834
860
  # @param [Hash] opts the optional parameters
835
861
  # @return [Array<(ModelAssetClassDetails, Integer, Hash)>] ModelAssetClassDetails data, response status code and response headers
836
- def detail_asset_class_with_http_info_impl(model_asset_class_id, opts = {})
862
+ def detail_asset_class_with_http_info_impl(model_asset_class_id, user_id, user_secret, opts = {})
837
863
  if @api_client.config.debugging
838
864
  @api_client.config.logger.debug 'Calling API: PortfolioManagementApi.detail_asset_class ...'
839
865
  end
@@ -841,11 +867,21 @@ module SnapTrade
841
867
  if @api_client.config.client_side_validation && model_asset_class_id.nil?
842
868
  fail ArgumentError, "Missing the required parameter 'model_asset_class_id' when calling PortfolioManagementApi.detail_asset_class"
843
869
  end
870
+ # verify the required parameter 'user_id' is set
871
+ if @api_client.config.client_side_validation && user_id.nil?
872
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling PortfolioManagementApi.detail_asset_class"
873
+ end
874
+ # verify the required parameter 'user_secret' is set
875
+ if @api_client.config.client_side_validation && user_secret.nil?
876
+ fail ArgumentError, "Missing the required parameter 'user_secret' when calling PortfolioManagementApi.detail_asset_class"
877
+ end
844
878
  # resource path
845
879
  local_var_path = '/modelAssetClass/{modelAssetClassId}'.sub('{' + 'modelAssetClassId' + '}', CGI.escape(model_asset_class_id.to_s))
846
880
 
847
881
  # query parameters
848
882
  query_params = opts[:query_params] || {}
883
+ query_params[:'userId'] = user_id
884
+ query_params[:'userSecret'] = user_secret
849
885
 
850
886
  # header parameters
851
887
  header_params = opts[:header_params] || {}
@@ -1786,40 +1822,58 @@ module SnapTrade
1786
1822
 
1787
1823
 
1788
1824
  # List of model asset class
1825
+ # @param user_id [String]
1826
+ # @param user_secret [String]
1789
1827
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1790
- def list_asset_classes(extra: {})
1828
+ def list_asset_classes(user_id:, user_secret:, extra: {})
1791
1829
 
1792
- data, _status_code, _headers = list_asset_classes_with_http_info_impl(extra)
1830
+ data, _status_code, _headers = list_asset_classes_with_http_info_impl(user_id, user_secret, extra)
1793
1831
  data
1794
1832
  end
1795
1833
 
1796
1834
  # List of model asset class
1835
+ # @param user_id [String]
1836
+ # @param user_secret [String]
1797
1837
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1798
- def list_asset_classes_with_http_info(extra: {})
1838
+ def list_asset_classes_with_http_info(user_id:, user_secret:, extra: {})
1799
1839
 
1800
- list_asset_classes_with_http_info_impl(extra)
1840
+ list_asset_classes_with_http_info_impl(user_id, user_secret, extra)
1801
1841
  end
1802
1842
 
1803
1843
  # List of model asset class
1844
+ # @param user_id [String]
1845
+ # @param user_secret [String]
1804
1846
  # @param [Hash] opts the optional parameters
1805
1847
  # @return [Array<ModelAssetClassDetails>]
1806
- def list_asset_classes_impl(opts = {})
1807
- data, _status_code, _headers = list_asset_classes_with_http_info(opts)
1848
+ def list_asset_classes_impl(user_id, user_secret, opts = {})
1849
+ data, _status_code, _headers = list_asset_classes_with_http_info(user_id, user_secret, opts)
1808
1850
  data
1809
1851
  end
1810
1852
 
1811
1853
  # List of model asset class
1854
+ # @param user_id [String]
1855
+ # @param user_secret [String]
1812
1856
  # @param [Hash] opts the optional parameters
1813
1857
  # @return [Array<(Array<ModelAssetClassDetails>, Integer, Hash)>] Array<ModelAssetClassDetails> data, response status code and response headers
1814
- def list_asset_classes_with_http_info_impl(opts = {})
1858
+ def list_asset_classes_with_http_info_impl(user_id, user_secret, opts = {})
1815
1859
  if @api_client.config.debugging
1816
1860
  @api_client.config.logger.debug 'Calling API: PortfolioManagementApi.list_asset_classes ...'
1817
1861
  end
1862
+ # verify the required parameter 'user_id' is set
1863
+ if @api_client.config.client_side_validation && user_id.nil?
1864
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling PortfolioManagementApi.list_asset_classes"
1865
+ end
1866
+ # verify the required parameter 'user_secret' is set
1867
+ if @api_client.config.client_side_validation && user_secret.nil?
1868
+ fail ArgumentError, "Missing the required parameter 'user_secret' when calling PortfolioManagementApi.list_asset_classes"
1869
+ end
1818
1870
  # resource path
1819
1871
  local_var_path = '/modelAssetClass'
1820
1872
 
1821
1873
  # query parameters
1822
1874
  query_params = opts[:query_params] || {}
1875
+ query_params[:'userId'] = user_id
1876
+ query_params[:'userSecret'] = user_secret
1823
1877
 
1824
1878
  # header parameters
1825
1879
  header_params = opts[:header_params] || {}
@@ -2483,51 +2537,59 @@ module SnapTrade
2483
2537
 
2484
2538
  # Updates model asset class objects
2485
2539
  # @param model_asset_class_id [String] The ID of the model asset class to update.
2540
+ # @param user_id [String]
2541
+ # @param user_secret [String]
2486
2542
  # @param model_asset_class [ModelAssetClass]
2487
2543
  # @param model_asset_class_target [Array<ModelAssetClassTarget>]
2488
2544
  # @param body [ModelAssetClassDetails] Use this endpoint change model asset class name and to add or remove a model asset class target. &lt;br /&gt;&lt;br /&gt; * Only the model asset class name is required for the model asset class object. &lt;br /&gt; * Only the symbol id is required for the symbol object in the model asset class target object. &lt;br /&gt; * To remove all model asset class targets, set the model asset class target as an empty array
2489
2545
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
2490
- def update_asset_class(model_asset_class_id:, model_asset_class: SENTINEL, model_asset_class_target: SENTINEL, extra: {})
2546
+ def update_asset_class(model_asset_class_id:, user_id:, user_secret:, model_asset_class: SENTINEL, model_asset_class_target: SENTINEL, extra: {})
2491
2547
  _body = {}
2492
2548
  _body[:model_asset_class] = model_asset_class if model_asset_class != SENTINEL
2493
2549
  _body[:model_asset_class_target] = model_asset_class_target if model_asset_class_target != SENTINEL
2494
2550
  model_asset_class_details = _body
2495
2551
 
2496
- update_asset_class_with_http_info_impl(model_asset_class_id, model_asset_class_details, extra)
2552
+ update_asset_class_with_http_info_impl(model_asset_class_id, user_id, user_secret, model_asset_class_details, extra)
2497
2553
  nil
2498
2554
  end
2499
2555
 
2500
2556
  # Updates model asset class objects
2501
2557
  # @param model_asset_class_id [String] The ID of the model asset class to update.
2558
+ # @param user_id [String]
2559
+ # @param user_secret [String]
2502
2560
  # @param model_asset_class [ModelAssetClass]
2503
2561
  # @param model_asset_class_target [Array<ModelAssetClassTarget>]
2504
2562
  # @param body [ModelAssetClassDetails] Use this endpoint change model asset class name and to add or remove a model asset class target. &lt;br /&gt;&lt;br /&gt; * Only the model asset class name is required for the model asset class object. &lt;br /&gt; * Only the symbol id is required for the symbol object in the model asset class target object. &lt;br /&gt; * To remove all model asset class targets, set the model asset class target as an empty array
2505
2563
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
2506
- def update_asset_class_with_http_info(model_asset_class_id:, model_asset_class: SENTINEL, model_asset_class_target: SENTINEL, extra: {})
2564
+ def update_asset_class_with_http_info(model_asset_class_id:, user_id:, user_secret:, model_asset_class: SENTINEL, model_asset_class_target: SENTINEL, extra: {})
2507
2565
  _body = {}
2508
2566
  _body[:model_asset_class] = model_asset_class if model_asset_class != SENTINEL
2509
2567
  _body[:model_asset_class_target] = model_asset_class_target if model_asset_class_target != SENTINEL
2510
2568
  model_asset_class_details = _body
2511
2569
 
2512
- update_asset_class_with_http_info_impl(model_asset_class_id, model_asset_class_details, extra)
2570
+ update_asset_class_with_http_info_impl(model_asset_class_id, user_id, user_secret, model_asset_class_details, extra)
2513
2571
  end
2514
2572
 
2515
2573
  # Updates model asset class objects
2516
2574
  # @param model_asset_class_id [String] The ID of the model asset class to update.
2575
+ # @param user_id [String]
2576
+ # @param user_secret [String]
2517
2577
  # @param model_asset_class_details [ModelAssetClassDetails] Use this endpoint change model asset class name and to add or remove a model asset class target. &lt;br /&gt;&lt;br /&gt; * Only the model asset class name is required for the model asset class object. &lt;br /&gt; * Only the symbol id is required for the symbol object in the model asset class target object. &lt;br /&gt; * To remove all model asset class targets, set the model asset class target as an empty array
2518
2578
  # @param [Hash] opts the optional parameters
2519
2579
  # @return [nil]
2520
- def update_asset_class_impl(model_asset_class_id, model_asset_class_details, opts = {})
2521
- update_asset_class_with_http_info(model_asset_class_id, model_asset_class_details, opts)
2580
+ def update_asset_class_impl(model_asset_class_id, user_id, user_secret, model_asset_class_details, opts = {})
2581
+ update_asset_class_with_http_info(model_asset_class_id, user_id, user_secret, model_asset_class_details, opts)
2522
2582
  nil
2523
2583
  end
2524
2584
 
2525
2585
  # Updates model asset class objects
2526
2586
  # @param model_asset_class_id [String] The ID of the model asset class to update.
2587
+ # @param user_id [String]
2588
+ # @param user_secret [String]
2527
2589
  # @param model_asset_class_details [ModelAssetClassDetails] Use this endpoint change model asset class name and to add or remove a model asset class target. &lt;br /&gt;&lt;br /&gt; * Only the model asset class name is required for the model asset class object. &lt;br /&gt; * Only the symbol id is required for the symbol object in the model asset class target object. &lt;br /&gt; * To remove all model asset class targets, set the model asset class target as an empty array
2528
2590
  # @param [Hash] opts the optional parameters
2529
2591
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2530
- def update_asset_class_with_http_info_impl(model_asset_class_id, model_asset_class_details, opts = {})
2592
+ def update_asset_class_with_http_info_impl(model_asset_class_id, user_id, user_secret, model_asset_class_details, opts = {})
2531
2593
  if @api_client.config.debugging
2532
2594
  @api_client.config.logger.debug 'Calling API: PortfolioManagementApi.update_asset_class ...'
2533
2595
  end
@@ -2535,6 +2597,14 @@ module SnapTrade
2535
2597
  if @api_client.config.client_side_validation && model_asset_class_id.nil?
2536
2598
  fail ArgumentError, "Missing the required parameter 'model_asset_class_id' when calling PortfolioManagementApi.update_asset_class"
2537
2599
  end
2600
+ # verify the required parameter 'user_id' is set
2601
+ if @api_client.config.client_side_validation && user_id.nil?
2602
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling PortfolioManagementApi.update_asset_class"
2603
+ end
2604
+ # verify the required parameter 'user_secret' is set
2605
+ if @api_client.config.client_side_validation && user_secret.nil?
2606
+ fail ArgumentError, "Missing the required parameter 'user_secret' when calling PortfolioManagementApi.update_asset_class"
2607
+ end
2538
2608
  # verify the required parameter 'model_asset_class_details' is set
2539
2609
  if @api_client.config.client_side_validation && model_asset_class_details.nil?
2540
2610
  fail ArgumentError, "Missing the required parameter 'model_asset_class_details' when calling PortfolioManagementApi.update_asset_class"
@@ -2544,6 +2614,8 @@ module SnapTrade
2544
2614
 
2545
2615
  # query parameters
2546
2616
  query_params = opts[:query_params] || {}
2617
+ query_params[:'userId'] = user_id
2618
+ query_params[:'userSecret'] = user_secret
2547
2619
 
2548
2620
  # header parameters
2549
2621
  header_params = opts[:header_params] || {}
@@ -490,7 +490,7 @@ module SnapTrade
490
490
  # @param account_id [String] The ID of the account to get quotes.
491
491
  # @param [Hash] opts the optional parameters
492
492
  # @option opts [Boolean] :use_ticker Should be set to True if providing tickers.
493
- # @return [SymbolsQuotes]
493
+ # @return [Array<SymbolsQuotesInner>]
494
494
  def get_user_account_quotes_impl(user_id, user_secret, symbols, account_id, opts = {})
495
495
  data, _status_code, _headers = get_user_account_quotes_with_http_info(user_id, user_secret, symbols, account_id, opts)
496
496
  data
@@ -503,7 +503,7 @@ module SnapTrade
503
503
  # @param account_id [String] The ID of the account to get quotes.
504
504
  # @param [Hash] opts the optional parameters
505
505
  # @option opts [Boolean] :use_ticker Should be set to True if providing tickers.
506
- # @return [Array<(SymbolsQuotes, Integer, Hash)>] SymbolsQuotes data, response status code and response headers
506
+ # @return [Array<(Array<SymbolsQuotesInner>, Integer, Hash)>] Array<SymbolsQuotesInner> data, response status code and response headers
507
507
  def get_user_account_quotes_with_http_info_impl(user_id, user_secret, symbols, account_id, opts = {})
508
508
  if @api_client.config.debugging
509
509
  @api_client.config.logger.debug 'Calling API: TradingApi.get_user_account_quotes ...'
@@ -546,7 +546,7 @@ module SnapTrade
546
546
  post_body = opts[:debug_body]
547
547
 
548
548
  # return_type
549
- return_type = opts[:debug_return_type] || 'SymbolsQuotes'
549
+ return_type = opts[:debug_return_type] || 'Array<SymbolsQuotesInner>'
550
550
 
551
551
  # auth_names
552
552
  auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
@@ -12,8 +12,7 @@ require 'date'
12
12
  require 'time'
13
13
 
14
14
  module SnapTrade
15
- # Symbols and Tickers Quotes object
16
- class SymbolsQuotes
15
+ class SymbolsQuotesInner
17
16
  attr_accessor :symbol
18
17
 
19
18
  attr_accessor :bid_price
@@ -65,13 +64,13 @@ module SnapTrade
65
64
  # @param [Hash] attributes Model attributes in the form of hash
66
65
  def initialize(attributes = {})
67
66
  if (!attributes.is_a?(Hash))
68
- fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::SymbolsQuotes` initialize method"
67
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::SymbolsQuotesInner` initialize method"
69
68
  end
70
69
 
71
70
  # check to see if the attribute exists and convert string to symbol for hash key
72
71
  attributes = attributes.each_with_object({}) { |(k, v), h|
73
72
  if (!self.class.attribute_map.key?(k.to_sym))
74
- fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::SymbolsQuotes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
73
+ fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::SymbolsQuotesInner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
75
74
  end
76
75
  h[k.to_sym] = v
77
76
  }
@@ -9,5 +9,5 @@ Contact: api@snaptrade.com
9
9
  =end
10
10
 
11
11
  module SnapTrade
12
- VERSION = '1.5.0'
12
+ VERSION = '1.6.0'
13
13
  end
data/lib/snaptrade.rb CHANGED
@@ -122,7 +122,7 @@ require 'snaptrade/models/strategy_type'
122
122
  require 'snaptrade/models/sub_period_return_rate'
123
123
  require 'snaptrade/models/symbol'
124
124
  require 'snaptrade/models/symbol_query'
125
- require 'snaptrade/models/symbols_quotes'
125
+ require 'snaptrade/models/symbols_quotes_inner'
126
126
  require 'snaptrade/models/target_asset'
127
127
  require 'snaptrade/models/time_in_force'
128
128
  require 'snaptrade/models/trade'
@@ -55,6 +55,8 @@ describe 'PortfolioManagementApi' do
55
55
 
56
56
  # unit tests for create_asset_class
57
57
  # Create a new model asset class
58
+ # @param user_id
59
+ # @param user_secret
58
60
  # @param [Hash] opts the optional parameters
59
61
  # @return [ModelAssetClassDetails]
60
62
  describe 'create_asset_class test' do
@@ -133,6 +135,8 @@ describe 'PortfolioManagementApi' do
133
135
  # unit tests for detail_asset_class
134
136
  # Get details of a model asset class
135
137
  # @param model_asset_class_id The ID of the model asset class to get.
138
+ # @param user_id
139
+ # @param user_secret
136
140
  # @param [Hash] opts the optional parameters
137
141
  # @return [ModelAssetClassDetails]
138
142
  describe 'detail_asset_class test' do
@@ -268,6 +272,8 @@ describe 'PortfolioManagementApi' do
268
272
 
269
273
  # unit tests for list_asset_classes
270
274
  # List of model asset class
275
+ # @param user_id
276
+ # @param user_secret
271
277
  # @param [Hash] opts the optional parameters
272
278
  # @return [Array<ModelAssetClassDetails>]
273
279
  describe 'list_asset_classes test' do
@@ -359,6 +365,8 @@ describe 'PortfolioManagementApi' do
359
365
  # unit tests for update_asset_class
360
366
  # Updates model asset class objects
361
367
  # @param model_asset_class_id The ID of the model asset class to update.
368
+ # @param user_id
369
+ # @param user_secret
362
370
  # @param model_asset_class_details Use this endpoint change model asset class name and to add or remove a model asset class target. &lt;br /&gt;&lt;br /&gt; * Only the model asset class name is required for the model asset class object. &lt;br /&gt; * Only the symbol id is required for the symbol object in the model asset class target object. &lt;br /&gt; * To remove all model asset class targets, set the model asset class target as an empty array
363
371
  # @param [Hash] opts the optional parameters
364
372
  # @return [nil]
@@ -88,7 +88,7 @@ describe 'TradingApi' do
88
88
  # @param account_id The ID of the account to get quotes.
89
89
  # @param [Hash] opts the optional parameters
90
90
  # @option opts [Boolean] :use_ticker Should be set to True if providing tickers.
91
- # @return [SymbolsQuotes]
91
+ # @return [Array<SymbolsQuotesInner>]
92
92
  describe 'get_user_account_quotes test' do
93
93
  it 'should work' do
94
94
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -12,13 +12,13 @@ require 'spec_helper'
12
12
  require 'json'
13
13
  require 'date'
14
14
 
15
- # Unit tests for SnapTrade::SymbolsQuotes
16
- describe SnapTrade::SymbolsQuotes do
17
- let(:instance) { SnapTrade::SymbolsQuotes.new }
15
+ # Unit tests for SnapTrade::SymbolsQuotesInner
16
+ describe SnapTrade::SymbolsQuotesInner do
17
+ let(:instance) { SnapTrade::SymbolsQuotesInner.new }
18
18
 
19
- describe 'test an instance of SymbolsQuotes' do
20
- it 'should create an instance of SymbolsQuotes' do
21
- expect(instance).to be_instance_of(SnapTrade::SymbolsQuotes)
19
+ describe 'test an instance of SymbolsQuotesInner' do
20
+ it 'should create an instance of SymbolsQuotesInner' do
21
+ expect(instance).to be_instance_of(SnapTrade::SymbolsQuotesInner)
22
22
  end
23
23
  end
24
24
  describe 'test attribute "symbol"' do
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: 1.5.0
4
+ version: 1.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - SnapTrade
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-06-07 00:00:00.000000000 Z
11
+ date: 2023-06-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -194,7 +194,7 @@ files:
194
194
  - docs/SubPeriodReturnRate.md
195
195
  - docs/Symbol.md
196
196
  - docs/SymbolQuery.md
197
- - docs/SymbolsQuotes.md
197
+ - docs/SymbolsQuotesInner.md
198
198
  - docs/TargetAsset.md
199
199
  - docs/TimeInForce.md
200
200
  - docs/Trade.md
@@ -336,7 +336,7 @@ files:
336
336
  - lib/snaptrade/models/sub_period_return_rate.rb
337
337
  - lib/snaptrade/models/symbol.rb
338
338
  - lib/snaptrade/models/symbol_query.rb
339
- - lib/snaptrade/models/symbols_quotes.rb
339
+ - lib/snaptrade/models/symbols_quotes_inner.rb
340
340
  - lib/snaptrade/models/target_asset.rb
341
341
  - lib/snaptrade/models/time_in_force.rb
342
342
  - lib/snaptrade/models/trade.rb
@@ -476,7 +476,7 @@ files:
476
476
  - spec/models/sub_period_return_rate_spec.rb
477
477
  - spec/models/symbol_query_spec.rb
478
478
  - spec/models/symbol_spec.rb
479
- - spec/models/symbols_quotes_spec.rb
479
+ - spec/models/symbols_quotes_inner_spec.rb
480
480
  - spec/models/target_asset_spec.rb
481
481
  - spec/models/time_in_force_spec.rb
482
482
  - spec/models/trade_action_spec.rb
@@ -564,7 +564,6 @@ test_files:
564
564
  - spec/models/strategy_order_place_spec.rb
565
565
  - spec/models/model_asset_class_target_spec.rb
566
566
  - spec/models/option_strategy_spec.rb
567
- - spec/models/symbols_quotes_spec.rb
568
567
  - spec/models/strategy_quotes_spec.rb
569
568
  - spec/models/model_asset_class_details_spec.rb
570
569
  - spec/models/manual_trade_and_impact_spec.rb
@@ -657,6 +656,7 @@ test_files:
657
656
  - spec/models/transactions_status_spec.rb
658
657
  - spec/models/brokerage_authorization_type_read_only_spec.rb
659
658
  - spec/models/strategy_order_record_order_type_spec.rb
659
+ - spec/models/symbols_quotes_inner_spec.rb
660
660
  - spec/models/dividend_at_date_spec.rb
661
661
  - spec/models/order_strategy_execute_body_order_type_spec.rb
662
662
  - spec/models/past_value_spec.rb