spartera_api_sdk 1.0.62 → 1.0.68
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 +4 -4
- data/config.json +1 -1
- data/docs/APIKeysApi.md +25 -15
- data/docs/AlertsApi.md +43 -29
- data/docs/AssetPriceHistoryApi.md +48 -32
- data/docs/AssetsApi.md +74 -336
- data/docs/CloudProvidersApi.md +10 -207
- data/docs/CompaniesApi.md +45 -27
- data/docs/ConnectionsApi.md +39 -25
- data/docs/FavoritesApi.md +52 -36
- data/docs/StorageEnginesApi.md +149 -0
- data/docs/UsersApi.md +29 -19
- data/lib/spartera_api_sdk/api/alerts_api.rb +11 -11
- data/lib/spartera_api_sdk/api/api_keys_api.rb +5 -5
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +12 -12
- data/lib/spartera_api_sdk/api/assets_api.rb +26 -302
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +2 -179
- data/lib/spartera_api_sdk/api/companies_api.rb +9 -9
- data/lib/spartera_api_sdk/api/connections_api.rb +9 -9
- data/lib/spartera_api_sdk/api/favorites_api.rb +14 -14
- data/lib/spartera_api_sdk/api/storage_engines_api.rb +150 -0
- data/lib/spartera_api_sdk/api/users_api.rb +7 -7
- data/lib/spartera_api_sdk/configuration.rb +2 -10
- data/lib/spartera_api_sdk/version.rb +1 -1
- data/lib/spartera_api_sdk.rb +1 -0
- data/spec/api/alerts_api_spec.rb +2 -2
- data/spec/api/asset_price_history_api_spec.rb +2 -2
- data/spec/api/assets_api_spec.rb +3 -53
- data/spec/api/cloud_providers_api_spec.rb +0 -32
- data/spec/api/connections_api_spec.rb +1 -1
- data/spec/api/favorites_api_spec.rb +3 -3
- data/spec/api/storage_engines_api_spec.rb +58 -0
- data/spec/api/users_api_spec.rb +1 -1
- metadata +28 -22
- data/Gemfile.lock +0 -69
data/docs/AssetsApi.md
CHANGED
@@ -4,29 +4,25 @@ All URIs are relative to *https://api.spartera.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**analyze_company_handle_assets_asset_slug_get**](AssetsApi.md#analyze_company_handle_assets_asset_slug_get) | **GET** /analyze/{company_handle}/assets/{asset_slug} | Process
|
7
|
+
| [**analyze_company_handle_assets_asset_slug_get**](AssetsApi.md#analyze_company_handle_assets_asset_slug_get) | **GET** /analyze/{company_handle}/assets/{asset_slug} | Process (analyze) an asset. Attempt to process an analytic on a backend warehouse/AI model. |
|
8
8
|
| [**companies_company_id_assets_asset_id_delete**](AssetsApi.md#companies_company_id_assets_asset_id_delete) | **DELETE** /companies/{company_id}/assets/{asset_id} | Delete single asset by ID |
|
9
9
|
| [**companies_company_id_assets_asset_id_get**](AssetsApi.md#companies_company_id_assets_asset_id_get) | **GET** /companies/{company_id}/assets/{asset_id} | Get single asset by ID |
|
10
10
|
| [**companies_company_id_assets_asset_id_infoschema_get**](AssetsApi.md#companies_company_id_assets_asset_id_infoschema_get) | **GET** /companies/{company_id}/assets/{asset_id}/infoschema | Get the information schema for a specific asset's table |
|
11
|
-
| [**companies_company_id_assets_asset_id_infoschema_save_get**](AssetsApi.md#companies_company_id_assets_asset_id_infoschema_save_get) | **GET** /companies/{company_id}/assets/{asset_id}/infoschema/save |
|
11
|
+
| [**companies_company_id_assets_asset_id_infoschema_save_get**](AssetsApi.md#companies_company_id_assets_asset_id_infoschema_save_get) | **GET** /companies/{company_id}/assets/{asset_id}/infoschema/save | Retrieve and save an asset's information schema |
|
12
12
|
| [**companies_company_id_assets_asset_id_patch**](AssetsApi.md#companies_company_id_assets_asset_id_patch) | **PATCH** /companies/{company_id}/assets/{asset_id} | Update an existing asset by ID |
|
13
13
|
| [**companies_company_id_assets_asset_id_predicted_price_get**](AssetsApi.md#companies_company_id_assets_asset_id_predicted_price_get) | **GET** /companies/{company_id}/assets/{asset_id}/predicted_price | Get AI-predicted pricing for a specific asset |
|
14
|
-
| [**companies_company_id_assets_asset_id_recommendations_explain_get**](AssetsApi.md#companies_company_id_assets_asset_id_recommendations_explain_get) | **GET** /companies/{company_id}/assets/{asset_id}/recommendations/explain | Get detailed explanation of how asset recommendations are calculated for debugging purposes. |
|
15
|
-
| [**companies_company_id_assets_asset_id_recommendations_get**](AssetsApi.md#companies_company_id_assets_asset_id_recommendations_get) | **GET** /companies/{company_id}/assets/{asset_id}/recommendations | Get asset recommendations for a specific asset using heuristic waterfall matching Returns list of similar assets based on industry, company, connection, tags, etc. Query Parameters: - limit: Number of recommendations to return (default: 12, max: 50) - min_score: Minimum similarity score threshold (default: 0.1) - include_details: Include component similarity scores (default: false) |
|
16
14
|
| [**companies_company_id_assets_asset_id_statistics_get**](AssetsApi.md#companies_company_id_assets_asset_id_statistics_get) | **GET** /companies/{company_id}/assets/{asset_id}/statistics | Get statistics for a specific asset (public endpoint) |
|
17
15
|
| [**companies_company_id_assets_asset_id_test_get**](AssetsApi.md#companies_company_id_assets_asset_id_test_get) | **GET** /companies/{company_id}/assets/{asset_id}/test | Test out an Asset (on a subset of data) |
|
18
16
|
| [**companies_company_id_assets_get**](AssetsApi.md#companies_company_id_assets_get) | **GET** /companies/{company_id}/assets | Get all assets for a specific company |
|
19
17
|
| [**companies_company_id_assets_post**](AssetsApi.md#companies_company_id_assets_post) | **POST** /companies/{company_id}/assets | Create a new asset |
|
20
|
-
| [**companies_company_id_assets_recommendations_bulk_post**](AssetsApi.md#companies_company_id_assets_recommendations_bulk_post) | **POST** /companies/{company_id}/assets/recommendations/bulk | Get recommendations for multiple assets in a single request. Useful for pre-loading recommendations. |
|
21
|
-
| [**companies_company_id_assets_recommendations_health_get**](AssetsApi.md#companies_company_id_assets_recommendations_health_get) | **GET** /companies/{company_id}/assets/recommendations/health | Health check for the recommendations system with sample data and performance metrics. |
|
22
18
|
| [**companies_company_id_assets_statistics_get**](AssetsApi.md#companies_company_id_assets_statistics_get) | **GET** /companies/{company_id}/assets/statistics | Get statistics for all assets the user has access to |
|
23
19
|
|
24
20
|
|
25
21
|
## analyze_company_handle_assets_asset_slug_get
|
26
22
|
|
27
|
-
> Object analyze_company_handle_assets_asset_slug_get(
|
23
|
+
> Object analyze_company_handle_assets_asset_slug_get(asset_slug, company_handle)
|
28
24
|
|
29
|
-
Process
|
25
|
+
Process (analyze) an asset. Attempt to process an analytic on a backend warehouse/AI model.
|
30
26
|
|
31
27
|
### Examples
|
32
28
|
|
@@ -35,17 +31,19 @@ require 'time'
|
|
35
31
|
require 'spartera_api_sdk'
|
36
32
|
# setup authorization
|
37
33
|
SparteraApiSdk.configure do |config|
|
38
|
-
# Configure
|
39
|
-
config.
|
34
|
+
# Configure API key authorization: ApiKeyAuth
|
35
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
37
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
40
38
|
end
|
41
39
|
|
42
40
|
api_instance = SparteraApiSdk::AssetsApi.new
|
43
|
-
company_handle = 'company_handle_example' # String |
|
44
41
|
asset_slug = 'asset_slug_example' # String |
|
42
|
+
company_handle = 'company_handle_example' # String |
|
45
43
|
|
46
44
|
begin
|
47
|
-
# Process
|
48
|
-
result = api_instance.analyze_company_handle_assets_asset_slug_get(
|
45
|
+
# Process (analyze) an asset. Attempt to process an analytic on a backend warehouse/AI model.
|
46
|
+
result = api_instance.analyze_company_handle_assets_asset_slug_get(asset_slug, company_handle)
|
49
47
|
p result
|
50
48
|
rescue SparteraApiSdk::ApiError => e
|
51
49
|
puts "Error when calling AssetsApi->analyze_company_handle_assets_asset_slug_get: #{e}"
|
@@ -56,12 +54,12 @@ end
|
|
56
54
|
|
57
55
|
This returns an Array which contains the response data, status code and headers.
|
58
56
|
|
59
|
-
> <Array(Object, Integer, Hash)> analyze_company_handle_assets_asset_slug_get_with_http_info(
|
57
|
+
> <Array(Object, Integer, Hash)> analyze_company_handle_assets_asset_slug_get_with_http_info(asset_slug, company_handle)
|
60
58
|
|
61
59
|
```ruby
|
62
60
|
begin
|
63
|
-
# Process
|
64
|
-
data, status_code, headers = api_instance.analyze_company_handle_assets_asset_slug_get_with_http_info(
|
61
|
+
# Process (analyze) an asset. Attempt to process an analytic on a backend warehouse/AI model.
|
62
|
+
data, status_code, headers = api_instance.analyze_company_handle_assets_asset_slug_get_with_http_info(asset_slug, company_handle)
|
65
63
|
p status_code # => 2xx
|
66
64
|
p headers # => { ... }
|
67
65
|
p data # => Object
|
@@ -74,8 +72,8 @@ end
|
|
74
72
|
|
75
73
|
| Name | Type | Description | Notes |
|
76
74
|
| ---- | ---- | ----------- | ----- |
|
77
|
-
| **company_handle** | **String** | | |
|
78
75
|
| **asset_slug** | **String** | | |
|
76
|
+
| **company_handle** | **String** | | |
|
79
77
|
|
80
78
|
### Return type
|
81
79
|
|
@@ -83,7 +81,7 @@ end
|
|
83
81
|
|
84
82
|
### Authorization
|
85
83
|
|
86
|
-
[
|
84
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
87
85
|
|
88
86
|
### HTTP request headers
|
89
87
|
|
@@ -104,8 +102,10 @@ require 'time'
|
|
104
102
|
require 'spartera_api_sdk'
|
105
103
|
# setup authorization
|
106
104
|
SparteraApiSdk.configure do |config|
|
107
|
-
# Configure
|
108
|
-
config.
|
105
|
+
# Configure API key authorization: ApiKeyAuth
|
106
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
107
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
108
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
109
109
|
end
|
110
110
|
|
111
111
|
api_instance = SparteraApiSdk::AssetsApi.new
|
@@ -152,7 +152,7 @@ end
|
|
152
152
|
|
153
153
|
### Authorization
|
154
154
|
|
155
|
-
[
|
155
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
156
156
|
|
157
157
|
### HTTP request headers
|
158
158
|
|
@@ -173,8 +173,10 @@ require 'time'
|
|
173
173
|
require 'spartera_api_sdk'
|
174
174
|
# setup authorization
|
175
175
|
SparteraApiSdk.configure do |config|
|
176
|
-
# Configure
|
177
|
-
config.
|
176
|
+
# Configure API key authorization: ApiKeyAuth
|
177
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
178
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
179
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
178
180
|
end
|
179
181
|
|
180
182
|
api_instance = SparteraApiSdk::AssetsApi.new
|
@@ -221,7 +223,7 @@ end
|
|
221
223
|
|
222
224
|
### Authorization
|
223
225
|
|
224
|
-
[
|
226
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
225
227
|
|
226
228
|
### HTTP request headers
|
227
229
|
|
@@ -242,8 +244,10 @@ require 'time'
|
|
242
244
|
require 'spartera_api_sdk'
|
243
245
|
# setup authorization
|
244
246
|
SparteraApiSdk.configure do |config|
|
245
|
-
# Configure
|
246
|
-
config.
|
247
|
+
# Configure API key authorization: ApiKeyAuth
|
248
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
249
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
250
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
247
251
|
end
|
248
252
|
|
249
253
|
api_instance = SparteraApiSdk::AssetsApi.new
|
@@ -290,7 +294,7 @@ end
|
|
290
294
|
|
291
295
|
### Authorization
|
292
296
|
|
293
|
-
[
|
297
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
294
298
|
|
295
299
|
### HTTP request headers
|
296
300
|
|
@@ -302,7 +306,7 @@ end
|
|
302
306
|
|
303
307
|
> Object companies_company_id_assets_asset_id_infoschema_save_get(company_id, asset_id)
|
304
308
|
|
305
|
-
|
309
|
+
Retrieve and save an asset's information schema
|
306
310
|
|
307
311
|
### Examples
|
308
312
|
|
@@ -311,8 +315,10 @@ require 'time'
|
|
311
315
|
require 'spartera_api_sdk'
|
312
316
|
# setup authorization
|
313
317
|
SparteraApiSdk.configure do |config|
|
314
|
-
# Configure
|
315
|
-
config.
|
318
|
+
# Configure API key authorization: ApiKeyAuth
|
319
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
320
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
321
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
316
322
|
end
|
317
323
|
|
318
324
|
api_instance = SparteraApiSdk::AssetsApi.new
|
@@ -320,7 +326,7 @@ company_id = 'company_id_example' # String |
|
|
320
326
|
asset_id = 'asset_id_example' # String |
|
321
327
|
|
322
328
|
begin
|
323
|
-
#
|
329
|
+
# Retrieve and save an asset's information schema
|
324
330
|
result = api_instance.companies_company_id_assets_asset_id_infoschema_save_get(company_id, asset_id)
|
325
331
|
p result
|
326
332
|
rescue SparteraApiSdk::ApiError => e
|
@@ -336,7 +342,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
336
342
|
|
337
343
|
```ruby
|
338
344
|
begin
|
339
|
-
#
|
345
|
+
# Retrieve and save an asset's information schema
|
340
346
|
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_infoschema_save_get_with_http_info(company_id, asset_id)
|
341
347
|
p status_code # => 2xx
|
342
348
|
p headers # => { ... }
|
@@ -359,7 +365,7 @@ end
|
|
359
365
|
|
360
366
|
### Authorization
|
361
367
|
|
362
|
-
[
|
368
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
363
369
|
|
364
370
|
### HTTP request headers
|
365
371
|
|
@@ -380,8 +386,10 @@ require 'time'
|
|
380
386
|
require 'spartera_api_sdk'
|
381
387
|
# setup authorization
|
382
388
|
SparteraApiSdk.configure do |config|
|
383
|
-
# Configure
|
384
|
-
config.
|
389
|
+
# Configure API key authorization: ApiKeyAuth
|
390
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
391
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
392
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
385
393
|
end
|
386
394
|
|
387
395
|
api_instance = SparteraApiSdk::AssetsApi.new
|
@@ -430,7 +438,7 @@ end
|
|
430
438
|
|
431
439
|
### Authorization
|
432
440
|
|
433
|
-
[
|
441
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
434
442
|
|
435
443
|
### HTTP request headers
|
436
444
|
|
@@ -451,8 +459,10 @@ require 'time'
|
|
451
459
|
require 'spartera_api_sdk'
|
452
460
|
# setup authorization
|
453
461
|
SparteraApiSdk.configure do |config|
|
454
|
-
# Configure
|
455
|
-
config.
|
462
|
+
# Configure API key authorization: ApiKeyAuth
|
463
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
464
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
465
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
456
466
|
end
|
457
467
|
|
458
468
|
api_instance = SparteraApiSdk::AssetsApi.new
|
@@ -499,153 +509,7 @@ end
|
|
499
509
|
|
500
510
|
### Authorization
|
501
511
|
|
502
|
-
[
|
503
|
-
|
504
|
-
### HTTP request headers
|
505
|
-
|
506
|
-
- **Content-Type**: Not defined
|
507
|
-
- **Accept**: application/json
|
508
|
-
|
509
|
-
|
510
|
-
## companies_company_id_assets_asset_id_recommendations_explain_get
|
511
|
-
|
512
|
-
> Object companies_company_id_assets_asset_id_recommendations_explain_get(company_id, asset_id)
|
513
|
-
|
514
|
-
Get detailed explanation of how asset recommendations are calculated for debugging purposes.
|
515
|
-
|
516
|
-
### Examples
|
517
|
-
|
518
|
-
```ruby
|
519
|
-
require 'time'
|
520
|
-
require 'spartera_api_sdk'
|
521
|
-
# setup authorization
|
522
|
-
SparteraApiSdk.configure do |config|
|
523
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
524
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
525
|
-
end
|
526
|
-
|
527
|
-
api_instance = SparteraApiSdk::AssetsApi.new
|
528
|
-
company_id = 'company_id_example' # String |
|
529
|
-
asset_id = 'asset_id_example' # String |
|
530
|
-
|
531
|
-
begin
|
532
|
-
# Get detailed explanation of how asset recommendations are calculated for debugging purposes.
|
533
|
-
result = api_instance.companies_company_id_assets_asset_id_recommendations_explain_get(company_id, asset_id)
|
534
|
-
p result
|
535
|
-
rescue SparteraApiSdk::ApiError => e
|
536
|
-
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_recommendations_explain_get: #{e}"
|
537
|
-
end
|
538
|
-
```
|
539
|
-
|
540
|
-
#### Using the companies_company_id_assets_asset_id_recommendations_explain_get_with_http_info variant
|
541
|
-
|
542
|
-
This returns an Array which contains the response data, status code and headers.
|
543
|
-
|
544
|
-
> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_recommendations_explain_get_with_http_info(company_id, asset_id)
|
545
|
-
|
546
|
-
```ruby
|
547
|
-
begin
|
548
|
-
# Get detailed explanation of how asset recommendations are calculated for debugging purposes.
|
549
|
-
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_recommendations_explain_get_with_http_info(company_id, asset_id)
|
550
|
-
p status_code # => 2xx
|
551
|
-
p headers # => { ... }
|
552
|
-
p data # => Object
|
553
|
-
rescue SparteraApiSdk::ApiError => e
|
554
|
-
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_recommendations_explain_get_with_http_info: #{e}"
|
555
|
-
end
|
556
|
-
```
|
557
|
-
|
558
|
-
### Parameters
|
559
|
-
|
560
|
-
| Name | Type | Description | Notes |
|
561
|
-
| ---- | ---- | ----------- | ----- |
|
562
|
-
| **company_id** | **String** | | |
|
563
|
-
| **asset_id** | **String** | | |
|
564
|
-
|
565
|
-
### Return type
|
566
|
-
|
567
|
-
**Object**
|
568
|
-
|
569
|
-
### Authorization
|
570
|
-
|
571
|
-
[bearerAuth](../README.md#bearerAuth)
|
572
|
-
|
573
|
-
### HTTP request headers
|
574
|
-
|
575
|
-
- **Content-Type**: Not defined
|
576
|
-
- **Accept**: application/json
|
577
|
-
|
578
|
-
|
579
|
-
## companies_company_id_assets_asset_id_recommendations_get
|
580
|
-
|
581
|
-
> Object companies_company_id_assets_asset_id_recommendations_get(company_id, asset_id, opts)
|
582
|
-
|
583
|
-
Get asset recommendations for a specific asset using heuristic waterfall matching Returns list of similar assets based on industry, company, connection, tags, etc. Query Parameters: - limit: Number of recommendations to return (default: 12, max: 50) - min_score: Minimum similarity score threshold (default: 0.1) - include_details: Include component similarity scores (default: false)
|
584
|
-
|
585
|
-
### Examples
|
586
|
-
|
587
|
-
```ruby
|
588
|
-
require 'time'
|
589
|
-
require 'spartera_api_sdk'
|
590
|
-
# setup authorization
|
591
|
-
SparteraApiSdk.configure do |config|
|
592
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
593
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
594
|
-
end
|
595
|
-
|
596
|
-
api_instance = SparteraApiSdk::AssetsApi.new
|
597
|
-
company_id = 'company_id_example' # String |
|
598
|
-
asset_id = 'asset_id_example' # String |
|
599
|
-
opts = {
|
600
|
-
limit: 'limit_example', # String |
|
601
|
-
min_score: 'min_score_example', # String |
|
602
|
-
include_details: 'include_details_example' # String |
|
603
|
-
}
|
604
|
-
|
605
|
-
begin
|
606
|
-
# Get asset recommendations for a specific asset using heuristic waterfall matching Returns list of similar assets based on industry, company, connection, tags, etc. Query Parameters: - limit: Number of recommendations to return (default: 12, max: 50) - min_score: Minimum similarity score threshold (default: 0.1) - include_details: Include component similarity scores (default: false)
|
607
|
-
result = api_instance.companies_company_id_assets_asset_id_recommendations_get(company_id, asset_id, opts)
|
608
|
-
p result
|
609
|
-
rescue SparteraApiSdk::ApiError => e
|
610
|
-
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_recommendations_get: #{e}"
|
611
|
-
end
|
612
|
-
```
|
613
|
-
|
614
|
-
#### Using the companies_company_id_assets_asset_id_recommendations_get_with_http_info variant
|
615
|
-
|
616
|
-
This returns an Array which contains the response data, status code and headers.
|
617
|
-
|
618
|
-
> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_recommendations_get_with_http_info(company_id, asset_id, opts)
|
619
|
-
|
620
|
-
```ruby
|
621
|
-
begin
|
622
|
-
# Get asset recommendations for a specific asset using heuristic waterfall matching Returns list of similar assets based on industry, company, connection, tags, etc. Query Parameters: - limit: Number of recommendations to return (default: 12, max: 50) - min_score: Minimum similarity score threshold (default: 0.1) - include_details: Include component similarity scores (default: false)
|
623
|
-
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_recommendations_get_with_http_info(company_id, asset_id, opts)
|
624
|
-
p status_code # => 2xx
|
625
|
-
p headers # => { ... }
|
626
|
-
p data # => Object
|
627
|
-
rescue SparteraApiSdk::ApiError => e
|
628
|
-
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_recommendations_get_with_http_info: #{e}"
|
629
|
-
end
|
630
|
-
```
|
631
|
-
|
632
|
-
### Parameters
|
633
|
-
|
634
|
-
| Name | Type | Description | Notes |
|
635
|
-
| ---- | ---- | ----------- | ----- |
|
636
|
-
| **company_id** | **String** | | |
|
637
|
-
| **asset_id** | **String** | | |
|
638
|
-
| **limit** | **String** | | [optional] |
|
639
|
-
| **min_score** | **String** | | [optional] |
|
640
|
-
| **include_details** | **String** | | [optional] |
|
641
|
-
|
642
|
-
### Return type
|
643
|
-
|
644
|
-
**Object**
|
645
|
-
|
646
|
-
### Authorization
|
647
|
-
|
648
|
-
[bearerAuth](../README.md#bearerAuth)
|
512
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
649
513
|
|
650
514
|
### HTTP request headers
|
651
515
|
|
@@ -666,8 +530,10 @@ require 'time'
|
|
666
530
|
require 'spartera_api_sdk'
|
667
531
|
# setup authorization
|
668
532
|
SparteraApiSdk.configure do |config|
|
669
|
-
# Configure
|
670
|
-
config.
|
533
|
+
# Configure API key authorization: ApiKeyAuth
|
534
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
535
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
536
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
671
537
|
end
|
672
538
|
|
673
539
|
api_instance = SparteraApiSdk::AssetsApi.new
|
@@ -714,7 +580,7 @@ end
|
|
714
580
|
|
715
581
|
### Authorization
|
716
582
|
|
717
|
-
[
|
583
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
718
584
|
|
719
585
|
### HTTP request headers
|
720
586
|
|
@@ -735,8 +601,10 @@ require 'time'
|
|
735
601
|
require 'spartera_api_sdk'
|
736
602
|
# setup authorization
|
737
603
|
SparteraApiSdk.configure do |config|
|
738
|
-
# Configure
|
739
|
-
config.
|
604
|
+
# Configure API key authorization: ApiKeyAuth
|
605
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
606
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
607
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
740
608
|
end
|
741
609
|
|
742
610
|
api_instance = SparteraApiSdk::AssetsApi.new
|
@@ -783,7 +651,7 @@ end
|
|
783
651
|
|
784
652
|
### Authorization
|
785
653
|
|
786
|
-
[
|
654
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
787
655
|
|
788
656
|
### HTTP request headers
|
789
657
|
|
@@ -804,8 +672,10 @@ require 'time'
|
|
804
672
|
require 'spartera_api_sdk'
|
805
673
|
# setup authorization
|
806
674
|
SparteraApiSdk.configure do |config|
|
807
|
-
# Configure
|
808
|
-
config.
|
675
|
+
# Configure API key authorization: ApiKeyAuth
|
676
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
677
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
678
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
809
679
|
end
|
810
680
|
|
811
681
|
api_instance = SparteraApiSdk::AssetsApi.new
|
@@ -850,7 +720,7 @@ end
|
|
850
720
|
|
851
721
|
### Authorization
|
852
722
|
|
853
|
-
[
|
723
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
854
724
|
|
855
725
|
### HTTP request headers
|
856
726
|
|
@@ -871,8 +741,10 @@ require 'time'
|
|
871
741
|
require 'spartera_api_sdk'
|
872
742
|
# setup authorization
|
873
743
|
SparteraApiSdk.configure do |config|
|
874
|
-
# Configure
|
875
|
-
config.
|
744
|
+
# Configure API key authorization: ApiKeyAuth
|
745
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
746
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
747
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
876
748
|
end
|
877
749
|
|
878
750
|
api_instance = SparteraApiSdk::AssetsApi.new
|
@@ -919,7 +791,7 @@ end
|
|
919
791
|
|
920
792
|
### Authorization
|
921
793
|
|
922
|
-
[
|
794
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
923
795
|
|
924
796
|
### HTTP request headers
|
925
797
|
|
@@ -927,142 +799,6 @@ end
|
|
927
799
|
- **Accept**: application/json
|
928
800
|
|
929
801
|
|
930
|
-
## companies_company_id_assets_recommendations_bulk_post
|
931
|
-
|
932
|
-
> Object companies_company_id_assets_recommendations_bulk_post(company_id, asset)
|
933
|
-
|
934
|
-
Get recommendations for multiple assets in a single request. Useful for pre-loading recommendations.
|
935
|
-
|
936
|
-
### Examples
|
937
|
-
|
938
|
-
```ruby
|
939
|
-
require 'time'
|
940
|
-
require 'spartera_api_sdk'
|
941
|
-
# setup authorization
|
942
|
-
SparteraApiSdk.configure do |config|
|
943
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
944
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
945
|
-
end
|
946
|
-
|
947
|
-
api_instance = SparteraApiSdk::AssetsApi.new
|
948
|
-
company_id = 'company_id_example' # String |
|
949
|
-
asset = SparteraApiSdk::Asset.new({company_id: 'company_id_example', name: 'name_example', source: 'source_example'}) # Asset |
|
950
|
-
|
951
|
-
begin
|
952
|
-
# Get recommendations for multiple assets in a single request. Useful for pre-loading recommendations.
|
953
|
-
result = api_instance.companies_company_id_assets_recommendations_bulk_post(company_id, asset)
|
954
|
-
p result
|
955
|
-
rescue SparteraApiSdk::ApiError => e
|
956
|
-
puts "Error when calling AssetsApi->companies_company_id_assets_recommendations_bulk_post: #{e}"
|
957
|
-
end
|
958
|
-
```
|
959
|
-
|
960
|
-
#### Using the companies_company_id_assets_recommendations_bulk_post_with_http_info variant
|
961
|
-
|
962
|
-
This returns an Array which contains the response data, status code and headers.
|
963
|
-
|
964
|
-
> <Array(Object, Integer, Hash)> companies_company_id_assets_recommendations_bulk_post_with_http_info(company_id, asset)
|
965
|
-
|
966
|
-
```ruby
|
967
|
-
begin
|
968
|
-
# Get recommendations for multiple assets in a single request. Useful for pre-loading recommendations.
|
969
|
-
data, status_code, headers = api_instance.companies_company_id_assets_recommendations_bulk_post_with_http_info(company_id, asset)
|
970
|
-
p status_code # => 2xx
|
971
|
-
p headers # => { ... }
|
972
|
-
p data # => Object
|
973
|
-
rescue SparteraApiSdk::ApiError => e
|
974
|
-
puts "Error when calling AssetsApi->companies_company_id_assets_recommendations_bulk_post_with_http_info: #{e}"
|
975
|
-
end
|
976
|
-
```
|
977
|
-
|
978
|
-
### Parameters
|
979
|
-
|
980
|
-
| Name | Type | Description | Notes |
|
981
|
-
| ---- | ---- | ----------- | ----- |
|
982
|
-
| **company_id** | **String** | | |
|
983
|
-
| **asset** | [**Asset**](Asset.md) | | |
|
984
|
-
|
985
|
-
### Return type
|
986
|
-
|
987
|
-
**Object**
|
988
|
-
|
989
|
-
### Authorization
|
990
|
-
|
991
|
-
[bearerAuth](../README.md#bearerAuth)
|
992
|
-
|
993
|
-
### HTTP request headers
|
994
|
-
|
995
|
-
- **Content-Type**: application/json
|
996
|
-
- **Accept**: application/json
|
997
|
-
|
998
|
-
|
999
|
-
## companies_company_id_assets_recommendations_health_get
|
1000
|
-
|
1001
|
-
> Object companies_company_id_assets_recommendations_health_get(company_id)
|
1002
|
-
|
1003
|
-
Health check for the recommendations system with sample data and performance metrics.
|
1004
|
-
|
1005
|
-
### Examples
|
1006
|
-
|
1007
|
-
```ruby
|
1008
|
-
require 'time'
|
1009
|
-
require 'spartera_api_sdk'
|
1010
|
-
# setup authorization
|
1011
|
-
SparteraApiSdk.configure do |config|
|
1012
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
1013
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
1014
|
-
end
|
1015
|
-
|
1016
|
-
api_instance = SparteraApiSdk::AssetsApi.new
|
1017
|
-
company_id = 'company_id_example' # String |
|
1018
|
-
|
1019
|
-
begin
|
1020
|
-
# Health check for the recommendations system with sample data and performance metrics.
|
1021
|
-
result = api_instance.companies_company_id_assets_recommendations_health_get(company_id)
|
1022
|
-
p result
|
1023
|
-
rescue SparteraApiSdk::ApiError => e
|
1024
|
-
puts "Error when calling AssetsApi->companies_company_id_assets_recommendations_health_get: #{e}"
|
1025
|
-
end
|
1026
|
-
```
|
1027
|
-
|
1028
|
-
#### Using the companies_company_id_assets_recommendations_health_get_with_http_info variant
|
1029
|
-
|
1030
|
-
This returns an Array which contains the response data, status code and headers.
|
1031
|
-
|
1032
|
-
> <Array(Object, Integer, Hash)> companies_company_id_assets_recommendations_health_get_with_http_info(company_id)
|
1033
|
-
|
1034
|
-
```ruby
|
1035
|
-
begin
|
1036
|
-
# Health check for the recommendations system with sample data and performance metrics.
|
1037
|
-
data, status_code, headers = api_instance.companies_company_id_assets_recommendations_health_get_with_http_info(company_id)
|
1038
|
-
p status_code # => 2xx
|
1039
|
-
p headers # => { ... }
|
1040
|
-
p data # => Object
|
1041
|
-
rescue SparteraApiSdk::ApiError => e
|
1042
|
-
puts "Error when calling AssetsApi->companies_company_id_assets_recommendations_health_get_with_http_info: #{e}"
|
1043
|
-
end
|
1044
|
-
```
|
1045
|
-
|
1046
|
-
### Parameters
|
1047
|
-
|
1048
|
-
| Name | Type | Description | Notes |
|
1049
|
-
| ---- | ---- | ----------- | ----- |
|
1050
|
-
| **company_id** | **String** | | |
|
1051
|
-
|
1052
|
-
### Return type
|
1053
|
-
|
1054
|
-
**Object**
|
1055
|
-
|
1056
|
-
### Authorization
|
1057
|
-
|
1058
|
-
[bearerAuth](../README.md#bearerAuth)
|
1059
|
-
|
1060
|
-
### HTTP request headers
|
1061
|
-
|
1062
|
-
- **Content-Type**: Not defined
|
1063
|
-
- **Accept**: application/json
|
1064
|
-
|
1065
|
-
|
1066
802
|
## companies_company_id_assets_statistics_get
|
1067
803
|
|
1068
804
|
> Object companies_company_id_assets_statistics_get(company_id)
|
@@ -1076,8 +812,10 @@ require 'time'
|
|
1076
812
|
require 'spartera_api_sdk'
|
1077
813
|
# setup authorization
|
1078
814
|
SparteraApiSdk.configure do |config|
|
1079
|
-
# Configure
|
1080
|
-
config.
|
815
|
+
# Configure API key authorization: ApiKeyAuth
|
816
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
817
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
818
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
1081
819
|
end
|
1082
820
|
|
1083
821
|
api_instance = SparteraApiSdk::AssetsApi.new
|
@@ -1122,7 +860,7 @@ end
|
|
1122
860
|
|
1123
861
|
### Authorization
|
1124
862
|
|
1125
|
-
[
|
863
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1126
864
|
|
1127
865
|
### HTTP request headers
|
1128
866
|
|