spartera_api_sdk 1.0.58
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 +7 -0
- data/Gemfile +11 -0
- data/Gemfile.lock +69 -0
- data/LICENSE +21 -0
- data/README.md +360 -0
- data/Rakefile +10 -0
- data/config.json +10 -0
- data/docs/APIKeysApi.md +353 -0
- data/docs/Alert.md +36 -0
- data/docs/AlertsApi.md +511 -0
- data/docs/Apikey.md +36 -0
- data/docs/Asset.md +110 -0
- data/docs/AssetPriceHistoryApi.md +573 -0
- data/docs/Assetpricehistory.md +38 -0
- data/docs/AssetsApi.md +1131 -0
- data/docs/CloudProvidersApi.md +341 -0
- data/docs/Cloudprovider.md +30 -0
- data/docs/CompaniesApi.md +619 -0
- data/docs/Company.md +44 -0
- data/docs/Connection.md +54 -0
- data/docs/ConnectionsApi.md +497 -0
- data/docs/Error.md +24 -0
- data/docs/Favorite.md +36 -0
- data/docs/FavoritesApi.md +581 -0
- data/docs/InlineObject.md +22 -0
- data/docs/InlineObject1.md +20 -0
- data/docs/InlineObject2.md +20 -0
- data/docs/InlineObject3.md +20 -0
- data/docs/User.md +34 -0
- data/docs/UsersApi.md +357 -0
- data/example.rb +51 -0
- data/git_push.sh +57 -0
- data/lib/spartera_api_sdk/api/alerts_api.rb +543 -0
- data/lib/spartera_api_sdk/api/api_keys_api.rb +345 -0
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +576 -0
- data/lib/spartera_api_sdk/api/assets_api.rb +1106 -0
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +315 -0
- data/lib/spartera_api_sdk/api/companies_api.rb +571 -0
- data/lib/spartera_api_sdk/api/connections_api.rb +501 -0
- data/lib/spartera_api_sdk/api/favorites_api.rb +610 -0
- data/lib/spartera_api_sdk/api/users_api.rb +367 -0
- data/lib/spartera_api_sdk/api_client.rb +393 -0
- data/lib/spartera_api_sdk/api_error.rb +58 -0
- data/lib/spartera_api_sdk/configuration.rb +320 -0
- data/lib/spartera_api_sdk/models/alert.rb +353 -0
- data/lib/spartera_api_sdk/models/apikey.rb +370 -0
- data/lib/spartera_api_sdk/models/asset.rb +686 -0
- data/lib/spartera_api_sdk/models/assetpricehistory.rb +345 -0
- data/lib/spartera_api_sdk/models/cloudprovider.rb +292 -0
- data/lib/spartera_api_sdk/models/company.rb +389 -0
- data/lib/spartera_api_sdk/models/connection.rb +434 -0
- data/lib/spartera_api_sdk/models/error.rb +285 -0
- data/lib/spartera_api_sdk/models/favorite.rb +353 -0
- data/lib/spartera_api_sdk/models/inline_object.rb +240 -0
- data/lib/spartera_api_sdk/models/inline_object1.rb +229 -0
- data/lib/spartera_api_sdk/models/inline_object2.rb +229 -0
- data/lib/spartera_api_sdk/models/inline_object3.rb +229 -0
- data/lib/spartera_api_sdk/models/user.rb +327 -0
- data/lib/spartera_api_sdk/version.rb +15 -0
- data/lib/spartera_api_sdk.rb +62 -0
- data/spartera_api_sdk.gemspec +28 -0
- data/spec/api/alerts_api_spec.rb +126 -0
- data/spec/api/api_keys_api_spec.rb +93 -0
- data/spec/api/asset_price_history_api_spec.rb +134 -0
- data/spec/api/assets_api_spec.rb +228 -0
- data/spec/api/cloud_providers_api_spec.rb +88 -0
- data/spec/api/companies_api_spec.rb +134 -0
- data/spec/api/connections_api_spec.rb +119 -0
- data/spec/api/favorites_api_spec.rb +138 -0
- data/spec/api/users_api_spec.rb +95 -0
- data/spec/models/alert_spec.rb +90 -0
- data/spec/models/apikey_spec.rb +90 -0
- data/spec/models/asset_spec.rb +312 -0
- data/spec/models/assetpricehistory_spec.rb +96 -0
- data/spec/models/cloudprovider_spec.rb +72 -0
- data/spec/models/company_spec.rb +114 -0
- data/spec/models/connection_spec.rb +144 -0
- data/spec/models/error_spec.rb +54 -0
- data/spec/models/favorite_spec.rb +90 -0
- data/spec/models/inline_object1_spec.rb +42 -0
- data/spec/models/inline_object2_spec.rb +42 -0
- data/spec/models/inline_object3_spec.rb +42 -0
- data/spec/models/inline_object_spec.rb +48 -0
- data/spec/models/user_spec.rb +84 -0
- data/spec/spec_helper.rb +111 -0
- data/test.sh +42 -0
- metadata +204 -0
data/docs/AssetsApi.md
ADDED
@@ -0,0 +1,1131 @@
|
|
1
|
+
# SparteraApiSdk::AssetsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.spartera.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
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 assets route that handles both owned and purchased assets. Minimal route function that passes all logic to crudder.process_asset Args: asset_path: The path after /analyze/ containing asset information company_handle: The subdomain from Flask's routing (if available) |
|
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
|
+
| [**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
|
+
| [**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 | Get the information schema for a specific asset and save it to the asset's asset_schema field |
|
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
|
+
| [**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
|
+
| [**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
|
+
| [**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
|
+
| [**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
|
+
| [**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
|
+
| [**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
|
+
|
24
|
+
|
25
|
+
## analyze_company_handle_assets_asset_slug_get
|
26
|
+
|
27
|
+
> Object analyze_company_handle_assets_asset_slug_get(company_handle, asset_slug)
|
28
|
+
|
29
|
+
Process assets route that handles both owned and purchased assets. Minimal route function that passes all logic to crudder.process_asset Args: asset_path: The path after /analyze/ containing asset information company_handle: The subdomain from Flask's routing (if available)
|
30
|
+
|
31
|
+
### Examples
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
require 'time'
|
35
|
+
require 'spartera_api_sdk'
|
36
|
+
# setup authorization
|
37
|
+
SparteraApiSdk.configure do |config|
|
38
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
39
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
40
|
+
end
|
41
|
+
|
42
|
+
api_instance = SparteraApiSdk::AssetsApi.new
|
43
|
+
company_handle = 'company_handle_example' # String |
|
44
|
+
asset_slug = 'asset_slug_example' # String |
|
45
|
+
|
46
|
+
begin
|
47
|
+
# Process assets route that handles both owned and purchased assets. Minimal route function that passes all logic to crudder.process_asset Args: asset_path: The path after /analyze/ containing asset information company_handle: The subdomain from Flask's routing (if available)
|
48
|
+
result = api_instance.analyze_company_handle_assets_asset_slug_get(company_handle, asset_slug)
|
49
|
+
p result
|
50
|
+
rescue SparteraApiSdk::ApiError => e
|
51
|
+
puts "Error when calling AssetsApi->analyze_company_handle_assets_asset_slug_get: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
#### Using the analyze_company_handle_assets_asset_slug_get_with_http_info variant
|
56
|
+
|
57
|
+
This returns an Array which contains the response data, status code and headers.
|
58
|
+
|
59
|
+
> <Array(Object, Integer, Hash)> analyze_company_handle_assets_asset_slug_get_with_http_info(company_handle, asset_slug)
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
begin
|
63
|
+
# Process assets route that handles both owned and purchased assets. Minimal route function that passes all logic to crudder.process_asset Args: asset_path: The path after /analyze/ containing asset information company_handle: The subdomain from Flask's routing (if available)
|
64
|
+
data, status_code, headers = api_instance.analyze_company_handle_assets_asset_slug_get_with_http_info(company_handle, asset_slug)
|
65
|
+
p status_code # => 2xx
|
66
|
+
p headers # => { ... }
|
67
|
+
p data # => Object
|
68
|
+
rescue SparteraApiSdk::ApiError => e
|
69
|
+
puts "Error when calling AssetsApi->analyze_company_handle_assets_asset_slug_get_with_http_info: #{e}"
|
70
|
+
end
|
71
|
+
```
|
72
|
+
|
73
|
+
### Parameters
|
74
|
+
|
75
|
+
| Name | Type | Description | Notes |
|
76
|
+
| ---- | ---- | ----------- | ----- |
|
77
|
+
| **company_handle** | **String** | | |
|
78
|
+
| **asset_slug** | **String** | | |
|
79
|
+
|
80
|
+
### Return type
|
81
|
+
|
82
|
+
**Object**
|
83
|
+
|
84
|
+
### Authorization
|
85
|
+
|
86
|
+
[bearerAuth](../README.md#bearerAuth)
|
87
|
+
|
88
|
+
### HTTP request headers
|
89
|
+
|
90
|
+
- **Content-Type**: Not defined
|
91
|
+
- **Accept**: application/json
|
92
|
+
|
93
|
+
|
94
|
+
## companies_company_id_assets_asset_id_delete
|
95
|
+
|
96
|
+
> Object companies_company_id_assets_asset_id_delete(company_id, asset_id)
|
97
|
+
|
98
|
+
Delete single asset by ID
|
99
|
+
|
100
|
+
### Examples
|
101
|
+
|
102
|
+
```ruby
|
103
|
+
require 'time'
|
104
|
+
require 'spartera_api_sdk'
|
105
|
+
# setup authorization
|
106
|
+
SparteraApiSdk.configure do |config|
|
107
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
108
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
109
|
+
end
|
110
|
+
|
111
|
+
api_instance = SparteraApiSdk::AssetsApi.new
|
112
|
+
company_id = 'company_id_example' # String |
|
113
|
+
asset_id = 'asset_id_example' # String |
|
114
|
+
|
115
|
+
begin
|
116
|
+
# Delete single asset by ID
|
117
|
+
result = api_instance.companies_company_id_assets_asset_id_delete(company_id, asset_id)
|
118
|
+
p result
|
119
|
+
rescue SparteraApiSdk::ApiError => e
|
120
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_delete: #{e}"
|
121
|
+
end
|
122
|
+
```
|
123
|
+
|
124
|
+
#### Using the companies_company_id_assets_asset_id_delete_with_http_info variant
|
125
|
+
|
126
|
+
This returns an Array which contains the response data, status code and headers.
|
127
|
+
|
128
|
+
> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_delete_with_http_info(company_id, asset_id)
|
129
|
+
|
130
|
+
```ruby
|
131
|
+
begin
|
132
|
+
# Delete single asset by ID
|
133
|
+
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_delete_with_http_info(company_id, asset_id)
|
134
|
+
p status_code # => 2xx
|
135
|
+
p headers # => { ... }
|
136
|
+
p data # => Object
|
137
|
+
rescue SparteraApiSdk::ApiError => e
|
138
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_delete_with_http_info: #{e}"
|
139
|
+
end
|
140
|
+
```
|
141
|
+
|
142
|
+
### Parameters
|
143
|
+
|
144
|
+
| Name | Type | Description | Notes |
|
145
|
+
| ---- | ---- | ----------- | ----- |
|
146
|
+
| **company_id** | **String** | | |
|
147
|
+
| **asset_id** | **String** | | |
|
148
|
+
|
149
|
+
### Return type
|
150
|
+
|
151
|
+
**Object**
|
152
|
+
|
153
|
+
### Authorization
|
154
|
+
|
155
|
+
[bearerAuth](../README.md#bearerAuth)
|
156
|
+
|
157
|
+
### HTTP request headers
|
158
|
+
|
159
|
+
- **Content-Type**: Not defined
|
160
|
+
- **Accept**: application/json
|
161
|
+
|
162
|
+
|
163
|
+
## companies_company_id_assets_asset_id_get
|
164
|
+
|
165
|
+
> Object companies_company_id_assets_asset_id_get(company_id, asset_id)
|
166
|
+
|
167
|
+
Get single asset by ID
|
168
|
+
|
169
|
+
### Examples
|
170
|
+
|
171
|
+
```ruby
|
172
|
+
require 'time'
|
173
|
+
require 'spartera_api_sdk'
|
174
|
+
# setup authorization
|
175
|
+
SparteraApiSdk.configure do |config|
|
176
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
177
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
178
|
+
end
|
179
|
+
|
180
|
+
api_instance = SparteraApiSdk::AssetsApi.new
|
181
|
+
company_id = 'company_id_example' # String |
|
182
|
+
asset_id = 'asset_id_example' # String |
|
183
|
+
|
184
|
+
begin
|
185
|
+
# Get single asset by ID
|
186
|
+
result = api_instance.companies_company_id_assets_asset_id_get(company_id, asset_id)
|
187
|
+
p result
|
188
|
+
rescue SparteraApiSdk::ApiError => e
|
189
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_get: #{e}"
|
190
|
+
end
|
191
|
+
```
|
192
|
+
|
193
|
+
#### Using the companies_company_id_assets_asset_id_get_with_http_info variant
|
194
|
+
|
195
|
+
This returns an Array which contains the response data, status code and headers.
|
196
|
+
|
197
|
+
> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_get_with_http_info(company_id, asset_id)
|
198
|
+
|
199
|
+
```ruby
|
200
|
+
begin
|
201
|
+
# Get single asset by ID
|
202
|
+
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_get_with_http_info(company_id, asset_id)
|
203
|
+
p status_code # => 2xx
|
204
|
+
p headers # => { ... }
|
205
|
+
p data # => Object
|
206
|
+
rescue SparteraApiSdk::ApiError => e
|
207
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_get_with_http_info: #{e}"
|
208
|
+
end
|
209
|
+
```
|
210
|
+
|
211
|
+
### Parameters
|
212
|
+
|
213
|
+
| Name | Type | Description | Notes |
|
214
|
+
| ---- | ---- | ----------- | ----- |
|
215
|
+
| **company_id** | **String** | | |
|
216
|
+
| **asset_id** | **String** | | |
|
217
|
+
|
218
|
+
### Return type
|
219
|
+
|
220
|
+
**Object**
|
221
|
+
|
222
|
+
### Authorization
|
223
|
+
|
224
|
+
[bearerAuth](../README.md#bearerAuth)
|
225
|
+
|
226
|
+
### HTTP request headers
|
227
|
+
|
228
|
+
- **Content-Type**: Not defined
|
229
|
+
- **Accept**: application/json
|
230
|
+
|
231
|
+
|
232
|
+
## companies_company_id_assets_asset_id_infoschema_get
|
233
|
+
|
234
|
+
> Object companies_company_id_assets_asset_id_infoschema_get(company_id, asset_id)
|
235
|
+
|
236
|
+
Get the information schema for a specific asset's table
|
237
|
+
|
238
|
+
### Examples
|
239
|
+
|
240
|
+
```ruby
|
241
|
+
require 'time'
|
242
|
+
require 'spartera_api_sdk'
|
243
|
+
# setup authorization
|
244
|
+
SparteraApiSdk.configure do |config|
|
245
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
246
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
247
|
+
end
|
248
|
+
|
249
|
+
api_instance = SparteraApiSdk::AssetsApi.new
|
250
|
+
company_id = 'company_id_example' # String |
|
251
|
+
asset_id = 'asset_id_example' # String |
|
252
|
+
|
253
|
+
begin
|
254
|
+
# Get the information schema for a specific asset's table
|
255
|
+
result = api_instance.companies_company_id_assets_asset_id_infoschema_get(company_id, asset_id)
|
256
|
+
p result
|
257
|
+
rescue SparteraApiSdk::ApiError => e
|
258
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_infoschema_get: #{e}"
|
259
|
+
end
|
260
|
+
```
|
261
|
+
|
262
|
+
#### Using the companies_company_id_assets_asset_id_infoschema_get_with_http_info variant
|
263
|
+
|
264
|
+
This returns an Array which contains the response data, status code and headers.
|
265
|
+
|
266
|
+
> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_infoschema_get_with_http_info(company_id, asset_id)
|
267
|
+
|
268
|
+
```ruby
|
269
|
+
begin
|
270
|
+
# Get the information schema for a specific asset's table
|
271
|
+
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_infoschema_get_with_http_info(company_id, asset_id)
|
272
|
+
p status_code # => 2xx
|
273
|
+
p headers # => { ... }
|
274
|
+
p data # => Object
|
275
|
+
rescue SparteraApiSdk::ApiError => e
|
276
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_infoschema_get_with_http_info: #{e}"
|
277
|
+
end
|
278
|
+
```
|
279
|
+
|
280
|
+
### Parameters
|
281
|
+
|
282
|
+
| Name | Type | Description | Notes |
|
283
|
+
| ---- | ---- | ----------- | ----- |
|
284
|
+
| **company_id** | **String** | | |
|
285
|
+
| **asset_id** | **String** | | |
|
286
|
+
|
287
|
+
### Return type
|
288
|
+
|
289
|
+
**Object**
|
290
|
+
|
291
|
+
### Authorization
|
292
|
+
|
293
|
+
[bearerAuth](../README.md#bearerAuth)
|
294
|
+
|
295
|
+
### HTTP request headers
|
296
|
+
|
297
|
+
- **Content-Type**: Not defined
|
298
|
+
- **Accept**: application/json
|
299
|
+
|
300
|
+
|
301
|
+
## companies_company_id_assets_asset_id_infoschema_save_get
|
302
|
+
|
303
|
+
> Object companies_company_id_assets_asset_id_infoschema_save_get(company_id, asset_id)
|
304
|
+
|
305
|
+
Get the information schema for a specific asset and save it to the asset's asset_schema field
|
306
|
+
|
307
|
+
### Examples
|
308
|
+
|
309
|
+
```ruby
|
310
|
+
require 'time'
|
311
|
+
require 'spartera_api_sdk'
|
312
|
+
# setup authorization
|
313
|
+
SparteraApiSdk.configure do |config|
|
314
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
315
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
316
|
+
end
|
317
|
+
|
318
|
+
api_instance = SparteraApiSdk::AssetsApi.new
|
319
|
+
company_id = 'company_id_example' # String |
|
320
|
+
asset_id = 'asset_id_example' # String |
|
321
|
+
|
322
|
+
begin
|
323
|
+
# Get the information schema for a specific asset and save it to the asset's asset_schema field
|
324
|
+
result = api_instance.companies_company_id_assets_asset_id_infoschema_save_get(company_id, asset_id)
|
325
|
+
p result
|
326
|
+
rescue SparteraApiSdk::ApiError => e
|
327
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_infoschema_save_get: #{e}"
|
328
|
+
end
|
329
|
+
```
|
330
|
+
|
331
|
+
#### Using the companies_company_id_assets_asset_id_infoschema_save_get_with_http_info variant
|
332
|
+
|
333
|
+
This returns an Array which contains the response data, status code and headers.
|
334
|
+
|
335
|
+
> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_infoschema_save_get_with_http_info(company_id, asset_id)
|
336
|
+
|
337
|
+
```ruby
|
338
|
+
begin
|
339
|
+
# Get the information schema for a specific asset and save it to the asset's asset_schema field
|
340
|
+
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_infoschema_save_get_with_http_info(company_id, asset_id)
|
341
|
+
p status_code # => 2xx
|
342
|
+
p headers # => { ... }
|
343
|
+
p data # => Object
|
344
|
+
rescue SparteraApiSdk::ApiError => e
|
345
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_infoschema_save_get_with_http_info: #{e}"
|
346
|
+
end
|
347
|
+
```
|
348
|
+
|
349
|
+
### Parameters
|
350
|
+
|
351
|
+
| Name | Type | Description | Notes |
|
352
|
+
| ---- | ---- | ----------- | ----- |
|
353
|
+
| **company_id** | **String** | | |
|
354
|
+
| **asset_id** | **String** | | |
|
355
|
+
|
356
|
+
### Return type
|
357
|
+
|
358
|
+
**Object**
|
359
|
+
|
360
|
+
### Authorization
|
361
|
+
|
362
|
+
[bearerAuth](../README.md#bearerAuth)
|
363
|
+
|
364
|
+
### HTTP request headers
|
365
|
+
|
366
|
+
- **Content-Type**: Not defined
|
367
|
+
- **Accept**: application/json
|
368
|
+
|
369
|
+
|
370
|
+
## companies_company_id_assets_asset_id_patch
|
371
|
+
|
372
|
+
> Object companies_company_id_assets_asset_id_patch(company_id, asset_id, asset)
|
373
|
+
|
374
|
+
Update an existing asset by ID
|
375
|
+
|
376
|
+
### Examples
|
377
|
+
|
378
|
+
```ruby
|
379
|
+
require 'time'
|
380
|
+
require 'spartera_api_sdk'
|
381
|
+
# setup authorization
|
382
|
+
SparteraApiSdk.configure do |config|
|
383
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
384
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
385
|
+
end
|
386
|
+
|
387
|
+
api_instance = SparteraApiSdk::AssetsApi.new
|
388
|
+
company_id = 'company_id_example' # String |
|
389
|
+
asset_id = 'asset_id_example' # String |
|
390
|
+
asset = SparteraApiSdk::Asset.new({company_id: 'company_id_example', name: 'name_example', source: 'source_example'}) # Asset |
|
391
|
+
|
392
|
+
begin
|
393
|
+
# Update an existing asset by ID
|
394
|
+
result = api_instance.companies_company_id_assets_asset_id_patch(company_id, asset_id, asset)
|
395
|
+
p result
|
396
|
+
rescue SparteraApiSdk::ApiError => e
|
397
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_patch: #{e}"
|
398
|
+
end
|
399
|
+
```
|
400
|
+
|
401
|
+
#### Using the companies_company_id_assets_asset_id_patch_with_http_info variant
|
402
|
+
|
403
|
+
This returns an Array which contains the response data, status code and headers.
|
404
|
+
|
405
|
+
> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_patch_with_http_info(company_id, asset_id, asset)
|
406
|
+
|
407
|
+
```ruby
|
408
|
+
begin
|
409
|
+
# Update an existing asset by ID
|
410
|
+
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_patch_with_http_info(company_id, asset_id, asset)
|
411
|
+
p status_code # => 2xx
|
412
|
+
p headers # => { ... }
|
413
|
+
p data # => Object
|
414
|
+
rescue SparteraApiSdk::ApiError => e
|
415
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_patch_with_http_info: #{e}"
|
416
|
+
end
|
417
|
+
```
|
418
|
+
|
419
|
+
### Parameters
|
420
|
+
|
421
|
+
| Name | Type | Description | Notes |
|
422
|
+
| ---- | ---- | ----------- | ----- |
|
423
|
+
| **company_id** | **String** | | |
|
424
|
+
| **asset_id** | **String** | | |
|
425
|
+
| **asset** | [**Asset**](Asset.md) | | |
|
426
|
+
|
427
|
+
### Return type
|
428
|
+
|
429
|
+
**Object**
|
430
|
+
|
431
|
+
### Authorization
|
432
|
+
|
433
|
+
[bearerAuth](../README.md#bearerAuth)
|
434
|
+
|
435
|
+
### HTTP request headers
|
436
|
+
|
437
|
+
- **Content-Type**: application/json
|
438
|
+
- **Accept**: application/json
|
439
|
+
|
440
|
+
|
441
|
+
## companies_company_id_assets_asset_id_predicted_price_get
|
442
|
+
|
443
|
+
> Object companies_company_id_assets_asset_id_predicted_price_get(company_id, asset_id)
|
444
|
+
|
445
|
+
Get AI-predicted pricing for a specific asset
|
446
|
+
|
447
|
+
### Examples
|
448
|
+
|
449
|
+
```ruby
|
450
|
+
require 'time'
|
451
|
+
require 'spartera_api_sdk'
|
452
|
+
# setup authorization
|
453
|
+
SparteraApiSdk.configure do |config|
|
454
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
455
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
456
|
+
end
|
457
|
+
|
458
|
+
api_instance = SparteraApiSdk::AssetsApi.new
|
459
|
+
company_id = 'company_id_example' # String |
|
460
|
+
asset_id = 'asset_id_example' # String |
|
461
|
+
|
462
|
+
begin
|
463
|
+
# Get AI-predicted pricing for a specific asset
|
464
|
+
result = api_instance.companies_company_id_assets_asset_id_predicted_price_get(company_id, asset_id)
|
465
|
+
p result
|
466
|
+
rescue SparteraApiSdk::ApiError => e
|
467
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_predicted_price_get: #{e}"
|
468
|
+
end
|
469
|
+
```
|
470
|
+
|
471
|
+
#### Using the companies_company_id_assets_asset_id_predicted_price_get_with_http_info variant
|
472
|
+
|
473
|
+
This returns an Array which contains the response data, status code and headers.
|
474
|
+
|
475
|
+
> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_predicted_price_get_with_http_info(company_id, asset_id)
|
476
|
+
|
477
|
+
```ruby
|
478
|
+
begin
|
479
|
+
# Get AI-predicted pricing for a specific asset
|
480
|
+
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_predicted_price_get_with_http_info(company_id, asset_id)
|
481
|
+
p status_code # => 2xx
|
482
|
+
p headers # => { ... }
|
483
|
+
p data # => Object
|
484
|
+
rescue SparteraApiSdk::ApiError => e
|
485
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_predicted_price_get_with_http_info: #{e}"
|
486
|
+
end
|
487
|
+
```
|
488
|
+
|
489
|
+
### Parameters
|
490
|
+
|
491
|
+
| Name | Type | Description | Notes |
|
492
|
+
| ---- | ---- | ----------- | ----- |
|
493
|
+
| **company_id** | **String** | | |
|
494
|
+
| **asset_id** | **String** | | |
|
495
|
+
|
496
|
+
### Return type
|
497
|
+
|
498
|
+
**Object**
|
499
|
+
|
500
|
+
### Authorization
|
501
|
+
|
502
|
+
[bearerAuth](../README.md#bearerAuth)
|
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)
|
649
|
+
|
650
|
+
### HTTP request headers
|
651
|
+
|
652
|
+
- **Content-Type**: Not defined
|
653
|
+
- **Accept**: application/json
|
654
|
+
|
655
|
+
|
656
|
+
## companies_company_id_assets_asset_id_statistics_get
|
657
|
+
|
658
|
+
> Object companies_company_id_assets_asset_id_statistics_get(company_id, asset_id)
|
659
|
+
|
660
|
+
Get statistics for a specific asset (public endpoint)
|
661
|
+
|
662
|
+
### Examples
|
663
|
+
|
664
|
+
```ruby
|
665
|
+
require 'time'
|
666
|
+
require 'spartera_api_sdk'
|
667
|
+
# setup authorization
|
668
|
+
SparteraApiSdk.configure do |config|
|
669
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
670
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
671
|
+
end
|
672
|
+
|
673
|
+
api_instance = SparteraApiSdk::AssetsApi.new
|
674
|
+
company_id = 'company_id_example' # String |
|
675
|
+
asset_id = 'asset_id_example' # String |
|
676
|
+
|
677
|
+
begin
|
678
|
+
# Get statistics for a specific asset (public endpoint)
|
679
|
+
result = api_instance.companies_company_id_assets_asset_id_statistics_get(company_id, asset_id)
|
680
|
+
p result
|
681
|
+
rescue SparteraApiSdk::ApiError => e
|
682
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_statistics_get: #{e}"
|
683
|
+
end
|
684
|
+
```
|
685
|
+
|
686
|
+
#### Using the companies_company_id_assets_asset_id_statistics_get_with_http_info variant
|
687
|
+
|
688
|
+
This returns an Array which contains the response data, status code and headers.
|
689
|
+
|
690
|
+
> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_statistics_get_with_http_info(company_id, asset_id)
|
691
|
+
|
692
|
+
```ruby
|
693
|
+
begin
|
694
|
+
# Get statistics for a specific asset (public endpoint)
|
695
|
+
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_statistics_get_with_http_info(company_id, asset_id)
|
696
|
+
p status_code # => 2xx
|
697
|
+
p headers # => { ... }
|
698
|
+
p data # => Object
|
699
|
+
rescue SparteraApiSdk::ApiError => e
|
700
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_statistics_get_with_http_info: #{e}"
|
701
|
+
end
|
702
|
+
```
|
703
|
+
|
704
|
+
### Parameters
|
705
|
+
|
706
|
+
| Name | Type | Description | Notes |
|
707
|
+
| ---- | ---- | ----------- | ----- |
|
708
|
+
| **company_id** | **String** | | |
|
709
|
+
| **asset_id** | **String** | | |
|
710
|
+
|
711
|
+
### Return type
|
712
|
+
|
713
|
+
**Object**
|
714
|
+
|
715
|
+
### Authorization
|
716
|
+
|
717
|
+
[bearerAuth](../README.md#bearerAuth)
|
718
|
+
|
719
|
+
### HTTP request headers
|
720
|
+
|
721
|
+
- **Content-Type**: Not defined
|
722
|
+
- **Accept**: application/json
|
723
|
+
|
724
|
+
|
725
|
+
## companies_company_id_assets_asset_id_test_get
|
726
|
+
|
727
|
+
> Object companies_company_id_assets_asset_id_test_get(company_id, asset_id)
|
728
|
+
|
729
|
+
Test out an Asset (on a subset of data)
|
730
|
+
|
731
|
+
### Examples
|
732
|
+
|
733
|
+
```ruby
|
734
|
+
require 'time'
|
735
|
+
require 'spartera_api_sdk'
|
736
|
+
# setup authorization
|
737
|
+
SparteraApiSdk.configure do |config|
|
738
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
739
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
740
|
+
end
|
741
|
+
|
742
|
+
api_instance = SparteraApiSdk::AssetsApi.new
|
743
|
+
company_id = 'company_id_example' # String |
|
744
|
+
asset_id = 'asset_id_example' # String |
|
745
|
+
|
746
|
+
begin
|
747
|
+
# Test out an Asset (on a subset of data)
|
748
|
+
result = api_instance.companies_company_id_assets_asset_id_test_get(company_id, asset_id)
|
749
|
+
p result
|
750
|
+
rescue SparteraApiSdk::ApiError => e
|
751
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_test_get: #{e}"
|
752
|
+
end
|
753
|
+
```
|
754
|
+
|
755
|
+
#### Using the companies_company_id_assets_asset_id_test_get_with_http_info variant
|
756
|
+
|
757
|
+
This returns an Array which contains the response data, status code and headers.
|
758
|
+
|
759
|
+
> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_test_get_with_http_info(company_id, asset_id)
|
760
|
+
|
761
|
+
```ruby
|
762
|
+
begin
|
763
|
+
# Test out an Asset (on a subset of data)
|
764
|
+
data, status_code, headers = api_instance.companies_company_id_assets_asset_id_test_get_with_http_info(company_id, asset_id)
|
765
|
+
p status_code # => 2xx
|
766
|
+
p headers # => { ... }
|
767
|
+
p data # => Object
|
768
|
+
rescue SparteraApiSdk::ApiError => e
|
769
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_asset_id_test_get_with_http_info: #{e}"
|
770
|
+
end
|
771
|
+
```
|
772
|
+
|
773
|
+
### Parameters
|
774
|
+
|
775
|
+
| Name | Type | Description | Notes |
|
776
|
+
| ---- | ---- | ----------- | ----- |
|
777
|
+
| **company_id** | **String** | | |
|
778
|
+
| **asset_id** | **String** | | |
|
779
|
+
|
780
|
+
### Return type
|
781
|
+
|
782
|
+
**Object**
|
783
|
+
|
784
|
+
### Authorization
|
785
|
+
|
786
|
+
[bearerAuth](../README.md#bearerAuth)
|
787
|
+
|
788
|
+
### HTTP request headers
|
789
|
+
|
790
|
+
- **Content-Type**: Not defined
|
791
|
+
- **Accept**: application/json
|
792
|
+
|
793
|
+
|
794
|
+
## companies_company_id_assets_get
|
795
|
+
|
796
|
+
> Object companies_company_id_assets_get(company_id)
|
797
|
+
|
798
|
+
Get all assets for a specific company
|
799
|
+
|
800
|
+
### Examples
|
801
|
+
|
802
|
+
```ruby
|
803
|
+
require 'time'
|
804
|
+
require 'spartera_api_sdk'
|
805
|
+
# setup authorization
|
806
|
+
SparteraApiSdk.configure do |config|
|
807
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
808
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
809
|
+
end
|
810
|
+
|
811
|
+
api_instance = SparteraApiSdk::AssetsApi.new
|
812
|
+
company_id = 'company_id_example' # String |
|
813
|
+
|
814
|
+
begin
|
815
|
+
# Get all assets for a specific company
|
816
|
+
result = api_instance.companies_company_id_assets_get(company_id)
|
817
|
+
p result
|
818
|
+
rescue SparteraApiSdk::ApiError => e
|
819
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_get: #{e}"
|
820
|
+
end
|
821
|
+
```
|
822
|
+
|
823
|
+
#### Using the companies_company_id_assets_get_with_http_info variant
|
824
|
+
|
825
|
+
This returns an Array which contains the response data, status code and headers.
|
826
|
+
|
827
|
+
> <Array(Object, Integer, Hash)> companies_company_id_assets_get_with_http_info(company_id)
|
828
|
+
|
829
|
+
```ruby
|
830
|
+
begin
|
831
|
+
# Get all assets for a specific company
|
832
|
+
data, status_code, headers = api_instance.companies_company_id_assets_get_with_http_info(company_id)
|
833
|
+
p status_code # => 2xx
|
834
|
+
p headers # => { ... }
|
835
|
+
p data # => Object
|
836
|
+
rescue SparteraApiSdk::ApiError => e
|
837
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_get_with_http_info: #{e}"
|
838
|
+
end
|
839
|
+
```
|
840
|
+
|
841
|
+
### Parameters
|
842
|
+
|
843
|
+
| Name | Type | Description | Notes |
|
844
|
+
| ---- | ---- | ----------- | ----- |
|
845
|
+
| **company_id** | **String** | | |
|
846
|
+
|
847
|
+
### Return type
|
848
|
+
|
849
|
+
**Object**
|
850
|
+
|
851
|
+
### Authorization
|
852
|
+
|
853
|
+
[bearerAuth](../README.md#bearerAuth)
|
854
|
+
|
855
|
+
### HTTP request headers
|
856
|
+
|
857
|
+
- **Content-Type**: Not defined
|
858
|
+
- **Accept**: application/json
|
859
|
+
|
860
|
+
|
861
|
+
## companies_company_id_assets_post
|
862
|
+
|
863
|
+
> Object companies_company_id_assets_post(company_id, asset)
|
864
|
+
|
865
|
+
Create a new asset
|
866
|
+
|
867
|
+
### Examples
|
868
|
+
|
869
|
+
```ruby
|
870
|
+
require 'time'
|
871
|
+
require 'spartera_api_sdk'
|
872
|
+
# setup authorization
|
873
|
+
SparteraApiSdk.configure do |config|
|
874
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
875
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
876
|
+
end
|
877
|
+
|
878
|
+
api_instance = SparteraApiSdk::AssetsApi.new
|
879
|
+
company_id = 'company_id_example' # String |
|
880
|
+
asset = SparteraApiSdk::Asset.new({company_id: 'company_id_example', name: 'name_example', source: 'source_example'}) # Asset |
|
881
|
+
|
882
|
+
begin
|
883
|
+
# Create a new asset
|
884
|
+
result = api_instance.companies_company_id_assets_post(company_id, asset)
|
885
|
+
p result
|
886
|
+
rescue SparteraApiSdk::ApiError => e
|
887
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_post: #{e}"
|
888
|
+
end
|
889
|
+
```
|
890
|
+
|
891
|
+
#### Using the companies_company_id_assets_post_with_http_info variant
|
892
|
+
|
893
|
+
This returns an Array which contains the response data, status code and headers.
|
894
|
+
|
895
|
+
> <Array(Object, Integer, Hash)> companies_company_id_assets_post_with_http_info(company_id, asset)
|
896
|
+
|
897
|
+
```ruby
|
898
|
+
begin
|
899
|
+
# Create a new asset
|
900
|
+
data, status_code, headers = api_instance.companies_company_id_assets_post_with_http_info(company_id, asset)
|
901
|
+
p status_code # => 2xx
|
902
|
+
p headers # => { ... }
|
903
|
+
p data # => Object
|
904
|
+
rescue SparteraApiSdk::ApiError => e
|
905
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_post_with_http_info: #{e}"
|
906
|
+
end
|
907
|
+
```
|
908
|
+
|
909
|
+
### Parameters
|
910
|
+
|
911
|
+
| Name | Type | Description | Notes |
|
912
|
+
| ---- | ---- | ----------- | ----- |
|
913
|
+
| **company_id** | **String** | | |
|
914
|
+
| **asset** | [**Asset**](Asset.md) | | |
|
915
|
+
|
916
|
+
### Return type
|
917
|
+
|
918
|
+
**Object**
|
919
|
+
|
920
|
+
### Authorization
|
921
|
+
|
922
|
+
[bearerAuth](../README.md#bearerAuth)
|
923
|
+
|
924
|
+
### HTTP request headers
|
925
|
+
|
926
|
+
- **Content-Type**: application/json
|
927
|
+
- **Accept**: application/json
|
928
|
+
|
929
|
+
|
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
|
+
## companies_company_id_assets_statistics_get
|
1067
|
+
|
1068
|
+
> Object companies_company_id_assets_statistics_get(company_id)
|
1069
|
+
|
1070
|
+
Get statistics for all assets the user has access to
|
1071
|
+
|
1072
|
+
### Examples
|
1073
|
+
|
1074
|
+
```ruby
|
1075
|
+
require 'time'
|
1076
|
+
require 'spartera_api_sdk'
|
1077
|
+
# setup authorization
|
1078
|
+
SparteraApiSdk.configure do |config|
|
1079
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
1080
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
1081
|
+
end
|
1082
|
+
|
1083
|
+
api_instance = SparteraApiSdk::AssetsApi.new
|
1084
|
+
company_id = 'company_id_example' # String |
|
1085
|
+
|
1086
|
+
begin
|
1087
|
+
# Get statistics for all assets the user has access to
|
1088
|
+
result = api_instance.companies_company_id_assets_statistics_get(company_id)
|
1089
|
+
p result
|
1090
|
+
rescue SparteraApiSdk::ApiError => e
|
1091
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_statistics_get: #{e}"
|
1092
|
+
end
|
1093
|
+
```
|
1094
|
+
|
1095
|
+
#### Using the companies_company_id_assets_statistics_get_with_http_info variant
|
1096
|
+
|
1097
|
+
This returns an Array which contains the response data, status code and headers.
|
1098
|
+
|
1099
|
+
> <Array(Object, Integer, Hash)> companies_company_id_assets_statistics_get_with_http_info(company_id)
|
1100
|
+
|
1101
|
+
```ruby
|
1102
|
+
begin
|
1103
|
+
# Get statistics for all assets the user has access to
|
1104
|
+
data, status_code, headers = api_instance.companies_company_id_assets_statistics_get_with_http_info(company_id)
|
1105
|
+
p status_code # => 2xx
|
1106
|
+
p headers # => { ... }
|
1107
|
+
p data # => Object
|
1108
|
+
rescue SparteraApiSdk::ApiError => e
|
1109
|
+
puts "Error when calling AssetsApi->companies_company_id_assets_statistics_get_with_http_info: #{e}"
|
1110
|
+
end
|
1111
|
+
```
|
1112
|
+
|
1113
|
+
### Parameters
|
1114
|
+
|
1115
|
+
| Name | Type | Description | Notes |
|
1116
|
+
| ---- | ---- | ----------- | ----- |
|
1117
|
+
| **company_id** | **String** | | |
|
1118
|
+
|
1119
|
+
### Return type
|
1120
|
+
|
1121
|
+
**Object**
|
1122
|
+
|
1123
|
+
### Authorization
|
1124
|
+
|
1125
|
+
[bearerAuth](../README.md#bearerAuth)
|
1126
|
+
|
1127
|
+
### HTTP request headers
|
1128
|
+
|
1129
|
+
- **Content-Type**: Not defined
|
1130
|
+
- **Accept**: application/json
|
1131
|
+
|