spartera_api_sdk 1.0.62 → 1.0.69
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 +45 -35
- data/docs/AlertsApi.md +71 -57
- data/docs/AssetPriceHistoryApi.md +80 -64
- data/docs/AssetsApi.md +116 -378
- data/docs/CloudProvidersApi.md +18 -215
- data/docs/CompaniesApi.md +81 -63
- data/docs/CompaniesCompanyIdApiKeysGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdDelete200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdDelete200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsAssetIdPatch200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdAssetsGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsPost200Response.md +20 -0
- data/docs/CompaniesCompanyIdAssetsPost200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdConnectionsConnectionIdDelete200Response.md +20 -0
- data/docs/CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdConnectionsConnectionIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdConnectionsConnectionIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdConnectionsConnectionIdPatch200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdConnectionsGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdConnectionsPost200Response.md +20 -0
- data/docs/CompaniesCompanyIdConnectionsPost200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersPost200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersPost200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsPost200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdAlertsPost200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdDelete200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdDelete200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesPost200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdFavoritesPost200ResponseData.md +18 -0
- data/docs/CompaniesCompanyIdUsersUserIdGet200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdPatch200Response.md +20 -0
- data/docs/CompaniesCompanyIdUsersUserIdPatch200ResponseData.md +18 -0
- data/docs/ConnectionsApi.md +67 -53
- data/docs/FavoritesApi.md +84 -68
- data/docs/MeGet200Response.md +36 -0
- data/docs/MeGet200ResponseApiKeyInfo.md +20 -0
- data/docs/MeGet200ResponseProfile.md +36 -0
- data/docs/MeGet200ResponseTokenMetadata.md +24 -0
- data/docs/StorageEnginesApi.md +149 -0
- data/docs/UsersApi.md +116 -39
- data/lib/spartera_api_sdk/api/alerts_api.rb +32 -32
- data/lib/spartera_api_sdk/api/api_keys_api.rb +20 -20
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +36 -36
- data/lib/spartera_api_sdk/api/assets_api.rb +52 -328
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +8 -185
- data/lib/spartera_api_sdk/api/companies_api.rb +36 -36
- data/lib/spartera_api_sdk/api/connections_api.rb +30 -30
- data/lib/spartera_api_sdk/api/favorites_api.rb +38 -38
- data/lib/spartera_api_sdk/api/storage_engines_api.rb +150 -0
- data/lib/spartera_api_sdk/api/users_api.rb +77 -22
- data/lib/spartera_api_sdk/configuration.rb +2 -10
- data/lib/spartera_api_sdk/models/companies_company_id_api_keys_get200_response.rb +248 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_delete200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_delete200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_asset_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_post200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_assets_post200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_delete200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_delete200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_connection_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_post200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_connections_post200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_post200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_post200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_post200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_alerts_post200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_delete200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_delete200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_get200_response.rb +266 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_post200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_favorites_post200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_get200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_patch200_response.rb +264 -0
- data/lib/spartera_api_sdk/models/companies_company_id_users_user_id_patch200_response_data.rb +238 -0
- data/lib/spartera_api_sdk/models/me_get200_response.rb +417 -0
- data/lib/spartera_api_sdk/models/me_get200_response_api_key_info.rb +232 -0
- data/lib/spartera_api_sdk/models/me_get200_response_profile.rb +345 -0
- data/lib/spartera_api_sdk/models/me_get200_response_token_metadata.rb +252 -0
- data/lib/spartera_api_sdk/version.rb +1 -1
- data/lib/spartera_api_sdk.rb +46 -0
- data/spec/api/alerts_api_spec.rb +9 -9
- data/spec/api/api_keys_api_spec.rb +5 -5
- data/spec/api/asset_price_history_api_spec.rb +10 -10
- data/spec/api/assets_api_spec.rb +14 -64
- data/spec/api/cloud_providers_api_spec.rb +2 -34
- data/spec/api/companies_api_spec.rb +9 -9
- data/spec/api/connections_api_spec.rb +8 -8
- data/spec/api/favorites_api_spec.rb +11 -11
- data/spec/api/storage_engines_api_spec.rb +58 -0
- data/spec/api/users_api_spec.rb +16 -6
- data/spec/models/companies_company_id_api_keys_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_asset_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_assets_asset_id_delete200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_asset_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_asset_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_assets_asset_id_patch200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_assets_post200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_assets_post200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_connections_connection_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_connections_connection_id_delete200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_connections_connection_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_connections_connection_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_connections_connection_id_patch200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_connections_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_connections_post200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_connections_post200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_post200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_post200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_delete200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_alerts_alert_id_patch200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_alerts_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_alerts_post200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_alerts_post200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_delete200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_delete200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_favorites_favorite_id_patch200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_favorites_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_favorites_post200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_favorites_post200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_get200_response_spec.rb +42 -0
- data/spec/models/companies_company_id_users_user_id_patch200_response_data_spec.rb +36 -0
- data/spec/models/companies_company_id_users_user_id_patch200_response_spec.rb +42 -0
- data/spec/models/me_get200_response_api_key_info_spec.rb +42 -0
- data/spec/models/me_get200_response_profile_spec.rb +94 -0
- data/spec/models/me_get200_response_spec.rb +94 -0
- data/spec/models/me_get200_response_token_metadata_spec.rb +54 -0
- metadata +208 -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
|
-
>
|
23
|
+
> <CompaniesCompanyIdAssetsAssetIdGet200Response> analyze_company_handle_assets_asset_slug_get(company_handle, asset_slug)
|
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,8 +31,10 @@ 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
|
@@ -44,7 +42,7 @@ company_handle = 'company_handle_example' # String |
|
|
44
42
|
asset_slug = 'asset_slug_example' # String |
|
45
43
|
|
46
44
|
begin
|
47
|
-
# Process
|
45
|
+
# Process (analyze) an asset. Attempt to process an analytic on a backend warehouse/AI model.
|
48
46
|
result = api_instance.analyze_company_handle_assets_asset_slug_get(company_handle, asset_slug)
|
49
47
|
p result
|
50
48
|
rescue SparteraApiSdk::ApiError => e
|
@@ -56,15 +54,15 @@ end
|
|
56
54
|
|
57
55
|
This returns an Array which contains the response data, status code and headers.
|
58
56
|
|
59
|
-
> <Array(
|
57
|
+
> <Array(<CompaniesCompanyIdAssetsAssetIdGet200Response>, Integer, Hash)> analyze_company_handle_assets_asset_slug_get_with_http_info(company_handle, asset_slug)
|
60
58
|
|
61
59
|
```ruby
|
62
60
|
begin
|
63
|
-
# Process
|
61
|
+
# Process (analyze) an asset. Attempt to process an analytic on a backend warehouse/AI model.
|
64
62
|
data, status_code, headers = api_instance.analyze_company_handle_assets_asset_slug_get_with_http_info(company_handle, asset_slug)
|
65
63
|
p status_code # => 2xx
|
66
64
|
p headers # => { ... }
|
67
|
-
p data # =>
|
65
|
+
p data # => <CompaniesCompanyIdAssetsAssetIdGet200Response>
|
68
66
|
rescue SparteraApiSdk::ApiError => e
|
69
67
|
puts "Error when calling AssetsApi->analyze_company_handle_assets_asset_slug_get_with_http_info: #{e}"
|
70
68
|
end
|
@@ -79,11 +77,11 @@ end
|
|
79
77
|
|
80
78
|
### Return type
|
81
79
|
|
82
|
-
**
|
80
|
+
[**CompaniesCompanyIdAssetsAssetIdGet200Response**](CompaniesCompanyIdAssetsAssetIdGet200Response.md)
|
83
81
|
|
84
82
|
### Authorization
|
85
83
|
|
86
|
-
[
|
84
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
87
85
|
|
88
86
|
### HTTP request headers
|
89
87
|
|
@@ -93,7 +91,7 @@ end
|
|
93
91
|
|
94
92
|
## companies_company_id_assets_asset_id_delete
|
95
93
|
|
96
|
-
>
|
94
|
+
> <CompaniesCompanyIdAssetsAssetIdDelete200Response> companies_company_id_assets_asset_id_delete(company_id, asset_id)
|
97
95
|
|
98
96
|
Delete single asset by ID
|
99
97
|
|
@@ -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
|
@@ -125,7 +125,7 @@ end
|
|
125
125
|
|
126
126
|
This returns an Array which contains the response data, status code and headers.
|
127
127
|
|
128
|
-
> <Array(
|
128
|
+
> <Array(<CompaniesCompanyIdAssetsAssetIdDelete200Response>, Integer, Hash)> companies_company_id_assets_asset_id_delete_with_http_info(company_id, asset_id)
|
129
129
|
|
130
130
|
```ruby
|
131
131
|
begin
|
@@ -133,7 +133,7 @@ begin
|
|
133
133
|
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_delete_with_http_info(company_id, asset_id)
|
134
134
|
p status_code # => 2xx
|
135
135
|
p headers # => { ... }
|
136
|
-
p data # =>
|
136
|
+
p data # => <CompaniesCompanyIdAssetsAssetIdDelete200Response>
|
137
137
|
rescue SparteraApiSdk::ApiError => e
|
138
138
|
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_delete_with_http_info: #{e}"
|
139
139
|
end
|
@@ -148,11 +148,11 @@ end
|
|
148
148
|
|
149
149
|
### Return type
|
150
150
|
|
151
|
-
**
|
151
|
+
[**CompaniesCompanyIdAssetsAssetIdDelete200Response**](CompaniesCompanyIdAssetsAssetIdDelete200Response.md)
|
152
152
|
|
153
153
|
### Authorization
|
154
154
|
|
155
|
-
[
|
155
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
156
156
|
|
157
157
|
### HTTP request headers
|
158
158
|
|
@@ -162,7 +162,7 @@ end
|
|
162
162
|
|
163
163
|
## companies_company_id_assets_asset_id_get
|
164
164
|
|
165
|
-
>
|
165
|
+
> <CompaniesCompanyIdAssetsAssetIdGet200Response> companies_company_id_assets_asset_id_get(company_id, asset_id)
|
166
166
|
|
167
167
|
Get single asset by ID
|
168
168
|
|
@@ -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
|
@@ -194,7 +196,7 @@ end
|
|
194
196
|
|
195
197
|
This returns an Array which contains the response data, status code and headers.
|
196
198
|
|
197
|
-
> <Array(
|
199
|
+
> <Array(<CompaniesCompanyIdAssetsAssetIdGet200Response>, Integer, Hash)> companies_company_id_assets_asset_id_get_with_http_info(company_id, asset_id)
|
198
200
|
|
199
201
|
```ruby
|
200
202
|
begin
|
@@ -202,7 +204,7 @@ begin
|
|
202
204
|
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_get_with_http_info(company_id, asset_id)
|
203
205
|
p status_code # => 2xx
|
204
206
|
p headers # => { ... }
|
205
|
-
p data # =>
|
207
|
+
p data # => <CompaniesCompanyIdAssetsAssetIdGet200Response>
|
206
208
|
rescue SparteraApiSdk::ApiError => e
|
207
209
|
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_get_with_http_info: #{e}"
|
208
210
|
end
|
@@ -217,11 +219,11 @@ end
|
|
217
219
|
|
218
220
|
### Return type
|
219
221
|
|
220
|
-
**
|
222
|
+
[**CompaniesCompanyIdAssetsAssetIdGet200Response**](CompaniesCompanyIdAssetsAssetIdGet200Response.md)
|
221
223
|
|
222
224
|
### Authorization
|
223
225
|
|
224
|
-
[
|
226
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
225
227
|
|
226
228
|
### HTTP request headers
|
227
229
|
|
@@ -231,7 +233,7 @@ end
|
|
231
233
|
|
232
234
|
## companies_company_id_assets_asset_id_infoschema_get
|
233
235
|
|
234
|
-
>
|
236
|
+
> <CompaniesCompanyIdAssetsGet200Response> companies_company_id_assets_asset_id_infoschema_get(company_id, asset_id)
|
235
237
|
|
236
238
|
Get the information schema for a specific asset's table
|
237
239
|
|
@@ -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
|
@@ -263,7 +267,7 @@ end
|
|
263
267
|
|
264
268
|
This returns an Array which contains the response data, status code and headers.
|
265
269
|
|
266
|
-
> <Array(
|
270
|
+
> <Array(<CompaniesCompanyIdAssetsGet200Response>, Integer, Hash)> companies_company_id_assets_asset_id_infoschema_get_with_http_info(company_id, asset_id)
|
267
271
|
|
268
272
|
```ruby
|
269
273
|
begin
|
@@ -271,7 +275,7 @@ begin
|
|
271
275
|
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_infoschema_get_with_http_info(company_id, asset_id)
|
272
276
|
p status_code # => 2xx
|
273
277
|
p headers # => { ... }
|
274
|
-
p data # =>
|
278
|
+
p data # => <CompaniesCompanyIdAssetsGet200Response>
|
275
279
|
rescue SparteraApiSdk::ApiError => e
|
276
280
|
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_infoschema_get_with_http_info: #{e}"
|
277
281
|
end
|
@@ -286,11 +290,11 @@ end
|
|
286
290
|
|
287
291
|
### Return type
|
288
292
|
|
289
|
-
**
|
293
|
+
[**CompaniesCompanyIdAssetsGet200Response**](CompaniesCompanyIdAssetsGet200Response.md)
|
290
294
|
|
291
295
|
### Authorization
|
292
296
|
|
293
|
-
[
|
297
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
294
298
|
|
295
299
|
### HTTP request headers
|
296
300
|
|
@@ -300,9 +304,9 @@ end
|
|
300
304
|
|
301
305
|
## companies_company_id_assets_asset_id_infoschema_save_get
|
302
306
|
|
303
|
-
>
|
307
|
+
> <CompaniesCompanyIdAssetsGet200Response> 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
|
@@ -332,15 +338,15 @@ end
|
|
332
338
|
|
333
339
|
This returns an Array which contains the response data, status code and headers.
|
334
340
|
|
335
|
-
> <Array(
|
341
|
+
> <Array(<CompaniesCompanyIdAssetsGet200Response>, Integer, Hash)> companies_company_id_assets_asset_id_infoschema_save_get_with_http_info(company_id, asset_id)
|
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 # => { ... }
|
343
|
-
p data # =>
|
349
|
+
p data # => <CompaniesCompanyIdAssetsGet200Response>
|
344
350
|
rescue SparteraApiSdk::ApiError => e
|
345
351
|
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_infoschema_save_get_with_http_info: #{e}"
|
346
352
|
end
|
@@ -355,11 +361,11 @@ end
|
|
355
361
|
|
356
362
|
### Return type
|
357
363
|
|
358
|
-
**
|
364
|
+
[**CompaniesCompanyIdAssetsGet200Response**](CompaniesCompanyIdAssetsGet200Response.md)
|
359
365
|
|
360
366
|
### Authorization
|
361
367
|
|
362
|
-
[
|
368
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
363
369
|
|
364
370
|
### HTTP request headers
|
365
371
|
|
@@ -369,7 +375,7 @@ end
|
|
369
375
|
|
370
376
|
## companies_company_id_assets_asset_id_patch
|
371
377
|
|
372
|
-
>
|
378
|
+
> <CompaniesCompanyIdAssetsAssetIdPatch200Response> companies_company_id_assets_asset_id_patch(company_id, asset_id, asset)
|
373
379
|
|
374
380
|
Update an existing asset by ID
|
375
381
|
|
@@ -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
|
@@ -402,7 +410,7 @@ end
|
|
402
410
|
|
403
411
|
This returns an Array which contains the response data, status code and headers.
|
404
412
|
|
405
|
-
> <Array(
|
413
|
+
> <Array(<CompaniesCompanyIdAssetsAssetIdPatch200Response>, Integer, Hash)> companies_company_id_assets_asset_id_patch_with_http_info(company_id, asset_id, asset)
|
406
414
|
|
407
415
|
```ruby
|
408
416
|
begin
|
@@ -410,7 +418,7 @@ begin
|
|
410
418
|
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_patch_with_http_info(company_id, asset_id, asset)
|
411
419
|
p status_code # => 2xx
|
412
420
|
p headers # => { ... }
|
413
|
-
p data # =>
|
421
|
+
p data # => <CompaniesCompanyIdAssetsAssetIdPatch200Response>
|
414
422
|
rescue SparteraApiSdk::ApiError => e
|
415
423
|
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_patch_with_http_info: #{e}"
|
416
424
|
end
|
@@ -426,11 +434,11 @@ end
|
|
426
434
|
|
427
435
|
### Return type
|
428
436
|
|
429
|
-
**
|
437
|
+
[**CompaniesCompanyIdAssetsAssetIdPatch200Response**](CompaniesCompanyIdAssetsAssetIdPatch200Response.md)
|
430
438
|
|
431
439
|
### Authorization
|
432
440
|
|
433
|
-
[
|
441
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
434
442
|
|
435
443
|
### HTTP request headers
|
436
444
|
|
@@ -440,7 +448,7 @@ end
|
|
440
448
|
|
441
449
|
## companies_company_id_assets_asset_id_predicted_price_get
|
442
450
|
|
443
|
-
>
|
451
|
+
> <CompaniesCompanyIdAssetsGet200Response> companies_company_id_assets_asset_id_predicted_price_get(company_id, asset_id)
|
444
452
|
|
445
453
|
Get AI-predicted pricing for a specific asset
|
446
454
|
|
@@ -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
|
@@ -472,7 +482,7 @@ end
|
|
472
482
|
|
473
483
|
This returns an Array which contains the response data, status code and headers.
|
474
484
|
|
475
|
-
> <Array(
|
485
|
+
> <Array(<CompaniesCompanyIdAssetsGet200Response>, Integer, Hash)> companies_company_id_assets_asset_id_predicted_price_get_with_http_info(company_id, asset_id)
|
476
486
|
|
477
487
|
```ruby
|
478
488
|
begin
|
@@ -480,7 +490,7 @@ begin
|
|
480
490
|
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_predicted_price_get_with_http_info(company_id, asset_id)
|
481
491
|
p status_code # => 2xx
|
482
492
|
p headers # => { ... }
|
483
|
-
p data # =>
|
493
|
+
p data # => <CompaniesCompanyIdAssetsGet200Response>
|
484
494
|
rescue SparteraApiSdk::ApiError => e
|
485
495
|
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_predicted_price_get_with_http_info: #{e}"
|
486
496
|
end
|
@@ -495,157 +505,11 @@ end
|
|
495
505
|
|
496
506
|
### Return type
|
497
507
|
|
498
|
-
**
|
508
|
+
[**CompaniesCompanyIdAssetsGet200Response**](CompaniesCompanyIdAssetsGet200Response.md)
|
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
|
|
@@ -655,7 +519,7 @@ end
|
|
655
519
|
|
656
520
|
## companies_company_id_assets_asset_id_statistics_get
|
657
521
|
|
658
|
-
>
|
522
|
+
> <CompaniesCompanyIdAssetsGet200Response> companies_company_id_assets_asset_id_statistics_get(company_id, asset_id)
|
659
523
|
|
660
524
|
Get statistics for a specific asset (public endpoint)
|
661
525
|
|
@@ -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
|
@@ -687,7 +553,7 @@ end
|
|
687
553
|
|
688
554
|
This returns an Array which contains the response data, status code and headers.
|
689
555
|
|
690
|
-
> <Array(
|
556
|
+
> <Array(<CompaniesCompanyIdAssetsGet200Response>, Integer, Hash)> companies_company_id_assets_asset_id_statistics_get_with_http_info(company_id, asset_id)
|
691
557
|
|
692
558
|
```ruby
|
693
559
|
begin
|
@@ -695,7 +561,7 @@ begin
|
|
695
561
|
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_statistics_get_with_http_info(company_id, asset_id)
|
696
562
|
p status_code # => 2xx
|
697
563
|
p headers # => { ... }
|
698
|
-
p data # =>
|
564
|
+
p data # => <CompaniesCompanyIdAssetsGet200Response>
|
699
565
|
rescue SparteraApiSdk::ApiError => e
|
700
566
|
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_statistics_get_with_http_info: #{e}"
|
701
567
|
end
|
@@ -710,11 +576,11 @@ end
|
|
710
576
|
|
711
577
|
### Return type
|
712
578
|
|
713
|
-
**
|
579
|
+
[**CompaniesCompanyIdAssetsGet200Response**](CompaniesCompanyIdAssetsGet200Response.md)
|
714
580
|
|
715
581
|
### Authorization
|
716
582
|
|
717
|
-
[
|
583
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
718
584
|
|
719
585
|
### HTTP request headers
|
720
586
|
|
@@ -724,7 +590,7 @@ end
|
|
724
590
|
|
725
591
|
## companies_company_id_assets_asset_id_test_get
|
726
592
|
|
727
|
-
>
|
593
|
+
> <CompaniesCompanyIdAssetsGet200Response> companies_company_id_assets_asset_id_test_get(company_id, asset_id)
|
728
594
|
|
729
595
|
Test out an Asset (on a subset of data)
|
730
596
|
|
@@ -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
|
@@ -756,7 +624,7 @@ end
|
|
756
624
|
|
757
625
|
This returns an Array which contains the response data, status code and headers.
|
758
626
|
|
759
|
-
> <Array(
|
627
|
+
> <Array(<CompaniesCompanyIdAssetsGet200Response>, Integer, Hash)> companies_company_id_assets_asset_id_test_get_with_http_info(company_id, asset_id)
|
760
628
|
|
761
629
|
```ruby
|
762
630
|
begin
|
@@ -764,7 +632,7 @@ begin
|
|
764
632
|
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_test_get_with_http_info(company_id, asset_id)
|
765
633
|
p status_code # => 2xx
|
766
634
|
p headers # => { ... }
|
767
|
-
p data # =>
|
635
|
+
p data # => <CompaniesCompanyIdAssetsGet200Response>
|
768
636
|
rescue SparteraApiSdk::ApiError => e
|
769
637
|
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_test_get_with_http_info: #{e}"
|
770
638
|
end
|
@@ -779,11 +647,11 @@ end
|
|
779
647
|
|
780
648
|
### Return type
|
781
649
|
|
782
|
-
**
|
650
|
+
[**CompaniesCompanyIdAssetsGet200Response**](CompaniesCompanyIdAssetsGet200Response.md)
|
783
651
|
|
784
652
|
### Authorization
|
785
653
|
|
786
|
-
[
|
654
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
787
655
|
|
788
656
|
### HTTP request headers
|
789
657
|
|
@@ -793,7 +661,7 @@ end
|
|
793
661
|
|
794
662
|
## companies_company_id_assets_get
|
795
663
|
|
796
|
-
>
|
664
|
+
> <CompaniesCompanyIdAssetsGet200Response> companies_company_id_assets_get(company_id)
|
797
665
|
|
798
666
|
Get all assets for a specific company
|
799
667
|
|
@@ -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
|
@@ -824,7 +694,7 @@ end
|
|
824
694
|
|
825
695
|
This returns an Array which contains the response data, status code and headers.
|
826
696
|
|
827
|
-
> <Array(
|
697
|
+
> <Array(<CompaniesCompanyIdAssetsGet200Response>, Integer, Hash)> companies_company_id_assets_get_with_http_info(company_id)
|
828
698
|
|
829
699
|
```ruby
|
830
700
|
begin
|
@@ -832,7 +702,7 @@ begin
|
|
832
702
|
data, status_code, headers = api_instance.companies_company_id_assets_get_with_http_info(company_id)
|
833
703
|
p status_code # => 2xx
|
834
704
|
p headers # => { ... }
|
835
|
-
p data # =>
|
705
|
+
p data # => <CompaniesCompanyIdAssetsGet200Response>
|
836
706
|
rescue SparteraApiSdk::ApiError => e
|
837
707
|
puts "Error when calling AssetsApi->companies_company_id_assets_get_with_http_info: #{e}"
|
838
708
|
end
|
@@ -846,11 +716,11 @@ end
|
|
846
716
|
|
847
717
|
### Return type
|
848
718
|
|
849
|
-
**
|
719
|
+
[**CompaniesCompanyIdAssetsGet200Response**](CompaniesCompanyIdAssetsGet200Response.md)
|
850
720
|
|
851
721
|
### Authorization
|
852
722
|
|
853
|
-
[
|
723
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
854
724
|
|
855
725
|
### HTTP request headers
|
856
726
|
|
@@ -860,7 +730,7 @@ end
|
|
860
730
|
|
861
731
|
## companies_company_id_assets_post
|
862
732
|
|
863
|
-
>
|
733
|
+
> <CompaniesCompanyIdAssetsPost200Response> companies_company_id_assets_post(company_id, asset)
|
864
734
|
|
865
735
|
Create a new asset
|
866
736
|
|
@@ -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
|
@@ -892,7 +764,7 @@ end
|
|
892
764
|
|
893
765
|
This returns an Array which contains the response data, status code and headers.
|
894
766
|
|
895
|
-
> <Array(
|
767
|
+
> <Array(<CompaniesCompanyIdAssetsPost200Response>, Integer, Hash)> companies_company_id_assets_post_with_http_info(company_id, asset)
|
896
768
|
|
897
769
|
```ruby
|
898
770
|
begin
|
@@ -900,7 +772,7 @@ begin
|
|
900
772
|
data, status_code, headers = api_instance.companies_company_id_assets_post_with_http_info(company_id, asset)
|
901
773
|
p status_code # => 2xx
|
902
774
|
p headers # => { ... }
|
903
|
-
p data # =>
|
775
|
+
p data # => <CompaniesCompanyIdAssetsPost200Response>
|
904
776
|
rescue SparteraApiSdk::ApiError => e
|
905
777
|
puts "Error when calling AssetsApi->companies_company_id_assets_post_with_http_info: #{e}"
|
906
778
|
end
|
@@ -915,11 +787,11 @@ end
|
|
915
787
|
|
916
788
|
### Return type
|
917
789
|
|
918
|
-
**
|
790
|
+
[**CompaniesCompanyIdAssetsPost200Response**](CompaniesCompanyIdAssetsPost200Response.md)
|
919
791
|
|
920
792
|
### Authorization
|
921
793
|
|
922
|
-
[
|
794
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
923
795
|
|
924
796
|
### HTTP request headers
|
925
797
|
|
@@ -927,145 +799,9 @@ 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
|
+
> <CompaniesCompanyIdAssetsGet200Response> companies_company_id_assets_statistics_get(company_id)
|
1069
805
|
|
1070
806
|
Get statistics for all assets the user has access to
|
1071
807
|
|
@@ -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
|
@@ -1096,7 +834,7 @@ end
|
|
1096
834
|
|
1097
835
|
This returns an Array which contains the response data, status code and headers.
|
1098
836
|
|
1099
|
-
> <Array(
|
837
|
+
> <Array(<CompaniesCompanyIdAssetsGet200Response>, Integer, Hash)> companies_company_id_assets_statistics_get_with_http_info(company_id)
|
1100
838
|
|
1101
839
|
```ruby
|
1102
840
|
begin
|
@@ -1104,7 +842,7 @@ begin
|
|
1104
842
|
data, status_code, headers = api_instance.companies_company_id_assets_statistics_get_with_http_info(company_id)
|
1105
843
|
p status_code # => 2xx
|
1106
844
|
p headers # => { ... }
|
1107
|
-
p data # =>
|
845
|
+
p data # => <CompaniesCompanyIdAssetsGet200Response>
|
1108
846
|
rescue SparteraApiSdk::ApiError => e
|
1109
847
|
puts "Error when calling AssetsApi->companies_company_id_assets_statistics_get_with_http_info: #{e}"
|
1110
848
|
end
|
@@ -1118,11 +856,11 @@ end
|
|
1118
856
|
|
1119
857
|
### Return type
|
1120
858
|
|
1121
|
-
**
|
859
|
+
[**CompaniesCompanyIdAssetsGet200Response**](CompaniesCompanyIdAssetsGet200Response.md)
|
1122
860
|
|
1123
861
|
### Authorization
|
1124
862
|
|
1125
|
-
[
|
863
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1126
864
|
|
1127
865
|
### HTTP request headers
|
1128
866
|
|