spartera_api_sdk 1.0.58 → 1.0.68
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/config.json +1 -1
- data/docs/APIKeysApi.md +25 -15
- data/docs/AlertsApi.md +43 -29
- data/docs/AssetPriceHistoryApi.md +48 -32
- data/docs/AssetsApi.md +74 -336
- data/docs/CloudProvidersApi.md +10 -207
- data/docs/CompaniesApi.md +45 -27
- data/docs/ConnectionsApi.md +39 -25
- data/docs/FavoritesApi.md +52 -36
- data/docs/StorageEnginesApi.md +149 -0
- data/docs/UsersApi.md +29 -19
- data/lib/spartera_api_sdk/api/alerts_api.rb +11 -11
- data/lib/spartera_api_sdk/api/api_keys_api.rb +5 -5
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +12 -12
- data/lib/spartera_api_sdk/api/assets_api.rb +26 -302
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +2 -179
- data/lib/spartera_api_sdk/api/companies_api.rb +9 -9
- data/lib/spartera_api_sdk/api/connections_api.rb +9 -9
- data/lib/spartera_api_sdk/api/favorites_api.rb +14 -14
- data/lib/spartera_api_sdk/api/storage_engines_api.rb +150 -0
- data/lib/spartera_api_sdk/api/users_api.rb +7 -7
- data/lib/spartera_api_sdk/configuration.rb +2 -10
- data/lib/spartera_api_sdk/version.rb +1 -1
- data/lib/spartera_api_sdk.rb +1 -0
- data/spec/api/alerts_api_spec.rb +2 -2
- data/spec/api/asset_price_history_api_spec.rb +2 -2
- data/spec/api/assets_api_spec.rb +3 -53
- data/spec/api/cloud_providers_api_spec.rb +0 -32
- data/spec/api/connections_api_spec.rb +1 -1
- data/spec/api/favorites_api_spec.rb +3 -3
- data/spec/api/storage_engines_api_spec.rb +58 -0
- data/spec/api/users_api_spec.rb +1 -1
- metadata +28 -22
- data/Gemfile.lock +0 -69
data/docs/FavoritesApi.md
CHANGED
@@ -5,11 +5,11 @@ All URIs are relative to *https://api.spartera.com*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**companies_company_id_users_user_id_favorites_category_category_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_category_category_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/category/{category} | Get all favorites for the specified user in a specific category |
|
8
|
-
| [**companies_company_id_users_user_id_favorites_check_asset_id_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_check_asset_id_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/check/{asset_id} | Check if the specified user has favorited a specific asset
|
8
|
+
| [**companies_company_id_users_user_id_favorites_check_asset_id_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_check_asset_id_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/check/{asset_id} | Check if the specified user has favorited a specific asset |
|
9
9
|
| [**companies_company_id_users_user_id_favorites_favorite_id_delete**](FavoritesApi.md#companies_company_id_users_user_id_favorites_favorite_id_delete) | **DELETE** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Delete single favorite by ID (unfavorite an asset) |
|
10
10
|
| [**companies_company_id_users_user_id_favorites_favorite_id_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_favorite_id_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Get single favorite by ID |
|
11
|
-
| [**companies_company_id_users_user_id_favorites_favorite_id_patch**](FavoritesApi.md#companies_company_id_users_user_id_favorites_favorite_id_patch) | **PATCH** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Update an existing favorite by ID
|
12
|
-
| [**companies_company_id_users_user_id_favorites_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_get) | **GET** /companies/{company_id}/users/{user_id}/favorites | Get a list of all favorites for a specific user
|
11
|
+
| [**companies_company_id_users_user_id_favorites_favorite_id_patch**](FavoritesApi.md#companies_company_id_users_user_id_favorites_favorite_id_patch) | **PATCH** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Update an existing favorite by ID |
|
12
|
+
| [**companies_company_id_users_user_id_favorites_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_get) | **GET** /companies/{company_id}/users/{user_id}/favorites | Get a list of all favorites for a specific user |
|
13
13
|
| [**companies_company_id_users_user_id_favorites_post**](FavoritesApi.md#companies_company_id_users_user_id_favorites_post) | **POST** /companies/{company_id}/users/{user_id}/favorites | POST /companies/{company_id}/users/{user_id}/favorites |
|
14
14
|
| [**companies_company_id_users_user_id_favorites_uncategorized_get**](FavoritesApi.md#companies_company_id_users_user_id_favorites_uncategorized_get) | **GET** /companies/{company_id}/users/{user_id}/favorites/uncategorized | Get all favorites for the specified user that don't have a category |
|
15
15
|
|
@@ -27,8 +27,10 @@ require 'time'
|
|
27
27
|
require 'spartera_api_sdk'
|
28
28
|
# setup authorization
|
29
29
|
SparteraApiSdk.configure do |config|
|
30
|
-
# Configure
|
31
|
-
config.
|
30
|
+
# Configure API key authorization: ApiKeyAuth
|
31
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
32
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
33
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
32
34
|
end
|
33
35
|
|
34
36
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -77,7 +79,7 @@ end
|
|
77
79
|
|
78
80
|
### Authorization
|
79
81
|
|
80
|
-
[
|
82
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
81
83
|
|
82
84
|
### HTTP request headers
|
83
85
|
|
@@ -89,7 +91,7 @@ end
|
|
89
91
|
|
90
92
|
> Object companies_company_id_users_user_id_favorites_check_asset_id_get(company_id, user_id, asset_id)
|
91
93
|
|
92
|
-
Check if the specified user has favorited a specific asset
|
94
|
+
Check if the specified user has favorited a specific asset
|
93
95
|
|
94
96
|
### Examples
|
95
97
|
|
@@ -98,8 +100,10 @@ require 'time'
|
|
98
100
|
require 'spartera_api_sdk'
|
99
101
|
# setup authorization
|
100
102
|
SparteraApiSdk.configure do |config|
|
101
|
-
# Configure
|
102
|
-
config.
|
103
|
+
# Configure API key authorization: ApiKeyAuth
|
104
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
105
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
106
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
103
107
|
end
|
104
108
|
|
105
109
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -108,7 +112,7 @@ user_id = 'user_id_example' # String |
|
|
108
112
|
asset_id = 'asset_id_example' # String |
|
109
113
|
|
110
114
|
begin
|
111
|
-
# Check if the specified user has favorited a specific asset
|
115
|
+
# Check if the specified user has favorited a specific asset
|
112
116
|
result = api_instance.companies_company_id_users_user_id_favorites_check_asset_id_get(company_id, user_id, asset_id)
|
113
117
|
p result
|
114
118
|
rescue SparteraApiSdk::ApiError => e
|
@@ -124,7 +128,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
124
128
|
|
125
129
|
```ruby
|
126
130
|
begin
|
127
|
-
# Check if the specified user has favorited a specific asset
|
131
|
+
# Check if the specified user has favorited a specific asset
|
128
132
|
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_check_asset_id_get_with_http_info(company_id, user_id, asset_id)
|
129
133
|
p status_code # => 2xx
|
130
134
|
p headers # => { ... }
|
@@ -148,7 +152,7 @@ end
|
|
148
152
|
|
149
153
|
### Authorization
|
150
154
|
|
151
|
-
[
|
155
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
152
156
|
|
153
157
|
### HTTP request headers
|
154
158
|
|
@@ -169,8 +173,10 @@ require 'time'
|
|
169
173
|
require 'spartera_api_sdk'
|
170
174
|
# setup authorization
|
171
175
|
SparteraApiSdk.configure do |config|
|
172
|
-
# Configure
|
173
|
-
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'
|
174
180
|
end
|
175
181
|
|
176
182
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -219,7 +225,7 @@ end
|
|
219
225
|
|
220
226
|
### Authorization
|
221
227
|
|
222
|
-
[
|
228
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
223
229
|
|
224
230
|
### HTTP request headers
|
225
231
|
|
@@ -240,8 +246,10 @@ require 'time'
|
|
240
246
|
require 'spartera_api_sdk'
|
241
247
|
# setup authorization
|
242
248
|
SparteraApiSdk.configure do |config|
|
243
|
-
# Configure
|
244
|
-
config.
|
249
|
+
# Configure API key authorization: ApiKeyAuth
|
250
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
251
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
252
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
245
253
|
end
|
246
254
|
|
247
255
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -290,7 +298,7 @@ end
|
|
290
298
|
|
291
299
|
### Authorization
|
292
300
|
|
293
|
-
[
|
301
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
294
302
|
|
295
303
|
### HTTP request headers
|
296
304
|
|
@@ -302,7 +310,7 @@ end
|
|
302
310
|
|
303
311
|
> Object companies_company_id_users_user_id_favorites_favorite_id_patch(company_id, user_id, favorite_id, favorite)
|
304
312
|
|
305
|
-
Update an existing favorite by ID
|
313
|
+
Update an existing favorite by ID
|
306
314
|
|
307
315
|
### Examples
|
308
316
|
|
@@ -311,8 +319,10 @@ require 'time'
|
|
311
319
|
require 'spartera_api_sdk'
|
312
320
|
# setup authorization
|
313
321
|
SparteraApiSdk.configure do |config|
|
314
|
-
# Configure
|
315
|
-
config.
|
322
|
+
# Configure API key authorization: ApiKeyAuth
|
323
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
324
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
325
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
316
326
|
end
|
317
327
|
|
318
328
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -322,7 +332,7 @@ favorite_id = 'favorite_id_example' # String |
|
|
322
332
|
favorite = SparteraApiSdk::Favorite.new({asset_id: 'asset_id_example', company_id: 'company_id_example', priority: 'priority_example'}) # Favorite |
|
323
333
|
|
324
334
|
begin
|
325
|
-
# Update an existing favorite by ID
|
335
|
+
# Update an existing favorite by ID
|
326
336
|
result = api_instance.companies_company_id_users_user_id_favorites_favorite_id_patch(company_id, user_id, favorite_id, favorite)
|
327
337
|
p result
|
328
338
|
rescue SparteraApiSdk::ApiError => e
|
@@ -338,7 +348,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
338
348
|
|
339
349
|
```ruby
|
340
350
|
begin
|
341
|
-
# Update an existing favorite by ID
|
351
|
+
# Update an existing favorite by ID
|
342
352
|
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_favorite_id_patch_with_http_info(company_id, user_id, favorite_id, favorite)
|
343
353
|
p status_code # => 2xx
|
344
354
|
p headers # => { ... }
|
@@ -363,7 +373,7 @@ end
|
|
363
373
|
|
364
374
|
### Authorization
|
365
375
|
|
366
|
-
[
|
376
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
367
377
|
|
368
378
|
### HTTP request headers
|
369
379
|
|
@@ -375,7 +385,7 @@ end
|
|
375
385
|
|
376
386
|
> Object companies_company_id_users_user_id_favorites_get(company_id, user_id)
|
377
387
|
|
378
|
-
Get a list of all favorites for a specific user
|
388
|
+
Get a list of all favorites for a specific user
|
379
389
|
|
380
390
|
### Examples
|
381
391
|
|
@@ -384,8 +394,10 @@ require 'time'
|
|
384
394
|
require 'spartera_api_sdk'
|
385
395
|
# setup authorization
|
386
396
|
SparteraApiSdk.configure do |config|
|
387
|
-
# Configure
|
388
|
-
config.
|
397
|
+
# Configure API key authorization: ApiKeyAuth
|
398
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
399
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
400
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
389
401
|
end
|
390
402
|
|
391
403
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -393,7 +405,7 @@ company_id = 'company_id_example' # String |
|
|
393
405
|
user_id = 'user_id_example' # String |
|
394
406
|
|
395
407
|
begin
|
396
|
-
# Get a list of all favorites for a specific user
|
408
|
+
# Get a list of all favorites for a specific user
|
397
409
|
result = api_instance.companies_company_id_users_user_id_favorites_get(company_id, user_id)
|
398
410
|
p result
|
399
411
|
rescue SparteraApiSdk::ApiError => e
|
@@ -409,7 +421,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
409
421
|
|
410
422
|
```ruby
|
411
423
|
begin
|
412
|
-
# Get a list of all favorites for a specific user
|
424
|
+
# Get a list of all favorites for a specific user
|
413
425
|
data, status_code, headers = api_instance.companies_company_id_users_user_id_favorites_get_with_http_info(company_id, user_id)
|
414
426
|
p status_code # => 2xx
|
415
427
|
p headers # => { ... }
|
@@ -432,7 +444,7 @@ end
|
|
432
444
|
|
433
445
|
### Authorization
|
434
446
|
|
435
|
-
[
|
447
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
436
448
|
|
437
449
|
### HTTP request headers
|
438
450
|
|
@@ -453,8 +465,10 @@ require 'time'
|
|
453
465
|
require 'spartera_api_sdk'
|
454
466
|
# setup authorization
|
455
467
|
SparteraApiSdk.configure do |config|
|
456
|
-
# Configure
|
457
|
-
config.
|
468
|
+
# Configure API key authorization: ApiKeyAuth
|
469
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
470
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
471
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
458
472
|
end
|
459
473
|
|
460
474
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -503,7 +517,7 @@ end
|
|
503
517
|
|
504
518
|
### Authorization
|
505
519
|
|
506
|
-
[
|
520
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
507
521
|
|
508
522
|
### HTTP request headers
|
509
523
|
|
@@ -524,8 +538,10 @@ require 'time'
|
|
524
538
|
require 'spartera_api_sdk'
|
525
539
|
# setup authorization
|
526
540
|
SparteraApiSdk.configure do |config|
|
527
|
-
# Configure
|
528
|
-
config.
|
541
|
+
# Configure API key authorization: ApiKeyAuth
|
542
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
543
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
544
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
529
545
|
end
|
530
546
|
|
531
547
|
api_instance = SparteraApiSdk::FavoritesApi.new
|
@@ -572,7 +588,7 @@ end
|
|
572
588
|
|
573
589
|
### Authorization
|
574
590
|
|
575
|
-
[
|
591
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
576
592
|
|
577
593
|
### HTTP request headers
|
578
594
|
|
@@ -0,0 +1,149 @@
|
|
1
|
+
# SparteraApiSdk::StorageEnginesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.spartera.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**cloud_providers_provider_id_storage_engines_engine_id_get**](StorageEnginesApi.md#cloud_providers_provider_id_storage_engines_engine_id_get) | **GET** /cloud-providers/{provider_id}/storage-engines/{engine_id} | Get single storage engine by ID |
|
8
|
+
| [**cloud_providers_provider_id_storage_engines_get**](StorageEnginesApi.md#cloud_providers_provider_id_storage_engines_get) | **GET** /cloud-providers/{provider_id}/storage-engines | Get a list of all storage engines |
|
9
|
+
|
10
|
+
|
11
|
+
## cloud_providers_provider_id_storage_engines_engine_id_get
|
12
|
+
|
13
|
+
> Object cloud_providers_provider_id_storage_engines_engine_id_get(provider_id, engine_id)
|
14
|
+
|
15
|
+
Get single storage engine by ID
|
16
|
+
|
17
|
+
### Examples
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'time'
|
21
|
+
require 'spartera_api_sdk'
|
22
|
+
# setup authorization
|
23
|
+
SparteraApiSdk.configure do |config|
|
24
|
+
# Configure API key authorization: ApiKeyAuth
|
25
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
26
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
28
|
+
end
|
29
|
+
|
30
|
+
api_instance = SparteraApiSdk::StorageEnginesApi.new
|
31
|
+
provider_id = 'provider_id_example' # String |
|
32
|
+
engine_id = 'engine_id_example' # String |
|
33
|
+
|
34
|
+
begin
|
35
|
+
# Get single storage engine by ID
|
36
|
+
result = api_instance.cloud_providers_provider_id_storage_engines_engine_id_get(provider_id, engine_id)
|
37
|
+
p result
|
38
|
+
rescue SparteraApiSdk::ApiError => e
|
39
|
+
puts "Error when calling StorageEnginesApi->cloud_providers_provider_id_storage_engines_engine_id_get: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
#### Using the cloud_providers_provider_id_storage_engines_engine_id_get_with_http_info variant
|
44
|
+
|
45
|
+
This returns an Array which contains the response data, status code and headers.
|
46
|
+
|
47
|
+
> <Array(Object, Integer, Hash)> cloud_providers_provider_id_storage_engines_engine_id_get_with_http_info(provider_id, engine_id)
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
begin
|
51
|
+
# Get single storage engine by ID
|
52
|
+
data, status_code, headers = api_instance.cloud_providers_provider_id_storage_engines_engine_id_get_with_http_info(provider_id, engine_id)
|
53
|
+
p status_code # => 2xx
|
54
|
+
p headers # => { ... }
|
55
|
+
p data # => Object
|
56
|
+
rescue SparteraApiSdk::ApiError => e
|
57
|
+
puts "Error when calling StorageEnginesApi->cloud_providers_provider_id_storage_engines_engine_id_get_with_http_info: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
| Name | Type | Description | Notes |
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
65
|
+
| **provider_id** | **String** | | |
|
66
|
+
| **engine_id** | **String** | | |
|
67
|
+
|
68
|
+
### Return type
|
69
|
+
|
70
|
+
**Object**
|
71
|
+
|
72
|
+
### Authorization
|
73
|
+
|
74
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
75
|
+
|
76
|
+
### HTTP request headers
|
77
|
+
|
78
|
+
- **Content-Type**: Not defined
|
79
|
+
- **Accept**: application/json
|
80
|
+
|
81
|
+
|
82
|
+
## cloud_providers_provider_id_storage_engines_get
|
83
|
+
|
84
|
+
> Object cloud_providers_provider_id_storage_engines_get(provider_id)
|
85
|
+
|
86
|
+
Get a list of all storage engines
|
87
|
+
|
88
|
+
### Examples
|
89
|
+
|
90
|
+
```ruby
|
91
|
+
require 'time'
|
92
|
+
require 'spartera_api_sdk'
|
93
|
+
# setup authorization
|
94
|
+
SparteraApiSdk.configure do |config|
|
95
|
+
# Configure API key authorization: ApiKeyAuth
|
96
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
97
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
98
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
99
|
+
end
|
100
|
+
|
101
|
+
api_instance = SparteraApiSdk::StorageEnginesApi.new
|
102
|
+
provider_id = 'provider_id_example' # String |
|
103
|
+
|
104
|
+
begin
|
105
|
+
# Get a list of all storage engines
|
106
|
+
result = api_instance.cloud_providers_provider_id_storage_engines_get(provider_id)
|
107
|
+
p result
|
108
|
+
rescue SparteraApiSdk::ApiError => e
|
109
|
+
puts "Error when calling StorageEnginesApi->cloud_providers_provider_id_storage_engines_get: #{e}"
|
110
|
+
end
|
111
|
+
```
|
112
|
+
|
113
|
+
#### Using the cloud_providers_provider_id_storage_engines_get_with_http_info variant
|
114
|
+
|
115
|
+
This returns an Array which contains the response data, status code and headers.
|
116
|
+
|
117
|
+
> <Array(Object, Integer, Hash)> cloud_providers_provider_id_storage_engines_get_with_http_info(provider_id)
|
118
|
+
|
119
|
+
```ruby
|
120
|
+
begin
|
121
|
+
# Get a list of all storage engines
|
122
|
+
data, status_code, headers = api_instance.cloud_providers_provider_id_storage_engines_get_with_http_info(provider_id)
|
123
|
+
p status_code # => 2xx
|
124
|
+
p headers # => { ... }
|
125
|
+
p data # => Object
|
126
|
+
rescue SparteraApiSdk::ApiError => e
|
127
|
+
puts "Error when calling StorageEnginesApi->cloud_providers_provider_id_storage_engines_get_with_http_info: #{e}"
|
128
|
+
end
|
129
|
+
```
|
130
|
+
|
131
|
+
### Parameters
|
132
|
+
|
133
|
+
| Name | Type | Description | Notes |
|
134
|
+
| ---- | ---- | ----------- | ----- |
|
135
|
+
| **provider_id** | **String** | | |
|
136
|
+
|
137
|
+
### Return type
|
138
|
+
|
139
|
+
**Object**
|
140
|
+
|
141
|
+
### Authorization
|
142
|
+
|
143
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
144
|
+
|
145
|
+
### HTTP request headers
|
146
|
+
|
147
|
+
- **Content-Type**: Not defined
|
148
|
+
- **Accept**: application/json
|
149
|
+
|
data/docs/UsersApi.md
CHANGED
@@ -4,7 +4,7 @@ All URIs are relative to *https://api.spartera.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**companies_company_id_users_get**](UsersApi.md#companies_company_id_users_get) | **GET** /companies/{company_id}/users | Get a list of all users
|
7
|
+
| [**companies_company_id_users_get**](UsersApi.md#companies_company_id_users_get) | **GET** /companies/{company_id}/users | Get a list of all users in a company |
|
8
8
|
| [**companies_company_id_users_post**](UsersApi.md#companies_company_id_users_post) | **POST** /companies/{company_id}/users | Create a new user |
|
9
9
|
| [**companies_company_id_users_user_id_delete**](UsersApi.md#companies_company_id_users_user_id_delete) | **DELETE** /companies/{company_id}/users/{user_id} | Delete single user by ID |
|
10
10
|
| [**companies_company_id_users_user_id_get**](UsersApi.md#companies_company_id_users_user_id_get) | **GET** /companies/{company_id}/users/{user_id} | Get single user by ID |
|
@@ -15,7 +15,7 @@ All URIs are relative to *https://api.spartera.com*
|
|
15
15
|
|
16
16
|
> Object companies_company_id_users_get(company_id)
|
17
17
|
|
18
|
-
Get a list of all users
|
18
|
+
Get a list of all users in a company
|
19
19
|
|
20
20
|
### Examples
|
21
21
|
|
@@ -24,15 +24,17 @@ require 'time'
|
|
24
24
|
require 'spartera_api_sdk'
|
25
25
|
# setup authorization
|
26
26
|
SparteraApiSdk.configure do |config|
|
27
|
-
# Configure
|
28
|
-
config.
|
27
|
+
# Configure API key authorization: ApiKeyAuth
|
28
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
29
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
29
31
|
end
|
30
32
|
|
31
33
|
api_instance = SparteraApiSdk::UsersApi.new
|
32
34
|
company_id = 'company_id_example' # String |
|
33
35
|
|
34
36
|
begin
|
35
|
-
# Get a list of all users
|
37
|
+
# Get a list of all users in a company
|
36
38
|
result = api_instance.companies_company_id_users_get(company_id)
|
37
39
|
p result
|
38
40
|
rescue SparteraApiSdk::ApiError => e
|
@@ -48,7 +50,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
48
50
|
|
49
51
|
```ruby
|
50
52
|
begin
|
51
|
-
# Get a list of all users
|
53
|
+
# Get a list of all users in a company
|
52
54
|
data, status_code, headers = api_instance.companies_company_id_users_get_with_http_info(company_id)
|
53
55
|
p status_code # => 2xx
|
54
56
|
p headers # => { ... }
|
@@ -70,7 +72,7 @@ end
|
|
70
72
|
|
71
73
|
### Authorization
|
72
74
|
|
73
|
-
[
|
75
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
74
76
|
|
75
77
|
### HTTP request headers
|
76
78
|
|
@@ -91,8 +93,10 @@ require 'time'
|
|
91
93
|
require 'spartera_api_sdk'
|
92
94
|
# setup authorization
|
93
95
|
SparteraApiSdk.configure do |config|
|
94
|
-
# Configure
|
95
|
-
config.
|
96
|
+
# Configure API key authorization: ApiKeyAuth
|
97
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
98
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
99
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
96
100
|
end
|
97
101
|
|
98
102
|
api_instance = SparteraApiSdk::UsersApi.new
|
@@ -139,7 +143,7 @@ end
|
|
139
143
|
|
140
144
|
### Authorization
|
141
145
|
|
142
|
-
[
|
146
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
143
147
|
|
144
148
|
### HTTP request headers
|
145
149
|
|
@@ -160,8 +164,10 @@ require 'time'
|
|
160
164
|
require 'spartera_api_sdk'
|
161
165
|
# setup authorization
|
162
166
|
SparteraApiSdk.configure do |config|
|
163
|
-
# Configure
|
164
|
-
config.
|
167
|
+
# Configure API key authorization: ApiKeyAuth
|
168
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
169
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
170
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
165
171
|
end
|
166
172
|
|
167
173
|
api_instance = SparteraApiSdk::UsersApi.new
|
@@ -208,7 +214,7 @@ end
|
|
208
214
|
|
209
215
|
### Authorization
|
210
216
|
|
211
|
-
[
|
217
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
212
218
|
|
213
219
|
### HTTP request headers
|
214
220
|
|
@@ -229,8 +235,10 @@ require 'time'
|
|
229
235
|
require 'spartera_api_sdk'
|
230
236
|
# setup authorization
|
231
237
|
SparteraApiSdk.configure do |config|
|
232
|
-
# Configure
|
233
|
-
config.
|
238
|
+
# Configure API key authorization: ApiKeyAuth
|
239
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
240
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
241
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
234
242
|
end
|
235
243
|
|
236
244
|
api_instance = SparteraApiSdk::UsersApi.new
|
@@ -277,7 +285,7 @@ end
|
|
277
285
|
|
278
286
|
### Authorization
|
279
287
|
|
280
|
-
[
|
288
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
281
289
|
|
282
290
|
### HTTP request headers
|
283
291
|
|
@@ -298,8 +306,10 @@ require 'time'
|
|
298
306
|
require 'spartera_api_sdk'
|
299
307
|
# setup authorization
|
300
308
|
SparteraApiSdk.configure do |config|
|
301
|
-
# Configure
|
302
|
-
config.
|
309
|
+
# Configure API key authorization: ApiKeyAuth
|
310
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
311
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
312
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
303
313
|
end
|
304
314
|
|
305
315
|
api_instance = SparteraApiSdk::UsersApi.new
|
@@ -348,7 +358,7 @@ end
|
|
348
358
|
|
349
359
|
### Authorization
|
350
360
|
|
351
|
-
[
|
361
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
352
362
|
|
353
363
|
### HTTP request headers
|
354
364
|
|
@@ -73,7 +73,7 @@ module SparteraApiSdk
|
|
73
73
|
return_type = opts[:debug_return_type] || 'Object'
|
74
74
|
|
75
75
|
# auth_names
|
76
|
-
auth_names = opts[:debug_auth_names] || ['
|
76
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
|
77
77
|
|
78
78
|
new_options = opts.merge(
|
79
79
|
:operation => :"AlertsApi.companies_company_id_users_user_id_alerts_alert_id_delete",
|
@@ -146,7 +146,7 @@ module SparteraApiSdk
|
|
146
146
|
return_type = opts[:debug_return_type] || 'Object'
|
147
147
|
|
148
148
|
# auth_names
|
149
|
-
auth_names = opts[:debug_auth_names] || ['
|
149
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
|
150
150
|
|
151
151
|
new_options = opts.merge(
|
152
152
|
:operation => :"AlertsApi.companies_company_id_users_user_id_alerts_alert_id_get",
|
@@ -230,7 +230,7 @@ module SparteraApiSdk
|
|
230
230
|
return_type = opts[:debug_return_type] || 'Object'
|
231
231
|
|
232
232
|
# auth_names
|
233
|
-
auth_names = opts[:debug_auth_names] || ['
|
233
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
|
234
234
|
|
235
235
|
new_options = opts.merge(
|
236
236
|
:operation => :"AlertsApi.companies_company_id_users_user_id_alerts_alert_id_patch",
|
@@ -249,7 +249,7 @@ module SparteraApiSdk
|
|
249
249
|
return data, status_code, headers
|
250
250
|
end
|
251
251
|
|
252
|
-
# Get all alerts for a specific asset
|
252
|
+
# Get all alerts for a specific asset
|
253
253
|
# @param company_id [String]
|
254
254
|
# @param user_id [String]
|
255
255
|
# @param asset_id [String]
|
@@ -260,7 +260,7 @@ module SparteraApiSdk
|
|
260
260
|
data
|
261
261
|
end
|
262
262
|
|
263
|
-
# Get all alerts for a specific asset
|
263
|
+
# Get all alerts for a specific asset
|
264
264
|
# @param company_id [String]
|
265
265
|
# @param user_id [String]
|
266
266
|
# @param asset_id [String]
|
@@ -303,7 +303,7 @@ module SparteraApiSdk
|
|
303
303
|
return_type = opts[:debug_return_type] || 'Object'
|
304
304
|
|
305
305
|
# auth_names
|
306
|
-
auth_names = opts[:debug_auth_names] || ['
|
306
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
|
307
307
|
|
308
308
|
new_options = opts.merge(
|
309
309
|
:operation => :"AlertsApi.companies_company_id_users_user_id_alerts_asset_asset_id_all_get",
|
@@ -322,7 +322,7 @@ module SparteraApiSdk
|
|
322
322
|
return data, status_code, headers
|
323
323
|
end
|
324
324
|
|
325
|
-
# Get all alerts for a specific asset by
|
325
|
+
# Get all alerts for a specific asset (by user)
|
326
326
|
# @param company_id [String]
|
327
327
|
# @param user_id [String]
|
328
328
|
# @param asset_id [String]
|
@@ -333,7 +333,7 @@ module SparteraApiSdk
|
|
333
333
|
data
|
334
334
|
end
|
335
335
|
|
336
|
-
# Get all alerts for a specific asset by
|
336
|
+
# Get all alerts for a specific asset (by user)
|
337
337
|
# @param company_id [String]
|
338
338
|
# @param user_id [String]
|
339
339
|
# @param asset_id [String]
|
@@ -376,7 +376,7 @@ module SparteraApiSdk
|
|
376
376
|
return_type = opts[:debug_return_type] || 'Object'
|
377
377
|
|
378
378
|
# auth_names
|
379
|
-
auth_names = opts[:debug_auth_names] || ['
|
379
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
|
380
380
|
|
381
381
|
new_options = opts.merge(
|
382
382
|
:operation => :"AlertsApi.companies_company_id_users_user_id_alerts_asset_asset_id_get",
|
@@ -443,7 +443,7 @@ module SparteraApiSdk
|
|
443
443
|
return_type = opts[:debug_return_type] || 'Object'
|
444
444
|
|
445
445
|
# auth_names
|
446
|
-
auth_names = opts[:debug_auth_names] || ['
|
446
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
|
447
447
|
|
448
448
|
new_options = opts.merge(
|
449
449
|
:operation => :"AlertsApi.companies_company_id_users_user_id_alerts_get",
|
@@ -521,7 +521,7 @@ module SparteraApiSdk
|
|
521
521
|
return_type = opts[:debug_return_type] || 'Object'
|
522
522
|
|
523
523
|
# auth_names
|
524
|
-
auth_names = opts[:debug_auth_names] || ['
|
524
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
|
525
525
|
|
526
526
|
new_options = opts.merge(
|
527
527
|
:operation => :"AlertsApi.companies_company_id_users_user_id_alerts_post",
|