spartera_api_sdk 1.0.68 → 1.0.72
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/docs/APIKeysApi.md +20 -20
- data/docs/AlertsApi.md +28 -28
- data/docs/AssetPriceHistoryApi.md +32 -32
- data/docs/AssetsApi.md +52 -52
- data/docs/CloudProvidersApi.md +8 -8
- data/docs/CompaniesApi.md +36 -36
- 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 +28 -28
- data/docs/FavoritesApi.md +32 -32
- 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 +8 -8
- data/docs/UsersApi.md +87 -20
- data/lib/spartera_api_sdk/api/alerts_api.rb +21 -21
- data/lib/spartera_api_sdk/api/api_keys_api.rb +15 -15
- data/lib/spartera_api_sdk/api/asset_price_history_api.rb +24 -24
- data/lib/spartera_api_sdk/api/assets_api.rb +46 -46
- data/lib/spartera_api_sdk/api/cloud_providers_api.rb +6 -6
- data/lib/spartera_api_sdk/api/companies_api.rb +27 -27
- data/lib/spartera_api_sdk/api/connections_api.rb +21 -21
- data/lib/spartera_api_sdk/api/favorites_api.rb +24 -24
- data/lib/spartera_api_sdk/api/storage_engines_api.rb +6 -6
- data/lib/spartera_api_sdk/api/users_api.rb +70 -15
- 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 -13
- data/lib/spartera_api_sdk.rb +45 -0
- data/spec/api/alerts_api_spec.rb +7 -7
- data/spec/api/api_keys_api_spec.rb +5 -5
- data/spec/api/asset_price_history_api_spec.rb +8 -8
- data/spec/api/assets_api_spec.rb +13 -13
- data/spec/api/cloud_providers_api_spec.rb +2 -2
- data/spec/api/companies_api_spec.rb +9 -9
- data/spec/api/connections_api_spec.rb +7 -7
- data/spec/api/favorites_api_spec.rb +8 -8
- data/spec/api/storage_engines_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +15 -5
- 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 +212 -20
- data/Gemfile +0 -11
- data/Rakefile +0 -10
- data/config.json +0 -10
- data/git_push.sh +0 -57
- data/spartera_api_sdk.gemspec +0 -28
- data/test.sh +0 -42
data/docs/CompaniesApi.md
CHANGED
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.spartera.com*
|
|
17
17
|
|
18
18
|
## companies_company_id_analytics_assets_get
|
19
19
|
|
20
|
-
>
|
20
|
+
> <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_analytics_assets_get(company_id)
|
21
21
|
|
22
22
|
Get asset performance analytics Query params: start_date, end_date, limit, sort_by, include
|
23
23
|
|
@@ -50,7 +50,7 @@ end
|
|
50
50
|
|
51
51
|
This returns an Array which contains the response data, status code and headers.
|
52
52
|
|
53
|
-
> <Array(
|
53
|
+
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_analytics_assets_get_with_http_info(company_id)
|
54
54
|
|
55
55
|
```ruby
|
56
56
|
begin
|
@@ -58,7 +58,7 @@ begin
|
|
58
58
|
data, status_code, headers = api_instance.companies_company_id_analytics_assets_get_with_http_info(company_id)
|
59
59
|
p status_code # => 2xx
|
60
60
|
p headers # => { ... }
|
61
|
-
p data # =>
|
61
|
+
p data # => <CompaniesCompanyIdApiKeysGet200Response>
|
62
62
|
rescue SparteraApiSdk::ApiError => e
|
63
63
|
puts "Error when calling CompaniesApi->companies_company_id_analytics_assets_get_with_http_info: #{e}"
|
64
64
|
end
|
@@ -72,7 +72,7 @@ end
|
|
72
72
|
|
73
73
|
### Return type
|
74
74
|
|
75
|
-
**
|
75
|
+
[**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
|
76
76
|
|
77
77
|
### Authorization
|
78
78
|
|
@@ -86,7 +86,7 @@ end
|
|
86
86
|
|
87
87
|
## companies_company_id_analytics_customers_get
|
88
88
|
|
89
|
-
>
|
89
|
+
> <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_analytics_customers_get(company_id)
|
90
90
|
|
91
91
|
Get customer analytics including growth and segmentation Query params: start_date, end_date, group_by, segment_by
|
92
92
|
|
@@ -119,7 +119,7 @@ end
|
|
119
119
|
|
120
120
|
This returns an Array which contains the response data, status code and headers.
|
121
121
|
|
122
|
-
> <Array(
|
122
|
+
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_analytics_customers_get_with_http_info(company_id)
|
123
123
|
|
124
124
|
```ruby
|
125
125
|
begin
|
@@ -127,7 +127,7 @@ begin
|
|
127
127
|
data, status_code, headers = api_instance.companies_company_id_analytics_customers_get_with_http_info(company_id)
|
128
128
|
p status_code # => 2xx
|
129
129
|
p headers # => { ... }
|
130
|
-
p data # =>
|
130
|
+
p data # => <CompaniesCompanyIdApiKeysGet200Response>
|
131
131
|
rescue SparteraApiSdk::ApiError => e
|
132
132
|
puts "Error when calling CompaniesApi->companies_company_id_analytics_customers_get_with_http_info: #{e}"
|
133
133
|
end
|
@@ -141,7 +141,7 @@ end
|
|
141
141
|
|
142
142
|
### Return type
|
143
143
|
|
144
|
-
**
|
144
|
+
[**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
|
145
145
|
|
146
146
|
### Authorization
|
147
147
|
|
@@ -155,7 +155,7 @@ end
|
|
155
155
|
|
156
156
|
## companies_company_id_analytics_dashboard_get
|
157
157
|
|
158
|
-
>
|
158
|
+
> <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_analytics_dashboard_get(company_id)
|
159
159
|
|
160
160
|
Get comprehensive dashboard analytics for seller dashboard Includes all metrics needed for dashboard charts in one call Query params: start_date, end_date, period (day/week/month/quarter)
|
161
161
|
|
@@ -188,7 +188,7 @@ end
|
|
188
188
|
|
189
189
|
This returns an Array which contains the response data, status code and headers.
|
190
190
|
|
191
|
-
> <Array(
|
191
|
+
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_analytics_dashboard_get_with_http_info(company_id)
|
192
192
|
|
193
193
|
```ruby
|
194
194
|
begin
|
@@ -196,7 +196,7 @@ begin
|
|
196
196
|
data, status_code, headers = api_instance.companies_company_id_analytics_dashboard_get_with_http_info(company_id)
|
197
197
|
p status_code # => 2xx
|
198
198
|
p headers # => { ... }
|
199
|
-
p data # =>
|
199
|
+
p data # => <CompaniesCompanyIdApiKeysGet200Response>
|
200
200
|
rescue SparteraApiSdk::ApiError => e
|
201
201
|
puts "Error when calling CompaniesApi->companies_company_id_analytics_dashboard_get_with_http_info: #{e}"
|
202
202
|
end
|
@@ -210,7 +210,7 @@ end
|
|
210
210
|
|
211
211
|
### Return type
|
212
212
|
|
213
|
-
**
|
213
|
+
[**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
|
214
214
|
|
215
215
|
### Authorization
|
216
216
|
|
@@ -224,7 +224,7 @@ end
|
|
224
224
|
|
225
225
|
## companies_company_id_analytics_sales_get
|
226
226
|
|
227
|
-
>
|
227
|
+
> <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_analytics_sales_get(company_id)
|
228
228
|
|
229
229
|
Get sales over time analytics Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
|
230
230
|
|
@@ -257,7 +257,7 @@ end
|
|
257
257
|
|
258
258
|
This returns an Array which contains the response data, status code and headers.
|
259
259
|
|
260
|
-
> <Array(
|
260
|
+
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_analytics_sales_get_with_http_info(company_id)
|
261
261
|
|
262
262
|
```ruby
|
263
263
|
begin
|
@@ -265,7 +265,7 @@ begin
|
|
265
265
|
data, status_code, headers = api_instance.companies_company_id_analytics_sales_get_with_http_info(company_id)
|
266
266
|
p status_code # => 2xx
|
267
267
|
p headers # => { ... }
|
268
|
-
p data # =>
|
268
|
+
p data # => <CompaniesCompanyIdApiKeysGet200Response>
|
269
269
|
rescue SparteraApiSdk::ApiError => e
|
270
270
|
puts "Error when calling CompaniesApi->companies_company_id_analytics_sales_get_with_http_info: #{e}"
|
271
271
|
end
|
@@ -279,7 +279,7 @@ end
|
|
279
279
|
|
280
280
|
### Return type
|
281
281
|
|
282
|
-
**
|
282
|
+
[**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
|
283
283
|
|
284
284
|
### Authorization
|
285
285
|
|
@@ -293,7 +293,7 @@ end
|
|
293
293
|
|
294
294
|
## companies_company_id_get
|
295
295
|
|
296
|
-
>
|
296
|
+
> <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_get(company_id)
|
297
297
|
|
298
298
|
Get details of the requestor's own company
|
299
299
|
|
@@ -326,7 +326,7 @@ end
|
|
326
326
|
|
327
327
|
This returns an Array which contains the response data, status code and headers.
|
328
328
|
|
329
|
-
> <Array(
|
329
|
+
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_get_with_http_info(company_id)
|
330
330
|
|
331
331
|
```ruby
|
332
332
|
begin
|
@@ -334,7 +334,7 @@ begin
|
|
334
334
|
data, status_code, headers = api_instance.companies_company_id_get_with_http_info(company_id)
|
335
335
|
p status_code # => 2xx
|
336
336
|
p headers # => { ... }
|
337
|
-
p data # =>
|
337
|
+
p data # => <CompaniesCompanyIdApiKeysGet200Response>
|
338
338
|
rescue SparteraApiSdk::ApiError => e
|
339
339
|
puts "Error when calling CompaniesApi->companies_company_id_get_with_http_info: #{e}"
|
340
340
|
end
|
@@ -348,7 +348,7 @@ end
|
|
348
348
|
|
349
349
|
### Return type
|
350
350
|
|
351
|
-
**
|
351
|
+
[**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
|
352
352
|
|
353
353
|
### Authorization
|
354
354
|
|
@@ -362,7 +362,7 @@ end
|
|
362
362
|
|
363
363
|
## companies_company_id_objects_get
|
364
364
|
|
365
|
-
>
|
365
|
+
> <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_objects_get(company_id)
|
366
366
|
|
367
367
|
Get all objects (connections, assets) of a single company
|
368
368
|
|
@@ -395,7 +395,7 @@ end
|
|
395
395
|
|
396
396
|
This returns an Array which contains the response data, status code and headers.
|
397
397
|
|
398
|
-
> <Array(
|
398
|
+
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_objects_get_with_http_info(company_id)
|
399
399
|
|
400
400
|
```ruby
|
401
401
|
begin
|
@@ -403,7 +403,7 @@ begin
|
|
403
403
|
data, status_code, headers = api_instance.companies_company_id_objects_get_with_http_info(company_id)
|
404
404
|
p status_code # => 2xx
|
405
405
|
p headers # => { ... }
|
406
|
-
p data # =>
|
406
|
+
p data # => <CompaniesCompanyIdApiKeysGet200Response>
|
407
407
|
rescue SparteraApiSdk::ApiError => e
|
408
408
|
puts "Error when calling CompaniesApi->companies_company_id_objects_get_with_http_info: #{e}"
|
409
409
|
end
|
@@ -417,7 +417,7 @@ end
|
|
417
417
|
|
418
418
|
### Return type
|
419
419
|
|
420
|
-
**
|
420
|
+
[**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
|
421
421
|
|
422
422
|
### Authorization
|
423
423
|
|
@@ -431,7 +431,7 @@ end
|
|
431
431
|
|
432
432
|
## companies_company_id_patch
|
433
433
|
|
434
|
-
>
|
434
|
+
> <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_patch(company_id)
|
435
435
|
|
436
436
|
Update an existing company by ID
|
437
437
|
|
@@ -464,7 +464,7 @@ end
|
|
464
464
|
|
465
465
|
This returns an Array which contains the response data, status code and headers.
|
466
466
|
|
467
|
-
> <Array(
|
467
|
+
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_patch_with_http_info(company_id)
|
468
468
|
|
469
469
|
```ruby
|
470
470
|
begin
|
@@ -472,7 +472,7 @@ begin
|
|
472
472
|
data, status_code, headers = api_instance.companies_company_id_patch_with_http_info(company_id)
|
473
473
|
p status_code # => 2xx
|
474
474
|
p headers # => { ... }
|
475
|
-
p data # =>
|
475
|
+
p data # => <CompaniesCompanyIdApiKeysGet200Response>
|
476
476
|
rescue SparteraApiSdk::ApiError => e
|
477
477
|
puts "Error when calling CompaniesApi->companies_company_id_patch_with_http_info: #{e}"
|
478
478
|
end
|
@@ -486,7 +486,7 @@ end
|
|
486
486
|
|
487
487
|
### Return type
|
488
488
|
|
489
|
-
**
|
489
|
+
[**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
|
490
490
|
|
491
491
|
### Authorization
|
492
492
|
|
@@ -500,7 +500,7 @@ end
|
|
500
500
|
|
501
501
|
## companies_company_id_requests_plan_get
|
502
502
|
|
503
|
-
>
|
503
|
+
> <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_requests_plan_get(company_id)
|
504
504
|
|
505
505
|
Get the total number of requests allocated in the company's current subscription plan.
|
506
506
|
|
@@ -533,7 +533,7 @@ end
|
|
533
533
|
|
534
534
|
This returns an Array which contains the response data, status code and headers.
|
535
535
|
|
536
|
-
> <Array(
|
536
|
+
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_requests_plan_get_with_http_info(company_id)
|
537
537
|
|
538
538
|
```ruby
|
539
539
|
begin
|
@@ -541,7 +541,7 @@ begin
|
|
541
541
|
data, status_code, headers = api_instance.companies_company_id_requests_plan_get_with_http_info(company_id)
|
542
542
|
p status_code # => 2xx
|
543
543
|
p headers # => { ... }
|
544
|
-
p data # =>
|
544
|
+
p data # => <CompaniesCompanyIdApiKeysGet200Response>
|
545
545
|
rescue SparteraApiSdk::ApiError => e
|
546
546
|
puts "Error when calling CompaniesApi->companies_company_id_requests_plan_get_with_http_info: #{e}"
|
547
547
|
end
|
@@ -555,7 +555,7 @@ end
|
|
555
555
|
|
556
556
|
### Return type
|
557
557
|
|
558
|
-
**
|
558
|
+
[**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
|
559
559
|
|
560
560
|
### Authorization
|
561
561
|
|
@@ -569,7 +569,7 @@ end
|
|
569
569
|
|
570
570
|
## companies_company_id_requests_usage_get
|
571
571
|
|
572
|
-
>
|
572
|
+
> <CompaniesCompanyIdApiKeysGet200Response> companies_company_id_requests_usage_get(company_id)
|
573
573
|
|
574
574
|
Get company request usage data for a specific month. Returns JSON metrics by default or CSV logs when download parameter is included.
|
575
575
|
|
@@ -602,7 +602,7 @@ end
|
|
602
602
|
|
603
603
|
This returns an Array which contains the response data, status code and headers.
|
604
604
|
|
605
|
-
> <Array(
|
605
|
+
> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> companies_company_id_requests_usage_get_with_http_info(company_id)
|
606
606
|
|
607
607
|
```ruby
|
608
608
|
begin
|
@@ -610,7 +610,7 @@ begin
|
|
610
610
|
data, status_code, headers = api_instance.companies_company_id_requests_usage_get_with_http_info(company_id)
|
611
611
|
p status_code # => 2xx
|
612
612
|
p headers # => { ... }
|
613
|
-
p data # =>
|
613
|
+
p data # => <CompaniesCompanyIdApiKeysGet200Response>
|
614
614
|
rescue SparteraApiSdk::ApiError => e
|
615
615
|
puts "Error when calling CompaniesApi->companies_company_id_requests_usage_get_with_http_info: #{e}"
|
616
616
|
end
|
@@ -624,7 +624,7 @@ end
|
|
624
624
|
|
625
625
|
### Return type
|
626
626
|
|
627
|
-
**
|
627
|
+
[**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
|
628
628
|
|
629
629
|
### Authorization
|
630
630
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdApiKeysGet200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | Response status message | |
|
8
|
+
| **data** | **Object** | Response data | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::CompaniesCompanyIdApiKeysGet200Response.new(
|
16
|
+
message: success,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdDelete200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | Response status message | |
|
8
|
+
| **data** | [**CompaniesCompanyIdAssetsAssetIdDelete200ResponseData**](CompaniesCompanyIdAssetsAssetIdDelete200ResponseData.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdDelete200Response.new(
|
16
|
+
message: success,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdDelete200ResponseData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **asset_id** | **String** | ID of the deleted assets | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'spartera_api_sdk'
|
13
|
+
|
14
|
+
instance = SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdDelete200ResponseData.new(
|
15
|
+
asset_id: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdGet200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | Response status message | |
|
8
|
+
| **data** | [**Asset**](Asset.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdGet200Response.new(
|
16
|
+
message: success,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdPatch200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | Response status message | |
|
8
|
+
| **data** | [**CompaniesCompanyIdAssetsAssetIdPatch200ResponseData**](CompaniesCompanyIdAssetsAssetIdPatch200ResponseData.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdPatch200Response.new(
|
16
|
+
message: success,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdPatch200ResponseData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **asset_id** | **String** | ID of the updated assets | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'spartera_api_sdk'
|
13
|
+
|
14
|
+
instance = SparteraApiSdk::CompaniesCompanyIdAssetsAssetIdPatch200ResponseData.new(
|
15
|
+
asset_id: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdAssetsGet200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | Response status message | |
|
8
|
+
| **data** | [**Array<Asset>**](Asset.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::CompaniesCompanyIdAssetsGet200Response.new(
|
16
|
+
message: success,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdAssetsPost200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | Response status message | |
|
8
|
+
| **data** | [**CompaniesCompanyIdAssetsPost200ResponseData**](CompaniesCompanyIdAssetsPost200ResponseData.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::CompaniesCompanyIdAssetsPost200Response.new(
|
16
|
+
message: success,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdAssetsPost200ResponseData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **asset_id** | **String** | ID of the created assets | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'spartera_api_sdk'
|
13
|
+
|
14
|
+
instance = SparteraApiSdk::CompaniesCompanyIdAssetsPost200ResponseData.new(
|
15
|
+
asset_id: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdDelete200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | Response status message | |
|
8
|
+
| **data** | [**CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData**](CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdDelete200Response.new(
|
16
|
+
message: success,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **connection_id** | **String** | ID of the deleted connections | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'spartera_api_sdk'
|
13
|
+
|
14
|
+
instance = SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData.new(
|
15
|
+
connection_id: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdGet200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | Response status message | |
|
8
|
+
| **data** | [**Connection**](Connection.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdGet200Response.new(
|
16
|
+
message: success,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdPatch200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | Response status message | |
|
8
|
+
| **data** | [**CompaniesCompanyIdConnectionsConnectionIdPatch200ResponseData**](CompaniesCompanyIdConnectionsConnectionIdPatch200ResponseData.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdPatch200Response.new(
|
16
|
+
message: success,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdPatch200ResponseData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **connection_id** | **String** | ID of the updated connections | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'spartera_api_sdk'
|
13
|
+
|
14
|
+
instance = SparteraApiSdk::CompaniesCompanyIdConnectionsConnectionIdPatch200ResponseData.new(
|
15
|
+
connection_id: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdConnectionsGet200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | Response status message | |
|
8
|
+
| **data** | [**Array<Connection>**](Connection.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::CompaniesCompanyIdConnectionsGet200Response.new(
|
16
|
+
message: success,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdConnectionsPost200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | Response status message | |
|
8
|
+
| **data** | [**CompaniesCompanyIdConnectionsPost200ResponseData**](CompaniesCompanyIdConnectionsPost200ResponseData.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::CompaniesCompanyIdConnectionsPost200Response.new(
|
16
|
+
message: success,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdConnectionsPost200ResponseData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **connection_id** | **String** | ID of the created connections | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'spartera_api_sdk'
|
13
|
+
|
14
|
+
instance = SparteraApiSdk::CompaniesCompanyIdConnectionsPost200ResponseData.new(
|
15
|
+
connection_id: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# SparteraApiSdk::CompaniesCompanyIdUsersGet200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | Response status message | |
|
8
|
+
| **data** | [**Array<User>**](User.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'spartera_api_sdk'
|
14
|
+
|
15
|
+
instance = SparteraApiSdk::CompaniesCompanyIdUsersGet200Response.new(
|
16
|
+
message: success,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|